dbus-message.c 46 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989
  1. /*
  2. *
  3. * Embedded Linux library
  4. *
  5. * Copyright (C) 2011-2014 Intel Corporation. All rights reserved.
  6. *
  7. * This library is free software; you can redistribute it and/or
  8. * modify it under the terms of the GNU Lesser General Public
  9. * License as published by the Free Software Foundation; either
  10. * version 2.1 of the License, or (at your option) any later version.
  11. *
  12. * This library is distributed in the hope that it will be useful,
  13. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  15. * Lesser General Public License for more details.
  16. *
  17. * You should have received a copy of the GNU Lesser General Public
  18. * License along with this library; if not, write to the Free Software
  19. * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  20. *
  21. */
  22. #ifdef HAVE_CONFIG_H
  23. #include <config.h>
  24. #endif
  25. #define _GNU_SOURCE
  26. #include <stdio.h>
  27. #include <fcntl.h>
  28. #include <unistd.h>
  29. #include "util.h"
  30. #include "private.h"
  31. #include "useful.h"
  32. #include "dbus.h"
  33. #include "dbus-private.h"
  34. #include "gvariant-private.h"
  35. #define DBUS_MESSAGE_LITTLE_ENDIAN ('l')
  36. #define DBUS_MESSAGE_BIG_ENDIAN ('B')
  37. #define DBUS_MESSAGE_PROTOCOL_VERSION 1
  38. #define DBUS_MESSAGE_FLAG_NO_REPLY_EXPECTED 0x01
  39. #define DBUS_MESSAGE_FLAG_NO_AUTO_START 0x02
  40. #define DBUS_MESSAGE_FIELD_PATH 1
  41. #define DBUS_MESSAGE_FIELD_INTERFACE 2
  42. #define DBUS_MESSAGE_FIELD_MEMBER 3
  43. #define DBUS_MESSAGE_FIELD_ERROR_NAME 4
  44. #define DBUS_MESSAGE_FIELD_REPLY_SERIAL 5
  45. #define DBUS_MESSAGE_FIELD_DESTINATION 6
  46. #define DBUS_MESSAGE_FIELD_SENDER 7
  47. #define DBUS_MESSAGE_FIELD_SIGNATURE 8
  48. #define DBUS_MESSAGE_FIELD_UNIX_FDS 9
  49. #define DBUS_MAX_NESTING 32
  50. struct l_dbus_message {
  51. int refcount;
  52. void *header;
  53. size_t header_size;
  54. size_t header_end;
  55. char *signature;
  56. void *body;
  57. size_t body_size;
  58. char *path;
  59. char *interface;
  60. char *member;
  61. char *error_name;
  62. uint32_t reply_serial;
  63. char *destination;
  64. char *sender;
  65. int fds[16];
  66. uint32_t num_fds;
  67. bool sealed : 1;
  68. bool signature_free : 1;
  69. };
  70. struct l_dbus_message_builder {
  71. struct l_dbus_message *message;
  72. struct dbus_builder *builder;
  73. struct builder_driver *driver;
  74. };
  75. static inline bool _dbus_message_is_gvariant(struct l_dbus_message *msg)
  76. {
  77. struct dbus_header *hdr = msg->header;
  78. return hdr->version == 2;
  79. }
  80. void *_dbus_message_get_header(struct l_dbus_message *msg, size_t *out_size)
  81. {
  82. if (out_size)
  83. *out_size = msg->header_size;
  84. return msg->header;
  85. }
  86. void *_dbus_message_get_body(struct l_dbus_message *msg, size_t *out_size)
  87. {
  88. if (out_size)
  89. *out_size = msg->body_size;
  90. return msg->body;
  91. }
  92. /* Get a buffer containing the final message contents except the header */
  93. void *_dbus_message_get_footer(struct l_dbus_message *msg, size_t *out_size)
  94. {
  95. size_t size;
  96. if (_dbus_message_is_gvariant(msg)) {
  97. size = _gvariant_message_finalize(msg->header_end,
  98. msg->body, msg->body_size,
  99. msg->signature);
  100. size -= msg->header_size;
  101. } else
  102. size = msg->body_size;
  103. if (out_size)
  104. *out_size = size;
  105. return msg->body;
  106. }
  107. int *_dbus_message_get_fds(struct l_dbus_message *msg, uint32_t *num_fds)
  108. {
  109. *num_fds = msg->num_fds;
  110. return msg->fds;
  111. }
  112. void _dbus_message_set_serial(struct l_dbus_message *msg, uint32_t serial)
  113. {
  114. struct dbus_header *hdr = msg->header;
  115. hdr->dbus1.serial = serial;
  116. }
  117. uint32_t _dbus_message_get_serial(struct l_dbus_message *msg)
  118. {
  119. struct dbus_header *hdr = msg->header;
  120. return hdr->dbus1.serial;
  121. }
  122. LIB_EXPORT bool l_dbus_message_set_no_reply(struct l_dbus_message *msg, bool on)
  123. {
  124. struct dbus_header *hdr;
  125. if (unlikely(!msg))
  126. return false;
  127. hdr = msg->header;
  128. if (on)
  129. hdr->flags |= DBUS_MESSAGE_FLAG_NO_REPLY_EXPECTED;
  130. else
  131. hdr->flags &= ~DBUS_MESSAGE_FLAG_NO_REPLY_EXPECTED;
  132. return true;
  133. }
  134. LIB_EXPORT bool l_dbus_message_get_no_reply(struct l_dbus_message *msg)
  135. {
  136. struct dbus_header *hdr;
  137. if (unlikely(!msg))
  138. return false;
  139. hdr = msg->header;
  140. if (hdr->flags & DBUS_MESSAGE_FLAG_NO_REPLY_EXPECTED)
  141. return true;
  142. return false;
  143. }
  144. LIB_EXPORT bool l_dbus_message_set_no_autostart(struct l_dbus_message *msg,
  145. bool on)
  146. {
  147. struct dbus_header *hdr;
  148. if (unlikely(!msg))
  149. return false;
  150. hdr = msg->header;
  151. if (on)
  152. hdr->flags |= DBUS_MESSAGE_FLAG_NO_AUTO_START;
  153. else
  154. hdr->flags &= ~DBUS_MESSAGE_FLAG_NO_AUTO_START;
  155. return true;
  156. }
  157. LIB_EXPORT bool l_dbus_message_get_no_autostart(struct l_dbus_message *msg)
  158. {
  159. struct dbus_header *hdr;
  160. if (unlikely(!msg))
  161. return false;
  162. hdr = msg->header;
  163. if (hdr->flags & DBUS_MESSAGE_FLAG_NO_AUTO_START)
  164. return true;
  165. return false;
  166. }
  167. static struct l_dbus_message *message_new_common(uint8_t type, uint8_t flags,
  168. uint8_t version)
  169. {
  170. struct l_dbus_message *message;
  171. struct dbus_header *hdr;
  172. message = l_new(struct l_dbus_message, 1);
  173. message->refcount = 1;
  174. /*
  175. * We allocate the header with the initial 12 bytes (up to the field
  176. * length) so that we can store the basic information here. For
  177. * GVariant we need 16 bytes.
  178. */
  179. message->header_size = version == 1 ? 12 : 16;
  180. message->header_end = message->header_size;
  181. message->header = l_realloc(NULL, message->header_size);
  182. hdr = message->header;
  183. hdr->endian = DBUS_NATIVE_ENDIAN;
  184. hdr->message_type = type;
  185. hdr->flags = flags;
  186. hdr->version = version;
  187. return message;
  188. }
  189. struct l_dbus_message *_dbus_message_new_method_call(uint8_t version,
  190. const char *destination,
  191. const char *path,
  192. const char *interface,
  193. const char *method)
  194. {
  195. struct l_dbus_message *message;
  196. message = message_new_common(DBUS_MESSAGE_TYPE_METHOD_CALL, 0, version);
  197. message->destination = l_strdup(destination);
  198. message->path = l_strdup(path);
  199. message->interface = l_strdup(interface);
  200. message->member = l_strdup(method);
  201. return message;
  202. }
  203. LIB_EXPORT struct l_dbus_message *l_dbus_message_new_method_call(
  204. struct l_dbus *dbus,
  205. const char *destination,
  206. const char *path,
  207. const char *interface,
  208. const char *method)
  209. {
  210. uint8_t version;
  211. if (unlikely(!dbus))
  212. return NULL;
  213. version = _dbus_get_version(dbus);
  214. return _dbus_message_new_method_call(version, destination, path,
  215. interface, method);
  216. }
  217. struct l_dbus_message *_dbus_message_new_signal(uint8_t version,
  218. const char *path,
  219. const char *interface,
  220. const char *name)
  221. {
  222. struct l_dbus_message *message;
  223. message = message_new_common(DBUS_MESSAGE_TYPE_SIGNAL,
  224. DBUS_MESSAGE_FLAG_NO_REPLY_EXPECTED,
  225. version);
  226. message->path = l_strdup(path);
  227. message->interface = l_strdup(interface);
  228. message->member = l_strdup(name);
  229. return message;
  230. }
  231. LIB_EXPORT struct l_dbus_message *l_dbus_message_new_signal(struct l_dbus *dbus,
  232. const char *path,
  233. const char *interface,
  234. const char *name)
  235. {
  236. uint8_t version;
  237. if (unlikely(!dbus))
  238. return NULL;
  239. version = _dbus_get_version(dbus);
  240. return _dbus_message_new_signal(version, path, interface, name);
  241. }
  242. LIB_EXPORT struct l_dbus_message *l_dbus_message_new_method_return(
  243. struct l_dbus_message *method_call)
  244. {
  245. struct l_dbus_message *message;
  246. struct dbus_header *hdr = method_call->header;
  247. const char *sender;
  248. message = message_new_common(DBUS_MESSAGE_TYPE_METHOD_RETURN,
  249. DBUS_MESSAGE_FLAG_NO_REPLY_EXPECTED,
  250. hdr->version);
  251. if (!l_dbus_message_get_no_reply(method_call))
  252. message->reply_serial = _dbus_message_get_serial(method_call);
  253. sender = l_dbus_message_get_sender(method_call);
  254. if (sender)
  255. message->destination = l_strdup(sender);
  256. return message;
  257. }
  258. struct l_dbus_message *_dbus_message_new_error(uint8_t version,
  259. uint32_t reply_serial,
  260. const char *destination,
  261. const char *name,
  262. const char *error)
  263. {
  264. struct l_dbus_message *reply;
  265. if (!_dbus_valid_interface(name))
  266. return NULL;
  267. reply = message_new_common(DBUS_MESSAGE_TYPE_ERROR,
  268. DBUS_MESSAGE_FLAG_NO_REPLY_EXPECTED,
  269. version);
  270. reply->error_name = l_strdup(name);
  271. reply->destination = l_strdup(destination);
  272. reply->reply_serial = reply_serial;
  273. if (!l_dbus_message_set_arguments(reply, "s", error)) {
  274. l_dbus_message_unref(reply);
  275. return NULL;
  276. }
  277. return reply;
  278. }
  279. LIB_EXPORT struct l_dbus_message *l_dbus_message_new_error_valist(
  280. struct l_dbus_message *method_call,
  281. const char *name,
  282. const char *format, va_list args)
  283. {
  284. char str[1024];
  285. struct dbus_header *hdr = method_call->header;
  286. uint32_t reply_serial = 0;
  287. vsnprintf(str, sizeof(str), format, args);
  288. if (!l_dbus_message_get_no_reply(method_call))
  289. reply_serial = _dbus_message_get_serial(method_call);
  290. return _dbus_message_new_error(hdr->version, reply_serial,
  291. l_dbus_message_get_sender(method_call),
  292. name, str);
  293. }
  294. LIB_EXPORT struct l_dbus_message *l_dbus_message_new_error(
  295. struct l_dbus_message *method_call,
  296. const char *name,
  297. const char *format, ...)
  298. {
  299. va_list args;
  300. struct l_dbus_message *reply;
  301. va_start(args, format);
  302. reply = l_dbus_message_new_error_valist(method_call, name,
  303. format, args);
  304. va_end(args);
  305. return reply;
  306. }
  307. LIB_EXPORT struct l_dbus_message *l_dbus_message_ref(struct l_dbus_message *message)
  308. {
  309. if (unlikely(!message))
  310. return NULL;
  311. __atomic_fetch_add(&message->refcount, 1, __ATOMIC_SEQ_CST);
  312. return message;
  313. }
  314. LIB_EXPORT void l_dbus_message_unref(struct l_dbus_message *message)
  315. {
  316. unsigned int i;
  317. if (unlikely(!message))
  318. return;
  319. if (__atomic_sub_fetch(&message->refcount, 1, __ATOMIC_SEQ_CST))
  320. return;
  321. for (i = 0; i < message->num_fds; i++)
  322. close(message->fds[i]);
  323. if (!message->sealed) {
  324. l_free(message->destination);
  325. l_free(message->path);
  326. l_free(message->interface);
  327. l_free(message->member);
  328. l_free(message->error_name);
  329. l_free(message->sender);
  330. }
  331. if (message->signature_free)
  332. l_free(message->signature);
  333. l_free(message->header);
  334. l_free(message->body);
  335. l_free(message);
  336. }
  337. const char *_dbus_message_get_nth_string_argument(
  338. struct l_dbus_message *message, int n)
  339. {
  340. struct l_dbus_message_iter iter;
  341. const char *signature, *value;
  342. void *body;
  343. size_t size;
  344. char type;
  345. bool (*skip_entry)(struct l_dbus_message_iter *);
  346. bool (*get_basic)(struct l_dbus_message_iter *, char, void *);
  347. signature = l_dbus_message_get_signature(message);
  348. body = _dbus_message_get_body(message, &size);
  349. if (!signature)
  350. return NULL;
  351. if (_dbus_message_is_gvariant(message)) {
  352. if (!_gvariant_iter_init(&iter, message, signature, NULL,
  353. body, size))
  354. return NULL;
  355. skip_entry = _gvariant_iter_skip_entry;
  356. get_basic = _gvariant_iter_next_entry_basic;
  357. } else {
  358. _dbus1_iter_init(&iter, message, signature, NULL, body, size);
  359. skip_entry = _dbus1_iter_skip_entry;
  360. get_basic = _dbus1_iter_next_entry_basic;
  361. }
  362. while (n--)
  363. if (!skip_entry(&iter))
  364. return NULL;
  365. if (!iter.sig_start)
  366. return NULL;
  367. type = iter.sig_start[iter.sig_pos];
  368. if (!strchr("sog", type))
  369. return NULL;
  370. if (!get_basic(&iter, type, &value))
  371. return NULL;
  372. return value;
  373. }
  374. static bool message_iter_next_entry_valist(struct l_dbus_message_iter *orig,
  375. va_list args)
  376. {
  377. static const char *simple_types = "sogybnqiuxtd";
  378. struct l_dbus_message_iter *iter = orig;
  379. const char *signature = orig->sig_start + orig->sig_pos;
  380. const char *end;
  381. struct l_dbus_message_iter *sub_iter;
  382. struct l_dbus_message_iter stack[DBUS_MAX_NESTING];
  383. unsigned int indent = 0;
  384. uint32_t uint32_val;
  385. int fd;
  386. void *arg;
  387. bool (*get_basic)(struct l_dbus_message_iter *, char ,void *);
  388. bool (*enter_struct)(struct l_dbus_message_iter *,
  389. struct l_dbus_message_iter *);
  390. bool (*enter_array)(struct l_dbus_message_iter *,
  391. struct l_dbus_message_iter *);
  392. bool (*enter_variant)(struct l_dbus_message_iter *,
  393. struct l_dbus_message_iter *);
  394. if (_dbus_message_is_gvariant(orig->message)) {
  395. get_basic = _gvariant_iter_next_entry_basic;
  396. enter_struct = _gvariant_iter_enter_struct;
  397. enter_array = _gvariant_iter_enter_array;
  398. enter_variant = _gvariant_iter_enter_variant;
  399. } else {
  400. get_basic = _dbus1_iter_next_entry_basic;
  401. enter_struct = _dbus1_iter_enter_struct;
  402. enter_array = _dbus1_iter_enter_array;
  403. enter_variant = _dbus1_iter_enter_variant;
  404. }
  405. while (signature < orig->sig_start + orig->sig_len) {
  406. if (strchr(simple_types, *signature)) {
  407. arg = va_arg(args, void *);
  408. if (!get_basic(iter, *signature, arg))
  409. return false;
  410. signature += 1;
  411. continue;
  412. }
  413. switch (*signature) {
  414. case 'h':
  415. if (!get_basic(iter, 'h', &uint32_val))
  416. return false;
  417. if (uint32_val < iter->message->num_fds)
  418. fd = fcntl(iter->message->fds[uint32_val],
  419. F_DUPFD_CLOEXEC, 3);
  420. else
  421. fd = -1;
  422. *va_arg(args, int *) = fd;
  423. signature += 1;
  424. break;
  425. case '(':
  426. case '{':
  427. signature += 1;
  428. indent += 1;
  429. if (indent > DBUS_MAX_NESTING)
  430. return false;
  431. if (!enter_struct(iter, &stack[indent - 1]))
  432. return false;
  433. iter = &stack[indent - 1];
  434. break;
  435. case ')':
  436. case '}':
  437. /*
  438. * Sanity check in case of an unmatched paren/brace
  439. * that isn't caught elsewhere.
  440. */
  441. if (unlikely(indent == 0))
  442. return false;
  443. signature += 1;
  444. indent -= 1;
  445. if (indent == 0)
  446. iter = orig;
  447. else
  448. iter = &stack[indent - 1];
  449. break;
  450. case 'a':
  451. sub_iter = va_arg(args, void *);
  452. if (!enter_array(iter, sub_iter))
  453. return false;
  454. end = _dbus_signature_end(signature + 1);
  455. signature = end + 1;
  456. break;
  457. case 'v':
  458. sub_iter = va_arg(args, void *);
  459. if (!enter_variant(iter, sub_iter))
  460. return false;
  461. signature += 1;
  462. break;
  463. default:
  464. return false;
  465. }
  466. }
  467. return true;
  468. }
  469. static inline bool message_iter_next_entry(struct l_dbus_message_iter *iter,
  470. ...)
  471. {
  472. va_list args;
  473. bool result;
  474. va_start(args, iter);
  475. result = message_iter_next_entry_valist(iter, args);
  476. va_end(args);
  477. return result;
  478. }
  479. static bool get_header_field_from_iter_valist(struct l_dbus_message *message,
  480. uint8_t type, char data_type,
  481. va_list args)
  482. {
  483. struct l_dbus_message_iter header;
  484. struct l_dbus_message_iter array, iter;
  485. uint8_t endian, message_type, flags, version;
  486. uint32_t body_length, serial;
  487. bool found;
  488. if (!message->sealed)
  489. return false;
  490. if (_dbus_message_is_gvariant(message)) {
  491. uint64_t field_type;
  492. if (!_gvariant_iter_init(&header, message, "a(tv)", NULL,
  493. message->header + 16,
  494. message->header_end - 16))
  495. return false;
  496. if (!_gvariant_iter_enter_array(&header, &array))
  497. return false;
  498. while ((found = message_iter_next_entry(&array,
  499. &field_type, &iter)))
  500. if (field_type == type)
  501. break;
  502. } else {
  503. uint8_t field_type;
  504. _dbus1_iter_init(&header, message, "yyyyuua(yv)", NULL,
  505. message->header, message->header_size);
  506. if (!message_iter_next_entry(&header, &endian,
  507. &message_type, &flags, &version,
  508. &body_length, &serial, &array))
  509. return false;
  510. while ((found = message_iter_next_entry(&array,
  511. &field_type, &iter)))
  512. if (field_type == type)
  513. break;
  514. }
  515. if (!found)
  516. return false;
  517. if (iter.sig_start[iter.sig_pos] != data_type)
  518. return false;
  519. return message_iter_next_entry_valist(&iter, args);
  520. }
  521. static inline bool get_header_field(struct l_dbus_message *message,
  522. uint8_t type, int data_type, ...)
  523. {
  524. va_list args;
  525. bool result;
  526. va_start(args, data_type);
  527. result = get_header_field_from_iter_valist(message, type, data_type,
  528. args);
  529. va_end(args);
  530. return result;
  531. }
  532. static bool valid_header(const struct dbus_header *hdr)
  533. {
  534. if (hdr->endian != DBUS_MESSAGE_LITTLE_ENDIAN &&
  535. hdr->endian != DBUS_MESSAGE_BIG_ENDIAN)
  536. return false;
  537. if (hdr->message_type < DBUS_MESSAGE_TYPE_METHOD_CALL ||
  538. hdr->message_type > DBUS_MESSAGE_TYPE_SIGNAL)
  539. return false;
  540. if (hdr->version != 1 && hdr->version != 2)
  541. return false;
  542. if (hdr->version == 1) {
  543. if (hdr->dbus1.serial == 0)
  544. return false;
  545. }
  546. return true;
  547. }
  548. unsigned int _dbus_message_unix_fds_from_header(const void *data, size_t size)
  549. {
  550. struct l_dbus_message message;
  551. uint32_t unix_fds;
  552. message.header = (uint8_t *) data;
  553. message.header_size = size;
  554. message.body_size = 0;
  555. message.sealed = true;
  556. if (!get_header_field(&message, DBUS_MESSAGE_FIELD_UNIX_FDS,
  557. 'u', &unix_fds))
  558. return 0;
  559. return unix_fds;
  560. }
  561. struct l_dbus_message *dbus_message_from_blob(const void *data, size_t size,
  562. int fds[], uint32_t num_fds)
  563. {
  564. const struct dbus_header *hdr = data;
  565. struct l_dbus_message *message;
  566. size_t body_pos;
  567. unsigned int i;
  568. if (unlikely(size < DBUS_HEADER_SIZE))
  569. return NULL;
  570. message = l_new(struct l_dbus_message, 1);
  571. message->refcount = 1;
  572. if (hdr->version == 1) {
  573. message->header_size = align_len(DBUS_HEADER_SIZE +
  574. hdr->dbus1.field_length, 8);
  575. message->body_size = hdr->dbus1.body_length;
  576. if (message->header_size + message->body_size < size)
  577. goto free;
  578. body_pos = message->header_size;
  579. } else {
  580. struct l_dbus_message_iter iter;
  581. struct l_dbus_message_iter header, variant, body;
  582. /*
  583. * GVariant message structure as per
  584. * https://wiki.gnome.org/Projects/GLib/GDBus/Version2
  585. * is "(yyyyuta{tv}v)". As noted this is equivalent to
  586. * some other types, this one lets us get iterators for
  587. * the header and the body in the fewest steps.
  588. */
  589. if (!_gvariant_iter_init(&iter, message, "(yyyyuta{tv})v",
  590. NULL, data, size))
  591. goto free;
  592. if (!_gvariant_iter_enter_struct(&iter, &header))
  593. goto free;
  594. if (!_gvariant_iter_enter_variant(&iter, &variant))
  595. goto free;
  596. if (!_gvariant_iter_enter_struct(&variant, &body))
  597. goto free;
  598. message->header_size = align_len(header.len - header.pos, 8);
  599. message->body_size = body.len - body.pos;
  600. message->signature = l_strndup(body.sig_start + body.sig_pos,
  601. body.sig_len - body.sig_pos);
  602. message->signature_free = true;
  603. message->header_end = header.len;
  604. body_pos = body.data + body.pos - data;
  605. }
  606. message->header = l_malloc(message->header_size);
  607. message->body = l_malloc(message->body_size);
  608. memcpy(message->header, data, message->header_size);
  609. memcpy(message->body, data + body_pos, message->body_size);
  610. message->sealed = true;
  611. /* If the field is absent message->signature will remain NULL */
  612. if (hdr->version == 1)
  613. get_header_field(message, DBUS_MESSAGE_FIELD_SIGNATURE,
  614. 'g', &message->signature);
  615. if (num_fds) {
  616. uint32_t unix_fds, orig_fds = num_fds;
  617. if (!get_header_field(message, DBUS_MESSAGE_FIELD_UNIX_FDS,
  618. 'u', &unix_fds))
  619. goto free;
  620. if (num_fds > unix_fds)
  621. num_fds = unix_fds;
  622. if (num_fds > L_ARRAY_SIZE(message->fds))
  623. num_fds = L_ARRAY_SIZE(message->fds);
  624. for (i = num_fds; i < orig_fds; i++)
  625. close(fds[i]);
  626. message->num_fds = num_fds;
  627. memcpy(message->fds, fds, num_fds * sizeof(int));
  628. }
  629. return message;
  630. free:
  631. l_dbus_message_unref(message);
  632. return NULL;
  633. }
  634. struct l_dbus_message *dbus_message_build(void *header, size_t header_size,
  635. void *body, size_t body_size,
  636. int fds[], uint32_t num_fds)
  637. {
  638. const struct dbus_header *hdr = header;
  639. struct l_dbus_message *message;
  640. unsigned int i;
  641. if (unlikely(header_size < DBUS_HEADER_SIZE))
  642. return NULL;
  643. if (unlikely(!valid_header(hdr)))
  644. return NULL;
  645. /*
  646. * With GVariant we need to know the signature, use
  647. * dbus_message_from_blob instead.
  648. */
  649. if (unlikely(hdr->version != 1))
  650. return NULL;
  651. message = l_new(struct l_dbus_message, 1);
  652. message->refcount = 1;
  653. message->header_size = header_size;
  654. message->header = header;
  655. message->body_size = body_size;
  656. message->body = body;
  657. message->sealed = true;
  658. if (num_fds) {
  659. uint32_t unix_fds, orig_fds = num_fds;
  660. if (!get_header_field(message, DBUS_MESSAGE_FIELD_UNIX_FDS,
  661. 'u', &unix_fds)) {
  662. l_free(message);
  663. return NULL;
  664. }
  665. if (num_fds > unix_fds)
  666. num_fds = unix_fds;
  667. if (num_fds > L_ARRAY_SIZE(message->fds))
  668. num_fds = L_ARRAY_SIZE(message->fds);
  669. for (i = num_fds; i < orig_fds; i++)
  670. close(fds[i]);
  671. message->num_fds = num_fds;
  672. memcpy(message->fds, fds, num_fds * sizeof(int));
  673. }
  674. /* If the field is absent message->signature will remain NULL */
  675. get_header_field(message, DBUS_MESSAGE_FIELD_SIGNATURE, 'g',
  676. &message->signature);
  677. return message;
  678. }
  679. bool dbus_message_compare(struct l_dbus_message *message,
  680. const void *data, size_t size)
  681. {
  682. struct l_dbus_message *other;
  683. bool ret = false;
  684. other = dbus_message_from_blob(data, size, NULL, 0);
  685. if (message->signature) {
  686. if (!other->signature)
  687. goto done;
  688. if (strcmp(message->signature, other->signature))
  689. goto done;
  690. } else {
  691. if (other->signature)
  692. goto done;
  693. }
  694. if (message->body_size != other->body_size)
  695. goto done;
  696. if (message->header_size != other->header_size)
  697. goto done;
  698. ret = !memcmp(message->body, other->body, message->body_size);
  699. done:
  700. l_dbus_message_unref(other);
  701. return ret;
  702. }
  703. struct builder_driver {
  704. bool (*append_basic)(struct dbus_builder *, char, const void *);
  705. bool (*enter_struct)(struct dbus_builder *, const char *);
  706. bool (*leave_struct)(struct dbus_builder *);
  707. bool (*enter_dict)(struct dbus_builder *, const char *);
  708. bool (*leave_dict)(struct dbus_builder *);
  709. bool (*enter_array)(struct dbus_builder *, const char *);
  710. bool (*leave_array)(struct dbus_builder *);
  711. bool (*enter_variant)(struct dbus_builder *, const char *);
  712. bool (*leave_variant)(struct dbus_builder *);
  713. char *(*finish)(struct dbus_builder *, void **, size_t *);
  714. bool (*mark)(struct dbus_builder *);
  715. bool (*rewind)(struct dbus_builder *);
  716. struct dbus_builder *(*new)(void *, size_t);
  717. void (*free)(struct dbus_builder *);
  718. };
  719. static struct builder_driver dbus1_driver = {
  720. .append_basic = _dbus1_builder_append_basic,
  721. .enter_struct = _dbus1_builder_enter_struct,
  722. .leave_struct = _dbus1_builder_leave_struct,
  723. .enter_dict = _dbus1_builder_enter_dict,
  724. .leave_dict = _dbus1_builder_leave_dict,
  725. .enter_variant = _dbus1_builder_enter_variant,
  726. .leave_variant = _dbus1_builder_leave_variant,
  727. .enter_array = _dbus1_builder_enter_array,
  728. .leave_array = _dbus1_builder_leave_array,
  729. .finish = _dbus1_builder_finish,
  730. .mark = _dbus1_builder_mark,
  731. .rewind = _dbus1_builder_rewind,
  732. .new = _dbus1_builder_new,
  733. .free = _dbus1_builder_free,
  734. };
  735. static struct builder_driver gvariant_driver = {
  736. .append_basic = _gvariant_builder_append_basic,
  737. .enter_struct = _gvariant_builder_enter_struct,
  738. .leave_struct = _gvariant_builder_leave_struct,
  739. .enter_dict = _gvariant_builder_enter_dict,
  740. .leave_dict = _gvariant_builder_leave_dict,
  741. .enter_variant = _gvariant_builder_enter_variant,
  742. .leave_variant = _gvariant_builder_leave_variant,
  743. .enter_array = _gvariant_builder_enter_array,
  744. .leave_array = _gvariant_builder_leave_array,
  745. .finish = _gvariant_builder_finish,
  746. .mark = _gvariant_builder_mark,
  747. .rewind = _gvariant_builder_rewind,
  748. .new = _gvariant_builder_new,
  749. .free = _gvariant_builder_free,
  750. };
  751. static void add_field(struct dbus_builder *builder,
  752. struct builder_driver *driver,
  753. uint8_t field, const char *type, const void *value)
  754. {
  755. if (driver == &gvariant_driver) {
  756. uint64_t long_field = field;
  757. driver->enter_struct(builder, "tv");
  758. driver->append_basic(builder, 't', &long_field);
  759. } else {
  760. driver->enter_struct(builder, "yv");
  761. driver->append_basic(builder, 'y', &field);
  762. }
  763. driver->enter_variant(builder, type);
  764. driver->append_basic(builder, type[0], value);
  765. driver->leave_variant(builder);
  766. driver->leave_struct(builder);
  767. }
  768. static void build_header(struct l_dbus_message *message, const char *signature)
  769. {
  770. struct dbus_builder *builder;
  771. struct builder_driver *driver;
  772. char *generated_signature;
  773. size_t header_size;
  774. bool gvariant;
  775. gvariant = _dbus_message_is_gvariant(message);
  776. if (gvariant)
  777. driver = &gvariant_driver;
  778. else
  779. driver = &dbus1_driver;
  780. builder = driver->new(message->header, message->header_size);
  781. driver->enter_array(builder, gvariant ? "(tv)" : "(yv)");
  782. if (message->path) {
  783. add_field(builder, driver, DBUS_MESSAGE_FIELD_PATH,
  784. "o", message->path);
  785. l_free(message->path);
  786. message->path = NULL;
  787. }
  788. if (message->member) {
  789. add_field(builder, driver, DBUS_MESSAGE_FIELD_MEMBER,
  790. "s", message->member);
  791. l_free(message->member);
  792. message->member = NULL;
  793. }
  794. if (message->interface) {
  795. add_field(builder, driver, DBUS_MESSAGE_FIELD_INTERFACE,
  796. "s", message->interface);
  797. l_free(message->interface);
  798. message->interface = NULL;
  799. }
  800. if (message->destination) {
  801. add_field(builder, driver, DBUS_MESSAGE_FIELD_DESTINATION,
  802. "s", message->destination);
  803. l_free(message->destination);
  804. message->destination = NULL;
  805. }
  806. if (message->error_name != 0) {
  807. add_field(builder, driver, DBUS_MESSAGE_FIELD_ERROR_NAME,
  808. "s", message->error_name);
  809. l_free(message->error_name);
  810. message->error_name = NULL;
  811. }
  812. if (message->reply_serial != 0) {
  813. if (gvariant) {
  814. uint64_t reply_serial = message->reply_serial;
  815. add_field(builder, driver,
  816. DBUS_MESSAGE_FIELD_REPLY_SERIAL,
  817. "t", &reply_serial);
  818. } else {
  819. add_field(builder, driver,
  820. DBUS_MESSAGE_FIELD_REPLY_SERIAL,
  821. "u", &message->reply_serial);
  822. }
  823. message->reply_serial = 0;
  824. }
  825. if (message->sender) {
  826. add_field(builder, driver, DBUS_MESSAGE_FIELD_SENDER,
  827. "s", message->sender);
  828. l_free(message->sender);
  829. message->sender = NULL;
  830. }
  831. if (signature[0] != '\0' && !gvariant)
  832. add_field(builder, driver, DBUS_MESSAGE_FIELD_SIGNATURE,
  833. "g", signature);
  834. if (message->num_fds)
  835. add_field(builder, driver, DBUS_MESSAGE_FIELD_UNIX_FDS,
  836. "u", &message->num_fds);
  837. driver->leave_array(builder);
  838. generated_signature = driver->finish(builder, &message->header,
  839. &header_size);
  840. l_free(generated_signature);
  841. driver->free(builder);
  842. if (!_dbus_message_is_gvariant(message)) {
  843. struct dbus_header *hdr = message->header;
  844. hdr->dbus1.body_length = message->body_size;
  845. }
  846. /* We must align the end of the header to an 8-byte boundary */
  847. message->header_size = align_len(header_size, 8);
  848. message->header = l_realloc(message->header, message->header_size);
  849. memset(message->header + header_size, 0,
  850. message->header_size - header_size);
  851. message->header_end = header_size;
  852. }
  853. struct container {
  854. char type;
  855. const char *sig_start;
  856. const char *sig_end;
  857. unsigned int n_items;
  858. };
  859. static bool append_arguments(struct l_dbus_message *message,
  860. const char *signature, va_list args)
  861. {
  862. struct l_dbus_message_builder *builder;
  863. bool ret;
  864. builder = l_dbus_message_builder_new(message);
  865. if (!builder)
  866. return false;
  867. if (!l_dbus_message_builder_append_from_valist(builder, signature,
  868. args)) {
  869. l_dbus_message_builder_destroy(builder);
  870. return false;
  871. }
  872. l_dbus_message_builder_finalize(builder);
  873. ret = strcmp(signature, builder->message->signature) == 0;
  874. l_dbus_message_builder_destroy(builder);
  875. return ret;
  876. }
  877. LIB_EXPORT bool l_dbus_message_get_error(struct l_dbus_message *message,
  878. const char **name, const char **text)
  879. {
  880. struct dbus_header *hdr;
  881. const char *str;
  882. if (unlikely(!message))
  883. return false;
  884. hdr = message->header;
  885. if (hdr->message_type != DBUS_MESSAGE_TYPE_ERROR)
  886. return false;
  887. if (!message->signature)
  888. return false;
  889. if (message->signature[0] != 's')
  890. return false;
  891. str = _dbus_message_get_nth_string_argument(message, 0);
  892. if (!str)
  893. return false;
  894. if (!message->error_name)
  895. get_header_field(message, DBUS_MESSAGE_FIELD_ERROR_NAME, 's',
  896. &message->error_name);
  897. if (name)
  898. *name = message->error_name;
  899. if (text)
  900. *text = str;
  901. return true;
  902. }
  903. LIB_EXPORT bool l_dbus_message_is_error(struct l_dbus_message *message)
  904. {
  905. struct dbus_header *hdr;
  906. if (unlikely(!message))
  907. return false;
  908. hdr = message->header;
  909. return hdr->message_type == DBUS_MESSAGE_TYPE_ERROR;
  910. }
  911. LIB_EXPORT bool l_dbus_message_get_arguments_valist(
  912. struct l_dbus_message *message,
  913. const char *signature, va_list args)
  914. {
  915. struct l_dbus_message_iter iter;
  916. if (unlikely(!message))
  917. return false;
  918. if (!message->signature) {
  919. /* An empty signature is valid */
  920. if (!signature || *signature == '\0')
  921. return true;
  922. return false;
  923. }
  924. if (!signature || strcmp(message->signature, signature))
  925. return false;
  926. if (_dbus_message_is_gvariant(message)) {
  927. if (!_gvariant_iter_init(&iter, message, message->signature,
  928. NULL, message->body,
  929. message->body_size))
  930. return false;
  931. } else
  932. _dbus1_iter_init(&iter, message, message->signature, NULL,
  933. message->body, message->body_size);
  934. return message_iter_next_entry_valist(&iter, args);
  935. }
  936. LIB_EXPORT bool l_dbus_message_get_arguments(struct l_dbus_message *message,
  937. const char *signature, ...)
  938. {
  939. va_list args;
  940. bool result;
  941. va_start(args, signature);
  942. result = l_dbus_message_get_arguments_valist(message, signature, args);
  943. va_end(args);
  944. return result;
  945. }
  946. LIB_EXPORT bool l_dbus_message_set_arguments(struct l_dbus_message *message,
  947. const char *signature, ...)
  948. {
  949. va_list args;
  950. bool result;
  951. if (unlikely(!message))
  952. return false;
  953. if (unlikely(message->sealed))
  954. return false;
  955. if (!signature)
  956. return true;
  957. va_start(args, signature);
  958. result = append_arguments(message, signature, args);
  959. va_end(args);
  960. return result;
  961. }
  962. LIB_EXPORT bool l_dbus_message_set_arguments_valist(
  963. struct l_dbus_message *message,
  964. const char *signature, va_list args)
  965. {
  966. bool result;
  967. if (unlikely(!message))
  968. return false;
  969. if (!signature)
  970. return true;
  971. result = append_arguments(message, signature, args);
  972. return result;
  973. }
  974. LIB_EXPORT const char *l_dbus_message_get_path(struct l_dbus_message *message)
  975. {
  976. if (unlikely(!message))
  977. return NULL;
  978. if (!message->path && message->sealed)
  979. get_header_field(message, DBUS_MESSAGE_FIELD_PATH, 'o',
  980. &message->path);
  981. return message->path;
  982. }
  983. LIB_EXPORT const char *l_dbus_message_get_interface(struct l_dbus_message *message)
  984. {
  985. if (unlikely(!message))
  986. return NULL;
  987. if (!message->interface && message->sealed)
  988. get_header_field(message, DBUS_MESSAGE_FIELD_INTERFACE, 's',
  989. &message->interface);
  990. return message->interface;
  991. }
  992. LIB_EXPORT const char *l_dbus_message_get_member(struct l_dbus_message *message)
  993. {
  994. if (unlikely(!message))
  995. return NULL;
  996. if (!message->member && message->sealed)
  997. get_header_field(message, DBUS_MESSAGE_FIELD_MEMBER, 's',
  998. &message->member);
  999. return message->member;
  1000. }
  1001. LIB_EXPORT const char *l_dbus_message_get_destination(struct l_dbus_message *message)
  1002. {
  1003. if (unlikely(!message))
  1004. return NULL;
  1005. if (!message->destination && message->sealed)
  1006. get_header_field(message, DBUS_MESSAGE_FIELD_DESTINATION, 's',
  1007. &message->destination);
  1008. return message->destination;
  1009. }
  1010. LIB_EXPORT const char *l_dbus_message_get_sender(struct l_dbus_message *message)
  1011. {
  1012. if (unlikely(!message))
  1013. return NULL;
  1014. if (!message->sender && message->sealed)
  1015. get_header_field(message, DBUS_MESSAGE_FIELD_SENDER, 's',
  1016. &message->sender);
  1017. return message->sender;
  1018. }
  1019. LIB_EXPORT const char *l_dbus_message_get_signature(
  1020. struct l_dbus_message *message)
  1021. {
  1022. if (unlikely(!message))
  1023. return NULL;
  1024. return message->signature;
  1025. }
  1026. uint32_t _dbus_message_get_reply_serial(struct l_dbus_message *message)
  1027. {
  1028. if (unlikely(!message))
  1029. return 0;
  1030. if (message->reply_serial == 0 && message->sealed) {
  1031. if (_dbus_message_is_gvariant(message)) {
  1032. uint64_t reply_serial = 0;
  1033. get_header_field(message,
  1034. DBUS_MESSAGE_FIELD_REPLY_SERIAL, 't',
  1035. &reply_serial);
  1036. message->reply_serial = reply_serial;
  1037. } else
  1038. get_header_field(message,
  1039. DBUS_MESSAGE_FIELD_REPLY_SERIAL, 'u',
  1040. &message->reply_serial);
  1041. }
  1042. return message->reply_serial;
  1043. }
  1044. enum dbus_message_type _dbus_message_get_type(struct l_dbus_message *message)
  1045. {
  1046. struct dbus_header *header;
  1047. header = message->header;
  1048. return header->message_type;
  1049. }
  1050. const char * _dbus_message_get_type_as_string(struct l_dbus_message *message)
  1051. {
  1052. struct dbus_header *header;
  1053. header = message->header;
  1054. switch (header->message_type) {
  1055. case DBUS_MESSAGE_TYPE_METHOD_CALL:
  1056. return "method_call";
  1057. case DBUS_MESSAGE_TYPE_METHOD_RETURN:
  1058. return "method_return";
  1059. case DBUS_MESSAGE_TYPE_ERROR:
  1060. return "error";
  1061. case DBUS_MESSAGE_TYPE_SIGNAL:
  1062. return "signal";
  1063. }
  1064. return NULL;
  1065. }
  1066. uint8_t _dbus_message_get_endian(struct l_dbus_message *message)
  1067. {
  1068. struct dbus_header *header = message->header;
  1069. return header->endian;
  1070. }
  1071. uint8_t _dbus_message_get_version(struct l_dbus_message *message)
  1072. {
  1073. struct dbus_header *header = message->header;
  1074. return header->version;
  1075. }
  1076. LIB_EXPORT bool l_dbus_message_iter_next_entry(struct l_dbus_message_iter *iter,
  1077. ...)
  1078. {
  1079. va_list args;
  1080. bool result;
  1081. if (unlikely(!iter))
  1082. return false;
  1083. va_start(args, iter);
  1084. result = message_iter_next_entry_valist(iter, args);
  1085. va_end(args);
  1086. return result;
  1087. }
  1088. LIB_EXPORT bool l_dbus_message_iter_get_variant(
  1089. struct l_dbus_message_iter *iter,
  1090. const char *signature, ...)
  1091. {
  1092. va_list args;
  1093. bool result;
  1094. if (unlikely(!iter))
  1095. return false;
  1096. if (!iter->sig_start || strlen(signature) != iter->sig_len ||
  1097. memcmp(iter->sig_start, signature, iter->sig_len))
  1098. return false;
  1099. va_start(args, signature);
  1100. result = message_iter_next_entry_valist(iter, args);
  1101. va_end(args);
  1102. return result;
  1103. }
  1104. LIB_EXPORT bool l_dbus_message_iter_get_fixed_array(
  1105. struct l_dbus_message_iter *iter,
  1106. void *out, uint32_t *n_elem)
  1107. {
  1108. if (unlikely(!iter))
  1109. return false;
  1110. if (_dbus_message_is_gvariant(iter->message))
  1111. return false;
  1112. return _dbus1_iter_get_fixed_array(iter, out, n_elem);
  1113. }
  1114. void _dbus_message_set_sender(struct l_dbus_message *message,
  1115. const char *sender)
  1116. {
  1117. if (!_dbus_message_is_gvariant(message))
  1118. return;
  1119. l_free(message->sender);
  1120. message->sender = l_strdup(sender);
  1121. }
  1122. void _dbus_message_set_destination(struct l_dbus_message *message,
  1123. const char *destination)
  1124. {
  1125. if (!_dbus_message_is_gvariant(message))
  1126. return;
  1127. l_free(message->destination);
  1128. message->destination = l_strdup(destination);
  1129. }
  1130. LIB_EXPORT struct l_dbus_message_builder *l_dbus_message_builder_new(
  1131. struct l_dbus_message *message)
  1132. {
  1133. struct l_dbus_message_builder *ret;
  1134. if (unlikely(!message))
  1135. return NULL;
  1136. if (message->sealed)
  1137. return NULL;
  1138. ret = l_new(struct l_dbus_message_builder, 1);
  1139. ret->message = l_dbus_message_ref(message);
  1140. if (_dbus_message_is_gvariant(message))
  1141. ret->driver = &gvariant_driver;
  1142. else
  1143. ret->driver = &dbus1_driver;
  1144. ret->builder = ret->driver->new(NULL, 0);
  1145. return ret;
  1146. }
  1147. LIB_EXPORT void l_dbus_message_builder_destroy(
  1148. struct l_dbus_message_builder *builder)
  1149. {
  1150. if (unlikely(!builder))
  1151. return;
  1152. builder->driver->free(builder->builder);
  1153. l_dbus_message_unref(builder->message);
  1154. l_free(builder);
  1155. }
  1156. LIB_EXPORT bool l_dbus_message_builder_append_basic(
  1157. struct l_dbus_message_builder *builder,
  1158. char type, const void *value)
  1159. {
  1160. if (unlikely(!builder))
  1161. return false;
  1162. return builder->driver->append_basic(builder->builder, type, value);
  1163. }
  1164. LIB_EXPORT bool l_dbus_message_builder_enter_container(
  1165. struct l_dbus_message_builder *builder,
  1166. char container_type,
  1167. const char *signature)
  1168. {
  1169. if (unlikely(!builder))
  1170. return false;
  1171. switch (container_type) {
  1172. case DBUS_CONTAINER_TYPE_ARRAY:
  1173. return builder->driver->enter_array(builder->builder,
  1174. signature);
  1175. case DBUS_CONTAINER_TYPE_DICT_ENTRY:
  1176. return builder->driver->enter_dict(builder->builder, signature);
  1177. case DBUS_CONTAINER_TYPE_STRUCT:
  1178. return builder->driver->enter_struct(builder->builder,
  1179. signature);
  1180. case DBUS_CONTAINER_TYPE_VARIANT:
  1181. return builder->driver->enter_variant(builder->builder,
  1182. signature);
  1183. default:
  1184. break;
  1185. }
  1186. return false;
  1187. }
  1188. LIB_EXPORT bool l_dbus_message_builder_leave_container(
  1189. struct l_dbus_message_builder *builder,
  1190. char container_type)
  1191. {
  1192. if (unlikely(!builder))
  1193. return false;
  1194. switch (container_type) {
  1195. case DBUS_CONTAINER_TYPE_ARRAY:
  1196. return builder->driver->leave_array(builder->builder);
  1197. case DBUS_CONTAINER_TYPE_DICT_ENTRY:
  1198. return builder->driver->leave_dict(builder->builder);
  1199. case DBUS_CONTAINER_TYPE_STRUCT:
  1200. return builder->driver->leave_struct(builder->builder);
  1201. case DBUS_CONTAINER_TYPE_VARIANT:
  1202. return builder->driver->leave_variant(builder->builder);
  1203. default:
  1204. break;
  1205. }
  1206. return false;
  1207. }
  1208. LIB_EXPORT bool l_dbus_message_builder_enter_struct(
  1209. struct l_dbus_message_builder *builder,
  1210. const char *signature)
  1211. {
  1212. return l_dbus_message_builder_enter_container(builder, 'r', signature);
  1213. }
  1214. LIB_EXPORT bool l_dbus_message_builder_leave_struct(
  1215. struct l_dbus_message_builder *builder)
  1216. {
  1217. return l_dbus_message_builder_leave_container(builder, 'r');
  1218. }
  1219. LIB_EXPORT bool l_dbus_message_builder_enter_array(
  1220. struct l_dbus_message_builder *builder,
  1221. const char *signature)
  1222. {
  1223. return l_dbus_message_builder_enter_container(builder, 'a', signature);
  1224. }
  1225. LIB_EXPORT bool l_dbus_message_builder_leave_array(
  1226. struct l_dbus_message_builder *builder)
  1227. {
  1228. return l_dbus_message_builder_leave_container(builder, 'a');
  1229. }
  1230. LIB_EXPORT bool l_dbus_message_builder_enter_dict(
  1231. struct l_dbus_message_builder *builder,
  1232. const char *signature)
  1233. {
  1234. return l_dbus_message_builder_enter_container(builder, 'e', signature);
  1235. }
  1236. LIB_EXPORT bool l_dbus_message_builder_leave_dict(
  1237. struct l_dbus_message_builder *builder)
  1238. {
  1239. return l_dbus_message_builder_leave_container(builder, 'e');
  1240. }
  1241. LIB_EXPORT bool l_dbus_message_builder_enter_variant(
  1242. struct l_dbus_message_builder *builder,
  1243. const char *signature)
  1244. {
  1245. return l_dbus_message_builder_enter_container(builder, 'v', signature);
  1246. }
  1247. LIB_EXPORT bool l_dbus_message_builder_leave_variant(
  1248. struct l_dbus_message_builder *builder)
  1249. {
  1250. return l_dbus_message_builder_leave_container(builder, 'v');
  1251. }
  1252. /**
  1253. * l_dbus_message_builder_append_from_iter:
  1254. * @builder: message builder to receive a new value
  1255. * @from: message iterator to have its position moved by one value
  1256. *
  1257. * Copy one value from a message iterator onto a message builder. The
  1258. * value's signature is also copied.
  1259. *
  1260. * Returns: whether the value was correctly copied. On failure both
  1261. * the @from iterator and the @builder may have their positions
  1262. * moved to somewhere within the new value if it's of a
  1263. * container type.
  1264. **/
  1265. LIB_EXPORT bool l_dbus_message_builder_append_from_iter(
  1266. struct l_dbus_message_builder *builder,
  1267. struct l_dbus_message_iter *from)
  1268. {
  1269. static const char *simple_types = "sogybnqiuxtd";
  1270. char type = from->sig_start[from->sig_pos];
  1271. char container_type;
  1272. char signature[256];
  1273. struct l_dbus_message_iter iter;
  1274. void *basic_ptr;
  1275. uint64_t basic;
  1276. uint32_t uint32_val;
  1277. bool (*get_basic)(struct l_dbus_message_iter *, char, void *);
  1278. bool (*enter_func)(struct l_dbus_message_iter *,
  1279. struct l_dbus_message_iter *);
  1280. bool (*enter_struct)(struct l_dbus_message_iter *,
  1281. struct l_dbus_message_iter *);
  1282. bool (*enter_array)(struct l_dbus_message_iter *,
  1283. struct l_dbus_message_iter *);
  1284. bool (*enter_variant)(struct l_dbus_message_iter *,
  1285. struct l_dbus_message_iter *);
  1286. if (_dbus_message_is_gvariant(from->message)) {
  1287. get_basic = _gvariant_iter_next_entry_basic;
  1288. enter_struct = _gvariant_iter_enter_struct;
  1289. enter_array = _gvariant_iter_enter_array;
  1290. enter_variant = _gvariant_iter_enter_variant;
  1291. } else {
  1292. get_basic = _dbus1_iter_next_entry_basic;
  1293. enter_struct = _dbus1_iter_enter_struct;
  1294. enter_array = _dbus1_iter_enter_array;
  1295. enter_variant = _dbus1_iter_enter_variant;
  1296. }
  1297. if (strchr(simple_types, type)) {
  1298. if (strchr("sog", type)) {
  1299. if (!get_basic(from, type, &basic_ptr))
  1300. return false;
  1301. } else {
  1302. basic_ptr = &basic;
  1303. if (!get_basic(from, type, basic_ptr))
  1304. return false;
  1305. }
  1306. if (!l_dbus_message_builder_append_basic(builder, type,
  1307. basic_ptr))
  1308. return false;
  1309. return true;
  1310. }
  1311. switch (type) {
  1312. case 'h':
  1313. if (!get_basic(from, type, &uint32_val))
  1314. return false;
  1315. if (!l_dbus_message_builder_append_basic(builder, type,
  1316. &builder->message->num_fds))
  1317. return false;
  1318. if (builder->message->num_fds <
  1319. L_ARRAY_SIZE(builder->message->fds)) {
  1320. int fd;
  1321. if (uint32_val < from->message->num_fds)
  1322. fd = fcntl(from->message->fds[uint32_val],
  1323. F_DUPFD_CLOEXEC, 3);
  1324. else
  1325. fd = -1;
  1326. builder->message->fds[builder->message->num_fds++] = fd;
  1327. }
  1328. return true;
  1329. case '(':
  1330. enter_func = enter_struct;
  1331. container_type = DBUS_CONTAINER_TYPE_STRUCT;
  1332. break;
  1333. case '{':
  1334. enter_func = enter_struct;
  1335. container_type = DBUS_CONTAINER_TYPE_DICT_ENTRY;
  1336. break;
  1337. case 'a':
  1338. enter_func = enter_array;
  1339. container_type = DBUS_CONTAINER_TYPE_ARRAY;
  1340. break;
  1341. case 'v':
  1342. enter_func = enter_variant;
  1343. container_type = DBUS_CONTAINER_TYPE_VARIANT;
  1344. break;
  1345. default:
  1346. return false;
  1347. }
  1348. if (!enter_func(from, &iter))
  1349. return false;
  1350. memcpy(signature, iter.sig_start, iter.sig_len);
  1351. signature[iter.sig_len] = '\0';
  1352. if (!l_dbus_message_builder_enter_container(builder,
  1353. container_type, signature))
  1354. return false;
  1355. if (container_type == DBUS_CONTAINER_TYPE_ARRAY)
  1356. while(l_dbus_message_builder_append_from_iter(builder, &iter));
  1357. else
  1358. while (iter.sig_pos < iter.sig_len)
  1359. if (!l_dbus_message_builder_append_from_iter(builder,
  1360. &iter))
  1361. return false;
  1362. if (!l_dbus_message_builder_leave_container(builder,
  1363. container_type))
  1364. return false;
  1365. return true;
  1366. }
  1367. LIB_EXPORT bool l_dbus_message_builder_append_from_valist(
  1368. struct l_dbus_message_builder *builder,
  1369. const char *signature, va_list args)
  1370. {
  1371. struct builder_driver *driver;
  1372. char subsig[256];
  1373. const char *sigend;
  1374. /* Nesting requires an extra stack entry for the base level */
  1375. struct container stack[DBUS_MAX_NESTING + 1];
  1376. unsigned int stack_index = 0;
  1377. if (unlikely(!builder))
  1378. return false;
  1379. driver = builder->driver;
  1380. stack[stack_index].type = DBUS_CONTAINER_TYPE_STRUCT;
  1381. stack[stack_index].sig_start = signature;
  1382. stack[stack_index].sig_end = signature + strlen(signature);
  1383. stack[stack_index].n_items = 0;
  1384. while (stack_index != 0 || stack[0].sig_start != stack[0].sig_end) {
  1385. const char *s;
  1386. const char *str;
  1387. if (stack[stack_index].type == DBUS_CONTAINER_TYPE_ARRAY &&
  1388. stack[stack_index].n_items == 0)
  1389. stack[stack_index].sig_start =
  1390. stack[stack_index].sig_end;
  1391. if (stack[stack_index].sig_start ==
  1392. stack[stack_index].sig_end) {
  1393. bool ret;
  1394. /*
  1395. * Sanity check in case of an invalid signature that
  1396. * isn't caught elsewhere.
  1397. */
  1398. if (unlikely(stack_index == 0))
  1399. return false;
  1400. switch (stack[stack_index].type) {
  1401. case DBUS_CONTAINER_TYPE_STRUCT:
  1402. ret = driver->leave_struct(builder->builder);
  1403. break;
  1404. case DBUS_CONTAINER_TYPE_DICT_ENTRY:
  1405. ret = driver->leave_dict(builder->builder);
  1406. break;
  1407. case DBUS_CONTAINER_TYPE_VARIANT:
  1408. ret = driver->leave_variant(builder->builder);
  1409. break;
  1410. case DBUS_CONTAINER_TYPE_ARRAY:
  1411. ret = driver->leave_array(builder->builder);
  1412. break;
  1413. default:
  1414. ret = false;
  1415. }
  1416. if (!ret)
  1417. return false;
  1418. stack_index -= 1;
  1419. continue;
  1420. }
  1421. s = stack[stack_index].sig_start;
  1422. if (stack[stack_index].type != DBUS_CONTAINER_TYPE_ARRAY)
  1423. stack[stack_index].sig_start += 1;
  1424. else
  1425. stack[stack_index].n_items -= 1;
  1426. switch (*s) {
  1427. case 'o':
  1428. case 's':
  1429. case 'g':
  1430. str = va_arg(args, const char *);
  1431. if (!driver->append_basic(builder->builder, *s, str))
  1432. return false;
  1433. break;
  1434. case 'b':
  1435. case 'y':
  1436. {
  1437. uint8_t y = (uint8_t) va_arg(args, int);
  1438. if (!driver->append_basic(builder->builder, *s, &y))
  1439. return false;
  1440. break;
  1441. }
  1442. case 'n':
  1443. case 'q':
  1444. {
  1445. uint16_t n = (uint16_t) va_arg(args, int);
  1446. if (!driver->append_basic(builder->builder, *s, &n))
  1447. return false;
  1448. break;
  1449. }
  1450. case 'i':
  1451. case 'u':
  1452. {
  1453. uint32_t u = va_arg(args, uint32_t);
  1454. if (!driver->append_basic(builder->builder, *s, &u))
  1455. return false;
  1456. break;
  1457. }
  1458. case 'h':
  1459. {
  1460. int fd = va_arg(args, int);
  1461. struct l_dbus_message *message = builder->message;
  1462. if (!driver->append_basic(builder->builder, *s,
  1463. &message->num_fds))
  1464. return false;
  1465. if (message->num_fds < L_ARRAY_SIZE(message->fds))
  1466. message->fds[message->num_fds++] =
  1467. fcntl(fd, F_DUPFD_CLOEXEC, 3);
  1468. break;
  1469. }
  1470. case 'x':
  1471. case 't':
  1472. {
  1473. uint64_t x = va_arg(args, uint64_t);
  1474. if (!driver->append_basic(builder->builder, *s, &x))
  1475. return false;
  1476. break;
  1477. }
  1478. case 'd':
  1479. {
  1480. double d = va_arg(args, double);
  1481. if (!driver->append_basic(builder->builder, *s, &d))
  1482. return false;
  1483. break;
  1484. }
  1485. case '(':
  1486. case '{':
  1487. if (stack_index == DBUS_MAX_NESTING)
  1488. return false;
  1489. sigend = _dbus_signature_end(s);
  1490. memcpy(subsig, s + 1, sigend - s - 1);
  1491. subsig[sigend - s - 1] = '\0';
  1492. if (*s == '(' && !driver->enter_struct(builder->builder,
  1493. subsig))
  1494. return false;
  1495. if (*s == '{' && !driver->enter_dict(builder->builder,
  1496. subsig))
  1497. return false;
  1498. if (stack[stack_index].type !=
  1499. DBUS_CONTAINER_TYPE_ARRAY)
  1500. stack[stack_index].sig_start = sigend + 1;
  1501. stack_index += 1;
  1502. stack[stack_index].sig_start = s + 1;
  1503. stack[stack_index].sig_end = sigend;
  1504. stack[stack_index].n_items = 0;
  1505. stack[stack_index].type = *s == '(' ?
  1506. DBUS_CONTAINER_TYPE_STRUCT :
  1507. DBUS_CONTAINER_TYPE_DICT_ENTRY;
  1508. break;
  1509. case 'v':
  1510. if (stack_index == DBUS_MAX_NESTING)
  1511. return false;
  1512. str = va_arg(args, const char *);
  1513. if (!str)
  1514. return false;
  1515. if (!driver->enter_variant(builder->builder, str))
  1516. return false;
  1517. stack_index += 1;
  1518. stack[stack_index].type = DBUS_CONTAINER_TYPE_VARIANT;
  1519. stack[stack_index].sig_start = str;
  1520. stack[stack_index].sig_end = str + strlen(str);
  1521. stack[stack_index].n_items = 0;
  1522. break;
  1523. case 'a':
  1524. if (stack_index == DBUS_MAX_NESTING)
  1525. return false;
  1526. sigend = _dbus_signature_end(s + 1) + 1;
  1527. memcpy(subsig, s + 1, sigend - s - 1);
  1528. subsig[sigend - s - 1] = '\0';
  1529. if (!driver->enter_array(builder->builder, subsig))
  1530. return false;
  1531. if (stack[stack_index].type !=
  1532. DBUS_CONTAINER_TYPE_ARRAY)
  1533. stack[stack_index].sig_start = sigend;
  1534. stack_index += 1;
  1535. stack[stack_index].sig_start = s + 1;
  1536. stack[stack_index].sig_end = sigend;
  1537. stack[stack_index].n_items = va_arg(args, unsigned int);
  1538. stack[stack_index].type = DBUS_CONTAINER_TYPE_ARRAY;
  1539. break;
  1540. default:
  1541. return false;
  1542. }
  1543. }
  1544. return true;
  1545. }
  1546. LIB_EXPORT struct l_dbus_message *l_dbus_message_builder_finalize(
  1547. struct l_dbus_message_builder *builder)
  1548. {
  1549. char *generated_signature;
  1550. if (unlikely(!builder))
  1551. return NULL;
  1552. generated_signature = builder->driver->finish(builder->builder,
  1553. &builder->message->body,
  1554. &builder->message->body_size);
  1555. build_header(builder->message, generated_signature);
  1556. builder->message->sealed = true;
  1557. builder->message->signature = generated_signature;
  1558. builder->message->signature_free = true;
  1559. return builder->message;
  1560. }
  1561. bool _dbus_message_builder_mark(struct l_dbus_message_builder *builder)
  1562. {
  1563. if (unlikely(!builder))
  1564. return false;
  1565. return builder->driver->mark(builder->builder);
  1566. }
  1567. bool _dbus_message_builder_rewind(struct l_dbus_message_builder *builder)
  1568. {
  1569. if (unlikely(!builder))
  1570. return false;
  1571. return builder->driver->rewind(builder->builder);
  1572. }