xref: /openbmc/qemu/net/net.c (revision 35d08458)
1 /*
2  * QEMU System Emulator
3  *
4  * Copyright (c) 2003-2008 Fabrice Bellard
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a copy
7  * of this software and associated documentation files (the "Software"), to deal
8  * in the Software without restriction, including without limitation the rights
9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10  * copies of the Software, and to permit persons to whom the Software is
11  * furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in
14  * all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22  * THE SOFTWARE.
23  */
24 #include "config-host.h"
25 
26 #include "net/net.h"
27 #include "clients.h"
28 #include "hub.h"
29 #include "net/slirp.h"
30 #include "net/eth.h"
31 #include "util.h"
32 
33 #include "monitor/monitor.h"
34 #include "qemu-common.h"
35 #include "qemu/sockets.h"
36 #include "qemu/config-file.h"
37 #include "qmp-commands.h"
38 #include "hw/qdev.h"
39 #include "qemu/iov.h"
40 #include "qemu/main-loop.h"
41 #include "qapi-visit.h"
42 #include "qapi/opts-visitor.h"
43 #include "qapi/dealloc-visitor.h"
44 
45 /* Net bridge is currently not supported for W32. */
46 #if !defined(_WIN32)
47 # define CONFIG_NET_BRIDGE
48 #endif
49 
50 static QTAILQ_HEAD(, NetClientState) net_clients;
51 
52 int default_net = 1;
53 
54 /***********************************************************/
55 /* network device redirectors */
56 
57 #if defined(DEBUG_NET)
58 static void hex_dump(FILE *f, const uint8_t *buf, int size)
59 {
60     int len, i, j, c;
61 
62     for(i=0;i<size;i+=16) {
63         len = size - i;
64         if (len > 16)
65             len = 16;
66         fprintf(f, "%08x ", i);
67         for(j=0;j<16;j++) {
68             if (j < len)
69                 fprintf(f, " %02x", buf[i+j]);
70             else
71                 fprintf(f, "   ");
72         }
73         fprintf(f, " ");
74         for(j=0;j<len;j++) {
75             c = buf[i+j];
76             if (c < ' ' || c > '~')
77                 c = '.';
78             fprintf(f, "%c", c);
79         }
80         fprintf(f, "\n");
81     }
82 }
83 #endif
84 
85 static int get_str_sep(char *buf, int buf_size, const char **pp, int sep)
86 {
87     const char *p, *p1;
88     int len;
89     p = *pp;
90     p1 = strchr(p, sep);
91     if (!p1)
92         return -1;
93     len = p1 - p;
94     p1++;
95     if (buf_size > 0) {
96         if (len > buf_size - 1)
97             len = buf_size - 1;
98         memcpy(buf, p, len);
99         buf[len] = '\0';
100     }
101     *pp = p1;
102     return 0;
103 }
104 
105 int parse_host_port(struct sockaddr_in *saddr, const char *str)
106 {
107     char buf[512];
108     struct hostent *he;
109     const char *p, *r;
110     int port;
111 
112     p = str;
113     if (get_str_sep(buf, sizeof(buf), &p, ':') < 0)
114         return -1;
115     saddr->sin_family = AF_INET;
116     if (buf[0] == '\0') {
117         saddr->sin_addr.s_addr = 0;
118     } else {
119         if (qemu_isdigit(buf[0])) {
120             if (!inet_aton(buf, &saddr->sin_addr))
121                 return -1;
122         } else {
123             if ((he = gethostbyname(buf)) == NULL)
124                 return - 1;
125             saddr->sin_addr = *(struct in_addr *)he->h_addr;
126         }
127     }
128     port = strtol(p, (char **)&r, 0);
129     if (r == p)
130         return -1;
131     saddr->sin_port = htons(port);
132     return 0;
133 }
134 
135 void qemu_format_nic_info_str(NetClientState *nc, uint8_t macaddr[6])
136 {
137     snprintf(nc->info_str, sizeof(nc->info_str),
138              "model=%s,macaddr=%02x:%02x:%02x:%02x:%02x:%02x",
139              nc->model,
140              macaddr[0], macaddr[1], macaddr[2],
141              macaddr[3], macaddr[4], macaddr[5]);
142 }
143 
144 void qemu_macaddr_default_if_unset(MACAddr *macaddr)
145 {
146     static int index = 0;
147     static const MACAddr zero = { .a = { 0,0,0,0,0,0 } };
148 
149     if (memcmp(macaddr, &zero, sizeof(zero)) != 0)
150         return;
151     macaddr->a[0] = 0x52;
152     macaddr->a[1] = 0x54;
153     macaddr->a[2] = 0x00;
154     macaddr->a[3] = 0x12;
155     macaddr->a[4] = 0x34;
156     macaddr->a[5] = 0x56 + index++;
157 }
158 
159 /**
160  * Generate a name for net client
161  *
162  * Only net clients created with the legacy -net option and NICs need this.
163  */
164 static char *assign_name(NetClientState *nc1, const char *model)
165 {
166     NetClientState *nc;
167     int id = 0;
168 
169     QTAILQ_FOREACH(nc, &net_clients, next) {
170         if (nc == nc1) {
171             continue;
172         }
173         if (strcmp(nc->model, model) == 0) {
174             id++;
175         }
176     }
177 
178     return g_strdup_printf("%s.%d", model, id);
179 }
180 
181 static void qemu_net_client_destructor(NetClientState *nc)
182 {
183     g_free(nc);
184 }
185 
186 static void qemu_net_client_setup(NetClientState *nc,
187                                   NetClientInfo *info,
188                                   NetClientState *peer,
189                                   const char *model,
190                                   const char *name,
191                                   NetClientDestructor *destructor)
192 {
193     nc->info = info;
194     nc->model = g_strdup(model);
195     if (name) {
196         nc->name = g_strdup(name);
197     } else {
198         nc->name = assign_name(nc, model);
199     }
200 
201     if (peer) {
202         assert(!peer->peer);
203         nc->peer = peer;
204         peer->peer = nc;
205     }
206     QTAILQ_INSERT_TAIL(&net_clients, nc, next);
207 
208     nc->incoming_queue = qemu_new_net_queue(nc);
209     nc->destructor = destructor;
210 }
211 
212 NetClientState *qemu_new_net_client(NetClientInfo *info,
213                                     NetClientState *peer,
214                                     const char *model,
215                                     const char *name)
216 {
217     NetClientState *nc;
218 
219     assert(info->size >= sizeof(NetClientState));
220 
221     nc = g_malloc0(info->size);
222     qemu_net_client_setup(nc, info, peer, model, name,
223                           qemu_net_client_destructor);
224 
225     return nc;
226 }
227 
228 NICState *qemu_new_nic(NetClientInfo *info,
229                        NICConf *conf,
230                        const char *model,
231                        const char *name,
232                        void *opaque)
233 {
234     NetClientState **peers = conf->peers.ncs;
235     NICState *nic;
236     int i, queues = MAX(1, conf->queues);
237 
238     assert(info->type == NET_CLIENT_OPTIONS_KIND_NIC);
239     assert(info->size >= sizeof(NICState));
240 
241     nic = g_malloc0(info->size + sizeof(NetClientState) * queues);
242     nic->ncs = (void *)nic + info->size;
243     nic->conf = conf;
244     nic->opaque = opaque;
245 
246     for (i = 0; i < queues; i++) {
247         qemu_net_client_setup(&nic->ncs[i], info, peers[i], model, name,
248                               NULL);
249         nic->ncs[i].queue_index = i;
250     }
251 
252     return nic;
253 }
254 
255 NetClientState *qemu_get_subqueue(NICState *nic, int queue_index)
256 {
257     return nic->ncs + queue_index;
258 }
259 
260 NetClientState *qemu_get_queue(NICState *nic)
261 {
262     return qemu_get_subqueue(nic, 0);
263 }
264 
265 NICState *qemu_get_nic(NetClientState *nc)
266 {
267     NetClientState *nc0 = nc - nc->queue_index;
268 
269     return (NICState *)((void *)nc0 - nc->info->size);
270 }
271 
272 void *qemu_get_nic_opaque(NetClientState *nc)
273 {
274     NICState *nic = qemu_get_nic(nc);
275 
276     return nic->opaque;
277 }
278 
279 static void qemu_cleanup_net_client(NetClientState *nc)
280 {
281     QTAILQ_REMOVE(&net_clients, nc, next);
282 
283     if (nc->info->cleanup) {
284         nc->info->cleanup(nc);
285     }
286 }
287 
288 static void qemu_free_net_client(NetClientState *nc)
289 {
290     if (nc->incoming_queue) {
291         qemu_del_net_queue(nc->incoming_queue);
292     }
293     if (nc->peer) {
294         nc->peer->peer = NULL;
295     }
296     g_free(nc->name);
297     g_free(nc->model);
298     if (nc->destructor) {
299         nc->destructor(nc);
300     }
301 }
302 
303 void qemu_del_net_client(NetClientState *nc)
304 {
305     NetClientState *ncs[MAX_QUEUE_NUM];
306     int queues, i;
307 
308     /* If the NetClientState belongs to a multiqueue backend, we will change all
309      * other NetClientStates also.
310      */
311     queues = qemu_find_net_clients_except(nc->name, ncs,
312                                           NET_CLIENT_OPTIONS_KIND_NIC,
313                                           MAX_QUEUE_NUM);
314     assert(queues != 0);
315 
316     /* If there is a peer NIC, delete and cleanup client, but do not free. */
317     if (nc->peer && nc->peer->info->type == NET_CLIENT_OPTIONS_KIND_NIC) {
318         NICState *nic = qemu_get_nic(nc->peer);
319         if (nic->peer_deleted) {
320             return;
321         }
322         nic->peer_deleted = true;
323 
324         for (i = 0; i < queues; i++) {
325             ncs[i]->peer->link_down = true;
326         }
327 
328         if (nc->peer->info->link_status_changed) {
329             nc->peer->info->link_status_changed(nc->peer);
330         }
331 
332         for (i = 0; i < queues; i++) {
333             qemu_cleanup_net_client(ncs[i]);
334         }
335 
336         return;
337     }
338 
339     assert(nc->info->type != NET_CLIENT_OPTIONS_KIND_NIC);
340 
341     for (i = 0; i < queues; i++) {
342         qemu_cleanup_net_client(ncs[i]);
343         qemu_free_net_client(ncs[i]);
344     }
345 }
346 
347 void qemu_del_nic(NICState *nic)
348 {
349     int i, queues = MAX(nic->conf->queues, 1);
350 
351     /* If this is a peer NIC and peer has already been deleted, free it now. */
352     if (nic->peer_deleted) {
353         for (i = 0; i < queues; i++) {
354             qemu_free_net_client(qemu_get_subqueue(nic, i)->peer);
355         }
356     }
357 
358     for (i = queues - 1; i >= 0; i--) {
359         NetClientState *nc = qemu_get_subqueue(nic, i);
360 
361         qemu_cleanup_net_client(nc);
362         qemu_free_net_client(nc);
363     }
364 
365     g_free(nic);
366 }
367 
368 void qemu_foreach_nic(qemu_nic_foreach func, void *opaque)
369 {
370     NetClientState *nc;
371 
372     QTAILQ_FOREACH(nc, &net_clients, next) {
373         if (nc->info->type == NET_CLIENT_OPTIONS_KIND_NIC) {
374             if (nc->queue_index == 0) {
375                 func(qemu_get_nic(nc), opaque);
376             }
377         }
378     }
379 }
380 
381 bool qemu_has_ufo(NetClientState *nc)
382 {
383     if (!nc || !nc->info->has_ufo) {
384         return false;
385     }
386 
387     return nc->info->has_ufo(nc);
388 }
389 
390 bool qemu_has_vnet_hdr(NetClientState *nc)
391 {
392     if (!nc || !nc->info->has_vnet_hdr) {
393         return false;
394     }
395 
396     return nc->info->has_vnet_hdr(nc);
397 }
398 
399 bool qemu_has_vnet_hdr_len(NetClientState *nc, int len)
400 {
401     if (!nc || !nc->info->has_vnet_hdr_len) {
402         return false;
403     }
404 
405     return nc->info->has_vnet_hdr_len(nc, len);
406 }
407 
408 void qemu_using_vnet_hdr(NetClientState *nc, bool enable)
409 {
410     if (!nc || !nc->info->using_vnet_hdr) {
411         return;
412     }
413 
414     nc->info->using_vnet_hdr(nc, enable);
415 }
416 
417 void qemu_set_offload(NetClientState *nc, int csum, int tso4, int tso6,
418                           int ecn, int ufo)
419 {
420     if (!nc || !nc->info->set_offload) {
421         return;
422     }
423 
424     nc->info->set_offload(nc, csum, tso4, tso6, ecn, ufo);
425 }
426 
427 void qemu_set_vnet_hdr_len(NetClientState *nc, int len)
428 {
429     if (!nc || !nc->info->set_vnet_hdr_len) {
430         return;
431     }
432 
433     nc->info->set_vnet_hdr_len(nc, len);
434 }
435 
436 int qemu_can_send_packet(NetClientState *sender)
437 {
438     if (!sender->peer) {
439         return 1;
440     }
441 
442     if (sender->peer->receive_disabled) {
443         return 0;
444     } else if (sender->peer->info->can_receive &&
445                !sender->peer->info->can_receive(sender->peer)) {
446         return 0;
447     }
448     return 1;
449 }
450 
451 ssize_t qemu_deliver_packet(NetClientState *sender,
452                             unsigned flags,
453                             const uint8_t *data,
454                             size_t size,
455                             void *opaque)
456 {
457     NetClientState *nc = opaque;
458     ssize_t ret;
459 
460     if (nc->link_down) {
461         return size;
462     }
463 
464     if (nc->receive_disabled) {
465         return 0;
466     }
467 
468     if (flags & QEMU_NET_PACKET_FLAG_RAW && nc->info->receive_raw) {
469         ret = nc->info->receive_raw(nc, data, size);
470     } else {
471         ret = nc->info->receive(nc, data, size);
472     }
473 
474     if (ret == 0) {
475         nc->receive_disabled = 1;
476     }
477 
478     return ret;
479 }
480 
481 void qemu_purge_queued_packets(NetClientState *nc)
482 {
483     if (!nc->peer) {
484         return;
485     }
486 
487     qemu_net_queue_purge(nc->peer->incoming_queue, nc);
488 }
489 
490 void qemu_flush_queued_packets(NetClientState *nc)
491 {
492     nc->receive_disabled = 0;
493 
494     if (nc->peer && nc->peer->info->type == NET_CLIENT_OPTIONS_KIND_HUBPORT) {
495         if (net_hub_flush(nc->peer)) {
496             qemu_notify_event();
497         }
498     }
499     if (qemu_net_queue_flush(nc->incoming_queue)) {
500         /* We emptied the queue successfully, signal to the IO thread to repoll
501          * the file descriptor (for tap, for example).
502          */
503         qemu_notify_event();
504     }
505 }
506 
507 static ssize_t qemu_send_packet_async_with_flags(NetClientState *sender,
508                                                  unsigned flags,
509                                                  const uint8_t *buf, int size,
510                                                  NetPacketSent *sent_cb)
511 {
512     NetQueue *queue;
513 
514 #ifdef DEBUG_NET
515     printf("qemu_send_packet_async:\n");
516     hex_dump(stdout, buf, size);
517 #endif
518 
519     if (sender->link_down || !sender->peer) {
520         return size;
521     }
522 
523     queue = sender->peer->incoming_queue;
524 
525     return qemu_net_queue_send(queue, sender, flags, buf, size, sent_cb);
526 }
527 
528 ssize_t qemu_send_packet_async(NetClientState *sender,
529                                const uint8_t *buf, int size,
530                                NetPacketSent *sent_cb)
531 {
532     return qemu_send_packet_async_with_flags(sender, QEMU_NET_PACKET_FLAG_NONE,
533                                              buf, size, sent_cb);
534 }
535 
536 void qemu_send_packet(NetClientState *nc, const uint8_t *buf, int size)
537 {
538     qemu_send_packet_async(nc, buf, size, NULL);
539 }
540 
541 ssize_t qemu_send_packet_raw(NetClientState *nc, const uint8_t *buf, int size)
542 {
543     return qemu_send_packet_async_with_flags(nc, QEMU_NET_PACKET_FLAG_RAW,
544                                              buf, size, NULL);
545 }
546 
547 static ssize_t nc_sendv_compat(NetClientState *nc, const struct iovec *iov,
548                                int iovcnt)
549 {
550     uint8_t buffer[NET_BUFSIZE];
551     size_t offset;
552 
553     offset = iov_to_buf(iov, iovcnt, 0, buffer, sizeof(buffer));
554 
555     return nc->info->receive(nc, buffer, offset);
556 }
557 
558 ssize_t qemu_deliver_packet_iov(NetClientState *sender,
559                                 unsigned flags,
560                                 const struct iovec *iov,
561                                 int iovcnt,
562                                 void *opaque)
563 {
564     NetClientState *nc = opaque;
565     int ret;
566 
567     if (nc->link_down) {
568         return iov_size(iov, iovcnt);
569     }
570 
571     if (nc->receive_disabled) {
572         return 0;
573     }
574 
575     if (nc->info->receive_iov) {
576         ret = nc->info->receive_iov(nc, iov, iovcnt);
577     } else {
578         ret = nc_sendv_compat(nc, iov, iovcnt);
579     }
580 
581     if (ret == 0) {
582         nc->receive_disabled = 1;
583     }
584 
585     return ret;
586 }
587 
588 ssize_t qemu_sendv_packet_async(NetClientState *sender,
589                                 const struct iovec *iov, int iovcnt,
590                                 NetPacketSent *sent_cb)
591 {
592     NetQueue *queue;
593 
594     if (sender->link_down || !sender->peer) {
595         return iov_size(iov, iovcnt);
596     }
597 
598     queue = sender->peer->incoming_queue;
599 
600     return qemu_net_queue_send_iov(queue, sender,
601                                    QEMU_NET_PACKET_FLAG_NONE,
602                                    iov, iovcnt, sent_cb);
603 }
604 
605 ssize_t
606 qemu_sendv_packet(NetClientState *nc, const struct iovec *iov, int iovcnt)
607 {
608     return qemu_sendv_packet_async(nc, iov, iovcnt, NULL);
609 }
610 
611 NetClientState *qemu_find_netdev(const char *id)
612 {
613     NetClientState *nc;
614 
615     QTAILQ_FOREACH(nc, &net_clients, next) {
616         if (nc->info->type == NET_CLIENT_OPTIONS_KIND_NIC)
617             continue;
618         if (!strcmp(nc->name, id)) {
619             return nc;
620         }
621     }
622 
623     return NULL;
624 }
625 
626 int qemu_find_net_clients_except(const char *id, NetClientState **ncs,
627                                  NetClientOptionsKind type, int max)
628 {
629     NetClientState *nc;
630     int ret = 0;
631 
632     QTAILQ_FOREACH(nc, &net_clients, next) {
633         if (nc->info->type == type) {
634             continue;
635         }
636         if (!strcmp(nc->name, id)) {
637             if (ret < max) {
638                 ncs[ret] = nc;
639             }
640             ret++;
641         }
642     }
643 
644     return ret;
645 }
646 
647 static int nic_get_free_idx(void)
648 {
649     int index;
650 
651     for (index = 0; index < MAX_NICS; index++)
652         if (!nd_table[index].used)
653             return index;
654     return -1;
655 }
656 
657 int qemu_show_nic_models(const char *arg, const char *const *models)
658 {
659     int i;
660 
661     if (!arg || !is_help_option(arg)) {
662         return 0;
663     }
664 
665     fprintf(stderr, "qemu: Supported NIC models: ");
666     for (i = 0 ; models[i]; i++)
667         fprintf(stderr, "%s%c", models[i], models[i+1] ? ',' : '\n');
668     return 1;
669 }
670 
671 void qemu_check_nic_model(NICInfo *nd, const char *model)
672 {
673     const char *models[2];
674 
675     models[0] = model;
676     models[1] = NULL;
677 
678     if (qemu_show_nic_models(nd->model, models))
679         exit(0);
680     if (qemu_find_nic_model(nd, models, model) < 0)
681         exit(1);
682 }
683 
684 int qemu_find_nic_model(NICInfo *nd, const char * const *models,
685                         const char *default_model)
686 {
687     int i;
688 
689     if (!nd->model)
690         nd->model = g_strdup(default_model);
691 
692     for (i = 0 ; models[i]; i++) {
693         if (strcmp(nd->model, models[i]) == 0)
694             return i;
695     }
696 
697     error_report("Unsupported NIC model: %s", nd->model);
698     return -1;
699 }
700 
701 static int net_init_nic(const NetClientOptions *opts, const char *name,
702                         NetClientState *peer)
703 {
704     int idx;
705     NICInfo *nd;
706     const NetLegacyNicOptions *nic;
707 
708     assert(opts->kind == NET_CLIENT_OPTIONS_KIND_NIC);
709     nic = opts->nic;
710 
711     idx = nic_get_free_idx();
712     if (idx == -1 || nb_nics >= MAX_NICS) {
713         error_report("Too Many NICs");
714         return -1;
715     }
716 
717     nd = &nd_table[idx];
718 
719     memset(nd, 0, sizeof(*nd));
720 
721     if (nic->has_netdev) {
722         nd->netdev = qemu_find_netdev(nic->netdev);
723         if (!nd->netdev) {
724             error_report("netdev '%s' not found", nic->netdev);
725             return -1;
726         }
727     } else {
728         assert(peer);
729         nd->netdev = peer;
730     }
731     nd->name = g_strdup(name);
732     if (nic->has_model) {
733         nd->model = g_strdup(nic->model);
734     }
735     if (nic->has_addr) {
736         nd->devaddr = g_strdup(nic->addr);
737     }
738 
739     if (nic->has_macaddr &&
740         net_parse_macaddr(nd->macaddr.a, nic->macaddr) < 0) {
741         error_report("invalid syntax for ethernet address");
742         return -1;
743     }
744     if (nic->has_macaddr &&
745         is_multicast_ether_addr(nd->macaddr.a)) {
746         error_report("NIC cannot have multicast MAC address (odd 1st byte)");
747         return -1;
748     }
749     qemu_macaddr_default_if_unset(&nd->macaddr);
750 
751     if (nic->has_vectors) {
752         if (nic->vectors > 0x7ffffff) {
753             error_report("invalid # of vectors: %"PRIu32, nic->vectors);
754             return -1;
755         }
756         nd->nvectors = nic->vectors;
757     } else {
758         nd->nvectors = DEV_NVECTORS_UNSPECIFIED;
759     }
760 
761     nd->used = 1;
762     nb_nics++;
763 
764     return idx;
765 }
766 
767 
768 static int (* const net_client_init_fun[NET_CLIENT_OPTIONS_KIND_MAX])(
769     const NetClientOptions *opts,
770     const char *name,
771     NetClientState *peer) = {
772         [NET_CLIENT_OPTIONS_KIND_NIC]       = net_init_nic,
773 #ifdef CONFIG_SLIRP
774         [NET_CLIENT_OPTIONS_KIND_USER]      = net_init_slirp,
775 #endif
776         [NET_CLIENT_OPTIONS_KIND_TAP]       = net_init_tap,
777         [NET_CLIENT_OPTIONS_KIND_SOCKET]    = net_init_socket,
778 #ifdef CONFIG_VDE
779         [NET_CLIENT_OPTIONS_KIND_VDE]       = net_init_vde,
780 #endif
781 #ifdef CONFIG_NETMAP
782         [NET_CLIENT_OPTIONS_KIND_NETMAP]    = net_init_netmap,
783 #endif
784         [NET_CLIENT_OPTIONS_KIND_DUMP]      = net_init_dump,
785 #ifdef CONFIG_NET_BRIDGE
786         [NET_CLIENT_OPTIONS_KIND_BRIDGE]    = net_init_bridge,
787 #endif
788         [NET_CLIENT_OPTIONS_KIND_HUBPORT]   = net_init_hubport,
789 };
790 
791 
792 static int net_client_init1(const void *object, int is_netdev, Error **errp)
793 {
794     union {
795         const Netdev    *netdev;
796         const NetLegacy *net;
797     } u;
798     const NetClientOptions *opts;
799     const char *name;
800 
801     if (is_netdev) {
802         u.netdev = object;
803         opts = u.netdev->opts;
804         name = u.netdev->id;
805 
806         switch (opts->kind) {
807 #ifdef CONFIG_SLIRP
808         case NET_CLIENT_OPTIONS_KIND_USER:
809 #endif
810         case NET_CLIENT_OPTIONS_KIND_TAP:
811         case NET_CLIENT_OPTIONS_KIND_SOCKET:
812 #ifdef CONFIG_VDE
813         case NET_CLIENT_OPTIONS_KIND_VDE:
814 #endif
815 #ifdef CONFIG_NETMAP
816         case NET_CLIENT_OPTIONS_KIND_NETMAP:
817 #endif
818 #ifdef CONFIG_NET_BRIDGE
819         case NET_CLIENT_OPTIONS_KIND_BRIDGE:
820 #endif
821         case NET_CLIENT_OPTIONS_KIND_HUBPORT:
822             break;
823 
824         default:
825             error_set(errp, QERR_INVALID_PARAMETER_VALUE, "type",
826                       "a netdev backend type");
827             return -1;
828         }
829     } else {
830         u.net = object;
831         opts = u.net->opts;
832         /* missing optional values have been initialized to "all bits zero" */
833         name = u.net->has_id ? u.net->id : u.net->name;
834     }
835 
836     if (net_client_init_fun[opts->kind]) {
837         NetClientState *peer = NULL;
838 
839         /* Do not add to a vlan if it's a -netdev or a nic with a netdev=
840          * parameter. */
841         if (!is_netdev &&
842             (opts->kind != NET_CLIENT_OPTIONS_KIND_NIC ||
843              !opts->nic->has_netdev)) {
844             peer = net_hub_add_port(u.net->has_vlan ? u.net->vlan : 0, NULL);
845         }
846 
847         if (net_client_init_fun[opts->kind](opts, name, peer) < 0) {
848             /* TODO push error reporting into init() methods */
849             error_set(errp, QERR_DEVICE_INIT_FAILED,
850                       NetClientOptionsKind_lookup[opts->kind]);
851             return -1;
852         }
853     }
854     return 0;
855 }
856 
857 
858 static void net_visit(Visitor *v, int is_netdev, void **object, Error **errp)
859 {
860     if (is_netdev) {
861         visit_type_Netdev(v, (Netdev **)object, NULL, errp);
862     } else {
863         visit_type_NetLegacy(v, (NetLegacy **)object, NULL, errp);
864     }
865 }
866 
867 
868 int net_client_init(QemuOpts *opts, int is_netdev, Error **errp)
869 {
870     void *object = NULL;
871     Error *err = NULL;
872     int ret = -1;
873 
874     {
875         OptsVisitor *ov = opts_visitor_new(opts);
876 
877         net_visit(opts_get_visitor(ov), is_netdev, &object, &err);
878         opts_visitor_cleanup(ov);
879     }
880 
881     if (!err) {
882         ret = net_client_init1(object, is_netdev, &err);
883     }
884 
885     if (object) {
886         QapiDeallocVisitor *dv = qapi_dealloc_visitor_new();
887 
888         net_visit(qapi_dealloc_get_visitor(dv), is_netdev, &object, NULL);
889         qapi_dealloc_visitor_cleanup(dv);
890     }
891 
892     error_propagate(errp, err);
893     return ret;
894 }
895 
896 
897 static int net_host_check_device(const char *device)
898 {
899     int i;
900     const char *valid_param_list[] = { "tap", "socket", "dump"
901 #ifdef CONFIG_NET_BRIDGE
902                                        , "bridge"
903 #endif
904 #ifdef CONFIG_SLIRP
905                                        ,"user"
906 #endif
907 #ifdef CONFIG_VDE
908                                        ,"vde"
909 #endif
910     };
911     for (i = 0; i < ARRAY_SIZE(valid_param_list); i++) {
912         if (!strncmp(valid_param_list[i], device,
913                      strlen(valid_param_list[i])))
914             return 1;
915     }
916 
917     return 0;
918 }
919 
920 void net_host_device_add(Monitor *mon, const QDict *qdict)
921 {
922     const char *device = qdict_get_str(qdict, "device");
923     const char *opts_str = qdict_get_try_str(qdict, "opts");
924     Error *local_err = NULL;
925     QemuOpts *opts;
926 
927     if (!net_host_check_device(device)) {
928         monitor_printf(mon, "invalid host network device %s\n", device);
929         return;
930     }
931 
932     opts = qemu_opts_parse(qemu_find_opts("net"), opts_str ? opts_str : "", 0);
933     if (!opts) {
934         return;
935     }
936 
937     qemu_opt_set(opts, "type", device);
938 
939     net_client_init(opts, 0, &local_err);
940     if (local_err) {
941         qerror_report_err(local_err);
942         error_free(local_err);
943         monitor_printf(mon, "adding host network device %s failed\n", device);
944     }
945 }
946 
947 void net_host_device_remove(Monitor *mon, const QDict *qdict)
948 {
949     NetClientState *nc;
950     int vlan_id = qdict_get_int(qdict, "vlan_id");
951     const char *device = qdict_get_str(qdict, "device");
952 
953     nc = net_hub_find_client_by_name(vlan_id, device);
954     if (!nc) {
955         error_report("Host network device '%s' on hub '%d' not found",
956                      device, vlan_id);
957         return;
958     }
959     if (!net_host_check_device(nc->model)) {
960         error_report("invalid host network device '%s'", device);
961         return;
962     }
963     qemu_del_net_client(nc);
964 }
965 
966 void netdev_add(QemuOpts *opts, Error **errp)
967 {
968     net_client_init(opts, 1, errp);
969 }
970 
971 int qmp_netdev_add(Monitor *mon, const QDict *qdict, QObject **ret)
972 {
973     Error *local_err = NULL;
974     QemuOptsList *opts_list;
975     QemuOpts *opts;
976 
977     opts_list = qemu_find_opts_err("netdev", &local_err);
978     if (local_err) {
979         goto exit_err;
980     }
981 
982     opts = qemu_opts_from_qdict(opts_list, qdict, &local_err);
983     if (local_err) {
984         goto exit_err;
985     }
986 
987     netdev_add(opts, &local_err);
988     if (local_err) {
989         qemu_opts_del(opts);
990         goto exit_err;
991     }
992 
993     return 0;
994 
995 exit_err:
996     qerror_report_err(local_err);
997     error_free(local_err);
998     return -1;
999 }
1000 
1001 void qmp_netdev_del(const char *id, Error **errp)
1002 {
1003     NetClientState *nc;
1004     QemuOpts *opts;
1005 
1006     nc = qemu_find_netdev(id);
1007     if (!nc) {
1008         error_set(errp, QERR_DEVICE_NOT_FOUND, id);
1009         return;
1010     }
1011 
1012     opts = qemu_opts_find(qemu_find_opts_err("netdev", NULL), id);
1013     if (!opts) {
1014         error_setg(errp, "Device '%s' is not a netdev", id);
1015         return;
1016     }
1017 
1018     qemu_del_net_client(nc);
1019     qemu_opts_del(opts);
1020 }
1021 
1022 void print_net_client(Monitor *mon, NetClientState *nc)
1023 {
1024     monitor_printf(mon, "%s: index=%d,type=%s,%s\n", nc->name,
1025                    nc->queue_index,
1026                    NetClientOptionsKind_lookup[nc->info->type],
1027                    nc->info_str);
1028 }
1029 
1030 RxFilterInfoList *qmp_query_rx_filter(bool has_name, const char *name,
1031                                       Error **errp)
1032 {
1033     NetClientState *nc;
1034     RxFilterInfoList *filter_list = NULL, *last_entry = NULL;
1035 
1036     QTAILQ_FOREACH(nc, &net_clients, next) {
1037         RxFilterInfoList *entry;
1038         RxFilterInfo *info;
1039 
1040         if (has_name && strcmp(nc->name, name) != 0) {
1041             continue;
1042         }
1043 
1044         /* only query rx-filter information of NIC */
1045         if (nc->info->type != NET_CLIENT_OPTIONS_KIND_NIC) {
1046             if (has_name) {
1047                 error_setg(errp, "net client(%s) isn't a NIC", name);
1048                 return NULL;
1049             }
1050             continue;
1051         }
1052 
1053         if (nc->info->query_rx_filter) {
1054             info = nc->info->query_rx_filter(nc);
1055             entry = g_malloc0(sizeof(*entry));
1056             entry->value = info;
1057 
1058             if (!filter_list) {
1059                 filter_list = entry;
1060             } else {
1061                 last_entry->next = entry;
1062             }
1063             last_entry = entry;
1064         } else if (has_name) {
1065             error_setg(errp, "net client(%s) doesn't support"
1066                        " rx-filter querying", name);
1067             return NULL;
1068         }
1069 
1070         if (has_name) {
1071             break;
1072         }
1073     }
1074 
1075     if (filter_list == NULL && has_name) {
1076         error_setg(errp, "invalid net client name: %s", name);
1077     }
1078 
1079     return filter_list;
1080 }
1081 
1082 void do_info_network(Monitor *mon, const QDict *qdict)
1083 {
1084     NetClientState *nc, *peer;
1085     NetClientOptionsKind type;
1086 
1087     net_hub_info(mon);
1088 
1089     QTAILQ_FOREACH(nc, &net_clients, next) {
1090         peer = nc->peer;
1091         type = nc->info->type;
1092 
1093         /* Skip if already printed in hub info */
1094         if (net_hub_id_for_client(nc, NULL) == 0) {
1095             continue;
1096         }
1097 
1098         if (!peer || type == NET_CLIENT_OPTIONS_KIND_NIC) {
1099             print_net_client(mon, nc);
1100         } /* else it's a netdev connected to a NIC, printed with the NIC */
1101         if (peer && type == NET_CLIENT_OPTIONS_KIND_NIC) {
1102             monitor_printf(mon, " \\ ");
1103             print_net_client(mon, peer);
1104         }
1105     }
1106 }
1107 
1108 void qmp_set_link(const char *name, bool up, Error **errp)
1109 {
1110     NetClientState *ncs[MAX_QUEUE_NUM];
1111     NetClientState *nc;
1112     int queues, i;
1113 
1114     queues = qemu_find_net_clients_except(name, ncs,
1115                                           NET_CLIENT_OPTIONS_KIND_MAX,
1116                                           MAX_QUEUE_NUM);
1117 
1118     if (queues == 0) {
1119         error_set(errp, QERR_DEVICE_NOT_FOUND, name);
1120         return;
1121     }
1122     nc = ncs[0];
1123 
1124     for (i = 0; i < queues; i++) {
1125         ncs[i]->link_down = !up;
1126     }
1127 
1128     if (nc->info->link_status_changed) {
1129         nc->info->link_status_changed(nc);
1130     }
1131 
1132     if (nc->peer) {
1133         /* Change peer link only if the peer is NIC and then notify peer.
1134          * If the peer is a HUBPORT or a backend, we do not change the
1135          * link status.
1136          *
1137          * This behavior is compatible with qemu vlans where there could be
1138          * multiple clients that can still communicate with each other in
1139          * disconnected mode. For now maintain this compatibility.
1140          */
1141         if (nc->peer->info->type == NET_CLIENT_OPTIONS_KIND_NIC) {
1142             for (i = 0; i < queues; i++) {
1143                 ncs[i]->peer->link_down = !up;
1144             }
1145         }
1146         if (nc->peer->info->link_status_changed) {
1147             nc->peer->info->link_status_changed(nc->peer);
1148         }
1149     }
1150 }
1151 
1152 void net_cleanup(void)
1153 {
1154     NetClientState *nc;
1155 
1156     /* We may del multiple entries during qemu_del_net_client(),
1157      * so QTAILQ_FOREACH_SAFE() is also not safe here.
1158      */
1159     while (!QTAILQ_EMPTY(&net_clients)) {
1160         nc = QTAILQ_FIRST(&net_clients);
1161         if (nc->info->type == NET_CLIENT_OPTIONS_KIND_NIC) {
1162             qemu_del_nic(qemu_get_nic(nc));
1163         } else {
1164             qemu_del_net_client(nc);
1165         }
1166     }
1167 }
1168 
1169 void net_check_clients(void)
1170 {
1171     NetClientState *nc;
1172     int i;
1173 
1174     /* Don't warn about the default network setup that you get if
1175      * no command line -net or -netdev options are specified. There
1176      * are two cases that we would otherwise complain about:
1177      * (1) board doesn't support a NIC but the implicit "-net nic"
1178      * requested one
1179      * (2) CONFIG_SLIRP not set, in which case the implicit "-net nic"
1180      * sets up a nic that isn't connected to anything.
1181      */
1182     if (default_net) {
1183         return;
1184     }
1185 
1186     net_hub_check_clients();
1187 
1188     QTAILQ_FOREACH(nc, &net_clients, next) {
1189         if (!nc->peer) {
1190             fprintf(stderr, "Warning: %s %s has no peer\n",
1191                     nc->info->type == NET_CLIENT_OPTIONS_KIND_NIC ?
1192                     "nic" : "netdev", nc->name);
1193         }
1194     }
1195 
1196     /* Check that all NICs requested via -net nic actually got created.
1197      * NICs created via -device don't need to be checked here because
1198      * they are always instantiated.
1199      */
1200     for (i = 0; i < MAX_NICS; i++) {
1201         NICInfo *nd = &nd_table[i];
1202         if (nd->used && !nd->instantiated) {
1203             fprintf(stderr, "Warning: requested NIC (%s, model %s) "
1204                     "was not created (not supported by this machine?)\n",
1205                     nd->name ? nd->name : "anonymous",
1206                     nd->model ? nd->model : "unspecified");
1207         }
1208     }
1209 }
1210 
1211 static int net_init_client(QemuOpts *opts, void *dummy)
1212 {
1213     Error *local_err = NULL;
1214 
1215     net_client_init(opts, 0, &local_err);
1216     if (local_err) {
1217         qerror_report_err(local_err);
1218         error_free(local_err);
1219         return -1;
1220     }
1221 
1222     return 0;
1223 }
1224 
1225 static int net_init_netdev(QemuOpts *opts, void *dummy)
1226 {
1227     Error *local_err = NULL;
1228     int ret;
1229 
1230     ret = net_client_init(opts, 1, &local_err);
1231     if (local_err) {
1232         qerror_report_err(local_err);
1233         error_free(local_err);
1234         return -1;
1235     }
1236 
1237     return ret;
1238 }
1239 
1240 int net_init_clients(void)
1241 {
1242     QemuOptsList *net = qemu_find_opts("net");
1243 
1244     if (default_net) {
1245         /* if no clients, we use a default config */
1246         qemu_opts_set(net, NULL, "type", "nic");
1247 #ifdef CONFIG_SLIRP
1248         qemu_opts_set(net, NULL, "type", "user");
1249 #endif
1250     }
1251 
1252     QTAILQ_INIT(&net_clients);
1253 
1254     if (qemu_opts_foreach(qemu_find_opts("netdev"), net_init_netdev, NULL, 1) == -1)
1255         return -1;
1256 
1257     if (qemu_opts_foreach(net, net_init_client, NULL, 1) == -1) {
1258         return -1;
1259     }
1260 
1261     return 0;
1262 }
1263 
1264 int net_client_parse(QemuOptsList *opts_list, const char *optarg)
1265 {
1266 #if defined(CONFIG_SLIRP)
1267     int ret;
1268     if (net_slirp_parse_legacy(opts_list, optarg, &ret)) {
1269         return ret;
1270     }
1271 #endif
1272 
1273     if (!qemu_opts_parse(opts_list, optarg, 1)) {
1274         return -1;
1275     }
1276 
1277     default_net = 0;
1278     return 0;
1279 }
1280 
1281 /* From FreeBSD */
1282 /* XXX: optimize */
1283 unsigned compute_mcast_idx(const uint8_t *ep)
1284 {
1285     uint32_t crc;
1286     int carry, i, j;
1287     uint8_t b;
1288 
1289     crc = 0xffffffff;
1290     for (i = 0; i < 6; i++) {
1291         b = *ep++;
1292         for (j = 0; j < 8; j++) {
1293             carry = ((crc & 0x80000000L) ? 1 : 0) ^ (b & 0x01);
1294             crc <<= 1;
1295             b >>= 1;
1296             if (carry) {
1297                 crc = ((crc ^ POLYNOMIAL) | carry);
1298             }
1299         }
1300     }
1301     return crc >> 26;
1302 }
1303 
1304 QemuOptsList qemu_netdev_opts = {
1305     .name = "netdev",
1306     .implied_opt_name = "type",
1307     .head = QTAILQ_HEAD_INITIALIZER(qemu_netdev_opts.head),
1308     .desc = {
1309         /*
1310          * no elements => accept any params
1311          * validation will happen later
1312          */
1313         { /* end of list */ }
1314     },
1315 };
1316 
1317 QemuOptsList qemu_net_opts = {
1318     .name = "net",
1319     .implied_opt_name = "type",
1320     .head = QTAILQ_HEAD_INITIALIZER(qemu_net_opts.head),
1321     .desc = {
1322         /*
1323          * no elements => accept any params
1324          * validation will happen later
1325          */
1326         { /* end of list */ }
1327     },
1328 };
1329