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