1 /*
2  * qdev property parsing and global properties
3  * (parts specific for qemu-system-*)
4  *
5  * This file is based on code from hw/qdev-properties.c from
6  * commit 074a86fccd185616469dfcdc0e157f438aebba18,
7  * Copyright (c) Gerd Hoffmann <kraxel@redhat.com> and other contributors.
8  *
9  * This work is licensed under the terms of the GNU GPL, version 2 or later.
10  * See the COPYING file in the top-level directory.
11  */
12 
13 #include "net/net.h"
14 #include "hw/qdev.h"
15 #include "qapi/qmp/qerror.h"
16 #include "sysemu/block-backend.h"
17 #include "sysemu/blockdev.h"
18 #include "hw/block/block.h"
19 #include "net/hub.h"
20 #include "qapi/visitor.h"
21 #include "sysemu/char.h"
22 #include "sysemu/iothread.h"
23 
24 static void get_pointer(Object *obj, Visitor *v, Property *prop,
25                         char *(*print)(void *ptr),
26                         const char *name, Error **errp)
27 {
28     DeviceState *dev = DEVICE(obj);
29     void **ptr = qdev_get_prop_ptr(dev, prop);
30     char *p;
31 
32     p = *ptr ? print(*ptr) : g_strdup("");
33     visit_type_str(v, &p, name, errp);
34     g_free(p);
35 }
36 
37 static void set_pointer(Object *obj, Visitor *v, Property *prop,
38                         int (*parse)(DeviceState *dev, const char *str,
39                                      void **ptr),
40                         const char *name, Error **errp)
41 {
42     DeviceState *dev = DEVICE(obj);
43     Error *local_err = NULL;
44     void **ptr = qdev_get_prop_ptr(dev, prop);
45     char *str;
46     int ret;
47 
48     if (dev->realized) {
49         qdev_prop_set_after_realize(dev, name, errp);
50         return;
51     }
52 
53     visit_type_str(v, &str, name, &local_err);
54     if (local_err) {
55         error_propagate(errp, local_err);
56         return;
57     }
58     if (!*str) {
59         g_free(str);
60         *ptr = NULL;
61         return;
62     }
63     ret = parse(dev, str, ptr);
64     error_set_from_qdev_prop_error(errp, ret, dev, prop, str);
65     g_free(str);
66 }
67 
68 /* --- drive --- */
69 
70 static int parse_drive(DeviceState *dev, const char *str, void **ptr)
71 {
72     BlockBackend *blk;
73 
74     blk = blk_by_name(str);
75     if (!blk) {
76         return -ENOENT;
77     }
78     if (blk_attach_dev(blk, dev) < 0) {
79         return -EEXIST;
80     }
81     *ptr = blk;
82     return 0;
83 }
84 
85 static void release_drive(Object *obj, const char *name, void *opaque)
86 {
87     DeviceState *dev = DEVICE(obj);
88     Property *prop = opaque;
89     BlockBackend **ptr = qdev_get_prop_ptr(dev, prop);
90 
91     if (*ptr) {
92         blk_detach_dev(*ptr, dev);
93         blockdev_auto_del(*ptr);
94     }
95 }
96 
97 static char *print_drive(void *ptr)
98 {
99     return g_strdup(blk_name(ptr));
100 }
101 
102 static void get_drive(Object *obj, Visitor *v, void *opaque,
103                       const char *name, Error **errp)
104 {
105     get_pointer(obj, v, opaque, print_drive, name, errp);
106 }
107 
108 static void set_drive(Object *obj, Visitor *v, void *opaque,
109                       const char *name, Error **errp)
110 {
111     set_pointer(obj, v, opaque, parse_drive, name, errp);
112 }
113 
114 PropertyInfo qdev_prop_drive = {
115     .name  = "str",
116     .description = "ID of a drive to use as a backend",
117     .get   = get_drive,
118     .set   = set_drive,
119     .release = release_drive,
120 };
121 
122 /* --- character device --- */
123 
124 static int parse_chr(DeviceState *dev, const char *str, void **ptr)
125 {
126     CharDriverState *chr = qemu_chr_find(str);
127     if (chr == NULL) {
128         return -ENOENT;
129     }
130     if (qemu_chr_fe_claim(chr) != 0) {
131         return -EEXIST;
132     }
133     *ptr = chr;
134     return 0;
135 }
136 
137 static void release_chr(Object *obj, const char *name, void *opaque)
138 {
139     DeviceState *dev = DEVICE(obj);
140     Property *prop = opaque;
141     CharDriverState **ptr = qdev_get_prop_ptr(dev, prop);
142     CharDriverState *chr = *ptr;
143 
144     if (chr) {
145         qemu_chr_add_handlers(chr, NULL, NULL, NULL, NULL);
146         qemu_chr_fe_release(chr);
147     }
148 }
149 
150 
151 static char *print_chr(void *ptr)
152 {
153     CharDriverState *chr = ptr;
154     const char *val = chr->label ? chr->label : "";
155 
156     return g_strdup(val);
157 }
158 
159 static void get_chr(Object *obj, Visitor *v, void *opaque,
160                     const char *name, Error **errp)
161 {
162     get_pointer(obj, v, opaque, print_chr, name, errp);
163 }
164 
165 static void set_chr(Object *obj, Visitor *v, void *opaque,
166                     const char *name, Error **errp)
167 {
168     set_pointer(obj, v, opaque, parse_chr, name, errp);
169 }
170 
171 PropertyInfo qdev_prop_chr = {
172     .name  = "str",
173     .description = "ID of a chardev to use as a backend",
174     .get   = get_chr,
175     .set   = set_chr,
176     .release = release_chr,
177 };
178 
179 /* --- netdev device --- */
180 
181 static int parse_netdev(DeviceState *dev, const char *str, void **ptr)
182 {
183     NICPeers *peers_ptr = (NICPeers *)ptr;
184     NetClientState **ncs = peers_ptr->ncs;
185     NetClientState *peers[MAX_QUEUE_NUM];
186     int queues, i = 0;
187     int ret;
188 
189     queues = qemu_find_net_clients_except(str, peers,
190                                           NET_CLIENT_OPTIONS_KIND_NIC,
191                                           MAX_QUEUE_NUM);
192     if (queues == 0) {
193         ret = -ENOENT;
194         goto err;
195     }
196 
197     if (queues > MAX_QUEUE_NUM) {
198         ret = -E2BIG;
199         goto err;
200     }
201 
202     for (i = 0; i < queues; i++) {
203         if (peers[i] == NULL) {
204             ret = -ENOENT;
205             goto err;
206         }
207 
208         if (peers[i]->peer) {
209             ret = -EEXIST;
210             goto err;
211         }
212 
213         if (ncs[i]) {
214             ret = -EINVAL;
215             goto err;
216         }
217 
218         ncs[i] = peers[i];
219         ncs[i]->queue_index = i;
220     }
221 
222     peers_ptr->queues = queues;
223 
224     return 0;
225 
226 err:
227     return ret;
228 }
229 
230 static char *print_netdev(void *ptr)
231 {
232     NetClientState *netdev = ptr;
233     const char *val = netdev->name ? netdev->name : "";
234 
235     return g_strdup(val);
236 }
237 
238 static void get_netdev(Object *obj, Visitor *v, void *opaque,
239                        const char *name, Error **errp)
240 {
241     get_pointer(obj, v, opaque, print_netdev, name, errp);
242 }
243 
244 static void set_netdev(Object *obj, Visitor *v, void *opaque,
245                        const char *name, Error **errp)
246 {
247     set_pointer(obj, v, opaque, parse_netdev, name, errp);
248 }
249 
250 PropertyInfo qdev_prop_netdev = {
251     .name  = "str",
252     .description = "ID of a netdev to use as a backend",
253     .get   = get_netdev,
254     .set   = set_netdev,
255 };
256 
257 /* --- vlan --- */
258 
259 static int print_vlan(DeviceState *dev, Property *prop, char *dest, size_t len)
260 {
261     NetClientState **ptr = qdev_get_prop_ptr(dev, prop);
262 
263     if (*ptr) {
264         int id;
265         if (!net_hub_id_for_client(*ptr, &id)) {
266             return snprintf(dest, len, "%d", id);
267         }
268     }
269 
270     return snprintf(dest, len, "<null>");
271 }
272 
273 static void get_vlan(Object *obj, Visitor *v, void *opaque,
274                      const char *name, Error **errp)
275 {
276     DeviceState *dev = DEVICE(obj);
277     Property *prop = opaque;
278     NetClientState **ptr = qdev_get_prop_ptr(dev, prop);
279     int32_t id = -1;
280 
281     if (*ptr) {
282         int hub_id;
283         if (!net_hub_id_for_client(*ptr, &hub_id)) {
284             id = hub_id;
285         }
286     }
287 
288     visit_type_int32(v, &id, name, errp);
289 }
290 
291 static void set_vlan(Object *obj, Visitor *v, void *opaque,
292                      const char *name, Error **errp)
293 {
294     DeviceState *dev = DEVICE(obj);
295     Property *prop = opaque;
296     NICPeers *peers_ptr = qdev_get_prop_ptr(dev, prop);
297     NetClientState **ptr = &peers_ptr->ncs[0];
298     Error *local_err = NULL;
299     int32_t id;
300     NetClientState *hubport;
301 
302     if (dev->realized) {
303         qdev_prop_set_after_realize(dev, name, errp);
304         return;
305     }
306 
307     visit_type_int32(v, &id, name, &local_err);
308     if (local_err) {
309         error_propagate(errp, local_err);
310         return;
311     }
312     if (id == -1) {
313         *ptr = NULL;
314         return;
315     }
316     if (*ptr) {
317         error_set_from_qdev_prop_error(errp, -EINVAL, dev, prop, name);
318         return;
319     }
320 
321     hubport = net_hub_port_find(id);
322     if (!hubport) {
323         error_set(errp, QERR_INVALID_PARAMETER_VALUE,
324                   name, prop->info->name);
325         return;
326     }
327     *ptr = hubport;
328 }
329 
330 PropertyInfo qdev_prop_vlan = {
331     .name  = "int32",
332     .description = "Integer VLAN id to connect to",
333     .print = print_vlan,
334     .get   = get_vlan,
335     .set   = set_vlan,
336 };
337 
338 int qdev_prop_set_drive(DeviceState *dev, const char *name,
339                         BlockBackend *value)
340 {
341     Error *err = NULL;
342     object_property_set_str(OBJECT(dev),
343                             value ? blk_name(value) : "", name, &err);
344     if (err) {
345         qerror_report_err(err);
346         error_free(err);
347         return -1;
348     }
349     return 0;
350 }
351 
352 void qdev_prop_set_drive_nofail(DeviceState *dev, const char *name,
353                                 BlockBackend *value)
354 {
355     if (qdev_prop_set_drive(dev, name, value) < 0) {
356         exit(1);
357     }
358 }
359 void qdev_prop_set_chr(DeviceState *dev, const char *name,
360                        CharDriverState *value)
361 {
362     assert(!value || value->label);
363     object_property_set_str(OBJECT(dev),
364                             value ? value->label : "", name, &error_abort);
365 }
366 
367 void qdev_prop_set_netdev(DeviceState *dev, const char *name,
368                           NetClientState *value)
369 {
370     assert(!value || value->name);
371     object_property_set_str(OBJECT(dev),
372                             value ? value->name : "", name, &error_abort);
373 }
374 
375 void qdev_set_nic_properties(DeviceState *dev, NICInfo *nd)
376 {
377     qdev_prop_set_macaddr(dev, "mac", nd->macaddr.a);
378     if (nd->netdev) {
379         qdev_prop_set_netdev(dev, "netdev", nd->netdev);
380     }
381     if (nd->nvectors != DEV_NVECTORS_UNSPECIFIED &&
382         object_property_find(OBJECT(dev), "vectors", NULL)) {
383         qdev_prop_set_uint32(dev, "vectors", nd->nvectors);
384     }
385     nd->instantiated = 1;
386 }
387 
388 static int qdev_add_one_global(QemuOpts *opts, void *opaque)
389 {
390     GlobalProperty *g;
391 
392     g = g_malloc0(sizeof(*g));
393     g->driver   = qemu_opt_get(opts, "driver");
394     g->property = qemu_opt_get(opts, "property");
395     g->value    = qemu_opt_get(opts, "value");
396     g->user_provided = true;
397     qdev_prop_register_global(g);
398     return 0;
399 }
400 
401 void qemu_add_globals(void)
402 {
403     qemu_opts_foreach(qemu_find_opts("global"), qdev_add_one_global, NULL, 0);
404 }
405