package tcpip
OCaml TCP/IP networking stack, used in MirageOS
Install
Dune Dependency
Authors
Maintainers
Sources
tcpip-v6.4.0.tbz
sha256=6e32bf540d291e9b7325cb3dd00df2f695533e009c46ea534d5518b9492c7348
sha512=2e9f9ca2eeac637599eb48e087b4632598539f1c76f9251758995c7eedeb723f8b951d557a2a53b85a58d50a04e68e15598581f88fca8997733e800fcfca422b
doc/src/tcpip.stack-direct/tcpip_stack_direct.ml.html
Source file tcpip_stack_direct.ml
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419
(* * Copyright (c) 2011-2014 Anil Madhavapeddy <anil@recoil.org> * * Permission to use, copy, modify, and distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. *) open Lwt.Infix let src = Logs.Src.create "tcpip-stack-direct" ~doc:"Pure OCaml TCP/IP stack" module Log = (val Logs.src_log src : Logs.LOG) module type UDPV4_DIRECT = Mirage_protocols.UDP with type ipaddr = Ipaddr.V4.t module type TCPV4_DIRECT = Mirage_protocols.TCP with type ipaddr = Ipaddr.V4.t module Make (Time : Mirage_time.S) (Random : Mirage_random.S) (Netif : Mirage_net.S) (Ethernet : Mirage_protocols.ETHERNET) (Arpv4 : Mirage_protocols.ARP) (Ipv4 : Mirage_protocols.IP with type ipaddr = Ipaddr.V4.t) (Icmpv4 : Mirage_protocols.ICMP with type ipaddr = Ipaddr.V4.t) (Udpv4 : UDPV4_DIRECT) (Tcpv4 : TCPV4_DIRECT) = struct module UDPV4 = Udpv4 module TCPV4 = Tcpv4 module IPV4 = Ipv4 type t = { netif : Netif.t; ethif : Ethernet.t; arpv4 : Arpv4.t; ipv4 : Ipv4.t; icmpv4: Icmpv4.t; udpv4 : Udpv4.t; tcpv4 : Tcpv4.t; mutable task : unit Lwt.t option; } let pp fmt t = Format.fprintf fmt "mac=%a,ip=%a" Macaddr.pp (Ethernet.mac t.ethif) (Fmt.list Ipaddr.V4.pp) (Ipv4.get_ip t.ipv4) let tcpv4 { tcpv4; _ } = tcpv4 let udpv4 { udpv4; _ } = udpv4 let ipv4 { ipv4; _ } = ipv4 let listen_udpv4 t ~port callback = Udpv4.listen t.udpv4 ~port callback let listen_tcpv4 ?keepalive t ~port process = Tcpv4.listen t.tcpv4 ~port ?keepalive process let listen t = Lwt.catch (fun () -> Log.debug (fun f -> f "Establishing or updating listener for stack %a" pp t); let ethif_listener = Ethernet.input ~arpv4:(Arpv4.input t.arpv4) ~ipv4:( Ipv4.input ~tcp:(Tcpv4.input t.tcpv4) ~udp:(Udpv4.input t.udpv4) ~default:(fun ~proto ~src ~dst buf -> match proto with | 1 -> Icmpv4.input t.icmpv4 ~src ~dst buf | _ -> Lwt.return_unit) t.ipv4) ~ipv6:(fun _ -> Lwt.return_unit) t.ethif in Netif.listen t.netif ~header_size:Ethernet_wire.sizeof_ethernet ethif_listener >>= function | Error e -> Log.warn (fun p -> p "%a" Netif.pp_error e) ; (* XXX: error should be passed to the caller *) Lwt.return_unit | Ok _res -> let nstat = Netif.get_stats_counters t.netif in let open Mirage_net in Log.info (fun f -> f "listening loop of interface %s terminated regularly:@ %Lu bytes \ (%lu packets) received, %Lu bytes (%lu packets) sent@ " (Macaddr.to_string (Netif.mac t.netif)) nstat.rx_bytes nstat.rx_pkts nstat.tx_bytes nstat.tx_pkts) ; Lwt.return_unit) (function | Lwt.Canceled -> Log.info (fun f -> f "listen of %a cancelled" pp t); Lwt.return_unit | e -> Lwt.fail e) let connect netif ethif arpv4 ipv4 icmpv4 udpv4 tcpv4 = let t = { netif; ethif; arpv4; ipv4; icmpv4; tcpv4; udpv4; task = None } in Log.info (fun f -> f "stack assembled: %a" pp t); Lwt.async (fun () -> let task = listen t in t.task <- Some task; task); Lwt.return t let disconnect t = Log.info (fun f -> f "disconnect called: %a" pp t); (match t.task with None -> () | Some task -> Lwt.cancel task); Lwt.return_unit end module type UDPV6_DIRECT = Mirage_protocols.UDP with type ipaddr = Ipaddr.V6.t module type TCPV6_DIRECT = Mirage_protocols.TCP with type ipaddr = Ipaddr.V6.t module MakeV6 (Time : Mirage_time.S) (Random : Mirage_random.S) (Netif : Mirage_net.S) (Ethernet : Mirage_protocols.ETHERNET) (Ipv6 : Mirage_protocols.IP with type ipaddr = Ipaddr.V6.t) (Udpv6 : UDPV6_DIRECT) (Tcpv6 : TCPV6_DIRECT) = struct module UDP = Udpv6 module TCP = Tcpv6 module IP = Ipv6 type t = { netif : Netif.t; ethif : Ethernet.t; ipv6 : Ipv6.t; udpv6 : Udpv6.t; tcpv6 : Tcpv6.t; mutable task : unit Lwt.t option; } let pp fmt t = Format.fprintf fmt "mac=%a,ip=%a" Macaddr.pp (Ethernet.mac t.ethif) (Fmt.list Ipaddr.V6.pp) (Ipv6.get_ip t.ipv6) let tcp { tcpv6; _ } = tcpv6 let udp { udpv6; _ } = udpv6 let ip { ipv6; _ } = ipv6 let listen_udp t ~port callback = Udpv6.listen t.udpv6 ~port callback let listen_tcp ?keepalive t ~port process = Tcpv6.listen t.tcpv6 ~port ?keepalive process let listen t = Lwt.catch (fun () -> Log.debug (fun f -> f "Establishing or updating listener for stack %a" pp t); let ethif_listener = Ethernet.input ~arpv4:(fun _ -> Lwt.return_unit) ~ipv4:(fun _ -> Lwt.return_unit) ~ipv6:( Ipv6.input ~tcp:(Tcpv6.input t.tcpv6) ~udp:(Udpv6.input t.udpv6) ~default:(fun ~proto:_ ~src:_ ~dst:_ _ -> Lwt.return_unit) t.ipv6) t.ethif in Netif.listen t.netif ~header_size:Ethernet_wire.sizeof_ethernet ethif_listener >>= function | Error e -> Log.warn (fun p -> p "%a" Netif.pp_error e) ; (* XXX: error should be passed to the caller *) Lwt.return_unit | Ok _res -> let nstat = Netif.get_stats_counters t.netif in let open Mirage_net in Log.info (fun f -> f "listening loop of interface %s terminated regularly:@ %Lu bytes \ (%lu packets) received, %Lu bytes (%lu packets) sent@ " (Macaddr.to_string (Netif.mac t.netif)) nstat.rx_bytes nstat.rx_pkts nstat.tx_bytes nstat.tx_pkts) ; Lwt.return_unit) (function | Lwt.Canceled -> Log.info (fun f -> f "listen of %a cancelled" pp t); Lwt.return_unit | e -> Lwt.fail e) let connect netif ethif ipv6 udpv6 tcpv6 = let t = { netif; ethif; ipv6; tcpv6; udpv6; task = None } in Log.info (fun f -> f "stack assembled: %a" pp t); Lwt.async (fun () -> let task = listen t in t.task <- Some task; task); Lwt.return t let disconnect t = Log.info (fun f -> f "disconnect called: %a" pp t); (match t.task with None -> () | Some task -> Lwt.cancel task); Lwt.return_unit end module type UDPV4V6_DIRECT = Mirage_protocols.UDP with type ipaddr = Ipaddr.t module type TCPV4V6_DIRECT = Mirage_protocols.TCP with type ipaddr = Ipaddr.t module IPV4V6 (Ipv4 : Mirage_protocols.IPV4) (Ipv6 : Mirage_protocols.IPV6) = struct type ipaddr = Ipaddr.t type callback = src:ipaddr -> dst:ipaddr -> Cstruct.t -> unit Lwt.t let pp_ipaddr = Ipaddr.pp type error = [ Mirage_protocols.Ip.error | `Ipv4 of Ipv4.error | `Ipv6 of Ipv6.error | `Msg of string ] let pp_error ppf = function | #Mirage_protocols.Ip.error as e -> Mirage_protocols.Ip.pp_error ppf e | `Ipv4 e -> Ipv4.pp_error ppf e | `Ipv6 e -> Ipv6.pp_error ppf e | `Msg m -> Fmt.string ppf m type t = { ipv4 : Ipv4.t ; ipv4_only : bool ; ipv6 : Ipv6.t ; ipv6_only : bool } let connect ~ipv4_only ~ipv6_only ipv4 ipv6 = if ipv4_only && ipv6_only then Lwt.fail_with "cannot configure stack with both IPv4 only and IPv6 only" else Lwt.return { ipv4 ; ipv4_only ; ipv6 ; ipv6_only } let disconnect _ = Lwt.return_unit let input t ~tcp ~udp ~default = let tcp4 ~src ~dst payload = tcp ~src:(Ipaddr.V4 src) ~dst:(Ipaddr.V4 dst) payload and tcp6 ~src ~dst payload = tcp ~src:(Ipaddr.V6 src) ~dst:(Ipaddr.V6 dst) payload and udp4 ~src ~dst payload = udp ~src:(Ipaddr.V4 src) ~dst:(Ipaddr.V4 dst) payload and udp6 ~src ~dst payload = udp ~src:(Ipaddr.V6 src) ~dst:(Ipaddr.V6 dst) payload and default4 ~proto ~src ~dst payload = default ~proto ~src:(Ipaddr.V4 src) ~dst:(Ipaddr.V4 dst) payload and default6 ~proto ~src ~dst payload = default ~proto ~src:(Ipaddr.V6 src) ~dst:(Ipaddr.V6 dst) payload in fun buf -> if Cstruct.length buf >= 1 then let v = Cstruct.get_uint8 buf 0 lsr 4 in if v = 4 && not t.ipv6_only then Ipv4.input t.ipv4 ~tcp:tcp4 ~udp:udp4 ~default:default4 buf else if v = 6 && not t.ipv4_only then Ipv6.input t.ipv6 ~tcp:tcp6 ~udp:udp6 ~default:default6 buf else Lwt.return_unit else Lwt.return_unit let write t ?fragment ?ttl ?src dst proto ?size headerf bufs = match dst with | Ipaddr.V4 dst -> if not t.ipv6_only then match match src with | None -> Ok None | Some (Ipaddr.V4 src) -> Ok (Some src) | _ -> Error (`Msg "source must be V4 if dst is V4") with | Error e -> Lwt.return (Error e) | Ok src -> Ipv4.write t.ipv4 ?fragment ?ttl ?src dst proto ?size headerf bufs >|= function | Ok () -> Ok () | Error e -> Error (`Ipv4 e) else begin Log.warn (fun m -> m "attempted to write an IPv4 packet in a v6 only stack"); Lwt.return (Ok ()) end | Ipaddr.V6 dst -> if not t.ipv4_only then match match src with | None -> Ok None | Some (Ipaddr.V6 src) -> Ok (Some src) | _ -> Error (`Msg "source must be V6 if dst is V6") with | Error e -> Lwt.return (Error e) | Ok src -> Ipv6.write t.ipv6 ?fragment ?ttl ?src dst proto ?size headerf bufs >|= function | Ok () -> Ok () | Error e -> Error (`Ipv6 e) else begin Log.warn (fun m -> m "attempted to write an IPv6 packet in a v4 only stack"); Lwt.return (Ok ()) end let pseudoheader t ?src dst proto len = match dst with | Ipaddr.V4 dst -> let src = match src with | None -> None | Some (Ipaddr.V4 src) -> Some src | _ -> None (* cannot happen *) in Ipv4.pseudoheader t.ipv4 ?src dst proto len | Ipaddr.V6 dst -> let src = match src with | None -> None | Some (Ipaddr.V6 src) -> Some src | _ -> None (* cannot happen *) in Ipv6.pseudoheader t.ipv6 ?src dst proto len let src t ~dst = match dst with | Ipaddr.V4 dst -> Ipaddr.V4 (Ipv4.src t.ipv4 ~dst) | Ipaddr.V6 dst -> Ipaddr.V6 (Ipv6.src t.ipv6 ~dst) let get_ip t = List.map (fun ip -> Ipaddr.V4 ip) (Ipv4.get_ip t.ipv4) @ List.map (fun ip -> Ipaddr.V6 ip) (Ipv6.get_ip t.ipv6) let mtu t ~dst = match dst with | Ipaddr.V4 dst -> Ipv4.mtu t.ipv4 ~dst | Ipaddr.V6 dst -> Ipv6.mtu t.ipv6 ~dst end module MakeV4V6 (Time : Mirage_time.S) (Random : Mirage_random.S) (Netif : Mirage_net.S) (Ethernet : Mirage_protocols.ETHERNET) (Arpv4 : Mirage_protocols.ARP) (Ip : Mirage_protocols.IP with type ipaddr = Ipaddr.t) (Icmpv4 : Mirage_protocols.ICMP with type ipaddr = Ipaddr.V4.t) (Udp : UDPV4V6_DIRECT) (Tcp : TCPV4V6_DIRECT) = struct module UDP = Udp module TCP = Tcp module IP = Ip type t = { netif : Netif.t; ethif : Ethernet.t; arpv4 : Arpv4.t; icmpv4 : Icmpv4.t; ip : IP.t; udp : Udp.t; tcp : Tcp.t; mutable task : unit Lwt.t option; } let pp fmt t = Format.fprintf fmt "mac=%a,ip=%a" Macaddr.pp (Ethernet.mac t.ethif) (Fmt.list Ipaddr.pp) (IP.get_ip t.ip) let tcp { tcp; _ } = tcp let udp { udp; _ } = udp let ip { ip; _ } = ip let listen_udp t ~port callback = Udp.listen t.udp ~port callback let listen_tcp ?keepalive t ~port process = Tcp.listen t.tcp ~port ?keepalive process let listen t = Lwt.catch (fun () -> Log.debug (fun f -> f "Establishing or updating listener for stack %a" pp t); let tcp = Tcp.input t.tcp and udp = Udp.input t.udp and default ~proto ~src ~dst buf = match proto, src, dst with | 1, Ipaddr.V4 src, Ipaddr.V4 dst -> Icmpv4.input t.icmpv4 ~src ~dst buf | _ -> Lwt.return_unit in let ethif_listener = Ethernet.input ~arpv4:(Arpv4.input t.arpv4) ~ipv4:(IP.input ~tcp ~udp ~default t.ip) ~ipv6:(IP.input ~tcp ~udp ~default t.ip) t.ethif in Netif.listen t.netif ~header_size:Ethernet_wire.sizeof_ethernet ethif_listener >>= function | Error e -> Log.warn (fun p -> p "%a" Netif.pp_error e) ; (* XXX: error should be passed to the caller *) Lwt.return_unit | Ok _res -> let nstat = Netif.get_stats_counters t.netif in let open Mirage_net in Log.info (fun f -> f "listening loop of interface %s terminated regularly:@ %Lu bytes \ (%lu packets) received, %Lu bytes (%lu packets) sent@ " (Macaddr.to_string (Netif.mac t.netif)) nstat.rx_bytes nstat.rx_pkts nstat.tx_bytes nstat.tx_pkts) ; Lwt.return_unit) (function | Lwt.Canceled -> Log.info (fun f -> f "listen of %a cancelled" pp t); Lwt.return_unit | e -> Lwt.fail e) let connect netif ethif arpv4 ip icmpv4 udp tcp = let t = { netif; ethif; arpv4; ip; icmpv4; tcp; udp; task = None } in Log.info (fun f -> f "stack assembled: %a" pp t); Lwt.async (fun () -> let task = listen t in t.task <- Some task; task); Lwt.return t let disconnect t = Log.info (fun f -> f "disconnect called: %a" pp t); (match t.task with None -> () | Some task -> Lwt.cancel task); Lwt.return_unit end
sectionYPositions = computeSectionYPositions($el), 10)"
x-init="setTimeout(() => sectionYPositions = computeSectionYPositions($el), 10)"
>