src/libsystemd/sd-bus/kdbus.h

   1 /*
   2  * kdbus is free software; you can redistribute it and/or modify it under
   3  * the terms of the GNU Lesser General Public License as published by the
   4  * Free Software Foundation; either version 2.1 of the License, or (at
   5  * your option) any later version.
   6  */
   7
   8 #ifndef _KDBUS_UAPI_H_
   9 #define _KDBUS_UAPI_H_
  10
  11 #include <linux/ioctl.h>
  12 #include <linux/types.h>
  13
  14 #define KDBUS_IOCTL_MAGIC               0x95
  15 #define KDBUS_SRC_ID_KERNEL             (0)
  16 #define KDBUS_DST_ID_NAME               (0)
  17 #define KDBUS_MATCH_ID_ANY              (~0ULL)
  18 #define KDBUS_DST_ID_BROADCAST          (~0ULL)
  19 #define KDBUS_FLAG_NEGOTIATE            (1ULL << 63)
  20
  21 /**
  22  * struct kdbus_notify_id_change - name registry change message
  23  * @id:                 New or former owner of the name
  24  * @flags:              flags field from KDBUS_HELLO_*
  25  *
  26  * Sent from kernel to userspace when the owner or activator of
  27  * a well-known name changes.
  28  *
  29  * Attached to:
  30  *   KDBUS_ITEM_ID_ADD
  31  *   KDBUS_ITEM_ID_REMOVE
  32  */
  33 struct kdbus_notify_id_change {
  34         __u64 id;
  35         __u64 flags;
  36 } __attribute__((__aligned__(8)));
  37
  38 /**
  39  * struct kdbus_notify_name_change - name registry change message
  40  * @old_id:             ID and flags of former owner of a name
  41  * @new_id:             ID and flags of new owner of a name
  42  * @name:               Well-known name
  43  *
  44  * Sent from kernel to userspace when the owner or activator of
  45  * a well-known name changes.
  46  *
  47  * Attached to:
  48  *   KDBUS_ITEM_NAME_ADD
  49  *   KDBUS_ITEM_NAME_REMOVE
  50  *   KDBUS_ITEM_NAME_CHANGE
  51  */
  52 struct kdbus_notify_name_change {
  53         struct kdbus_notify_id_change old_id;
  54         struct kdbus_notify_id_change new_id;
  55         char name[0];
  56 } __attribute__((__aligned__(8)));
  57
  58 /**
  59  * struct kdbus_creds - process credentials
  60  * @uid:                User ID
  61  * @euid:               Effective UID
  62  * @suid:               Saved UID
  63  * @fsuid:              Filesystem UID
  64  * @gid:                Group ID
  65  * @egid:               Effective GID
  66  * @sgid:               Saved GID
  67  * @fsgid:              Filesystem GID
  68  *
  69  * Attached to:
  70  *   KDBUS_ITEM_CREDS
  71  */
  72 struct kdbus_creds {
  73         __u32 uid;
  74         __u32 euid;
  75         __u32 suid;
  76         __u32 fsuid;
  77         __u32 gid;
  78         __u32 egid;
  79         __u32 sgid;
  80         __u32 fsgid;
  81 } __attribute__((__aligned__(8)));
  82
  83 /**
  84  * struct kdbus_pids - process identifiers
  85  * @pid:                Process ID
  86  * @tid:                Thread ID
  87  * @ppid:               Parent process ID
  88  *
  89  * The PID and TID of a process.
  90  *
  91  * Attached to:
  92  *   KDBUS_ITEM_PIDS
  93  */
  94 struct kdbus_pids {
  95         __u64 pid;
  96         __u64 tid;
  97         __u64 ppid;
  98 } __attribute__((__aligned__(8)));
  99
 100 /**
 101  * struct kdbus_caps - process capabilities
 102  * @last_cap:   Highest currently known capability bit
 103  * @caps:       Variable number of 32-bit capabilities flags
 104  *
 105  * Contains a variable number of 32-bit capabilities flags.
 106  *
 107  * Attached to:
 108  *   KDBUS_ITEM_CAPS
 109  */
 110 struct kdbus_caps {
 111         __u32 last_cap;
 112         __u32 caps[0];
 113 } __attribute__((__aligned__(8)));
 114
 115 /**
 116  * struct kdbus_audit - audit information
 117  * @sessionid:          The audit session ID
 118  * @loginuid:           The audit login uid
 119  *
 120  * Attached to:
 121  *   KDBUS_ITEM_AUDIT
 122  */
 123 struct kdbus_audit {
 124         __u32 sessionid;
 125         __u32 loginuid;
 126 } __attribute__((__aligned__(8)));
 127
 128 /**
 129  * struct kdbus_timestamp
 130  * @seqnum:             Global per-domain message sequence number
 131  * @monotonic_ns:       Monotonic timestamp, in nanoseconds
 132  * @realtime_ns:        Realtime timestamp, in nanoseconds
 133  *
 134  * Attached to:
 135  *   KDBUS_ITEM_TIMESTAMP
 136  */
 137 struct kdbus_timestamp {
 138         __u64 seqnum;
 139         __u64 monotonic_ns;
 140         __u64 realtime_ns;
 141 } __attribute__((__aligned__(8)));
 142
 143 /**
 144  * struct kdbus_vec - I/O vector for kdbus payload items
 145  * @size:               The size of the vector
 146  * @address:            Memory address of data buffer
 147  * @offset:             Offset in the in-message payload memory,
 148  *                      relative to the message head
 149  *
 150  * Attached to:
 151  *   KDBUS_ITEM_PAYLOAD_VEC, KDBUS_ITEM_PAYLOAD_OFF
 152  */
 153 struct kdbus_vec {
 154         __u64 size;
 155         union {
 156                 __u64 address;
 157                 __u64 offset;
 158         };
 159 } __attribute__((__aligned__(8)));
 160
 161 /**
 162  * struct kdbus_bloom_parameter - bus-wide bloom parameters
 163  * @size:               Size of the bit field in bytes (m / 8)
 164  * @n_hash:             Number of hash functions used (k)
 165  */
 166 struct kdbus_bloom_parameter {
 167         __u64 size;
 168         __u64 n_hash;
 169 } __attribute__((__aligned__(8)));
 170
 171 /**
 172  * struct kdbus_bloom_filter - bloom filter containing n elements
 173  * @generation:         Generation of the element set in the filter
 174  * @data:               Bit field, multiple of 8 bytes
 175  */
 176 struct kdbus_bloom_filter {
 177         __u64 generation;
 178         __u64 data[0];
 179 } __attribute__((__aligned__(8)));
 180
 181 /**
 182  * struct kdbus_memfd - a kdbus memfd
 183  * @start:              The offset into the memfd where the segment starts
 184  * @size:               The size of the memfd segment
 185  * @fd:                 The file descriptor number
 186  * @__pad:              Padding to ensure proper alignment and size
 187  *
 188  * Attached to:
 189  *   KDBUS_ITEM_PAYLOAD_MEMFD
 190  */
 191 struct kdbus_memfd {
 192         __u64 start;
 193         __u64 size;
 194         int fd;
 195         __u32 __pad;
 196 } __attribute__((__aligned__(8)));
 197
 198 /**
 199  * struct kdbus_name - a registered well-known name with its flags
 200  * @flags:              Flags from KDBUS_NAME_*
 201  * @name:               Well-known name
 202  *
 203  * Attached to:
 204  *   KDBUS_ITEM_OWNED_NAME
 205  */
 206 struct kdbus_name {
 207         __u64 flags;
 208         char name[0];
 209 } __attribute__((__aligned__(8)));
 210
 211 /**
 212  * enum kdbus_policy_access_type - permissions of a policy record
 213  * @_KDBUS_POLICY_ACCESS_NULL:  Uninitialized/invalid
 214  * @KDBUS_POLICY_ACCESS_USER:   Grant access to a uid
 215  * @KDBUS_POLICY_ACCESS_GROUP:  Grant access to gid
 216  * @KDBUS_POLICY_ACCESS_WORLD:  World-accessible
 217  */
 218 enum kdbus_policy_access_type {
 219         _KDBUS_POLICY_ACCESS_NULL,
 220         KDBUS_POLICY_ACCESS_USER,
 221         KDBUS_POLICY_ACCESS_GROUP,
 222         KDBUS_POLICY_ACCESS_WORLD,
 223 };
 224
 225 /**
 226  * enum kdbus_policy_access_flags - mode flags
 227  * @KDBUS_POLICY_OWN:           Allow to own a well-known name
 228  *                              Implies KDBUS_POLICY_TALK and KDBUS_POLICY_SEE
 229  * @KDBUS_POLICY_TALK:          Allow communication to a well-known name
 230  *                              Implies KDBUS_POLICY_SEE
 231  * @KDBUS_POLICY_SEE:           Allow to see a well-known name
 232  */
 233 enum kdbus_policy_type {
 234         KDBUS_POLICY_SEE        = 0,
 235         KDBUS_POLICY_TALK,
 236         KDBUS_POLICY_OWN,
 237 };
 238
 239 /**
 240  * struct kdbus_policy_access - policy access item
 241  * @type:               One of KDBUS_POLICY_ACCESS_* types
 242  * @access:             Access to grant
 243  * @id:                 For KDBUS_POLICY_ACCESS_USER, the uid
 244  *                      For KDBUS_POLICY_ACCESS_GROUP, the gid
 245  */
 246 struct kdbus_policy_access {
 247         __u64 type;     /* USER, GROUP, WORLD */
 248         __u64 access;   /* OWN, TALK, SEE */
 249         __u64 id;       /* uid, gid, 0 */
 250 } __attribute__((__aligned__(8)));
 251
 252 /**
 253  * enum kdbus_attach_flags - flags for metadata attachments
 254  * @KDBUS_ATTACH_TIMESTAMP:             Timestamp
 255  * @KDBUS_ATTACH_CREDS:                 Credentials
 256  * @KDBUS_ATTACH_PIDS:                  PIDs
 257  * @KDBUS_ATTACH_AUXGROUPS:             Auxiliary groups
 258  * @KDBUS_ATTACH_NAMES:                 Well-known names
 259  * @KDBUS_ATTACH_TID_COMM:              The "comm" process identifier of the TID
 260  * @KDBUS_ATTACH_PID_COMM:              The "comm" process identifier of the PID
 261  * @KDBUS_ATTACH_EXE:                   The path of the executable
 262  * @KDBUS_ATTACH_CMDLINE:               The process command line
 263  * @KDBUS_ATTACH_CGROUP:                The croup membership
 264  * @KDBUS_ATTACH_CAPS:                  The process capabilities
 265  * @KDBUS_ATTACH_SECLABEL:              The security label
 266  * @KDBUS_ATTACH_AUDIT:                 The audit IDs
 267  * @KDBUS_ATTACH_CONN_DESCRIPTION:      The human-readable connection name
 268  * @_KDBUS_ATTACH_ALL:                  All of the above
 269  * @_KDBUS_ATTACH_ANY:                  Wildcard match to enable any kind of
 270  *                                      metatdata.
 271  */
 272 enum kdbus_attach_flags {
 273         KDBUS_ATTACH_TIMESTAMP          =  1ULL <<  0,
 274         KDBUS_ATTACH_CREDS              =  1ULL <<  1,
 275         KDBUS_ATTACH_PIDS               =  1ULL <<  2,
 276         KDBUS_ATTACH_AUXGROUPS          =  1ULL <<  3,
 277         KDBUS_ATTACH_NAMES              =  1ULL <<  4,
 278         KDBUS_ATTACH_TID_COMM           =  1ULL <<  5,
 279         KDBUS_ATTACH_PID_COMM           =  1ULL <<  6,
 280         KDBUS_ATTACH_EXE                =  1ULL <<  7,
 281         KDBUS_ATTACH_CMDLINE            =  1ULL <<  8,
 282         KDBUS_ATTACH_CGROUP             =  1ULL <<  9,
 283         KDBUS_ATTACH_CAPS               =  1ULL << 10,
 284         KDBUS_ATTACH_SECLABEL           =  1ULL << 11,
 285         KDBUS_ATTACH_AUDIT              =  1ULL << 12,
 286         KDBUS_ATTACH_CONN_DESCRIPTION   =  1ULL << 13,
 287         _KDBUS_ATTACH_ALL               =  (1ULL << 14) - 1,
 288         _KDBUS_ATTACH_ANY               =  ~0ULL
 289 };
 290
 291 /**
 292  * enum kdbus_item_type - item types to chain data in a list
 293  * @_KDBUS_ITEM_NULL:                   Uninitialized/invalid
 294  * @_KDBUS_ITEM_USER_BASE:              Start of user items
 295  * @KDBUS_ITEM_NEGOTIATE:               Negotiate supported items
 296  * @KDBUS_ITEM_PAYLOAD_VEC:             Vector to data
 297  * @KDBUS_ITEM_PAYLOAD_OFF:             Data at returned offset to message head
 298  * @KDBUS_ITEM_PAYLOAD_MEMFD:           Data as sealed memfd
 299  * @KDBUS_ITEM_FDS:                     Attached file descriptors
 300  * @KDBUS_ITEM_CANCEL_FD:               FD used to cancel a synchronous
 301  *                                      operation by writing to it from
 302  *                                      userspace
 303  * @KDBUS_ITEM_BLOOM_PARAMETER:         Bus-wide bloom parameters, used with
 304  *                                      KDBUS_CMD_BUS_MAKE, carries a
 305  *                                      struct kdbus_bloom_parameter
 306  * @KDBUS_ITEM_BLOOM_FILTER:            Bloom filter carried with a message,
 307  *                                      used to match against a bloom mask of a
 308  *                                      connection, carries a struct
 309  *                                      kdbus_bloom_filter
 310  * @KDBUS_ITEM_BLOOM_MASK:              Bloom mask used to match against a
 311  *                                      message'sbloom filter
 312  * @KDBUS_ITEM_DST_NAME:                Destination's well-known name
 313  * @KDBUS_ITEM_MAKE_NAME:               Name of domain, bus, endpoint
 314  * @KDBUS_ITEM_ATTACH_FLAGS_SEND:       Attach-flags, used for updating which
 315  *                                      metadata a connection opts in to send
 316  * @KDBUS_ITEM_ATTACH_FLAGS_RECV:       Attach-flags, used for updating which
 317  *                                      metadata a connection requests to
 318  *                                      receive for each reeceived message
 319  * @KDBUS_ITEM_ID:                      Connection ID
 320  * @KDBUS_ITEM_NAME:                    Well-know name with flags
 321  * @_KDBUS_ITEM_ATTACH_BASE:            Start of metadata attach items
 322  * @KDBUS_ITEM_TIMESTAMP:               Timestamp
 323  * @KDBUS_ITEM_CREDS:                   Process credentials
 324  * @KDBUS_ITEM_PIDS:                    Process identifiers
 325  * @KDBUS_ITEM_AUXGROUPS:               Auxiliary process groups
 326  * @KDBUS_ITEM_OWNED_NAME:              A name owned by the associated
 327  *                                      connection
 328  * @KDBUS_ITEM_TID_COMM:                Thread ID "comm" identifier
 329  *                                      (Don't trust this, see below.)
 330  * @KDBUS_ITEM_PID_COMM:                Process ID "comm" identifier
 331  *                                      (Don't trust this, see below.)
 332  * @KDBUS_ITEM_EXE:                     The path of the executable
 333  *                                      (Don't trust this, see below.)
 334  * @KDBUS_ITEM_CMDLINE:                 The process command line
 335  *                                      (Don't trust this, see below.)
 336  * @KDBUS_ITEM_CGROUP:                  The croup membership
 337  * @KDBUS_ITEM_CAPS:                    The process capabilities
 338  * @KDBUS_ITEM_SECLABEL:                The security label
 339  * @KDBUS_ITEM_AUDIT:                   The audit IDs
 340  * @KDBUS_ITEM_CONN_DESCRIPTION:        The connection's human-readable name
 341  *                                      (debugging)
 342  * @_KDBUS_ITEM_POLICY_BASE:            Start of policy items
 343  * @KDBUS_ITEM_POLICY_ACCESS:           Policy access block
 344  * @_KDBUS_ITEM_KERNEL_BASE:            Start of kernel-generated message items
 345  * @KDBUS_ITEM_NAME_ADD:                Notification in kdbus_notify_name_change
 346  * @KDBUS_ITEM_NAME_REMOVE:             Notification in kdbus_notify_name_change
 347  * @KDBUS_ITEM_NAME_CHANGE:             Notification in kdbus_notify_name_change
 348  * @KDBUS_ITEM_ID_ADD:                  Notification in kdbus_notify_id_change
 349  * @KDBUS_ITEM_ID_REMOVE:               Notification in kdbus_notify_id_change
 350  * @KDBUS_ITEM_REPLY_TIMEOUT:           Timeout has been reached
 351  * @KDBUS_ITEM_REPLY_DEAD:              Destination died
 352  *
 353  * N.B: The process and thread COMM fields, as well as the CMDLINE and
 354  * EXE fields may be altered by unprivileged processes und should
 355  * hence *not* used for security decisions. Peers should make use of
 356  * these items only for informational purposes, such as generating log
 357  * records.
 358  */
 359 enum kdbus_item_type {
 360         _KDBUS_ITEM_NULL,
 361         _KDBUS_ITEM_USER_BASE,
 362         KDBUS_ITEM_NEGOTIATE    = _KDBUS_ITEM_USER_BASE,
 363         KDBUS_ITEM_PAYLOAD_VEC,
 364         KDBUS_ITEM_PAYLOAD_OFF,
 365         KDBUS_ITEM_PAYLOAD_MEMFD,
 366         KDBUS_ITEM_FDS,
 367         KDBUS_ITEM_CANCEL_FD,
 368         KDBUS_ITEM_BLOOM_PARAMETER,
 369         KDBUS_ITEM_BLOOM_FILTER,
 370         KDBUS_ITEM_BLOOM_MASK,
 371         KDBUS_ITEM_DST_NAME,
 372         KDBUS_ITEM_MAKE_NAME,
 373         KDBUS_ITEM_ATTACH_FLAGS_SEND,
 374         KDBUS_ITEM_ATTACH_FLAGS_RECV,
 375         KDBUS_ITEM_ID,
 376         KDBUS_ITEM_NAME,
 377
 378         /* keep these item types in sync with KDBUS_ATTACH_* flags */
 379         _KDBUS_ITEM_ATTACH_BASE = 0x1000,
 380         KDBUS_ITEM_TIMESTAMP    = _KDBUS_ITEM_ATTACH_BASE,
 381         KDBUS_ITEM_CREDS,
 382         KDBUS_ITEM_PIDS,
 383         KDBUS_ITEM_AUXGROUPS,
 384         KDBUS_ITEM_OWNED_NAME,
 385         KDBUS_ITEM_TID_COMM,
 386         KDBUS_ITEM_PID_COMM,
 387         KDBUS_ITEM_EXE,
 388         KDBUS_ITEM_CMDLINE,
 389         KDBUS_ITEM_CGROUP,
 390         KDBUS_ITEM_CAPS,
 391         KDBUS_ITEM_SECLABEL,
 392         KDBUS_ITEM_AUDIT,
 393         KDBUS_ITEM_CONN_DESCRIPTION,
 394
 395         _KDBUS_ITEM_POLICY_BASE = 0x2000,
 396         KDBUS_ITEM_POLICY_ACCESS = _KDBUS_ITEM_POLICY_BASE,
 397
 398         _KDBUS_ITEM_KERNEL_BASE = 0x8000,
 399         KDBUS_ITEM_NAME_ADD     = _KDBUS_ITEM_KERNEL_BASE,
 400         KDBUS_ITEM_NAME_REMOVE,
 401         KDBUS_ITEM_NAME_CHANGE,
 402         KDBUS_ITEM_ID_ADD,
 403         KDBUS_ITEM_ID_REMOVE,
 404         KDBUS_ITEM_REPLY_TIMEOUT,
 405         KDBUS_ITEM_REPLY_DEAD,
 406 };
 407
 408 /**
 409  * struct kdbus_item - chain of data blocks
 410  * @size:               Overall data record size
 411  * @type:               Kdbus_item type of data
 412  * @data:               Generic bytes
 413  * @data32:             Generic 32 bit array
 414  * @data64:             Generic 64 bit array
 415  * @str:                Generic string
 416  * @id:                 Connection ID
 417  * @vec:                KDBUS_ITEM_PAYLOAD_VEC
 418  * @creds:              KDBUS_ITEM_CREDS
 419  * @audit:              KDBUS_ITEM_AUDIT
 420  * @timestamp:          KDBUS_ITEM_TIMESTAMP
 421  * @name:               KDBUS_ITEM_NAME
 422  * @bloom_parameter:    KDBUS_ITEM_BLOOM_PARAMETER
 423  * @bloom_filter:       KDBUS_ITEM_BLOOM_FILTER
 424  * @memfd:              KDBUS_ITEM_PAYLOAD_MEMFD
 425  * @name_change:        KDBUS_ITEM_NAME_ADD
 426  *                      KDBUS_ITEM_NAME_REMOVE
 427  *                      KDBUS_ITEM_NAME_CHANGE
 428  * @id_change:          KDBUS_ITEM_ID_ADD
 429  *                      KDBUS_ITEM_ID_REMOVE
 430  * @policy:             KDBUS_ITEM_POLICY_ACCESS
 431  */
 432 struct kdbus_item {
 433         __u64 size;
 434         __u64 type;
 435         union {
 436                 __u8 data[0];
 437                 __u32 data32[0];
 438                 __u64 data64[0];
 439                 char str[0];
 440
 441                 __u64 id;
 442                 struct kdbus_vec vec;
 443                 struct kdbus_creds creds;
 444                 struct kdbus_pids pids;
 445                 struct kdbus_audit audit;
 446                 struct kdbus_caps caps;
 447                 struct kdbus_timestamp timestamp;
 448                 struct kdbus_name name;
 449                 struct kdbus_bloom_parameter bloom_parameter;
 450                 struct kdbus_bloom_filter bloom_filter;
 451                 struct kdbus_memfd memfd;
 452                 int fds[0];
 453                 struct kdbus_notify_name_change name_change;
 454                 struct kdbus_notify_id_change id_change;
 455                 struct kdbus_policy_access policy_access;
 456         };
 457 } __attribute__((__aligned__(8)));
 458
 459 /**
 460  * struct kdbus_item_list - A list of items
 461  * @size:               The total size of the structure
 462  * @items:              Array of items
 463  */
 464 struct kdbus_item_list {
 465         __u64 size;
 466         struct kdbus_item items[0];
 467 } __attribute__((__aligned__(8)));
 468
 469 /**
 470  * enum kdbus_msg_flags - type of message
 471  * @KDBUS_MSG_EXPECT_REPLY:     Expect a reply message, used for
 472  *                              method calls. The userspace-supplied
 473  *                              cookie identifies the message and the
 474  *                              respective reply carries the cookie
 475  *                              in cookie_reply
 476  * @KDBUS_MSG_NO_AUTO_START:    Do not start a service, if the addressed
 477  *                              name is not currently active
 478  * @KDBUS_MSG_SIGNAL:           Treat this message as signal
 479  */
 480 enum kdbus_msg_flags {
 481         KDBUS_MSG_EXPECT_REPLY  = 1ULL << 0,
 482         KDBUS_MSG_NO_AUTO_START = 1ULL << 1,
 483         KDBUS_MSG_SIGNAL        = 1ULL << 2,
 484 };
 485
 486 /**
 487  * enum kdbus_payload_type - type of payload carried by message
 488  * @KDBUS_PAYLOAD_KERNEL:       Kernel-generated simple message
 489  * @KDBUS_PAYLOAD_DBUS:         D-Bus marshalling "DBusDBus"
 490  *
 491  * Any payload-type is accepted. Common types will get added here once
 492  * established.
 493  */
 494 enum kdbus_payload_type {
 495         KDBUS_PAYLOAD_KERNEL,
 496         KDBUS_PAYLOAD_DBUS      = 0x4442757344427573ULL,
 497 };
 498
 499 /**
 500  * struct kdbus_msg - the representation of a kdbus message
 501  * @size:               Total size of the message
 502  * @flags:              Message flags (KDBUS_MSG_*), userspace → kernel
 503  * @priority:           Message queue priority value
 504  * @dst_id:             64-bit ID of the destination connection
 505  * @src_id:             64-bit ID of the source connection
 506  * @payload_type:       Payload type (KDBUS_PAYLOAD_*)
 507  * @cookie:             Userspace-supplied cookie, for the connection
 508  *                      to identify its messages
 509  * @timeout_ns:         The time to wait for a message reply from the peer.
 510  *                      If there is no reply, a kernel-generated message
 511  *                      with an attached KDBUS_ITEM_REPLY_TIMEOUT item
 512  *                      is sent to @src_id. The timeout is expected in
 513  *                      nanoseconds and as absolute CLOCK_MONOTONIC value.
 514  * @cookie_reply:       A reply to the requesting message with the same
 515  *                      cookie. The requesting connection can match its
 516  *                      request and the reply with this value
 517  * @items:              A list of kdbus_items containing the message payload
 518  */
 519 struct kdbus_msg {
 520         __u64 size;
 521         __u64 flags;
 522         __s64 priority;
 523         __u64 dst_id;
 524         __u64 src_id;
 525         __u64 payload_type;
 526         __u64 cookie;
 527         union {
 528                 __u64 timeout_ns;
 529                 __u64 cookie_reply;
 530         };
 531         struct kdbus_item items[0];
 532 } __attribute__((__aligned__(8)));
 533
 534 /**
 535  * struct kdbus_msg_info - returned message container
 536  * @offset:             Offset of kdbus_msg slice in pool
 537  * @msg_size:           Copy of the kdbus_msg.size field
 538  * @return_flags:       Command return flags, kernel → userspace
 539  */
 540 struct kdbus_msg_info {
 541         __u64 offset;
 542         __u64 msg_size;
 543         __u64 return_flags;
 544 } __attribute__((__aligned__(8)));
 545
 546 /**
 547  * enum kdbus_send_flags - flags for sending messages
 548  * @KDBUS_SEND_SYNC_REPLY:      Wait for destination connection to
 549  *                              reply to this message. The
 550  *                              KDBUS_CMD_SEND ioctl() will block
 551  *                              until the reply is received, and
 552  *                              offset_reply in struct kdbus_msg will
 553  *                              yield the offset in the sender's pool
 554  *                              where the reply can be found.
 555  *                              This flag is only valid if
 556  *                              @KDBUS_MSG_EXPECT_REPLY is set as well.
 557  */
 558 enum kdbus_send_flags {
 559         KDBUS_SEND_SYNC_REPLY           = 1ULL << 0,
 560 };
 561
 562 /**
 563  * struct kdbus_cmd_send - send message
 564  * @size:               Overall size of this structure
 565  * @flags:              Flags to change send behavior (KDBUS_SEND_*)
 566  * @return_flags:       Command return flags, kernel → userspace
 567  * @msg_address:        Storage address of the kdbus_msg to send
 568  * @reply:              Storage for message reply if KDBUS_SEND_SYNC_REPLY
 569  *                      was given
 570  * @items:              Additional items for this command
 571  */
 572 struct kdbus_cmd_send {
 573         __u64 size;
 574         __u64 flags;
 575         __u64 return_flags;
 576         __u64 msg_address;
 577         struct kdbus_msg_info reply;
 578         struct kdbus_item items[0];
 579 } __attribute__((__aligned__(8)));
 580
 581 /**
 582  * enum kdbus_recv_flags - flags for de-queuing messages
 583  * @KDBUS_RECV_PEEK:            Return the next queued message without
 584  *                              actually de-queuing it, and without installing
 585  *                              any file descriptors or other resources. It is
 586  *                              usually used to determine the activating
 587  *                              connection of a bus name.
 588  * @KDBUS_RECV_DROP:            Drop and free the next queued message and all
 589  *                              its resources without actually receiving it.
 590  * @KDBUS_RECV_USE_PRIORITY:    Only de-queue messages with the specified or
 591  *                              higher priority (lowest values); if not set,
 592  *                              the priority value is ignored.
 593  */
 594 enum kdbus_recv_flags {
 595         KDBUS_RECV_PEEK         = 1ULL <<  0,
 596         KDBUS_RECV_DROP         = 1ULL <<  1,
 597         KDBUS_RECV_USE_PRIORITY = 1ULL <<  2,
 598 };
 599
 600 /**
 601  * enum kdbus_recv_return_flags - return flags for message receive commands
 602  * @KDBUS_RECV_RETURN_INCOMPLETE_FDS:   One or more file descriptors could not
 603  *                                      be installed. These descriptors in
 604  *                                      KDBUS_ITEM_FDS will carry the value -1.
 605  * @KDBUS_RECV_RETURN_DROPPED_MSGS:     There have been dropped messages since
 606  *                                      the last time a message was received.
 607  *                                      The 'dropped_msgs' counter contains the
 608  *                                      number of messages dropped pool
 609  *                                      overflows or other missed broadcasts.
 610  */
 611 enum kdbus_recv_return_flags {
 612         KDBUS_RECV_RETURN_INCOMPLETE_FDS        = 1ULL <<  0,
 613         KDBUS_RECV_RETURN_DROPPED_MSGS          = 1ULL <<  1,
 614 };
 615
 616 /**
 617  * struct kdbus_cmd_recv - struct to de-queue a buffered message
 618  * @size:               Overall size of this object
 619  * @flags:              KDBUS_RECV_* flags, userspace → kernel
 620  * @return_flags:       Command return flags, kernel → userspace
 621  * @priority:           Minimum priority of the messages to de-queue. Lowest
 622  *                      values have the highest priority.
 623  * @dropped_msgs:       In case there were any dropped messages since the last
 624  *                      time a message was received, this will be set to the
 625  *                      number of lost messages and
 626  *                      KDBUS_RECV_RETURN_DROPPED_MSGS will be set in
 627  *                      'return_flags'. This can only happen if the ioctl
 628  *                      returns 0 or EAGAIN.
 629  * @msg:                Return storage for received message.
 630  * @items:              Additional items for this command.
 631  *
 632  * This struct is used with the KDBUS_CMD_RECV ioctl.
 633  */
 634 struct kdbus_cmd_recv {
 635         __u64 size;
 636         __u64 flags;
 637         __u64 return_flags;
 638         __s64 priority;
 639         __u64 dropped_msgs;
 640         struct kdbus_msg_info msg;
 641         struct kdbus_item items[0];
 642 } __attribute__((__aligned__(8)));
 643
 644 /**
 645  * struct kdbus_cmd_free - struct to free a slice of memory in the pool
 646  * @size:               Overall size of this structure
 647  * @flags:              Flags for the free command, userspace → kernel
 648  * @return_flags:       Command return flags, kernel → userspace
 649  * @offset:             The offset of the memory slice, as returned by other
 650  *                      ioctls
 651  * @items:              Additional items to modify the behavior
 652  *
 653  * This struct is used with the KDBUS_CMD_FREE ioctl.
 654  */
 655 struct kdbus_cmd_free {
 656         __u64 size;
 657         __u64 flags;
 658         __u64 return_flags;
 659         __u64 offset;
 660         struct kdbus_item items[0];
 661 } __attribute__((__aligned__(8)));
 662
 663 /**
 664  * enum kdbus_hello_flags - flags for struct kdbus_cmd_hello
 665  * @KDBUS_HELLO_ACCEPT_FD:      The connection allows the reception of
 666  *                              any passed file descriptors
 667  * @KDBUS_HELLO_ACTIVATOR:      Special-purpose connection which registers
 668  *                              a well-know name for a process to be started
 669  *                              when traffic arrives
 670  * @KDBUS_HELLO_POLICY_HOLDER:  Special-purpose connection which registers
 671  *                              policy entries for a name. The provided name
 672  *                              is not activated and not registered with the
 673  *                              name database, it only allows unprivileged
 674  *                              connections to acquire a name, talk or discover
 675  *                              a service
 676  * @KDBUS_HELLO_MONITOR:        Special-purpose connection to monitor
 677  *                              bus traffic
 678  */
 679 enum kdbus_hello_flags {
 680         KDBUS_HELLO_ACCEPT_FD           =  1ULL <<  0,
 681         KDBUS_HELLO_ACTIVATOR           =  1ULL <<  1,
 682         KDBUS_HELLO_POLICY_HOLDER       =  1ULL <<  2,
 683         KDBUS_HELLO_MONITOR             =  1ULL <<  3,
 684 };
 685
 686 /**
 687  * struct kdbus_cmd_hello - struct to say hello to kdbus
 688  * @size:               The total size of the structure
 689  * @flags:              Connection flags (KDBUS_HELLO_*), userspace → kernel
 690  * @return_flags:       Command return flags, kernel → userspace
 691  * @attach_flags_send:  Mask of metadata to attach to each message sent
 692  *                      off by this connection (KDBUS_ATTACH_*)
 693  * @attach_flags_recv:  Mask of metadata to attach to each message receieved
 694  *                      by the new connection (KDBUS_ATTACH_*)
 695  * @bus_flags:          The flags field copied verbatim from the original
 696  *                      KDBUS_CMD_BUS_MAKE ioctl. It's intended to be useful
 697  *                      to do negotiation of features of the payload that is
 698  *                      transferred (kernel → userspace)
 699  * @id:                 The ID of this connection (kernel → userspace)
 700  * @pool_size:          Size of the connection's buffer where the received
 701  *                      messages are placed
 702  * @offset:             Pool offset where additional items of type
 703  *                      kdbus_item_list are stored. They contain information
 704  *                      about the bus and the newly created connection.
 705  * @items_size:         Copy of item_list.size stored in @offset.
 706  * @id128:              Unique 128-bit ID of the bus (kernel → userspace)
 707  * @items:              A list of items
 708  *
 709  * This struct is used with the KDBUS_CMD_HELLO ioctl.
 710  */
 711 struct kdbus_cmd_hello {
 712         __u64 size;
 713         __u64 flags;
 714         __u64 return_flags;
 715         __u64 attach_flags_send;
 716         __u64 attach_flags_recv;
 717         __u64 bus_flags;
 718         __u64 id;
 719         __u64 pool_size;
 720         __u64 offset;
 721         __u64 items_size;
 722         __u8 id128[16];
 723         struct kdbus_item items[0];
 724 } __attribute__((__aligned__(8)));
 725
 726 /**
 727  * struct kdbus_info - connection information
 728  * @size:               total size of the struct
 729  * @id:                 64bit object ID
 730  * @flags:              object creation flags
 731  * @items:              list of items
 732  *
 733  * Note that the user is responsible for freeing the allocated memory with
 734  * the KDBUS_CMD_FREE ioctl.
 735  */
 736 struct kdbus_info {
 737         __u64 size;
 738         __u64 id;
 739         __u64 flags;
 740         struct kdbus_item items[0];
 741 } __attribute__((__aligned__(8)));
 742
 743 /**
 744  * enum kdbus_list_flags - what to include into the returned list
 745  * @KDBUS_LIST_UNIQUE:          active connections
 746  * @KDBUS_LIST_ACTIVATORS:      activator connections
 747  * @KDBUS_LIST_NAMES:           known well-known names
 748  * @KDBUS_LIST_QUEUED:          queued-up names
 749  */
 750 enum kdbus_list_flags {
 751         KDBUS_LIST_UNIQUE               = 1ULL <<  0,
 752         KDBUS_LIST_NAMES                = 1ULL <<  1,
 753         KDBUS_LIST_ACTIVATORS           = 1ULL <<  2,
 754         KDBUS_LIST_QUEUED               = 1ULL <<  3,
 755 };
 756
 757 /**
 758  * struct kdbus_cmd_list - list connections
 759  * @size:               overall size of this object
 760  * @flags:              flags for the query (KDBUS_LIST_*), userspace → kernel
 761  * @return_flags:       command return flags, kernel → userspace
 762  * @offset:             Offset in the caller's pool buffer where an array of
 763  *                      kdbus_info objects is stored.
 764  *                      The user must use KDBUS_CMD_FREE to free the
 765  *                      allocated memory.
 766  * @list_size:          size of returned list in bytes
 767  * @items:              Items for the command. Reserved for future use.
 768  *
 769  * This structure is used with the KDBUS_CMD_LIST ioctl.
 770  */
 771 struct kdbus_cmd_list {
 772         __u64 size;
 773         __u64 flags;
 774         __u64 return_flags;
 775         __u64 offset;
 776         __u64 list_size;
 777         struct kdbus_item items[0];
 778 } __attribute__((__aligned__(8)));
 779
 780 /**
 781  * struct kdbus_cmd_info - struct used for KDBUS_CMD_CONN_INFO ioctl
 782  * @size:               The total size of the struct
 783  * @flags:              KDBUS_ATTACH_* flags, userspace → kernel
 784  * @return_flags:       Command return flags, kernel → userspace
 785  * @id:                 The 64-bit ID of the connection. If set to zero, passing
 786  *                      @name is required. kdbus will look up the name to
 787  *                      determine the ID in this case.
 788  * @offset:             Returned offset in the caller's pool buffer where the
 789  *                      kdbus_info struct result is stored. The user must
 790  *                      use KDBUS_CMD_FREE to free the allocated memory.
 791  * @info_size:          Output buffer to report size of data at @offset.
 792  * @items:              The optional item list, containing the
 793  *                      well-known name to look up as a KDBUS_ITEM_NAME.
 794  *                      Only needed in case @id is zero.
 795  *
 796  * On success, the KDBUS_CMD_CONN_INFO ioctl will return 0 and @offset will
 797  * tell the user the offset in the connection pool buffer at which to find the
 798  * result in a struct kdbus_info.
 799  */
 800 struct kdbus_cmd_info {
 801         __u64 size;
 802         __u64 flags;
 803         __u64 return_flags;
 804         __u64 id;
 805         __u64 offset;
 806         __u64 info_size;
 807         struct kdbus_item items[0];
 808 } __attribute__((__aligned__(8)));
 809
 810 /**
 811  * enum kdbus_cmd_match_flags - flags to control the KDBUS_CMD_MATCH_ADD ioctl
 812  * @KDBUS_MATCH_REPLACE:        If entries with the supplied cookie already
 813  *                              exists, remove them before installing the new
 814  *                              matches.
 815  */
 816 enum kdbus_cmd_match_flags {
 817         KDBUS_MATCH_REPLACE     = 1ULL <<  0,
 818 };
 819
 820 /**
 821  * struct kdbus_cmd_match - struct to add or remove matches
 822  * @size:               The total size of the struct
 823  * @flags:              Flags for match command (KDBUS_MATCH_*),
 824  *                      userspace → kernel
 825  * @return_flags:       Command return flags, kernel → userspace
 826  * @cookie:             Userspace supplied cookie. When removing, the cookie
 827  *                      identifies the match to remove
 828  * @items:              A list of items for additional information
 829  *
 830  * This structure is used with the KDBUS_CMD_MATCH_ADD and
 831  * KDBUS_CMD_MATCH_REMOVE ioctl.
 832  */
 833 struct kdbus_cmd_match {
 834         __u64 size;
 835         __u64 flags;
 836         __u64 return_flags;
 837         __u64 cookie;
 838         struct kdbus_item items[0];
 839 } __attribute__((__aligned__(8)));
 840
 841 /**
 842  * enum kdbus_make_flags - Flags for KDBUS_CMD_{BUS,ENDPOINT}_MAKE
 843  * @KDBUS_MAKE_ACCESS_GROUP:    Make the bus or endpoint node group-accessible
 844  * @KDBUS_MAKE_ACCESS_WORLD:    Make the bus or endpoint node world-accessible
 845  */
 846 enum kdbus_make_flags {
 847         KDBUS_MAKE_ACCESS_GROUP         = 1ULL <<  0,
 848         KDBUS_MAKE_ACCESS_WORLD         = 1ULL <<  1,
 849 };
 850
 851 /**
 852  * enum kdbus_name_flags - flags for KDBUS_CMD_NAME_ACQUIRE
 853  * @KDBUS_NAME_REPLACE_EXISTING:        Try to replace name of other connections
 854  * @KDBUS_NAME_ALLOW_REPLACEMENT:       Allow the replacement of the name
 855  * @KDBUS_NAME_QUEUE:                   Name should be queued if busy
 856  * @KDBUS_NAME_IN_QUEUE:                Name is queued
 857  * @KDBUS_NAME_ACTIVATOR:               Name is owned by a activator connection
 858  */
 859 enum kdbus_name_flags {
 860         KDBUS_NAME_REPLACE_EXISTING     = 1ULL <<  0,
 861         KDBUS_NAME_ALLOW_REPLACEMENT    = 1ULL <<  1,
 862         KDBUS_NAME_QUEUE                = 1ULL <<  2,
 863         KDBUS_NAME_IN_QUEUE             = 1ULL <<  3,
 864         KDBUS_NAME_ACTIVATOR            = 1ULL <<  4,
 865 };
 866
 867 /**
 868  * struct kdbus_cmd - generic ioctl payload
 869  * @size:               Overall size of this structure
 870  * @flags:              Flags for this ioctl, userspace → kernel
 871  * @return_flags:       Ioctl return flags, kernel → userspace
 872  * @items:              Additional items to modify the behavior
 873  *
 874  * This is a generic ioctl payload object. It's used by all ioctls that only
 875  * take flags and items as input.
 876  */
 877 struct kdbus_cmd {
 878         __u64 size;
 879         __u64 flags;
 880         __u64 return_flags;
 881         struct kdbus_item items[0];
 882 } __attribute__((__aligned__(8)));
 883
 884 /**
 885  * Ioctl API
 886  *
 887  * KDBUS_CMD_BUS_MAKE:          After opening the "control" node, this command
 888  *                              creates a new bus with the specified
 889  *                              name. The bus is immediately shut down and
 890  *                              cleaned up when the opened file descriptor is
 891  *                              closed.
 892  *
 893  * KDBUS_CMD_ENDPOINT_MAKE:     Creates a new named special endpoint to talk to
 894  *                              the bus. Such endpoints usually carry a more
 895  *                              restrictive policy and grant restricted access
 896  *                              to specific applications.
 897  * KDBUS_CMD_ENDPOINT_UPDATE:   Update the properties of a custom enpoint. Used
 898  *                              to update the policy.
 899  *
 900  * KDBUS_CMD_HELLO:             By opening the bus node, a connection is
 901  *                              created. After a HELLO the opened connection
 902  *                              becomes an active peer on the bus.
 903  * KDBUS_CMD_UPDATE:            Update the properties of a connection. Used to
 904  *                              update the metadata subscription mask and
 905  *                              policy.
 906  * KDBUS_CMD_BYEBYE:            Disconnect a connection. If there are no
 907  *                              messages queued up in the connection's pool,
 908  *                              the call succeeds, and the handle is rendered
 909  *                              unusable. Otherwise, -EBUSY is returned without
 910  *                              any further side-effects.
 911  * KDBUS_CMD_FREE:              Release the allocated memory in the receiver's
 912  *                              pool.
 913  * KDBUS_CMD_CONN_INFO:         Retrieve credentials and properties of the
 914  *                              initial creator of the connection. The data was
 915  *                              stored at registration time and does not
 916  *                              necessarily represent the connected process or
 917  *                              the actual state of the process.
 918  * KDBUS_CMD_BUS_CREATOR_INFO:  Retrieve information of the creator of the bus
 919  *                              a connection is attached to.
 920  *
 921  * KDBUS_CMD_SEND:              Send a message and pass data from userspace to
 922  *                              the kernel.
 923  * KDBUS_CMD_RECV:              Receive a message from the kernel which is
 924  *                              placed in the receiver's pool.
 925  *
 926  * KDBUS_CMD_NAME_ACQUIRE:      Request a well-known bus name to associate with
 927  *                              the connection. Well-known names are used to
 928  *                              address a peer on the bus.
 929  * KDBUS_CMD_NAME_RELEASE:      Release a well-known name the connection
 930  *                              currently owns.
 931  * KDBUS_CMD_LIST:              Retrieve the list of all currently registered
 932  *                              well-known and unique names.
 933  *
 934  * KDBUS_CMD_MATCH_ADD:         Install a match which broadcast messages should
 935  *                              be delivered to the connection.
 936  * KDBUS_CMD_MATCH_REMOVE:      Remove a current match for broadcast messages.
 937  */
 938 enum kdbus_ioctl_type {
 939         /* bus owner (00-0f) */
 940         KDBUS_CMD_BUS_MAKE =            _IOW(KDBUS_IOCTL_MAGIC, 0x00,
 941                                              struct kdbus_cmd),
 942
 943         /* endpoint owner (10-1f) */
 944         KDBUS_CMD_ENDPOINT_MAKE =       _IOW(KDBUS_IOCTL_MAGIC, 0x10,
 945                                              struct kdbus_cmd),
 946         KDBUS_CMD_ENDPOINT_UPDATE =     _IOW(KDBUS_IOCTL_MAGIC, 0x11,
 947                                              struct kdbus_cmd),
 948
 949         /* connection owner (80-ff) */
 950         KDBUS_CMD_HELLO =               _IOWR(KDBUS_IOCTL_MAGIC, 0x80,
 951                                               struct kdbus_cmd_hello),
 952         KDBUS_CMD_UPDATE =              _IOW(KDBUS_IOCTL_MAGIC, 0x81,
 953                                              struct kdbus_cmd),
 954         KDBUS_CMD_BYEBYE =              _IOW(KDBUS_IOCTL_MAGIC, 0x82,
 955                                              struct kdbus_cmd),
 956         KDBUS_CMD_FREE =                _IOW(KDBUS_IOCTL_MAGIC, 0x83,
 957                                              struct kdbus_cmd_free),
 958         KDBUS_CMD_CONN_INFO =           _IOR(KDBUS_IOCTL_MAGIC, 0x84,
 959                                              struct kdbus_cmd_info),
 960         KDBUS_CMD_BUS_CREATOR_INFO =    _IOR(KDBUS_IOCTL_MAGIC, 0x85,
 961                                              struct kdbus_cmd_info),
 962         KDBUS_CMD_LIST =                _IOR(KDBUS_IOCTL_MAGIC, 0x86,
 963                                              struct kdbus_cmd_list),
 964
 965         KDBUS_CMD_SEND =                _IOW(KDBUS_IOCTL_MAGIC, 0x90,
 966                                              struct kdbus_cmd_send),
 967         KDBUS_CMD_RECV =                _IOR(KDBUS_IOCTL_MAGIC, 0x91,
 968                                              struct kdbus_cmd_recv),
 969
 970         KDBUS_CMD_NAME_ACQUIRE =        _IOW(KDBUS_IOCTL_MAGIC, 0xa0,
 971                                              struct kdbus_cmd),
 972         KDBUS_CMD_NAME_RELEASE =        _IOW(KDBUS_IOCTL_MAGIC, 0xa1,
 973                                              struct kdbus_cmd),
 974
 975         KDBUS_CMD_MATCH_ADD =           _IOW(KDBUS_IOCTL_MAGIC, 0xb0,
 976                                              struct kdbus_cmd_match),
 977         KDBUS_CMD_MATCH_REMOVE =        _IOW(KDBUS_IOCTL_MAGIC, 0xb1,
 978                                              struct kdbus_cmd_match),
 979 };
 980
 981 #endif /* _KDBUS_UAPI_H_ */