vmm: Add a virtual networking layer
[akaros.git] / user / vmm / nat.c
1 /* Copyright (c) 2016 Google Inc
2  * Barret Rhoden <brho@cs.berkeley.edu>
3  * See LICENSE for details.
4  *
5  * Network address translation for VM guests.
6  *
7  * There are two styles of addressing: qemu and real-addr.  qemu-style is what
8  * you expect from Qemu's user-mode networking.  real-addr mode uses the same
9  * addresses for the guest as the host uses.
10  *
11  * For qemu-style networking:
12  *              guest = 10.0.2.15, mask = 255.255.255.0, router = 10.0.2.2.
13  * For real-addr networking:
14  *              guest = host_v4, mask = host_mask, router = host's_route
15  *
16  * Real-addr mode is useful for guests that statically config their address from
17  * the nodes hard drive.  It might also help for apps that want to advertise
18  * their IP address to external users (though that would require straight-thru
19  * port-fowardarding set up by the VMM).
20  *
21  * As far as the guest is concerned, the host is the guest_v4_router.  If we
22  * ever get a remote IP addr of 'router', that'll be redirected to the host's
23  * loopback IP.  That means the guest can't reach the "real" router (in
24  * real-addr mode).  The host can reach the guest via 127.0.0.1.  In either
25  * case, use the host's side of a mapping.
26  *
27  * TODO:
28  * - We're working with the IOVs that the guest gave us through virtio.  If we
29  *   care, that whole thing is susceptible to time-of-check attacks.  The guest
30  *   could be modifying the IOV that we're working on, so we need to not care
31  *   too much about that.
32  *
33  * - Consider having the kernel proto bypass outbound path overwrite the src
34  *   address and the proto port.  We don't care about the proto payload.  We
35  *   might care about IP and proto headers.  o/w, the user could fake traffic
36  *   for other ports - basically they can craft whatever packet they want (which
37  *   is what they had previously with unrestricted access to devether).
38  *
39  * - Consider injecting packets to the guest from #srv/snoop-PID.
40  *
41  * - IPv6 support
42  *
43  * FAQ:
44  * - Why are we using FD taps, instead of threads, to watch all the host FD?
45  *   Couldn't we block a uthread on each FD?  I went back and forth on this.
46  *   The final reason for this is to avoid copies and weird joins.  The
47  *   concurrency with the guest is based on the number of IOVs they give us -
48  *   not the number of host conversations open.  We could listen on 1000 convs,
49  *   each with their own read buffer, but we'd then have to copy the entire
50  *   packet into the IOVs the guest gave us.  We'd also need to synchronize on
51  *   access to virtio and do some structural work (draw out how the packets
52  *   would move around).  It'd be different if each uthread could just push
53  *   packets into virtio-net (push vs the current pull model).
54  *
55  * - What's the deal with sending packets to broadcast domain targets?  Short
56  *   answer: the host responds to every ARP request, regardless of the IP.  If
57  *   the networking is done QEMU style, there's only one other host: the router,
58  *   so that's not interesting.  If we are in real-addr mode and the guest is
59  *   trying to reach someone in our broadcast, they'll be told that we
60  *   (host_eth_addr) is the MAC for that addr.  Then the guest sends us an IP
61  *   packet for that target.  Akaros will see an IP packet and will route it to
62  *   its own broadcast (on the real network).  The guest's ARP only matters when
63  *   it comes to getting the packet to us, not the actual network's broadcast
64  *   domain.
65  *
66  * - Why is the RX path single threaded?  So it's possible to rewrite
67  *   __poll_inbound() such that readv() is not called while holding the rx_mtx.
68  *   To do so, we pop the first item off the inbound_todo list (so we have the
69  *   ref), do the read, then put it back on the list if it hasn't been drained
70  *   to empty.  The main issue, apart from being more complicated, is that since
71  *   we're unlocking and relocking, any invariant that we had before calling
72  *   __poll_inbound needs to be rechecked.  Specifically, we would need to check
73  *   __poll_injection *after* returning from __poll_inbound.  Otherwise we could
74  *   sleep with a packet waiting to be injected.  Whoops!  That could have been
75  *   dealt with, but it's subtle.  There also might be races with FD taps
76  *   firing, the fdtap_watcher not putting items on the list, and the thread
77  *   then not putting it on the list.  Specifically:
78  *      fdtap_watcher:                                                  __poll_inbound:
79  *      -------------------------------------------------------
80  *                                                                                      yanks map off list
81  *                                                                                      map tracked as "on inbound"
82  *                                                                                      unlock mtx
83  *                                                                                      readv, get -1 EAGAIN
84  *                                                                                      decide to drop the item
85  *      packet arrives
86  *      FD tap fires
87  *      send event
88  *      lock mtx
89  *      see map is "on inbound"
90  *      ignore event
91  *      unlock mtx
92  *                                                                                      lock mtx
93  *                                                                                      clear "on inbound"
94  *                                                                                      unlock + sleep on CV
95  *   The FD has data, but we lost the event, and we'll never read it.
96  *
97  * - Why is the fdtap_watcher its own thread?  You can't kick a CV from vcore
98  *   context, since you almost always want to hold the MTX while kicking the CV
99  *   (see the lengthy comments in the CV code).  It's easier to blockon an event
100  *   queue as a uthread.  But since the RX thread wants to sleep on two sources,
101  *   it's simpler this way.  It also decouples the inbound_todo list from the
102  *   evq.
103  *
104  * - Could we model the packet injection with an event queue?  Maybe with a UCQ
105  *   or BCQ.  We'd need some support from the kernel (minor) and maybe
106  *   user-level event posting (major) to do it right.  If we did that, we
107  *   probably could get rid of the fdtap_watcher.  The RX checks inbound_todo,
108  *   then blocks on two evqs (inbound and inject).  This way is simpler, for
109  *   now.
110  *
111  * - Why do we rewrite IP addresses for the router to loopback, instead of
112  *   host_v4_addr?  First off, you have to pick one: loopback or host_v4_addr,
113  *   not both.  If we accept both (say, when the host connects to a static map),
114  *   then on the other end (i.e. TX, response to an RX) will need to know which
115  *   option we chose for its rewriting rule.  We have to be consistent with how
116  *   we handle ROUTER_IP and do the same thing in both directions.  Given that
117  *   we have to pick one of them, I opted for 127.0.0.1.  That way, any host
118  *   users know how to connect to the guest without worrying about their actual
119  *   IP address.  This also allows us to announce services on the host that are
120  *   only available to loopback (i.e. not the main network) and let the guest
121  *   reach those.
122  *
123  * - How can a guest reach the real host IP in qemu mode, but not in real-addr
124  *   mode?  This comes up when someone uses a static map but connects with the
125  *   host_v4_addr as the source (which you do by contacting host_v4_addr as the
126  *   *destination* from akaros).  We don't rewrite those on the RX path.  When
127  *   the guest responds, it responds to whatever the src was on the inbound
128  *   path.  To the guest, our host_v4_addr is just another IP, which the host
129  *   knows how to route to.  It'd be similar to the guest trying to reach an
130  *   address that is in the broadcast domain of the host.  This doesn't work for
131  *   real-addr mode, since the guest has the same IP as the host.  Most guests
132  *   won't emit a packet that is sent to their own IP address.  If they did, the
133  *   NAT code would remap it, but the guest just won't send it out.  Hence the
134  *   warning.
135  */
136
137 #include <vmm/net.h>
138 #include <parlib/iovec.h>
139 #include <iplib/iplib.h>
140 #include <parlib/ros_debug.h>
141 #include <parlib/uthread.h>
142 #include <ndblib/ndb.h>
143 #include <iplib/iplib.h>
144 #include <parlib/printf-ext.h>
145 #include <parlib/event.h>
146 #include <parlib/spinlock.h>
147 #include <parlib/kref.h>
148
149 #include <stdlib.h>
150 #include <stdio.h>
151 #include <string.h>
152 #include <unistd.h>
153 #include <assert.h>
154 #include <sys/types.h>
155 #include <sys/stat.h>
156 #include <fcntl.h>
157 #include <sys/queue.h>
158
159 /* Global control variables.  The main VMM sets these manually. */
160 bool vnet_snoop = FALSE;
161 bool vnet_real_ip_addrs = FALSE;
162 bool vnet_map_diagnostics = FALSE;
163 unsigned long vnet_nat_timeout = 200;
164
165 uint8_t host_v4_addr[IPV4_ADDR_LEN];
166 uint8_t host_v4_mask[IPV4_ADDR_LEN];
167 uint8_t host_v4_router[IPV4_ADDR_LEN];
168 uint8_t host_v4_dns[IPV4_ADDR_LEN];
169
170 uint8_t loopback_v4_addr[IPV4_ADDR_LEN];
171 uint8_t bcast_v4_addr[IPV4_ADDR_LEN];
172
173 uint8_t guest_v4_addr[IPV4_ADDR_LEN];
174 uint8_t guest_v4_mask[IPV4_ADDR_LEN];
175 uint8_t guest_v4_router[IPV4_ADDR_LEN];
176 uint8_t guest_v4_dns[IPV4_ADDR_LEN];
177
178 /* We'll use this in all our eth headers with the guest. */
179 uint8_t host_eth_addr[] = {0x00, 0x01, 0x02, 0x03, 0x04, 0x0a};
180 uint8_t guest_eth_addr[] = {0x00, 0x01, 0x02, 0x03, 0x04, 0x0b};
181 const char dhcp_hostname[] = "host";
182 const char dhcp_guestname[] = "guest";
183
184 int snoop_fd;
185
186 /* We map between host port and guest port for a given protocol.  We don't care
187  * about confirming IP addresses or anything - we just swap ports. */
188 struct ip_nat_map {
189         TAILQ_ENTRY(ip_nat_map)         lookup_tuple;
190         TAILQ_ENTRY(ip_nat_map)         lookup_fd;
191         struct kref                                     kref;
192         uint8_t                                         protocol;
193         uint16_t                                        guest_port;
194         uint16_t                                        host_port;
195         int                                                     host_data_fd;
196         bool                                            is_static;
197         bool                                            is_stale;
198         /* These fields are protected by the rx mutex */
199         TAILQ_ENTRY(ip_nat_map)         inbound;
200         bool                                            is_on_inbound;
201 };
202
203 #define NR_VNET_HASH 128
204 TAILQ_HEAD(ip_nat_map_tailq, ip_nat_map);
205 struct spin_pdr_lock maps_lock = SPINPDR_INITIALIZER;
206 /* Two hash tables: one for tuples (tx) and one for FD (rx).  There's one kref
207  * for being in both tables; they are treated as a unit. */
208 struct ip_nat_map_tailq map_hash_tuple[NR_VNET_HASH];
209 struct ip_nat_map_tailq map_hash_fd[NR_VNET_HASH];
210
211 /* The todo list, used to track FDs that had activity but haven't told us EAGAIN
212  * yet.  The list is protected by the rx_mtx */
213 struct ip_nat_map_tailq inbound_todo = TAILQ_HEAD_INITIALIZER(inbound_todo);
214
215 /* buf_pkt: tracks a packet, used for injecting packets (usually synthetic
216  * responses) into the guest via receive_packet. */
217 struct buf_pkt {
218         STAILQ_ENTRY(buf_pkt)           next;
219         uint8_t                                         *buf;
220         size_t                                          sz;
221 };
222 STAILQ_HEAD(buf_pkt_stailq, buf_pkt);
223
224 struct buf_pkt_stailq inject_pkts = STAILQ_HEAD_INITIALIZER(inject_pkts);
225 uth_mutex_t rx_mtx;
226 uth_cond_var_t rx_cv;
227 struct event_queue *inbound_evq;
228
229 static void tap_inbound_conv(int fd);
230
231 #define GOLDEN_RATIO_64 0x61C8864680B583EBull
232
233 static struct ip_nat_map_tailq *list_hash_tuple(uint8_t protocol,
234                                                 uint16_t guest_port)
235 {
236         size_t idx;
237
238         idx = ((protocol << 16 | guest_port) * GOLDEN_RATIO_64) % NR_VNET_HASH;
239         return &map_hash_tuple[idx];
240 }
241
242 static struct ip_nat_map_tailq *list_hash_fd(int host_data_fd)
243 {
244         size_t idx;
245
246         idx = (host_data_fd * GOLDEN_RATIO_64) % NR_VNET_HASH;
247         return &map_hash_fd[idx];
248 }
249
250 /* Returnes a refcnted map. */
251 static struct ip_nat_map *lookup_map_by_tuple(uint8_t protocol,
252                                               uint16_t guest_port)
253 {
254         struct ip_nat_map *i;
255
256         spin_pdr_lock(&maps_lock);
257         TAILQ_FOREACH(i, list_hash_tuple(protocol, guest_port), lookup_tuple) {
258                 if ((i->protocol == protocol) && (i->guest_port == guest_port)) {
259                         kref_get(&i->kref, 1);
260                         break;
261                 }
262         }
263         spin_pdr_unlock(&maps_lock);
264         return i;
265 }
266
267 static struct ip_nat_map *lookup_map_by_hostfd(int host_data_fd)
268 {
269         struct ip_nat_map *i;
270
271         spin_pdr_lock(&maps_lock);
272         TAILQ_FOREACH(i, list_hash_fd(host_data_fd), lookup_fd) {
273                 if (i->host_data_fd == host_data_fd) {
274                         kref_get(&i->kref, 1);
275                         break;
276                 }
277         }
278         spin_pdr_unlock(&maps_lock);
279         return i;
280 }
281
282 /* Stores the ref to the map in the global lookup 'table.' */
283 static void add_map(struct ip_nat_map *map)
284 {
285         spin_pdr_lock(&maps_lock);
286         TAILQ_INSERT_HEAD(list_hash_tuple(map->protocol, map->guest_port),
287                           map, lookup_tuple);
288         TAILQ_INSERT_HEAD(list_hash_fd(map->host_data_fd), map, lookup_fd);
289         spin_pdr_unlock(&maps_lock);
290 }
291
292 static void map_release(struct kref *kref)
293 {
294         struct ip_nat_map *map = container_of(kref, struct ip_nat_map, kref);
295
296         close(map->host_data_fd);
297         free(map);
298 }
299
300 /* Creates a reference counted ip_nat_map for protocol between guest_port and
301  * host_port.  Static mappings are ones that never expire, such as a port
302  * forwarding.  Caller should add it to the lookup structure.
303  *
304  * For the host port, pass "*" for any port, like in a dialstring. */
305 static struct ip_nat_map *create_map(uint8_t protocol, uint16_t guest_port,
306                                      char *host_port, bool is_static)
307 {
308         struct ip_nat_map *map;
309         char dialstring[128];
310         char conv_dir[NETPATHLEN];
311         char *proto_str;
312         int bypass_fd;
313         bool port_check;
314
315         map = malloc(sizeof(struct ip_nat_map));
316         assert(map);
317         kref_init(&map->kref, map_release, 1);
318         map->protocol = protocol;
319         map->guest_port = guest_port;
320         map->is_static = is_static;
321         map->is_stale = FALSE;
322         map->is_on_inbound = FALSE;
323
324         switch (protocol) {
325         case IP_UDPPROTO:
326                 proto_str = "udp";
327                 break;
328         case IP_TCPPROTO:
329                 proto_str = "tcp";
330                 break;
331         default:
332                 panic("get_map for unsupported protocol %d!", protocol);
333         }
334         snprintf(dialstring, sizeof(dialstring), "%s!*!%s", proto_str, host_port);
335
336         bypass_fd = bypass9(dialstring, conv_dir, 0);
337         parlib_assert_perror(bypass_fd >= 0);
338
339         port_check = get_port9(conv_dir, "local", &map->host_port);
340         parlib_assert_perror(port_check);
341
342         map->host_data_fd = open_data_fd9(conv_dir, O_NONBLOCK);
343         parlib_assert_perror(map->host_data_fd >= 0);
344
345         tap_inbound_conv(map->host_data_fd);
346
347         close(bypass_fd);
348         return map;
349 }
350
351 /* Looks up or creates an ip_nat_map for the given proto/port tuple. */
352 static struct ip_nat_map *get_map_by_tuple(uint8_t protocol,
353                                            uint16_t guest_port)
354 {
355         struct ip_nat_map *map;
356
357         map = lookup_map_by_tuple(protocol, guest_port);
358         if (map)
359                 return map;
360         map = create_map(protocol, guest_port, "*", FALSE);
361         kref_get(&map->kref, 1);
362         add_map(map);
363         return map;
364 }
365
366 static void map_reaper(void *arg)
367 {
368         struct ip_nat_map *i, *temp;
369         struct ip_nat_map_tailq to_release;
370
371         while (1) {
372                 uthread_sleep(vnet_nat_timeout);
373                 TAILQ_INIT(&to_release);
374                 spin_pdr_lock(&maps_lock);
375                 /* Only need to scan one map_hash, might as well be the tuple */
376                 for (int j = 0; j < NR_VNET_HASH; j++) {
377                         TAILQ_FOREACH_SAFE(i, &map_hash_tuple[j], lookup_tuple, temp) {
378                                 if (i->is_static)
379                                         continue;
380                                 if (!i->is_stale) {
381                                         i->is_stale = TRUE;
382                                         continue;
383                                 }
384                                 /* Remove from both lists, hashing for the FD list */
385                                 TAILQ_REMOVE(&map_hash_tuple[j], i, lookup_tuple);
386                                 TAILQ_REMOVE(list_hash_fd(i->host_data_fd), i, lookup_fd);
387                                 /* Use the lookup_tuple for the temp list */
388                                 TAILQ_INSERT_HEAD(&to_release, i, lookup_tuple);
389                         }
390                 }
391                 spin_pdr_unlock(&maps_lock);
392                 TAILQ_FOREACH_SAFE(i, &to_release, lookup_tuple, temp)
393                         kref_put(&i->kref);
394         }
395 }
396
397 static void map_dumper(void)
398 {
399         struct ip_nat_map *i;
400
401         fprintf(stderr, "\n\nVNET NAT maps:\n---------------\n");
402         spin_pdr_lock(&maps_lock);
403         for (int j = 0; j < NR_VNET_HASH; j++) {
404                 TAILQ_FOREACH(i, &map_hash_tuple[j], lookup_tuple) {
405                         fprintf(stderr, "\tproto %2d, host %5d, guest %5d, FD %4d, stale %d, static %d, ref %d\n",
406                                 i->protocol, i->host_port, i->guest_port, i->host_data_fd,
407                                 i->is_stale, i->is_static, i->kref.refcnt);
408                 }
409         }
410         spin_pdr_unlock(&maps_lock);
411 }
412
413 static void init_map_lookup(struct virtual_machine *vm)
414 {
415         for (int i = 0; i < NR_VNET_HASH; i++)
416                 TAILQ_INIT(&map_hash_tuple[i]);
417         for (int i = 0; i < NR_VNET_HASH; i++)
418                 TAILQ_INIT(&map_hash_fd[i]);
419         vmm_run_task(vm, map_reaper, NULL);
420 }
421
422 static struct buf_pkt *zalloc_bpkt(size_t size)
423 {
424         struct buf_pkt *bpkt;
425
426         bpkt = malloc(sizeof(struct buf_pkt));
427         assert(bpkt);
428         bpkt->sz = size;
429         bpkt->buf = malloc(bpkt->sz);
430         assert(bpkt->buf);
431         memset(bpkt->buf, 0, bpkt->sz);
432         return bpkt;
433 }
434
435 static void free_bpkt(struct buf_pkt *bpkt)
436 {
437         free(bpkt->buf);
438         free(bpkt);
439 }
440
441 /* Queues a buf_pkt, which the rx thread will inject when it wakes. */
442 static void inject_buf_pkt(struct buf_pkt *bpkt)
443 {
444         uth_mutex_lock(rx_mtx);
445         STAILQ_INSERT_TAIL(&inject_pkts, bpkt, next);
446         uth_mutex_unlock(rx_mtx);
447         uth_cond_var_broadcast(rx_cv);
448 }
449
450 /* Helper for xsum_update, mostly for paranoia with integer promotion and
451  * cleanly keeping variables as u16. */
452 static uint16_t ones_comp(uint16_t x)
453 {
454         return ~x;
455 }
456
457 /* IP checksum updater.  If you change amt bytes in a packet from old to new,
458  * this updates the xsum at xsum_off in the iov.
459  *
460  * Assumes a few things:
461  * - there's a 16 byte xsum at xsum_off
462  * - amt is a multiple of two
463  * - the data at *old and *new is network (big) endian
464  *
465  * There's no assumption about the alignment of old and new, thanks to Plan 9's
466  * sensible nhgets() (just byte accesses, not assuming u16 alignment).
467  *
468  * See RFC 1624 for the math.  I opted for Eqn 3, instead of 4, since I didn't
469  * want to deal with subtraction underflow / carry / etc.  Also note that we
470  * need to do the intermediate carry before doing the one's comp.  That wasn't
471  * clear from the RFC either.  RFC 1141 didn't need to do that, since they
472  * didn't complement the intermediate HC (xsum). */
473 static void xsum_update(struct iovec *iov, int iovcnt, size_t xsum_off,
474                         uint8_t *old, uint8_t *new, size_t amt)
475 {
476         uint32_t xsum;
477
478         assert(amt % 2 == 0);
479         xsum = iov_get_be16(iov, iovcnt, xsum_off);
480         /* for each short: HC' = ~(~HC + ~m + m') (' == new, ~ == ones-comp) */
481         for (int i = 0; i < amt / 2; i++, old += 2, new += 2) {
482                 xsum = ones_comp(xsum) + ones_comp(nhgets(old)) + nhgets(new);
483                 /* Need to deal with the carry for any additions, before the outer ~()
484                  * operation.  (Not mentioned in the RFC, determined manually...) */
485                 while (xsum >> 16)
486                         xsum = (xsum & 0xffff) + (xsum >> 16);
487                 /* Yes, next time around the loop we ones comp right back.  Not worth
488                  * optimizing. */
489                 xsum = ones_comp(xsum);
490         }
491         iov_put_be16(iov, iovcnt, xsum_off, xsum);
492 }
493
494 static void snoop_on_virtio(void)
495 {
496         int ret;
497         int srv_fd, pipe_dir_fd, pipe_ctl_fd, pipe_srv_fd, pipe_snoop_fd;
498         const char cmd[] = "oneblock";
499         char buf[MAX_PATH_LEN];
500
501         pipe_dir_fd = open("#pipe", O_PATH);
502         parlib_assert_perror(pipe_dir_fd >= 0);
503
504         pipe_ctl_fd = openat(pipe_dir_fd, "ctl", O_RDWR);
505         parlib_assert_perror(pipe_ctl_fd >= 0);
506         ret = write(pipe_ctl_fd, cmd, sizeof(cmd));
507         parlib_assert_perror(ret == sizeof(cmd));
508         close(pipe_ctl_fd);
509
510         pipe_snoop_fd = openat(pipe_dir_fd, "data", O_RDWR);
511         parlib_assert_perror(pipe_snoop_fd >= 0);
512         ret = fcntl(pipe_snoop_fd, F_SETFL, O_NONBLOCK);
513         parlib_assert_perror(!ret);
514         snoop_fd = pipe_snoop_fd;
515
516         pipe_srv_fd = openat(pipe_dir_fd, "data1", O_RDWR);
517         parlib_assert_perror(pipe_srv_fd >= 0);
518         ret = snprintf(buf, sizeof(buf), "#srv/%s-%d", "snoop", getpid());
519         /* We don't close srv_fd here.  When we exit, it'll close and remove. */
520         srv_fd = open(buf, O_RDWR | O_EXCL | O_CREAT | O_REMCLO, 0444);
521         parlib_assert_perror(srv_fd >= 0);
522         ret = snprintf(buf, sizeof(buf), "%d", pipe_srv_fd);
523         ret = write(srv_fd, buf, ret);
524         parlib_assert_perror(ret > 0);
525         close(pipe_srv_fd);
526 }
527
528 /* Gets the host's IPv4 information from iplib and ndb. */
529 static void get_host_ip_addrs(void)
530 {
531         struct ndb *ndb;
532         struct ndbtuple *nt;
533         char *dns = "dns";
534         char my_ip_str[40];
535         char buf[128];
536         struct ipifc *to_free;
537         struct iplifc *lifc;
538         int ret;
539         uint8_t router_ip[IPaddrlen];
540
541         register_printf_specifier('i', printf_ipaddr, printf_ipaddr_info);
542         register_printf_specifier('M', printf_ipmask, printf_ipmask_info);
543
544         lifc = get_first_noloop_iplifc(NULL, &to_free);
545         parlib_assert_perror(lifc);
546         snprintf(my_ip_str, sizeof(my_ip_str), "%i", lifc->ip);
547         snprintf(buf, sizeof(buf), "%i%M", lifc->ip, lifc->mask);
548         v4parsecidr(host_v4_addr, host_v4_mask, buf);
549         free_ipifc(to_free);
550
551         ret = my_router_addr(router_ip, NULL);
552         parlib_assert_perror(!ret);
553         v6tov4(host_v4_router, router_ip);
554
555         ndb = ndbopen("/net/ndb");
556         parlib_assert_perror(ndb);
557         nt = ndbipinfo(ndb, "ip", my_ip_str, &dns, 1);
558         assert(nt);
559         v4parseip(host_v4_dns, nt->val);
560         ndbfree(nt);
561         ndbclose(ndb);
562 }
563
564 static void set_ip_addrs(void)
565 {
566         get_host_ip_addrs();
567
568         loopback_v4_addr[0] = 127;
569         loopback_v4_addr[1] = 0;
570         loopback_v4_addr[2] = 0;
571         loopback_v4_addr[3] = 1;
572
573         bcast_v4_addr[0] = 255;
574         bcast_v4_addr[1] = 255;
575         bcast_v4_addr[2] = 255;
576         bcast_v4_addr[3] = 255;
577
578         /* even in qemu mode, the guest gets the real DNS IP */
579         memcpy(guest_v4_dns, host_v4_dns, IPV4_ADDR_LEN);
580
581         if (vnet_real_ip_addrs) {
582                 memcpy(guest_v4_addr, host_v4_addr, IPV4_ADDR_LEN);
583                 memcpy(guest_v4_mask, host_v4_mask, IPV4_ADDR_LEN);
584                 memcpy(guest_v4_router, host_v4_router, IPV4_ADDR_LEN);
585         } else {
586                 guest_v4_addr[0] = 10;
587                 guest_v4_addr[1] = 0;
588                 guest_v4_addr[2] = 2;
589                 guest_v4_addr[3] = 15;
590
591                 guest_v4_mask[0] = 255;
592                 guest_v4_mask[1] = 255;
593                 guest_v4_mask[2] = 255;
594                 guest_v4_mask[3] = 0;
595
596                 guest_v4_router[0] = 10;
597                 guest_v4_router[1] = 0;
598                 guest_v4_router[2] = 2;
599                 guest_v4_router[3] = 2;
600         }
601 }
602
603 static void tap_inbound_conv(int fd)
604 {
605         struct fd_tap_req tap_req = {0};
606         int ret;
607
608         tap_req.fd = fd;
609         tap_req.cmd = FDTAP_CMD_ADD;
610         tap_req.filter = FDTAP_FILT_READABLE;
611         tap_req.ev_q = inbound_evq;
612         tap_req.ev_id = fd;
613         tap_req.data = NULL;
614         ret = sys_tap_fds(&tap_req, 1);
615         parlib_assert_perror(ret == 1);
616 }
617
618 /* For every FD tap that fires, make sure the map is on the inbound_todo list
619  * and kick the receiver.
620  *
621  * A map who's FD fires might already be on the list - it's possible for an FD
622  * to drain to 0 and get another packet (thus triggering a tap) before
623  * __poll_inbound() notices and removes it from the list. */
624 static void fdtap_watcher(void *arg)
625 {
626         struct event_msg msg[1];
627         struct ip_nat_map *map;
628
629         while (1) {
630                 uth_blockon_evqs(msg, NULL, 1, inbound_evq);
631                 map = lookup_map_by_hostfd(msg->ev_type);
632                 /* Could get an event for an FD/map that has since been reaped. */
633                 if (!map)
634                         continue;
635                 uth_mutex_lock(rx_mtx);
636                 if (!map->is_on_inbound) {
637                         map->is_on_inbound = TRUE;
638                         TAILQ_INSERT_TAIL(&inbound_todo, map, inbound);
639                         uth_cond_var_broadcast(rx_cv);
640                 } else {
641                         kref_put(&map->kref);
642                 }
643                 uth_mutex_unlock(rx_mtx);
644         }
645 }
646
647 static struct event_queue *get_inbound_evq(void)
648 {
649         struct event_queue *ceq;
650
651         ceq = get_eventq_raw();
652         ceq->ev_mbox->type = EV_MBOX_CEQ;
653         ceq_init(&ceq->ev_mbox->ceq, CEQ_OR, NR_FILE_DESC_MAX, 128);
654         /* As far as flags go, we might not want IPI in the future.  Depends on some
655          * longer range VMM/2LS changes.  Regarding INDIR, if you want to find out
656          * about the event (i.e. not poll) for non-VCPD mboxes (like this evq's
657          * mbox), then you need INDIR.  We need that for the wakeup/blockon. */
658         ceq->ev_flags = EVENT_INDIR | EVENT_SPAM_INDIR | EVENT_WAKEUP | EVENT_IPI;
659         evq_attach_wakeup_ctlr(ceq);
660         return ceq;
661 }
662
663 void vnet_port_forward(char *protocol, char *host_port, char *guest_port)
664 {
665         struct ip_nat_map *map;
666         uint8_t proto_nr;
667
668         if (!strcmp("udp", protocol)) {
669                 proto_nr = IP_UDPPROTO;
670         } else if (!strcmp("tcp", protocol)) {
671                 proto_nr = IP_TCPPROTO;
672         } else {
673                 fprintf(stderr, "Can't port forward protocol %s\n", protocol);
674                 return;
675         }
676         map = create_map(proto_nr, atoi(guest_port), host_port, TRUE);
677         add_map(map);
678 }
679
680 static void ev_handle_diag(struct event_msg *ev_msg, unsigned int ev_type,
681                            void *data)
682 {
683         map_dumper();
684 }
685
686 void vnet_init(struct virtual_machine *vm, struct virtio_vq_dev *vqdev)
687 {
688         set_ip_addrs();
689         virtio_net_set_mac(vqdev, guest_eth_addr);
690         rx_mtx = uth_mutex_alloc();
691         rx_cv = uth_cond_var_alloc();
692         if (vnet_snoop)
693                 snoop_on_virtio();
694         init_map_lookup(vm);
695         inbound_evq = get_inbound_evq();
696         vmm_run_task(vm, fdtap_watcher, NULL);
697         if (vnet_map_diagnostics)
698                 register_ev_handler(EV_FREE_APPLE_PIE, ev_handle_diag, NULL);
699 }
700
701 /* Good DHCP reference:
702  * http://www.tcpipguide.com/free/t_TCPIPDynamicHostConfigurationProtocolDHCP.htm
703  */
704 #define DHCP_MAX_OPT_LEN 200
705 #define DHCP_MAIN_BODY_LEN 236
706 #define DHCP_RSP_LEN (DHCP_MAIN_BODY_LEN + DHCP_MAX_OPT_LEN)
707 #define DHCP_LEASE_TIME 3600
708
709 #define DHCP_OP_REQ                             1
710 #define DHCP_OP_RSP                             2
711
712 #define DHCP_MSG_DISCOVER               1
713 #define DHCP_MSG_OFFER                  2
714 #define DHCP_MSG_REQUEST                3
715 #define DHCP_MSG_DECLINE                4
716 #define DHCP_MSG_ACK                    5
717 #define DHCP_MSG_NAK                    6
718 #define DHCP_MSG_RELEASE                7
719 #define DHCP_MSG_INFORM                 8
720
721 #define DHCP_MAGIC_COOKIE_1             0x63
722 #define DHCP_MAGIC_COOKIE_2             0x82
723 #define DHCP_MAGIC_COOKIE_3             0x53
724 #define DHCP_MAGIC_COOKIE_4             0x63
725
726 #define DHCP_OPT_PAD                    0
727 #define DHCP_OPT_SUBNET                 1
728 #define DHCP_OPT_ROUTER                 3
729 #define DHCP_OPT_DNS                    6
730 #define DHCP_OPT_HOSTNAME               12
731 #define DHCP_OPT_LEASE                  51
732 #define DHCP_OPT_MSG_TYPE               53
733 #define DHCP_OPT_SERVER_ID              54
734 #define DHCP_OPT_END_OF_OPT             255
735
736 static int get_dhcp_req_type(struct iovec *iov, int iovcnt)
737 {
738         size_t idx = ETH_HDR_LEN + IPV4_HDR_LEN + UDP_HDR_LEN + DHCP_MAIN_BODY_LEN;
739
740         if (!iov_has_bytes(iov, iovcnt, idx + 4)) {
741                 fprintf(stderr, "DHCP request too short!\n");
742                 return -1;
743         }
744         /* Sanity checks */
745         if ((iov_get_byte(iov, iovcnt, idx + 0) != DHCP_MAGIC_COOKIE_1) ||
746             (iov_get_byte(iov, iovcnt, idx + 1) != DHCP_MAGIC_COOKIE_2) ||
747             (iov_get_byte(iov, iovcnt, idx + 2) != DHCP_MAGIC_COOKIE_3) ||
748             (iov_get_byte(iov, iovcnt, idx + 3) != DHCP_MAGIC_COOKIE_4)) {
749                 fprintf(stderr, "DHCP request didn't have magic cookie!\n");
750                 return -1;
751         }
752         /* Some clients might ask us to look in sname or other locations, which is
753          * communicated by an option.  So far, the clients I've seen just use the
754          * main options to communicate the message type. */
755         idx += 4;
756         while (1) {
757                 if (!iov_has_bytes(iov, iovcnt, idx + 1)) {
758                         fprintf(stderr, "DHCP request too short!\n");
759                         return -1;
760                 }
761                 switch (iov_get_byte(iov, iovcnt, idx)) {
762                 case DHCP_OPT_MSG_TYPE:
763                         if (!iov_has_bytes(iov, iovcnt, idx + 3)) {
764                                 fprintf(stderr, "DHCP request too short!\n");
765                                 return -1;
766                         }
767                         return iov_get_byte(iov, iovcnt, idx + 2);
768                 case DHCP_OPT_PAD:
769                         idx += 1;
770                         break;
771                 case DHCP_OPT_END_OF_OPT:
772                         fprintf(stderr, "DHCP request without a type!\n");
773                         return -1;
774                 default:
775                         if (!iov_has_bytes(iov, iovcnt, idx + 2)) {
776                                 fprintf(stderr, "DHCP request too short!\n");
777                                 return -1;
778                         }
779                         /* idx + 1 is size of the payload.  Skip the opt, size, payload. */
780                         idx += 2 + iov_get_byte(iov, iovcnt, idx + 1);
781                         break;
782                 }
783         }
784 }
785
786 static size_t build_dhcp_response(struct iovec *iov, int iovcnt, uint8_t *buf)
787 {
788         uint8_t *p = buf;
789         int req_type;
790
791         *p++ = DHCP_OP_RSP;
792         *p++ = ETH_HTYPE_ETH;
793         *p++ = ETH_ADDR_LEN;
794         *p++ = 0x00;    /* hops */
795         /* TODO: copies XID; assumes the inbound packet had standard headers */
796         iov_memcpy_from(iov, iovcnt, ETH_HDR_LEN + IPV4_HDR_LEN + UDP_HDR_LEN + 4,
797                         p, 4);
798         p += 4;
799         p += 8;                 /* secs, flags, CIADDR */
800         memcpy(p, guest_v4_addr, IPV4_ADDR_LEN);
801         p += IPV4_ADDR_LEN;
802         memcpy(p, guest_v4_router, IPV4_ADDR_LEN);
803         p += IPV4_ADDR_LEN;
804         memcpy(p, guest_v4_router, IPV4_ADDR_LEN);
805         p += IPV4_ADDR_LEN;
806         iov_memcpy_from(iov, iovcnt, ETH_ADDR_LEN, p, ETH_ADDR_LEN);
807         p += 16;        /* CHaddr has 16 bytes, we only use 6 */
808         memcpy(p, dhcp_hostname, strlen(dhcp_hostname));
809         p += 64;
810         p += 128;
811
812         req_type = get_dhcp_req_type(iov, iovcnt);
813
814         /* DHCP options: Technically, we should be responding with whatever fields
815          * they asked for in their incoming message.  For the most part, there are a
816          * bunch of standard things we can just respond with. */
817
818         *p++ = DHCP_MAGIC_COOKIE_1;
819         *p++ = DHCP_MAGIC_COOKIE_2;
820         *p++ = DHCP_MAGIC_COOKIE_3;
821         *p++ = DHCP_MAGIC_COOKIE_4;
822
823         *p++ = DHCP_OPT_MSG_TYPE;
824         *p++ = 1;
825         switch (req_type) {
826         case DHCP_MSG_DISCOVER:
827                 *p++ = DHCP_MSG_OFFER;
828                 break;
829         case DHCP_MSG_REQUEST:
830                 *p++ = DHCP_MSG_ACK;
831                 break;
832         default:
833                 panic("Unexpected DHCP message type %d", req_type);
834         }
835
836         *p++ = DHCP_OPT_SUBNET;
837         *p++ = 4;
838         memcpy(p, guest_v4_mask, IPV4_ADDR_LEN);
839         p += IPV4_ADDR_LEN;
840
841         *p++ = DHCP_OPT_ROUTER;
842         *p++ = 4;
843         memcpy(p, guest_v4_router, IPV4_ADDR_LEN);
844         p += IPV4_ADDR_LEN;
845
846         *p++ = DHCP_OPT_DNS;
847         *p++ = 4;
848         memcpy(p, guest_v4_dns, IPV4_ADDR_LEN);
849         p += IPV4_ADDR_LEN;
850
851         *p++ = DHCP_OPT_HOSTNAME;
852         *p++ = strlen(dhcp_guestname);  /* not null-terminated */
853         memcpy(p, dhcp_guestname, strlen(dhcp_guestname));
854         p += strlen(dhcp_guestname);
855
856         if (req_type == DHCP_MSG_REQUEST) {
857                 *p++ = DHCP_OPT_LEASE;
858                 *p++ = 4;
859                 hnputl(p, DHCP_LEASE_TIME);
860                 p += 4;
861
862                 *p++ = DHCP_OPT_SERVER_ID;
863                 *p++ = 4;
864                 memcpy(p, guest_v4_dns, IPV4_ADDR_LEN);
865                 p += IPV4_ADDR_LEN;
866
867         }
868
869         *p++ = DHCP_OPT_END_OF_OPT;
870
871         return p - buf;
872 }
873
874 /* Builds a UDP packet responding to IOV with buf of payload_sz.  Sent from
875  * src_port to dst_port.  Returns the new size, including UDP headers. */
876 static size_t build_udp_response(struct iovec *iov, int iovcnt, uint8_t *buf,
877                                  size_t payload_sz,
878                                  uint16_t src_port, uint16_t dst_port)
879 {
880         uint8_t *p = buf;
881
882         hnputs(p, src_port);
883         p += 2;
884         hnputs(p, dst_port);
885         p += 2;
886         hnputs(p, payload_sz + UDP_HDR_LEN);
887         p += 2;
888         /* For v4, we don't need to do the xsum.  It's a minor pain too, since they
889          * xsum parts of the IP header too. */
890         hnputs(p, 0);
891         p += 2;
892
893         return p - buf + payload_sz;
894 }
895
896 /* Builds an IP packet responding to iov with buf of payload_sz.  Sent from->to
897  * with protocol.  Returns the new size, including IP headers.
898  *
899  * We take parameters for the IP, since some usages won't use the iov's IP (e.g.
900  * DHCP). */
901 static size_t build_ip_response(struct iovec *iov, int iovcnt, uint8_t *buf,
902                                 size_t payload_sz, uint8_t *from, uint8_t *to,
903                                 uint8_t protocol)
904 {
905         uint8_t *p = buf;
906         uint8_t *xsum_addr;
907
908         *p = 0x45;              /* version, etc */
909         p += 2;
910         hnputs(p, payload_sz + IPV4_HDR_LEN);
911         p += 2;
912         p += 4;
913         *p = 255;               /* TTL */
914         p += 1;
915         *p = protocol;
916         p += 1;
917         xsum_addr = p;
918         p += 2;
919         memcpy(p, from, IPV4_ADDR_LEN);
920         p += IPV4_ADDR_LEN;
921         memcpy(p, to, IPV4_ADDR_LEN);
922         p += IPV4_ADDR_LEN;
923         hnputs(xsum_addr, ip_calc_xsum(buf, IPV4_HDR_LEN));
924
925         return p - buf + payload_sz;
926 }
927
928 /* Builds an ethernet response to iov from buf of payload_sz.  Returns the new
929  * size, including ethernet headers. */
930 static size_t build_eth_response(struct iovec *iov, int iovcnt, uint8_t *buf,
931                                  size_t payload_sz, uint16_t ether_type)
932 {
933         uint8_t *p = buf;
934
935         iov_memcpy_from(iov, iovcnt, ETH_OFF_SRC, p, ETH_ADDR_LEN);
936         p += ETH_ADDR_LEN;
937         memcpy(p, host_eth_addr, ETH_ADDR_LEN);
938         p += ETH_ADDR_LEN;
939         hnputs(p, ether_type);
940         p += 2;
941
942         return p - buf + payload_sz;
943 }
944
945 static void fake_dhcp_response(struct iovec *iov, int iovcnt)
946 {
947         struct buf_pkt *bpkt;
948         size_t payload_sz;
949
950         switch (get_dhcp_req_type(iov, iovcnt)) {
951         case DHCP_MSG_OFFER:
952         case DHCP_MSG_DECLINE:
953         case DHCP_MSG_ACK:
954         case DHCP_MSG_NAK:
955         case DHCP_MSG_RELEASE:
956         case DHCP_MSG_INFORM:
957                 return;
958         }
959         bpkt = zalloc_bpkt(ETH_HDR_LEN + IPV4_HDR_LEN + UDP_HDR_LEN + DHCP_RSP_LEN);
960
961         payload_sz = build_dhcp_response(iov, iovcnt, bpkt->buf + ETH_HDR_LEN
962                                                       + IPV4_HDR_LEN + UDP_HDR_LEN);
963         payload_sz = build_udp_response(iov, iovcnt,
964                                         bpkt->buf + ETH_HDR_LEN + IPV4_HDR_LEN,
965                                         payload_sz, 67, 68);
966         /* For offers and initial requests, we definitely need to send it to
967          * 255.255.255.255 (bcast).  For renewals, it seems like that that also
968          * suffices, which seems reasonable. */
969         payload_sz = build_ip_response(iov, iovcnt, bpkt->buf + ETH_HDR_LEN,
970                                        payload_sz, guest_v4_router, bcast_v4_addr,
971                                        IP_UDPPROTO);
972         payload_sz = build_eth_response(iov, iovcnt, bpkt->buf, payload_sz,
973                                         ETH_TYPE_IPV4);
974
975         assert(payload_sz <= bpkt->sz);
976         bpkt->sz = payload_sz;
977         inject_buf_pkt(bpkt);
978 }
979
980 static size_t build_arp_response(struct iovec *iov, int iovcnt, uint8_t *buf)
981 {
982         uint8_t *p = buf;
983
984         hnputs(p, ETH_HTYPE_ETH);
985         p += 2;
986         hnputs(p, ETH_TYPE_IPV4);
987         p += 2;
988         *p++ = ETH_ADDR_LEN;
989         *p++ = IPV4_ADDR_LEN;
990         hnputs(p, ARP_OP_RSP);
991         p += 2;
992         /* SHA: addr they are looking for, which is always host's eth addr */
993         memcpy(p, host_eth_addr, ETH_ADDR_LEN);
994         p += ETH_ADDR_LEN;
995         /* SPA: addr they are looking for, which was the request TPA */
996         iov_memcpy_from(iov, iovcnt, ETH_HDR_LEN + ARP_OFF_TPA, p, IPV4_ADDR_LEN);
997         p += IPV4_ADDR_LEN;
998         /* THA was the SHA of the request */
999         iov_memcpy_from(iov, iovcnt, ETH_HDR_LEN + ARP_OFF_SHA, p, ETH_ADDR_LEN);
1000         p += ETH_ADDR_LEN;
1001         /* TPA was the SPA of the request */
1002         iov_memcpy_from(iov, iovcnt, ETH_HDR_LEN + ARP_OFF_SPA, p, IPV4_ADDR_LEN);
1003         p += IPV4_ADDR_LEN;
1004
1005         return p - buf;
1006 }
1007
1008 static bool should_ignore_arp(struct iovec *iov, int iovcnt)
1009 {
1010         size_t arp_off = ETH_HDR_LEN;
1011
1012         if (iov_get_be16(iov, iovcnt, arp_off + ARP_OFF_OP) != ARP_OP_REQ)
1013                 return TRUE;
1014         /* ARP probes set the SPA to 0.  Ignore these. */
1015         if (iov_get_be32(iov, iovcnt, arp_off + ARP_OFF_SPA) == 0)
1016                 return TRUE;
1017         return FALSE;
1018 }
1019
1020 static void handle_arp_tx(struct iovec *iov, int iovcnt)
1021 {
1022         struct buf_pkt *bpkt;
1023         size_t payload_sz;
1024
1025         if (should_ignore_arp(iov, iovcnt))
1026                 return;
1027         bpkt = zalloc_bpkt(ETH_HDR_LEN + ARP_PKT_LEN);
1028         payload_sz = build_arp_response(iov, iovcnt, bpkt->buf + ETH_HDR_LEN);
1029         payload_sz = build_eth_response(iov, iovcnt, bpkt->buf, payload_sz,
1030                                         ETH_TYPE_ARP);
1031         assert(payload_sz <= bpkt->sz);
1032         bpkt->sz = payload_sz;
1033         inject_buf_pkt(bpkt);
1034 }
1035
1036 /* Helper for protocols: updates an xsum, given a port number change */
1037 static void xsum_changed_port(struct iovec *iov, int iovcnt, size_t xsum_off,
1038                               uint16_t old_port, uint16_t new_port)
1039 {
1040         uint16_t old_port_be, new_port_be;
1041
1042         /* xsum update expects to work on big endian */
1043         hnputs(&old_port_be, old_port);
1044         hnputs(&new_port_be, new_port);
1045         xsum_update(iov, iovcnt, xsum_off, (uint8_t*)&old_port_be,
1046                     (uint8_t*)&new_port_be, 2);
1047 }
1048
1049 static struct ip_nat_map *handle_udp_tx(struct iovec *iov, int iovcnt,
1050                                         size_t udp_off)
1051 {
1052         uint16_t src_port, dst_port;
1053         struct ip_nat_map *map;
1054
1055         if (!iov_has_bytes(iov, iovcnt, udp_off + UDP_HDR_LEN)) {
1056                 fprintf(stderr, "Short UDP header, dropping!\n");
1057                 return NULL;
1058         }
1059         src_port = iov_get_be16(iov, iovcnt, udp_off + UDP_OFF_SRC_PORT);
1060         dst_port = iov_get_be16(iov, iovcnt, udp_off + UDP_OFF_DST_PORT);
1061         if (dst_port == 67) {
1062                 fake_dhcp_response(iov, iovcnt);
1063                 return NULL;
1064         }
1065         map = get_map_by_tuple(IP_UDPPROTO, src_port);
1066         xsum_changed_port(iov, iovcnt, udp_off + UDP_OFF_XSUM, src_port,
1067                           map->host_port);
1068         iov_put_be16(iov, iovcnt, udp_off + UDP_OFF_SRC_PORT, map->host_port);
1069         return map;
1070 }
1071
1072 static struct ip_nat_map *handle_tcp_tx(struct iovec *iov, int iovcnt,
1073                                         size_t tcp_off)
1074 {
1075         uint16_t src_port, dst_port;
1076         struct ip_nat_map *map;
1077
1078         if (!iov_has_bytes(iov, iovcnt, tcp_off + TCP_HDR_LEN)) {
1079                 fprintf(stderr, "Short TCP header, dropping!\n");
1080                 return NULL;
1081         }
1082         src_port = iov_get_be16(iov, iovcnt, tcp_off + TCP_OFF_SRC_PORT);
1083         dst_port = iov_get_be16(iov, iovcnt, tcp_off + TCP_OFF_DST_PORT);
1084         map = get_map_by_tuple(IP_TCPPROTO, src_port);
1085         xsum_changed_port(iov, iovcnt, tcp_off + TCP_OFF_XSUM, src_port,
1086                           map->host_port);
1087         iov_put_be16(iov, iovcnt, tcp_off + TCP_OFF_SRC_PORT, map->host_port);
1088         return map;
1089 }
1090
1091 static struct ip_nat_map *handle_icmp_tx(struct iovec *iov, int iovcnt,
1092                                          size_t icmp_off)
1093 {
1094         /* TODO: we could respond to pings sent to us (router_ip).  For anything
1095          * else, we'll need to work with the bypass (if possible, maybe ID it with
1096          * the Identifier field and map that to the bypassed conv)). */
1097         return NULL;
1098 }
1099
1100 /* Some protocols (like TCP and UDP) need to adjust their xsums whenever an IPv4
1101  * address changes. */
1102 static void ipv4_proto_changed_addr(struct iovec *iov, int iovcnt,
1103                                     uint8_t protocol, size_t proto_hdr_off,
1104                                     uint8_t *old_addr, uint8_t *new_addr)
1105 {
1106         switch (protocol) {
1107         case IP_UDPPROTO:
1108                 xsum_update(iov, iovcnt, proto_hdr_off + UDP_OFF_XSUM, old_addr,
1109                             new_addr, IPV4_ADDR_LEN);
1110                 break;
1111         case IP_TCPPROTO:
1112                 xsum_update(iov, iovcnt, proto_hdr_off + TCP_OFF_XSUM, old_addr,
1113                             new_addr, IPV4_ADDR_LEN);
1114                 break;
1115         }
1116 }
1117
1118 /* Helper, changes a packet's IP address, updating xsums.  'which' controls
1119  * whether we're changing the src or dst address. */
1120 static void ipv4_change_addr(struct iovec *iov, int iovcnt, size_t ip_off,
1121                              uint8_t protocol, uint8_t proto_hdr_off,
1122                              uint8_t *old_addr, uint8_t *new_addr, size_t which)
1123 {
1124         xsum_update(iov, iovcnt, ip_off + IPV4_OFF_XSUM, old_addr, new_addr,
1125                     IPV4_ADDR_LEN);
1126         ipv4_proto_changed_addr(iov, iovcnt, protocol, proto_hdr_off, old_addr,
1127                                 new_addr);
1128         iov_memcpy_to(iov, iovcnt, ip_off + which, new_addr, IPV4_ADDR_LEN);
1129 }
1130
1131 static size_t ipv4_get_header_len(struct iovec *iov, int iovcnt, size_t ip_off)
1132 {
1133         /* First byte, lower nibble, times 4. */
1134         return (iov_get_byte(iov, iovcnt, ip_off + 0) & 0x0f) * 4;
1135 }
1136
1137 static size_t ipv4_get_proto_off(struct iovec *iov, int iovcnt, size_t ip_off)
1138 {
1139         return ipv4_get_header_len(iov, iovcnt, ip_off) + ip_off;
1140 }
1141
1142 static uint8_t ipv4_get_version(struct iovec *iov, int iovcnt, size_t ip_off)
1143 {
1144         /* First byte, upper nibble, but keep in the upper nibble location */
1145         return iov_get_byte(iov, iovcnt, ip_off + 0) & 0xf0;
1146 }
1147
1148 static void handle_ipv4_tx(struct iovec *iov, int iovcnt)
1149 {
1150         size_t ip_off = ETH_HDR_LEN;
1151         uint8_t protocol;
1152         size_t proto_hdr_off;
1153         struct ip_nat_map *map;
1154         uint8_t src_addr[IPV4_ADDR_LEN];
1155         uint8_t dst_addr[IPV4_ADDR_LEN];
1156
1157         if (!iov_has_bytes(iov, iovcnt, ip_off + IPV4_HDR_LEN)) {
1158                 fprintf(stderr, "Short IPv4 header, dropping!\n");
1159                 return;
1160         }
1161         /* It's up to each protocol to give us the ip_nat_map matching the packet
1162          * and to change the packet's src port. */
1163         protocol = iov_get_byte(iov, iovcnt, ip_off + IPV4_OFF_PROTO);
1164         proto_hdr_off = ipv4_get_proto_off(iov, iovcnt, ip_off);
1165         switch (protocol) {
1166         case IP_UDPPROTO:
1167                 map = handle_udp_tx(iov, iovcnt, proto_hdr_off);
1168                 break;
1169         case IP_TCPPROTO:
1170                 map = handle_tcp_tx(iov, iovcnt, proto_hdr_off);
1171                 break;
1172         case IP_ICMPPROTO:
1173                 map = handle_icmp_tx(iov, iovcnt, proto_hdr_off);
1174                 break;
1175         }
1176         /* If the protocol handler already dealt with it (e.g. via emulation), we
1177          * bail out.  o/w, they gave us the remapping we should use to rewrite and
1178          * send the packet. */
1179         if (!map)
1180                 return;
1181         /* At this point, we have a refcnted map, which will keep the map alive and
1182          * its FD open. */
1183         iov_memcpy_from(iov, iovcnt, ip_off + IPV4_OFF_SRC, src_addr,
1184                         IPV4_ADDR_LEN);
1185         iov_memcpy_from(iov, iovcnt, ip_off + IPV4_OFF_DST, dst_addr,
1186                         IPV4_ADDR_LEN);
1187         /* If the destination is the ROUTER_IP, then it's really meant to go to the
1188          * host (loopback).  In that case, we also need the src to be loopback, so
1189          * that the *host's* IP stack recognizes the connection (necessary for
1190          * host-initiated connections via static maps). */
1191         if (!memcmp(dst_addr, guest_v4_router, IPV4_ADDR_LEN)) {
1192                 ipv4_change_addr(iov, iovcnt, ip_off, protocol, proto_hdr_off,
1193                                  dst_addr, loopback_v4_addr, IPV4_OFF_DST);
1194                 ipv4_change_addr(iov, iovcnt, ip_off, protocol, proto_hdr_off,
1195                                  src_addr, loopback_v4_addr, IPV4_OFF_SRC);
1196         } else {
1197                 ipv4_change_addr(iov, iovcnt, ip_off, protocol, proto_hdr_off,
1198                                  src_addr, host_v4_addr, IPV4_OFF_SRC);
1199         }
1200         /* We didn't change the size of the packet, just a few fields.  So we
1201          * shouldn't need to worry about iov[] being too big.  This is different
1202          * than the receive case, where the guest should give us an MTU-sized iov.
1203          * Here, they just gave us whatever they wanted to send.
1204          *
1205          * However, we still need to drop the ethernet header from the front of the
1206          * packet, and just send the IP header + payload. */
1207         iov_strip_bytes(iov, iovcnt, ETH_HDR_LEN);
1208         /* As far as blocking goes, this is like blasting out a raw IP packet.  It
1209          * shouldn't block, preferring to drop, though there might be some cases
1210          * where a qlock is grabbed or the medium/NIC blocks. */
1211         writev(map->host_data_fd, iov, iovcnt);
1212         map->is_stale = FALSE;
1213         kref_put(&map->kref);
1214 }
1215
1216 static void handle_ipv6_tx(struct iovec *iov, int iovcnt)
1217 {
1218 }
1219
1220 /* virtio-net calls this when the guest transmits a packet */
1221 int vnet_transmit_packet(struct iovec *iov, int iovcnt)
1222 {
1223         uint16_t ether_type;
1224
1225         if (vnet_snoop)
1226                 writev(snoop_fd, iov, iovcnt);
1227         if (!iov_has_bytes(iov, iovcnt, ETH_HDR_LEN)) {
1228                 fprintf(stderr, "Short ethernet frame from the guest, dropping!\n");
1229                 return -1;
1230         }
1231         ether_type = iov_get_be16(iov, iovcnt, ETH_OFF_ETYPE);
1232         switch (ether_type) {
1233         case ETH_TYPE_ARP:
1234                 handle_arp_tx(iov, iovcnt);
1235                 break;
1236         case ETH_TYPE_IPV4:
1237                 handle_ipv4_tx(iov, iovcnt);
1238                 break;
1239         case ETH_TYPE_IPV6:
1240                 handle_ipv6_tx(iov, iovcnt);
1241                 break;
1242         default:
1243                 fprintf(stderr, "Unknown ethertype 0x%x, dropping!\n", ether_type);
1244                 return -1;
1245         };
1246         return 0;
1247 }
1248
1249 /* Polls for injected packets, filling the iov[iovcnt] on success and returning
1250  * the amount.  0 means 'nothing there.' */
1251 static size_t __poll_injection(struct iovec *iov, int iovcnt)
1252 {
1253         size_t ret;
1254         struct buf_pkt *bpkt;
1255
1256         if (STAILQ_EMPTY(&inject_pkts))
1257                 return 0;
1258         bpkt = STAILQ_FIRST(&inject_pkts);
1259         STAILQ_REMOVE_HEAD(&inject_pkts, next);
1260         iov_memcpy_to(iov, iovcnt, 0, bpkt->buf, bpkt->sz);
1261         ret = bpkt->sz;
1262         free_bpkt(bpkt);
1263         return ret;
1264 }
1265
1266 static void handle_udp_rx(struct iovec *iov, int iovcnt, size_t len,
1267                           struct ip_nat_map *map, size_t udp_off)
1268 {
1269         assert(len >= udp_off + UDP_HDR_LEN);
1270         xsum_changed_port(iov, iovcnt, udp_off + UDP_OFF_XSUM,
1271                           iov_get_be16(iov, iovcnt, udp_off + UDP_OFF_DST_PORT),
1272                           map->guest_port);
1273         iov_put_be16(iov, iovcnt, udp_off + UDP_OFF_DST_PORT, map->guest_port);
1274 }
1275
1276 static void handle_tcp_rx(struct iovec *iov, int iovcnt, size_t len,
1277                           struct ip_nat_map *map, size_t tcp_off)
1278 {
1279         assert(len >= tcp_off + TCP_HDR_LEN);
1280         xsum_changed_port(iov, iovcnt, tcp_off + TCP_OFF_XSUM,
1281                           iov_get_be16(iov, iovcnt, tcp_off + TCP_OFF_DST_PORT),
1282                           map->guest_port);
1283         iov_put_be16(iov, iovcnt, tcp_off + TCP_OFF_DST_PORT, map->guest_port);
1284 }
1285
1286 /* Computes and stores the xsum for the ipv4 header in the iov. */
1287 static void xsum_ipv4_header(struct iovec *iov, int iovcnt, size_t ip_off)
1288 {
1289         size_t hdr_len = ipv4_get_header_len(iov, iovcnt, ip_off);
1290         uint8_t buf[hdr_len];
1291
1292         iov_memcpy_from(iov, iovcnt, ip_off, buf, hdr_len);
1293         *(uint16_t*)&buf[IPV4_OFF_XSUM] = 0;
1294         iov_put_be16(iov, iovcnt, ip_off + IPV4_OFF_XSUM,
1295                      ip_calc_xsum(buf, IPV4_HDR_LEN));
1296 }
1297
1298 static void handle_ipv4_rx(struct iovec *iov, int iovcnt, size_t len,
1299                            struct ip_nat_map *map)
1300 {
1301         size_t ip_off = ETH_HDR_LEN;
1302         uint8_t protocol;
1303         size_t proto_hdr_off;
1304         uint8_t src_addr[IPV4_ADDR_LEN];
1305         uint8_t dst_addr[IPV4_ADDR_LEN];
1306
1307         protocol = iov_get_byte(iov, iovcnt, ip_off + IPV4_OFF_PROTO);
1308         proto_hdr_off = ipv4_get_proto_off(iov, iovcnt, ip_off);
1309         switch (map->protocol) {
1310         case IP_UDPPROTO:
1311                 handle_udp_rx(iov, iovcnt, len, map, proto_hdr_off);
1312                 break;
1313         case IP_TCPPROTO:
1314                 handle_tcp_rx(iov, iovcnt, len, map, proto_hdr_off);
1315                 break;
1316         default:
1317                 panic("Bad proto %d on map for conv FD %d\n", map->protocol,
1318                       map->host_data_fd);
1319         }
1320         iov_memcpy_from(iov, iovcnt, ip_off + IPV4_OFF_SRC, src_addr,
1321                         IPV4_ADDR_LEN);
1322         iov_memcpy_from(iov, iovcnt, ip_off + IPV4_OFF_DST, dst_addr,
1323                         IPV4_ADDR_LEN);
1324         /* If the src was the host (loopback), the guest thinks the remote is
1325          * ROUTER_IP. */
1326         if (!memcmp(src_addr, loopback_v4_addr, IPV4_ADDR_LEN)) {
1327                 ipv4_change_addr(iov, iovcnt, ip_off, map->protocol, proto_hdr_off,
1328                                  src_addr, guest_v4_router, IPV4_OFF_SRC);
1329         }
1330         /* Interesting case.  If we rewrite it to guest_v4_router, when the guest
1331          * responds, *that* packet will get rewritten to loopback.  If we ignore it,
1332          * and it's qemu mode, it'll actually work.  If it's real addr mode, the
1333          * guest won't send an IP packet out that it thinks is for itself.  */
1334         if (vnet_real_ip_addrs && !memcmp(src_addr, host_v4_addr, IPV4_ADDR_LEN)) {
1335                 fprintf(stderr, "VNET received packet from host_v4_addr.  Not translating, the guest cannot respond!\n");
1336         }
1337         /* Regardless, the dst changes from HOST_IP/loopback to GUEST_IP */
1338         ipv4_change_addr(iov, iovcnt, ip_off, map->protocol, proto_hdr_off,
1339                          dst_addr, guest_v4_addr, IPV4_OFF_DST);
1340         /* Note we did the incremental xsum for the IP header, but also do a final
1341          * xsum.  We need the final xsum in case the kernel's networking stack
1342          * messed up the header. */
1343         xsum_ipv4_header(iov, iovcnt, ip_off);
1344 }
1345
1346 /* NAT / translate an inbound packet iov[len], using map.  If a packet comes in
1347  * on a certain FD, then it's going to the guest at the appropriate port, no
1348  * questions asked.
1349  *
1350  * The iov has ETH_HDR_LEN bytes at the front.  The data actually read from the
1351  * conv starts at that offset.  len includes this frontal padding - it's the
1352  * full length of the real data in the iov + the ethernet header.  len may
1353  * include data beyond the IP packet length; we often get padding from the
1354  * kernel networking stack.  Returns the final size of the packet. */
1355 static size_t handle_rx(struct iovec *iov, int iovcnt, size_t len,
1356                         struct ip_nat_map *map)
1357 {
1358         size_t ip_off = ETH_HDR_LEN;
1359         uint8_t version;
1360         uint16_t ether_type;
1361
1362         /* The conv is reading from a Qmsg queue.  We should always receive at least
1363          * an IPv4 header from the kernel. */
1364         assert(len >= IPV4_HDR_LEN + ETH_HDR_LEN);
1365         version = ipv4_get_version(iov, iovcnt, ip_off);
1366         switch (version) {
1367         case IP_VER4:
1368                 ether_type = ETH_TYPE_IPV4;
1369                 handle_ipv4_rx(iov, iovcnt, len, map);
1370                 break;
1371         case IP_VER6:
1372                 ether_type = ETH_TYPE_IPV6;
1373                 /* Technically, this could be a bad actor outside our node */
1374                 panic("Got an IPv6 packet on FD %d!\n", map->host_data_fd);
1375         default:
1376                 panic("Unexpected IP version 0x%x, probably a bug", version);
1377         }
1378         iov_memcpy_to(iov, iovcnt, ETH_OFF_DST, guest_eth_addr, ETH_ADDR_LEN);
1379         iov_memcpy_to(iov, iovcnt, ETH_OFF_SRC, host_eth_addr, ETH_ADDR_LEN);
1380         iov_put_be16(iov, iovcnt, ETH_OFF_ETYPE, ether_type);
1381         return len;
1382 }
1383
1384 /* Polls for inbound packets on the host's FD, filling the iov[iovcnt] on
1385  * success and returning the amount.  0 means 'nothing there.'
1386  *
1387  * Notes on concurrency:
1388  * - The inbound_todo list is protected by the rx_mtx.  Since we're readv()ing
1389  *   while holding the mtx (because we're in a FOREACH), we're single threaded
1390  *   in the RX path.
1391  * - The inbound_todo list is filled by another thread that puts maps on the
1392  *   list whenever their FD tap fires.
1393  * - The maps on the inbound_todo list are refcounted.  It's possible for them
1394  *   to be reaped and removed from the mapping lookup, but the mapping would
1395  *   stay around until we drained all of the packets from the inbound conv. */
1396 static size_t __poll_inbound(struct iovec *iov, int iovcnt)
1397 {
1398         struct ip_nat_map *i, *temp;
1399         ssize_t pkt_sz = 0;
1400         struct iovec iov_copy[iovcnt];
1401
1402         /* We're going to readv ETH_HDR_LEN bytes into the iov.  To do so, we'll use
1403          * a separate iov to track this offset.  The iov and iov_copy both point to
1404          * the same memory (minus the stripping). */
1405         memcpy(iov_copy, iov, sizeof(struct iovec) * iovcnt);
1406         iov_strip_bytes(iov_copy, iovcnt, ETH_HDR_LEN);
1407         TAILQ_FOREACH_SAFE(i, &inbound_todo, inbound, temp) {
1408                 pkt_sz = readv(i->host_data_fd, iov_copy, iovcnt);
1409                 if (pkt_sz > 0) {
1410                         i->is_stale = FALSE;
1411                         return handle_rx(iov, iovcnt, pkt_sz + ETH_HDR_LEN, i);
1412                 }
1413                 parlib_assert_perror(errno == EAGAIN);
1414                 TAILQ_REMOVE(&inbound_todo, i, inbound);
1415                 i->is_on_inbound = FALSE;
1416                 kref_put(&i->kref);
1417         }
1418         return 0;
1419 }
1420
1421 /* virtio-net calls this when it wants us to fill iov with a packet. */
1422 int vnet_receive_packet(struct iovec *iov, int iovcnt)
1423 {
1424         size_t rx_amt;
1425
1426         uth_mutex_lock(rx_mtx);
1427         while (1) {
1428                 rx_amt = __poll_injection(iov, iovcnt);
1429                 if (rx_amt)
1430                         break;
1431                 rx_amt = __poll_inbound(iov, iovcnt);
1432                 if (rx_amt)
1433                         break;
1434                 uth_cond_var_wait(rx_cv, rx_mtx);
1435         }
1436         uth_mutex_unlock(rx_mtx);
1437         iov_trim_len_to(iov, iovcnt, rx_amt);
1438         if (vnet_snoop)
1439                 writev(snoop_fd, iov, iovcnt);
1440         return rx_amt;
1441 }