X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dbus%2Fdbus-message.c;h=272592e8367bfa723bcd37540bdb07ad34797ac5;hb=3171383ce9bac0c2718da4ce288db890d5d7bfda;hp=696b25038cee78ea65c70cdffd85e1c947e9aa0f;hpb=93f433a17a0aabff91a0384bf9c4f99c9cf30ae1;p=platform%2Fupstream%2Fdbus.git diff --git a/dbus/dbus-message.c b/dbus/dbus-message.c index 696b250..272592e 100644 --- a/dbus/dbus-message.c +++ b/dbus/dbus-message.c @@ -1,11 +1,11 @@ -/* -*- mode: C; c-file-style: "gnu" -*- */ +/* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */ /* dbus-message.c DBusMessage object * - * Copyright (C) 2002, 2003 Red Hat Inc. + * Copyright (C) 2002, 2003, 2004, 2005 Red Hat Inc. * Copyright (C) 2002, 2003 CodeFactory AB * - * Licensed under the Academic Free License version 2.0 - * + * Licensed under the Academic Free License version 2.1 + * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or @@ -15,23 +15,28 @@ * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. - * + * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software - * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * */ #include "dbus-internals.h" -#include "dbus-marshal.h" -#include "dbus-message.h" -#include "dbus-message-internal.h" +#include "dbus-marshal-recursive.h" +#include "dbus-marshal-validate.h" +#include "dbus-marshal-byteswap.h" +#include "dbus-marshal-header.h" +#include "dbus-signature.h" +#include "dbus-message-private.h" +#include "dbus-object-tree.h" #include "dbus-memory.h" #include "dbus-list.h" -#include "dbus-message-builder.h" -#include "dbus-dataslot.h" +#include "dbus-threads-internal.h" #include +static void dbus_message_finalize (DBusMessage *message); + /** * @defgroup DBusMessageInternals DBusMessage implementation details * @ingroup DBusInternals @@ -42,76 +47,17 @@ * @{ */ -/** - * Cached information about a header field in the message +/* Not thread locked, but strictly const/read-only so should be OK */ -typedef struct -{ - int name_offset; /**< Offset to name of field */ - int value_offset; /**< Offset to value of field */ -} HeaderField; - -/** Offset to byte order from start of header */ -#define BYTE_ORDER_OFFSET 0 -/** Offset to type from start of header */ -#define TYPE_OFFSET 1 -/** Offset to flags from start of header */ -#define FLAGS_OFFSET 2 -/** Offset to version from start of header */ -#define VERSION_OFFSET 3 -/** Offset to header length from start of header */ -#define HEADER_LENGTH_OFFSET 4 -/** Offset to body length from start of header */ -#define BODY_LENGTH_OFFSET 8 -/** Offset to client serial from start of header */ -#define CLIENT_SERIAL_OFFSET 12 - +/** An static string representing an empty signature */ +_DBUS_STRING_DEFINE_STATIC(_dbus_empty_signature_str, ""); -/** - * @brief Internals of DBusMessage - * - * Object representing a message received from or to be sent to - * another application. This is an opaque object, all members - * are private. +/* these have wacky values to help trap uninitialized iterators; + * but has to fit in 3 bits */ -struct DBusMessage -{ - DBusAtomic refcount; /**< Reference count */ - - DBusString header; /**< Header network data, stored - * separately from body so we can - * independently realloc it. - */ - - HeaderField header_fields[DBUS_HEADER_FIELD_LAST + 1]; /**< Track the location - * of each field in "header" - */ - - dbus_uint32_t client_serial; /**< Cached client serial value for speed */ - dbus_uint32_t reply_serial; /**< Cached reply serial value for speed */ - - int header_padding; /**< bytes of alignment in header */ - - DBusString body; /**< Body network data. */ - - char byte_order; /**< Message byte order. */ - - DBusList *size_counters; /**< 0-N DBusCounter used to track message size. */ - long size_counter_delta; /**< Size we incremented the size counters by. */ - - dbus_uint32_t changed_stamp; /**< Incremented when iterators are invalidated. */ - - unsigned int locked : 1; /**< Message being sent, no modifications allowed. */ - - DBusDataSlotList slot_list; /**< Data stored by allocated integer ID */ - - DBusString signature; /**< Signature */ -}; - enum { - DBUS_MESSAGE_ITER_TYPE_MESSAGE, - DBUS_MESSAGE_ITER_TYPE_ARRAY, - DBUS_MESSAGE_ITER_TYPE_DICT + DBUS_MESSAGE_ITER_TYPE_READER = 3, + DBUS_MESSAGE_ITER_TYPE_WRITER = 7 }; /** typedef for internals of message iterator */ @@ -119,34 +65,84 @@ typedef struct DBusMessageRealIter DBusMessageRealIter; /** * @brief Internals of DBusMessageIter - * + * * Object representing a position in a message. All fields are internal. */ struct DBusMessageRealIter { - DBusMessageRealIter *parent_iter; /**< parent iter, or NULL */ DBusMessage *message; /**< Message used */ - dbus_uint32_t changed_stamp; /**< stamp to detect invalid iters */ + dbus_uint32_t changed_stamp : CHANGED_STAMP_BITS; /**< stamp to detect invalid iters */ + dbus_uint32_t iter_type : 3; /**< whether this is a reader or writer iter */ + dbus_uint32_t sig_refcount : 8; /**< depth of open_signature() */ + union + { + DBusTypeWriter writer; /**< writer */ + DBusTypeReader reader; /**< reader */ + } u; /**< the type writer or reader that does all the work */ +}; + +static void +get_const_signature (DBusHeader *header, + const DBusString **type_str_p, + int *type_pos_p) +{ + if (_dbus_header_get_field_raw (header, + DBUS_HEADER_FIELD_SIGNATURE, + type_str_p, + type_pos_p)) + { + *type_pos_p += 1; /* skip the signature length which is 1 byte */ + } + else + { + *type_str_p = &_dbus_empty_signature_str; + *type_pos_p = 0; + } +} + +/** + * Swaps the message to compiler byte order if required + * + * @param message the message + */ +static void +_dbus_message_byteswap (DBusMessage *message) +{ + const DBusString *type_str; + int type_pos; - /* This is an int instead of an enum to get a guaranteed size for the dummy: */ - int type; /**< type of iter */ + if (message->byte_order == DBUS_COMPILER_BYTE_ORDER) + return; + + _dbus_verbose ("Swapping message into compiler byte order\n"); - int pos; /**< Current position in the string */ - int end; /**< position right after the container */ - int container_start; /**< offset of the start of the container */ - int container_length_pos; /**< offset of the length of the container */ + get_const_signature (&message->header, &type_str, &type_pos); - int wrote_dict_key; /**< whether we wrote the dict key for the current dict element */ + _dbus_marshal_byteswap (type_str, type_pos, + message->byte_order, + DBUS_COMPILER_BYTE_ORDER, + &message->body, 0); - int array_type_pos; /**< pointer to the position of the array element type */ - int array_type_done; /**< TRUE if the array type is fully finished */ -}; + message->byte_order = DBUS_COMPILER_BYTE_ORDER; + + _dbus_header_byteswap (&message->header, DBUS_COMPILER_BYTE_ORDER); +} + +/** byte-swap the message if it doesn't match our byte order. + * Called only when we need the message in our own byte order, + * normally when reading arrays of integers or doubles. + * Otherwise should not be called since it would do needless + * work. + */ +#define ensure_byte_order(message) \ + if (message->byte_order != DBUS_COMPILER_BYTE_ORDER) \ + _dbus_message_byteswap (message) /** * Gets the data to be sent over the network for this message. * The header and then the body should be written out. * This function is guaranteed to always return the same - * data once a message is locked (with _dbus_message_lock()). + * data once a message is locked (with dbus_message_lock()). * * @param message the message. * @param header return location for message header data. @@ -158,1043 +154,857 @@ _dbus_message_get_network_data (DBusMessage *message, const DBusString **body) { _dbus_assert (message->locked); - - *header = &message->header; + + *header = &message->header.data; *body = &message->body; } -static void -clear_header_padding (DBusMessage *message) +/** + * Sets the serial number of a message. + * This can only be done once on a message. + * + * DBusConnection will automatically set the serial to an appropriate value + * when the message is sent; this function is only needed when encapsulating + * messages in another protocol, or otherwise bypassing DBusConnection. + * + * @param message the message + * @param serial the serial + */ +void +dbus_message_set_serial (DBusMessage *message, + dbus_uint32_t serial) { - _dbus_string_shorten (&message->header, - message->header_padding); - message->header_padding = 0; -} + _dbus_return_if_fail (message != NULL); + _dbus_return_if_fail (!message->locked); -static dbus_bool_t -append_header_padding (DBusMessage *message) + _dbus_header_set_serial (&message->header, serial); +} + +/** + * Adds a counter to be incremented immediately with the + * size of this message, and decremented by the size + * of this message when this message if finalized. + * The link contains a counter with its refcount already + * incremented, but the counter itself not incremented. + * Ownership of link and counter refcount is passed to + * the message. + * + * @param message the message + * @param link link with counter as data + */ +void +_dbus_message_add_size_counter_link (DBusMessage *message, + DBusList *link) { - int old_len; - old_len = _dbus_string_get_length (&message->header); - if (!_dbus_string_align_length (&message->header, 8)) - return FALSE; + /* right now we don't recompute the delta when message + * size changes, and that's OK for current purposes + * I think, but could be important to change later. + * Do recompute it whenever there are no outstanding counters, + * since it's basically free. + */ + if (message->size_counters == NULL) + { + message->size_counter_delta = + _dbus_string_get_length (&message->header.data) + + _dbus_string_get_length (&message->body); + +#if 0 + _dbus_verbose ("message has size %ld\n", + message->size_counter_delta); +#endif + } - message->header_padding = _dbus_string_get_length (&message->header) - old_len; + _dbus_list_append_link (&message->size_counters, link); - return TRUE; + _dbus_counter_adjust (link->data, message->size_counter_delta); } -#ifdef DBUS_BUILD_TESTS -/* tests-only until it's actually used */ -static dbus_int32_t -get_int_field (DBusMessage *message, - int field) +/** + * Adds a counter to be incremented immediately with the + * size of this message, and decremented by the size + * of this message when this message if finalized. + * + * @param message the message + * @param counter the counter + * @returns #FALSE if no memory + */ +dbus_bool_t +_dbus_message_add_size_counter (DBusMessage *message, + DBusCounter *counter) { - int offset; + DBusList *link; - _dbus_assert (field <= DBUS_HEADER_FIELD_LAST); - - offset = message->header_fields[field].value_offset; - - if (offset < 0) - return -1; /* useless if -1 is a valid value of course */ - - return _dbus_demarshal_int32 (&message->header, - message->byte_order, - offset, - NULL); -} -#endif + link = _dbus_list_alloc_link (counter); + if (link == NULL) + return FALSE; -static dbus_uint32_t -get_uint_field (DBusMessage *message, - int field) -{ - int offset; - - _dbus_assert (field <= DBUS_HEADER_FIELD_LAST); - - offset = message->header_fields[field].value_offset; - - if (offset < 0) - return 0; /* useless if 0 is a valid value of course */ - - return _dbus_demarshal_uint32 (&message->header, - message->byte_order, - offset, - NULL); + _dbus_counter_ref (counter); + _dbus_message_add_size_counter_link (message, link); + + return TRUE; } -static const char* -get_string_field (DBusMessage *message, - int field, - int *len) +/** + * Removes a counter tracking the size of this message, and decrements + * the counter by the size of this message. + * + * @param message the message + * @param link_return return the link used + * @param counter the counter + */ +void +_dbus_message_remove_size_counter (DBusMessage *message, + DBusCounter *counter, + DBusList **link_return) { - int offset; - const char *data; + DBusList *link; - offset = message->header_fields[field].value_offset; + link = _dbus_list_find_last (&message->size_counters, + counter); + _dbus_assert (link != NULL); - _dbus_assert (field <= DBUS_HEADER_FIELD_LAST); - - if (offset < 0) - return NULL; + _dbus_list_unlink (&message->size_counters, + link); + if (link_return) + *link_return = link; + else + _dbus_list_free_link (link); - /* offset points to string length, string data follows it */ - /* FIXME _dbus_demarshal_const_string() that returned - * a reference to the string plus its len might be nice. - */ - - if (len) - *len = _dbus_demarshal_uint32 (&message->header, - message->byte_order, - offset, - NULL); + _dbus_counter_adjust (counter, - message->size_counter_delta); - data = _dbus_string_get_const_data (&message->header); - - return data + (offset + 4); + _dbus_counter_unref (counter); } -/* returns FALSE if no memory, TRUE with NULL path if no field */ -static dbus_bool_t -get_path_field_decomposed (DBusMessage *message, - int field, - char ***path) +/** + * Locks a message. Allows checking that applications don't keep a + * reference to a message in the outgoing queue and change it + * underneath us. Messages are locked when they enter the outgoing + * queue (dbus_connection_send_message()), and the library complains + * if the message is modified while locked. This function may also + * called externally, for applications wrapping D-Bus in another protocol. + * + * @param message the message to lock. + */ +void +dbus_message_lock (DBusMessage *message) { - int offset; + if (!message->locked) + { + _dbus_header_update_lengths (&message->header, + _dbus_string_get_length (&message->body)); - offset = message->header_fields[field].value_offset; + /* must have a signature if you have a body */ + _dbus_assert (_dbus_string_get_length (&message->body) == 0 || + dbus_message_get_signature (message) != NULL); - _dbus_assert (field <= DBUS_HEADER_FIELD_LAST); - - if (offset < 0) - { - *path = NULL; - return TRUE; + message->locked = TRUE; } - - return _dbus_demarshal_object_path (&message->header, - message->byte_order, - offset, - NULL, - path, NULL); } -#ifdef DBUS_BUILD_TESTS static dbus_bool_t -append_int_field (DBusMessage *message, - int field, - int value) +set_or_delete_string_field (DBusMessage *message, + int field, + int typecode, + const char *value) { - _dbus_assert (!message->locked); - - clear_header_padding (message); - - message->header_fields[field].name_offset = - _dbus_string_get_length (&message->header); - - if (!_dbus_string_append_byte (&message->header, field)) - goto failed; - - if (!_dbus_string_append_byte (&message->header, DBUS_TYPE_INT32)) - goto failed; - - if (!_dbus_string_align_length (&message->header, 4)) - goto failed; - - message->header_fields[field].value_offset = - _dbus_string_get_length (&message->header); - - if (!_dbus_marshal_int32 (&message->header, message->byte_order, - value)) - goto failed; + if (value == NULL) + return _dbus_header_delete_field (&message->header, field); + else + return _dbus_header_set_field_basic (&message->header, + field, + typecode, + &value); +} - if (!append_header_padding (message)) - goto failed; - - return TRUE; - - failed: - _dbus_string_set_length (&message->header, - message->header_fields[field].name_offset); - message->header_fields[field].name_offset = -1; - message->header_fields[field].value_offset = -1; +#if 0 +/* Probably we don't need to use this */ +/** + * Sets the signature of the message, i.e. the arguments in the + * message payload. The signature includes only "in" arguments for + * #DBUS_MESSAGE_TYPE_METHOD_CALL and only "out" arguments for + * #DBUS_MESSAGE_TYPE_METHOD_RETURN, so is slightly different from + * what you might expect (it does not include the signature of the + * entire C++-style method). + * + * The signature is a string made up of type codes such as + * #DBUS_TYPE_INT32. The string is terminated with nul (nul is also + * the value of #DBUS_TYPE_INVALID). The macros such as + * #DBUS_TYPE_INT32 evaluate to integers; to assemble a signature you + * may find it useful to use the string forms, such as + * #DBUS_TYPE_INT32_AS_STRING. + * + * An "unset" or #NULL signature is considered the same as an empty + * signature. In fact dbus_message_get_signature() will never return + * #NULL. + * + * @param message the message + * @param signature the type signature or #NULL to unset + * @returns #FALSE if no memory + */ +static dbus_bool_t +_dbus_message_set_signature (DBusMessage *message, + const char *signature) +{ + _dbus_return_val_if_fail (message != NULL, FALSE); + _dbus_return_val_if_fail (!message->locked, FALSE); + _dbus_return_val_if_fail (signature == NULL || + _dbus_check_is_valid_signature (signature)); + /* can't delete the signature if you have a message body */ + _dbus_return_val_if_fail (_dbus_string_get_length (&message->body) == 0 || + signature != NULL); - /* this must succeed because it was allocated on function entry and - * DBusString doesn't ever realloc smaller - */ - if (!append_header_padding (message)) - _dbus_assert_not_reached ("failed to reappend header padding"); - return FALSE; + return set_or_delete_string_field (message, + DBUS_HEADER_FIELD_SIGNATURE, + DBUS_TYPE_SIGNATURE, + signature); } #endif -static dbus_bool_t -append_uint_field (DBusMessage *message, - int field, - int value) +/* Message Cache + * + * We cache some DBusMessage to reduce the overhead of allocating + * them. In my profiling this consistently made about an 8% + * difference. It avoids the malloc for the message, the malloc for + * the slot list, the malloc for the header string and body string, + * and the associated free() calls. It does introduce another global + * lock which could be a performance issue in certain cases. + * + * For the echo client/server the round trip time goes from around + * .000077 to .000069 with the message cache on my laptop. The sysprof + * change is as follows (numbers are cumulative percentage): + * + * with message cache implemented as array as it is now (0.000069 per): + * new_empty_header 1.46 + * mutex_lock 0.56 # i.e. _DBUS_LOCK(message_cache) + * mutex_unlock 0.25 + * self 0.41 + * unref 2.24 + * self 0.68 + * list_clear 0.43 + * mutex_lock 0.33 # i.e. _DBUS_LOCK(message_cache) + * mutex_unlock 0.25 + * + * with message cache implemented as list (0.000070 per roundtrip): + * new_empty_header 2.72 + * list_pop_first 1.88 + * unref 3.3 + * list_prepend 1.63 + * + * without cache (0.000077 per roundtrip): + * new_empty_header 6.7 + * string_init_preallocated 3.43 + * dbus_malloc 2.43 + * dbus_malloc0 2.59 + * + * unref 4.02 + * string_free 1.82 + * dbus_free 1.63 + * dbus_free 0.71 + * + * If you implement the message_cache with a list, the primary reason + * it's slower is that you add another thread lock (on the DBusList + * mempool). + */ + +/** Avoid caching huge messages */ +#define MAX_MESSAGE_SIZE_TO_CACHE 10 * _DBUS_ONE_KILOBYTE + +/** Avoid caching too many messages */ +#define MAX_MESSAGE_CACHE_SIZE 5 + +_DBUS_DEFINE_GLOBAL_LOCK (message_cache); +static DBusMessage *message_cache[MAX_MESSAGE_CACHE_SIZE]; +static int message_cache_count = 0; +static dbus_bool_t message_cache_shutdown_registered = FALSE; + +static void +dbus_message_cache_shutdown (void *data) { - _dbus_assert (!message->locked); + int i; - clear_header_padding (message); - - message->header_fields[field].name_offset = - _dbus_string_get_length (&message->header); - - if (!_dbus_string_append_byte (&message->header, field)) - goto failed; + _DBUS_LOCK (message_cache); - if (!_dbus_string_append_byte (&message->header, DBUS_TYPE_UINT32)) - goto failed; + i = 0; + while (i < MAX_MESSAGE_CACHE_SIZE) + { + if (message_cache[i]) + dbus_message_finalize (message_cache[i]); - if (!_dbus_string_align_length (&message->header, 4)) - goto failed; - - message->header_fields[field].value_offset = - _dbus_string_get_length (&message->header); - - if (!_dbus_marshal_uint32 (&message->header, message->byte_order, - value)) - goto failed; + ++i; + } - if (!append_header_padding (message)) - goto failed; - - return TRUE; - - failed: - _dbus_string_set_length (&message->header, - message->header_fields[field].name_offset); - message->header_fields[field].name_offset = -1; - message->header_fields[field].value_offset = -1; + message_cache_count = 0; + message_cache_shutdown_registered = FALSE; - /* this must succeed because it was allocated on function entry and - * DBusString doesn't ever realloc smaller - */ - if (!append_header_padding (message)) - _dbus_assert_not_reached ("failed to reappend header padding"); - return FALSE; + _DBUS_UNLOCK (message_cache); } -#define MAX_BYTES_OVERHEAD_TO_APPEND_A_STRING (1 + 1 + 3 + 1 + 8) -static dbus_bool_t -append_string_field (DBusMessage *message, - int field, - int type, - const char *value) +/** + * Tries to get a message from the message cache. The retrieved + * message will have junk in it, so it still needs to be cleared out + * in dbus_message_new_empty_header() + * + * @returns the message, or #NULL if none cached + */ +static DBusMessage* +dbus_message_get_cached (void) { - _dbus_assert (!message->locked); + DBusMessage *message; + int i; - clear_header_padding (message); - - message->header_fields[field].name_offset = - _dbus_string_get_length (&message->header); - - if (!_dbus_string_append_byte (&message->header, field)) - goto failed; - - if (!_dbus_string_append_byte (&message->header, type)) - goto failed; + message = NULL; - if (!_dbus_string_align_length (&message->header, 4)) - goto failed; - - message->header_fields[field].value_offset = - _dbus_string_get_length (&message->header); - - if (!_dbus_marshal_string (&message->header, message->byte_order, - value)) - goto failed; + _DBUS_LOCK (message_cache); - if (!append_header_padding (message)) - goto failed; - - return TRUE; - - failed: - _dbus_string_set_length (&message->header, - message->header_fields[field].name_offset); - message->header_fields[field].name_offset = -1; - message->header_fields[field].value_offset = -1; + _dbus_assert (message_cache_count >= 0); + + if (message_cache_count == 0) + { + _DBUS_UNLOCK (message_cache); + return NULL; + } - /* this must succeed because it was allocated on function entry and - * DBusString doesn't ever realloc smaller + /* This is not necessarily true unless count > 0, and + * message_cache is uninitialized until the shutdown is + * registered */ - if (!append_header_padding (message)) - _dbus_assert_not_reached ("failed to reappend header padding"); - - return FALSE; -} + _dbus_assert (message_cache_shutdown_registered); -static int -get_type_alignment (int type) -{ - int alignment; - - switch (type) + i = 0; + while (i < MAX_MESSAGE_CACHE_SIZE) { - case DBUS_TYPE_NIL: - case DBUS_TYPE_BYTE: - case DBUS_TYPE_BOOLEAN: - alignment = 0; - break; - - case DBUS_TYPE_INT32: - case DBUS_TYPE_UINT32: - case DBUS_TYPE_STRING: - case DBUS_TYPE_OBJECT_PATH: - /* These are aligned 4 because they have a length as the - * first field; - */ - case DBUS_TYPE_CUSTOM: - case DBUS_TYPE_DICT: - alignment = 4; - break; - - case DBUS_TYPE_INT64: - case DBUS_TYPE_UINT64: - case DBUS_TYPE_DOUBLE: - alignment = 8; - break; - - case DBUS_TYPE_ARRAY: - _dbus_assert_not_reached ("passed an ARRAY type to get_type_alignment()"); - break; - - case DBUS_TYPE_INVALID: - default: - _dbus_assert_not_reached ("passed an invalid or unknown type to get_type_alignment()"); - break; + if (message_cache[i]) + { + message = message_cache[i]; + message_cache[i] = NULL; + message_cache_count -= 1; + break; + } + ++i; } + _dbus_assert (message_cache_count >= 0); + _dbus_assert (i < MAX_MESSAGE_CACHE_SIZE); + _dbus_assert (message != NULL); - return alignment; + _dbus_assert (message->refcount.value == 0); + _dbus_assert (message->size_counters == NULL); + + _DBUS_UNLOCK (message_cache); + + return message; } -static dbus_bool_t -iterate_one_field (const DBusString *str, - int byte_order, - int name_offset, - int *next_offset_p, - int *field_name_p, - DBusString *append_copy_to, - int *copy_name_offset_p, - int *copy_value_offset_p) +static void +free_size_counter (void *element, + void *data) { - int name, type, array_type; - int alignment; - int type_len; - int type_pos; - int value_pos; - int value_len; - int value_end; - int pos; - - _dbus_verbose ("%s: name_offset=%d, append to %p\n", - _DBUS_FUNCTION_NAME, name_offset, append_copy_to); - - pos = name_offset; - - name = _dbus_string_get_byte (str, name_offset); - pos++; + DBusCounter *counter = element; + DBusMessage *message = data; - type_pos = pos; - type = _dbus_string_get_byte (str, type_pos); - pos++; - type_len = 1; + _dbus_counter_adjust (counter, - message->size_counter_delta); - array_type = type; - /* find out the type of our array */ - while (array_type == DBUS_TYPE_ARRAY) - { - pos++; - type_len++; - array_type = _dbus_string_get_byte (str, pos); - } + _dbus_counter_unref (counter); +} - _dbus_verbose ("%s: name %d, type '%c' %d at %d len %d, array type '%c' %d\n", - _DBUS_FUNCTION_NAME, - name, type, type, type_pos, type_len, array_type, array_type); +/** + * Tries to cache a message, otherwise finalize it. + * + * @param message the message + */ +static void +dbus_message_cache_or_finalize (DBusMessage *message) +{ + dbus_bool_t was_cached; + int i; -#ifndef DBUS_DISABLE_ASSERT - if (!_dbus_type_is_valid (array_type)) - { - _dbus_warn ("type '%c' %d is not valid in %s\n", - array_type, array_type, _DBUS_FUNCTION_NAME); - _dbus_assert_not_reached ("invalid type"); - } -#endif - - alignment = get_type_alignment (array_type); - - if (alignment > 0) - pos = _DBUS_ALIGN_VALUE (pos, alignment); + _dbus_assert (message->refcount.value == 0); - _dbus_verbose ("%s: alignment %d value at pos %d\n", - _DBUS_FUNCTION_NAME, alignment, pos); - - /* pos now points to our value */ - if (!_dbus_marshal_get_arg_end_pos (str, byte_order, - type, pos, &value_end)) - _dbus_assert_not_reached ("failed to get the byte after this header"); + /* This calls application code and has to be done first thing + * without holding the lock + */ + _dbus_data_slot_list_clear (&message->slot_list); - value_pos = pos; - value_len = value_end - value_pos; + _dbus_list_foreach (&message->size_counters, + free_size_counter, message); + _dbus_list_clear (&message->size_counters); - _dbus_verbose ("%s: value_pos %d value_len %d value_end %d\n", - _DBUS_FUNCTION_NAME, value_pos, value_len, value_end); - - if (next_offset_p) - *next_offset_p = pos + value_len; + was_cached = FALSE; - if (field_name_p) - *field_name_p = name; + _DBUS_LOCK (message_cache); - if (append_copy_to) + if (!message_cache_shutdown_registered) { - int orig_len; + _dbus_assert (message_cache_count == 0); - orig_len = _dbus_string_get_length (append_copy_to); + if (!_dbus_register_shutdown_func (dbus_message_cache_shutdown, NULL)) + goto out; - if (copy_name_offset_p) - *copy_name_offset_p = orig_len; - - if (!_dbus_string_append_byte (append_copy_to, name)) - goto failed_copy; + i = 0; + while (i < MAX_MESSAGE_CACHE_SIZE) + { + message_cache[i] = NULL; + ++i; + } - if (!_dbus_string_copy_len (str, type_pos, type_len, - append_copy_to, - _dbus_string_get_length (append_copy_to))) - goto failed_copy; + message_cache_shutdown_registered = TRUE; + } - if (!_dbus_string_align_length (append_copy_to, alignment)) - goto failed_copy; + _dbus_assert (message_cache_count >= 0); - if (copy_value_offset_p) - *copy_value_offset_p = _dbus_string_get_length (append_copy_to); - - if (!_dbus_string_copy_len (str, value_pos, value_len, - append_copy_to, - _dbus_string_get_length (append_copy_to))) - goto failed_copy; - - return TRUE; + if ((_dbus_string_get_length (&message->header.data) + + _dbus_string_get_length (&message->body)) > + MAX_MESSAGE_SIZE_TO_CACHE) + goto out; - failed_copy: - _dbus_verbose ("%s: Failed copying old fields to new string\n", - _DBUS_FUNCTION_NAME); - _dbus_string_set_length (append_copy_to, orig_len); - return FALSE; - } - else - return TRUE; -} + if (message_cache_count >= MAX_MESSAGE_CACHE_SIZE) + goto out; -#ifndef DBUS_DISABLE_ASSERT -static void -verify_header_fields (DBusMessage *message) -{ - int i; + /* Find empty slot */ i = 0; - while (i < DBUS_HEADER_FIELD_LAST) - { - if (message->header_fields[i].name_offset >= 0) - _dbus_assert (_dbus_string_get_byte (&message->header, - message->header_fields[i].name_offset) == - i); - ++i; - } -} -#else /* DBUS_DISABLE_ASSERT */ -#define verify_header_fields(x) -#endif /* DBUS_DISABLE_ASSERT */ + while (message_cache[i] != NULL) + ++i; -/* In this function we delete one field and re-align all the fields - * following it. - */ -static dbus_bool_t -delete_one_and_re_align (DBusMessage *message, - int name_offset_to_delete) -{ - DBusString copy; - int new_fields_front_padding; - int next_offset; - int field_name; - dbus_bool_t retval; - HeaderField new_header_fields[DBUS_HEADER_FIELD_LAST]; - - _dbus_assert (name_offset_to_delete < _dbus_string_get_length (&message->header)); - verify_header_fields (message); + _dbus_assert (i < MAX_MESSAGE_CACHE_SIZE); - _dbus_verbose ("%s: Deleting one field at offset %d\n", - _DBUS_FUNCTION_NAME, - name_offset_to_delete); - - retval = FALSE; + _dbus_assert (message_cache[i] == NULL); + message_cache[i] = message; + message_cache_count += 1; + was_cached = TRUE; +#ifndef DBUS_DISABLE_CHECKS + message->in_cache = TRUE; +#endif - clear_header_padding (message); - - if (!_dbus_string_init_preallocated (©, - _dbus_string_get_length (&message->header) - - name_offset_to_delete + 8)) - { - _dbus_verbose ("%s: Failed to init string to hold copy of fields\n", - _DBUS_FUNCTION_NAME); - goto out_0; - } + out: + _dbus_assert (message->refcount.value == 0); - /* Align the name offset of the first field in the same way it's - * aligned in the real header - */ - new_fields_front_padding = name_offset_to_delete % 8; - - if (!_dbus_string_insert_bytes (©, 0, new_fields_front_padding, - '\0')) - _dbus_assert_not_reached ("Should not have failed to insert bytes into preallocated string\n"); - - memcpy (new_header_fields, message->header_fields, - sizeof (new_header_fields)); + _DBUS_UNLOCK (message_cache); - /* Now just re-marshal each field in the header to our temporary - * buffer, skipping the first one. The tricky part is that the - * fields are padded as if for previous_name_offset, but are in fact - * at unaligned_name_offset - */ - - if (!iterate_one_field (&message->header, - message->byte_order, - name_offset_to_delete, - &next_offset, - &field_name, NULL, NULL, NULL)) - _dbus_assert_not_reached ("shouldn't have failed to alloc memory to skip the deleted field"); + if (!was_cached) + dbus_message_finalize (message); +} - if (field_name < DBUS_HEADER_FIELD_LAST) +#ifndef DBUS_DISABLE_CHECKS +static dbus_bool_t +_dbus_message_iter_check (DBusMessageRealIter *iter) +{ + if (iter == NULL) { - new_header_fields[field_name].name_offset = -1; - new_header_fields[field_name].value_offset = -1; + _dbus_warn_check_failed ("dbus message iterator is NULL\n"); + return FALSE; } - - while (next_offset < _dbus_string_get_length (&message->header)) + + if (iter->iter_type == DBUS_MESSAGE_ITER_TYPE_READER) { - int copy_name_offset; - int copy_value_offset; - - if (!iterate_one_field (&message->header, - message->byte_order, - next_offset, - &next_offset, - &field_name, - ©, - ©_name_offset, - ©_value_offset)) + if (iter->u.reader.byte_order != iter->message->byte_order) { - _dbus_verbose ("%s: OOM iterating one field\n", - _DBUS_FUNCTION_NAME); - goto out_1; + _dbus_warn_check_failed ("dbus message changed byte order since iterator was created\n"); + return FALSE; } - - if (field_name < DBUS_HEADER_FIELD_LAST) + /* because we swap the message into compiler order when you init an iter */ + _dbus_assert (iter->u.reader.byte_order == DBUS_COMPILER_BYTE_ORDER); + } + else if (iter->iter_type == DBUS_MESSAGE_ITER_TYPE_WRITER) + { + if (iter->u.writer.byte_order != iter->message->byte_order) { - new_header_fields[field_name].name_offset = copy_name_offset - new_fields_front_padding + name_offset_to_delete; - new_header_fields[field_name].value_offset = copy_value_offset - new_fields_front_padding + name_offset_to_delete; + _dbus_warn_check_failed ("dbus message changed byte order since append iterator was created\n"); + return FALSE; } + /* because we swap the message into compiler order when you init an iter */ + _dbus_assert (iter->u.writer.byte_order == DBUS_COMPILER_BYTE_ORDER); + } + else + { + _dbus_warn_check_failed ("dbus message iterator looks uninitialized or corrupted\n"); + return FALSE; } - if (!_dbus_string_replace_len (©, - new_fields_front_padding, - _dbus_string_get_length (©) - new_fields_front_padding, - &message->header, - name_offset_to_delete, - _dbus_string_get_length (&message->header) - name_offset_to_delete)) + if (iter->changed_stamp != iter->message->changed_stamp) { - _dbus_verbose ("%s: OOM moving copy back into header\n", - _DBUS_FUNCTION_NAME); - goto out_1; + _dbus_warn_check_failed ("dbus message iterator invalid because the message has been modified (or perhaps the iterator is just uninitialized)\n"); + return FALSE; } - - memcpy (message->header_fields, new_header_fields, - sizeof (new_header_fields)); - verify_header_fields (message); - - retval = TRUE; - - out_1: - _dbus_string_free (©); - - out_0: - if (!append_header_padding (message)) - _dbus_assert_not_reached ("Failed to re-append header padding in re_align_field_recurse()"); - - return retval; + + return TRUE; } +#endif /* DBUS_DISABLE_CHECKS */ -static dbus_bool_t -delete_field (DBusMessage *message, - int field, - int prealloc_header_space) +/** + * Implementation of the varargs arg-getting functions. + * dbus_message_get_args() is the place to go for complete + * documentation. + * + * @see dbus_message_get_args + * @param iter the message iter + * @param error error to be filled in + * @param first_arg_type type of the first argument + * @param var_args return location for first argument, followed by list of type/location pairs + * @returns #FALSE if error was set + */ +dbus_bool_t +_dbus_message_iter_get_args_valist (DBusMessageIter *iter, + DBusError *error, + int first_arg_type, + va_list var_args) { - int offset; + DBusMessageRealIter *real = (DBusMessageRealIter *)iter; + int spec_type, msg_type, i; + dbus_bool_t retval; - _dbus_assert (!message->locked); + _dbus_assert (_dbus_message_iter_check (real)); - /* Prealloc */ - if (!_dbus_string_lengthen (&message->header, prealloc_header_space)) - { - _dbus_verbose ("failed to prealloc %d bytes header space\n", - prealloc_header_space); - return FALSE; - } - _dbus_string_shorten (&message->header, prealloc_header_space); + retval = FALSE; + + spec_type = first_arg_type; + i = 0; - /* Delete */ - offset = message->header_fields[field].name_offset; - if (offset < 0) + while (spec_type != DBUS_TYPE_INVALID) { - _dbus_verbose ("header field didn't exist, no need to delete\n"); - return TRUE; /* field didn't exist */ - } + msg_type = dbus_message_iter_get_arg_type (iter); - return delete_one_and_re_align (message, offset); -} + if (msg_type != spec_type) + { + dbus_set_error (error, DBUS_ERROR_INVALID_ARGS, + "Argument %d is specified to be of type \"%s\", but " + "is actually of type \"%s\"\n", i, + _dbus_type_to_string (spec_type), + _dbus_type_to_string (msg_type)); -#ifdef DBUS_BUILD_TESTS -static dbus_bool_t -set_int_field (DBusMessage *message, - int field, - int value) -{ - int offset = message->header_fields[field].value_offset; + goto out; + } - _dbus_assert (!message->locked); - - if (offset < 0) - { - /* need to append the field */ - return append_int_field (message, field, value); - } - else - { - _dbus_marshal_set_int32 (&message->header, - message->byte_order, - offset, value); + if (dbus_type_is_basic (spec_type)) + { + DBusBasicValue *ptr; - return TRUE; - } -} -#endif + ptr = va_arg (var_args, DBusBasicValue*); -static dbus_bool_t -set_uint_field (DBusMessage *message, - int field, - dbus_uint32_t value) -{ - int offset = message->header_fields[field].value_offset; + _dbus_assert (ptr != NULL); - _dbus_assert (!message->locked); - - if (offset < 0) - { - /* need to append the field */ - return append_uint_field (message, field, value); - } - else - { - _dbus_marshal_set_uint32 (&message->header, - message->byte_order, - offset, value); + _dbus_type_reader_read_basic (&real->u.reader, + ptr); + } + else if (spec_type == DBUS_TYPE_ARRAY) + { + int element_type; + int spec_element_type; + const DBusBasicValue **ptr; + int *n_elements_p; + DBusTypeReader array; - return TRUE; - } -} + spec_element_type = va_arg (var_args, int); + element_type = _dbus_type_reader_get_element_type (&real->u.reader); -static dbus_bool_t -set_string_field (DBusMessage *message, - int field, - int type, - const char *value) -{ - int prealloc; - - _dbus_assert (!message->locked); + if (spec_element_type != element_type) + { + dbus_set_error (error, DBUS_ERROR_INVALID_ARGS, + "Argument %d is specified to be an array of \"%s\", but " + "is actually an array of \"%s\"\n", + i, + _dbus_type_to_string (spec_element_type), + _dbus_type_to_string (element_type)); + + goto out; + } - /* the prealloc is so the append_string_field() - * below won't fail, leaving us in inconsistent state - */ - prealloc = (value ? strlen (value) : 0) + MAX_BYTES_OVERHEAD_TO_APPEND_A_STRING; + if (dbus_type_is_fixed (spec_element_type)) + { + ptr = va_arg (var_args, const DBusBasicValue**); + n_elements_p = va_arg (var_args, int*); - _dbus_verbose ("set_string_field() field %d prealloc %d\n", - field, prealloc); - - if (!delete_field (message, field, prealloc)) - return FALSE; + _dbus_assert (ptr != NULL); + _dbus_assert (n_elements_p != NULL); - if (value != NULL) - { - /* need to append the field */ - if (!append_string_field (message, field, type, value)) - _dbus_assert_not_reached ("Appending string field shouldn't have failed, due to preallocation"); + _dbus_type_reader_recurse (&real->u.reader, &array); + + _dbus_type_reader_read_fixed_multi (&array, + ptr, n_elements_p); + } + else if (spec_element_type == DBUS_TYPE_STRING || + spec_element_type == DBUS_TYPE_SIGNATURE || + spec_element_type == DBUS_TYPE_OBJECT_PATH) + { + char ***str_array_p; + int n_elements; + char **str_array; + + str_array_p = va_arg (var_args, char***); + n_elements_p = va_arg (var_args, int*); + + _dbus_assert (str_array_p != NULL); + _dbus_assert (n_elements_p != NULL); + + /* Count elements in the array */ + _dbus_type_reader_recurse (&real->u.reader, &array); + + n_elements = 0; + while (_dbus_type_reader_get_current_type (&array) != DBUS_TYPE_INVALID) + { + ++n_elements; + _dbus_type_reader_next (&array); + } + + str_array = dbus_new0 (char*, n_elements + 1); + if (str_array == NULL) + { + _DBUS_SET_OOM (error); + goto out; + } + + /* Now go through and dup each string */ + _dbus_type_reader_recurse (&real->u.reader, &array); + + i = 0; + while (i < n_elements) + { + const char *s; + _dbus_type_reader_read_basic (&array, + &s); + + str_array[i] = _dbus_strdup (s); + if (str_array[i] == NULL) + { + dbus_free_string_array (str_array); + _DBUS_SET_OOM (error); + goto out; + } + + ++i; + + if (!_dbus_type_reader_next (&array)) + _dbus_assert (i == n_elements); + } + + _dbus_assert (_dbus_type_reader_get_current_type (&array) == DBUS_TYPE_INVALID); + _dbus_assert (i == n_elements); + _dbus_assert (str_array[i] == NULL); + + *str_array_p = str_array; + *n_elements_p = n_elements; + } +#ifndef DBUS_DISABLE_CHECKS + else + { + _dbus_warn ("you can't read arrays of container types (struct, variant, array) with %s for now\n", + _DBUS_FUNCTION_NAME); + goto out; + } +#endif + } +#ifndef DBUS_DISABLE_CHECKS + else + { + _dbus_warn ("you can only read arrays and basic types with %s for now\n", + _DBUS_FUNCTION_NAME); + goto out; + } +#endif + + spec_type = va_arg (var_args, int); + if (!_dbus_type_reader_next (&real->u.reader) && spec_type != DBUS_TYPE_INVALID) + { + dbus_set_error (error, DBUS_ERROR_INVALID_ARGS, + "Message has only %d arguments, but more were expected", i); + goto out; + } + + i++; } - - return TRUE; + + retval = TRUE; + + out: + + return retval; } +/** @} */ + /** - * Sets the serial number of a message. - * This can only be done once on a message. + * @defgroup DBusMessage DBusMessage + * @ingroup DBus + * @brief Message to be sent or received over a #DBusConnection. + * + * A DBusMessage is the most basic unit of communication over a + * DBusConnection. A DBusConnection represents a stream of messages + * received from a remote application, and a stream of messages + * sent to a remote application. + * + * A message has a message type, returned from + * dbus_message_get_type(). This indicates whether the message is a + * method call, a reply to a method call, a signal, or an error reply. + * + * A message has header fields such as the sender, destination, method + * or signal name, and so forth. DBusMessage has accessor functions for + * these, such as dbus_message_get_member(). + * + * Convenience functions dbus_message_is_method_call(), dbus_message_is_signal(), + * and dbus_message_is_error() check several header fields at once and are + * slightly more efficient than checking the header fields with individual + * accessor functions. + * + * Finally, a message has arguments. The number and types of arguments + * are in the message's signature header field (accessed with + * dbus_message_get_signature()). Simple argument values are usually + * retrieved with dbus_message_get_args() but more complex values such + * as structs may require the use of #DBusMessageIter. + * + * The D-Bus specification goes into some more detail about header fields and + * message types. * + * @{ + */ + +/** + * @typedef DBusMessage + * + * Opaque data type representing a message received from or to be + * sent to another application. + */ + +/** + * Returns the serial of a message or 0 if none has been specified. + * The message's serial number is provided by the application sending + * the message and is used to identify replies to this message. + * + * All messages received on a connection will have a serial provided + * by the remote application. + * + * For messages you're sending, dbus_connection_send() will assign a + * serial and return it to you. + * * @param message the message - * @param serial the serial + * @returns the serial */ -void -_dbus_message_set_serial (DBusMessage *message, - dbus_int32_t serial) +dbus_uint32_t +dbus_message_get_serial (DBusMessage *message) { - _dbus_assert (!message->locked); - _dbus_assert (dbus_message_get_serial (message) == 0); - - _dbus_marshal_set_uint32 (&message->header, - message->byte_order, - CLIENT_SERIAL_OFFSET, - serial); + _dbus_return_val_if_fail (message != NULL, 0); - message->client_serial = serial; + return _dbus_header_get_serial (&message->header); } /** - * Sets the reply serial of a message (the client serial - * of the message this is a reply to). + * Sets the reply serial of a message (the serial of the message this + * is a reply to). * * @param message the message - * @param reply_serial the client serial + * @param reply_serial the serial we're replying to * @returns #FALSE if not enough memory */ dbus_bool_t dbus_message_set_reply_serial (DBusMessage *message, dbus_uint32_t reply_serial) { - _dbus_assert (!message->locked); + _dbus_return_val_if_fail (message != NULL, FALSE); + _dbus_return_val_if_fail (!message->locked, FALSE); + _dbus_return_val_if_fail (reply_serial != 0, FALSE); /* 0 is invalid */ - if (set_uint_field (message, - DBUS_HEADER_FIELD_REPLY_SERIAL, - reply_serial)) - { - message->reply_serial = reply_serial; - return TRUE; - } - else - return FALSE; + return _dbus_header_set_field_basic (&message->header, + DBUS_HEADER_FIELD_REPLY_SERIAL, + DBUS_TYPE_UINT32, + &reply_serial); } /** - * Returns the serial of a message or 0 if none has been specified. - * The message's serial number is provided by the application sending - * the message and is used to identify replies to this message. All - * messages received on a connection will have a serial, but messages - * you haven't sent yet may return 0. + * Returns the serial that the message is a reply to or 0 if none. * * @param message the message - * @returns the client serial + * @returns the reply serial */ dbus_uint32_t -dbus_message_get_serial (DBusMessage *message) +dbus_message_get_reply_serial (DBusMessage *message) { - return message->client_serial; -} + dbus_uint32_t v_UINT32; -/** - * Returns the serial that the message is a reply to or 0 if none. - * - * @param message the message - * @returns the reply serial - */ -dbus_uint32_t -dbus_message_get_reply_serial (DBusMessage *message) -{ - return message->reply_serial; -} - -/** - * Adds a counter to be incremented immediately with the - * size of this message, and decremented by the size - * of this message when this message if finalized. - * The link contains a counter with its refcount already - * incremented, but the counter itself not incremented. - * Ownership of link and counter refcount is passed to - * the message. - * - * @param message the message - * @param link link with counter as data - */ -void -_dbus_message_add_size_counter_link (DBusMessage *message, - DBusList *link) -{ - /* right now we don't recompute the delta when message - * size changes, and that's OK for current purposes - * I think, but could be important to change later. - * Do recompute it whenever there are no outstanding counters, - * since it's basically free. - */ - if (message->size_counters == NULL) - { - message->size_counter_delta = - _dbus_string_get_length (&message->header) + - _dbus_string_get_length (&message->body); - -#if 0 - _dbus_verbose ("message has size %ld\n", - message->size_counter_delta); -#endif - } - - _dbus_list_append_link (&message->size_counters, link); - - _dbus_counter_adjust (link->data, message->size_counter_delta); -} - -/** - * Adds a counter to be incremented immediately with the - * size of this message, and decremented by the size - * of this message when this message if finalized. - * - * @param message the message - * @param counter the counter - * @returns #FALSE if no memory - */ -dbus_bool_t -_dbus_message_add_size_counter (DBusMessage *message, - DBusCounter *counter) -{ - DBusList *link; - - link = _dbus_list_alloc_link (counter); - if (link == NULL) - return FALSE; - - _dbus_counter_ref (counter); - _dbus_message_add_size_counter_link (message, link); - - return TRUE; -} - -/** - * Removes a counter tracking the size of this message, and decrements - * the counter by the size of this message. - * - * @param message the message - * @param link_return return the link used - * @param counter the counter - */ -void -_dbus_message_remove_size_counter (DBusMessage *message, - DBusCounter *counter, - DBusList **link_return) -{ - DBusList *link; + _dbus_return_val_if_fail (message != NULL, 0); - link = _dbus_list_find_last (&message->size_counters, - counter); - _dbus_assert (link != NULL); - - _dbus_list_unlink (&message->size_counters, - link); - if (link_return) - *link_return = link; + if (_dbus_header_get_field_basic (&message->header, + DBUS_HEADER_FIELD_REPLY_SERIAL, + DBUS_TYPE_UINT32, + &v_UINT32)) + return v_UINT32; else - _dbus_list_free_link (link); - - _dbus_counter_adjust (counter, message->size_counter_delta); - - _dbus_counter_unref (counter); + return 0; } -static dbus_bool_t -dbus_message_create_header (DBusMessage *message, - int type, - const char *service, - const char *path, - const char *interface, - const char *member, - const char *error_name) +static void +dbus_message_finalize (DBusMessage *message) { - unsigned int flags; - - _dbus_assert ((interface && member) || - (error_name) || - !(interface || member || error_name)); - - if (!_dbus_string_append_byte (&message->header, message->byte_order)) - return FALSE; - - if (!_dbus_string_append_byte (&message->header, type)) - return FALSE; - - flags = 0; - if (!_dbus_string_append_byte (&message->header, flags)) - return FALSE; - - if (!_dbus_string_append_byte (&message->header, DBUS_MAJOR_PROTOCOL_VERSION)) - return FALSE; - - /* header length */ - if (!_dbus_marshal_uint32 (&message->header, message->byte_order, 0)) - return FALSE; - - /* body length */ - if (!_dbus_marshal_uint32 (&message->header, message->byte_order, 0)) - return FALSE; + _dbus_assert (message->refcount.value == 0); - /* serial */ - if (!_dbus_marshal_uint32 (&message->header, message->byte_order, 0)) - return FALSE; - - /* Marshal all the fields (Marshall Fields?) */ - - if (path != NULL) - { - if (!append_string_field (message, - DBUS_HEADER_FIELD_PATH, - DBUS_TYPE_OBJECT_PATH, - path)) - return FALSE; - } - - if (service != NULL) - { - if (!append_string_field (message, - DBUS_HEADER_FIELD_SERVICE, - DBUS_TYPE_STRING, - service)) - return FALSE; - } + /* This calls application callbacks! */ + _dbus_data_slot_list_free (&message->slot_list); - if (interface != NULL) - { - if (!append_string_field (message, - DBUS_HEADER_FIELD_INTERFACE, - DBUS_TYPE_STRING, - interface)) - return FALSE; - } + _dbus_list_foreach (&message->size_counters, + free_size_counter, message); + _dbus_list_clear (&message->size_counters); - if (member != NULL) - { - if (!append_string_field (message, - DBUS_HEADER_FIELD_MEMBER, - DBUS_TYPE_STRING, - member)) - return FALSE; - } + _dbus_header_free (&message->header); + _dbus_string_free (&message->body); - if (error_name != NULL) - { - if (!append_string_field (message, - DBUS_HEADER_FIELD_ERROR_NAME, - DBUS_TYPE_STRING, - error_name)) - return FALSE; - } + _dbus_assert (message->refcount.value == 0); - return TRUE; -} - -/** - * Locks a message. Allows checking that applications don't keep a - * reference to a message in the outgoing queue and change it - * underneath us. Messages are locked when they enter the outgoing - * queue (dbus_connection_send_message()), and the library complains - * if the message is modified while locked. - * - * @param message the message to lock. - */ -void -_dbus_message_lock (DBusMessage *message) -{ - if (!message->locked) - { - /* Fill in our lengths */ - _dbus_marshal_set_uint32 (&message->header, - message->byte_order, - HEADER_LENGTH_OFFSET, - _dbus_string_get_length (&message->header)); - - _dbus_marshal_set_uint32 (&message->header, - message->byte_order, - BODY_LENGTH_OFFSET, - _dbus_string_get_length (&message->body)); - - message->locked = TRUE; - } + dbus_free (message); } -/** @} */ - -/** - * @defgroup DBusMessage DBusMessage - * @ingroup DBus - * @brief Message to be sent or received over a DBusConnection. - * - * A DBusMessage is the most basic unit of communication over a - * DBusConnection. A DBusConnection represents a stream of messages - * received from a remote application, and a stream of messages - * sent to a remote application. - * - * @{ - */ - -/** - * @typedef DBusMessage - * - * Opaque data type representing a message received from or to be - * sent to another application. - */ - static DBusMessage* dbus_message_new_empty_header (void) { DBusMessage *message; - int i; - - message = dbus_new0 (DBusMessage, 1); - if (message == NULL) - return NULL; - - message->refcount.value = 1; - message->byte_order = DBUS_COMPILER_BYTE_ORDER; - message->client_serial = 0; - message->reply_serial = 0; + dbus_bool_t from_cache; - _dbus_data_slot_list_init (&message->slot_list); - - i = 0; - while (i <= DBUS_HEADER_FIELD_LAST) + message = dbus_message_get_cached (); + + if (message != NULL) { - message->header_fields[i].name_offset = -1; - message->header_fields[i].value_offset = -1; - ++i; + from_cache = TRUE; } - - if (!_dbus_string_init_preallocated (&message->header, 64)) + else { - dbus_free (message); - return NULL; + from_cache = FALSE; + message = dbus_new (DBusMessage, 1); + if (message == NULL) + return NULL; +#ifndef DBUS_DISABLE_CHECKS + message->generation = _dbus_current_generation; +#endif } - if (!_dbus_string_init_preallocated (&message->body, 64)) + message->refcount.value = 1; + message->byte_order = DBUS_COMPILER_BYTE_ORDER; + message->locked = FALSE; +#ifndef DBUS_DISABLE_CHECKS + message->in_cache = FALSE; +#endif + message->size_counters = NULL; + message->size_counter_delta = 0; + message->changed_stamp = 0; + + if (!from_cache) + _dbus_data_slot_list_init (&message->slot_list); + + if (from_cache) { - _dbus_string_free (&message->header); - dbus_free (message); - return NULL; + _dbus_header_reinit (&message->header, message->byte_order); + _dbus_string_set_length (&message->body, 0); } - - if (!_dbus_string_init_preallocated (&message->signature, 4)) + else { - _dbus_string_free (&message->header); - _dbus_string_free (&message->body); - dbus_free (message); - return NULL; + if (!_dbus_header_init (&message->header, message->byte_order)) + { + dbus_free (message); + return NULL; + } + + if (!_dbus_string_init_preallocated (&message->body, 32)) + { + _dbus_header_free (&message->header); + dbus_free (message); + return NULL; + } } - + return message; } @@ -1203,8 +1013,12 @@ dbus_message_new_empty_header (void) * Types include #DBUS_MESSAGE_TYPE_METHOD_CALL, * #DBUS_MESSAGE_TYPE_SIGNAL, and so forth. * + * Usually you want to use dbus_message_new_method_call(), + * dbus_message_new_method_return(), dbus_message_new_signal(), + * or dbus_message_new_error() instead. + * * @param message_type type of message - * @returns new message or #NULL If no memory + * @returns new message or #NULL if no memory */ DBusMessage* dbus_message_new (int message_type) @@ -1212,41 +1026,45 @@ dbus_message_new (int message_type) DBusMessage *message; _dbus_return_val_if_fail (message_type != DBUS_MESSAGE_TYPE_INVALID, NULL); - + message = dbus_message_new_empty_header (); if (message == NULL) return NULL; - - if (!dbus_message_create_header (message, - message_type, - NULL, NULL, NULL, NULL, NULL)) + + if (!_dbus_header_create (&message->header, + message_type, + NULL, NULL, NULL, NULL, NULL)) { dbus_message_unref (message); return NULL; } - + return message; } /** * Constructs a new message to invoke a method on a remote * object. Returns #NULL if memory can't be allocated for the - * message. The service may be #NULL in which case no service is set; - * this is appropriate when using D-BUS in a peer-to-peer context (no - * message bus). The interface may be #NULL, which means that - * if multiple methods with the given name exist it is undefined + * message. The destination may be #NULL in which case no destination + * is set; this is appropriate when using D-Bus in a peer-to-peer + * context (no message bus). The interface may be #NULL, which means + * that if multiple methods with the given name exist it is undefined * which one will be invoked. - * - * @param service service that the message should be sent to or #NULL + * + * The path and method names may not be #NULL. + * + * Destination, path, interface, and method name can't contain + * any invalid characters (see the D-Bus specification). + * + * @param destination name that the message should be sent to or #NULL * @param path object path the message should be sent to - * @param interface interface to invoke method on + * @param interface interface to invoke method on, or #NULL * @param method method to invoke - * + * * @returns a new DBusMessage, free with dbus_message_unref() - * @see dbus_message_unref() */ DBusMessage* -dbus_message_new_method_call (const char *service, +dbus_message_new_method_call (const char *destination, const char *path, const char *interface, const char *method) @@ -1255,19 +1073,25 @@ dbus_message_new_method_call (const char *service, _dbus_return_val_if_fail (path != NULL, NULL); _dbus_return_val_if_fail (method != NULL, NULL); - + _dbus_return_val_if_fail (destination == NULL || + _dbus_check_is_valid_bus_name (destination), NULL); + _dbus_return_val_if_fail (_dbus_check_is_valid_path (path), NULL); + _dbus_return_val_if_fail (interface == NULL || + _dbus_check_is_valid_interface (interface), NULL); + _dbus_return_val_if_fail (_dbus_check_is_valid_member (method), NULL); + message = dbus_message_new_empty_header (); if (message == NULL) return NULL; - - if (!dbus_message_create_header (message, - DBUS_MESSAGE_TYPE_METHOD_CALL, - service, path, interface, method, NULL)) + + if (!_dbus_header_create (&message->header, + DBUS_MESSAGE_TYPE_METHOD_CALL, + destination, path, interface, method, NULL)) { dbus_message_unref (message); return NULL; } - + return message; } @@ -1275,11 +1099,9 @@ dbus_message_new_method_call (const char *service, * Constructs a message that is a reply to a method call. Returns * #NULL if memory can't be allocated for the message. * - * @param method_call the message which the created - * message is a reply to. + * @param method_call the message being replied to * @returns a new DBusMessage, free with dbus_message_unref() - * @see dbus_message_new_method_call(), dbus_message_unref() - */ + */ DBusMessage* dbus_message_new_method_return (DBusMessage *method_call) { @@ -1287,20 +1109,18 @@ dbus_message_new_method_return (DBusMessage *method_call) const char *sender; _dbus_return_val_if_fail (method_call != NULL, NULL); - - sender = get_string_field (method_call, - DBUS_HEADER_FIELD_SENDER_SERVICE, - NULL); - + + sender = dbus_message_get_sender (method_call); + /* sender is allowed to be null here in peer-to-peer case */ message = dbus_message_new_empty_header (); if (message == NULL) return NULL; - - if (!dbus_message_create_header (message, - DBUS_MESSAGE_TYPE_METHOD_RETURN, - sender, NULL, NULL, NULL, NULL)) + + if (!_dbus_header_create (&message->header, + DBUS_MESSAGE_TYPE_METHOD_RETURN, + sender, NULL, NULL, NULL, NULL)) { dbus_message_unref (message); return NULL; @@ -1320,15 +1140,17 @@ dbus_message_new_method_return (DBusMessage *method_call) /** * Constructs a new message representing a signal emission. Returns - * #NULL if memory can't be allocated for the message. - * A signal is identified by its originating interface, and - * the name of the signal. + * #NULL if memory can't be allocated for the message. A signal is + * identified by its originating object path, interface, and the name + * of the signal. * + * Path, interface, and signal name must all be valid (the D-Bus + * specification defines the syntax of these fields). + * * @param path the path to the object emitting the signal * @param interface the interface the signal is emitted from * @param name name of the signal * @returns a new DBusMessage, free with dbus_message_unref() - * @see dbus_message_unref() */ DBusMessage* dbus_message_new_signal (const char *path, @@ -1340,32 +1162,40 @@ dbus_message_new_signal (const char *path, _dbus_return_val_if_fail (path != NULL, NULL); _dbus_return_val_if_fail (interface != NULL, NULL); _dbus_return_val_if_fail (name != NULL, NULL); - + _dbus_return_val_if_fail (_dbus_check_is_valid_path (path), NULL); + _dbus_return_val_if_fail (_dbus_check_is_valid_interface (interface), NULL); + _dbus_return_val_if_fail (_dbus_check_is_valid_member (name), NULL); + message = dbus_message_new_empty_header (); if (message == NULL) return NULL; - - if (!dbus_message_create_header (message, - DBUS_MESSAGE_TYPE_SIGNAL, - NULL, path, interface, name, NULL)) + + if (!_dbus_header_create (&message->header, + DBUS_MESSAGE_TYPE_SIGNAL, + NULL, path, interface, name, NULL)) { dbus_message_unref (message); return NULL; } dbus_message_set_no_reply (message, TRUE); - + return message; } /** - * Creates a new message that is an error reply to a certain message. - * Error replies are possible in response to method calls primarily. + * Creates a new message that is an error reply to another message. + * Error replies are most common in response to method calls, but + * can be returned in reply to any message. * - * @param reply_to the original message + * The error name must be a valid error name according to the syntax + * given in the D-Bus specification. If you don't want to make + * up an error name just use #DBUS_ERROR_FAILED. + * + * @param reply_to the message we're replying to * @param error_name the error name - * @param error_message the error message string or #NULL for none - * @returns a new error message + * @param error_message the error message string (or #NULL for none, but please give a message) + * @returns a new error message object, free with dbus_message_unref() */ DBusMessage* dbus_message_new_error (DBusMessage *reply_to, @@ -1378,10 +1208,9 @@ dbus_message_new_error (DBusMessage *reply_to, _dbus_return_val_if_fail (reply_to != NULL, NULL); _dbus_return_val_if_fail (error_name != NULL, NULL); - - sender = get_string_field (reply_to, - DBUS_HEADER_FIELD_SENDER_SERVICE, - NULL); + _dbus_return_val_if_fail (_dbus_check_is_valid_error_name (error_name), NULL); + + sender = dbus_message_get_sender (reply_to); /* sender may be NULL for non-message-bus case or * when the message bus is dealing with an unregistered @@ -1390,17 +1219,17 @@ dbus_message_new_error (DBusMessage *reply_to, message = dbus_message_new_empty_header (); if (message == NULL) return NULL; - - if (!dbus_message_create_header (message, - DBUS_MESSAGE_TYPE_ERROR, - sender, NULL, NULL, NULL, error_name)) + + if (!_dbus_header_create (&message->header, + DBUS_MESSAGE_TYPE_ERROR, + sender, NULL, NULL, NULL, error_name)) { dbus_message_unref (message); return NULL; } dbus_message_set_no_reply (message, TRUE); - + if (!dbus_message_set_reply_serial (message, dbus_message_get_serial (reply_to))) { @@ -1410,100 +1239,129 @@ dbus_message_new_error (DBusMessage *reply_to, if (error_message != NULL) { - dbus_message_append_iter_init (message, &iter); - if (!dbus_message_iter_append_string (&iter, error_message)) + dbus_message_iter_init_append (message, &iter); + if (!dbus_message_iter_append_basic (&iter, + DBUS_TYPE_STRING, + &error_message)) { dbus_message_unref (message); return NULL; } } - + + return message; +} + +/** + * Creates a new message that is an error reply to another message, allowing + * you to use printf formatting. + * + * See dbus_message_new_error() for details - this function is the same + * aside from the printf formatting. + * + * @todo add _DBUS_GNUC_PRINTF to this (requires moving _DBUS_GNUC_PRINTF to + * public header, see DBUS_DEPRECATED for an example) + * + * @param reply_to the original message + * @param error_name the error name + * @param error_format the error message format as with printf + * @param ... format string arguments + * @returns a new error message + */ +DBusMessage* +dbus_message_new_error_printf (DBusMessage *reply_to, + const char *error_name, + const char *error_format, + ...) +{ + va_list args; + DBusString str; + DBusMessage *message; + + _dbus_return_val_if_fail (reply_to != NULL, NULL); + _dbus_return_val_if_fail (error_name != NULL, NULL); + _dbus_return_val_if_fail (_dbus_check_is_valid_error_name (error_name), NULL); + + if (!_dbus_string_init (&str)) + return NULL; + + va_start (args, error_format); + + if (_dbus_string_append_printf_valist (&str, error_format, args)) + message = dbus_message_new_error (reply_to, error_name, + _dbus_string_get_const_data (&str)); + else + message = NULL; + + _dbus_string_free (&str); + + va_end (args); + return message; } + /** * Creates a new message that is an exact replica of the message - * specified, except that its refcount is set to 1. + * specified, except that its refcount is set to 1, its message serial + * is reset to 0, and if the original message was "locked" (in the + * outgoing message queue and thus not modifiable) the new message + * will not be locked. * - * @param message the message. - * @returns the new message. + * @param message the message + * @returns the new message.or #NULL if not enough memory */ DBusMessage * dbus_message_copy (const DBusMessage *message) { DBusMessage *retval; - int i; _dbus_return_val_if_fail (message != NULL, NULL); - + retval = dbus_new0 (DBusMessage, 1); if (retval == NULL) return NULL; - + retval->refcount.value = 1; retval->byte_order = message->byte_order; - retval->client_serial = message->client_serial; - retval->reply_serial = message->reply_serial; - retval->header_padding = message->header_padding; retval->locked = FALSE; - - if (!_dbus_string_init_preallocated (&retval->header, - _dbus_string_get_length (&message->header))) +#ifndef DBUS_DISABLE_CHECKS + retval->generation = message->generation; +#endif + + if (!_dbus_header_copy (&message->header, &retval->header)) { dbus_free (retval); return NULL; } - + if (!_dbus_string_init_preallocated (&retval->body, _dbus_string_get_length (&message->body))) { - _dbus_string_free (&retval->header); - dbus_free (retval); - return NULL; - } - - if (!_dbus_string_init_preallocated (&retval->signature, - _dbus_string_get_length (&message->signature))) - { - _dbus_string_free (&retval->header); - _dbus_string_free (&retval->body); + _dbus_header_free (&retval->header); dbus_free (retval); return NULL; } - - if (!_dbus_string_copy (&message->header, 0, - &retval->header, 0)) - goto failed_copy; if (!_dbus_string_copy (&message->body, 0, &retval->body, 0)) goto failed_copy; - if (!_dbus_string_copy (&message->signature, 0, - &retval->signature, 0)) - goto failed_copy; - - for (i = 0; i <= DBUS_HEADER_FIELD_LAST; i++) - { - retval->header_fields[i] = message->header_fields[i]; - } - return retval; failed_copy: - _dbus_string_free (&retval->header); + _dbus_header_free (&retval->header); _dbus_string_free (&retval->body); - _dbus_string_free (&retval->signature); dbus_free (retval); - - return NULL; + + return NULL; } /** * Increments the reference count of a DBusMessage. * - * @param message The message + * @param message the message * @returns the message * @see dbus_message_unref */ @@ -1513,6 +1371,8 @@ dbus_message_ref (DBusMessage *message) dbus_int32_t old_refcount; _dbus_return_val_if_fail (message != NULL, NULL); + _dbus_return_val_if_fail (message->generation == _dbus_current_generation, NULL); + _dbus_return_val_if_fail (!message->in_cache, NULL); old_refcount = _dbus_atomic_inc (&message->refcount); _dbus_assert (old_refcount >= 1); @@ -1520,22 +1380,11 @@ dbus_message_ref (DBusMessage *message) return message; } -static void -free_size_counter (void *element, - void *data) -{ - DBusCounter *counter = element; - DBusMessage *message = data; - - _dbus_counter_adjust (counter, - message->size_counter_delta); - - _dbus_counter_unref (counter); -} - /** - * Decrements the reference count of a DBusMessage. + * Decrements the reference count of a DBusMessage, freeing the + * message if the count reaches 0. * - * @param message The message + * @param message the message * @see dbus_message_ref */ void @@ -1544,35 +1393,26 @@ dbus_message_unref (DBusMessage *message) dbus_int32_t old_refcount; _dbus_return_if_fail (message != NULL); - + _dbus_return_if_fail (message->generation == _dbus_current_generation); + _dbus_return_if_fail (!message->in_cache); + old_refcount = _dbus_atomic_dec (&message->refcount); - + _dbus_assert (old_refcount >= 0); if (old_refcount == 1) { - /* This calls application callbacks! */ - _dbus_data_slot_list_free (&message->slot_list); - - _dbus_list_foreach (&message->size_counters, - free_size_counter, message); - _dbus_list_clear (&message->size_counters); - - _dbus_string_free (&message->header); - _dbus_string_free (&message->body); - _dbus_string_free (&message->signature); - - dbus_free (message); + /* Calls application callbacks! */ + dbus_message_cache_or_finalize (message); } } /** * Gets the type of a message. Types include - * DBUS_MESSAGE_TYPE_METHOD_CALL, DBUS_MESSAGE_TYPE_METHOD_RETURN, - * DBUS_MESSAGE_TYPE_ERROR, DBUS_MESSAGE_TYPE_SIGNAL, but other types - * are allowed and all code must silently ignore messages of unknown - * type. DBUS_MESSAGE_TYPE_INVALID will never be returned, however. - * + * #DBUS_MESSAGE_TYPE_METHOD_CALL, #DBUS_MESSAGE_TYPE_METHOD_RETURN, + * #DBUS_MESSAGE_TYPE_ERROR, #DBUS_MESSAGE_TYPE_SIGNAL, but other + * types are allowed and all code must silently ignore messages of + * unknown type. #DBUS_MESSAGE_TYPE_INVALID will never be returned. * * @param message the message * @returns the type of the message @@ -1580,245 +1420,62 @@ dbus_message_unref (DBusMessage *message) int dbus_message_get_type (DBusMessage *message) { - int type; - - type = _dbus_string_get_byte (&message->header, 1); - _dbus_assert (type != DBUS_MESSAGE_TYPE_INVALID); - - return type; -} - -/** - * Sets the object path this message is being sent to (for - * DBUS_MESSAGE_TYPE_METHOD_CALL) or the one a signal is being - * emitted from (for DBUS_MESSAGE_TYPE_SIGNAL). - * - * @param message the message - * @param object_path the path - * @returns #FALSE if not enough memory - */ -dbus_bool_t -dbus_message_set_path (DBusMessage *message, - const char *object_path) -{ - _dbus_return_val_if_fail (message != NULL, FALSE); - _dbus_return_val_if_fail (!message->locked, FALSE); + _dbus_return_val_if_fail (message != NULL, DBUS_MESSAGE_TYPE_INVALID); - return set_string_field (message, - DBUS_HEADER_FIELD_PATH, - DBUS_TYPE_OBJECT_PATH, - object_path); + return _dbus_header_get_message_type (&message->header); } /** - * Gets the object path this message is being sent to - * (for DBUS_MESSAGE_TYPE_METHOD_CALL) or being emitted - * from (for DBUS_MESSAGE_TYPE_SIGNAL). - * - * @param message the message - * @returns the path (should not be freed) - */ -const char* -dbus_message_get_path (DBusMessage *message) -{ - _dbus_return_val_if_fail (message != NULL, NULL); - - return get_string_field (message, DBUS_HEADER_FIELD_PATH, NULL); -} - -/** - * Gets the object path this message is being sent to - * (for DBUS_MESSAGE_TYPE_METHOD_CALL) or being emitted - * from (for DBUS_MESSAGE_TYPE_SIGNAL) in a decomposed - * format (one array element per path component). - * Free the returned array with dbus_free_string_array(). + * Appends fields to a message given a variable argument list. The + * variable argument list should contain the type of each argument + * followed by the value to append. Appendable types are basic types, + * and arrays of fixed-length basic types. To append variable-length + * basic types, or any more complex value, you have to use an iterator + * rather than this function. * - * An empty but non-NULL path array means the path "/". - * So the path "/foo/bar" becomes { "foo", "bar", NULL } - * and the path "/" becomes { NULL }. + * To append a basic type, specify its type code followed by the + * address of the value. For example: * - * @param message the message - * @param path place to store allocated array of path components; #NULL set here if no path field exists - * @returns #FALSE if no memory to allocate the array - */ -dbus_bool_t -dbus_message_get_path_decomposed (DBusMessage *message, - char ***path) -{ - _dbus_return_val_if_fail (message != NULL, FALSE); - _dbus_return_val_if_fail (path != NULL, FALSE); - - return get_path_field_decomposed (message, - DBUS_HEADER_FIELD_PATH, - path); -} - -/** - * Sets the interface this message is being sent to - * (for DBUS_MESSAGE_TYPE_METHOD_CALL) or - * the interface a signal is being emitted from - * (for DBUS_MESSAGE_TYPE_SIGNAL). + * @code * - * @param message the message - * @param interface the interface - * @returns #FALSE if not enough memory - */ -dbus_bool_t -dbus_message_set_interface (DBusMessage *message, - const char *interface) -{ - _dbus_return_val_if_fail (message != NULL, FALSE); - _dbus_return_val_if_fail (!message->locked, FALSE); - - return set_string_field (message, - DBUS_HEADER_FIELD_INTERFACE, - DBUS_TYPE_STRING, - interface); -} - -/** - * Gets the interface this message is being sent to - * (for DBUS_MESSAGE_TYPE_METHOD_CALL) or being emitted - * from (for DBUS_MESSAGE_TYPE_SIGNAL). - * The interface name is fully-qualified (namespaced). + * dbus_int32_t v_INT32 = 42; + * const char *v_STRING = "Hello World"; + * dbus_message_append_args (message, + * DBUS_TYPE_INT32, &v_INT32, + * DBUS_TYPE_STRING, &v_STRING, + * DBUS_TYPE_INVALID); + * @endcode * - * @param message the message - * @returns the message interface (should not be freed) - */ -const char* -dbus_message_get_interface (DBusMessage *message) -{ - _dbus_return_val_if_fail (message != NULL, NULL); - - return get_string_field (message, DBUS_HEADER_FIELD_INTERFACE, NULL); -} - -/** - * Sets the interface member being invoked - * (DBUS_MESSAGE_TYPE_METHOD_CALL) or emitted - * (DBUS_MESSAGE_TYPE_SIGNAL). - * The interface name is fully-qualified (namespaced). + * To append an array of fixed-length basic types, pass in the + * DBUS_TYPE_ARRAY typecode, the element typecode, the address of + * the array pointer, and a 32-bit integer giving the number of + * elements in the array. So for example: + * @code + * const dbus_int32_t array[] = { 1, 2, 3 }; + * const dbus_int32_t *v_ARRAY = array; + * dbus_message_append_args (message, + * DBUS_TYPE_ARRAY, DBUS_TYPE_INT32, &v_ARRAY, 3, + * DBUS_TYPE_INVALID); + * @endcode * - * @param message the message - * @param member the member - * @returns #FALSE if not enough memory - */ -dbus_bool_t -dbus_message_set_member (DBusMessage *message, - const char *member) -{ - _dbus_return_val_if_fail (message != NULL, FALSE); - _dbus_return_val_if_fail (!message->locked, FALSE); - - return set_string_field (message, - DBUS_HEADER_FIELD_MEMBER, - DBUS_TYPE_STRING, - member); -} - -/** - * Gets the interface member being invoked - * (DBUS_MESSAGE_TYPE_METHOD_CALL) or emitted - * (DBUS_MESSAGE_TYPE_SIGNAL). - * - * @param message the message - * @returns the member name (should not be freed) - */ -const char* -dbus_message_get_member (DBusMessage *message) -{ - _dbus_return_val_if_fail (message != NULL, NULL); - - return get_string_field (message, - DBUS_HEADER_FIELD_MEMBER, - NULL); -} - -/** - * Sets the name of the error (DBUS_MESSAGE_TYPE_ERROR). - * The name is fully-qualified (namespaced). + * @warning in C, given "int array[]", "&array == array" (the + * comp.lang.c FAQ says otherwise, but gcc and the FAQ don't agree). + * So if you're using an array instead of a pointer you have to create + * a pointer variable, assign the array to it, then take the address + * of the pointer variable. For strings it works to write + * const char *array = "Hello" and then use &array though. * - * @param message the message - * @param error_name the name - * @returns #FALSE if not enough memory - */ -dbus_bool_t -dbus_message_set_error_name (DBusMessage *message, - const char *error_name) -{ - _dbus_return_val_if_fail (message != NULL, FALSE); - _dbus_return_val_if_fail (!message->locked, FALSE); - - return set_string_field (message, - DBUS_HEADER_FIELD_ERROR_NAME, - DBUS_TYPE_STRING, - error_name); -} - -/** - * Gets the error name (DBUS_MESSAGE_TYPE_ERROR only). - * - * @param message the message - * @returns the error name (should not be freed) - */ -const char* -dbus_message_get_error_name (DBusMessage *message) -{ - _dbus_return_val_if_fail (message != NULL, NULL); - - return get_string_field (message, - DBUS_HEADER_FIELD_ERROR_NAME, - NULL); -} - -/** - * Sets the message's destination service. + * The last argument to this function must be #DBUS_TYPE_INVALID, + * marking the end of the argument list. If you don't do this + * then libdbus won't know to stop and will read invalid memory. * - * @param message the message - * @param destination the destination service name - * @returns #FALSE if not enough memory - */ -dbus_bool_t -dbus_message_set_destination (DBusMessage *message, - const char *destination) -{ - _dbus_return_val_if_fail (message != NULL, FALSE); - _dbus_return_val_if_fail (!message->locked, FALSE); - - return set_string_field (message, - DBUS_HEADER_FIELD_SERVICE, - DBUS_TYPE_STRING, - destination); -} - -/** - * Gets the destination service of a message. - * - * @param message the message - * @returns the message destination service (should not be freed) - */ -const char* -dbus_message_get_destination (DBusMessage *message) -{ - _dbus_return_val_if_fail (message != NULL, NULL); - - return get_string_field (message, - DBUS_HEADER_FIELD_SERVICE, - NULL); -} - -/** - * Appends fields to a message given a variable argument list. The - * variable argument list should contain the type of the argument - * followed by the value to add. Array values are specified by an int - * typecode followed by a pointer to the array followed by an int - * giving the length of the array. The argument list must be - * terminated with #DBUS_TYPE_INVALID. + * String/signature/path arrays should be passed in as "const char*** + * address_of_array" and "int n_elements" * - * This function doesn't support dicts or non-fundamental arrays. + * @todo support DBUS_TYPE_STRUCT and DBUS_TYPE_VARIANT and complex arrays * - * This function supports #DBUS_TYPE_INT64 and #DBUS_TYPE_UINT64 - * only if #DBUS_HAVE_INT64 is defined. + * @todo If this fails due to lack of memory, the message is hosed and + * you have to start over building the whole message. * * @param message the message * @param first_arg_type type of the first argument @@ -1827,14 +1484,14 @@ dbus_message_get_destination (DBusMessage *message) */ dbus_bool_t dbus_message_append_args (DBusMessage *message, - int first_arg_type, + int first_arg_type, ...) { dbus_bool_t retval; va_list var_args; _dbus_return_val_if_fail (message != NULL, FALSE); - + va_start (var_args, first_arg_type); retval = dbus_message_append_args_valist (message, first_arg_type, @@ -1845,13 +1502,13 @@ dbus_message_append_args (DBusMessage *message, } /** - * This function takes a va_list for use by language bindings. - * It's otherwise the same as dbus_message_append_args(). + * Like dbus_message_append_args() but takes a va_list for use by language bindings. * - * @todo: Shouldn't this function clean up the changes to the message - * on failures? (Yes) - - * @see dbus_message_append_args. + * @todo for now, if this function fails due to OOM it will leave + * the message half-written and you have to discard the message + * and start over. + * + * @see dbus_message_append_args. * @param message the message * @param first_arg_type type of first argument * @param var_args value of first argument, then list of type/value pairs @@ -1862,157 +1519,142 @@ dbus_message_append_args_valist (DBusMessage *message, int first_arg_type, va_list var_args) { - int type, old_len; + int type; DBusMessageIter iter; _dbus_return_val_if_fail (message != NULL, FALSE); - - old_len = _dbus_string_get_length (&message->body); - + type = first_arg_type; - dbus_message_append_iter_init (message, &iter); - + dbus_message_iter_init_append (message, &iter); + while (type != DBUS_TYPE_INVALID) { - switch (type) - { - case DBUS_TYPE_NIL: - if (!dbus_message_iter_append_nil (&iter)) - goto errorout; - break; - case DBUS_TYPE_BYTE: - if (!dbus_message_iter_append_byte (&iter, va_arg (var_args, unsigned char))) - goto errorout; - break; - case DBUS_TYPE_BOOLEAN: - if (!dbus_message_iter_append_boolean (&iter, va_arg (var_args, dbus_bool_t))) - goto errorout; - break; - case DBUS_TYPE_INT32: - if (!dbus_message_iter_append_int32 (&iter, va_arg (var_args, dbus_int32_t))) - goto errorout; - break; - case DBUS_TYPE_UINT32: - if (!dbus_message_iter_append_uint32 (&iter, va_arg (var_args, dbus_uint32_t))) - goto errorout; - break; -#ifdef DBUS_HAVE_INT64 - case DBUS_TYPE_INT64: - if (!dbus_message_iter_append_int64 (&iter, va_arg (var_args, dbus_int64_t))) - goto errorout; - break; - case DBUS_TYPE_UINT64: - if (!dbus_message_iter_append_uint64 (&iter, va_arg (var_args, dbus_uint64_t))) - goto errorout; - break; -#endif /* DBUS_HAVE_INT64 */ - case DBUS_TYPE_DOUBLE: - if (!dbus_message_iter_append_double (&iter, va_arg (var_args, double))) - goto errorout; - break; - case DBUS_TYPE_STRING: - if (!dbus_message_iter_append_string (&iter, va_arg (var_args, const char *))) - goto errorout; - break; - case DBUS_TYPE_OBJECT_PATH: + if (dbus_type_is_basic (type)) + { + const DBusBasicValue *value; + value = va_arg (var_args, const DBusBasicValue*); - break; - case DBUS_TYPE_CUSTOM: - { - const char *name; - unsigned char *data; - int len; - - name = va_arg (var_args, const char *); - data = va_arg (var_args, unsigned char *); - len = va_arg (var_args, int); - - if (!dbus_message_iter_append_custom (&iter, name, data, len)) - goto errorout; - break; - } - case DBUS_TYPE_ARRAY: - { - void *data; - int len, type; - - type = va_arg (var_args, int); - data = va_arg (var_args, void *); - len = va_arg (var_args, int); - - switch (type) - { - case DBUS_TYPE_BYTE: - if (!dbus_message_iter_append_byte_array (&iter, (unsigned char *)data, len)) - goto errorout; - break; - case DBUS_TYPE_BOOLEAN: - if (!dbus_message_iter_append_boolean_array (&iter, (unsigned char *)data, len)) - goto errorout; - break; - case DBUS_TYPE_INT32: - if (!dbus_message_iter_append_int32_array (&iter, (dbus_int32_t *)data, len)) - goto errorout; - break; - case DBUS_TYPE_UINT32: - if (!dbus_message_iter_append_uint32_array (&iter, (dbus_uint32_t *)data, len)) - goto errorout; - break; -#ifdef DBUS_HAVE_INT64 - case DBUS_TYPE_INT64: - if (!dbus_message_iter_append_int64_array (&iter, (dbus_int64_t *)data, len)) - goto errorout; - break; - case DBUS_TYPE_UINT64: - if (!dbus_message_iter_append_uint64_array (&iter, (dbus_uint64_t *)data, len)) - goto errorout; - break; -#endif /* DBUS_HAVE_INT64 */ - case DBUS_TYPE_DOUBLE: - if (!dbus_message_iter_append_double_array (&iter, (double *)data, len)) - goto errorout; - break; - case DBUS_TYPE_STRING: - if (!dbus_message_iter_append_string_array (&iter, (const char **)data, len)) - goto errorout; - break; - case DBUS_TYPE_NIL: - case DBUS_TYPE_ARRAY: - case DBUS_TYPE_CUSTOM: - case DBUS_TYPE_DICT: - _dbus_warn ("dbus_message_append_args_valist doesn't support recursive arrays\n"); - goto errorout; - default: - _dbus_warn ("Unknown field type %d\n", type); - goto errorout; - } - } - break; - - case DBUS_TYPE_DICT: - _dbus_warn ("dbus_message_append_args_valist doesn't support dicts\n"); - goto errorout; - default: - _dbus_warn ("Unknown field type %d\n", type); - goto errorout; - } + if (!dbus_message_iter_append_basic (&iter, + type, + value)) + goto failed; + } + else if (type == DBUS_TYPE_ARRAY) + { + int element_type; + DBusMessageIter array; + char buf[2]; + + element_type = va_arg (var_args, int); + + buf[0] = element_type; + buf[1] = '\0'; + if (!dbus_message_iter_open_container (&iter, + DBUS_TYPE_ARRAY, + buf, + &array)) + goto failed; + + if (dbus_type_is_fixed (element_type)) + { + const DBusBasicValue **value; + int n_elements; + + value = va_arg (var_args, const DBusBasicValue**); + n_elements = va_arg (var_args, int); + + if (!dbus_message_iter_append_fixed_array (&array, + element_type, + value, + n_elements)) { + dbus_message_iter_abandon_container (&iter, &array); + goto failed; + } + } + else if (element_type == DBUS_TYPE_STRING || + element_type == DBUS_TYPE_SIGNATURE || + element_type == DBUS_TYPE_OBJECT_PATH) + { + const char ***value_p; + const char **value; + int n_elements; + int i; + + value_p = va_arg (var_args, const char***); + n_elements = va_arg (var_args, int); + + value = *value_p; + + i = 0; + while (i < n_elements) + { + if (!dbus_message_iter_append_basic (&array, + element_type, + &value[i])) { + dbus_message_iter_abandon_container (&iter, &array); + goto failed; + } + ++i; + } + } + else + { + _dbus_warn ("arrays of %s can't be appended with %s for now\n", + _dbus_type_to_string (element_type), + _DBUS_FUNCTION_NAME); + goto failed; + } + + if (!dbus_message_iter_close_container (&iter, &array)) + goto failed; + } +#ifndef DBUS_DISABLE_CHECKS + else + { + _dbus_warn ("type %s isn't supported yet in %s\n", + _dbus_type_to_string (type), _DBUS_FUNCTION_NAME); + goto failed; + } +#endif type = va_arg (var_args, int); } return TRUE; - errorout: + failed: return FALSE; } - /** - * Gets arguments from a message given a variable argument list. - * The variable argument list should contain the type of the - * argumen followed by a pointer to where the value should be - * stored. The list is terminated with #DBUS_TYPE_INVALID. + * Gets arguments from a message given a variable argument list. The + * supported types include those supported by + * dbus_message_append_args(); that is, basic types and arrays of + * fixed-length basic types. The arguments are the same as they would + * be for dbus_message_iter_get_basic() or + * dbus_message_iter_get_fixed_array(). + * + * In addition to those types, arrays of string, object path, and + * signature are supported; but these are returned as allocated memory + * and must be freed with dbus_free_string_array(), while the other + * types are returned as const references. To get a string array + * pass in "char ***array_location" and "int *n_elements" + * + * The variable argument list should contain the type of the argument + * followed by a pointer to where the value should be stored. The list + * is terminated with #DBUS_TYPE_INVALID. + * + * Except for string arrays, the returned values are constant; do not + * free them. They point into the #DBusMessage. + * + * If the requested arguments are not present, or do not have the + * requested types, then an error will be set. + * + * If more arguments than requested are present, the requested + * arguments are returned and the extra arguments are ignored. + * + * @todo support DBUS_TYPE_STRUCT and DBUS_TYPE_VARIANT and complex arrays * * @param message the message * @param error error to be filled in on failure @@ -2031,7 +1673,7 @@ dbus_message_get_args (DBusMessage *message, _dbus_return_val_if_fail (message != NULL, FALSE); _dbus_return_val_if_error_is_set (error, FALSE); - + va_start (var_args, first_arg_type); retval = dbus_message_get_args_valist (message, error, first_arg_type, var_args); va_end (var_args); @@ -2040,9 +1682,7 @@ dbus_message_get_args (DBusMessage *message, } /** - * This function takes a va_list for use by language bindings - * - * @todo We need to free the argument data when an error occurs. + * Like dbus_message_get_args but takes a va_list for use by language bindings. * * @see dbus_message_get_args * @param message the message @@ -2061,5209 +1701,2473 @@ dbus_message_get_args_valist (DBusMessage *message, _dbus_return_val_if_fail (message != NULL, FALSE); _dbus_return_val_if_error_is_set (error, FALSE); - + dbus_message_iter_init (message, &iter); - return dbus_message_iter_get_args_valist (&iter, error, first_arg_type, var_args); + return _dbus_message_iter_get_args_valist (&iter, error, first_arg_type, var_args); } -/** - * Gets arguments from a message iterator given a variable argument list. - * The variable argument list should contain the type of the - * argumen followed by a pointer to where the value should be - * stored. The list is terminated with 0. - * - * @param iter the message iterator - * @param error error to be filled in on failure - * @param first_arg_type the first argument type - * @param ... location for first argument value, then list of type-location pairs - * @returns #FALSE if the error was set - */ -dbus_bool_t -dbus_message_iter_get_args (DBusMessageIter *iter, - DBusError *error, - int first_arg_type, - ...) +static void +_dbus_message_iter_init_common (DBusMessage *message, + DBusMessageRealIter *real, + int iter_type) { - dbus_bool_t retval; - va_list var_args; + _dbus_assert (sizeof (DBusMessageRealIter) <= sizeof (DBusMessageIter)); - _dbus_return_val_if_fail (iter != NULL, FALSE); - _dbus_return_val_if_error_is_set (error, FALSE); + /* Since the iterator will read or write who-knows-what from the + * message, we need to get in the right byte order + */ + ensure_byte_order (message); - va_start (var_args, first_arg_type); - retval = dbus_message_iter_get_args_valist (iter, error, first_arg_type, var_args); - va_end (var_args); - - return retval; + real->message = message; + real->changed_stamp = message->changed_stamp; + real->iter_type = iter_type; + real->sig_refcount = 0; } /** - * This function takes a va_list for use by language bindings - * - * This function supports #DBUS_TYPE_INT64 and #DBUS_TYPE_UINT64 - * only if #DBUS_HAVE_INT64 is defined. - * - * @todo this function (or some lower-level non-convenience function) - * needs better error handling; should allow the application to - * distinguish between out of memory, and bad data from the remote - * app. It also needs to not leak a bunch of args when it gets - * to the arg that's bad, as that would be a security hole - * (allow one app to force another to leak memory) + * Initializes a #DBusMessageIter for reading the arguments of the + * message passed in. * - * @todo We need to free the argument data when an error occurs. + * When possible, dbus_message_get_args() is much more convenient. + * Some types of argument can only be read with #DBusMessageIter + * however. * - * @see dbus_message_get_args - * @param iter the message iter - * @param error error to be filled in - * @param first_arg_type type of the first argument - * @param var_args return location for first argument, followed by list of type/location pairs - * @returns #FALSE if error was set - */ -dbus_bool_t -dbus_message_iter_get_args_valist (DBusMessageIter *iter, - DBusError *error, - int first_arg_type, - va_list var_args) -{ - int spec_type, msg_type, i; - dbus_bool_t retval; - - _dbus_return_val_if_fail (iter != NULL, FALSE); - _dbus_return_val_if_error_is_set (error, FALSE); - - retval = FALSE; - - spec_type = first_arg_type; - i = 0; - - while (spec_type != 0) - { - msg_type = dbus_message_iter_get_arg_type (iter); - - if (msg_type != spec_type) - { - dbus_set_error (error, DBUS_ERROR_INVALID_ARGS, - "Argument %d is specified to be of type \"%s\", but " - "is actually of type \"%s\"\n", i, - _dbus_type_to_string (spec_type), - _dbus_type_to_string (msg_type)); - - goto out; - } - - switch (spec_type) - { - case DBUS_TYPE_NIL: - break; - case DBUS_TYPE_BYTE: - { - unsigned char *ptr; - - ptr = va_arg (var_args, unsigned char *); - - *ptr = dbus_message_iter_get_byte (iter); - break; - } - case DBUS_TYPE_BOOLEAN: - { - dbus_bool_t *ptr; - - ptr = va_arg (var_args, dbus_bool_t *); - - *ptr = dbus_message_iter_get_boolean (iter); - break; - } - case DBUS_TYPE_INT32: - { - dbus_int32_t *ptr; - - ptr = va_arg (var_args, dbus_int32_t *); - - *ptr = dbus_message_iter_get_int32 (iter); - break; - } - case DBUS_TYPE_UINT32: - { - dbus_uint32_t *ptr; - - ptr = va_arg (var_args, dbus_uint32_t *); - - *ptr = dbus_message_iter_get_uint32 (iter); - break; - } -#ifdef DBUS_HAVE_INT64 - case DBUS_TYPE_INT64: - { - dbus_int64_t *ptr; - - ptr = va_arg (var_args, dbus_int64_t *); - - *ptr = dbus_message_iter_get_int64 (iter); - break; - } - case DBUS_TYPE_UINT64: - { - dbus_uint64_t *ptr; - - ptr = va_arg (var_args, dbus_uint64_t *); - - *ptr = dbus_message_iter_get_uint64 (iter); - break; - } -#endif /* DBUS_HAVE_INT64 */ - - case DBUS_TYPE_DOUBLE: - { - double *ptr; - - ptr = va_arg (var_args, double *); - - *ptr = dbus_message_iter_get_double (iter); - break; - } - - case DBUS_TYPE_STRING: - { - char **ptr; - - ptr = va_arg (var_args, char **); - - *ptr = dbus_message_iter_get_string (iter); - - if (!*ptr) - { - dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL); - goto out; - } - - break; - } - - case DBUS_TYPE_CUSTOM: - { - char **name; - unsigned char **data; - int *len; - - name = va_arg (var_args, char **); - data = va_arg (var_args, unsigned char **); - len = va_arg (var_args, int *); - - if (!dbus_message_iter_get_custom (iter, name, data, len)) - { - dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL); - goto out; - } - } - break; - case DBUS_TYPE_ARRAY: - { - void **data; - int *len, type; - dbus_bool_t err = FALSE; - - type = va_arg (var_args, int); - data = va_arg (var_args, void *); - len = va_arg (var_args, int *); - - _dbus_return_val_if_fail (data != NULL, FALSE); - _dbus_return_val_if_fail (len != NULL, FALSE); - - if (dbus_message_iter_get_array_type (iter) != type) - { - dbus_set_error (error, DBUS_ERROR_INVALID_ARGS, - "Argument %d is specified to be of type \"array of %s\", but " - "is actually of type \"array of %s\"\n", i, - _dbus_type_to_string (type), - _dbus_type_to_string (dbus_message_iter_get_array_type (iter))); - goto out; - } - - switch (type) - { - case DBUS_TYPE_BYTE: - err = !dbus_message_iter_get_byte_array (iter, (unsigned char **)data, len); - break; - case DBUS_TYPE_BOOLEAN: - err = !dbus_message_iter_get_boolean_array (iter, (unsigned char **)data, len); - break; - case DBUS_TYPE_INT32: - err = !dbus_message_iter_get_int32_array (iter, (dbus_int32_t **)data, len); - break; - case DBUS_TYPE_UINT32: - err = !dbus_message_iter_get_uint32_array (iter, (dbus_uint32_t **)data, len); - break; -#ifdef DBUS_HAVE_INT64 - case DBUS_TYPE_INT64: - err = !dbus_message_iter_get_int64_array (iter, (dbus_int64_t **)data, len); - break; - case DBUS_TYPE_UINT64: - err = !dbus_message_iter_get_uint64_array (iter, (dbus_uint64_t **)data, len); - break; -#endif /* DBUS_HAVE_INT64 */ - case DBUS_TYPE_DOUBLE: - err = !dbus_message_iter_get_double_array (iter, (double **)data, len); - break; - case DBUS_TYPE_STRING: - err = !dbus_message_iter_get_string_array (iter, (char ***)data, len); - break; - case DBUS_TYPE_NIL: - case DBUS_TYPE_ARRAY: - case DBUS_TYPE_CUSTOM: - case DBUS_TYPE_DICT: - _dbus_warn ("dbus_message_get_args_valist doesn't support recursive arrays\n"); - dbus_set_error (error, DBUS_ERROR_NOT_SUPPORTED, NULL); - goto out; - default: - _dbus_warn ("Unknown field type %d\n", type); - dbus_set_error (error, DBUS_ERROR_NOT_SUPPORTED, NULL); - goto out; - } - if (err) - { - dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL); - goto out; - } - } - break; - case DBUS_TYPE_DICT: - _dbus_warn ("dbus_message_get_args_valist doesn't support dicts\n"); - dbus_set_error (error, DBUS_ERROR_NOT_SUPPORTED, NULL); - goto out; - default: - dbus_set_error (error, DBUS_ERROR_NOT_SUPPORTED, NULL); - _dbus_warn ("Unknown field type %d\n", spec_type); - goto out; - } - - spec_type = va_arg (var_args, int); - if (spec_type != 0 && !dbus_message_iter_next (iter)) - { - dbus_set_error (error, DBUS_ERROR_INVALID_ARGS, - "Message has only %d arguments, but more were expected", i); - goto out; - } - - i++; - } - - retval = TRUE; - - out: - - return retval; -} - - -/** - * Initializes a DBusMessageIter representing the arguments of the - * message passed in. + * The easiest way to iterate is like this: + * @code + * dbus_message_iter_init (message, &iter); + * while ((current_type = dbus_message_iter_get_arg_type (&iter)) != DBUS_TYPE_INVALID) + * dbus_message_iter_next (&iter); + * @endcode * + * #DBusMessageIter contains no allocated memory; it need not be + * freed, and can be copied by assignment or memcpy(). + * * @param message the message * @param iter pointer to an iterator to initialize + * @returns #FALSE if the message has no arguments */ -void +dbus_bool_t dbus_message_iter_init (DBusMessage *message, DBusMessageIter *iter) { DBusMessageRealIter *real = (DBusMessageRealIter *)iter; + const DBusString *type_str; + int type_pos; - _dbus_return_if_fail (message != NULL); - _dbus_return_if_fail (iter != NULL); - - _dbus_assert (sizeof (DBusMessageRealIter) <= sizeof (DBusMessageIter)); - - real->message = message; - real->parent_iter = NULL; - real->changed_stamp = message->changed_stamp; - - real->type = DBUS_MESSAGE_ITER_TYPE_MESSAGE; - real->pos = 0; - real->end = _dbus_string_get_length (&message->body); - - real->container_start = 0; - real->container_length_pos = 0; - real->wrote_dict_key = 0; - real->array_type_pos = 0; -} - -#ifndef DBUS_DISABLE_CHECKS -static dbus_bool_t -dbus_message_iter_check (DBusMessageRealIter *iter) -{ - if (iter == NULL) - { - _dbus_warn ("dbus iterator check failed: iterator is NULL\n"); - return FALSE; - } - - if (iter->changed_stamp != iter->message->changed_stamp) - { - _dbus_warn ("dbus iterator check failed: invalid iterator, must re-initialize it after modifying the message\n"); - return FALSE; - } - - if (iter->pos < 0 || iter->pos > iter->end) - { - _dbus_warn ("dbus iterator check failed: invalid position\n"); - return FALSE; - } - - return TRUE; -} -#endif /* DBUS_DISABLE_CHECKS */ + _dbus_return_val_if_fail (message != NULL, FALSE); + _dbus_return_val_if_fail (iter != NULL, FALSE); -static int -skip_array_type (DBusMessageRealIter *iter, int pos) -{ - const char *data; + get_const_signature (&message->header, &type_str, &type_pos); - do - { - data = _dbus_string_get_const_data_len (&iter->message->body, - pos++, 1); - } - while (*data == DBUS_TYPE_ARRAY); - - return pos; -} + _dbus_message_iter_init_common (message, real, + DBUS_MESSAGE_ITER_TYPE_READER); -/* FIXME what are these _dbus_type_is_valid() checks for? - * haven't we validated the message? - */ -static int -dbus_message_iter_get_data_start (DBusMessageRealIter *iter, int *type) -{ - const char *data; - int pos, len; - - switch (iter->type) - { - case DBUS_MESSAGE_ITER_TYPE_MESSAGE: - data = _dbus_string_get_const_data_len (&iter->message->body, - iter->pos, 1); - if (_dbus_type_is_valid (*data)) - *type = *data; - else - *type = DBUS_TYPE_INVALID; - - return skip_array_type (iter, iter->pos); - - case DBUS_MESSAGE_ITER_TYPE_ARRAY: - data = _dbus_string_get_const_data_len (&iter->message->body, - iter->array_type_pos, 1); - if (_dbus_type_is_valid (*data)) - *type = *data; - else - *type = DBUS_TYPE_INVALID; - - return iter->pos; - - case DBUS_MESSAGE_ITER_TYPE_DICT: - /* Get the length of the string */ - len = _dbus_demarshal_uint32 (&iter->message->body, - iter->message->byte_order, - iter->pos, &pos); - pos = pos + len + 1; - - data = _dbus_string_get_const_data_len (&iter->message->body, - pos, 1); - if (_dbus_type_is_valid (*data)) - *type = *data; - else - *type = DBUS_TYPE_INVALID; + _dbus_type_reader_init (&real->u.reader, + message->byte_order, + type_str, type_pos, + &message->body, + 0); - return skip_array_type (iter, pos); - - default: - _dbus_assert_not_reached ("Invalid iter type"); - break; - } - *type = DBUS_TYPE_INVALID; - return iter->pos; + return _dbus_type_reader_get_current_type (&real->u.reader) != DBUS_TYPE_INVALID; } - /** * Checks if an iterator has any more fields. * * @param iter the message iter - * @returns #TRUE if there are more fields - * following + * @returns #TRUE if there are more fields following */ dbus_bool_t dbus_message_iter_has_next (DBusMessageIter *iter) { DBusMessageRealIter *real = (DBusMessageRealIter *)iter; - int end_pos; - int type, pos; - - _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE); - if (real->pos >= real->end) - return FALSE; - - pos = dbus_message_iter_get_data_start (real, &type); - - if (!_dbus_marshal_get_arg_end_pos (&real->message->body, - real->message->byte_order, - type, pos, &end_pos)) - return FALSE; - - if (end_pos >= real->end) - return FALSE; + _dbus_return_val_if_fail (_dbus_message_iter_check (real), FALSE); + _dbus_return_val_if_fail (real->iter_type == DBUS_MESSAGE_ITER_TYPE_READER, FALSE); - return TRUE; + return _dbus_type_reader_has_next (&real->u.reader); } /** - * Moves the iterator to the next field. + * Moves the iterator to the next field, if any. If there's no next + * field, returns #FALSE. If the iterator moves forward, returns + * #TRUE. * - * @param iter The message iter + * @param iter the message iter * @returns #TRUE if the iterator was moved to the next field */ dbus_bool_t dbus_message_iter_next (DBusMessageIter *iter) { DBusMessageRealIter *real = (DBusMessageRealIter *)iter; - int end_pos; - int type, pos; - - _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE); - - pos = dbus_message_iter_get_data_start (real, &type); - - if (!_dbus_marshal_get_arg_end_pos (&real->message->body, - real->message->byte_order, - type, pos, &end_pos)) - return FALSE; - - if (end_pos >= real->end) - return FALSE; - real->pos = end_pos; + _dbus_return_val_if_fail (_dbus_message_iter_check (real), FALSE); + _dbus_return_val_if_fail (real->iter_type == DBUS_MESSAGE_ITER_TYPE_READER, FALSE); - return TRUE; + return _dbus_type_reader_next (&real->u.reader); } /** - * Returns the argument type of the argument that the - * message iterator points at. + * Returns the argument type of the argument that the message iterator + * points to. If the iterator is at the end of the message, returns + * #DBUS_TYPE_INVALID. You can thus write a loop as follows: + * + * @code + * dbus_message_iter_init (&iter); + * while ((current_type = dbus_message_iter_get_arg_type (&iter)) != DBUS_TYPE_INVALID) + * dbus_message_iter_next (&iter); + * @endcode * * @param iter the message iter - * @returns the field type + * @returns the argument type */ int dbus_message_iter_get_arg_type (DBusMessageIter *iter) { DBusMessageRealIter *real = (DBusMessageRealIter *)iter; - int type, pos; - - _dbus_return_val_if_fail (dbus_message_iter_check (real), DBUS_TYPE_INVALID); - - if (real->pos >= real->end) - { - _dbus_verbose (" iterator at or beyond end of message\n"); - return DBUS_TYPE_INVALID; - } - - pos = dbus_message_iter_get_data_start (real, &type); - - return type; -} -/* FIXME why do we validate the typecode in here, hasn't the message - * already been verified? - */ -static int -iter_get_array_type (DBusMessageRealIter *iter, int *array_type_pos) -{ - const char *data; - int _array_type_pos; - int len, pos; - - switch (iter->type) - { - case DBUS_MESSAGE_ITER_TYPE_MESSAGE: - _array_type_pos = iter->pos + 1; - break; - case DBUS_MESSAGE_ITER_TYPE_ARRAY: - _array_type_pos = iter->array_type_pos + 1; - break; - case DBUS_MESSAGE_ITER_TYPE_DICT: - /* Get the length of the string */ - len = _dbus_demarshal_uint32 (&iter->message->body, - iter->message->byte_order, - iter->pos, &pos); - pos = pos + len + 1; - data = _dbus_string_get_const_data_len (&iter->message->body, - pos + 1, 1); - _array_type_pos = pos + 1; - break; - default: - _dbus_assert_not_reached ("wrong iter type"); - return DBUS_TYPE_INVALID; - } + _dbus_return_val_if_fail (_dbus_message_iter_check (real), DBUS_TYPE_INVALID); + _dbus_return_val_if_fail (real->iter_type == DBUS_MESSAGE_ITER_TYPE_READER, FALSE); - if (array_type_pos != NULL) - *array_type_pos = _array_type_pos; - - data = _dbus_string_get_const_data_len (&iter->message->body, - _array_type_pos, 1); - if (_dbus_type_is_valid (*data)) - return *data; - - return DBUS_TYPE_INVALID; + return _dbus_type_reader_get_current_type (&real->u.reader); } - /** - * Returns the element type of the array that the - * message iterator points at. Note that you need - * to check that the iterator points to an array - * prior to using this function. + * Returns the element type of the array that the message iterator + * points to. Note that you need to check that the iterator points to + * an array prior to using this function. * * @param iter the message iter - * @returns the field type + * @returns the array element type */ int -dbus_message_iter_get_array_type (DBusMessageIter *iter) +dbus_message_iter_get_element_type (DBusMessageIter *iter) { DBusMessageRealIter *real = (DBusMessageRealIter *)iter; - int type, pos; - - _dbus_return_val_if_fail (dbus_message_iter_check (real), DBUS_TYPE_INVALID); - - if (real->pos >= real->end) - return DBUS_TYPE_INVALID; - - pos = dbus_message_iter_get_data_start (real, &type); - _dbus_assert (type == DBUS_TYPE_ARRAY); + _dbus_return_val_if_fail (_dbus_message_iter_check (real), DBUS_TYPE_INVALID); + _dbus_return_val_if_fail (real->iter_type == DBUS_MESSAGE_ITER_TYPE_READER, DBUS_TYPE_INVALID); + _dbus_return_val_if_fail (dbus_message_iter_get_arg_type (iter) == DBUS_TYPE_ARRAY, DBUS_TYPE_INVALID); - return iter_get_array_type (real, NULL); + return _dbus_type_reader_get_element_type (&real->u.reader); } - /** - * Returns the string value that an iterator may point to. - * Note that you need to check that the iterator points to - * a string value before using this function. + * Recurses into a container value when reading values from a message, + * initializing a sub-iterator to use for traversing the child values + * of the container. * - * @see dbus_message_iter_get_arg_type - * @param iter the message iter - * @returns the string + * Note that this recurses into a value, not a type, so you can only + * recurse if the value exists. The main implication of this is that + * if you have for example an empty array of array of int32, you can + * recurse into the outermost array, but it will have no values, so + * you won't be able to recurse further. There's no array of int32 to + * recurse into. + * + * If a container is an array of fixed-length types, it is much more + * efficient to use dbus_message_iter_get_fixed_array() to get the + * whole array in one shot, rather than individually walking over the + * array elements. + * + * Be sure you have somehow checked that + * dbus_message_iter_get_arg_type() matches the type you are expecting + * to recurse into. Results of this function are undefined if there is + * no container to recurse into at the current iterator position. + * + * @param iter the message iterator + * @param sub the sub-iterator to initialize */ -char * -dbus_message_iter_get_string (DBusMessageIter *iter) +void +dbus_message_iter_recurse (DBusMessageIter *iter, + DBusMessageIter *sub) { DBusMessageRealIter *real = (DBusMessageRealIter *)iter; - int type, pos; - - _dbus_return_val_if_fail (dbus_message_iter_check (real), NULL); + DBusMessageRealIter *real_sub = (DBusMessageRealIter *)sub; - pos = dbus_message_iter_get_data_start (real, &type); - - _dbus_assert (type == DBUS_TYPE_STRING); + _dbus_return_if_fail (_dbus_message_iter_check (real)); + _dbus_return_if_fail (sub != NULL); - return _dbus_demarshal_string (&real->message->body, real->message->byte_order, - pos, NULL); + *real_sub = *real; + _dbus_type_reader_recurse (&real->u.reader, &real_sub->u.reader); } -#if 0 /** - * @todo FIXME to finish this _dbus_demarshal_object_path() needs - * to not explode the path. - * - * Returns the object path value that an iterator may point to. - * Note that you need to check that the iterator points to - * an object path value before using this function. + * Returns the current signature of a message iterator. This + * is useful primarily for dealing with variants; one can + * recurse into a variant and determine the signature of + * the variant's value. * - * @see dbus_message_iter_get_arg_type - * @param iter the message iter - * @returns the path + * The returned string must be freed with dbus_free(). + * + * @param iter the message iterator + * @returns the contained signature, or NULL if out of memory */ char * -dbus_message_iter_get_object_path (DBusMessageIter *iter) +dbus_message_iter_get_signature (DBusMessageIter *iter) { + const DBusString *sig; + DBusString retstr; + char *ret; + int start, len; DBusMessageRealIter *real = (DBusMessageRealIter *)iter; - int type, pos; - _dbus_return_val_if_fail (dbus_message_iter_check (real), NULL); + _dbus_return_val_if_fail (_dbus_message_iter_check (real), NULL); - pos = dbus_message_iter_get_data_start (real, &type); - - _dbus_assert (type == DBUS_TYPE_OBJECT_PATH); + if (!_dbus_string_init (&retstr)) + return NULL; - return _dbus_demarshal_object_path (&real->message->body, real->message->byte_order, - pos, NULL); + _dbus_type_reader_get_signature (&real->u.reader, &sig, + &start, &len); + if (!_dbus_string_append_len (&retstr, + _dbus_string_get_const_data (sig) + start, + len)) + return NULL; + if (!_dbus_string_steal_data (&retstr, &ret)) + return NULL; + _dbus_string_free (&retstr); + return ret; } -#endif /** - * Returns the name and data from a custom type that an iterator may - * point to. Note that you need to check that the iterator points to a - * custom type before using this function. + * Reads a basic-typed value from the message iterator. + * Basic types are the non-containers such as integer and string. * - * @see dbus_message_iter_get_arg_type - * @param iter the message iter - * @param name return location for the name of the custom type - * @param value return location for data - * @param len return location for length of data - * @returns TRUE if get succeed + * The value argument should be the address of a location to store + * the returned value. So for int32 it should be a "dbus_int32_t*" + * and for string a "const char**". The returned value is + * by reference and should not be freed. + * + * Be sure you have somehow checked that + * dbus_message_iter_get_arg_type() matches the type you are + * expecting, or you'll crash when you try to use an integer as a + * string or something. + * + * To read any container type (array, struct, dict) you will need + * to recurse into the container with dbus_message_iter_recurse(). + * If the container is an array of fixed-length values, you can + * get all the array elements at once with + * dbus_message_iter_get_fixed_array(). Otherwise, you have to + * iterate over the container's contents one value at a time. * - */ -dbus_bool_t -dbus_message_iter_get_custom (DBusMessageIter *iter, - char **name, - unsigned char **value, - int *len) -{ - DBusMessageRealIter *real = (DBusMessageRealIter *)iter; - int type, pos; - char *_name; - - _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE); - - pos = dbus_message_iter_get_data_start (real, &type); - - _dbus_assert (type == DBUS_TYPE_CUSTOM); - - _name = _dbus_demarshal_string (&real->message->body, real->message->byte_order, - pos, &pos); - - if (_name == NULL) - return FALSE; - - if (!_dbus_demarshal_byte_array (&real->message->body, real->message->byte_order, - pos, NULL, value, len)) - { - dbus_free (_name); - return FALSE; - } - - *name = _name; - - return TRUE; -} - -/** - * Returns the byte value that an iterator may point to. - * Note that you need to check that the iterator points to - * a byte value before using this function. + * All basic-typed values are guaranteed to fit in 8 bytes. So you can + * write code like this: * - * @see dbus_message_iter_get_arg_type - * @param iter the message iter - * @returns the byte value + * @code + * dbus_uint64_t value; + * int type; + * dbus_message_iter_get_basic (&read_iter, &value); + * type = dbus_message_iter_get_arg_type (&read_iter); + * dbus_message_iter_append_basic (&write_iter, type, &value); + * @endcode + * + * On some really obscure platforms dbus_uint64_t might not exist, if + * you need to worry about this you will know. dbus_uint64_t is just + * one example of a type that's large enough to hold any possible + * value, you could use a struct or char[8] instead if you like. + * + * @param iter the iterator + * @param value location to store the value */ -unsigned char -dbus_message_iter_get_byte (DBusMessageIter *iter) +void +dbus_message_iter_get_basic (DBusMessageIter *iter, + void *value) { - unsigned char value; DBusMessageRealIter *real = (DBusMessageRealIter *)iter; - int type, pos; - _dbus_return_val_if_fail (dbus_message_iter_check (real), 0); + _dbus_return_if_fail (_dbus_message_iter_check (real)); + _dbus_return_if_fail (value != NULL); - pos = dbus_message_iter_get_data_start (real, &type); - - _dbus_assert (type == DBUS_TYPE_BYTE); - - value = _dbus_string_get_byte (&real->message->body, pos); - - return value; + _dbus_type_reader_read_basic (&real->u.reader, + value); } - /** - * Returns the boolean value that an iterator may point to. - * Note that you need to check that the iterator points to - * a boolean value before using this function. + * Returns the number of bytes in the array as marshaled in the wire + * protocol. The iterator must currently be inside an array-typed + * value. * - * @see dbus_message_iter_get_arg_type - * @param iter the message iter - * @returns the boolean value + * This function is deprecated on the grounds that it is stupid. Why + * would you want to know how many bytes are in the array as marshaled + * in the wire protocol? For now, use the n_elements returned from + * dbus_message_iter_get_fixed_array() instead, or iterate over the + * array values and count them. + * + * @todo introduce a variant of this get_n_elements that returns + * the number of elements, though with a non-fixed array it will not + * be very efficient, so maybe it's not good. + * + * @param iter the iterator + * @returns the number of bytes in the array */ -dbus_bool_t -dbus_message_iter_get_boolean (DBusMessageIter *iter) +int +dbus_message_iter_get_array_len (DBusMessageIter *iter) { - unsigned char value; DBusMessageRealIter *real = (DBusMessageRealIter *)iter; - int type, pos; - _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE); - - pos = dbus_message_iter_get_data_start (real, &type); - - _dbus_assert (type == DBUS_TYPE_BOOLEAN); + _dbus_return_val_if_fail (_dbus_message_iter_check (real), 0); - value = _dbus_string_get_byte (&real->message->body, pos); - - return value; + return _dbus_type_reader_get_array_length (&real->u.reader); } /** - * Returns the 32 bit signed integer value that an iterator may point to. - * Note that you need to check that the iterator points to - * a 32-bit integer value before using this function. + * Reads a block of fixed-length values from the message iterator. + * Fixed-length values are those basic types that are not string-like, + * such as integers, bool, double. The returned block will be from the + * current position in the array until the end of the array. * - * @see dbus_message_iter_get_arg_type - * @param iter the message iter - * @returns the integer + * The message iter should be "in" the array (that is, you recurse into the + * array, and then you call dbus_message_iter_get_fixed_array() on the + * "sub-iterator" created by dbus_message_iter_recurse()). + * + * The value argument should be the address of a location to store the + * returned array. So for int32 it should be a "const dbus_int32_t**" + * The returned value is by reference and should not be freed. + * + * This function should only be used if dbus_type_is_fixed() returns + * #TRUE for the element type. + * + * If an array's elements are not fixed in size, you have to recurse + * into the array with dbus_message_iter_recurse() and read the + * elements one by one. + * + * Because the array is not copied, this function runs in constant + * time and is fast; it's much preferred over walking the entire array + * with an iterator. (However, you can always use + * dbus_message_iter_recurse(), even for fixed-length types; + * dbus_message_iter_get_fixed_array() is just an optimization.) + * + * @param iter the iterator + * @param value location to store the block + * @param n_elements number of elements in the block */ -dbus_int32_t -dbus_message_iter_get_int32 (DBusMessageIter *iter) +void +dbus_message_iter_get_fixed_array (DBusMessageIter *iter, + void *value, + int *n_elements) { DBusMessageRealIter *real = (DBusMessageRealIter *)iter; - int type, pos; + int subtype = _dbus_type_reader_get_current_type(&real->u.reader); - _dbus_return_val_if_fail (dbus_message_iter_check (real), 0); + _dbus_return_if_fail (_dbus_message_iter_check (real)); + _dbus_return_if_fail (value != NULL); + _dbus_return_if_fail ((subtype == DBUS_TYPE_INVALID) || + dbus_type_is_fixed (subtype)); - pos = dbus_message_iter_get_data_start (real, &type); - - _dbus_assert (type == DBUS_TYPE_INT32); - - return _dbus_demarshal_int32 (&real->message->body, real->message->byte_order, - pos, NULL); + _dbus_type_reader_read_fixed_multi (&real->u.reader, + value, n_elements); } /** - * Returns the 32 bit unsigned integer value that an iterator may point to. - * Note that you need to check that the iterator points to - * a 32-bit unsigned integer value before using this function. + * Initializes a #DBusMessageIter for appending arguments to the end + * of a message. * - * @see dbus_message_iter_get_arg_type - * @param iter the message iter - * @returns the integer + * @todo If appending any of the arguments fails due to lack of + * memory, the message is hosed and you have to start over building + * the whole message. + * + * @param message the message + * @param iter pointer to an iterator to initialize */ -dbus_uint32_t -dbus_message_iter_get_uint32 (DBusMessageIter *iter) +void +dbus_message_iter_init_append (DBusMessage *message, + DBusMessageIter *iter) { DBusMessageRealIter *real = (DBusMessageRealIter *)iter; - int type, pos; - _dbus_return_val_if_fail (dbus_message_iter_check (real), 0); + _dbus_return_if_fail (message != NULL); + _dbus_return_if_fail (iter != NULL); + + _dbus_message_iter_init_common (message, real, + DBUS_MESSAGE_ITER_TYPE_WRITER); - pos = dbus_message_iter_get_data_start (real, &type); - - _dbus_assert (type == DBUS_TYPE_UINT32); - - return _dbus_demarshal_uint32 (&real->message->body, real->message->byte_order, - pos, NULL); + /* We create the signature string and point iterators at it "on demand" + * when a value is actually appended. That means that init() never fails + * due to OOM. + */ + _dbus_type_writer_init_types_delayed (&real->u.writer, + message->byte_order, + &message->body, + _dbus_string_get_length (&message->body)); } -#ifdef DBUS_HAVE_INT64 - /** - * Returns the 64 bit signed integer value that an iterator may point - * to. Note that you need to check that the iterator points to a - * 64-bit integer value before using this function. - * - * This function only exists if #DBUS_HAVE_INT64 is defined. + * Creates a temporary signature string containing the current + * signature, stores it in the iterator, and points the iterator to + * the end of it. Used any time we write to the message. * - * @see dbus_message_iter_get_arg_type - * @param iter the message iter - * @returns the integer + * @param real an iterator without a type_str + * @returns #FALSE if no memory */ -dbus_int64_t -dbus_message_iter_get_int64 (DBusMessageIter *iter) +static dbus_bool_t +_dbus_message_iter_open_signature (DBusMessageRealIter *real) { - DBusMessageRealIter *real = (DBusMessageRealIter *)iter; - int type, pos; + DBusString *str; + const DBusString *current_sig; + int current_sig_pos; - _dbus_return_val_if_fail (dbus_message_iter_check (real), 0); + _dbus_assert (real->iter_type == DBUS_MESSAGE_ITER_TYPE_WRITER); - pos = dbus_message_iter_get_data_start (real, &type); - - _dbus_assert (type == DBUS_TYPE_INT64); - - return _dbus_demarshal_int64 (&real->message->body, real->message->byte_order, - pos, NULL); -} + if (real->u.writer.type_str != NULL) + { + _dbus_assert (real->sig_refcount > 0); + real->sig_refcount += 1; + return TRUE; + } -/** - * Returns the 64 bit unsigned integer value that an iterator may point to. - * Note that you need to check that the iterator points to - * a 64-bit unsigned integer value before using this function. - * - * This function only exists if #DBUS_HAVE_INT64 is defined. - * - * @see dbus_message_iter_get_arg_type - * @param iter the message iter - * @returns the integer - */ -dbus_uint64_t -dbus_message_iter_get_uint64 (DBusMessageIter *iter) -{ - DBusMessageRealIter *real = (DBusMessageRealIter *)iter; - int type, pos; + str = dbus_new (DBusString, 1); + if (str == NULL) + return FALSE; - _dbus_return_val_if_fail (dbus_message_iter_check (real), 0); + if (!_dbus_header_get_field_raw (&real->message->header, + DBUS_HEADER_FIELD_SIGNATURE, + ¤t_sig, ¤t_sig_pos)) + current_sig = NULL; - pos = dbus_message_iter_get_data_start (real, &type); - - _dbus_assert (type == DBUS_TYPE_UINT64); - - return _dbus_demarshal_uint64 (&real->message->body, real->message->byte_order, - pos, NULL); -} + if (current_sig) + { + int current_len; -#endif /* DBUS_HAVE_INT64 */ + current_len = _dbus_string_get_byte (current_sig, current_sig_pos); + current_sig_pos += 1; /* move on to sig data */ -/** - * Returns the double value that an iterator may point to. - * Note that you need to check that the iterator points to - * a string value before using this function. - * - * @see dbus_message_iter_get_arg_type - * @param iter the message iter - * @returns the double - */ -double -dbus_message_iter_get_double (DBusMessageIter *iter) -{ - DBusMessageRealIter *real = (DBusMessageRealIter *)iter; - int type, pos; + if (!_dbus_string_init_preallocated (str, current_len + 4)) + { + dbus_free (str); + return FALSE; + } + + if (!_dbus_string_copy_len (current_sig, current_sig_pos, current_len, + str, 0)) + { + _dbus_string_free (str); + dbus_free (str); + return FALSE; + } + } + else + { + if (!_dbus_string_init_preallocated (str, 4)) + { + dbus_free (str); + return FALSE; + } + } - _dbus_return_val_if_fail (dbus_message_iter_check (real), 0.0); + real->sig_refcount = 1; - pos = dbus_message_iter_get_data_start (real, &type); - - _dbus_assert (type == DBUS_TYPE_DOUBLE); - - return _dbus_demarshal_double (&real->message->body, real->message->byte_order, - pos, NULL); + _dbus_type_writer_add_types (&real->u.writer, + str, _dbus_string_get_length (str)); + return TRUE; } /** - * Initializes an iterator for the array that the iterator - * may point to. Note that you need to check that the iterator - * points to an array prior to using this function. - * - * The array element type is returned in array_type, and the array - * iterator can only be used to get that type of data. + * Sets the new signature as the message signature, frees the + * signature string, and marks the iterator as not having a type_str + * anymore. Frees the signature even if it fails, so you can't + * really recover from failure. Kinda busted. * - * @param iter the iterator - * @param array_iter pointer to an iterator to initialize - * @param array_type gets set to the type of the array elements + * @param real an iterator without a type_str + * @returns #FALSE if no memory */ -void -dbus_message_iter_init_array_iterator (DBusMessageIter *iter, - DBusMessageIter *array_iter, - int *array_type) +static dbus_bool_t +_dbus_message_iter_close_signature (DBusMessageRealIter *real) { - DBusMessageRealIter *real = (DBusMessageRealIter *)iter; - DBusMessageRealIter *array_real = (DBusMessageRealIter *)array_iter; - int type, pos, len_pos, len, array_type_pos; - int _array_type; + DBusString *str; + const char *v_STRING; + dbus_bool_t retval; - _dbus_return_if_fail (dbus_message_iter_check (real)); + _dbus_assert (real->iter_type == DBUS_MESSAGE_ITER_TYPE_WRITER); + _dbus_assert (real->u.writer.type_str != NULL); + _dbus_assert (real->sig_refcount > 0); - pos = dbus_message_iter_get_data_start (real, &type); - - _dbus_assert (type == DBUS_TYPE_ARRAY); + real->sig_refcount -= 1; - _array_type = iter_get_array_type (real, &array_type_pos); - - len_pos = _DBUS_ALIGN_VALUE (pos, sizeof (dbus_uint32_t)); - len = _dbus_demarshal_uint32 (&real->message->body, real->message->byte_order, - pos, &pos); - - array_real->parent_iter = real; - array_real->message = real->message; - array_real->changed_stamp = real->message->changed_stamp; - - array_real->type = DBUS_MESSAGE_ITER_TYPE_ARRAY; - array_real->pos = pos; - array_real->end = pos + len; - - array_real->container_start = pos; - array_real->container_length_pos = len_pos; - array_real->wrote_dict_key = 0; - array_real->array_type_pos = array_type_pos; - array_real->array_type_done = TRUE; - - if (array_type != NULL) - *array_type = _array_type; -} + if (real->sig_refcount > 0) + return TRUE; + _dbus_assert (real->sig_refcount == 0); + retval = TRUE; -/** - * Initializes an iterator for the dict that the iterator - * may point to. Note that you need to check that the iterator - * points to a dict prior to using this function. - * - * @param iter the iterator - * @param dict_iter pointer to an iterator to initialize - */ -void -dbus_message_iter_init_dict_iterator (DBusMessageIter *iter, - DBusMessageIter *dict_iter) -{ - DBusMessageRealIter *real = (DBusMessageRealIter *)iter; - DBusMessageRealIter *dict_real = (DBusMessageRealIter *)dict_iter; - int type, pos, len_pos, len; + str = real->u.writer.type_str; - _dbus_return_if_fail (dbus_message_iter_check (real)); + v_STRING = _dbus_string_get_const_data (str); + if (!_dbus_header_set_field_basic (&real->message->header, + DBUS_HEADER_FIELD_SIGNATURE, + DBUS_TYPE_SIGNATURE, + &v_STRING)) + retval = FALSE; - pos = dbus_message_iter_get_data_start (real, &type); - - _dbus_assert (type == DBUS_TYPE_DICT); + _dbus_type_writer_remove_types (&real->u.writer); + _dbus_string_free (str); + dbus_free (str); - len_pos = _DBUS_ALIGN_VALUE (pos, sizeof (dbus_uint32_t)); - len = _dbus_demarshal_uint32 (&real->message->body, real->message->byte_order, - pos, &pos); - - dict_real->parent_iter = real; - dict_real->message = real->message; - dict_real->changed_stamp = real->message->changed_stamp; - - dict_real->type = DBUS_MESSAGE_ITER_TYPE_DICT; - dict_real->pos = pos; - dict_real->end = pos + len; - - dict_real->container_start = pos; - dict_real->container_length_pos = len_pos; - dict_real->wrote_dict_key = 0; + return retval; } /** - * Returns the byte array that the iterator may point to. - * Note that you need to check that the iterator points - * to a byte array prior to using this function. + * Frees the signature string and marks the iterator as not having a + * type_str anymore. Since the new signature is not set, the message + * will generally be hosed after this is called. * - * @param iter the iterator - * @param value return location for array values - * @param len return location for length of byte array - * @returns #TRUE on success + * @param real an iterator without a type_str */ -dbus_bool_t -dbus_message_iter_get_byte_array (DBusMessageIter *iter, - unsigned char **value, - int *len) +static void +_dbus_message_iter_abandon_signature (DBusMessageRealIter *real) { - DBusMessageRealIter *real = (DBusMessageRealIter *)iter; - int type, pos; + DBusString *str; - _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE); + _dbus_assert (real->iter_type == DBUS_MESSAGE_ITER_TYPE_WRITER); + _dbus_assert (real->u.writer.type_str != NULL); + _dbus_assert (real->sig_refcount > 0); - pos = dbus_message_iter_get_data_start (real, &type); - - _dbus_assert (type == DBUS_TYPE_ARRAY); + real->sig_refcount -= 1; - type = iter_get_array_type (real, NULL); + if (real->sig_refcount > 0) + return; + _dbus_assert (real->sig_refcount == 0); - _dbus_assert (type == DBUS_TYPE_BYTE); + str = real->u.writer.type_str; + + _dbus_type_writer_remove_types (&real->u.writer); + _dbus_string_free (str); + dbus_free (str); +} - if (!_dbus_demarshal_byte_array (&real->message->body, real->message->byte_order, - pos, NULL, value, len)) +#ifndef DBUS_DISABLE_CHECKS +static dbus_bool_t +_dbus_message_iter_append_check (DBusMessageRealIter *iter) +{ + if (!_dbus_message_iter_check (iter)) return FALSE; - else - return TRUE; + + if (iter->message->locked) + { + _dbus_warn_check_failed ("dbus append iterator can't be used: message is locked (has already been sent)\n"); + return FALSE; + } + + return TRUE; } +#endif /* DBUS_DISABLE_CHECKS */ /** - * Returns the boolean array that the iterator may point to. Note that - * you need to check that the iterator points to an array of the - * correct type prior to using this function. + * Appends a basic-typed value to the message. The basic types are the + * non-container types such as integer and string. * - * @param iter the iterator - * @param value return location for the array - * @param len return location for the array length - * @returns #TRUE on success + * The "value" argument should be the address of a basic-typed value. + * So for string, const char**. For integer, dbus_int32_t*. + * + * @todo If this fails due to lack of memory, the message is hosed and + * you have to start over building the whole message. + * + * @param iter the append iterator + * @param type the type of the value + * @param value the address of the value + * @returns #FALSE if not enough memory */ dbus_bool_t -dbus_message_iter_get_boolean_array (DBusMessageIter *iter, - unsigned char **value, - int *len) +dbus_message_iter_append_basic (DBusMessageIter *iter, + int type, + const void *value) { DBusMessageRealIter *real = (DBusMessageRealIter *)iter; - int type, pos; + dbus_bool_t ret; - _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE); + _dbus_return_val_if_fail (_dbus_message_iter_append_check (real), FALSE); + _dbus_return_val_if_fail (real->iter_type == DBUS_MESSAGE_ITER_TYPE_WRITER, FALSE); + _dbus_return_val_if_fail (dbus_type_is_basic (type), FALSE); + _dbus_return_val_if_fail (value != NULL, FALSE); - pos = dbus_message_iter_get_data_start (real, &type); - - _dbus_assert (type == DBUS_TYPE_ARRAY); + if (!_dbus_message_iter_open_signature (real)) + return FALSE; - type = iter_get_array_type (real, NULL); + ret = _dbus_type_writer_write_basic (&real->u.writer, type, value); - _dbus_assert (type == DBUS_TYPE_BOOLEAN); + if (!_dbus_message_iter_close_signature (real)) + ret = FALSE; - if (!_dbus_demarshal_byte_array (&real->message->body, real->message->byte_order, - pos, NULL, value, len)) - return FALSE; - else - return TRUE; + return ret; } /** - * Returns the 32 bit signed integer array that the iterator may point - * to. Note that you need to check that the iterator points to an - * array of the correct type prior to using this function. + * Appends a block of fixed-length values to an array. The + * fixed-length types are all basic types that are not string-like. So + * int32, double, bool, etc. You must call + * dbus_message_iter_open_container() to open an array of values + * before calling this function. You may call this function multiple + * times (and intermixed with calls to + * dbus_message_iter_append_basic()) for the same array. * - * @param iter the iterator - * @param value return location for the array - * @param len return location for the array length - * @returns #TRUE on success + * The "value" argument should be the address of the array. So for + * integer, "dbus_int32_t**" is expected for example. + * + * @warning in C, given "int array[]", "&array == array" (the + * comp.lang.c FAQ says otherwise, but gcc and the FAQ don't agree). + * So if you're using an array instead of a pointer you have to create + * a pointer variable, assign the array to it, then take the address + * of the pointer variable. + * @code + * const dbus_int32_t array[] = { 1, 2, 3 }; + * const dbus_int32_t *v_ARRAY = array; + * if (!dbus_message_iter_append_fixed_array (&iter, DBUS_TYPE_INT32, &v_ARRAY, 3)) + * fprintf (stderr, "No memory!\n"); + * @endcode + * For strings it works to write const char *array = "Hello" and then + * use &array though. + * + * @todo If this fails due to lack of memory, the message is hosed and + * you have to start over building the whole message. + * + * @param iter the append iterator + * @param element_type the type of the array elements + * @param value the address of the array + * @param n_elements the number of elements to append + * @returns #FALSE if not enough memory */ dbus_bool_t -dbus_message_iter_get_int32_array (DBusMessageIter *iter, - dbus_int32_t **value, - int *len) +dbus_message_iter_append_fixed_array (DBusMessageIter *iter, + int element_type, + const void *value, + int n_elements) { DBusMessageRealIter *real = (DBusMessageRealIter *)iter; - int type, pos; - - _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE); - - pos = dbus_message_iter_get_data_start (real, &type); - - _dbus_assert (type == DBUS_TYPE_ARRAY); - - type = iter_get_array_type (real, NULL); - - _dbus_assert (type == DBUS_TYPE_INT32); - - if (!_dbus_demarshal_int32_array (&real->message->body, real->message->byte_order, - pos, NULL, value, len)) - return FALSE; - else - return TRUE; -} - -/** - * Returns the 32 bit unsigned integer array that the iterator may point - * to. Note that you need to check that the iterator points to an - * array of the correct type prior to using this function. - * - * @param iter the iterator - * @param value return location for the array - * @param len return location for the array length - * @returns #TRUE on success + dbus_bool_t ret; + + _dbus_return_val_if_fail (_dbus_message_iter_append_check (real), FALSE); + _dbus_return_val_if_fail (real->iter_type == DBUS_MESSAGE_ITER_TYPE_WRITER, FALSE); + _dbus_return_val_if_fail (dbus_type_is_fixed (element_type), FALSE); + _dbus_return_val_if_fail (real->u.writer.container_type == DBUS_TYPE_ARRAY, FALSE); + _dbus_return_val_if_fail (value != NULL, FALSE); + _dbus_return_val_if_fail (n_elements >= 0, FALSE); + _dbus_return_val_if_fail (n_elements <= + DBUS_MAXIMUM_ARRAY_LENGTH / _dbus_type_get_alignment (element_type), + FALSE); + + ret = _dbus_type_writer_write_fixed_multi (&real->u.writer, element_type, value, n_elements); + + return ret; +} + +/** + * Appends a container-typed value to the message; you are required to + * append the contents of the container using the returned + * sub-iterator, and then call + * dbus_message_iter_close_container(). Container types are for + * example struct, variant, and array. For variants, the + * contained_signature should be the type of the single value inside + * the variant. For structs and dict entries, contained_signature + * should be #NULL; it will be set to whatever types you write into + * the struct. For arrays, contained_signature should be the type of + * the array elements. + * + * @todo If this fails due to lack of memory, the message is hosed and + * you have to start over building the whole message. + * + * @param iter the append iterator + * @param type the type of the value + * @param contained_signature the type of container contents + * @param sub sub-iterator to initialize + * @returns #FALSE if not enough memory */ dbus_bool_t -dbus_message_iter_get_uint32_array (DBusMessageIter *iter, - dbus_uint32_t **value, - int *len) +dbus_message_iter_open_container (DBusMessageIter *iter, + int type, + const char *contained_signature, + DBusMessageIter *sub) { DBusMessageRealIter *real = (DBusMessageRealIter *)iter; - int type, pos; + DBusMessageRealIter *real_sub = (DBusMessageRealIter *)sub; + DBusString contained_str; + + _dbus_return_val_if_fail (_dbus_message_iter_append_check (real), FALSE); + _dbus_return_val_if_fail (real->iter_type == DBUS_MESSAGE_ITER_TYPE_WRITER, FALSE); + _dbus_return_val_if_fail (dbus_type_is_container (type), FALSE); + _dbus_return_val_if_fail (sub != NULL, FALSE); + _dbus_return_val_if_fail ((type == DBUS_TYPE_STRUCT && + contained_signature == NULL) || + (type == DBUS_TYPE_DICT_ENTRY && + contained_signature == NULL) || + (type == DBUS_TYPE_VARIANT && + contained_signature != NULL) || + (type == DBUS_TYPE_ARRAY && + contained_signature != NULL), FALSE); + + /* this would fail if the contained_signature is a dict entry, since + * dict entries are invalid signatures standalone (they must be in + * an array) + */ + _dbus_return_val_if_fail ((type == DBUS_TYPE_ARRAY && contained_signature && *contained_signature == DBUS_DICT_ENTRY_BEGIN_CHAR) || + (contained_signature == NULL || + _dbus_check_is_valid_signature (contained_signature)), + FALSE); - _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE); + if (!_dbus_message_iter_open_signature (real)) + return FALSE; - pos = dbus_message_iter_get_data_start (real, &type); - - _dbus_assert (type == DBUS_TYPE_ARRAY); + *real_sub = *real; - type = iter_get_array_type (real, NULL); - _dbus_assert (type == DBUS_TYPE_UINT32); + if (contained_signature != NULL) + { + _dbus_string_init_const (&contained_str, contained_signature); - if (!_dbus_demarshal_uint32_array (&real->message->body, real->message->byte_order, - pos, NULL, value, len)) - return FALSE; + return _dbus_type_writer_recurse (&real->u.writer, + type, + &contained_str, 0, + &real_sub->u.writer); + } else - return TRUE; + { + return _dbus_type_writer_recurse (&real->u.writer, + type, + NULL, 0, + &real_sub->u.writer); + } } -#ifdef DBUS_HAVE_INT64 /** - * Returns the 64 bit signed integer array that the iterator may point - * to. Note that you need to check that the iterator points to an - * array of the correct type prior to using this function. - * - * This function only exists if #DBUS_HAVE_INT64 is defined. + * Closes a container-typed value appended to the message; may write + * out more information to the message known only after the entire + * container is written, and may free resources created by + * dbus_message_iter_open_container(). * - * @param iter the iterator - * @param value return location for the array - * @param len return location for the array length - * @returns #TRUE on success + * @todo If this fails due to lack of memory, the message is hosed and + * you have to start over building the whole message. + * + * @param iter the append iterator + * @param sub sub-iterator to close + * @returns #FALSE if not enough memory */ dbus_bool_t -dbus_message_iter_get_int64_array (DBusMessageIter *iter, - dbus_int64_t **value, - int *len) +dbus_message_iter_close_container (DBusMessageIter *iter, + DBusMessageIter *sub) { DBusMessageRealIter *real = (DBusMessageRealIter *)iter; - int type, pos; + DBusMessageRealIter *real_sub = (DBusMessageRealIter *)sub; + dbus_bool_t ret; - _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE); + _dbus_return_val_if_fail (_dbus_message_iter_append_check (real), FALSE); + _dbus_return_val_if_fail (real->iter_type == DBUS_MESSAGE_ITER_TYPE_WRITER, FALSE); + _dbus_return_val_if_fail (_dbus_message_iter_append_check (real_sub), FALSE); + _dbus_return_val_if_fail (real_sub->iter_type == DBUS_MESSAGE_ITER_TYPE_WRITER, FALSE); - pos = dbus_message_iter_get_data_start (real, &type); - - _dbus_assert (type == DBUS_TYPE_ARRAY); + ret = _dbus_type_writer_unrecurse (&real->u.writer, + &real_sub->u.writer); - type = iter_get_array_type (real, NULL); - - _dbus_assert (type == DBUS_TYPE_INT64); + if (!_dbus_message_iter_close_signature (real)) + ret = FALSE; - if (!_dbus_demarshal_int64_array (&real->message->body, real->message->byte_order, - pos, NULL, value, len)) - return FALSE; - else - return TRUE; + return ret; } /** - * Returns the 64 bit unsigned integer array that the iterator may point - * to. Note that you need to check that the iterator points to an - * array of the correct type prior to using this function. + * Abandons creation of a contained-typed value and frees resources created + * by dbus_message_iter_open_container(). Once this returns, the message + * is hosed and you have to start over building the whole message. * - * This function only exists if #DBUS_HAVE_INT64 is defined. + * This should only be used to abandon creation of a message when you have + * open containers. * - * @param iter the iterator - * @param value return location for the array - * @param len return location for the array length - * @returns #TRUE on success + * @param iter the append iterator + * @param sub sub-iterator to close */ -dbus_bool_t -dbus_message_iter_get_uint64_array (DBusMessageIter *iter, - dbus_uint64_t **value, - int *len) +void +dbus_message_iter_abandon_container (DBusMessageIter *iter, + DBusMessageIter *sub) { DBusMessageRealIter *real = (DBusMessageRealIter *)iter; - int type, pos; - - _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE); + DBusMessageRealIter *real_sub = (DBusMessageRealIter *)sub; - pos = dbus_message_iter_get_data_start (real, &type); - - _dbus_assert (type == DBUS_TYPE_ARRAY); - - type = iter_get_array_type (real, NULL); - _dbus_assert (type == DBUS_TYPE_UINT64); + _dbus_return_if_fail (_dbus_message_iter_append_check (real)); + _dbus_return_if_fail (real->iter_type == DBUS_MESSAGE_ITER_TYPE_WRITER); + _dbus_return_if_fail (_dbus_message_iter_append_check (real_sub)); + _dbus_return_if_fail (real_sub->iter_type == DBUS_MESSAGE_ITER_TYPE_WRITER); - if (!_dbus_demarshal_uint64_array (&real->message->body, real->message->byte_order, - pos, NULL, value, len)) - return FALSE; - else - return TRUE; + _dbus_message_iter_abandon_signature (real); } -#endif /* DBUS_HAVE_INT64 */ - /** - * Returns the double array that the iterator may point to. Note that - * you need to check that the iterator points to an array of the - * correct type prior to using this function. + * Sets a flag indicating that the message does not want a reply; if + * this flag is set, the other end of the connection may (but is not + * required to) optimize by not sending method return or error + * replies. If this flag is set, there is no way to know whether the + * message successfully arrived at the remote end. Normally you know a + * message was received when you receive the reply to it. * - * @param iter the iterator - * @param value return location for the array - * @param len return location for the array length - * @returns #TRUE on success + * The flag is #FALSE by default, that is by default the other end is + * required to reply. + * + * On the protocol level this toggles #DBUS_HEADER_FLAG_NO_REPLY_EXPECTED + * + * @param message the message + * @param no_reply #TRUE if no reply is desired */ -dbus_bool_t -dbus_message_iter_get_double_array (DBusMessageIter *iter, - double **value, - int *len) +void +dbus_message_set_no_reply (DBusMessage *message, + dbus_bool_t no_reply) { - DBusMessageRealIter *real = (DBusMessageRealIter *)iter; - int type, pos; - - _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE); - - pos = dbus_message_iter_get_data_start (real, &type); - - _dbus_assert (type == DBUS_TYPE_ARRAY); - - type = iter_get_array_type (real, NULL); - _dbus_assert (type == DBUS_TYPE_DOUBLE); + _dbus_return_if_fail (message != NULL); + _dbus_return_if_fail (!message->locked); - if (!_dbus_demarshal_double_array (&real->message->body, real->message->byte_order, - pos, NULL, value, len)) - return FALSE; - else - return TRUE; + _dbus_header_toggle_flag (&message->header, + DBUS_HEADER_FLAG_NO_REPLY_EXPECTED, + no_reply); } /** - * Returns the string array that the iterator may point to. - * Note that you need to check that the iterator points - * to a string array prior to using this function. - * - * The returned value is a #NULL-terminated array of strings. - * Each string is a separate malloc block, and the array - * itself is a malloc block. You can free this type of - * string array with dbus_free_string_array(). + * Returns #TRUE if the message does not expect + * a reply. * - * @param iter the iterator - * @param value return location for string values - * @param len return location for length of byte array - * @returns #TRUE on success + * @param message the message + * @returns #TRUE if the message sender isn't waiting for a reply */ dbus_bool_t -dbus_message_iter_get_string_array (DBusMessageIter *iter, - char ***value, - int *len) +dbus_message_get_no_reply (DBusMessage *message) { - DBusMessageRealIter *real = (DBusMessageRealIter *)iter; - int type, pos; + _dbus_return_val_if_fail (message != NULL, FALSE); - _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE); - - pos = dbus_message_iter_get_data_start (real, &type); - - _dbus_assert (type == DBUS_TYPE_ARRAY); - - type = iter_get_array_type (real, NULL); - _dbus_assert (type == DBUS_TYPE_STRING); - - if (!_dbus_demarshal_string_array (&real->message->body, real->message->byte_order, - pos, NULL, value, len)) - return FALSE; - else - return TRUE; + return _dbus_header_get_flag (&message->header, + DBUS_HEADER_FLAG_NO_REPLY_EXPECTED); } -#if 0 /** - * @todo FIXME to implement this _dbus_demarshal_object_path_array() - * needs implementing - * - * Returns the object path array that the iterator may point to. - * Note that you need to check that the iterator points - * to an object path array prior to using this function. + * Sets a flag indicating that an owner for the destination name will + * be automatically started before the message is delivered. When this + * flag is set, the message is held until a name owner finishes + * starting up, or fails to start up. In case of failure, the reply + * will be an error. * - * The returned value is a #NULL-terminated array of strings. - * Each string is a separate malloc block, and the array - * itself is a malloc block. You can free this type of - * array with dbus_free_string_array(). + * The flag is set to #TRUE by default, i.e. auto starting is the default. * - * @param iter the iterator - * @param value return location for string values - * @param len return location for length of byte array - * @returns #TRUE on success + * On the protocol level this toggles #DBUS_HEADER_FLAG_NO_AUTO_START + * + * @param message the message + * @param auto_start #TRUE if auto-starting is desired */ -dbus_bool_t -dbus_message_iter_get_object_path_array (DBusMessageIter *iter, - char ***value, - int *len) +void +dbus_message_set_auto_start (DBusMessage *message, + dbus_bool_t auto_start) { - DBusMessageRealIter *real = (DBusMessageRealIter *)iter; - int type, pos; - - _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE); - - pos = dbus_message_iter_get_data_start (real, &type); - - _dbus_assert (type == DBUS_TYPE_ARRAY); - - type = iter_get_array_type (real, NULL); - _dbus_assert (type == DBUS_TYPE_OBJECT_PATH); + _dbus_return_if_fail (message != NULL); + _dbus_return_if_fail (!message->locked); - if (!_dbus_demarshal_object_path_array (&real->message->body, real->message->byte_order, - pos, NULL, value, len)) - return FALSE; - else - return TRUE; + _dbus_header_toggle_flag (&message->header, + DBUS_HEADER_FLAG_NO_AUTO_START, + !auto_start); } -#endif /** - * Returns the key name fot the dict entry that an iterator - * may point to. Note that you need to check that the iterator - * points to a dict entry before using this function. + * Returns #TRUE if the message will cause an owner for + * destination name to be auto-started. * - * @see dbus_message_iter_init_dict_iterator - * @param iter the message iter - * @returns the key name + * @param message the message + * @returns #TRUE if the message will use auto-start */ -char * -dbus_message_iter_get_dict_key (DBusMessageIter *iter) +dbus_bool_t +dbus_message_get_auto_start (DBusMessage *message) { - DBusMessageRealIter *real = (DBusMessageRealIter *)iter; - - _dbus_return_val_if_fail (dbus_message_iter_check (real), NULL); - - _dbus_assert (real->type == DBUS_MESSAGE_ITER_TYPE_DICT); + _dbus_return_val_if_fail (message != NULL, FALSE); - return _dbus_demarshal_string (&real->message->body, real->message->byte_order, - real->pos, NULL); + return !_dbus_header_get_flag (&message->header, + DBUS_HEADER_FLAG_NO_AUTO_START); } + /** - * Initializes a DBusMessageIter pointing to the end of the - * message. This iterator can be used to append data to the - * message. + * Sets the object path this message is being sent to (for + * DBUS_MESSAGE_TYPE_METHOD_CALL) or the one a signal is being + * emitted from (for DBUS_MESSAGE_TYPE_SIGNAL). + * + * The path must contain only valid characters as defined + * in the D-Bus specification. * * @param message the message - * @param iter pointer to an iterator to initialize + * @param object_path the path or #NULL to unset + * @returns #FALSE if not enough memory */ -void -dbus_message_append_iter_init (DBusMessage *message, - DBusMessageIter *iter) -{ - DBusMessageRealIter *real = (DBusMessageRealIter *)iter; - - _dbus_return_if_fail (message != NULL); - _dbus_return_if_fail (iter != NULL); - - real->message = message; - real->parent_iter = NULL; - real->changed_stamp = message->changed_stamp; - - real->type = DBUS_MESSAGE_ITER_TYPE_MESSAGE; - real->end = _dbus_string_get_length (&real->message->body); - real->pos = real->end; - - real->container_length_pos = 0; - real->wrote_dict_key = 0; -} - -#ifndef DBUS_DISABLE_CHECKS -static dbus_bool_t -dbus_message_iter_append_check (DBusMessageRealIter *iter) -{ - if (iter == NULL) - { - _dbus_warn ("dbus iterator check failed: NULL iterator\n"); - return FALSE; - } - - if (iter->message->locked) - { - _dbus_warn ("dbus iterator check failed: message is locked (has already been sent)\n"); - return FALSE; - } - - if (iter->changed_stamp != iter->message->changed_stamp) - { - _dbus_warn ("dbus iterator check failed: invalid iterator, must re-initialize it after modifying the message"); - return FALSE; - } - - if (iter->pos != iter->end) - { - _dbus_warn ("dbus iterator check failed: can only append at end of message"); - return FALSE; - } - - if (iter->pos != _dbus_string_get_length (&iter->message->body)) - { - _dbus_warn ("dbus iterator check failed: append pos not at end of message string"); - return FALSE; - } - - return TRUE; -} -#endif /* DBUS_DISABLE_CHECKS */ - -static dbus_bool_t -dbus_message_iter_append_type (DBusMessageRealIter *iter, - int type) -{ - const char *data; - switch (iter->type) - { - case DBUS_MESSAGE_ITER_TYPE_MESSAGE: - if (!_dbus_string_append_byte (&iter->message->signature, type)) - return FALSE; - - if (!_dbus_string_append_byte (&iter->message->body, type)) - { - _dbus_string_shorten (&iter->message->signature, 1); - return FALSE; - } - break; - - case DBUS_MESSAGE_ITER_TYPE_ARRAY: - data = _dbus_string_get_const_data_len (&iter->message->body, - iter->array_type_pos, 1); - if (type != *data) - { - _dbus_warn ("Appended element of wrong type for array\n"); - return FALSE; - } - break; - - case DBUS_MESSAGE_ITER_TYPE_DICT: - if (!iter->wrote_dict_key) - { - _dbus_warn ("Appending dict data before key name\n"); - return FALSE; - } - - if (!_dbus_string_append_byte (&iter->message->body, type)) - return FALSE; - - break; - - default: - _dbus_assert_not_reached ("Invalid iter type"); - break; - } - - return TRUE; -} - -static void -dbus_message_iter_update_after_change (DBusMessageRealIter *iter) +dbus_bool_t +dbus_message_set_path (DBusMessage *message, + const char *object_path) { - iter->changed_stamp = iter->message->changed_stamp; - - /* Set new end of iter */ - iter->end = _dbus_string_get_length (&iter->message->body); - iter->pos = iter->end; - - /* Set container length */ - if (iter->type == DBUS_MESSAGE_ITER_TYPE_DICT || - (iter->type == DBUS_MESSAGE_ITER_TYPE_ARRAY && iter->array_type_done)) - _dbus_marshal_set_uint32 (&iter->message->body, - iter->message->byte_order, - iter->container_length_pos, - iter->end - iter->container_start); - - if (iter->parent_iter) - dbus_message_iter_update_after_change (iter->parent_iter); -} + _dbus_return_val_if_fail (message != NULL, FALSE); + _dbus_return_val_if_fail (!message->locked, FALSE); + _dbus_return_val_if_fail (object_path == NULL || + _dbus_check_is_valid_path (object_path), + FALSE); -static void -dbus_message_iter_append_done (DBusMessageRealIter *iter) -{ - iter->message->changed_stamp++; - dbus_message_iter_update_after_change (iter); - iter->wrote_dict_key = FALSE; + return set_or_delete_string_field (message, + DBUS_HEADER_FIELD_PATH, + DBUS_TYPE_OBJECT_PATH, + object_path); } /** - * Appends a nil value to the message + * Gets the object path this message is being sent to (for + * DBUS_MESSAGE_TYPE_METHOD_CALL) or being emitted from (for + * DBUS_MESSAGE_TYPE_SIGNAL). Returns #NULL if none. * - * @param iter an iterator pointing to the end of the message - * @returns #TRUE on success + * See also dbus_message_get_path_decomposed(). + * + * The returned string becomes invalid if the message is + * modified, since it points into the wire-marshaled message data. + * + * @param message the message + * @returns the path (should not be freed) or #NULL */ -dbus_bool_t -dbus_message_iter_append_nil (DBusMessageIter *iter) +const char* +dbus_message_get_path (DBusMessage *message) { - DBusMessageRealIter *real = (DBusMessageRealIter *)iter; + const char *v; - _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE); + _dbus_return_val_if_fail (message != NULL, NULL); - if (!dbus_message_iter_append_type (real, DBUS_TYPE_NIL)) - return FALSE; - - dbus_message_iter_append_done (real); - - return TRUE; + v = NULL; /* in case field doesn't exist */ + _dbus_header_get_field_basic (&message->header, + DBUS_HEADER_FIELD_PATH, + DBUS_TYPE_OBJECT_PATH, + &v); + return v; } /** - * Appends a boolean value to the message + * Checks if the message has a particular object path. The object + * path is the destination object for a method call or the emitting + * object for a signal. * - * @param iter an iterator pointing to the end of the message - * @param value the boolean value - * @returns #TRUE on success + * @param message the message + * @param path the path name + * @returns #TRUE if there is a path field in the header */ dbus_bool_t -dbus_message_iter_append_boolean (DBusMessageIter *iter, - dbus_bool_t value) +dbus_message_has_path (DBusMessage *message, + const char *path) { - DBusMessageRealIter *real = (DBusMessageRealIter *)iter; - - _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE); - - if (!dbus_message_iter_append_type (real, DBUS_TYPE_BOOLEAN)) - return FALSE; + const char *msg_path; + msg_path = dbus_message_get_path (message); - if (!_dbus_string_append_byte (&real->message->body, (value != FALSE))) + if (msg_path == NULL) { - _dbus_string_set_length (&real->message->body, real->pos); - return FALSE; + if (path == NULL) + return TRUE; + else + return FALSE; } - dbus_message_iter_append_done (real); - - return TRUE; + if (path == NULL) + return FALSE; + + if (strcmp (msg_path, path) == 0) + return TRUE; + + return FALSE; } /** - * Appends a byte to the message + * Gets the object path this message is being sent to + * (for DBUS_MESSAGE_TYPE_METHOD_CALL) or being emitted + * from (for DBUS_MESSAGE_TYPE_SIGNAL) in a decomposed + * format (one array element per path component). + * Free the returned array with dbus_free_string_array(). * - * @param iter an iterator pointing to the end of the message - * @param value the byte value - * @returns #TRUE on success + * An empty but non-NULL path array means the path "/". + * So the path "/foo/bar" becomes { "foo", "bar", NULL } + * and the path "/" becomes { NULL }. + * + * See also dbus_message_get_path(). + * + * @todo this could be optimized by using the len from the message + * instead of calling strlen() again + * + * @param message the message + * @param path place to store allocated array of path components; #NULL set here if no path field exists + * @returns #FALSE if no memory to allocate the array */ dbus_bool_t -dbus_message_iter_append_byte (DBusMessageIter *iter, - unsigned char value) +dbus_message_get_path_decomposed (DBusMessage *message, + char ***path) { - DBusMessageRealIter *real = (DBusMessageRealIter *)iter; + const char *v; - _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE); + _dbus_return_val_if_fail (message != NULL, FALSE); + _dbus_return_val_if_fail (path != NULL, FALSE); - if (!dbus_message_iter_append_type (real, DBUS_TYPE_BYTE)) - return FALSE; - - if (!_dbus_string_append_byte (&real->message->body, value)) + *path = NULL; + + v = dbus_message_get_path (message); + if (v != NULL) { - _dbus_string_set_length (&real->message->body, real->pos); - return FALSE; + if (!_dbus_decompose_path (v, strlen (v), + path, NULL)) + return FALSE; } - - dbus_message_iter_append_done (real); - return TRUE; } - /** - * Appends a 32 bit signed integer to the message. + * Sets the interface this message is being sent to + * (for DBUS_MESSAGE_TYPE_METHOD_CALL) or + * the interface a signal is being emitted from + * (for DBUS_MESSAGE_TYPE_SIGNAL). * - * @param iter an iterator pointing to the end of the message - * @param value the integer value - * @returns #TRUE on success + * The interface name must contain only valid characters as defined + * in the D-Bus specification. + * + * @param message the message + * @param interface the interface or #NULL to unset + * @returns #FALSE if not enough memory */ dbus_bool_t -dbus_message_iter_append_int32 (DBusMessageIter *iter, - dbus_int32_t value) +dbus_message_set_interface (DBusMessage *message, + const char *interface) { - DBusMessageRealIter *real = (DBusMessageRealIter *)iter; - - _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE); - - if (!dbus_message_iter_append_type (real, DBUS_TYPE_INT32)) - return FALSE; - - if (!_dbus_marshal_int32 (&real->message->body, real->message->byte_order, value)) - { - _dbus_string_set_length (&real->message->body, real->pos); - return FALSE; - } + _dbus_return_val_if_fail (message != NULL, FALSE); + _dbus_return_val_if_fail (!message->locked, FALSE); + _dbus_return_val_if_fail (interface == NULL || + _dbus_check_is_valid_interface (interface), + FALSE); - dbus_message_iter_append_done (real); - - return TRUE; + return set_or_delete_string_field (message, + DBUS_HEADER_FIELD_INTERFACE, + DBUS_TYPE_STRING, + interface); } /** - * Appends a 32 bit unsigned integer to the message. + * Gets the interface this message is being sent to + * (for DBUS_MESSAGE_TYPE_METHOD_CALL) or being emitted + * from (for DBUS_MESSAGE_TYPE_SIGNAL). + * The interface name is fully-qualified (namespaced). + * Returns #NULL if none. * - * @param iter an iterator pointing to the end of the message - * @param value the integer value - * @returns #TRUE on success + * The returned string becomes invalid if the message is + * modified, since it points into the wire-marshaled message data. + * + * @param message the message + * @returns the message interface (should not be freed) or #NULL */ -dbus_bool_t -dbus_message_iter_append_uint32 (DBusMessageIter *iter, - dbus_uint32_t value) +const char* +dbus_message_get_interface (DBusMessage *message) { - DBusMessageRealIter *real = (DBusMessageRealIter *)iter; + const char *v; - _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE); - - if (!dbus_message_iter_append_type (real, DBUS_TYPE_UINT32)) - return FALSE; - - if (!_dbus_marshal_uint32 (&real->message->body, real->message->byte_order, value)) - { - _dbus_string_set_length (&real->message->body, real->pos); - return FALSE; - } + _dbus_return_val_if_fail (message != NULL, NULL); - dbus_message_iter_append_done (real); - - return TRUE; + v = NULL; /* in case field doesn't exist */ + _dbus_header_get_field_basic (&message->header, + DBUS_HEADER_FIELD_INTERFACE, + DBUS_TYPE_STRING, + &v); + return v; } -#ifdef DBUS_HAVE_INT64 - /** - * Appends a 64 bit signed integer to the message. - * - * This function only exists if #DBUS_HAVE_INT64 is defined. + * Checks if the message has an interface * - * @param iter an iterator pointing to the end of the message - * @param value the integer value - * @returns #TRUE on success + * @param message the message + * @param interface the interface name + * @returns #TRUE if the interface field in the header matches */ dbus_bool_t -dbus_message_iter_append_int64 (DBusMessageIter *iter, - dbus_int64_t value) +dbus_message_has_interface (DBusMessage *message, + const char *interface) { - DBusMessageRealIter *real = (DBusMessageRealIter *)iter; - - _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE); - - if (!dbus_message_iter_append_type (real, DBUS_TYPE_INT64)) - return FALSE; - - if (!_dbus_marshal_int64 (&real->message->body, real->message->byte_order, value)) + const char *msg_interface; + msg_interface = dbus_message_get_interface (message); + + if (msg_interface == NULL) { - _dbus_string_set_length (&real->message->body, real->pos); - return FALSE; + if (interface == NULL) + return TRUE; + else + return FALSE; } - dbus_message_iter_append_done (real); - - return TRUE; + if (interface == NULL) + return FALSE; + + if (strcmp (msg_interface, interface) == 0) + return TRUE; + + return FALSE; + } /** - * Appends a 64 bit unsigned integer to the message. + * Sets the interface member being invoked + * (DBUS_MESSAGE_TYPE_METHOD_CALL) or emitted + * (DBUS_MESSAGE_TYPE_SIGNAL). * - * This function only exists if #DBUS_HAVE_INT64 is defined. + * The member name must contain only valid characters as defined + * in the D-Bus specification. * - * @param iter an iterator pointing to the end of the message - * @param value the integer value - * @returns #TRUE on success + * @param message the message + * @param member the member or #NULL to unset + * @returns #FALSE if not enough memory */ dbus_bool_t -dbus_message_iter_append_uint64 (DBusMessageIter *iter, - dbus_uint64_t value) +dbus_message_set_member (DBusMessage *message, + const char *member) { - DBusMessageRealIter *real = (DBusMessageRealIter *)iter; + _dbus_return_val_if_fail (message != NULL, FALSE); + _dbus_return_val_if_fail (!message->locked, FALSE); + _dbus_return_val_if_fail (member == NULL || + _dbus_check_is_valid_member (member), + FALSE); - _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE); - - if (!dbus_message_iter_append_type (real, DBUS_TYPE_UINT64)) - return FALSE; - - if (!_dbus_marshal_uint64 (&real->message->body, real->message->byte_order, value)) - { - _dbus_string_set_length (&real->message->body, real->pos); - return FALSE; - } - - dbus_message_iter_append_done (real); - - return TRUE; -} - -#endif /* DBUS_HAVE_INT64 */ + return set_or_delete_string_field (message, + DBUS_HEADER_FIELD_MEMBER, + DBUS_TYPE_STRING, + member); +} /** - * Appends a double value to the message. + * Gets the interface member being invoked + * (DBUS_MESSAGE_TYPE_METHOD_CALL) or emitted + * (DBUS_MESSAGE_TYPE_SIGNAL). Returns #NULL if none. * - * @param iter an iterator pointing to the end of the message - * @param value the double value - * @returns #TRUE on success + * The returned string becomes invalid if the message is + * modified, since it points into the wire-marshaled message data. + * + * @param message the message + * @returns the member name (should not be freed) or #NULL */ -dbus_bool_t -dbus_message_iter_append_double (DBusMessageIter *iter, - double value) +const char* +dbus_message_get_member (DBusMessage *message) { - DBusMessageRealIter *real = (DBusMessageRealIter *)iter; - - _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE); + const char *v; - if (!dbus_message_iter_append_type (real, DBUS_TYPE_DOUBLE)) - return FALSE; - - if (!_dbus_marshal_double (&real->message->body, real->message->byte_order, value)) - { - _dbus_string_set_length (&real->message->body, real->pos); - return FALSE; - } + _dbus_return_val_if_fail (message != NULL, NULL); - dbus_message_iter_append_done (real); - - return TRUE; + v = NULL; /* in case field doesn't exist */ + _dbus_header_get_field_basic (&message->header, + DBUS_HEADER_FIELD_MEMBER, + DBUS_TYPE_STRING, + &v); + return v; } /** - * Appends a UTF-8 string to the message. - * - * @todo add return_val_if_fail(UTF-8 is valid) + * Checks if the message has an interface member * - * @param iter an iterator pointing to the end of the message - * @param value the string - * @returns #TRUE on success + * @param message the message + * @param member the member name + * @returns #TRUE if there is a member field in the header */ dbus_bool_t -dbus_message_iter_append_string (DBusMessageIter *iter, - const char *value) +dbus_message_has_member (DBusMessage *message, + const char *member) { - DBusMessageRealIter *real = (DBusMessageRealIter *)iter; - - _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE); - - if (!dbus_message_iter_append_type (real, DBUS_TYPE_STRING)) - return FALSE; - - if (!_dbus_marshal_string (&real->message->body, real->message->byte_order, value)) + const char *msg_member; + msg_member = dbus_message_get_member (message); + + if (msg_member == NULL) { - _dbus_string_set_length (&real->message->body, real->pos); - return FALSE; + if (member == NULL) + return TRUE; + else + return FALSE; } - dbus_message_iter_append_done (real); - - return TRUE; + if (member == NULL) + return FALSE; + + if (strcmp (msg_member, member) == 0) + return TRUE; + + return FALSE; + } /** - * Appends a custom type data chunk to the message. A custom - * type is simply an arbitrary UTF-8 string used as a type - * tag, plus an array of arbitrary bytes to be interpreted - * according to the type tag. - * - * @param iter an iterator pointing to the end of the message - * @param name the name of the type - * @param data the binary data used to store the value - * @param len the length of the binary data in bytes - * @returns #TRUE on success + * Sets the name of the error (DBUS_MESSAGE_TYPE_ERROR). + * The name is fully-qualified (namespaced). + * + * The error name must contain only valid characters as defined + * in the D-Bus specification. + * + * @param message the message + * @param error_name the name or #NULL to unset + * @returns #FALSE if not enough memory */ dbus_bool_t -dbus_message_iter_append_custom (DBusMessageIter *iter, - const char *name, - const unsigned char *data, - int len) +dbus_message_set_error_name (DBusMessage *message, + const char *error_name) { - DBusMessageRealIter *real = (DBusMessageRealIter *)iter; - - _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE); - - if (!dbus_message_iter_append_type (real, DBUS_TYPE_CUSTOM)) - return FALSE; - - if (!_dbus_marshal_string (&real->message->body, real->message->byte_order, name)) - { - _dbus_string_set_length (&real->message->body, real->pos); - return FALSE; - } - - if (!_dbus_marshal_byte_array (&real->message->body, real->message->byte_order, data, len)) - { - _dbus_string_set_length (&real->message->body, real->pos); - return FALSE; - } + _dbus_return_val_if_fail (message != NULL, FALSE); + _dbus_return_val_if_fail (!message->locked, FALSE); + _dbus_return_val_if_fail (error_name == NULL || + _dbus_check_is_valid_error_name (error_name), + FALSE); - dbus_message_iter_append_done (real); - - return TRUE; + return set_or_delete_string_field (message, + DBUS_HEADER_FIELD_ERROR_NAME, + DBUS_TYPE_STRING, + error_name); } - /** - * Appends a dict key name to the message. The iterator used - * must point to a dict. + * Gets the error name (DBUS_MESSAGE_TYPE_ERROR only) + * or #NULL if none. * - * @param iter an iterator pointing to the end of the message - * @param value the string - * @returns #TRUE on success + * The returned string becomes invalid if the message is + * modified, since it points into the wire-marshaled message data. + * + * @param message the message + * @returns the error name (should not be freed) or #NULL */ -dbus_bool_t -dbus_message_iter_append_dict_key (DBusMessageIter *iter, - const char *value) +const char* +dbus_message_get_error_name (DBusMessage *message) { - DBusMessageRealIter *real = (DBusMessageRealIter *)iter; + const char *v; - _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE); - _dbus_assert (real->type == DBUS_MESSAGE_ITER_TYPE_DICT); - - if (real->wrote_dict_key) - { - _dbus_warn ("Appending multiple dict key names\n"); - return FALSE; - } - - if (!_dbus_marshal_string (&real->message->body, real->message->byte_order, value)) - { - return FALSE; - } + _dbus_return_val_if_fail (message != NULL, NULL); - dbus_message_iter_append_done (real); - real->wrote_dict_key = TRUE; - - return TRUE; + v = NULL; /* in case field doesn't exist */ + _dbus_header_get_field_basic (&message->header, + DBUS_HEADER_FIELD_ERROR_NAME, + DBUS_TYPE_STRING, + &v); + return v; } -static dbus_bool_t -array_iter_type_mark_done (DBusMessageRealIter *iter) +/** + * Sets the message's destination. The destination is the name of + * another connection on the bus and may be either the unique name + * assigned by the bus to each connection, or a well-known name + * specified in advance. + * + * The destination name must contain only valid characters as defined + * in the D-Bus specification. + * + * @param message the message + * @param destination the destination name or #NULL to unset + * @returns #FALSE if not enough memory + */ +dbus_bool_t +dbus_message_set_destination (DBusMessage *message, + const char *destination) { - int len_pos; - - if (iter->type == DBUS_MESSAGE_ITER_TYPE_ARRAY) - array_iter_type_mark_done (iter->parent_iter); - else - return TRUE; - - len_pos = _DBUS_ALIGN_VALUE (_dbus_string_get_length (&iter->message->body), - sizeof (dbus_uint32_t)); - - /* Empty length for now, backfill later */ - if (!_dbus_marshal_uint32 (&iter->message->body, iter->message->byte_order, 0)) - { - _dbus_string_set_length (&iter->message->body, iter->pos); - return FALSE; - } - - iter->container_start = _dbus_string_get_length (&iter->message->body); - iter->container_length_pos = len_pos; - iter->array_type_done = TRUE; + _dbus_return_val_if_fail (message != NULL, FALSE); + _dbus_return_val_if_fail (!message->locked, FALSE); + _dbus_return_val_if_fail (destination == NULL || + _dbus_check_is_valid_bus_name (destination), + FALSE); - return TRUE; + return set_or_delete_string_field (message, + DBUS_HEADER_FIELD_DESTINATION, + DBUS_TYPE_STRING, + destination); } -static dbus_bool_t -append_array_type (DBusMessageRealIter *real, - int element_type, - dbus_bool_t *array_type_done, - int *array_type_pos) +/** + * Gets the destination of a message or #NULL if there is none set. + * + * The returned string becomes invalid if the message is + * modified, since it points into the wire-marshaled message data. + * + * @param message the message + * @returns the message destination (should not be freed) or #NULL + */ +const char* +dbus_message_get_destination (DBusMessage *message) { - int existing_element_type; - - if (!dbus_message_iter_append_type (real, DBUS_TYPE_ARRAY)) - return FALSE; - - if (real->type == DBUS_MESSAGE_ITER_TYPE_ARRAY && - real->array_type_done) - { - existing_element_type = iter_get_array_type (real, array_type_pos); - if (existing_element_type != element_type) - { - _dbus_warn ("Appending array of %s, when expecting array of %s\n", - _dbus_type_to_string (element_type), - _dbus_type_to_string (existing_element_type)); - _dbus_string_set_length (&real->message->body, real->pos); - return FALSE; - } - if (array_type_done != NULL) - *array_type_done = TRUE; - } - else - { - if (array_type_pos != NULL) - *array_type_pos = _dbus_string_get_length (&real->message->body); - - - if (!_dbus_string_append_byte (&real->message->signature, element_type)) - { - _dbus_string_set_length (&real->message->body, real->pos); - return FALSE; - } - - /* Append element type */ - if (!_dbus_string_append_byte (&real->message->body, element_type)) - { - _dbus_string_shorten (&real->message->signature, 1); - _dbus_string_set_length (&real->message->body, real->pos); - return FALSE; - } + const char *v; - if (array_type_done != NULL) - *array_type_done = element_type != DBUS_TYPE_ARRAY; - - if (element_type != DBUS_TYPE_ARRAY && - !array_iter_type_mark_done (real)) - { - _dbus_string_shorten (&real->message->signature, 1); - return FALSE; - } - } + _dbus_return_val_if_fail (message != NULL, NULL); - return TRUE; + v = NULL; /* in case field doesn't exist */ + _dbus_header_get_field_basic (&message->header, + DBUS_HEADER_FIELD_DESTINATION, + DBUS_TYPE_STRING, + &v); + return v; } /** - * Appends an array to the message and initializes an iterator that - * can be used to append to the array. + * Sets the message sender. * - * @param iter an iterator pointing to the end of the message - * @param array_iter pointer to an iter that will be initialized - * @param element_type the type of the array elements - * @returns #TRUE on success + * The sender must be a valid bus name as defined in the D-Bus + * specification. + * + * Usually you don't want to call this. The message bus daemon will + * call it to set the origin of each message. If you aren't implementing + * a message bus daemon you shouldn't need to set the sender. + * + * @param message the message + * @param sender the sender or #NULL to unset + * @returns #FALSE if not enough memory */ dbus_bool_t -dbus_message_iter_append_array (DBusMessageIter *iter, - DBusMessageIter *array_iter, - int element_type) +dbus_message_set_sender (DBusMessage *message, + const char *sender) { - DBusMessageRealIter *real = (DBusMessageRealIter *)iter; - DBusMessageRealIter *array_real = (DBusMessageRealIter *)array_iter; - int len_pos; - int array_type_pos; - dbus_bool_t array_type_done; - - if (element_type == DBUS_TYPE_NIL) - { - _dbus_warn ("Can't create NIL arrays\n"); - return FALSE; - } - - _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE); - - if (!append_array_type (real, element_type, &array_type_done, &array_type_pos)) - return FALSE; - - len_pos = _DBUS_ALIGN_VALUE (_dbus_string_get_length (&real->message->body), sizeof (dbus_uint32_t)); - - if (array_type_done) - { - /* Empty length for now, backfill later */ - if (!_dbus_marshal_uint32 (&real->message->body, real->message->byte_order, 0)) - { - _dbus_string_set_length (&real->message->body, real->pos); - return FALSE; - } - } - - array_real->parent_iter = real; - array_real->message = real->message; - array_real->changed_stamp = real->message->changed_stamp; - - array_real->type = DBUS_MESSAGE_ITER_TYPE_ARRAY; - array_real->pos = _dbus_string_get_length (&real->message->body); - array_real->end = array_real->end; - - array_real->container_start = array_real->pos; - array_real->container_length_pos = len_pos; - array_real->wrote_dict_key = 0; - array_real->array_type_done = array_type_done; - array_real->array_type_pos = array_type_pos; + _dbus_return_val_if_fail (message != NULL, FALSE); + _dbus_return_val_if_fail (!message->locked, FALSE); + _dbus_return_val_if_fail (sender == NULL || + _dbus_check_is_valid_bus_name (sender), + FALSE); - dbus_message_iter_append_done (array_real); - - return TRUE; + return set_or_delete_string_field (message, + DBUS_HEADER_FIELD_SENDER, + DBUS_TYPE_STRING, + sender); } /** - * Appends a dict to the message and initializes an iterator that - * can be used to append to the dict. + * Gets the unique name of the connection which originated this + * message, or #NULL if unknown or inapplicable. The sender is filled + * in by the message bus. * - * @param iter an iterator pointing to the end of the message - * @param dict_iter pointer to an iter that will be initialized - * @returns #TRUE on success + * Note, the returned sender is always the unique bus name. + * Connections may own multiple other bus names, but those + * are not found in the sender field. + * + * The returned string becomes invalid if the message is + * modified, since it points into the wire-marshaled message data. + * + * @param message the message + * @returns the unique name of the sender or #NULL */ -dbus_bool_t -dbus_message_iter_append_dict (DBusMessageIter *iter, - DBusMessageIter *dict_iter) +const char* +dbus_message_get_sender (DBusMessage *message) { - DBusMessageRealIter *real = (DBusMessageRealIter *)iter; - DBusMessageRealIter *dict_real = (DBusMessageRealIter *)dict_iter; - int len_pos; - - _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE); - - if (!dbus_message_iter_append_type (real, DBUS_TYPE_DICT)) - return FALSE; - - len_pos = _DBUS_ALIGN_VALUE (_dbus_string_get_length (&real->message->body), sizeof (dbus_uint32_t)); + const char *v; - /* Empty length for now, backfill later */ - if (!_dbus_marshal_uint32 (&real->message->body, real->message->byte_order, 0)) - { - _dbus_string_set_length (&real->message->body, real->pos); - return FALSE; - } - - dict_real->parent_iter = real; - dict_real->message = real->message; - dict_real->changed_stamp = real->message->changed_stamp; - - dict_real->type = DBUS_MESSAGE_ITER_TYPE_DICT; - dict_real->pos = _dbus_string_get_length (&real->message->body); - dict_real->end = dict_real->end; - - dict_real->container_start = dict_real->pos; - dict_real->container_length_pos = len_pos; - dict_real->wrote_dict_key = 0; + _dbus_return_val_if_fail (message != NULL, NULL); - dbus_message_iter_append_done (dict_real); - - real->wrote_dict_key = FALSE; - - return TRUE; + v = NULL; /* in case field doesn't exist */ + _dbus_header_get_field_basic (&message->header, + DBUS_HEADER_FIELD_SENDER, + DBUS_TYPE_STRING, + &v); + return v; } - /** - * Appends a boolean array to the message. + * Gets the type signature of the message, i.e. the arguments in the + * message payload. The signature includes only "in" arguments for + * #DBUS_MESSAGE_TYPE_METHOD_CALL and only "out" arguments for + * #DBUS_MESSAGE_TYPE_METHOD_RETURN, so is slightly different from + * what you might expect (that is, it does not include the signature of the + * entire C++-style method). * - * @param iter an iterator pointing to the end of the message - * @param value the array - * @param len the length of the array - * @returns #TRUE on success + * The signature is a string made up of type codes such as + * #DBUS_TYPE_INT32. The string is terminated with nul (nul is also + * the value of #DBUS_TYPE_INVALID). + * + * The returned string becomes invalid if the message is + * modified, since it points into the wire-marshaled message data. + * + * @param message the message + * @returns the type signature */ -dbus_bool_t -dbus_message_iter_append_boolean_array (DBusMessageIter *iter, - unsigned const char *value, - int len) +const char* +dbus_message_get_signature (DBusMessage *message) { - DBusMessageRealIter *real = (DBusMessageRealIter *)iter; + const DBusString *type_str; + int type_pos; - _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE); + _dbus_return_val_if_fail (message != NULL, NULL); - if (!append_array_type (real, DBUS_TYPE_BOOLEAN, NULL, NULL)) - return FALSE; - - if (!_dbus_marshal_byte_array (&real->message->body, real->message->byte_order, value, len)) - { - _dbus_string_set_length (&real->message->body, real->pos); - return FALSE; - } + get_const_signature (&message->header, &type_str, &type_pos); - dbus_message_iter_append_done (real); - - return TRUE; + return _dbus_string_get_const_data_len (type_str, type_pos, 0); } -/** - * Appends a 32 bit signed integer array to the message. - * - * @param iter an iterator pointing to the end of the message - * @param value the array - * @param len the length of the array - * @returns #TRUE on success - */ -dbus_bool_t -dbus_message_iter_append_int32_array (DBusMessageIter *iter, - const dbus_int32_t *value, - int len) +static dbus_bool_t +_dbus_message_has_type_interface_member (DBusMessage *message, + int type, + const char *interface, + const char *member) { - DBusMessageRealIter *real = (DBusMessageRealIter *)iter; + const char *n; - _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE); + _dbus_assert (message != NULL); + _dbus_assert (interface != NULL); + _dbus_assert (member != NULL); - if (!append_array_type (real, DBUS_TYPE_INT32, NULL, NULL)) + if (dbus_message_get_type (message) != type) return FALSE; - - if (!_dbus_marshal_int32_array (&real->message->body, real->message->byte_order, value, len)) + + /* Optimize by checking the short member name first + * instead of the longer interface name + */ + + n = dbus_message_get_member (message); + + if (n && strcmp (n, member) == 0) { - _dbus_string_set_length (&real->message->body, real->pos); - return FALSE; + n = dbus_message_get_interface (message); + + if (n == NULL || strcmp (n, interface) == 0) + return TRUE; } - dbus_message_iter_append_done (real); - - return TRUE; + return FALSE; } /** - * Appends a 32 bit unsigned integer array to the message. + * Checks whether the message is a method call with the given + * interface and member fields. If the message is not + * #DBUS_MESSAGE_TYPE_METHOD_CALL, or has a different interface or + * member field, returns #FALSE. If the interface field is missing, + * then it will be assumed equal to the provided interface. The D-Bus + * protocol allows method callers to leave out the interface name. * - * @param iter an iterator pointing to the end of the message - * @param value the array - * @param len the length of the array - * @returns #TRUE on success - */ -dbus_bool_t -dbus_message_iter_append_uint32_array (DBusMessageIter *iter, - const dbus_uint32_t *value, - int len) + * @param message the message + * @param interface the name to check (must not be #NULL) + * @param method the name to check (must not be #NULL) + * + * @returns #TRUE if the message is the specified method call + */ +dbus_bool_t +dbus_message_is_method_call (DBusMessage *message, + const char *interface, + const char *method) { - DBusMessageRealIter *real = (DBusMessageRealIter *)iter; - - _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE); - - if (!append_array_type (real, DBUS_TYPE_UINT32, NULL, NULL)) - return FALSE; - - if (!_dbus_marshal_uint32_array (&real->message->body, real->message->byte_order, value, len)) - { - _dbus_string_set_length (&real->message->body, real->pos); - return FALSE; - } + _dbus_return_val_if_fail (message != NULL, FALSE); + _dbus_return_val_if_fail (interface != NULL, FALSE); + _dbus_return_val_if_fail (method != NULL, FALSE); + /* don't check that interface/method are valid since it would be + * expensive, and not catch many common errors + */ - dbus_message_iter_append_done (real); - - return TRUE; + return _dbus_message_has_type_interface_member (message, + DBUS_MESSAGE_TYPE_METHOD_CALL, + interface, method); } -#ifdef DBUS_HAVE_INT64 - /** - * Appends a 64 bit signed integer array to the message. + * Checks whether the message is a signal with the given interface and + * member fields. If the message is not #DBUS_MESSAGE_TYPE_SIGNAL, or + * has a different interface or member field, returns #FALSE. * - * This function only exists if #DBUS_HAVE_INT64 is defined. + * @param message the message + * @param interface the name to check (must not be #NULL) + * @param signal_name the name to check (must not be #NULL) * - * @param iter an iterator pointing to the end of the message - * @param value the array - * @param len the length of the array - * @returns #TRUE on success + * @returns #TRUE if the message is the specified signal */ dbus_bool_t -dbus_message_iter_append_int64_array (DBusMessageIter *iter, - const dbus_int64_t *value, - int len) +dbus_message_is_signal (DBusMessage *message, + const char *interface, + const char *signal_name) { - DBusMessageRealIter *real = (DBusMessageRealIter *)iter; - - _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE); - - if (!append_array_type (real, DBUS_TYPE_INT64, NULL, NULL)) - return FALSE; - - if (!_dbus_marshal_int64_array (&real->message->body, real->message->byte_order, value, len)) - { - _dbus_string_set_length (&real->message->body, real->pos); - return FALSE; - } + _dbus_return_val_if_fail (message != NULL, FALSE); + _dbus_return_val_if_fail (interface != NULL, FALSE); + _dbus_return_val_if_fail (signal_name != NULL, FALSE); + /* don't check that interface/name are valid since it would be + * expensive, and not catch many common errors + */ - dbus_message_iter_append_done (real); - - return TRUE; + return _dbus_message_has_type_interface_member (message, + DBUS_MESSAGE_TYPE_SIGNAL, + interface, signal_name); } /** - * Appends a 64 bit unsigned integer array to the message. + * Checks whether the message is an error reply with the given error + * name. If the message is not #DBUS_MESSAGE_TYPE_ERROR, or has a + * different name, returns #FALSE. * - * This function only exists if #DBUS_HAVE_INT64 is defined. + * @param message the message + * @param error_name the name to check (must not be #NULL) * - * @param iter an iterator pointing to the end of the message - * @param value the array - * @param len the length of the array - * @returns #TRUE on success + * @returns #TRUE if the message is the specified error */ dbus_bool_t -dbus_message_iter_append_uint64_array (DBusMessageIter *iter, - const dbus_uint64_t *value, - int len) +dbus_message_is_error (DBusMessage *message, + const char *error_name) { - DBusMessageRealIter *real = (DBusMessageRealIter *)iter; + const char *n; - _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE); + _dbus_return_val_if_fail (message != NULL, FALSE); + _dbus_return_val_if_fail (error_name != NULL, FALSE); + /* don't check that error_name is valid since it would be expensive, + * and not catch many common errors + */ - if (!append_array_type (real, DBUS_TYPE_UINT64, NULL, NULL)) + if (dbus_message_get_type (message) != DBUS_MESSAGE_TYPE_ERROR) return FALSE; - - if (!_dbus_marshal_uint64_array (&real->message->body, real->message->byte_order, value, len)) - { - _dbus_string_set_length (&real->message->body, real->pos); - return FALSE; - } - dbus_message_iter_append_done (real); - - return TRUE; + n = dbus_message_get_error_name (message); + + if (n && strcmp (n, error_name) == 0) + return TRUE; + else + return FALSE; } -#endif /* DBUS_HAVE_INT64 */ /** - * Appends a double array to the message. + * Checks whether the message was sent to the given name. If the + * message has no destination specified or has a different + * destination, returns #FALSE. * - * @param iter an iterator pointing to the end of the message - * @param value the array - * @param len the length of the array - * @returns #TRUE on success + * @param message the message + * @param name the name to check (must not be #NULL) + * + * @returns #TRUE if the message has the given destination name */ dbus_bool_t -dbus_message_iter_append_double_array (DBusMessageIter *iter, - const double *value, - int len) +dbus_message_has_destination (DBusMessage *message, + const char *name) { - DBusMessageRealIter *real = (DBusMessageRealIter *)iter; + const char *s; - _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE); + _dbus_return_val_if_fail (message != NULL, FALSE); + _dbus_return_val_if_fail (name != NULL, FALSE); + /* don't check that name is valid since it would be expensive, and + * not catch many common errors + */ - if (!append_array_type (real, DBUS_TYPE_DOUBLE, NULL, NULL)) - return FALSE; - - if (!_dbus_marshal_double_array (&real->message->body, real->message->byte_order, value, len)) - { - _dbus_string_set_length (&real->message->body, real->pos); - return FALSE; - } + s = dbus_message_get_destination (message); - dbus_message_iter_append_done (real); - - return TRUE; + if (s && strcmp (s, name) == 0) + return TRUE; + else + return FALSE; } /** - * Appends a byte array to the message. + * Checks whether the message has the given unique name as its sender. + * If the message has no sender specified or has a different sender, + * returns #FALSE. Note that a peer application will always have the + * unique name of the connection as the sender. So you can't use this + * function to see whether a sender owned a well-known name. * - * @param iter an iterator pointing to the end of the message - * @param value the array - * @param len the length of the array - * @returns #TRUE on success + * Messages from the bus itself will have #DBUS_SERVICE_DBUS + * as the sender. + * + * @param message the message + * @param name the name to check (must not be #NULL) + * + * @returns #TRUE if the message has the given sender */ dbus_bool_t -dbus_message_iter_append_byte_array (DBusMessageIter *iter, - unsigned const char *value, - int len) +dbus_message_has_sender (DBusMessage *message, + const char *name) { - DBusMessageRealIter *real = (DBusMessageRealIter *)iter; + const char *s; - _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE); + _dbus_return_val_if_fail (message != NULL, FALSE); + _dbus_return_val_if_fail (name != NULL, FALSE); + /* don't check that name is valid since it would be expensive, and + * not catch many common errors + */ - if (!append_array_type (real, DBUS_TYPE_BYTE, NULL, NULL)) - return FALSE; - - if (!_dbus_marshal_byte_array (&real->message->body, real->message->byte_order, value, len)) - { - _dbus_string_set_length (&real->message->body, real->pos); - return FALSE; - } + s = dbus_message_get_sender (message); - dbus_message_iter_append_done (real); - - return TRUE; + if (s && strcmp (s, name) == 0) + return TRUE; + else + return FALSE; } /** - * Appends a string array to the message. + * Checks whether the message has the given signature; see + * dbus_message_get_signature() for more details on what the signature + * looks like. * - * @param iter an iterator pointing to the end of the message - * @param value the array - * @param len the length of the array - * @returns #TRUE on success - */ + * @param message the message + * @param signature typecode array + * @returns #TRUE if message has the given signature +*/ dbus_bool_t -dbus_message_iter_append_string_array (DBusMessageIter *iter, - const char **value, - int len) +dbus_message_has_signature (DBusMessage *message, + const char *signature) { - DBusMessageRealIter *real = (DBusMessageRealIter *)iter; + const char *s; - _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE); + _dbus_return_val_if_fail (message != NULL, FALSE); + _dbus_return_val_if_fail (signature != NULL, FALSE); + /* don't check that signature is valid since it would be expensive, + * and not catch many common errors + */ - if (!append_array_type (real, DBUS_TYPE_STRING, NULL, NULL)) - return FALSE; - - if (!_dbus_marshal_string_array (&real->message->body, real->message->byte_order, value, len)) - { - _dbus_string_set_length (&real->message->body, real->pos); - return FALSE; - } + s = dbus_message_get_signature (message); - dbus_message_iter_append_done (real); - - return TRUE; + if (s && strcmp (s, signature) == 0) + return TRUE; + else + return FALSE; } /** - * Sets the message sender. + * Sets a #DBusError based on the contents of the given + * message. The error is only set if the message + * is an error message, as in #DBUS_MESSAGE_TYPE_ERROR. + * The name of the error is set to the name of the message, + * and the error message is set to the first argument + * if the argument exists and is a string. * - * @param message the message - * @param sender the sender - * @returns #FALSE if not enough memory + * The return value indicates whether the error was set (the error is + * set if and only if the message is an error message). So you can + * check for an error reply and convert it to DBusError in one go: + * @code + * if (dbus_set_error_from_message (error, reply)) + * return error; + * else + * process reply; + * @endcode + * + * @param error the error to set + * @param message the message to set it from + * @returns #TRUE if the message had type #DBUS_MESSAGE_TYPE_ERROR */ dbus_bool_t -dbus_message_set_sender (DBusMessage *message, - const char *sender) +dbus_set_error_from_message (DBusError *error, + DBusMessage *message) { + const char *str; + _dbus_return_val_if_fail (message != NULL, FALSE); - _dbus_return_val_if_fail (!message->locked, FALSE); + _dbus_return_val_if_error_is_set (error, FALSE); + + if (dbus_message_get_type (message) != DBUS_MESSAGE_TYPE_ERROR) + return FALSE; + + str = NULL; + dbus_message_get_args (message, NULL, + DBUS_TYPE_STRING, &str, + DBUS_TYPE_INVALID); + + dbus_set_error (error, dbus_message_get_error_name (message), + str ? "%s" : NULL, str); - return set_string_field (message, - DBUS_HEADER_FIELD_SENDER_SERVICE, - DBUS_TYPE_STRING, - sender); + return TRUE; } +/** @} */ + /** - * Sets a flag indicating that the message does not want a reply; if - * this flag is set, the other end of the connection may (but is not - * required to) optimize by not sending method return or error - * replies. If this flag is set, there is no way to know whether the - * message successfully arrived at the remote end. + * @addtogroup DBusMessageInternals * - * @param message the message - * @param no_reply #TRUE if no reply is desired + * @{ */ -void -dbus_message_set_no_reply (DBusMessage *message, - dbus_bool_t no_reply) -{ - char *header; - _dbus_return_if_fail (message != NULL); - _dbus_return_if_fail (!message->locked); - - header = _dbus_string_get_data_len (&message->header, FLAGS_OFFSET, 1); - - if (no_reply) - *header |= DBUS_HEADER_FLAG_NO_REPLY_EXPECTED; - else - *header &= ~DBUS_HEADER_FLAG_NO_REPLY_EXPECTED; -} +/** + * The initial buffer size of the message loader. + * + * @todo this should be based on min header size plus some average + * body size, or something. Or rather, the min header size only, if we + * want to try to read only the header, store that in a DBusMessage, + * then read only the body and store that, etc., depends on + * how we optimize _dbus_message_loader_get_buffer() and what + * the exact message format is. + */ +#define INITIAL_LOADER_DATA_LEN 32 /** - * Returns #TRUE if the message does not expect - * a reply. + * Creates a new message loader. Returns #NULL if memory can't + * be allocated. * - * @param message the message - * @returns #TRUE if the message sender isn't waiting for a reply + * @returns new loader, or #NULL. */ -dbus_bool_t -dbus_message_get_no_reply (DBusMessage *message) +DBusMessageLoader* +_dbus_message_loader_new (void) { - const char *header; + DBusMessageLoader *loader; - _dbus_return_val_if_fail (message != NULL, FALSE); + loader = dbus_new0 (DBusMessageLoader, 1); + if (loader == NULL) + return NULL; - header = _dbus_string_get_const_data_len (&message->header, FLAGS_OFFSET, 1); - - return (*header & DBUS_HEADER_FLAG_NO_REPLY_EXPECTED) != 0; -} + loader->refcount = 1; -void -dbus_message_set_auto_activation (DBusMessage *message, - dbus_bool_t auto_activation) -{ - char *header; + loader->corrupted = FALSE; + loader->corruption_reason = DBUS_VALID; - _dbus_return_if_fail (message != NULL); - _dbus_return_if_fail (!message->locked); - - header = _dbus_string_get_data_len (&message->header, FLAGS_OFFSET, 1); - - if (auto_activation) - *header |= DBUS_HEADER_FLAG_AUTO_ACTIVATION; - else - *header &= ~DBUS_HEADER_FLAG_AUTO_ACTIVATION; -} + /* this can be configured by the app, but defaults to the protocol max */ + loader->max_message_size = DBUS_MAXIMUM_MESSAGE_LENGTH; -dbus_bool_t -dbus_message_get_auto_activation (DBusMessage *message) -{ - const char *header; + if (!_dbus_string_init (&loader->data)) + { + dbus_free (loader); + return NULL; + } - _dbus_return_val_if_fail (message != NULL, FALSE); - - header = _dbus_string_get_const_data_len (&message->header, FLAGS_OFFSET, 1); + /* preallocate the buffer for speed, ignore failure */ + _dbus_string_set_length (&loader->data, INITIAL_LOADER_DATA_LEN); + _dbus_string_set_length (&loader->data, 0); - return (*header & DBUS_HEADER_FLAG_AUTO_ACTIVATION) != 0; + return loader; } /** - * Gets the service which originated this message, - * or #NULL if unknown or inapplicable. + * Increments the reference count of the loader. * - * @param message the message - * @returns the service name or #NULL + * @param loader the loader. + * @returns the loader */ -const char* -dbus_message_get_sender (DBusMessage *message) +DBusMessageLoader * +_dbus_message_loader_ref (DBusMessageLoader *loader) { - _dbus_return_val_if_fail (message != NULL, NULL); - - return get_string_field (message, - DBUS_HEADER_FIELD_SENDER_SERVICE, - NULL); + loader->refcount += 1; + + return loader; } /** - * Gets the type signature of the message, i.e. the arguments in the - * message payload. The signature includes only "in" arguments for - * #DBUS_MESSAGE_TYPE_METHOD_CALL and only "out" arguments for - * #DBUS_MESSAGE_TYPE_METHOD_RETURN, so is slightly different from - * what you might expect (it does not include the signature of the - * entire C++-style method). + * Decrements the reference count of the loader and finalizes the + * loader when the count reaches zero. * - * The signature is a string made up of type codes such - * as #DBUS_TYPE_STRING. The string is terminated with nul - * (nul is also the value of #DBUS_TYPE_INVALID). - * - * @param message the message - * @returns the type signature + * @param loader the loader. */ -const char* -dbus_message_get_signature (DBusMessage *message) -{ - _dbus_return_val_if_fail (message != NULL, NULL); - - return _dbus_string_get_const_data (&message->signature); -} - -static dbus_bool_t -_dbus_message_has_type_interface_member (DBusMessage *message, - int type, - const char *interface, - const char *method) +void +_dbus_message_loader_unref (DBusMessageLoader *loader) { - const char *n; - - _dbus_assert (message != NULL); - _dbus_assert (interface != NULL); - _dbus_assert (method != NULL); - - if (dbus_message_get_type (message) != type) - return FALSE; - - /* Optimize by checking the short method name first - * instead of the longer interface name - */ - - n = dbus_message_get_member (message); - - if (n && strcmp (n, method) == 0) + loader->refcount -= 1; + if (loader->refcount == 0) { - n = dbus_message_get_interface (message); - - if (n && strcmp (n, interface) == 0) - return TRUE; + _dbus_list_foreach (&loader->messages, + (DBusForeachFunction) dbus_message_unref, + NULL); + _dbus_list_clear (&loader->messages); + _dbus_string_free (&loader->data); + dbus_free (loader); } - - return FALSE; } /** - * Checks whether the message is a method call with the given - * interface and member fields. If the message is not - * #DBUS_MESSAGE_TYPE_METHOD_CALL, or has a different interface or member field, - * returns #FALSE. + * Gets the buffer to use for reading data from the network. Network + * data is read directly into an allocated buffer, which is then used + * in the DBusMessage, to avoid as many extra memcpy's as possible. + * The buffer must always be returned immediately using + * _dbus_message_loader_return_buffer(), even if no bytes are + * successfully read. * - * @param message the message - * @param interface the name to check (must not be #NULL) - * @param method the name to check (must not be #NULL) - * - * @returns #TRUE if the message is the specified method call - */ -dbus_bool_t -dbus_message_is_method_call (DBusMessage *message, - const char *interface, - const char *method) -{ - _dbus_return_val_if_fail (message != NULL, FALSE); - _dbus_return_val_if_fail (interface != NULL, FALSE); - _dbus_return_val_if_fail (method != NULL, FALSE); - - return _dbus_message_has_type_interface_member (message, - DBUS_MESSAGE_TYPE_METHOD_CALL, - interface, method); -} - -/** - * Checks whether the message is a signal with the given - * interface and member fields. If the message is not - * #DBUS_MESSAGE_TYPE_SIGNAL, or has a different interface or member field, - * returns #FALSE. + * @todo this function can be a lot more clever. For example + * it can probably always return a buffer size to read exactly + * the body of the next message, thus avoiding any memory wastage + * or reallocs. * - * @param message the message - * @param interface the name to check (must not be #NULL) - * @param signal_name the name to check (must not be #NULL) - * - * @returns #TRUE if the message is the specified signal - */ -dbus_bool_t -dbus_message_is_signal (DBusMessage *message, - const char *interface, - const char *signal_name) -{ - _dbus_return_val_if_fail (message != NULL, FALSE); - _dbus_return_val_if_fail (interface != NULL, FALSE); - _dbus_return_val_if_fail (signal_name != NULL, FALSE); - - return _dbus_message_has_type_interface_member (message, - DBUS_MESSAGE_TYPE_SIGNAL, - interface, signal_name); -} - -/** - * Checks whether the message is an error reply with the given error - * name. If the message is not #DBUS_MESSAGE_TYPE_ERROR, or has a - * different name, returns #FALSE. + * @todo we need to enforce a max length on strings in header fields. * - * @param message the message - * @param error_name the name to check (must not be #NULL) - * - * @returns #TRUE if the message is the specified error + * @param loader the message loader. + * @param buffer the buffer */ -dbus_bool_t -dbus_message_is_error (DBusMessage *message, - const char *error_name) +void +_dbus_message_loader_get_buffer (DBusMessageLoader *loader, + DBusString **buffer) { - const char *n; - - _dbus_return_val_if_fail (message != NULL, FALSE); - _dbus_return_val_if_fail (error_name != NULL, FALSE); - - if (dbus_message_get_type (message) != DBUS_MESSAGE_TYPE_ERROR) - return FALSE; + _dbus_assert (!loader->buffer_outstanding); - n = dbus_message_get_error_name (message); + *buffer = &loader->data; - if (n && strcmp (n, error_name) == 0) - return TRUE; - else - return FALSE; + loader->buffer_outstanding = TRUE; } /** - * Checks whether the message was sent to the given service. If the - * message has no service specified or has a different name, returns - * #FALSE. + * Returns a buffer obtained from _dbus_message_loader_get_buffer(), + * indicating to the loader how many bytes of the buffer were filled + * in. This function must always be called, even if no bytes were + * successfully read. * - * @param message the message - * @param service the service to check (must not be #NULL) - * - * @returns #TRUE if the message has the given destination service + * @param loader the loader. + * @param buffer the buffer. + * @param bytes_read number of bytes that were read into the buffer. */ -dbus_bool_t -dbus_message_has_destination (DBusMessage *message, - const char *service) +void +_dbus_message_loader_return_buffer (DBusMessageLoader *loader, + DBusString *buffer, + int bytes_read) { - const char *s; - - _dbus_return_val_if_fail (message != NULL, FALSE); - _dbus_return_val_if_fail (service != NULL, FALSE); - - s = dbus_message_get_destination (message); + _dbus_assert (loader->buffer_outstanding); + _dbus_assert (buffer == &loader->data); - if (s && strcmp (s, service) == 0) - return TRUE; - else - return FALSE; + loader->buffer_outstanding = FALSE; } -/** - * Checks whether the message has the given service as its sender. If - * the message has no sender specified or has a different sender, - * returns #FALSE. Note that if a peer application owns multiple - * services, its messages will have only one of those services as the - * sender (usually the base service). So you can't use this - * function to prove the sender didn't own service Foo, you can - * only use it to prove that it did. +/* + * FIXME when we move the header out of the buffer, that memmoves all + * buffered messages. Kind of crappy. * - * @param message the message - * @param service the service to check (must not be #NULL) - * - * @returns #TRUE if the message has the given origin service - */ -dbus_bool_t -dbus_message_has_sender (DBusMessage *message, - const char *service) -{ - const char *s; - - _dbus_return_val_if_fail (message != NULL, FALSE); - _dbus_return_val_if_fail (service != NULL, FALSE); - - s = dbus_message_get_sender (message); - - if (s && strcmp (s, service) == 0) - return TRUE; - else - return FALSE; -} - -/** - * Checks whether the message has the given signature; - * see dbus_message_get_signature() for more details on - * what the signature looks like. + * Also we copy the header and body, which is kind of crappy. To + * avoid this, we have to allow header and body to be in a single + * memory block, which is good for messages we read and bad for + * messages we are creating. But we could move_len() the buffer into + * this single memory block, and move_len() will just swap the buffers + * if you're moving the entire buffer replacing the dest string. * - * @param message the message - * @param signature typecode array - * @returns #TRUE if message has the given signature -*/ -dbus_bool_t -dbus_message_has_signature (DBusMessage *message, - const char *signature) -{ - _dbus_return_val_if_fail (message != NULL, FALSE); - _dbus_return_val_if_fail (signature != NULL, FALSE); - - return _dbus_string_equal_c_str (&message->signature, signature); -} - -/** - * Sets a #DBusError based on the contents of the given - * message. The error is only set if the message - * is an error message, as in DBUS_MESSAGE_TYPE_ERROR. - * The name of the error is set to the name of the message, - * and the error message is set to the first argument - * if the argument exists and is a string. + * We could also have the message loader tell the transport how many + * bytes to read; so it would first ask for some arbitrary number like + * 256, then if the message was incomplete it would use the + * header/body len to ask for exactly the size of the message (or + * blocks the size of a typical kernel buffer for the socket). That + * way we don't get trailing bytes in the buffer that have to be + * memmoved. Though I suppose we also don't have a chance of reading a + * bunch of small messages at once, so the optimization may be stupid. * - * The return value indicates whether the error was set (the error is - * set if and only if the message is an error message). - * So you can check for an error reply and convert it to DBusError - * in one go. + * Another approach would be to keep a "start" index into + * loader->data and only delete it occasionally, instead of after + * each message is loaded. * - * @param error the error to set - * @param message the message to set it from - * @returns #TRUE if dbus_message_get_is_error() returns #TRUE for the message + * load_message() returns FALSE if not enough memory OR the loader was corrupted */ -dbus_bool_t -dbus_set_error_from_message (DBusError *error, - DBusMessage *message) +static dbus_bool_t +load_message (DBusMessageLoader *loader, + DBusMessage *message, + int byte_order, + int fields_array_len, + int header_len, + int body_len) { - char *str; - - _dbus_return_val_if_fail (message != NULL, FALSE); - _dbus_return_val_if_error_is_set (error, FALSE); - - if (dbus_message_get_type (message) != DBUS_MESSAGE_TYPE_ERROR) - return FALSE; - - str = NULL; - dbus_message_get_args (message, NULL, - DBUS_TYPE_STRING, &str, - DBUS_TYPE_INVALID); - - dbus_set_error (error, dbus_message_get_error_name (message), - str ? "%s" : NULL, str); + dbus_bool_t oom; + DBusValidity validity; + const DBusString *type_str; + int type_pos; + DBusValidationMode mode; - dbus_free (str); + mode = DBUS_VALIDATION_MODE_DATA_IS_UNTRUSTED; - return TRUE; -} - -/** @} */ - -/** - * @addtogroup DBusMessageInternals - * - * @{ - */ -/** - * @typedef DBusMessageLoader - * - * The DBusMessageLoader object encapsulates the process of converting - * a byte stream into a series of DBusMessage. It buffers the incoming - * bytes as efficiently as possible, and generates a queue of - * messages. DBusMessageLoader is typically used as part of a - * DBusTransport implementation. The DBusTransport then hands off - * the loaded messages to a DBusConnection, making the messages - * visible to the application. - * - * @todo write tests for break-loader that a) randomly delete header - * fields and b) set string fields to zero-length and other funky - * values. - * - */ - -/* we definitely use signed ints for sizes, so don't exceed - * _DBUS_INT_MAX; and add 16 for paranoia, since a message - * over 128M is pretty nuts anyhow. - */ - -/** - * The maximum sane message size. - */ -#define MAX_SANE_MESSAGE_SIZE (_DBUS_INT_MAX/16) + oom = FALSE; -/** - * Implementation details of DBusMessageLoader. - * All members are private. - */ -struct DBusMessageLoader -{ - int refcount; /**< Reference count. */ +#if 0 + _dbus_verbose_bytes_of_string (&loader->data, 0, header_len /* + body_len */); +#endif - DBusString data; /**< Buffered data */ - - DBusList *messages; /**< Complete messages. */ + /* 1. VALIDATE AND COPY OVER HEADER */ + _dbus_assert (_dbus_string_get_length (&message->header.data) == 0); + _dbus_assert ((header_len + body_len) <= _dbus_string_get_length (&loader->data)); - long max_message_size; /**< Maximum size of a message */ - - unsigned int buffer_outstanding : 1; /**< Someone is using the buffer to read */ + if (!_dbus_header_load (&message->header, + mode, + &validity, + byte_order, + fields_array_len, + header_len, + body_len, + &loader->data, 0, + _dbus_string_get_length (&loader->data))) + { + _dbus_verbose ("Failed to load header for new message code %d\n", validity); - unsigned int corrupted : 1; /**< We got broken data, and are no longer working */ -}; + /* assert here so we can catch any code that still uses DBUS_VALID to indicate + oom errors. They should use DBUS_VALIDITY_UNKNOWN_OOM_ERROR instead */ + _dbus_assert (validity != DBUS_VALID); -/** - * The initial buffer size of the message loader. - * - * @todo this should be based on min header size plus some average - * body size, or something. Or rather, the min header size only, if we - * want to try to read only the header, store that in a DBusMessage, - * then read only the body and store that, etc., depends on - * how we optimize _dbus_message_loader_get_buffer() and what - * the exact message format is. - */ -#define INITIAL_LOADER_DATA_LEN 32 - -/** - * Creates a new message loader. Returns #NULL if memory can't - * be allocated. - * - * @returns new loader, or #NULL. - */ -DBusMessageLoader* -_dbus_message_loader_new (void) -{ - DBusMessageLoader *loader; - - loader = dbus_new0 (DBusMessageLoader, 1); - if (loader == NULL) - return NULL; - - loader->refcount = 1; - - /* Try to cap message size at something that won't *totally* hose - * the system if we have a couple of them. - */ - loader->max_message_size = _DBUS_ONE_MEGABYTE * 32; - - if (!_dbus_string_init (&loader->data)) - { - dbus_free (loader); - return NULL; - } - - /* preallocate the buffer for speed, ignore failure */ - _dbus_string_set_length (&loader->data, INITIAL_LOADER_DATA_LEN); - _dbus_string_set_length (&loader->data, 0); - - return loader; -} - -/** - * Increments the reference count of the loader. - * - * @param loader the loader. - * @returns the loader - */ -DBusMessageLoader * -_dbus_message_loader_ref (DBusMessageLoader *loader) -{ - loader->refcount += 1; - - return loader; -} - -/** - * Decrements the reference count of the loader and finalizes the - * loader when the count reaches zero. - * - * @param loader the loader. - */ -void -_dbus_message_loader_unref (DBusMessageLoader *loader) -{ - loader->refcount -= 1; - if (loader->refcount == 0) - { - _dbus_list_foreach (&loader->messages, - (DBusForeachFunction) dbus_message_unref, - NULL); - _dbus_list_clear (&loader->messages); - _dbus_string_free (&loader->data); - dbus_free (loader); - } -} - -/** - * Gets the buffer to use for reading data from the network. Network - * data is read directly into an allocated buffer, which is then used - * in the DBusMessage, to avoid as many extra memcpy's as possible. - * The buffer must always be returned immediately using - * _dbus_message_loader_return_buffer(), even if no bytes are - * successfully read. - * - * @todo this function can be a lot more clever. For example - * it can probably always return a buffer size to read exactly - * the body of the next message, thus avoiding any memory wastage - * or reallocs. - * - * @todo we need to enforce a max length on strings in header fields. - * - * @param loader the message loader. - * @param buffer the buffer - */ -void -_dbus_message_loader_get_buffer (DBusMessageLoader *loader, - DBusString **buffer) -{ - _dbus_assert (!loader->buffer_outstanding); - - *buffer = &loader->data; - - loader->buffer_outstanding = TRUE; -} - -/** - * The smallest header size that can occur. - * (It won't be valid) - */ -#define DBUS_MINIMUM_HEADER_SIZE 16 - -static dbus_bool_t -decode_string_field (const DBusString *data, - int field, - HeaderField *header_field, - DBusString *field_data, - int pos, - int type) -{ - int string_data_pos; - - _dbus_assert (header_field != NULL); - _dbus_assert (field_data != NULL); - - if (header_field->name_offset >= 0) - { - _dbus_verbose ("%s field provided twice\n", - _dbus_header_field_to_string (field)); - return FALSE; - } - - if (type != DBUS_TYPE_STRING) - { - _dbus_verbose ("%s field has wrong type %s\n", - _dbus_header_field_to_string (field), - _dbus_type_to_string (type)); - return FALSE; - } - - /* skip padding after typecode, skip string length; - * we assume that the string arg has already been validated - * for sanity and UTF-8 - */ - string_data_pos = _DBUS_ALIGN_VALUE (pos, 4) + 4; - _dbus_assert (string_data_pos < _dbus_string_get_length (data)); - - _dbus_string_init_const (field_data, - _dbus_string_get_const_data (data) + string_data_pos); - - header_field->name_offset = pos; - header_field->value_offset = _DBUS_ALIGN_VALUE (pos, 4); - -#if 0 - _dbus_verbose ("Found field %s at offset %d\n", - _dbus_header_field_to_string (field), - header_field->value_offset); -#endif - - return TRUE; -} - -/* FIXME because the service/interface/member/error names are already - * validated to be in the particular ASCII subset, UTF-8 validating - * them could be skipped as a probably-interesting optimization. - * The UTF-8 validation definitely shows up in profiles. - */ -static dbus_bool_t -decode_header_data (const DBusString *data, - int header_len, - int byte_order, - int message_type, - HeaderField fields[DBUS_HEADER_FIELD_LAST + 1], - int *message_padding) -{ - DBusString field_data; - int pos, new_pos; - int i; - int field; - int type; - - if (header_len < 16) - { - _dbus_verbose ("Header length %d is too short\n", header_len); - return FALSE; - } - - i = 0; - while (i <= DBUS_HEADER_FIELD_LAST) - { - fields[i].name_offset = -1; - fields[i].value_offset = -1; - ++i; - } - - pos = 16; - while (pos < header_len) - { - field = _dbus_string_get_byte (data, pos); - if (field == DBUS_HEADER_FIELD_INVALID) - break; /* Must be padding */ - pos++; - - if (!_dbus_marshal_validate_type (data, pos, &type, &pos)) - { - _dbus_verbose ("Failed to validate type of named header field pos = %d\n", - pos); - return FALSE; - } - - if (!_dbus_marshal_validate_arg (data, byte_order, 0, type, -1, pos, &new_pos)) - { - _dbus_verbose ("Failed to validate argument to named header field pos = %d\n", - pos); - return FALSE; - } - - if (new_pos > header_len) - { - _dbus_verbose ("Named header field tries to extend beyond header length\n"); - return FALSE; - } - - switch (field) - { - case DBUS_HEADER_FIELD_SERVICE: - if (!decode_string_field (data, field, &fields[field], - &field_data, pos, type)) - return FALSE; - - if (!_dbus_string_validate_service (&field_data, 0, - _dbus_string_get_length (&field_data))) - { - _dbus_verbose ("service field has invalid content \"%s\"\n", - _dbus_string_get_const_data (&field_data)); - return FALSE; - } - break; - - case DBUS_HEADER_FIELD_INTERFACE: - if (!decode_string_field (data, field, &fields[field], - &field_data, pos, type)) - return FALSE; - - if (!_dbus_string_validate_interface (&field_data, 0, - _dbus_string_get_length (&field_data))) - { - _dbus_verbose ("interface field has invalid content \"%s\"\n", - _dbus_string_get_const_data (&field_data)); - return FALSE; - } - - if (_dbus_string_equal_c_str (&field_data, - DBUS_INTERFACE_ORG_FREEDESKTOP_LOCAL)) - { - _dbus_verbose ("Message is on the local interface\n"); - return FALSE; - } - break; - - case DBUS_HEADER_FIELD_MEMBER: - if (!decode_string_field (data, field, &fields[field], - &field_data, pos, type)) - return FALSE; - - if (!_dbus_string_validate_member (&field_data, 0, - _dbus_string_get_length (&field_data))) - { - _dbus_verbose ("member field has invalid content \"%s\"\n", - _dbus_string_get_const_data (&field_data)); - return FALSE; - } - break; - - case DBUS_HEADER_FIELD_ERROR_NAME: - if (!decode_string_field (data, field, &fields[field], - &field_data, pos, type)) - return FALSE; - - if (!_dbus_string_validate_error_name (&field_data, 0, - _dbus_string_get_length (&field_data))) - { - _dbus_verbose ("error-name field has invalid content \"%s\"\n", - _dbus_string_get_const_data (&field_data)); - return FALSE; - } - break; - - case DBUS_HEADER_FIELD_SENDER_SERVICE: - if (!decode_string_field (data, field, &fields[field], - &field_data, pos, type)) - return FALSE; - - if (!_dbus_string_validate_service (&field_data, 0, - _dbus_string_get_length (&field_data))) - { - _dbus_verbose ("sender-service field has invalid content \"%s\"\n", - _dbus_string_get_const_data (&field_data)); - return FALSE; - } - break; - - case DBUS_HEADER_FIELD_PATH: - - /* Path was already validated as part of standard - * type validation, since there's an OBJECT_PATH - * type. - */ - - if (fields[field].name_offset >= 0) - { - _dbus_verbose ("path field provided twice\n"); - return FALSE; - } - if (type != DBUS_TYPE_OBJECT_PATH) - { - _dbus_verbose ("path field has wrong type\n"); - return FALSE; - } - - fields[field].name_offset = pos; - fields[field].value_offset = _DBUS_ALIGN_VALUE (pos, 4); - - /* No forging signals from the local path */ - { - const char *s; - s = _dbus_string_get_const_data_len (data, - fields[field].value_offset, - _dbus_string_get_length (data) - - fields[field].value_offset); - if (strcmp (s, DBUS_PATH_ORG_FREEDESKTOP_LOCAL) == 0) - { - _dbus_verbose ("Message is on the local path\n"); - return FALSE; - } - } - - _dbus_verbose ("Found path at offset %d\n", - fields[field].value_offset); - break; - - case DBUS_HEADER_FIELD_REPLY_SERIAL: - if (fields[field].name_offset >= 0) - { - _dbus_verbose ("reply field provided twice\n"); - return FALSE; - } - - if (type != DBUS_TYPE_UINT32) - { - _dbus_verbose ("reply field has wrong type\n"); - return FALSE; - } - - fields[field].name_offset = pos; - fields[field].value_offset = _DBUS_ALIGN_VALUE (pos, 4); - - _dbus_verbose ("Found reply serial %u at offset %d\n", - _dbus_demarshal_uint32 (data, - byte_order, - fields[field].value_offset, - NULL), - fields[field].value_offset); - break; - - default: - _dbus_verbose ("Ignoring an unknown header field: %d at offset %d\n", - field, pos); - } - - pos = new_pos; - } - - if (pos < header_len) - { - /* Alignment padding, verify that it's nul */ - if ((header_len - pos) >= 8) - { - _dbus_verbose ("too much header alignment padding\n"); - return FALSE; - } - - if (!_dbus_string_validate_nul (data, - pos, (header_len - pos))) - { - _dbus_verbose ("header alignment padding is not nul\n"); - return FALSE; - } - } - - /* Depending on message type, enforce presence of certain fields. */ - switch (message_type) - { - case DBUS_MESSAGE_TYPE_SIGNAL: - case DBUS_MESSAGE_TYPE_METHOD_CALL: - if (fields[DBUS_HEADER_FIELD_PATH].value_offset < 0) - { - _dbus_verbose ("No path field provided\n"); - return FALSE; - } - /* FIXME make this optional, only for method calls */ - if (fields[DBUS_HEADER_FIELD_INTERFACE].value_offset < 0) - { - _dbus_verbose ("No interface field provided\n"); - return FALSE; - } - if (fields[DBUS_HEADER_FIELD_MEMBER].value_offset < 0) - { - _dbus_verbose ("No member field provided\n"); - return FALSE; - } - break; - case DBUS_MESSAGE_TYPE_ERROR: - if (fields[DBUS_HEADER_FIELD_ERROR_NAME].value_offset < 0) - { - _dbus_verbose ("No error-name field provided\n"); - return FALSE; - } - if (fields[DBUS_HEADER_FIELD_REPLY_SERIAL].value_offset < 0) - { - _dbus_verbose ("No reply serial field provided in error\n"); - return FALSE; - } - break; - case DBUS_MESSAGE_TYPE_METHOD_RETURN: - if (fields[DBUS_HEADER_FIELD_REPLY_SERIAL].value_offset < 0) + if (validity == DBUS_VALIDITY_UNKNOWN_OOM_ERROR) + oom = TRUE; + else { - _dbus_verbose ("No reply serial field provided in method return\n"); - return FALSE; - } - break; - default: - /* An unknown type, spec requires us to ignore it */ - break; - } - - if (message_padding) - *message_padding = header_len - pos; - - return TRUE; -} - -/** - * Returns a buffer obtained from _dbus_message_loader_get_buffer(), - * indicating to the loader how many bytes of the buffer were filled - * in. This function must always be called, even if no bytes were - * successfully read. - * - * @param loader the loader. - * @param buffer the buffer. - * @param bytes_read number of bytes that were read into the buffer. - */ -void -_dbus_message_loader_return_buffer (DBusMessageLoader *loader, - DBusString *buffer, - int bytes_read) -{ - _dbus_assert (loader->buffer_outstanding); - _dbus_assert (buffer == &loader->data); - - loader->buffer_outstanding = FALSE; -} - -static dbus_bool_t -load_one_message (DBusMessageLoader *loader, - int byte_order, - int message_type, - int header_len, - int body_len) -{ - DBusMessage *message; - HeaderField fields[DBUS_HEADER_FIELD_LAST + 1]; - int i; - int next_arg; - dbus_bool_t oom; - int header_padding; - - message = NULL; - oom = FALSE; - -#if 0 - _dbus_verbose_bytes_of_string (&loader->data, 0, header_len /* + body_len */); -#endif - - if (!decode_header_data (&loader->data, - header_len, byte_order, - message_type, - fields, &header_padding)) - { - _dbus_verbose ("Header was invalid\n"); - loader->corrupted = TRUE; - goto failed; - } - - next_arg = header_len; - while (next_arg < (header_len + body_len)) - { - int type; - int prev = next_arg; - - if (!_dbus_marshal_validate_type (&loader->data, next_arg, - &type, &next_arg)) - { - _dbus_verbose ("invalid typecode at offset %d\n", prev); - loader->corrupted = TRUE; - goto failed; - } - - if (!_dbus_marshal_validate_arg (&loader->data, - byte_order, - 0, - type, -1, - next_arg, - &next_arg)) - { - _dbus_verbose ("invalid type data at %d, next_arg\n", next_arg); - loader->corrupted = TRUE; - goto failed; - } - - _dbus_assert (next_arg > prev); - } - - if (next_arg > (header_len + body_len)) - { - _dbus_verbose ("end of last arg at %d but message has len %d+%d=%d\n", - next_arg, header_len, body_len, - header_len + body_len); - loader->corrupted = TRUE; - goto failed; - } - - message = dbus_message_new_empty_header (); - if (message == NULL) - { - _dbus_verbose ("Failed to allocate empty message\n"); - oom = TRUE; - goto failed; - } - - message->byte_order = byte_order; - message->header_padding = header_padding; - - /* Copy in the offsets we found */ - i = 0; - while (i <= DBUS_HEADER_FIELD_LAST) - { - message->header_fields[i] = fields[i]; - ++i; - } - - if (!_dbus_list_append (&loader->messages, message)) - { - _dbus_verbose ("Failed to append new message to loader queue\n"); - oom = TRUE; - goto failed; - } - - _dbus_assert (_dbus_string_get_length (&message->header) == 0); - _dbus_assert (_dbus_string_get_length (&message->body) == 0); - - _dbus_assert (_dbus_string_get_length (&loader->data) >= - (header_len + body_len)); - - if (!_dbus_string_move_len (&loader->data, 0, header_len, &message->header, 0)) - { - _dbus_verbose ("Failed to move header into new message\n"); - oom = TRUE; - goto failed; - } - - if (!_dbus_string_move_len (&loader->data, 0, body_len, &message->body, 0)) - { - _dbus_verbose ("Failed to move body into new message\n"); - - oom = TRUE; - goto failed; - } - - _dbus_assert (_dbus_string_get_length (&message->header) == header_len); - _dbus_assert (_dbus_string_get_length (&message->body) == body_len); - - /* Fill in caches (we checked the types of these fields - * earlier) - */ - message->reply_serial = get_uint_field (message, - DBUS_HEADER_FIELD_REPLY_SERIAL); - - message->client_serial = _dbus_demarshal_uint32 (&message->header, - message->byte_order, - CLIENT_SERIAL_OFFSET, - NULL); - if (message->client_serial == 0 || - (message->header_fields[DBUS_HEADER_FIELD_REPLY_SERIAL].value_offset >= 0 && message->reply_serial == 0)) - { - _dbus_verbose ("client_serial = %d reply_serial = %d, one of these no good\n", - message->client_serial, - message->reply_serial); - - loader->corrupted = TRUE; - goto failed; - } - - /* Fill in signature (FIXME should do this during validation, - * but I didn't want to spend time on it since we want to change - * the wire format to contain the signature anyway) - */ - { - DBusMessageIter iter; - - dbus_message_iter_init (message, &iter); - - do - { - int t; - - t = dbus_message_iter_get_arg_type (&iter); - if (t == DBUS_TYPE_INVALID) - break; - - if (!_dbus_string_append_byte (&message->signature, - t)) - { - _dbus_verbose ("failed to append type byte to signature\n"); - oom = TRUE; - goto failed; - } - - if (t == DBUS_TYPE_ARRAY) - { - DBusMessageIter child_iter; - int array_type = t; - - child_iter = iter; - - while (array_type == DBUS_TYPE_ARRAY) - { - DBusMessageIter parent_iter = child_iter; - dbus_message_iter_init_array_iterator (&parent_iter, - &child_iter, - &array_type); - - if (!_dbus_string_append_byte (&message->signature, - array_type)) - { - _dbus_verbose ("failed to append array type byte to signature\n"); - - oom = TRUE; - goto failed; - } - } - } - } - while (dbus_message_iter_next (&iter)); - } - - _dbus_verbose ("Loaded message %p\n", message); - - _dbus_assert (!oom); - _dbus_assert (!loader->corrupted); - - return TRUE; - - failed: - - /* Clean up */ - - if (message != NULL) - { - /* Put the data back so we can try again later if it was an OOM issue */ - if (_dbus_string_get_length (&message->body) > 0) - { - dbus_bool_t result; - - result = _dbus_string_copy_len (&message->body, 0, body_len, - &loader->data, 0); - - _dbus_assert (result); /* because DBusString never reallocs smaller */ - } - - if (_dbus_string_get_length (&message->header) > 0) - { - dbus_bool_t result; - - result = _dbus_string_copy_len (&message->header, 0, header_len, - &loader->data, 0); - - _dbus_assert (result); /* because DBusString never reallocs smaller */ - } - - /* does nothing if the message isn't in the list */ - _dbus_list_remove_last (&loader->messages, message); - - dbus_message_unref (message); - } - - - return !oom; -} - -/** - * Converts buffered data into messages. - * - * @todo we need to check that the proper named header fields exist - * for each message type. - * - * @todo If a message has unknown type, we should probably eat it - * right here rather than passing it out to applications. However - * it's not an error to see messages of unknown type. - * - * @param loader the loader. - * @returns #TRUE if we had enough memory to finish. - */ -dbus_bool_t -_dbus_message_loader_queue_messages (DBusMessageLoader *loader) -{ - while (!loader->corrupted && _dbus_string_get_length (&loader->data) >= 16) - { - const char *header_data; - int byte_order, message_type, header_len, body_len; - dbus_uint32_t header_len_unsigned, body_len_unsigned; - - header_data = _dbus_string_get_const_data_len (&loader->data, 0, 16); - - _dbus_assert (_DBUS_ALIGN_ADDRESS (header_data, 4) == header_data); - - if (header_data[VERSION_OFFSET] != DBUS_MAJOR_PROTOCOL_VERSION) - { - _dbus_verbose ("Message has protocol version %d ours is %d\n", - (int) header_data[VERSION_OFFSET], DBUS_MAJOR_PROTOCOL_VERSION); - loader->corrupted = TRUE; - return TRUE; - } - - byte_order = header_data[BYTE_ORDER_OFFSET]; - - if (byte_order != DBUS_LITTLE_ENDIAN && - byte_order != DBUS_BIG_ENDIAN) - { - _dbus_verbose ("Message with bad byte order '%c' received\n", - byte_order); - loader->corrupted = TRUE; - return TRUE; - } - - /* Unknown types are ignored, but INVALID is - * disallowed - */ - message_type = header_data[TYPE_OFFSET]; - if (message_type == DBUS_MESSAGE_TYPE_INVALID) - { - _dbus_verbose ("Message with bad type '%d' received\n", - message_type); - loader->corrupted = TRUE; - return TRUE; - } - - header_len_unsigned = _dbus_unpack_uint32 (byte_order, header_data + 4); - body_len_unsigned = _dbus_unpack_uint32 (byte_order, header_data + 8); - - if (header_len_unsigned < 16) - { - _dbus_verbose ("Message had broken too-small header length %u\n", - header_len_unsigned); - loader->corrupted = TRUE; - return TRUE; - } - - if (header_len_unsigned > (unsigned) MAX_SANE_MESSAGE_SIZE || - body_len_unsigned > (unsigned) MAX_SANE_MESSAGE_SIZE) - { - _dbus_verbose ("Header or body length too large (%u %u)\n", - header_len_unsigned, - body_len_unsigned); loader->corrupted = TRUE; - return TRUE; - } - - /* Now that we know the values are in signed range, get - * rid of stupid unsigned, just causes bugs - */ - header_len = header_len_unsigned; - body_len = body_len_unsigned; - - if (_DBUS_ALIGN_VALUE (header_len, 8) != header_len_unsigned) - { - - _dbus_verbose ("header length %d is not aligned to 8 bytes\n", - header_len); - loader->corrupted = TRUE; - return TRUE; - } - - if (header_len + body_len > loader->max_message_size) - { - _dbus_verbose ("Message claimed length header = %d body = %d exceeds max message length %ld\n", - header_len, body_len, loader->max_message_size); - loader->corrupted = TRUE; - return TRUE; - } - - if (_dbus_string_get_length (&loader->data) >= (header_len + body_len)) - { - if (!load_one_message (loader, byte_order, message_type, - header_len, body_len)) - return FALSE; - } - else - return TRUE; - } - - return TRUE; -} - -/** - * Peeks at first loaded message, returns #NULL if no messages have - * been queued. - * - * @param loader the loader. - * @returns the next message, or #NULL if none. - */ -DBusMessage* -_dbus_message_loader_peek_message (DBusMessageLoader *loader) -{ - if (loader->messages) - return loader->messages->data; - else - return NULL; -} - -/** - * Pops a loaded message (passing ownership of the message - * to the caller). Returns #NULL if no messages have been - * queued. - * - * @param loader the loader. - * @returns the next message, or #NULL if none. - */ -DBusMessage* -_dbus_message_loader_pop_message (DBusMessageLoader *loader) -{ - return _dbus_list_pop_first (&loader->messages); -} - -/** - * Pops a loaded message inside a list link (passing ownership of the - * message and link to the caller). Returns #NULL if no messages have - * been loaded. - * - * @param loader the loader. - * @returns the next message link, or #NULL if none. - */ -DBusList* -_dbus_message_loader_pop_message_link (DBusMessageLoader *loader) -{ - return _dbus_list_pop_first_link (&loader->messages); -} - -/** - * Returns a popped message link, used to undo a pop. - * - * @param loader the loader - * @param link the link with a message in it - */ -void -_dbus_message_loader_putback_message_link (DBusMessageLoader *loader, - DBusList *link) -{ - _dbus_list_prepend_link (&loader->messages, link); -} - -/** - * Checks whether the loader is confused due to bad data. - * If messages are received that are invalid, the - * loader gets confused and gives up permanently. - * This state is called "corrupted." - * - * @param loader the loader - * @returns #TRUE if the loader is hosed. - */ -dbus_bool_t -_dbus_message_loader_get_is_corrupted (DBusMessageLoader *loader) -{ - return loader->corrupted; -} - -/** - * Sets the maximum size message we allow. - * - * @param loader the loader - * @param size the max message size in bytes - */ -void -_dbus_message_loader_set_max_message_size (DBusMessageLoader *loader, - long size) -{ - if (size > MAX_SANE_MESSAGE_SIZE) - { - _dbus_verbose ("clamping requested max message size %ld to %d\n", - size, MAX_SANE_MESSAGE_SIZE); - size = MAX_SANE_MESSAGE_SIZE; - } - loader->max_message_size = size; -} - -/** - * Gets the maximum allowed message size in bytes. - * - * @param loader the loader - * @returns max size in bytes - */ -long -_dbus_message_loader_get_max_message_size (DBusMessageLoader *loader) -{ - return loader->max_message_size; -} - -static DBusDataSlotAllocator slot_allocator; -_DBUS_DEFINE_GLOBAL_LOCK (message_slots); - -/** - * Allocates an integer ID to be used for storing application-specific - * data on any DBusMessage. The allocated ID may then be used - * with dbus_message_set_data() and dbus_message_get_data(). - * The passed-in slot must be initialized to -1, and is filled in - * with the slot ID. If the passed-in slot is not -1, it's assumed - * to be already allocated, and its refcount is incremented. - * - * The allocated slot is global, i.e. all DBusMessage objects will - * have a slot with the given integer ID reserved. - * - * @param slot_p address of a global variable storing the slot - * @returns #FALSE on failure (no memory) - */ -dbus_bool_t -dbus_message_allocate_data_slot (dbus_int32_t *slot_p) -{ - return _dbus_data_slot_allocator_alloc (&slot_allocator, - _DBUS_LOCK_NAME (message_slots), - slot_p); -} - -/** - * Deallocates a global ID for message data slots. - * dbus_message_get_data() and dbus_message_set_data() may no - * longer be used with this slot. Existing data stored on existing - * DBusMessage objects will be freed when the message is - * finalized, but may not be retrieved (and may only be replaced if - * someone else reallocates the slot). When the refcount on the - * passed-in slot reaches 0, it is set to -1. - * - * @param slot_p address storing the slot to deallocate - */ -void -dbus_message_free_data_slot (dbus_int32_t *slot_p) -{ - _dbus_return_if_fail (*slot_p >= 0); - - _dbus_data_slot_allocator_free (&slot_allocator, slot_p); -} - -/** - * Stores a pointer on a DBusMessage, along - * with an optional function to be used for freeing - * the data when the data is set again, or when - * the message is finalized. The slot number - * must have been allocated with dbus_message_allocate_data_slot(). - * - * @param message the message - * @param slot the slot number - * @param data the data to store - * @param free_data_func finalizer function for the data - * @returns #TRUE if there was enough memory to store the data - */ -dbus_bool_t -dbus_message_set_data (DBusMessage *message, - dbus_int32_t slot, - void *data, - DBusFreeFunction free_data_func) -{ - DBusFreeFunction old_free_func; - void *old_data; - dbus_bool_t retval; - - _dbus_return_val_if_fail (message != NULL, FALSE); - _dbus_return_val_if_fail (slot >= 0, FALSE); - - retval = _dbus_data_slot_list_set (&slot_allocator, - &message->slot_list, - slot, data, free_data_func, - &old_free_func, &old_data); - - if (retval) - { - /* Do the actual free outside the message lock */ - if (old_free_func) - (* old_free_func) (old_data); - } - - return retval; -} - -/** - * Retrieves data previously set with dbus_message_set_data(). - * The slot must still be allocated (must not have been freed). - * - * @param message the message - * @param slot the slot to get data from - * @returns the data, or #NULL if not found - */ -void* -dbus_message_get_data (DBusMessage *message, - dbus_int32_t slot) -{ - void *res; - - _dbus_return_val_if_fail (message != NULL, NULL); - - res = _dbus_data_slot_list_get (&slot_allocator, - &message->slot_list, - slot); - - return res; -} - -/** - * Utility function to convert a machine-readable (not translated) - * string into a D-BUS message type. - * - * @code - * "method_call" -> DBUS_MESSAGE_TYPE_METHOD_CALL - * "method_return" -> DBUS_MESSAGE_TYPE_METHOD_RETURN - * "signal" -> DBUS_MESSAGE_TYPE_SIGNAL - * "error" -> DBUS_MESSAGE_TYPE_ERROR - * anything else -> DBUS_MESSAGE_TYPE_INVALID - * @endcode - * - */ -int -dbus_message_type_from_string (const char *type_str) -{ - if (strcmp (type_str, "method_call") == 0) - return DBUS_MESSAGE_TYPE_METHOD_CALL; - if (strcmp (type_str, "method_return") == 0) - return DBUS_MESSAGE_TYPE_METHOD_RETURN; - else if (strcmp (type_str, "signal") == 0) - return DBUS_MESSAGE_TYPE_SIGNAL; - else if (strcmp (type_str, "error") == 0) - return DBUS_MESSAGE_TYPE_ERROR; - else - return DBUS_MESSAGE_TYPE_INVALID; -} - -/** @} */ -#ifdef DBUS_BUILD_TESTS -#include "dbus-test.h" -#include -#include - -static void -message_iter_test (DBusMessage *message) -{ - DBusMessageIter iter, dict, dict2, array, array2; - char *str; - unsigned char *data; - dbus_int32_t *our_int_array; - int len; - - dbus_message_iter_init (message, &iter); - - /* String tests */ - if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_STRING) - _dbus_assert_not_reached ("Argument type isn't string"); - - str = dbus_message_iter_get_string (&iter); - if (strcmp (str, "Test string") != 0) - _dbus_assert_not_reached ("Strings differ"); - dbus_free (str); - - if (!dbus_message_iter_next (&iter)) - _dbus_assert_not_reached ("Reached end of arguments"); - - /* Signed integer tests */ - if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_INT32) - _dbus_assert_not_reached ("Argument type isn't int32"); - - if (dbus_message_iter_get_int32 (&iter) != -0x12345678) - _dbus_assert_not_reached ("Signed integers differ"); - - if (!dbus_message_iter_next (&iter)) - _dbus_assert_not_reached ("Reached end of fields"); - - /* Unsigned integer tests */ - if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_UINT32) - _dbus_assert_not_reached ("Argument type isn't int32"); - - if (dbus_message_iter_get_uint32 (&iter) != 0xedd1e) - _dbus_assert_not_reached ("Unsigned integers differ"); - - if (!dbus_message_iter_next (&iter)) - _dbus_assert_not_reached ("Reached end of arguments"); - - /* Double tests */ - if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_DOUBLE) - _dbus_assert_not_reached ("Argument type isn't double"); - - if (dbus_message_iter_get_double (&iter) != 3.14159) - _dbus_assert_not_reached ("Doubles differ"); - - if (!dbus_message_iter_next (&iter)) - _dbus_assert_not_reached ("Reached end of arguments"); - - if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_ARRAY) - _dbus_assert_not_reached ("Argument type not an array"); - - if (dbus_message_iter_get_array_type (&iter) != DBUS_TYPE_DOUBLE) - _dbus_assert_not_reached ("Array type not double"); - - - dbus_message_iter_init_array_iterator (&iter, &array, NULL); - - if (dbus_message_iter_get_arg_type (&array) != DBUS_TYPE_DOUBLE) - _dbus_assert_not_reached ("Argument type isn't double"); - - if (dbus_message_iter_get_double (&array) != 1.5) - _dbus_assert_not_reached ("Unsigned integers differ"); - - if (!dbus_message_iter_next (&array)) - _dbus_assert_not_reached ("Reached end of arguments"); - - if (dbus_message_iter_get_arg_type (&array) != DBUS_TYPE_DOUBLE) - _dbus_assert_not_reached ("Argument type isn't double"); - - if (dbus_message_iter_get_double (&array) != 2.5) - _dbus_assert_not_reached ("Unsigned integers differ"); - - if (dbus_message_iter_next (&array)) - _dbus_assert_not_reached ("Didn't reach end of arguments"); - - if (!dbus_message_iter_next (&iter)) - _dbus_assert_not_reached ("Reached end of arguments"); - - - /* dict */ - - if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_DICT) - _dbus_assert_not_reached ("not dict type"); - - dbus_message_iter_init_dict_iterator (&iter, &dict); - - str = dbus_message_iter_get_dict_key (&dict); - if (str == NULL || strcmp (str, "test") != 0) - _dbus_assert_not_reached ("wrong dict key"); - dbus_free (str); - - if (dbus_message_iter_get_arg_type (&dict) != DBUS_TYPE_UINT32) - _dbus_assert_not_reached ("wrong dict entry type"); - - if (dbus_message_iter_get_uint32 (&dict) != 0xDEADBEEF) - _dbus_assert_not_reached ("wrong dict entry value"); - - /* dict (in dict) */ - - if (!dbus_message_iter_next (&dict)) - _dbus_assert_not_reached ("reached end of dict"); - - if (dbus_message_iter_get_arg_type (&dict) != DBUS_TYPE_DICT) - _dbus_assert_not_reached ("not dict type"); - - dbus_message_iter_init_dict_iterator (&dict, &dict2); - - str = dbus_message_iter_get_dict_key (&dict2); - if (str == NULL || strcmp (str, "dictkey") != 0) - _dbus_assert_not_reached ("wrong dict key"); - dbus_free (str); - - if (dbus_message_iter_get_arg_type (&dict2) != DBUS_TYPE_STRING) - _dbus_assert_not_reached ("wrong dict entry type"); - - str = dbus_message_iter_get_string (&dict2); - if (str == NULL || strcmp (str, "dictvalue") != 0) - _dbus_assert_not_reached ("wrong dict entry value"); - dbus_free (str); - - if (dbus_message_iter_next (&dict2)) - _dbus_assert_not_reached ("didn't reach end of dict"); - - if (!dbus_message_iter_next (&dict)) - _dbus_assert_not_reached ("reached end of dict"); - - /* array of array of int32 (in dict) */ - - str = dbus_message_iter_get_dict_key (&dict); - if (str == NULL || strcmp (str, "array") != 0) - _dbus_assert_not_reached ("wrong dict key"); - dbus_free (str); - - if (dbus_message_iter_get_arg_type (&dict) != DBUS_TYPE_ARRAY) - _dbus_assert_not_reached ("Argument type not an array"); - - if (dbus_message_iter_get_array_type (&dict) != DBUS_TYPE_ARRAY) - _dbus_assert_not_reached ("Array type not array"); - - dbus_message_iter_init_array_iterator (&dict, &array, NULL); - - if (dbus_message_iter_get_arg_type (&array) != DBUS_TYPE_ARRAY) - _dbus_assert_not_reached ("Argument type isn't array"); - - if (dbus_message_iter_get_array_type (&array) != DBUS_TYPE_INT32) - _dbus_assert_not_reached ("Array type not int32"); - - dbus_message_iter_init_array_iterator (&array, &array2, NULL); - - if (dbus_message_iter_get_arg_type (&array2) != DBUS_TYPE_INT32) - _dbus_assert_not_reached ("Argument type isn't int32"); - - if (dbus_message_iter_get_int32 (&array2) != 0x12345678) - _dbus_assert_not_reached ("Signed integers differ"); - - if (!dbus_message_iter_next (&array2)) - _dbus_assert_not_reached ("Reached end of arguments"); - - if (dbus_message_iter_get_int32 (&array2) != 0x23456781) - _dbus_assert_not_reached ("Signed integers differ"); - - if (dbus_message_iter_next (&array2)) - _dbus_assert_not_reached ("Didn't reached end of arguments"); - - if (!dbus_message_iter_next (&array)) - _dbus_assert_not_reached ("Reached end of arguments"); - - if (dbus_message_iter_get_array_type (&array) != DBUS_TYPE_INT32) - _dbus_assert_not_reached ("Array type not int32"); - - if (!dbus_message_iter_get_int32_array (&array, - &our_int_array, - &len)) - _dbus_assert_not_reached ("couldn't get int32 array"); - - _dbus_assert (len == 3); - _dbus_assert (our_int_array[0] == 0x34567812 && - our_int_array[1] == 0x45678123 && - our_int_array[2] == 0x56781234); - dbus_free (our_int_array); - - if (dbus_message_iter_next (&array)) - _dbus_assert_not_reached ("Didn't reach end of array"); - - if (dbus_message_iter_next (&dict)) - _dbus_assert_not_reached ("Didn't reach end of dict"); - - if (!dbus_message_iter_next (&iter)) - _dbus_assert_not_reached ("Reached end of arguments"); - - if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_BYTE) - { - _dbus_warn ("type was: %d\n", dbus_message_iter_get_arg_type (&iter)); - _dbus_assert_not_reached ("wrong type after dict (should be byte)"); - } - - if (dbus_message_iter_get_byte (&iter) != 0xF0) - _dbus_assert_not_reached ("wrong value after dict"); - - - if (!dbus_message_iter_next (&iter)) - _dbus_assert_not_reached ("Reached end of arguments"); - - if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_NIL) - _dbus_assert_not_reached ("not a nil type"); - - if (!dbus_message_iter_next (&iter)) - _dbus_assert_not_reached ("Reached end of arguments"); - - if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_CUSTOM) - _dbus_assert_not_reached ("wrong type after dict"); - - if (!dbus_message_iter_get_custom (&iter, &str, &data, &len)) - _dbus_assert_not_reached ("failed to get custom type"); - - _dbus_assert (strcmp (str, "MyTypeName")==0); - _dbus_assert (len == 5); - _dbus_assert (strcmp (data, "data")==0); - dbus_free (str); - dbus_free (data); - - if (!dbus_message_iter_next (&iter)) - _dbus_assert_not_reached ("Reached end of arguments"); - - if (dbus_message_iter_get_byte (&iter) != 0xF0) - _dbus_assert_not_reached ("wrong value after custom"); - - if (dbus_message_iter_next (&iter)) - _dbus_assert_not_reached ("Didn't reach end of arguments"); -} - - -static dbus_bool_t -check_message_handling_type (DBusMessageIter *iter, - int type) -{ - DBusMessageIter child_iter; - - switch (type) - { - case DBUS_TYPE_NIL: - break; - case DBUS_TYPE_BYTE: - dbus_message_iter_get_byte (iter); - break; - case DBUS_TYPE_BOOLEAN: - dbus_message_iter_get_boolean (iter); - break; - case DBUS_TYPE_INT32: - dbus_message_iter_get_int32 (iter); - break; - case DBUS_TYPE_UINT32: - dbus_message_iter_get_uint32 (iter); - break; - case DBUS_TYPE_INT64: -#ifdef DBUS_HAVE_INT64 - dbus_message_iter_get_int64 (iter); -#endif - break; - case DBUS_TYPE_UINT64: -#ifdef DBUS_HAVE_INT64 - dbus_message_iter_get_uint64 (iter); -#endif - break; - case DBUS_TYPE_DOUBLE: - dbus_message_iter_get_double (iter); - break; - case DBUS_TYPE_STRING: - { - char *str; - str = dbus_message_iter_get_string (iter); - if (str == NULL) - { - _dbus_warn ("NULL string in message\n"); - return FALSE; - } - dbus_free (str); - } - break; - case DBUS_TYPE_CUSTOM: - { - char *name; - unsigned char *data; - int len; - - if (!dbus_message_iter_get_custom (iter, &name, &data, &len)) - { - _dbus_warn ("error reading name from custom type\n"); - return FALSE; - } - dbus_free (data); - dbus_free (name); - } - break; - case DBUS_TYPE_ARRAY: - { - int array_type; - - dbus_message_iter_init_array_iterator (iter, &child_iter, &array_type); - - while (dbus_message_iter_has_next (&child_iter)) - { - if (!check_message_handling_type (&child_iter, array_type)) - { - _dbus_warn ("error in array element\n"); - return FALSE; - } - - if (!dbus_message_iter_next (&child_iter)) - break; - } - } - break; - case DBUS_TYPE_DICT: - { - int entry_type; - char *key; - - dbus_message_iter_init_dict_iterator (iter, &child_iter); - - while ((entry_type = dbus_message_iter_get_arg_type (&child_iter)) != DBUS_TYPE_INVALID) - { - key = dbus_message_iter_get_dict_key (&child_iter); - if (key == NULL) - { - _dbus_warn ("error reading dict key\n"); - return FALSE; - } - dbus_free (key); - - if (!check_message_handling_type (&child_iter, entry_type)) - { - _dbus_warn ("error in dict value\n"); - return FALSE; - } - - if (!dbus_message_iter_next (&child_iter)) - break; - } - } - break; - - default: - _dbus_warn ("unknown type %d\n", type); - return FALSE; - break; - } - return TRUE; -} - - -static dbus_bool_t -check_message_handling (DBusMessage *message) -{ - DBusMessageIter iter; - int type; - dbus_bool_t retval; - dbus_uint32_t client_serial; - - retval = FALSE; - - client_serial = dbus_message_get_serial (message); - - /* can't use set_serial due to the assertions at the start of it */ - _dbus_marshal_set_uint32 (&message->header, - message->byte_order, - CLIENT_SERIAL_OFFSET, - client_serial); - - if (client_serial != dbus_message_get_serial (message)) - { - _dbus_warn ("get/set cycle for client_serial did not succeed\n"); - goto failed; - } - - /* If we implement message_set_arg (message, n, value) - * then we would want to test it here - */ - - dbus_message_iter_init (message, &iter); - while ((type = dbus_message_iter_get_arg_type (&iter)) != DBUS_TYPE_INVALID) - { - if (!check_message_handling_type (&iter, type)) - goto failed; - - if (!dbus_message_iter_next (&iter)) - break; - } - - retval = TRUE; - - failed: - return retval; -} - -static dbus_bool_t -check_have_valid_message (DBusMessageLoader *loader) -{ - DBusMessage *message; - dbus_bool_t retval; - - message = NULL; - retval = FALSE; - - if (!_dbus_message_loader_queue_messages (loader)) - _dbus_assert_not_reached ("no memory to queue messages"); - - if (_dbus_message_loader_get_is_corrupted (loader)) - { - _dbus_warn ("loader corrupted on message that was expected to be valid\n"); - goto failed; - } - - message = _dbus_message_loader_pop_message (loader); - if (message == NULL) - { - _dbus_warn ("didn't load message that was expected to be valid (message not popped)\n"); - goto failed; - } - - if (_dbus_string_get_length (&loader->data) > 0) - { - _dbus_warn ("had leftover bytes from expected-to-be-valid single message\n"); - goto failed; - } - - /* Verify that we're able to properly deal with the message. - * For example, this would detect improper handling of messages - * in nonstandard byte order. - */ - if (!check_message_handling (message)) - goto failed; - - retval = TRUE; - - failed: - if (message) - dbus_message_unref (message); - - return retval; -} - -static dbus_bool_t -check_invalid_message (DBusMessageLoader *loader) -{ - dbus_bool_t retval; - - retval = FALSE; - - if (!_dbus_message_loader_queue_messages (loader)) - _dbus_assert_not_reached ("no memory to queue messages"); - - if (!_dbus_message_loader_get_is_corrupted (loader)) - { - _dbus_warn ("loader not corrupted on message that was expected to be invalid\n"); + loader->corruption_reason = validity; + } goto failed; } - retval = TRUE; + _dbus_assert (validity == DBUS_VALID); - failed: - return retval; -} + message->byte_order = byte_order; -static dbus_bool_t -check_incomplete_message (DBusMessageLoader *loader) -{ - DBusMessage *message; - dbus_bool_t retval; + /* 2. VALIDATE BODY */ + if (mode != DBUS_VALIDATION_MODE_WE_TRUST_THIS_DATA_ABSOLUTELY) + { + get_const_signature (&message->header, &type_str, &type_pos); + + /* Because the bytes_remaining arg is NULL, this validates that the + * body is the right length + */ + validity = _dbus_validate_body_with_reason (type_str, + type_pos, + byte_order, + NULL, + &loader->data, + header_len, + body_len); + if (validity != DBUS_VALID) + { + _dbus_verbose ("Failed to validate message body code %d\n", validity); - message = NULL; - retval = FALSE; + loader->corrupted = TRUE; + loader->corruption_reason = validity; + + goto failed; + } + } - if (!_dbus_message_loader_queue_messages (loader)) - _dbus_assert_not_reached ("no memory to queue messages"); - - if (_dbus_message_loader_get_is_corrupted (loader)) + /* 3. COPY OVER BODY AND QUEUE MESSAGE */ + + if (!_dbus_list_append (&loader->messages, message)) { - _dbus_warn ("loader corrupted on message that was expected to be valid (but incomplete)\n"); + _dbus_verbose ("Failed to append new message to loader queue\n"); + oom = TRUE; goto failed; } - - message = _dbus_message_loader_pop_message (loader); - if (message != NULL) + + _dbus_assert (_dbus_string_get_length (&message->body) == 0); + _dbus_assert (_dbus_string_get_length (&loader->data) >= + (header_len + body_len)); + + if (!_dbus_string_copy_len (&loader->data, header_len, body_len, &message->body, 0)) { - _dbus_warn ("loaded message that was expected to be incomplete\n"); + _dbus_verbose ("Failed to move body into new message\n"); + oom = TRUE; goto failed; } - retval = TRUE; + _dbus_string_delete (&loader->data, 0, header_len + body_len); + + /* don't waste more than 2k of memory */ + _dbus_string_compact (&loader->data, 2048); + + _dbus_assert (_dbus_string_get_length (&message->header.data) == header_len); + _dbus_assert (_dbus_string_get_length (&message->body) == body_len); + + _dbus_verbose ("Loaded message %p\n", message); + + _dbus_assert (!oom); + _dbus_assert (!loader->corrupted); + _dbus_assert (loader->messages != NULL); + _dbus_assert (_dbus_list_find_last (&loader->messages, message) != NULL); + + return TRUE; failed: - if (message) - dbus_message_unref (message); - return retval; -} -static dbus_bool_t -check_loader_results (DBusMessageLoader *loader, - DBusMessageValidity validity) -{ - if (!_dbus_message_loader_queue_messages (loader)) - _dbus_assert_not_reached ("no memory to queue messages"); + /* Clean up */ + + /* does nothing if the message isn't in the list */ + _dbus_list_remove_last (&loader->messages, message); - switch (validity) - { - case _DBUS_MESSAGE_VALID: - return check_have_valid_message (loader); - case _DBUS_MESSAGE_INVALID: - return check_invalid_message (loader); - case _DBUS_MESSAGE_INCOMPLETE: - return check_incomplete_message (loader); - case _DBUS_MESSAGE_UNKNOWN: - return TRUE; - } + if (oom) + _dbus_assert (!loader->corrupted); + else + _dbus_assert (loader->corrupted); + + _dbus_verbose_bytes_of_string (&loader->data, 0, _dbus_string_get_length (&loader->data)); - _dbus_assert_not_reached ("bad DBusMessageValidity"); return FALSE; } - /** - * Loads the message in the given message file. + * Converts buffered data into messages, if we have enough data. If + * we don't have enough data, does nothing. + * + * @todo we need to check that the proper named header fields exist + * for each message type. * - * @param filename filename to load - * @param is_raw if #TRUE load as binary data, if #FALSE as message builder language - * @param data string to load message into - * @returns #TRUE if the message was loaded + * @todo If a message has unknown type, we should probably eat it + * right here rather than passing it out to applications. However + * it's not an error to see messages of unknown type. + * + * @param loader the loader. + * @returns #TRUE if we had enough memory to finish. */ dbus_bool_t -dbus_internal_do_not_use_load_message_file (const DBusString *filename, - dbus_bool_t is_raw, - DBusString *data) +_dbus_message_loader_queue_messages (DBusMessageLoader *loader) { - dbus_bool_t retval; - - retval = FALSE; - - if (is_raw) + while (!loader->corrupted && + _dbus_string_get_length (&loader->data) >= DBUS_MINIMUM_HEADER_SIZE) { - DBusError error; + DBusValidity validity; + int byte_order, fields_array_len, header_len, body_len; - _dbus_verbose ("Loading raw %s\n", _dbus_string_get_const_data (filename)); - dbus_error_init (&error); - if (!_dbus_file_get_contents (data, filename, &error)) + if (_dbus_header_have_message_untrusted (loader->max_message_size, + &validity, + &byte_order, + &fields_array_len, + &header_len, + &body_len, + &loader->data, 0, + _dbus_string_get_length (&loader->data))) { - _dbus_warn ("Could not load message file %s: %s\n", - _dbus_string_get_const_data (filename), - error.message); - dbus_error_free (&error); - goto failed; - } - } - else - { - if (!_dbus_message_data_load (data, filename)) + DBusMessage *message; + + _dbus_assert (validity == DBUS_VALID); + + message = dbus_message_new_empty_header (); + if (message == NULL) + return FALSE; + + if (!load_message (loader, message, + byte_order, fields_array_len, + header_len, body_len)) + { + dbus_message_unref (message); + /* load_message() returns false if corrupted or OOM; if + * corrupted then return TRUE for not OOM + */ + return loader->corrupted; + } + + _dbus_assert (loader->messages != NULL); + _dbus_assert (_dbus_list_find_last (&loader->messages, message) != NULL); + } + else { - _dbus_warn ("Could not load message file %s\n", - _dbus_string_get_const_data (filename)); - goto failed; + _dbus_verbose ("Initial peek at header says we don't have a whole message yet, or data broken with invalid code %d\n", + validity); + if (validity != DBUS_VALID) + { + loader->corrupted = TRUE; + loader->corruption_reason = validity; + } + return TRUE; } } - retval = TRUE; - - failed: - - return retval; + return TRUE; } /** - * Tries loading the message in the given message file - * and verifies that DBusMessageLoader can handle it. + * Peeks at first loaded message, returns #NULL if no messages have + * been queued. * - * @param filename filename to load - * @param is_raw if #TRUE load as binary data, if #FALSE as message builder language - * @param expected_validity what the message has to be like to return #TRUE - * @returns #TRUE if the message has the expected validity + * @param loader the loader. + * @returns the next message, or #NULL if none. */ -dbus_bool_t -dbus_internal_do_not_use_try_message_file (const DBusString *filename, - dbus_bool_t is_raw, - DBusMessageValidity expected_validity) +DBusMessage* +_dbus_message_loader_peek_message (DBusMessageLoader *loader) { - DBusString data; - dbus_bool_t retval; - - retval = FALSE; - - if (!_dbus_string_init (&data)) - _dbus_assert_not_reached ("could not allocate string\n"); - - if (!dbus_internal_do_not_use_load_message_file (filename, is_raw, - &data)) - goto failed; - - retval = dbus_internal_do_not_use_try_message_data (&data, expected_validity); - - failed: + if (loader->messages) + return loader->messages->data; + else + return NULL; +} - if (!retval) - { - if (_dbus_string_get_length (&data) > 0) - _dbus_verbose_bytes_of_string (&data, 0, - _dbus_string_get_length (&data)); - - _dbus_warn ("Failed message loader test on %s\n", - _dbus_string_get_const_data (filename)); - } - - _dbus_string_free (&data); +/** + * Pops a loaded message (passing ownership of the message + * to the caller). Returns #NULL if no messages have been + * queued. + * + * @param loader the loader. + * @returns the next message, or #NULL if none. + */ +DBusMessage* +_dbus_message_loader_pop_message (DBusMessageLoader *loader) +{ + return _dbus_list_pop_first (&loader->messages); +} - return retval; +/** + * Pops a loaded message inside a list link (passing ownership of the + * message and link to the caller). Returns #NULL if no messages have + * been loaded. + * + * @param loader the loader. + * @returns the next message link, or #NULL if none. + */ +DBusList* +_dbus_message_loader_pop_message_link (DBusMessageLoader *loader) +{ + return _dbus_list_pop_first_link (&loader->messages); } /** - * Tries loading the given message data. + * Returns a popped message link, used to undo a pop. * + * @param loader the loader + * @param link the link with a message in it + */ +void +_dbus_message_loader_putback_message_link (DBusMessageLoader *loader, + DBusList *link) +{ + _dbus_list_prepend_link (&loader->messages, link); +} + +/** + * Checks whether the loader is confused due to bad data. + * If messages are received that are invalid, the + * loader gets confused and gives up permanently. + * This state is called "corrupted." * - * @param data the message data - * @param expected_validity what the message has to be like to return #TRUE - * @returns #TRUE if the message has the expected validity + * @param loader the loader + * @returns #TRUE if the loader is hosed. */ dbus_bool_t -dbus_internal_do_not_use_try_message_data (const DBusString *data, - DBusMessageValidity expected_validity) +_dbus_message_loader_get_is_corrupted (DBusMessageLoader *loader) { - DBusMessageLoader *loader; - dbus_bool_t retval; - int len; - int i; + _dbus_assert ((loader->corrupted && loader->corruption_reason != DBUS_VALID) || + (!loader->corrupted && loader->corruption_reason == DBUS_VALID)); + return loader->corrupted; +} - loader = NULL; - retval = FALSE; +/** + * Checks what kind of bad data confused the loader. + * + * @param loader the loader + * @returns why the loader is hosed, or DBUS_VALID if it isn't. + */ +DBusValidity +_dbus_message_loader_get_corruption_reason (DBusMessageLoader *loader) +{ + _dbus_assert ((loader->corrupted && loader->corruption_reason != DBUS_VALID) || + (!loader->corrupted && loader->corruption_reason == DBUS_VALID)); - /* Write the data one byte at a time */ - - loader = _dbus_message_loader_new (); + return loader->corruption_reason; +} - /* check some trivial loader functions */ - _dbus_message_loader_ref (loader); - _dbus_message_loader_unref (loader); - _dbus_message_loader_get_max_message_size (loader); - - len = _dbus_string_get_length (data); - for (i = 0; i < len; i++) +/** + * Sets the maximum size message we allow. + * + * @param loader the loader + * @param size the max message size in bytes + */ +void +_dbus_message_loader_set_max_message_size (DBusMessageLoader *loader, + long size) +{ + if (size > DBUS_MAXIMUM_MESSAGE_LENGTH) { - DBusString *buffer; - - _dbus_message_loader_get_buffer (loader, &buffer); - _dbus_string_append_byte (buffer, - _dbus_string_get_byte (data, i)); - _dbus_message_loader_return_buffer (loader, buffer, 1); + _dbus_verbose ("clamping requested max message size %ld to %d\n", + size, DBUS_MAXIMUM_MESSAGE_LENGTH); + size = DBUS_MAXIMUM_MESSAGE_LENGTH; } - - if (!check_loader_results (loader, expected_validity)) - goto failed; - - _dbus_message_loader_unref (loader); - loader = NULL; - - /* Write the data all at once */ - - loader = _dbus_message_loader_new (); + loader->max_message_size = size; +} - { - DBusString *buffer; - - _dbus_message_loader_get_buffer (loader, &buffer); - _dbus_string_copy (data, 0, buffer, - _dbus_string_get_length (buffer)); - _dbus_message_loader_return_buffer (loader, buffer, 1); - } - - if (!check_loader_results (loader, expected_validity)) - goto failed; +/** + * Gets the maximum allowed message size in bytes. + * + * @param loader the loader + * @returns max size in bytes + */ +long +_dbus_message_loader_get_max_message_size (DBusMessageLoader *loader) +{ + return loader->max_message_size; +} - _dbus_message_loader_unref (loader); - loader = NULL; +static DBusDataSlotAllocator slot_allocator; +_DBUS_DEFINE_GLOBAL_LOCK (message_slots); - /* Write the data 2 bytes at a time */ - - loader = _dbus_message_loader_new (); +/** + * Allocates an integer ID to be used for storing application-specific + * data on any DBusMessage. The allocated ID may then be used + * with dbus_message_set_data() and dbus_message_get_data(). + * The passed-in slot must be initialized to -1, and is filled in + * with the slot ID. If the passed-in slot is not -1, it's assumed + * to be already allocated, and its refcount is incremented. + * + * The allocated slot is global, i.e. all DBusMessage objects will + * have a slot with the given integer ID reserved. + * + * @param slot_p address of a global variable storing the slot + * @returns #FALSE on failure (no memory) + */ +dbus_bool_t +dbus_message_allocate_data_slot (dbus_int32_t *slot_p) +{ + return _dbus_data_slot_allocator_alloc (&slot_allocator, + &_DBUS_LOCK_NAME (message_slots), + slot_p); +} - len = _dbus_string_get_length (data); - for (i = 0; i < len; i += 2) - { - DBusString *buffer; - - _dbus_message_loader_get_buffer (loader, &buffer); - _dbus_string_append_byte (buffer, - _dbus_string_get_byte (data, i)); - if ((i+1) < len) - _dbus_string_append_byte (buffer, - _dbus_string_get_byte (data, i+1)); - _dbus_message_loader_return_buffer (loader, buffer, 1); - } - - if (!check_loader_results (loader, expected_validity)) - goto failed; +/** + * Deallocates a global ID for message data slots. + * dbus_message_get_data() and dbus_message_set_data() may no + * longer be used with this slot. Existing data stored on existing + * DBusMessage objects will be freed when the message is + * finalized, but may not be retrieved (and may only be replaced if + * someone else reallocates the slot). When the refcount on the + * passed-in slot reaches 0, it is set to -1. + * + * @param slot_p address storing the slot to deallocate + */ +void +dbus_message_free_data_slot (dbus_int32_t *slot_p) +{ + _dbus_return_if_fail (*slot_p >= 0); - _dbus_message_loader_unref (loader); - loader = NULL; - - retval = TRUE; - - failed: - - if (loader) - _dbus_message_loader_unref (loader); - - return retval; + _dbus_data_slot_allocator_free (&slot_allocator, slot_p); } -static dbus_bool_t -process_test_subdir (const DBusString *test_base_dir, - const char *subdir, - DBusMessageValidity validity, - DBusForeachMessageFileFunc function, - void *user_data) +/** + * Stores a pointer on a DBusMessage, along + * with an optional function to be used for freeing + * the data when the data is set again, or when + * the message is finalized. The slot number + * must have been allocated with dbus_message_allocate_data_slot(). + * + * @param message the message + * @param slot the slot number + * @param data the data to store + * @param free_data_func finalizer function for the data + * @returns #TRUE if there was enough memory to store the data + */ +dbus_bool_t +dbus_message_set_data (DBusMessage *message, + dbus_int32_t slot, + void *data, + DBusFreeFunction free_data_func) { - DBusString test_directory; - DBusString filename; - DBusDirIter *dir; + DBusFreeFunction old_free_func; + void *old_data; dbus_bool_t retval; - DBusError error; - - retval = FALSE; - dir = NULL; - - if (!_dbus_string_init (&test_directory)) - _dbus_assert_not_reached ("didn't allocate test_directory\n"); - - _dbus_string_init_const (&filename, subdir); - - if (!_dbus_string_copy (test_base_dir, 0, - &test_directory, 0)) - _dbus_assert_not_reached ("couldn't copy test_base_dir to test_directory"); - - if (!_dbus_concat_dir_and_file (&test_directory, &filename)) - _dbus_assert_not_reached ("couldn't allocate full path"); - - _dbus_string_free (&filename); - if (!_dbus_string_init (&filename)) - _dbus_assert_not_reached ("didn't allocate filename string\n"); - - dbus_error_init (&error); - dir = _dbus_directory_open (&test_directory, &error); - if (dir == NULL) - { - _dbus_warn ("Could not open %s: %s\n", - _dbus_string_get_const_data (&test_directory), - error.message); - dbus_error_free (&error); - goto failed; - } - - printf ("Testing %s:\n", subdir); - - next: - while (_dbus_directory_get_next_file (dir, &filename, &error)) - { - DBusString full_path; - dbus_bool_t is_raw; - - if (!_dbus_string_init (&full_path)) - _dbus_assert_not_reached ("couldn't init string"); - - if (!_dbus_string_copy (&test_directory, 0, &full_path, 0)) - _dbus_assert_not_reached ("couldn't copy dir to full_path"); - if (!_dbus_concat_dir_and_file (&full_path, &filename)) - _dbus_assert_not_reached ("couldn't concat file to dir"); - - if (_dbus_string_ends_with_c_str (&filename, ".message")) - is_raw = FALSE; - else if (_dbus_string_ends_with_c_str (&filename, ".message-raw")) - is_raw = TRUE; - else - { - _dbus_verbose ("Skipping non-.message file %s\n", - _dbus_string_get_const_data (&filename)); - _dbus_string_free (&full_path); - goto next; - } + _dbus_return_val_if_fail (message != NULL, FALSE); + _dbus_return_val_if_fail (slot >= 0, FALSE); - printf (" %s\n", - _dbus_string_get_const_data (&filename)); - - _dbus_verbose (" expecting %s for %s\n", - validity == _DBUS_MESSAGE_VALID ? "valid" : - (validity == _DBUS_MESSAGE_INVALID ? "invalid" : - (validity == _DBUS_MESSAGE_INCOMPLETE ? "incomplete" : "unknown")), - _dbus_string_get_const_data (&filename)); - - if (! (*function) (&full_path, is_raw, validity, user_data)) - { - _dbus_string_free (&full_path); - goto failed; - } - else - _dbus_string_free (&full_path); - } + retval = _dbus_data_slot_list_set (&slot_allocator, + &message->slot_list, + slot, data, free_data_func, + &old_free_func, &old_data); - if (dbus_error_is_set (&error)) + if (retval) { - _dbus_warn ("Could not get next file in %s: %s\n", - _dbus_string_get_const_data (&test_directory), - error.message); - dbus_error_free (&error); - goto failed; + /* Do the actual free outside the message lock */ + if (old_free_func) + (* old_free_func) (old_data); } - - retval = TRUE; - - failed: - - if (dir) - _dbus_directory_close (dir); - _dbus_string_free (&test_directory); - _dbus_string_free (&filename); return retval; } - + /** - * Runs the given function on every message file in the test suite. - * The function should return #FALSE on test failure or fatal error. + * Retrieves data previously set with dbus_message_set_data(). + * The slot must still be allocated (must not have been freed). * - * @param test_data_dir root dir of the test suite data files (top_srcdir/test/data) - * @param func the function to run - * @param user_data data for function - * @returns #FALSE if there's a failure + * @param message the message + * @param slot the slot to get data from + * @returns the data, or #NULL if not found */ -dbus_bool_t -dbus_internal_do_not_use_foreach_message_file (const char *test_data_dir, - DBusForeachMessageFileFunc func, - void *user_data) +void* +dbus_message_get_data (DBusMessage *message, + dbus_int32_t slot) { - DBusString test_directory; - dbus_bool_t retval; - - retval = FALSE; - - _dbus_string_init_const (&test_directory, test_data_dir); - - if (!process_test_subdir (&test_directory, "valid-messages", - _DBUS_MESSAGE_VALID, func, user_data)) - goto failed; + void *res; - if (!process_test_subdir (&test_directory, "invalid-messages", - _DBUS_MESSAGE_INVALID, func, user_data)) - goto failed; - - if (!process_test_subdir (&test_directory, "incomplete-messages", - _DBUS_MESSAGE_INCOMPLETE, func, user_data)) - goto failed; + _dbus_return_val_if_fail (message != NULL, NULL); - retval = TRUE; - - failed: + res = _dbus_data_slot_list_get (&slot_allocator, + &message->slot_list, + slot); - _dbus_string_free (&test_directory); - - return retval; + return res; } -static void -verify_test_message (DBusMessage *message) +/** + * Utility function to convert a machine-readable (not translated) + * string into a D-Bus message type. + * + * @code + * "method_call" -> DBUS_MESSAGE_TYPE_METHOD_CALL + * "method_return" -> DBUS_MESSAGE_TYPE_METHOD_RETURN + * "signal" -> DBUS_MESSAGE_TYPE_SIGNAL + * "error" -> DBUS_MESSAGE_TYPE_ERROR + * anything else -> DBUS_MESSAGE_TYPE_INVALID + * @endcode + * + */ +int +dbus_message_type_from_string (const char *type_str) { - DBusMessageIter iter, dict; - DBusError error; - dbus_int32_t our_int; - char *our_str; - double our_double; - dbus_bool_t our_bool; - dbus_uint32_t our_uint32; - dbus_int32_t *our_uint32_array; - int our_uint32_array_len; - dbus_int32_t *our_int32_array; - int our_int32_array_len; - char **our_string_array; - int our_string_array_len; -#ifdef DBUS_HAVE_INT64 - dbus_int64_t our_int64; - dbus_uint64_t our_uint64; - dbus_int64_t *our_uint64_array; - int our_uint64_array_len; - dbus_int64_t *our_int64_array; - int our_int64_array_len; -#endif - double *our_double_array; - int our_double_array_len; - unsigned char *our_byte_array; - int our_byte_array_len; - unsigned char *our_boolean_array; - int our_boolean_array_len; - - dbus_message_iter_init (message, &iter); + if (strcmp (type_str, "method_call") == 0) + return DBUS_MESSAGE_TYPE_METHOD_CALL; + if (strcmp (type_str, "method_return") == 0) + return DBUS_MESSAGE_TYPE_METHOD_RETURN; + else if (strcmp (type_str, "signal") == 0) + return DBUS_MESSAGE_TYPE_SIGNAL; + else if (strcmp (type_str, "error") == 0) + return DBUS_MESSAGE_TYPE_ERROR; + else + return DBUS_MESSAGE_TYPE_INVALID; +} - dbus_error_init (&error); - if (!dbus_message_iter_get_args (&iter, &error, - DBUS_TYPE_INT32, &our_int, -#ifdef DBUS_HAVE_INT64 - DBUS_TYPE_INT64, &our_int64, - DBUS_TYPE_UINT64, &our_uint64, -#endif - DBUS_TYPE_STRING, &our_str, - DBUS_TYPE_DOUBLE, &our_double, - DBUS_TYPE_BOOLEAN, &our_bool, - DBUS_TYPE_ARRAY, DBUS_TYPE_UINT32, - &our_uint32_array, &our_uint32_array_len, - DBUS_TYPE_ARRAY, DBUS_TYPE_INT32, - &our_int32_array, &our_int32_array_len, -#ifdef DBUS_HAVE_INT64 - DBUS_TYPE_ARRAY, DBUS_TYPE_UINT64, - &our_uint64_array, &our_uint64_array_len, - DBUS_TYPE_ARRAY, DBUS_TYPE_INT64, - &our_int64_array, &our_int64_array_len, -#endif - DBUS_TYPE_ARRAY, DBUS_TYPE_STRING, - &our_string_array, &our_string_array_len, - DBUS_TYPE_ARRAY, DBUS_TYPE_DOUBLE, - &our_double_array, &our_double_array_len, - DBUS_TYPE_ARRAY, DBUS_TYPE_BYTE, - &our_byte_array, &our_byte_array_len, - DBUS_TYPE_ARRAY, DBUS_TYPE_BOOLEAN, - &our_boolean_array, &our_boolean_array_len, - 0)) +/** + * Utility function to convert a D-Bus message type into a + * machine-readable string (not translated). + * + * @code + * DBUS_MESSAGE_TYPE_METHOD_CALL -> "method_call" + * DBUS_MESSAGE_TYPE_METHOD_RETURN -> "method_return" + * DBUS_MESSAGE_TYPE_SIGNAL -> "signal" + * DBUS_MESSAGE_TYPE_ERROR -> "error" + * DBUS_MESSAGE_TYPE_INVALID -> "invalid" + * @endcode + * + */ +const char * +dbus_message_type_to_string (int type) +{ + switch (type) { - _dbus_warn ("error: %s - %s\n", error.name, - (error.message != NULL) ? error.message : "no message"); - _dbus_assert_not_reached ("Could not get arguments"); + case DBUS_MESSAGE_TYPE_METHOD_CALL: + return "method_call"; + case DBUS_MESSAGE_TYPE_METHOD_RETURN: + return "method_return"; + case DBUS_MESSAGE_TYPE_SIGNAL: + return "signal"; + case DBUS_MESSAGE_TYPE_ERROR: + return "error"; + default: + return "invalid"; } +} - if (our_int != -0x12345678) - _dbus_assert_not_reached ("integers differ!"); +/** + * Turn a DBusMessage into the marshalled form as described in the D-Bus + * specification. + * + * Generally, this function is only useful for encapsulating D-Bus messages in + * a different protocol. + * + * @param msg the DBusMessage + * @param marshalled_data_p the location to save the marshalled form to + * @param len_p the location to save the length of the marshalled form to + * @returns #FALSE if there was not enough memory + */ +dbus_bool_t +dbus_message_marshal (DBusMessage *msg, + char **marshalled_data_p, + int *len_p) +{ + DBusString tmp; + dbus_bool_t was_locked; -#ifdef DBUS_HAVE_INT64 - if (our_int64 != DBUS_INT64_CONSTANT (-0x123456789abcd)) - _dbus_assert_not_reached ("64-bit integers differ!"); - if (our_uint64 != DBUS_UINT64_CONSTANT (0x123456789abcd)) - _dbus_assert_not_reached ("64-bit unsigned integers differ!"); -#endif + _dbus_return_val_if_fail (msg != NULL, FALSE); + _dbus_return_val_if_fail (marshalled_data_p != NULL, FALSE); + _dbus_return_val_if_fail (len_p != NULL, FALSE); - if (our_double != 3.14159) - _dbus_assert_not_reached ("doubles differ!"); - - if (strcmp (our_str, "Test string") != 0) - _dbus_assert_not_reached ("strings differ!"); - dbus_free (our_str); - - if (!our_bool) - _dbus_assert_not_reached ("booleans differ"); - - if (our_uint32_array_len != 4 || - our_uint32_array[0] != 0x12345678 || - our_uint32_array[1] != 0x23456781 || - our_uint32_array[2] != 0x34567812 || - our_uint32_array[3] != 0x45678123) - _dbus_assert_not_reached ("uint array differs"); - dbus_free (our_uint32_array); - - if (our_int32_array_len != 4 || - our_int32_array[0] != 0x12345678 || - our_int32_array[1] != -0x23456781 || - our_int32_array[2] != 0x34567812 || - our_int32_array[3] != -0x45678123) - _dbus_assert_not_reached ("int array differs"); - dbus_free (our_int32_array); - -#ifdef DBUS_HAVE_INT64 - if (our_uint64_array_len != 4 || - our_uint64_array[0] != 0x12345678 || - our_uint64_array[1] != 0x23456781 || - our_uint64_array[2] != 0x34567812 || - our_uint64_array[3] != 0x45678123) - _dbus_assert_not_reached ("uint64 array differs"); - dbus_free (our_uint64_array); - - if (our_int64_array_len != 4 || - our_int64_array[0] != 0x12345678 || - our_int64_array[1] != -0x23456781 || - our_int64_array[2] != 0x34567812 || - our_int64_array[3] != -0x45678123) - _dbus_assert_not_reached ("int64 array differs"); - dbus_free (our_int64_array); -#endif /* DBUS_HAVE_INT64 */ - - if (our_string_array_len != 4) - _dbus_assert_not_reached ("string array has wrong length"); - - if (strcmp (our_string_array[0], "Foo") != 0 || - strcmp (our_string_array[1], "bar") != 0 || - strcmp (our_string_array[2], "") != 0 || - strcmp (our_string_array[3], "woo woo woo woo") != 0) - _dbus_assert_not_reached ("string array differs"); - - dbus_free_string_array (our_string_array); - - if (our_double_array_len != 3) - _dbus_assert_not_reached ("double array had wrong length"); - - /* On all IEEE machines (i.e. everything sane) exact equality - * should be preserved over the wire - */ - if (our_double_array[0] != 0.1234 || - our_double_array[1] != 9876.54321 || - our_double_array[2] != -300.0) - _dbus_assert_not_reached ("double array had wrong values"); + if (!_dbus_string_init (&tmp)) + return FALSE; - dbus_free (our_double_array); + /* Ensure the message is locked, to ensure the length header is filled in. */ + was_locked = msg->locked; - if (our_byte_array_len != 4) - _dbus_assert_not_reached ("byte array had wrong length"); + if (!was_locked) + dbus_message_lock (msg); - if (our_byte_array[0] != 'a' || - our_byte_array[1] != 'b' || - our_byte_array[2] != 'c' || - our_byte_array[3] != 234) - _dbus_assert_not_reached ("byte array had wrong values"); + if (!_dbus_string_copy (&(msg->header.data), 0, &tmp, 0)) + goto fail; - dbus_free (our_byte_array); + *len_p = _dbus_string_get_length (&tmp); - if (our_boolean_array_len != 5) - _dbus_assert_not_reached ("bool array had wrong length"); + if (!_dbus_string_copy (&(msg->body), 0, &tmp, *len_p)) + goto fail; - if (our_boolean_array[0] != TRUE || - our_boolean_array[1] != FALSE || - our_boolean_array[2] != TRUE || - our_boolean_array[3] != TRUE || - our_boolean_array[4] != FALSE) - _dbus_assert_not_reached ("bool array had wrong values"); + *len_p = _dbus_string_get_length (&tmp); - dbus_free (our_boolean_array); - - if (!dbus_message_iter_next (&iter)) - _dbus_assert_not_reached ("Reached end of arguments"); + if (!_dbus_string_steal_data (&tmp, marshalled_data_p)) + goto fail; - if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_DICT) - _dbus_assert_not_reached ("not dict type"); - - dbus_message_iter_init_dict_iterator (&iter, &dict); + _dbus_string_free (&tmp); - our_str = dbus_message_iter_get_dict_key (&dict); - if (our_str == NULL || strcmp (our_str, "test") != 0) - _dbus_assert_not_reached ("wrong dict key"); - dbus_free (our_str); + if (!was_locked) + msg->locked = FALSE; - if (dbus_message_iter_get_arg_type (&dict) != DBUS_TYPE_UINT32) - { - _dbus_verbose ("dict entry type: %d\n", dbus_message_iter_get_arg_type (&dict)); - _dbus_assert_not_reached ("wrong dict entry type"); - } + return TRUE; - if ((our_uint32 = dbus_message_iter_get_uint32 (&dict)) != 0xDEADBEEF) - { - _dbus_verbose ("dict entry val: %x\n", our_uint32); - _dbus_assert_not_reached ("wrong dict entry value"); - } + fail: + _dbus_string_free (&tmp); - if (dbus_message_iter_next (&dict)) - _dbus_assert_not_reached ("Didn't reach end of dict"); - - if (!dbus_message_iter_next (&iter)) - _dbus_assert_not_reached ("Reached end of arguments"); - - if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_UINT32) - _dbus_assert_not_reached ("wrong type after dict"); - - if (dbus_message_iter_get_uint32 (&iter) != 0xCAFEBABE) - _dbus_assert_not_reached ("wrong value after dict"); + if (!was_locked) + msg->locked = FALSE; - if (dbus_message_iter_next (&iter)) - _dbus_assert_not_reached ("Didn't reach end of arguments"); + return FALSE; } /** - * @ingroup DBusMessageInternals - * Unit test for DBusMessage. + * Demarshal a D-Bus message from the format described in the D-Bus + * specification. + * + * Generally, this function is only useful for encapsulating D-Bus messages in + * a different protocol. * - * @returns #TRUE on success. + * @param str the marshalled DBusMessage + * @param len the length of str + * @param error the location to save errors to + * @returns #NULL if there was an error */ -dbus_bool_t -_dbus_message_test (const char *test_data_dir) +DBusMessage * +dbus_message_demarshal (const char *str, + int len, + DBusError *error) { - DBusMessage *message; DBusMessageLoader *loader; - DBusMessageIter iter, child_iter, child_iter2, child_iter3; - int i; - const char *data; - DBusMessage *copy; - const char *name1; - const char *name2; - const dbus_uint32_t our_uint32_array[] = - { 0x12345678, 0x23456781, 0x34567812, 0x45678123 }; - const dbus_uint32_t our_int32_array[] = - { 0x12345678, -0x23456781, 0x34567812, -0x45678123 }; -#ifdef DBUS_HAVE_INT64 - const dbus_uint64_t our_uint64_array[] = - { 0x12345678, 0x23456781, 0x34567812, 0x45678123 }; - const dbus_uint64_t our_int64_array[] = - { 0x12345678, -0x23456781, 0x34567812, -0x45678123 }; -#endif - const char *our_string_array[] = { "Foo", "bar", "", "woo woo woo woo" }; - const double our_double_array[] = { 0.1234, 9876.54321, -300.0 }; - const unsigned char our_byte_array[] = { 'a', 'b', 'c', 234 }; - const unsigned char our_boolean_array[] = { TRUE, FALSE, TRUE, TRUE, FALSE }; - char sig[64]; - const char *s; - char *t; - DBusError error; - - _dbus_assert (sizeof (DBusMessageRealIter) <= sizeof (DBusMessageIter)); + DBusString *buffer; + DBusMessage *msg; - message = dbus_message_new_method_call ("org.freedesktop.DBus.TestService", - "/org/freedesktop/TestPath", - "Foo.TestInterface", - "TestMethod"); - _dbus_assert (dbus_message_has_destination (message, "org.freedesktop.DBus.TestService")); - _dbus_assert (dbus_message_is_method_call (message, "Foo.TestInterface", - "TestMethod")); - _dbus_assert (strcmp (dbus_message_get_path (message), - "/org/freedesktop/TestPath") == 0); - _dbus_message_set_serial (message, 1234); - /* string length including nul byte not a multiple of 4 */ - if (!dbus_message_set_sender (message, "org.foo.bar1")) - _dbus_assert_not_reached ("out of memory"); - _dbus_assert (dbus_message_has_sender (message, "org.foo.bar1")); - dbus_message_set_reply_serial (message, 5678); - if (!dbus_message_set_sender (message, NULL)) - _dbus_assert_not_reached ("out of memory"); - _dbus_assert (!dbus_message_has_sender (message, "org.foo.bar1")); - _dbus_assert (dbus_message_get_serial (message) == 1234); - _dbus_assert (dbus_message_get_reply_serial (message) == 5678); - _dbus_assert (dbus_message_has_destination (message, "org.freedesktop.DBus.TestService")); - - _dbus_assert (dbus_message_get_no_reply (message) == FALSE); - dbus_message_set_no_reply (message, TRUE); - _dbus_assert (dbus_message_get_no_reply (message) == TRUE); - dbus_message_set_no_reply (message, FALSE); - _dbus_assert (dbus_message_get_no_reply (message) == FALSE); - - /* Set/get some header fields */ - - if (!dbus_message_set_path (message, "/foo")) - _dbus_assert_not_reached ("out of memory"); - _dbus_assert (strcmp (dbus_message_get_path (message), - "/foo") == 0); - - if (!dbus_message_set_interface (message, "org.Foo")) - _dbus_assert_not_reached ("out of memory"); - _dbus_assert (strcmp (dbus_message_get_interface (message), - "org.Foo") == 0); - - if (!dbus_message_set_member (message, "Bar")) - _dbus_assert_not_reached ("out of memory"); - _dbus_assert (strcmp (dbus_message_get_member (message), - "Bar") == 0); - - /* Set/get them with longer values */ - if (!dbus_message_set_path (message, "/foo/bar")) - _dbus_assert_not_reached ("out of memory"); - _dbus_assert (strcmp (dbus_message_get_path (message), - "/foo/bar") == 0); - - if (!dbus_message_set_interface (message, "org.Foo.Bar")) - _dbus_assert_not_reached ("out of memory"); - _dbus_assert (strcmp (dbus_message_get_interface (message), - "org.Foo.Bar") == 0); - - if (!dbus_message_set_member (message, "BarFoo")) - _dbus_assert_not_reached ("out of memory"); - _dbus_assert (strcmp (dbus_message_get_member (message), - "BarFoo") == 0); + _dbus_return_val_if_fail (str != NULL, NULL); - /* Realloc shorter again */ - - if (!dbus_message_set_path (message, "/foo")) - _dbus_assert_not_reached ("out of memory"); - _dbus_assert (strcmp (dbus_message_get_path (message), - "/foo") == 0); - - if (!dbus_message_set_interface (message, "org.Foo")) - _dbus_assert_not_reached ("out of memory"); - _dbus_assert (strcmp (dbus_message_get_interface (message), - "org.Foo") == 0); - - if (!dbus_message_set_member (message, "Bar")) - _dbus_assert_not_reached ("out of memory"); - _dbus_assert (strcmp (dbus_message_get_member (message), - "Bar") == 0); - - dbus_message_unref (message); - - /* Test the vararg functions */ - message = dbus_message_new_method_call ("org.freedesktop.DBus.TestService", - "/org/freedesktop/TestPath", - "Foo.TestInterface", - "TestMethod"); - _dbus_message_set_serial (message, 1); - dbus_message_append_args (message, - DBUS_TYPE_INT32, -0x12345678, -#ifdef DBUS_HAVE_INT64 - DBUS_TYPE_INT64, DBUS_INT64_CONSTANT (-0x123456789abcd), - DBUS_TYPE_UINT64, DBUS_UINT64_CONSTANT (0x123456789abcd), -#endif - DBUS_TYPE_STRING, "Test string", - DBUS_TYPE_DOUBLE, 3.14159, - DBUS_TYPE_BOOLEAN, TRUE, - DBUS_TYPE_ARRAY, DBUS_TYPE_UINT32, our_uint32_array, - _DBUS_N_ELEMENTS (our_uint32_array), - DBUS_TYPE_ARRAY, DBUS_TYPE_INT32, our_int32_array, - _DBUS_N_ELEMENTS (our_int32_array), -#ifdef DBUS_HAVE_INT64 - DBUS_TYPE_ARRAY, DBUS_TYPE_UINT64, our_uint64_array, - _DBUS_N_ELEMENTS (our_uint64_array), - DBUS_TYPE_ARRAY, DBUS_TYPE_INT64, our_int64_array, - _DBUS_N_ELEMENTS (our_int64_array), -#endif - DBUS_TYPE_ARRAY, DBUS_TYPE_STRING, our_string_array, - _DBUS_N_ELEMENTS (our_string_array), - DBUS_TYPE_ARRAY, DBUS_TYPE_DOUBLE, our_double_array, - _DBUS_N_ELEMENTS (our_double_array), - DBUS_TYPE_ARRAY, DBUS_TYPE_BYTE, our_byte_array, - _DBUS_N_ELEMENTS (our_byte_array), - DBUS_TYPE_ARRAY, DBUS_TYPE_BOOLEAN, our_boolean_array, - _DBUS_N_ELEMENTS (our_boolean_array), - 0); - - dbus_message_append_iter_init (message, &iter); - dbus_message_iter_append_dict (&iter, &child_iter); - dbus_message_iter_append_dict_key (&child_iter, "test"); - dbus_message_iter_append_uint32 (&child_iter, 0xDEADBEEF); - dbus_message_iter_append_uint32 (&iter, 0xCAFEBABE); + loader = _dbus_message_loader_new (); - i = 0; - sig[i++] = DBUS_TYPE_INT32; -#ifdef DBUS_HAVE_INT64 - sig[i++] = DBUS_TYPE_INT64; - sig[i++] = DBUS_TYPE_UINT64; -#endif - sig[i++] = DBUS_TYPE_STRING; - sig[i++] = DBUS_TYPE_DOUBLE; - sig[i++] = DBUS_TYPE_BOOLEAN; - sig[i++] = DBUS_TYPE_ARRAY; - sig[i++] = DBUS_TYPE_UINT32; - sig[i++] = DBUS_TYPE_ARRAY; - sig[i++] = DBUS_TYPE_INT32; -#ifdef DBUS_HAVE_INT64 - sig[i++] = DBUS_TYPE_ARRAY; - sig[i++] = DBUS_TYPE_UINT64; - sig[i++] = DBUS_TYPE_ARRAY; - sig[i++] = DBUS_TYPE_INT64; -#endif - sig[i++] = DBUS_TYPE_ARRAY; - sig[i++] = DBUS_TYPE_STRING; - sig[i++] = DBUS_TYPE_ARRAY; - sig[i++] = DBUS_TYPE_DOUBLE; - sig[i++] = DBUS_TYPE_ARRAY; - sig[i++] = DBUS_TYPE_BYTE; - sig[i++] = DBUS_TYPE_ARRAY; - sig[i++] = DBUS_TYPE_BOOLEAN; - sig[i++] = DBUS_TYPE_DICT; - sig[i++] = DBUS_TYPE_UINT32; - sig[i++] = DBUS_TYPE_INVALID; - - _dbus_assert (i < (int) _DBUS_N_ELEMENTS (sig)); - - _dbus_verbose_bytes_of_string (&message->header, 0, - _dbus_string_get_length (&message->header)); - _dbus_verbose_bytes_of_string (&message->body, 0, - _dbus_string_get_length (&message->body)); - - _dbus_verbose ("Signature expected \"%s\" actual \"%s\"\n", - sig, dbus_message_get_signature (message)); - - s = dbus_message_get_signature (message); - - _dbus_assert (dbus_message_has_signature (message, sig)); - _dbus_assert (strcmp (s, sig) == 0); - - verify_test_message (message); + if (loader == NULL) + return NULL; - copy = dbus_message_copy (message); - - _dbus_assert (message->client_serial == copy->client_serial); - _dbus_assert (message->reply_serial == copy->reply_serial); - _dbus_assert (message->header_padding == copy->header_padding); - - _dbus_assert (_dbus_string_get_length (&message->header) == - _dbus_string_get_length (©->header)); + _dbus_message_loader_get_buffer (loader, &buffer); + _dbus_string_append_len (buffer, str, len); + _dbus_message_loader_return_buffer (loader, buffer, len); - _dbus_assert (_dbus_string_get_length (&message->body) == - _dbus_string_get_length (©->body)); + if (!_dbus_message_loader_queue_messages (loader)) + goto fail_oom; - _dbus_assert (_dbus_string_get_length (&message->signature) == - _dbus_string_get_length (©->signature)); - - verify_test_message (copy); + if (_dbus_message_loader_get_is_corrupted (loader)) + goto fail_corrupt; - name1 = dbus_message_get_interface (message); - name2 = dbus_message_get_interface (copy); + msg = _dbus_message_loader_pop_message (loader); - _dbus_assert (strcmp (name1, name2) == 0); + if (!msg) + goto fail_oom; - name1 = dbus_message_get_member (message); - name2 = dbus_message_get_member (copy); + _dbus_message_loader_unref (loader); + return msg; - _dbus_assert (strcmp (name1, name2) == 0); - - dbus_message_unref (message); - dbus_message_unref (copy); - - message = dbus_message_new_method_call ("org.freedesktop.DBus.TestService", - "/org/freedesktop/TestPath", - "Foo.TestInterface", - "TestMethod"); - - _dbus_message_set_serial (message, 1); - dbus_message_set_reply_serial (message, 0x12345678); - - dbus_message_append_iter_init (message, &iter); - dbus_message_iter_append_string (&iter, "Test string"); - dbus_message_iter_append_int32 (&iter, -0x12345678); - dbus_message_iter_append_uint32 (&iter, 0xedd1e); - dbus_message_iter_append_double (&iter, 3.14159); - - dbus_message_iter_append_array (&iter, &child_iter, DBUS_TYPE_DOUBLE); - dbus_message_iter_append_double (&child_iter, 1.5); - dbus_message_iter_append_double (&child_iter, 2.5); - - /* dict */ - dbus_message_iter_append_dict (&iter, &child_iter); - dbus_message_iter_append_dict_key (&child_iter, "test"); - dbus_message_iter_append_uint32 (&child_iter, 0xDEADBEEF); - - /* dict (in dict) */ - dbus_message_iter_append_dict_key (&child_iter, "testdict"); - dbus_message_iter_append_dict (&child_iter, &child_iter2); - - dbus_message_iter_append_dict_key (&child_iter2, "dictkey"); - dbus_message_iter_append_string (&child_iter2, "dictvalue"); - - /* array of array of int32 (in dict) */ - dbus_message_iter_append_dict_key (&child_iter, "array"); - dbus_message_iter_append_array (&child_iter, &child_iter2, DBUS_TYPE_ARRAY); - dbus_message_iter_append_array (&child_iter2, &child_iter3, DBUS_TYPE_INT32); - dbus_message_iter_append_int32 (&child_iter3, 0x12345678); - dbus_message_iter_append_int32 (&child_iter3, 0x23456781); - _dbus_warn ("next call expected to fail with wrong array type\n"); - _dbus_assert (!dbus_message_iter_append_array (&child_iter2, &child_iter3, DBUS_TYPE_UINT32)); - dbus_message_iter_append_array (&child_iter2, &child_iter3, DBUS_TYPE_INT32); - dbus_message_iter_append_int32 (&child_iter3, 0x34567812); - dbus_message_iter_append_int32 (&child_iter3, 0x45678123); - dbus_message_iter_append_int32 (&child_iter3, 0x56781234); - - dbus_message_iter_append_byte (&iter, 0xF0); + fail_corrupt: + dbus_set_error (error, DBUS_ERROR_INVALID_ARGS, "Message is corrupted (%s)", + _dbus_validity_to_error_message (loader->corruption_reason)); + _dbus_message_loader_unref (loader); + return NULL; - dbus_message_iter_append_nil (&iter); + fail_oom: + _DBUS_SET_OOM (error); + _dbus_message_loader_unref (loader); + return NULL; +} - dbus_message_iter_append_custom (&iter, "MyTypeName", - "data", 5); - - dbus_message_iter_append_byte (&iter, 0xF0); +/** + * Returns the number of bytes required to be in the buffer to demarshal a + * D-Bus message. + * + * Generally, this function is only useful for encapsulating D-Bus messages in + * a different protocol. + * + * @param str data to be marshalled + * @param len the length of str + * @param error the location to save errors to + * @returns -1 if there was no valid data to be demarshalled, 0 if there wasn't enough data to determine how much should be demarshalled. Otherwise returns the number of bytes to be demarshalled + * + */ +int +dbus_message_demarshal_bytes_needed(const char *buf, + int len) +{ + DBusString str; + int byte_order, fields_array_len, header_len, body_len; + DBusValidity validity = DBUS_VALID; + int have_message; - message_iter_test (message); - - /* Message loader test */ - _dbus_message_lock (message); - loader = _dbus_message_loader_new (); + if (!buf || len < DBUS_MINIMUM_HEADER_SIZE) + return 0; - /* check ref/unref */ - _dbus_message_loader_ref (loader); - _dbus_message_loader_unref (loader); + if (len > DBUS_MAXIMUM_MESSAGE_LENGTH) + len = DBUS_MAXIMUM_MESSAGE_LENGTH; + _dbus_string_init_const_len (&str, buf, len); - /* Write the header data one byte at a time */ - data = _dbus_string_get_const_data (&message->header); - for (i = 0; i < _dbus_string_get_length (&message->header); i++) - { - DBusString *buffer; - - _dbus_message_loader_get_buffer (loader, &buffer); - _dbus_string_append_byte (buffer, data[i]); - _dbus_message_loader_return_buffer (loader, buffer, 1); - } + validity = DBUS_VALID; + have_message + = _dbus_header_have_message_untrusted(DBUS_MAXIMUM_MESSAGE_LENGTH, + &validity, &byte_order, + &fields_array_len, + &header_len, + &body_len, + &str, 0, + len); + _dbus_string_free (&str); - /* Write the body data one byte at a time */ - data = _dbus_string_get_const_data (&message->body); - for (i = 0; i < _dbus_string_get_length (&message->body); i++) + if (validity == DBUS_VALID) { - DBusString *buffer; - - _dbus_message_loader_get_buffer (loader, &buffer); - _dbus_string_append_byte (buffer, data[i]); - _dbus_message_loader_return_buffer (loader, buffer, 1); + _dbus_assert(have_message); + return header_len + body_len; } - - copy = dbus_message_copy (message); /* save for tests below */ - dbus_message_unref (message); - - /* Now pop back the message */ - if (!_dbus_message_loader_queue_messages (loader)) - _dbus_assert_not_reached ("no memory to queue messages"); - - if (_dbus_message_loader_get_is_corrupted (loader)) - _dbus_assert_not_reached ("message loader corrupted"); - - message = _dbus_message_loader_pop_message (loader); - if (!message) - _dbus_assert_not_reached ("received a NULL message"); - - if (dbus_message_get_reply_serial (message) != 0x12345678) - _dbus_assert_not_reached ("reply serial fields differ"); - - message_iter_test (message); - - dbus_message_unref (message); - _dbus_message_loader_unref (loader); - - message = dbus_message_new_method_return (copy); - if (message == NULL) - _dbus_assert_not_reached ("out of memory\n"); - dbus_message_unref (copy); - - if (!dbus_message_append_args (message, - DBUS_TYPE_STRING, "hello", - DBUS_TYPE_INVALID)) - _dbus_assert_not_reached ("no memory"); - - if (!dbus_message_has_signature (message, "s")) - _dbus_assert_not_reached ("method return has wrong signature"); - - dbus_error_init (&error); - if (!dbus_message_get_args (message, &error, DBUS_TYPE_STRING, - &t, DBUS_TYPE_INVALID)) - + else { - _dbus_warn ("Failed to get expected string arg: %s\n", error.message); - exit (1); + return -1; /* broken! */ } - dbus_free (t); - - dbus_message_unref (message); - - /* Now load every message in test_data_dir if we have one */ - if (test_data_dir == NULL) - return TRUE; - - return dbus_internal_do_not_use_foreach_message_file (test_data_dir, - (DBusForeachMessageFileFunc) - dbus_internal_do_not_use_try_message_file, - NULL); } -#endif /* DBUS_BUILD_TESTS */ +/** @} */ + +/* tests in dbus-message-util.c */