1 /* -*- mode: C; c-file-style: "gnu" -*- */
2 /* dbus-message.c DBusMessage object
4 * Copyright (C) 2002, 2003 Red Hat Inc.
5 * Copyright (C) 2002, 2003 CodeFactory AB
7 * Licensed under the Academic Free License version 1.2
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
25 #include "dbus-internals.h"
26 #include "dbus-marshal.h"
27 #include "dbus-message.h"
28 #include "dbus-message-internal.h"
29 #include "dbus-memory.h"
30 #include "dbus-list.h"
31 #include "dbus-message-builder.h"
35 * @defgroup DBusMessageInternals DBusMessage implementation details
36 * @ingroup DBusInternals
37 * @brief DBusMessage private implementation details.
39 * The guts of DBusMessage and its methods.
57 static dbus_bool_t field_is_named[FIELD_LAST] =
59 FALSE, /* FIELD_HEADER_LENGTH */
60 FALSE, /* FIELD_BODY_LENGTH */
61 FALSE, /* FIELD_CLIENT_SERIAL */
62 TRUE, /* FIELD_NAME */
63 TRUE, /* FIELD_SERVICE */
64 TRUE, /* FIELD_SENDER */
65 TRUE /* FIELD_REPLY_SERIAL */
70 int offset; /**< Offset to start of field (location of name of field
76 * @brief Internals of DBusMessage
78 * Object representing a message received from or to be sent to
79 * another application. This is an opaque object, all members
84 dbus_atomic_t refcount; /**< Reference count */
86 DBusString header; /**< Header network data, stored
87 * separately from body so we can
88 * independently realloc it.
91 HeaderField header_fields[FIELD_LAST]; /**< Track the location
92 * of each field in "header"
95 dbus_int32_t client_serial; /**< Cached client serial value for speed */
96 dbus_int32_t reply_serial; /**< Cached reply serial value for speed */
98 int header_padding; /**< bytes of alignment in header */
100 DBusString body; /**< Body network data. */
102 char byte_order; /**< Message byte order. */
104 DBusCounter *size_counter; /**< Counter for the size of the message, or #NULL */
105 long size_counter_delta; /**< Size we incremented the size counter by. */
107 unsigned int locked : 1; /**< Message being sent, no modifications allowed. */
111 * @brief Internals of DBusMessageIter
113 * Object representing a position in a message. All fields are internal.
115 struct DBusMessageIter
117 int refcount; /**< Reference count */
119 int pos; /**< Current position in the string */
121 DBusMessage *message; /**< Message used */
125 * Gets the data to be sent over the network for this message.
126 * The header and then the body should be written out.
127 * This function is guaranteed to always return the same
128 * data once a message is locked (with _dbus_message_lock()).
130 * @param message the message.
131 * @param header return location for message header data.
132 * @param body return location for message body data.
135 _dbus_message_get_network_data (DBusMessage *message,
136 const DBusString **header,
137 const DBusString **body)
139 _dbus_assert (message->locked);
141 *header = &message->header;
142 *body = &message->body;
146 clear_header_padding (DBusMessage *message)
148 _dbus_string_shorten (&message->header,
149 message->header_padding);
150 message->header_padding = 0;
154 append_header_padding (DBusMessage *message)
157 old_len = _dbus_string_get_length (&message->header);
158 if (!_dbus_string_align_length (&message->header, 8))
161 message->header_padding = _dbus_string_get_length (&message->header) - old_len;
167 adjust_field_offsets (DBusMessage *message,
177 while (i < FIELD_LAST)
179 if (message->header_fields[i].offset > offsets_after)
180 message->header_fields[i].offset += delta;
187 get_string_field (DBusMessage *message,
194 offset = message->header_fields[field].offset;
196 _dbus_assert (field < FIELD_LAST);
201 /* offset points to string length, string data follows it */
202 /* FIXME _dbus_demarshal_const_string() that returned
203 * a reference to the string plus its len might be nice.
207 *len = _dbus_demarshal_uint32 (&message->header,
212 _dbus_string_get_const_data (&message->header,
215 return data + (offset + 4);
219 get_int_field (DBusMessage *message,
224 _dbus_assert (field < FIELD_LAST);
226 offset = message->header_fields[field].offset;
229 return -1; /* useless if -1 is a valid value of course */
231 return _dbus_demarshal_int32 (&message->header,
238 append_int_field (DBusMessage *message,
245 _dbus_assert (!message->locked);
247 clear_header_padding (message);
249 orig_len = _dbus_string_get_length (&message->header);
251 if (!_dbus_string_align_length (&message->header, 4))
254 if (!_dbus_string_append_len (&message->header, name, 4))
257 if (!_dbus_string_append_byte (&message->header, DBUS_TYPE_INT32))
260 if (!_dbus_string_align_length (&message->header, 4))
263 message->header_fields[FIELD_REPLY_SERIAL].offset =
264 _dbus_string_get_length (&message->header);
266 if (!_dbus_marshal_int32 (&message->header, message->byte_order,
270 if (!append_header_padding (message))
276 message->header_fields[field].offset = -1;
277 _dbus_string_set_length (&message->header, orig_len);
279 /* this must succeed because it was allocated on function entry and
280 * DBusString doesn't ever realloc smaller
282 if (!append_header_padding (message))
283 _dbus_assert_not_reached ("failed to reappend header padding");
288 append_string_field (DBusMessage *message,
295 _dbus_assert (!message->locked);
297 clear_header_padding (message);
299 orig_len = _dbus_string_get_length (&message->header);
301 if (!_dbus_string_align_length (&message->header, 4))
304 if (!_dbus_string_append_len (&message->header, name, 4))
307 if (!_dbus_string_append_byte (&message->header, DBUS_TYPE_STRING))
310 if (!_dbus_string_align_length (&message->header, 4))
313 message->header_fields[field].offset =
314 _dbus_string_get_length (&message->header);
316 if (!_dbus_marshal_string (&message->header, message->byte_order,
320 if (!append_header_padding (message))
326 message->header_fields[field].offset = -1;
327 _dbus_string_set_length (&message->header, orig_len);
329 /* this must succeed because it was allocated on function entry and
330 * DBusString doesn't ever realloc smaller
332 if (!append_header_padding (message))
333 _dbus_assert_not_reached ("failed to reappend header padding");
339 delete_int_field (DBusMessage *message,
342 int offset = message->header_fields[field].offset;
344 _dbus_assert (!message->locked);
345 _dbus_assert (field_is_named[field]);
350 clear_header_padding (message);
352 /* The field typecode and name take up 8 bytes */
353 _dbus_string_delete (&message->header,
357 message->header_fields[field].offset = -1;
359 adjust_field_offsets (message,
363 append_header_padding (message);
367 delete_string_field (DBusMessage *message,
370 int offset = message->header_fields[field].offset;
374 _dbus_assert (!message->locked);
375 _dbus_assert (field_is_named[field]);
380 clear_header_padding (message);
382 get_string_field (message, field, &len);
384 /* The field typecode and name take up 8 bytes, and the nul
385 * termination is 1 bytes, string length integer is 4 bytes
387 delete_len = 8 + 4 + 1 + len;
389 _dbus_string_delete (&message->header,
393 message->header_fields[field].offset = -1;
395 adjust_field_offsets (message,
399 append_header_padding (message);
403 set_int_field (DBusMessage *message,
407 int offset = message->header_fields[field].offset;
409 _dbus_assert (!message->locked);
413 /* need to append the field */
417 case FIELD_REPLY_SERIAL:
418 return append_int_field (message, field,
419 DBUS_HEADER_FIELD_REPLY,
422 _dbus_assert_not_reached ("appending an int field we don't support appending");
428 _dbus_marshal_set_int32 (&message->header,
437 set_uint_field (DBusMessage *message,
441 int offset = message->header_fields[field].offset;
443 _dbus_assert (!message->locked);
447 /* need to append the field */
452 _dbus_assert_not_reached ("appending a uint field we don't support appending");
458 _dbus_marshal_set_uint32 (&message->header,
467 set_string_field (DBusMessage *message,
471 int offset = message->header_fields[field].offset;
473 _dbus_assert (!message->locked);
474 _dbus_assert (value != NULL);
478 /* need to append the field */
483 return append_string_field (message, field,
484 DBUS_HEADER_FIELD_SENDER,
487 _dbus_assert_not_reached ("appending a string field we don't support appending");
498 clear_header_padding (message);
500 old_len = _dbus_string_get_length (&message->header);
502 len = strlen (value);
504 _dbus_string_init_const_len (&v, value,
505 len + 1); /* include nul */
506 if (!_dbus_marshal_set_string (&message->header,
512 new_len = _dbus_string_get_length (&message->header);
514 adjust_field_offsets (message,
518 if (!append_header_padding (message))
524 /* this must succeed because it was allocated on function entry and
525 * DBusString doesn't ever realloc smaller
527 if (!append_header_padding (message))
528 _dbus_assert_not_reached ("failed to reappend header padding");
535 * Sets the serial number of a message.
536 * This can only be done once on a message.
538 * @param message the message
539 * @param serial the serial
542 _dbus_message_set_serial (DBusMessage *message,
545 _dbus_assert (!message->locked);
546 _dbus_assert (dbus_message_get_serial (message) < 0);
548 set_int_field (message, FIELD_CLIENT_SERIAL,
550 message->client_serial = serial;
554 * Sets the reply serial of a message (the client serial
555 * of the message this is a reply to).
557 * @param message the message
558 * @param reply_serial the client serial
559 * @returns #FALSE if not enough memory
562 dbus_message_set_reply_serial (DBusMessage *message,
563 dbus_int32_t reply_serial)
565 _dbus_assert (!message->locked);
567 if (set_int_field (message, FIELD_REPLY_SERIAL,
570 message->reply_serial = reply_serial;
578 * Returns the serial of a message or -1 if none has been specified.
579 * The message's serial number is provided by the application sending
580 * the message and is used to identify replies to this message.
582 * @param message the message
583 * @returns the client serial
586 dbus_message_get_serial (DBusMessage *message)
588 return message->client_serial;
592 * Returns the serial that the message is
593 * a reply to or -1 if none.
595 * @param message the message
596 * @returns the reply serial
599 dbus_message_get_reply_serial (DBusMessage *message)
601 return message->reply_serial;
605 * Adds a counter to be incremented immediately with the
606 * size of this message, and decremented by the size
607 * of this message when this message if finalized.
609 * @param message the message
610 * @param counter the counter
613 _dbus_message_add_size_counter (DBusMessage *message,
614 DBusCounter *counter)
616 _dbus_assert (message->size_counter == NULL); /* If this fails we may need to keep a list of
617 * counters instead of just one
620 message->size_counter = counter;
621 _dbus_counter_ref (message->size_counter);
623 /* When we can change message size, we may want to
624 * update this each time we do so, or we may want to
625 * just KISS like this.
627 message->size_counter_delta =
628 _dbus_string_get_length (&message->header) +
629 _dbus_string_get_length (&message->body);
632 _dbus_verbose ("message has size %ld\n",
633 message->size_counter_delta);
636 _dbus_counter_adjust (message->size_counter, message->size_counter_delta);
640 dbus_message_create_header (DBusMessage *message,
646 if (!_dbus_string_append_byte (&message->header, message->byte_order))
650 if (!_dbus_string_append_byte (&message->header, flags))
653 if (!_dbus_string_append_byte (&message->header, DBUS_MAJOR_PROTOCOL_VERSION))
656 if (!_dbus_string_append_byte (&message->header, 0))
659 message->header_fields[FIELD_HEADER_LENGTH].offset = 4;
660 if (!_dbus_marshal_uint32 (&message->header, message->byte_order, 0))
663 message->header_fields[FIELD_BODY_LENGTH].offset = 8;
664 if (!_dbus_marshal_uint32 (&message->header, message->byte_order, 0))
667 message->header_fields[FIELD_CLIENT_SERIAL].offset = 12;
668 if (!_dbus_marshal_int32 (&message->header, message->byte_order, -1))
671 /* Marshal message service */
674 if (!append_string_field (message,
676 DBUS_HEADER_FIELD_SERVICE,
681 _dbus_assert (name != NULL);
682 if (!append_string_field (message,
684 DBUS_HEADER_FIELD_NAME,
692 * Locks a message. Allows checking that applications don't keep a
693 * reference to a message in the outgoing queue and change it
694 * underneath us. Messages are locked when they enter the outgoing
695 * queue (dbus_connection_send_message()), and the library complains
696 * if the message is modified while locked.
698 * @param message the message to lock.
701 _dbus_message_lock (DBusMessage *message)
703 if (!message->locked)
705 /* Fill in our lengths */
706 set_uint_field (message,
708 _dbus_string_get_length (&message->header));
710 set_uint_field (message,
712 _dbus_string_get_length (&message->body));
714 message->locked = TRUE;
721 * @defgroup DBusMessage DBusMessage
723 * @brief Message to be sent or received over a DBusConnection.
725 * A DBusMessage is the most basic unit of communication over a
726 * DBusConnection. A DBusConnection represents a stream of messages
727 * received from a remote application, and a stream of messages
728 * sent to a remote application.
734 * @typedef DBusMessage
736 * Opaque data type representing a message received from or to be
737 * sent to another application.
741 dbus_message_new_empty_header (void)
743 DBusMessage *message;
746 message = dbus_new0 (DBusMessage, 1);
750 message->refcount = 1;
751 message->byte_order = DBUS_COMPILER_BYTE_ORDER;
752 message->client_serial = -1;
753 message->reply_serial = -1;
756 while (i < FIELD_LAST)
758 message->header_fields[i].offset = -1;
762 if (!_dbus_string_init (&message->header, _DBUS_INT_MAX))
768 if (!_dbus_string_init (&message->body, _DBUS_INT_MAX))
770 _dbus_string_free (&message->header);
780 * Constructs a new message. Returns #NULL if memory can't be
781 * allocated for the message. The service may be #NULL in which case
782 * no service is set; this is appropriate when using D-BUS in a
783 * peer-to-peer context (no message bus).
785 * @todo reverse the arguments, first 'name' then 'service'
786 * as 'name' is more fundamental
788 * @param service service that the message should be sent to or #NULL
789 * @param name name of the message
790 * @returns a new DBusMessage, free with dbus_message_unref()
791 * @see dbus_message_unref()
794 dbus_message_new (const char *service,
797 DBusMessage *message;
799 message = dbus_message_new_empty_header ();
803 if (!dbus_message_create_header (message, service, name))
805 dbus_message_unref (message);
813 * Constructs a message that is a reply to some other
814 * message. Returns #NULL if memory can't be allocated
817 * @param original_message the message which the created
818 * message is a reply to.
819 * @returns a new DBusMessage, free with dbus_message_unref()
820 * @see dbus_message_new(), dbus_message_unref()
823 dbus_message_new_reply (DBusMessage *original_message)
825 DBusMessage *message;
826 const char *sender, *name;
828 sender = get_string_field (original_message,
830 name = get_string_field (original_message,
833 /* sender is allowed to be null here in peer-to-peer case */
835 message = dbus_message_new (sender, name);
840 if (!dbus_message_set_reply_serial (message,
841 dbus_message_get_serial (original_message)))
843 dbus_message_unref (message);
851 * Creates a new message that is an error reply to a certain message.
853 * @param original_message the original message
854 * @param error_name the error name
855 * @param error_message the error message string
856 * @returns a new error message
859 dbus_message_new_error_reply (DBusMessage *original_message,
860 const char *error_name,
861 const char *error_message)
863 DBusMessage *message;
866 sender = get_string_field (original_message,
869 _dbus_assert (sender != NULL);
871 message = dbus_message_new (sender, error_name);
876 if (!dbus_message_set_reply_serial (message,
877 dbus_message_get_serial (original_message)))
879 dbus_message_unref (message);
883 if (!dbus_message_append_string (message, error_message))
885 dbus_message_unref (message);
889 dbus_message_set_is_error (message, TRUE);
895 * Creates a new message that is an exact replica of the message
896 * specified, except that its refcount is set to 1.
898 * @param message the message.
899 * @returns the new message.
902 dbus_message_copy (const DBusMessage *message)
907 retval = dbus_new0 (DBusMessage, 1);
911 retval->refcount = 1;
912 retval->byte_order = message->byte_order;
913 retval->client_serial = message->client_serial;
914 retval->reply_serial = message->reply_serial;
915 retval->header_padding = message->header_padding;
916 retval->locked = FALSE;
918 if (!_dbus_string_init (&retval->header, _DBUS_INT_MAX))
924 if (!_dbus_string_init (&retval->body, _DBUS_INT_MAX))
926 _dbus_string_free (&retval->header);
931 if (!_dbus_string_copy (&message->header, 0,
934 _dbus_string_free (&retval->header);
935 _dbus_string_free (&retval->body);
941 if (!_dbus_string_copy (&message->body, 0,
944 _dbus_string_free (&retval->header);
945 _dbus_string_free (&retval->body);
951 for (i = 0; i < FIELD_LAST; i++)
953 retval->header_fields[i].offset = message->header_fields[i].offset;
961 * Increments the reference count of a DBusMessage.
963 * @param message The message
964 * @see dbus_message_unref
967 dbus_message_ref (DBusMessage *message)
969 dbus_atomic_t refcount;
971 refcount = _dbus_atomic_inc (&message->refcount);
972 _dbus_assert (refcount > 1);
976 * Decrements the reference count of a DBusMessage.
978 * @param message The message
979 * @see dbus_message_ref
982 dbus_message_unref (DBusMessage *message)
984 dbus_atomic_t refcount;
986 refcount = _dbus_atomic_dec (&message->refcount);
988 _dbus_assert (refcount >= 0);
992 if (message->size_counter != NULL)
994 _dbus_counter_adjust (message->size_counter,
995 - message->size_counter_delta);
996 _dbus_counter_unref (message->size_counter);
999 _dbus_string_free (&message->header);
1000 _dbus_string_free (&message->body);
1002 dbus_free (message);
1007 * Gets the name of a message.
1009 * @param message the message
1010 * @returns the message name (should not be freed)
1013 dbus_message_get_name (DBusMessage *message)
1015 return get_string_field (message, FIELD_NAME, NULL);
1019 * Gets the destination service of a message.
1021 * @param message the message
1022 * @returns the message destination service (should not be freed)
1025 dbus_message_get_service (DBusMessage *message)
1027 return get_string_field (message, FIELD_SERVICE, NULL);
1031 * Appends fields to a message given a variable argument
1032 * list. The variable argument list should contain the type
1033 * of the argument followed by the value to add. Array values
1034 * are specified by a pointer to the array followed by an int
1035 * giving the length of the array. The list is terminated
1038 * @param message the message
1039 * @param first_arg_type type of the first argument
1040 * @param ... value of first argument, list of additional type-value pairs
1041 * @returns #TRUE on success
1044 dbus_message_append_args (DBusMessage *message,
1051 va_start (var_args, first_arg_type);
1052 retval = dbus_message_append_args_valist (message,
1061 * This function takes a va_list for use by language bindings
1063 * @see dbus_message_append_args.
1064 * @param message the message
1065 * @param first_arg_type type of first argument
1066 * @param var_args value of first argument, then list of type/value pairs
1067 * @returns #TRUE on success
1070 dbus_message_append_args_valist (DBusMessage *message,
1076 old_len = _dbus_string_get_length (&message->body);
1078 type = first_arg_type;
1085 if (!dbus_message_append_nil (message))
1087 case DBUS_TYPE_BOOLEAN:
1088 if (!dbus_message_append_boolean (message, va_arg (var_args, dbus_bool_t)))
1091 case DBUS_TYPE_INT32:
1092 if (!dbus_message_append_int32 (message, va_arg (var_args, dbus_int32_t)))
1095 case DBUS_TYPE_UINT32:
1096 if (!dbus_message_append_uint32 (message, va_arg (var_args, dbus_uint32_t)))
1099 case DBUS_TYPE_DOUBLE:
1100 if (!dbus_message_append_double (message, va_arg (var_args, double)))
1103 case DBUS_TYPE_STRING:
1104 if (!dbus_message_append_string (message, va_arg (var_args, const char *)))
1107 case DBUS_TYPE_BOOLEAN_ARRAY:
1110 unsigned char *data;
1112 data = va_arg (var_args, unsigned char *);
1113 len = va_arg (var_args, int);
1115 if (!dbus_message_append_boolean_array (message, data, len))
1119 case DBUS_TYPE_INT32_ARRAY:
1124 data = va_arg (var_args, dbus_int32_t *);
1125 len = va_arg (var_args, int);
1127 if (!dbus_message_append_int32_array (message, data, len))
1131 case DBUS_TYPE_UINT32_ARRAY:
1134 dbus_uint32_t *data;
1136 data = va_arg (var_args, dbus_uint32_t *);
1137 len = va_arg (var_args, int);
1139 if (!dbus_message_append_uint32_array (message, data, len))
1143 case DBUS_TYPE_DOUBLE_ARRAY:
1148 data = va_arg (var_args, double *);
1149 len = va_arg (var_args, int);
1151 if (!dbus_message_append_double_array (message, data, len))
1155 case DBUS_TYPE_BYTE_ARRAY:
1158 unsigned char *data;
1160 data = va_arg (var_args, unsigned char *);
1161 len = va_arg (var_args, int);
1163 if (!dbus_message_append_byte_array (message, data, len))
1167 case DBUS_TYPE_STRING_ARRAY:
1172 data = va_arg (var_args, const char **);
1173 len = va_arg (var_args, int);
1175 if (!dbus_message_append_string_array (message, data, len))
1179 case DBUS_TYPE_DICT:
1183 dict = va_arg (var_args, DBusDict *);
1185 if (!dbus_message_append_dict (message, dict))
1189 _dbus_warn ("Unknown field type %d\n", type);
1192 type = va_arg (var_args, int);
1202 * Appends a nil value to the message
1204 * @param message the message
1205 * @returns #TRUE on success
1208 dbus_message_append_nil (DBusMessage *message)
1210 _dbus_assert (!message->locked);
1212 if (!_dbus_string_append_byte (&message->body, DBUS_TYPE_NIL))
1219 * Appends a boolean value to the message
1221 * @param message the message
1222 * @param value the boolean value
1223 * @returns #TRUE on success
1226 dbus_message_append_boolean (DBusMessage *message,
1229 _dbus_assert (!message->locked);
1231 if (!_dbus_string_append_byte (&message->body, DBUS_TYPE_BOOLEAN))
1234 if (!_dbus_string_append_byte (&message->body, (value != FALSE)))
1236 _dbus_string_shorten (&message->body, 1);
1244 * Appends a 32 bit signed integer to the message.
1246 * @param message the message
1247 * @param value the integer value
1248 * @returns #TRUE on success
1251 dbus_message_append_int32 (DBusMessage *message,
1254 _dbus_assert (!message->locked);
1256 if (!_dbus_string_append_byte (&message->body, DBUS_TYPE_INT32))
1259 if (!_dbus_marshal_int32 (&message->body, message->byte_order, value))
1261 _dbus_string_shorten (&message->body, 1);
1269 * Appends a 32 bit unsigned integer to the message.
1271 * @param message the message
1272 * @param value the integer value
1273 * @returns #TRUE on success
1276 dbus_message_append_uint32 (DBusMessage *message,
1277 dbus_uint32_t value)
1279 _dbus_assert (!message->locked);
1281 if (!_dbus_string_append_byte (&message->body, DBUS_TYPE_UINT32))
1284 if (!_dbus_marshal_uint32 (&message->body, message->byte_order, value))
1286 _dbus_string_shorten (&message->body, 1);
1294 * Appends a double value to the message.
1296 * @param message the message
1297 * @param value the double value
1298 * @returns #TRUE on success
1301 dbus_message_append_double (DBusMessage *message,
1304 _dbus_assert (!message->locked);
1306 if (!_dbus_string_append_byte (&message->body, DBUS_TYPE_DOUBLE))
1309 if (!_dbus_marshal_double (&message->body, message->byte_order, value))
1311 _dbus_string_shorten (&message->body, 1);
1319 * Appends a UTF-8 string to the message.
1321 * @param message the message
1322 * @param value the string
1323 * @returns #TRUE on success
1326 dbus_message_append_string (DBusMessage *message,
1329 _dbus_assert (!message->locked);
1331 if (!_dbus_string_append_byte (&message->body, DBUS_TYPE_STRING))
1334 if (!_dbus_marshal_string (&message->body, message->byte_order, value))
1336 _dbus_string_shorten (&message->body, 1);
1344 * Appends a boolean array to the message.
1346 * @param message the message
1347 * @param value the array
1348 * @param len the length of the array
1349 * @returns #TRUE on success
1352 dbus_message_append_boolean_array (DBusMessage *message,
1353 unsigned const char *value,
1356 _dbus_assert (!message->locked);
1358 if (!_dbus_string_append_byte (&message->body, DBUS_TYPE_BOOLEAN_ARRAY))
1361 if (!_dbus_marshal_byte_array (&message->body, message->byte_order, value, len))
1363 _dbus_string_shorten (&message->body, 1);
1371 * Appends a 32 bit signed integer array to the message.
1373 * @param message the message
1374 * @param value the array
1375 * @param len the length of the array
1376 * @returns #TRUE on success
1379 dbus_message_append_int32_array (DBusMessage *message,
1380 const dbus_int32_t *value,
1383 _dbus_assert (!message->locked);
1385 if (!_dbus_string_append_byte (&message->body, DBUS_TYPE_INT32_ARRAY))
1388 if (!_dbus_marshal_int32_array (&message->body, message->byte_order,
1391 _dbus_string_shorten (&message->body, 1);
1399 * Appends a 32 bit unsigned integer array to the message.
1401 * @param message the message
1402 * @param value the array
1403 * @param len the length of the array
1404 * @returns #TRUE on success
1407 dbus_message_append_uint32_array (DBusMessage *message,
1408 const dbus_uint32_t *value,
1411 _dbus_assert (!message->locked);
1413 if (!_dbus_string_append_byte (&message->body, DBUS_TYPE_UINT32_ARRAY))
1416 if (!_dbus_marshal_uint32_array (&message->body, message->byte_order,
1419 _dbus_string_shorten (&message->body, 1);
1427 * Appends a double array to the message.
1429 * @param message the message
1430 * @param value the array
1431 * @param len the length of the array
1432 * @returns #TRUE on success
1435 dbus_message_append_double_array (DBusMessage *message,
1436 const double *value,
1439 _dbus_assert (!message->locked);
1441 if (!_dbus_string_append_byte (&message->body, DBUS_TYPE_DOUBLE_ARRAY))
1444 if (!_dbus_marshal_double_array (&message->body, message->byte_order,
1447 _dbus_string_shorten (&message->body, 1);
1455 * Appends a byte array to the message.
1457 * @param message the message
1458 * @param value the array
1459 * @param len the length of the array
1460 * @returns #TRUE on success
1463 dbus_message_append_byte_array (DBusMessage *message,
1464 unsigned const char *value,
1467 _dbus_assert (!message->locked);
1469 if (!_dbus_string_append_byte (&message->body, DBUS_TYPE_BYTE_ARRAY))
1472 if (!_dbus_marshal_byte_array (&message->body, message->byte_order, value, len))
1474 _dbus_string_shorten (&message->body, 1);
1482 * Appends a string array to the message.
1484 * @param message the message
1485 * @param value the array
1486 * @param len the length of the array
1487 * @returns #TRUE on success
1490 dbus_message_append_string_array (DBusMessage *message,
1494 _dbus_assert (!message->locked);
1496 if (!_dbus_string_append_byte (&message->body, DBUS_TYPE_STRING_ARRAY))
1499 if (!_dbus_marshal_string_array (&message->body, message->byte_order,
1502 _dbus_string_shorten (&message->body, 1);
1510 * Appends a dict to the message.
1512 * @param message the message
1513 * @param dict the dict
1514 * @returns #TRUE on success
1517 dbus_message_append_dict (DBusMessage *message,
1520 _dbus_assert (!message->locked);
1522 if (!_dbus_string_append_byte (&message->body, DBUS_TYPE_DICT))
1525 if (!_dbus_marshal_dict (&message->body, message->byte_order, dict))
1527 _dbus_string_shorten (&message->body, 1);
1535 * Gets arguments from a message given a variable argument list.
1536 * The variable argument list should contain the type of the
1537 * argumen followed by a pointer to where the value should be
1538 * stored. The list is terminated with 0.
1540 * @param message the message
1541 * @param error error to be filled in on failure
1542 * @param first_arg_type the first argument type
1543 * @param ... location for first argument value, then list of type-location pairs
1544 * @returns #FALSE if the error was set
1547 dbus_message_get_args (DBusMessage *message,
1552 DBusResultCode retval;
1555 va_start (var_args, first_arg_type);
1556 retval = dbus_message_get_args_valist (message, error, first_arg_type, var_args);
1563 * This function takes a va_list for use by language bindings
1565 * @todo this function (or some lower-level non-convenience function)
1566 * needs better error handling; should allow the application to
1567 * distinguish between out of memory, and bad data from the remote
1568 * app. It also needs to not leak a bunch of args when it gets
1569 * to the arg that's bad, as that would be a security hole
1570 * (allow one app to force another to leak memory)
1572 * @todo We need to free the argument data when an error occurs.
1574 * @see dbus_message_get_args
1575 * @param message the message
1576 * @param error error to be filled in
1577 * @param first_arg_type type of the first argument
1578 * @param var_args return location for first argument, followed by list of type/location pairs
1579 * @returns #FALSE if error was set
1582 dbus_message_get_args_valist (DBusMessage *message,
1587 int spec_type, msg_type, i;
1588 DBusMessageIter *iter;
1591 iter = dbus_message_get_args_iter (message);
1595 dbus_set_error (error, DBUS_ERROR_NO_MEMORY,
1596 "No memory to get message arguments");
1602 spec_type = first_arg_type;
1605 while (spec_type != 0)
1607 msg_type = dbus_message_iter_get_arg_type (iter);
1609 if (msg_type != spec_type)
1611 dbus_set_error (error, DBUS_ERROR_INVALID_ARGS,
1612 "Argument %d is specified to be of type \"%s\", but "
1613 "is actually of type \"%s\"\n", i,
1614 _dbus_type_to_string (spec_type),
1615 _dbus_type_to_string (msg_type));
1624 case DBUS_TYPE_BOOLEAN:
1628 ptr = va_arg (var_args, dbus_bool_t *);
1630 *ptr = dbus_message_iter_get_boolean (iter);
1633 case DBUS_TYPE_INT32:
1637 ptr = va_arg (var_args, dbus_int32_t *);
1639 *ptr = dbus_message_iter_get_int32 (iter);
1642 case DBUS_TYPE_UINT32:
1646 ptr = va_arg (var_args, dbus_uint32_t *);
1648 *ptr = dbus_message_iter_get_uint32 (iter);
1652 case DBUS_TYPE_DOUBLE:
1656 ptr = va_arg (var_args, double *);
1658 *ptr = dbus_message_iter_get_double (iter);
1662 case DBUS_TYPE_STRING:
1666 ptr = va_arg (var_args, char **);
1668 *ptr = dbus_message_iter_get_string (iter);
1672 dbus_set_error (error, DBUS_ERROR_NO_MEMORY,
1673 "No memory for argument %d", i);
1680 case DBUS_TYPE_BOOLEAN_ARRAY:
1682 unsigned char **ptr;
1685 ptr = va_arg (var_args, unsigned char **);
1686 len = va_arg (var_args, int *);
1688 if (!dbus_message_iter_get_boolean_array (iter, ptr, len))
1690 dbus_set_error (error, DBUS_ERROR_NO_MEMORY,
1691 "No memory for argument %d", i);
1697 case DBUS_TYPE_INT32_ARRAY:
1702 ptr = va_arg (var_args, dbus_int32_t **);
1703 len = va_arg (var_args, int *);
1705 if (!dbus_message_iter_get_int32_array (iter, ptr, len))
1707 dbus_set_error (error, DBUS_ERROR_NO_MEMORY,
1708 "No memory for argument %d", i);
1715 case DBUS_TYPE_UINT32_ARRAY:
1717 dbus_uint32_t **ptr;
1720 ptr = va_arg (var_args, dbus_uint32_t **);
1721 len = va_arg (var_args, int *);
1723 if (!dbus_message_iter_get_uint32_array (iter, ptr, len))
1725 dbus_set_error (error, DBUS_ERROR_NO_MEMORY,
1726 "No memory for argument %d", i);
1733 case DBUS_TYPE_DOUBLE_ARRAY:
1738 ptr = va_arg (var_args, double **);
1739 len = va_arg (var_args, int *);
1741 if (!dbus_message_iter_get_double_array (iter, ptr, len))
1743 dbus_set_error (error, DBUS_ERROR_NO_MEMORY,
1744 "No memory for argument %d", i);
1750 case DBUS_TYPE_BYTE_ARRAY:
1752 unsigned char **ptr;
1755 ptr = va_arg (var_args, unsigned char **);
1756 len = va_arg (var_args, int *);
1758 if (!dbus_message_iter_get_byte_array (iter, ptr, len))
1760 dbus_set_error (error, DBUS_ERROR_NO_MEMORY,
1761 "No memory for argument %d", i);
1766 case DBUS_TYPE_STRING_ARRAY:
1771 ptr = va_arg (var_args, char ***);
1772 len = va_arg (var_args, int *);
1774 if (!dbus_message_iter_get_string_array (iter, ptr, len))
1776 dbus_set_error (error, DBUS_ERROR_NO_MEMORY,
1777 "No memory for argument %d", i);
1782 case DBUS_TYPE_DICT:
1786 dict = va_arg (var_args, DBusDict **);
1788 if (!dbus_message_iter_get_dict (iter, dict))
1790 dbus_set_error (error, DBUS_ERROR_NO_MEMORY,
1791 "No memory for argument %d", i);
1797 _dbus_warn ("Unknown field type %d\n", spec_type);
1800 spec_type = va_arg (var_args, int);
1801 if (spec_type != 0 && !dbus_message_iter_next (iter))
1803 dbus_set_error (error, DBUS_ERROR_INVALID_ARGS,
1804 "Message has only %d arguments, but more were expected", i);
1814 dbus_message_iter_unref (iter);
1819 * Returns a DBusMessageIter representing the arguments of the
1820 * message passed in.
1822 * @todo IMO the message iter should follow the GtkTextIter pattern,
1823 * a static object with a "stamp" value used to detect invalid
1824 * iter uses (uninitialized or after changing the message).
1825 * ref/unref is kind of annoying to deal with, and slower too.
1826 * This implies not ref'ing the message from the iter.
1828 * @todo I'd also name this dbus_message_iter_new() or
1829 * for the static object dbus_message_iter_init() rather
1830 * than making it a method on the message
1832 * @param message the message
1833 * @returns a new iter.
1836 dbus_message_get_args_iter (DBusMessage *message)
1838 DBusMessageIter *iter;
1840 iter = dbus_new (DBusMessageIter, 1);
1844 dbus_message_ref (message);
1847 iter->message = message;
1855 * Increments the reference count of a DBusMessageIter.
1857 * @param iter the message iter
1858 * @see dbus_message_iter_unref
1861 dbus_message_iter_ref (DBusMessageIter *iter)
1863 _dbus_assert (iter->refcount > 0);
1865 iter->refcount += 1;
1869 * Decrements the reference count of a DBusMessageIter.
1871 * @param iter The message iter
1872 * @see dbus_message_iter_ref
1875 dbus_message_iter_unref (DBusMessageIter *iter)
1877 _dbus_assert (iter->refcount > 0);
1879 iter->refcount -= 1;
1881 if (iter->refcount == 0)
1883 dbus_message_unref (iter->message);
1890 * Checks if an iterator has any more fields.
1892 * @param iter the message iter
1893 * @returns #TRUE if there are more fields
1897 dbus_message_iter_has_next (DBusMessageIter *iter)
1901 if (!_dbus_marshal_get_arg_end_pos (&iter->message->body,
1902 iter->message->byte_order,
1903 iter->pos, &end_pos))
1906 if (end_pos >= _dbus_string_get_length (&iter->message->body))
1913 * Moves the iterator to the next field.
1915 * @param iter The message iter
1916 * @returns #TRUE if the iterator was moved to the next field
1919 dbus_message_iter_next (DBusMessageIter *iter)
1923 if (!_dbus_marshal_get_arg_end_pos (&iter->message->body,
1924 iter->message->byte_order,
1925 iter->pos, &end_pos))
1928 if (end_pos >= _dbus_string_get_length (&iter->message->body))
1931 iter->pos = end_pos;
1937 * Returns the argument type of the argument that the
1938 * message iterator points at.
1940 * @param iter the message iter
1941 * @returns the field type
1944 dbus_message_iter_get_arg_type (DBusMessageIter *iter)
1948 if (iter->pos >= _dbus_string_get_length (&iter->message->body))
1949 return DBUS_TYPE_INVALID;
1951 _dbus_string_get_const_data_len (&iter->message->body, &data, iter->pos, 1);
1953 if (*data > DBUS_TYPE_INVALID && *data <= DBUS_TYPE_DICT)
1956 return DBUS_TYPE_INVALID;
1960 * Returns the string value that an iterator may point to.
1961 * Note that you need to check that the iterator points to
1962 * a string value before using this function.
1964 * @see dbus_message_iter_get_arg_type
1965 * @param iter the message iter
1966 * @returns the string
1969 dbus_message_iter_get_string (DBusMessageIter *iter)
1971 _dbus_assert (dbus_message_iter_get_arg_type (iter) == DBUS_TYPE_STRING);
1973 return _dbus_demarshal_string (&iter->message->body, iter->message->byte_order,
1974 iter->pos + 1, NULL);
1978 * Returns the boolean value that an iterator may point to.
1979 * Note that you need to check that the iterator points to
1980 * a boolean value before using this function.
1982 * @see dbus_message_iter_get_arg_type
1983 * @param iter the message iter
1984 * @returns the string
1987 dbus_message_iter_get_boolean (DBusMessageIter *iter)
1989 unsigned char value;
1991 _dbus_assert (dbus_message_iter_get_arg_type (iter) == DBUS_TYPE_BOOLEAN);
1993 value = _dbus_string_get_byte (&iter->message->body, iter->pos + 1);
2000 * Returns the 32 bit signed integer value that an iterator may point to.
2001 * Note that you need to check that the iterator points to
2002 * an integer value before using this function.
2004 * @see dbus_message_iter_get_arg_type
2005 * @param iter the message iter
2006 * @returns the integer
2009 dbus_message_iter_get_int32 (DBusMessageIter *iter)
2011 _dbus_assert (dbus_message_iter_get_arg_type (iter) == DBUS_TYPE_INT32);
2013 return _dbus_demarshal_int32 (&iter->message->body, iter->message->byte_order,
2014 iter->pos + 1, NULL);
2018 * Returns the 32 bit unsigned integer value that an iterator may point to.
2019 * Note that you need to check that the iterator points to
2020 * an unsigned integer value before using this function.
2022 * @see dbus_message_iter_get_arg_type
2023 * @param iter the message iter
2024 * @returns the integer
2027 dbus_message_iter_get_uint32 (DBusMessageIter *iter)
2029 _dbus_assert (dbus_message_iter_get_arg_type (iter) == DBUS_TYPE_UINT32);
2031 return _dbus_demarshal_uint32 (&iter->message->body, iter->message->byte_order,
2032 iter->pos + 1, NULL);
2036 * Returns the double value that an iterator may point to.
2037 * Note that you need to check that the iterator points to
2038 * a string value before using this function.
2040 * @see dbus_message_iter_get_arg_type
2041 * @param iter the message iter
2042 * @returns the double
2045 dbus_message_iter_get_double (DBusMessageIter *iter)
2047 _dbus_assert (dbus_message_iter_get_arg_type (iter) == DBUS_TYPE_DOUBLE);
2049 return _dbus_demarshal_double (&iter->message->body, iter->message->byte_order,
2050 iter->pos + 1, NULL);
2054 * Returns the boolean array that the iterator may point to. Note that
2055 * you need to check that the iterator points to an array of the
2056 * correct type prior to using this function.
2058 * @param iter the iterator
2059 * @param value return location for the array
2060 * @param len return location for the array length
2061 * @returns #TRUE on success
2064 dbus_message_iter_get_boolean_array (DBusMessageIter *iter,
2065 unsigned char **value,
2068 _dbus_assert (dbus_message_iter_get_arg_type (iter) == DBUS_TYPE_BOOLEAN_ARRAY);
2070 *value = _dbus_demarshal_byte_array (&iter->message->body, iter->message->byte_order,
2071 iter->pos + 1, NULL, len);
2080 * Returns the 32 bit signed integer array that the iterator may point
2081 * to. Note that you need to check that the iterator points to an
2082 * array of the correct type prior to using this function.
2084 * @param iter the iterator
2085 * @param value return location for the array
2086 * @param len return location for the array length
2087 * @returns #TRUE on success
2090 dbus_message_iter_get_int32_array (DBusMessageIter *iter,
2091 dbus_int32_t **value,
2094 _dbus_assert (dbus_message_iter_get_arg_type (iter) == DBUS_TYPE_INT32_ARRAY);
2096 *value = _dbus_demarshal_int32_array (&iter->message->body, iter->message->byte_order,
2097 iter->pos + 1, NULL, len);
2106 * Returns the 32 bit unsigned integer array that the iterator may point
2107 * to. Note that you need to check that the iterator points to an
2108 * array of the correct type prior to using this function.
2110 * @param iter the iterator
2111 * @param value return location for the array
2112 * @param len return location for the array length
2113 * @returns #TRUE on success
2116 dbus_message_iter_get_uint32_array (DBusMessageIter *iter,
2117 dbus_uint32_t **value,
2120 _dbus_assert (dbus_message_iter_get_arg_type (iter) == DBUS_TYPE_UINT32_ARRAY);
2122 *value = _dbus_demarshal_uint32_array (&iter->message->body, iter->message->byte_order,
2123 iter->pos + 1, NULL, len);
2132 * Returns the double array that the iterator may point to. Note that
2133 * you need to check that the iterator points to an array of the
2134 * correct type prior to using this function.
2136 * @param iter the iterator
2137 * @param value return location for the array
2138 * @param len return location for the array length
2139 * @returns #TRUE on success
2142 dbus_message_iter_get_double_array (DBusMessageIter *iter,
2146 _dbus_assert (dbus_message_iter_get_arg_type (iter) == DBUS_TYPE_DOUBLE_ARRAY);
2148 *value = _dbus_demarshal_double_array (&iter->message->body, iter->message->byte_order,
2149 iter->pos + 1, NULL, len);
2158 * Returns the byte array that the iterator may point to.
2159 * Note that you need to check that the iterator points
2160 * to a byte array prior to using this function.
2162 * @param iter the iterator
2163 * @param value return location for array values
2164 * @param len return location for length of byte array
2165 * @returns #TRUE on success
2168 dbus_message_iter_get_byte_array (DBusMessageIter *iter,
2169 unsigned char **value,
2172 _dbus_assert (dbus_message_iter_get_arg_type (iter) == DBUS_TYPE_BYTE_ARRAY);
2174 *value = _dbus_demarshal_byte_array (&iter->message->body, iter->message->byte_order,
2175 iter->pos + 1, NULL, len);
2184 * Returns the string array that the iterator may point to.
2185 * Note that you need to check that the iterator points
2186 * to a byte array prior to using this function.
2188 * The returned value is a #NULL-terminated array of strings.
2189 * Each string is a separate malloc block, and the array
2190 * itself is a malloc block. You can free this type of
2191 * string array with dbus_free_string_array().
2193 * @param iter the iterator
2194 * @param value return location for string values
2195 * @param len return location for length of byte array
2196 * @returns #TRUE on success
2199 dbus_message_iter_get_string_array (DBusMessageIter *iter,
2203 _dbus_assert (dbus_message_iter_get_arg_type (iter) == DBUS_TYPE_STRING_ARRAY);
2205 *value = _dbus_demarshal_string_array (&iter->message->body, iter->message->byte_order,
2206 iter->pos + 1, NULL, len);
2215 * Returns the dict that the iterator may point to.
2216 * Note that you need to check that the iterator points
2217 * to a dict prior to using this function.
2219 * @param iter the iterator
2220 * @param dict return location for dict
2221 * @returns #TRUE on success
2224 dbus_message_iter_get_dict (DBusMessageIter *iter,
2227 _dbus_assert (dbus_message_iter_get_arg_type (iter) == DBUS_TYPE_DICT);
2229 *dict = _dbus_demarshal_dict (&iter->message->body, iter->message->byte_order,
2230 iter->pos + 1, NULL);
2239 * Sets the message sender.
2241 * @param message the message
2242 * @param sender the sender
2243 * @returns #FALSE if not enough memory
2246 dbus_message_set_sender (DBusMessage *message,
2249 _dbus_assert (!message->locked);
2253 delete_string_field (message, FIELD_SENDER);
2258 return set_string_field (message,
2265 * Sets a flag indicating that the message is an error reply
2266 * message, i.e. an "exception" rather than a normal response.
2268 * @param message the message
2269 * @param is_error_reply #TRUE if this is an error message.
2272 dbus_message_set_is_error (DBusMessage *message,
2273 dbus_bool_t is_error_reply)
2277 _dbus_assert (!message->locked);
2279 _dbus_string_get_data_len (&message->header, &header, 1, 1);
2282 *header |= DBUS_HEADER_FLAG_ERROR;
2284 *header &= ~DBUS_HEADER_FLAG_ERROR;
2288 * Returns #TRUE if the message is an error
2289 * reply to some previous message we sent.
2291 * @param message the message
2292 * @returns #TRUE if the message is an error
2295 dbus_message_get_is_error (DBusMessage *message)
2299 _dbus_string_get_const_data_len (&message->header, &header, 1, 1);
2301 return (*header & DBUS_HEADER_FLAG_ERROR) != 0;
2305 * Gets the service which originated this message,
2306 * or #NULL if unknown or inapplicable.
2308 * @param message the message
2309 * @returns the service name or #NULL
2312 dbus_message_get_sender (DBusMessage *message)
2314 return get_string_field (message, FIELD_SENDER, NULL);
2318 * Checks whether the message has the given name.
2319 * If the message has no name or has a different
2320 * name, returns #FALSE.
2322 * @param message the message
2323 * @param name the name to check (must not be #NULL)
2325 * @returns #TRUE if the message has the given name
2328 dbus_message_name_is (DBusMessage *message,
2333 _dbus_assert (name != NULL);
2335 n = dbus_message_get_name (message);
2337 if (n && strcmp (n, name) == 0)
2346 * @addtogroup DBusMessageInternals
2351 * @typedef DBusMessageLoader
2353 * The DBusMessageLoader object encapsulates the process of converting
2354 * a byte stream into a series of DBusMessage. It buffers the incoming
2355 * bytes as efficiently as possible, and generates a queue of
2356 * messages. DBusMessageLoader is typically used as part of a
2357 * DBusTransport implementation. The DBusTransport then hands off
2358 * the loaded messages to a DBusConnection, making the messages
2359 * visible to the application.
2361 * @todo write tests for break-loader that a) randomly delete header
2362 * fields and b) set string fields to zero-length and other funky
2367 /* we definitely use signed ints for sizes, so don't exceed
2368 * _DBUS_INT_MAX; and add 16 for paranoia, since a message
2369 * over 128M is pretty nuts anyhow.
2373 * The maximum sane message size.
2375 #define MAX_SANE_MESSAGE_SIZE (_DBUS_INT_MAX/16)
2378 * Implementation details of DBusMessageLoader.
2379 * All members are private.
2381 struct DBusMessageLoader
2383 int refcount; /**< Reference count. */
2385 DBusString data; /**< Buffered data */
2387 DBusList *messages; /**< Complete messages. */
2389 long max_message_size; /**< Maximum size of a message */
2391 unsigned int buffer_outstanding : 1; /**< Someone is using the buffer to read */
2393 unsigned int corrupted : 1; /**< We got broken data, and are no longer working */
2397 * The initial buffer size of the message loader.
2399 * @todo this should be based on min header size plus some average
2400 * body size, or something. Or rather, the min header size only, if we
2401 * want to try to read only the header, store that in a DBusMessage,
2402 * then read only the body and store that, etc., depends on
2403 * how we optimize _dbus_message_loader_get_buffer() and what
2404 * the exact message format is.
2406 #define INITIAL_LOADER_DATA_LEN 32
2409 * Creates a new message loader. Returns #NULL if memory can't
2412 * @returns new loader, or #NULL.
2415 _dbus_message_loader_new (void)
2417 DBusMessageLoader *loader;
2419 loader = dbus_new0 (DBusMessageLoader, 1);
2423 loader->refcount = 1;
2425 /* Try to cap message size at something that won't *totally* hose
2426 * the system if we have a couple of them.
2428 loader->max_message_size = _DBUS_ONE_MEGABYTE * 32;
2430 if (!_dbus_string_init (&loader->data, _DBUS_INT_MAX))
2436 /* preallocate the buffer for speed, ignore failure */
2437 _dbus_string_set_length (&loader->data, INITIAL_LOADER_DATA_LEN);
2438 _dbus_string_set_length (&loader->data, 0);
2444 * Increments the reference count of the loader.
2446 * @param loader the loader.
2449 _dbus_message_loader_ref (DBusMessageLoader *loader)
2451 loader->refcount += 1;
2455 * Decrements the reference count of the loader and finalizes the
2456 * loader when the count reaches zero.
2458 * @param loader the loader.
2461 _dbus_message_loader_unref (DBusMessageLoader *loader)
2463 loader->refcount -= 1;
2464 if (loader->refcount == 0)
2466 _dbus_list_foreach (&loader->messages,
2467 (DBusForeachFunction) dbus_message_unref,
2469 _dbus_list_clear (&loader->messages);
2470 _dbus_string_free (&loader->data);
2476 * Gets the buffer to use for reading data from the network. Network
2477 * data is read directly into an allocated buffer, which is then used
2478 * in the DBusMessage, to avoid as many extra memcpy's as possible.
2479 * The buffer must always be returned immediately using
2480 * _dbus_message_loader_return_buffer(), even if no bytes are
2481 * successfully read.
2483 * @todo this function can be a lot more clever. For example
2484 * it can probably always return a buffer size to read exactly
2485 * the body of the next message, thus avoiding any memory wastage
2488 * @todo we need to enforce a max length on strings in header fields.
2490 * @param loader the message loader.
2491 * @param buffer the buffer
2494 _dbus_message_loader_get_buffer (DBusMessageLoader *loader,
2495 DBusString **buffer)
2497 _dbus_assert (!loader->buffer_outstanding);
2499 *buffer = &loader->data;
2501 loader->buffer_outstanding = TRUE;
2505 * The smallest header size that can occur.
2506 * (It won't be valid)
2508 #define DBUS_MINIMUM_HEADER_SIZE 16
2510 /** Pack four characters as in "abcd" into a uint32 */
2511 #define FOUR_CHARS_TO_UINT32(a, b, c, d) \
2512 ((((dbus_uint32_t)a) << 24) | \
2513 (((dbus_uint32_t)b) << 16) | \
2514 (((dbus_uint32_t)c) << 8) | \
2517 /** DBUS_HEADER_FIELD_NAME packed into a dbus_uint32_t */
2518 #define DBUS_HEADER_FIELD_NAME_AS_UINT32 \
2519 FOUR_CHARS_TO_UINT32 ('n', 'a', 'm', 'e')
2521 /** DBUS_HEADER_FIELD_SERVICE packed into a dbus_uint32_t */
2522 #define DBUS_HEADER_FIELD_SERVICE_AS_UINT32 \
2523 FOUR_CHARS_TO_UINT32 ('s', 'r', 'v', 'c')
2525 /** DBUS_HEADER_FIELD_REPLY packed into a dbus_uint32_t */
2526 #define DBUS_HEADER_FIELD_REPLY_AS_UINT32 \
2527 FOUR_CHARS_TO_UINT32 ('r', 'p', 'l', 'y')
2529 /** DBUS_HEADER_FIELD_SENDER Packed into a dbus_uint32_t */
2530 #define DBUS_HEADER_FIELD_SENDER_AS_UINT32 \
2531 FOUR_CHARS_TO_UINT32 ('s', 'n', 'd', 'r')
2533 /* FIXME impose max length on name, srvc, sndr */
2535 decode_header_data (const DBusString *data,
2538 HeaderField fields[FIELD_LAST],
2539 int *message_padding)
2545 if (header_len < 16)
2549 while (i < FIELD_LAST)
2551 fields[i].offset = -1;
2555 fields[FIELD_HEADER_LENGTH].offset = 4;
2556 fields[FIELD_BODY_LENGTH].offset = 8;
2557 fields[FIELD_CLIENT_SERIAL].offset = 12;
2559 /* Now handle the named fields. A real named field is at least 4
2560 * bytes for the name, plus a type code (1 byte) plus padding. So
2561 * if we have less than 8 bytes left, it must be alignment padding,
2562 * not a field. While >= 8 bytes can't be entirely alignment
2566 while ((pos + 7) < header_len)
2568 pos = _DBUS_ALIGN_VALUE (pos, 4);
2570 if ((pos + 4) > header_len)
2573 _dbus_string_get_const_data_len (data, &field, pos, 4);
2576 _dbus_assert (_DBUS_ALIGN_ADDRESS (field, 4) == field);
2578 /* I believe FROM_BE is right, but if not we'll find out
2581 switch (DBUS_UINT32_FROM_BE (*(int*)field))
2583 case DBUS_HEADER_FIELD_SERVICE_AS_UINT32:
2584 if (fields[FIELD_SERVICE].offset >= 0)
2586 _dbus_verbose ("%s field provided twice\n",
2587 DBUS_HEADER_FIELD_SERVICE);
2591 fields[FIELD_SERVICE].offset = _DBUS_ALIGN_VALUE (pos + 1, 4);
2593 _dbus_verbose ("Found service name at offset %d\n",
2594 fields[FIELD_SERVICE].offset);
2598 case DBUS_HEADER_FIELD_NAME_AS_UINT32:
2599 if (fields[FIELD_NAME].offset >= 0)
2601 _dbus_verbose ("%s field provided twice\n",
2602 DBUS_HEADER_FIELD_NAME);
2606 fields[FIELD_NAME].offset = _DBUS_ALIGN_VALUE (pos + 1, 4);
2609 _dbus_verbose ("Found message name at offset %d\n",
2610 fields[FIELD_NAME].offset);
2613 case DBUS_HEADER_FIELD_SENDER_AS_UINT32:
2614 if (fields[FIELD_SENDER].offset >= 0)
2616 _dbus_verbose ("%s field provided twice\n",
2617 DBUS_HEADER_FIELD_SENDER);
2621 fields[FIELD_SENDER].offset = _DBUS_ALIGN_VALUE (pos + 1, 4);
2623 _dbus_verbose ("Found sender name at offset %d\n",
2624 fields[FIELD_NAME].offset);
2627 case DBUS_HEADER_FIELD_REPLY_AS_UINT32:
2628 if (fields[FIELD_REPLY_SERIAL].offset >= 0)
2630 _dbus_verbose ("%s field provided twice\n",
2631 DBUS_HEADER_FIELD_REPLY);
2635 fields[FIELD_REPLY_SERIAL].offset = _DBUS_ALIGN_VALUE (pos + 1, 4);
2637 _dbus_verbose ("Found reply serial at offset %d\n",
2638 fields[FIELD_REPLY_SERIAL].offset);
2642 _dbus_verbose ("Ignoring an unknown header field: %c%c%c%c at offset %d\n",
2643 field[0], field[1], field[2], field[3], pos);
2646 if (!_dbus_marshal_validate_arg (data, byte_order, pos, &new_pos))
2648 _dbus_verbose ("Failed to validate argument to named header field\n");
2652 if (new_pos > header_len)
2654 _dbus_verbose ("Named header field tries to extend beyond header length\n");
2661 if (pos < header_len)
2663 /* Alignment padding, verify that it's nul */
2664 _dbus_assert ((header_len - pos) < 8);
2666 if (!_dbus_string_validate_nul (data,
2667 pos, (header_len - pos)))
2669 _dbus_verbose ("header alignment padding is not nul\n");
2674 if (fields[FIELD_NAME].offset < 0)
2676 _dbus_verbose ("No %s field provided\n",
2677 DBUS_HEADER_FIELD_NAME);
2681 if (message_padding)
2682 *message_padding = header_len - pos;
2688 * Returns a buffer obtained from _dbus_message_loader_get_buffer(),
2689 * indicating to the loader how many bytes of the buffer were filled
2690 * in. This function must always be called, even if no bytes were
2691 * successfully read.
2693 * @todo if we run out of memory in here, we offer no way for calling
2694 * code to handle it, i.e. they can't re-run the message parsing
2695 * attempt. Perhaps much of this code could be moved to pop_message()?
2696 * But then that may need to distinguish NULL return for no messages
2697 * from NULL return for errors.
2699 * @param loader the loader.
2700 * @param buffer the buffer.
2701 * @param bytes_read number of bytes that were read into the buffer.
2704 _dbus_message_loader_return_buffer (DBusMessageLoader *loader,
2708 _dbus_assert (loader->buffer_outstanding);
2709 _dbus_assert (buffer == &loader->data);
2711 loader->buffer_outstanding = FALSE;
2713 if (loader->corrupted)
2716 while (_dbus_string_get_length (&loader->data) >= 16)
2718 DBusMessage *message;
2719 const char *header_data;
2720 int byte_order, header_len, body_len, header_padding;
2721 dbus_uint32_t header_len_unsigned, body_len_unsigned;
2723 _dbus_string_get_const_data_len (&loader->data, &header_data, 0, 16);
2725 _dbus_assert (_DBUS_ALIGN_ADDRESS (header_data, 4) == header_data);
2727 if (header_data[2] != DBUS_MAJOR_PROTOCOL_VERSION)
2729 _dbus_verbose ("Message has protocol version %d ours is %d\n",
2730 (int) header_data[2], DBUS_MAJOR_PROTOCOL_VERSION);
2731 loader->corrupted = TRUE;
2735 byte_order = header_data[0];
2737 if (byte_order != DBUS_LITTLE_ENDIAN &&
2738 byte_order != DBUS_BIG_ENDIAN)
2740 _dbus_verbose ("Message with bad byte order '%c' received\n",
2742 loader->corrupted = TRUE;
2746 header_len_unsigned = _dbus_unpack_uint32 (byte_order, header_data + 4);
2747 body_len_unsigned = _dbus_unpack_uint32 (byte_order, header_data + 8);
2749 if (header_len_unsigned < 16)
2751 _dbus_verbose ("Message had broken too-small header length %u\n",
2752 header_len_unsigned);
2753 loader->corrupted = TRUE;
2757 if (header_len_unsigned > (unsigned) MAX_SANE_MESSAGE_SIZE ||
2758 body_len_unsigned > (unsigned) MAX_SANE_MESSAGE_SIZE)
2760 _dbus_verbose ("Header or body length too large (%u %u)\n",
2761 header_len_unsigned,
2763 loader->corrupted = TRUE;
2767 /* Now that we know the values are in signed range, get
2768 * rid of stupid unsigned, just causes bugs
2770 header_len = header_len_unsigned;
2771 body_len = body_len_unsigned;
2773 if (_DBUS_ALIGN_VALUE (header_len, 8) != header_len_unsigned)
2776 _dbus_verbose ("header length %d is not aligned to 8 bytes\n",
2778 loader->corrupted = TRUE;
2782 if (header_len + body_len > loader->max_message_size)
2784 _dbus_verbose ("Message claimed length header = %d body = %d exceeds max message length %d\n",
2785 header_len, body_len, loader->max_message_size);
2786 loader->corrupted = TRUE;
2790 if (_dbus_string_get_length (&loader->data) >= (header_len + body_len))
2792 HeaderField fields[FIELD_LAST];
2797 _dbus_verbose_bytes_of_string (&loader->data, 0, header_len + body_len);
2799 if (!decode_header_data (&loader->data, header_len, byte_order,
2800 fields, &header_padding))
2802 _dbus_verbose ("Header was invalid\n");
2803 loader->corrupted = TRUE;
2807 next_arg = header_len;
2808 while (next_arg < (header_len + body_len))
2810 int prev = next_arg;
2812 if (!_dbus_marshal_validate_arg (&loader->data,
2817 loader->corrupted = TRUE;
2821 _dbus_assert (next_arg > prev);
2824 if (next_arg > (header_len + body_len))
2826 _dbus_verbose ("end of last arg at %d but message has len %d+%d=%d\n",
2827 next_arg, header_len, body_len,
2828 header_len + body_len);
2829 loader->corrupted = TRUE;
2833 message = dbus_message_new_empty_header ();
2834 if (message == NULL)
2835 break; /* ugh, postpone this I guess. */
2837 message->byte_order = byte_order;
2838 message->header_padding = header_padding;
2840 /* Copy in the offsets we found */
2842 while (i < FIELD_LAST)
2844 message->header_fields[i] = fields[i];
2848 if (!_dbus_list_append (&loader->messages, message))
2850 dbus_message_unref (message);
2854 _dbus_assert (_dbus_string_get_length (&message->header) == 0);
2855 _dbus_assert (_dbus_string_get_length (&message->body) == 0);
2857 _dbus_assert (_dbus_string_get_length (&loader->data) >=
2858 (header_len + body_len));
2860 if (!_dbus_string_move_len (&loader->data, 0, header_len, &message->header, 0))
2862 _dbus_list_remove_last (&loader->messages, message);
2863 dbus_message_unref (message);
2867 if (!_dbus_string_move_len (&loader->data, 0, body_len, &message->body, 0))
2871 /* put the header back, we'll try again later */
2872 result = _dbus_string_copy_len (&message->header, 0, header_len,
2874 _dbus_assert (result); /* because DBusString never reallocs smaller */
2876 _dbus_list_remove_last (&loader->messages, message);
2877 dbus_message_unref (message);
2881 _dbus_assert (_dbus_string_get_length (&message->header) == header_len);
2882 _dbus_assert (_dbus_string_get_length (&message->body) == body_len);
2884 /* Fill in caches */
2885 message->reply_serial = get_int_field (message,
2886 FIELD_REPLY_SERIAL);
2887 message->client_serial = get_int_field (message,
2888 FIELD_CLIENT_SERIAL);
2890 _dbus_verbose ("Loaded message %p\n", message);
2898 * Pops a loaded message (passing ownership of the message
2899 * to the caller). Returns #NULL if no messages have been
2902 * @param loader the loader.
2903 * @returns the next message, or #NULL if none.
2906 _dbus_message_loader_pop_message (DBusMessageLoader *loader)
2908 return _dbus_list_pop_first (&loader->messages);
2912 * Pops a loaded message inside a list link (passing ownership of the
2913 * message and link to the caller). Returns #NULL if no messages have
2916 * @param loader the loader.
2917 * @returns the next message link, or #NULL if none.
2920 _dbus_message_loader_pop_message_link (DBusMessageLoader *loader)
2922 return _dbus_list_pop_first_link (&loader->messages);
2926 * Checks whether the loader is confused due to bad data.
2927 * If messages are received that are invalid, the
2928 * loader gets confused and gives up permanently.
2929 * This state is called "corrupted."
2931 * @param loader the loader
2932 * @returns #TRUE if the loader is hosed.
2935 _dbus_message_loader_get_is_corrupted (DBusMessageLoader *loader)
2937 return loader->corrupted;
2941 * Sets the maximum size message we allow.
2943 * @param loader the loader
2944 * @param size the max message size in bytes
2947 _dbus_message_loader_set_max_message_size (DBusMessageLoader *loader,
2950 if (size > MAX_SANE_MESSAGE_SIZE)
2952 _dbus_verbose ("clamping requested max message size %ld to %d\n",
2953 size, MAX_SANE_MESSAGE_SIZE);
2954 size = MAX_SANE_MESSAGE_SIZE;
2956 loader->max_message_size = size;
2960 * Gets the maximum allowed message size in bytes.
2962 * @param loader the loader
2963 * @returns max size in bytes
2966 _dbus_message_loader_get_max_message_size (DBusMessageLoader *loader)
2968 return loader->max_message_size;
2972 #ifdef DBUS_BUILD_TESTS
2973 #include "dbus-test.h"
2977 message_iter_test (DBusMessage *message)
2979 DBusMessageIter *iter;
2982 iter = dbus_message_get_args_iter (message);
2985 if (dbus_message_iter_get_arg_type (iter) != DBUS_TYPE_STRING)
2986 _dbus_assert_not_reached ("Argument type isn't string");
2988 str = dbus_message_iter_get_string (iter);
2989 if (strcmp (str, "Test string") != 0)
2990 _dbus_assert_not_reached ("Strings differ");
2993 if (!dbus_message_iter_next (iter))
2994 _dbus_assert_not_reached ("Reached end of arguments");
2996 /* Signed integer tests */
2997 if (dbus_message_iter_get_arg_type (iter) != DBUS_TYPE_INT32)
2998 _dbus_assert_not_reached ("Argument type isn't int32");
3000 if (dbus_message_iter_get_int32 (iter) != -0x12345678)
3001 _dbus_assert_not_reached ("Signed integers differ");
3003 if (!dbus_message_iter_next (iter))
3004 _dbus_assert_not_reached ("Reached end of fields");
3006 /* Unsigned integer tests */
3007 if (dbus_message_iter_get_arg_type (iter) != DBUS_TYPE_UINT32)
3008 _dbus_assert_not_reached ("Argument type isn't int32");
3010 if (dbus_message_iter_get_uint32 (iter) != 0xedd1e)
3011 _dbus_assert_not_reached ("Unsigned integers differ");
3013 if (!dbus_message_iter_next (iter))
3014 _dbus_assert_not_reached ("Reached end of arguments");
3017 if (dbus_message_iter_get_arg_type (iter) != DBUS_TYPE_DOUBLE)
3018 _dbus_assert_not_reached ("Argument type isn't double");
3020 if (dbus_message_iter_get_double (iter) != 3.14159)
3021 _dbus_assert_not_reached ("Doubles differ");
3023 if (dbus_message_iter_next (iter))
3024 _dbus_assert_not_reached ("Didn't reach end of arguments");
3026 dbus_message_iter_unref (iter);
3030 check_message_handling (DBusMessage *message)
3032 DBusMessageIter *iter;
3035 dbus_int32_t client_serial;
3040 client_serial = dbus_message_get_serial (message);
3042 /* can't use set_serial due to the assertions at the start of it */
3043 set_int_field (message, FIELD_CLIENT_SERIAL,
3046 if (client_serial != dbus_message_get_serial (message))
3048 _dbus_warn ("get/set cycle for client_serial did not succeed\n");
3052 /* If we implement message_set_arg (message, n, value)
3053 * then we would want to test it here
3056 iter = dbus_message_get_args_iter (message);
3057 while ((type = dbus_message_iter_get_arg_type (iter)) != DBUS_TYPE_INVALID)
3063 case DBUS_TYPE_INT32:
3064 dbus_message_iter_get_int32 (iter);
3066 case DBUS_TYPE_UINT32:
3067 dbus_message_iter_get_uint32 (iter);
3069 case DBUS_TYPE_DOUBLE:
3070 dbus_message_iter_get_double (iter);
3072 case DBUS_TYPE_STRING:
3075 str = dbus_message_iter_get_string (iter);
3079 case DBUS_TYPE_INT32_ARRAY:
3081 dbus_int32_t *values;
3084 if (!dbus_message_iter_get_int32_array (iter, &values, &len))
3090 case DBUS_TYPE_UINT32_ARRAY:
3092 dbus_uint32_t *values;
3095 if (!dbus_message_iter_get_uint32_array (iter, &values, &len))
3101 case DBUS_TYPE_DOUBLE_ARRAY:
3106 if (!dbus_message_iter_get_double_array (iter, &values, &len))
3112 case DBUS_TYPE_STRING_ARRAY:
3117 if (!dbus_message_iter_get_string_array (iter, &values, &len))
3120 dbus_free_string_array (values);
3124 case DBUS_TYPE_DICT:
3128 if (!dbus_message_iter_get_dict (iter, &dict))
3131 dbus_dict_unref (dict);
3139 if (!dbus_message_iter_next (iter))
3147 dbus_message_iter_unref (iter);
3153 check_have_valid_message (DBusMessageLoader *loader)
3155 DBusMessage *message;
3161 if (_dbus_message_loader_get_is_corrupted (loader))
3163 _dbus_warn ("loader corrupted on message that was expected to be valid\n");
3167 message = _dbus_message_loader_pop_message (loader);
3168 if (message == NULL)
3170 _dbus_warn ("didn't load message that was expected to be valid (message not popped)\n");
3174 if (_dbus_string_get_length (&loader->data) > 0)
3176 _dbus_warn ("had leftover bytes from expected-to-be-valid single message\n");
3180 /* Verify that we're able to properly deal with the message.
3181 * For example, this would detect improper handling of messages
3182 * in nonstandard byte order.
3184 if (!check_message_handling (message))
3191 dbus_message_unref (message);
3197 check_invalid_message (DBusMessageLoader *loader)
3203 if (!_dbus_message_loader_get_is_corrupted (loader))
3205 _dbus_warn ("loader not corrupted on message that was expected to be invalid\n");
3216 check_incomplete_message (DBusMessageLoader *loader)
3218 DBusMessage *message;
3224 if (_dbus_message_loader_get_is_corrupted (loader))
3226 _dbus_warn ("loader corrupted on message that was expected to be valid (but incomplete)\n");
3230 message = _dbus_message_loader_pop_message (loader);
3231 if (message != NULL)
3233 _dbus_warn ("loaded message that was expected to be incomplete\n");
3241 dbus_message_unref (message);
3246 check_loader_results (DBusMessageLoader *loader,
3247 DBusMessageValidity validity)
3251 case _DBUS_MESSAGE_VALID:
3252 return check_have_valid_message (loader);
3253 case _DBUS_MESSAGE_INVALID:
3254 return check_invalid_message (loader);
3255 case _DBUS_MESSAGE_INCOMPLETE:
3256 return check_incomplete_message (loader);
3257 case _DBUS_MESSAGE_UNKNOWN:
3261 _dbus_assert_not_reached ("bad DBusMessageValidity");
3267 * Loads the message in the given message file.
3269 * @param filename filename to load
3270 * @param is_raw if #TRUE load as binary data, if #FALSE as message builder language
3271 * @param data string to load message into
3272 * @returns #TRUE if the message was loaded
3275 dbus_internal_do_not_use_load_message_file (const DBusString *filename,
3287 dbus_error_init (&error);
3288 if (!_dbus_file_get_contents (data, filename, &error))
3291 _dbus_string_get_const_data (filename, &s);
3292 _dbus_warn ("Could not load message file %s: %s\n", s, error.message);
3293 dbus_error_free (&error);
3299 if (!_dbus_message_data_load (data, filename))
3302 _dbus_string_get_const_data (filename, &s);
3303 _dbus_warn ("Could not load message file %s\n", s);
3316 * Tries loading the message in the given message file
3317 * and verifies that DBusMessageLoader can handle it.
3319 * @param filename filename to load
3320 * @param is_raw if #TRUE load as binary data, if #FALSE as message builder language
3321 * @param expected_validity what the message has to be like to return #TRUE
3322 * @returns #TRUE if the message has the expected validity
3325 dbus_internal_do_not_use_try_message_file (const DBusString *filename,
3327 DBusMessageValidity expected_validity)
3334 if (!_dbus_string_init (&data, _DBUS_INT_MAX))
3335 _dbus_assert_not_reached ("could not allocate string\n");
3337 if (!dbus_internal_do_not_use_load_message_file (filename, is_raw,
3341 retval = dbus_internal_do_not_use_try_message_data (&data, expected_validity);
3349 if (_dbus_string_get_length (&data) > 0)
3350 _dbus_verbose_bytes_of_string (&data, 0,
3351 _dbus_string_get_length (&data));
3353 _dbus_string_get_const_data (filename, &s);
3354 _dbus_warn ("Failed message loader test on %s\n",
3358 _dbus_string_free (&data);
3364 * Tries loading the given message data.
3367 * @param data the message data
3368 * @param expected_validity what the message has to be like to return #TRUE
3369 * @returns #TRUE if the message has the expected validity
3372 dbus_internal_do_not_use_try_message_data (const DBusString *data,
3373 DBusMessageValidity expected_validity)
3375 DBusMessageLoader *loader;
3383 /* Write the data one byte at a time */
3385 loader = _dbus_message_loader_new ();
3387 len = _dbus_string_get_length (data);
3388 for (i = 0; i < len; i++)
3392 _dbus_message_loader_get_buffer (loader, &buffer);
3393 _dbus_string_append_byte (buffer,
3394 _dbus_string_get_byte (data, i));
3395 _dbus_message_loader_return_buffer (loader, buffer, 1);
3398 if (!check_loader_results (loader, expected_validity))
3401 _dbus_message_loader_unref (loader);
3404 /* Write the data all at once */
3406 loader = _dbus_message_loader_new ();
3411 _dbus_message_loader_get_buffer (loader, &buffer);
3412 _dbus_string_copy (data, 0, buffer,
3413 _dbus_string_get_length (buffer));
3414 _dbus_message_loader_return_buffer (loader, buffer, 1);
3417 if (!check_loader_results (loader, expected_validity))
3420 _dbus_message_loader_unref (loader);
3423 /* Write the data 2 bytes at a time */
3425 loader = _dbus_message_loader_new ();
3427 len = _dbus_string_get_length (data);
3428 for (i = 0; i < len; i += 2)
3432 _dbus_message_loader_get_buffer (loader, &buffer);
3433 _dbus_string_append_byte (buffer,
3434 _dbus_string_get_byte (data, i));
3436 _dbus_string_append_byte (buffer,
3437 _dbus_string_get_byte (data, i+1));
3438 _dbus_message_loader_return_buffer (loader, buffer, 1);
3441 if (!check_loader_results (loader, expected_validity))
3444 _dbus_message_loader_unref (loader);
3452 _dbus_message_loader_unref (loader);
3458 process_test_subdir (const DBusString *test_base_dir,
3460 DBusMessageValidity validity,
3461 DBusForeachMessageFileFunc function,
3464 DBusString test_directory;
3465 DBusString filename;
3473 if (!_dbus_string_init (&test_directory, _DBUS_INT_MAX))
3474 _dbus_assert_not_reached ("didn't allocate test_directory\n");
3476 _dbus_string_init_const (&filename, subdir);
3478 if (!_dbus_string_copy (test_base_dir, 0,
3479 &test_directory, 0))
3480 _dbus_assert_not_reached ("couldn't copy test_base_dir to test_directory");
3482 if (!_dbus_concat_dir_and_file (&test_directory, &filename))
3483 _dbus_assert_not_reached ("couldn't allocate full path");
3485 _dbus_string_free (&filename);
3486 if (!_dbus_string_init (&filename, _DBUS_INT_MAX))
3487 _dbus_assert_not_reached ("didn't allocate filename string\n");
3489 dbus_error_init (&error);
3490 dir = _dbus_directory_open (&test_directory, &error);
3494 _dbus_string_get_const_data (&test_directory, &s);
3495 _dbus_warn ("Could not open %s: %s\n", s,
3497 dbus_error_free (&error);
3501 printf ("Testing:\n");
3504 while (_dbus_directory_get_next_file (dir, &filename, &error))
3506 DBusString full_path;
3509 if (!_dbus_string_init (&full_path, _DBUS_INT_MAX))
3510 _dbus_assert_not_reached ("couldn't init string");
3512 if (!_dbus_string_copy (&test_directory, 0, &full_path, 0))
3513 _dbus_assert_not_reached ("couldn't copy dir to full_path");
3515 if (!_dbus_concat_dir_and_file (&full_path, &filename))
3516 _dbus_assert_not_reached ("couldn't concat file to dir");
3518 if (_dbus_string_ends_with_c_str (&filename, ".message"))
3520 else if (_dbus_string_ends_with_c_str (&filename, ".message-raw"))
3524 const char *filename_c;
3525 _dbus_string_get_const_data (&filename, &filename_c);
3526 _dbus_verbose ("Skipping non-.message file %s\n",
3528 _dbus_string_free (&full_path);
3534 _dbus_string_get_const_data (&filename, &s);
3535 printf (" %s\n", s);
3538 _dbus_verbose (" expecting %s\n",
3539 validity == _DBUS_MESSAGE_VALID ? "valid" :
3540 (validity == _DBUS_MESSAGE_INVALID ? "invalid" :
3541 (validity == _DBUS_MESSAGE_INCOMPLETE ? "incomplete" : "unknown")));
3543 if (! (*function) (&full_path, is_raw, validity, user_data))
3545 _dbus_string_free (&full_path);
3549 _dbus_string_free (&full_path);
3552 if (dbus_error_is_set (&error))
3555 _dbus_string_get_const_data (&test_directory, &s);
3556 _dbus_warn ("Could not get next file in %s: %s\n",
3558 dbus_error_free (&error);
3567 _dbus_directory_close (dir);
3568 _dbus_string_free (&test_directory);
3569 _dbus_string_free (&filename);
3575 * Runs the given function on every message file in the test suite.
3576 * The function should return #FALSE on test failure or fatal error.
3578 * @param test_data_dir root dir of the test suite data files (top_srcdir/test/data)
3579 * @param func the function to run
3580 * @param user_data data for function
3581 * @returns #FALSE if there's a failure
3584 dbus_internal_do_not_use_foreach_message_file (const char *test_data_dir,
3585 DBusForeachMessageFileFunc func,
3588 DBusString test_directory;
3593 _dbus_string_init_const (&test_directory, test_data_dir);
3595 if (!process_test_subdir (&test_directory, "valid-messages",
3596 _DBUS_MESSAGE_VALID, func, user_data))
3599 if (!process_test_subdir (&test_directory, "invalid-messages",
3600 _DBUS_MESSAGE_INVALID, func, user_data))
3603 if (!process_test_subdir (&test_directory, "incomplete-messages",
3604 _DBUS_MESSAGE_INCOMPLETE, func, user_data))
3611 _dbus_string_free (&test_directory);
3617 verify_test_message (DBusMessage *message)
3619 dbus_int32_t our_int;
3622 dbus_bool_t our_bool;
3624 if (!dbus_message_get_args (message, NULL,
3625 DBUS_TYPE_INT32, &our_int,
3626 DBUS_TYPE_STRING, &our_str,
3627 DBUS_TYPE_DOUBLE, &our_double,
3628 DBUS_TYPE_BOOLEAN, &our_bool,
3630 _dbus_assert_not_reached ("Could not get arguments");
3632 if (our_int != -0x12345678)
3633 _dbus_assert_not_reached ("integers differ!");
3635 if (our_double != 3.14159)
3636 _dbus_assert_not_reached ("doubles differ!");
3638 if (strcmp (our_str, "Test string") != 0)
3639 _dbus_assert_not_reached ("strings differ!");
3642 _dbus_assert_not_reached ("booleans differ");
3644 dbus_free (our_str);
3648 * @ingroup DBusMessageInternals
3649 * Unit test for DBusMessage.
3651 * @returns #TRUE on success.
3654 _dbus_message_test (const char *test_data_dir)
3656 DBusMessage *message;
3657 DBusMessageLoader *loader;
3664 /* Test the vararg functions */
3665 message = dbus_message_new ("org.freedesktop.DBus.Test", "testMessage");
3666 _dbus_message_set_serial (message, 1);
3667 dbus_message_append_args (message,
3668 DBUS_TYPE_INT32, -0x12345678,
3669 DBUS_TYPE_STRING, "Test string",
3670 DBUS_TYPE_DOUBLE, 3.14159,
3671 DBUS_TYPE_BOOLEAN, TRUE,
3673 _dbus_verbose_bytes_of_string (&message->header, 0,
3674 _dbus_string_get_length (&message->header));
3675 _dbus_verbose_bytes_of_string (&message->body, 0,
3676 _dbus_string_get_length (&message->body));
3678 verify_test_message (message);
3680 copy = dbus_message_copy (message);
3682 _dbus_assert (message->client_serial == copy->client_serial);
3683 _dbus_assert (message->reply_serial == copy->reply_serial);
3684 _dbus_assert (message->header_padding == copy->header_padding);
3686 _dbus_assert (_dbus_string_get_length (&message->header) ==
3687 _dbus_string_get_length (©->header));
3689 _dbus_assert (_dbus_string_get_length (&message->body) ==
3690 _dbus_string_get_length (©->body));
3692 verify_test_message (copy);
3694 name1 = dbus_message_get_name (message);
3695 name2 = dbus_message_get_name (copy);
3697 _dbus_assert (strcmp (name1, name2) == 0);
3699 dbus_message_unref (message);
3700 dbus_message_unref (copy);
3702 message = dbus_message_new ("org.freedesktop.DBus.Test", "testMessage");
3703 _dbus_message_set_serial (message, 1);
3704 dbus_message_set_reply_serial (message, 0x12345678);
3706 dbus_message_append_string (message, "Test string");
3707 dbus_message_append_int32 (message, -0x12345678);
3708 dbus_message_append_uint32 (message, 0xedd1e);
3709 dbus_message_append_double (message, 3.14159);
3711 message_iter_test (message);
3713 /* Message loader test */
3714 _dbus_message_lock (message);
3715 loader = _dbus_message_loader_new ();
3717 /* Write the header data one byte at a time */
3718 _dbus_string_get_const_data (&message->header, &data);
3719 for (i = 0; i < _dbus_string_get_length (&message->header); i++)
3723 _dbus_message_loader_get_buffer (loader, &buffer);
3724 _dbus_string_append_byte (buffer, data[i]);
3725 _dbus_message_loader_return_buffer (loader, buffer, 1);
3728 /* Write the body data one byte at a time */
3729 _dbus_string_get_const_data (&message->body, &data);
3730 for (i = 0; i < _dbus_string_get_length (&message->body); i++)
3734 _dbus_message_loader_get_buffer (loader, &buffer);
3735 _dbus_string_append_byte (buffer, data[i]);
3736 _dbus_message_loader_return_buffer (loader, buffer, 1);
3739 dbus_message_unref (message);
3741 /* Now pop back the message */
3742 if (_dbus_message_loader_get_is_corrupted (loader))
3743 _dbus_assert_not_reached ("message loader corrupted");
3745 message = _dbus_message_loader_pop_message (loader);
3747 _dbus_assert_not_reached ("received a NULL message");
3749 if (dbus_message_get_reply_serial (message) != 0x12345678)
3750 _dbus_assert_not_reached ("reply serial fields differ");
3752 message_iter_test (message);
3754 dbus_message_unref (message);
3755 _dbus_message_loader_unref (loader);
3757 /* Now load every message in test_data_dir if we have one */
3758 if (test_data_dir == NULL)
3761 return dbus_internal_do_not_use_foreach_message_file (test_data_dir,
3762 (DBusForeachMessageFileFunc)
3763 dbus_internal_do_not_use_try_message_file,
3767 #endif /* DBUS_BUILD_TESTS */