qdev-properties.c 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095
  1. #include "qemu/osdep.h"
  2. #include "hw/qdev-properties.h"
  3. #include "qapi/error.h"
  4. #include "qapi/qapi-types-misc.h"
  5. #include "qobject/qlist.h"
  6. #include "qemu/ctype.h"
  7. #include "qemu/error-report.h"
  8. #include "qapi/visitor.h"
  9. #include "qemu/units.h"
  10. #include "qemu/cutils.h"
  11. #include "qdev-prop-internal.h"
  12. #include "qom/qom-qobject.h"
  13. void qdev_prop_set_after_realize(DeviceState *dev, const char *name,
  14. Error **errp)
  15. {
  16. if (dev->id) {
  17. error_setg(errp, "Attempt to set property '%s' on device '%s' "
  18. "(type '%s') after it was realized", name, dev->id,
  19. object_get_typename(OBJECT(dev)));
  20. } else {
  21. error_setg(errp, "Attempt to set property '%s' on anonymous device "
  22. "(type '%s') after it was realized", name,
  23. object_get_typename(OBJECT(dev)));
  24. }
  25. }
  26. /* returns: true if property is allowed to be set, false otherwise */
  27. static bool qdev_prop_allow_set(Object *obj, const char *name,
  28. const PropertyInfo *info, Error **errp)
  29. {
  30. DeviceState *dev = DEVICE(obj);
  31. if (dev->realized && !info->realized_set_allowed) {
  32. qdev_prop_set_after_realize(dev, name, errp);
  33. return false;
  34. }
  35. return true;
  36. }
  37. void qdev_prop_allow_set_link_before_realize(const Object *obj,
  38. const char *name,
  39. Object *val, Error **errp)
  40. {
  41. DeviceState *dev = DEVICE(obj);
  42. if (dev->realized) {
  43. error_setg(errp, "Attempt to set link property '%s' on device '%s' "
  44. "(type '%s') after it was realized",
  45. name, dev->id, object_get_typename(obj));
  46. }
  47. }
  48. void *object_field_prop_ptr(Object *obj, const Property *prop)
  49. {
  50. void *ptr = obj;
  51. ptr += prop->offset;
  52. return ptr;
  53. }
  54. static void field_prop_get(Object *obj, Visitor *v, const char *name,
  55. void *opaque, Error **errp)
  56. {
  57. const Property *prop = opaque;
  58. return prop->info->get(obj, v, name, opaque, errp);
  59. }
  60. /**
  61. * field_prop_getter: Return getter function to be used for property
  62. *
  63. * Return value can be NULL if @info has no getter function.
  64. */
  65. static ObjectPropertyAccessor *field_prop_getter(const PropertyInfo *info)
  66. {
  67. return info->get ? field_prop_get : NULL;
  68. }
  69. static void field_prop_set(Object *obj, Visitor *v, const char *name,
  70. void *opaque, Error **errp)
  71. {
  72. const Property *prop = opaque;
  73. if (!qdev_prop_allow_set(obj, name, prop->info, errp)) {
  74. return;
  75. }
  76. return prop->info->set(obj, v, name, opaque, errp);
  77. }
  78. /**
  79. * field_prop_setter: Return setter function to be used for property
  80. *
  81. * Return value can be NULL if @info has not setter function.
  82. */
  83. static ObjectPropertyAccessor *field_prop_setter(const PropertyInfo *info)
  84. {
  85. return info->set ? field_prop_set : NULL;
  86. }
  87. void qdev_propinfo_get_enum(Object *obj, Visitor *v, const char *name,
  88. void *opaque, Error **errp)
  89. {
  90. const Property *prop = opaque;
  91. int *ptr = object_field_prop_ptr(obj, prop);
  92. visit_type_enum(v, name, ptr, prop->info->enum_table, errp);
  93. }
  94. void qdev_propinfo_set_enum(Object *obj, Visitor *v, const char *name,
  95. void *opaque, Error **errp)
  96. {
  97. const Property *prop = opaque;
  98. int *ptr = object_field_prop_ptr(obj, prop);
  99. visit_type_enum(v, name, ptr, prop->info->enum_table, errp);
  100. }
  101. void qdev_propinfo_set_default_value_enum(ObjectProperty *op,
  102. const Property *prop)
  103. {
  104. object_property_set_default_str(op,
  105. qapi_enum_lookup(prop->info->enum_table, prop->defval.i));
  106. }
  107. const PropertyInfo qdev_prop_enum = {
  108. .name = "enum",
  109. .get = qdev_propinfo_get_enum,
  110. .set = qdev_propinfo_set_enum,
  111. .set_default_value = qdev_propinfo_set_default_value_enum,
  112. };
  113. /* Bit */
  114. static uint32_t qdev_get_prop_mask(const Property *prop)
  115. {
  116. assert(prop->info == &qdev_prop_bit);
  117. return 0x1 << prop->bitnr;
  118. }
  119. static void bit_prop_set(Object *obj, const Property *props, bool val)
  120. {
  121. uint32_t *p = object_field_prop_ptr(obj, props);
  122. uint32_t mask = qdev_get_prop_mask(props);
  123. if (val) {
  124. *p |= mask;
  125. } else {
  126. *p &= ~mask;
  127. }
  128. }
  129. static void prop_get_bit(Object *obj, Visitor *v, const char *name,
  130. void *opaque, Error **errp)
  131. {
  132. const Property *prop = opaque;
  133. uint32_t *p = object_field_prop_ptr(obj, prop);
  134. bool value = (*p & qdev_get_prop_mask(prop)) != 0;
  135. visit_type_bool(v, name, &value, errp);
  136. }
  137. static void prop_set_bit(Object *obj, Visitor *v, const char *name,
  138. void *opaque, Error **errp)
  139. {
  140. const Property *prop = opaque;
  141. bool value;
  142. if (!visit_type_bool(v, name, &value, errp)) {
  143. return;
  144. }
  145. bit_prop_set(obj, prop, value);
  146. }
  147. static void set_default_value_bool(ObjectProperty *op, const Property *prop)
  148. {
  149. object_property_set_default_bool(op, prop->defval.u);
  150. }
  151. const PropertyInfo qdev_prop_bit = {
  152. .name = "bool",
  153. .description = "on/off",
  154. .get = prop_get_bit,
  155. .set = prop_set_bit,
  156. .set_default_value = set_default_value_bool,
  157. };
  158. /* Bit64 */
  159. static uint64_t qdev_get_prop_mask64(const Property *prop)
  160. {
  161. assert(prop->info == &qdev_prop_bit64);
  162. return 0x1ull << prop->bitnr;
  163. }
  164. static void bit64_prop_set(Object *obj, const Property *props, bool val)
  165. {
  166. uint64_t *p = object_field_prop_ptr(obj, props);
  167. uint64_t mask = qdev_get_prop_mask64(props);
  168. if (val) {
  169. *p |= mask;
  170. } else {
  171. *p &= ~mask;
  172. }
  173. }
  174. static void prop_get_bit64(Object *obj, Visitor *v, const char *name,
  175. void *opaque, Error **errp)
  176. {
  177. const Property *prop = opaque;
  178. uint64_t *p = object_field_prop_ptr(obj, prop);
  179. bool value = (*p & qdev_get_prop_mask64(prop)) != 0;
  180. visit_type_bool(v, name, &value, errp);
  181. }
  182. static void prop_set_bit64(Object *obj, Visitor *v, const char *name,
  183. void *opaque, Error **errp)
  184. {
  185. const Property *prop = opaque;
  186. bool value;
  187. if (!visit_type_bool(v, name, &value, errp)) {
  188. return;
  189. }
  190. bit64_prop_set(obj, prop, value);
  191. }
  192. const PropertyInfo qdev_prop_bit64 = {
  193. .name = "bool",
  194. .description = "on/off",
  195. .get = prop_get_bit64,
  196. .set = prop_set_bit64,
  197. .set_default_value = set_default_value_bool,
  198. };
  199. /* --- bool --- */
  200. static void get_bool(Object *obj, Visitor *v, const char *name, void *opaque,
  201. Error **errp)
  202. {
  203. const Property *prop = opaque;
  204. bool *ptr = object_field_prop_ptr(obj, prop);
  205. visit_type_bool(v, name, ptr, errp);
  206. }
  207. static void set_bool(Object *obj, Visitor *v, const char *name, void *opaque,
  208. Error **errp)
  209. {
  210. const Property *prop = opaque;
  211. bool *ptr = object_field_prop_ptr(obj, prop);
  212. visit_type_bool(v, name, ptr, errp);
  213. }
  214. const PropertyInfo qdev_prop_bool = {
  215. .name = "bool",
  216. .get = get_bool,
  217. .set = set_bool,
  218. .set_default_value = set_default_value_bool,
  219. };
  220. /* --- 8bit integer --- */
  221. static void get_uint8(Object *obj, Visitor *v, const char *name, void *opaque,
  222. Error **errp)
  223. {
  224. const Property *prop = opaque;
  225. uint8_t *ptr = object_field_prop_ptr(obj, prop);
  226. visit_type_uint8(v, name, ptr, errp);
  227. }
  228. static void set_uint8(Object *obj, Visitor *v, const char *name, void *opaque,
  229. Error **errp)
  230. {
  231. const Property *prop = opaque;
  232. uint8_t *ptr = object_field_prop_ptr(obj, prop);
  233. visit_type_uint8(v, name, ptr, errp);
  234. }
  235. void qdev_propinfo_set_default_value_int(ObjectProperty *op,
  236. const Property *prop)
  237. {
  238. object_property_set_default_int(op, prop->defval.i);
  239. }
  240. void qdev_propinfo_set_default_value_uint(ObjectProperty *op,
  241. const Property *prop)
  242. {
  243. object_property_set_default_uint(op, prop->defval.u);
  244. }
  245. const PropertyInfo qdev_prop_uint8 = {
  246. .name = "uint8",
  247. .get = get_uint8,
  248. .set = set_uint8,
  249. .set_default_value = qdev_propinfo_set_default_value_uint,
  250. };
  251. /* --- 16bit integer --- */
  252. static void get_uint16(Object *obj, Visitor *v, const char *name,
  253. void *opaque, Error **errp)
  254. {
  255. const Property *prop = opaque;
  256. uint16_t *ptr = object_field_prop_ptr(obj, prop);
  257. visit_type_uint16(v, name, ptr, errp);
  258. }
  259. static void set_uint16(Object *obj, Visitor *v, const char *name,
  260. void *opaque, Error **errp)
  261. {
  262. const Property *prop = opaque;
  263. uint16_t *ptr = object_field_prop_ptr(obj, prop);
  264. visit_type_uint16(v, name, ptr, errp);
  265. }
  266. const PropertyInfo qdev_prop_uint16 = {
  267. .name = "uint16",
  268. .get = get_uint16,
  269. .set = set_uint16,
  270. .set_default_value = qdev_propinfo_set_default_value_uint,
  271. };
  272. /* --- 32bit integer --- */
  273. static void get_uint32(Object *obj, Visitor *v, const char *name,
  274. void *opaque, Error **errp)
  275. {
  276. const Property *prop = opaque;
  277. uint32_t *ptr = object_field_prop_ptr(obj, prop);
  278. visit_type_uint32(v, name, ptr, errp);
  279. }
  280. static void set_uint32(Object *obj, Visitor *v, const char *name,
  281. void *opaque, Error **errp)
  282. {
  283. const Property *prop = opaque;
  284. uint32_t *ptr = object_field_prop_ptr(obj, prop);
  285. visit_type_uint32(v, name, ptr, errp);
  286. }
  287. void qdev_propinfo_get_int32(Object *obj, Visitor *v, const char *name,
  288. void *opaque, Error **errp)
  289. {
  290. const Property *prop = opaque;
  291. int32_t *ptr = object_field_prop_ptr(obj, prop);
  292. visit_type_int32(v, name, ptr, errp);
  293. }
  294. static void set_int32(Object *obj, Visitor *v, const char *name, void *opaque,
  295. Error **errp)
  296. {
  297. const Property *prop = opaque;
  298. int32_t *ptr = object_field_prop_ptr(obj, prop);
  299. visit_type_int32(v, name, ptr, errp);
  300. }
  301. const PropertyInfo qdev_prop_uint32 = {
  302. .name = "uint32",
  303. .get = get_uint32,
  304. .set = set_uint32,
  305. .set_default_value = qdev_propinfo_set_default_value_uint,
  306. };
  307. const PropertyInfo qdev_prop_int32 = {
  308. .name = "int32",
  309. .get = qdev_propinfo_get_int32,
  310. .set = set_int32,
  311. .set_default_value = qdev_propinfo_set_default_value_int,
  312. };
  313. /* --- 64bit integer --- */
  314. static void get_uint64(Object *obj, Visitor *v, const char *name,
  315. void *opaque, Error **errp)
  316. {
  317. const Property *prop = opaque;
  318. uint64_t *ptr = object_field_prop_ptr(obj, prop);
  319. visit_type_uint64(v, name, ptr, errp);
  320. }
  321. static void set_uint64(Object *obj, Visitor *v, const char *name,
  322. void *opaque, Error **errp)
  323. {
  324. const Property *prop = opaque;
  325. uint64_t *ptr = object_field_prop_ptr(obj, prop);
  326. visit_type_uint64(v, name, ptr, errp);
  327. }
  328. static void get_int64(Object *obj, Visitor *v, const char *name,
  329. void *opaque, Error **errp)
  330. {
  331. const Property *prop = opaque;
  332. int64_t *ptr = object_field_prop_ptr(obj, prop);
  333. visit_type_int64(v, name, ptr, errp);
  334. }
  335. static void set_int64(Object *obj, Visitor *v, const char *name,
  336. void *opaque, Error **errp)
  337. {
  338. const Property *prop = opaque;
  339. int64_t *ptr = object_field_prop_ptr(obj, prop);
  340. visit_type_int64(v, name, ptr, errp);
  341. }
  342. const PropertyInfo qdev_prop_uint64 = {
  343. .name = "uint64",
  344. .get = get_uint64,
  345. .set = set_uint64,
  346. .set_default_value = qdev_propinfo_set_default_value_uint,
  347. };
  348. const PropertyInfo qdev_prop_int64 = {
  349. .name = "int64",
  350. .get = get_int64,
  351. .set = set_int64,
  352. .set_default_value = qdev_propinfo_set_default_value_int,
  353. };
  354. static void set_uint64_checkmask(Object *obj, Visitor *v, const char *name,
  355. void *opaque, Error **errp)
  356. {
  357. const Property *prop = opaque;
  358. uint64_t *ptr = object_field_prop_ptr(obj, prop);
  359. visit_type_uint64(v, name, ptr, errp);
  360. if (*ptr & ~prop->bitmask) {
  361. error_setg(errp, "Property value for '%s' has bits outside mask '0x%" PRIx64 "'",
  362. name, prop->bitmask);
  363. }
  364. }
  365. const PropertyInfo qdev_prop_uint64_checkmask = {
  366. .name = "uint64",
  367. .get = get_uint64,
  368. .set = set_uint64_checkmask,
  369. };
  370. /* --- string --- */
  371. static void release_string(Object *obj, const char *name, void *opaque)
  372. {
  373. const Property *prop = opaque;
  374. g_free(*(char **)object_field_prop_ptr(obj, prop));
  375. }
  376. static void get_string(Object *obj, Visitor *v, const char *name,
  377. void *opaque, Error **errp)
  378. {
  379. const Property *prop = opaque;
  380. char **ptr = object_field_prop_ptr(obj, prop);
  381. if (!*ptr) {
  382. char *str = (char *)"";
  383. visit_type_str(v, name, &str, errp);
  384. } else {
  385. visit_type_str(v, name, ptr, errp);
  386. }
  387. }
  388. static void set_string(Object *obj, Visitor *v, const char *name,
  389. void *opaque, Error **errp)
  390. {
  391. const Property *prop = opaque;
  392. char **ptr = object_field_prop_ptr(obj, prop);
  393. char *str;
  394. if (!visit_type_str(v, name, &str, errp)) {
  395. return;
  396. }
  397. g_free(*ptr);
  398. *ptr = str;
  399. }
  400. const PropertyInfo qdev_prop_string = {
  401. .name = "str",
  402. .release = release_string,
  403. .get = get_string,
  404. .set = set_string,
  405. };
  406. /* --- on/off/auto --- */
  407. const PropertyInfo qdev_prop_on_off_auto = {
  408. .name = "OnOffAuto",
  409. .description = "on/off/auto",
  410. .enum_table = &OnOffAuto_lookup,
  411. .get = qdev_propinfo_get_enum,
  412. .set = qdev_propinfo_set_enum,
  413. .set_default_value = qdev_propinfo_set_default_value_enum,
  414. };
  415. /* --- 32bit unsigned int 'size' type --- */
  416. void qdev_propinfo_get_size32(Object *obj, Visitor *v, const char *name,
  417. void *opaque, Error **errp)
  418. {
  419. const Property *prop = opaque;
  420. uint32_t *ptr = object_field_prop_ptr(obj, prop);
  421. uint64_t value = *ptr;
  422. visit_type_size(v, name, &value, errp);
  423. }
  424. static void set_size32(Object *obj, Visitor *v, const char *name, void *opaque,
  425. Error **errp)
  426. {
  427. const Property *prop = opaque;
  428. uint32_t *ptr = object_field_prop_ptr(obj, prop);
  429. uint64_t value;
  430. if (!visit_type_size(v, name, &value, errp)) {
  431. return;
  432. }
  433. if (value > UINT32_MAX) {
  434. error_setg(errp,
  435. "Property %s.%s doesn't take value %" PRIu64
  436. " (maximum: %u)",
  437. object_get_typename(obj), name, value, UINT32_MAX);
  438. return;
  439. }
  440. *ptr = value;
  441. }
  442. const PropertyInfo qdev_prop_size32 = {
  443. .name = "size",
  444. .get = qdev_propinfo_get_size32,
  445. .set = set_size32,
  446. .set_default_value = qdev_propinfo_set_default_value_uint,
  447. };
  448. /* --- support for array properties --- */
  449. typedef struct ArrayElementList ArrayElementList;
  450. struct ArrayElementList {
  451. ArrayElementList *next;
  452. void *value;
  453. };
  454. /*
  455. * Given an array property @parent_prop in @obj, return a Property for a
  456. * specific element of the array. Arrays are backed by an uint32_t length field
  457. * and an element array. @elem points at an element in this element array.
  458. */
  459. static Property array_elem_prop(Object *obj, const Property *parent_prop,
  460. const char *name, char *elem)
  461. {
  462. return (Property) {
  463. .info = parent_prop->arrayinfo,
  464. .name = name,
  465. /*
  466. * This ugly piece of pointer arithmetic sets up the offset so
  467. * that when the underlying release hook calls qdev_get_prop_ptr
  468. * they get the right answer despite the array element not actually
  469. * being inside the device struct.
  470. */
  471. .offset = (uintptr_t)elem - (uintptr_t)obj,
  472. };
  473. }
  474. /*
  475. * Object property release callback for array properties: We call the
  476. * underlying element's property release hook for each element.
  477. *
  478. * Note that it is the responsibility of the individual device's deinit
  479. * to free the array proper.
  480. */
  481. static void release_prop_array(Object *obj, const char *name, void *opaque)
  482. {
  483. const Property *prop = opaque;
  484. uint32_t *alenptr = object_field_prop_ptr(obj, prop);
  485. void **arrayptr = (void *)obj + prop->arrayoffset;
  486. char *elem = *arrayptr;
  487. int i;
  488. if (!prop->arrayinfo->release) {
  489. return;
  490. }
  491. for (i = 0; i < *alenptr; i++) {
  492. Property elem_prop = array_elem_prop(obj, prop, name, elem);
  493. prop->arrayinfo->release(obj, NULL, &elem_prop);
  494. elem += prop->arrayfieldsize;
  495. }
  496. }
  497. /*
  498. * Setter for an array property. This sets both the array length (which
  499. * is technically the property field in the object) and the array itself
  500. * (a pointer to which is stored in the additional field described by
  501. * prop->arrayoffset).
  502. */
  503. static void set_prop_array(Object *obj, Visitor *v, const char *name,
  504. void *opaque, Error **errp)
  505. {
  506. ERRP_GUARD();
  507. const Property *prop = opaque;
  508. uint32_t *alenptr = object_field_prop_ptr(obj, prop);
  509. void **arrayptr = (void *)obj + prop->arrayoffset;
  510. ArrayElementList *list, *elem, *next;
  511. const size_t size = sizeof(*list);
  512. char *elemptr;
  513. bool ok = true;
  514. if (*alenptr) {
  515. error_setg(errp, "array size property %s may not be set more than once",
  516. name);
  517. return;
  518. }
  519. if (!visit_start_list(v, name, (GenericList **) &list, size, errp)) {
  520. return;
  521. }
  522. /* Read the whole input into a temporary list */
  523. elem = list;
  524. while (elem) {
  525. Property elem_prop;
  526. elem->value = g_malloc0(prop->arrayfieldsize);
  527. elem_prop = array_elem_prop(obj, prop, name, elem->value);
  528. prop->arrayinfo->set(obj, v, NULL, &elem_prop, errp);
  529. if (*errp) {
  530. ok = false;
  531. goto out_obj;
  532. }
  533. if (*alenptr == INT_MAX) {
  534. error_setg(errp, "array is too big");
  535. return;
  536. }
  537. (*alenptr)++;
  538. elem = (ArrayElementList *) visit_next_list(v, (GenericList*) elem,
  539. size);
  540. }
  541. ok = visit_check_list(v, errp);
  542. out_obj:
  543. visit_end_list(v, (void**) &list);
  544. if (!ok) {
  545. for (elem = list; elem; elem = next) {
  546. Property elem_prop = array_elem_prop(obj, prop, name,
  547. elem->value);
  548. if (prop->arrayinfo->release) {
  549. prop->arrayinfo->release(obj, NULL, &elem_prop);
  550. }
  551. next = elem->next;
  552. g_free(elem->value);
  553. g_free(elem);
  554. }
  555. return;
  556. }
  557. /*
  558. * Now that we know how big the array has to be, move the data over to a
  559. * linear array and free the temporary list.
  560. */
  561. *arrayptr = g_malloc_n(*alenptr, prop->arrayfieldsize);
  562. elemptr = *arrayptr;
  563. for (elem = list; elem; elem = next) {
  564. memcpy(elemptr, elem->value, prop->arrayfieldsize);
  565. elemptr += prop->arrayfieldsize;
  566. next = elem->next;
  567. g_free(elem->value);
  568. g_free(elem);
  569. }
  570. }
  571. static void get_prop_array(Object *obj, Visitor *v, const char *name,
  572. void *opaque, Error **errp)
  573. {
  574. ERRP_GUARD();
  575. const Property *prop = opaque;
  576. uint32_t *alenptr = object_field_prop_ptr(obj, prop);
  577. void **arrayptr = (void *)obj + prop->arrayoffset;
  578. char *elemptr = *arrayptr;
  579. ArrayElementList *list = NULL, *elem;
  580. ArrayElementList **tail = &list;
  581. const size_t size = sizeof(*list);
  582. int i;
  583. bool ok;
  584. /* At least the string output visitor needs a real list */
  585. for (i = 0; i < *alenptr; i++) {
  586. elem = g_new0(ArrayElementList, 1);
  587. elem->value = elemptr;
  588. elemptr += prop->arrayfieldsize;
  589. *tail = elem;
  590. tail = &elem->next;
  591. }
  592. if (!visit_start_list(v, name, (GenericList **) &list, size, errp)) {
  593. return;
  594. }
  595. elem = list;
  596. while (elem) {
  597. Property elem_prop = array_elem_prop(obj, prop, name, elem->value);
  598. prop->arrayinfo->get(obj, v, NULL, &elem_prop, errp);
  599. if (*errp) {
  600. goto out_obj;
  601. }
  602. elem = (ArrayElementList *) visit_next_list(v, (GenericList*) elem,
  603. size);
  604. }
  605. /* visit_check_list() can only fail for input visitors */
  606. ok = visit_check_list(v, errp);
  607. assert(ok);
  608. out_obj:
  609. visit_end_list(v, (void**) &list);
  610. while (list) {
  611. elem = list;
  612. list = elem->next;
  613. g_free(elem);
  614. }
  615. }
  616. static void default_prop_array(ObjectProperty *op, const Property *prop)
  617. {
  618. object_property_set_default_list(op);
  619. }
  620. const PropertyInfo qdev_prop_array = {
  621. .name = "list",
  622. .get = get_prop_array,
  623. .set = set_prop_array,
  624. .release = release_prop_array,
  625. .set_default_value = default_prop_array,
  626. };
  627. /* --- public helpers --- */
  628. static const Property *qdev_prop_walk(DeviceClass *cls, const char *name)
  629. {
  630. for (int i = 0, n = cls->props_count_; i < n; ++i) {
  631. const Property *prop = &cls->props_[i];
  632. if (strcmp(prop->name, name) == 0) {
  633. return prop;
  634. }
  635. }
  636. return NULL;
  637. }
  638. static const Property *qdev_prop_find(DeviceState *dev, const char *name)
  639. {
  640. ObjectClass *class;
  641. const Property *prop;
  642. /* device properties */
  643. class = object_get_class(OBJECT(dev));
  644. do {
  645. prop = qdev_prop_walk(DEVICE_CLASS(class), name);
  646. if (prop) {
  647. return prop;
  648. }
  649. class = object_class_get_parent(class);
  650. } while (class != object_class_by_name(TYPE_DEVICE));
  651. return NULL;
  652. }
  653. void error_set_from_qdev_prop_error(Error **errp, int ret, Object *obj,
  654. const char *name, const char *value)
  655. {
  656. switch (ret) {
  657. case -EEXIST:
  658. error_setg(errp, "Property '%s.%s' can't take value '%s', it's in use",
  659. object_get_typename(obj), name, value);
  660. break;
  661. default:
  662. case -EINVAL:
  663. error_setg(errp, "Property '%s.%s' doesn't take value '%s'",
  664. object_get_typename(obj), name, value);
  665. break;
  666. case -ENOENT:
  667. error_setg(errp, "Property '%s.%s' can't find value '%s'",
  668. object_get_typename(obj), name, value);
  669. break;
  670. case 0:
  671. break;
  672. }
  673. }
  674. void qdev_prop_set_bit(DeviceState *dev, const char *name, bool value)
  675. {
  676. object_property_set_bool(OBJECT(dev), name, value, &error_abort);
  677. }
  678. void qdev_prop_set_uint8(DeviceState *dev, const char *name, uint8_t value)
  679. {
  680. object_property_set_int(OBJECT(dev), name, value, &error_abort);
  681. }
  682. void qdev_prop_set_uint16(DeviceState *dev, const char *name, uint16_t value)
  683. {
  684. object_property_set_int(OBJECT(dev), name, value, &error_abort);
  685. }
  686. void qdev_prop_set_uint32(DeviceState *dev, const char *name, uint32_t value)
  687. {
  688. object_property_set_int(OBJECT(dev), name, value, &error_abort);
  689. }
  690. void qdev_prop_set_int32(DeviceState *dev, const char *name, int32_t value)
  691. {
  692. object_property_set_int(OBJECT(dev), name, value, &error_abort);
  693. }
  694. void qdev_prop_set_uint64(DeviceState *dev, const char *name, uint64_t value)
  695. {
  696. object_property_set_int(OBJECT(dev), name, value, &error_abort);
  697. }
  698. void qdev_prop_set_string(DeviceState *dev, const char *name, const char *value)
  699. {
  700. object_property_set_str(OBJECT(dev), name, value, &error_abort);
  701. }
  702. void qdev_prop_set_enum(DeviceState *dev, const char *name, int value)
  703. {
  704. const Property *prop;
  705. prop = qdev_prop_find(dev, name);
  706. object_property_set_str(OBJECT(dev), name,
  707. qapi_enum_lookup(prop->info->enum_table, value),
  708. &error_abort);
  709. }
  710. void qdev_prop_set_array(DeviceState *dev, const char *name, QList *values)
  711. {
  712. object_property_set_qobject(OBJECT(dev), name, QOBJECT(values),
  713. &error_abort);
  714. qobject_unref(values);
  715. }
  716. static GPtrArray *global_props(void)
  717. {
  718. static GPtrArray *gp;
  719. if (!gp) {
  720. gp = g_ptr_array_new();
  721. }
  722. return gp;
  723. }
  724. void qdev_prop_register_global(GlobalProperty *prop)
  725. {
  726. g_ptr_array_add(global_props(), prop);
  727. }
  728. const GlobalProperty *qdev_find_global_prop(Object *obj,
  729. const char *name)
  730. {
  731. GPtrArray *props = global_props();
  732. const GlobalProperty *p;
  733. int i;
  734. for (i = 0; i < props->len; i++) {
  735. p = g_ptr_array_index(props, i);
  736. if (object_dynamic_cast(obj, p->driver)
  737. && !strcmp(p->property, name)) {
  738. return p;
  739. }
  740. }
  741. return NULL;
  742. }
  743. int qdev_prop_check_globals(void)
  744. {
  745. int i, ret = 0;
  746. for (i = 0; i < global_props()->len; i++) {
  747. GlobalProperty *prop;
  748. ObjectClass *oc;
  749. DeviceClass *dc;
  750. prop = g_ptr_array_index(global_props(), i);
  751. if (prop->used) {
  752. continue;
  753. }
  754. oc = object_class_by_name(prop->driver);
  755. oc = object_class_dynamic_cast(oc, TYPE_DEVICE);
  756. if (!oc) {
  757. warn_report("global %s.%s has invalid class name",
  758. prop->driver, prop->property);
  759. ret = 1;
  760. continue;
  761. }
  762. dc = DEVICE_CLASS(oc);
  763. if (!dc->hotpluggable && !prop->used) {
  764. warn_report("global %s.%s=%s not used",
  765. prop->driver, prop->property, prop->value);
  766. ret = 1;
  767. continue;
  768. }
  769. }
  770. return ret;
  771. }
  772. void qdev_prop_set_globals(DeviceState *dev)
  773. {
  774. object_apply_global_props(OBJECT(dev), global_props(),
  775. dev->hotplugged ? NULL : &error_fatal);
  776. }
  777. /* --- 64bit unsigned int 'size' type --- */
  778. static void get_size(Object *obj, Visitor *v, const char *name, void *opaque,
  779. Error **errp)
  780. {
  781. const Property *prop = opaque;
  782. uint64_t *ptr = object_field_prop_ptr(obj, prop);
  783. visit_type_size(v, name, ptr, errp);
  784. }
  785. static void set_size(Object *obj, Visitor *v, const char *name, void *opaque,
  786. Error **errp)
  787. {
  788. const Property *prop = opaque;
  789. uint64_t *ptr = object_field_prop_ptr(obj, prop);
  790. visit_type_size(v, name, ptr, errp);
  791. }
  792. const PropertyInfo qdev_prop_size = {
  793. .name = "size",
  794. .get = get_size,
  795. .set = set_size,
  796. .set_default_value = qdev_propinfo_set_default_value_uint,
  797. };
  798. /* --- object link property --- */
  799. static ObjectProperty *create_link_property(ObjectClass *oc, const char *name,
  800. const Property *prop)
  801. {
  802. return object_class_property_add_link(oc, name, prop->link_type,
  803. prop->offset,
  804. qdev_prop_allow_set_link_before_realize,
  805. OBJ_PROP_LINK_STRONG);
  806. }
  807. const PropertyInfo qdev_prop_link = {
  808. .name = "link",
  809. .create = create_link_property,
  810. };
  811. void qdev_property_add_static(DeviceState *dev, const Property *prop)
  812. {
  813. Object *obj = OBJECT(dev);
  814. ObjectProperty *op;
  815. assert(!prop->info->create);
  816. op = object_property_add(obj, prop->name, prop->info->name,
  817. field_prop_getter(prop->info),
  818. field_prop_setter(prop->info),
  819. prop->info->release,
  820. (Property *)prop);
  821. object_property_set_description(obj, prop->name,
  822. prop->info->description);
  823. if (prop->set_default) {
  824. prop->info->set_default_value(op, prop);
  825. if (op->init) {
  826. op->init(obj, op);
  827. }
  828. }
  829. }
  830. static void qdev_class_add_property(DeviceClass *klass, const char *name,
  831. const Property *prop)
  832. {
  833. ObjectClass *oc = OBJECT_CLASS(klass);
  834. ObjectProperty *op;
  835. if (prop->info->create) {
  836. op = prop->info->create(oc, name, prop);
  837. } else {
  838. op = object_class_property_add(oc,
  839. name, prop->info->name,
  840. field_prop_getter(prop->info),
  841. field_prop_setter(prop->info),
  842. prop->info->release,
  843. (Property *)prop);
  844. }
  845. if (prop->set_default) {
  846. prop->info->set_default_value(op, prop);
  847. }
  848. object_class_property_set_description(oc, name, prop->info->description);
  849. }
  850. /**
  851. * Legacy property handling
  852. */
  853. static void qdev_get_legacy_property(Object *obj, Visitor *v,
  854. const char *name, void *opaque,
  855. Error **errp)
  856. {
  857. const Property *prop = opaque;
  858. char buffer[1024];
  859. char *ptr = buffer;
  860. prop->info->print(obj, prop, buffer, sizeof(buffer));
  861. visit_type_str(v, name, &ptr, errp);
  862. }
  863. /**
  864. * qdev_class_add_legacy_property:
  865. * @dev: Device to add the property to.
  866. * @prop: The qdev property definition.
  867. *
  868. * Add a legacy QOM property to @dev for qdev property @prop.
  869. *
  870. * Legacy properties are string versions of QOM properties. The format of
  871. * the string depends on the property type. Legacy properties are only
  872. * needed for "info qtree".
  873. *
  874. * Do not use this in new code! QOM Properties added through this interface
  875. * will be given names in the "legacy" namespace.
  876. */
  877. static void qdev_class_add_legacy_property(DeviceClass *dc, const Property *prop)
  878. {
  879. g_autofree char *name = NULL;
  880. /* Register pointer properties as legacy properties */
  881. if (!prop->info->print && prop->info->get) {
  882. return;
  883. }
  884. name = g_strdup_printf("legacy-%s", prop->name);
  885. object_class_property_add(OBJECT_CLASS(dc), name, "str",
  886. prop->info->print ? qdev_get_legacy_property : prop->info->get,
  887. NULL, NULL, (Property *)prop);
  888. }
  889. void device_class_set_props_n(DeviceClass *dc, const Property *props, size_t n)
  890. {
  891. /* We used a hole in DeviceClass because that's still a lot. */
  892. assert(n <= UINT16_MAX);
  893. assert(n != 0);
  894. dc->props_ = props;
  895. dc->props_count_ = n;
  896. for (size_t i = 0; i < n; ++i) {
  897. const Property *prop = &props[i];
  898. assert(prop->name);
  899. qdev_class_add_legacy_property(dc, prop);
  900. qdev_class_add_property(dc, prop->name, prop);
  901. }
  902. }
  903. void qdev_alias_all_properties(DeviceState *target, Object *source)
  904. {
  905. ObjectClass *class;
  906. ObjectPropertyIterator iter;
  907. ObjectProperty *prop;
  908. class = object_get_class(OBJECT(target));
  909. object_class_property_iter_init(&iter, class);
  910. while ((prop = object_property_iter_next(&iter))) {
  911. if (object_property_find(source, prop->name)) {
  912. continue; /* skip duplicate properties */
  913. }
  914. object_property_add_alias(source, prop->name,
  915. OBJECT(target), prop->name);
  916. }
  917. }