dbus/dbus-marshal.c

   1 /* -*- mode: C; c-file-style: "gnu" -*- */
   2 /* dbus-marshal.c  Marshalling routines
   3  *
   4  * Copyright (C) 2002  CodeFactory AB
   5  *
   6  * Licensed under the Academic Free License version 1.2
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21  *
  22  */
  23
  24 #include "dbus-marshal.h"
  25 #include "dbus-internals.h"
  26
  27 #include <string.h>
  28
  29 #define DBUS_UINT32_SWAP_LE_BE_CONSTANT(val)    ((dbus_uint32_t) ( \
  30     (((dbus_uint32_t) (val) & (dbus_uint32_t) 0x000000ffU) << 24) |  \
  31     (((dbus_uint32_t) (val) & (dbus_uint32_t) 0x0000ff00U) <<  8) |  \
  32     (((dbus_uint32_t) (val) & (dbus_uint32_t) 0x00ff0000U) >>  8) |  \
  33     (((dbus_uint32_t) (val) & (dbus_uint32_t) 0xff000000U) >> 24)))
  34
  35 #define DBUS_UINT32_SWAP_LE_BE(val) (DBUS_UINT32_SWAP_LE_BE_CONSTANT (val))
  36
  37 #ifdef WORDS_BIGENDIAN
  38 #define DBUS_INT32_TO_BE(val)   ((dbus_int32_t) (val))
  39 #define DBUS_UINT32_TO_BE(val)  ((dbus_uint32_t) (val))
  40 #define DBUS_INT32_TO_LE(val)   ((dbus_int32_t) DBUS_UINT32_SWAP_LE_BE (val))
  41 #define DBUS_UINT32_TO_LE(val)  (DBUS_UINT32_SWAP_LE_BE (val))
  42 #else
  43 #define DBUS_INT32_TO_LE(val)   ((dbus_int32_t) (val))
  44 #define DBUS_UINT32_TO_LE(val)  ((dbus_uint32_t) (val))
  45 #define DBUS_INT32_TO_BE(val)   ((dbus_int32_t) DBUS_UINT32_SWAP_LE_BE (val))
  46 #define DBUS_UINT32_TO_BE(val)  (DBUS_UINT32_SWAP_LE_BE (val))
  47 #endif
  48
  49 /* The transformation is symmetric, so the FROM just maps to the TO. */
  50 #define DBUS_INT32_FROM_LE(val)  (DBUS_INT32_TO_LE (val))
  51 #define DBUS_UINT32_FROM_LE(val) (DBUS_UINT32_TO_LE (val))
  52 #define DBUS_INT32_FROM_BE(val)  (DBUS_INT32_TO_BE (val))
  53 #define DBUS_UINT32_FROM_BE(val) (DBUS_UINT32_TO_BE (val))
  54
  55
  56 /* This alignment thing is from ORBit2 */
  57 /* Align a value upward to a boundary, expressed as a number of bytes.
  58  * E.g. align to an 8-byte boundary with argument of 8.
  59  */
  60
  61 /*
  62  *   (this + boundary - 1)
  63  *          &
  64  *    ~(boundary - 1)
  65  */
  66
  67 #define DBUS_ALIGN_VALUE(this, boundary) \
  68   (( ((unsigned long)(this)) + (((unsigned long)(boundary)) -1)) & (~(((unsigned long)(boundary))-1)))
  69
  70 #define DBUS_ALIGN_ADDRESS(this, boundary) \
  71   ((void*)DBUS_ALIGN_VALUE(this, boundary))
  72
  73 /* from ORBit */
  74 static void
  75 swap_bytes (unsigned char *data,
  76             unsigned int   len)
  77 {
  78   unsigned char *p1 = data;
  79   unsigned char *p2 = data + len - 1;
  80
  81   while (p1 < p2)
  82     {
  83       unsigned char tmp = *p1;
  84       *p1 = *p2;
  85       *p2 = tmp;
  86
  87       --p2;
  88       ++p1;
  89     }
  90 }
  91
  92 static dbus_uint32_t
  93 unpack_uint32 (int                  byte_order,
  94                const unsigned char *data)
  95 {
  96   _dbus_assert (DBUS_ALIGN_ADDRESS (data, 4) == data);
  97
  98   if (byte_order == DBUS_LITTLE_ENDIAN)
  99     return DBUS_UINT32_FROM_LE (*(dbus_uint32_t*)data);
 100   else
 101     return DBUS_UINT32_FROM_BE (*(dbus_uint32_t*)data);
 102 }
 103
 104 static dbus_int32_t
 105 unpack_int32 (int                  byte_order,
 106               const unsigned char *data)
 107 {
 108   _dbus_assert (DBUS_ALIGN_ADDRESS (data, 4) == data);
 109
 110   if (byte_order == DBUS_LITTLE_ENDIAN)
 111     return DBUS_INT32_FROM_LE (*(dbus_int32_t*)data);
 112   else
 113     return DBUS_INT32_FROM_BE (*(dbus_int32_t*)data);
 114 }
 115
 116 /**
 117  * @defgroup DBusMarshal marshaling and unmarshaling
 118  * @ingroup  DBusInternals
 119  * @brief functions to marshal/unmarshal data from the wire
 120  *
 121  * Types and functions related to converting primitive data types from
 122  * wire format to native machine format, and vice versa.
 123  *
 124  * @{
 125  */
 126
 127 /**
 128  * Marshals a double value.
 129  *
 130  * @param str the string to append the marshalled value to
 131  * @param byte_order the byte order to use
 132  * @param value the value
 133  * @returns #TRUE on success
 134  */
 135 dbus_bool_t
 136 _dbus_marshal_double (DBusString *str,
 137                       int         byte_order,
 138                       double      value)
 139 {
 140   if (!_dbus_string_set_length (str,
 141                                 DBUS_ALIGN_VALUE (_dbus_string_get_length (str),
 142                                                   sizeof (double))))
 143     return FALSE;
 144
 145   if (byte_order != DBUS_COMPILER_BYTE_ORDER)
 146     swap_bytes ((unsigned char *)&value, sizeof (double));
 147
 148   return _dbus_string_append_len (str, (const char *)&value, sizeof (double));
 149 }
 150
 151 /**
 152  * Marshals a 32 bit signed integer value.
 153  *
 154  * @param str the string to append the marshalled value to
 155  * @param byte_order the byte order to use
 156  * @param value the value
 157  * @returns #TRUE on success
 158  */
 159 dbus_bool_t
 160 _dbus_marshal_int32  (DBusString   *str,
 161                       int           byte_order,
 162                       dbus_int32_t  value)
 163 {
 164   if (!_dbus_string_set_length (str,
 165                                 DBUS_ALIGN_VALUE (_dbus_string_get_length (str),
 166                                                   sizeof (dbus_int32_t))))
 167     return FALSE;
 168
 169   if (byte_order != DBUS_COMPILER_BYTE_ORDER)
 170     swap_bytes ((unsigned char *)&value, sizeof (dbus_int32_t));
 171
 172   return _dbus_string_append_len (str, (const char *)&value, sizeof (dbus_int32_t));
 173 }
 174
 175 /**
 176  * Marshals a 32 bit unsigned integer value.
 177  *
 178  * @param str the string to append the marshalled value to
 179  * @param byte_order the byte order to use
 180  * @param value the value
 181  * @returns #TRUE on success
 182  */
 183 dbus_bool_t
 184 _dbus_marshal_uint32 (DBusString    *str,
 185                       int            byte_order,
 186                       dbus_uint32_t  value)
 187 {
 188   if (!_dbus_string_set_length (str,
 189                                 DBUS_ALIGN_VALUE (_dbus_string_get_length (str),
 190                                                   sizeof (dbus_uint32_t))))
 191     return FALSE;
 192
 193   if (byte_order != DBUS_COMPILER_BYTE_ORDER)
 194     swap_bytes ((unsigned char *)&value, sizeof (dbus_uint32_t));
 195
 196   return _dbus_string_append_len (str, (const char *)&value, sizeof (dbus_uint32_t));
 197 }
 198
 199 /**
 200  * Marshals a UTF-8 string
 201  *
 202  * @param str the string to append the marshalled value to
 203  * @param byte_order the byte order to use
 204  * @param value the string
 205  * @returns #TRUE on success
 206  */
 207 dbus_bool_t
 208 _dbus_marshal_string (DBusString    *str,
 209                       int            byte_order,
 210                       const char    *value)
 211 {
 212   int len;
 213
 214   len = strlen (value);
 215
 216   if (!_dbus_marshal_uint32 (str, byte_order, len))
 217     return FALSE;
 218
 219   return _dbus_string_append_len (str, value, len + 1);
 220 }
 221
 222 /**
 223  * Marshals a byte array
 224  *
 225  * @param str the string to append the marshalled value to
 226  * @param byte_order the byte order to use
 227  * @param value the byte array
 228  * @param len the length of the byte array
 229  * @returns #TRUE on success
 230  */
 231 dbus_bool_t
 232 _dbus_marshal_byte_array (DBusString          *str,
 233                           int                  byte_order,
 234                           const unsigned char *value,
 235                           int                  len)
 236 {
 237   if (!_dbus_marshal_uint32 (str, byte_order, len))
 238     return FALSE;
 239
 240   return _dbus_string_append_len (str, value, len);
 241 }
 242
 243 /**
 244  * Demarshals a double.
 245  *
 246  * @param str the string containing the data
 247  * @param byte_order the byte order
 248  * @param pos the position in the string
 249  * @param new_pos the new position of the string
 250  * @returns the demarshaled double.
 251  */
 252 double
 253 _dbus_demarshal_double (DBusString  *str,
 254                         int          byte_order,
 255                         int          pos,
 256                         int         *new_pos)
 257 {
 258   double retval;
 259   const char *buffer;
 260
 261   pos = DBUS_ALIGN_VALUE (pos, sizeof (double));
 262
 263   _dbus_string_get_const_data_len (str, &buffer, pos, sizeof (double));
 264
 265   retval = *(double *)buffer;
 266
 267   if (byte_order != DBUS_COMPILER_BYTE_ORDER)
 268     swap_bytes ((unsigned char *)&retval, sizeof (double));
 269
 270   if (new_pos)
 271     *new_pos = pos + sizeof (double);
 272
 273   return retval;
 274 }
 275
 276 /**
 277  * Demarshals a 32 bit signed integer.
 278  *
 279  * @param str the string containing the data
 280  * @param byte_order the byte order
 281  * @param pos the position in the string
 282  * @param new_pos the new position of the string
 283  * @returns the demarshaled integer.
 284  */
 285 dbus_int32_t
 286 _dbus_demarshal_int32  (DBusString *str,
 287                         int         byte_order,
 288                         int         pos,
 289                         int        *new_pos)
 290 {
 291   const char *buffer;
 292
 293   pos = DBUS_ALIGN_VALUE (pos, sizeof (dbus_int32_t));
 294
 295   _dbus_string_get_const_data_len (str, &buffer, pos, sizeof (dbus_int32_t));
 296
 297   if (new_pos)
 298     *new_pos = pos + sizeof (dbus_int32_t);
 299
 300   return unpack_int32 (byte_order, buffer);
 301 }
 302
 303 /**
 304  * Demarshals a 32 bit unsigned integer.
 305  *
 306  * @param str the string containing the data
 307  * @param byte_order the byte order
 308  * @param pos the position in the string
 309  * @param new_pos the new position of the string
 310  * @returns the demarshaled integer.
 311  */
 312 dbus_uint32_t
 313 _dbus_demarshal_uint32  (DBusString *str,
 314                          int         byte_order,
 315                          int         pos,
 316                          int        *new_pos)
 317 {
 318   const char *buffer;
 319
 320   pos = DBUS_ALIGN_VALUE (pos, sizeof (dbus_uint32_t));
 321
 322   _dbus_string_get_const_data_len (str, &buffer, pos, sizeof (dbus_uint32_t));
 323
 324   if (new_pos)
 325     *new_pos = pos + sizeof (dbus_uint32_t);
 326
 327   return unpack_uint32 (byte_order, buffer);
 328 }
 329
 330 /**
 331  * Demarshals an UTF-8 string.
 332  *
 333  * @todo Should we check the string to make sure
 334  * that it's  valid UTF-8, and maybe "fix" the string
 335  * if it's broken?
 336  *
 337  * @param str the string containing the data
 338  * @param byte_order the byte order
 339  * @param pos the position in the string
 340  * @param new_pos the new position of the string
 341  * @returns the demarshaled string.
 342  */
 343 char *
 344 _dbus_demarshal_string (DBusString *str,
 345                         int         byte_order,
 346                         int         pos,
 347                         int        *new_pos)
 348 {
 349   int len;
 350   char *retval;
 351   const char *data;
 352
 353   len = _dbus_demarshal_uint32 (str, byte_order, pos, &pos);
 354
 355   retval = dbus_malloc (len + 1);
 356
 357   if (!retval)
 358     return NULL;
 359
 360   _dbus_string_get_const_data_len (str, &data, pos, 3);
 361
 362   if (!data)
 363     return NULL;
 364
 365   memcpy (retval, data, len + 1);
 366
 367   if (new_pos)
 368     *new_pos = pos + len + 1;
 369
 370   return retval;
 371 }
 372
 373 /**
 374  * If in verbose mode, print a block of binary data.
 375  *
 376  * @param data the data
 377  * @param len the length of the data
 378  */
 379 void
 380 _dbus_verbose_bytes (const unsigned char *data,
 381                      int                  len)
 382 {
 383   int i;
 384   const unsigned char *aligned;
 385
 386   /* Print blanks on first row if appropriate */
 387   aligned = DBUS_ALIGN_ADDRESS (data, 4);
 388   if (aligned > data)
 389     aligned -= 4;
 390   _dbus_assert (aligned <= data);
 391
 392   if (aligned != data)
 393     {
 394       _dbus_verbose ("%5d\t%p: ", - (data - aligned), aligned);
 395       while (aligned != data)
 396         {
 397           _dbus_verbose ("    ");
 398           ++aligned;
 399         }
 400     }
 401
 402   /* now print the bytes */
 403   i = 0;
 404   while (i < len)
 405     {
 406       if (DBUS_ALIGN_ADDRESS (&data[i], 4) == &data[i])
 407         {
 408           _dbus_verbose ("%5d\t%p: ",
 409                    i, &data[i]);
 410         }
 411
 412       if (data[i] >= 32 &&
 413           data[i] <= 126)
 414         _dbus_verbose (" '%c' ", data[i]);
 415       else
 416         _dbus_verbose ("0x%s%x ",
 417                  data[i] <= 0xf ? "0" : "", data[i]);
 418
 419       ++i;
 420
 421       if (DBUS_ALIGN_ADDRESS (&data[i], 4) == &data[i])
 422         {
 423           if (i > 3)
 424             _dbus_verbose ("big: %d little: %d",
 425                      unpack_uint32 (DBUS_BIG_ENDIAN, &data[i-4]),
 426                      unpack_uint32 (DBUS_LITTLE_ENDIAN, &data[i-4]));
 427
 428           _dbus_verbose ("\n");
 429         }
 430     }
 431
 432   _dbus_verbose ("\n");
 433 }
 434
 435 /**
 436  * Dump the given part of the string to verbose log.
 437  *
 438  * @param str the string
 439  * @param start the start of range to dump
 440  * @param len length of range
 441  */
 442 void
 443 _dbus_verbose_bytes_of_string (const DBusString    *str,
 444                                int                  start,
 445                                int                  len)
 446 {
 447   const char *d;
 448
 449   _dbus_string_get_const_data_len (str, &d, start, len);
 450
 451   _dbus_verbose_bytes (d, len);
 452 }
 453
 454 /** @} */
 455
 456 #ifdef DBUS_BUILD_TESTS
 457 #include "dbus-test.h"
 458 #include <stdio.h>
 459
 460 dbus_bool_t
 461 _dbus_marshal_test (void)
 462 {
 463   DBusString str;
 464   char *tmp1, *tmp2;
 465   int pos = 0;
 466
 467   if (!_dbus_string_init (&str, _DBUS_INT_MAX))
 468     _dbus_assert_not_reached ("failed to init string");
 469
 470
 471   /* Marshal doubles */
 472   if (!_dbus_marshal_double (&str, DBUS_BIG_ENDIAN, 3.14))
 473     _dbus_assert_not_reached ("could not marshal double value");
 474   _dbus_assert (_dbus_demarshal_double (&str, DBUS_BIG_ENDIAN, pos, &pos) == 3.14);
 475
 476
 477   if (!_dbus_marshal_double (&str, DBUS_LITTLE_ENDIAN, 3.14))
 478     _dbus_assert_not_reached ("could not marshal double value");
 479   _dbus_assert (_dbus_demarshal_double (&str, DBUS_LITTLE_ENDIAN, pos, &pos) == 3.14);
 480
 481   /* Marshal signed integers */
 482   if (!_dbus_marshal_int32 (&str, DBUS_BIG_ENDIAN, -12345678))
 483     _dbus_assert_not_reached ("could not marshal signed integer value");
 484   _dbus_assert (_dbus_demarshal_int32 (&str, DBUS_BIG_ENDIAN, pos, &pos) == -12345678);
 485
 486   if (!_dbus_marshal_int32 (&str, DBUS_LITTLE_ENDIAN, -12345678))
 487     _dbus_assert_not_reached ("could not marshal signed integer value");
 488   _dbus_assert (_dbus_demarshal_int32 (&str, DBUS_LITTLE_ENDIAN, pos, &pos) == -12345678);
 489
 490   /* Marshal unsigned integers */
 491   if (!_dbus_marshal_uint32 (&str, DBUS_BIG_ENDIAN, 0x12345678))
 492     _dbus_assert_not_reached ("could not marshal signed integer value");
 493   _dbus_assert (_dbus_demarshal_uint32 (&str, DBUS_BIG_ENDIAN, pos, &pos) == 0x12345678);
 494
 495   if (!_dbus_marshal_uint32 (&str, DBUS_LITTLE_ENDIAN, 0x12345678))
 496     _dbus_assert_not_reached ("could not marshal signed integer value");
 497   _dbus_assert (_dbus_demarshal_uint32 (&str, DBUS_LITTLE_ENDIAN, pos, &pos) == 0x12345678);
 498
 499   /* Marshal strings */
 500   tmp1 = "This is the dbus test string";
 501   if (!_dbus_marshal_string (&str, DBUS_BIG_ENDIAN, tmp1))
 502     _dbus_assert_not_reached ("could not marshal string");
 503   tmp2 = _dbus_demarshal_string (&str, DBUS_BIG_ENDIAN, pos, &pos);
 504   _dbus_assert (strcmp (tmp1, tmp2) == 0);
 505   dbus_free (tmp2);
 506
 507   tmp1 = "This is the dbus test string";
 508   if (!_dbus_marshal_string (&str, DBUS_LITTLE_ENDIAN, tmp1))
 509     _dbus_assert_not_reached ("could not marshal string");
 510   tmp2 = _dbus_demarshal_string (&str, DBUS_LITTLE_ENDIAN, pos, &pos);
 511   _dbus_assert (strcmp (tmp1, tmp2) == 0);
 512   dbus_free (tmp2);
 513
 514   _dbus_string_free (&str);
 515
 516   return TRUE;
 517 }
 518
 519 #endif /* DBUS_BUILD_TESTS */