dbus/dbus-marshal-basic.c

   1 /* -*- mode: C; c-file-style: "gnu" -*- */
   2 /* dbus-marshal-basic.c  Marshalling routines for basic (primitive) types
   3  *
   4  * Copyright (C) 2002 CodeFactory AB
   5  * Copyright (C) 2003, 2004, 2005 Red Hat, Inc.
   6  *
   7  * Licensed under the Academic Free License version 2.1
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  22  *
  23  */
  24
  25 #include "dbus-internals.h"
  26 #include "dbus-marshal-basic.h"
  27
  28 #include <string.h>
  29
  30 /**
  31  * @defgroup DBusMarshal marshaling and unmarshaling
  32  * @ingroup  DBusInternals
  33  * @brief functions to marshal/unmarshal data from the wire
  34  *
  35  * Types and functions related to converting primitive data types from
  36  * wire format to native machine format, and vice versa.
  37  *
  38  * A signature is just a string with multiple types one after the other.
  39  * for example a type is "i" or "(ii)", a signature is "i(ii)"
  40  * where i is int and (ii) is struct { int; int; }
  41  *
  42  * @{
  43  */
  44
  45 static void
  46 pack_4_octets (dbus_uint32_t   value,
  47                int             byte_order,
  48                unsigned char  *data)
  49 {
  50   _dbus_assert (_DBUS_ALIGN_ADDRESS (data, 4) == data);
  51
  52   if ((byte_order) == DBUS_LITTLE_ENDIAN)
  53     *((dbus_uint32_t*)(data)) = DBUS_UINT32_TO_LE (value);
  54   else
  55     *((dbus_uint32_t*)(data)) = DBUS_UINT32_TO_BE (value);
  56 }
  57
  58 static void
  59 pack_8_octets (DBusBasicValue     value,
  60                int                byte_order,
  61                unsigned char     *data)
  62 {
  63   _dbus_assert (_DBUS_ALIGN_ADDRESS (data, 8) == data);
  64
  65 #ifdef DBUS_HAVE_INT64
  66   if ((byte_order) == DBUS_LITTLE_ENDIAN)
  67     *((dbus_uint64_t*)(data)) = DBUS_UINT64_TO_LE (value.u64);
  68   else
  69     *((dbus_uint64_t*)(data)) = DBUS_UINT64_TO_BE (value.u64);
  70 #else
  71   *(DBus8ByteStruct*)data = value.u64;
  72   swap_8_octets ((DBusBasicValue*)data, byte_order);
  73 #endif
  74 }
  75
  76 /**
  77  * Packs a 32 bit unsigned integer into a data pointer.
  78  *
  79  * @param value the value
  80  * @param byte_order the byte order to use
  81  * @param data the data pointer
  82  */
  83 void
  84 _dbus_pack_uint32 (dbus_uint32_t   value,
  85                    int             byte_order,
  86                    unsigned char  *data)
  87 {
  88   pack_4_octets (value, byte_order, data);
  89 }
  90
  91 #ifndef DBUS_HAVE_INT64
  92 /* from ORBit */
  93 static void
  94 swap_bytes (unsigned char *data,
  95             unsigned int   len)
  96 {
  97   unsigned char *p1 = data;
  98   unsigned char *p2 = data + len - 1;
  99
 100   while (p1 < p2)
 101     {
 102       unsigned char tmp = *p1;
 103       *p1 = *p2;
 104       *p2 = tmp;
 105
 106       --p2;
 107       ++p1;
 108     }
 109 }
 110 #endif /* !DBUS_HAVE_INT64 */
 111
 112 static void
 113 swap_8_octets (DBusBasicValue    *value,
 114                int                byte_order)
 115 {
 116   if (byte_order != DBUS_COMPILER_BYTE_ORDER)
 117     {
 118 #ifdef DBUS_HAVE_INT64
 119       value->u64 = DBUS_UINT64_SWAP_LE_BE (value->u64);
 120 #else
 121       swap_bytes ((unsigned char *)value, 8);
 122 #endif
 123     }
 124 }
 125
 126 #if 0
 127 static DBusBasicValue
 128 unpack_8_octets (int                  byte_order,
 129                  const unsigned char *data)
 130 {
 131   DBusBasicValue r;
 132
 133   _dbus_assert (_DBUS_ALIGN_ADDRESS (data, 8) == data);
 134   _dbus_assert (sizeof (r) == 8);
 135
 136 #ifdef DBUS_HAVE_INT64
 137   if (byte_order == DBUS_LITTLE_ENDIAN)
 138     r.u64 = DBUS_UINT64_FROM_LE (*(dbus_uint64_t*)data);
 139   else
 140     r.u64 = DBUS_UINT64_FROM_BE (*(dbus_uint64_t*)data);
 141 #else
 142   r.u64 = *(DBus8ByteStruct*)data;
 143   swap_8_octets (&r, byte_order);
 144 #endif
 145
 146   return r;
 147 }
 148 #endif
 149
 150 #ifndef _dbus_unpack_uint32
 151 /**
 152  * Unpacks a 32 bit unsigned integer from a data pointer
 153  *
 154  * @param byte_order The byte order to use
 155  * @param data the data pointer
 156  * @returns the integer
 157  */
 158 dbus_uint32_t
 159 _dbus_unpack_uint32 (int                  byte_order,
 160                      const unsigned char *data)
 161 {
 162   _dbus_assert (_DBUS_ALIGN_ADDRESS (data, 4) == data);
 163
 164   if (byte_order == DBUS_LITTLE_ENDIAN)
 165     return DBUS_UINT32_FROM_LE (*(dbus_uint32_t*)data);
 166   else
 167     return DBUS_UINT32_FROM_BE (*(dbus_uint32_t*)data);
 168 }
 169 #endif /* _dbus_unpack_uint32 */
 170
 171 static void
 172 set_4_octets (DBusString          *str,
 173               int                  offset,
 174               dbus_uint32_t        value,
 175               int                  byte_order)
 176 {
 177   char *data;
 178
 179   _dbus_assert (byte_order == DBUS_LITTLE_ENDIAN ||
 180                 byte_order == DBUS_BIG_ENDIAN);
 181
 182   data = _dbus_string_get_data_len (str, offset, 4);
 183
 184   _dbus_pack_uint32 (value, byte_order, data);
 185 }
 186
 187 static void
 188 set_8_octets (DBusString          *str,
 189               int                  offset,
 190               DBusBasicValue       value,
 191               int                  byte_order)
 192 {
 193   char *data;
 194
 195   _dbus_assert (byte_order == DBUS_LITTLE_ENDIAN ||
 196                 byte_order == DBUS_BIG_ENDIAN);
 197
 198   data = _dbus_string_get_data_len (str, offset, 8);
 199
 200   pack_8_octets (value, byte_order, data);
 201 }
 202
 203 /**
 204  * Sets the 4 bytes at the given offset to a marshaled unsigned
 205  * integer, replacing anything found there previously.
 206  *
 207  * @param str the string to write the marshalled int to
 208  * @param pos the byte offset where int should be written
 209  * @param value the value
 210  * @param byte_order the byte order to use
 211  *
 212  */
 213 void
 214 _dbus_marshal_set_uint32 (DBusString          *str,
 215                           int                  pos,
 216                           dbus_uint32_t        value,
 217                           int                  byte_order)
 218 {
 219   set_4_octets (str, pos, value, byte_order);
 220 }
 221
 222 /**
 223  * Sets the existing marshaled string at the given offset with
 224  * a new marshaled string. The given offset must point to
 225  * an existing string or the wrong length will be deleted
 226  * and replaced with the new string.
 227  *
 228  * Note: no attempt is made by this function to re-align
 229  * any data which has been already marshalled after this
 230  * string. Use with caution.
 231  *
 232  * @param str the string to write the marshalled string to
 233  * @param pos the position of the marshaled string length
 234  * @param value the value
 235  * @param byte_order the byte order to use
 236  * @param old_end_pos place to store byte after the nul byte of the old value
 237  * @param new_end_pos place to store byte after the nul byte of the new value
 238  * @returns #TRUE on success, #FALSE if no memory
 239  *
 240  */
 241 static dbus_bool_t
 242 set_string (DBusString          *str,
 243             int                  pos,
 244             const char          *value,
 245             int                  byte_order,
 246             int                 *old_end_pos,
 247             int                 *new_end_pos)
 248 {
 249   int old_len, new_len;
 250   DBusString dstr;
 251
 252   _dbus_string_init_const (&dstr, value);
 253
 254   _dbus_assert (_DBUS_ALIGN_VALUE (pos, 4) == (unsigned) pos);
 255   old_len = _dbus_unpack_uint32 (byte_order,
 256                                  _dbus_string_get_const_data_len (str, pos, 4));
 257
 258   new_len = _dbus_string_get_length (&dstr);
 259
 260   if (!_dbus_string_replace_len (&dstr, 0, new_len,
 261                                  str, pos + 4, old_len))
 262     return FALSE;
 263
 264   _dbus_marshal_set_uint32 (str, pos, new_len, byte_order);
 265
 266   if (old_end_pos)
 267     *old_end_pos = pos + 4 + old_len + 1;
 268   if (new_end_pos)
 269     *new_end_pos = pos + 4 + new_len + 1;
 270
 271   return TRUE;
 272 }
 273
 274 /**
 275  * Sets the existing marshaled signature at the given offset to a new
 276  * marshaled signature. Same basic ideas as set_string().
 277  *
 278  * @param str the string to write the marshalled signature to
 279  * @param pos the position of the marshaled signature length
 280  * @param value the value
 281  * @param byte_order the byte order to use
 282  * @param old_end_pos place to store byte after the nul byte of the old value
 283  * @param new_end_pos place to store byte after the nul byte of the new value
 284  * @returns #TRUE on success, #FALSE if no memory
 285  *
 286  */
 287 static dbus_bool_t
 288 set_signature (DBusString          *str,
 289                int                  pos,
 290                const char          *value,
 291                int                  byte_order,
 292                int                 *old_end_pos,
 293                int                 *new_end_pos)
 294 {
 295   int old_len, new_len;
 296   DBusString dstr;
 297
 298   _dbus_string_init_const (&dstr, value);
 299
 300   old_len = _dbus_string_get_byte (str, pos);
 301   new_len = _dbus_string_get_length (&dstr);
 302
 303   if (!_dbus_string_replace_len (&dstr, 0, new_len,
 304                                  str, pos + 1, old_len))
 305     return FALSE;
 306
 307   _dbus_string_set_byte (str, pos, new_len);
 308
 309   if (old_end_pos)
 310     *old_end_pos = pos + 1 + old_len + 1;
 311   if (new_end_pos)
 312     *new_end_pos = pos + 1 + new_len + 1;
 313
 314   return TRUE;
 315 }
 316
 317 /**
 318  * Sets an existing basic type value to a new value.
 319  * Arguments work the same way as _dbus_marshal_basic_type().
 320  *
 321  * @param str the string
 322  * @param pos location of the current value
 323  * @param type the type of the current and new values
 324  * @param value the address of the new value
 325  * @param byte_order byte order for marshaling
 326  * @param old_end_pos location to store end position of the old value, or #NULL
 327  * @param new_end_pos location to store end position of the new value, or #NULL
 328  * @returns #FALSE if no memory
 329  */
 330 dbus_bool_t
 331 _dbus_marshal_set_basic (DBusString       *str,
 332                          int               pos,
 333                          int               type,
 334                          const void       *value,
 335                          int               byte_order,
 336                          int              *old_end_pos,
 337                          int              *new_end_pos)
 338 {
 339   const DBusBasicValue *vp;
 340
 341   vp = value;
 342
 343   switch (type)
 344     {
 345     case DBUS_TYPE_BYTE:
 346       _dbus_string_set_byte (str, pos, vp->byt);
 347       if (old_end_pos)
 348         *old_end_pos = pos + 1;
 349       if (new_end_pos)
 350         *new_end_pos = pos + 1;
 351       return TRUE;
 352       break;
 353     case DBUS_TYPE_BOOLEAN:
 354     case DBUS_TYPE_INT32:
 355     case DBUS_TYPE_UINT32:
 356       pos = _DBUS_ALIGN_VALUE (pos, 4);
 357       set_4_octets (str, pos, vp->u32, byte_order);
 358       if (old_end_pos)
 359         *old_end_pos = pos + 4;
 360       if (new_end_pos)
 361         *new_end_pos = pos + 4;
 362       return TRUE;
 363       break;
 364     case DBUS_TYPE_INT64:
 365     case DBUS_TYPE_UINT64:
 366     case DBUS_TYPE_DOUBLE:
 367       pos = _DBUS_ALIGN_VALUE (pos, 8);
 368       set_8_octets (str, pos, *vp, byte_order);
 369       if (old_end_pos)
 370         *old_end_pos = pos + 8;
 371       if (new_end_pos)
 372         *new_end_pos = pos + 8;
 373       return TRUE;
 374       break;
 375     case DBUS_TYPE_STRING:
 376     case DBUS_TYPE_OBJECT_PATH:
 377       pos = _DBUS_ALIGN_VALUE (pos, 4);
 378       _dbus_assert (vp->str != NULL);
 379       return set_string (str, pos, vp->str, byte_order,
 380                          old_end_pos, new_end_pos);
 381       break;
 382     case DBUS_TYPE_SIGNATURE:
 383       _dbus_assert (vp->str != NULL);
 384       return set_signature (str, pos, vp->str, byte_order,
 385                             old_end_pos, new_end_pos);
 386       break;
 387     default:
 388       _dbus_assert_not_reached ("not a basic type");
 389       return FALSE;
 390       break;
 391     }
 392 }
 393
 394 /**
 395  * Convenience function to demarshal a 32 bit unsigned integer.
 396  *
 397  * @param str the string containing the data
 398  * @param byte_order the byte order
 399  * @param pos the position in the string
 400  * @param new_pos the new position of the string
 401  * @returns the demarshaled integer.
 402  */
 403 dbus_uint32_t
 404 _dbus_marshal_read_uint32  (const DBusString *str,
 405                             int               pos,
 406                             int               byte_order,
 407                             int              *new_pos)
 408 {
 409   pos = _DBUS_ALIGN_VALUE (pos, 4);
 410
 411   if (new_pos)
 412     *new_pos = pos + 4;
 413
 414   _dbus_assert (pos + 4 <= _dbus_string_get_length (str));
 415
 416   return _dbus_unpack_uint32 (byte_order,
 417                               _dbus_string_get_const_data (str) + pos);
 418 }
 419
 420 /**
 421  * Demarshals a basic-typed value. The "value" pointer is always
 422  * the address of a variable of the basic type. So e.g.
 423  * if the basic type is "double" then the pointer is
 424  * a double*, and if it's "char*" then the pointer is
 425  * a "char**".
 426  *
 427  * A value of type #DBusBasicValue is guaranteed to be large enough to
 428  * hold any of the types that may be returned, which is handy if you
 429  * are trying to do things generically. For example you can pass
 430  * a DBusBasicValue* in to this function, and then pass the same
 431  * DBusBasicValue* in to _dbus_marshal_basic_type() in order to
 432  * move a value from one place to another.
 433  *
 434  * @param str the string containing the data
 435  * @param pos position in the string
 436  * @param type type of value to demarshal
 437  * @param value pointer to return value data
 438  * @param byte_order the byte order
 439  * @param new_pos pointer to update with new position, or #NULL
 440  **/
 441 void
 442 _dbus_marshal_read_basic (const DBusString      *str,
 443                           int                    pos,
 444                           int                    type,
 445                           void                  *value,
 446                           int                    byte_order,
 447                           int                   *new_pos)
 448 {
 449   const char *str_data;
 450   DBusBasicValue *vp;
 451
 452   _dbus_assert (_dbus_type_is_basic (type));
 453
 454   str_data = _dbus_string_get_const_data (str);
 455   vp = value;
 456
 457   switch (type)
 458     {
 459     case DBUS_TYPE_BYTE:
 460       vp->byt = _dbus_string_get_byte (str, pos);
 461       (pos)++;
 462       break;
 463     case DBUS_TYPE_INT32:
 464     case DBUS_TYPE_UINT32:
 465     case DBUS_TYPE_BOOLEAN:
 466       pos = _DBUS_ALIGN_VALUE (pos, 4);
 467       vp->u32 = *(dbus_uint32_t *)(str_data + pos);
 468       if (byte_order != DBUS_COMPILER_BYTE_ORDER)
 469         vp->u32 = DBUS_UINT32_SWAP_LE_BE (vp->u32);
 470       pos += 4;
 471       break;
 472     case DBUS_TYPE_INT64:
 473     case DBUS_TYPE_UINT64:
 474     case DBUS_TYPE_DOUBLE:
 475       pos = _DBUS_ALIGN_VALUE (pos, 8);
 476 #ifdef DBUS_HAVE_INT64
 477       if (byte_order != DBUS_COMPILER_BYTE_ORDER)
 478         vp->u64 = DBUS_UINT64_SWAP_LE_BE (*(dbus_uint64_t*)(str_data + pos));
 479       else
 480         vp->u64 = *(dbus_uint64_t*)(str_data + pos);
 481 #else
 482       vp->u64 = *(DBus8ByteStruct*) (str_data + pos);
 483       swap_8_octets (vp, byte_order);
 484 #endif
 485       pos += 8;
 486       break;
 487     case DBUS_TYPE_STRING:
 488     case DBUS_TYPE_OBJECT_PATH:
 489       {
 490         int len;
 491
 492         len = _dbus_marshal_read_uint32 (str, pos, byte_order, &pos);
 493
 494         vp->str = (char*) str_data + pos;
 495
 496         pos += len + 1; /* length plus nul */
 497       }
 498       break;
 499     case DBUS_TYPE_SIGNATURE:
 500       {
 501         int len;
 502
 503         len = _dbus_string_get_byte (str, pos);
 504         pos += 1;
 505
 506         vp->str = (char*) str_data + pos;
 507
 508         pos += len + 1; /* length plus nul */
 509       }
 510       break;
 511     default:
 512       _dbus_warn ("type %s not a basic type\n",
 513                   _dbus_type_to_string (type));
 514       _dbus_assert_not_reached ("not a basic type");
 515       break;
 516     }
 517
 518   if (new_pos)
 519     *new_pos = pos;
 520 }
 521
 522 /**
 523  * Reads a block of fixed-length basic values, as an optimization
 524  * vs. reading each one individually into a new buffer.
 525  *
 526  * This function returns the data in-place; it does not make a copy,
 527  * and it does not swap the bytes.
 528  *
 529  * If you ask for #DBUS_TYPE_DOUBLE you will get a "const double*" back
 530  * and the "value" argument should be a "const double**" and so on.
 531  *
 532  * @todo we aren't using this function (except in the test suite)
 533  *
 534  * @param str the string to read from
 535  * @param pos position to read from
 536  * @param element_type type of array elements
 537  * @param value place to return the array
 538  * @param n_elements number of array elements to read
 539  * @param byte_order the byte order, used to read the array length
 540  * @param new_pos #NULL or location to store a position after the elements
 541  */
 542 void
 543 _dbus_marshal_read_fixed_multi  (const DBusString *str,
 544                                  int               pos,
 545                                  int               element_type,
 546                                  void             *value,
 547                                  int               n_elements,
 548                                  int               byte_order,
 549                                  int              *new_pos)
 550 {
 551   int array_len;
 552   int alignment;
 553
 554   _dbus_assert (_dbus_type_is_fixed (element_type));
 555   _dbus_assert (_dbus_type_is_basic (element_type));
 556
 557 #if 0
 558   _dbus_verbose ("reading %d elements of %s\n",
 559                  n_elements, _dbus_type_to_string (element_type));
 560 #endif
 561
 562   alignment = _dbus_type_get_alignment (element_type);
 563
 564   pos = _DBUS_ALIGN_VALUE (pos, alignment);
 565
 566   array_len = n_elements * alignment;
 567
 568   *(const DBusBasicValue**) value = (void*) _dbus_string_get_const_data_len (str, pos, array_len);
 569   if (new_pos)
 570     *new_pos = pos + array_len;
 571 }
 572
 573 static dbus_bool_t
 574 marshal_4_octets (DBusString   *str,
 575                   int           insert_at,
 576                   dbus_uint32_t value,
 577                   int           byte_order,
 578                   int          *pos_after)
 579 {
 580   dbus_bool_t retval;
 581   int orig_len;
 582
 583   _dbus_assert (sizeof (value) == 4);
 584
 585   if (byte_order != DBUS_COMPILER_BYTE_ORDER)
 586     value = DBUS_UINT32_SWAP_LE_BE (value);
 587
 588   orig_len = _dbus_string_get_length (str);
 589
 590   retval = _dbus_string_insert_4_aligned (str, insert_at,
 591                                           (const unsigned char *)&value);
 592
 593   if (pos_after)
 594     {
 595       *pos_after = insert_at + (_dbus_string_get_length (str) - orig_len);
 596       _dbus_assert (*pos_after <= _dbus_string_get_length (str));
 597     }
 598
 599   return retval;
 600 }
 601
 602 static dbus_bool_t
 603 marshal_8_octets (DBusString    *str,
 604                   int            insert_at,
 605                   DBusBasicValue value,
 606                   int            byte_order,
 607                   int           *pos_after)
 608 {
 609   dbus_bool_t retval;
 610   int orig_len;
 611
 612   _dbus_assert (sizeof (value) == 8);
 613
 614   swap_8_octets (&value, byte_order);
 615
 616   orig_len = _dbus_string_get_length (str);
 617
 618   retval = _dbus_string_insert_8_aligned (str, insert_at,
 619                                           (const unsigned char *)&value);
 620
 621   if (pos_after)
 622     *pos_after = insert_at + _dbus_string_get_length (str) - orig_len;
 623
 624   return retval;
 625 }
 626
 627 enum
 628   {
 629     MARSHAL_AS_STRING,
 630     MARSHAL_AS_SIGNATURE,
 631     MARSHAL_AS_BYTE_ARRAY
 632   };
 633
 634 static dbus_bool_t
 635 marshal_len_followed_by_bytes (int                  marshal_as,
 636                                DBusString          *str,
 637                                int                  insert_at,
 638                                const unsigned char *value,
 639                                int                  data_len, /* doesn't include nul if any */
 640                                int                  byte_order,
 641                                int                 *pos_after)
 642 {
 643   int pos;
 644   DBusString value_str;
 645   int value_len;
 646
 647   _dbus_assert (byte_order == DBUS_LITTLE_ENDIAN || byte_order == DBUS_BIG_ENDIAN);
 648   if (insert_at > _dbus_string_get_length (str))
 649     _dbus_warn ("insert_at = %d string len = %d data_len = %d\n",
 650                 insert_at, _dbus_string_get_length (str), data_len);
 651
 652   if (marshal_as == MARSHAL_AS_BYTE_ARRAY)
 653     value_len = data_len;
 654   else
 655     value_len = data_len + 1; /* value has a nul */
 656
 657   _dbus_string_init_const_len (&value_str, value, value_len);
 658
 659   pos = insert_at;
 660
 661   if (marshal_as == MARSHAL_AS_SIGNATURE)
 662     {
 663       if (!_dbus_string_insert_byte (str, pos, data_len))
 664         goto oom;
 665
 666       pos += 1;
 667     }
 668   else
 669     {
 670       if (!marshal_4_octets (str, pos, data_len,
 671                              byte_order, &pos))
 672         goto oom;
 673     }
 674
 675   if (!_dbus_string_copy_len (&value_str, 0, value_len,
 676                               str, pos))
 677     goto oom;
 678
 679 #if 0
 680   /* too expensive */
 681   _dbus_assert (_dbus_string_equal_substring (&value_str, 0, value_len,
 682                                               str, pos));
 683   _dbus_verbose_bytes_of_string (str, pos, value_len);
 684 #endif
 685
 686   pos += value_len;
 687
 688   if (pos_after)
 689     *pos_after = pos;
 690
 691   return TRUE;
 692
 693  oom:
 694   /* Delete what we've inserted */
 695   _dbus_string_delete (str, insert_at, pos - insert_at);
 696
 697   return FALSE;
 698 }
 699
 700 static dbus_bool_t
 701 marshal_string (DBusString    *str,
 702                 int            insert_at,
 703                 const char    *value,
 704                 int            byte_order,
 705                 int           *pos_after)
 706 {
 707   return marshal_len_followed_by_bytes (MARSHAL_AS_STRING,
 708                                         str, insert_at, value,
 709                                         strlen (value),
 710                                         byte_order, pos_after);
 711 }
 712
 713 static dbus_bool_t
 714 marshal_signature (DBusString    *str,
 715                    int            insert_at,
 716                    const char    *value,
 717                    int           *pos_after)
 718 {
 719   return marshal_len_followed_by_bytes (MARSHAL_AS_SIGNATURE,
 720                                         str, insert_at, value,
 721                                         strlen (value),
 722                                         DBUS_COMPILER_BYTE_ORDER, /* irrelevant */
 723                                         pos_after);
 724 }
 725
 726 /**
 727  * Marshals a basic-typed value. The "value" pointer is always the
 728  * address of a variable containing the basic type value.
 729  * So for example for int32 it will be dbus_int32_t*, and
 730  * for string it will be const char**. This is for symmetry
 731  * with _dbus_marshal_read_basic() and to have a simple
 732  * consistent rule.
 733  *
 734  * @param str string to marshal to
 735  * @param insert_at where to insert the value
 736  * @param type type of value
 737  * @param value pointer to a variable containing the value
 738  * @param byte_order byte order
 739  * @param pos_after #NULL or the position after the type
 740  * @returns #TRUE on success
 741  **/
 742 dbus_bool_t
 743 _dbus_marshal_write_basic (DBusString *str,
 744                            int         insert_at,
 745                            int         type,
 746                            const void *value,
 747                            int         byte_order,
 748                            int        *pos_after)
 749 {
 750   const DBusBasicValue *vp;
 751
 752   _dbus_assert (_dbus_type_is_basic (type));
 753
 754   vp = value;
 755
 756   switch (type)
 757     {
 758     case DBUS_TYPE_BYTE:
 759       if (!_dbus_string_insert_byte (str, insert_at, vp->byt))
 760         return FALSE;
 761       if (pos_after)
 762         *pos_after = insert_at + 1;
 763       return TRUE;
 764       break;
 765     case DBUS_TYPE_BOOLEAN:
 766       return marshal_4_octets (str, insert_at, vp->u32 != FALSE,
 767                                byte_order, pos_after);
 768       break;
 769     case DBUS_TYPE_INT32:
 770     case DBUS_TYPE_UINT32:
 771       return marshal_4_octets (str, insert_at, vp->u32,
 772                                byte_order, pos_after);
 773       break;
 774     case DBUS_TYPE_INT64:
 775     case DBUS_TYPE_UINT64:
 776     case DBUS_TYPE_DOUBLE:
 777       return marshal_8_octets (str, insert_at, *vp, byte_order, pos_after);
 778       break;
 779
 780     case DBUS_TYPE_STRING:
 781     case DBUS_TYPE_OBJECT_PATH:
 782       _dbus_assert (vp->str != NULL);
 783       return marshal_string (str, insert_at, vp->str, byte_order, pos_after);
 784       break;
 785     case DBUS_TYPE_SIGNATURE:
 786       _dbus_assert (vp->str != NULL);
 787       return marshal_signature (str, insert_at, vp->str, pos_after);
 788       break;
 789     default:
 790       _dbus_assert_not_reached ("not a basic type");
 791       return FALSE;
 792       break;
 793     }
 794 }
 795
 796 static dbus_bool_t
 797 marshal_1_octets_array (DBusString          *str,
 798                         int                  insert_at,
 799                         const unsigned char *value,
 800                         int                  n_elements,
 801                         int                  byte_order,
 802                         int                 *pos_after)
 803 {
 804   int pos;
 805   DBusString value_str;
 806
 807   _dbus_string_init_const_len (&value_str, value, n_elements);
 808
 809   pos = insert_at;
 810
 811   if (!_dbus_string_copy_len (&value_str, 0, n_elements,
 812                               str, pos))
 813     return FALSE;
 814
 815   pos += n_elements;
 816
 817   if (pos_after)
 818     *pos_after = pos;
 819
 820   return TRUE;
 821 }
 822
 823 static void
 824 swap_array (DBusString *str,
 825             int         array_start,
 826             int         n_elements,
 827             int         byte_order,
 828             int         alignment)
 829 {
 830   _dbus_assert (_DBUS_ALIGN_VALUE (array_start, alignment) == (unsigned) array_start);
 831
 832   if (byte_order != DBUS_COMPILER_BYTE_ORDER)
 833     {
 834       unsigned char *d;
 835       unsigned char *end;
 836
 837       /* we use const_data and cast it off so DBusString can be a const string
 838        * for the unit tests. don't ask.
 839        */
 840       d = (unsigned char*) _dbus_string_get_const_data (str) + array_start;
 841       end = d + n_elements * alignment;
 842
 843       if (alignment == 8)
 844         {
 845           while (d != end)
 846             {
 847 #ifdef DBUS_HAVE_INT64
 848               *((dbus_uint64_t*)d) = DBUS_UINT64_SWAP_LE_BE (*((dbus_uint64_t*)d));
 849 #else
 850               swap_8_bytes ((DBusBasicValue*) d);
 851 #endif
 852               d += 8;
 853             }
 854         }
 855       else
 856         {
 857           _dbus_assert (alignment == 4);
 858
 859           while (d != end)
 860             {
 861               *((dbus_uint32_t*)d) = DBUS_UINT32_SWAP_LE_BE (*((dbus_uint32_t*)d));
 862               d += 4;
 863             }
 864         }
 865     }
 866 }
 867
 868 static dbus_bool_t
 869 marshal_fixed_multi (DBusString           *str,
 870                      int                   insert_at,
 871                      const DBusBasicValue *value,
 872                      int                   n_elements,
 873                      int                   byte_order,
 874                      int                   alignment,
 875                      int                  *pos_after)
 876 {
 877   int old_string_len;
 878   int array_start;
 879   DBusString t;
 880   int len_in_bytes;
 881
 882   _dbus_assert (n_elements <= DBUS_MAXIMUM_ARRAY_LENGTH / alignment);
 883
 884   old_string_len = _dbus_string_get_length (str);
 885
 886   len_in_bytes = n_elements * alignment;
 887   array_start = insert_at;
 888
 889   /* Note that we do alignment padding unconditionally
 890    * even if the array is empty; this means that
 891    * padding + len is always equal to the number of bytes
 892    * in the array.
 893    */
 894
 895   if (!_dbus_string_insert_alignment (str, &array_start, alignment))
 896     goto error;
 897
 898   _dbus_string_init_const_len (&t,
 899                                (const unsigned char*) value,
 900                                len_in_bytes);
 901
 902   if (!_dbus_string_copy (&t, 0,
 903                           str, array_start))
 904     goto error;
 905
 906   swap_array (str, array_start, n_elements, byte_order, alignment);
 907
 908   if (pos_after)
 909     *pos_after = array_start + len_in_bytes;
 910
 911   return TRUE;
 912
 913  error:
 914   _dbus_string_delete (str, insert_at,
 915                        _dbus_string_get_length (str) - old_string_len);
 916
 917   return FALSE;
 918 }
 919
 920 /**
 921  * Marshals a block of values of fixed-length type all at once, as an
 922  * optimization.  _dbus_type_is_fixed() returns #TRUE for fixed-length
 923  * types, which are the basic types minus the string-like types.
 924  *
 925  * The value argument should be the adddress of an
 926  * array, so e.g. "const dbus_uint32_t**"
 927  *
 928  * @param str string to marshal to
 929  * @param insert_at where to insert the value
 930  * @param element_type type of array elements
 931  * @param value address of an array to marshal
 932  * @param n_elements number of elements in the array
 933  * @param byte_order byte order
 934  * @param pos_after #NULL or the position after the type
 935  * @returns #TRUE on success
 936  **/
 937 dbus_bool_t
 938 _dbus_marshal_write_fixed_multi (DBusString *str,
 939                                  int         insert_at,
 940                                  int         element_type,
 941                                  const void *value,
 942                                  int         n_elements,
 943                                  int         byte_order,
 944                                  int        *pos_after)
 945 {
 946   const void* vp = *(const DBusBasicValue**)value;
 947
 948   _dbus_assert (_dbus_type_is_fixed (element_type));
 949   _dbus_assert (n_elements >= 0);
 950
 951 #if 0
 952   _dbus_verbose ("writing %d elements of %s\n",
 953                  n_elements, _dbus_type_to_string (element_type));
 954 #endif
 955
 956   switch (element_type)
 957     {
 958     case DBUS_TYPE_BYTE:
 959       return marshal_1_octets_array (str, insert_at, vp, n_elements, byte_order, pos_after);
 960       break;
 961       /* FIXME: we canonicalize to 0 or 1 for the single boolean case
 962        * should we here too ? */
 963     case DBUS_TYPE_BOOLEAN:
 964     case DBUS_TYPE_INT32:
 965     case DBUS_TYPE_UINT32:
 966       return marshal_fixed_multi (str, insert_at, vp, n_elements, byte_order, 4, pos_after);
 967       break;
 968     case DBUS_TYPE_INT64:
 969     case DBUS_TYPE_UINT64:
 970     case DBUS_TYPE_DOUBLE:
 971       return marshal_fixed_multi (str, insert_at, vp, n_elements, byte_order, 8, pos_after);
 972       break;
 973
 974     default:
 975       _dbus_assert_not_reached ("non fixed type in array write");
 976       break;
 977     }
 978
 979   return FALSE;
 980 }
 981
 982
 983 /**
 984  * Skips over a basic-typed value, reporting the following position.
 985  *
 986  * @param str the string containing the data
 987  * @param type type of value to read
 988  * @param byte_order the byte order
 989  * @param pos pointer to position in the string,
 990  *            updated on return to new position
 991  **/
 992 void
 993 _dbus_marshal_skip_basic (const DBusString      *str,
 994                           int                    type,
 995                           int                    byte_order,
 996                           int                   *pos)
 997 {
 998   _dbus_assert (byte_order == DBUS_LITTLE_ENDIAN ||
 999                 byte_order == DBUS_BIG_ENDIAN);
1000
1001   switch (type)
1002     {
1003     case DBUS_TYPE_BYTE:
1004       (*pos)++;
1005       break;
1006     case DBUS_TYPE_BOOLEAN:
1007     case DBUS_TYPE_INT32:
1008     case DBUS_TYPE_UINT32:
1009       *pos = _DBUS_ALIGN_VALUE (*pos, 4);
1010       *pos += 4;
1011       break;
1012     case DBUS_TYPE_INT64:
1013     case DBUS_TYPE_UINT64:
1014     case DBUS_TYPE_DOUBLE:
1015       *pos = _DBUS_ALIGN_VALUE (*pos, 8);
1016       *pos += 8;
1017       break;
1018     case DBUS_TYPE_STRING:
1019     case DBUS_TYPE_OBJECT_PATH:
1020       {
1021         int len;
1022
1023         len = _dbus_marshal_read_uint32 (str, *pos, byte_order, pos);
1024
1025         *pos += len + 1; /* length plus nul */
1026       }
1027       break;
1028     case DBUS_TYPE_SIGNATURE:
1029       {
1030         int len;
1031
1032         len = _dbus_string_get_byte (str, *pos);
1033
1034         *pos += len + 2; /* length byte plus length plus nul */
1035       }
1036       break;
1037     default:
1038       _dbus_warn ("type %s not a basic type\n",
1039                   _dbus_type_to_string (type));
1040       _dbus_assert_not_reached ("not a basic type");
1041       break;
1042     }
1043 }
1044
1045 /**
1046  * Skips an array, returning the next position.
1047  *
1048  * @param str the string containing the data
1049  * @param element_type the type of array elements
1050  * @param byte_order the byte order
1051  * @param pos pointer to position in the string,
1052  *            updated on return to new position
1053  */
1054 void
1055 _dbus_marshal_skip_array (const DBusString  *str,
1056                           int                element_type,
1057                           int                byte_order,
1058                           int               *pos)
1059 {
1060   dbus_uint32_t array_len;
1061   int i;
1062   int alignment;
1063
1064   i = _DBUS_ALIGN_VALUE (*pos, 4);
1065
1066   array_len = _dbus_marshal_read_uint32 (str, i, byte_order, &i);
1067
1068   alignment = _dbus_type_get_alignment (element_type);
1069
1070   i = _DBUS_ALIGN_VALUE (i, alignment);
1071
1072   *pos = i + array_len;
1073 }
1074
1075 /**
1076  * Gets the alignment requirement for the given type;
1077  * will be 1, 4, or 8.
1078  *
1079  * @param typecode the type
1080  * @returns alignment of 1, 4, or 8
1081  */
1082 int
1083 _dbus_type_get_alignment (int typecode)
1084 {
1085   switch (typecode)
1086     {
1087     case DBUS_TYPE_BYTE:
1088     case DBUS_TYPE_VARIANT:
1089     case DBUS_TYPE_SIGNATURE:
1090       return 1;
1091     case DBUS_TYPE_BOOLEAN:
1092     case DBUS_TYPE_INT32:
1093     case DBUS_TYPE_UINT32:
1094       /* this stuff is 4 since it starts with a length */
1095     case DBUS_TYPE_STRING:
1096     case DBUS_TYPE_OBJECT_PATH:
1097     case DBUS_TYPE_ARRAY:
1098       return 4;
1099     case DBUS_TYPE_INT64:
1100     case DBUS_TYPE_UINT64:
1101     case DBUS_TYPE_DOUBLE:
1102       /* struct is 8 since it could contain an 8-aligned item
1103        * and it's simpler to just always align structs to 8;
1104        * we want the amount of padding in a struct of a given
1105        * type to be predictable, not location-dependent.
1106        */
1107     case DBUS_TYPE_STRUCT:
1108       return 8;
1109
1110     default:
1111       _dbus_assert_not_reached ("unknown typecode in _dbus_type_get_alignment()");
1112       return 0;
1113     }
1114 }
1115
1116
1117 /**
1118  * Return #TRUE if the typecode is a valid typecode.
1119  * #DBUS_TYPE_INVALID surprisingly enough is not considered valid, and
1120  * random unknown bytes aren't either. This function is safe with
1121  * untrusted data.
1122  *
1123  * @returns #TRUE if valid
1124  */
1125 dbus_bool_t
1126 _dbus_type_is_valid (int typecode)
1127 {
1128   switch (typecode)
1129     {
1130     case DBUS_TYPE_BYTE:
1131     case DBUS_TYPE_BOOLEAN:
1132     case DBUS_TYPE_INT32:
1133     case DBUS_TYPE_UINT32:
1134     case DBUS_TYPE_INT64:
1135     case DBUS_TYPE_UINT64:
1136     case DBUS_TYPE_DOUBLE:
1137     case DBUS_TYPE_STRING:
1138     case DBUS_TYPE_OBJECT_PATH:
1139     case DBUS_TYPE_SIGNATURE:
1140     case DBUS_TYPE_ARRAY:
1141     case DBUS_TYPE_STRUCT:
1142     case DBUS_TYPE_VARIANT:
1143       return TRUE;
1144
1145     default:
1146       return FALSE;
1147     }
1148 }
1149
1150 /** macro that checks whether a typecode is a container type */
1151 #define TYPE_IS_CONTAINER(typecode)             \
1152     ((typecode) == DBUS_TYPE_STRUCT ||          \
1153      (typecode) == DBUS_TYPE_VARIANT ||         \
1154      (typecode) == DBUS_TYPE_ARRAY)
1155
1156 /**
1157  * A "container type" can contain basic types, or nested
1158  * container types. #DBUS_TYPE_INVALID is not a container type.
1159  * This function will crash if passed a typecode that isn't
1160  * in dbus-protocol.h
1161  *
1162  * @returns #TRUE if type is a container
1163  */
1164 dbus_bool_t
1165 _dbus_type_is_container (int typecode)
1166 {
1167   /* only reasonable (non-line-noise) typecodes are allowed */
1168   _dbus_assert (_dbus_type_is_valid (typecode) || typecode == DBUS_TYPE_INVALID);
1169   return TYPE_IS_CONTAINER (typecode);
1170 }
1171
1172 /**
1173  * A "basic type" is a somewhat arbitrary concept, but the intent
1174  * is to include those types that are fully-specified by a single
1175  * typecode, with no additional type information or nested
1176  * values. So all numbers and strings are basic types and
1177  * structs, arrays, and variants are not basic types.
1178  * #DBUS_TYPE_INVALID is not a basic type.
1179  *
1180  * This function is defined to return #TRUE for exactly those
1181  * types that can be written with _dbus_marshal_basic_type()
1182  * and read with _dbus_marshal_read_basic().
1183  *
1184  * This function will crash if passed a typecode that isn't
1185  * in dbus-protocol.h
1186  *
1187  * @returns #TRUE if type is basic
1188  */
1189 dbus_bool_t
1190 _dbus_type_is_basic (int typecode)
1191 {
1192   /* only reasonable (non-line-noise) typecodes are allowed */
1193   _dbus_assert (_dbus_type_is_valid (typecode) || typecode == DBUS_TYPE_INVALID);
1194
1195   /* everything that isn't invalid or a container */
1196   return !(typecode == DBUS_TYPE_INVALID || TYPE_IS_CONTAINER (typecode));
1197 }
1198
1199 /**
1200  * Tells you whether values of this type can change length if you set
1201  * them to some other value. For this purpose, you assume that the
1202  * first byte of the old and new value would be in the same location,
1203  * so alignment padding is not a factor.
1204  *
1205  * @returns #FALSE if the type can occupy different lengths
1206  */
1207 dbus_bool_t
1208 _dbus_type_is_fixed (int typecode)
1209 {
1210   switch (typecode)
1211     {
1212     case DBUS_TYPE_BYTE:
1213     case DBUS_TYPE_BOOLEAN:
1214     case DBUS_TYPE_INT32:
1215     case DBUS_TYPE_UINT32:
1216     case DBUS_TYPE_INT64:
1217     case DBUS_TYPE_UINT64:
1218     case DBUS_TYPE_DOUBLE:
1219       return TRUE;
1220     default:
1221       return FALSE;
1222     }
1223 }
1224
1225 /**
1226  * Returns a string describing the given type.
1227  *
1228  * @param typecode the type to describe
1229  * @returns a constant string describing the type
1230  */
1231 const char *
1232 _dbus_type_to_string (int typecode)
1233 {
1234   switch (typecode)
1235     {
1236     case DBUS_TYPE_INVALID:
1237       return "invalid";
1238     case DBUS_TYPE_BOOLEAN:
1239       return "boolean";
1240     case DBUS_TYPE_BYTE:
1241       return "byte";
1242     case DBUS_TYPE_INT32:
1243       return "int32";
1244     case DBUS_TYPE_UINT32:
1245       return "uint32";
1246     case DBUS_TYPE_DOUBLE:
1247       return "double";
1248     case DBUS_TYPE_STRING:
1249       return "string";
1250     case DBUS_TYPE_OBJECT_PATH:
1251       return "object_path";
1252     case DBUS_TYPE_SIGNATURE:
1253       return "signature";
1254     case DBUS_TYPE_STRUCT:
1255       return "struct";
1256     case DBUS_TYPE_ARRAY:
1257       return "array";
1258     case DBUS_TYPE_VARIANT:
1259       return "variant";
1260     case DBUS_STRUCT_BEGIN_CHAR:
1261       return "begin_struct";
1262     case DBUS_STRUCT_END_CHAR:
1263       return "end_struct";
1264     default:
1265       return "unknown";
1266     }
1267 }
1268
1269 /**
1270  * If in verbose mode, print a block of binary data.
1271  *
1272  * @todo right now it prints even if not in verbose mode
1273  *
1274  * @param data the data
1275  * @param len the length of the data
1276  * @param offset where to start counting for byte indexes
1277  */
1278 void
1279 _dbus_verbose_bytes (const unsigned char *data,
1280                      int                  len,
1281                      int                  offset)
1282 {
1283   int i;
1284   const unsigned char *aligned;
1285
1286   _dbus_assert (len >= 0);
1287
1288   /* Print blanks on first row if appropriate */
1289   aligned = _DBUS_ALIGN_ADDRESS (data, 4);
1290   if (aligned > data)
1291     aligned -= 4;
1292   _dbus_assert (aligned <= data);
1293
1294   if (aligned != data)
1295     {
1296       _dbus_verbose ("%4d\t%p: ", - (data - aligned), aligned);
1297       while (aligned != data)
1298         {
1299           _dbus_verbose ("    ");
1300           ++aligned;
1301         }
1302     }
1303
1304   /* now print the bytes */
1305   i = 0;
1306   while (i < len)
1307     {
1308       if (_DBUS_ALIGN_ADDRESS (&data[i], 4) == &data[i])
1309         {
1310           _dbus_verbose ("%4d\t%p: ",
1311                          offset + i, &data[i]);
1312         }
1313
1314       if (data[i] >= 32 &&
1315           data[i] <= 126)
1316         _dbus_verbose (" '%c' ", data[i]);
1317       else
1318         _dbus_verbose ("0x%s%x ",
1319                        data[i] <= 0xf ? "0" : "", data[i]);
1320
1321       ++i;
1322
1323       if (_DBUS_ALIGN_ADDRESS (&data[i], 4) == &data[i])
1324         {
1325           if (i > 3)
1326             _dbus_verbose ("BE: %d LE: %d",
1327                            _dbus_unpack_uint32 (DBUS_BIG_ENDIAN, &data[i-4]),
1328                            _dbus_unpack_uint32 (DBUS_LITTLE_ENDIAN, &data[i-4]));
1329
1330           if (i > 7 &&
1331               _DBUS_ALIGN_ADDRESS (&data[i], 8) == &data[i])
1332             {
1333 #ifdef DBUS_HAVE_INT64
1334               /* I think I probably mean "GNU libc printf" and not "GNUC"
1335                * but we'll wait until someone complains. If you hit this,
1336                * just turn off verbose mode as a workaround.
1337                */
1338 #if __GNUC__
1339               _dbus_verbose (" u64: 0x%llx",
1340                              *(dbus_uint64_t*)&data[i-8]);
1341 #endif
1342 #endif
1343               _dbus_verbose (" dbl: %g",
1344                              *(double*)&data[i-8]);
1345             }
1346
1347           _dbus_verbose ("\n");
1348         }
1349     }
1350
1351   _dbus_verbose ("\n");
1352 }
1353
1354 /**
1355  * Dump the given part of the string to verbose log.
1356  *
1357  * @param str the string
1358  * @param start the start of range to dump
1359  * @param len length of range
1360  */
1361 void
1362 _dbus_verbose_bytes_of_string (const DBusString    *str,
1363                                int                  start,
1364                                int                  len)
1365 {
1366   const char *d;
1367   int real_len;
1368
1369   real_len = _dbus_string_get_length (str);
1370
1371   _dbus_assert (start >= 0);
1372
1373   if (start > real_len)
1374     {
1375       _dbus_verbose ("  [%d,%d) is not inside string of length %d\n",
1376                      start, len, real_len);
1377       return;
1378     }
1379
1380   if ((start + len) > real_len)
1381     {
1382       _dbus_verbose ("  [%d,%d) extends outside string of length %d\n",
1383                      start, len, real_len);
1384       len = real_len - start;
1385     }
1386
1387   d = _dbus_string_get_const_data_len (str, start, len);
1388
1389   _dbus_verbose_bytes (d, len, start);
1390 }
1391
1392 /** @} */
1393
1394 #ifdef DBUS_BUILD_TESTS
1395 #include "dbus-test.h"
1396 #include <stdio.h>
1397
1398 static void
1399 swap_test_array (void *array,
1400                  int   len_bytes,
1401                  int   byte_order,
1402                  int   alignment)
1403 {
1404   DBusString t;
1405
1406   if (alignment == 1)
1407     return;
1408
1409   _dbus_string_init_const_len (&t, array, len_bytes);
1410   swap_array (&t, 0, len_bytes / alignment, byte_order, alignment);
1411 }
1412
1413 #define MARSHAL_BASIC(typename, byte_order, literal)                    \
1414   do {                                                                  \
1415      v_##typename = literal;                                            \
1416      if (!_dbus_marshal_write_basic (&str, pos, DBUS_TYPE_##typename,   \
1417                                     &v_##typename,                      \
1418                                     byte_order, NULL))                  \
1419        _dbus_assert_not_reached ("no memory");                          \
1420    } while (0)
1421
1422 #define DEMARSHAL_BASIC(typename, byte_order)                                   \
1423   do {                                                                          \
1424     _dbus_marshal_read_basic (&str, pos, DBUS_TYPE_##typename, &v_##typename,   \
1425                               byte_order, &pos);                                \
1426   } while (0)
1427
1428 #define DEMARSHAL_BASIC_AND_CHECK(typename, byte_order, literal)                        \
1429   do {                                                                                  \
1430     DEMARSHAL_BASIC (typename, byte_order);                                             \
1431     if (literal != v_##typename)                                                        \
1432       {                                                                                 \
1433         _dbus_verbose_bytes_of_string (&str, dump_pos,                                  \
1434                                      _dbus_string_get_length (&str) - dump_pos);        \
1435         _dbus_assert_not_reached ("demarshaled wrong value");                           \
1436       }                                                                                 \
1437   } while (0)
1438
1439 #define MARSHAL_TEST(typename, byte_order, literal)             \
1440   do {                                                          \
1441     MARSHAL_BASIC (typename, byte_order, literal);              \
1442     dump_pos = pos;                                             \
1443     DEMARSHAL_BASIC_AND_CHECK (typename, byte_order, literal);  \
1444   } while (0)
1445
1446 #define MARSHAL_TEST_STRCMP(typename, byte_order, literal)                              \
1447   do {                                                                                  \
1448     MARSHAL_BASIC (typename, byte_order, literal);                                      \
1449     dump_pos = pos;                                                                     \
1450     DEMARSHAL_BASIC (typename, byte_order);                                             \
1451     if (strcmp (literal, v_##typename) != 0)                                            \
1452       {                                                                                 \
1453         _dbus_verbose_bytes_of_string (&str, dump_pos,                                  \
1454                                        _dbus_string_get_length (&str) - dump_pos);      \
1455         _dbus_warn ("literal '%s'\nvalue  '%s'\n", literal, v_##typename);              \
1456         _dbus_assert_not_reached ("demarshaled wrong value");                           \
1457       }                                                                                 \
1458   } while (0)
1459
1460 #define MARSHAL_FIXED_ARRAY(typename, byte_order, literal)                                      \
1461   do {                                                                                          \
1462      int next;                                                                                  \
1463      v_UINT32 = sizeof(literal);                                                                \
1464      if (!_dbus_marshal_write_basic (&str, pos, DBUS_TYPE_UINT32, &v_UINT32,                    \
1465                                      byte_order, &next))                                        \
1466        _dbus_assert_not_reached ("no memory");                                                  \
1467      v_ARRAY_##typename = literal;                                                              \
1468      if (!_dbus_marshal_write_fixed_multi (&str, next, DBUS_TYPE_##typename,                    \
1469                                            &v_ARRAY_##typename, _DBUS_N_ELEMENTS(literal),      \
1470                                            byte_order, NULL))                                   \
1471        _dbus_assert_not_reached ("no memory");                                                  \
1472    } while (0)
1473
1474 #define DEMARSHAL_FIXED_ARRAY(typename, byte_order)                                             \
1475   do {                                                                                          \
1476     int next;                                                                                   \
1477     alignment = _dbus_type_get_alignment (DBUS_TYPE_##typename);                                \
1478     v_UINT32 = _dbus_marshal_read_uint32 (&str, dump_pos, byte_order, &next);                   \
1479     _dbus_marshal_read_fixed_multi (&str, next, DBUS_TYPE_##typename, &v_ARRAY_##typename,      \
1480                                     v_UINT32/alignment,                                         \
1481                                     byte_order, NULL);                                          \
1482     swap_test_array (v_ARRAY_##typename, v_UINT32,                                              \
1483                      byte_order, alignment);                                                    \
1484   } while (0)
1485
1486 #define DEMARSHAL_FIXED_ARRAY_AND_CHECK(typename, byte_order, literal)                  \
1487   do {                                                                                  \
1488     DEMARSHAL_FIXED_ARRAY (typename, byte_order);                                       \
1489     if (memcmp (literal, v_ARRAY_##typename, sizeof (literal) != 0))                    \
1490       {                                                                                 \
1491         _dbus_verbose ("MARSHALED DATA\n");                                             \
1492         _dbus_verbose_bytes_of_string (&str, dump_pos,                                  \
1493                                       _dbus_string_get_length (&str) - dump_pos);       \
1494         _dbus_verbose ("LITERAL DATA\n");                                               \
1495         _dbus_verbose_bytes ((char*)literal, sizeof (literal), 0);                      \
1496         _dbus_verbose ("READ DATA\n");                                                  \
1497         _dbus_verbose_bytes ((char*)v_ARRAY_##typename, sizeof (literal), 0);           \
1498         _dbus_assert_not_reached ("demarshaled wrong fixed array value");               \
1499       }                                                                                 \
1500   } while (0)
1501
1502 #define MARSHAL_TEST_FIXED_ARRAY(typename, byte_order, literal)         \
1503   do {                                                                  \
1504     MARSHAL_FIXED_ARRAY (typename, byte_order, literal);                \
1505     dump_pos = pos;                                                     \
1506     DEMARSHAL_FIXED_ARRAY_AND_CHECK (typename, byte_order, literal);    \
1507   } while (0)
1508
1509 dbus_bool_t
1510 _dbus_marshal_test (void)
1511 {
1512   int alignment;
1513   DBusString str;
1514   int pos, dump_pos;
1515   unsigned char array1[5] = { 3, 4, 0, 1, 9 };
1516   dbus_int32_t array4[3] = { 123, 456, 789 };
1517 #ifdef DBUS_HAVE_INT64
1518   dbus_int64_t array8[3] = { DBUS_INT64_CONSTANT (0x123ffffffff),
1519                              DBUS_INT64_CONSTANT (0x456ffffffff),
1520                              DBUS_INT64_CONSTANT (0x789ffffffff) };
1521   dbus_int64_t *v_ARRAY_INT64;
1522 #endif
1523   unsigned char *v_ARRAY_BYTE;
1524   dbus_int32_t *v_ARRAY_INT32;
1525   double *v_ARRAY_DOUBLE;
1526   DBusString t;
1527   double v_DOUBLE;
1528   double t_DOUBLE;
1529   dbus_int32_t v_INT32;
1530   dbus_uint32_t v_UINT32;
1531   dbus_int64_t v_INT64;
1532   dbus_uint64_t v_UINT64;
1533   unsigned char v_BYTE;
1534   dbus_bool_t v_BOOLEAN;
1535   const char *v_STRING;
1536   const char *v_SIGNATURE;
1537   const char *v_OBJECT_PATH;
1538   int byte_order;
1539
1540   if (!_dbus_string_init (&str))
1541     _dbus_assert_not_reached ("failed to init string");
1542
1543   pos = 0;
1544
1545   /* Marshal doubles */
1546   MARSHAL_BASIC (DOUBLE, DBUS_BIG_ENDIAN, 3.14);
1547   DEMARSHAL_BASIC (DOUBLE, DBUS_BIG_ENDIAN);
1548   t_DOUBLE = 3.14;
1549   if (!_DBUS_DOUBLES_BITWISE_EQUAL (t_DOUBLE, v_DOUBLE))
1550     _dbus_assert_not_reached ("got wrong double value");
1551
1552   MARSHAL_BASIC (DOUBLE, DBUS_LITTLE_ENDIAN, 3.14);
1553   DEMARSHAL_BASIC (DOUBLE, DBUS_LITTLE_ENDIAN);
1554   t_DOUBLE = 3.14;
1555   if (!_DBUS_DOUBLES_BITWISE_EQUAL (t_DOUBLE, v_DOUBLE))
1556     _dbus_assert_not_reached ("got wrong double value");
1557
1558   /* Marshal signed integers */
1559   MARSHAL_TEST (INT32, DBUS_BIG_ENDIAN, -12345678);
1560   MARSHAL_TEST (INT32, DBUS_LITTLE_ENDIAN, -12345678);
1561
1562   /* Marshal unsigned integers */
1563   MARSHAL_TEST (UINT32, DBUS_BIG_ENDIAN, 0x12345678);
1564   MARSHAL_TEST (UINT32, DBUS_LITTLE_ENDIAN, 0x12345678);
1565
1566 #ifdef DBUS_HAVE_INT64
1567   /* Marshal signed integers */
1568   MARSHAL_TEST (INT64, DBUS_BIG_ENDIAN, DBUS_INT64_CONSTANT (-0x123456789abc7));
1569   MARSHAL_TEST (INT64, DBUS_LITTLE_ENDIAN, DBUS_INT64_CONSTANT (-0x123456789abc7));
1570
1571   /* Marshal unsigned integers */
1572   MARSHAL_TEST (UINT64, DBUS_BIG_ENDIAN, DBUS_UINT64_CONSTANT (0x123456789abc7));
1573   MARSHAL_TEST (UINT64, DBUS_LITTLE_ENDIAN, DBUS_UINT64_CONSTANT (0x123456789abc7));
1574 #endif /* DBUS_HAVE_INT64 */
1575
1576   /* Marshal byte */
1577   MARSHAL_TEST (BYTE, DBUS_BIG_ENDIAN, 5);
1578   MARSHAL_TEST (BYTE, DBUS_LITTLE_ENDIAN, 5);
1579
1580   /* Marshal all possible bools! */
1581   MARSHAL_TEST (BOOLEAN, DBUS_BIG_ENDIAN, FALSE);
1582   MARSHAL_TEST (BOOLEAN, DBUS_LITTLE_ENDIAN, FALSE);
1583   MARSHAL_TEST (BOOLEAN, DBUS_BIG_ENDIAN, TRUE);
1584   MARSHAL_TEST (BOOLEAN, DBUS_LITTLE_ENDIAN, TRUE);
1585
1586   /* Marshal strings */
1587   MARSHAL_TEST_STRCMP (STRING, DBUS_BIG_ENDIAN, "");
1588   MARSHAL_TEST_STRCMP (STRING, DBUS_LITTLE_ENDIAN, "");
1589   MARSHAL_TEST_STRCMP (STRING, DBUS_BIG_ENDIAN, "This is the dbus test string");
1590   MARSHAL_TEST_STRCMP (STRING, DBUS_LITTLE_ENDIAN, "This is the dbus test string");
1591
1592   /* object paths */
1593   MARSHAL_TEST_STRCMP (OBJECT_PATH, DBUS_BIG_ENDIAN, "/a/b/c");
1594   MARSHAL_TEST_STRCMP (OBJECT_PATH, DBUS_LITTLE_ENDIAN, "/a/b/c");
1595
1596   /* signatures */
1597   MARSHAL_TEST_STRCMP (SIGNATURE, DBUS_BIG_ENDIAN, "");
1598   MARSHAL_TEST_STRCMP (SIGNATURE, DBUS_LITTLE_ENDIAN, "");
1599   MARSHAL_TEST_STRCMP (SIGNATURE, DBUS_BIG_ENDIAN, "a(ii)");
1600   MARSHAL_TEST_STRCMP (SIGNATURE, DBUS_LITTLE_ENDIAN, "a(ii)");
1601
1602   /* Arrays */
1603   MARSHAL_TEST_FIXED_ARRAY (INT32, DBUS_BIG_ENDIAN, array4);
1604   MARSHAL_TEST_FIXED_ARRAY (INT32, DBUS_LITTLE_ENDIAN, array4);
1605
1606   MARSHAL_TEST_FIXED_ARRAY (BYTE, DBUS_BIG_ENDIAN, array1);
1607   MARSHAL_TEST_FIXED_ARRAY (BYTE, DBUS_LITTLE_ENDIAN, array1);
1608
1609 #ifdef DBUS_HAVE_INT64
1610   MARSHAL_TEST_FIXED_ARRAY (INT64, DBUS_BIG_ENDIAN, array8);
1611   MARSHAL_TEST_FIXED_ARRAY (INT64, DBUS_LITTLE_ENDIAN, array8);
1612 #endif
1613
1614 #if 0
1615
1616   /*
1617    * FIXME restore the set/pack tests
1618    */
1619
1620 #ifdef DBUS_HAVE_INT64
1621   /* set/pack 64-bit integers */
1622   _dbus_string_set_length (&str, 8);
1623
1624   /* signed little */
1625   _dbus_marshal_set_int64 (&str, DBUS_LITTLE_ENDIAN,
1626                            0, DBUS_INT64_CONSTANT (-0x123456789abc7));
1627
1628   _dbus_assert (DBUS_INT64_CONSTANT (-0x123456789abc7) ==
1629                 _dbus_unpack_int64 (DBUS_LITTLE_ENDIAN,
1630                                     _dbus_string_get_const_data (&str)));
1631
1632   /* signed big */
1633   _dbus_marshal_set_int64 (&str, DBUS_BIG_ENDIAN,
1634                            0, DBUS_INT64_CONSTANT (-0x123456789abc7));
1635
1636   _dbus_assert (DBUS_INT64_CONSTANT (-0x123456789abc7) ==
1637                 _dbus_unpack_int64 (DBUS_BIG_ENDIAN,
1638                                     _dbus_string_get_const_data (&str)));
1639
1640   /* signed little pack */
1641   _dbus_pack_int64 (DBUS_INT64_CONSTANT (-0x123456789abc7),
1642                     DBUS_LITTLE_ENDIAN,
1643                     _dbus_string_get_data (&str));
1644
1645   _dbus_assert (DBUS_INT64_CONSTANT (-0x123456789abc7) ==
1646                 _dbus_unpack_int64 (DBUS_LITTLE_ENDIAN,
1647                                     _dbus_string_get_const_data (&str)));
1648
1649   /* signed big pack */
1650   _dbus_pack_int64 (DBUS_INT64_CONSTANT (-0x123456789abc7),
1651                     DBUS_BIG_ENDIAN,
1652                     _dbus_string_get_data (&str));
1653
1654   _dbus_assert (DBUS_INT64_CONSTANT (-0x123456789abc7) ==
1655                 _dbus_unpack_int64 (DBUS_BIG_ENDIAN,
1656                                     _dbus_string_get_const_data (&str)));
1657
1658   /* unsigned little */
1659   _dbus_marshal_set_uint64 (&str, DBUS_LITTLE_ENDIAN,
1660                             0, DBUS_UINT64_CONSTANT (0x123456789abc7));
1661
1662   _dbus_assert (DBUS_UINT64_CONSTANT (0x123456789abc7) ==
1663                 _dbus_unpack_uint64 (DBUS_LITTLE_ENDIAN,
1664                                      _dbus_string_get_const_data (&str)));
1665
1666   /* unsigned big */
1667   _dbus_marshal_set_uint64 (&str, DBUS_BIG_ENDIAN,
1668                             0, DBUS_UINT64_CONSTANT (0x123456789abc7));
1669
1670   _dbus_assert (DBUS_UINT64_CONSTANT (0x123456789abc7) ==
1671                 _dbus_unpack_uint64 (DBUS_BIG_ENDIAN,
1672                                      _dbus_string_get_const_data (&str)));
1673
1674   /* unsigned little pack */
1675   _dbus_pack_uint64 (DBUS_UINT64_CONSTANT (0x123456789abc7),
1676                      DBUS_LITTLE_ENDIAN,
1677                      _dbus_string_get_data (&str));
1678
1679   _dbus_assert (DBUS_UINT64_CONSTANT (0x123456789abc7) ==
1680                 _dbus_unpack_uint64 (DBUS_LITTLE_ENDIAN,
1681                                      _dbus_string_get_const_data (&str)));
1682
1683   /* unsigned big pack */
1684   _dbus_pack_uint64 (DBUS_UINT64_CONSTANT (0x123456789abc7),
1685                      DBUS_BIG_ENDIAN,
1686                      _dbus_string_get_data (&str));
1687
1688   _dbus_assert (DBUS_UINT64_CONSTANT (0x123456789abc7) ==
1689                 _dbus_unpack_uint64 (DBUS_BIG_ENDIAN,
1690                                      _dbus_string_get_const_data (&str)));
1691 #endif /* DBUS_HAVE_INT64 */
1692
1693   /* set/pack 32-bit integers */
1694   _dbus_string_set_length (&str, 4);
1695
1696   /* signed little */
1697   _dbus_marshal_set_int32 (&str, DBUS_LITTLE_ENDIAN,
1698                            0, -0x123456);
1699
1700   _dbus_assert (-0x123456 ==
1701                 _dbus_unpack_int32 (DBUS_LITTLE_ENDIAN,
1702                                     _dbus_string_get_const_data (&str)));
1703
1704   /* signed big */
1705   _dbus_marshal_set_int32 (&str, DBUS_BIG_ENDIAN,
1706                            0, -0x123456);
1707
1708   _dbus_assert (-0x123456 ==
1709                 _dbus_unpack_int32 (DBUS_BIG_ENDIAN,
1710                                     _dbus_string_get_const_data (&str)));
1711
1712   /* signed little pack */
1713   _dbus_pack_int32 (-0x123456,
1714                     DBUS_LITTLE_ENDIAN,
1715                     _dbus_string_get_data (&str));
1716
1717   _dbus_assert (-0x123456 ==
1718                 _dbus_unpack_int32 (DBUS_LITTLE_ENDIAN,
1719                                     _dbus_string_get_const_data (&str)));
1720
1721   /* signed big pack */
1722   _dbus_pack_int32 (-0x123456,
1723                     DBUS_BIG_ENDIAN,
1724                     _dbus_string_get_data (&str));
1725
1726   _dbus_assert (-0x123456 ==
1727                 _dbus_unpack_int32 (DBUS_BIG_ENDIAN,
1728                                     _dbus_string_get_const_data (&str)));
1729
1730   /* unsigned little */
1731   _dbus_marshal_set_uint32 (&str,
1732                             0, 0x123456,
1733                             DBUS_LITTLE_ENDIAN);
1734
1735   _dbus_assert (0x123456 ==
1736                 _dbus_unpack_uint32 (DBUS_LITTLE_ENDIAN,
1737                                      _dbus_string_get_const_data (&str)));
1738
1739   /* unsigned big */
1740   _dbus_marshal_set_uint32 (&str,
1741                             0, 0x123456,
1742                             DBUS_BIG_ENDIAN);
1743
1744   _dbus_assert (0x123456 ==
1745                 _dbus_unpack_uint32 (DBUS_BIG_ENDIAN,
1746                                      _dbus_string_get_const_data (&str)));
1747
1748   /* unsigned little pack */
1749   _dbus_pack_uint32 (0x123456,
1750                      DBUS_LITTLE_ENDIAN,
1751                      _dbus_string_get_data (&str));
1752
1753   _dbus_assert (0x123456 ==
1754                 _dbus_unpack_uint32 (DBUS_LITTLE_ENDIAN,
1755                                      _dbus_string_get_const_data (&str)));
1756
1757   /* unsigned big pack */
1758   _dbus_pack_uint32 (0x123456,
1759                      DBUS_BIG_ENDIAN,
1760                      _dbus_string_get_data (&str));
1761
1762   _dbus_assert (0x123456 ==
1763                 _dbus_unpack_uint32 (DBUS_BIG_ENDIAN,
1764                                      _dbus_string_get_const_data (&str)));
1765
1766 #endif /* set/pack tests for integers */
1767
1768   /* Strings in-place set */
1769   byte_order = DBUS_LITTLE_ENDIAN;
1770   while (TRUE)
1771     {
1772       /* Init a string */
1773       _dbus_string_set_length (&str, 0);
1774
1775       /* reset pos for the macros */
1776       pos = 0;
1777
1778       MARSHAL_TEST_STRCMP (STRING, byte_order, "Hello world");
1779
1780       /* Set it to something longer */
1781       _dbus_string_init_const (&t, "Hello world foo");
1782
1783       v_STRING = _dbus_string_get_const_data (&t);
1784       _dbus_marshal_set_basic (&str, 0, DBUS_TYPE_STRING,
1785                                &v_STRING, byte_order, NULL, NULL);
1786
1787       _dbus_marshal_read_basic (&str, 0, DBUS_TYPE_STRING,
1788                                 &v_STRING, byte_order,
1789                                 NULL);
1790       _dbus_assert (strcmp (v_STRING, "Hello world foo") == 0);
1791
1792       /* Set it to something shorter */
1793       _dbus_string_init_const (&t, "Hello");
1794
1795       v_STRING = _dbus_string_get_const_data (&t);
1796       _dbus_marshal_set_basic (&str, 0, DBUS_TYPE_STRING,
1797                                &v_STRING, byte_order, NULL, NULL);
1798       _dbus_marshal_read_basic (&str, 0, DBUS_TYPE_STRING,
1799                                 &v_STRING, byte_order,
1800                                 NULL);
1801       _dbus_assert (strcmp (v_STRING, "Hello") == 0);
1802
1803       /* Do the other byte order */
1804       if (byte_order == DBUS_LITTLE_ENDIAN)
1805         byte_order = DBUS_BIG_ENDIAN;
1806       else
1807         break;
1808     }
1809
1810   /* Clean up */
1811   _dbus_string_free (&str);
1812
1813   return TRUE;
1814 }
1815
1816 #endif /* DBUS_BUILD_TESTS */