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