src/systemd/sd-bus-vtable.h

   1 /* SPDX-License-Identifier: LGPL-2.1+ */
   2 #ifndef foosdbusvtablehfoo
   3 #define foosdbusvtablehfoo
   4
   5 /***
   6   systemd is free software; you can redistribute it and/or modify it
   7   under the terms of the GNU Lesser General Public License as published by
   8   the Free Software Foundation; either version 2.1 of the License, or
   9   (at your option) any later version.
  10
  11   systemd is distributed in the hope that it will be useful, but
  12   WITHOUT ANY WARRANTY; without even the implied warranty of
  13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  14   Lesser General Public License for more details.
  15
  16   You should have received a copy of the GNU Lesser General Public License
  17   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  18 ***/
  19
  20 #include "_sd-common.h"
  21
  22 _SD_BEGIN_DECLARATIONS;
  23
  24 typedef struct sd_bus_vtable sd_bus_vtable;
  25
  26 #include "sd-bus.h"
  27
  28 enum {
  29         _SD_BUS_VTABLE_START             = '<',
  30         _SD_BUS_VTABLE_END               = '>',
  31         _SD_BUS_VTABLE_METHOD            = 'M',
  32         _SD_BUS_VTABLE_SIGNAL            = 'S',
  33         _SD_BUS_VTABLE_PROPERTY          = 'P',
  34         _SD_BUS_VTABLE_WRITABLE_PROPERTY = 'W'
  35 };
  36
  37 enum {
  38         SD_BUS_VTABLE_DEPRECATED                   = 1ULL << 0,
  39         SD_BUS_VTABLE_HIDDEN                       = 1ULL << 1,
  40         SD_BUS_VTABLE_UNPRIVILEGED                 = 1ULL << 2,
  41         SD_BUS_VTABLE_METHOD_NO_REPLY              = 1ULL << 3,
  42         SD_BUS_VTABLE_PROPERTY_CONST               = 1ULL << 4,
  43         SD_BUS_VTABLE_PROPERTY_EMITS_CHANGE        = 1ULL << 5,
  44         SD_BUS_VTABLE_PROPERTY_EMITS_INVALIDATION  = 1ULL << 6,
  45         SD_BUS_VTABLE_PROPERTY_EXPLICIT            = 1ULL << 7,
  46         SD_BUS_VTABLE_SENSITIVE                    = 1ULL << 8, /* covers both directions: method call + reply */
  47         SD_BUS_VTABLE_ABSOLUTE_OFFSET              = 1ULL << 9,
  48         _SD_BUS_VTABLE_CAPABILITY_MASK             = 0xFFFFULL << 40
  49 };
  50
  51 #define SD_BUS_VTABLE_CAPABILITY(x) ((uint64_t) (((x)+1) & 0xFFFF) << 40)
  52
  53 enum {
  54         _SD_BUS_VTABLE_PARAM_NAMES     = 1 << 0,
  55 };
  56
  57 extern const unsigned sd_bus_object_vtable_format;
  58
  59 /* Note: unused areas in the sd_bus_vtable[] array must be initialized to 0. The structure contains an embedded
  60  * union, and the compiler is NOT required to initialize the unused areas of the union when the rest of the
  61  * structure is initialized. Normally the array is defined as read-only data, in which case the linker places
  62  * it in the BSS section, which is always fully initialized, so this is not a concern. But if the array is
  63  * created on the stack or on the heap, care must be taken to initialize the unused areas, for examply by
  64  * first memsetting the whole region to zero before filling the data in. */
  65
  66 struct sd_bus_vtable {
  67         /* Please do not initialize this structure directly, use the
  68          * macros below instead */
  69
  70         uint8_t type:8;
  71         uint64_t flags:56;
  72         union {
  73                 struct {
  74                         size_t element_size;
  75                         uint64_t features;
  76                         const unsigned *vtable_format_reference;
  77                 } start;
  78                 struct {
  79                         const char *member;
  80                         const char *signature;
  81                         const char *result;
  82                         sd_bus_message_handler_t handler;
  83                         size_t offset;
  84                         const char *names;
  85                 } method;
  86                 struct {
  87                         const char *member;
  88                         const char *signature;
  89                         const char *names;
  90                 } signal;
  91                 struct {
  92                         const char *member;
  93                         const char *signature;
  94                         sd_bus_property_get_t get;
  95                         sd_bus_property_set_t set;
  96                         size_t offset;
  97                 } property;
  98         } x;
  99 };
 100
 101 #define SD_BUS_VTABLE_START(_flags)                                     \
 102         {                                                               \
 103                 .type = _SD_BUS_VTABLE_START,                           \
 104                 .flags = _flags,                                        \
 105                 .x = {                                                  \
 106                     .start = {                                          \
 107                         .element_size = sizeof(sd_bus_vtable),          \
 108                         .features = _SD_BUS_VTABLE_PARAM_NAMES,         \
 109                         .vtable_format_reference = &sd_bus_object_vtable_format, \
 110                     },                                                  \
 111                 },                                                      \
 112         }
 113
 114 /* helper macro to format method and signal parameters, one at a time */
 115 #define SD_BUS_PARAM(x) #x "\0"
 116
 117 #define SD_BUS_METHOD_WITH_NAMES_OFFSET(_member, _signature, _in_names, _result, _out_names, _handler, _offset, _flags)  \
 118         {                                                               \
 119                 .type = _SD_BUS_VTABLE_METHOD,                          \
 120                 .flags = _flags,                                        \
 121                 .x = {                                                  \
 122                     .method = {                                         \
 123                         .member = _member,                              \
 124                         .signature = _signature,                        \
 125                         .result = _result,                              \
 126                         .handler = _handler,                            \
 127                         .offset = _offset,                              \
 128                         .names = _in_names _out_names,                  \
 129                     },                                                  \
 130                 },                                                      \
 131         }
 132 #define SD_BUS_METHOD_WITH_OFFSET(_member, _signature, _result, _handler, _offset, _flags)   \
 133         SD_BUS_METHOD_WITH_NAMES_OFFSET(_member, _signature, "", _result, "", _handler, _offset, _flags)
 134 #define SD_BUS_METHOD_WITH_NAMES(_member, _signature, _in_names, _result, _out_names, _handler, _flags)   \
 135         SD_BUS_METHOD_WITH_NAMES_OFFSET(_member, _signature, _in_names, _result, _out_names, _handler, 0, _flags)
 136 #define SD_BUS_METHOD(_member, _signature, _result, _handler, _flags)   \
 137         SD_BUS_METHOD_WITH_NAMES_OFFSET(_member, _signature, "", _result, "", _handler, 0, _flags)
 138
 139 #define SD_BUS_SIGNAL_WITH_NAMES(_member, _signature, _out_names, _flags)                      \
 140         {                                                               \
 141                 .type = _SD_BUS_VTABLE_SIGNAL,                          \
 142                 .flags = _flags,                                        \
 143                 .x = {                                                  \
 144                     .signal = {                                         \
 145                         .member = _member,                              \
 146                         .signature = _signature,                        \
 147                         .names = _out_names,                            \
 148                     },                                                  \
 149                 },                                                      \
 150         }
 151 #define SD_BUS_SIGNAL(_member, _signature, _flags)   \
 152         SD_BUS_SIGNAL_WITH_NAMES(_member, _signature, "", _flags)
 153
 154 #define SD_BUS_PROPERTY(_member, _signature, _get, _offset, _flags)     \
 155         {                                                               \
 156                 .type = _SD_BUS_VTABLE_PROPERTY,                        \
 157                 .flags = _flags,                                        \
 158                 .x = {                                                  \
 159                     .property = {                                       \
 160                         .member = _member,                              \
 161                         .signature = _signature,                        \
 162                         .get = _get,                                    \
 163                         .set = NULL,                                    \
 164                         .offset = _offset,                              \
 165                     },                                                  \
 166                 },                                                      \
 167         }
 168
 169 #define SD_BUS_WRITABLE_PROPERTY(_member, _signature, _get, _set, _offset, _flags) \
 170         {                                                               \
 171                 .type = _SD_BUS_VTABLE_WRITABLE_PROPERTY,               \
 172                 .flags = _flags,                                        \
 173                 .x = {                                                  \
 174                     .property = {                                       \
 175                         .member = _member,                              \
 176                         .signature = _signature,                        \
 177                         .get = _get,                                    \
 178                         .set = _set,                                    \
 179                         .offset = _offset,                              \
 180                     },                                                  \
 181                 },                                                      \
 182         }
 183
 184 #define SD_BUS_VTABLE_END                                               \
 185         {                                                               \
 186                 .type = _SD_BUS_VTABLE_END,                             \
 187                 .flags = 0,                                             \
 188                 .x = { { 0 } },                                         \
 189         }
 190
 191 #define _SD_ECHO(X) X
 192 #define _SD_CONCAT(X) #X "\0"
 193
 194 #define _SD_VARARGS_FOREACH_EVEN_01(FN, X, ...)
 195 #define _SD_VARARGS_FOREACH_EVEN_02(FN, X, ...) FN(X) _SD_VARARGS_FOREACH_EVEN_01(FN, __VA_ARGS__)
 196 #define _SD_VARARGS_FOREACH_EVEN_03(FN, X, ...)       _SD_VARARGS_FOREACH_EVEN_02(FN, __VA_ARGS__)
 197 #define _SD_VARARGS_FOREACH_EVEN_04(FN, X, ...) FN(X) _SD_VARARGS_FOREACH_EVEN_03(FN, __VA_ARGS__)
 198 #define _SD_VARARGS_FOREACH_EVEN_05(FN, X, ...)       _SD_VARARGS_FOREACH_EVEN_04(FN, __VA_ARGS__)
 199 #define _SD_VARARGS_FOREACH_EVEN_06(FN, X, ...) FN(X) _SD_VARARGS_FOREACH_EVEN_05(FN, __VA_ARGS__)
 200 #define _SD_VARARGS_FOREACH_EVEN_07(FN, X, ...)       _SD_VARARGS_FOREACH_EVEN_06(FN, __VA_ARGS__)
 201 #define _SD_VARARGS_FOREACH_EVEN_08(FN, X, ...) FN(X) _SD_VARARGS_FOREACH_EVEN_07(FN, __VA_ARGS__)
 202 #define _SD_VARARGS_FOREACH_EVEN_09(FN, X, ...)       _SD_VARARGS_FOREACH_EVEN_08(FN, __VA_ARGS__)
 203 #define _SD_VARARGS_FOREACH_EVEN_10(FN, X, ...) FN(X) _SD_VARARGS_FOREACH_EVEN_09(FN, __VA_ARGS__)
 204 #define _SD_VARARGS_FOREACH_EVEN_11(FN, X, ...)       _SD_VARARGS_FOREACH_EVEN_10(FN, __VA_ARGS__)
 205 #define _SD_VARARGS_FOREACH_EVEN_12(FN, X, ...) FN(X) _SD_VARARGS_FOREACH_EVEN_11(FN, __VA_ARGS__)
 206 #define _SD_VARARGS_FOREACH_EVEN_13(FN, X, ...)       _SD_VARARGS_FOREACH_EVEN_12(FN, __VA_ARGS__)
 207 #define _SD_VARARGS_FOREACH_EVEN_14(FN, X, ...) FN(X) _SD_VARARGS_FOREACH_EVEN_13(FN, __VA_ARGS__)
 208 #define _SD_VARARGS_FOREACH_EVEN_15(FN, X, ...)       _SD_VARARGS_FOREACH_EVEN_14(FN, __VA_ARGS__)
 209 #define _SD_VARARGS_FOREACH_EVEN_16(FN, X, ...) FN(X) _SD_VARARGS_FOREACH_EVEN_15(FN, __VA_ARGS__)
 210 #define _SD_VARARGS_FOREACH_EVEN_17(FN, X, ...)       _SD_VARARGS_FOREACH_EVEN_16(FN, __VA_ARGS__)
 211 #define _SD_VARARGS_FOREACH_EVEN_18(FN, X, ...) FN(X) _SD_VARARGS_FOREACH_EVEN_17(FN, __VA_ARGS__)
 212 #define _SD_VARARGS_FOREACH_EVEN_19(FN, X, ...)       _SD_VARARGS_FOREACH_EVEN_18(FN, __VA_ARGS__)
 213 #define _SD_VARARGS_FOREACH_EVEN_20(FN, X, ...) FN(X) _SD_VARARGS_FOREACH_EVEN_19(FN, __VA_ARGS__)
 214 #define _SD_VARARGS_FOREACH_EVEN_21(FN, X, ...)       _SD_VARARGS_FOREACH_EVEN_20(FN, __VA_ARGS__)
 215 #define _SD_VARARGS_FOREACH_EVEN_22(FN, X, ...) FN(X) _SD_VARARGS_FOREACH_EVEN_21(FN, __VA_ARGS__)
 216 #define _SD_VARARGS_FOREACH_EVEN_23(FN, X, ...)       _SD_VARARGS_FOREACH_EVEN_22(FN, __VA_ARGS__)
 217 #define _SD_VARARGS_FOREACH_EVEN_24(FN, X, ...) FN(X) _SD_VARARGS_FOREACH_EVEN_23(FN, __VA_ARGS__)
 218 #define _SD_VARARGS_FOREACH_EVEN_25(FN, X, ...)       _SD_VARARGS_FOREACH_EVEN_24(FN, __VA_ARGS__)
 219 #define _SD_VARARGS_FOREACH_EVEN_26(FN, X, ...) FN(X) _SD_VARARGS_FOREACH_EVEN_25(FN, __VA_ARGS__)
 220 #define _SD_VARARGS_FOREACH_EVEN_27(FN, X, ...)       _SD_VARARGS_FOREACH_EVEN_26(FN, __VA_ARGS__)
 221 #define _SD_VARARGS_FOREACH_EVEN_28(FN, X, ...) FN(X) _SD_VARARGS_FOREACH_EVEN_27(FN, __VA_ARGS__)
 222 #define _SD_VARARGS_FOREACH_EVEN_29(FN, X, ...)       _SD_VARARGS_FOREACH_EVEN_28(FN, __VA_ARGS__)
 223 #define _SD_VARARGS_FOREACH_EVEN_30(FN, X, ...) FN(X) _SD_VARARGS_FOREACH_EVEN_29(FN, __VA_ARGS__)
 224 #define _SD_VARARGS_FOREACH_EVEN_31(FN, X, ...)       _SD_VARARGS_FOREACH_EVEN_30(FN, __VA_ARGS__)
 225 #define _SD_VARARGS_FOREACH_EVEN_32(FN, X, ...) FN(X) _SD_VARARGS_FOREACH_EVEN_31(FN, __VA_ARGS__)
 226 #define _SD_VARARGS_FOREACH_EVEN_33(FN, X, ...)       _SD_VARARGS_FOREACH_EVEN_32(FN, __VA_ARGS__)
 227 #define _SD_VARARGS_FOREACH_EVEN_34(FN, X, ...) FN(X) _SD_VARARGS_FOREACH_EVEN_33(FN, __VA_ARGS__)
 228 #define _SD_VARARGS_FOREACH_EVEN_35(FN, X, ...)       _SD_VARARGS_FOREACH_EVEN_34(FN, __VA_ARGS__)
 229 #define _SD_VARARGS_FOREACH_EVEN_36(FN, X, ...) FN(X) _SD_VARARGS_FOREACH_EVEN_35(FN, __VA_ARGS__)
 230 #define _SD_VARARGS_FOREACH_EVEN_37(FN, X, ...)       _SD_VARARGS_FOREACH_EVEN_36(FN, __VA_ARGS__)
 231 #define _SD_VARARGS_FOREACH_EVEN_38(FN, X, ...) FN(X) _SD_VARARGS_FOREACH_EVEN_37(FN, __VA_ARGS__)
 232 #define _SD_VARARGS_FOREACH_EVEN_39(FN, X, ...)       _SD_VARARGS_FOREACH_EVEN_38(FN, __VA_ARGS__)
 233 #define _SD_VARARGS_FOREACH_EVEN_40(FN, X, ...) FN(X) _SD_VARARGS_FOREACH_EVEN_39(FN, __VA_ARGS__)
 234 #define _SD_VARARGS_FOREACH_EVEN_41(FN, X, ...)       _SD_VARARGS_FOREACH_EVEN_40(FN, __VA_ARGS__)
 235 #define _SD_VARARGS_FOREACH_EVEN_42(FN, X, ...) FN(X) _SD_VARARGS_FOREACH_EVEN_41(FN, __VA_ARGS__)
 236 #define _SD_VARARGS_FOREACH_EVEN_43(FN, X, ...)       _SD_VARARGS_FOREACH_EVEN_42(FN, __VA_ARGS__)
 237 #define _SD_VARARGS_FOREACH_EVEN_44(FN, X, ...) FN(X) _SD_VARARGS_FOREACH_EVEN_43(FN, __VA_ARGS__)
 238 #define _SD_VARARGS_FOREACH_EVEN_45(FN, X, ...)       _SD_VARARGS_FOREACH_EVEN_44(FN, __VA_ARGS__)
 239 #define _SD_VARARGS_FOREACH_EVEN_46(FN, X, ...) FN(X) _SD_VARARGS_FOREACH_EVEN_45(FN, __VA_ARGS__)
 240 #define _SD_VARARGS_FOREACH_EVEN_47(FN, X, ...)       _SD_VARARGS_FOREACH_EVEN_46(FN, __VA_ARGS__)
 241 #define _SD_VARARGS_FOREACH_EVEN_48(FN, X, ...) FN(X) _SD_VARARGS_FOREACH_EVEN_47(FN, __VA_ARGS__)
 242 #define _SD_VARARGS_FOREACH_EVEN_49(FN, X, ...)       _SD_VARARGS_FOREACH_EVEN_48(FN, __VA_ARGS__)
 243 #define _SD_VARARGS_FOREACH_EVEN_50(FN, X, ...) FN(X) _SD_VARARGS_FOREACH_EVEN_49(FN, __VA_ARGS__)
 244
 245 #define _SD_VARARGS_FOREACH_EVEN_SEQ(_01, _02, _03, _04, _05, _06, _07, _08, _09, _10, \
 246                                      _11, _12, _13, _14, _15, _16, _17, _18, _19, _20, \
 247                                      _21, _22, _23, _24, _25, _26, _27, _28, _29, _30, \
 248                                      _31, _32, _33, _34, _35, _36, _37, _38, _39, _40, \
 249                                      _41, _42, _43, _44, _45, _46, _47, _48, _49, _50, \
 250                                      NAME, ...) NAME
 251
 252 #define _SD_VARARGS_FOREACH_EVEN(FN, ...)                                                      \
 253         _SD_VARARGS_FOREACH_EVEN_SEQ(__VA_ARGS__,                                              \
 254                                      _SD_VARARGS_FOREACH_EVEN_50, _SD_VARARGS_FOREACH_EVEN_49, \
 255                                      _SD_VARARGS_FOREACH_EVEN_48, _SD_VARARGS_FOREACH_EVEN_47, \
 256                                      _SD_VARARGS_FOREACH_EVEN_46, _SD_VARARGS_FOREACH_EVEN_45, \
 257                                      _SD_VARARGS_FOREACH_EVEN_44, _SD_VARARGS_FOREACH_EVEN_43, \
 258                                      _SD_VARARGS_FOREACH_EVEN_42, _SD_VARARGS_FOREACH_EVEN_41, \
 259                                      _SD_VARARGS_FOREACH_EVEN_40, _SD_VARARGS_FOREACH_EVEN_39, \
 260                                      _SD_VARARGS_FOREACH_EVEN_38, _SD_VARARGS_FOREACH_EVEN_37, \
 261                                      _SD_VARARGS_FOREACH_EVEN_36, _SD_VARARGS_FOREACH_EVEN_35, \
 262                                      _SD_VARARGS_FOREACH_EVEN_34, _SD_VARARGS_FOREACH_EVEN_33, \
 263                                      _SD_VARARGS_FOREACH_EVEN_32, _SD_VARARGS_FOREACH_EVEN_31, \
 264                                      _SD_VARARGS_FOREACH_EVEN_30, _SD_VARARGS_FOREACH_EVEN_29, \
 265                                      _SD_VARARGS_FOREACH_EVEN_28, _SD_VARARGS_FOREACH_EVEN_27, \
 266                                      _SD_VARARGS_FOREACH_EVEN_26, _SD_VARARGS_FOREACH_EVEN_25, \
 267                                      _SD_VARARGS_FOREACH_EVEN_24, _SD_VARARGS_FOREACH_EVEN_23, \
 268                                      _SD_VARARGS_FOREACH_EVEN_22, _SD_VARARGS_FOREACH_EVEN_21, \
 269                                      _SD_VARARGS_FOREACH_EVEN_20, _SD_VARARGS_FOREACH_EVEN_19, \
 270                                      _SD_VARARGS_FOREACH_EVEN_18, _SD_VARARGS_FOREACH_EVEN_17, \
 271                                      _SD_VARARGS_FOREACH_EVEN_16, _SD_VARARGS_FOREACH_EVEN_15, \
 272                                      _SD_VARARGS_FOREACH_EVEN_14, _SD_VARARGS_FOREACH_EVEN_13, \
 273                                      _SD_VARARGS_FOREACH_EVEN_12, _SD_VARARGS_FOREACH_EVEN_11, \
 274                                      _SD_VARARGS_FOREACH_EVEN_10, _SD_VARARGS_FOREACH_EVEN_09, \
 275                                      _SD_VARARGS_FOREACH_EVEN_08, _SD_VARARGS_FOREACH_EVEN_07, \
 276                                      _SD_VARARGS_FOREACH_EVEN_06, _SD_VARARGS_FOREACH_EVEN_05, \
 277                                      _SD_VARARGS_FOREACH_EVEN_04, _SD_VARARGS_FOREACH_EVEN_03, \
 278                                      _SD_VARARGS_FOREACH_EVEN_02, _SD_VARARGS_FOREACH_EVEN_01) \
 279                                      (FN, __VA_ARGS__)
 280
 281 #define SD_BUS_ARGS(...) __VA_ARGS__
 282 #define SD_BUS_RESULT(...) __VA_ARGS__
 283
 284 #define SD_BUS_NO_ARGS SD_BUS_ARGS(NULL,)
 285 #define SD_BUS_NO_RESULT SD_BUS_RESULT(NULL,)
 286
 287 #define SD_BUS_METHOD_WITH_ARGS(_member, _args, _result, _handler, _flags)                 \
 288         SD_BUS_METHOD_WITH_NAMES(_member,                                                  \
 289                                 _SD_VARARGS_FOREACH_EVEN(_SD_ECHO, _args),                 \
 290                                 _SD_VARARGS_FOREACH_EVEN(_SD_CONCAT, _args, ""),           \
 291                                 _SD_VARARGS_FOREACH_EVEN(_SD_ECHO, _result),               \
 292                                 _SD_VARARGS_FOREACH_EVEN(_SD_CONCAT, _result, ""),         \
 293                                 _handler, _flags)
 294
 295 #define SD_BUS_METHOD_WITH_ARGS_OFFSET(_member, _args, _result, _handler, _offset, _flags) \
 296         SD_BUS_METHOD_WITH_NAMES_OFFSET(_member,                                           \
 297                                         _SD_VARARGS_FOREACH_EVEN(_SD_ECHO, _args),         \
 298                                         _SD_VARARGS_FOREACH_EVEN(_SD_CONCAT, _args, ""),   \
 299                                         _SD_VARARGS_FOREACH_EVEN(_SD_ECHO, _result),       \
 300                                         _SD_VARARGS_FOREACH_EVEN(_SD_CONCAT, _result, ""), \
 301                                         _handler, _offset, _flags)
 302
 303 #define SD_BUS_SIGNAL_WITH_ARGS(_member, _args, _flags)                                    \
 304         SD_BUS_SIGNAL_WITH_NAMES(_member,                                                  \
 305                                  _SD_VARARGS_FOREACH_EVEN(_SD_ECHO, _args),                \
 306                                  _SD_VARARGS_FOREACH_EVEN(_SD_CONCAT, _args, ""),          \
 307                                  _flags)
 308
 309 _SD_END_DECLARATIONS;
 310
 311 #endif