dbus/dbus-protocol.h

   1 /* -*- mode: C; c-file-style: "gnu" -*- */
   2 /* dbus-protocol.h  D-Bus protocol constants
   3  *
   4  * Copyright (C) 2002, 2003  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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  22  *
  23  */
  24
  25 #ifndef DBUS_PROTOCOL_H
  26 #define DBUS_PROTOCOL_H
  27
  28 /* Don't include anything in here from anywhere else. It's
  29  * intended for use by any random library.
  30  */
  31
  32 #ifdef  __cplusplus
  33 extern "C" {
  34 #endif
  35
  36 /* Message byte order */
  37 #define DBUS_LITTLE_ENDIAN ('l')  /* LSB first */
  38 #define DBUS_BIG_ENDIAN    ('B')  /* MSB first */
  39
  40 /* Protocol version */
  41 #define DBUS_MAJOR_PROTOCOL_VERSION 1
  42
  43 /* Never a legitimate type */
  44 #define DBUS_TYPE_INVALID       ((int) '\0')
  45 #define DBUS_TYPE_INVALID_AS_STRING        "\0"
  46
  47 /* Primitive types */
  48 #define DBUS_TYPE_BYTE          ((int) 'y')
  49 #define DBUS_TYPE_BYTE_AS_STRING           "y"
  50 #define DBUS_TYPE_BOOLEAN       ((int) 'b')
  51 #define DBUS_TYPE_BOOLEAN_AS_STRING        "b"
  52 #define DBUS_TYPE_INT16         ((int) 'n')
  53 #define DBUS_TYPE_INT16_AS_STRING          "n"
  54 #define DBUS_TYPE_UINT16        ((int) 'q')
  55 #define DBUS_TYPE_UINT16_AS_STRING         "q"
  56 #define DBUS_TYPE_INT32         ((int) 'i')
  57 #define DBUS_TYPE_INT32_AS_STRING          "i"
  58 #define DBUS_TYPE_UINT32        ((int) 'u')
  59 #define DBUS_TYPE_UINT32_AS_STRING         "u"
  60 #define DBUS_TYPE_INT64         ((int) 'x')
  61 #define DBUS_TYPE_INT64_AS_STRING          "x"
  62 #define DBUS_TYPE_UINT64        ((int) 't')
  63 #define DBUS_TYPE_UINT64_AS_STRING         "t"
  64
  65 #define DBUS_TYPE_DOUBLE        ((int) 'd')
  66 #define DBUS_TYPE_DOUBLE_AS_STRING         "d"
  67 #define DBUS_TYPE_STRING        ((int) 's')
  68 #define DBUS_TYPE_STRING_AS_STRING         "s"
  69 #define DBUS_TYPE_OBJECT_PATH   ((int) 'o')
  70 #define DBUS_TYPE_OBJECT_PATH_AS_STRING    "o"
  71 #define DBUS_TYPE_SIGNATURE     ((int) 'g')
  72 #define DBUS_TYPE_SIGNATURE_AS_STRING      "g"
  73
  74 /* Compound types */
  75 #define DBUS_TYPE_ARRAY         ((int) 'a')
  76 #define DBUS_TYPE_ARRAY_AS_STRING          "a"
  77 #define DBUS_TYPE_VARIANT       ((int) 'v')
  78 #define DBUS_TYPE_VARIANT_AS_STRING        "v"
  79
  80 /* STRUCT and DICT_ENTRY are sort of special since their codes can't
  81  * appear in a type string, instead
  82  * DBUS_STRUCT_BEGIN_CHAR/DBUS_DICT_ENTRY_BEGIN_CHAR have to appear
  83  */
  84 #define DBUS_TYPE_STRUCT        ((int) 'r')
  85 #define DBUS_TYPE_STRUCT_AS_STRING         "r"
  86 #define DBUS_TYPE_DICT_ENTRY    ((int) 'e')
  87 #define DBUS_TYPE_DICT_ENTRY_AS_STRING     "e"
  88
  89 /* Does not count INVALID */
  90 #define DBUS_NUMBER_OF_TYPES    (16)
  91
  92 /* characters other than typecodes that appear in type signatures */
  93 #define DBUS_STRUCT_BEGIN_CHAR   ((int) '(')
  94 #define DBUS_STRUCT_BEGIN_CHAR_AS_STRING   "("
  95 #define DBUS_STRUCT_END_CHAR     ((int) ')')
  96 #define DBUS_STRUCT_END_CHAR_AS_STRING     ")"
  97 #define DBUS_DICT_ENTRY_BEGIN_CHAR   ((int) '{')
  98 #define DBUS_DICT_ENTRY_BEGIN_CHAR_AS_STRING   "{"
  99 #define DBUS_DICT_ENTRY_END_CHAR     ((int) '}')
 100 #define DBUS_DICT_ENTRY_END_CHAR_AS_STRING     "}"
 101
 102 /* Max length in bytes of a bus name, interface, or member (not object
 103  * path, paths are unlimited). This is limited because lots of stuff
 104  * is O(n) in this number, plus it would be obnoxious to type in a
 105  * paragraph-long method name so most likely something like that would
 106  * be an exploit.
 107  */
 108 #define DBUS_MAXIMUM_NAME_LENGTH 255
 109
 110 /* This one is 255 so it fits in a byte */
 111 #define DBUS_MAXIMUM_SIGNATURE_LENGTH 255
 112
 113 /* Max length of a match rule string; to keep people from hosing the
 114  * daemon with some huge rule
 115  */
 116 #define DBUS_MAXIMUM_MATCH_RULE_LENGTH 1024
 117
 118 /* Max arg number you can match on in a match rule, e.g.
 119  * arg0='hello' is OK, arg3489720987='hello' is not
 120  */
 121 #define DBUS_MAXIMUM_MATCH_RULE_ARG_NUMBER 63
 122
 123 /* Max length of a marshaled array in bytes (64M, 2^26) We use signed
 124  * int for lengths so must be INT_MAX or less.  We need something a
 125  * bit smaller than INT_MAX because the array is inside a message with
 126  * header info, etc.  so an INT_MAX array wouldn't allow the message
 127  * overhead.  The 64M number is an attempt at a larger number than
 128  * we'd reasonably ever use, but small enough that your bus would chew
 129  * through it fairly quickly without locking up forever. If you have
 130  * data that's likely to be larger than this, you should probably be
 131  * sending it in multiple incremental messages anyhow.
 132  */
 133 #define DBUS_MAXIMUM_ARRAY_LENGTH (67108864)
 134 /* Number of bits you need in an unsigned to store the max array size */
 135 #define DBUS_MAXIMUM_ARRAY_LENGTH_BITS 26
 136
 137 /* The maximum total message size including header and body; similar
 138  * rationale to max array size.
 139  */
 140 #define DBUS_MAXIMUM_MESSAGE_LENGTH (DBUS_MAXIMUM_ARRAY_LENGTH * 2)
 141 /* Number of bits you need in an unsigned to store the max message size */
 142 #define DBUS_MAXIMUM_MESSAGE_LENGTH_BITS 27
 143
 144 /* Depth of recursion in the type tree. This is automatically limited
 145  * to DBUS_MAXIMUM_SIGNATURE_LENGTH since you could only have an array
 146  * of array of array of ... that fit in the max signature.  But that's
 147  * probably a bit too large.
 148  */
 149 #define DBUS_MAXIMUM_TYPE_RECURSION_DEPTH 32
 150
 151 /* Types of message */
 152 #define DBUS_MESSAGE_TYPE_INVALID       0
 153 #define DBUS_MESSAGE_TYPE_METHOD_CALL   1
 154 #define DBUS_MESSAGE_TYPE_METHOD_RETURN 2
 155 #define DBUS_MESSAGE_TYPE_ERROR         3
 156 #define DBUS_MESSAGE_TYPE_SIGNAL        4
 157
 158 /* Header flags */
 159 #define DBUS_HEADER_FLAG_NO_REPLY_EXPECTED 0x1
 160 #define DBUS_HEADER_FLAG_NO_AUTO_START     0x2
 161
 162 /* Header fields */
 163 #define DBUS_HEADER_FIELD_INVALID        0
 164 #define DBUS_HEADER_FIELD_PATH           1
 165 #define DBUS_HEADER_FIELD_INTERFACE      2
 166 #define DBUS_HEADER_FIELD_MEMBER         3
 167 #define DBUS_HEADER_FIELD_ERROR_NAME     4
 168 #define DBUS_HEADER_FIELD_REPLY_SERIAL   5
 169 #define DBUS_HEADER_FIELD_DESTINATION    6
 170 #define DBUS_HEADER_FIELD_SENDER         7
 171 #define DBUS_HEADER_FIELD_SIGNATURE      8
 172
 173 #define DBUS_HEADER_FIELD_LAST DBUS_HEADER_FIELD_SIGNATURE
 174
 175 /* Header format is defined as a signature:
 176  *   byte                            byte order
 177  *   byte                            message type ID
 178  *   byte                            flags
 179  *   byte                            protocol version
 180  *   uint32                          body length
 181  *   uint32                          serial
 182  *   array of struct (byte,variant)  (field name, value)
 183  *
 184  * The length of the header can be computed as the
 185  * fixed size of the initial data, plus the length of
 186  * the array at the end, plus padding to an 8-boundary.
 187  */
 188 #define DBUS_HEADER_SIGNATURE                   \
 189      DBUS_TYPE_BYTE_AS_STRING                   \
 190      DBUS_TYPE_BYTE_AS_STRING                   \
 191      DBUS_TYPE_BYTE_AS_STRING                   \
 192      DBUS_TYPE_BYTE_AS_STRING                   \
 193      DBUS_TYPE_UINT32_AS_STRING                 \
 194      DBUS_TYPE_UINT32_AS_STRING                 \
 195      DBUS_TYPE_ARRAY_AS_STRING                  \
 196      DBUS_STRUCT_BEGIN_CHAR_AS_STRING           \
 197      DBUS_TYPE_BYTE_AS_STRING                   \
 198      DBUS_TYPE_VARIANT_AS_STRING                \
 199      DBUS_STRUCT_END_CHAR_AS_STRING
 200
 201
 202 /**
 203  * The smallest header size that can occur.  (It won't be valid due to
 204  * missing required header fields.) This is 4 bytes, two uint32, an
 205  * array length. This isn't any kind of resource limit, just the
 206  * necessary/logical outcome of the header signature.
 207  */
 208 #define DBUS_MINIMUM_HEADER_SIZE 16
 209
 210 /* Errors */
 211 /* WARNING these get autoconverted to an enum in dbus-glib.h. Thus,
 212  * if you change the order it breaks the ABI. Keep them in order.
 213  * Also, don't change the formatting since that will break the sed
 214  * script.
 215  */
 216 #define DBUS_ERROR_FAILED                     "org.freedesktop.DBus.Error.Failed"
 217 #define DBUS_ERROR_NO_MEMORY                  "org.freedesktop.DBus.Error.NoMemory"
 218 #define DBUS_ERROR_SERVICE_UNKNOWN            "org.freedesktop.DBus.Error.ServiceUnknown"
 219 #define DBUS_ERROR_NAME_HAS_NO_OWNER          "org.freedesktop.DBus.Error.NameHasNoOwner"
 220 #define DBUS_ERROR_NO_REPLY                   "org.freedesktop.DBus.Error.NoReply"
 221 #define DBUS_ERROR_IO_ERROR                   "org.freedesktop.DBus.Error.IOError"
 222 #define DBUS_ERROR_BAD_ADDRESS                "org.freedesktop.DBus.Error.BadAddress"
 223 #define DBUS_ERROR_NOT_SUPPORTED              "org.freedesktop.DBus.Error.NotSupported"
 224 #define DBUS_ERROR_LIMITS_EXCEEDED            "org.freedesktop.DBus.Error.LimitsExceeded"
 225 #define DBUS_ERROR_ACCESS_DENIED              "org.freedesktop.DBus.Error.AccessDenied"
 226 #define DBUS_ERROR_AUTH_FAILED                "org.freedesktop.DBus.Error.AuthFailed"
 227 #define DBUS_ERROR_NO_SERVER                  "org.freedesktop.DBus.Error.NoServer"
 228 #define DBUS_ERROR_TIMEOUT                    "org.freedesktop.DBus.Error.Timeout"
 229 #define DBUS_ERROR_NO_NETWORK                 "org.freedesktop.DBus.Error.NoNetwork"
 230 #define DBUS_ERROR_ADDRESS_IN_USE             "org.freedesktop.DBus.Error.AddressInUse"
 231 #define DBUS_ERROR_DISCONNECTED               "org.freedesktop.DBus.Error.Disconnected"
 232 #define DBUS_ERROR_INVALID_ARGS               "org.freedesktop.DBus.Error.InvalidArgs"
 233 #define DBUS_ERROR_FILE_NOT_FOUND             "org.freedesktop.DBus.Error.FileNotFound"
 234 #define DBUS_ERROR_UNKNOWN_METHOD             "org.freedesktop.DBus.Error.UnknownMethod"
 235 #define DBUS_ERROR_TIMED_OUT                  "org.freedesktop.DBus.Error.TimedOut"
 236 #define DBUS_ERROR_MATCH_RULE_NOT_FOUND       "org.freedesktop.DBus.Error.MatchRuleNotFound"
 237 #define DBUS_ERROR_MATCH_RULE_INVALID         "org.freedesktop.DBus.Error.MatchRuleInvalid"
 238 #define DBUS_ERROR_SPAWN_EXEC_FAILED          "org.freedesktop.DBus.Error.Spawn.ExecFailed"
 239 #define DBUS_ERROR_SPAWN_FORK_FAILED          "org.freedesktop.DBus.Error.Spawn.ForkFailed"
 240 #define DBUS_ERROR_SPAWN_CHILD_EXITED         "org.freedesktop.DBus.Error.Spawn.ChildExited"
 241 #define DBUS_ERROR_SPAWN_CHILD_SIGNALED       "org.freedesktop.DBus.Error.Spawn.ChildSignaled"
 242 #define DBUS_ERROR_SPAWN_FAILED               "org.freedesktop.DBus.Error.Spawn.Failed"
 243 #define DBUS_ERROR_UNIX_PROCESS_ID_UNKNOWN    "org.freedesktop.DBus.Error.UnixProcessIdUnknown"
 244 #define DBUS_ERROR_INVALID_SIGNATURE          "org.freedesktop.DBus.Error.InvalidSignature"
 245 #define DBUS_ERROR_SELINUX_SECURITY_CONTEXT_UNKNOWN    "org.freedesktop.DBus.Error.SELinuxSecurityContextUnknown"
 246
 247 #define DBUS_INTROSPECT_1_0_XML_NAMESPACE         "http://www.freedesktop.org/standards/dbus"
 248 #define DBUS_INTROSPECT_1_0_XML_PUBLIC_IDENTIFIER "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN"
 249 #define DBUS_INTROSPECT_1_0_XML_SYSTEM_IDENTIFIER "http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd"
 250 #define DBUS_INTROSPECT_1_0_XML_DOCTYPE_DECL_NODE "<!DOCTYPE node PUBLIC \""DBUS_INTROSPECT_1_0_XML_PUBLIC_IDENTIFIER"\"\n\""DBUS_INTROSPECT_1_0_XML_SYSTEM_IDENTIFIER"\">\n"
 251
 252
 253 #ifdef __cplusplus
 254 }
 255 #endif
 256
 257 #endif /* DBUS_PROTOCOL_H */