Merge remote-tracking branch 'pm-arm/for-upstream' into pm
[sdk/emulator/qemu.git] / net.c
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 "net.h"
25
26 #include "config-host.h"
27
28 #include "net/tap.h"
29 #include "net/socket.h"
30 #include "net/dump.h"
31 #include "net/slirp.h"
32 #include "net/vde.h"
33 #include "net/util.h"
34 #include "monitor.h"
35 #include "qemu-common.h"
36 #include "qemu_socket.h"
37 #include "hw/qdev.h"
38 #include "iov.h"
39
40 static QTAILQ_HEAD(, VLANState) vlans;
41 static QTAILQ_HEAD(, VLANClientState) non_vlan_clients;
42
43 int default_net = 1;
44
45 /***********************************************************/
46 /* network device redirectors */
47
48 #if defined(DEBUG_NET)
49 static void hex_dump(FILE *f, const uint8_t *buf, int size)
50 {
51     int len, i, j, c;
52
53     for(i=0;i<size;i+=16) {
54         len = size - i;
55         if (len > 16)
56             len = 16;
57         fprintf(f, "%08x ", i);
58         for(j=0;j<16;j++) {
59             if (j < len)
60                 fprintf(f, " %02x", buf[i+j]);
61             else
62                 fprintf(f, "   ");
63         }
64         fprintf(f, " ");
65         for(j=0;j<len;j++) {
66             c = buf[i+j];
67             if (c < ' ' || c > '~')
68                 c = '.';
69             fprintf(f, "%c", c);
70         }
71         fprintf(f, "\n");
72     }
73 }
74 #endif
75
76 static int get_str_sep(char *buf, int buf_size, const char **pp, int sep)
77 {
78     const char *p, *p1;
79     int len;
80     p = *pp;
81     p1 = strchr(p, sep);
82     if (!p1)
83         return -1;
84     len = p1 - p;
85     p1++;
86     if (buf_size > 0) {
87         if (len > buf_size - 1)
88             len = buf_size - 1;
89         memcpy(buf, p, len);
90         buf[len] = '\0';
91     }
92     *pp = p1;
93     return 0;
94 }
95
96 int parse_host_port(struct sockaddr_in *saddr, const char *str)
97 {
98     char buf[512];
99     struct hostent *he;
100     const char *p, *r;
101     int port;
102
103     p = str;
104     if (get_str_sep(buf, sizeof(buf), &p, ':') < 0)
105         return -1;
106     saddr->sin_family = AF_INET;
107     if (buf[0] == '\0') {
108         saddr->sin_addr.s_addr = 0;
109     } else {
110         if (qemu_isdigit(buf[0])) {
111             if (!inet_aton(buf, &saddr->sin_addr))
112                 return -1;
113         } else {
114             if ((he = gethostbyname(buf)) == NULL)
115                 return - 1;
116             saddr->sin_addr = *(struct in_addr *)he->h_addr;
117         }
118     }
119     port = strtol(p, (char **)&r, 0);
120     if (r == p)
121         return -1;
122     saddr->sin_port = htons(port);
123     return 0;
124 }
125
126 void qemu_format_nic_info_str(VLANClientState *vc, uint8_t macaddr[6])
127 {
128     snprintf(vc->info_str, sizeof(vc->info_str),
129              "model=%s,macaddr=%02x:%02x:%02x:%02x:%02x:%02x",
130              vc->model,
131              macaddr[0], macaddr[1], macaddr[2],
132              macaddr[3], macaddr[4], macaddr[5]);
133 }
134
135 void qemu_macaddr_default_if_unset(MACAddr *macaddr)
136 {
137     static int index = 0;
138     static const MACAddr zero = { .a = { 0,0,0,0,0,0 } };
139
140     if (memcmp(macaddr, &zero, sizeof(zero)) != 0)
141         return;
142     macaddr->a[0] = 0x52;
143     macaddr->a[1] = 0x54;
144     macaddr->a[2] = 0x00;
145     macaddr->a[3] = 0x12;
146     macaddr->a[4] = 0x34;
147     macaddr->a[5] = 0x56 + index++;
148 }
149
150 static char *assign_name(VLANClientState *vc1, const char *model)
151 {
152     VLANState *vlan;
153     VLANClientState *vc;
154     char buf[256];
155     int id = 0;
156
157     QTAILQ_FOREACH(vlan, &vlans, next) {
158         QTAILQ_FOREACH(vc, &vlan->clients, next) {
159             if (vc != vc1 && strcmp(vc->model, model) == 0) {
160                 id++;
161             }
162         }
163     }
164
165     QTAILQ_FOREACH(vc, &non_vlan_clients, next) {
166         if (vc != vc1 && strcmp(vc->model, model) == 0) {
167             id++;
168         }
169     }
170
171     snprintf(buf, sizeof(buf), "%s.%d", model, id);
172
173     return qemu_strdup(buf);
174 }
175
176 static ssize_t qemu_deliver_packet(VLANClientState *sender,
177                                    unsigned flags,
178                                    const uint8_t *data,
179                                    size_t size,
180                                    void *opaque);
181 static ssize_t qemu_deliver_packet_iov(VLANClientState *sender,
182                                        unsigned flags,
183                                        const struct iovec *iov,
184                                        int iovcnt,
185                                        void *opaque);
186
187 VLANClientState *qemu_new_net_client(NetClientInfo *info,
188                                      VLANState *vlan,
189                                      VLANClientState *peer,
190                                      const char *model,
191                                      const char *name)
192 {
193     VLANClientState *vc;
194
195     assert(info->size >= sizeof(VLANClientState));
196
197     vc = qemu_mallocz(info->size);
198
199     vc->info = info;
200     vc->model = qemu_strdup(model);
201     if (name) {
202         vc->name = qemu_strdup(name);
203     } else {
204         vc->name = assign_name(vc, model);
205     }
206
207     if (vlan) {
208         assert(!peer);
209         vc->vlan = vlan;
210         QTAILQ_INSERT_TAIL(&vc->vlan->clients, vc, next);
211     } else {
212         if (peer) {
213             assert(!peer->peer);
214             vc->peer = peer;
215             peer->peer = vc;
216         }
217         QTAILQ_INSERT_TAIL(&non_vlan_clients, vc, next);
218
219         vc->send_queue = qemu_new_net_queue(qemu_deliver_packet,
220                                             qemu_deliver_packet_iov,
221                                             vc);
222     }
223
224     return vc;
225 }
226
227 NICState *qemu_new_nic(NetClientInfo *info,
228                        NICConf *conf,
229                        const char *model,
230                        const char *name,
231                        void *opaque)
232 {
233     VLANClientState *nc;
234     NICState *nic;
235
236     assert(info->type == NET_CLIENT_TYPE_NIC);
237     assert(info->size >= sizeof(NICState));
238
239     nc = qemu_new_net_client(info, conf->vlan, conf->peer, model, name);
240
241     nic = DO_UPCAST(NICState, nc, nc);
242     nic->conf = conf;
243     nic->opaque = opaque;
244
245     return nic;
246 }
247
248 static void qemu_cleanup_vlan_client(VLANClientState *vc)
249 {
250     if (vc->vlan) {
251         QTAILQ_REMOVE(&vc->vlan->clients, vc, next);
252     } else {
253         QTAILQ_REMOVE(&non_vlan_clients, vc, next);
254     }
255
256     if (vc->info->cleanup) {
257         vc->info->cleanup(vc);
258     }
259 }
260
261 static void qemu_free_vlan_client(VLANClientState *vc)
262 {
263     if (!vc->vlan) {
264         if (vc->send_queue) {
265             qemu_del_net_queue(vc->send_queue);
266         }
267         if (vc->peer) {
268             vc->peer->peer = NULL;
269         }
270     }
271     qemu_free(vc->name);
272     qemu_free(vc->model);
273     qemu_free(vc);
274 }
275
276 void qemu_del_vlan_client(VLANClientState *vc)
277 {
278     /* If there is a peer NIC, delete and cleanup client, but do not free. */
279     if (!vc->vlan && vc->peer && vc->peer->info->type == NET_CLIENT_TYPE_NIC) {
280         NICState *nic = DO_UPCAST(NICState, nc, vc->peer);
281         if (nic->peer_deleted) {
282             return;
283         }
284         nic->peer_deleted = true;
285         /* Let NIC know peer is gone. */
286         vc->peer->link_down = true;
287         if (vc->peer->info->link_status_changed) {
288             vc->peer->info->link_status_changed(vc->peer);
289         }
290         qemu_cleanup_vlan_client(vc);
291         return;
292     }
293
294     /* If this is a peer NIC and peer has already been deleted, free it now. */
295     if (!vc->vlan && vc->peer && vc->info->type == NET_CLIENT_TYPE_NIC) {
296         NICState *nic = DO_UPCAST(NICState, nc, vc);
297         if (nic->peer_deleted) {
298             qemu_free_vlan_client(vc->peer);
299         }
300     }
301
302     qemu_cleanup_vlan_client(vc);
303     qemu_free_vlan_client(vc);
304 }
305
306 VLANClientState *
307 qemu_find_vlan_client_by_name(Monitor *mon, int vlan_id,
308                               const char *client_str)
309 {
310     VLANState *vlan;
311     VLANClientState *vc;
312
313     vlan = qemu_find_vlan(vlan_id, 0);
314     if (!vlan) {
315         monitor_printf(mon, "unknown VLAN %d\n", vlan_id);
316         return NULL;
317     }
318
319     QTAILQ_FOREACH(vc, &vlan->clients, next) {
320         if (!strcmp(vc->name, client_str)) {
321             break;
322         }
323     }
324     if (!vc) {
325         monitor_printf(mon, "can't find device %s on VLAN %d\n",
326                        client_str, vlan_id);
327     }
328
329     return vc;
330 }
331
332 void qemu_foreach_nic(qemu_nic_foreach func, void *opaque)
333 {
334     VLANClientState *nc;
335     VLANState *vlan;
336
337     QTAILQ_FOREACH(nc, &non_vlan_clients, next) {
338         if (nc->info->type == NET_CLIENT_TYPE_NIC) {
339             func(DO_UPCAST(NICState, nc, nc), opaque);
340         }
341     }
342
343     QTAILQ_FOREACH(vlan, &vlans, next) {
344         QTAILQ_FOREACH(nc, &vlan->clients, next) {
345             if (nc->info->type == NET_CLIENT_TYPE_NIC) {
346                 func(DO_UPCAST(NICState, nc, nc), opaque);
347             }
348         }
349     }
350 }
351
352 int qemu_can_send_packet(VLANClientState *sender)
353 {
354     VLANState *vlan = sender->vlan;
355     VLANClientState *vc;
356
357     if (sender->peer) {
358         if (sender->peer->receive_disabled) {
359             return 0;
360         } else if (sender->peer->info->can_receive &&
361                    !sender->peer->info->can_receive(sender->peer)) {
362             return 0;
363         } else {
364             return 1;
365         }
366     }
367
368     if (!sender->vlan) {
369         return 1;
370     }
371
372     QTAILQ_FOREACH(vc, &vlan->clients, next) {
373         if (vc == sender) {
374             continue;
375         }
376
377         /* no can_receive() handler, they can always receive */
378         if (vc->info->can_receive && !vc->info->can_receive(vc)) {
379             return 0;
380         }
381     }
382     return 1;
383 }
384
385 static ssize_t qemu_deliver_packet(VLANClientState *sender,
386                                    unsigned flags,
387                                    const uint8_t *data,
388                                    size_t size,
389                                    void *opaque)
390 {
391     VLANClientState *vc = opaque;
392     ssize_t ret;
393
394     if (vc->link_down) {
395         return size;
396     }
397
398     if (vc->receive_disabled) {
399         return 0;
400     }
401
402     if (flags & QEMU_NET_PACKET_FLAG_RAW && vc->info->receive_raw) {
403         ret = vc->info->receive_raw(vc, data, size);
404     } else {
405         ret = vc->info->receive(vc, data, size);
406     }
407
408     if (ret == 0) {
409         vc->receive_disabled = 1;
410     };
411
412     return ret;
413 }
414
415 static ssize_t qemu_vlan_deliver_packet(VLANClientState *sender,
416                                         unsigned flags,
417                                         const uint8_t *buf,
418                                         size_t size,
419                                         void *opaque)
420 {
421     VLANState *vlan = opaque;
422     VLANClientState *vc;
423     ssize_t ret = -1;
424
425     QTAILQ_FOREACH(vc, &vlan->clients, next) {
426         ssize_t len;
427
428         if (vc == sender) {
429             continue;
430         }
431
432         if (vc->link_down) {
433             ret = size;
434             continue;
435         }
436
437         if (vc->receive_disabled) {
438             ret = 0;
439             continue;
440         }
441
442         if (flags & QEMU_NET_PACKET_FLAG_RAW && vc->info->receive_raw) {
443             len = vc->info->receive_raw(vc, buf, size);
444         } else {
445             len = vc->info->receive(vc, buf, size);
446         }
447
448         if (len == 0) {
449             vc->receive_disabled = 1;
450         }
451
452         ret = (ret >= 0) ? ret : len;
453
454     }
455
456     return ret;
457 }
458
459 void qemu_purge_queued_packets(VLANClientState *vc)
460 {
461     NetQueue *queue;
462
463     if (!vc->peer && !vc->vlan) {
464         return;
465     }
466
467     if (vc->peer) {
468         queue = vc->peer->send_queue;
469     } else {
470         queue = vc->vlan->send_queue;
471     }
472
473     qemu_net_queue_purge(queue, vc);
474 }
475
476 void qemu_flush_queued_packets(VLANClientState *vc)
477 {
478     NetQueue *queue;
479
480     vc->receive_disabled = 0;
481
482     if (vc->vlan) {
483         queue = vc->vlan->send_queue;
484     } else {
485         queue = vc->send_queue;
486     }
487
488     qemu_net_queue_flush(queue);
489 }
490
491 static ssize_t qemu_send_packet_async_with_flags(VLANClientState *sender,
492                                                  unsigned flags,
493                                                  const uint8_t *buf, int size,
494                                                  NetPacketSent *sent_cb)
495 {
496     NetQueue *queue;
497
498 #ifdef DEBUG_NET
499     printf("qemu_send_packet_async:\n");
500     hex_dump(stdout, buf, size);
501 #endif
502
503     if (sender->link_down || (!sender->peer && !sender->vlan)) {
504         return size;
505     }
506
507     if (sender->peer) {
508         queue = sender->peer->send_queue;
509     } else {
510         queue = sender->vlan->send_queue;
511     }
512
513     return qemu_net_queue_send(queue, sender, flags, buf, size, sent_cb);
514 }
515
516 ssize_t qemu_send_packet_async(VLANClientState *sender,
517                                const uint8_t *buf, int size,
518                                NetPacketSent *sent_cb)
519 {
520     return qemu_send_packet_async_with_flags(sender, QEMU_NET_PACKET_FLAG_NONE,
521                                              buf, size, sent_cb);
522 }
523
524 void qemu_send_packet(VLANClientState *vc, const uint8_t *buf, int size)
525 {
526     qemu_send_packet_async(vc, buf, size, NULL);
527 }
528
529 ssize_t qemu_send_packet_raw(VLANClientState *vc, const uint8_t *buf, int size)
530 {
531     return qemu_send_packet_async_with_flags(vc, QEMU_NET_PACKET_FLAG_RAW,
532                                              buf, size, NULL);
533 }
534
535 static ssize_t vc_sendv_compat(VLANClientState *vc, const struct iovec *iov,
536                                int iovcnt)
537 {
538     uint8_t buffer[4096];
539     size_t offset;
540
541     offset = iov_to_buf(iov, iovcnt, buffer, 0, sizeof(buffer));
542
543     return vc->info->receive(vc, buffer, offset);
544 }
545
546 static ssize_t qemu_deliver_packet_iov(VLANClientState *sender,
547                                        unsigned flags,
548                                        const struct iovec *iov,
549                                        int iovcnt,
550                                        void *opaque)
551 {
552     VLANClientState *vc = opaque;
553
554     if (vc->link_down) {
555         return iov_size(iov, iovcnt);
556     }
557
558     if (vc->info->receive_iov) {
559         return vc->info->receive_iov(vc, iov, iovcnt);
560     } else {
561         return vc_sendv_compat(vc, iov, iovcnt);
562     }
563 }
564
565 static ssize_t qemu_vlan_deliver_packet_iov(VLANClientState *sender,
566                                             unsigned flags,
567                                             const struct iovec *iov,
568                                             int iovcnt,
569                                             void *opaque)
570 {
571     VLANState *vlan = opaque;
572     VLANClientState *vc;
573     ssize_t ret = -1;
574
575     QTAILQ_FOREACH(vc, &vlan->clients, next) {
576         ssize_t len;
577
578         if (vc == sender) {
579             continue;
580         }
581
582         if (vc->link_down) {
583             ret = iov_size(iov, iovcnt);
584             continue;
585         }
586
587         assert(!(flags & QEMU_NET_PACKET_FLAG_RAW));
588
589         if (vc->info->receive_iov) {
590             len = vc->info->receive_iov(vc, iov, iovcnt);
591         } else {
592             len = vc_sendv_compat(vc, iov, iovcnt);
593         }
594
595         ret = (ret >= 0) ? ret : len;
596     }
597
598     return ret;
599 }
600
601 ssize_t qemu_sendv_packet_async(VLANClientState *sender,
602                                 const struct iovec *iov, int iovcnt,
603                                 NetPacketSent *sent_cb)
604 {
605     NetQueue *queue;
606
607     if (sender->link_down || (!sender->peer && !sender->vlan)) {
608         return iov_size(iov, iovcnt);
609     }
610
611     if (sender->peer) {
612         queue = sender->peer->send_queue;
613     } else {
614         queue = sender->vlan->send_queue;
615     }
616
617     return qemu_net_queue_send_iov(queue, sender,
618                                    QEMU_NET_PACKET_FLAG_NONE,
619                                    iov, iovcnt, sent_cb);
620 }
621
622 ssize_t
623 qemu_sendv_packet(VLANClientState *vc, const struct iovec *iov, int iovcnt)
624 {
625     return qemu_sendv_packet_async(vc, iov, iovcnt, NULL);
626 }
627
628 /* find or alloc a new VLAN */
629 VLANState *qemu_find_vlan(int id, int allocate)
630 {
631     VLANState *vlan;
632
633     QTAILQ_FOREACH(vlan, &vlans, next) {
634         if (vlan->id == id) {
635             return vlan;
636         }
637     }
638
639     if (!allocate) {
640         return NULL;
641     }
642
643     vlan = qemu_mallocz(sizeof(VLANState));
644     vlan->id = id;
645     QTAILQ_INIT(&vlan->clients);
646
647     vlan->send_queue = qemu_new_net_queue(qemu_vlan_deliver_packet,
648                                           qemu_vlan_deliver_packet_iov,
649                                           vlan);
650
651     QTAILQ_INSERT_TAIL(&vlans, vlan, next);
652
653     return vlan;
654 }
655
656 VLANClientState *qemu_find_netdev(const char *id)
657 {
658     VLANClientState *vc;
659
660     QTAILQ_FOREACH(vc, &non_vlan_clients, next) {
661         if (vc->info->type == NET_CLIENT_TYPE_NIC)
662             continue;
663         if (!strcmp(vc->name, id)) {
664             return vc;
665         }
666     }
667
668     return NULL;
669 }
670
671 static int nic_get_free_idx(void)
672 {
673     int index;
674
675     for (index = 0; index < MAX_NICS; index++)
676         if (!nd_table[index].used)
677             return index;
678     return -1;
679 }
680
681 int qemu_show_nic_models(const char *arg, const char *const *models)
682 {
683     int i;
684
685     if (!arg || strcmp(arg, "?"))
686         return 0;
687
688     fprintf(stderr, "qemu: Supported NIC models: ");
689     for (i = 0 ; models[i]; i++)
690         fprintf(stderr, "%s%c", models[i], models[i+1] ? ',' : '\n');
691     return 1;
692 }
693
694 void qemu_check_nic_model(NICInfo *nd, const char *model)
695 {
696     const char *models[2];
697
698     models[0] = model;
699     models[1] = NULL;
700
701     if (qemu_show_nic_models(nd->model, models))
702         exit(0);
703     if (qemu_find_nic_model(nd, models, model) < 0)
704         exit(1);
705 }
706
707 int qemu_find_nic_model(NICInfo *nd, const char * const *models,
708                         const char *default_model)
709 {
710     int i;
711
712     if (!nd->model)
713         nd->model = qemu_strdup(default_model);
714
715     for (i = 0 ; models[i]; i++) {
716         if (strcmp(nd->model, models[i]) == 0)
717             return i;
718     }
719
720     error_report("Unsupported NIC model: %s", nd->model);
721     return -1;
722 }
723
724 int net_handle_fd_param(Monitor *mon, const char *param)
725 {
726     int fd;
727
728     if (!qemu_isdigit(param[0]) && mon) {
729
730         fd = monitor_get_fd(mon, param);
731         if (fd == -1) {
732             error_report("No file descriptor named %s found", param);
733             return -1;
734         }
735     } else {
736         char *endptr = NULL;
737
738         fd = strtol(param, &endptr, 10);
739         if (*endptr || (fd == 0 && param == endptr)) {
740             return -1;
741         }
742     }
743
744     return fd;
745 }
746
747 static int net_init_nic(QemuOpts *opts,
748                         Monitor *mon,
749                         const char *name,
750                         VLANState *vlan)
751 {
752     int idx;
753     NICInfo *nd;
754     const char *netdev;
755
756     idx = nic_get_free_idx();
757     if (idx == -1 || nb_nics >= MAX_NICS) {
758         error_report("Too Many NICs");
759         return -1;
760     }
761
762     nd = &nd_table[idx];
763
764     memset(nd, 0, sizeof(*nd));
765
766     if ((netdev = qemu_opt_get(opts, "netdev"))) {
767         nd->netdev = qemu_find_netdev(netdev);
768         if (!nd->netdev) {
769             error_report("netdev '%s' not found", netdev);
770             return -1;
771         }
772     } else {
773         assert(vlan);
774         nd->vlan = vlan;
775     }
776     if (name) {
777         nd->name = qemu_strdup(name);
778     }
779     if (qemu_opt_get(opts, "model")) {
780         nd->model = qemu_strdup(qemu_opt_get(opts, "model"));
781     }
782     if (qemu_opt_get(opts, "addr")) {
783         nd->devaddr = qemu_strdup(qemu_opt_get(opts, "addr"));
784     }
785
786     if (qemu_opt_get(opts, "macaddr") &&
787         net_parse_macaddr(nd->macaddr.a, qemu_opt_get(opts, "macaddr")) < 0) {
788         error_report("invalid syntax for ethernet address");
789         return -1;
790     }
791     qemu_macaddr_default_if_unset(&nd->macaddr);
792
793     nd->nvectors = qemu_opt_get_number(opts, "vectors",
794                                        DEV_NVECTORS_UNSPECIFIED);
795     if (nd->nvectors != DEV_NVECTORS_UNSPECIFIED &&
796         (nd->nvectors < 0 || nd->nvectors > 0x7ffffff)) {
797         error_report("invalid # of vectors: %d", nd->nvectors);
798         return -1;
799     }
800
801     nd->used = 1;
802     nb_nics++;
803
804     return idx;
805 }
806
807 #define NET_COMMON_PARAMS_DESC                     \
808     {                                              \
809         .name = "type",                            \
810         .type = QEMU_OPT_STRING,                   \
811         .help = "net client type (nic, tap etc.)", \
812      }, {                                          \
813         .name = "vlan",                            \
814         .type = QEMU_OPT_NUMBER,                   \
815         .help = "vlan number",                     \
816      }, {                                          \
817         .name = "name",                            \
818         .type = QEMU_OPT_STRING,                   \
819         .help = "identifier for monitor commands", \
820      }
821
822 typedef int (*net_client_init_func)(QemuOpts *opts,
823                                     Monitor *mon,
824                                     const char *name,
825                                     VLANState *vlan);
826
827 /* magic number, but compiler will warn if too small */
828 #define NET_MAX_DESC 20
829
830 static const struct {
831     const char *type;
832     net_client_init_func init;
833     QemuOptDesc desc[NET_MAX_DESC];
834 } net_client_types[NET_CLIENT_TYPE_MAX] = {
835     [NET_CLIENT_TYPE_NONE] = {
836         .type = "none",
837         .desc = {
838             NET_COMMON_PARAMS_DESC,
839             { /* end of list */ }
840         },
841     },
842     [NET_CLIENT_TYPE_NIC] = {
843         .type = "nic",
844         .init = net_init_nic,
845         .desc = {
846             NET_COMMON_PARAMS_DESC,
847             {
848                 .name = "netdev",
849                 .type = QEMU_OPT_STRING,
850                 .help = "id of -netdev to connect to",
851             },
852             {
853                 .name = "macaddr",
854                 .type = QEMU_OPT_STRING,
855                 .help = "MAC address",
856             }, {
857                 .name = "model",
858                 .type = QEMU_OPT_STRING,
859                 .help = "device model (e1000, rtl8139, virtio etc.)",
860             }, {
861                 .name = "addr",
862                 .type = QEMU_OPT_STRING,
863                 .help = "PCI device address",
864             }, {
865                 .name = "vectors",
866                 .type = QEMU_OPT_NUMBER,
867                 .help = "number of MSI-x vectors, 0 to disable MSI-X",
868             },
869             { /* end of list */ }
870         },
871     },
872 #ifdef CONFIG_SLIRP
873     [NET_CLIENT_TYPE_USER] = {
874         .type = "user",
875         .init = net_init_slirp,
876         .desc = {
877             NET_COMMON_PARAMS_DESC,
878             {
879                 .name = "hostname",
880                 .type = QEMU_OPT_STRING,
881                 .help = "client hostname reported by the builtin DHCP server",
882             }, {
883                 .name = "restrict",
884                 .type = QEMU_OPT_STRING,
885                 .help = "isolate the guest from the host (y|yes|n|no)",
886             }, {
887                 .name = "ip",
888                 .type = QEMU_OPT_STRING,
889                 .help = "legacy parameter, use net= instead",
890             }, {
891                 .name = "net",
892                 .type = QEMU_OPT_STRING,
893                 .help = "IP address and optional netmask",
894             }, {
895                 .name = "host",
896                 .type = QEMU_OPT_STRING,
897                 .help = "guest-visible address of the host",
898             }, {
899                 .name = "tftp",
900                 .type = QEMU_OPT_STRING,
901                 .help = "root directory of the built-in TFTP server",
902             }, {
903                 .name = "bootfile",
904                 .type = QEMU_OPT_STRING,
905                 .help = "BOOTP filename, for use with tftp=",
906             }, {
907                 .name = "dhcpstart",
908                 .type = QEMU_OPT_STRING,
909                 .help = "the first of the 16 IPs the built-in DHCP server can assign",
910             }, {
911                 .name = "dns",
912                 .type = QEMU_OPT_STRING,
913                 .help = "guest-visible address of the virtual nameserver",
914             }, {
915                 .name = "smb",
916                 .type = QEMU_OPT_STRING,
917                 .help = "root directory of the built-in SMB server",
918             }, {
919                 .name = "smbserver",
920                 .type = QEMU_OPT_STRING,
921                 .help = "IP address of the built-in SMB server",
922             }, {
923                 .name = "hostfwd",
924                 .type = QEMU_OPT_STRING,
925                 .help = "guest port number to forward incoming TCP or UDP connections",
926             }, {
927                 .name = "guestfwd",
928                 .type = QEMU_OPT_STRING,
929                 .help = "IP address and port to forward guest TCP connections",
930             },
931             { /* end of list */ }
932         },
933     },
934 #endif
935     [NET_CLIENT_TYPE_TAP] = {
936         .type = "tap",
937         .init = net_init_tap,
938         .desc = {
939             NET_COMMON_PARAMS_DESC,
940             {
941                 .name = "ifname",
942                 .type = QEMU_OPT_STRING,
943                 .help = "interface name",
944             },
945 #ifndef _WIN32
946             {
947                 .name = "fd",
948                 .type = QEMU_OPT_STRING,
949                 .help = "file descriptor of an already opened tap",
950             }, {
951                 .name = "script",
952                 .type = QEMU_OPT_STRING,
953                 .help = "script to initialize the interface",
954             }, {
955                 .name = "downscript",
956                 .type = QEMU_OPT_STRING,
957                 .help = "script to shut down the interface",
958             }, {
959                 .name = "sndbuf",
960                 .type = QEMU_OPT_SIZE,
961                 .help = "send buffer limit"
962             }, {
963                 .name = "vnet_hdr",
964                 .type = QEMU_OPT_BOOL,
965                 .help = "enable the IFF_VNET_HDR flag on the tap interface"
966             }, {
967                 .name = "vhost",
968                 .type = QEMU_OPT_BOOL,
969                 .help = "enable vhost-net network accelerator",
970             }, {
971                 .name = "vhostfd",
972                 .type = QEMU_OPT_STRING,
973                 .help = "file descriptor of an already opened vhost net device",
974             }, {
975                 .name = "vhostforce",
976                 .type = QEMU_OPT_BOOL,
977                 .help = "force vhost on for non-MSIX virtio guests",
978         },
979 #endif /* _WIN32 */
980             { /* end of list */ }
981         },
982     },
983     [NET_CLIENT_TYPE_SOCKET] = {
984         .type = "socket",
985         .init = net_init_socket,
986         .desc = {
987             NET_COMMON_PARAMS_DESC,
988             {
989                 .name = "fd",
990                 .type = QEMU_OPT_STRING,
991                 .help = "file descriptor of an already opened socket",
992             }, {
993                 .name = "listen",
994                 .type = QEMU_OPT_STRING,
995                 .help = "port number, and optional hostname, to listen on",
996             }, {
997                 .name = "connect",
998                 .type = QEMU_OPT_STRING,
999                 .help = "port number, and optional hostname, to connect to",
1000             }, {
1001                 .name = "mcast",
1002                 .type = QEMU_OPT_STRING,
1003                 .help = "UDP multicast address and port number",
1004             }, {
1005                 .name = "localaddr",
1006                 .type = QEMU_OPT_STRING,
1007                 .help = "source address for multicast packets",
1008             },
1009             { /* end of list */ }
1010         },
1011     },
1012 #ifdef CONFIG_VDE
1013     [NET_CLIENT_TYPE_VDE] = {
1014         .type = "vde",
1015         .init = net_init_vde,
1016         .desc = {
1017             NET_COMMON_PARAMS_DESC,
1018             {
1019                 .name = "sock",
1020                 .type = QEMU_OPT_STRING,
1021                 .help = "socket path",
1022             }, {
1023                 .name = "port",
1024                 .type = QEMU_OPT_NUMBER,
1025                 .help = "port number",
1026             }, {
1027                 .name = "group",
1028                 .type = QEMU_OPT_STRING,
1029                 .help = "group owner of socket",
1030             }, {
1031                 .name = "mode",
1032                 .type = QEMU_OPT_NUMBER,
1033                 .help = "permissions for socket",
1034             },
1035             { /* end of list */ }
1036         },
1037     },
1038 #endif
1039     [NET_CLIENT_TYPE_DUMP] = {
1040         .type = "dump",
1041         .init = net_init_dump,
1042         .desc = {
1043             NET_COMMON_PARAMS_DESC,
1044             {
1045                 .name = "len",
1046                 .type = QEMU_OPT_SIZE,
1047                 .help = "per-packet size limit (64k default)",
1048             }, {
1049                 .name = "file",
1050                 .type = QEMU_OPT_STRING,
1051                 .help = "dump file path (default is qemu-vlan0.pcap)",
1052             },
1053             { /* end of list */ }
1054         },
1055     },
1056 };
1057
1058 int net_client_init(Monitor *mon, QemuOpts *opts, int is_netdev)
1059 {
1060     const char *name;
1061     const char *type;
1062     int i;
1063
1064     type = qemu_opt_get(opts, "type");
1065     if (!type) {
1066         qerror_report(QERR_MISSING_PARAMETER, "type");
1067         return -1;
1068     }
1069
1070     if (is_netdev) {
1071         if (strcmp(type, "tap") != 0 &&
1072 #ifdef CONFIG_SLIRP
1073             strcmp(type, "user") != 0 &&
1074 #endif
1075 #ifdef CONFIG_VDE
1076             strcmp(type, "vde") != 0 &&
1077 #endif
1078             strcmp(type, "socket") != 0) {
1079             qerror_report(QERR_INVALID_PARAMETER_VALUE, "type",
1080                           "a netdev backend type");
1081             return -1;
1082         }
1083
1084         if (qemu_opt_get(opts, "vlan")) {
1085             qerror_report(QERR_INVALID_PARAMETER, "vlan");
1086             return -1;
1087         }
1088         if (qemu_opt_get(opts, "name")) {
1089             qerror_report(QERR_INVALID_PARAMETER, "name");
1090             return -1;
1091         }
1092         if (!qemu_opts_id(opts)) {
1093             qerror_report(QERR_MISSING_PARAMETER, "id");
1094             return -1;
1095         }
1096     }
1097
1098     name = qemu_opts_id(opts);
1099     if (!name) {
1100         name = qemu_opt_get(opts, "name");
1101     }
1102
1103     for (i = 0; i < NET_CLIENT_TYPE_MAX; i++) {
1104         if (net_client_types[i].type != NULL &&
1105             !strcmp(net_client_types[i].type, type)) {
1106             VLANState *vlan = NULL;
1107             int ret;
1108
1109             if (qemu_opts_validate(opts, &net_client_types[i].desc[0]) == -1) {
1110                 return -1;
1111             }
1112
1113             /* Do not add to a vlan if it's a -netdev or a nic with a
1114              * netdev= parameter. */
1115             if (!(is_netdev ||
1116                   (strcmp(type, "nic") == 0 && qemu_opt_get(opts, "netdev")))) {
1117                 vlan = qemu_find_vlan(qemu_opt_get_number(opts, "vlan", 0), 1);
1118             }
1119
1120             ret = 0;
1121             if (net_client_types[i].init) {
1122                 ret = net_client_types[i].init(opts, mon, name, vlan);
1123                 if (ret < 0) {
1124                     /* TODO push error reporting into init() methods */
1125                     qerror_report(QERR_DEVICE_INIT_FAILED, type);
1126                     return -1;
1127                 }
1128             }
1129             return ret;
1130         }
1131     }
1132
1133     qerror_report(QERR_INVALID_PARAMETER_VALUE, "type",
1134                   "a network client type");
1135     return -1;
1136 }
1137
1138 static int net_host_check_device(const char *device)
1139 {
1140     int i;
1141     const char *valid_param_list[] = { "tap", "socket", "dump"
1142 #ifdef CONFIG_SLIRP
1143                                        ,"user"
1144 #endif
1145 #ifdef CONFIG_VDE
1146                                        ,"vde"
1147 #endif
1148     };
1149     for (i = 0; i < sizeof(valid_param_list) / sizeof(char *); i++) {
1150         if (!strncmp(valid_param_list[i], device,
1151                      strlen(valid_param_list[i])))
1152             return 1;
1153     }
1154
1155     return 0;
1156 }
1157
1158 void net_host_device_add(Monitor *mon, const QDict *qdict)
1159 {
1160     const char *device = qdict_get_str(qdict, "device");
1161     const char *opts_str = qdict_get_try_str(qdict, "opts");
1162     QemuOpts *opts;
1163
1164     if (!net_host_check_device(device)) {
1165         monitor_printf(mon, "invalid host network device %s\n", device);
1166         return;
1167     }
1168
1169     opts = qemu_opts_parse(qemu_find_opts("net"), opts_str ? opts_str : "", 0);
1170     if (!opts) {
1171         return;
1172     }
1173
1174     qemu_opt_set(opts, "type", device);
1175
1176     if (net_client_init(mon, opts, 0) < 0) {
1177         monitor_printf(mon, "adding host network device %s failed\n", device);
1178     }
1179 }
1180
1181 void net_host_device_remove(Monitor *mon, const QDict *qdict)
1182 {
1183     VLANClientState *vc;
1184     int vlan_id = qdict_get_int(qdict, "vlan_id");
1185     const char *device = qdict_get_str(qdict, "device");
1186
1187     vc = qemu_find_vlan_client_by_name(mon, vlan_id, device);
1188     if (!vc) {
1189         return;
1190     }
1191     if (!net_host_check_device(vc->model)) {
1192         monitor_printf(mon, "invalid host network device %s\n", device);
1193         return;
1194     }
1195     qemu_del_vlan_client(vc);
1196 }
1197
1198 int do_netdev_add(Monitor *mon, const QDict *qdict, QObject **ret_data)
1199 {
1200     QemuOpts *opts;
1201     int res;
1202
1203     opts = qemu_opts_from_qdict(qemu_find_opts("netdev"), qdict);
1204     if (!opts) {
1205         return -1;
1206     }
1207
1208     res = net_client_init(mon, opts, 1);
1209     if (res < 0) {
1210         qemu_opts_del(opts);
1211     }
1212
1213     return res;
1214 }
1215
1216 int do_netdev_del(Monitor *mon, const QDict *qdict, QObject **ret_data)
1217 {
1218     const char *id = qdict_get_str(qdict, "id");
1219     VLANClientState *vc;
1220
1221     vc = qemu_find_netdev(id);
1222     if (!vc) {
1223         qerror_report(QERR_DEVICE_NOT_FOUND, id);
1224         return -1;
1225     }
1226     qemu_del_vlan_client(vc);
1227     qemu_opts_del(qemu_opts_find(qemu_find_opts("netdev"), id));
1228     return 0;
1229 }
1230
1231 static void print_net_client(Monitor *mon, VLANClientState *vc)
1232 {
1233     monitor_printf(mon, "%s: type=%s,%s\n", vc->name,
1234                    net_client_types[vc->info->type].type, vc->info_str);
1235 }
1236
1237 void do_info_network(Monitor *mon)
1238 {
1239     VLANState *vlan;
1240     VLANClientState *vc, *peer;
1241     net_client_type type;
1242
1243     QTAILQ_FOREACH(vlan, &vlans, next) {
1244         monitor_printf(mon, "VLAN %d devices:\n", vlan->id);
1245
1246         QTAILQ_FOREACH(vc, &vlan->clients, next) {
1247             monitor_printf(mon, "  ");
1248             print_net_client(mon, vc);
1249         }
1250     }
1251     monitor_printf(mon, "Devices not on any VLAN:\n");
1252     QTAILQ_FOREACH(vc, &non_vlan_clients, next) {
1253         peer = vc->peer;
1254         type = vc->info->type;
1255         if (!peer || type == NET_CLIENT_TYPE_NIC) {
1256             monitor_printf(mon, "  ");
1257             print_net_client(mon, vc);
1258         } /* else it's a netdev connected to a NIC, printed with the NIC */
1259         if (peer && type == NET_CLIENT_TYPE_NIC) {
1260             monitor_printf(mon, "   \\ ");
1261             print_net_client(mon, peer);
1262         }
1263     }
1264 }
1265
1266 int do_set_link(Monitor *mon, const QDict *qdict, QObject **ret_data)
1267 {
1268     VLANState *vlan;
1269     VLANClientState *vc = NULL;
1270     const char *name = qdict_get_str(qdict, "name");
1271     int up = qdict_get_bool(qdict, "up");
1272
1273     QTAILQ_FOREACH(vlan, &vlans, next) {
1274         QTAILQ_FOREACH(vc, &vlan->clients, next) {
1275             if (strcmp(vc->name, name) == 0) {
1276                 goto done;
1277             }
1278         }
1279     }
1280     QTAILQ_FOREACH(vc, &non_vlan_clients, next) {
1281         if (!strcmp(vc->name, name)) {
1282             goto done;
1283         }
1284     }
1285 done:
1286
1287     if (!vc) {
1288         qerror_report(QERR_DEVICE_NOT_FOUND, name);
1289         return -1;
1290     }
1291
1292     vc->link_down = !up;
1293
1294     if (vc->info->link_status_changed) {
1295         vc->info->link_status_changed(vc);
1296     }
1297
1298     /* Notify peer. Don't update peer link status: this makes it possible to
1299      * disconnect from host network without notifying the guest.
1300      * FIXME: is disconnected link status change operation useful?
1301      *
1302      * Current behaviour is compatible with qemu vlans where there could be
1303      * multiple clients that can still communicate with each other in
1304      * disconnected mode. For now maintain this compatibility. */
1305     if (vc->peer && vc->peer->info->link_status_changed) {
1306         vc->peer->info->link_status_changed(vc->peer);
1307     }
1308     return 0;
1309 }
1310
1311 void net_cleanup(void)
1312 {
1313     VLANState *vlan;
1314     VLANClientState *vc, *next_vc;
1315
1316     QTAILQ_FOREACH(vlan, &vlans, next) {
1317         QTAILQ_FOREACH_SAFE(vc, &vlan->clients, next, next_vc) {
1318             qemu_del_vlan_client(vc);
1319         }
1320     }
1321
1322     QTAILQ_FOREACH_SAFE(vc, &non_vlan_clients, next, next_vc) {
1323         qemu_del_vlan_client(vc);
1324     }
1325 }
1326
1327 void net_check_clients(void)
1328 {
1329     VLANState *vlan;
1330     VLANClientState *vc;
1331     int i;
1332
1333     /* Don't warn about the default network setup that you get if
1334      * no command line -net or -netdev options are specified. There
1335      * are two cases that we would otherwise complain about:
1336      * (1) board doesn't support a NIC but the implicit "-net nic"
1337      * requested one
1338      * (2) CONFIG_SLIRP not set, in which case the implicit "-net nic"
1339      * sets up a nic that isn't connected to anything.
1340      */
1341     if (default_net) {
1342         return;
1343     }
1344
1345     QTAILQ_FOREACH(vlan, &vlans, next) {
1346         int has_nic = 0, has_host_dev = 0;
1347
1348         QTAILQ_FOREACH(vc, &vlan->clients, next) {
1349             switch (vc->info->type) {
1350             case NET_CLIENT_TYPE_NIC:
1351                 has_nic = 1;
1352                 break;
1353             case NET_CLIENT_TYPE_USER:
1354             case NET_CLIENT_TYPE_TAP:
1355             case NET_CLIENT_TYPE_SOCKET:
1356             case NET_CLIENT_TYPE_VDE:
1357                 has_host_dev = 1;
1358                 break;
1359             default: ;
1360             }
1361         }
1362         if (has_host_dev && !has_nic)
1363             fprintf(stderr, "Warning: vlan %d with no nics\n", vlan->id);
1364         if (has_nic && !has_host_dev)
1365             fprintf(stderr,
1366                     "Warning: vlan %d is not connected to host network\n",
1367                     vlan->id);
1368     }
1369     QTAILQ_FOREACH(vc, &non_vlan_clients, next) {
1370         if (!vc->peer) {
1371             fprintf(stderr, "Warning: %s %s has no peer\n",
1372                     vc->info->type == NET_CLIENT_TYPE_NIC ? "nic" : "netdev",
1373                     vc->name);
1374         }
1375     }
1376
1377     /* Check that all NICs requested via -net nic actually got created.
1378      * NICs created via -device don't need to be checked here because
1379      * they are always instantiated.
1380      */
1381     for (i = 0; i < MAX_NICS; i++) {
1382         NICInfo *nd = &nd_table[i];
1383         if (nd->used && !nd->instantiated) {
1384             fprintf(stderr, "Warning: requested NIC (%s, model %s) "
1385                     "was not created (not supported by this machine?)\n",
1386                     nd->name ? nd->name : "anonymous",
1387                     nd->model ? nd->model : "unspecified");
1388         }
1389     }
1390 }
1391
1392 static int net_init_client(QemuOpts *opts, void *dummy)
1393 {
1394     if (net_client_init(NULL, opts, 0) < 0)
1395         return -1;
1396     return 0;
1397 }
1398
1399 static int net_init_netdev(QemuOpts *opts, void *dummy)
1400 {
1401     return net_client_init(NULL, opts, 1);
1402 }
1403
1404 int net_init_clients(void)
1405 {
1406     QemuOptsList *net = qemu_find_opts("net");
1407
1408     if (default_net) {
1409         /* if no clients, we use a default config */
1410         qemu_opts_set(net, NULL, "type", "nic");
1411 #ifdef CONFIG_SLIRP
1412         qemu_opts_set(net, NULL, "type", "user");
1413 #endif
1414     }
1415
1416     QTAILQ_INIT(&vlans);
1417     QTAILQ_INIT(&non_vlan_clients);
1418
1419     if (qemu_opts_foreach(qemu_find_opts("netdev"), net_init_netdev, NULL, 1) == -1)
1420         return -1;
1421
1422     if (qemu_opts_foreach(net, net_init_client, NULL, 1) == -1) {
1423         return -1;
1424     }
1425
1426     return 0;
1427 }
1428
1429 int net_client_parse(QemuOptsList *opts_list, const char *optarg)
1430 {
1431 #if defined(CONFIG_SLIRP)
1432     int ret;
1433     if (net_slirp_parse_legacy(opts_list, optarg, &ret)) {
1434         return ret;
1435     }
1436 #endif
1437
1438     if (!qemu_opts_parse(opts_list, optarg, 1)) {
1439         return -1;
1440     }
1441
1442     default_net = 0;
1443     return 0;
1444 }