fdo-mirrors/dbus
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/dbus/dbus.git synced 2026-01-26 05:00:27 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
dbus/dbus/dbus-marshal-basic.c
Ralf Habacker 2dee523608 Add SPDX license marker for the AFL-2.1 OR GPL-2.0-or-later license 
The full license texts are not added because they were already
added in a previous commit.

Signed-off-by: Ralf Habacker <ralf.habacker@freenet.de>

see #394
2023-01-04 07:53:44 +00:00

1993 lines
64 KiB
C
Raw Blame History

/* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
/* dbus-marshal-basic.c Marshalling routines for basic (primitive) types
*
* Copyright (C) 2002 CodeFactory AB
* Copyright (C) 2003, 2004, 2005 Red Hat, Inc.
*
* SPDX-License-Identifier: AFL-2.1 OR GPL-2.0-or-later
*
* 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
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*
*/
#include <config.h>
#include "dbus-internals.h"
#include "dbus-marshal-basic.h"
#include "dbus-signature.h"
#include <dbus/dbus-test-tap.h>
#include <string.h>
#define _DBUS_ASSERT_ALIGNMENT(type, op, val) \
_DBUS_STATIC_ASSERT (_DBUS_ALIGNOF (type) op val)
#define _DBUS_ASSERT_CMP_ALIGNMENT(left, op, right) \
_DBUS_STATIC_ASSERT (_DBUS_ALIGNOF (left) op _DBUS_ALIGNOF (right))
/* True by definition, but just for completeness... */
_DBUS_STATIC_ASSERT (sizeof (char) == 1);
_DBUS_ASSERT_ALIGNMENT (char, ==, 1);
_DBUS_STATIC_ASSERT (sizeof (dbus_int16_t) == 2);
_DBUS_ASSERT_ALIGNMENT (dbus_int16_t, <=, 2);
_DBUS_STATIC_ASSERT (sizeof (dbus_uint16_t) == 2);
_DBUS_ASSERT_ALIGNMENT (dbus_uint16_t, <=, 2);
_DBUS_ASSERT_CMP_ALIGNMENT (dbus_uint16_t, ==, dbus_int16_t);
_DBUS_STATIC_ASSERT (sizeof (dbus_int32_t) == 4);
_DBUS_ASSERT_ALIGNMENT (dbus_int32_t, <=, 4);
_DBUS_STATIC_ASSERT (sizeof (dbus_uint32_t) == 4);
_DBUS_ASSERT_ALIGNMENT (dbus_uint32_t, <=, 4);
_DBUS_ASSERT_CMP_ALIGNMENT (dbus_uint32_t, ==, dbus_int32_t);
_DBUS_STATIC_ASSERT (sizeof (dbus_bool_t) == 4);
_DBUS_ASSERT_ALIGNMENT (dbus_bool_t, <=, 4);
_DBUS_ASSERT_CMP_ALIGNMENT (dbus_uint32_t, ==, dbus_bool_t);
_DBUS_STATIC_ASSERT (sizeof (double) == 8);
_DBUS_ASSERT_ALIGNMENT (double, <=, 8);
/* Doubles might sometimes be more strictly aligned than int64, but we
* assume they are no less strictly aligned. This means every (double *)
* has enough alignment to be treated as though it was a
* (dbus_uint64_t *). */
_DBUS_ASSERT_CMP_ALIGNMENT (dbus_uint64_t, <=, double);
_DBUS_STATIC_ASSERT (sizeof (dbus_int64_t) == 8);
_DBUS_ASSERT_ALIGNMENT (dbus_int64_t, <=, 8);
_DBUS_STATIC_ASSERT (sizeof (dbus_uint64_t) == 8);
_DBUS_ASSERT_ALIGNMENT (dbus_uint64_t, <=, 8);
_DBUS_ASSERT_CMP_ALIGNMENT (dbus_uint64_t, ==, dbus_int64_t);
_DBUS_STATIC_ASSERT (sizeof (DBusBasicValue) >= 8);
/* The alignment of a DBusBasicValue might conceivably be > 8 because of the
* pointer, so we don't assert about it */
_DBUS_STATIC_ASSERT (sizeof (DBus8ByteStruct) == 8);
_DBUS_ASSERT_ALIGNMENT (DBus8ByteStruct, <=, 8);
/**
* @defgroup DBusMarshal marshaling and unmarshaling
* @ingroup DBusInternals
* @brief functions to marshal/unmarshal data from the wire
*
* Types and functions related to converting primitive data types from
* wire format to native machine format, and vice versa.
*
* A signature is just a string with multiple types one after the other.
* for example a type is "i" or "(ii)", a signature is "i(ii)"
* where i is int and (ii) is struct { int; int; }
*
* @{
*/
static void
pack_2_octets (dbus_uint16_t value,
int byte_order,
void *data)
{
_dbus_assert (_DBUS_ALIGN_ADDRESS (data, 2) == data);
if ((byte_order) == DBUS_LITTLE_ENDIAN)
*((dbus_uint16_t*)(data)) = DBUS_UINT16_TO_LE (value);
else
*((dbus_uint16_t*)(data)) = DBUS_UINT16_TO_BE (value);
}
static void
pack_4_octets (dbus_uint32_t value,
int byte_order,
void *data)
{
_dbus_assert (_DBUS_ALIGN_ADDRESS (data, 4) == data);
if ((byte_order) == DBUS_LITTLE_ENDIAN)
*((dbus_uint32_t*)(data)) = DBUS_UINT32_TO_LE (value);
else
*((dbus_uint32_t*)(data)) = DBUS_UINT32_TO_BE (value);
}
static void
pack_8_octets (dbus_uint64_t value,
int byte_order,
void *data)
{
_dbus_assert (_DBUS_ALIGN_ADDRESS (data, 8) == data);
if ((byte_order) == DBUS_LITTLE_ENDIAN)
*((dbus_uint64_t*)(data)) = DBUS_UINT64_TO_LE (value);
else
*((dbus_uint64_t*)(data)) = DBUS_UINT64_TO_BE (value);
}
/**
* Packs a 32 bit unsigned integer into a data pointer.
*
* @param value the value
* @param byte_order the byte order to use
* @param data the data pointer
*/
void
_dbus_pack_uint32 (dbus_uint32_t value,
int byte_order,
unsigned char *data)
{
pack_4_octets (value, byte_order, data);
}
static void
swap_8_octets (dbus_uint64_t *value,
int byte_order)
{
if (byte_order != DBUS_COMPILER_BYTE_ORDER)
{
*value = DBUS_UINT64_SWAP_LE_BE (*value);
}
}
#ifndef _dbus_unpack_uint16
/**
* Unpacks a 16 bit unsigned integer from a data pointer
*
* @param byte_order The byte order to use
* @param data the data pointer
* @returns the integer
*/
dbus_uint16_t
_dbus_unpack_uint16 (int byte_order,
const unsigned char *data)
{
_dbus_assert (_DBUS_ALIGN_ADDRESS (data, 2) == data);
if (byte_order == DBUS_LITTLE_ENDIAN)
return DBUS_UINT16_FROM_LE (*(dbus_uint16_t *) (void *) data);
else
return DBUS_UINT16_FROM_BE (*(dbus_uint16_t *) (void *) data);
}
#endif /* _dbus_unpack_uint16 */
#ifndef _dbus_unpack_uint32
/**
* Unpacks a 32 bit unsigned integer from a data pointer
*
* @param byte_order The byte order to use
* @param data the data pointer
* @returns the integer
*/
dbus_uint32_t
_dbus_unpack_uint32 (int byte_order,
const unsigned char *data)
{
_dbus_assert (_DBUS_ALIGN_ADDRESS (data, 4) == data);
if (byte_order == DBUS_LITTLE_ENDIAN)
return DBUS_UINT32_FROM_LE (*(dbus_uint32_t *) (void *) data);
else
return DBUS_UINT32_FROM_BE (*(dbus_uint32_t *) (void *) data);
}
#endif /* _dbus_unpack_uint32 */
static void
set_2_octets (DBusString *str,
int offset,
dbus_uint16_t value,
int byte_order)
{
char *data;
_dbus_assert (byte_order == DBUS_LITTLE_ENDIAN ||
byte_order == DBUS_BIG_ENDIAN);
data = _dbus_string_get_data_len (str, offset, 2);
pack_2_octets (value, byte_order, (unsigned char *) data);
}
static void
set_4_octets (DBusString *str,
int offset,
dbus_uint32_t value,
int byte_order)
{
char *data;
_dbus_assert (byte_order == DBUS_LITTLE_ENDIAN ||
byte_order == DBUS_BIG_ENDIAN);
data = _dbus_string_get_data_len (str, offset, 4);
pack_4_octets (value, byte_order, (unsigned char *) data);
}
static void
set_8_octets (DBusString *str,
int offset,
dbus_uint64_t value,
int byte_order)
{
char *data;
_dbus_assert (byte_order == DBUS_LITTLE_ENDIAN ||
byte_order == DBUS_BIG_ENDIAN);
data = _dbus_string_get_data_len (str, offset, 8);
pack_8_octets (value, byte_order, (unsigned char *) data);
}
/**
* Sets the 4 bytes at the given offset to a marshaled unsigned
* integer, replacing anything found there previously.
*
* @param str the string to write the marshalled int to
* @param pos the byte offset where int should be written
* @param value the value
* @param byte_order the byte order to use
*
*/
void
_dbus_marshal_set_uint32 (DBusString *str,
int pos,
dbus_uint32_t value,
int byte_order)
{
set_4_octets (str, pos, value, byte_order);
}
/**
* Sets the existing marshaled string at the given offset with
* a new marshaled string. The given offset must point to
* an existing string or the wrong length will be deleted
* and replaced with the new string.
*
* Note: no attempt is made by this function to re-align
* any data which has been already marshalled after this
* string. Use with caution.
*
* @param str the string to write the marshalled string to
* @param pos the position of the marshaled string length
* @param value the value
* @param byte_order the byte order to use
* @param old_end_pos place to store byte after the nul byte of the old value
* @param new_end_pos place to store byte after the nul byte of the new value
* @returns #TRUE on success, #FALSE if no memory
*
*/
static dbus_bool_t
set_string (DBusString *str,
int pos,
const char *value,
int byte_order,
int *old_end_pos,
int *new_end_pos)
{
int old_len, new_len;
DBusString dstr;
_dbus_string_init_const (&dstr, value);
_dbus_assert (_DBUS_ALIGN_VALUE (pos, 4) == (unsigned) pos);
old_len = _dbus_unpack_uint32 (byte_order,
_dbus_string_get_const_udata_len (str, pos, 4));
new_len = _dbus_string_get_length (&dstr);
if (!_dbus_string_replace_len (&dstr, 0, new_len,
str, pos + 4, old_len))
return FALSE;
_dbus_marshal_set_uint32 (str, pos, new_len, byte_order);
if (old_end_pos)
*old_end_pos = pos + 4 + old_len + 1;
if (new_end_pos)
*new_end_pos = pos + 4 + new_len + 1;
return TRUE;
}
/**
* Sets the existing marshaled signature at the given offset to a new
* marshaled signature. Same basic ideas as set_string().
*
* @param str the string to write the marshalled signature to
* @param pos the position of the marshaled signature length
* @param value the value
* @param byte_order the byte order to use
* @param old_end_pos place to store byte after the nul byte of the old value
* @param new_end_pos place to store byte after the nul byte of the new value
* @returns #TRUE on success, #FALSE if no memory
*
*/
static dbus_bool_t
set_signature (DBusString *str,
int pos,
const char *value,
int byte_order,
int *old_end_pos,
int *new_end_pos)
{
int old_len, new_len;
DBusString dstr;
_dbus_string_init_const (&dstr, value);
old_len = _dbus_string_get_byte (str, pos);
new_len = _dbus_string_get_length (&dstr);
if (!_dbus_string_replace_len (&dstr, 0, new_len,
str, pos + 1, old_len))
return FALSE;
_dbus_string_set_byte (str, pos, new_len);
if (old_end_pos)
*old_end_pos = pos + 1 + old_len + 1;
if (new_end_pos)
*new_end_pos = pos + 1 + new_len + 1;
return TRUE;
}
/**
* Sets an existing basic type value to a new value.
* Arguments work the same way as _dbus_marshal_basic_type().
*
* @param str the string
* @param pos location of the current value
* @param type the type of the current and new values
* @param value the address of the new value
* @param byte_order byte order for marshaling
* @param old_end_pos location to store end position of the old value, or #NULL
* @param new_end_pos location to store end position of the new value, or #NULL
* @returns #FALSE if no memory
*/
dbus_bool_t
_dbus_marshal_set_basic (DBusString *str,
int pos,
int type,
const void *value,
int byte_order,
int *old_end_pos,
int *new_end_pos)
{
/* Static assertions near the top of this file assert that signed and
* unsigned 16- and 32-bit quantities have the same alignment, and that
* doubles have alignment at least as strict as unsigned int64, so we
* don't have to distinguish further: every (double *)
* has strong enough alignment to be treated as though it was a
* (dbus_uint64_t *). Going via a (void *) means the compiler should
* know that pointers can alias each other. */
const unsigned char *u8_p;
const dbus_uint16_t *u16_p;
const dbus_uint32_t *u32_p;
const dbus_uint64_t *u64_p;
const char * const *string_p;
switch (type)
{
case DBUS_TYPE_BYTE:
u8_p = value;
_dbus_string_set_byte (str, pos, *u8_p);
if (old_end_pos)
*old_end_pos = pos + 1;
if (new_end_pos)
*new_end_pos = pos + 1;
return TRUE;
break;
case DBUS_TYPE_INT16:
case DBUS_TYPE_UINT16:
u16_p = value;
pos = _DBUS_ALIGN_VALUE (pos, 2);
set_2_octets (str, pos, *u16_p, byte_order);
if (old_end_pos)
*old_end_pos = pos + 2;
if (new_end_pos)
*new_end_pos = pos + 2;
return TRUE;
break;
case DBUS_TYPE_BOOLEAN:
case DBUS_TYPE_INT32:
case DBUS_TYPE_UINT32:
case DBUS_TYPE_UNIX_FD:
u32_p = value;
pos = _DBUS_ALIGN_VALUE (pos, 4);
set_4_octets (str, pos, *u32_p, byte_order);
if (old_end_pos)
*old_end_pos = pos + 4;
if (new_end_pos)
*new_end_pos = pos + 4;
return TRUE;
break;
case DBUS_TYPE_INT64:
case DBUS_TYPE_UINT64:
case DBUS_TYPE_DOUBLE:
u64_p = value;
pos = _DBUS_ALIGN_VALUE (pos, 8);
set_8_octets (str, pos, *u64_p, byte_order);
if (old_end_pos)
*old_end_pos = pos + 8;
if (new_end_pos)
*new_end_pos = pos + 8;
return TRUE;
break;
case DBUS_TYPE_STRING:
case DBUS_TYPE_OBJECT_PATH:
string_p = value;
pos = _DBUS_ALIGN_VALUE (pos, 4);
_dbus_assert (*string_p != NULL);
return set_string (str, pos, *string_p, byte_order,
old_end_pos, new_end_pos);
break;
case DBUS_TYPE_SIGNATURE:
string_p = value;
_dbus_assert (*string_p != NULL);
return set_signature (str, pos, *string_p, byte_order,
old_end_pos, new_end_pos);
break;
default:
_dbus_assert_not_reached ("not a basic type");
return FALSE;
break;
}
}
/**
* Convenience function to demarshal a 32 bit unsigned integer.
*
* @param str the string containing the data
* @param byte_order the byte order
* @param pos the position in the string
* @param new_pos the new position of the string
* @returns the demarshaled integer.
*/
dbus_uint32_t
_dbus_marshal_read_uint32 (const DBusString *str,
int pos,
int byte_order,
int *new_pos)
{
pos = _DBUS_ALIGN_VALUE (pos, 4);
if (new_pos)
*new_pos = pos + 4;
_dbus_assert (pos + 4 <= _dbus_string_get_length (str));
return _dbus_unpack_uint32 (byte_order,
_dbus_string_get_const_udata (str) + pos);
}
/**
* Demarshals a basic-typed value. The "value" pointer is always
* the address of a variable of the basic type. So e.g.
* if the basic type is "double" then the pointer is
* a double*, and if it's "char*" then the pointer is
* a "char**".
*
* A value of type #DBusBasicValue is guaranteed to be large enough to
* hold any of the types that may be returned, which is handy if you
* are trying to do things generically. For example you can pass
* a DBusBasicValue* in to this function, and then pass the same
* DBusBasicValue* in to _dbus_marshal_basic_type() in order to
* move a value from one place to another.
*
* @param str the string containing the data
* @param pos position in the string
* @param type type of value to demarshal
* @param value pointer to return value data
* @param byte_order the byte order
* @param new_pos pointer to update with new position, or #NULL
**/
void
_dbus_marshal_read_basic (const DBusString *str,
int pos,
int type,
void *value,
int byte_order,
int *new_pos)
{
const char *str_data;
_dbus_assert (dbus_type_is_basic (type));
str_data = _dbus_string_get_const_data (str);
/* Below we volatile types to avoid aliasing issues;
* see http://bugs.freedesktop.org/show_bug.cgi?id=20137
*/
switch (type)
{
case DBUS_TYPE_BYTE:
{
volatile unsigned char *vp = value;
*vp = (unsigned char) _dbus_string_get_byte (str, pos);
(pos)++;
}
break;
case DBUS_TYPE_INT16:
case DBUS_TYPE_UINT16:
{
volatile dbus_uint16_t *vp = value;
pos = _DBUS_ALIGN_VALUE (pos, 2);
*vp = *(dbus_uint16_t *) (void *) (str_data + pos);
if (byte_order != DBUS_COMPILER_BYTE_ORDER)
*vp = DBUS_UINT16_SWAP_LE_BE (*vp);
pos += 2;
}
break;
case DBUS_TYPE_INT32:
case DBUS_TYPE_UINT32:
case DBUS_TYPE_BOOLEAN:
case DBUS_TYPE_UNIX_FD:
{
volatile dbus_uint32_t *vp = value;
pos = _DBUS_ALIGN_VALUE (pos, 4);
*vp = *(dbus_uint32_t *) (void *) (str_data + pos);
if (byte_order != DBUS_COMPILER_BYTE_ORDER)
*vp = DBUS_UINT32_SWAP_LE_BE (*vp);
pos += 4;
}
break;
case DBUS_TYPE_INT64:
case DBUS_TYPE_UINT64:
case DBUS_TYPE_DOUBLE:
{
volatile dbus_uint64_t *vp = value;
pos = _DBUS_ALIGN_VALUE (pos, 8);
if (byte_order != DBUS_COMPILER_BYTE_ORDER)
*vp = DBUS_UINT64_SWAP_LE_BE (
*(dbus_uint64_t *) (void *) (str_data + pos));
else
*vp = *(dbus_uint64_t *) (void *) (str_data + pos);
pos += 8;
}
break;
case DBUS_TYPE_STRING:
case DBUS_TYPE_OBJECT_PATH:
{
int len;
volatile char **vp = value;
len = _dbus_marshal_read_uint32 (str, pos, byte_order, &pos);
*vp = (char*) str_data + pos;
pos += len + 1; /* length plus nul */
}
break;
case DBUS_TYPE_SIGNATURE:
{
int len;
volatile char **vp = value;
len = _dbus_string_get_byte (str, pos);
pos += 1;
*vp = (char*) str_data + pos;
pos += len + 1; /* length plus nul */
}
break;
default:
_dbus_warn_check_failed ("type %s %d not a basic type",
_dbus_type_to_string (type), type);
_dbus_assert_not_reached ("not a basic type");
break;
}
if (new_pos)
*new_pos = pos;
}
static dbus_bool_t
marshal_2_octets (DBusString *str,
int insert_at,
dbus_uint16_t value,
int byte_order,
int *pos_after)
{
dbus_bool_t retval;
int orig_len;
_DBUS_STATIC_ASSERT (sizeof (value) == 2);
if (byte_order != DBUS_COMPILER_BYTE_ORDER)
value = DBUS_UINT16_SWAP_LE_BE (value);
orig_len = _dbus_string_get_length (str);
retval = _dbus_string_insert_2_aligned (str, insert_at,
(const unsigned char *)&value);
if (pos_after)
{
*pos_after = insert_at + (_dbus_string_get_length (str) - orig_len);
_dbus_assert (*pos_after <= _dbus_string_get_length (str));
}
return retval;
}
static dbus_bool_t
marshal_4_octets (DBusString *str,
int insert_at,
dbus_uint32_t value,
int byte_order,
int *pos_after)
{
dbus_bool_t retval;
int orig_len;
_DBUS_STATIC_ASSERT (sizeof (value) == 4);
if (byte_order != DBUS_COMPILER_BYTE_ORDER)
value = DBUS_UINT32_SWAP_LE_BE (value);
orig_len = _dbus_string_get_length (str);
retval = _dbus_string_insert_4_aligned (str, insert_at,
(const unsigned char *)&value);
if (pos_after)
{
*pos_after = insert_at + (_dbus_string_get_length (str) - orig_len);
_dbus_assert (*pos_after <= _dbus_string_get_length (str));
}
return retval;
}
static dbus_bool_t
marshal_8_octets (DBusString *str,
int insert_at,
dbus_uint64_t value,
int byte_order,
int *pos_after)
{
dbus_bool_t retval;
int orig_len;
_DBUS_STATIC_ASSERT (sizeof (value) == 8);
swap_8_octets (&value, byte_order);
orig_len = _dbus_string_get_length (str);
retval = _dbus_string_insert_8_aligned (str, insert_at,
(const unsigned char *)&value);
if (pos_after)
*pos_after = insert_at + _dbus_string_get_length (str) - orig_len;
return retval;
}
enum
{
MARSHAL_AS_STRING,
MARSHAL_AS_SIGNATURE,
MARSHAL_AS_BYTE_ARRAY
};
static dbus_bool_t
marshal_len_followed_by_bytes (int marshal_as,
DBusString *str,
int insert_at,
const unsigned char *value,
int data_len, /* doesn't include nul if any */
int byte_order,
int *pos_after)
{
int pos;
DBusString value_str;
int value_len;
_dbus_assert (byte_order == DBUS_LITTLE_ENDIAN || byte_order == DBUS_BIG_ENDIAN);
if (insert_at > _dbus_string_get_length (str))
_dbus_warn ("insert_at = %d string len = %d data_len = %d",
insert_at, _dbus_string_get_length (str), data_len);
if (marshal_as == MARSHAL_AS_BYTE_ARRAY)
value_len = data_len;
else
value_len = data_len + 1; /* value has a nul */
_dbus_string_init_const_len (&value_str, (const char *) value, value_len);
pos = insert_at;
if (marshal_as == MARSHAL_AS_SIGNATURE)
{
_dbus_assert (data_len <= DBUS_MAXIMUM_SIGNATURE_LENGTH);
_dbus_assert (data_len <= 255); /* same as max sig len right now */
if (!_dbus_string_insert_byte (str, pos, data_len))
goto oom;
pos += 1;
}
else
{
if (!marshal_4_octets (str, pos, data_len,
byte_order, &pos))
goto oom;
}
if (!_dbus_string_copy_len (&value_str, 0, value_len,
str, pos))
goto oom;
#if 0
/* too expensive */
_dbus_assert (_dbus_string_equal_substring (&value_str, 0, value_len,
str, pos));
_dbus_verbose_bytes_of_string (str, pos, value_len);
#endif
pos += value_len;
if (pos_after)
*pos_after = pos;
return TRUE;
oom:
/* Delete what we've inserted */
_dbus_string_delete (str, insert_at, pos - insert_at);
return FALSE;
}
static dbus_bool_t
marshal_string (DBusString *str,
int insert_at,
const char *value,
int byte_order,
int *pos_after)
{
return marshal_len_followed_by_bytes (MARSHAL_AS_STRING,
str, insert_at, (const unsigned char *) value,
strlen (value),
byte_order, pos_after);
}
static dbus_bool_t
marshal_signature (DBusString *str,
int insert_at,
const char *value,
int *pos_after)
{
return marshal_len_followed_by_bytes (MARSHAL_AS_SIGNATURE,
str, insert_at, (const unsigned char *) value,
strlen (value),
DBUS_COMPILER_BYTE_ORDER, /* irrelevant */
pos_after);
}
/**
* Marshals a basic-typed value. The "value" pointer is always the
* address of a variable containing the basic type value.
* So for example for int32 it will be dbus_int32_t*, and
* for string it will be const char**. This is for symmetry
* with _dbus_marshal_read_basic() and to have a simple
* consistent rule.
*
* @param str string to marshal to
* @param insert_at where to insert the value
* @param type type of value
* @param value pointer to a variable containing the value
* @param byte_order byte order
* @param pos_after #NULL or the position after the type
* @returns #TRUE on success
**/
dbus_bool_t
_dbus_marshal_write_basic (DBusString *str,
int insert_at,
int type,
const void *value,
int byte_order,
int *pos_after)
{
/* Static assertions near the top of this file assert that signed and
* unsigned 16- and 32-bit quantities have the same alignment, and that
* doubles have alignment at least as strict as unsigned int64, so we
* don't have to distinguish further: every (double *)
* has strong enough alignment to be treated as though it was a
* (dbus_uint64_t *). Going via a (void *) means the compiler should
* know that pointers can alias each other. */
const unsigned char *u8_p;
const dbus_uint16_t *u16_p;
const dbus_uint32_t *u32_p;
const dbus_uint64_t *u64_p;
const char * const *string_p;
_dbus_assert (dbus_type_is_basic (type));
switch (type)
{
case DBUS_TYPE_BYTE:
u8_p = value;
if (!_dbus_string_insert_byte (str, insert_at, *u8_p))
return FALSE;
if (pos_after)
*pos_after = insert_at + 1;
return TRUE;
break;
case DBUS_TYPE_INT16:
case DBUS_TYPE_UINT16:
u16_p = value;
return marshal_2_octets (str, insert_at, *u16_p,
byte_order, pos_after);
break;
case DBUS_TYPE_BOOLEAN:
u32_p = value;
return marshal_4_octets (str, insert_at, (*u32_p != FALSE),
byte_order, pos_after);
break;
case DBUS_TYPE_INT32:
case DBUS_TYPE_UINT32:
case DBUS_TYPE_UNIX_FD:
u32_p = value;
return marshal_4_octets (str, insert_at, *u32_p,
byte_order, pos_after);
break;
case DBUS_TYPE_INT64:
case DBUS_TYPE_UINT64:
case DBUS_TYPE_DOUBLE:
u64_p = value;
return marshal_8_octets (str, insert_at, *u64_p, byte_order, pos_after);
break;
case DBUS_TYPE_STRING:
case DBUS_TYPE_OBJECT_PATH:
string_p = value;
_dbus_assert (*string_p != NULL);
return marshal_string (str, insert_at, *string_p, byte_order, pos_after);
break;
case DBUS_TYPE_SIGNATURE:
string_p = value;
_dbus_assert (*string_p != NULL);
return marshal_signature (str, insert_at, *string_p, pos_after);
break;
default:
_dbus_assert_not_reached ("not a basic type");
return FALSE;
break;
}
}
static dbus_bool_t
marshal_1_octets_array (DBusString *str,
int insert_at,
const unsigned char *value,
int n_elements,
int byte_order,
int *pos_after)
{
int pos;
DBusString value_str;
_dbus_string_init_const_len (&value_str, (const char *) value, n_elements);
pos = insert_at;
if (!_dbus_string_copy_len (&value_str, 0, n_elements,
str, pos))
return FALSE;
pos += n_elements;
if (pos_after)
*pos_after = pos;
return TRUE;
}
/**
* Swaps the elements of an array to the opposite byte order
*
* @param data start of array
* @param n_elements number of elements
* @param alignment size of each element
*/
void
_dbus_swap_array (unsigned char *data,
int n_elements,
int alignment)
{
void *d;
void *end;
_dbus_assert (_DBUS_ALIGN_ADDRESS (data, alignment) == data);
/* we use const_data and cast it off so DBusString can be a const string
* for the unit tests. don't ask.
*/
d = data;
end = data + (n_elements * alignment);
if (alignment == 8)
{
while (d != end)
{
*((dbus_uint64_t*)d) = DBUS_UINT64_SWAP_LE_BE (*((dbus_uint64_t*)d));
d = ((unsigned char *) d) + 8;
}
}
else if (alignment == 4)
{
while (d != end)
{
*((dbus_uint32_t*)d) = DBUS_UINT32_SWAP_LE_BE (*((dbus_uint32_t*)d));
d = ((unsigned char *) d) + 4;
}
}
else
{
_dbus_assert (alignment == 2);
while (d != end)
{
*((dbus_uint16_t*)d) = DBUS_UINT16_SWAP_LE_BE (*((dbus_uint16_t*)d));
d = ((unsigned char *) d) + 2;
}
}
}
static void
swap_array (DBusString *str,
int array_start,
int n_elements,
int byte_order,
int alignment)
{
_dbus_assert (_DBUS_ALIGN_VALUE (array_start, alignment) == (unsigned) array_start);
if (byte_order != DBUS_COMPILER_BYTE_ORDER)
{
/* we use const_data and cast it off so DBusString can be a const string
* for the unit tests. don't ask.
*/
_dbus_swap_array ((unsigned char*) (_dbus_string_get_const_data (str) + array_start),
n_elements, alignment);
}
}
static dbus_bool_t
marshal_fixed_multi (DBusString *str,
int insert_at,
const void *value,
int n_elements,
int byte_order,
int alignment,
int *pos_after)
{
int old_string_len;
int array_start;
DBusString t;
int len_in_bytes;
_dbus_assert (n_elements <= DBUS_MAXIMUM_ARRAY_LENGTH / alignment);
old_string_len = _dbus_string_get_length (str);
len_in_bytes = n_elements * alignment;
array_start = insert_at;
/* Note that we do alignment padding unconditionally
* even if the array is empty; this means that
* padding + len is always equal to the number of bytes
* in the array.
*/
if (!_dbus_string_insert_alignment (str, &array_start, alignment))
goto error;
_dbus_string_init_const_len (&t,
(const char *) value,
len_in_bytes);
if (!_dbus_string_copy (&t, 0,
str, array_start))
goto error;
swap_array (str, array_start, n_elements, byte_order, alignment);
if (pos_after)
*pos_after = array_start + len_in_bytes;
return TRUE;
error:
_dbus_string_delete (str, insert_at,
_dbus_string_get_length (str) - old_string_len);
return FALSE;
}
/**
* Marshals a block of values of fixed-length type all at once, as an
* optimization. dbus_type_is_fixed() returns #TRUE for fixed-length
* types, which are the basic types minus the string-like types.
*
* The value argument should be the adddress of an
* array, so e.g. "const dbus_uint32_t**"
*
* @param str string to marshal to
* @param insert_at where to insert the value
* @param element_type type of array elements
* @param value address of an array to marshal
* @param n_elements number of elements in the array
* @param byte_order byte order
* @param pos_after #NULL or the position after the type
* @returns #TRUE on success
**/
dbus_bool_t
_dbus_marshal_write_fixed_multi (DBusString *str,
int insert_at,
int element_type,
const void *value,
int n_elements,
int byte_order,
int *pos_after)
{
/* Static assertions near the top of this file assert that signed and
* unsigned 16- and 32-bit quantities have the same alignment, and that
* doubles have alignment at least as strict as unsigned int64, so we
* don't have to distinguish further: every (double *)
* has strong enough alignment to be treated as though it was a
* (dbus_uint64_t *). Going via a (void *) means the compiler should
* know that pointers can alias each other. */
const unsigned char * const *u8_pp;
const dbus_uint16_t * const *u16_pp;
const dbus_uint32_t * const *u32_pp;
const dbus_uint64_t * const *u64_pp;
_dbus_assert (dbus_type_is_fixed (element_type));
_dbus_assert (n_elements >= 0);
#if 0
_dbus_verbose ("writing %d elements of %s\n",
n_elements, _dbus_type_to_string (element_type));
#endif
switch (element_type)
{
case DBUS_TYPE_BYTE:
u8_pp = value;
return marshal_1_octets_array (str, insert_at, *u8_pp, n_elements, byte_order, pos_after);
break;
case DBUS_TYPE_INT16:
case DBUS_TYPE_UINT16:
u16_pp = value;
return marshal_fixed_multi (str, insert_at, *u16_pp, n_elements, byte_order, 2, pos_after);
case DBUS_TYPE_BOOLEAN:
case DBUS_TYPE_INT32:
case DBUS_TYPE_UINT32:
case DBUS_TYPE_UNIX_FD:
u32_pp = value;
return marshal_fixed_multi (str, insert_at, *u32_pp, n_elements, byte_order, 4, pos_after);
break;
case DBUS_TYPE_INT64:
case DBUS_TYPE_UINT64:
case DBUS_TYPE_DOUBLE:
u64_pp = value;
return marshal_fixed_multi (str, insert_at, *u64_pp, n_elements, byte_order, 8, pos_after);
break;
default:
_dbus_assert_not_reached ("non fixed type in array write");
break;
}
return FALSE;
}
/**
* Skips over a basic-typed value, reporting the following position.
*
* @param str the string containing the data
* @param type type of value to read
* @param byte_order the byte order
* @param pos pointer to position in the string,
* updated on return to new position
**/
void
_dbus_marshal_skip_basic (const DBusString *str,
int type,
int byte_order,
int *pos)
{
_dbus_assert (byte_order == DBUS_LITTLE_ENDIAN ||
byte_order == DBUS_BIG_ENDIAN);
switch (type)
{
case DBUS_TYPE_BYTE:
(*pos)++;
break;
case DBUS_TYPE_INT16:
case DBUS_TYPE_UINT16:
/* Advance to the next suitably-aligned position >= *pos */
*pos = _DBUS_ALIGN_VALUE (*pos, 2);
*pos += 2;
break;
case DBUS_TYPE_BOOLEAN:
case DBUS_TYPE_INT32:
case DBUS_TYPE_UINT32:
case DBUS_TYPE_UNIX_FD:
*pos = _DBUS_ALIGN_VALUE (*pos, 4);
*pos += 4;
break;
case DBUS_TYPE_INT64:
case DBUS_TYPE_UINT64:
case DBUS_TYPE_DOUBLE:
*pos = _DBUS_ALIGN_VALUE (*pos, 8);
*pos += 8;
break;
case DBUS_TYPE_STRING:
case DBUS_TYPE_OBJECT_PATH:
{
int len;
/* Let len be the number of bytes of string data, and advance
* *pos to just after the length */
len = _dbus_marshal_read_uint32 (str, *pos, byte_order, pos);
*pos += len + 1; /* length plus nul */
}
break;
case DBUS_TYPE_SIGNATURE:
{
int len;
len = _dbus_string_get_byte (str, *pos);
*pos += len + 2; /* length byte plus length plus nul */
}
break;
default:
_dbus_warn ("type %s not a basic type",
_dbus_type_to_string (type));
_dbus_assert_not_reached ("not a basic type");
break;
}
/* We had better still be in-bounds at this point (pointing either into
* the content of the string, or 1 past the logical length of the string) */
_dbus_assert (*pos <= _dbus_string_get_length (str));
}
/**
* Skips an array, returning the next position.
*
* @param str the string containing the data
* @param element_type the type of array elements
* @param byte_order the byte order
* @param pos pointer to position in the string,
* updated on return to new position
*/
void
_dbus_marshal_skip_array (const DBusString *str,
int element_type,
int byte_order,
int *pos)
{
dbus_uint32_t array_len;
int i;
int alignment;
/* Advance to the next 4-byte-aligned position >= *pos */
i = _DBUS_ALIGN_VALUE (*pos, 4);
/* Let array_len be the number of bytes of array data, and advance
* i to just after the length */
array_len = _dbus_marshal_read_uint32 (str, i, byte_order, &i);
/* If the element type is more strictly-aligned than the length,
* advance i to the next suitably-aligned position
* (in other words, skip the padding) */
alignment = _dbus_type_get_alignment (element_type);
i = _DBUS_ALIGN_VALUE (i, alignment);
/* Skip the actual array data */
*pos = i + array_len;
/* We had better still be in-bounds at this point (pointing either into
* the content of the string, or 1 past the logical length of the string) */
_dbus_assert (*pos <= _dbus_string_get_length (str));
}
/**
* Gets the alignment requirement for the given type;
* will be 1, 2, 4, or 8.
*
* @param typecode the type
* @returns alignment of 1, 2, 4, or 8
*/
int
_dbus_type_get_alignment (int typecode)
{
switch (typecode)
{
case DBUS_TYPE_BYTE:
case DBUS_TYPE_VARIANT:
case DBUS_TYPE_SIGNATURE:
return 1;
case DBUS_TYPE_INT16:
case DBUS_TYPE_UINT16:
return 2;
case DBUS_TYPE_BOOLEAN:
case DBUS_TYPE_INT32:
case DBUS_TYPE_UINT32:
case DBUS_TYPE_UNIX_FD:
/* this stuff is 4 since it starts with a length */
case DBUS_TYPE_STRING:
case DBUS_TYPE_OBJECT_PATH:
case DBUS_TYPE_ARRAY:
return 4;
case DBUS_TYPE_INT64:
case DBUS_TYPE_UINT64:
case DBUS_TYPE_DOUBLE:
/* struct is 8 since it could contain an 8-aligned item
* and it's simpler to just always align structs to 8;
* we want the amount of padding in a struct of a given
* type to be predictable, not location-dependent.
* DICT_ENTRY is always the same as struct.
*/
case DBUS_TYPE_STRUCT:
case DBUS_TYPE_DICT_ENTRY:
return 8;
default:
_dbus_assert_not_reached ("unknown typecode in _dbus_type_get_alignment()");
return 0;
}
}
/**
* Returns a string describing the given type.
*
* @param typecode the type to describe
* @returns a constant string describing the type
*/
const char *
_dbus_type_to_string (int typecode)
{
switch (typecode)
{
case DBUS_TYPE_INVALID:
return "invalid";
case DBUS_TYPE_BOOLEAN:
return "boolean";
case DBUS_TYPE_BYTE:
return "byte";
case DBUS_TYPE_INT16:
return "int16";
case DBUS_TYPE_UINT16:
return "uint16";
case DBUS_TYPE_INT32:
return "int32";
case DBUS_TYPE_UINT32:
return "uint32";
case DBUS_TYPE_INT64:
return "int64";
case DBUS_TYPE_UINT64:
return "uint64";
case DBUS_TYPE_DOUBLE:
return "double";
case DBUS_TYPE_STRING:
return "string";
case DBUS_TYPE_OBJECT_PATH:
return "object_path";
case DBUS_TYPE_SIGNATURE:
return "signature";
case DBUS_TYPE_STRUCT:
return "struct";
case DBUS_TYPE_DICT_ENTRY:
return "dict_entry";
case DBUS_TYPE_ARRAY:
return "array";
case DBUS_TYPE_VARIANT:
return "variant";
case DBUS_STRUCT_BEGIN_CHAR:
return "begin_struct";
case DBUS_STRUCT_END_CHAR:
return "end_struct";
case DBUS_DICT_ENTRY_BEGIN_CHAR:
return "begin_dict_entry";
case DBUS_DICT_ENTRY_END_CHAR:
return "end_dict_entry";
case DBUS_TYPE_UNIX_FD:
return "unix_fd";
default:
return "unknown";
}
}
/**
* If in verbose mode, print a block of binary data.
*
* @param data the data
* @param len the length of the data
* @param offset where to start counting for byte indexes
*/
void
_dbus_verbose_bytes (const unsigned char *data,
int len,
int offset)
{
int i;
const unsigned char *aligned;
_dbus_assert (len >= 0);
if (!_dbus_is_verbose())
return;
/* Print blanks on first row if appropriate */
aligned = _DBUS_ALIGN_ADDRESS (data, 4);
if (aligned > data)
aligned -= 4;
_dbus_assert (aligned <= data);
if (aligned != data)
{
_dbus_verbose ("%4ld\t%p: ", - (long)(data - aligned), aligned);
while (aligned != data)
{
_dbus_verbose (" ");
++aligned;
}
}
/* now print the bytes */
i = 0;
while (i < len)
{
if (_DBUS_ALIGN_ADDRESS (&data[i], 4) == &data[i])
{
_dbus_verbose ("%4d\t%p: ",
offset + i, &data[i]);
}
if (data[i] >= 32 &&
data[i] <= 126)
_dbus_verbose (" '%c' ", data[i]);
else
_dbus_verbose ("0x%s%x ",
data[i] <= 0xf ? "0" : "", data[i]);
++i;
if (_DBUS_ALIGN_ADDRESS (&data[i], 4) == &data[i])
{
if (i > 3)
_dbus_verbose ("BE: %d LE: %d",
_dbus_unpack_uint32 (DBUS_BIG_ENDIAN, &data[i-4]),
_dbus_unpack_uint32 (DBUS_LITTLE_ENDIAN, &data[i-4]));
if (i > 7 &&
_DBUS_ALIGN_ADDRESS (&data[i], 8) == &data[i])
{
_dbus_verbose (" u64: 0x%" DBUS_INT64_MODIFIER "x",
*(dbus_uint64_t *) (void *) &data[i - 8]);
_dbus_verbose (" dbl: %g", *(double *) (void *) &data[i - 8]);
}
_dbus_verbose ("\n");
}
}
_dbus_verbose ("\n");
}
/**
* Dump the given part of the string to verbose log.
*
* @param str the string
* @param start the start of range to dump
* @param len length of range
*/
void
_dbus_verbose_bytes_of_string (const DBusString *str,
int start,
int len)
{
const char *d;
int real_len;
real_len = _dbus_string_get_length (str);
_dbus_assert (start >= 0);
if (start > real_len)
{
_dbus_verbose (" [%d,%d) is not inside string of length %d\n",
start, len, real_len);
return;
}
if ((start + len) > real_len)
{
_dbus_verbose (" [%d,%d) extends outside string of length %d\n",
start, len, real_len);
len = real_len - start;
}
d = _dbus_string_get_const_data_len (str, start, len);
_dbus_verbose_bytes ((const unsigned char *) d, len, start);
}
static int
map_type_char_to_type (int t)
{
if (t == DBUS_STRUCT_BEGIN_CHAR)
return DBUS_TYPE_STRUCT;
else if (t == DBUS_DICT_ENTRY_BEGIN_CHAR)
return DBUS_TYPE_DICT_ENTRY;
else
{
_dbus_assert (t != DBUS_STRUCT_END_CHAR);
_dbus_assert (t != DBUS_DICT_ENTRY_END_CHAR);
return t;
}
}
/**
* Get the first type in the signature. The difference between this
* and just getting the first byte of the signature is that you won't
* get DBUS_STRUCT_BEGIN_CHAR, you'll get DBUS_TYPE_STRUCT
* instead.
*
* @param str string containing signature
* @param pos where the signature starts
* @returns the first type in the signature
*/
int
_dbus_first_type_in_signature (const DBusString *str,
int pos)
{
return map_type_char_to_type (_dbus_string_get_byte (str, pos));
}
/**
* Similar to #_dbus_first_type_in_signature, but operates
* on a C string buffer.
*
* @param str a C string buffer
* @param pos where the signature starts
* @returns the first type in the signature
*/
int
_dbus_first_type_in_signature_c_str (const char *str,
int pos)
{
return map_type_char_to_type (str[pos]);
}
/** @} */
#ifdef DBUS_ENABLE_EMBEDDED_TESTS
#include "dbus-test.h"
#include <stdio.h>
/**
* Reads a block of fixed-length basic values, as an optimization
* vs. reading each one individually into a new buffer.
*
* This function returns the data in-place; it does not make a copy,
* and it does not swap the bytes.
*
* If you ask for #DBUS_TYPE_DOUBLE you will get a "const double*" back
* and the "value" argument should be a "const double**" and so on.
*
* @param str the string to read from
* @param pos position to read from
* @param element_type type of array elements
* @param value place to return the array
* @param n_elements number of array elements to read
* @param byte_order the byte order, used to read the array length
* @param new_pos #NULL or location to store a position after the elements
*/
void
_dbus_marshal_read_fixed_multi (const DBusString *str,
int pos,
int element_type,
const void **value,
int n_elements,
int byte_order,
int *new_pos)
{
int array_len;
int alignment;
_dbus_assert (dbus_type_is_fixed (element_type));
_dbus_assert (dbus_type_is_basic (element_type));
#if 0
_dbus_verbose ("reading %d elements of %s\n",
n_elements, _dbus_type_to_string (element_type));
#endif
alignment = _dbus_type_get_alignment (element_type);
pos = _DBUS_ALIGN_VALUE (pos, alignment);
array_len = n_elements * alignment;
*value = _dbus_string_get_const_data_len (str, pos, array_len);
if (new_pos)
*new_pos = pos + array_len;
}
static void
swap_test_array (void *array,
int len_bytes,
int byte_order,
int alignment)
{
DBusString t;
if (alignment == 1)
return;
_dbus_string_init_const_len (&t, array, len_bytes);
swap_array (&t, 0, len_bytes / alignment, byte_order, alignment);
}
#define MARSHAL_BASIC(typename, byte_order, literal) \
do { \
v_##typename = literal; \
if (!_dbus_marshal_write_basic (&str, pos, DBUS_TYPE_##typename, \
&v_##typename, \
byte_order, NULL)) \
_dbus_test_fatal ("no memory"); \
} while (0)
#define DEMARSHAL_BASIC(typename, byte_order) \
do { \
_dbus_marshal_read_basic (&str, pos, DBUS_TYPE_##typename, &v_##typename, \
byte_order, &pos); \
} while (0)
#define DEMARSHAL_BASIC_AND_CHECK(typename, byte_order, literal) \
do { \
DEMARSHAL_BASIC (typename, byte_order); \
if (literal != v_##typename) \
{ \
_dbus_verbose_bytes_of_string (&str, dump_pos, \
_dbus_string_get_length (&str) - dump_pos); \
_dbus_test_fatal ("demarshaled wrong value"); \
} \
} while (0)
#define MARSHAL_TEST(typename, byte_order, literal) \
do { \
MARSHAL_BASIC (typename, byte_order, literal); \
dump_pos = pos; \
DEMARSHAL_BASIC_AND_CHECK (typename, byte_order, literal); \
} while (0)
#define MARSHAL_TEST_STRCMP(typename, byte_order, literal) \
do { \
MARSHAL_BASIC (typename, byte_order, literal); \
dump_pos = pos; \
DEMARSHAL_BASIC (typename, byte_order); \
if (strcmp (literal, v_##typename) != 0) \
{ \
_dbus_verbose_bytes_of_string (&str, dump_pos, \
_dbus_string_get_length (&str) - dump_pos); \
_dbus_warn ("literal '%s'\nvalue '%s'", literal, v_##typename); \
_dbus_test_fatal ("demarshaled wrong value"); \
} \
} while (0)
#define MARSHAL_FIXED_ARRAY(typename, byte_order, literal) \
do { \
int next; \
v_UINT32 = sizeof(literal); \
if (!_dbus_marshal_write_basic (&str, pos, DBUS_TYPE_UINT32, &v_UINT32, \
byte_order, &next)) \
_dbus_test_fatal ("no memory"); \
v_ARRAY_##typename = literal; \
if (!_dbus_marshal_write_fixed_multi (&str, next, DBUS_TYPE_##typename, \
&v_ARRAY_##typename, _DBUS_N_ELEMENTS(literal), \
byte_order, NULL)) \
_dbus_test_fatal ("no memory"); \
} while (0)
#define DEMARSHAL_FIXED_ARRAY(typename, byte_order) \
do { \
int next; \
alignment = _dbus_type_get_alignment (DBUS_TYPE_##typename); \
v_UINT32 = _dbus_marshal_read_uint32 (&str, dump_pos, byte_order, &next); \
_dbus_marshal_read_fixed_multi (&str, next, DBUS_TYPE_##typename, \
(const void **) &v_ARRAY_##typename, \
v_UINT32/alignment, \
byte_order, NULL); \
swap_test_array (v_ARRAY_##typename, v_UINT32, \
byte_order, alignment); \
} while (0)
#define DEMARSHAL_FIXED_ARRAY_AND_CHECK(typename, byte_order, literal) \
do { \
DEMARSHAL_FIXED_ARRAY (typename, byte_order); \
if (memcmp (literal, v_ARRAY_##typename, sizeof (literal)) != 0) \
{ \
_dbus_verbose ("MARSHALED DATA\n"); \
_dbus_verbose_bytes_of_string (&str, dump_pos, \
_dbus_string_get_length (&str) - dump_pos); \
_dbus_verbose ("LITERAL DATA\n"); \
_dbus_verbose_bytes ((const unsigned char *) literal, sizeof (literal), 0); \
_dbus_verbose ("READ DATA\n"); \
_dbus_verbose_bytes ((const unsigned char *) v_ARRAY_##typename, sizeof (literal), 0); \
_dbus_test_fatal ("demarshaled wrong fixed array value"); \
} \
} while (0)
#define MARSHAL_TEST_FIXED_ARRAY(typename, byte_order, literal) \
do { \
MARSHAL_FIXED_ARRAY (typename, byte_order, literal); \
dump_pos = pos; \
DEMARSHAL_FIXED_ARRAY_AND_CHECK (typename, byte_order, literal); \
} while (0)
dbus_bool_t
_dbus_marshal_test (const char *test_data_dir _DBUS_GNUC_UNUSED)
{
int alignment;
DBusString str;
int pos, dump_pos;
unsigned char array1[5] = { 3, 4, 0, 1, 9 };
dbus_int16_t array2[3] = { 124, 457, 780 };
dbus_uint16_t array2u[3] = { 124, 457, 780 };
dbus_int32_t array4[3] = { 123, 456, 789 };
dbus_uint32_t array4u[3] = { 123, 456, 789 };
dbus_int64_t array8[3] = { DBUS_INT64_CONSTANT (0x123ffffffff),
DBUS_INT64_CONSTANT (0x456ffffffff),
DBUS_INT64_CONSTANT (0x789ffffffff) };
dbus_int64_t *v_ARRAY_INT64;
unsigned char *v_ARRAY_BYTE;
dbus_int16_t *v_ARRAY_INT16;
dbus_uint16_t *v_ARRAY_UINT16;
dbus_int32_t *v_ARRAY_INT32;
dbus_uint32_t *v_ARRAY_UINT32;
DBusString t;
double v_DOUBLE;
double t_DOUBLE;
dbus_int16_t v_INT16;
dbus_uint16_t v_UINT16;
dbus_int32_t v_INT32;
dbus_uint32_t v_UINT32;
dbus_int64_t v_INT64;
dbus_uint64_t v_UINT64;
unsigned char v_BYTE;
dbus_bool_t v_BOOLEAN;
const char *v_STRING;
const char *v_SIGNATURE;
const char *v_OBJECT_PATH;
int byte_order;
if (!_dbus_string_init (&str))
_dbus_test_fatal ("failed to init string");
pos = 0;
/* Marshal doubles */
MARSHAL_BASIC (DOUBLE, DBUS_BIG_ENDIAN, 3.14);
DEMARSHAL_BASIC (DOUBLE, DBUS_BIG_ENDIAN);
t_DOUBLE = 3.14;
if (!_DBUS_DOUBLES_BITWISE_EQUAL (t_DOUBLE, v_DOUBLE))
_dbus_test_fatal ("got wrong double value");
MARSHAL_BASIC (DOUBLE, DBUS_LITTLE_ENDIAN, 3.14);
DEMARSHAL_BASIC (DOUBLE, DBUS_LITTLE_ENDIAN);
t_DOUBLE = 3.14;
if (!_DBUS_DOUBLES_BITWISE_EQUAL (t_DOUBLE, v_DOUBLE))
_dbus_test_fatal ("got wrong double value");
/* Marshal signed 16 integers */
MARSHAL_TEST (INT16, DBUS_BIG_ENDIAN, -12345);
MARSHAL_TEST (INT16, DBUS_LITTLE_ENDIAN, -12345);
/* Marshal unsigned 16 integers */
MARSHAL_TEST (UINT16, DBUS_BIG_ENDIAN, 0x1234);
MARSHAL_TEST (UINT16, DBUS_LITTLE_ENDIAN, 0x1234);
/* Marshal signed integers */
MARSHAL_TEST (INT32, DBUS_BIG_ENDIAN, -12345678);
MARSHAL_TEST (INT32, DBUS_LITTLE_ENDIAN, -12345678);
/* Marshal unsigned integers */
MARSHAL_TEST (UINT32, DBUS_BIG_ENDIAN, 0x12345678);
MARSHAL_TEST (UINT32, DBUS_LITTLE_ENDIAN, 0x12345678);
/* Marshal signed integers */
MARSHAL_TEST (INT64, DBUS_BIG_ENDIAN, DBUS_INT64_CONSTANT (-0x123456789abc7));
MARSHAL_TEST (INT64, DBUS_LITTLE_ENDIAN, DBUS_INT64_CONSTANT (-0x123456789abc7));
/* Marshal unsigned integers */
MARSHAL_TEST (UINT64, DBUS_BIG_ENDIAN, DBUS_UINT64_CONSTANT (0x123456789abc7));
MARSHAL_TEST (UINT64, DBUS_LITTLE_ENDIAN, DBUS_UINT64_CONSTANT (0x123456789abc7));
/* Marshal byte */
MARSHAL_TEST (BYTE, DBUS_BIG_ENDIAN, 5);
MARSHAL_TEST (BYTE, DBUS_LITTLE_ENDIAN, 5);
/* Marshal all possible bools! */
MARSHAL_TEST (BOOLEAN, DBUS_BIG_ENDIAN, FALSE);
MARSHAL_TEST (BOOLEAN, DBUS_LITTLE_ENDIAN, FALSE);
MARSHAL_TEST (BOOLEAN, DBUS_BIG_ENDIAN, TRUE);
MARSHAL_TEST (BOOLEAN, DBUS_LITTLE_ENDIAN, TRUE);
/* Marshal strings */
MARSHAL_TEST_STRCMP (STRING, DBUS_BIG_ENDIAN, "");
MARSHAL_TEST_STRCMP (STRING, DBUS_LITTLE_ENDIAN, "");
MARSHAL_TEST_STRCMP (STRING, DBUS_BIG_ENDIAN, "This is the dbus test string");
MARSHAL_TEST_STRCMP (STRING, DBUS_LITTLE_ENDIAN, "This is the dbus test string");
/* object paths */
MARSHAL_TEST_STRCMP (OBJECT_PATH, DBUS_BIG_ENDIAN, "/a/b/c");
MARSHAL_TEST_STRCMP (OBJECT_PATH, DBUS_LITTLE_ENDIAN, "/a/b/c");
/* signatures */
MARSHAL_TEST_STRCMP (SIGNATURE, DBUS_BIG_ENDIAN, "");
MARSHAL_TEST_STRCMP (SIGNATURE, DBUS_LITTLE_ENDIAN, "");
MARSHAL_TEST_STRCMP (SIGNATURE, DBUS_BIG_ENDIAN, "a(ii)");
MARSHAL_TEST_STRCMP (SIGNATURE, DBUS_LITTLE_ENDIAN, "a(ii)");
/* Arrays */
MARSHAL_TEST_FIXED_ARRAY (INT16, DBUS_BIG_ENDIAN, array2);
MARSHAL_TEST_FIXED_ARRAY (INT16, DBUS_LITTLE_ENDIAN, array2);
MARSHAL_TEST_FIXED_ARRAY (UINT16, DBUS_BIG_ENDIAN, array2u);
MARSHAL_TEST_FIXED_ARRAY (UINT16, DBUS_LITTLE_ENDIAN, array2u);
MARSHAL_TEST_FIXED_ARRAY (INT32, DBUS_BIG_ENDIAN, array4);
MARSHAL_TEST_FIXED_ARRAY (INT32, DBUS_LITTLE_ENDIAN, array4);
MARSHAL_TEST_FIXED_ARRAY (UINT32, DBUS_BIG_ENDIAN, array4u);
MARSHAL_TEST_FIXED_ARRAY (UINT32, DBUS_LITTLE_ENDIAN, array4u);
MARSHAL_TEST_FIXED_ARRAY (BYTE, DBUS_BIG_ENDIAN, array1);
MARSHAL_TEST_FIXED_ARRAY (BYTE, DBUS_LITTLE_ENDIAN, array1);
MARSHAL_TEST_FIXED_ARRAY (INT64, DBUS_BIG_ENDIAN, array8);
MARSHAL_TEST_FIXED_ARRAY (INT64, DBUS_LITTLE_ENDIAN, array8);
#if 0
/*
* FIXME restore the set/pack tests
*/
/* set/pack 64-bit integers */
_dbus_string_set_length (&str, 8);
/* signed little */
_dbus_marshal_set_int64 (&str, DBUS_LITTLE_ENDIAN,
0, DBUS_INT64_CONSTANT (-0x123456789abc7));
_dbus_assert (DBUS_INT64_CONSTANT (-0x123456789abc7) ==
_dbus_unpack_int64 (DBUS_LITTLE_ENDIAN,
_dbus_string_get_const_data (&str)));
/* signed big */
_dbus_marshal_set_int64 (&str, DBUS_BIG_ENDIAN,
0, DBUS_INT64_CONSTANT (-0x123456789abc7));
_dbus_assert (DBUS_INT64_CONSTANT (-0x123456789abc7) ==
_dbus_unpack_int64 (DBUS_BIG_ENDIAN,
_dbus_string_get_const_data (&str)));
/* signed little pack */
_dbus_pack_int64 (DBUS_INT64_CONSTANT (-0x123456789abc7),
DBUS_LITTLE_ENDIAN,
_dbus_string_get_data (&str));
_dbus_assert (DBUS_INT64_CONSTANT (-0x123456789abc7) ==
_dbus_unpack_int64 (DBUS_LITTLE_ENDIAN,
_dbus_string_get_const_data (&str)));
/* signed big pack */
_dbus_pack_int64 (DBUS_INT64_CONSTANT (-0x123456789abc7),
DBUS_BIG_ENDIAN,
_dbus_string_get_data (&str));
_dbus_assert (DBUS_INT64_CONSTANT (-0x123456789abc7) ==
_dbus_unpack_int64 (DBUS_BIG_ENDIAN,
_dbus_string_get_const_data (&str)));
/* unsigned little */
_dbus_marshal_set_uint64 (&str, DBUS_LITTLE_ENDIAN,
0, DBUS_UINT64_CONSTANT (0x123456789abc7));
_dbus_assert (DBUS_UINT64_CONSTANT (0x123456789abc7) ==
_dbus_unpack_uint64 (DBUS_LITTLE_ENDIAN,
_dbus_string_get_const_data (&str)));
/* unsigned big */
_dbus_marshal_set_uint64 (&str, DBUS_BIG_ENDIAN,
0, DBUS_UINT64_CONSTANT (0x123456789abc7));
_dbus_assert (DBUS_UINT64_CONSTANT (0x123456789abc7) ==
_dbus_unpack_uint64 (DBUS_BIG_ENDIAN,
_dbus_string_get_const_data (&str)));
/* unsigned little pack */
_dbus_pack_uint64 (DBUS_UINT64_CONSTANT (0x123456789abc7),
DBUS_LITTLE_ENDIAN,
_dbus_string_get_data (&str));
_dbus_assert (DBUS_UINT64_CONSTANT (0x123456789abc7) ==
_dbus_unpack_uint64 (DBUS_LITTLE_ENDIAN,
_dbus_string_get_const_data (&str)));
/* unsigned big pack */
_dbus_pack_uint64 (DBUS_UINT64_CONSTANT (0x123456789abc7),
DBUS_BIG_ENDIAN,
_dbus_string_get_data (&str));
_dbus_assert (DBUS_UINT64_CONSTANT (0x123456789abc7) ==
_dbus_unpack_uint64 (DBUS_BIG_ENDIAN,
_dbus_string_get_const_data (&str)));
/* set/pack 32-bit integers */
_dbus_string_set_length (&str, 4);
/* signed little */
_dbus_marshal_set_int32 (&str, DBUS_LITTLE_ENDIAN,
0, -0x123456);
_dbus_assert (-0x123456 ==
_dbus_unpack_int32 (DBUS_LITTLE_ENDIAN,
_dbus_string_get_const_data (&str)));
/* signed big */
_dbus_marshal_set_int32 (&str, DBUS_BIG_ENDIAN,
0, -0x123456);
_dbus_assert (-0x123456 ==
_dbus_unpack_int32 (DBUS_BIG_ENDIAN,
_dbus_string_get_const_data (&str)));
/* signed little pack */
_dbus_pack_int32 (-0x123456,
DBUS_LITTLE_ENDIAN,
_dbus_string_get_data (&str));
_dbus_assert (-0x123456 ==
_dbus_unpack_int32 (DBUS_LITTLE_ENDIAN,
_dbus_string_get_const_data (&str)));
/* signed big pack */
_dbus_pack_int32 (-0x123456,
DBUS_BIG_ENDIAN,
_dbus_string_get_data (&str));
_dbus_assert (-0x123456 ==
_dbus_unpack_int32 (DBUS_BIG_ENDIAN,
_dbus_string_get_const_data (&str)));
/* unsigned little */
_dbus_marshal_set_uint32 (&str,
0, 0x123456,
DBUS_LITTLE_ENDIAN);
_dbus_assert (0x123456 ==
_dbus_unpack_uint32 (DBUS_LITTLE_ENDIAN,
_dbus_string_get_const_data (&str)));
/* unsigned big */
_dbus_marshal_set_uint32 (&str,
0, 0x123456,
DBUS_BIG_ENDIAN);
_dbus_assert (0x123456 ==
_dbus_unpack_uint32 (DBUS_BIG_ENDIAN,
_dbus_string_get_const_data (&str)));
/* unsigned little pack */
_dbus_pack_uint32 (0x123456,
DBUS_LITTLE_ENDIAN,
_dbus_string_get_data (&str));
_dbus_assert (0x123456 ==
_dbus_unpack_uint32 (DBUS_LITTLE_ENDIAN,
_dbus_string_get_const_data (&str)));
/* unsigned big pack */
_dbus_pack_uint32 (0x123456,
DBUS_BIG_ENDIAN,
_dbus_string_get_data (&str));
_dbus_assert (0x123456 ==
_dbus_unpack_uint32 (DBUS_BIG_ENDIAN,
_dbus_string_get_const_data (&str)));
#endif /* set/pack tests for integers */
/* Strings in-place set */
byte_order = DBUS_LITTLE_ENDIAN;
while (TRUE)
{
/* Init a string */
_dbus_string_set_length (&str, 0);
/* reset pos for the macros */
pos = 0;
MARSHAL_TEST_STRCMP (STRING, byte_order, "Hello world");
/* Set it to something longer */
_dbus_string_init_const (&t, "Hello world foo");
v_STRING = _dbus_string_get_const_data (&t);
_dbus_marshal_set_basic (&str, 0, DBUS_TYPE_STRING,
&v_STRING, byte_order, NULL, NULL);
_dbus_marshal_read_basic (&str, 0, DBUS_TYPE_STRING,
&v_STRING, byte_order,
NULL);
_dbus_assert (strcmp (v_STRING, "Hello world foo") == 0);
/* Set it to something shorter */
_dbus_string_init_const (&t, "Hello");
v_STRING = _dbus_string_get_const_data (&t);
_dbus_marshal_set_basic (&str, 0, DBUS_TYPE_STRING,
&v_STRING, byte_order, NULL, NULL);
_dbus_marshal_read_basic (&str, 0, DBUS_TYPE_STRING,
&v_STRING, byte_order,
NULL);
_dbus_assert (strcmp (v_STRING, "Hello") == 0);
/* Do the other byte order */
if (byte_order == DBUS_LITTLE_ENDIAN)
byte_order = DBUS_BIG_ENDIAN;
else
break;
}
/* Clean up */
_dbus_string_free (&str);
return TRUE;
}
#endif /* DBUS_ENABLE_EMBEDDED_TESTS */
Reference in a new issue View git blame Copy permalink