Update for Frenetic 4.0

Author: craig-riecke

Introduction/index.md

@@ -46,7 +46,7 @@ Software Environment
 This is a hands-on tutorial with several programming exercises.  We
 recommend using the virtual machine we've prepared that has all the
 necessary software that you need pre-installed. You can get the
-tutorial VM from the following link: [Frenetic Tutorial VM](http://storage.googleapis.com/arjun-umass-disks/Frenetic-Tutorial.ova).
+tutorial VM from the following link: [Frenetic Tutorial VM](https://cornell.box.com/frenetic-4-tutorial).
 
 References
 ----------
@@ -76,4 +76,3 @@ References
   [NetKAT](http://frenetic-lang.github.io/api/frenetic) libraries, as
   well as other supporting libraries used in this tutorial.
 
-[Real World OCaml]: https://realworldocaml.org

NetKATFirewall/index.md

@@ -14,15 +14,22 @@ to configure the switch.
 We can implement the same policy in NetKAT as follows:
 
 ~~~ ocaml
-open NetKAT.Std
-open RepeaterPolicy
+open Frenetic_NetKAT
+open Core.Std
+open Async.Std
+open Repeater
 
 let firewall : policy =
   <:netkat<
     if ipProto = 0x01 && ethType = 0x800 then drop else $pol
   >>
 
-let _ = run_static firewall
+let _ =
+  let module Controller = Frenetic_NetKAT_Controller.Make in
+  Controller.start 6633;
+  Controller.update_policy repeater;
+  never_returns (Scheduler.go ());
+
 ~~~
 
 There are two things to note about this program. First, rather than
@@ -44,8 +51,8 @@ To test your code, compile the firewall and start the controller in
 one terminal,
 
 ~~~
-$ netkat-build Firewall.native
-$ ./Firewall.native
+$ netkat-build Firewall
+$ ./Firewall.d.byte
 ~~~
 
 and Mininet in another:
@@ -86,7 +93,9 @@ The hosts have IP addresses 10.0.0.1 through 10.0.0.4 and are
 connected to ports 1 through 4 respetively.
 
 ~~~
-open NetKAT.Std
+open Frenetic_NetKAT
+open Core.Std
+open Async.Std
 
 let forwarding : policy =
   <:netkat<
@@ -103,15 +112,22 @@ Type this policy into a file `Forwarding.ml` in the
 We want our firewall policy to wrap this forwarding policy:
 
 ~~~
-open NetKAT.Std
+open Frenetic_NetKAT
+open Core.Std
+open Async.Std
 open Forwarding
 
 let firewall : policy =
   <:netkat<
     if (* FILL condition for ICMP packets *) then drop else (filter ethType = 0x800; $forwarding)
   >>
 
-let _ = run_static firewall
+let _ =
+  let module Controller = Frenetic_NetKAT_Controller.Make in
+  Controller.start 6633;
+  Controller.update_policy repeater;
+  never_returns (Scheduler.go ());
+
 ~~~
 
 Save this policy into a file `Firewall2.ml` in the
@@ -122,8 +138,8 @@ Save this policy into a file `Firewall2.ml` in the
 - Build and launch the controller:
 
 ~~~ shell
-$ netkat-build Firewall2.native
-$ ./Firewall2.native
+$ netkat-build Firewall2
+$ ./Firewall2.d.byte
 ~~~
 
 - Start Mininet using the same parameters you've used before:
@@ -188,7 +204,9 @@ policy in NetKAT, you need to allow packets from the first host to
 port 80 on second *and* from port 80 on the second back to the first:
 
 ~~~ ocaml
-open NetKAT.Std
+open Frenetic_NetKAT
+open Core.Std
+open Async.Std
 open Forwarding
 
 let firewall : policy =

NetKATRepeater/index.md

@@ -9,7 +9,7 @@ platform. Most of the controllers we built followed a two-step recipe:
 * Write a `packet_in` handler that implements the desired
   packet-processing functionality.
 
-* Use `flow__mod` messages to configure the switch flow tables to
+* Use `flow_mod` messages to configure the switch flow tables to
   implement the same functionality efficiently.
 
 In the next few chapters, we will explore a completely different
@@ -18,12 +18,11 @@ programming language, and let a compiler and run-time system handle
 the details related to configuring switch flow tables (as well as
 sending requests for statistics, accumulating replies, etc.)
 
-The templates for this part of the tutorial are in the
-`netkat-tutorial-workspace` directory, and the solutions are in
-`netkat-tutorial-solutions`.
+The templates for this part are in
+`src/netkat-tutorial-solutions`.
 
 ~~~
-$ cd tutorials/netkat-tutorial-solutions
+$ cd src/netkat-tutorial-solutions
 ~~~
 
 ### Example 1: A Repeater (Redux)
@@ -39,7 +38,9 @@ of a single switch with four ports, numbered 1 through 4:
 The following program implements a repeater in NetKAT:
 
 ~~~ ocaml
-open NetKAT.Std
+open Frenetic_NetKAT
+open Core.Std
+open Async.Std
 
 (* a simple repeater *)
 let repeater : policy =
@@ -51,7 +52,12 @@ let repeater : policy =
     else drop
   >>
 
-let _ = run_static repeater
+let _ =
+  let module Controller = Frenetic_NetKAT_Controller.Make in
+  Controller.start 6633;
+  Controller.update_policy repeater;
+  never_returns (Scheduler.go ());
+
 ~~~
 
 This main part of this code uses a Camlp4 quotation,
@@ -67,13 +73,16 @@ the switch with a static NetKAT policy.
 
 To run the repeater, type the code above into a file
 <code>Repeater.ml</code> within the
-<code>netkat-tutorial-workspace</code> directory. Then compile and
+<code>netkat-tutorial-solutionbs</code> directory. Then compile and
 start the repeater controller using the following commands.
+
 ~~~
-$ netkatbuild Repeater.native
-$ ./Repeater.native
+$ netkat-build Repeater
+$ ./Repeater.d.byte
 ~~~
+
 Next, in a separate terminal, start up mininet.
+
 ~~~
 $ sudo mn --controller=remote --topology=single,4 --mac --arp
 ~~~
@@ -111,7 +120,9 @@ wanted to implement repeaters on switches with different numbers of
 ports.
 
 ~~~ ocaml
-open NetKAT.Std
+open Frenetic_NetKAT
+open Core.Std
+open Async.Std
 
 (* a simple repeater *)
 let all_ports : int list = [1; 2; 3; 4]
@@ -125,5 +136,5 @@ let repeater : policy =
   List.fold_right
     (fun m pol -> <:netkat<let p = flood m in if port = $m then $p else $pol>>)
     all_ports <:netkat<drop>>
->>
+
 ~~~

NetKATRouting/index.md

@@ -78,7 +78,9 @@ last chapter to this new network. Unfortunately, you cannot simply reuse the fir
 Your firewall policy from the previous chapter probably has the following form: 
 
 ~~~
-open NetKAT.Std
+open Frenetic_NetKAT
+open Core.Std
+open Async.Std
 open Forwarding
 
 let firewall =

OxFirewall/index.md

@@ -39,12 +39,15 @@ number for ICMP is 1 (`Packet.nwProto pk = 1`).
 Fill in the `is_icmp_packet` function in the following template:
 
 ~~~ ocaml
-open OpenFlow0x01_Core
-open OxPlatform
+open Frenetic_Ox
+open Frenetic_OpenFlow0x01
+open Core.Std
+open Async.Std
 
 module MyApplication = struct
 
-  include OxStart.DefaultTutorialHandlers
+  include DefaultHandlers
+  open Platform
 
   let is_icmp_packet (pk : Packet.packet) = ... (* [FILL] *)
 
@@ -59,7 +62,9 @@ module MyApplication = struct
 
 end
 
-module Controller = OxStart.Make (MyApplication)
+let _ =
+  let module C = Make (MyApplication) in
+  C.start ();
 ~~~
 
 ### Building and Testing Your Firewall

OxLearning/index.md

@@ -40,18 +40,20 @@ learns host locations.
 
 You should use the template below to get started.  Save it in a file
 called `Learning.ml` and place it in the directory
-`~/src/frenetic/ox-tutorial-workspace/Learning.ml`.
+`~/src/frenetic-tutorial-workspace/Learning.ml`.
 
 ~~~ ocaml
-(* ~/src/frenetic/ox-tutorial-workspace/Learning.ml *)
+(* ~/src/frenetic-tutorial-workspace/Learning.ml *)
 
-open OxPlatform
-open OpenFlow0x01_Core
-open Packet
+open Frenetic_Ox
+open Frenetic_OpenFlow0x01
+open Frenetic_Packet
+open Core.Std
+open Async.Std
 
 module MyApplication = struct
-
-  include OxStart.DefaultTutorialHandlers
+  include DefaultHandlers
+  open Platform
 
   let known_hosts : (dlAddr, portId) Hashtbl.t = Hashtbl.create 50
 
@@ -90,7 +92,9 @@ module MyApplication = struct
 
 end
 
-module Controller = OxStart.Make (MyApplication)
+let _ =
+  let module C = Make (MyApplication) in
+  C.start ();
 ~~~
 
 Note that it contains a hash table to map hosts to ports:

OxMonitor/index.md

@@ -36,18 +36,20 @@ let packet_in (sw : switchId) (xid : xid) (pktIn : packetIn) : unit =
 
 Use the following code as a template for this exercise.  Save it in a file
 called `Monitor.ml` and place it in the directory
-`~/src/frenetic/ox-tutorial-workspace/Monitor.ml`.
+`~/src/frenetic-tutorial-workspace/Monitor.ml`.
 
 ~~~ ocaml
-(* ~/src/frenetic/ox-tutorial-workspace/Monitor.ml *)
+(* ~/src/frenetic-tutorial-workspace/Monitor.ml *)
 
-open OxPlatform
-open OpenFlow0x01_Core
-module Stats = OpenFlow0x01_Stats
+open Frenetic_Ox
+open Frenetic_OpenFlow0x01
+open Core.Std
+open Async.Std
 
 module MyApplication = struct
 
-  include OxStart.DefaultTutorialHandlers
+  include DefaultHandlers
+  open Platform
 
   (* [FILL] copy over the packet_in function from Firewall.ml
      verbatim, including any helper functions. *)
@@ -71,7 +73,9 @@ module MyApplication = struct
 
 end
 
-module Controller = OxStart.Make (MyApplication)
+let _ =
+  let module C = Make (MyApplication) in
+  C.start ();
 ~~~
 
 Your task:
@@ -225,7 +229,7 @@ let rec periodic_stats_request sw interval xid pat =
   let callback () =
     Printf.printf "Sending stats request to %Ld\n%!" sw;
     send_stats_request sw xid
-      (Stats.AggregateRequest (pat, 0xff, None));
+      (AggregateRequest (pat, 0xff, None));
     periodic_stats_request sw interval xid pat in
   timeout interval callback
 ~~~
@@ -259,12 +263,12 @@ let num_http_response_packets = ref 0L
 
 let stats_reply (sw : switchId) (xid : xid) (stats : Stats.reply) : unit =
   match stats with
-  | Stats.AggregateFlowRep rep ->
+  | AggregateFlowRep rep ->
     begin
       if xid = 10l then
-        num_http_request_packets := rep.Stats.total_packet_count
+        num_http_request_packets := rep.total_packet_count
       else if xid = 20l then
-        num_http_response_packets := rep.Stats.total_packet_count
+        num_http_response_packets := rep.total_packet_count
     end;
     Printf.printf "Saw %Ld HTTP packets.\n%!"
       (Int64.add !num_http_request_packets !num_http_response_packets)
@@ -282,7 +286,7 @@ Consider what happens if the controller receives HTTP packets before
 the switch is fully initialized and extend your monitoring program to
 handle this situation.
 
-[statistics]: https://github.com/frenetic-lang/ocaml-openflow/blob/master/lib/OpenFlow0x01_Stats.mli
+[statistics]: https://github.com/frenetic-lang/frenetic/blob/master/lib/OpenFlow0x01.mli
 
 [Action]: http://frenetic-lang.github.io/frenetic/docs/OpenFlow0x01.Action.html
 

OxNat/index.md

@@ -43,18 +43,19 @@ $ sudo mn --controller=remote --topo=single,3 --mac --arp
 #### Programming Task
 
 Use the template below to get started. Save it in a file called
-`Nat1.ml` and place it in the directory `~/src/frenetic/ox-tutorial-workspace/Nat1.ml`.
+`Nat1.ml` and place it in the directory `~/src/frenetic-tutorial-workspace/Nat1.ml`.
 
 ~~~ ocaml
-(* ~/src/frenetic/ox-tutorial-workspace/Nat1.ml *)
+(* ~/src/frenetic-tutorial-workspace/Nat1.ml *)
 
-open OxPlatform
-open Packet
-open OpenFlow0x01_Core
+open Frenetic_Ox
+open Frenetic_OpenFlow0x01
+open Core.Std
+open Async.Std
 
 module MyApplication = struct
-
-  include OxStart.DefaultTutorialHandlers
+  include DefaultHandlers
+  open Platform
 
   let mappings = Hashtbl.create 50
 
@@ -88,7 +89,9 @@ module MyApplication = struct
           ...
 end
 
-module Controller = OxStart.Make (MyApplication)
+let _ =
+  let module C = Make (MyApplication) in
+  C.start ();
 
 ~~~