/* -*- mode: C; c-file-style: "gnu" -*- */
/* 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 1.2
- *
+ * 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
* 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
*/
#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-message-private.h"
+#include "dbus-object-tree.h"
#include "dbus-memory.h"
#include "dbus-list.h"
-#include "dbus-message-builder.h"
#include <string.h>
/**
* @{
*/
-enum
-{
- FIELD_HEADER_LENGTH,
- FIELD_BODY_LENGTH,
- FIELD_CLIENT_SERIAL,
- FIELD_NAME,
- FIELD_SERVICE,
- FIELD_SENDER,
- FIELD_REPLY_SERIAL,
+/* Not thread locked, but strictly const/read-only so should be OK
+ */
+/** An static string representing an empty signature */
+_DBUS_STRING_DEFINE_STATIC(_dbus_empty_signature_str, "");
- FIELD_LAST
+/* these have wacky values to help trap uninitialized iterators;
+ * but has to fit in 3 bits
+ */
+enum {
+ DBUS_MESSAGE_ITER_TYPE_READER = 3,
+ DBUS_MESSAGE_ITER_TYPE_WRITER = 7
};
-static dbus_bool_t field_is_named[FIELD_LAST] =
+/** typedef for internals of message iterator */
+typedef struct DBusMessageRealIter DBusMessageRealIter;
+
+/**
+ * @brief Internals of DBusMessageIter
+ *
+ * Object representing a position in a message. All fields are internal.
+ */
+struct DBusMessageRealIter
{
- FALSE, /* FIELD_HEADER_LENGTH */
- FALSE, /* FIELD_BODY_LENGTH */
- FALSE, /* FIELD_CLIENT_SERIAL */
- TRUE, /* FIELD_NAME */
- TRUE, /* FIELD_SERVICE */
- TRUE, /* FIELD_SENDER */
- TRUE /* FIELD_REPLY_SERIAL */
+ DBusMessage *message; /**< Message used */
+ 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 */
};
-typedef struct
+static void
+get_const_signature (DBusHeader *header,
+ const DBusString **type_str_p,
+ int *type_pos_p)
{
- int offset; /**< Offset to start of field (location of name of field
- * for named fields)
- */
-} HeaderField;
+ 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;
+ }
+}
/**
- * @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.
+ * Swaps the message to compiler byte order if required
+ *
+ * @param message the message
*/
-struct DBusMessage
+static void
+_dbus_message_byteswap (DBusMessage *message)
{
- dbus_atomic_t refcount; /**< Reference count */
-
- DBusString header; /**< Header network data, stored
- * separately from body so we can
- * independently realloc it.
- */
-
- HeaderField header_fields[FIELD_LAST]; /**< Track the location
- * of each field in "header"
- */
+ const DBusString *type_str;
+ int type_pos;
+
+ if (message->byte_order == DBUS_COMPILER_BYTE_ORDER)
+ return;
- dbus_int32_t client_serial; /**< Cached client serial value for speed */
- dbus_int32_t reply_serial; /**< Cached reply serial value for speed */
+ _dbus_verbose ("Swapping message into compiler byte order\n");
- int header_padding; /**< bytes of alignment in header */
+ get_const_signature (&message->header, &type_str, &type_pos);
- DBusString body; /**< Body network data. */
+ _dbus_marshal_byteswap (type_str, type_pos,
+ message->byte_order,
+ DBUS_COMPILER_BYTE_ORDER,
+ &message->body, 0);
- char byte_order; /**< Message byte order. */
-
- DBusCounter *size_counter; /**< Counter for the size of the message, or #NULL */
- long size_counter_delta; /**< Size we incremented the size counter by. */
+ message->byte_order = DBUS_COMPILER_BYTE_ORDER;
- unsigned int locked : 1; /**< Message being sent, no modifications allowed. */
-};
-
-/**
- * @brief Internals of DBusMessageIter
- *
- * Object representing a position in a message. All fields are internal.
- */
-struct DBusMessageIter
-{
- int refcount; /**< Reference count */
+ _dbus_header_byteswap (&message->header, DBUS_COMPILER_BYTE_ORDER);
+}
- int pos; /**< Current position in the string */
-
- DBusMessage *message; /**< Message used */
-};
+#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.
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.
+ *
+ * @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_assert (message != NULL);
+ _dbus_assert (!message->locked);
+ _dbus_assert (dbus_message_get_serial (message) == 0);
-static dbus_bool_t
-append_header_padding (DBusMessage *message)
-{
- int old_len;
- old_len = _dbus_string_get_length (&message->header);
- if (!_dbus_string_align_length (&message->header, 8))
- return FALSE;
+ _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)
+{
+ /* 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);
}
-static void
-adjust_field_offsets (DBusMessage *message,
- int offsets_after,
- int 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)
{
- int i;
+ DBusList *link;
- if (delta == 0)
- return;
-
- i = 0;
- while (i < FIELD_LAST)
- {
- if (message->header_fields[i].offset > offsets_after)
- message->header_fields[i].offset += delta;
+ link = _dbus_list_alloc_link (counter);
+ if (link == NULL)
+ return FALSE;
- ++i;
- }
+ _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].offset;
+ link = _dbus_list_find_last (&message->size_counters,
+ counter);
+ _dbus_assert (link != NULL);
- _dbus_assert (field < 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_string_get_const_data (&message->header,
- &data);
-
- return data + (offset + 4);
+ _dbus_counter_adjust (counter, - message->size_counter_delta);
+
+ _dbus_counter_unref (counter);
}
-static dbus_int32_t
-get_int_field (DBusMessage *message,
- int field)
+/**
+ * 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)
{
- int offset;
+ if (!message->locked)
+ {
+ _dbus_header_update_lengths (&message->header,
+ _dbus_string_get_length (&message->body));
- _dbus_assert (field < FIELD_LAST);
-
- offset = message->header_fields[field].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);
+ /* must have a signature if you have a body */
+ _dbus_assert (_dbus_string_get_length (&message->body) == 0 ||
+ dbus_message_get_signature (message) != NULL);
+
+ message->locked = TRUE;
+ }
}
static dbus_bool_t
-append_int_field (DBusMessage *message,
- int field,
- const char *name,
- int value)
+set_or_delete_string_field (DBusMessage *message,
+ int field,
+ int typecode,
+ const char *value)
{
- int orig_len;
+ if (value == NULL)
+ return _dbus_header_delete_field (&message->header, field);
+ else
+ return _dbus_header_set_field_basic (&message->header,
+ field,
+ typecode,
+ &value);
+}
- _dbus_assert (!message->locked);
+#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);
+
+ return set_or_delete_string_field (message,
+ DBUS_HEADER_FIELD_SIGNATURE,
+ DBUS_TYPE_SIGNATURE,
+ signature);
+}
+#endif
- clear_header_padding (message);
-
- orig_len = _dbus_string_get_length (&message->header);
-
- if (!_dbus_string_align_length (&message->header, 4))
- goto failed;
-
- if (!_dbus_string_append_len (&message->header, name, 4))
- goto failed;
+/** @} */
- if (!_dbus_string_append_byte (&message->header, DBUS_TYPE_INT32))
- goto failed;
+/**
+ * @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.
+ *
+ * @{
+ */
- if (!_dbus_string_align_length (&message->header, 4))
- goto failed;
-
- message->header_fields[FIELD_REPLY_SERIAL].offset =
- _dbus_string_get_length (&message->header);
-
- if (!_dbus_marshal_int32 (&message->header, message->byte_order,
- value))
- goto failed;
+/**
+ * @typedef DBusMessage
+ *
+ * Opaque data type representing a message received from or to be
+ * sent to another application.
+ */
- if (!append_header_padding (message))
- goto failed;
-
- return TRUE;
-
- failed:
- message->header_fields[field].offset = -1;
- _dbus_string_set_length (&message->header, orig_len);
+/**
+ * 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.
+ *
+ * @param message the message
+ * @returns the client serial
+ */
+dbus_uint32_t
+dbus_message_get_serial (DBusMessage *message)
+{
+ _dbus_return_val_if_fail (message != NULL, 0);
- /* 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 _dbus_header_get_serial (&message->header);
}
-static dbus_bool_t
-append_string_field (DBusMessage *message,
- int field,
- const char *name,
- const char *value)
+/**
+ * Sets the reply serial of a message (the client serial
+ * of the message this is a reply to).
+ *
+ * @param message the message
+ * @param reply_serial the client serial
+ * @returns #FALSE if not enough memory
+ */
+dbus_bool_t
+dbus_message_set_reply_serial (DBusMessage *message,
+ dbus_uint32_t reply_serial)
{
- int orig_len;
+ _dbus_return_val_if_fail (message != NULL, FALSE);
+ _dbus_return_val_if_fail (!message->locked, FALSE);
- _dbus_assert (!message->locked);
+ return _dbus_header_set_field_basic (&message->header,
+ DBUS_HEADER_FIELD_REPLY_SERIAL,
+ DBUS_TYPE_UINT32,
+ &reply_serial);
+}
- clear_header_padding (message);
-
- orig_len = _dbus_string_get_length (&message->header);
+/**
+ * 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)
+{
+ dbus_uint32_t v_UINT32;
- if (!_dbus_string_align_length (&message->header, 4))
- goto failed;
-
- if (!_dbus_string_append_len (&message->header, name, 4))
- goto failed;
-
- if (!_dbus_string_append_byte (&message->header, DBUS_TYPE_STRING))
- goto failed;
+ _dbus_return_val_if_fail (message != NULL, 0);
- if (!_dbus_string_align_length (&message->header, 4))
- goto failed;
-
- message->header_fields[field].offset =
- _dbus_string_get_length (&message->header);
-
- if (!_dbus_marshal_string (&message->header, message->byte_order,
- value))
- goto failed;
+ if (_dbus_header_get_field_basic (&message->header,
+ DBUS_HEADER_FIELD_REPLY_SERIAL,
+ DBUS_TYPE_UINT32,
+ &v_UINT32))
+ return v_UINT32;
+ else
+ return 0;
+}
- if (!append_header_padding (message))
- goto failed;
-
- return TRUE;
-
- failed:
- message->header_fields[field].offset = -1;
- _dbus_string_set_length (&message->header, orig_len);
+static void
+free_size_counter (void *element,
+ void *data)
+{
+ DBusCounter *counter = element;
+ DBusMessage *message = data;
- /* 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_counter_adjust (counter, - message->size_counter_delta);
+
+ _dbus_counter_unref (counter);
}
static void
-delete_int_field (DBusMessage *message,
- int field)
+dbus_message_finalize (DBusMessage *message)
{
- int offset = message->header_fields[field].offset;
+ _dbus_assert (message->refcount.value == 0);
- _dbus_assert (!message->locked);
- _dbus_assert (field_is_named[field]);
-
- if (offset < 0)
- return;
+ /* This calls application callbacks! */
+ _dbus_data_slot_list_free (&message->slot_list);
- clear_header_padding (message);
-
- /* The field typecode and name take up 8 bytes */
- _dbus_string_delete (&message->header,
- offset - 8,
- 12);
+ _dbus_list_foreach (&message->size_counters,
+ free_size_counter, message);
+ _dbus_list_clear (&message->size_counters);
- message->header_fields[field].offset = -1;
-
- adjust_field_offsets (message,
- offset - 8,
- - 12);
+ _dbus_header_free (&message->header);
+ _dbus_string_free (&message->body);
- append_header_padding (message);
+ dbus_free (message);
}
-static void
-delete_string_field (DBusMessage *message,
- int field)
-{
- int offset = message->header_fields[field].offset;
- int len;
- int delete_len;
-
- _dbus_assert (!message->locked);
- _dbus_assert (field_is_named[field]);
-
- if (offset < 0)
- return;
+/* 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).
+ */
- clear_header_padding (message);
-
- get_string_field (message, field, &len);
-
- /* The field typecode and name take up 8 bytes, and the nul
- * termination is 1 bytes, string length integer is 4 bytes
- */
- delete_len = 8 + 4 + 1 + len;
-
- _dbus_string_delete (&message->header,
- offset - 8,
- delete_len);
+/** Avoid caching huge messages */
+#define MAX_MESSAGE_SIZE_TO_CACHE _DBUS_ONE_MEGABYTE
- message->header_fields[field].offset = -1;
-
- adjust_field_offsets (message,
- offset - 8,
- - delete_len);
+/** Avoid caching too many messages */
+#define MAX_MESSAGE_CACHE_SIZE 5
- append_header_padding (message);
-}
+_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 dbus_bool_t
-set_int_field (DBusMessage *message,
- int field,
- int value)
+static void
+dbus_message_cache_shutdown (void *data)
{
- int offset = message->header_fields[field].offset;
+ int i;
- _dbus_assert (!message->locked);
-
- if (offset < 0)
- {
- /* need to append the field */
+ _DBUS_LOCK (message_cache);
- switch (field)
- {
- case FIELD_REPLY_SERIAL:
- return append_int_field (message, field,
- DBUS_HEADER_FIELD_REPLY,
- value);
- default:
- _dbus_assert_not_reached ("appending an int field we don't support appending");
- return FALSE;
- }
- }
- else
+ i = 0;
+ while (i < MAX_MESSAGE_CACHE_SIZE)
{
- _dbus_marshal_set_int32 (&message->header,
- message->byte_order,
- offset, value);
+ if (message_cache[i])
+ dbus_message_finalize (message_cache[i]);
- return TRUE;
+ ++i;
}
-}
-static dbus_bool_t
-set_uint_field (DBusMessage *message,
- int field,
- dbus_uint32_t value)
-{
- int offset = message->header_fields[field].offset;
+ message_cache_count = 0;
+ message_cache_shutdown_registered = FALSE;
- _dbus_assert (!message->locked);
-
- if (offset < 0)
- {
- /* need to append the field */
+ _DBUS_UNLOCK (message_cache);
+}
- switch (field)
- {
- default:
- _dbus_assert_not_reached ("appending a uint field we don't support appending");
- return FALSE;
- }
- }
- else
- {
- _dbus_marshal_set_uint32 (&message->header,
- message->byte_order,
- offset, 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)
+{
+ DBusMessage *message;
+ int i;
- return TRUE;
- }
-}
+ message = NULL;
-static dbus_bool_t
-set_string_field (DBusMessage *message,
- int field,
- const char *value)
-{
- int offset = message->header_fields[field].offset;
+ _DBUS_LOCK (message_cache);
- _dbus_assert (!message->locked);
- _dbus_assert (value != NULL);
-
- if (offset < 0)
- {
- /* need to append the field */
+ _dbus_assert (message_cache_count >= 0);
- switch (field)
- {
- case FIELD_SENDER:
- return append_string_field (message, field,
- DBUS_HEADER_FIELD_SENDER,
- value);
- default:
- _dbus_assert_not_reached ("appending a string field we don't support appending");
- return FALSE;
- }
- }
- else
+ if (message_cache_count == 0)
{
- DBusString v;
- int old_len;
- int new_len;
- int len;
-
- clear_header_padding (message);
-
- old_len = _dbus_string_get_length (&message->header);
+ _DBUS_UNLOCK (message_cache);
+ return NULL;
+ }
- len = strlen (value);
-
- _dbus_string_init_const_len (&v, value,
- len + 1); /* include nul */
- if (!_dbus_marshal_set_string (&message->header,
- message->byte_order,
- offset, &v,
- len))
- goto failed;
-
- new_len = _dbus_string_get_length (&message->header);
+ /* This is not necessarily true unless count > 0, and
+ * message_cache is uninitialized until the shutdown is
+ * registered
+ */
+ _dbus_assert (message_cache_shutdown_registered);
- adjust_field_offsets (message,
- offset,
- new_len - old_len);
+ i = 0;
+ while (i < MAX_MESSAGE_CACHE_SIZE)
+ {
+ 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);
- if (!append_header_padding (message))
- goto failed;
-
- return TRUE;
+ _DBUS_UNLOCK (message_cache);
- failed:
- /* 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");
+ _dbus_assert (message->refcount.value == 0);
+ _dbus_assert (message->size_counters == NULL);
- return FALSE;
- }
+ return message;
}
/**
- * Sets the serial number of a message.
- * This can only be done once on a message.
- *
+ * Tries to cache a message, otherwise finalize it.
+ *
* @param message the message
- * @param serial the serial
*/
-void
-_dbus_message_set_serial (DBusMessage *message,
- dbus_int32_t serial)
+static void
+dbus_message_cache_or_finalize (DBusMessage *message)
{
- _dbus_assert (!message->locked);
- _dbus_assert (dbus_message_get_serial (message) < 0);
+ dbus_bool_t was_cached;
+ int i;
- set_int_field (message, FIELD_CLIENT_SERIAL,
- serial);
- message->client_serial = serial;
-}
+ _dbus_assert (message->refcount.value == 0);
-/**
- * Sets the reply serial of a message (the client serial
- * of the message this is a reply to).
- *
- * @param message the message
- * @param reply_serial the client serial
- * @returns #FALSE if not enough memory
- */
-dbus_bool_t
-dbus_message_set_reply_serial (DBusMessage *message,
- dbus_int32_t reply_serial)
-{
- _dbus_assert (!message->locked);
+ /* This calls application code and has to be done first thing
+ * without holding the lock
+ */
+ _dbus_data_slot_list_clear (&message->slot_list);
- if (set_int_field (message, FIELD_REPLY_SERIAL,
- reply_serial))
- {
- message->reply_serial = reply_serial;
- return TRUE;
- }
- else
- return FALSE;
-}
+ _dbus_list_foreach (&message->size_counters,
+ free_size_counter, message);
+ _dbus_list_clear (&message->size_counters);
-/**
- * Returns the serial of a message or -1 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.
- *
- * @param message the message
- * @returns the client serial
- */
-dbus_int32_t
-dbus_message_get_serial (DBusMessage *message)
-{
- return message->client_serial;
-}
+ was_cached = FALSE;
-/**
- * Returns the serial that the message is
- * a reply to or -1 if none.
- *
- * @param message the message
- * @returns the reply serial
- */
-dbus_int32_t
-dbus_message_get_reply_serial (DBusMessage *message)
-{
- return message->reply_serial;
-}
+ _DBUS_LOCK (message_cache);
-/**
- * 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
- */
-void
-_dbus_message_add_size_counter (DBusMessage *message,
- DBusCounter *counter)
-{
- _dbus_assert (message->size_counter == NULL); /* If this fails we may need to keep a list of
- * counters instead of just one
- */
+ if (!message_cache_shutdown_registered)
+ {
+ _dbus_assert (message_cache_count == 0);
- message->size_counter = counter;
- _dbus_counter_ref (message->size_counter);
+ if (!_dbus_register_shutdown_func (dbus_message_cache_shutdown, NULL))
+ goto out;
- /* When we can change message size, we may want to
- * update this each time we do so, or we may want to
- * just KISS like this.
- */
- message->size_counter_delta =
- _dbus_string_get_length (&message->header) +
- _dbus_string_get_length (&message->body);
+ i = 0;
+ while (i < MAX_MESSAGE_CACHE_SIZE)
+ {
+ message_cache[i] = NULL;
+ ++i;
+ }
-#if 0
- _dbus_verbose ("message has size %ld\n",
- message->size_counter_delta);
-#endif
-
- _dbus_counter_adjust (message->size_counter, message->size_counter_delta);
-}
+ message_cache_shutdown_registered = TRUE;
+ }
-static dbus_bool_t
-dbus_message_create_header (DBusMessage *message,
- const char *service,
- const char *name)
-{
- unsigned int flags;
-
- if (!_dbus_string_append_byte (&message->header, message->byte_order))
- return FALSE;
+ _dbus_assert (message_cache_count >= 0);
- flags = 0;
- if (!_dbus_string_append_byte (&message->header, flags))
- return FALSE;
+ if ((_dbus_string_get_length (&message->header.data) +
+ _dbus_string_get_length (&message->body)) >
+ MAX_MESSAGE_SIZE_TO_CACHE)
+ goto out;
- if (!_dbus_string_append_byte (&message->header, DBUS_MAJOR_PROTOCOL_VERSION))
- return FALSE;
+ if (message_cache_count >= MAX_MESSAGE_CACHE_SIZE)
+ goto out;
- if (!_dbus_string_append_byte (&message->header, 0))
- return FALSE;
+ /* Find empty slot */
+ i = 0;
+ while (message_cache[i] != NULL)
+ ++i;
- message->header_fields[FIELD_HEADER_LENGTH].offset = 4;
- if (!_dbus_marshal_uint32 (&message->header, message->byte_order, 0))
- return FALSE;
+ _dbus_assert (i < MAX_MESSAGE_CACHE_SIZE);
- message->header_fields[FIELD_BODY_LENGTH].offset = 8;
- if (!_dbus_marshal_uint32 (&message->header, message->byte_order, 0))
- return FALSE;
+ _dbus_assert (message_cache[i] == NULL);
+ message_cache[i] = message;
+ message_cache_count += 1;
+ was_cached = TRUE;
- message->header_fields[FIELD_CLIENT_SERIAL].offset = 12;
- if (!_dbus_marshal_int32 (&message->header, message->byte_order, -1))
- return FALSE;
-
- /* Marshal message service */
- if (service != NULL)
- {
- if (!append_string_field (message,
- FIELD_SERVICE,
- DBUS_HEADER_FIELD_SERVICE,
- service))
- return FALSE;
- }
+ out:
+ _DBUS_UNLOCK (message_cache);
- _dbus_assert (name != NULL);
- if (!append_string_field (message,
- FIELD_NAME,
- DBUS_HEADER_FIELD_NAME,
- name))
- return FALSE;
-
- return TRUE;
+ if (!was_cached)
+ dbus_message_finalize (message);
}
-/**
- * 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)
+static DBusMessage*
+dbus_message_new_empty_header (void)
{
- if (!message->locked)
+ DBusMessage *message;
+ dbus_bool_t from_cache;
+
+ message = dbus_message_get_cached ();
+
+ if (message != NULL)
+ {
+ from_cache = TRUE;
+ }
+ else
{
- /* Fill in our lengths */
- set_uint_field (message,
- FIELD_HEADER_LENGTH,
- _dbus_string_get_length (&message->header));
+ from_cache = FALSE;
+ message = dbus_new (DBusMessage, 1);
+ if (message == NULL)
+ return NULL;
+#ifndef DBUS_DISABLE_CHECKS
+ message->generation = _dbus_current_generation;
+#endif
+ }
+
+ message->refcount.value = 1;
+ message->byte_order = DBUS_COMPILER_BYTE_ORDER;
+ message->locked = FALSE;
+ message->size_counters = NULL;
+ message->size_counter_delta = 0;
+ message->changed_stamp = 0;
- set_uint_field (message,
- FIELD_BODY_LENGTH,
- _dbus_string_get_length (&message->body));
+ if (!from_cache)
+ _dbus_data_slot_list_init (&message->slot_list);
- message->locked = TRUE;
+ if (from_cache)
+ {
+ _dbus_header_reinit (&message->header, message->byte_order);
+ _dbus_string_set_length (&message->body, 0);
}
-}
+ else
+ {
+ 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;
+ }
+ }
-/**
- * @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.
- *
- * @{
- */
+ return message;
+}
/**
- * @typedef DBusMessage
+ * Constructs a new message of the given message type.
+ * Types include #DBUS_MESSAGE_TYPE_METHOD_CALL,
+ * #DBUS_MESSAGE_TYPE_SIGNAL, and so forth.
*
- * Opaque data type representing a message received from or to be
- * sent to another application.
+ * @param message_type type of message
+ * @returns new message or #NULL If no memory
*/
-
-static DBusMessage*
-dbus_message_new_empty_header (void)
+DBusMessage*
+dbus_message_new (int message_type)
{
DBusMessage *message;
- int i;
-
- message = dbus_new0 (DBusMessage, 1);
+
+ _dbus_return_val_if_fail (message_type != DBUS_MESSAGE_TYPE_INVALID, NULL);
+
+ message = dbus_message_new_empty_header ();
if (message == NULL)
return NULL;
-
- message->refcount = 1;
- message->byte_order = DBUS_COMPILER_BYTE_ORDER;
- message->client_serial = -1;
- message->reply_serial = -1;
-
- i = 0;
- while (i < FIELD_LAST)
- {
- message->header_fields[i].offset = -1;
- ++i;
- }
-
- if (!_dbus_string_init (&message->header, _DBUS_INT_MAX))
- {
- dbus_free (message);
- return NULL;
- }
-
- if (!_dbus_string_init (&message->body, _DBUS_INT_MAX))
+
+ if (!_dbus_header_create (&message->header,
+ message_type,
+ NULL, NULL, NULL, NULL, NULL))
{
- _dbus_string_free (&message->header);
- dbus_free (message);
+ dbus_message_unref (message);
return NULL;
}
-
+
return message;
}
-
/**
- * Constructs a new message. 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).
- *
- * @todo reverse the arguments, first 'name' then 'service'
- * as 'name' is more fundamental
+ * Constructs a new message to invoke a method on a remote
+ * object. Returns #NULL if memory can't be allocated for the
+ * 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 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 method method to invoke
*
- * @param service service that the message should be sent to or #NULL
- * @param name name of the message
* @returns a new DBusMessage, free with dbus_message_unref()
* @see dbus_message_unref()
*/
DBusMessage*
-dbus_message_new (const char *service,
- const char *name)
+dbus_message_new_method_call (const char *destination,
+ const char *path,
+ const char *interface,
+ const char *method)
{
DBusMessage *message;
+ _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, service, name))
+
+ if (!_dbus_header_create (&message->header,
+ DBUS_MESSAGE_TYPE_METHOD_CALL,
+ destination, path, interface, method, NULL))
{
dbus_message_unref (message);
return NULL;
}
-
+
return message;
}
/**
- * Constructs a message that is a reply to some other
- * message. Returns #NULL if memory can't be allocated
- * for the message.
+ * Constructs a message that is a reply to a method call. Returns
+ * #NULL if memory can't be allocated for the message.
*
- * @param original_message the message which the created
+ * @param method_call the message which the created
* message is a reply to.
* @returns a new DBusMessage, free with dbus_message_unref()
- * @see dbus_message_new(), dbus_message_unref()
- */
+ * @see dbus_message_new_method_call(), dbus_message_unref()
+ */
DBusMessage*
-dbus_message_new_reply (DBusMessage *original_message)
+dbus_message_new_method_return (DBusMessage *method_call)
{
DBusMessage *message;
- const char *sender, *name;
+ const char *sender;
+
+ _dbus_return_val_if_fail (method_call != NULL, NULL);
- sender = get_string_field (original_message,
- FIELD_SENDER, NULL);
- name = get_string_field (original_message,
- FIELD_NAME, NULL);
+ sender = dbus_message_get_sender (method_call);
/* sender is allowed to be null here in peer-to-peer case */
-
- message = dbus_message_new (sender, name);
-
+
+ message = dbus_message_new_empty_header ();
if (message == NULL)
return NULL;
+ if (!_dbus_header_create (&message->header,
+ DBUS_MESSAGE_TYPE_METHOD_RETURN,
+ sender, NULL, NULL, NULL, NULL))
+ {
+ dbus_message_unref (message);
+ return NULL;
+ }
+
+ dbus_message_set_no_reply (message, TRUE);
+
if (!dbus_message_set_reply_serial (message,
- dbus_message_get_serial (original_message)))
+ dbus_message_get_serial (method_call)))
{
dbus_message_unref (message);
return NULL;
}
/**
- * Creates a new message that is an error reply to a certain message.
+ * 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.
*
- * @param original_message the original message
- * @param error_name the error name
- * @param error_message the error message string
- * @returns a new error message
+ * @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_error_reply (DBusMessage *original_message,
- const char *error_name,
- const char *error_message)
+dbus_message_new_signal (const char *path,
+ const char *interface,
+ const char *name)
{
DBusMessage *message;
- const char *sender;
- sender = get_string_field (original_message,
- FIELD_SENDER, NULL);
-
- _dbus_assert (sender != NULL);
-
- message = dbus_message_new (sender, error_name);
-
+ _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_set_reply_serial (message,
- dbus_message_get_serial (original_message)))
+ if (!_dbus_header_create (&message->header,
+ DBUS_MESSAGE_TYPE_SIGNAL,
+ NULL, path, interface, name, NULL))
{
dbus_message_unref (message);
return NULL;
}
- if (!dbus_message_append_string (message, error_message))
- {
- dbus_message_unref (message);
- return NULL;
- }
+ dbus_message_set_no_reply (message, TRUE);
- dbus_message_set_is_error (message, TRUE);
-
return message;
}
/**
- * Creates a new message that is an exact replica of the message
- * specified, except that its refcount is set to 1.
+ * Creates a new message that is an error reply to a certain message.
+ * Error replies are possible in response to method calls primarily.
*
- * @param message the message.
- * @returns the new message.
+ * @param reply_to the original message
+ * @param error_name the error name
+ * @param error_message the error message string or #NULL for none
+ * @returns a new error message
*/
-DBusMessage *
-dbus_message_copy (const DBusMessage *message)
+DBusMessage*
+dbus_message_new_error (DBusMessage *reply_to,
+ const char *error_name,
+ const char *error_message)
{
- DBusMessage *retval;
- int i;
-
- retval = dbus_new0 (DBusMessage, 1);
- if (retval == NULL)
+ DBusMessage *message;
+ const char *sender;
+ DBusMessageIter iter;
+
+ _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);
+
+ 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
+ * connection.
+ */
+ message = dbus_message_new_empty_header ();
+ if (message == NULL)
return NULL;
-
- retval->refcount = 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 (&retval->header, _DBUS_INT_MAX))
+
+ if (!_dbus_header_create (&message->header,
+ DBUS_MESSAGE_TYPE_ERROR,
+ sender, NULL, NULL, NULL, error_name))
{
- dbus_free (retval);
+ dbus_message_unref (message);
return NULL;
}
-
- if (!_dbus_string_init (&retval->body, _DBUS_INT_MAX))
+
+ dbus_message_set_no_reply (message, TRUE);
+
+ if (!dbus_message_set_reply_serial (message,
+ dbus_message_get_serial (reply_to)))
{
- _dbus_string_free (&retval->header);
- dbus_free (retval);
+ dbus_message_unref (message);
return NULL;
}
- if (!_dbus_string_copy (&message->header, 0,
- &retval->header, 0))
+ if (error_message != NULL)
{
- _dbus_string_free (&retval->header);
- _dbus_string_free (&retval->body);
- dbus_free (retval);
-
- return NULL;
+ 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;
+ }
}
- if (!_dbus_string_copy (&message->body, 0,
- &retval->body, 0))
+ 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.
+ *
+ * @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, 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.
+ */
+DBusMessage *
+dbus_message_copy (const DBusMessage *message)
+{
+ DBusMessage *retval;
+
+ _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->locked = FALSE;
+#ifndef DBUS_DISABLE_CHECKS
+ retval->generation = message->generation;
+#endif
+
+ if (!_dbus_header_copy (&message->header, &retval->header))
{
- _dbus_string_free (&retval->header);
- _dbus_string_free (&retval->body);
dbus_free (retval);
-
return NULL;
}
- for (i = 0; i < FIELD_LAST; i++)
+ if (!_dbus_string_init_preallocated (&retval->body,
+ _dbus_string_get_length (&message->body)))
{
- retval->header_fields[i].offset = message->header_fields[i].offset;
+ _dbus_header_free (&retval->header);
+ dbus_free (retval);
+ return NULL;
}
-
+
+ if (!_dbus_string_copy (&message->body, 0,
+ &retval->body, 0))
+ goto failed_copy;
+
return retval;
+
+ failed_copy:
+ _dbus_header_free (&retval->header);
+ _dbus_string_free (&retval->body);
+ dbus_free (retval);
+
+ return NULL;
}
* Increments the reference count of a DBusMessage.
*
* @param message The message
+ * @returns the message
* @see dbus_message_unref
*/
-void
+DBusMessage *
dbus_message_ref (DBusMessage *message)
{
- dbus_atomic_t refcount;
+ dbus_int32_t old_refcount;
+
+ _dbus_return_val_if_fail (message != NULL, NULL);
+ _dbus_return_val_if_fail (message->generation == _dbus_current_generation, NULL);
+
+ old_refcount = _dbus_atomic_inc (&message->refcount);
+ _dbus_assert (old_refcount >= 1);
- refcount = _dbus_atomic_inc (&message->refcount);
- _dbus_assert (refcount > 1);
+ return message;
}
/**
void
dbus_message_unref (DBusMessage *message)
{
- dbus_atomic_t refcount;
+ dbus_int32_t old_refcount;
- refcount = _dbus_atomic_dec (&message->refcount);
-
- _dbus_assert (refcount >= 0);
+ _dbus_return_if_fail (message != NULL);
+ _dbus_return_if_fail (message->generation == _dbus_current_generation);
+
+ old_refcount = _dbus_atomic_dec (&message->refcount);
+
+ _dbus_assert (old_refcount >= 0);
- if (refcount == 0)
+ if (old_refcount == 1)
{
- if (message->size_counter != NULL)
- {
- _dbus_counter_adjust (message->size_counter,
- - message->size_counter_delta);
- _dbus_counter_unref (message->size_counter);
- }
-
- _dbus_string_free (&message->header);
- _dbus_string_free (&message->body);
-
- dbus_free (message);
+ /* Calls application callbacks! */
+ dbus_message_cache_or_finalize (message);
}
}
/**
- * Gets the name of a 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.
*
- * @param message the message
- * @returns the message name (should not be freed)
- */
-const char*
-dbus_message_get_name (DBusMessage *message)
-{
- return get_string_field (message, FIELD_NAME, NULL);
-}
-
-/**
- * Gets the destination service of a message.
*
- * @todo I think if we have set_sender/get_sender,
- * this function might be better named set_destination/
- * get_destination for clarity, as the sender
- * is also a service name.
- *
* @param message the message
- * @returns the message destination service (should not be freed)
+ * @returns the type of the message
*/
-const char*
-dbus_message_get_service (DBusMessage *message)
-{
- return get_string_field (message, 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 a pointer to the array followed by an int
- * giving the length of the array. The list is terminated
- * with 0.
+int
+dbus_message_get_type (DBusMessage *message)
+{
+ _dbus_return_val_if_fail (message != NULL, DBUS_MESSAGE_TYPE_INVALID);
+
+ return _dbus_header_get_message_type (&message->header);
+}
+
+/**
+ * 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.
+ *
+ * To append a basic type, specify its type code followed by the
+ * value. For example:
+ *
+ * @code
+ * DBUS_TYPE_INT32, 42,
+ * DBUS_TYPE_STRING, "Hello World"
+ * @endcode
+ * or
+ * @code
+ * dbus_int32_t val = 42;
+ * DBUS_TYPE_INT32, val
+ * @endcode
+ *
+ * Be sure that your provided value is the right size. For example, this
+ * won't work:
+ * @code
+ * DBUS_TYPE_INT64, 42
+ * @endcode
+ * Because the "42" will be a 32-bit integer. You need to cast to
+ * 64-bit.
+ *
+ * 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_TYPE_ARRAY, DBUS_TYPE_INT32, &v_ARRAY, 3
+ * @endcode
+ *
+ * @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.
+ *
+ * The last argument to this function must be #DBUS_TYPE_INVALID,
+ * marking the end of the argument list.
+ *
+ * @todo support DBUS_TYPE_STRUCT and DBUS_TYPE_VARIANT and complex arrays
+ *
+ * @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
*/
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,
}
/**
- * This function takes a va_list for use by language bindings
+ * This function takes a va_list for use by language bindings.
+ * It's otherwise the same as dbus_message_append_args().
*
- * @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
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;
- while (type != 0)
+ dbus_message_iter_init_append (message, &iter);
+
+ while (type != DBUS_TYPE_INVALID)
{
- switch (type)
- {
- case DBUS_TYPE_NIL:
- if (!dbus_message_append_nil (message))
- goto enomem;
- case DBUS_TYPE_BOOLEAN:
- if (!dbus_message_append_boolean (message, va_arg (var_args, dbus_bool_t)))
- goto enomem;
- break;
- case DBUS_TYPE_INT32:
- if (!dbus_message_append_int32 (message, va_arg (var_args, dbus_int32_t)))
- goto enomem;
- break;
- case DBUS_TYPE_UINT32:
- if (!dbus_message_append_uint32 (message, va_arg (var_args, dbus_uint32_t)))
- goto enomem;
- break;
- case DBUS_TYPE_DOUBLE:
- if (!dbus_message_append_double (message, va_arg (var_args, double)))
- goto enomem;
- break;
- case DBUS_TYPE_STRING:
- if (!dbus_message_append_string (message, va_arg (var_args, const char *)))
- goto enomem;
- break;
- case DBUS_TYPE_BOOLEAN_ARRAY:
- {
- int len;
- unsigned char *data;
-
- data = va_arg (var_args, unsigned char *);
- len = va_arg (var_args, int);
-
- if (!dbus_message_append_boolean_array (message, data, len))
- goto enomem;
- }
- break;
- case DBUS_TYPE_INT32_ARRAY:
- {
- int len;
- dbus_int32_t *data;
-
- data = va_arg (var_args, dbus_int32_t *);
- len = va_arg (var_args, int);
-
- if (!dbus_message_append_int32_array (message, data, len))
- goto enomem;
- }
- break;
- case DBUS_TYPE_UINT32_ARRAY:
- {
- int len;
- dbus_uint32_t *data;
-
- data = va_arg (var_args, dbus_uint32_t *);
- len = va_arg (var_args, int);
-
- if (!dbus_message_append_uint32_array (message, data, len))
- goto enomem;
- }
- break;
- case DBUS_TYPE_DOUBLE_ARRAY:
- {
- int len;
- double *data;
-
- data = va_arg (var_args, double *);
- len = va_arg (var_args, int);
-
- if (!dbus_message_append_double_array (message, data, len))
- goto enomem;
- }
- break;
- case DBUS_TYPE_BYTE_ARRAY:
- {
- int len;
- unsigned char *data;
-
- data = va_arg (var_args, unsigned char *);
- len = va_arg (var_args, int);
-
- if (!dbus_message_append_byte_array (message, data, len))
- goto enomem;
- }
- break;
- case DBUS_TYPE_STRING_ARRAY:
- {
- int len;
- const char **data;
-
- data = va_arg (var_args, const char **);
- len = va_arg (var_args, int);
-
- if (!dbus_message_append_string_array (message, data, len))
- goto enomem;
- }
- break;
- case DBUS_TYPE_DICT:
- {
- DBusDict *dict;
-
- dict = va_arg (var_args, DBusDict *);
-
- if (!dbus_message_append_dict (message, dict))
- goto enomem;
- break;
- }
- default:
- _dbus_warn ("Unknown field type %d\n", type);
- }
+ if (_dbus_type_is_basic (type))
+ {
+ const DBusBasicValue *value;
+ value = va_arg (var_args, const DBusBasicValue*);
+
+ if (!dbus_message_iter_append_basic (&iter,
+ type,
+ value))
+ goto failed;
+ }
+ else if (type == DBUS_TYPE_ARRAY)
+ {
+ int element_type;
+ const DBusBasicValue **value;
+ int n_elements;
+ DBusMessageIter array;
+ char buf[2];
+
+ element_type = va_arg (var_args, int);
+
+#ifndef DBUS_DISABLE_CHECKS
+ if (!_dbus_type_is_fixed (element_type))
+ {
+ _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;
+ }
+#endif
+
+ value = va_arg (var_args, const DBusBasicValue**);
+ n_elements = 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_message_iter_append_fixed_array (&array,
+ element_type,
+ value,
+ n_elements))
+ 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;
- enomem:
+ failed:
return FALSE;
}
/**
- * Appends a nil value to the message
+ * 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.
+ *
+ * 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.
+ *
+ * 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.
+ *
+ * @todo support DBUS_TYPE_STRUCT and DBUS_TYPE_VARIANT and complex arrays
*
* @param message the message
- * @returns #TRUE on success
+ * @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_append_nil (DBusMessage *message)
+dbus_message_get_args (DBusMessage *message,
+ DBusError *error,
+ int first_arg_type,
+ ...)
{
- _dbus_assert (!message->locked);
+ dbus_bool_t retval;
+ va_list var_args;
- if (!_dbus_string_append_byte (&message->body, DBUS_TYPE_NIL))
- return FALSE;
- else
- return TRUE;
+ _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);
+
+ return retval;
}
/**
- * Appends a boolean value to the message
+ * This function takes a va_list for use by language bindings. It is
+ * otherwise the same as dbus_message_get_args().
*
+ * @see dbus_message_get_args
* @param message the message
- * @param value the boolean value
- * @returns #TRUE on success
+ * @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_append_boolean (DBusMessage *message,
- dbus_bool_t value)
+dbus_message_get_args_valist (DBusMessage *message,
+ DBusError *error,
+ int first_arg_type,
+ va_list var_args)
{
- _dbus_assert (!message->locked);
-
- if (!_dbus_string_append_byte (&message->body, DBUS_TYPE_BOOLEAN))
- return FALSE;
+ DBusMessageIter iter;
- if (!_dbus_string_append_byte (&message->body, (value != FALSE)))
- {
- _dbus_string_shorten (&message->body, 1);
- return FALSE;
- }
+ _dbus_return_val_if_fail (message != NULL, FALSE);
+ _dbus_return_val_if_error_is_set (error, FALSE);
- return TRUE;
+ dbus_message_iter_init (message, &iter);
+ return _dbus_message_iter_get_args_valist (&iter, error, first_arg_type, var_args);
+}
+
+static void
+_dbus_message_iter_init_common (DBusMessage *message,
+ DBusMessageRealIter *real,
+ int iter_type)
+{
+ _dbus_assert (sizeof (DBusMessageRealIter) <= sizeof (DBusMessageIter));
+
+ /* 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);
+
+ real->message = message;
+ real->changed_stamp = message->changed_stamp;
+ real->iter_type = iter_type;
+ real->sig_refcount = 0;
}
/**
- * Appends a 32 bit signed integer to the message.
+ * Initializes a #DBusMessageIter for reading the arguments of the
+ * message passed in.
*
* @param message the message
- * @param value the integer value
- * @returns #TRUE on success
+ * @param iter pointer to an iterator to initialize
+ * @returns #FALSE if the message has no arguments
*/
dbus_bool_t
-dbus_message_append_int32 (DBusMessage *message,
- dbus_int32_t value)
+dbus_message_iter_init (DBusMessage *message,
+ DBusMessageIter *iter)
{
- _dbus_assert (!message->locked);
+ DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
+ const DBusString *type_str;
+ int type_pos;
+
+ _dbus_return_val_if_fail (message != NULL, FALSE);
+ _dbus_return_val_if_fail (iter != NULL, FALSE);
+
+ get_const_signature (&message->header, &type_str, &type_pos);
+
+ _dbus_message_iter_init_common (message, real,
+ DBUS_MESSAGE_ITER_TYPE_READER);
- if (!_dbus_string_append_byte (&message->body, DBUS_TYPE_INT32))
+ _dbus_type_reader_init (&real->u.reader,
+ message->byte_order,
+ type_str, type_pos,
+ &message->body,
+ 0);
+
+ return _dbus_type_reader_get_current_type (&real->u.reader) != DBUS_TYPE_INVALID;
+}
+
+#ifndef DBUS_DISABLE_CHECKS
+static dbus_bool_t
+_dbus_message_iter_check (DBusMessageRealIter *iter)
+{
+ if (iter == NULL)
+ {
+ _dbus_warn ("dbus message iterator is NULL\n");
return FALSE;
-
- if (!_dbus_marshal_int32 (&message->body, message->byte_order, value))
+ }
+
+ if (iter->iter_type == DBUS_MESSAGE_ITER_TYPE_READER)
+ {
+ if (iter->u.reader.byte_order != iter->message->byte_order)
+ {
+ _dbus_warn ("dbus message changed byte order since iterator was created\n");
+ return FALSE;
+ }
+ /* 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)
+ {
+ _dbus_warn ("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 ("dbus message iterator looks uninitialized or corrupted\n");
+ return FALSE;
+ }
+
+ if (iter->changed_stamp != iter->message->changed_stamp)
{
- _dbus_string_shorten (&message->body, 1);
+ _dbus_warn ("dbus message iterator invalid because the message has been modified (or perhaps the iterator is just uninitialized)\n");
return FALSE;
}
return TRUE;
}
+#endif /* DBUS_DISABLE_CHECKS */
/**
- * Appends a 32 bit unsigned integer to the message.
+ * Checks if an iterator has any more fields.
*
- * @param message the message
- * @param value the integer value
- * @returns #TRUE on success
+ * @param iter the message iter
+ * @returns #TRUE if there are more fields
+ * following
*/
dbus_bool_t
-dbus_message_append_uint32 (DBusMessage *message,
- dbus_uint32_t value)
+dbus_message_iter_has_next (DBusMessageIter *iter)
{
- _dbus_assert (!message->locked);
+ DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
- if (!_dbus_string_append_byte (&message->body, DBUS_TYPE_UINT32))
- return FALSE;
-
- if (!_dbus_marshal_uint32 (&message->body, message->byte_order, value))
- {
- _dbus_string_shorten (&message->body, 1);
- 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);
}
/**
- * Appends a double value to the message.
+ * 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 message the message
- * @param value the double value
- * @returns #TRUE on success
+ * @param iter the message iter
+ * @returns #TRUE if the iterator was moved to the next field
*/
dbus_bool_t
-dbus_message_append_double (DBusMessage *message,
- double value)
+dbus_message_iter_next (DBusMessageIter *iter)
{
- _dbus_assert (!message->locked);
+ DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
- if (!_dbus_string_append_byte (&message->body, DBUS_TYPE_DOUBLE))
- 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);
- if (!_dbus_marshal_double (&message->body, message->byte_order, value))
- {
- _dbus_string_shorten (&message->body, 1);
- return FALSE;
- }
-
- return TRUE;
+ return _dbus_type_reader_next (&real->u.reader);
}
/**
- * Appends a UTF-8 string to the message.
+ * 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:
*
- * @param message the message
- * @param value the string
- * @returns #TRUE on success
+ * @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 argument type
*/
-dbus_bool_t
-dbus_message_append_string (DBusMessage *message,
- const char *value)
+int
+dbus_message_iter_get_arg_type (DBusMessageIter *iter)
{
- _dbus_assert (!message->locked);
+ DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
- if (!_dbus_string_append_byte (&message->body, DBUS_TYPE_STRING))
- return FALSE;
-
- if (!_dbus_marshal_string (&message->body, message->byte_order, value))
- {
- _dbus_string_shorten (&message->body, 1);
- return FALSE;
- }
+ _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);
- return TRUE;
+ return _dbus_type_reader_get_current_type (&real->u.reader);
}
/**
- * Appends a boolean array to the message.
+ * 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 message the message
- * @param value the array
- * @param len the length of the array
- * @returns #TRUE on success
+ * @param iter the message iter
+ * @returns the array element type
*/
-dbus_bool_t
-dbus_message_append_boolean_array (DBusMessage *message,
- unsigned const char *value,
- int len)
+int
+dbus_message_iter_get_element_type (DBusMessageIter *iter)
{
- _dbus_assert (!message->locked);
+ DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
- if (!_dbus_string_append_byte (&message->body, DBUS_TYPE_BOOLEAN_ARRAY))
- return FALSE;
+ _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);
- if (!_dbus_marshal_byte_array (&message->body, message->byte_order, value, len))
- {
- _dbus_string_shorten (&message->body, 1);
- return FALSE;
- }
-
- return TRUE;
+ return _dbus_type_reader_get_element_type (&real->u.reader);
}
/**
- * Appends a 32 bit signed integer array to the message.
+ * 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.
*
- * @param message the message
- * @param value the array
- * @param len the length of the array
- * @returns #TRUE on success
- */
-dbus_bool_t
-dbus_message_append_int32_array (DBusMessage *message,
- const dbus_int32_t *value,
- int len)
-{
- _dbus_assert (!message->locked);
-
- if (!_dbus_string_append_byte (&message->body, DBUS_TYPE_INT32_ARRAY))
- return FALSE;
-
- if (!_dbus_marshal_int32_array (&message->body, message->byte_order,
- value, len))
- {
- _dbus_string_shorten (&message->body, 1);
- return FALSE;
- }
-
- return TRUE;
-}
-
-/**
- * Appends a 32 bit unsigned integer array to the message.
+ * 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.
*
- * @param message the message
- * @param value the array
- * @param len the length of the array
- * @returns #TRUE on success
+ * @param iter the message iterator
+ * @param sub the sub-iterator to initialize
*/
-dbus_bool_t
-dbus_message_append_uint32_array (DBusMessage *message,
- const dbus_uint32_t *value,
- int len)
+void
+dbus_message_iter_recurse (DBusMessageIter *iter,
+ DBusMessageIter *sub)
{
- _dbus_assert (!message->locked);
-
- if (!_dbus_string_append_byte (&message->body, DBUS_TYPE_UINT32_ARRAY))
- return FALSE;
+ DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
+ DBusMessageRealIter *real_sub = (DBusMessageRealIter *)sub;
- if (!_dbus_marshal_uint32_array (&message->body, message->byte_order,
- value, len))
- {
- _dbus_string_shorten (&message->body, 1);
- return FALSE;
- }
+ _dbus_return_if_fail (_dbus_message_iter_check (real));
+ _dbus_return_if_fail (sub != NULL);
- return TRUE;
+ *real_sub = *real;
+ _dbus_type_reader_recurse (&real->u.reader, &real_sub->u.reader);
}
/**
- * Appends a double array to the message.
+ * Reads a basic-typed value from the message iterator.
+ * Basic types are the non-containers such as integer and string.
*
- * @param message the message
- * @param value the array
- * @param len the length of the array
- * @returns #TRUE on success
- */
-dbus_bool_t
-dbus_message_append_double_array (DBusMessage *message,
- const double *value,
- int len)
-{
- _dbus_assert (!message->locked);
-
- if (!_dbus_string_append_byte (&message->body, DBUS_TYPE_DOUBLE_ARRAY))
- return FALSE;
-
- if (!_dbus_marshal_double_array (&message->body, message->byte_order,
- value, len))
- {
- _dbus_string_shorten (&message->body, 1);
- return FALSE;
- }
-
- return TRUE;
-}
-
-/**
- * Appends a byte array to the message.
+ * 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.
*
- * @param message the message
- * @param value the array
- * @param len the length of the array
- * @returns #TRUE on success
- */
-dbus_bool_t
-dbus_message_append_byte_array (DBusMessage *message,
- unsigned const char *value,
- int len)
-{
- _dbus_assert (!message->locked);
-
- if (!_dbus_string_append_byte (&message->body, DBUS_TYPE_BYTE_ARRAY))
- return FALSE;
-
- if (!_dbus_marshal_byte_array (&message->body, message->byte_order, value, len))
- {
- _dbus_string_shorten (&message->body, 1);
- return FALSE;
- }
-
- return TRUE;
-}
-
-/**
- * Appends a string array to the message.
+ * All returned values are guaranteed to fit in 8 bytes. So you can
+ * write code like this:
*
- * @param message the message
- * @param value the array
- * @param len the length of the array
- * @returns #TRUE on success
- */
-dbus_bool_t
-dbus_message_append_string_array (DBusMessage *message,
- const char **value,
- int len)
-{
- _dbus_assert (!message->locked);
-
- if (!_dbus_string_append_byte (&message->body, DBUS_TYPE_STRING_ARRAY))
- return FALSE;
-
- if (!_dbus_marshal_string_array (&message->body, message->byte_order,
- (const char **)value, len))
- {
- _dbus_string_shorten (&message->body, 1);
- return FALSE;
- }
-
- return TRUE;
-}
-
-/**
- * Appends a dict to the message.
+ * @code
+ * #ifdef DBUS_HAVE_INT64
+ * 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);
+ * #endif
+ * @endcode
*
- * @param message the message
- * @param dict the dict
- * @returns #TRUE on success
+ * To avoid the #DBUS_HAVE_INT64 conditional, create a struct or
+ * something that occupies at least 8 bytes, e.g. you could use a
+ * struct with two int32 values in it. dbus_uint64_t is just one
+ * example of a type that's large enough to hold any possible value.
+ *
+ * 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.
+ *
+ * @param iter the iterator
+ * @param value location to store the value
*/
-dbus_bool_t
-dbus_message_append_dict (DBusMessage *message,
- DBusDict *dict)
+void
+dbus_message_iter_get_basic (DBusMessageIter *iter,
+ void *value)
{
- _dbus_assert (!message->locked);
-
- if (!_dbus_string_append_byte (&message->body, DBUS_TYPE_DICT))
- return FALSE;
+ DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
- if (!_dbus_marshal_dict (&message->body, message->byte_order, dict))
- {
- _dbus_string_shorten (&message->body, 1);
- return FALSE;
- }
+ _dbus_return_if_fail (_dbus_message_iter_check (real));
+ _dbus_return_if_fail (value != NULL);
- return TRUE;
+ _dbus_type_reader_read_basic (&real->u.reader,
+ value);
}
/**
- * 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 0.
+ * 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 block read will be from the
+ * current position in the array until the end of the array.
*
- * @param message the message
- * @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
+ * 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.
+ *
+ * @param iter the iterator
+ * @param value location to store the block
+ * @param n_elements number of elements in the block
*/
-dbus_bool_t
-dbus_message_get_args (DBusMessage *message,
- DBusError *error,
- int first_arg_type,
- ...)
+void
+dbus_message_iter_get_fixed_array (DBusMessageIter *iter,
+ void *value,
+ int *n_elements)
{
- dbus_bool_t retval;
- va_list var_args;
+ DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
- _DBUS_ASSERT_ERROR_IS_CLEAR (error);
-
- va_start (var_args, first_arg_type);
- retval = dbus_message_get_args_valist (message, error, first_arg_type, var_args);
- va_end (var_args);
+ _dbus_return_if_fail (_dbus_message_iter_check (real));
+ _dbus_return_if_fail (value != NULL);
+ _dbus_return_if_fail (_dbus_type_is_fixed (_dbus_type_reader_get_element_type (&real->u.reader)));
- return retval;
+ _dbus_type_reader_read_fixed_multi (&real->u.reader,
+ value, n_elements);
}
/**
- * This function takes a va_list for use by language bindings
- *
- * @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)
- *
- * @todo We need to free the argument data when an error occurs.
+ * This function takes a va_list for use by language bindings and is
+ * otherwise the same as dbus_message_iter_get_args().
+ * dbus_message_get_args() is the place to go for complete
+ * documentation.
*
* @see dbus_message_get_args
- * @param message the message
+ * @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_get_args_valist (DBusMessage *message,
- DBusError *error,
- int first_arg_type,
- va_list var_args)
+_dbus_message_iter_get_args_valist (DBusMessageIter *iter,
+ DBusError *error,
+ int first_arg_type,
+ va_list var_args)
{
+ DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
int spec_type, msg_type, i;
- DBusMessageIter *iter;
dbus_bool_t retval;
- _DBUS_ASSERT_ERROR_IS_CLEAR (error);
-
- iter = dbus_message_get_args_iter (message);
-
- if (iter == NULL)
- {
- dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
- return FALSE;
- }
+ _dbus_assert (_dbus_message_iter_check (real));
retval = FALSE;
-
+
spec_type = first_arg_type;
i = 0;
-
- while (spec_type != 0)
+
+ while (spec_type != DBUS_TYPE_INVALID)
{
- msg_type = dbus_message_iter_get_arg_type (iter);
-
+ msg_type = dbus_message_iter_get_arg_type (iter);
+
if (msg_type != spec_type)
{
dbus_set_error (error, DBUS_ERROR_INVALID_ARGS,
goto out;
}
- switch (spec_type)
- {
- case DBUS_TYPE_NIL:
- 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;
- }
-
- 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_BOOLEAN_ARRAY:
- {
- unsigned char **ptr;
- int *len;
-
- ptr = va_arg (var_args, unsigned char **);
- len = va_arg (var_args, int *);
-
- if (!dbus_message_iter_get_boolean_array (iter, ptr, len))
- {
- dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
- goto out;
- }
- break;
- }
-
- case DBUS_TYPE_INT32_ARRAY:
- {
- dbus_int32_t **ptr;
- int *len;
-
- ptr = va_arg (var_args, dbus_int32_t **);
- len = va_arg (var_args, int *);
-
- if (!dbus_message_iter_get_int32_array (iter, ptr, len))
- {
- dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
- goto out;
- }
-
- break;
- }
-
- case DBUS_TYPE_UINT32_ARRAY:
- {
- dbus_uint32_t **ptr;
- int *len;
-
- ptr = va_arg (var_args, dbus_uint32_t **);
- len = va_arg (var_args, int *);
-
- if (!dbus_message_iter_get_uint32_array (iter, ptr, len))
- {
- dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
- goto out;
- }
-
- break;
- }
-
- case DBUS_TYPE_DOUBLE_ARRAY:
- {
- double **ptr;
- int *len;
-
- ptr = va_arg (var_args, double **);
- len = va_arg (var_args, int *);
-
- if (!dbus_message_iter_get_double_array (iter, ptr, len))
- {
- dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
- goto out;
- }
- break;
- }
-
- case DBUS_TYPE_BYTE_ARRAY:
- {
- unsigned char **ptr;
- int *len;
-
- ptr = va_arg (var_args, unsigned char **);
- len = va_arg (var_args, int *);
-
- if (!dbus_message_iter_get_byte_array (iter, ptr, len))
- {
- dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
- goto out;
- }
- break;
- }
- case DBUS_TYPE_STRING_ARRAY:
- {
- char ***ptr;
- int *len;
-
- ptr = va_arg (var_args, char ***);
- len = va_arg (var_args, int *);
-
- if (!dbus_message_iter_get_string_array (iter, ptr, len))
- {
- dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
- goto out;
- }
- break;
- }
- case DBUS_TYPE_DICT:
- {
- DBusDict **dict;
-
- dict = va_arg (var_args, DBusDict **);
-
- if (!dbus_message_iter_get_dict (iter, dict))
- {
- dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
- goto out;
- }
- break;
- }
- default:
- _dbus_warn ("Unknown field type %d\n", spec_type);
- }
-
+ if (_dbus_type_is_basic (spec_type))
+ {
+ DBusBasicValue *ptr;
+
+ ptr = va_arg (var_args, DBusBasicValue*);
+
+ _dbus_assert (ptr != NULL);
+
+ _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;
+
+ spec_element_type = va_arg (var_args, int);
+ element_type = _dbus_type_reader_get_element_type (&real->u.reader);
+
+ 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;
+ }
+
+ if (_dbus_type_is_fixed (spec_element_type))
+ {
+ ptr = va_arg (var_args, const DBusBasicValue**);
+ n_elements_p = va_arg (var_args, int*);
+
+ _dbus_assert (ptr != NULL);
+ _dbus_assert (n_elements_p != NULL);
+
+ _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 i;
+ 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);
+
+ i = 0;
+ if (_dbus_type_reader_has_next (&array))
+ {
+ while (_dbus_type_reader_next (&array))
+ ++i;
+ }
+
+ str_array = dbus_new0 (char*, i + 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;
+ if (_dbus_type_reader_has_next (&array))
+ {
+ do
+ {
+ 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;
+ }
+ while (_dbus_type_reader_next (&array));
+ }
+
+ *str_array_p = str_array;
+ *n_elements_p = i;
+ }
+#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 (spec_type != 0 && !dbus_message_iter_next (iter))
+ 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);
i++;
}
-
+
retval = TRUE;
-
+
out:
- dbus_message_iter_unref (iter);
+
return retval;
}
/**
- * Returns a DBusMessageIter representing the arguments of the
- * message passed in.
+ * Initializes a #DBusMessageIter for appending arguments to the end
+ * of a message.
*
- * @todo IMO the message iter should follow the GtkTextIter pattern,
- * a static object with a "stamp" value used to detect invalid
- * iter uses (uninitialized or after changing the message).
- * ref/unref is kind of annoying to deal with, and slower too.
- * This implies not ref'ing the message from the iter.
- *
- * @todo I'd also name this dbus_message_iter_new() or
- * for the static object dbus_message_iter_init() rather
- * than making it a method on the message
+ * @todo If appending any of the arguments fails due to lack of
+ * memory, generally the message is hosed and you have to start over
+ * building the whole message.
*
* @param message the message
- * @returns a new iter.
+ * @param iter pointer to an iterator to initialize
*/
-DBusMessageIter *
-dbus_message_get_args_iter (DBusMessage *message)
+void
+dbus_message_iter_init_append (DBusMessage *message,
+ DBusMessageIter *iter)
{
- DBusMessageIter *iter;
-
- iter = dbus_new (DBusMessageIter, 1);
+ DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
- if (iter != NULL)
- {
- dbus_message_ref (message);
-
- iter->refcount = 1;
- iter->message = message;
- iter->pos = 0;
- }
-
- return iter;
-}
+ _dbus_return_if_fail (message != NULL);
+ _dbus_return_if_fail (iter != NULL);
-/**
- * Increments the reference count of a DBusMessageIter.
- *
- * @param iter the message iter
- * @see dbus_message_iter_unref
- */
-void
-dbus_message_iter_ref (DBusMessageIter *iter)
-{
- _dbus_assert (iter->refcount > 0);
-
- iter->refcount += 1;
+ _dbus_message_iter_init_common (message, real,
+ DBUS_MESSAGE_ITER_TYPE_WRITER);
+
+ /* 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));
}
/**
- * Decrements the reference count of a DBusMessageIter.
+ * 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.
*
- * @param iter The message iter
- * @see dbus_message_iter_ref
+ * @param real an iterator without a type_str
+ * @returns #FALSE if no memory
*/
-void
-dbus_message_iter_unref (DBusMessageIter *iter)
+static dbus_bool_t
+_dbus_message_iter_open_signature (DBusMessageRealIter *real)
{
- _dbus_assert (iter->refcount > 0);
+ DBusString *str;
+ const DBusString *current_sig;
+ int current_sig_pos;
- iter->refcount -= 1;
+ _dbus_assert (real->iter_type == DBUS_MESSAGE_ITER_TYPE_WRITER);
- if (iter->refcount == 0)
+ if (real->u.writer.type_str != NULL)
{
- dbus_message_unref (iter->message);
-
- dbus_free (iter);
+ _dbus_assert (real->sig_refcount > 0);
+ real->sig_refcount += 1;
+ return TRUE;
}
-}
-/**
- * Checks if an iterator has any more fields.
- *
- * @param iter the message iter
- * @returns #TRUE if there are more fields
- * following
- */
-dbus_bool_t
-dbus_message_iter_has_next (DBusMessageIter *iter)
-{
- int end_pos;
-
- if (!_dbus_marshal_get_arg_end_pos (&iter->message->body,
- iter->message->byte_order,
- iter->pos, &end_pos))
- return FALSE;
-
- if (end_pos >= _dbus_string_get_length (&iter->message->body))
+ str = dbus_new (DBusString, 1);
+ if (str == NULL)
return FALSE;
-
- return TRUE;
-}
-/**
- * Moves the iterator to the next field.
- *
- * @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)
-{
- int end_pos;
-
- if (!_dbus_marshal_get_arg_end_pos (&iter->message->body,
- iter->message->byte_order,
- iter->pos, &end_pos))
- return FALSE;
+ if (!_dbus_header_get_field_raw (&real->message->header,
+ DBUS_HEADER_FIELD_SIGNATURE,
+ ¤t_sig, ¤t_sig_pos))
+ current_sig = NULL;
- if (end_pos >= _dbus_string_get_length (&iter->message->body))
- return FALSE;
+ if (current_sig)
+ {
+ int current_len;
+
+ current_len = _dbus_string_get_byte (current_sig, current_sig_pos);
+ current_sig_pos += 1; /* move on to sig data */
+
+ 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;
+ }
+ }
- iter->pos = end_pos;
+ real->sig_refcount = 1;
+ _dbus_type_writer_add_types (&real->u.writer,
+ str, _dbus_string_get_length (str));
return TRUE;
}
/**
- * Returns the argument type of the argument that the
- * message iterator points at.
+ * 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 message iter
- * @returns the field type
+ * @param real an iterator without a type_str
+ * @returns #FALSE if no memory
*/
-int
-dbus_message_iter_get_arg_type (DBusMessageIter *iter)
+static dbus_bool_t
+_dbus_message_iter_close_signature (DBusMessageRealIter *real)
{
- const char *data;
+ DBusString *str;
+ const char *v_STRING;
+ dbus_bool_t retval;
- if (iter->pos >= _dbus_string_get_length (&iter->message->body))
- return DBUS_TYPE_INVALID;
+ _dbus_assert (real->iter_type == DBUS_MESSAGE_ITER_TYPE_WRITER);
+ _dbus_assert (real->u.writer.type_str != NULL);
+ _dbus_assert (real->sig_refcount > 0);
- _dbus_string_get_const_data_len (&iter->message->body, &data, iter->pos, 1);
+ real->sig_refcount -= 1;
- if (*data > DBUS_TYPE_INVALID && *data <= DBUS_TYPE_DICT)
- return *data;
+ if (real->sig_refcount > 0)
+ return TRUE;
+ _dbus_assert (real->sig_refcount == 0);
- return DBUS_TYPE_INVALID;
-}
+ retval = TRUE;
-/**
- * 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.
- *
- * @see dbus_message_iter_get_arg_type
- * @param iter the message iter
- * @returns the string
- */
-char *
-dbus_message_iter_get_string (DBusMessageIter *iter)
+ str = real->u.writer.type_str;
+
+ 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;
+
+ _dbus_type_writer_remove_types (&real->u.writer);
+ _dbus_string_free (str);
+ dbus_free (str);
+
+ return retval;
+}
+
+#ifndef DBUS_DISABLE_CHECKS
+static dbus_bool_t
+_dbus_message_iter_append_check (DBusMessageRealIter *iter)
{
- _dbus_assert (dbus_message_iter_get_arg_type (iter) == DBUS_TYPE_STRING);
+ if (!_dbus_message_iter_check (iter))
+ return FALSE;
+
+ if (iter->message->locked)
+ {
+ _dbus_warn ("dbus append iterator can't be used: message is locked (has already been sent)\n");
+ return FALSE;
+ }
- return _dbus_demarshal_string (&iter->message->body, iter->message->byte_order,
- iter->pos + 1, NULL);
+ return TRUE;
}
+#endif /* DBUS_DISABLE_CHECKS */
/**
- * 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.
+ * Appends a basic-typed value to the message. The basic types are the
+ * non-container types such as integer and string.
*
- * @see dbus_message_iter_get_arg_type
- * @param iter the message iter
- * @returns the string
+ * 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 (DBusMessageIter *iter)
+dbus_message_iter_append_basic (DBusMessageIter *iter,
+ int type,
+ const void *value)
{
- unsigned char value;
-
- _dbus_assert (dbus_message_iter_get_arg_type (iter) == DBUS_TYPE_BOOLEAN);
+ DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
+ dbus_bool_t ret;
- value = _dbus_string_get_byte (&iter->message->body, iter->pos + 1);
-
- return value;
+ _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);
+
+ if (!_dbus_message_iter_open_signature (real))
+ return FALSE;
+
+ ret = _dbus_type_writer_write_basic (&real->u.writer, type, value);
+
+ if (!_dbus_message_iter_close_signature (real))
+ ret = FALSE;
+
+ return ret;
}
/**
- * Returns the 32 bit signed integer value that an iterator may point to.
- * Note that you need to check that the iterator points to
- * an integer value before 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.
*
- * @see dbus_message_iter_get_arg_type
- * @param iter the message iter
- * @returns the integer
+ * 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
*/
-int
-dbus_message_iter_get_int32 (DBusMessageIter *iter)
-{
- _dbus_assert (dbus_message_iter_get_arg_type (iter) == DBUS_TYPE_INT32);
+dbus_bool_t
+dbus_message_iter_append_fixed_array (DBusMessageIter *iter,
+ int element_type,
+ const void *value,
+ int n_elements)
+{
+ DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
+ 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_open_container (DBusMessageIter *iter,
+ int type,
+ const char *contained_signature,
+ DBusMessageIter *sub)
+{
+ DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
+ 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) ||
+ contained_signature != NULL, FALSE);
+ _dbus_return_val_if_fail (type != DBUS_TYPE_DICT_ENTRY ||
+ dbus_message_iter_get_arg_type (iter) == DBUS_TYPE_ARRAY,
+ FALSE);
- return _dbus_demarshal_int32 (&iter->message->body, iter->message->byte_order,
- iter->pos + 1, NULL);
+#if 0
+ /* FIXME 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 (contained_signature == NULL ||
+ _dbus_check_is_valid_signature (contained_signature));
+#endif
+
+ if (!_dbus_message_iter_open_signature (real))
+ return FALSE;
+
+ _dbus_string_init_const (&contained_str, contained_signature);
+
+ *real_sub = *real;
+ return _dbus_type_writer_recurse (&real->u.writer,
+ type,
+ &contained_str, 0,
+ &real_sub->u.writer);
}
+
/**
- * Returns the 32 bit unsigned integer value that an iterator may point to.
- * Note that you need to check that the iterator points to
- * an unsigned integer value before using this function.
+ * 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().
*
- * @see dbus_message_iter_get_arg_type
- * @param iter the message iter
- * @returns the integer
+ * @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
*/
-int
-dbus_message_iter_get_uint32 (DBusMessageIter *iter)
+dbus_bool_t
+dbus_message_iter_close_container (DBusMessageIter *iter,
+ DBusMessageIter *sub)
{
- _dbus_assert (dbus_message_iter_get_arg_type (iter) == DBUS_TYPE_UINT32);
-
- return _dbus_demarshal_uint32 (&iter->message->body, iter->message->byte_order,
- iter->pos + 1, NULL);
+ DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
+ DBusMessageRealIter *real_sub = (DBusMessageRealIter *)sub;
+ 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_message_iter_append_check (real_sub), FALSE);
+ _dbus_return_val_if_fail (real_sub->iter_type == DBUS_MESSAGE_ITER_TYPE_WRITER, FALSE);
+
+ ret = _dbus_type_writer_unrecurse (&real->u.writer,
+ &real_sub->u.writer);
+
+ if (!_dbus_message_iter_close_signature (real))
+ ret = FALSE;
+
+ return ret;
}
/**
- * 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.
+ * 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.
*
- * @see dbus_message_iter_get_arg_type
- * @param iter the message iter
- * @returns the double
+ * @param message the message
+ * @param no_reply #TRUE if no reply is desired
*/
-double
-dbus_message_iter_get_double (DBusMessageIter *iter)
+void
+dbus_message_set_no_reply (DBusMessage *message,
+ dbus_bool_t no_reply)
{
- _dbus_assert (dbus_message_iter_get_arg_type (iter) == DBUS_TYPE_DOUBLE);
-
- return _dbus_demarshal_double (&iter->message->body, iter->message->byte_order,
- iter->pos + 1, NULL);
+ _dbus_return_if_fail (message != NULL);
+ _dbus_return_if_fail (!message->locked);
+
+ _dbus_header_toggle_flag (&message->header,
+ DBUS_HEADER_FLAG_NO_REPLY_EXPECTED,
+ no_reply);
}
/**
- * 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.
+ * Returns #TRUE if the message does not expect
+ * a reply.
*
- * @param iter the iterator
- * @param value return location for the array
- * @param len return location for the array length
- * @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_boolean_array (DBusMessageIter *iter,
- unsigned char **value,
- int *len)
+dbus_message_get_no_reply (DBusMessage *message)
{
- _dbus_assert (dbus_message_iter_get_arg_type (iter) == DBUS_TYPE_BOOLEAN_ARRAY);
+ _dbus_return_val_if_fail (message != NULL, FALSE);
- if (!_dbus_demarshal_byte_array (&iter->message->body, iter->message->byte_order,
- iter->pos + 1, NULL, value, len))
- return FALSE;
- else
- return TRUE;
+ return _dbus_header_get_flag (&message->header,
+ DBUS_HEADER_FLAG_NO_REPLY_EXPECTED);
}
/**
- * 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.
+ * 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.
*
- * @param iter the iterator
- * @param value return location for the array
- * @param len return location for the array length
- * @returns #TRUE on success
+ * @param message the message
+ * @param auto_start #TRUE if auto-starting is desired
*/
-dbus_bool_t
-dbus_message_iter_get_int32_array (DBusMessageIter *iter,
- dbus_int32_t **value,
- int *len)
+void
+dbus_message_set_auto_start (DBusMessage *message,
+ dbus_bool_t auto_start)
{
- _dbus_assert (dbus_message_iter_get_arg_type (iter) == DBUS_TYPE_INT32_ARRAY);
+ _dbus_return_if_fail (message != NULL);
+ _dbus_return_if_fail (!message->locked);
- if (!_dbus_demarshal_int32_array (&iter->message->body, iter->message->byte_order,
- iter->pos + 1, NULL, value, len))
- return FALSE;
- else
- return TRUE;
+ _dbus_header_toggle_flag (&message->header,
+ DBUS_HEADER_FLAG_NO_AUTO_START,
+ !auto_start);
}
/**
- * 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.
+ * Returns #TRUE if the message will cause an owner for
+ * destination name to be auto-started.
*
- * @param iter the iterator
- * @param value return location for the array
- * @param len return location for the array length
- * @returns #TRUE on success
+ * @param message the message
+ * @returns #TRUE if the message will use auto-start
*/
dbus_bool_t
-dbus_message_iter_get_uint32_array (DBusMessageIter *iter,
- dbus_uint32_t **value,
- int *len)
+dbus_message_get_auto_start (DBusMessage *message)
{
- _dbus_assert (dbus_message_iter_get_arg_type (iter) == DBUS_TYPE_UINT32_ARRAY);
+ _dbus_return_val_if_fail (message != NULL, FALSE);
- if (!_dbus_demarshal_uint32_array (&iter->message->body, iter->message->byte_order,
- iter->pos + 1, NULL, value, len))
- return FALSE;
- else
- return TRUE;
+ return !_dbus_header_get_flag (&message->header,
+ DBUS_HEADER_FLAG_NO_AUTO_START);
}
+
/**
- * 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 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 iter the iterator
- * @param value return location for the array
- * @param len return location for the array length
- * @returns #TRUE on success
+ * @param message the message
+ * @param object_path the path or #NULL to unset
+ * @returns #FALSE if not enough memory
*/
dbus_bool_t
-dbus_message_iter_get_double_array (DBusMessageIter *iter,
- double **value,
- int *len)
+dbus_message_set_path (DBusMessage *message,
+ const char *object_path)
{
- _dbus_assert (dbus_message_iter_get_arg_type (iter) == DBUS_TYPE_DOUBLE_ARRAY);
+ _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);
- if (!_dbus_demarshal_double_array (&iter->message->body, iter->message->byte_order,
- iter->pos + 1, NULL, value, len))
- return FALSE;
- else
- return TRUE;
+ return set_or_delete_string_field (message,
+ DBUS_HEADER_FIELD_PATH,
+ DBUS_TYPE_OBJECT_PATH,
+ object_path);
}
/**
- * 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.
+ * 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 the iterator
- * @param value return location for array values
- * @param len return location for length of byte array
- * @returns #TRUE on success
+ * @param message the message
+ * @returns the path (should not be freed) or #NULL
*/
-dbus_bool_t
-dbus_message_iter_get_byte_array (DBusMessageIter *iter,
- unsigned char **value,
- int *len)
+const char*
+dbus_message_get_path (DBusMessage *message)
{
- _dbus_assert (dbus_message_iter_get_arg_type (iter) == DBUS_TYPE_BYTE_ARRAY);
+ const char *v;
- if (!_dbus_demarshal_byte_array (&iter->message->body, iter->message->byte_order,
- iter->pos + 1, NULL, value, len))
- return FALSE;
- else
- return TRUE;
+ _dbus_return_val_if_fail (message != NULL, NULL);
+
+ 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;
}
/**
- * Returns the string 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.
+ * 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().
*
- * 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().
+ * An empty but non-NULL path array means the path "/".
+ * So the path "/foo/bar" becomes { "foo", "bar", NULL }
+ * and the path "/" becomes { NULL }.
*
- * @param iter the iterator
- * @param value return location for string values
- * @param len return location for length of byte array
- * @returns #TRUE on success
+ * @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_get_string_array (DBusMessageIter *iter,
- char ***value,
- int *len)
+dbus_message_get_path_decomposed (DBusMessage *message,
+ char ***path)
{
- _dbus_assert (dbus_message_iter_get_arg_type (iter) == DBUS_TYPE_STRING_ARRAY);
+ const char *v;
- if (!_dbus_demarshal_string_array (&iter->message->body, iter->message->byte_order,
- iter->pos + 1, NULL, value, len))
- return FALSE;
- else
- return TRUE;
+ _dbus_return_val_if_fail (message != NULL, FALSE);
+ _dbus_return_val_if_fail (path != NULL, FALSE);
+
+ *path = NULL;
+
+ v = dbus_message_get_path (message);
+ if (v != NULL)
+ {
+ if (!_dbus_decompose_path (v, strlen (v),
+ path, NULL))
+ return FALSE;
+ }
+ return TRUE;
}
/**
- * Returns 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.
+ * 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 the iterator
- * @param dict return location for dict
- * @returns #TRUE on success
+ * @param message the message
+ * @param interface the interface or #NULL to unset
+ * @returns #FALSE if not enough memory
*/
dbus_bool_t
-dbus_message_iter_get_dict (DBusMessageIter *iter,
- DBusDict **dict)
+dbus_message_set_interface (DBusMessage *message,
+ const char *interface)
{
- _dbus_assert (dbus_message_iter_get_arg_type (iter) == DBUS_TYPE_DICT);
+ _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);
- if (!_dbus_demarshal_dict (&iter->message->body, iter->message->byte_order,
- iter->pos + 1, NULL, dict))
- return FALSE;
- else
- return TRUE;
+ return set_or_delete_string_field (message,
+ DBUS_HEADER_FIELD_INTERFACE,
+ DBUS_TYPE_STRING,
+ interface);
}
/**
- * Sets the message sender.
+ * 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 message the message
- * @param sender the sender
- * @returns #FALSE if not enough memory
+ * @returns the message interface (should not be freed) or #NULL
*/
-dbus_bool_t
-dbus_message_set_sender (DBusMessage *message,
- const char *sender)
+const char*
+dbus_message_get_interface (DBusMessage *message)
{
- _dbus_assert (!message->locked);
+ const char *v;
- if (sender == NULL)
- {
- delete_string_field (message, FIELD_SENDER);
- return TRUE;
- }
- else
- {
- return set_string_field (message,
- FIELD_SENDER,
- sender);
- }
+ _dbus_return_val_if_fail (message != NULL, NULL);
+
+ 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;
}
/**
- * Sets a flag indicating that the message is an error reply
- * message, i.e. an "exception" rather than a normal response.
+ * Sets the interface member being invoked
+ * (DBUS_MESSAGE_TYPE_METHOD_CALL) or emitted
+ * (DBUS_MESSAGE_TYPE_SIGNAL).
+ * The interface name is fully-qualified (namespaced).
*
* @param message the message
- * @param is_error_reply #TRUE if this is an error message.
+ * @param member the member or #NULL to unset
+ * @returns #FALSE if not enough memory
*/
-void
-dbus_message_set_is_error (DBusMessage *message,
- dbus_bool_t is_error_reply)
+dbus_bool_t
+dbus_message_set_member (DBusMessage *message,
+ const char *member)
{
- char *header;
-
- _dbus_assert (!message->locked);
-
- _dbus_string_get_data_len (&message->header, &header, 1, 1);
-
- if (is_error_reply)
- *header |= DBUS_HEADER_FLAG_ERROR;
- else
- *header &= ~DBUS_HEADER_FLAG_ERROR;
+ _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);
+
+ return set_or_delete_string_field (message,
+ DBUS_HEADER_FIELD_MEMBER,
+ DBUS_TYPE_STRING,
+ member);
}
/**
- * Returns #TRUE if the message is an error
- * reply to some previous message we sent.
+ * Gets the interface member being invoked
+ * (DBUS_MESSAGE_TYPE_METHOD_CALL) or emitted
+ * (DBUS_MESSAGE_TYPE_SIGNAL). Returns #NULL if none.
*
* @param message the message
- * @returns #TRUE if the message is an error
+ * @returns the member name (should not be freed) or #NULL
*/
-dbus_bool_t
-dbus_message_get_is_error (DBusMessage *message)
+const char*
+dbus_message_get_member (DBusMessage *message)
{
- const char *header;
+ const char *v;
- _dbus_string_get_const_data_len (&message->header, &header, 1, 1);
+ _dbus_return_val_if_fail (message != NULL, NULL);
- return (*header & DBUS_HEADER_FLAG_ERROR) != 0;
+ 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;
}
/**
- * Gets the service which originated this message,
- * or #NULL if unknown or inapplicable.
+ * Sets the name of the error (DBUS_MESSAGE_TYPE_ERROR).
+ * The name is fully-qualified (namespaced).
*
* @param message the message
- * @returns the service name or #NULL
+ * @param error_name the name or #NULL to unset
+ * @returns #FALSE if not enough memory
*/
-const char*
-dbus_message_get_sender (DBusMessage *message)
+dbus_bool_t
+dbus_message_set_error_name (DBusMessage *message,
+ const char *error_name)
{
- return get_string_field (message, FIELD_SENDER, NULL);
+ _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);
+
+ return set_or_delete_string_field (message,
+ DBUS_HEADER_FIELD_ERROR_NAME,
+ DBUS_TYPE_STRING,
+ error_name);
}
/**
- * Checks whether the message has the given name.
- * If the message has no name or has a different
- * name, returns #FALSE.
+ * Gets the error name (DBUS_MESSAGE_TYPE_ERROR only)
+ * or #NULL if none.
*
* @param message the message
- * @param name the name to check (must not be #NULL)
- *
- * @returns #TRUE if the message has the given name
+ * @returns the error name (should not be freed) or #NULL
*/
-dbus_bool_t
-dbus_message_name_is (DBusMessage *message,
- const char *name)
+const char*
+dbus_message_get_error_name (DBusMessage *message)
{
- const char *n;
+ const char *v;
- _dbus_assert (name != NULL);
-
- n = dbus_message_get_name (message);
+ _dbus_return_val_if_fail (message != NULL, NULL);
- if (n && strcmp (n, name) == 0)
- return TRUE;
- else
- return FALSE;
+ 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;
}
/**
- * Checks whether the message was sent to the given service. If the
- * message has no service specified or has a different name, returns
- * #FALSE.
+ * 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.
*
* @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 destination the destination name or #NULL to unset
+ * @returns #FALSE if not enough memory
*/
dbus_bool_t
-dbus_message_service_is (DBusMessage *message,
- const char *service)
+dbus_message_set_destination (DBusMessage *message,
+ const char *destination)
{
- const char *s;
+ _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);
- _dbus_assert (service != NULL);
-
- s = dbus_message_get_service (message);
-
- if (s && strcmp (s, service) == 0)
- return TRUE;
- else
- return FALSE;
+ return set_or_delete_string_field (message,
+ DBUS_HEADER_FIELD_DESTINATION,
+ DBUS_TYPE_STRING,
+ destination);
}
/**
- * 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.
+ * Gets the destination of a message or #NULL if there is none set.
*
* @param message the message
- * @param service the service to check (must not be #NULL)
- *
- * @returns #TRUE if the message has the given origin service
+ * @returns the message destination (should not be freed) or #NULL
*/
-dbus_bool_t
-dbus_message_sender_is (DBusMessage *message,
- const char *service)
+const char*
+dbus_message_get_destination (DBusMessage *message)
{
- const char *s;
+ const char *v;
- _dbus_assert (service != NULL);
-
- s = dbus_message_get_sender (message);
+ _dbus_return_val_if_fail (message != NULL, NULL);
- if (s && strcmp (s, service) == 0)
- return TRUE;
- else
- return FALSE;
+ 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;
}
-/** @} */
-
/**
- * @addtogroup DBusMessageInternals
+ * Sets the message sender.
*
- * @{
+ * @param message the message
+ * @param sender the sender or #NULL to unset
+ * @returns #FALSE if not enough memory
*/
+dbus_bool_t
+dbus_message_set_sender (DBusMessage *message,
+ const char *sender)
+{
+ _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);
+
+ return set_or_delete_string_field (message,
+ DBUS_HEADER_FIELD_SENDER,
+ DBUS_TYPE_STRING,
+ sender);
+}
+
/**
- * @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.
+ * 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.
*
- * @todo write tests for break-loader that a) randomly delete header
- * fields and b) set string fields to zero-length and other funky
- * values.
- *
+ * @param message the message
+ * @returns the unique name of the sender or #NULL
*/
+const char*
+dbus_message_get_sender (DBusMessage *message)
+{
+ const char *v;
-/* 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.
- */
+ _dbus_return_val_if_fail (message != NULL, NULL);
-/**
- * The maximum sane message size.
- */
-#define MAX_SANE_MESSAGE_SIZE (_DBUS_INT_MAX/16)
+ 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;
+}
/**
- * Implementation details of DBusMessageLoader.
- * All members are private.
+ * 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).
+ *
+ * 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).
+ *
+ * @param message the message
+ * @returns the type signature
*/
-struct DBusMessageLoader
+const char*
+dbus_message_get_signature (DBusMessage *message)
{
- int refcount; /**< Reference count. */
+ const DBusString *type_str;
+ int type_pos;
- DBusString data; /**< Buffered data */
-
- DBusList *messages; /**< Complete messages. */
-
- long max_message_size; /**< Maximum size of a message */
-
- unsigned int buffer_outstanding : 1; /**< Someone is using the buffer to read */
+ _dbus_return_val_if_fail (message != NULL, NULL);
- unsigned int corrupted : 1; /**< We got broken data, and are no longer working */
-};
+ get_const_signature (&message->header, &type_str, &type_pos);
-/**
- * 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
+ return _dbus_string_get_const_data_len (type_str, type_pos, 0);
+}
-/**
- * Creates a new message loader. Returns #NULL if memory can't
- * be allocated.
- *
- * @returns new loader, or #NULL.
- */
-DBusMessageLoader*
-_dbus_message_loader_new (void)
+static dbus_bool_t
+_dbus_message_has_type_interface_member (DBusMessage *message,
+ int type,
+ const char *interface,
+ const char *member)
{
- DBusMessageLoader *loader;
+ const char *n;
- loader = dbus_new0 (DBusMessageLoader, 1);
- if (loader == NULL)
- return NULL;
-
- loader->refcount = 1;
+ _dbus_assert (message != NULL);
+ _dbus_assert (interface != NULL);
+ _dbus_assert (member != NULL);
- /* Try to cap message size at something that won't *totally* hose
- * the system if we have a couple of them.
+ if (dbus_message_get_type (message) != type)
+ return FALSE;
+
+ /* Optimize by checking the short member name first
+ * instead of the longer interface name
*/
- loader->max_message_size = _DBUS_ONE_MEGABYTE * 32;
-
- if (!_dbus_string_init (&loader->data, _DBUS_INT_MAX))
+
+ n = dbus_message_get_member (message);
+
+ if (n && strcmp (n, member) == 0)
{
- dbus_free (loader);
- return NULL;
+ n = dbus_message_get_interface (message);
+
+ if (n == NULL || strcmp (n, interface) == 0)
+ return TRUE;
}
- /* 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;
+ return FALSE;
}
/**
- * Increments the reference count of the loader.
+ * 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 loader the loader.
+ * @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
*/
-void
-_dbus_message_loader_ref (DBusMessageLoader *loader)
-{
- loader->refcount += 1;
+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);
+ /* don't check that interface/method are valid since it would be
+ * expensive, and not catch many common errors
+ */
+
+ 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. If the
+ * interface field in the message is missing, it is assumed to match
+ * any interface you pass in to this function.
+ *
+ * @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);
+ /* don't check that interface/name are valid since it would be
+ * expensive, and not catch many common errors
+ */
+
+ 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.
+ *
+ * @param message the message
+ * @param error_name the name to check (must not be #NULL)
+ *
+ * @returns #TRUE if the message is the specified error
+ */
+dbus_bool_t
+dbus_message_is_error (DBusMessage *message,
+ const char *error_name)
+{
+ const char *n;
+
+ _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 (dbus_message_get_type (message) != DBUS_MESSAGE_TYPE_ERROR)
+ return FALSE;
+
+ n = dbus_message_get_error_name (message);
+
+ if (n && strcmp (n, error_name) == 0)
+ return TRUE;
+ else
+ return FALSE;
+}
+
+/**
+ * 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 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_has_destination (DBusMessage *message,
+ const char *name)
+{
+ const char *s;
+
+ _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
+ */
+
+ s = dbus_message_get_destination (message);
+
+ if (s && strcmp (s, name) == 0)
+ return TRUE;
+ else
+ return FALSE;
+}
+
+/**
+ * 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.
+ *
+ * Messages from the bus itself will have #DBUS_SERVICE_ORG_FREEDESKTOP_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_has_sender (DBusMessage *message,
+ const char *name)
+{
+ const char *s;
+
+ _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
+ */
+
+ s = dbus_message_get_sender (message);
+
+ if (s && strcmp (s, name) == 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.
+ *
+ * @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)
+{
+ const char *s;
+
+ _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
+ */
+
+ s = dbus_message_get_signature (message);
+
+ if (s && strcmp (s, signature) == 0)
+ return TRUE;
+ else
+ return FALSE;
+}
+
+/**
+ * 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.
+ *
+ * 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 dbus_message_get_is_error() returns #TRUE for the message
+ */
+dbus_bool_t
+dbus_set_error_from_message (DBusError *error,
+ DBusMessage *message)
+{
+ const 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);
+
+ return TRUE;
+}
+
+/** @} */
+
+/**
+ * @addtogroup DBusMessageInternals
+ *
+ * @{
+ */
+
+/**
+ * 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;
+
+ loader->corrupted = FALSE;
+ loader->corruption_reason = DBUS_VALID;
+
+ /* 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;
}
/**
* or reallocs.
*
* @todo we need to enforce a max length on strings in header fields.
- *
+ *
* @param loader the message loader.
* @param buffer the 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
-
-/** Pack four characters as in "abcd" into a uint32 */
-#define FOUR_CHARS_TO_UINT32(a, b, c, d) \
- ((((dbus_uint32_t)a) << 24) | \
- (((dbus_uint32_t)b) << 16) | \
- (((dbus_uint32_t)c) << 8) | \
- ((dbus_uint32_t)d))
-
-/** DBUS_HEADER_FIELD_NAME packed into a dbus_uint32_t */
-#define DBUS_HEADER_FIELD_NAME_AS_UINT32 \
- FOUR_CHARS_TO_UINT32 ('n', 'a', 'm', 'e')
-
-/** DBUS_HEADER_FIELD_SERVICE packed into a dbus_uint32_t */
-#define DBUS_HEADER_FIELD_SERVICE_AS_UINT32 \
- FOUR_CHARS_TO_UINT32 ('s', 'r', 'v', 'c')
-
-/** DBUS_HEADER_FIELD_REPLY packed into a dbus_uint32_t */
-#define DBUS_HEADER_FIELD_REPLY_AS_UINT32 \
- FOUR_CHARS_TO_UINT32 ('r', 'p', 'l', 'y')
-
-/** DBUS_HEADER_FIELD_SENDER Packed into a dbus_uint32_t */
-#define DBUS_HEADER_FIELD_SENDER_AS_UINT32 \
- FOUR_CHARS_TO_UINT32 ('s', 'n', 'd', 'r')
-
-/* FIXME impose max length on name, srvc, sndr */
-static dbus_bool_t
-decode_header_data (const DBusString *data,
- int header_len,
- int byte_order,
- HeaderField fields[FIELD_LAST],
- int *message_padding)
-{
- const char *field;
- int pos, new_pos;
- int i;
-
- if (header_len < 16)
- return FALSE;
-
- i = 0;
- while (i < FIELD_LAST)
- {
- fields[i].offset = -1;
- ++i;
- }
-
- fields[FIELD_HEADER_LENGTH].offset = 4;
- fields[FIELD_BODY_LENGTH].offset = 8;
- fields[FIELD_CLIENT_SERIAL].offset = 12;
-
- /* Now handle the named fields. A real named field is at least 4
- * bytes for the name, plus a type code (1 byte) plus padding. So
- * if we have less than 8 bytes left, it must be alignment padding,
- * not a field. While >= 8 bytes can't be entirely alignment
- * padding.
- */
- pos = 16;
- while ((pos + 7) < header_len)
- {
- pos = _DBUS_ALIGN_VALUE (pos, 4);
-
- if ((pos + 4) > header_len)
- return FALSE;
-
- _dbus_string_get_const_data_len (data, &field, pos, 4);
- pos += 4;
-
- _dbus_assert (_DBUS_ALIGN_ADDRESS (field, 4) == field);
- /* I believe FROM_BE is right, but if not we'll find out
- * I guess. ;-)
- */
- switch (DBUS_UINT32_FROM_BE (*(int*)field))
- {
- case DBUS_HEADER_FIELD_SERVICE_AS_UINT32:
- if (fields[FIELD_SERVICE].offset >= 0)
- {
- _dbus_verbose ("%s field provided twice\n",
- DBUS_HEADER_FIELD_SERVICE);
- return FALSE;
- }
-
- fields[FIELD_SERVICE].offset = _DBUS_ALIGN_VALUE (pos + 1, 4);
-#if 0
- _dbus_verbose ("Found service name at offset %d\n",
- fields[FIELD_SERVICE].offset);
-#endif
- break;
-
- case DBUS_HEADER_FIELD_NAME_AS_UINT32:
- if (fields[FIELD_NAME].offset >= 0)
- {
- _dbus_verbose ("%s field provided twice\n",
- DBUS_HEADER_FIELD_NAME);
- return FALSE;
- }
-
- fields[FIELD_NAME].offset = _DBUS_ALIGN_VALUE (pos + 1, 4);
-
-#if 0
- _dbus_verbose ("Found message name at offset %d\n",
- fields[FIELD_NAME].offset);
-#endif
- break;
- case DBUS_HEADER_FIELD_SENDER_AS_UINT32:
- if (fields[FIELD_SENDER].offset >= 0)
- {
- _dbus_verbose ("%s field provided twice\n",
- DBUS_HEADER_FIELD_SENDER);
- return FALSE;
- }
-
- fields[FIELD_SENDER].offset = _DBUS_ALIGN_VALUE (pos + 1, 4);
-
- _dbus_verbose ("Found sender name at offset %d\n",
- fields[FIELD_NAME].offset);
- break;
-
- case DBUS_HEADER_FIELD_REPLY_AS_UINT32:
- if (fields[FIELD_REPLY_SERIAL].offset >= 0)
- {
- _dbus_verbose ("%s field provided twice\n",
- DBUS_HEADER_FIELD_REPLY);
- return FALSE;
- }
-
- fields[FIELD_REPLY_SERIAL].offset = _DBUS_ALIGN_VALUE (pos + 1, 4);
-
- _dbus_verbose ("Found reply serial at offset %d\n",
- fields[FIELD_REPLY_SERIAL].offset);
- break;
-
- default:
- _dbus_verbose ("Ignoring an unknown header field: %c%c%c%c at offset %d\n",
- field[0], field[1], field[2], field[3], pos);
- }
-
- if (!_dbus_marshal_validate_arg (data, byte_order, pos, &new_pos))
- {
- _dbus_verbose ("Failed to validate argument to named header field\n");
- return FALSE;
- }
-
- if (new_pos > header_len)
- {
- _dbus_verbose ("Named header field tries to extend beyond header length\n");
- return FALSE;
- }
-
- pos = new_pos;
- }
-
- if (pos < header_len)
- {
- /* Alignment padding, verify that it's nul */
- _dbus_assert ((header_len - pos) < 8);
-
- if (!_dbus_string_validate_nul (data,
- pos, (header_len - pos)))
- {
- _dbus_verbose ("header alignment padding is not nul\n");
- return FALSE;
- }
- }
-
- if (fields[FIELD_NAME].offset < 0)
- {
- _dbus_verbose ("No %s field provided\n",
- DBUS_HEADER_FIELD_NAME);
- return FALSE;
- }
-
- if (message_padding)
- *message_padding = header_len - pos;
-
- return TRUE;
+ loader->buffer_outstanding = TRUE;
}
/**
loader->buffer_outstanding = FALSE;
}
-/**
- * Converts buffered data into messages.
+/*
+ * FIXME when we move the header out of the buffer, that memmoves all
+ * buffered messages. Kind of crappy.
*
- * @param loader the loader.
- * @returns #TRUE if we had enough memory to finish.
+ * 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.
+ *
+ * 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.
+ *
+ * Another approach would be to keep a "start" index into
+ * loader->data and only delete it occasionally, instead of after
+ * each message is loaded.
+ *
+ * load_message() returns FALSE if not enough memory OR the loader was corrupted
*/
-dbus_bool_t
-_dbus_message_loader_queue_messages (DBusMessageLoader *loader)
+static dbus_bool_t
+load_message (DBusMessageLoader *loader,
+ DBusMessage *message,
+ int byte_order,
+ int fields_array_len,
+ int header_len,
+ int body_len)
{
- if (loader->corrupted)
- return TRUE;
+ dbus_bool_t oom;
+ DBusValidity validity;
+ const DBusString *type_str;
+ int type_pos;
+ DBusValidationMode mode;
- while (_dbus_string_get_length (&loader->data) >= 16)
- {
- DBusMessage *message;
- const char *header_data;
- int byte_order, header_len, body_len, header_padding;
- dbus_uint32_t header_len_unsigned, body_len_unsigned;
-
- _dbus_string_get_const_data_len (&loader->data, &header_data, 0, 16);
+ mode = DBUS_VALIDATION_MODE_DATA_IS_UNTRUSTED;
+
+ oom = FALSE;
- _dbus_assert (_DBUS_ALIGN_ADDRESS (header_data, 4) == header_data);
+#if 0
+ _dbus_verbose_bytes_of_string (&loader->data, 0, header_len /* + body_len */);
+#endif
- if (header_data[2] != DBUS_MAJOR_PROTOCOL_VERSION)
+ /* 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));
+
+ 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);
+ if (validity == DBUS_VALID)
+ oom = TRUE;
+ else
{
- _dbus_verbose ("Message has protocol version %d ours is %d\n",
- (int) header_data[2], DBUS_MAJOR_PROTOCOL_VERSION);
loader->corrupted = TRUE;
- return TRUE;
+ loader->corruption_reason = validity;
}
-
- byte_order = header_data[0];
+ goto failed;
+ }
- 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;
- }
+ _dbus_assert (validity == DBUS_VALID);
- header_len_unsigned = _dbus_unpack_uint32 (byte_order, header_data + 4);
- body_len_unsigned = _dbus_unpack_uint32 (byte_order, header_data + 8);
+ message->byte_order = byte_order;
- if (header_len_unsigned < 16)
+ /* 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 ("Message had broken too-small header length %u\n",
- header_len_unsigned);
- loader->corrupted = TRUE;
- return TRUE;
- }
+ _dbus_verbose ("Failed to validate message body code %d\n", validity);
- 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;
+ loader->corruption_reason = validity;
+
+ goto failed;
}
+ }
- /* 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;
+ /* 3. COPY OVER BODY AND QUEUE MESSAGE */
- 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_list_append (&loader->messages, message))
+ {
+ _dbus_verbose ("Failed to append new message to loader queue\n");
+ oom = TRUE;
+ goto failed;
+ }
- if (_dbus_string_get_length (&loader->data) >= (header_len + body_len))
- {
- HeaderField fields[FIELD_LAST];
- int i;
- int next_arg;
+ _dbus_assert (_dbus_string_get_length (&message->body) == 0);
+ _dbus_assert (_dbus_string_get_length (&loader->data) >=
+ (header_len + body_len));
-#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,
- fields, &header_padding))
- {
- _dbus_verbose ("Header was invalid\n");
- loader->corrupted = TRUE;
- return TRUE;
- }
-
- next_arg = header_len;
- while (next_arg < (header_len + body_len))
- {
- int prev = next_arg;
+ if (!_dbus_string_copy_len (&loader->data, header_len, body_len, &message->body, 0))
+ {
+ _dbus_verbose ("Failed to move body into new message\n");
+ oom = TRUE;
+ goto failed;
+ }
- if (!_dbus_marshal_validate_arg (&loader->data,
- byte_order,
- next_arg,
- &next_arg))
- {
- loader->corrupted = TRUE;
- return TRUE;
- }
+ _dbus_string_delete (&loader->data, 0, header_len + body_len);
- _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;
- return TRUE;
- }
+ _dbus_assert (_dbus_string_get_length (&message->header.data) == header_len);
+ _dbus_assert (_dbus_string_get_length (&message->body) == body_len);
- message = dbus_message_new_empty_header ();
- if (message == NULL)
- return FALSE;
+ _dbus_verbose ("Loaded message %p\n", message);
- message->byte_order = byte_order;
- message->header_padding = header_padding;
-
- /* Copy in the offsets we found */
- i = 0;
- while (i < FIELD_LAST)
- {
- message->header_fields[i] = fields[i];
- ++i;
- }
-
- if (!_dbus_list_append (&loader->messages, message))
- {
- dbus_message_unref (message);
- return FALSE;
- }
+ _dbus_assert (!oom);
+ _dbus_assert (!loader->corrupted);
+ _dbus_assert (loader->messages != NULL);
+ _dbus_assert (_dbus_list_find_last (&loader->messages, message) != NULL);
- _dbus_assert (_dbus_string_get_length (&message->header) == 0);
- _dbus_assert (_dbus_string_get_length (&message->body) == 0);
+ return TRUE;
- _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_list_remove_last (&loader->messages, message);
- dbus_message_unref (message);
- return FALSE;
- }
-
- if (!_dbus_string_move_len (&loader->data, 0, body_len, &message->body, 0))
- {
- dbus_bool_t result;
+ failed:
+
+ /* Clean up */
+
+ /* does nothing if the message isn't in the list */
+ _dbus_list_remove_last (&loader->messages, message);
+
+ 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));
+
+ return FALSE;
+}
- /* put the header back, we'll try again later */
- result = _dbus_string_copy_len (&message->header, 0, header_len,
- &loader->data, 0);
- _dbus_assert (result); /* because DBusString never reallocs smaller */
+/**
+ * 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.
+ *
+ * @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) >= DBUS_MINIMUM_HEADER_SIZE)
+ {
+ DBusValidity validity;
+ int byte_order, fields_array_len, header_len, body_len;
+
+ 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)))
+ {
+ DBusMessage *message;
- _dbus_list_remove_last (&loader->messages, 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);
- return FALSE;
+ /* load_message() returns false if corrupted or OOM; if
+ * corrupted then return TRUE for not OOM
+ */
+ return loader->corrupted;
}
- _dbus_assert (_dbus_string_get_length (&message->header) == header_len);
- _dbus_assert (_dbus_string_get_length (&message->body) == body_len);
-
- /* Fill in caches */
- message->reply_serial = get_int_field (message,
- FIELD_REPLY_SERIAL);
- message->client_serial = get_int_field (message,
- FIELD_CLIENT_SERIAL);
-
- _dbus_verbose ("Loaded message %p\n", message);
+ _dbus_assert (loader->messages != NULL);
+ _dbus_assert (_dbus_list_find_last (&loader->messages, message) != NULL);
}
else
- return TRUE;
+ {
+ _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;
+ }
}
return TRUE;
}
/**
+ * 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.
dbus_bool_t
_dbus_message_loader_get_is_corrupted (DBusMessageLoader *loader)
{
+ _dbus_assert ((loader->corrupted && loader->corruption_reason != DBUS_VALID) ||
+ (!loader->corrupted && loader->corruption_reason == DBUS_VALID));
return loader->corrupted;
}
_dbus_message_loader_set_max_message_size (DBusMessageLoader *loader,
long size)
{
- if (size > MAX_SANE_MESSAGE_SIZE)
+ if (size > DBUS_MAXIMUM_MESSAGE_LENGTH)
{
_dbus_verbose ("clamping requested max message size %ld to %d\n",
- size, MAX_SANE_MESSAGE_SIZE);
- size = MAX_SANE_MESSAGE_SIZE;
+ size, DBUS_MAXIMUM_MESSAGE_LENGTH);
+ size = DBUS_MAXIMUM_MESSAGE_LENGTH;
}
loader->max_message_size = size;
}
return loader->max_message_size;
}
-/** @} */
-#ifdef DBUS_BUILD_TESTS
-#include "dbus-test.h"
-#include <stdio.h>
-
-static void
-message_iter_test (DBusMessage *message)
-{
- DBusMessageIter *iter;
- char *str;
-
- iter = dbus_message_get_args_iter (message);
-
- /* 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 ("Didn't reach end of arguments");
-
- dbus_message_iter_unref (iter);
-}
-
-static dbus_bool_t
-check_message_handling (DBusMessage *message)
-{
- DBusMessageIter *iter;
- int type;
- dbus_bool_t retval;
- dbus_int32_t client_serial;
-
- retval = FALSE;
- iter = NULL;
-
- client_serial = dbus_message_get_serial (message);
-
- /* can't use set_serial due to the assertions at the start of it */
- set_int_field (message, FIELD_CLIENT_SERIAL,
- 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
- */
-
- iter = dbus_message_get_args_iter (message);
- while ((type = dbus_message_iter_get_arg_type (iter)) != DBUS_TYPE_INVALID)
- {
- switch (type)
- {
- case DBUS_TYPE_NIL:
- 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_DOUBLE:
- dbus_message_iter_get_double (iter);
- break;
- case DBUS_TYPE_STRING:
- {
- char *str;
- str = dbus_message_iter_get_string (iter);
- dbus_free (str);
- }
- break;
- case DBUS_TYPE_BOOLEAN_ARRAY:
- {
- unsigned char *values;
- int len;
-
- if (!dbus_message_iter_get_boolean_array (iter, &values, &len))
- return FALSE;
-
- dbus_free (values);
- }
- break;
- case DBUS_TYPE_INT32_ARRAY:
- {
- dbus_int32_t *values;
- int len;
-
- if (!dbus_message_iter_get_int32_array (iter, &values, &len))
- return FALSE;
-
- dbus_free (values);
- }
- break;
- case DBUS_TYPE_UINT32_ARRAY:
- {
- dbus_uint32_t *values;
- int len;
-
- if (!dbus_message_iter_get_uint32_array (iter, &values, &len))
- return FALSE;
-
- dbus_free (values);
- }
- break;
- case DBUS_TYPE_DOUBLE_ARRAY:
- {
- double *values;
- int len;
-
- if (!dbus_message_iter_get_double_array (iter, &values, &len))
- return FALSE;
-
- dbus_free (values);
- }
- break;
- case DBUS_TYPE_STRING_ARRAY:
- {
- char **values;
- int len;
-
- if (!dbus_message_iter_get_string_array (iter, &values, &len))
- return FALSE;
-
- dbus_free_string_array (values);
- }
- break;
-
- case DBUS_TYPE_DICT:
- {
- DBusDict *dict;
-
- if (!dbus_message_iter_get_dict (iter, &dict))
- return FALSE;
- dbus_dict_unref (dict);
- }
- break;
-
- default:
- break;
- }
-
- if (!dbus_message_iter_next (iter))
- break;
- }
-
- retval = TRUE;
-
- failed:
- if (iter)
- dbus_message_iter_unref (iter);
-
- 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");
- goto failed;
- }
-
- retval = TRUE;
-
- failed:
- return retval;
-}
-
-static dbus_bool_t
-check_incomplete_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 (but incomplete)\n");
- goto failed;
- }
-
- message = _dbus_message_loader_pop_message (loader);
- if (message != NULL)
- {
- _dbus_warn ("loaded message that was expected to be incomplete\n");
- goto failed;
- }
-
- retval = 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");
-
- 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;
- }
-
- _dbus_assert_not_reached ("bad DBusMessageValidity");
- return FALSE;
-}
-
+static DBusDataSlotAllocator slot_allocator;
+_DBUS_DEFINE_GLOBAL_LOCK (message_slots);
/**
- * Loads the message in the given message file.
+ * 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 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
+ * @param slot_p address of a global variable storing the slot
+ * @returns #FALSE on failure (no memory)
*/
dbus_bool_t
-dbus_internal_do_not_use_load_message_file (const DBusString *filename,
- dbus_bool_t is_raw,
- DBusString *data)
+dbus_message_allocate_data_slot (dbus_int32_t *slot_p)
{
- dbus_bool_t retval;
-
- retval = FALSE;
-
- if (is_raw)
- {
- DBusError error;
-
- dbus_error_init (&error);
- if (!_dbus_file_get_contents (data, filename, &error))
- {
- const char *s;
- _dbus_string_get_const_data (filename, &s);
- _dbus_warn ("Could not load message file %s: %s\n", s, error.message);
- dbus_error_free (&error);
- goto failed;
- }
- }
- else
- {
- if (!_dbus_message_data_load (data, filename))
- {
- const char *s;
- _dbus_string_get_const_data (filename, &s);
- _dbus_warn ("Could not load message file %s\n", s);
- goto failed;
- }
- }
-
- retval = TRUE;
-
- failed:
-
- return retval;
+ return _dbus_data_slot_allocator_alloc (&slot_allocator,
+ _DBUS_LOCK_NAME (message_slots),
+ slot_p);
}
/**
- * Tries loading the message in the given message file
- * and verifies that DBusMessageLoader can handle it.
+ * 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 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 slot_p address storing the slot to deallocate
*/
-dbus_bool_t
-dbus_internal_do_not_use_try_message_file (const DBusString *filename,
- dbus_bool_t is_raw,
- DBusMessageValidity expected_validity)
+void
+dbus_message_free_data_slot (dbus_int32_t *slot_p)
{
- DBusString data;
- dbus_bool_t retval;
-
- retval = FALSE;
-
- if (!_dbus_string_init (&data, _DBUS_INT_MAX))
- _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);
+ _dbus_return_if_fail (*slot_p >= 0);
- failed:
-
- if (!retval)
- {
- const char *s;
-
- if (_dbus_string_get_length (&data) > 0)
- _dbus_verbose_bytes_of_string (&data, 0,
- _dbus_string_get_length (&data));
-
- _dbus_string_get_const_data (filename, &s);
- _dbus_warn ("Failed message loader test on %s\n",
- s);
- }
-
- _dbus_string_free (&data);
-
- return retval;
+ _dbus_data_slot_allocator_free (&slot_allocator, slot_p);
}
/**
- * Tries loading the given message 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 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 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_internal_do_not_use_try_message_data (const DBusString *data,
- DBusMessageValidity expected_validity)
+dbus_message_set_data (DBusMessage *message,
+ dbus_int32_t slot,
+ void *data,
+ DBusFreeFunction free_data_func)
{
- DBusMessageLoader *loader;
+ DBusFreeFunction old_free_func;
+ void *old_data;
dbus_bool_t retval;
- int len;
- int i;
- loader = NULL;
- retval = FALSE;
+ _dbus_return_val_if_fail (message != NULL, FALSE);
+ _dbus_return_val_if_fail (slot >= 0, FALSE);
- /* Write the data one byte at a time */
-
- loader = _dbus_message_loader_new ();
+ retval = _dbus_data_slot_list_set (&slot_allocator,
+ &message->slot_list,
+ slot, data, free_data_func,
+ &old_free_func, &old_data);
- len = _dbus_string_get_length (data);
- for (i = 0; i < len; i++)
+ if (retval)
{
- 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);
+ /* Do the actual free outside the message lock */
+ if (old_free_func)
+ (* old_free_func) (old_data);
}
-
- 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 ();
-
- {
- 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;
-
- _dbus_message_loader_unref (loader);
- loader = NULL;
-
- /* Write the data 2 bytes at a time */
-
- loader = _dbus_message_loader_new ();
- 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;
-
- _dbus_message_loader_unref (loader);
- loader = NULL;
-
- retval = TRUE;
-
- failed:
-
- if (loader)
- _dbus_message_loader_unref (loader);
-
return retval;
}
-static dbus_bool_t
-process_test_subdir (const DBusString *test_base_dir,
- const char *subdir,
- DBusMessageValidity validity,
- DBusForeachMessageFileFunc function,
- void *user_data)
-{
- DBusString test_directory;
- DBusString filename;
- DBusDirIter *dir;
- dbus_bool_t retval;
- DBusError error;
-
- retval = FALSE;
- dir = NULL;
-
- if (!_dbus_string_init (&test_directory, _DBUS_INT_MAX))
- _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_INT_MAX))
- _dbus_assert_not_reached ("didn't allocate filename string\n");
-
- dbus_error_init (&error);
- dir = _dbus_directory_open (&test_directory, &error);
- if (dir == NULL)
- {
- const char *s;
- _dbus_string_get_const_data (&test_directory, &s);
- _dbus_warn ("Could not open %s: %s\n", s,
- error.message);
- dbus_error_free (&error);
- goto failed;
- }
-
- printf ("Testing:\n");
-
- 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_INT_MAX))
- _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
- {
- const char *filename_c;
- _dbus_string_get_const_data (&filename, &filename_c);
- _dbus_verbose ("Skipping non-.message file %s\n",
- filename_c);
- _dbus_string_free (&full_path);
- goto next;
- }
-
- {
- const char *s;
- _dbus_string_get_const_data (&filename, &s);
- printf (" %s\n", s);
- }
-
- _dbus_verbose (" expecting %s\n",
- validity == _DBUS_MESSAGE_VALID ? "valid" :
- (validity == _DBUS_MESSAGE_INVALID ? "invalid" :
- (validity == _DBUS_MESSAGE_INCOMPLETE ? "incomplete" : "unknown")));
-
- if (! (*function) (&full_path, is_raw, validity, user_data))
- {
- _dbus_string_free (&full_path);
- goto failed;
- }
- else
- _dbus_string_free (&full_path);
- }
-
- if (dbus_error_is_set (&error))
- {
- const char *s;
- _dbus_string_get_const_data (&test_directory, &s);
- _dbus_warn ("Could not get next file in %s: %s\n",
- s, error.message);
- dbus_error_free (&error);
- goto failed;
- }
-
- 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)
-{
- dbus_int32_t our_int;
- char *our_str;
- double our_double;
- dbus_bool_t our_bool;
-
- if (!dbus_message_get_args (message, NULL,
- DBUS_TYPE_INT32, &our_int,
- DBUS_TYPE_STRING, &our_str,
- DBUS_TYPE_DOUBLE, &our_double,
- DBUS_TYPE_BOOLEAN, &our_bool,
- 0))
- _dbus_assert_not_reached ("Could not get arguments");
-
- if (our_int != -0x12345678)
- _dbus_assert_not_reached ("integers differ!");
-
- if (our_double != 3.14159)
- _dbus_assert_not_reached ("doubles differ!");
-
- if (strcmp (our_str, "Test string") != 0)
- _dbus_assert_not_reached ("strings differ!");
-
- if (!our_bool)
- _dbus_assert_not_reached ("booleans differ");
-
- dbus_free (our_str);
+/**
+ * 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;
}
/**
- * @ingroup DBusMessageInternals
- * Unit test for DBusMessage.
+ * 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
*
- * @returns #TRUE on success.
*/
-dbus_bool_t
-_dbus_message_test (const char *test_data_dir)
+const char *
+dbus_message_type_to_string (int type)
{
- DBusMessage *message;
- DBusMessageLoader *loader;
- int i;
- const char *data;
- DBusMessage *copy;
- const char *name1;
- const char *name2;
-
- /* Test the vararg functions */
- message = dbus_message_new ("org.freedesktop.DBus.Test", "testMessage");
- _dbus_message_set_serial (message, 1);
- dbus_message_append_args (message,
- DBUS_TYPE_INT32, -0x12345678,
- DBUS_TYPE_STRING, "Test string",
- DBUS_TYPE_DOUBLE, 3.14159,
- DBUS_TYPE_BOOLEAN, TRUE,
- 0);
- _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));
-
- verify_test_message (message);
-
- 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_assert (_dbus_string_get_length (&message->body) ==
- _dbus_string_get_length (©->body));
-
- verify_test_message (copy);
-
- name1 = dbus_message_get_name (message);
- name2 = dbus_message_get_name (copy);
-
- _dbus_assert (strcmp (name1, name2) == 0);
-
- dbus_message_unref (message);
- dbus_message_unref (copy);
-
- message = dbus_message_new ("org.freedesktop.DBus.Test", "testMessage");
- _dbus_message_set_serial (message, 1);
- dbus_message_set_reply_serial (message, 0x12345678);
-
- dbus_message_append_string (message, "Test string");
- dbus_message_append_int32 (message, -0x12345678);
- dbus_message_append_uint32 (message, 0xedd1e);
- dbus_message_append_double (message, 3.14159);
-
- message_iter_test (message);
-
- /* Message loader test */
- _dbus_message_lock (message);
- loader = _dbus_message_loader_new ();
-
- /* Write the header data one byte at a time */
- _dbus_string_get_const_data (&message->header, &data);
- 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);
- }
-
- /* Write the body data one byte at a time */
- _dbus_string_get_const_data (&message->body, &data);
- for (i = 0; i < _dbus_string_get_length (&message->body); i++)
+ switch (type)
{
- DBusString *buffer;
-
- _dbus_message_loader_get_buffer (loader, &buffer);
- _dbus_string_append_byte (buffer, data[i]);
- _dbus_message_loader_return_buffer (loader, buffer, 1);
+ 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";
}
-
- 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);
-
- /* 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 */
projects / platform / upstream / dbus.git / blobdiff