src/libsystemd-bus/kdbus.h

   1 /*
   2  * Copyright (C) 2013 Kay Sievers
   3  * Copyright (C) 2013 Greg Kroah-Hartman <gregkh@linuxfoundation.org>
   4  * Copyright (C) 2013 Linux Foundation
   5  * Copyright (C) 2013 Lennart Poettering
   6  * Copyright (C) 2013 Daniel Mack <daniel@zonque.org>
   7  *
   8  * kdbus is free software; you can redistribute it and/or modify it under
   9  * the terms of the GNU Lesser General Public License as published by the
  10  * Free Software Foundation; either version 2.1 of the License, or (at
  11  * your option) any later version.
  12  */
  13
  14 #ifndef _KDBUS_H_
  15 #define _KDBUS_H_
  16
  17 #ifndef __KERNEL__
  18 #include <sys/ioctl.h>
  19 #include <sys/types.h>
  20 #include <linux/types.h>
  21 #endif
  22
  23 #define KDBUS_IOC_MAGIC                 0x95
  24 #define KDBUS_SRC_ID_KERNEL             (0)
  25 #define KDBUS_DST_ID_NAME               (0)
  26 #define KDBUS_MATCH_SRC_ID_ANY          (~0ULL)
  27 #define KDBUS_DST_ID_BROADCAST          (~0ULL)
  28
  29 /**
  30  * struct kdbus_notify_name_change - name registry change message
  31  * @old_id:             Former owner of a name
  32  * @new_id:             New owner of a name
  33  * @flags:              flags from KDBUS_NAME_*
  34  * @name:               Well-known name
  35  *
  36  * Sent from kernel to userspace when the owner or starter of
  37  * a well-known name changes.
  38  *
  39  * Attached to:
  40  *   KDBUS_ITEM_NAME_ADD
  41  *   KDBUS_ITEM_NAME_REMOVE
  42  *   KDBUS_ITEM_NAME_CHANGE
  43  */
  44 struct kdbus_notify_name_change {
  45         __u64 old_id;
  46         __u64 new_id;
  47         __u64 flags;
  48         char name[0];
  49 };
  50
  51 /**
  52  * struct kdbus_notify_id_change - name registry change message
  53  * @id:                 New or former owner of the name
  54  * @flags:              flags field from KDBUS_HELLO_*
  55  *
  56  * Sent from kernel to userspace when the owner or starter of
  57  * a well-known name changes.
  58  *
  59  * Attached to:
  60  *   KDBUS_ITEM_ID_ADD
  61  *   KDBUS_ITEM_ID_REMOVE
  62  */
  63 struct kdbus_notify_id_change {
  64         __u64 id;
  65         __u64 flags;
  66 };
  67
  68 /**
  69  * struct kdbus_creds - process credentials
  70  * @uid:                User ID
  71  * @gid:                Group ID
  72  * @pid:                Process ID
  73  * @tid:                Thread ID
  74  * @starttime:          Starttime of the process
  75  *
  76  * The starttime of the process PID. This is useful to detect PID overruns
  77  * from the client side. i.e. if you use the PID to look something up in
  78  * /proc/$PID/ you can afterwards check the starttime field of it, to ensure
  79  * you didn't run into a PID overrun.
  80  *
  81  * Attached to:
  82  *   KDBUS_ITEM_CREDS
  83  */
  84 struct kdbus_creds {
  85         __u64 uid;
  86         __u64 gid;
  87         __u64 pid;
  88         __u64 tid;
  89         __u64 starttime;
  90 };
  91
  92 /**
  93  * struct kdbus_audit - audit information
  94  * @sessionid:          The audit session ID
  95  * @loginuid:           The audit login uid
  96  *
  97  * Attached to:
  98  *   KDBUS_ITEM_AUDIT
  99  */
 100 struct kdbus_audit {
 101         __u64 sessionid;
 102         __u64 loginuid;
 103 };
 104
 105 /**
 106  * struct kdbus_timestamp
 107  * @monotonic_ns:       Monotonic timestamp, in nanoseconds
 108  * @realtime_ns:        Realtime timestamp, in nanoseconds
 109  *
 110  * Attached to:
 111  *   KDBUS_ITEM_TIMESTAMP
 112  */
 113 struct kdbus_timestamp {
 114         __u64 monotonic_ns;
 115         __u64 realtime_ns;
 116 };
 117
 118 /**
 119  * struct kdbus_vec - I/O vector for kdbus payload items
 120  * @size:               The size of the vector
 121  * @address:            Memory address for memory addresses
 122  * @offset:             Offset in the in-message payload memory
 123  *
 124  * Attached to:
 125  *   KDBUS_ITEM_PAYLOAD_VEC
 126  */
 127 struct kdbus_vec {
 128         __u64 size;
 129         union {
 130                 __u64 address;
 131                 __u64 offset;
 132         };
 133 };
 134
 135 /**
 136  * struct kdbus_memfd - a kdbus memfd
 137  * @size:               The memfd's size
 138  * @fd:                 The file descriptor number
 139  * @__pad:              Padding to make the struct aligned
 140  *
 141  * Attached to:
 142  *   KDBUS_ITEM_PAYLOAD_MEMFD
 143  */
 144 struct kdbus_memfd {
 145         __u64 size;
 146         int fd;
 147         __u32 __pad;
 148 };
 149
 150 /**
 151  * struct kdbus_name - a registered well-known name with its flags
 152  * @flags:              flags from KDBUS_NAME_*
 153  * @name:               well-known name
 154  *
 155  * Attached to:
 156  *   KDBUS_ITEM_NAME
 157  */
 158 struct kdbus_name {
 159         __u64 flags;
 160         char name[0];
 161 };
 162
 163 /**
 164  * struct kdbus_policy_access - policy access item
 165  * @type:               One of KDBUS_POLICY_ACCESS_* types
 166  * @bits:               Access to grant. One of KDBUS_POLICY_*
 167  * @id:                 For KDBUS_POLICY_ACCESS_USER, the uid
 168  *                      For KDBUS_POLICY_ACCESS_GROUP, the gid
 169  *
 170  * Embedded in:
 171  *   struct kdbus_policy
 172  */
 173 struct kdbus_policy_access {
 174         __u64 type;     /* USER, GROUP, WORLD */
 175         __u64 bits;     /* RECV, SEND, OWN */
 176         __u64 id;       /* uid, gid, 0 */
 177 };
 178
 179 /**
 180  * struct kdbus_policy - a policy item
 181  * @access:             Policy access details
 182  * @name:               Well-known name to grant access to
 183  *
 184  * Attached to:
 185  *   KDBUS_POLICY_ACCESS
 186  *   KDBUS_ITEM_POLICY_NAME
 187  */
 188 struct kdbus_policy {
 189         union {
 190                 struct kdbus_policy_access access;
 191                 char name[0];
 192         };
 193 };
 194
 195 /**
 196  * enum kdbus_item_type - item types to chain data in a list
 197  * @KDBUS_ITEM_PAYLOAD_VEC:     Vevtor to data
 198  * @KDBUS_ITEM_PAYLOAD_OFF:     Data at returned offset in the pool
 199  * @KDBUS_ITEM_PAYLOAD_MEMFD:   Data as sealed memfd
 200  * @KDBUS_ITEM_FDS:             Attached file descriptors
 201  * @KDBUS_ITEM_BLOOM:           For broadcasts, carries bloom filter
 202  * @KDBUS_ITEM_DST_NAME:        Destination's well-known name
 203  * @KDBUS_ITEM_PRIORITY:        Queue priority for message
 204  * @KDBUS_ITEM_MAKE_NAME:       Name of namespace, bus, endpoint
 205  * @KDBUS_ITEM_POLICY_NAME:     Policy in struct kdbus_policy
 206  * @KDBUS_ITEM_POLICY_ACCESS:   Policy in struct kdbus_policy
 207  * @KDBUS_ITEM_NAME:            Well-know name with flags
 208  * @KDBUS_ITEM_STARTER_NAME:    Well-known name for the starter
 209  * @KDBUS_ITEM_TIMESTAMP:       Timestamp
 210  * @KDBUS_ITEM_CREDS:           Process credential
 211  * @KDBUS_ITEM_PID_COMM:        Process ID "comm" identifier
 212  * @KDBUS_ITEM_TID_COMM:        Thread ID "comm" identifier
 213  * @KDBUS_ITEM_EXE:             The path of the executable
 214  * @KDBUS_ITEM_CMDLINE:         The process command line
 215  * @KDBUS_ITEM_CGROUP:          The croup membership
 216  * @KDBUS_ITEM_CAPS:            The process capabilities
 217  * @KDBUS_ITEM_SECLABEL:        The security label
 218  * @KDBUS_ITEM_AUDIT:           The audit IDs
 219  * @KDBUS_ITEM_NAME_ADD:        Notify in struct kdbus_notify_name_change
 220  * @KDBUS_ITEM_NAME_REMOVE:     Notify in struct kdbus_notify_name_change
 221  * @KDBUS_ITEM_NAME_CHANGE:     Notify in struct kdbus_notify_name_change
 222  * @KDBUS_ITEM_ID_ADD:          Notify in struct kdbus_notify_id_change
 223  * @KDBUS_ITEM_ID_REMOVE:       Notify in struct kdbus_notify_id_change
 224  * @KDBUS_ITEM_REPLY_TIMEOUT:   Timeout has been reached
 225  * @KDBUS_ITEM_REPLY_DEAD:      Destiantion died
 226  */
 227 enum kdbus_item_type {
 228         _KDBUS_ITEM_NULL,
 229         _KDBUS_ITEM_USER_BASE,
 230         KDBUS_ITEM_PAYLOAD_VEC  = _KDBUS_ITEM_USER_BASE,
 231         KDBUS_ITEM_PAYLOAD_OFF,
 232         KDBUS_ITEM_PAYLOAD_MEMFD,
 233         KDBUS_ITEM_FDS,
 234         KDBUS_ITEM_BLOOM,
 235         KDBUS_ITEM_DST_NAME,
 236         KDBUS_ITEM_PRIORITY,
 237         KDBUS_ITEM_MAKE_NAME,
 238
 239         _KDBUS_ITEM_POLICY_BASE = 0x400,
 240         KDBUS_ITEM_POLICY_NAME = _KDBUS_ITEM_POLICY_BASE,
 241         KDBUS_ITEM_POLICY_ACCESS,
 242
 243         _KDBUS_ITEM_ATTACH_BASE = 0x600,
 244         KDBUS_ITEM_NAME         = _KDBUS_ITEM_ATTACH_BASE,
 245         KDBUS_ITEM_STARTER_NAME,
 246         KDBUS_ITEM_TIMESTAMP,
 247         KDBUS_ITEM_CREDS,
 248         KDBUS_ITEM_PID_COMM,
 249         KDBUS_ITEM_TID_COMM,
 250         KDBUS_ITEM_EXE,
 251         KDBUS_ITEM_CMDLINE,
 252         KDBUS_ITEM_CGROUP,
 253         KDBUS_ITEM_CAPS,
 254         KDBUS_ITEM_SECLABEL,
 255         KDBUS_ITEM_AUDIT,
 256
 257         _KDBUS_ITEM_KERNEL_BASE = 0x800,
 258         KDBUS_ITEM_NAME_ADD     = _KDBUS_ITEM_KERNEL_BASE,
 259         KDBUS_ITEM_NAME_REMOVE,
 260         KDBUS_ITEM_NAME_CHANGE,
 261         KDBUS_ITEM_ID_ADD,
 262         KDBUS_ITEM_ID_REMOVE,
 263         KDBUS_ITEM_REPLY_TIMEOUT,
 264         KDBUS_ITEM_REPLY_DEAD,
 265 };
 266
 267 /**
 268  * struct kdbus_item - chain of data blocks
 269  * @size:               Overall data record size
 270  * @type:               Kdbus_item type of data
 271  * @data:               Generic bytes
 272  * @data32:             Generic 32 bit array
 273  * @data64:             Generic 64 bit array
 274  * @str:                Generic string
 275  * @id:                 Connection ID
 276  * @vec:                KDBUS_ITEM_PAYLOAD_VEC
 277  * @creds:              KDBUS_ITEM_CREDS
 278  * @audit:              KDBUS_ITEM_AUDIT
 279  * @timestamp:          KDBUS_ITEM_TIMESTAMP
 280  * @name:               KDBUS_ITEM_NAME
 281  * @memfd:              KDBUS_ITEM_PAYLOAD_MEMFD
 282  * @name_change:        KDBUS_ITEM_NAME_ADD
 283  *                      KDBUS_ITEM_NAME_REMOVE
 284  *                      KDBUS_ITEM_NAME_CHANGE
 285  * @id_change:          KDBUS_ITEM_ID_ADD
 286  *                      KDBUS_ITEM_ID_REMOVE
 287  * @policy:             KDBUS_ITEM_POLICY_NAME
 288  *                      KDBUS_ITEM_POLICY_ACCESS
 289  */
 290 struct kdbus_item {
 291         __u64 size;
 292         __u64 type;
 293         union {
 294                 __u8 data[0];
 295                 __u32 data32[0];
 296                 __u64 data64[0];
 297                 char str[0];
 298
 299                 __u64 id;
 300                 struct kdbus_vec vec;
 301                 struct kdbus_creds creds;
 302                 struct kdbus_audit audit;
 303                 struct kdbus_timestamp timestamp;
 304                 struct kdbus_name name;
 305                 struct kdbus_memfd memfd;
 306                 int fds[0];
 307                 struct kdbus_notify_name_change name_change;
 308                 struct kdbus_notify_id_change id_change;
 309                 struct kdbus_policy policy;
 310         };
 311 };
 312
 313 /**
 314  * enum kdbus_msg_flags - type of message
 315  * @KDBUS_MSG_FLAGS_EXPECT_REPLY:       Expect a reply message, used for method
 316  *                                      calls. The cookie identifies the
 317  *                                      message and the respective reply
 318  * @KDBUS_MSG_FLAGS_NO_AUTO_START:      Do not start a service, if the addressed
 319  *                                      name is not currently active
 320  */
 321 enum kdbus_msg_flags {
 322         KDBUS_MSG_FLAGS_EXPECT_REPLY    = 1 << 0,
 323         KDBUS_MSG_FLAGS_NO_AUTO_START   = 1 << 1,
 324 };
 325
 326 /**
 327  * enum kdbus_payload_type - type of payload carried by message
 328  * @KDBUS_PAYLOAD_KERNEL:       Kernel-generated simple message
 329  * @KDBUS_PAYLOAD_DBUS1:        Legacy D-Bus version 1 marshalling
 330  * @KDBUS_PAYLOAD_GVARIANT:     GVariant marshalling
 331  */
 332 enum kdbus_payload_type {
 333         KDBUS_PAYLOAD_KERNEL,
 334         KDBUS_PAYLOAD_DBUS      = 0x4442757356657231ULL, /* 'DBusVer1' */
 335 };
 336
 337 /**
 338  * struct kdbus_msg - the representation of a kdbus message
 339  * @size:               Total size of the message
 340  * @flags:              Message flags (KDBUS_MSG_FLAGS_*)
 341  * @dst_id:             64-bit ID of the destination connection
 342  * @src_id:             64-bit ID of the source connection
 343  * @payload_type:       Payload type (KDBUS_PAYLOAD_*)
 344  * @cookie:             Userspace-supplied cookie
 345  * @cookie_reply:       For kernel-generated messages, this is the cookie
 346  *                      the message is a reply to
 347  * @timeout_ns:         For non-kernel-generated messages, this denotes the
 348  *                      message timeout in nanoseconds
 349  * @items:              A list of kdbus_items containing the message payload
 350  */
 351 struct kdbus_msg {
 352         __u64 size;
 353         __u64 flags;
 354         __u64 dst_id;
 355         __u64 src_id;
 356         __u64 payload_type;
 357         __u64 cookie;
 358         union {
 359                 __u64 cookie_reply;
 360                 __u64 timeout_ns;
 361         };
 362         struct kdbus_item items[0];
 363 };
 364
 365 /**
 366  * enum kdbus_policy_access_type - permissions of a policy record
 367  * @KDBUS_POLICY_ACCESS_USER:   Grant access to a uid
 368  * @KDBUS_POLICY_ACCESS_GROUP:  Grant acces to gid
 369  * @KDBUS_POLICY_ACCESS_WORLD:  World-accessible
 370  */
 371 enum kdbus_policy_access_type {
 372         _KDBUS_POLICY_ACCESS_NULL,
 373         KDBUS_POLICY_ACCESS_USER,
 374         KDBUS_POLICY_ACCESS_GROUP,
 375         KDBUS_POLICY_ACCESS_WORLD,
 376 };
 377
 378 /**
 379  * enum kdbus_policy_access_flags - mode flags
 380  * @KDBUS_POLICY_RECV:          Allow receive
 381  * @KDBUS_POLICY_SEND:          Allow send
 382  * @KDBUS_POLICY_OWN:           Allow to own a well-known name
 383  */
 384 enum kdbus_policy_type {
 385         KDBUS_POLICY_RECV               = 1 <<  2,
 386         KDBUS_POLICY_SEND               = 1 <<  1,
 387         KDBUS_POLICY_OWN                = 1 <<  0,
 388 };
 389
 390 /**
 391  * struct kdbus_cmd_policy - a series of policies to upload
 392  * @size:               The total size of the structure
 393  * @policies:           The policies to upload
 394  *
 395  * A KDBUS_POLICY_NAME must always preceed a KDBUS_POLICY_ACCESS entry.
 396  * A new KDBUS_POLICY_NAME can be added after KDBUS_POLICY_ACCESS for
 397  * chaining multiple policies together.
 398  */
 399 struct kdbus_cmd_policy {
 400         __u64 size;
 401         struct kdbus_item policies[0];
 402 };
 403
 404 /**
 405  * enum kdbus_hello_flags - flags for struct kdbus_cmd_hello
 406  * @KDBUS_HELLO_STARTER:                The connection registers a name for activation
 407  *                              by well-know name
 408  * @KDBUS_HELLO_ACCEPT_FD:      The connection allows the receiving of
 409  *                              any passed file descriptors
 410  */
 411 enum kdbus_hello_flags {
 412         KDBUS_HELLO_STARTER             =  1 <<  0,
 413         KDBUS_HELLO_ACCEPT_FD           =  1 <<  1,
 414 };
 415
 416 /**
 417  * enum kdbus_attach_flags - flags for metadata attachments
 418  * @KDBUS_ATTACH_TIMESTAMP:     Timestamp
 419  * @KDBUS_ATTACH_CREDS:         Credentials
 420  * @KDBUS_ATTACH_NAMES:         Well-known names
 421  * @KDBUS_ATTACH_COMM:          The "comm" process identifier
 422  * @KDBUS_ATTACH_EXE:           The path of the executable
 423  * @KDBUS_ATTACH_CMDLINE:       The process command line
 424  * @KDBUS_ATTACH_CGROUP:        The croup membership
 425  * @KDBUS_ATTACH_CAPS:          The process capabilities
 426  * @KDBUS_ATTACH_SECLABEL:      The security label
 427  * @KDBUS_ATTACH_AUDIT:         The audit IDs
 428  */
 429 enum kdbus_attach_flags {
 430         KDBUS_ATTACH_TIMESTAMP          =  1 <<  0,
 431         KDBUS_ATTACH_CREDS              =  1 <<  1,
 432         KDBUS_ATTACH_NAMES              =  1 <<  2,
 433         KDBUS_ATTACH_COMM               =  1 <<  3,
 434         KDBUS_ATTACH_EXE                =  1 <<  4,
 435         KDBUS_ATTACH_CMDLINE            =  1 <<  5,
 436         KDBUS_ATTACH_CGROUP             =  1 <<  6,
 437         KDBUS_ATTACH_CAPS               =  1 <<  7,
 438         KDBUS_ATTACH_SECLABEL           =  1 <<  8,
 439         KDBUS_ATTACH_AUDIT              =  1 <<  9,
 440 };
 441
 442 /**
 443  * struct kdbus_cmd_hello - struct to say hello to kdbus
 444  * @size:               The total size of the structure
 445  * @conn_flags:         Connection flags (KDBUS_HELLO_*). The kernel will
 446  *                      return its capabilities in that field.
 447  * @attach_flags:       Mask of metdata to attach to each message sent
 448  *                      (KDBUS_ATTACH_*)
 449  * @bus_flags:          The flags field copied verbatim from the original
 450  *                      KDBUS_CMD_BUS_MAKE ioctl. It's intended to be useful
 451  *                      to do negotiation of features of the payload that is
 452  *                      transferred (kernel → userspace)
 453  * @id:                 The ID of this connection (kernel → userspace)
 454  * @bloom_size:         The bloom filter size chosen by the owner
 455  *                      (kernel → userspace)
 456  * @pool_size:          Maximum size of the pool buffer (kernel → userspace)
 457  * @id128:              Unique 128-bit ID of the bus (kernel → userspace)
 458  * @items:              A list of items
 459  *
 460  * This struct is used with the KDBUS_CMD_HELLO ioctl. See the ioctl
 461  * documentation for more information.
 462  */
 463 struct kdbus_cmd_hello {
 464         __u64 size;
 465
 466         /* userspace → kernel, kernel → userspace */
 467         __u64 conn_flags;
 468         __u64 attach_flags;
 469
 470         /* kernel → userspace */
 471         __u64 bus_flags;
 472         __u64 id;
 473         __u64 bloom_size;
 474         __u64 pool_size;
 475         __u8 id128[16];
 476
 477         struct kdbus_item items[0];
 478 };
 479
 480 /* Flags for KDBUS_CMD_{BUS,EP,NS}_MAKE */
 481 enum kdbus_make_flags {
 482         KDBUS_MAKE_ACCESS_GROUP         = 1 <<  0,
 483         KDBUS_MAKE_ACCESS_WORLD         = 1 <<  1,
 484         KDBUS_MAKE_POLICY_OPEN          = 1 <<  2,
 485 };
 486
 487 /**
 488  * struct kdbus_cmd_bus_make - struct to make a bus
 489  * @size:               The total size of the struct
 490  * @flags:              Properties for the bus to create
 491  * @bloom_size:         Size of the bloom filter for this bus
 492  * @items:              Items describing details such as the name of the bus
 493  *
 494  * This structure is used with the KDBUS_CMD_BUS_MAKE ioctl. Refer to the
 495  * documentation for more information.
 496  */
 497 struct kdbus_cmd_bus_make {
 498         __u64 size;
 499         __u64 flags;
 500         __u64 bloom_size;
 501         struct kdbus_item items[0];
 502 };
 503
 504 /**
 505  * struct kdbus_cmd_ep_make - struct to make an endpoint
 506  * @size:               The total size of the struct
 507  * @flags:              Unused for now
 508  * @items:              Items describing details such as the
 509  *                      name of the endpoint
 510  *
 511  * This structure is used with the KDBUS_CMD_EP_MAKE ioctl. Refer to the
 512  * documentation for more information.
 513  */
 514 struct kdbus_cmd_ep_make {
 515         __u64 size;
 516         __u64 flags;
 517         struct kdbus_item items[0];
 518 };
 519
 520 /**
 521  * struct kdbus_cmd_ns_make - struct to make a namespace
 522  * @size:               The total size of the struct
 523  * @flags:              Unused for now
 524  * @items:              Items describing details such as the
 525  *                      name of the namespace
 526  *
 527  * This structure is used with the KDBUS_CMD_NS_MAKE ioctl. Refer to the
 528  * documentation for more information.
 529  */
 530 struct kdbus_cmd_ns_make {
 531         __u64 size;
 532         __u64 flags;
 533         struct kdbus_item items[0];
 534 };
 535
 536 /**
 537  * enum kdbus_name_flags - properties of a well-known name
 538  * @KDBUS_NAME_REPLACE_EXISTING:        Try to replace name of other connections
 539  * @KDBUS_NAME_QUEUE:                   Name should be queued if busy
 540  * @KDBUS_NAME_ALLOW_REPLACEMENT:       Allow the replacement of the name
 541  * @KDBUS_NAME_IN_QUEUE:                Name is queued
 542  */
 543 enum kdbus_name_flags {
 544         /* userspace → kernel */
 545         KDBUS_NAME_REPLACE_EXISTING             = 1 <<  0,
 546         KDBUS_NAME_QUEUE                        = 1 <<  1,
 547         KDBUS_NAME_ALLOW_REPLACEMENT            = 1 <<  2,
 548
 549         /* kernel → userspace */
 550         KDBUS_NAME_IN_QUEUE                     = 1 << 16,
 551 };
 552
 553 /**
 554  * struct kdbus_cmd_name - struct to describe a well-known name
 555  * @size:               The total size of the struct
 556  * @flags:              Flags for a name entry (KDBUS_NAME_*)
 557  * @id:                 Priviledged users may use this field to (de)register
 558  *                      names on behalf of other peers.
 559  * @conn_flags:         The flags of the owning connection (KDBUS_HELLO_*)
 560  * @name:               The well-known name
 561  *
 562  * This structure is used with the KDBUS_CMD_NAME_ACQUIRE ioctl.
 563  * Refer to the documentation for more information.
 564  */
 565 struct kdbus_cmd_name {
 566         __u64 size;
 567         __u64 flags;
 568         __u64 id;
 569         __u64 conn_flags;
 570         char name[0];
 571 };
 572
 573 /**
 574  * enum kdbus_name_list_flags - what to include into the returned list
 575  * @KDBUS_NAME_LIST_UNIQUE:     All active connections
 576  * @KDBUS_NAME_LIST_NAMES:      All known well-known names
 577  * @KDBUS_NAME_LIST_STARTERS:   All connections which are starter connections
 578  * @KDBUS_NAME_LIST_QUEUED:     All queued-up names
 579  */
 580 enum kdbus_name_list_flags {
 581         KDBUS_NAME_LIST_UNIQUE          = 1 <<  0,
 582         KDBUS_NAME_LIST_NAMES           = 1 <<  1,
 583         KDBUS_NAME_LIST_STARTERS        = 1 <<  2,
 584         KDBUS_NAME_LIST_QUEUED          = 1 <<  3,
 585 };
 586
 587 /**
 588  * struct kdbus_cmd_name_list - request a list of name entries
 589  * @flags:              Flags for the query (KDBUS_NAME_LIST_*)
 590  * @offset:             The returned offset in the caller's pool buffer.
 591  *                      The user must use KDBUS_CMD_FREE to free the
 592  *                      allocated memory.
 593  *
 594  * This structure is used with the KDBUS_CMD_NAME_LIST ioctl.
 595  */
 596 struct kdbus_cmd_name_list {
 597         __u64 flags;
 598         __u64 offset;
 599 };
 600
 601 /**
 602  * struct kdbus_name_list - information returned by KDBUS_CMD_NAME_LIST
 603  * @size:               The total size of the structure
 604  * @names:              A list of names
 605  *
 606  * Note that the user is responsible for freeing the allocated memory with
 607  * the KDBUS_CMD_FREE ioctl.
 608  */
 609 struct kdbus_name_list {
 610         __u64 size;
 611         struct kdbus_cmd_name names[0];
 612 };
 613
 614 /**
 615  * struct kdbus_cmd_conn_info - struct used for KDBUS_CMD_CONN_INFO ioctl
 616  * @size:               The total size of the struct
 617  * @flags:              KDBUS_ATTACH_* flags
 618  * @id:                 The 64-bit ID of the connection. If set to zero, passing
 619  *                      @name is required. kdbus will look up the name to determine
 620  *                      the ID in this case.
 621  * @offset:             Returned offset in the caller's pool buffer where the
 622  *                      kdbus_name_info struct result is stored. The user must
 623  *                      use KDBUS_CMD_FREE to free the allocated memory.
 624  * @name:               The optional well-known name to look up. Only needed in
 625  *                      case @id is zero.
 626  *
 627  * On success, the KDBUS_CMD_CONN_INFO ioctl will return 0 and @offset will
 628  * tell the user the offset in the connection pool buffer at which to find the
 629  * result in a struct kdbus_conn_info.
 630  */
 631 struct kdbus_cmd_conn_info {
 632         __u64 size;
 633         __u64 flags;
 634         __u64 id;
 635         __u64 offset;
 636         char name[0];
 637 };
 638
 639 /**
 640  * struct kdbus_conn_info - information returned by KDBUS_CMD_CONN_INFO
 641  * @size:               The total size of the struct
 642  * @id:                 The connection's 64-bit ID
 643  * @flags:              The connection's flags
 644  * @items:              A list of struct kdbus_item
 645  *
 646  * Note that the user is responsible for freeing the allocated memory with
 647  * the KDBUS_CMD_FREE ioctl.
 648  */
 649 struct kdbus_conn_info {
 650         __u64 size;
 651         __u64 id;
 652         __u64 flags;
 653         struct kdbus_item items[0];
 654 };
 655
 656 /**
 657  * enum kdbus_match_type - type of match record
 658  * @KDBUS_MATCH_BLOOM:          Matches against KDBUS_MSG_BLOOM
 659  * @KDBUS_MATCH_SRC_NAME:       Matches a name string
 660  * @KDBUS_MATCH_NAME_ADD:       Matches a name string
 661  * @KDBUS_MATCH_NAME_REMOVE:    Matches a name string
 662  * @KDBUS_MATCH_NAME_CHANGE:    Matches a name string
 663  * @KDBUS_MATCH_ID_ADD:         Matches an ID
 664  * @KDBUS_MATCH_ID_REMOVE:      Matches an ID
 665  */
 666 enum kdbus_match_type {
 667         _KDBUS_MATCH_NULL,
 668         KDBUS_MATCH_BLOOM,
 669         KDBUS_MATCH_SRC_NAME,
 670         KDBUS_MATCH_NAME_ADD,
 671         KDBUS_MATCH_NAME_REMOVE,
 672         KDBUS_MATCH_NAME_CHANGE,
 673         KDBUS_MATCH_ID_ADD,
 674         KDBUS_MATCH_ID_REMOVE,
 675 };
 676
 677 /**
 678  * struct kdbus_cmd_match - struct to add or remove matches
 679  * @size:               The total size of the struct
 680  * @id:                 Privileged users may (de)register matches on behalf
 681  *                      of other peers. In other cases, set to 0.
 682  * @cookie:             Userspace supplied cookie. When removing, the cookie
 683  *                      identifies the match to remove.
 684  * @src_id:             The source ID to match against. Use
 685  *                      KDBUS_MATCH_SRC_ID_ANY or any other value for a unique
 686  *                      match.
 687  * @items:              A list of items for additional information
 688  *
 689  * This structure is used with the KDBUS_CMD_ADD_MATCH and
 690  * KDBUS_CMD_REMOVE_MATCH ioctl. Refer to the documentation for more
 691  * information.
 692  */
 693 struct kdbus_cmd_match {
 694         __u64 size;
 695         __u64 id;
 696         __u64 cookie;
 697         __u64 src_id;
 698         struct kdbus_item items[0];
 699 };
 700
 701 /**
 702  * enum kdbus_monitor_flags - flags for monitoring
 703  * @KDBUS_MONITOR_ENABLE:       Enable monitoring
 704  */
 705 enum kdbus_monitor_flags {
 706         KDBUS_MONITOR_ENABLE            = 1 <<  0,
 707 };
 708
 709 /**
 710  * struct kdbus_cmd_monitor - struct to enable or disable eavesdropping
 711  * @id:                 Priviledged users may enable or disable the monitor feature
 712  *                      on behalf of other peers
 713  * @flags:              Use KDBUS_MONITOR_ENABLE to enable eavesdropping
 714  *
 715  * This structure is used with the KDBUS_CMD_MONITOR ioctl.
 716  * Refer to the documentation for more information.
 717  */
 718 struct kdbus_cmd_monitor {
 719         __u64 id;
 720         __u64 flags;
 721 };
 722
 723 /**
 724  * enum kdbus_ioctl_type - Ioctl API
 725  * @KDBUS_CMD_BUS_MAKE:         After opening the "control" device node, this
 726  *                              command creates a new bus with the specified
 727  *                              name. The bus is immediately shut down and
 728  *                              cleaned up when the opened "control" device node
 729  *                              is closed.
 730  * @KDBUS_CMD_NS_MAKE:          Similar to KDBUS_CMD_BUS_MAKE, but it creates a
 731  *                              new kdbus namespace.
 732  * @KDBUS_CMD_EP_MAKE:          Creates a new named special endpoint to talk to
 733  *                              the bus. Such endpoints usually carry a more
 734  *                              restrictive policy and grant restricted access
 735  *                              to specific applications.
 736  * @KDBUS_CMD_HELLO:            By opening the bus device node a connection is
 737  *                              created. After a HELLO the opened connection
 738  *                              becomes an active peer on the bus.
 739  * @KDBUS_CMD_MSG_SEND:         Send a message and pass data from userspace to
 740  *                              the kernel.
 741  * @KDBUS_CMD_MSG_RECV:         Receive a message from the kernel which is
 742  *                              placed in the receiver's pool.
 743  * @KDBUS_CMD_FREE:             Release the allocated memory in the receiver's
 744  *                              pool.
 745  * @KDBUS_CMD_NAME_ACQUIRE:     Request a well-known bus name to associate with
 746  *                              the connection. Well-known names are used to
 747  *                              address a peer on the bus.
 748  * @KDBUS_CMD_NAME_RELEASE:     Release a well-known name the connection
 749  *                              currently owns.
 750  * @KDBUS_CMD_NAME_LIST:        Retrieve the list of all currently registered
 751  *                              well-known and unique names.
 752  * @KDBUS_CMD_CONN_INFO:        Retrieve credentials and properties of the
 753  *                              initial creator of the connection. The data was
 754  *                              stored at registration time and does not
 755  *                              neccessarily represent the connected process or
 756  *                              the actual state of the process.
 757  * @KDBUS_CMD_MATCH_ADD:        Install a match which broadcast messages should
 758  *                              be delivered to the connection.
 759  * @KDBUS_CMD_MATCH_REMOVE:     Remove a current match for broadcast messages.
 760  * @KDBUS_CMD_MONITOR:          Monitor the bus and receive all transmitted
 761  *                              messages. Privileges are required for this
 762  *                              operation.
 763  * @KDBUS_CMD_EP_POLICY_SET:    Set the policy of an endpoint. It is used to
 764  *                              restrict the access for endpoints created with
 765  *                              KDBUS_CMD_EP_MAKE.
 766  * @KDBUS_CMD_MEMFD_NEW:        Return a new file descriptor which provides an
 767  *                              anonymous shared memory file and which can be
 768  *                              used to pass around larger chunks of data.
 769  *                              Kdbus memfd files can be sealed, which allows
 770  *                              the receiver to trust the data it has received.
 771  *                              Kdbus memfd files expose only very limited
 772  *                              operations, they can be mmap()ed, seek()ed,
 773  *                              (p)read(v)() and (p)write(v)(); most other
 774  *                              common file operations are not implemented.
 775  *                              Special caution needs to be taken with
 776  *                              read(v)()/write(v)() on a shared file; the
 777  *                              underlying file position is always shared
 778  *                              between all users of the file and race against
 779  *                              each other, pread(v)()/pwrite(v)() avoid these
 780  *                              issues.
 781  * @KDBUS_CMD_MEMFD_SIZE_GET:   Return the size of the underlying file, which
 782  *                              changes with write().
 783  * @KDBUS_CMD_MEMFD_SIZE_SET:   Truncate the underlying file to the specified
 784  *                              size.
 785  * @KDBUS_CMD_MEMFD_SEAL_GET:   Return the state of the file sealing.
 786  * @KDBUS_CMD_MEMFD_SEAL_SET:   Seal or break a seal of the file. Only files
 787  *                              which are not shared with other processes and
 788  *                              which are currently not mapped can be sealed.
 789  *                              The current process needs to be the one and
 790  *                              single owner of the file, the sealing cannot
 791  *                              be changed as long as the file is shared.
 792  */
 793 enum kdbus_ioctl_type {
 794         KDBUS_CMD_BUS_MAKE =            _IOW (KDBUS_IOC_MAGIC, 0x00, struct kdbus_cmd_bus_make),
 795         KDBUS_CMD_NS_MAKE =             _IOR (KDBUS_IOC_MAGIC, 0x10, struct kdbus_cmd_ns_make),
 796
 797         KDBUS_CMD_EP_MAKE =             _IOW (KDBUS_IOC_MAGIC, 0x20, struct kdbus_cmd_ep_make),
 798         KDBUS_CMD_HELLO =               _IOWR(KDBUS_IOC_MAGIC, 0x30, struct kdbus_cmd_hello),
 799
 800         KDBUS_CMD_MSG_SEND =            _IOW (KDBUS_IOC_MAGIC, 0x40, struct kdbus_msg),
 801         KDBUS_CMD_MSG_RECV =            _IOR (KDBUS_IOC_MAGIC, 0x41, __u64 *),
 802         KDBUS_CMD_FREE =                _IOW (KDBUS_IOC_MAGIC, 0x42, __u64 *),
 803
 804         KDBUS_CMD_NAME_ACQUIRE =        _IOWR(KDBUS_IOC_MAGIC, 0x50, struct kdbus_cmd_name),
 805         KDBUS_CMD_NAME_RELEASE =        _IOW (KDBUS_IOC_MAGIC, 0x51, struct kdbus_cmd_name),
 806         KDBUS_CMD_NAME_LIST =           _IOWR(KDBUS_IOC_MAGIC, 0x52, struct kdbus_cmd_name_list),
 807
 808         KDBUS_CMD_CONN_INFO =           _IOWR(KDBUS_IOC_MAGIC, 0x60, struct kdbus_cmd_conn_info),
 809
 810         KDBUS_CMD_MATCH_ADD =           _IOW (KDBUS_IOC_MAGIC, 0x70, struct kdbus_cmd_match),
 811         KDBUS_CMD_MATCH_REMOVE =        _IOW (KDBUS_IOC_MAGIC, 0x71, struct kdbus_cmd_match),
 812         KDBUS_CMD_MONITOR =             _IOW (KDBUS_IOC_MAGIC, 0x72, struct kdbus_cmd_monitor),
 813
 814         KDBUS_CMD_EP_POLICY_SET =       _IOW (KDBUS_IOC_MAGIC, 0x80, struct kdbus_cmd_policy),
 815
 816         KDBUS_CMD_MEMFD_NEW =           _IOR (KDBUS_IOC_MAGIC, 0x90, int *),
 817         KDBUS_CMD_MEMFD_SIZE_GET =      _IOR (KDBUS_IOC_MAGIC, 0x91, __u64 *),
 818         KDBUS_CMD_MEMFD_SIZE_SET =      _IOW (KDBUS_IOC_MAGIC, 0x92, __u64 *),
 819         KDBUS_CMD_MEMFD_SEAL_GET =      _IOR (KDBUS_IOC_MAGIC, 0x93, int *),
 820         KDBUS_CMD_MEMFD_SEAL_SET =      _IO  (KDBUS_IOC_MAGIC, 0x94),
 821 };
 822
 823 /*
 824  * errno - api error codes
 825  * @E2BIG:              A message contains too many records or items.
 826  * @EADDRNOTAVAIL:      A message flagged not to activate a service, addressed
 827  *                      a service which is not currently running.
 828  * @EAGAIN:             No messages are queued at the moment.
 829  * @EBADF:              File descriptors passed with the message are not valid.
 830  * @EBADFD:             A bus connection is in a corrupted state.
 831  * @EBADMSG:            Passed data contains a combination of conflicting or
 832  *                      inconsistent types.
 833  * @EBUSY:              A well-known bus name is already taken by another
 834  *                      connection.
 835  * @ECOMM:              A peer does not accept the file descriptors addressed
 836  *                      to it.
 837  * @EDESTADDRREQ:       The well-known bus name is required but missing.
 838  * @EDOM:               The size of data does not match the expectations. Used
 839  *                      for the size of the bloom filter bit field.
 840  * @EEXIST:             A requested namespace, bus or endpoint with the same
 841  *                      name already exists.  A specific data type, which is
 842  *                      only expected once, is provided multiple times.
 843  * @EFAULT:             The supplied memory could not be accessed, or the data
 844  *                      is not properly aligned.
 845  * @EINVAL:             The provided data does not match its type or other
 846  *                      expectations, like a string which is not NUL terminated,
 847  *                      or a string length that points behind the first
 848  *                      \0-byte in the string.
 849  * @EMEDIUMTYPE:        A file descriptor which is not a kdbus memfd was
 850  *                      refused to send as KDBUS_MSG_PAYLOAD_MEMFD.
 851  * @EMFILE:             Too many file descriptors have been supplied with a
 852  *                      message.
 853  * @EMSGSIZE:           The supplied data is larger than the allowed maximum
 854  *                      size.
 855  * @ENAMETOOLONG:       The requested name is larger than the allowed maximum
 856  *                      size.
 857  * @ENOBUFS:            There is no space left for the submitted data to fit
 858  *                      into the receiver's pool.
 859  * @ENOMEM:             Out of memory.
 860  * @ENOSYS:             The requested functionality is not available.
 861  * @ENOTCONN:           The addressed peer is not an active connection.
 862  * @ENOTSUPP:           The feature negotiation failed, a not supported feature
 863  *                      was requested.
 864  * @ENOTTY:             An unknown ioctl command was received.
 865  * @ENOTUNIQ:           A specific data type was addressed to a broadcast
 866  *                      address, but only direct addresses support this kind of
 867  *                      data.
 868  * @ENXIO:              A unique address does not exist.
 869  * @EPERM:              The policy prevented an operation. The requested
 870  *                      resource is owned by another entity.
 871  * @ESHUTDOWN:          The connection is currently shutting down, no further
 872  *                      operations are possible.
 873  * @ESRCH:              A requested well-known bus name is not found.
 874  * @ETXTBSY:            A kdbus memfd file cannot be sealed or the seal removed,
 875  *                      because it is shared with other processes or still
 876  *                      mmap()ed.
 877  * @EXFULL:             The size limits in the pool are reached, no data of
 878  *                      the size tried to submit can be queued.
 879  */
 880 #endif