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/blockdev.h"
17 #include "hw/block/block.h"
18 #include "net/hub.h"
19 #include "qapi/visitor.h"
20 #include "sysemu/char.h"
21 #include "sysemu/iothread.h"
22 
23 static void get_pointer(Object *obj, Visitor *v, Property *prop,
24                         char *(*print)(void *ptr),
25                         const char *name, Error **errp)
26 {
27     DeviceState *dev = DEVICE(obj);
28     void **ptr = qdev_get_prop_ptr(dev, prop);
29     char *p;
30 
31     p = *ptr ? print(*ptr) : g_strdup("");
32     visit_type_str(v, &p, name, errp);
33     g_free(p);
34 }
35 
36 static void set_pointer(Object *obj, Visitor *v, Property *prop,
37                         int (*parse)(DeviceState *dev, const char *str,
38                                      void **ptr),
39                         const char *name, Error **errp)
40 {
41     DeviceState *dev = DEVICE(obj);
42     Error *local_err = NULL;
43     void **ptr = qdev_get_prop_ptr(dev, prop);
44     char *str;
45     int ret;
46 
47     if (dev->realized) {
48         qdev_prop_set_after_realize(dev, name, errp);
49         return;
50     }
51 
52     visit_type_str(v, &str, name, &local_err);
53     if (local_err) {
54         error_propagate(errp, local_err);
55         return;
56     }
57     if (!*str) {
58         g_free(str);
59         *ptr = NULL;
60         return;
61     }
62     ret = parse(dev, str, ptr);
63     error_set_from_qdev_prop_error(errp, ret, dev, prop, str);
64     g_free(str);
65 }
66 
67 /* --- drive --- */
68 
69 static int parse_drive(DeviceState *dev, const char *str, void **ptr)
70 {
71     BlockDriverState *bs;
72 
73     bs = bdrv_find(str);
74     if (bs == NULL) {
75         return -ENOENT;
76     }
77     if (bdrv_attach_dev(bs, dev) < 0) {
78         return -EEXIST;
79     }
80     *ptr = bs;
81     return 0;
82 }
83 
84 static void release_drive(Object *obj, const char *name, void *opaque)
85 {
86     DeviceState *dev = DEVICE(obj);
87     Property *prop = opaque;
88     BlockDriverState **ptr = qdev_get_prop_ptr(dev, prop);
89 
90     if (*ptr) {
91         bdrv_detach_dev(*ptr, dev);
92         blockdev_auto_del(*ptr);
93     }
94 }
95 
96 static char *print_drive(void *ptr)
97 {
98     return g_strdup(bdrv_get_device_name(ptr));
99 }
100 
101 static void get_drive(Object *obj, Visitor *v, void *opaque,
102                       const char *name, Error **errp)
103 {
104     get_pointer(obj, v, opaque, print_drive, name, errp);
105 }
106 
107 static void set_drive(Object *obj, Visitor *v, void *opaque,
108                       const char *name, Error **errp)
109 {
110     set_pointer(obj, v, opaque, parse_drive, name, errp);
111 }
112 
113 PropertyInfo qdev_prop_drive = {
114     .name  = "str",
115     .legacy_name  = "drive",
116     .get   = get_drive,
117     .set   = set_drive,
118     .release = release_drive,
119 };
120 
121 /* --- character device --- */
122 
123 static int parse_chr(DeviceState *dev, const char *str, void **ptr)
124 {
125     CharDriverState *chr = qemu_chr_find(str);
126     if (chr == NULL) {
127         return -ENOENT;
128     }
129     if (qemu_chr_fe_claim(chr) != 0) {
130         return -EEXIST;
131     }
132     *ptr = chr;
133     return 0;
134 }
135 
136 static void release_chr(Object *obj, const char *name, void *opaque)
137 {
138     DeviceState *dev = DEVICE(obj);
139     Property *prop = opaque;
140     CharDriverState **ptr = qdev_get_prop_ptr(dev, prop);
141     CharDriverState *chr = *ptr;
142 
143     if (chr) {
144         qemu_chr_add_handlers(chr, NULL, NULL, NULL, NULL);
145         qemu_chr_fe_release(chr);
146     }
147 }
148 
149 
150 static char *print_chr(void *ptr)
151 {
152     CharDriverState *chr = ptr;
153     const char *val = chr->label ? chr->label : "";
154 
155     return g_strdup(val);
156 }
157 
158 static void get_chr(Object *obj, Visitor *v, void *opaque,
159                     const char *name, Error **errp)
160 {
161     get_pointer(obj, v, opaque, print_chr, name, errp);
162 }
163 
164 static void set_chr(Object *obj, Visitor *v, void *opaque,
165                     const char *name, Error **errp)
166 {
167     set_pointer(obj, v, opaque, parse_chr, name, errp);
168 }
169 
170 PropertyInfo qdev_prop_chr = {
171     .name  = "str",
172     .legacy_name  = "chr",
173     .get   = get_chr,
174     .set   = set_chr,
175     .release = release_chr,
176 };
177 
178 /* --- netdev device --- */
179 
180 static int parse_netdev(DeviceState *dev, const char *str, void **ptr)
181 {
182     NICPeers *peers_ptr = (NICPeers *)ptr;
183     NetClientState **ncs = peers_ptr->ncs;
184     NetClientState *peers[MAX_QUEUE_NUM];
185     int queues, i = 0;
186     int ret;
187 
188     queues = qemu_find_net_clients_except(str, peers,
189                                           NET_CLIENT_OPTIONS_KIND_NIC,
190                                           MAX_QUEUE_NUM);
191     if (queues == 0) {
192         ret = -ENOENT;
193         goto err;
194     }
195 
196     if (queues > MAX_QUEUE_NUM) {
197         ret = -E2BIG;
198         goto err;
199     }
200 
201     for (i = 0; i < queues; i++) {
202         if (peers[i] == NULL) {
203             ret = -ENOENT;
204             goto err;
205         }
206 
207         if (peers[i]->peer) {
208             ret = -EEXIST;
209             goto err;
210         }
211 
212         if (ncs[i]) {
213             ret = -EINVAL;
214             goto err;
215         }
216 
217         ncs[i] = peers[i];
218         ncs[i]->queue_index = i;
219     }
220 
221     peers_ptr->queues = queues;
222 
223     return 0;
224 
225 err:
226     return ret;
227 }
228 
229 static char *print_netdev(void *ptr)
230 {
231     NetClientState *netdev = ptr;
232     const char *val = netdev->name ? netdev->name : "";
233 
234     return g_strdup(val);
235 }
236 
237 static void get_netdev(Object *obj, Visitor *v, void *opaque,
238                        const char *name, Error **errp)
239 {
240     get_pointer(obj, v, opaque, print_netdev, name, errp);
241 }
242 
243 static void set_netdev(Object *obj, Visitor *v, void *opaque,
244                        const char *name, Error **errp)
245 {
246     set_pointer(obj, v, opaque, parse_netdev, name, errp);
247 }
248 
249 PropertyInfo qdev_prop_netdev = {
250     .name  = "str",
251     .legacy_name  = "netdev",
252     .get   = get_netdev,
253     .set   = set_netdev,
254 };
255 
256 /* --- vlan --- */
257 
258 static int print_vlan(DeviceState *dev, Property *prop, char *dest, size_t len)
259 {
260     NetClientState **ptr = qdev_get_prop_ptr(dev, prop);
261 
262     if (*ptr) {
263         int id;
264         if (!net_hub_id_for_client(*ptr, &id)) {
265             return snprintf(dest, len, "%d", id);
266         }
267     }
268 
269     return snprintf(dest, len, "<null>");
270 }
271 
272 static void get_vlan(Object *obj, Visitor *v, void *opaque,
273                      const char *name, Error **errp)
274 {
275     DeviceState *dev = DEVICE(obj);
276     Property *prop = opaque;
277     NetClientState **ptr = qdev_get_prop_ptr(dev, prop);
278     int32_t id = -1;
279 
280     if (*ptr) {
281         int hub_id;
282         if (!net_hub_id_for_client(*ptr, &hub_id)) {
283             id = hub_id;
284         }
285     }
286 
287     visit_type_int32(v, &id, name, errp);
288 }
289 
290 static void set_vlan(Object *obj, Visitor *v, void *opaque,
291                      const char *name, Error **errp)
292 {
293     DeviceState *dev = DEVICE(obj);
294     Property *prop = opaque;
295     NICPeers *peers_ptr = qdev_get_prop_ptr(dev, prop);
296     NetClientState **ptr = &peers_ptr->ncs[0];
297     Error *local_err = NULL;
298     int32_t id;
299     NetClientState *hubport;
300 
301     if (dev->realized) {
302         qdev_prop_set_after_realize(dev, name, errp);
303         return;
304     }
305 
306     visit_type_int32(v, &id, name, &local_err);
307     if (local_err) {
308         error_propagate(errp, local_err);
309         return;
310     }
311     if (id == -1) {
312         *ptr = NULL;
313         return;
314     }
315     if (*ptr) {
316         error_set_from_qdev_prop_error(errp, -EINVAL, dev, prop, name);
317         return;
318     }
319 
320     hubport = net_hub_port_find(id);
321     if (!hubport) {
322         error_set(errp, QERR_INVALID_PARAMETER_VALUE,
323                   name, prop->info->name);
324         return;
325     }
326     *ptr = hubport;
327 }
328 
329 PropertyInfo qdev_prop_vlan = {
330     .name  = "int32",
331     .legacy_name  = "vlan",
332     .print = print_vlan,
333     .get   = get_vlan,
334     .set   = set_vlan,
335 };
336 
337 int qdev_prop_set_drive(DeviceState *dev, const char *name,
338                         BlockDriverState *value)
339 {
340     Error *err = NULL;
341     const char *bdrv_name = value ? bdrv_get_device_name(value) : "";
342     object_property_set_str(OBJECT(dev), bdrv_name,
343                             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                                 BlockDriverState *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 /* --- iothread --- */
389 
390 static char *print_iothread(void *ptr)
391 {
392     return iothread_get_id(ptr);
393 }
394 
395 static int parse_iothread(DeviceState *dev, const char *str, void **ptr)
396 {
397     IOThread *iothread;
398 
399     iothread = iothread_find(str);
400     if (!iothread) {
401         return -ENOENT;
402     }
403     object_ref(OBJECT(iothread));
404     *ptr = iothread;
405     return 0;
406 }
407 
408 static void get_iothread(Object *obj, struct Visitor *v, void *opaque,
409                          const char *name, Error **errp)
410 {
411     get_pointer(obj, v, opaque, print_iothread, name, errp);
412 }
413 
414 static void set_iothread(Object *obj, struct Visitor *v, void *opaque,
415                          const char *name, Error **errp)
416 {
417     set_pointer(obj, v, opaque, parse_iothread, name, errp);
418 }
419 
420 static void release_iothread(Object *obj, const char *name, void *opaque)
421 {
422     DeviceState *dev = DEVICE(obj);
423     Property *prop = opaque;
424     IOThread **ptr = qdev_get_prop_ptr(dev, prop);
425 
426     if (*ptr) {
427         object_unref(OBJECT(*ptr));
428     }
429 }
430 
431 PropertyInfo qdev_prop_iothread = {
432     .name = "iothread",
433     .get = get_iothread,
434     .set = set_iothread,
435     .release = release_iothread,
436 };
437 
438 static int qdev_add_one_global(QemuOpts *opts, void *opaque)
439 {
440     GlobalProperty *g;
441     ObjectClass *oc;
442 
443     g = g_malloc0(sizeof(*g));
444     g->driver   = qemu_opt_get(opts, "driver");
445     g->property = qemu_opt_get(opts, "property");
446     g->value    = qemu_opt_get(opts, "value");
447     oc = object_class_by_name(g->driver);
448     if (oc) {
449         DeviceClass *dc = DEVICE_CLASS(oc);
450 
451         if (dc->hotpluggable) {
452             /* If hotpluggable then skip not_used checking. */
453             g->not_used = false;
454         } else {
455             /* Maybe a typo. */
456             g->not_used = true;
457         }
458     } else {
459         /* Maybe a typo. */
460         g->not_used = true;
461     }
462     qdev_prop_register_global(g);
463     return 0;
464 }
465 
466 void qemu_add_globals(void)
467 {
468     qemu_opts_foreach(qemu_find_opts("global"), qdev_add_one_global, NULL, 0);
469 }
470