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     case DBUS_TYPE_BOOLEAN:
 347       _dbus_string_set_byte (str, pos, vp->byt);
 348       if (old_end_pos)
 349         *old_end_pos = pos + 1;
 350       if (new_end_pos)
 351         *new_end_pos = pos + 1;
 352       return TRUE;
 353       break;
 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     case DBUS_TYPE_BOOLEAN:
 461       vp->byt = _dbus_string_get_byte (str, pos);
 462       (pos)++;
 463       break;
 464     case DBUS_TYPE_INT32:
 465     case DBUS_TYPE_UINT32:
 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     case DBUS_TYPE_BOOLEAN:
 760       if (!_dbus_string_insert_byte (str, insert_at, vp->byt))
 761         return FALSE;
 762       if (pos_after)
 763         *pos_after = insert_at + 1;
 764       return TRUE;
 765       break;
 766     case DBUS_TYPE_INT32:
 767     case DBUS_TYPE_UINT32:
 768       return marshal_4_octets (str, insert_at, vp->u32,
 769                                byte_order, pos_after);
 770       break;
 771     case DBUS_TYPE_INT64:
 772     case DBUS_TYPE_UINT64:
 773     case DBUS_TYPE_DOUBLE:
 774       return marshal_8_octets (str, insert_at, *vp, byte_order, pos_after);
 775       break;
 776
 777     case DBUS_TYPE_STRING:
 778     case DBUS_TYPE_OBJECT_PATH:
 779       _dbus_assert (vp->str != NULL);
 780       return marshal_string (str, insert_at, vp->str, byte_order, pos_after);
 781       break;
 782     case DBUS_TYPE_SIGNATURE:
 783       _dbus_assert (vp->str != NULL);
 784       return marshal_signature (str, insert_at, vp->str, pos_after);
 785       break;
 786     default:
 787       _dbus_assert_not_reached ("not a basic type");
 788       return FALSE;
 789       break;
 790     }
 791 }
 792
 793 static dbus_bool_t
 794 marshal_1_octets_array (DBusString          *str,
 795                         int                  insert_at,
 796                         const unsigned char *value,
 797                         int                  n_elements,
 798                         int                  byte_order,
 799                         int                 *pos_after)
 800 {
 801   int pos;
 802   DBusString value_str;
 803
 804   _dbus_string_init_const_len (&value_str, value, n_elements);
 805
 806   pos = insert_at;
 807
 808   if (!_dbus_string_copy_len (&value_str, 0, n_elements,
 809                               str, pos))
 810     return FALSE;
 811
 812   pos += n_elements;
 813
 814   if (pos_after)
 815     *pos_after = pos;
 816
 817   return TRUE;
 818 }
 819
 820 static void
 821 swap_array (DBusString *str,
 822             int         array_start,
 823             int         n_elements,
 824             int         byte_order,
 825             int         alignment)
 826 {
 827   _dbus_assert (_DBUS_ALIGN_VALUE (array_start, alignment) == (unsigned) array_start);
 828
 829   if (byte_order != DBUS_COMPILER_BYTE_ORDER)
 830     {
 831       unsigned char *d;
 832       unsigned char *end;
 833
 834       /* we use const_data and cast it off so DBusString can be a const string
 835        * for the unit tests. don't ask.
 836        */
 837       d = (unsigned char*) _dbus_string_get_const_data (str) + array_start;
 838       end = d + n_elements * alignment;
 839
 840       if (alignment == 8)
 841         {
 842           while (d != end)
 843             {
 844 #ifdef DBUS_HAVE_INT64
 845               *((dbus_uint64_t*)d) = DBUS_UINT64_SWAP_LE_BE (*((dbus_uint64_t*)d));
 846 #else
 847               swap_8_bytes ((DBusBasicValue*) d);
 848 #endif
 849               d += 8;
 850             }
 851         }
 852       else
 853         {
 854           _dbus_assert (alignment == 4);
 855
 856           while (d != end)
 857             {
 858               *((dbus_uint32_t*)d) = DBUS_UINT32_SWAP_LE_BE (*((dbus_uint32_t*)d));
 859               d += 4;
 860             }
 861         }
 862     }
 863 }
 864
 865 static dbus_bool_t
 866 marshal_fixed_multi (DBusString           *str,
 867                      int                   insert_at,
 868                      const DBusBasicValue *value,
 869                      int                   n_elements,
 870                      int                   byte_order,
 871                      int                   alignment,
 872                      int                  *pos_after)
 873 {
 874   int old_string_len;
 875   int array_start;
 876   DBusString t;
 877   int len_in_bytes;
 878
 879   _dbus_assert (n_elements <= DBUS_MAXIMUM_ARRAY_LENGTH / alignment);
 880
 881   old_string_len = _dbus_string_get_length (str);
 882
 883   len_in_bytes = n_elements * alignment;
 884   array_start = insert_at;
 885
 886   /* Note that we do alignment padding unconditionally
 887    * even if the array is empty; this means that
 888    * padding + len is always equal to the number of bytes
 889    * in the array.
 890    */
 891
 892   if (!_dbus_string_insert_alignment (str, &array_start, alignment))
 893     goto error;
 894
 895   _dbus_string_init_const_len (&t,
 896                                (const unsigned char*) value,
 897                                len_in_bytes);
 898
 899   if (!_dbus_string_copy (&t, 0,
 900                           str, array_start))
 901     goto error;
 902
 903   swap_array (str, array_start, n_elements, byte_order, alignment);
 904
 905   if (pos_after)
 906     *pos_after = array_start + len_in_bytes;
 907
 908   return TRUE;
 909
 910  error:
 911   _dbus_string_delete (str, insert_at,
 912                        _dbus_string_get_length (str) - old_string_len);
 913
 914   return FALSE;
 915 }
 916
 917 /**
 918  * Marshals a block of values of fixed-length type all at once, as an
 919  * optimization.  _dbus_type_is_fixed() returns #TRUE for fixed-length
 920  * types, which are the basic types minus the string-like types.
 921  *
 922  * The value argument should be the adddress of an
 923  * array, so e.g. "const dbus_uint32_t**"
 924  *
 925  * @param str string to marshal to
 926  * @param insert_at where to insert the value
 927  * @param element_type type of array elements
 928  * @param value address of an array to marshal
 929  * @param n_elements number of elements in the array
 930  * @param byte_order byte order
 931  * @param pos_after #NULL or the position after the type
 932  * @returns #TRUE on success
 933  **/
 934 dbus_bool_t
 935 _dbus_marshal_write_fixed_multi (DBusString *str,
 936                                  int         insert_at,
 937                                  int         element_type,
 938                                  const void *value,
 939                                  int         n_elements,
 940                                  int         byte_order,
 941                                  int        *pos_after)
 942 {
 943   const void* vp = *(const DBusBasicValue**)value;
 944
 945   _dbus_assert (_dbus_type_is_fixed (element_type));
 946   _dbus_assert (n_elements >= 0);
 947
 948 #if 0
 949   _dbus_verbose ("writing %d elements of %s\n",
 950                  n_elements, _dbus_type_to_string (element_type));
 951 #endif
 952
 953   switch (element_type)
 954     {
 955     case DBUS_TYPE_BOOLEAN:
 956       /* FIXME: we canonicalize to 0 or 1 for the single boolean case
 957        * should we here too ? */
 958     case DBUS_TYPE_BYTE:
 959       return marshal_1_octets_array (str, insert_at, vp, n_elements, byte_order, pos_after);
 960       break;
 961     case DBUS_TYPE_INT32:
 962     case DBUS_TYPE_UINT32:
 963       return marshal_fixed_multi (str, insert_at, vp, n_elements, byte_order, 4, pos_after);
 964       break;
 965     case DBUS_TYPE_INT64:
 966     case DBUS_TYPE_UINT64:
 967     case DBUS_TYPE_DOUBLE:
 968       return marshal_fixed_multi (str, insert_at, vp, n_elements, byte_order, 8, pos_after);
 969       break;
 970
 971     default:
 972       _dbus_assert_not_reached ("non fixed type in array write");
 973       break;
 974     }
 975
 976   return FALSE;
 977 }
 978
 979
 980 /**
 981  * Skips over a basic-typed value, reporting the following position.
 982  *
 983  * @param str the string containing the data
 984  * @param type type of value to read
 985  * @param byte_order the byte order
 986  * @param pos pointer to position in the string,
 987  *            updated on return to new position
 988  **/
 989 void
 990 _dbus_marshal_skip_basic (const DBusString      *str,
 991                           int                    type,
 992                           int                    byte_order,
 993                           int                   *pos)
 994 {
 995   _dbus_assert (byte_order == DBUS_LITTLE_ENDIAN ||
 996                 byte_order == DBUS_BIG_ENDIAN);
 997
 998   switch (type)
 999     {
1000     case DBUS_TYPE_BYTE:
1001     case DBUS_TYPE_BOOLEAN:
1002       (*pos)++;
1003       break;
1004     case DBUS_TYPE_INT32:
1005     case DBUS_TYPE_UINT32:
1006       *pos = _DBUS_ALIGN_VALUE (*pos, 4);
1007       *pos += 4;
1008       break;
1009     case DBUS_TYPE_INT64:
1010     case DBUS_TYPE_UINT64:
1011     case DBUS_TYPE_DOUBLE:
1012       *pos = _DBUS_ALIGN_VALUE (*pos, 8);
1013       *pos += 8;
1014       break;
1015     case DBUS_TYPE_STRING:
1016     case DBUS_TYPE_OBJECT_PATH:
1017       {
1018         int len;
1019
1020         len = _dbus_marshal_read_uint32 (str, *pos, byte_order, pos);
1021
1022         *pos += len + 1; /* length plus nul */
1023       }
1024       break;
1025     case DBUS_TYPE_SIGNATURE:
1026       {
1027         int len;
1028
1029         len = _dbus_string_get_byte (str, *pos);
1030
1031         *pos += len + 2; /* length byte plus length plus nul */
1032       }
1033       break;
1034     default:
1035       _dbus_warn ("type %s not a basic type\n",
1036                   _dbus_type_to_string (type));
1037       _dbus_assert_not_reached ("not a basic type");
1038       break;
1039     }
1040 }
1041
1042 /**
1043  * Skips an array, returning the next position.
1044  *
1045  * @param str the string containing the data
1046  * @param element_type the type of array elements
1047  * @param byte_order the byte order
1048  * @param pos pointer to position in the string,
1049  *            updated on return to new position
1050  */
1051 void
1052 _dbus_marshal_skip_array (const DBusString  *str,
1053                           int                element_type,
1054                           int                byte_order,
1055                           int               *pos)
1056 {
1057   dbus_uint32_t array_len;
1058   int i;
1059   int alignment;
1060
1061   i = _DBUS_ALIGN_VALUE (*pos, 4);
1062
1063   array_len = _dbus_marshal_read_uint32 (str, i, byte_order, &i);
1064
1065   alignment = _dbus_type_get_alignment (element_type);
1066
1067   i = _DBUS_ALIGN_VALUE (i, alignment);
1068
1069   *pos = i + array_len;
1070 }
1071
1072 /**
1073  * Gets the alignment requirement for the given type;
1074  * will be 1, 4, or 8.
1075  *
1076  * @param typecode the type
1077  * @returns alignment of 1, 4, or 8
1078  */
1079 int
1080 _dbus_type_get_alignment (int typecode)
1081 {
1082   switch (typecode)
1083     {
1084     case DBUS_TYPE_BYTE:
1085     case DBUS_TYPE_BOOLEAN:
1086     case DBUS_TYPE_VARIANT:
1087     case DBUS_TYPE_SIGNATURE:
1088       return 1;
1089     case DBUS_TYPE_INT32:
1090     case DBUS_TYPE_UINT32:
1091       /* this stuff is 4 since it starts with a length */
1092     case DBUS_TYPE_STRING:
1093     case DBUS_TYPE_OBJECT_PATH:
1094     case DBUS_TYPE_ARRAY:
1095       return 4;
1096     case DBUS_TYPE_INT64:
1097     case DBUS_TYPE_UINT64:
1098     case DBUS_TYPE_DOUBLE:
1099       /* struct is 8 since it could contain an 8-aligned item
1100        * and it's simpler to just always align structs to 8;
1101        * we want the amount of padding in a struct of a given
1102        * type to be predictable, not location-dependent.
1103        */
1104     case DBUS_TYPE_STRUCT:
1105       return 8;
1106
1107     default:
1108       _dbus_assert_not_reached ("unknown typecode in _dbus_type_get_alignment()");
1109       return 0;
1110     }
1111 }
1112
1113
1114 /**
1115  * Return #TRUE if the typecode is a valid typecode.
1116  * #DBUS_TYPE_INVALID surprisingly enough is not considered valid, and
1117  * random unknown bytes aren't either. This function is safe with
1118  * untrusted data.
1119  *
1120  * @returns #TRUE if valid
1121  */
1122 dbus_bool_t
1123 _dbus_type_is_valid (int typecode)
1124 {
1125   switch (typecode)
1126     {
1127     case DBUS_TYPE_BYTE:
1128     case DBUS_TYPE_BOOLEAN:
1129     case DBUS_TYPE_INT32:
1130     case DBUS_TYPE_UINT32:
1131     case DBUS_TYPE_INT64:
1132     case DBUS_TYPE_UINT64:
1133     case DBUS_TYPE_DOUBLE:
1134     case DBUS_TYPE_STRING:
1135     case DBUS_TYPE_OBJECT_PATH:
1136     case DBUS_TYPE_SIGNATURE:
1137     case DBUS_TYPE_ARRAY:
1138     case DBUS_TYPE_STRUCT:
1139     case DBUS_TYPE_VARIANT:
1140       return TRUE;
1141
1142     default:
1143       return FALSE;
1144     }
1145 }
1146
1147 /** macro that checks whether a typecode is a container type */
1148 #define TYPE_IS_CONTAINER(typecode)             \
1149     ((typecode) == DBUS_TYPE_STRUCT ||          \
1150      (typecode) == DBUS_TYPE_VARIANT ||         \
1151      (typecode) == DBUS_TYPE_ARRAY)
1152
1153 /**
1154  * A "container type" can contain basic types, or nested
1155  * container types. #DBUS_TYPE_INVALID is not a container type.
1156  * This function will crash if passed a typecode that isn't
1157  * in dbus-protocol.h
1158  *
1159  * @returns #TRUE if type is a container
1160  */
1161 dbus_bool_t
1162 _dbus_type_is_container (int typecode)
1163 {
1164   /* only reasonable (non-line-noise) typecodes are allowed */
1165   _dbus_assert (_dbus_type_is_valid (typecode) || typecode == DBUS_TYPE_INVALID);
1166   return TYPE_IS_CONTAINER (typecode);
1167 }
1168
1169 /**
1170  * A "basic type" is a somewhat arbitrary concept, but the intent
1171  * is to include those types that are fully-specified by a single
1172  * typecode, with no additional type information or nested
1173  * values. So all numbers and strings are basic types and
1174  * structs, arrays, and variants are not basic types.
1175  * #DBUS_TYPE_INVALID is not a basic type.
1176  *
1177  * This function is defined to return #TRUE for exactly those
1178  * types that can be written with _dbus_marshal_basic_type()
1179  * and read with _dbus_marshal_read_basic().
1180  *
1181  * This function will crash if passed a typecode that isn't
1182  * in dbus-protocol.h
1183  *
1184  * @returns #TRUE if type is basic
1185  */
1186 dbus_bool_t
1187 _dbus_type_is_basic (int typecode)
1188 {
1189   /* only reasonable (non-line-noise) typecodes are allowed */
1190   _dbus_assert (_dbus_type_is_valid (typecode) || typecode == DBUS_TYPE_INVALID);
1191
1192   /* everything that isn't invalid or a container */
1193   return !(typecode == DBUS_TYPE_INVALID || TYPE_IS_CONTAINER (typecode));
1194 }
1195
1196 /**
1197  * Tells you whether values of this type can change length if you set
1198  * them to some other value. For this purpose, you assume that the
1199  * first byte of the old and new value would be in the same location,
1200  * so alignment padding is not a factor.
1201  *
1202  * @returns #FALSE if the type can occupy different lengths
1203  */
1204 dbus_bool_t
1205 _dbus_type_is_fixed (int typecode)
1206 {
1207   switch (typecode)
1208     {
1209     case DBUS_TYPE_BYTE:
1210     case DBUS_TYPE_BOOLEAN:
1211     case DBUS_TYPE_INT32:
1212     case DBUS_TYPE_UINT32:
1213     case DBUS_TYPE_INT64:
1214     case DBUS_TYPE_UINT64:
1215     case DBUS_TYPE_DOUBLE:
1216       return TRUE;
1217     default:
1218       return FALSE;
1219     }
1220 }
1221
1222 /**
1223  * Returns a string describing the given type.
1224  *
1225  * @param typecode the type to describe
1226  * @returns a constant string describing the type
1227  */
1228 const char *
1229 _dbus_type_to_string (int typecode)
1230 {
1231   switch (typecode)
1232     {
1233     case DBUS_TYPE_INVALID:
1234       return "invalid";
1235     case DBUS_TYPE_BOOLEAN:
1236       return "boolean";
1237     case DBUS_TYPE_BYTE:
1238       return "byte";
1239     case DBUS_TYPE_INT32:
1240       return "int32";
1241     case DBUS_TYPE_UINT32:
1242       return "uint32";
1243     case DBUS_TYPE_DOUBLE:
1244       return "double";
1245     case DBUS_TYPE_STRING:
1246       return "string";
1247     case DBUS_TYPE_OBJECT_PATH:
1248       return "object_path";
1249     case DBUS_TYPE_SIGNATURE:
1250       return "signature";
1251     case DBUS_TYPE_STRUCT:
1252       return "struct";
1253     case DBUS_TYPE_ARRAY:
1254       return "array";
1255     case DBUS_TYPE_VARIANT:
1256       return "variant";
1257     case DBUS_STRUCT_BEGIN_CHAR:
1258       return "begin_struct";
1259     case DBUS_STRUCT_END_CHAR:
1260       return "end_struct";
1261     default:
1262       return "unknown";
1263     }
1264 }
1265
1266 /**
1267  * If in verbose mode, print a block of binary data.
1268  *
1269  * @todo right now it prints even if not in verbose mode
1270  *
1271  * @param data the data
1272  * @param len the length of the data
1273  * @param offset where to start counting for byte indexes
1274  */
1275 void
1276 _dbus_verbose_bytes (const unsigned char *data,
1277                      int                  len,
1278                      int                  offset)
1279 {
1280   int i;
1281   const unsigned char *aligned;
1282
1283   _dbus_assert (len >= 0);
1284
1285   /* Print blanks on first row if appropriate */
1286   aligned = _DBUS_ALIGN_ADDRESS (data, 4);
1287   if (aligned > data)
1288     aligned -= 4;
1289   _dbus_assert (aligned <= data);
1290
1291   if (aligned != data)
1292     {
1293       _dbus_verbose ("%4d\t%p: ", - (data - aligned), aligned);
1294       while (aligned != data)
1295         {
1296           _dbus_verbose ("    ");
1297           ++aligned;
1298         }
1299     }
1300
1301   /* now print the bytes */
1302   i = 0;
1303   while (i < len)
1304     {
1305       if (_DBUS_ALIGN_ADDRESS (&data[i], 4) == &data[i])
1306         {
1307           _dbus_verbose ("%4d\t%p: ",
1308                          offset + i, &data[i]);
1309         }
1310
1311       if (data[i] >= 32 &&
1312           data[i] <= 126)
1313         _dbus_verbose (" '%c' ", data[i]);
1314       else
1315         _dbus_verbose ("0x%s%x ",
1316                        data[i] <= 0xf ? "0" : "", data[i]);
1317
1318       ++i;
1319
1320       if (_DBUS_ALIGN_ADDRESS (&data[i], 4) == &data[i])
1321         {
1322           if (i > 3)
1323             _dbus_verbose ("BE: %d LE: %d",
1324                            _dbus_unpack_uint32 (DBUS_BIG_ENDIAN, &data[i-4]),
1325                            _dbus_unpack_uint32 (DBUS_LITTLE_ENDIAN, &data[i-4]));
1326
1327           if (i > 7 &&
1328               _DBUS_ALIGN_ADDRESS (&data[i], 8) == &data[i])
1329             {
1330 #ifdef DBUS_HAVE_INT64
1331               /* I think I probably mean "GNU libc printf" and not "GNUC"
1332                * but we'll wait until someone complains. If you hit this,
1333                * just turn off verbose mode as a workaround.
1334                */
1335 #if __GNUC__
1336               _dbus_verbose (" u64: 0x%llx",
1337                              *(dbus_uint64_t*)&data[i-8]);
1338 #endif
1339 #endif
1340               _dbus_verbose (" dbl: %g",
1341                              *(double*)&data[i-8]);
1342             }
1343
1344           _dbus_verbose ("\n");
1345         }
1346     }
1347
1348   _dbus_verbose ("\n");
1349 }
1350
1351 /**
1352  * Dump the given part of the string to verbose log.
1353  *
1354  * @param str the string
1355  * @param start the start of range to dump
1356  * @param len length of range
1357  */
1358 void
1359 _dbus_verbose_bytes_of_string (const DBusString    *str,
1360                                int                  start,
1361                                int                  len)
1362 {
1363   const char *d;
1364   int real_len;
1365
1366   real_len = _dbus_string_get_length (str);
1367
1368   _dbus_assert (start >= 0);
1369
1370   if (start > real_len)
1371     {
1372       _dbus_verbose ("  [%d,%d) is not inside string of length %d\n",
1373                      start, len, real_len);
1374       return;
1375     }
1376
1377   if ((start + len) > real_len)
1378     {
1379       _dbus_verbose ("  [%d,%d) extends outside string of length %d\n",
1380                      start, len, real_len);
1381       len = real_len - start;
1382     }
1383
1384   d = _dbus_string_get_const_data_len (str, start, len);
1385
1386   _dbus_verbose_bytes (d, len, start);
1387 }
1388
1389 /** @} */
1390
1391 #ifdef DBUS_BUILD_TESTS
1392 #include "dbus-test.h"
1393 #include <stdio.h>
1394
1395 static void
1396 swap_test_array (void *array,
1397                  int   len_bytes,
1398                  int   byte_order,
1399                  int   alignment)
1400 {
1401   DBusString t;
1402
1403   if (alignment == 1)
1404     return;
1405
1406   _dbus_string_init_const_len (&t, array, len_bytes);
1407   swap_array (&t, 0, len_bytes / alignment, byte_order, alignment);
1408 }
1409
1410 #define MARSHAL_BASIC(typename, byte_order, literal)                    \
1411   do {                                                                  \
1412      v_##typename = literal;                                            \
1413      if (!_dbus_marshal_write_basic (&str, pos, DBUS_TYPE_##typename,   \
1414                                     &v_##typename,                      \
1415                                     byte_order, NULL))                  \
1416        _dbus_assert_not_reached ("no memory");                          \
1417    } while (0)
1418
1419 #define DEMARSHAL_BASIC(typename, byte_order)                                   \
1420   do {                                                                          \
1421     _dbus_marshal_read_basic (&str, pos, DBUS_TYPE_##typename, &v_##typename,   \
1422                               byte_order, &pos);                                \
1423   } while (0)
1424
1425 #define DEMARSHAL_BASIC_AND_CHECK(typename, byte_order, literal)                        \
1426   do {                                                                                  \
1427     DEMARSHAL_BASIC (typename, byte_order);                                             \
1428     if (literal != v_##typename)                                                        \
1429       {                                                                                 \
1430         _dbus_verbose_bytes_of_string (&str, dump_pos,                                  \
1431                                      _dbus_string_get_length (&str) - dump_pos);        \
1432         _dbus_assert_not_reached ("demarshaled wrong value");                           \
1433       }                                                                                 \
1434   } while (0)
1435
1436 #define MARSHAL_TEST(typename, byte_order, literal)             \
1437   do {                                                          \
1438     MARSHAL_BASIC (typename, byte_order, literal);              \
1439     dump_pos = pos;                                             \
1440     DEMARSHAL_BASIC_AND_CHECK (typename, byte_order, literal);  \
1441   } while (0)
1442
1443 #define MARSHAL_TEST_STRCMP(typename, byte_order, literal)                              \
1444   do {                                                                                  \
1445     MARSHAL_BASIC (typename, byte_order, literal);                                      \
1446     dump_pos = pos;                                                                     \
1447     DEMARSHAL_BASIC (typename, byte_order);                                             \
1448     if (strcmp (literal, v_##typename) != 0)                                            \
1449       {                                                                                 \
1450         _dbus_verbose_bytes_of_string (&str, dump_pos,                                  \
1451                                        _dbus_string_get_length (&str) - dump_pos);      \
1452         _dbus_warn ("literal '%s'\nvalue  '%s'\n", literal, v_##typename);              \
1453         _dbus_assert_not_reached ("demarshaled wrong value");                           \
1454       }                                                                                 \
1455   } while (0)
1456
1457 #define MARSHAL_FIXED_ARRAY(typename, byte_order, literal)                                      \
1458   do {                                                                                          \
1459      int next;                                                                                  \
1460      v_UINT32 = sizeof(literal);                                                                \
1461      if (!_dbus_marshal_write_basic (&str, pos, DBUS_TYPE_UINT32, &v_UINT32,                    \
1462                                      byte_order, &next))                                        \
1463        _dbus_assert_not_reached ("no memory");                                                  \
1464      v_ARRAY_##typename = literal;                                                              \
1465      if (!_dbus_marshal_write_fixed_multi (&str, next, DBUS_TYPE_##typename,                    \
1466                                            &v_ARRAY_##typename, _DBUS_N_ELEMENTS(literal),      \
1467                                            byte_order, NULL))                                   \
1468        _dbus_assert_not_reached ("no memory");                                                  \
1469    } while (0)
1470
1471 #define DEMARSHAL_FIXED_ARRAY(typename, byte_order)                                             \
1472   do {                                                                                          \
1473     int next;                                                                                   \
1474     alignment = _dbus_type_get_alignment (DBUS_TYPE_##typename);                                \
1475     v_UINT32 = _dbus_marshal_read_uint32 (&str, dump_pos, byte_order, &next);                   \
1476     _dbus_marshal_read_fixed_multi (&str, next, DBUS_TYPE_##typename, &v_ARRAY_##typename,      \
1477                                     v_UINT32/alignment,                                         \
1478                                     byte_order, NULL);                                          \
1479     swap_test_array (v_ARRAY_##typename, v_UINT32,                                              \
1480                      byte_order, alignment);                                                    \
1481   } while (0)
1482
1483 #define DEMARSHAL_FIXED_ARRAY_AND_CHECK(typename, byte_order, literal)                  \
1484   do {                                                                                  \
1485     DEMARSHAL_FIXED_ARRAY (typename, byte_order);                                       \
1486     if (memcmp (literal, v_ARRAY_##typename, sizeof (literal) != 0))                    \
1487       {                                                                                 \
1488         _dbus_verbose ("MARSHALED DATA\n");                                             \
1489         _dbus_verbose_bytes_of_string (&str, dump_pos,                                  \
1490                                       _dbus_string_get_length (&str) - dump_pos);       \
1491         _dbus_verbose ("LITERAL DATA\n");                                               \
1492         _dbus_verbose_bytes ((char*)literal, sizeof (literal), 0);                      \
1493         _dbus_verbose ("READ DATA\n");                                                  \
1494         _dbus_verbose_bytes ((char*)v_ARRAY_##typename, sizeof (literal), 0);           \
1495         _dbus_assert_not_reached ("demarshaled wrong fixed array value");               \
1496       }                                                                                 \
1497   } while (0)
1498
1499 #define MARSHAL_TEST_FIXED_ARRAY(typename, byte_order, literal)         \
1500   do {                                                                  \
1501     MARSHAL_FIXED_ARRAY (typename, byte_order, literal);                \
1502     dump_pos = pos;                                                     \
1503     DEMARSHAL_FIXED_ARRAY_AND_CHECK (typename, byte_order, literal);    \
1504   } while (0)
1505
1506 dbus_bool_t
1507 _dbus_marshal_test (void)
1508 {
1509   int alignment;
1510   DBusString str;
1511   int pos, dump_pos;
1512   unsigned char array1[5] = { 3, 4, 0, 1, 9 };
1513   dbus_int32_t array4[3] = { 123, 456, 789 };
1514 #ifdef DBUS_HAVE_INT64
1515   dbus_int64_t array8[3] = { DBUS_INT64_CONSTANT (0x123ffffffff),
1516                              DBUS_INT64_CONSTANT (0x456ffffffff),
1517                              DBUS_INT64_CONSTANT (0x789ffffffff) };
1518   dbus_int64_t *v_ARRAY_INT64;
1519 #endif
1520   unsigned char *v_ARRAY_BYTE;
1521   dbus_int32_t *v_ARRAY_INT32;
1522   double *v_ARRAY_DOUBLE;
1523   DBusString t;
1524   double v_DOUBLE;
1525   double t_DOUBLE;
1526   dbus_int32_t v_INT32;
1527   dbus_uint32_t v_UINT32;
1528   dbus_int64_t v_INT64;
1529   dbus_uint64_t v_UINT64;
1530   unsigned char v_BYTE;
1531   unsigned char v_BOOLEAN;
1532   const char *v_STRING;
1533   const char *v_SIGNATURE;
1534   const char *v_OBJECT_PATH;
1535   int byte_order;
1536
1537   if (!_dbus_string_init (&str))
1538     _dbus_assert_not_reached ("failed to init string");
1539
1540   pos = 0;
1541
1542   /* Marshal doubles */
1543   MARSHAL_BASIC (DOUBLE, DBUS_BIG_ENDIAN, 3.14);
1544   DEMARSHAL_BASIC (DOUBLE, DBUS_BIG_ENDIAN);
1545   t_DOUBLE = 3.14;
1546   if (!_DBUS_DOUBLES_BITWISE_EQUAL (t_DOUBLE, v_DOUBLE))
1547     _dbus_assert_not_reached ("got wrong double value");
1548
1549   MARSHAL_BASIC (DOUBLE, DBUS_LITTLE_ENDIAN, 3.14);
1550   DEMARSHAL_BASIC (DOUBLE, DBUS_LITTLE_ENDIAN);
1551   t_DOUBLE = 3.14;
1552   if (!_DBUS_DOUBLES_BITWISE_EQUAL (t_DOUBLE, v_DOUBLE))
1553     _dbus_assert_not_reached ("got wrong double value");
1554
1555   /* Marshal signed integers */
1556   MARSHAL_TEST (INT32, DBUS_BIG_ENDIAN, -12345678);
1557   MARSHAL_TEST (INT32, DBUS_LITTLE_ENDIAN, -12345678);
1558
1559   /* Marshal unsigned integers */
1560   MARSHAL_TEST (UINT32, DBUS_BIG_ENDIAN, 0x12345678);
1561   MARSHAL_TEST (UINT32, DBUS_LITTLE_ENDIAN, 0x12345678);
1562
1563 #ifdef DBUS_HAVE_INT64
1564   /* Marshal signed integers */
1565   MARSHAL_TEST (INT64, DBUS_BIG_ENDIAN, DBUS_INT64_CONSTANT (-0x123456789abc7));
1566   MARSHAL_TEST (INT64, DBUS_LITTLE_ENDIAN, DBUS_INT64_CONSTANT (-0x123456789abc7));
1567
1568   /* Marshal unsigned integers */
1569   MARSHAL_TEST (UINT64, DBUS_BIG_ENDIAN, DBUS_UINT64_CONSTANT (0x123456789abc7));
1570   MARSHAL_TEST (UINT64, DBUS_LITTLE_ENDIAN, DBUS_UINT64_CONSTANT (0x123456789abc7));
1571 #endif /* DBUS_HAVE_INT64 */
1572
1573   /* Marshal byte */
1574   MARSHAL_TEST (BYTE, DBUS_BIG_ENDIAN, 5);
1575   MARSHAL_TEST (BYTE, DBUS_LITTLE_ENDIAN, 5);
1576
1577   /* Marshal all possible bools! */
1578   MARSHAL_TEST (BOOLEAN, DBUS_BIG_ENDIAN, FALSE);
1579   MARSHAL_TEST (BOOLEAN, DBUS_LITTLE_ENDIAN, FALSE);
1580   MARSHAL_TEST (BOOLEAN, DBUS_BIG_ENDIAN, TRUE);
1581   MARSHAL_TEST (BOOLEAN, DBUS_LITTLE_ENDIAN, TRUE);
1582
1583   /* Marshal strings */
1584   MARSHAL_TEST_STRCMP (STRING, DBUS_BIG_ENDIAN, "");
1585   MARSHAL_TEST_STRCMP (STRING, DBUS_LITTLE_ENDIAN, "");
1586   MARSHAL_TEST_STRCMP (STRING, DBUS_BIG_ENDIAN, "This is the dbus test string");
1587   MARSHAL_TEST_STRCMP (STRING, DBUS_LITTLE_ENDIAN, "This is the dbus test string");
1588
1589   /* object paths */
1590   MARSHAL_TEST_STRCMP (OBJECT_PATH, DBUS_BIG_ENDIAN, "/a/b/c");
1591   MARSHAL_TEST_STRCMP (OBJECT_PATH, DBUS_LITTLE_ENDIAN, "/a/b/c");
1592
1593   /* signatures */
1594   MARSHAL_TEST_STRCMP (SIGNATURE, DBUS_BIG_ENDIAN, "");
1595   MARSHAL_TEST_STRCMP (SIGNATURE, DBUS_LITTLE_ENDIAN, "");
1596   MARSHAL_TEST_STRCMP (SIGNATURE, DBUS_BIG_ENDIAN, "a(ii)");
1597   MARSHAL_TEST_STRCMP (SIGNATURE, DBUS_LITTLE_ENDIAN, "a(ii)");
1598
1599   /* Arrays */
1600   MARSHAL_TEST_FIXED_ARRAY (INT32, DBUS_BIG_ENDIAN, array4);
1601   MARSHAL_TEST_FIXED_ARRAY (INT32, DBUS_LITTLE_ENDIAN, array4);
1602
1603   MARSHAL_TEST_FIXED_ARRAY (BYTE, DBUS_BIG_ENDIAN, array1);
1604   MARSHAL_TEST_FIXED_ARRAY (BYTE, DBUS_LITTLE_ENDIAN, array1);
1605
1606 #ifdef DBUS_HAVE_INT64
1607   MARSHAL_TEST_FIXED_ARRAY (INT64, DBUS_BIG_ENDIAN, array8);
1608   MARSHAL_TEST_FIXED_ARRAY (INT64, DBUS_LITTLE_ENDIAN, array8);
1609 #endif
1610
1611 #if 0
1612
1613   /*
1614    * FIXME restore the set/pack tests
1615    */
1616
1617 #ifdef DBUS_HAVE_INT64
1618   /* set/pack 64-bit integers */
1619   _dbus_string_set_length (&str, 8);
1620
1621   /* signed little */
1622   _dbus_marshal_set_int64 (&str, DBUS_LITTLE_ENDIAN,
1623                            0, DBUS_INT64_CONSTANT (-0x123456789abc7));
1624
1625   _dbus_assert (DBUS_INT64_CONSTANT (-0x123456789abc7) ==
1626                 _dbus_unpack_int64 (DBUS_LITTLE_ENDIAN,
1627                                     _dbus_string_get_const_data (&str)));
1628
1629   /* signed big */
1630   _dbus_marshal_set_int64 (&str, DBUS_BIG_ENDIAN,
1631                            0, DBUS_INT64_CONSTANT (-0x123456789abc7));
1632
1633   _dbus_assert (DBUS_INT64_CONSTANT (-0x123456789abc7) ==
1634                 _dbus_unpack_int64 (DBUS_BIG_ENDIAN,
1635                                     _dbus_string_get_const_data (&str)));
1636
1637   /* signed little pack */
1638   _dbus_pack_int64 (DBUS_INT64_CONSTANT (-0x123456789abc7),
1639                     DBUS_LITTLE_ENDIAN,
1640                     _dbus_string_get_data (&str));
1641
1642   _dbus_assert (DBUS_INT64_CONSTANT (-0x123456789abc7) ==
1643                 _dbus_unpack_int64 (DBUS_LITTLE_ENDIAN,
1644                                     _dbus_string_get_const_data (&str)));
1645
1646   /* signed big pack */
1647   _dbus_pack_int64 (DBUS_INT64_CONSTANT (-0x123456789abc7),
1648                     DBUS_BIG_ENDIAN,
1649                     _dbus_string_get_data (&str));
1650
1651   _dbus_assert (DBUS_INT64_CONSTANT (-0x123456789abc7) ==
1652                 _dbus_unpack_int64 (DBUS_BIG_ENDIAN,
1653                                     _dbus_string_get_const_data (&str)));
1654
1655   /* unsigned little */
1656   _dbus_marshal_set_uint64 (&str, DBUS_LITTLE_ENDIAN,
1657                             0, DBUS_UINT64_CONSTANT (0x123456789abc7));
1658
1659   _dbus_assert (DBUS_UINT64_CONSTANT (0x123456789abc7) ==
1660                 _dbus_unpack_uint64 (DBUS_LITTLE_ENDIAN,
1661                                      _dbus_string_get_const_data (&str)));
1662
1663   /* unsigned big */
1664   _dbus_marshal_set_uint64 (&str, DBUS_BIG_ENDIAN,
1665                             0, DBUS_UINT64_CONSTANT (0x123456789abc7));
1666
1667   _dbus_assert (DBUS_UINT64_CONSTANT (0x123456789abc7) ==
1668                 _dbus_unpack_uint64 (DBUS_BIG_ENDIAN,
1669                                      _dbus_string_get_const_data (&str)));
1670
1671   /* unsigned little pack */
1672   _dbus_pack_uint64 (DBUS_UINT64_CONSTANT (0x123456789abc7),
1673                      DBUS_LITTLE_ENDIAN,
1674                      _dbus_string_get_data (&str));
1675
1676   _dbus_assert (DBUS_UINT64_CONSTANT (0x123456789abc7) ==
1677                 _dbus_unpack_uint64 (DBUS_LITTLE_ENDIAN,
1678                                      _dbus_string_get_const_data (&str)));
1679
1680   /* unsigned big pack */
1681   _dbus_pack_uint64 (DBUS_UINT64_CONSTANT (0x123456789abc7),
1682                      DBUS_BIG_ENDIAN,
1683                      _dbus_string_get_data (&str));
1684
1685   _dbus_assert (DBUS_UINT64_CONSTANT (0x123456789abc7) ==
1686                 _dbus_unpack_uint64 (DBUS_BIG_ENDIAN,
1687                                      _dbus_string_get_const_data (&str)));
1688 #endif /* DBUS_HAVE_INT64 */
1689
1690   /* set/pack 32-bit integers */
1691   _dbus_string_set_length (&str, 4);
1692
1693   /* signed little */
1694   _dbus_marshal_set_int32 (&str, DBUS_LITTLE_ENDIAN,
1695                            0, -0x123456);
1696
1697   _dbus_assert (-0x123456 ==
1698                 _dbus_unpack_int32 (DBUS_LITTLE_ENDIAN,
1699                                     _dbus_string_get_const_data (&str)));
1700
1701   /* signed big */
1702   _dbus_marshal_set_int32 (&str, DBUS_BIG_ENDIAN,
1703                            0, -0x123456);
1704
1705   _dbus_assert (-0x123456 ==
1706                 _dbus_unpack_int32 (DBUS_BIG_ENDIAN,
1707                                     _dbus_string_get_const_data (&str)));
1708
1709   /* signed little pack */
1710   _dbus_pack_int32 (-0x123456,
1711                     DBUS_LITTLE_ENDIAN,
1712                     _dbus_string_get_data (&str));
1713
1714   _dbus_assert (-0x123456 ==
1715                 _dbus_unpack_int32 (DBUS_LITTLE_ENDIAN,
1716                                     _dbus_string_get_const_data (&str)));
1717
1718   /* signed big pack */
1719   _dbus_pack_int32 (-0x123456,
1720                     DBUS_BIG_ENDIAN,
1721                     _dbus_string_get_data (&str));
1722
1723   _dbus_assert (-0x123456 ==
1724                 _dbus_unpack_int32 (DBUS_BIG_ENDIAN,
1725                                     _dbus_string_get_const_data (&str)));
1726
1727   /* unsigned little */
1728   _dbus_marshal_set_uint32 (&str,
1729                             0, 0x123456,
1730                             DBUS_LITTLE_ENDIAN);
1731
1732   _dbus_assert (0x123456 ==
1733                 _dbus_unpack_uint32 (DBUS_LITTLE_ENDIAN,
1734                                      _dbus_string_get_const_data (&str)));
1735
1736   /* unsigned big */
1737   _dbus_marshal_set_uint32 (&str,
1738                             0, 0x123456,
1739                             DBUS_BIG_ENDIAN);
1740
1741   _dbus_assert (0x123456 ==
1742                 _dbus_unpack_uint32 (DBUS_BIG_ENDIAN,
1743                                      _dbus_string_get_const_data (&str)));
1744
1745   /* unsigned little pack */
1746   _dbus_pack_uint32 (0x123456,
1747                      DBUS_LITTLE_ENDIAN,
1748                      _dbus_string_get_data (&str));
1749
1750   _dbus_assert (0x123456 ==
1751                 _dbus_unpack_uint32 (DBUS_LITTLE_ENDIAN,
1752                                      _dbus_string_get_const_data (&str)));
1753
1754   /* unsigned big pack */
1755   _dbus_pack_uint32 (0x123456,
1756                      DBUS_BIG_ENDIAN,
1757                      _dbus_string_get_data (&str));
1758
1759   _dbus_assert (0x123456 ==
1760                 _dbus_unpack_uint32 (DBUS_BIG_ENDIAN,
1761                                      _dbus_string_get_const_data (&str)));
1762
1763 #endif /* set/pack tests for integers */
1764
1765   /* Strings in-place set */
1766   byte_order = DBUS_LITTLE_ENDIAN;
1767   while (TRUE)
1768     {
1769       /* Init a string */
1770       _dbus_string_set_length (&str, 0);
1771
1772       /* reset pos for the macros */
1773       pos = 0;
1774
1775       MARSHAL_TEST_STRCMP (STRING, byte_order, "Hello world");
1776
1777       /* Set it to something longer */
1778       _dbus_string_init_const (&t, "Hello world foo");
1779
1780       v_STRING = _dbus_string_get_const_data (&t);
1781       _dbus_marshal_set_basic (&str, 0, DBUS_TYPE_STRING,
1782                                &v_STRING, byte_order, NULL, NULL);
1783
1784       _dbus_marshal_read_basic (&str, 0, DBUS_TYPE_STRING,
1785                                 &v_STRING, byte_order,
1786                                 NULL);
1787       _dbus_assert (strcmp (v_STRING, "Hello world foo") == 0);
1788
1789       /* Set it to something shorter */
1790       _dbus_string_init_const (&t, "Hello");
1791
1792       v_STRING = _dbus_string_get_const_data (&t);
1793       _dbus_marshal_set_basic (&str, 0, DBUS_TYPE_STRING,
1794                                &v_STRING, byte_order, NULL, NULL);
1795       _dbus_marshal_read_basic (&str, 0, DBUS_TYPE_STRING,
1796                                 &v_STRING, byte_order,
1797                                 NULL);
1798       _dbus_assert (strcmp (v_STRING, "Hello") == 0);
1799
1800       /* Do the other byte order */
1801       if (byte_order == DBUS_LITTLE_ENDIAN)
1802         byte_order = DBUS_BIG_ENDIAN;
1803       else
1804         break;
1805     }
1806
1807   /* Clean up */
1808   _dbus_string_free (&str);
1809
1810   return TRUE;
1811 }
1812
1813 #endif /* DBUS_BUILD_TESTS */