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 dbus_bool_t
 128 _dbus_marshal_double (DBusString *str,
 129                       int         byte_order,
 130                       double      value)
 131 {
 132   if (!_dbus_string_set_length (str,
 133                                 DBUS_ALIGN_VALUE (_dbus_string_get_length (str),
 134                                                   sizeof (double))))
 135     return FALSE;
 136
 137   if (byte_order != DBUS_COMPILER_BYTE_ORDER)
 138     swap_bytes ((unsigned char *)&value, sizeof (double));
 139
 140   return _dbus_string_append_len (str, (const char *)&value, sizeof (double));
 141 }
 142
 143 dbus_bool_t
 144 _dbus_marshal_int32  (DBusString   *str,
 145                       int           byte_order,
 146                       dbus_int32_t  value)
 147 {
 148   if (!_dbus_string_set_length (str,
 149                                 DBUS_ALIGN_VALUE (_dbus_string_get_length (str),
 150                                                   sizeof (dbus_int32_t))))
 151     return FALSE;
 152
 153   if (byte_order != DBUS_COMPILER_BYTE_ORDER)
 154     swap_bytes ((unsigned char *)&value, sizeof (dbus_int32_t));
 155
 156   return _dbus_string_append_len (str, (const char *)&value, sizeof (dbus_int32_t));
 157 }
 158
 159 dbus_bool_t
 160 _dbus_marshal_uint32 (DBusString    *str,
 161                       int            byte_order,
 162                       dbus_uint32_t  value)
 163 {
 164   if (!_dbus_string_set_length (str,
 165                                 DBUS_ALIGN_VALUE (_dbus_string_get_length (str),
 166                                                   sizeof (dbus_uint32_t))))
 167     return FALSE;
 168
 169   if (byte_order != DBUS_COMPILER_BYTE_ORDER)
 170     swap_bytes ((unsigned char *)&value, sizeof (dbus_uint32_t));
 171
 172   return _dbus_string_append_len (str, (const char *)&value, sizeof (dbus_uint32_t));
 173 }
 174
 175 dbus_bool_t
 176 _dbus_marshal_string (DBusString    *str,
 177                       int            byte_order,
 178                       const char    *value)
 179 {
 180   int len;
 181
 182   if (!_dbus_string_set_length (str,
 183                                 DBUS_ALIGN_VALUE (_dbus_string_get_length (str),
 184                                                   sizeof (dbus_uint32_t))))
 185     return FALSE;
 186
 187   len = strlen (value);
 188
 189   if (!_dbus_string_lengthen (str, len + 1))
 190     return FALSE;
 191
 192   if (!_dbus_marshal_uint32 (str, byte_order, len))
 193     return FALSE;
 194
 195   return _dbus_string_append_len (str, value, len + 1);
 196 }
 197
 198
 199 double
 200 _dbus_demarshal_double (DBusString  *str,
 201                         int          byte_order,
 202                         int          pos,
 203                         int         *new_pos)
 204 {
 205   double retval;
 206   const char *buffer;
 207
 208   _dbus_string_get_const_data_len (str, &buffer, pos, sizeof (double));
 209
 210   retval = *(double *)buffer;
 211
 212   if (byte_order != DBUS_COMPILER_BYTE_ORDER)
 213     swap_bytes ((unsigned char *)&retval, sizeof (double));
 214
 215   if (new_pos)
 216     *new_pos = pos + sizeof (double);
 217
 218   return retval;
 219 }
 220
 221 dbus_int32_t
 222 _dbus_demarshal_int32  (DBusString *str,
 223                         int         byte_order,
 224                         int         pos,
 225                         int        *new_pos)
 226 {
 227   const char *buffer;
 228
 229   _dbus_string_get_const_data_len (str, &buffer, pos, sizeof (dbus_int32_t));
 230
 231   if (new_pos)
 232     *new_pos = pos + sizeof (dbus_int32_t);
 233
 234   return unpack_int32 (byte_order, buffer);
 235 }
 236
 237 dbus_uint32_t
 238 _dbus_demarshal_uint32  (DBusString *str,
 239                          int         byte_order,
 240                          int         pos,
 241                          int        *new_pos)
 242 {
 243   const char *buffer;
 244
 245   _dbus_string_get_const_data_len (str, &buffer, pos, sizeof (dbus_uint32_t));
 246
 247   if (new_pos)
 248     *new_pos = pos + sizeof (dbus_uint32_t);
 249
 250   return unpack_uint32 (byte_order, buffer);
 251 }
 252
 253 char *
 254 _dbus_demarshal_string (DBusString *str,
 255                         int         byte_order,
 256                         int         pos,
 257                         int        *new_pos)
 258 {
 259   int len;
 260   char *retval;
 261   const char *data;
 262
 263   len = _dbus_demarshal_uint32 (str, byte_order, pos, &pos);
 264
 265   retval = dbus_malloc (len + 1);
 266
 267   if (!retval)
 268     return NULL;
 269
 270   _dbus_string_get_const_data_len (str, &data, pos, len + 1);
 271
 272   if (!data)
 273     return NULL;
 274
 275   memcpy (retval, data, len + 1);
 276
 277   if (new_pos)
 278     *new_pos = pos + len + 1;
 279
 280   return retval;
 281 }
 282
 283 /**
 284  * If in verbose mode, print a block of binary data.
 285  *
 286  * @param data the data
 287  * @param len the length of the data
 288  */
 289 void
 290 _dbus_verbose_bytes (const unsigned char *data,
 291                      int                  len)
 292 {
 293   int i;
 294   const unsigned char *aligned;
 295
 296   /* Print blanks on first row if appropriate */
 297   aligned = DBUS_ALIGN_ADDRESS (data, 4);
 298   if (aligned > data)
 299     aligned -= 4;
 300   _dbus_assert (aligned <= data);
 301
 302   if (aligned != data)
 303     {
 304       _dbus_verbose ("%5d\t%p: ", - (data - aligned), aligned);
 305       while (aligned != data)
 306         {
 307           _dbus_verbose ("    ");
 308           ++aligned;
 309         }
 310     }
 311
 312   /* now print the bytes */
 313   i = 0;
 314   while (i < len)
 315     {
 316       if (DBUS_ALIGN_ADDRESS (&data[i], 4) == &data[i])
 317         {
 318           _dbus_verbose ("%5d\t%p: ",
 319                    i, &data[i]);
 320         }
 321
 322       if (data[i] >= 32 &&
 323           data[i] <= 126)
 324         _dbus_verbose (" '%c' ", data[i]);
 325       else
 326         _dbus_verbose ("0x%s%x ",
 327                  data[i] <= 0xf ? "0" : "", data[i]);
 328
 329       ++i;
 330
 331       if (DBUS_ALIGN_ADDRESS (&data[i], 4) == &data[i])
 332         {
 333           if (i > 3)
 334             _dbus_verbose ("big: %d little: %d",
 335                      unpack_uint32 (DBUS_BIG_ENDIAN, &data[i-4]),
 336                      unpack_uint32 (DBUS_LITTLE_ENDIAN, &data[i-4]));
 337
 338           _dbus_verbose ("\n");
 339         }
 340     }
 341
 342   _dbus_verbose ("\n");
 343 }
 344
 345 /**
 346  * Dump the given part of the string to verbose log.
 347  *
 348  * @param str the string
 349  * @param start the start of range to dump
 350  * @param len length of range
 351  */
 352 void
 353 _dbus_verbose_bytes_of_string (const DBusString    *str,
 354                                int                  start,
 355                                int                  len)
 356 {
 357   const char *d;
 358
 359   _dbus_string_get_const_data_len (str, &d, start, len);
 360
 361   _dbus_verbose_bytes (d, len);
 362 }
 363
 364 /** @} */
 365
 366 #ifdef DBUS_BUILD_TESTS
 367 #include "dbus-test.h"
 368 #include <stdio.h>
 369
 370 dbus_bool_t
 371 _dbus_marshal_test (void)
 372 {
 373   DBusString str;
 374   int pos = 0;
 375
 376   if (!_dbus_string_init (&str, _DBUS_INT_MAX))
 377     _dbus_assert_not_reached ("failed to init string");
 378
 379
 380   /* Marshal doubles */
 381   if (!_dbus_marshal_double (&str, DBUS_BIG_ENDIAN, 3.14))
 382     _dbus_assert_not_reached ("could not marshal double value");
 383   _dbus_assert (_dbus_demarshal_double (&str, DBUS_BIG_ENDIAN, pos, &pos) == 3.14);
 384
 385
 386   if (!_dbus_marshal_double (&str, DBUS_LITTLE_ENDIAN, 3.14))
 387     _dbus_assert_not_reached ("could not marshal double value");
 388   _dbus_assert (_dbus_demarshal_double (&str, DBUS_LITTLE_ENDIAN, pos, &pos) == 3.14);
 389
 390   /* Marshal signed integers */
 391   if (!_dbus_marshal_int32 (&str, DBUS_BIG_ENDIAN, -12345678))
 392     _dbus_assert_not_reached ("could not marshal signed integer value");
 393   _dbus_assert (_dbus_demarshal_int32 (&str, DBUS_BIG_ENDIAN, pos, &pos) == -12345678);
 394
 395   if (!_dbus_marshal_int32 (&str, DBUS_LITTLE_ENDIAN, -12345678))
 396     _dbus_assert_not_reached ("could not marshal signed integer value");
 397   _dbus_assert (_dbus_demarshal_int32 (&str, DBUS_LITTLE_ENDIAN, pos, &pos) == -12345678);
 398
 399   /* Marshal unsigned integers */
 400   if (!_dbus_marshal_uint32 (&str, DBUS_LITTLE_ENDIAN, 0x12345678))
 401     _dbus_assert_not_reached ("could not marshal signed integer value");
 402   _dbus_assert (_dbus_demarshal_uint32 (&str, DBUS_LITTLE_ENDIAN, pos, &pos) == 0x12345678);
 403
 404   _dbus_string_free (&str);
 405
 406   /* FIXME. Add string marshal tests */
 407
 408   return TRUE;
 409 }
 410
 411 #endif /* DBUS_BUILD_TESTS */