Documentation: Use UTF-8 encoding and fix one wrong encoding
[qemu/kevin.git] / net.h
blob116bb80119d10b82deb6d6bb7f5cd287a4bf3374
1 #ifndef QEMU_NET_H
2 #define QEMU_NET_H
4 #include <stdbool.h>
5 #include "qemu-queue.h"
6 #include "qemu-common.h"
7 #include "qdict.h"
8 #include "qemu-option.h"
9 #include "net/queue.h"
11 struct MACAddr {
12 uint8_t a[6];
15 /* qdev nic properties */
17 typedef struct NICConf {
18 MACAddr macaddr;
19 VLANState *vlan;
20 VLANClientState *peer;
21 } NICConf;
23 #define DEFINE_NIC_PROPERTIES(_state, _conf) \
24 DEFINE_PROP_MACADDR("mac", _state, _conf.macaddr), \
25 DEFINE_PROP_VLAN("vlan", _state, _conf.vlan), \
26 DEFINE_PROP_NETDEV("netdev", _state, _conf.peer)
28 /* VLANs support */
30 typedef enum {
31 NET_CLIENT_TYPE_NONE,
32 NET_CLIENT_TYPE_NIC,
33 NET_CLIENT_TYPE_SLIRP,
34 NET_CLIENT_TYPE_TAP,
35 NET_CLIENT_TYPE_SOCKET,
36 NET_CLIENT_TYPE_VDE,
37 NET_CLIENT_TYPE_DUMP
38 } net_client_type;
40 typedef void (NetPoll)(VLANClientState *, bool enable);
41 typedef int (NetCanReceive)(VLANClientState *);
42 typedef ssize_t (NetReceive)(VLANClientState *, const uint8_t *, size_t);
43 typedef ssize_t (NetReceiveIOV)(VLANClientState *, const struct iovec *, int);
44 typedef void (NetCleanup) (VLANClientState *);
45 typedef void (LinkStatusChanged)(VLANClientState *);
47 typedef struct NetClientInfo {
48 net_client_type type;
49 size_t size;
50 NetReceive *receive;
51 NetReceive *receive_raw;
52 NetReceiveIOV *receive_iov;
53 NetCanReceive *can_receive;
54 NetCleanup *cleanup;
55 LinkStatusChanged *link_status_changed;
56 NetPoll *poll;
57 } NetClientInfo;
59 struct VLANClientState {
60 NetClientInfo *info;
61 int link_down;
62 QTAILQ_ENTRY(VLANClientState) next;
63 struct VLANState *vlan;
64 VLANClientState *peer;
65 NetQueue *send_queue;
66 char *model;
67 char *name;
68 char info_str[256];
69 unsigned receive_disabled : 1;
72 typedef struct NICState {
73 VLANClientState nc;
74 NICConf *conf;
75 void *opaque;
76 } NICState;
78 struct VLANState {
79 int id;
80 QTAILQ_HEAD(, VLANClientState) clients;
81 QTAILQ_ENTRY(VLANState) next;
82 unsigned int nb_guest_devs, nb_host_devs;
83 NetQueue *send_queue;
86 VLANState *qemu_find_vlan(int id, int allocate);
87 VLANClientState *qemu_find_netdev(const char *id);
88 VLANClientState *qemu_new_net_client(NetClientInfo *info,
89 VLANState *vlan,
90 VLANClientState *peer,
91 const char *model,
92 const char *name);
93 NICState *qemu_new_nic(NetClientInfo *info,
94 NICConf *conf,
95 const char *model,
96 const char *name,
97 void *opaque);
98 void qemu_del_vlan_client(VLANClientState *vc);
99 VLANClientState *qemu_find_vlan_client_by_name(Monitor *mon, int vlan_id,
100 const char *client_str);
101 typedef void (*qemu_nic_foreach)(NICState *nic, void *opaque);
102 void qemu_foreach_nic(qemu_nic_foreach func, void *opaque);
103 int qemu_can_send_packet(VLANClientState *vc);
104 ssize_t qemu_sendv_packet(VLANClientState *vc, const struct iovec *iov,
105 int iovcnt);
106 ssize_t qemu_sendv_packet_async(VLANClientState *vc, const struct iovec *iov,
107 int iovcnt, NetPacketSent *sent_cb);
108 void qemu_send_packet(VLANClientState *vc, const uint8_t *buf, int size);
109 ssize_t qemu_send_packet_raw(VLANClientState *vc, const uint8_t *buf, int size);
110 ssize_t qemu_send_packet_async(VLANClientState *vc, const uint8_t *buf,
111 int size, NetPacketSent *sent_cb);
112 void qemu_purge_queued_packets(VLANClientState *vc);
113 void qemu_flush_queued_packets(VLANClientState *vc);
114 void qemu_format_nic_info_str(VLANClientState *vc, uint8_t macaddr[6]);
115 void qemu_macaddr_default_if_unset(MACAddr *macaddr);
116 int qemu_show_nic_models(const char *arg, const char *const *models);
117 void qemu_check_nic_model(NICInfo *nd, const char *model);
118 int qemu_find_nic_model(NICInfo *nd, const char * const *models,
119 const char *default_model);
121 void do_info_network(Monitor *mon);
122 void do_set_link(Monitor *mon, const QDict *qdict);
124 /* NIC info */
126 #define MAX_NICS 8
127 enum {
128 NIC_NVECTORS_UNSPECIFIED = -1
131 struct NICInfo {
132 uint8_t macaddr[6];
133 char *model;
134 char *name;
135 char *devaddr;
136 VLANState *vlan;
137 VLANClientState *netdev;
138 int used;
139 int bootable;
140 int nvectors;
143 extern int nb_nics;
144 extern NICInfo nd_table[MAX_NICS];
145 extern int default_net;
147 /* BT HCI info */
149 struct HCIInfo {
150 int (*bdaddr_set)(struct HCIInfo *hci, const uint8_t *bd_addr);
151 void (*cmd_send)(struct HCIInfo *hci, const uint8_t *data, int len);
152 void (*sco_send)(struct HCIInfo *hci, const uint8_t *data, int len);
153 void (*acl_send)(struct HCIInfo *hci, const uint8_t *data, int len);
154 void *opaque;
155 void (*evt_recv)(void *opaque, const uint8_t *data, int len);
156 void (*acl_recv)(void *opaque, const uint8_t *data, int len);
159 struct HCIInfo *qemu_next_hci(void);
161 /* from net.c */
162 extern const char *legacy_tftp_prefix;
163 extern const char *legacy_bootp_filename;
165 int net_client_init(Monitor *mon, QemuOpts *opts, int is_netdev);
166 void net_client_uninit(NICInfo *nd);
167 int net_client_parse(QemuOptsList *opts_list, const char *str);
168 int net_init_clients(void);
169 void net_cleanup(void);
170 void net_set_boot_mask(int boot_mask);
171 void net_host_device_add(Monitor *mon, const QDict *qdict);
172 void net_host_device_remove(Monitor *mon, const QDict *qdict);
174 #define DEFAULT_NETWORK_SCRIPT "/etc/qemu-ifup"
175 #define DEFAULT_NETWORK_DOWN_SCRIPT "/etc/qemu-ifdown"
176 #ifdef __sun__
177 #define SMBD_COMMAND "/usr/sfw/sbin/smbd"
178 #else
179 #define SMBD_COMMAND "/usr/sbin/smbd"
180 #endif
182 void qdev_set_nic_properties(DeviceState *dev, NICInfo *nd);
184 int net_handle_fd_param(Monitor *mon, const char *param);
186 #endif