dbus/dbus-marshal-basic.h

   1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
   2 /* dbus-marshal-basic.h  Marshalling routines for basic (primitive) types
   3  *
   4  * Copyright (C) 2002  CodeFactory AB
   5  * Copyright (C) 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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  22  *
  23  */
  24
  25 #ifndef DBUS_MARSHAL_BASIC_H
  26 #define DBUS_MARSHAL_BASIC_H
  27
  28 #ifdef HAVE_BYTESWAP_H
  29 #include <byteswap.h>
  30 #endif
  31
  32 #include <dbus/dbus-protocol.h>
  33 #include <dbus/dbus-types.h>
  34 #include <dbus/dbus-arch-deps.h>
  35 #include <dbus/dbus-string.h>
  36
  37 #ifdef WORDS_BIGENDIAN
  38 #define DBUS_COMPILER_BYTE_ORDER DBUS_BIG_ENDIAN
  39 #else
  40 #define DBUS_COMPILER_BYTE_ORDER DBUS_LITTLE_ENDIAN
  41 #endif
  42
  43 #ifdef HAVE_BYTESWAP_H
  44 #define DBUS_UINT16_SWAP_LE_BE_CONSTANT(val) bswap_16(val)
  45 #define DBUS_UINT32_SWAP_LE_BE_CONSTANT(val) bswap_32(val)
  46 #else /* HAVE_BYTESWAP_H */
  47
  48 #define DBUS_UINT16_SWAP_LE_BE_CONSTANT(val)    ((dbus_uint16_t) (      \
  49     (dbus_uint16_t) ((dbus_uint16_t) (val) >> 8) |                      \
  50     (dbus_uint16_t) ((dbus_uint16_t) (val) << 8)))
  51
  52 #define DBUS_UINT32_SWAP_LE_BE_CONSTANT(val)    ((dbus_uint32_t) (      \
  53     (((dbus_uint32_t) (val) & (dbus_uint32_t) 0x000000ffU) << 24) |     \
  54     (((dbus_uint32_t) (val) & (dbus_uint32_t) 0x0000ff00U) <<  8) |     \
  55     (((dbus_uint32_t) (val) & (dbus_uint32_t) 0x00ff0000U) >>  8) |     \
  56     (((dbus_uint32_t) (val) & (dbus_uint32_t) 0xff000000U) >> 24)))
  57
  58 #endif /* HAVE_BYTESWAP_H */
  59
  60 #ifdef HAVE_BYTESWAP_H
  61 #define DBUS_UINT64_SWAP_LE_BE_CONSTANT(val) bswap_64(val)
  62 #else /* HAVE_BYTESWAP_H */
  63
  64 #define DBUS_UINT64_SWAP_LE_BE_CONSTANT(val)    ((dbus_uint64_t) (              \
  65       (((dbus_uint64_t) (val) &                                                 \
  66         (dbus_uint64_t) DBUS_UINT64_CONSTANT (0x00000000000000ff)) << 56) |    \
  67       (((dbus_uint64_t) (val) &                                                 \
  68         (dbus_uint64_t) DBUS_UINT64_CONSTANT (0x000000000000ff00)) << 40) |    \
  69       (((dbus_uint64_t) (val) &                                                 \
  70         (dbus_uint64_t) DBUS_UINT64_CONSTANT (0x0000000000ff0000)) << 24) |    \
  71       (((dbus_uint64_t) (val) &                                                 \
  72         (dbus_uint64_t) DBUS_UINT64_CONSTANT (0x00000000ff000000)) <<  8) |    \
  73       (((dbus_uint64_t) (val) &                                                 \
  74         (dbus_uint64_t) DBUS_UINT64_CONSTANT (0x000000ff00000000)) >>  8) |    \
  75       (((dbus_uint64_t) (val) &                                                 \
  76         (dbus_uint64_t) DBUS_UINT64_CONSTANT (0x0000ff0000000000)) >> 24) |    \
  77       (((dbus_uint64_t) (val) &                                                 \
  78         (dbus_uint64_t) DBUS_UINT64_CONSTANT (0x00ff000000000000)) >> 40) |    \
  79       (((dbus_uint64_t) (val) &                                                 \
  80         (dbus_uint64_t) DBUS_UINT64_CONSTANT (0xff00000000000000)) >> 56)))
  81
  82 #endif /* HAVE_BYTESWAP_H */
  83
  84 #define DBUS_UINT16_SWAP_LE_BE(val) (DBUS_UINT16_SWAP_LE_BE_CONSTANT (val))
  85 #define DBUS_INT16_SWAP_LE_BE(val)  ((dbus_int16_t)DBUS_UINT16_SWAP_LE_BE_CONSTANT (val))
  86
  87 #define DBUS_UINT32_SWAP_LE_BE(val) (DBUS_UINT32_SWAP_LE_BE_CONSTANT (val))
  88 #define DBUS_INT32_SWAP_LE_BE(val)  ((dbus_int32_t)DBUS_UINT32_SWAP_LE_BE_CONSTANT (val))
  89
  90 #define DBUS_UINT64_SWAP_LE_BE(val) (DBUS_UINT64_SWAP_LE_BE_CONSTANT (val))
  91 #define DBUS_INT64_SWAP_LE_BE(val)  ((dbus_int64_t)DBUS_UINT64_SWAP_LE_BE_CONSTANT (val))
  92
  93 #ifdef WORDS_BIGENDIAN
  94
  95 #  define DBUS_INT16_TO_BE(val) ((dbus_int16_t) (val))
  96 #  define DBUS_UINT16_TO_BE(val)        ((dbus_uint16_t) (val))
  97 #  define DBUS_INT16_TO_LE(val) (DBUS_INT16_SWAP_LE_BE (val))
  98 #  define DBUS_UINT16_TO_LE(val)        (DBUS_UINT16_SWAP_LE_BE (val))
  99 #  define DBUS_INT32_TO_BE(val) ((dbus_int32_t) (val))
 100 #  define DBUS_UINT32_TO_BE(val)        ((dbus_uint32_t) (val))
 101 #  define DBUS_INT32_TO_LE(val) (DBUS_INT32_SWAP_LE_BE (val))
 102 #  define DBUS_UINT32_TO_LE(val)        (DBUS_UINT32_SWAP_LE_BE (val))
 103 #  define DBUS_INT64_TO_BE(val) ((dbus_int64_t) (val))
 104 #  define DBUS_UINT64_TO_BE(val)        ((dbus_uint64_t) (val))
 105 #  define DBUS_INT64_TO_LE(val) (DBUS_INT64_SWAP_LE_BE (val))
 106 #  define DBUS_UINT64_TO_LE(val)        (DBUS_UINT64_SWAP_LE_BE (val))
 107
 108 #else /* WORDS_BIGENDIAN */
 109
 110 #  define DBUS_INT16_TO_LE(val) ((dbus_int16_t) (val))
 111 #  define DBUS_UINT16_TO_LE(val)        ((dbus_uint16_t) (val))
 112 #  define DBUS_INT16_TO_BE(val) ((dbus_int16_t) DBUS_UINT16_SWAP_LE_BE (val))
 113 #  define DBUS_UINT16_TO_BE(val)        (DBUS_UINT16_SWAP_LE_BE (val))
 114 #  define DBUS_INT32_TO_LE(val) ((dbus_int32_t) (val))
 115 #  define DBUS_UINT32_TO_LE(val)        ((dbus_uint32_t) (val))
 116 #  define DBUS_INT32_TO_BE(val) ((dbus_int32_t) DBUS_UINT32_SWAP_LE_BE (val))
 117 #  define DBUS_UINT32_TO_BE(val)        (DBUS_UINT32_SWAP_LE_BE (val))
 118 #  define DBUS_INT64_TO_LE(val) ((dbus_int64_t) (val))
 119 #  define DBUS_UINT64_TO_LE(val)        ((dbus_uint64_t) (val))
 120 #  define DBUS_INT64_TO_BE(val) ((dbus_int64_t) DBUS_UINT64_SWAP_LE_BE (val))
 121 #  define DBUS_UINT64_TO_BE(val)        (DBUS_UINT64_SWAP_LE_BE (val))
 122 #endif
 123
 124 /* The transformation is symmetric, so the FROM just maps to the TO. */
 125 #define DBUS_INT16_FROM_LE(val)  (DBUS_INT16_TO_LE (val))
 126 #define DBUS_UINT16_FROM_LE(val) (DBUS_UINT16_TO_LE (val))
 127 #define DBUS_INT16_FROM_BE(val)  (DBUS_INT16_TO_BE (val))
 128 #define DBUS_UINT16_FROM_BE(val) (DBUS_UINT16_TO_BE (val))
 129 #define DBUS_INT32_FROM_LE(val)  (DBUS_INT32_TO_LE (val))
 130 #define DBUS_UINT32_FROM_LE(val) (DBUS_UINT32_TO_LE (val))
 131 #define DBUS_INT32_FROM_BE(val)  (DBUS_INT32_TO_BE (val))
 132 #define DBUS_UINT32_FROM_BE(val) (DBUS_UINT32_TO_BE (val))
 133 #define DBUS_INT64_FROM_LE(val)  (DBUS_INT64_TO_LE (val))
 134 #define DBUS_UINT64_FROM_LE(val) (DBUS_UINT64_TO_LE (val))
 135 #define DBUS_INT64_FROM_BE(val)  (DBUS_INT64_TO_BE (val))
 136 #define DBUS_UINT64_FROM_BE(val) (DBUS_UINT64_TO_BE (val))
 137
 138 #ifdef DBUS_DISABLE_ASSERT
 139 #define _dbus_unpack_uint16(byte_order, data)           \
 140    (((byte_order) == DBUS_LITTLE_ENDIAN) ?              \
 141      DBUS_UINT16_FROM_LE (*(dbus_uint16_t*)(data)) :    \
 142      DBUS_UINT16_FROM_BE (*(dbus_uint16_t*)(data)))
 143
 144 #define _dbus_unpack_uint32(byte_order, data)           \
 145    (((byte_order) == DBUS_LITTLE_ENDIAN) ?              \
 146      DBUS_UINT32_FROM_LE (*(dbus_uint32_t*)(data)) :    \
 147      DBUS_UINT32_FROM_BE (*(dbus_uint32_t*)(data)))
 148 #endif
 149
 150 #ifndef _dbus_unpack_uint16
 151 DBUS_PRIVATE_EXPORT
 152 dbus_uint16_t _dbus_unpack_uint16 (int                  byte_order,
 153                                    const unsigned char *data);
 154 #endif
 155
 156 void          _dbus_pack_uint32   (dbus_uint32_t        value,
 157                                    int                  byte_order,
 158                                    unsigned char       *data);
 159 #ifndef _dbus_unpack_uint32
 160 DBUS_PRIVATE_EXPORT
 161 dbus_uint32_t _dbus_unpack_uint32 (int                  byte_order,
 162                                    const unsigned char *data);
 163 #endif
 164
 165 dbus_bool_t   _dbus_marshal_set_basic         (DBusString       *str,
 166                                                int               pos,
 167                                                int               type,
 168                                                const void       *value,
 169                                                int               byte_order,
 170                                                int              *old_end_pos,
 171                                                int              *new_end_pos);
 172 dbus_bool_t   _dbus_marshal_write_basic       (DBusString       *str,
 173                                                int               insert_at,
 174                                                int               type,
 175                                                const void       *value,
 176                                                int               byte_order,
 177                                                int              *pos_after);
 178 dbus_bool_t   _dbus_marshal_write_fixed_multi (DBusString       *str,
 179                                                int               insert_at,
 180                                                int               element_type,
 181                                                const void       *value,
 182                                                int               n_elements,
 183                                                int               byte_order,
 184                                                int              *pos_after);
 185 void          _dbus_marshal_read_basic        (const DBusString *str,
 186                                                int               pos,
 187                                                int               type,
 188                                                void             *value,
 189                                                int               byte_order,
 190                                                int              *new_pos);
 191 void          _dbus_marshal_read_fixed_multi  (const DBusString *str,
 192                                                int               pos,
 193                                                int               element_type,
 194                                                void             *value,
 195                                                int               n_elements,
 196                                                int               byte_order,
 197                                                int              *new_pos);
 198 void          _dbus_marshal_skip_basic        (const DBusString *str,
 199                                                int               type,
 200                                                int               byte_order,
 201                                                int              *pos);
 202 void          _dbus_marshal_skip_array        (const DBusString *str,
 203                                                int               element_type,
 204                                                int               byte_order,
 205                                                int              *pos);
 206 DBUS_PRIVATE_EXPORT
 207 void          _dbus_marshal_set_uint32        (DBusString       *str,
 208                                                int               pos,
 209                                                dbus_uint32_t     value,
 210                                                int               byte_order);
 211 DBUS_PRIVATE_EXPORT
 212 dbus_uint32_t _dbus_marshal_read_uint32       (const DBusString *str,
 213                                                int               pos,
 214                                                int               byte_order,
 215                                                int              *new_pos);
 216 int           _dbus_type_get_alignment        (int               typecode);
 217 DBUS_PRIVATE_EXPORT
 218 const char*   _dbus_type_to_string            (int               typecode);
 219
 220 DBUS_PRIVATE_EXPORT
 221 int           _dbus_first_type_in_signature   (const DBusString *str,
 222                                                int               pos);
 223
 224 int           _dbus_first_type_in_signature_c_str   (const char       *str,
 225                                                      int               pos);
 226
 227 void _dbus_swap_array (unsigned char *data,
 228                        int            n_elements,
 229                        int            alignment);
 230
 231 #endif /* DBUS_MARSHAL_BASIC_H */