parlib: Change opaque mutex/cv types to be structs
[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         if (bypass_fd < 0) {
338                 fprintf(stderr, "Failed to clone a conv for %s:%d (%r), won't bypass!\n",
339                         proto_str, guest_port);
340                 free(map);
341                 return NULL;
342         }
343
344         port_check = get_port9(conv_dir, "local", &map->host_port);
345         parlib_assert_perror(port_check);
346
347         map->host_data_fd = open_data_fd9(conv_dir, O_NONBLOCK);
348         parlib_assert_perror(map->host_data_fd >= 0);
349
350         tap_inbound_conv(map->host_data_fd);
351
352         close(bypass_fd);
353         return map;
354 }
355
356 /* Looks up or creates an ip_nat_map for the given proto/port tuple. */
357 static struct ip_nat_map *get_map_by_tuple(uint8_t protocol,
358                                            uint16_t guest_port)
359 {
360         struct ip_nat_map *map;
361
362         map = lookup_map_by_tuple(protocol, guest_port);
363         if (map)
364                 return map;
365         map = create_map(protocol, guest_port, "*", FALSE);
366         if (!map)
367                 return NULL;
368         kref_get(&map->kref, 1);
369         add_map(map);
370         return map;
371 }
372
373 static void map_reaper(void *arg)
374 {
375         struct ip_nat_map *i, *temp;
376         struct ip_nat_map_tailq to_release;
377
378         while (1) {
379                 uthread_sleep(vnet_nat_timeout);
380                 TAILQ_INIT(&to_release);
381                 spin_pdr_lock(&maps_lock);
382                 /* Only need to scan one map_hash, might as well be the tuple */
383                 for (int j = 0; j < NR_VNET_HASH; j++) {
384                         TAILQ_FOREACH_SAFE(i, &map_hash_tuple[j], lookup_tuple, temp) {
385                                 if (i->is_static)
386                                         continue;
387                                 if (!i->is_stale) {
388                                         i->is_stale = TRUE;
389                                         continue;
390                                 }
391                                 /* Remove from both lists, hashing for the FD list */
392                                 TAILQ_REMOVE(&map_hash_tuple[j], i, lookup_tuple);
393                                 TAILQ_REMOVE(list_hash_fd(i->host_data_fd), i, lookup_fd);
394                                 /* Use the lookup_tuple for the temp list */
395                                 TAILQ_INSERT_HEAD(&to_release, i, lookup_tuple);
396                         }
397                 }
398                 spin_pdr_unlock(&maps_lock);
399                 TAILQ_FOREACH_SAFE(i, &to_release, lookup_tuple, temp)
400                         kref_put(&i->kref);
401         }
402 }
403
404 static void map_dumper(void)
405 {
406         struct ip_nat_map *i;
407
408         fprintf(stderr, "\n\nVNET NAT maps:\n---------------\n");
409         spin_pdr_lock(&maps_lock);
410         for (int j = 0; j < NR_VNET_HASH; j++) {
411                 TAILQ_FOREACH(i, &map_hash_tuple[j], lookup_tuple) {
412                         fprintf(stderr, "\tproto %2d, host %5d, guest %5d, FD %4d, stale %d, static %d, ref %d\n",
413                                 i->protocol, i->host_port, i->guest_port, i->host_data_fd,
414                                 i->is_stale, i->is_static, i->kref.refcnt);
415                 }
416         }
417         spin_pdr_unlock(&maps_lock);
418 }
419
420 static void init_map_lookup(struct virtual_machine *vm)
421 {
422         for (int i = 0; i < NR_VNET_HASH; i++)
423                 TAILQ_INIT(&map_hash_tuple[i]);
424         for (int i = 0; i < NR_VNET_HASH; i++)
425                 TAILQ_INIT(&map_hash_fd[i]);
426         vmm_run_task(vm, map_reaper, NULL);
427 }
428
429 static struct buf_pkt *zalloc_bpkt(size_t size)
430 {
431         struct buf_pkt *bpkt;
432
433         bpkt = malloc(sizeof(struct buf_pkt));
434         assert(bpkt);
435         bpkt->sz = size;
436         bpkt->buf = malloc(bpkt->sz);
437         assert(bpkt->buf);
438         memset(bpkt->buf, 0, bpkt->sz);
439         return bpkt;
440 }
441
442 static void free_bpkt(struct buf_pkt *bpkt)
443 {
444         free(bpkt->buf);
445         free(bpkt);
446 }
447
448 /* Queues a buf_pkt, which the rx thread will inject when it wakes. */
449 static void inject_buf_pkt(struct buf_pkt *bpkt)
450 {
451         uth_mutex_lock(rx_mtx);
452         STAILQ_INSERT_TAIL(&inject_pkts, bpkt, next);
453         uth_mutex_unlock(rx_mtx);
454         uth_cond_var_broadcast(rx_cv);
455 }
456
457 /* Helper for xsum_update, mostly for paranoia with integer promotion and
458  * cleanly keeping variables as u16. */
459 static uint16_t ones_comp(uint16_t x)
460 {
461         return ~x;
462 }
463
464 /* IP checksum updater.  If you change amt bytes in a packet from old to new,
465  * this updates the xsum at xsum_off in the iov.
466  *
467  * Assumes a few things:
468  * - there's a 16 byte xsum at xsum_off
469  * - amt is a multiple of two
470  * - the data at *old and *new is network (big) endian
471  *
472  * There's no assumption about the alignment of old and new, thanks to Plan 9's
473  * sensible nhgets() (just byte accesses, not assuming u16 alignment).
474  *
475  * See RFC 1624 for the math.  I opted for Eqn 3, instead of 4, since I didn't
476  * want to deal with subtraction underflow / carry / etc.  Also note that we
477  * need to do the intermediate carry before doing the one's comp.  That wasn't
478  * clear from the RFC either.  RFC 1141 didn't need to do that, since they
479  * didn't complement the intermediate HC (xsum). */
480 static void xsum_update(struct iovec *iov, int iovcnt, size_t xsum_off,
481                         uint8_t *old, uint8_t *new, size_t amt)
482 {
483         uint32_t xsum;
484
485         assert(amt % 2 == 0);
486         xsum = iov_get_be16(iov, iovcnt, xsum_off);
487         /* for each short: HC' = ~(~HC + ~m + m') (' == new, ~ == ones-comp) */
488         for (int i = 0; i < amt / 2; i++, old += 2, new += 2) {
489                 xsum = ones_comp(xsum) + ones_comp(nhgets(old)) + nhgets(new);
490                 /* Need to deal with the carry for any additions, before the outer ~()
491                  * operation.  (Not mentioned in the RFC, determined manually...) */
492                 while (xsum >> 16)
493                         xsum = (xsum & 0xffff) + (xsum >> 16);
494                 /* Yes, next time around the loop we ones comp right back.  Not worth
495                  * optimizing. */
496                 xsum = ones_comp(xsum);
497         }
498         iov_put_be16(iov, iovcnt, xsum_off, xsum);
499 }
500
501 static void snoop_on_virtio(void)
502 {
503         int ret;
504         int srv_fd, pipe_dir_fd, pipe_ctl_fd, pipe_srv_fd, pipe_snoop_fd;
505         const char cmd[] = "oneblock";
506         char buf[MAX_PATH_LEN];
507
508         pipe_dir_fd = open("#pipe", O_PATH);
509         parlib_assert_perror(pipe_dir_fd >= 0);
510
511         pipe_ctl_fd = openat(pipe_dir_fd, "ctl", O_RDWR);
512         parlib_assert_perror(pipe_ctl_fd >= 0);
513         ret = write(pipe_ctl_fd, cmd, sizeof(cmd));
514         parlib_assert_perror(ret == sizeof(cmd));
515         close(pipe_ctl_fd);
516
517         pipe_snoop_fd = openat(pipe_dir_fd, "data", O_RDWR);
518         parlib_assert_perror(pipe_snoop_fd >= 0);
519         ret = fcntl(pipe_snoop_fd, F_SETFL, O_NONBLOCK);
520         parlib_assert_perror(!ret);
521         snoop_fd = pipe_snoop_fd;
522
523         pipe_srv_fd = openat(pipe_dir_fd, "data1", O_RDWR);
524         parlib_assert_perror(pipe_srv_fd >= 0);
525         ret = snprintf(buf, sizeof(buf), "#srv/%s-%d", "snoop", getpid());
526         /* We don't close srv_fd here.  When we exit, it'll close and remove. */
527         srv_fd = open(buf, O_RDWR | O_EXCL | O_CREAT | O_REMCLO, 0444);
528         parlib_assert_perror(srv_fd >= 0);
529         ret = snprintf(buf, sizeof(buf), "%d", pipe_srv_fd);
530         ret = write(srv_fd, buf, ret);
531         parlib_assert_perror(ret > 0);
532         close(pipe_srv_fd);
533 }
534
535 /* Gets the host's IPv4 information from iplib and ndb. */
536 static void get_host_ip_addrs(void)
537 {
538         struct ndb *ndb;
539         struct ndbtuple *nt;
540         char *dns = "dns";
541         char my_ip_str[40];
542         char buf[128];
543         struct ipifc *to_free;
544         struct iplifc *lifc;
545         int ret;
546         uint8_t router_ip[IPaddrlen];
547
548         register_printf_specifier('i', printf_ipaddr, printf_ipaddr_info);
549         register_printf_specifier('M', printf_ipmask, printf_ipmask_info);
550
551         lifc = get_first_noloop_iplifc(NULL, &to_free);
552         if (!lifc) {
553                 fprintf(stderr, "IP addr lookup failed (%r), no VM networking\n");
554                 return;
555         }
556         snprintf(my_ip_str, sizeof(my_ip_str), "%i", lifc->ip);
557         snprintf(buf, sizeof(buf), "%i%M", lifc->ip, lifc->mask);
558         v4parsecidr(host_v4_addr, host_v4_mask, buf);
559         free_ipifc(to_free);
560
561         ret = my_router_addr(router_ip, NULL);
562         if (ret) {
563                 fprintf(stderr, "Router lookup failed (%r), no VM networking\n");
564                 return;
565         }
566         v6tov4(host_v4_router, router_ip);
567
568         ndb = ndbopen("/net/ndb");
569         if (!ndb) {
570                 fprintf(stderr, "NDB open failed (%r), no VM networking\n");
571                 return;
572         }
573         nt = ndbipinfo(ndb, "ip", my_ip_str, &dns, 1);
574         if (!nt) {
575                 fprintf(stderr, "DNS server lookup failed (%r), no VM networking\n");
576                 return;
577         }
578         v4parseip(host_v4_dns, nt->val);
579         ndbfree(nt);
580         ndbclose(ndb);
581 }
582
583 static void set_ip_addrs(void)
584 {
585         get_host_ip_addrs();
586
587         loopback_v4_addr[0] = 127;
588         loopback_v4_addr[1] = 0;
589         loopback_v4_addr[2] = 0;
590         loopback_v4_addr[3] = 1;
591
592         bcast_v4_addr[0] = 255;
593         bcast_v4_addr[1] = 255;
594         bcast_v4_addr[2] = 255;
595         bcast_v4_addr[3] = 255;
596
597         /* even in qemu mode, the guest gets the real DNS IP */
598         memcpy(guest_v4_dns, host_v4_dns, IPV4_ADDR_LEN);
599
600         if (vnet_real_ip_addrs) {
601                 memcpy(guest_v4_addr, host_v4_addr, IPV4_ADDR_LEN);
602                 memcpy(guest_v4_mask, host_v4_mask, IPV4_ADDR_LEN);
603                 memcpy(guest_v4_router, host_v4_router, IPV4_ADDR_LEN);
604         } else {
605                 guest_v4_addr[0] = 10;
606                 guest_v4_addr[1] = 0;
607                 guest_v4_addr[2] = 2;
608                 guest_v4_addr[3] = 15;
609
610                 guest_v4_mask[0] = 255;
611                 guest_v4_mask[1] = 255;
612                 guest_v4_mask[2] = 255;
613                 guest_v4_mask[3] = 0;
614
615                 guest_v4_router[0] = 10;
616                 guest_v4_router[1] = 0;
617                 guest_v4_router[2] = 2;
618                 guest_v4_router[3] = 2;
619         }
620 }
621
622 static void tap_inbound_conv(int fd)
623 {
624         struct fd_tap_req tap_req = {0};
625         int ret;
626
627         tap_req.fd = fd;
628         tap_req.cmd = FDTAP_CMD_ADD;
629         tap_req.filter = FDTAP_FILT_READABLE;
630         tap_req.ev_q = inbound_evq;
631         tap_req.ev_id = fd;
632         tap_req.data = NULL;
633         ret = sys_tap_fds(&tap_req, 1);
634         parlib_assert_perror(ret == 1);
635 }
636
637 /* For every FD tap that fires, make sure the map is on the inbound_todo list
638  * and kick the receiver.
639  *
640  * A map who's FD fires might already be on the list - it's possible for an FD
641  * to drain to 0 and get another packet (thus triggering a tap) before
642  * __poll_inbound() notices and removes it from the list. */
643 static void fdtap_watcher(void *arg)
644 {
645         struct event_msg msg[1];
646         struct ip_nat_map *map;
647
648         while (1) {
649                 uth_blockon_evqs(msg, NULL, 1, inbound_evq);
650                 map = lookup_map_by_hostfd(msg->ev_type);
651                 /* Could get an event for an FD/map that has since been reaped. */
652                 if (!map)
653                         continue;
654                 uth_mutex_lock(rx_mtx);
655                 if (!map->is_on_inbound) {
656                         map->is_on_inbound = TRUE;
657                         TAILQ_INSERT_TAIL(&inbound_todo, map, inbound);
658                         uth_cond_var_broadcast(rx_cv);
659                 } else {
660                         kref_put(&map->kref);
661                 }
662                 uth_mutex_unlock(rx_mtx);
663         }
664 }
665
666 static struct event_queue *get_inbound_evq(void)
667 {
668         struct event_queue *ceq;
669
670         ceq = get_eventq_raw();
671         ceq->ev_mbox->type = EV_MBOX_CEQ;
672         ceq_init(&ceq->ev_mbox->ceq, CEQ_OR, NR_FILE_DESC_MAX, 128);
673         /* As far as flags go, we might not want IPI in the future.  Depends on some
674          * longer range VMM/2LS changes.  Regarding INDIR, if you want to find out
675          * about the event (i.e. not poll) for non-VCPD mboxes (like this evq's
676          * mbox), then you need INDIR.  We need that for the wakeup/blockon. */
677         ceq->ev_flags = EVENT_INDIR | EVENT_SPAM_INDIR | EVENT_WAKEUP | EVENT_IPI;
678         evq_attach_wakeup_ctlr(ceq);
679         return ceq;
680 }
681
682 void vnet_port_forward(char *protocol, char *host_port, char *guest_port)
683 {
684         struct ip_nat_map *map;
685         uint8_t proto_nr;
686
687         if (!strcmp("udp", protocol)) {
688                 proto_nr = IP_UDPPROTO;
689         } else if (!strcmp("tcp", protocol)) {
690                 proto_nr = IP_TCPPROTO;
691         } else {
692                 fprintf(stderr, "Can't port forward protocol %s\n", protocol);
693                 return;
694         }
695         map = create_map(proto_nr, atoi(guest_port), host_port, TRUE);
696         if (!map) {
697                 fprintf(stderr, "Failed to set up port forward!");
698                 exit(-1);
699         }
700         add_map(map);
701 }
702
703 static void ev_handle_diag(struct event_msg *ev_msg, unsigned int ev_type,
704                            void *data)
705 {
706         map_dumper();
707 }
708
709 void vnet_init(struct virtual_machine *vm, struct virtio_vq_dev *vqdev)
710 {
711         set_ip_addrs();
712         virtio_net_set_mac(vqdev, guest_eth_addr);
713         rx_mtx = uth_mutex_alloc();
714         rx_cv = uth_cond_var_alloc();
715         if (vnet_snoop)
716                 snoop_on_virtio();
717         init_map_lookup(vm);
718         inbound_evq = get_inbound_evq();
719         vmm_run_task(vm, fdtap_watcher, NULL);
720         if (vnet_map_diagnostics)
721                 register_ev_handler(EV_FREE_APPLE_PIE, ev_handle_diag, NULL);
722 }
723
724 /* Good DHCP reference:
725  * http://www.tcpipguide.com/free/t_TCPIPDynamicHostConfigurationProtocolDHCP.htm
726  */
727 #define DHCP_MAX_OPT_LEN 200
728 #define DHCP_MAIN_BODY_LEN 236
729 #define DHCP_RSP_LEN (DHCP_MAIN_BODY_LEN + DHCP_MAX_OPT_LEN)
730 #define DHCP_LEASE_TIME 3600
731
732 #define DHCP_OP_REQ                             1
733 #define DHCP_OP_RSP                             2
734
735 #define DHCP_MSG_DISCOVER               1
736 #define DHCP_MSG_OFFER                  2
737 #define DHCP_MSG_REQUEST                3
738 #define DHCP_MSG_DECLINE                4
739 #define DHCP_MSG_ACK                    5
740 #define DHCP_MSG_NAK                    6
741 #define DHCP_MSG_RELEASE                7
742 #define DHCP_MSG_INFORM                 8
743
744 #define DHCP_MAGIC_COOKIE_1             0x63
745 #define DHCP_MAGIC_COOKIE_2             0x82
746 #define DHCP_MAGIC_COOKIE_3             0x53
747 #define DHCP_MAGIC_COOKIE_4             0x63
748
749 #define DHCP_OPT_PAD                    0
750 #define DHCP_OPT_SUBNET                 1
751 #define DHCP_OPT_ROUTER                 3
752 #define DHCP_OPT_DNS                    6
753 #define DHCP_OPT_HOSTNAME               12
754 #define DHCP_OPT_LEASE                  51
755 #define DHCP_OPT_MSG_TYPE               53
756 #define DHCP_OPT_SERVER_ID              54
757 #define DHCP_OPT_END_OF_OPT             255
758
759 static int get_dhcp_req_type(struct iovec *iov, int iovcnt)
760 {
761         size_t idx = ETH_HDR_LEN + IPV4_HDR_LEN + UDP_HDR_LEN + DHCP_MAIN_BODY_LEN;
762
763         if (!iov_has_bytes(iov, iovcnt, idx + 4)) {
764                 fprintf(stderr, "DHCP request too short!\n");
765                 return -1;
766         }
767         /* Sanity checks */
768         if ((iov_get_byte(iov, iovcnt, idx + 0) != DHCP_MAGIC_COOKIE_1) ||
769             (iov_get_byte(iov, iovcnt, idx + 1) != DHCP_MAGIC_COOKIE_2) ||
770             (iov_get_byte(iov, iovcnt, idx + 2) != DHCP_MAGIC_COOKIE_3) ||
771             (iov_get_byte(iov, iovcnt, idx + 3) != DHCP_MAGIC_COOKIE_4)) {
772                 fprintf(stderr, "DHCP request didn't have magic cookie!\n");
773                 return -1;
774         }
775         /* Some clients might ask us to look in sname or other locations, which is
776          * communicated by an option.  So far, the clients I've seen just use the
777          * main options to communicate the message type. */
778         idx += 4;
779         while (1) {
780                 if (!iov_has_bytes(iov, iovcnt, idx + 1)) {
781                         fprintf(stderr, "DHCP request too short!\n");
782                         return -1;
783                 }
784                 switch (iov_get_byte(iov, iovcnt, idx)) {
785                 case DHCP_OPT_MSG_TYPE:
786                         if (!iov_has_bytes(iov, iovcnt, idx + 3)) {
787                                 fprintf(stderr, "DHCP request too short!\n");
788                                 return -1;
789                         }
790                         return iov_get_byte(iov, iovcnt, idx + 2);
791                 case DHCP_OPT_PAD:
792                         idx += 1;
793                         break;
794                 case DHCP_OPT_END_OF_OPT:
795                         fprintf(stderr, "DHCP request without a type!\n");
796                         return -1;
797                 default:
798                         if (!iov_has_bytes(iov, iovcnt, idx + 2)) {
799                                 fprintf(stderr, "DHCP request too short!\n");
800                                 return -1;
801                         }
802                         /* idx + 1 is size of the payload.  Skip the opt, size, payload. */
803                         idx += 2 + iov_get_byte(iov, iovcnt, idx + 1);
804                         break;
805                 }
806         }
807 }
808
809 static size_t build_dhcp_response(struct iovec *iov, int iovcnt, uint8_t *buf)
810 {
811         uint8_t *p = buf;
812         int req_type;
813
814         *p++ = DHCP_OP_RSP;
815         *p++ = ETH_HTYPE_ETH;
816         *p++ = ETH_ADDR_LEN;
817         *p++ = 0x00;    /* hops */
818         /* TODO: copies XID; assumes the inbound packet had standard headers */
819         iov_memcpy_from(iov, iovcnt, ETH_HDR_LEN + IPV4_HDR_LEN + UDP_HDR_LEN + 4,
820                         p, 4);
821         p += 4;
822         p += 8;                 /* secs, flags, CIADDR */
823         memcpy(p, guest_v4_addr, IPV4_ADDR_LEN);
824         p += IPV4_ADDR_LEN;
825         memcpy(p, guest_v4_router, IPV4_ADDR_LEN);
826         p += IPV4_ADDR_LEN;
827         memcpy(p, guest_v4_router, IPV4_ADDR_LEN);
828         p += IPV4_ADDR_LEN;
829         iov_memcpy_from(iov, iovcnt, ETH_ADDR_LEN, p, ETH_ADDR_LEN);
830         p += 16;        /* CHaddr has 16 bytes, we only use 6 */
831         memcpy(p, dhcp_hostname, strlen(dhcp_hostname));
832         p += 64;
833         p += 128;
834
835         req_type = get_dhcp_req_type(iov, iovcnt);
836
837         /* DHCP options: Technically, we should be responding with whatever fields
838          * they asked for in their incoming message.  For the most part, there are a
839          * bunch of standard things we can just respond with. */
840
841         *p++ = DHCP_MAGIC_COOKIE_1;
842         *p++ = DHCP_MAGIC_COOKIE_2;
843         *p++ = DHCP_MAGIC_COOKIE_3;
844         *p++ = DHCP_MAGIC_COOKIE_4;
845
846         *p++ = DHCP_OPT_MSG_TYPE;
847         *p++ = 1;
848         switch (req_type) {
849         case DHCP_MSG_DISCOVER:
850                 *p++ = DHCP_MSG_OFFER;
851                 break;
852         case DHCP_MSG_REQUEST:
853                 *p++ = DHCP_MSG_ACK;
854                 break;
855         default:
856                 panic("Unexpected DHCP message type %d", req_type);
857         }
858
859         *p++ = DHCP_OPT_SUBNET;
860         *p++ = 4;
861         memcpy(p, guest_v4_mask, IPV4_ADDR_LEN);
862         p += IPV4_ADDR_LEN;
863
864         *p++ = DHCP_OPT_ROUTER;
865         *p++ = 4;
866         memcpy(p, guest_v4_router, IPV4_ADDR_LEN);
867         p += IPV4_ADDR_LEN;
868
869         *p++ = DHCP_OPT_DNS;
870         *p++ = 4;
871         memcpy(p, guest_v4_dns, IPV4_ADDR_LEN);
872         p += IPV4_ADDR_LEN;
873
874         *p++ = DHCP_OPT_HOSTNAME;
875         *p++ = strlen(dhcp_guestname);  /* not null-terminated */
876         memcpy(p, dhcp_guestname, strlen(dhcp_guestname));
877         p += strlen(dhcp_guestname);
878
879         if (req_type == DHCP_MSG_REQUEST) {
880                 *p++ = DHCP_OPT_LEASE;
881                 *p++ = 4;
882                 hnputl(p, DHCP_LEASE_TIME);
883                 p += 4;
884
885                 *p++ = DHCP_OPT_SERVER_ID;
886                 *p++ = 4;
887                 memcpy(p, guest_v4_dns, IPV4_ADDR_LEN);
888                 p += IPV4_ADDR_LEN;
889
890         }
891
892         *p++ = DHCP_OPT_END_OF_OPT;
893
894         return p - buf;
895 }
896
897 /* Builds a UDP packet responding to IOV with buf of payload_sz.  Sent from
898  * src_port to dst_port.  Returns the new size, including UDP headers. */
899 static size_t build_udp_response(struct iovec *iov, int iovcnt, uint8_t *buf,
900                                  size_t payload_sz,
901                                  uint16_t src_port, uint16_t dst_port)
902 {
903         uint8_t *p = buf;
904
905         hnputs(p, src_port);
906         p += 2;
907         hnputs(p, dst_port);
908         p += 2;
909         hnputs(p, payload_sz + UDP_HDR_LEN);
910         p += 2;
911         /* For v4, we don't need to do the xsum.  It's a minor pain too, since they
912          * xsum parts of the IP header too. */
913         hnputs(p, 0);
914         p += 2;
915
916         return p - buf + payload_sz;
917 }
918
919 /* Builds an IP packet responding to iov with buf of payload_sz.  Sent from->to
920  * with protocol.  Returns the new size, including IP headers.
921  *
922  * We take parameters for the IP, since some usages won't use the iov's IP (e.g.
923  * DHCP). */
924 static size_t build_ip_response(struct iovec *iov, int iovcnt, uint8_t *buf,
925                                 size_t payload_sz, uint8_t *from, uint8_t *to,
926                                 uint8_t protocol)
927 {
928         uint8_t *p = buf;
929         uint8_t *xsum_addr;
930
931         *p = 0x45;              /* version, etc */
932         p += 2;
933         hnputs(p, payload_sz + IPV4_HDR_LEN);
934         p += 2;
935         p += 4;
936         *p = 255;               /* TTL */
937         p += 1;
938         *p = protocol;
939         p += 1;
940         xsum_addr = p;
941         p += 2;
942         memcpy(p, from, IPV4_ADDR_LEN);
943         p += IPV4_ADDR_LEN;
944         memcpy(p, to, IPV4_ADDR_LEN);
945         p += IPV4_ADDR_LEN;
946         hnputs(xsum_addr, ip_calc_xsum(buf, IPV4_HDR_LEN));
947
948         return p - buf + payload_sz;
949 }
950
951 /* Builds an ethernet response to iov from buf of payload_sz.  Returns the new
952  * size, including ethernet headers. */
953 static size_t build_eth_response(struct iovec *iov, int iovcnt, uint8_t *buf,
954                                  size_t payload_sz, uint16_t ether_type)
955 {
956         uint8_t *p = buf;
957
958         iov_memcpy_from(iov, iovcnt, ETH_OFF_SRC, p, ETH_ADDR_LEN);
959         p += ETH_ADDR_LEN;
960         memcpy(p, host_eth_addr, ETH_ADDR_LEN);
961         p += ETH_ADDR_LEN;
962         hnputs(p, ether_type);
963         p += 2;
964
965         return p - buf + payload_sz;
966 }
967
968 static void fake_dhcp_response(struct iovec *iov, int iovcnt)
969 {
970         struct buf_pkt *bpkt;
971         size_t payload_sz;
972
973         switch (get_dhcp_req_type(iov, iovcnt)) {
974         case DHCP_MSG_OFFER:
975         case DHCP_MSG_DECLINE:
976         case DHCP_MSG_ACK:
977         case DHCP_MSG_NAK:
978         case DHCP_MSG_RELEASE:
979         case DHCP_MSG_INFORM:
980                 return;
981         }
982         bpkt = zalloc_bpkt(ETH_HDR_LEN + IPV4_HDR_LEN + UDP_HDR_LEN + DHCP_RSP_LEN);
983
984         payload_sz = build_dhcp_response(iov, iovcnt, bpkt->buf + ETH_HDR_LEN
985                                                       + IPV4_HDR_LEN + UDP_HDR_LEN);
986         payload_sz = build_udp_response(iov, iovcnt,
987                                         bpkt->buf + ETH_HDR_LEN + IPV4_HDR_LEN,
988                                         payload_sz, 67, 68);
989         /* For offers and initial requests, we definitely need to send it to
990          * 255.255.255.255 (bcast).  For renewals, it seems like that that also
991          * suffices, which seems reasonable. */
992         payload_sz = build_ip_response(iov, iovcnt, bpkt->buf + ETH_HDR_LEN,
993                                        payload_sz, guest_v4_router, bcast_v4_addr,
994                                        IP_UDPPROTO);
995         payload_sz = build_eth_response(iov, iovcnt, bpkt->buf, payload_sz,
996                                         ETH_TYPE_IPV4);
997
998         assert(payload_sz <= bpkt->sz);
999         bpkt->sz = payload_sz;
1000         inject_buf_pkt(bpkt);
1001 }
1002
1003 static size_t build_arp_response(struct iovec *iov, int iovcnt, uint8_t *buf)
1004 {
1005         uint8_t *p = buf;
1006
1007         hnputs(p, ETH_HTYPE_ETH);
1008         p += 2;
1009         hnputs(p, ETH_TYPE_IPV4);
1010         p += 2;
1011         *p++ = ETH_ADDR_LEN;
1012         *p++ = IPV4_ADDR_LEN;
1013         hnputs(p, ARP_OP_RSP);
1014         p += 2;
1015         /* SHA: addr they are looking for, which is always host's eth addr */
1016         memcpy(p, host_eth_addr, ETH_ADDR_LEN);
1017         p += ETH_ADDR_LEN;
1018         /* SPA: addr they are looking for, which was the request TPA */
1019         iov_memcpy_from(iov, iovcnt, ETH_HDR_LEN + ARP_OFF_TPA, p, IPV4_ADDR_LEN);
1020         p += IPV4_ADDR_LEN;
1021         /* THA was the SHA of the request */
1022         iov_memcpy_from(iov, iovcnt, ETH_HDR_LEN + ARP_OFF_SHA, p, ETH_ADDR_LEN);
1023         p += ETH_ADDR_LEN;
1024         /* TPA was the SPA of the request */
1025         iov_memcpy_from(iov, iovcnt, ETH_HDR_LEN + ARP_OFF_SPA, p, IPV4_ADDR_LEN);
1026         p += IPV4_ADDR_LEN;
1027
1028         return p - buf;
1029 }
1030
1031 static bool should_ignore_arp(struct iovec *iov, int iovcnt)
1032 {
1033         size_t arp_off = ETH_HDR_LEN;
1034
1035         if (iov_get_be16(iov, iovcnt, arp_off + ARP_OFF_OP) != ARP_OP_REQ)
1036                 return TRUE;
1037         /* ARP probes set the SPA to 0.  Ignore these. */
1038         if (iov_get_be32(iov, iovcnt, arp_off + ARP_OFF_SPA) == 0)
1039                 return TRUE;
1040         return FALSE;
1041 }
1042
1043 static void handle_arp_tx(struct iovec *iov, int iovcnt)
1044 {
1045         struct buf_pkt *bpkt;
1046         size_t payload_sz;
1047
1048         if (should_ignore_arp(iov, iovcnt))
1049                 return;
1050         bpkt = zalloc_bpkt(ETH_HDR_LEN + ARP_PKT_LEN);
1051         payload_sz = build_arp_response(iov, iovcnt, bpkt->buf + ETH_HDR_LEN);
1052         payload_sz = build_eth_response(iov, iovcnt, bpkt->buf, payload_sz,
1053                                         ETH_TYPE_ARP);
1054         assert(payload_sz <= bpkt->sz);
1055         bpkt->sz = payload_sz;
1056         inject_buf_pkt(bpkt);
1057 }
1058
1059 /* Helper for protocols: updates an xsum, given a port number change */
1060 static void xsum_changed_port(struct iovec *iov, int iovcnt, size_t xsum_off,
1061                               uint16_t old_port, uint16_t new_port)
1062 {
1063         uint16_t old_port_be, new_port_be;
1064
1065         /* xsum update expects to work on big endian */
1066         hnputs(&old_port_be, old_port);
1067         hnputs(&new_port_be, new_port);
1068         xsum_update(iov, iovcnt, xsum_off, (uint8_t*)&old_port_be,
1069                     (uint8_t*)&new_port_be, 2);
1070 }
1071
1072 static struct ip_nat_map *handle_udp_tx(struct iovec *iov, int iovcnt,
1073                                         size_t udp_off)
1074 {
1075         uint16_t src_port, dst_port;
1076         struct ip_nat_map *map;
1077
1078         if (!iov_has_bytes(iov, iovcnt, udp_off + UDP_HDR_LEN)) {
1079                 fprintf(stderr, "Short UDP header, dropping!\n");
1080                 return NULL;
1081         }
1082         src_port = iov_get_be16(iov, iovcnt, udp_off + UDP_OFF_SRC_PORT);
1083         dst_port = iov_get_be16(iov, iovcnt, udp_off + UDP_OFF_DST_PORT);
1084         if (dst_port == 67) {
1085                 fake_dhcp_response(iov, iovcnt);
1086                 return NULL;
1087         }
1088         map = get_map_by_tuple(IP_UDPPROTO, src_port);
1089         if (!map)
1090                 return NULL;
1091         xsum_changed_port(iov, iovcnt, udp_off + UDP_OFF_XSUM, src_port,
1092                           map->host_port);
1093         iov_put_be16(iov, iovcnt, udp_off + UDP_OFF_SRC_PORT, map->host_port);
1094         return map;
1095 }
1096
1097 static struct ip_nat_map *handle_tcp_tx(struct iovec *iov, int iovcnt,
1098                                         size_t tcp_off)
1099 {
1100         uint16_t src_port, dst_port;
1101         struct ip_nat_map *map;
1102
1103         if (!iov_has_bytes(iov, iovcnt, tcp_off + TCP_HDR_LEN)) {
1104                 fprintf(stderr, "Short TCP header, dropping!\n");
1105                 return NULL;
1106         }
1107         src_port = iov_get_be16(iov, iovcnt, tcp_off + TCP_OFF_SRC_PORT);
1108         dst_port = iov_get_be16(iov, iovcnt, tcp_off + TCP_OFF_DST_PORT);
1109         map = get_map_by_tuple(IP_TCPPROTO, src_port);
1110         if (!map)
1111                 return NULL;
1112         xsum_changed_port(iov, iovcnt, tcp_off + TCP_OFF_XSUM, src_port,
1113                           map->host_port);
1114         iov_put_be16(iov, iovcnt, tcp_off + TCP_OFF_SRC_PORT, map->host_port);
1115         return map;
1116 }
1117
1118 static struct ip_nat_map *handle_icmp_tx(struct iovec *iov, int iovcnt,
1119                                          size_t icmp_off)
1120 {
1121         /* TODO: we could respond to pings sent to us (router_ip).  For anything
1122          * else, we'll need to work with the bypass (if possible, maybe ID it with
1123          * the Identifier field and map that to the bypassed conv)). */
1124         return NULL;
1125 }
1126
1127 /* Some protocols (like TCP and UDP) need to adjust their xsums whenever an IPv4
1128  * address changes. */
1129 static void ipv4_proto_changed_addr(struct iovec *iov, int iovcnt,
1130                                     uint8_t protocol, size_t proto_hdr_off,
1131                                     uint8_t *old_addr, uint8_t *new_addr)
1132 {
1133         switch (protocol) {
1134         case IP_UDPPROTO:
1135                 xsum_update(iov, iovcnt, proto_hdr_off + UDP_OFF_XSUM, old_addr,
1136                             new_addr, IPV4_ADDR_LEN);
1137                 break;
1138         case IP_TCPPROTO:
1139                 xsum_update(iov, iovcnt, proto_hdr_off + TCP_OFF_XSUM, old_addr,
1140                             new_addr, IPV4_ADDR_LEN);
1141                 break;
1142         }
1143 }
1144
1145 /* Helper, changes a packet's IP address, updating xsums.  'which' controls
1146  * whether we're changing the src or dst address. */
1147 static void ipv4_change_addr(struct iovec *iov, int iovcnt, size_t ip_off,
1148                              uint8_t protocol, uint8_t proto_hdr_off,
1149                              uint8_t *old_addr, uint8_t *new_addr, size_t which)
1150 {
1151         xsum_update(iov, iovcnt, ip_off + IPV4_OFF_XSUM, old_addr, new_addr,
1152                     IPV4_ADDR_LEN);
1153         ipv4_proto_changed_addr(iov, iovcnt, protocol, proto_hdr_off, old_addr,
1154                                 new_addr);
1155         iov_memcpy_to(iov, iovcnt, ip_off + which, new_addr, IPV4_ADDR_LEN);
1156 }
1157
1158 static size_t ipv4_get_header_len(struct iovec *iov, int iovcnt, size_t ip_off)
1159 {
1160         /* First byte, lower nibble, times 4. */
1161         return (iov_get_byte(iov, iovcnt, ip_off + 0) & 0x0f) * 4;
1162 }
1163
1164 static size_t ipv4_get_proto_off(struct iovec *iov, int iovcnt, size_t ip_off)
1165 {
1166         return ipv4_get_header_len(iov, iovcnt, ip_off) + ip_off;
1167 }
1168
1169 static uint8_t ipv4_get_version(struct iovec *iov, int iovcnt, size_t ip_off)
1170 {
1171         /* First byte, upper nibble, but keep in the upper nibble location */
1172         return iov_get_byte(iov, iovcnt, ip_off + 0) & 0xf0;
1173 }
1174
1175 static void handle_ipv4_tx(struct iovec *iov, int iovcnt)
1176 {
1177         size_t ip_off = ETH_HDR_LEN;
1178         uint8_t protocol;
1179         size_t proto_hdr_off;
1180         struct ip_nat_map *map;
1181         uint8_t src_addr[IPV4_ADDR_LEN];
1182         uint8_t dst_addr[IPV4_ADDR_LEN];
1183
1184         if (!iov_has_bytes(iov, iovcnt, ip_off + IPV4_HDR_LEN)) {
1185                 fprintf(stderr, "Short IPv4 header, dropping!\n");
1186                 return;
1187         }
1188         /* It's up to each protocol to give us the ip_nat_map matching the packet
1189          * and to change the packet's src port. */
1190         protocol = iov_get_byte(iov, iovcnt, ip_off + IPV4_OFF_PROTO);
1191         proto_hdr_off = ipv4_get_proto_off(iov, iovcnt, ip_off);
1192         switch (protocol) {
1193         case IP_UDPPROTO:
1194                 map = handle_udp_tx(iov, iovcnt, proto_hdr_off);
1195                 break;
1196         case IP_TCPPROTO:
1197                 map = handle_tcp_tx(iov, iovcnt, proto_hdr_off);
1198                 break;
1199         case IP_ICMPPROTO:
1200                 map = handle_icmp_tx(iov, iovcnt, proto_hdr_off);
1201                 break;
1202         }
1203         /* If the protocol handler already dealt with it (e.g. via emulation), we
1204          * bail out.  o/w, they gave us the remapping we should use to rewrite and
1205          * send the packet. */
1206         if (!map)
1207                 return;
1208         /* At this point, we have a refcnted map, which will keep the map alive and
1209          * its FD open. */
1210         iov_memcpy_from(iov, iovcnt, ip_off + IPV4_OFF_SRC, src_addr,
1211                         IPV4_ADDR_LEN);
1212         iov_memcpy_from(iov, iovcnt, ip_off + IPV4_OFF_DST, dst_addr,
1213                         IPV4_ADDR_LEN);
1214         /* If the destination is the ROUTER_IP, then it's really meant to go to the
1215          * host (loopback).  In that case, we also need the src to be loopback, so
1216          * that the *host's* IP stack recognizes the connection (necessary for
1217          * host-initiated connections via static maps). */
1218         if (!memcmp(dst_addr, guest_v4_router, IPV4_ADDR_LEN)) {
1219                 ipv4_change_addr(iov, iovcnt, ip_off, protocol, proto_hdr_off,
1220                                  dst_addr, loopback_v4_addr, IPV4_OFF_DST);
1221                 ipv4_change_addr(iov, iovcnt, ip_off, protocol, proto_hdr_off,
1222                                  src_addr, loopback_v4_addr, IPV4_OFF_SRC);
1223         } else {
1224                 ipv4_change_addr(iov, iovcnt, ip_off, protocol, proto_hdr_off,
1225                                  src_addr, host_v4_addr, IPV4_OFF_SRC);
1226         }
1227         /* We didn't change the size of the packet, just a few fields.  So we
1228          * shouldn't need to worry about iov[] being too big.  This is different
1229          * than the receive case, where the guest should give us an MTU-sized iov.
1230          * Here, they just gave us whatever they wanted to send.
1231          *
1232          * However, we still need to drop the ethernet header from the front of the
1233          * packet, and just send the IP header + payload. */
1234         iov_strip_bytes(iov, iovcnt, ETH_HDR_LEN);
1235         /* As far as blocking goes, this is like blasting out a raw IP packet.  It
1236          * shouldn't block, preferring to drop, though there might be some cases
1237          * where a qlock is grabbed or the medium/NIC blocks. */
1238         writev(map->host_data_fd, iov, iovcnt);
1239         map->is_stale = FALSE;
1240         kref_put(&map->kref);
1241 }
1242
1243 static void handle_ipv6_tx(struct iovec *iov, int iovcnt)
1244 {
1245 }
1246
1247 /* virtio-net calls this when the guest transmits a packet */
1248 int vnet_transmit_packet(struct iovec *iov, int iovcnt)
1249 {
1250         uint16_t ether_type;
1251
1252         if (vnet_snoop)
1253                 writev(snoop_fd, iov, iovcnt);
1254         if (!iov_has_bytes(iov, iovcnt, ETH_HDR_LEN)) {
1255                 fprintf(stderr, "Short ethernet frame from the guest, dropping!\n");
1256                 return -1;
1257         }
1258         ether_type = iov_get_be16(iov, iovcnt, ETH_OFF_ETYPE);
1259         switch (ether_type) {
1260         case ETH_TYPE_ARP:
1261                 handle_arp_tx(iov, iovcnt);
1262                 break;
1263         case ETH_TYPE_IPV4:
1264                 handle_ipv4_tx(iov, iovcnt);
1265                 break;
1266         case ETH_TYPE_IPV6:
1267                 handle_ipv6_tx(iov, iovcnt);
1268                 break;
1269         default:
1270                 fprintf(stderr, "Unknown ethertype 0x%x, dropping!\n", ether_type);
1271                 return -1;
1272         };
1273         return 0;
1274 }
1275
1276 /* Polls for injected packets, filling the iov[iovcnt] on success and returning
1277  * the amount.  0 means 'nothing there.' */
1278 static size_t __poll_injection(struct iovec *iov, int iovcnt)
1279 {
1280         size_t ret;
1281         struct buf_pkt *bpkt;
1282
1283         if (STAILQ_EMPTY(&inject_pkts))
1284                 return 0;
1285         bpkt = STAILQ_FIRST(&inject_pkts);
1286         STAILQ_REMOVE_HEAD(&inject_pkts, next);
1287         iov_memcpy_to(iov, iovcnt, 0, bpkt->buf, bpkt->sz);
1288         ret = bpkt->sz;
1289         free_bpkt(bpkt);
1290         return ret;
1291 }
1292
1293 static void handle_udp_rx(struct iovec *iov, int iovcnt, size_t len,
1294                           struct ip_nat_map *map, size_t udp_off)
1295 {
1296         assert(len >= udp_off + UDP_HDR_LEN);
1297         xsum_changed_port(iov, iovcnt, udp_off + UDP_OFF_XSUM,
1298                           iov_get_be16(iov, iovcnt, udp_off + UDP_OFF_DST_PORT),
1299                           map->guest_port);
1300         iov_put_be16(iov, iovcnt, udp_off + UDP_OFF_DST_PORT, map->guest_port);
1301 }
1302
1303 static void handle_tcp_rx(struct iovec *iov, int iovcnt, size_t len,
1304                           struct ip_nat_map *map, size_t tcp_off)
1305 {
1306         assert(len >= tcp_off + TCP_HDR_LEN);
1307         xsum_changed_port(iov, iovcnt, tcp_off + TCP_OFF_XSUM,
1308                           iov_get_be16(iov, iovcnt, tcp_off + TCP_OFF_DST_PORT),
1309                           map->guest_port);
1310         iov_put_be16(iov, iovcnt, tcp_off + TCP_OFF_DST_PORT, map->guest_port);
1311 }
1312
1313 /* Computes and stores the xsum for the ipv4 header in the iov. */
1314 static void xsum_ipv4_header(struct iovec *iov, int iovcnt, size_t ip_off)
1315 {
1316         size_t hdr_len = ipv4_get_header_len(iov, iovcnt, ip_off);
1317         uint8_t buf[hdr_len];
1318
1319         iov_memcpy_from(iov, iovcnt, ip_off, buf, hdr_len);
1320         *(uint16_t*)&buf[IPV4_OFF_XSUM] = 0;
1321         iov_put_be16(iov, iovcnt, ip_off + IPV4_OFF_XSUM,
1322                      ip_calc_xsum(buf, IPV4_HDR_LEN));
1323 }
1324
1325 static void handle_ipv4_rx(struct iovec *iov, int iovcnt, size_t len,
1326                            struct ip_nat_map *map)
1327 {
1328         size_t ip_off = ETH_HDR_LEN;
1329         uint8_t protocol;
1330         size_t proto_hdr_off;
1331         uint8_t src_addr[IPV4_ADDR_LEN];
1332         uint8_t dst_addr[IPV4_ADDR_LEN];
1333
1334         protocol = iov_get_byte(iov, iovcnt, ip_off + IPV4_OFF_PROTO);
1335         proto_hdr_off = ipv4_get_proto_off(iov, iovcnt, ip_off);
1336         switch (map->protocol) {
1337         case IP_UDPPROTO:
1338                 handle_udp_rx(iov, iovcnt, len, map, proto_hdr_off);
1339                 break;
1340         case IP_TCPPROTO:
1341                 handle_tcp_rx(iov, iovcnt, len, map, proto_hdr_off);
1342                 break;
1343         default:
1344                 panic("Bad proto %d on map for conv FD %d\n", map->protocol,
1345                       map->host_data_fd);
1346         }
1347         iov_memcpy_from(iov, iovcnt, ip_off + IPV4_OFF_SRC, src_addr,
1348                         IPV4_ADDR_LEN);
1349         iov_memcpy_from(iov, iovcnt, ip_off + IPV4_OFF_DST, dst_addr,
1350                         IPV4_ADDR_LEN);
1351         /* If the src was the host (loopback), the guest thinks the remote is
1352          * ROUTER_IP. */
1353         if (!memcmp(src_addr, loopback_v4_addr, IPV4_ADDR_LEN)) {
1354                 ipv4_change_addr(iov, iovcnt, ip_off, map->protocol, proto_hdr_off,
1355                                  src_addr, guest_v4_router, IPV4_OFF_SRC);
1356         }
1357         /* Interesting case.  If we rewrite it to guest_v4_router, when the guest
1358          * responds, *that* packet will get rewritten to loopback.  If we ignore it,
1359          * and it's qemu mode, it'll actually work.  If it's real addr mode, the
1360          * guest won't send an IP packet out that it thinks is for itself.  */
1361         if (vnet_real_ip_addrs && !memcmp(src_addr, host_v4_addr, IPV4_ADDR_LEN)) {
1362                 fprintf(stderr, "VNET received packet from host_v4_addr.  Not translating, the guest cannot respond!\n");
1363         }
1364         /* Regardless, the dst changes from HOST_IP/loopback to GUEST_IP */
1365         ipv4_change_addr(iov, iovcnt, ip_off, map->protocol, proto_hdr_off,
1366                          dst_addr, guest_v4_addr, IPV4_OFF_DST);
1367         /* Note we did the incremental xsum for the IP header, but also do a final
1368          * xsum.  We need the final xsum in case the kernel's networking stack
1369          * messed up the header. */
1370         xsum_ipv4_header(iov, iovcnt, ip_off);
1371 }
1372
1373 /* NAT / translate an inbound packet iov[len], using map.  If a packet comes in
1374  * on a certain FD, then it's going to the guest at the appropriate port, no
1375  * questions asked.
1376  *
1377  * The iov has ETH_HDR_LEN bytes at the front.  The data actually read from the
1378  * conv starts at that offset.  len includes this frontal padding - it's the
1379  * full length of the real data in the iov + the ethernet header.  len may
1380  * include data beyond the IP packet length; we often get padding from the
1381  * kernel networking stack.  Returns the final size of the packet. */
1382 static size_t handle_rx(struct iovec *iov, int iovcnt, size_t len,
1383                         struct ip_nat_map *map)
1384 {
1385         size_t ip_off = ETH_HDR_LEN;
1386         uint8_t version;
1387         uint16_t ether_type;
1388
1389         /* The conv is reading from a Qmsg queue.  We should always receive at least
1390          * an IPv4 header from the kernel. */
1391         assert(len >= IPV4_HDR_LEN + ETH_HDR_LEN);
1392         version = ipv4_get_version(iov, iovcnt, ip_off);
1393         switch (version) {
1394         case IP_VER4:
1395                 ether_type = ETH_TYPE_IPV4;
1396                 handle_ipv4_rx(iov, iovcnt, len, map);
1397                 break;
1398         case IP_VER6:
1399                 ether_type = ETH_TYPE_IPV6;
1400                 /* Technically, this could be a bad actor outside our node */
1401                 panic("Got an IPv6 packet on FD %d!\n", map->host_data_fd);
1402         default:
1403                 panic("Unexpected IP version 0x%x, probably a bug", version);
1404         }
1405         iov_memcpy_to(iov, iovcnt, ETH_OFF_DST, guest_eth_addr, ETH_ADDR_LEN);
1406         iov_memcpy_to(iov, iovcnt, ETH_OFF_SRC, host_eth_addr, ETH_ADDR_LEN);
1407         iov_put_be16(iov, iovcnt, ETH_OFF_ETYPE, ether_type);
1408         return len;
1409 }
1410
1411 /* Polls for inbound packets on the host's FD, filling the iov[iovcnt] on
1412  * success and returning the amount.  0 means 'nothing there.'
1413  *
1414  * Notes on concurrency:
1415  * - The inbound_todo list is protected by the rx_mtx.  Since we're readv()ing
1416  *   while holding the mtx (because we're in a FOREACH), we're single threaded
1417  *   in the RX path.
1418  * - The inbound_todo list is filled by another thread that puts maps on the
1419  *   list whenever their FD tap fires.
1420  * - The maps on the inbound_todo list are refcounted.  It's possible for them
1421  *   to be reaped and removed from the mapping lookup, but the mapping would
1422  *   stay around until we drained all of the packets from the inbound conv. */
1423 static size_t __poll_inbound(struct iovec *iov, int iovcnt)
1424 {
1425         struct ip_nat_map *i, *temp;
1426         ssize_t pkt_sz = 0;
1427         struct iovec iov_copy[iovcnt];
1428
1429         /* We're going to readv ETH_HDR_LEN bytes into the iov.  To do so, we'll use
1430          * a separate iov to track this offset.  The iov and iov_copy both point to
1431          * the same memory (minus the stripping). */
1432         memcpy(iov_copy, iov, sizeof(struct iovec) * iovcnt);
1433         iov_strip_bytes(iov_copy, iovcnt, ETH_HDR_LEN);
1434         TAILQ_FOREACH_SAFE(i, &inbound_todo, inbound, temp) {
1435                 pkt_sz = readv(i->host_data_fd, iov_copy, iovcnt);
1436                 if (pkt_sz > 0) {
1437                         i->is_stale = FALSE;
1438                         return handle_rx(iov, iovcnt, pkt_sz + ETH_HDR_LEN, i);
1439                 }
1440                 parlib_assert_perror(errno == EAGAIN);
1441                 TAILQ_REMOVE(&inbound_todo, i, inbound);
1442                 i->is_on_inbound = FALSE;
1443                 kref_put(&i->kref);
1444         }
1445         return 0;
1446 }
1447
1448 /* virtio-net calls this when it wants us to fill iov with a packet. */
1449 int vnet_receive_packet(struct iovec *iov, int iovcnt)
1450 {
1451         size_t rx_amt;
1452
1453         uth_mutex_lock(rx_mtx);
1454         while (1) {
1455                 rx_amt = __poll_injection(iov, iovcnt);
1456                 if (rx_amt)
1457                         break;
1458                 rx_amt = __poll_inbound(iov, iovcnt);
1459                 if (rx_amt)
1460                         break;
1461                 uth_cond_var_wait(rx_cv, rx_mtx);
1462         }
1463         uth_mutex_unlock(rx_mtx);
1464         iov_trim_len_to(iov, iovcnt, rx_amt);
1465         if (vnet_snoop)
1466                 writev(snoop_fd, iov, iovcnt);
1467         return rx_amt;
1468 }