src/libsystemd/sd-bus/kdbus.h

   1 /*
   2  * Copyright (C) 2013-2014 Kay Sievers
   3  * Copyright (C) 2013-2014 Greg Kroah-Hartman <gregkh@linuxfoundation.org>
   4  * Copyright (C) 2013-2014 Linux Foundation
   5  * Copyright (C) 2013-2014 Lennart Poettering
   6  * Copyright (C) 2013-2014 Daniel Mack <daniel@zonque.org>
   7  * Copyright (C) 2013-2014 David Herrmann <dh.herrmann@gmail.com>
   8  *
   9  * kdbus is free software; you can redistribute it and/or modify it under
  10  * the terms of the GNU Lesser General Public License as published by the
  11  * Free Software Foundation; either version 2.1 of the License, or (at
  12  * your option) any later version.
  13  *
  14  * "Everything should be made as simple as possible, but not simpler."
  15  *   -- Albert Einstein
  16  */
  17
  18 #ifndef _KDBUS_UAPI_H_
  19 #define _KDBUS_UAPI_H_
  20
  21 #include <linux/ioctl.h>
  22 #include <linux/types.h>
  23
  24 #define KDBUS_IOCTL_MAGIC               0x95
  25 #define KDBUS_SRC_ID_KERNEL             (0)
  26 #define KDBUS_DST_ID_NAME               (0)
  27 #define KDBUS_MATCH_ID_ANY              (~0ULL)
  28 #define KDBUS_DST_ID_BROADCAST          (~0ULL)
  29
  30 /**
  31  * struct kdbus_notify_id_change - name registry change message
  32  * @id:                 New or former owner of the name
  33  * @flags:              flags field from KDBUS_HELLO_*
  34  *
  35  * Sent from kernel to userspace when the owner or activator of
  36  * a well-known name changes.
  37  *
  38  * Attached to:
  39  *   KDBUS_ITEM_ID_ADD
  40  *   KDBUS_ITEM_ID_REMOVE
  41  */
  42 struct kdbus_notify_id_change {
  43         __u64 id;
  44         __u64 flags;
  45 };
  46
  47 /**
  48  * struct kdbus_notify_name_change - name registry change message
  49  * @old_id:             ID and flags of former owner of a name
  50  * @new_id:             ID and flags of new owner of a name
  51  * @name:               Well-known name
  52  *
  53  * Sent from kernel to userspace when the owner or activator of
  54  * a well-known name changes.
  55  *
  56  * Attached to:
  57  *   KDBUS_ITEM_NAME_ADD
  58  *   KDBUS_ITEM_NAME_REMOVE
  59  *   KDBUS_ITEM_NAME_CHANGE
  60  */
  61 struct kdbus_notify_name_change {
  62         struct kdbus_notify_id_change old_id;
  63         struct kdbus_notify_id_change new_id;
  64         char name[0];
  65 };
  66
  67 /**
  68  * struct kdbus_creds - process credentials
  69  * @uid:                User ID
  70  * @gid:                Group ID
  71  * @pid:                Process ID
  72  * @tid:                Thread ID
  73  * @starttime:          Starttime of the process
  74  *
  75  * The starttime of the process PID. This is useful to detect PID overruns
  76  * from the client side. i.e. if you use the PID to look something up in
  77  * /proc/$PID/ you can afterwards check the starttime field of it, to ensure
  78  * you didn't run into a PID overrun.
  79  *
  80  * Attached to:
  81  *   KDBUS_ITEM_CREDS
  82  */
  83 struct kdbus_creds {
  84         __u64 uid;
  85         __u64 gid;
  86         __u64 pid;
  87         __u64 tid;
  88         __u64 starttime;
  89 };
  90
  91 /**
  92  * struct kdbus_audit - audit information
  93  * @sessionid:          The audit session ID
  94  * @loginuid:           The audit login uid
  95  *
  96  * Attached to:
  97  *   KDBUS_ITEM_AUDIT
  98  */
  99 struct kdbus_audit {
 100         __u64 sessionid;
 101         __u64 loginuid;
 102 };
 103
 104 /**
 105  * struct kdbus_timestamp
 106  * @seqnum:             Global per-domain message sequence number
 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 seqnum;
 115         __u64 monotonic_ns;
 116         __u64 realtime_ns;
 117 };
 118
 119 /**
 120  * struct kdbus_vec - I/O vector for kdbus payload items
 121  * @size:               The size of the vector
 122  * @address:            Memory address of data buffer
 123  * @offset:             Offset in the in-message payload memory,
 124  *                      relative to the message head
 125  *
 126  * Attached to:
 127  *   KDBUS_ITEM_PAYLOAD_VEC, KDBUS_ITEM_PAYLOAD_OFF
 128  */
 129 struct kdbus_vec {
 130         __u64 size;
 131         union {
 132                 __u64 address;
 133                 __u64 offset;
 134         };
 135 };
 136
 137 /**
 138  * struct kdbus_bloom_parameter - bus-wide bloom parameters
 139  * @size:               Size of the bit field in bytes (m / 8)
 140  * @n_hash:             Number of hash functions used (k)
 141  */
 142 struct kdbus_bloom_parameter {
 143         __u64 size;
 144         __u64 n_hash;
 145 };
 146
 147 /**
 148  * struct kdbus_bloom_filter - bloom filter containing n elements
 149  * @generation:         Generation of the element set in the filter
 150  * @data:               Bit field, multiple of 8 bytes
 151  */
 152 struct kdbus_bloom_filter {
 153         __u64 generation;
 154         __u64 data[0];
 155 };
 156
 157 /**
 158  * struct kdbus_memfd - a kdbus memfd
 159  * @size:               The memfd's size
 160  * @fd:                 The file descriptor number
 161  * @__pad:              Padding to ensure proper alignment and size
 162  *
 163  * Attached to:
 164  *   KDBUS_ITEM_PAYLOAD_MEMFD
 165  */
 166 struct kdbus_memfd {
 167         __u64 size;
 168         int fd;
 169         __u32 __pad;
 170 };
 171
 172 /**
 173  * struct kdbus_name - a registered well-known name with its flags
 174  * @flags:              Flags from KDBUS_NAME_*
 175  * @name:               Well-known name
 176  *
 177  * Attached to:
 178  *   KDBUS_ITEM_NAME
 179  */
 180 struct kdbus_name {
 181         __u64 flags;
 182         char name[0];
 183 };
 184
 185 /**
 186  * struct kdbus_policy_access - policy access item
 187  * @type:               One of KDBUS_POLICY_ACCESS_* types
 188  * @access:             Access to grant
 189  * @id:                 For KDBUS_POLICY_ACCESS_USER, the uid
 190  *                      For KDBUS_POLICY_ACCESS_GROUP, the gid
 191  */
 192 struct kdbus_policy_access {
 193         __u64 type;     /* USER, GROUP, WORLD */
 194         __u64 access;   /* OWN, TALK, SEE */
 195         __u64 id;       /* uid, gid, 0 */
 196 };
 197
 198 /**
 199  * enum kdbus_item_type - item types to chain data in a list
 200  * @_KDBUS_ITEM_NULL:           Uninitialized/invalid
 201  * @_KDBUS_ITEM_USER_BASE:      Start of user items
 202  * @KDBUS_ITEM_PAYLOAD_VEC:     Vector to data
 203  * @KDBUS_ITEM_PAYLOAD_OFF:     Data at returned offset to message head
 204  * @KDBUS_ITEM_PAYLOAD_MEMFD:   Data as sealed memfd
 205  * @KDBUS_ITEM_FDS:             Attached file descriptors
 206  * @KDBUS_ITEM_BLOOM_PARAMETER: Bus-wide bloom parameters, used with
 207  *                              KDBUS_CMD_BUS_MAKE, carries a
 208  *                              struct kdbus_bloom_parameter
 209  * @KDBUS_ITEM_BLOOM_FILTER:    Bloom filter carried with a message, used to
 210  *                              match against a bloom mask of a connection,
 211  *                              carries a struct kdbus_bloom_filter
 212  * @KDBUS_ITEM_BLOOM_MASK:      Bloom mask used to match against a message's
 213  *                              bloom filter
 214  * @KDBUS_ITEM_DST_NAME:        Destination's well-known name
 215  * @KDBUS_ITEM_MAKE_NAME:       Name of domain, bus, endpoint
 216  * @KDBUS_ITEM_ATTACH_FLAGS:    Attach-flags, used for updating which metadata
 217  *                              a connection subscribes to
 218  * @_KDBUS_ITEM_ATTACH_BASE:    Start of metadata attach items
 219  * @KDBUS_ITEM_NAME:            Well-know name with flags
 220  * @KDBUS_ITEM_ID:              Connection ID
 221  * @KDBUS_ITEM_TIMESTAMP:       Timestamp
 222  * @KDBUS_ITEM_CREDS:           Process credential
 223  * @KDBUS_ITEM_AUXGROUPS:       Auxiliary process groups
 224  * @KDBUS_ITEM_PID_COMM:        Process ID "comm" identifier
 225  * @KDBUS_ITEM_TID_COMM:        Thread ID "comm" identifier
 226  * @KDBUS_ITEM_EXE:             The path of the executable
 227  * @KDBUS_ITEM_CMDLINE:         The process command line
 228  * @KDBUS_ITEM_CGROUP:          The croup membership
 229  * @KDBUS_ITEM_CAPS:            The process capabilities
 230  * @KDBUS_ITEM_SECLABEL:        The security label
 231  * @KDBUS_ITEM_AUDIT:           The audit IDs
 232  * @KDBUS_ITEM_CONN_NAME:       The connection's human-readable name (debugging)
 233  * @_KDBUS_ITEM_POLICY_BASE:    Start of policy items
 234  * @KDBUS_ITEM_POLICY_ACCESS:   Policy access block
 235  * @_KDBUS_ITEM_KERNEL_BASE:    Start of kernel-generated message items
 236  * @KDBUS_ITEM_NAME_ADD:        Notify in struct kdbus_notify_name_change
 237  * @KDBUS_ITEM_NAME_REMOVE:     Notify in struct kdbus_notify_name_change
 238  * @KDBUS_ITEM_NAME_CHANGE:     Notify in struct kdbus_notify_name_change
 239  * @KDBUS_ITEM_ID_ADD:          Notify in struct kdbus_notify_id_change
 240  * @KDBUS_ITEM_ID_REMOVE:       Notify in struct kdbus_notify_id_change
 241  * @KDBUS_ITEM_REPLY_TIMEOUT:   Timeout has been reached
 242  * @KDBUS_ITEM_REPLY_DEAD:      Destination died
 243  */
 244 enum kdbus_item_type {
 245         _KDBUS_ITEM_NULL,
 246         _KDBUS_ITEM_USER_BASE,
 247         KDBUS_ITEM_PAYLOAD_VEC  = _KDBUS_ITEM_USER_BASE,
 248         KDBUS_ITEM_PAYLOAD_OFF,
 249         KDBUS_ITEM_PAYLOAD_MEMFD,
 250         KDBUS_ITEM_FDS,
 251         KDBUS_ITEM_BLOOM_PARAMETER,
 252         KDBUS_ITEM_BLOOM_FILTER,
 253         KDBUS_ITEM_BLOOM_MASK,
 254         KDBUS_ITEM_DST_NAME,
 255         KDBUS_ITEM_MAKE_NAME,
 256         KDBUS_ITEM_ATTACH_FLAGS,
 257
 258         _KDBUS_ITEM_ATTACH_BASE = 0x1000,
 259         KDBUS_ITEM_NAME         = _KDBUS_ITEM_ATTACH_BASE,
 260         KDBUS_ITEM_ID,
 261         KDBUS_ITEM_TIMESTAMP,
 262         KDBUS_ITEM_CREDS,
 263         KDBUS_ITEM_AUXGROUPS,
 264         KDBUS_ITEM_PID_COMM,
 265         KDBUS_ITEM_TID_COMM,
 266         KDBUS_ITEM_EXE,
 267         KDBUS_ITEM_CMDLINE,
 268         KDBUS_ITEM_CGROUP,
 269         KDBUS_ITEM_CAPS,
 270         KDBUS_ITEM_SECLABEL,
 271         KDBUS_ITEM_AUDIT,
 272         KDBUS_ITEM_CONN_NAME,
 273
 274         _KDBUS_ITEM_POLICY_BASE = 0x2000,
 275         KDBUS_ITEM_POLICY_ACCESS = _KDBUS_ITEM_POLICY_BASE,
 276
 277         _KDBUS_ITEM_KERNEL_BASE = 0x8000,
 278         KDBUS_ITEM_NAME_ADD     = _KDBUS_ITEM_KERNEL_BASE,
 279         KDBUS_ITEM_NAME_REMOVE,
 280         KDBUS_ITEM_NAME_CHANGE,
 281         KDBUS_ITEM_ID_ADD,
 282         KDBUS_ITEM_ID_REMOVE,
 283         KDBUS_ITEM_REPLY_TIMEOUT,
 284         KDBUS_ITEM_REPLY_DEAD,
 285 };
 286
 287 /**
 288  * struct kdbus_item - chain of data blocks
 289  * @size:               Overall data record size
 290  * @type:               Kdbus_item type of data
 291  * @data:               Generic bytes
 292  * @data32:             Generic 32 bit array
 293  * @data64:             Generic 64 bit array
 294  * @str:                Generic string
 295  * @id:                 Connection ID
 296  * @vec:                KDBUS_ITEM_PAYLOAD_VEC
 297  * @creds:              KDBUS_ITEM_CREDS
 298  * @audit:              KDBUS_ITEM_AUDIT
 299  * @timestamp:          KDBUS_ITEM_TIMESTAMP
 300  * @name:               KDBUS_ITEM_NAME
 301  * @bloom_parameter:    KDBUS_ITEM_BLOOM_PARAMETER
 302  * @bloom_filter:       KDBUS_ITEM_BLOOM_FILTER
 303  * @memfd:              KDBUS_ITEM_PAYLOAD_MEMFD
 304  * @name_change:        KDBUS_ITEM_NAME_ADD
 305  *                      KDBUS_ITEM_NAME_REMOVE
 306  *                      KDBUS_ITEM_NAME_CHANGE
 307  * @id_change:          KDBUS_ITEM_ID_ADD
 308  *                      KDBUS_ITEM_ID_REMOVE
 309  * @policy:             KDBUS_ITEM_POLICY_ACCESS
 310  */
 311 struct kdbus_item {
 312         __u64 size;
 313         __u64 type;
 314         union {
 315                 __u8 data[0];
 316                 __u32 data32[0];
 317                 __u64 data64[0];
 318                 char str[0];
 319
 320                 __u64 id;
 321                 struct kdbus_vec vec;
 322                 struct kdbus_creds creds;
 323                 struct kdbus_audit audit;
 324                 struct kdbus_timestamp timestamp;
 325                 struct kdbus_name name;
 326                 struct kdbus_bloom_parameter bloom_parameter;
 327                 struct kdbus_bloom_filter bloom_filter;
 328                 struct kdbus_memfd memfd;
 329                 int fds[0];
 330                 struct kdbus_notify_name_change name_change;
 331                 struct kdbus_notify_id_change id_change;
 332                 struct kdbus_policy_access policy_access;
 333         };
 334 };
 335
 336 /**
 337  * enum kdbus_msg_flags - type of message
 338  * @KDBUS_MSG_FLAGS_EXPECT_REPLY:       Expect a reply message, used for
 339  *                                      method calls. The userspace-supplied
 340  *                                      cookie identifies the message and the
 341  *                                      respective reply carries the cookie
 342  *                                      in cookie_reply
 343  * @KDBUS_MSG_FLAGS_SYNC_REPLY:         Wait for destination connection to
 344  *                                      reply to this message. The
 345  *                                      KDBUS_CMD_MSG_SEND ioctl() will block
 346  *                                      until the reply is received, and
 347  *                                      offset_reply in struct kdbus_msg will
 348  *                                      yield the offset in the sender's pool
 349  *                                      where the reply can be found.
 350  *                                      This flag is only valid if
 351  *                                      @KDBUS_MSG_FLAGS_EXPECT_REPLY is set as
 352  *                                      well.
 353  * @KDBUS_MSG_FLAGS_NO_AUTO_START:      Do not start a service, if the addressed
 354  *                                      name is not currently active
 355  */
 356 enum kdbus_msg_flags {
 357         KDBUS_MSG_FLAGS_EXPECT_REPLY    = 1ULL << 0,
 358         KDBUS_MSG_FLAGS_SYNC_REPLY      = 1ULL << 1,
 359         KDBUS_MSG_FLAGS_NO_AUTO_START   = 1ULL << 2,
 360 };
 361
 362 /**
 363  * enum kdbus_payload_type - type of payload carried by message
 364  * @KDBUS_PAYLOAD_KERNEL:       Kernel-generated simple message
 365  * @KDBUS_PAYLOAD_DBUS:         D-Bus marshalling "DBusDBus"
 366  */
 367 enum kdbus_payload_type {
 368         KDBUS_PAYLOAD_KERNEL,
 369         KDBUS_PAYLOAD_DBUS      = 0x4442757344427573ULL,
 370 };
 371
 372 /**
 373  * struct kdbus_msg - the representation of a kdbus message
 374  * @size:               Total size of the message
 375  * @flags:              Message flags (KDBUS_MSG_FLAGS_*)
 376  * @priority:           Message queue priority value
 377  * @dst_id:             64-bit ID of the destination connection
 378  * @src_id:             64-bit ID of the source connection
 379  * @payload_type:       Payload type (KDBUS_PAYLOAD_*)
 380  * @cookie:             Userspace-supplied cookie, for the connection
 381  *                      to identify its messages
 382  * @timeout_ns:         The time to wait for a message reply from the peer.
 383  *                      If there is no reply, a kernel-generated message
 384  *                      with an attached KDBUS_ITEM_REPLY_TIMEOUT item
 385  *                      is sent to @src_id.
 386  * @cookie_reply:       A reply to the requesting message with the same
 387  *                      cookie. The requesting connection can match its
 388  *                      request and the reply with this value
 389  * @offset_reply:       If KDBUS_MSG_FLAGS_EXPECT_REPLY, this field will
 390  *                      contain the offset in the sender's pool where the
 391  *                      reply is stored.
 392  * @items:              A list of kdbus_items containing the message payload
 393  */
 394 struct kdbus_msg {
 395         __u64 size;
 396         __u64 flags;
 397         __s64 priority;
 398         __u64 dst_id;
 399         __u64 src_id;
 400         __u64 payload_type;
 401         __u64 cookie;
 402         union {
 403                 __u64 timeout_ns;
 404                 __u64 cookie_reply;
 405                 __u64 offset_reply;
 406         };
 407         struct kdbus_item items[0];
 408 } __attribute__((aligned(8)));
 409
 410 /**
 411  * enum kdbus_recv_flags - flags for de-queuing messages
 412  * @KDBUS_RECV_PEEK:            Return the next queued message without
 413  *                              actually de-queuing it, and without installing
 414  *                              any file descriptors or other resources. It is
 415  *                              usually used to determine the activating
 416  *                              connection of a bus name.
 417  * @KDBUS_RECV_DROP:            Drop and free the next queued message and all
 418  *                              its resources without actually receiving it.
 419  * @KDBUS_RECV_USE_PRIORITY:    Only de-queue messages with the specified or
 420  *                              higher priority (lowest values); if not set,
 421  *                              the priority value is ignored.
 422  */
 423 enum kdbus_recv_flags {
 424         KDBUS_RECV_PEEK         = 1ULL <<  0,
 425         KDBUS_RECV_DROP         = 1ULL <<  1,
 426         KDBUS_RECV_USE_PRIORITY = 1ULL <<  2,
 427 };
 428
 429 /**
 430  * struct kdbus_cmd_recv - struct to de-queue a buffered message
 431  * @flags:              KDBUS_RECV_* flags
 432  * @priority:           Minimum priority of the messages to de-queue. Lowest
 433  *                      values have the highest priority.
 434  * @offset:             Returned offset in the pool where the message is
 435  *                      stored. The user must use KDBUS_CMD_FREE to free
 436  *                      the allocated memory.
 437  *
 438  * This struct is used with the KDBUS_CMD_MSG_RECV ioctl.
 439  */
 440 struct kdbus_cmd_recv {
 441         __u64 flags;
 442         __s64 priority;
 443         __u64 offset;
 444 } __attribute__((aligned(8)));
 445
 446 /**
 447  * struct kdbus_cmd_cancel - struct to cancel a synchronously pending message
 448  * @cookie              The cookie of the pending message
 449  * @flags               Flags for the free command. Currently unused.
 450  *
 451  * This struct is used with the KDBUS_CMD_CANCEL ioctl.
 452  */
 453 struct kdbus_cmd_cancel {
 454         __u64 cookie;
 455         __u64 flags;
 456 } __attribute__((aligned(8)));
 457
 458 /**
 459  * struct kdbus_cmd_free - struct to free a slice of memory in the pool
 460  * @offset              The offset of the memory slice, as returned by other
 461  *                      ioctls
 462  * @flags               Flags for the free command. Currently unused.
 463  *
 464  * This struct is used with the KDBUS_CMD_FREE ioctl.
 465  */
 466 struct kdbus_cmd_free {
 467         __u64 offset;
 468         __u64 flags;
 469 } __attribute__((aligned(8)));
 470
 471 /**
 472  * enum kdbus_policy_access_type - permissions of a policy record
 473  * @_KDBUS_POLICY_ACCESS_NULL:  Uninitialized/invalid
 474  * @KDBUS_POLICY_ACCESS_USER:   Grant access to a uid
 475  * @KDBUS_POLICY_ACCESS_GROUP:  Grant access to gid
 476  * @KDBUS_POLICY_ACCESS_WORLD:  World-accessible
 477  */
 478 enum kdbus_policy_access_type {
 479         _KDBUS_POLICY_ACCESS_NULL,
 480         KDBUS_POLICY_ACCESS_USER,
 481         KDBUS_POLICY_ACCESS_GROUP,
 482         KDBUS_POLICY_ACCESS_WORLD,
 483 };
 484
 485 /**
 486  * enum kdbus_policy_access_flags - mode flags
 487  * @KDBUS_POLICY_OWN:           Allow to own a well-known name
 488  *                              Implies KDBUS_POLICY_TALK and KDBUS_POLICY_SEE
 489  * @KDBUS_POLICY_TALK:          Allow communication to a well-known name
 490  *                              Implies KDBUS_POLICY_SEE
 491  * @KDBUS_POLICY_SEE:           Allow to see a well-known name
 492  */
 493 enum kdbus_policy_type {
 494         KDBUS_POLICY_SEE        = 0,
 495         KDBUS_POLICY_TALK,
 496         KDBUS_POLICY_OWN,
 497 };
 498
 499 /**
 500  * enum kdbus_hello_flags - flags for struct kdbus_cmd_hello
 501  * @KDBUS_HELLO_ACCEPT_FD:      The connection allows the reception of
 502  *                              any passed file descriptors
 503  * @KDBUS_HELLO_ACTIVATOR:      Special-purpose connection which registers
 504  *                              a well-know name for a process to be started
 505  *                              when traffic arrives
 506  * @KDBUS_HELLO_POLICY_HOLDER:  Special-purpose connection which registers
 507  *                              policy entries for a name. The provided name
 508  *                              is not activated and not registered with the
 509  *                              name database, it only allows unprivileged
 510  *                              connections to aquire a name, talk or discover
 511  *                              a service
 512  * @KDBUS_HELLO_MONITOR:        Special-purpose connection to monitor
 513  *                              bus traffic
 514  */
 515 enum kdbus_hello_flags {
 516         KDBUS_HELLO_ACCEPT_FD           =  1ULL <<  0,
 517         KDBUS_HELLO_ACTIVATOR           =  1ULL <<  1,
 518         KDBUS_HELLO_POLICY_HOLDER       =  1ULL <<  2,
 519         KDBUS_HELLO_MONITOR             =  1ULL <<  3,
 520 };
 521
 522 /**
 523  * enum kdbus_attach_flags - flags for metadata attachments
 524  * @KDBUS_ATTACH_TIMESTAMP:     Timestamp
 525  * @KDBUS_ATTACH_CREDS:         Credentials
 526  * @KDBUS_ATTACH_AUXGROUPS:     Auxiliary groups
 527  * @KDBUS_ATTACH_NAMES:         Well-known names
 528  * @KDBUS_ATTACH_COMM:          The "comm" process identifier
 529  * @KDBUS_ATTACH_EXE:           The path of the executable
 530  * @KDBUS_ATTACH_CMDLINE:       The process command line
 531  * @KDBUS_ATTACH_CGROUP:        The croup membership
 532  * @KDBUS_ATTACH_CAPS:          The process capabilities
 533  * @KDBUS_ATTACH_SECLABEL:      The security label
 534  * @KDBUS_ATTACH_AUDIT:         The audit IDs
 535  * @KDBUS_ATTACH_CONN_NAME:     The human-readable connection name
 536  * @_KDBUS_ATTACH_ALL:          All of the above
 537  */
 538 enum kdbus_attach_flags {
 539         KDBUS_ATTACH_TIMESTAMP          =  1ULL <<  0,
 540         KDBUS_ATTACH_CREDS              =  1ULL <<  1,
 541         KDBUS_ATTACH_AUXGROUPS          =  1ULL <<  2,
 542         KDBUS_ATTACH_NAMES              =  1ULL <<  3,
 543         KDBUS_ATTACH_COMM               =  1ULL <<  4,
 544         KDBUS_ATTACH_EXE                =  1ULL <<  5,
 545         KDBUS_ATTACH_CMDLINE            =  1ULL <<  6,
 546         KDBUS_ATTACH_CGROUP             =  1ULL <<  7,
 547         KDBUS_ATTACH_CAPS               =  1ULL <<  8,
 548         KDBUS_ATTACH_SECLABEL           =  1ULL <<  9,
 549         KDBUS_ATTACH_AUDIT              =  1ULL << 10,
 550         KDBUS_ATTACH_CONN_NAME          =  1ULL << 11,
 551         _KDBUS_ATTACH_ALL               =  (1ULL << 12) - 1,
 552 };
 553
 554 /**
 555  * struct kdbus_cmd_hello - struct to say hello to kdbus
 556  * @size:               The total size of the structure
 557  * @features:           Feature negotiation bitmask
 558  * @conn_flags:         Connection flags (KDBUS_HELLO_*).
 559  * @attach_flags:       Mask of metadata to attach to each message sent
 560  *                      (KDBUS_ATTACH_*)
 561  * @bus_flags:          The flags field copied verbatim from the original
 562  *                      KDBUS_CMD_BUS_MAKE ioctl. It's intended to be useful
 563  *                      to do negotiation of features of the payload that is
 564  *                      transferred (kernel → userspace)
 565  * @id:                 The ID of this connection (kernel → userspace)
 566  * @pool_size:          Size of the connection's buffer where the received
 567  *                      messages are placed
 568  * @bloom:              The bloom properties of the bus, specified
 569  *                      by the bus creator (kernel → userspace)
 570  * @id128:              Unique 128-bit ID of the bus (kernel → userspace)
 571  * @items:              A list of items
 572  *
 573  * This struct is used with the KDBUS_CMD_HELLO ioctl.
 574  */
 575 struct kdbus_cmd_hello {
 576         __u64 size;
 577         __u64 features;
 578         __u64 conn_flags;
 579         __u64 attach_flags;
 580         __u64 bus_flags;
 581         __u64 id;
 582         __u64 pool_size;
 583         struct kdbus_bloom_parameter bloom;
 584         __u8 id128[16];
 585         struct kdbus_item items[0];
 586 } __attribute__((aligned(8)));
 587
 588 /**
 589  * enum kdbus_make_flags - Flags for KDBUS_CMD_{BUS,EP,NS}_MAKE
 590  * @KDBUS_MAKE_ACCESS_GROUP:    Make the device node group-accessible
 591  * @KDBUS_MAKE_ACCESS_WORLD:    Make the device node world-accessible
 592  */
 593 enum kdbus_make_flags {
 594         KDBUS_MAKE_ACCESS_GROUP         = 1ULL <<  0,
 595         KDBUS_MAKE_ACCESS_WORLD         = 1ULL <<  1,
 596 };
 597
 598 /**
 599  * struct kdbus_cmd_make - struct to make a bus, an endpoint or a domain
 600  * @size:               The total size of the struct
 601  * @features:           Feature negotiation bitmask
 602  * @flags:              Properties for the bus/ep/domain to create
 603  * @items:              Items describing details
 604  *
 605  * This structure is used with the KDBUS_CMD_BUS_MAKE, KDBUS_CMD_ENDPOINT_MAKE
 606  * and KDBUS_CMD_DOMAIN_MAKE ioctls.
 607  */
 608 struct kdbus_cmd_make {
 609         __u64 size;
 610         __u64 features;
 611         __u64 flags;
 612         struct kdbus_item items[0];
 613 } __attribute__((aligned(8)));
 614
 615 /**
 616  * enum kdbus_name_flags - properties of a well-known name
 617  * @KDBUS_NAME_REPLACE_EXISTING:        Try to replace name of other connections
 618  * @KDBUS_NAME_ALLOW_REPLACEMENT:       Allow the replacement of the name
 619  * @KDBUS_NAME_QUEUE:                   Name should be queued if busy
 620  * @KDBUS_NAME_IN_QUEUE:                Name is queued
 621  * @KDBUS_NAME_ACTIVATOR:               Name is owned by a activator connection
 622  */
 623 enum kdbus_name_flags {
 624         KDBUS_NAME_REPLACE_EXISTING     = 1ULL <<  0,
 625         KDBUS_NAME_ALLOW_REPLACEMENT    = 1ULL <<  1,
 626         KDBUS_NAME_QUEUE                = 1ULL <<  2,
 627         KDBUS_NAME_IN_QUEUE             = 1ULL <<  3,
 628         KDBUS_NAME_ACTIVATOR            = 1ULL <<  4,
 629 };
 630
 631 /**
 632  * struct kdbus_cmd_name - struct to describe a well-known name
 633  * @size:               The total size of the struct
 634  * @flags:              Flags for a name entry (KDBUS_NAME_*)
 635  * @owner_id:           The current owner of the name
 636  * @conn_flags:         The flags of the owning connection (KDBUS_HELLO_*)
 637  * @items:              Item list, containing the well-known name as
 638  *                      KDBUS_ITEM_NAME
 639  *
 640  * This structure is used with the KDBUS_CMD_NAME_ACQUIRE ioctl.
 641  */
 642 struct kdbus_cmd_name {
 643         __u64 size;
 644         __u64 flags;
 645         __u64 owner_id;
 646         __u64 conn_flags;
 647         struct kdbus_item items[0];
 648 } __attribute__((aligned(8)));
 649
 650 /**
 651  * enum kdbus_name_list_flags - what to include into the returned list
 652  * @KDBUS_NAME_LIST_UNIQUE:     All active connections
 653  * @KDBUS_NAME_LIST_NAMES:      All known well-known names
 654  * @KDBUS_NAME_LIST_ACTIVATORS: All activator connections
 655  * @KDBUS_NAME_LIST_QUEUED:     All queued-up names
 656  */
 657 enum kdbus_name_list_flags {
 658         KDBUS_NAME_LIST_UNIQUE          = 1ULL <<  0,
 659         KDBUS_NAME_LIST_NAMES           = 1ULL <<  1,
 660         KDBUS_NAME_LIST_ACTIVATORS      = 1ULL <<  2,
 661         KDBUS_NAME_LIST_QUEUED          = 1ULL <<  3,
 662 };
 663
 664 /**
 665  * struct kdbus_cmd_name_list - request a list of name entries
 666  * @flags:              Flags for the query (KDBUS_NAME_LIST_*)
 667  * @offset:             The returned offset in the caller's pool buffer.
 668  *                      The user must use KDBUS_CMD_FREE to free the
 669  *                      allocated memory.
 670  *
 671  * This structure is used with the KDBUS_CMD_NAME_LIST ioctl.
 672  */
 673 struct kdbus_cmd_name_list {
 674         __u64 flags;
 675         __u64 offset;
 676 } __attribute__((aligned(8)));
 677
 678 /**
 679  * struct kdbus_name_list - information returned by KDBUS_CMD_NAME_LIST
 680  * @size:               The total size of the structure
 681  * @names:              A list of names
 682  *
 683  * Note that the user is responsible for freeing the allocated memory with
 684  * the KDBUS_CMD_FREE ioctl.
 685  */
 686 struct kdbus_name_list {
 687         __u64 size;
 688         struct kdbus_cmd_name names[0];
 689 };
 690
 691 /**
 692  * struct kdbus_cmd_conn_info - struct used for KDBUS_CMD_CONN_INFO ioctl
 693  * @size:               The total size of the struct
 694  * @flags:              KDBUS_ATTACH_* flags
 695  * @id:                 The 64-bit ID of the connection. If set to zero, passing
 696  *                      @name is required. kdbus will look up the name to
 697  *                      determine the ID in this case.
 698  * @offset:             Returned offset in the caller's pool buffer where the
 699  *                      kdbus_conn_info struct result is stored. The user must
 700  *                      use KDBUS_CMD_FREE to free the allocated memory.
 701  * @name:               The optional well-known name to look up. Only needed in
 702  *                      case @id is zero.
 703  *
 704  * On success, the KDBUS_CMD_CONN_INFO ioctl will return 0 and @offset will
 705  * tell the user the offset in the connection pool buffer at which to find the
 706  * result in a struct kdbus_conn_info.
 707  */
 708 struct kdbus_cmd_conn_info {
 709         __u64 size;
 710         __u64 flags;
 711         __u64 id;
 712         __u64 offset;
 713         struct kdbus_item items[0];
 714 } __attribute__((aligned(8)));
 715
 716 /**
 717  * struct kdbus_conn_info - information returned by KDBUS_CMD_CONN_INFO
 718  * @size:               The total size of the struct
 719  * @id:                 The connection's 64-bit ID
 720  * @flags:              The connection's flags
 721  * @items:              A list of struct kdbus_item
 722  *
 723  * Note that the user is responsible for freeing the allocated memory with
 724  * the KDBUS_CMD_FREE ioctl.
 725  */
 726 struct kdbus_conn_info {
 727         __u64 size;
 728         __u64 id;
 729         __u64 flags;
 730         struct kdbus_item items[0];
 731 };
 732
 733 /**
 734  * struct kdbus_cmd_update - update flags of a connection
 735  * @size:               The total size of the struct
 736  * @items:              A list of struct kdbus_item
 737  *
 738  * This struct is used with the KDBUS_CMD_CONN_UPDATE ioctl.
 739  */
 740 struct kdbus_cmd_update {
 741         __u64 size;
 742         __u64 flags;
 743         struct kdbus_item items[0];
 744 } __attribute__((aligned(8)));
 745
 746 /**
 747  * enum kdbus_cmd_match_flags - flags to control the KDBUS_CMD_MATCH_ADD ioctl
 748  * @KDBUS_MATCH_REPLACE:        If entries with the supplied cookie already
 749  *                              exists, remove them before installing the new
 750  *                              matches.
 751  */
 752 enum kdbus_cmd_match_flags {
 753         KDBUS_MATCH_REPLACE     = 1ULL <<  0,
 754 };
 755
 756 /**
 757  * struct kdbus_cmd_match - struct to add or remove matches
 758  * @size:               The total size of the struct
 759  * @cookie:             Userspace supplied cookie. When removing, the cookie
 760  *                      identifies the match to remove
 761  * @items:              A list of items for additional information
 762  *
 763  * This structure is used with the KDBUS_CMD_ADD_MATCH and
 764  * KDBUS_CMD_REMOVE_MATCH ioctl.
 765  */
 766 struct kdbus_cmd_match {
 767         __u64 size;
 768         __u64 cookie;
 769         __u64 flags;
 770         struct kdbus_item items[0];
 771 } __attribute__((aligned(8)));
 772
 773 /**
 774  * enum kdbus_ioctl_type - Ioctl API
 775  * @KDBUS_CMD_BUS_MAKE:         After opening the "control" device node, this
 776  *                              command creates a new bus with the specified
 777  *                              name. The bus is immediately shut down and
 778  *                              cleaned up when the opened "control" device node
 779  *                              is closed.
 780  * @KDBUS_CMD_DOMAIN_MAKE:      Similar to KDBUS_CMD_BUS_MAKE, but it creates a
 781  *                              new kdbus domain.
 782  * @KDBUS_CMD_ENDPOINT_MAKE:    Creates a new named special endpoint to talk to
 783  *                              the bus. Such endpoints usually carry a more
 784  *                              restrictive policy and grant restricted access
 785  *                              to specific applications.
 786  * @KDBUS_CMD_HELLO:            By opening the bus device node a connection is
 787  *                              created. After a HELLO the opened connection
 788  *                              becomes an active peer on the bus.
 789  * @KDBUS_CMD_BYEBYE:           Disconnect a connection. If there are no
 790  *                              messages queued up in the connection's pool,
 791  *                              the call succeeds, and the handle is rendered
 792  *                              unusable. Otherwise, -EBUSY is returned without
 793  *                              any further side-effects.
 794  * @KDBUS_CMD_MSG_SEND:         Send a message and pass data from userspace to
 795  *                              the kernel.
 796  * @KDBUS_CMD_MSG_RECV:         Receive a message from the kernel which is
 797  *                              placed in the receiver's pool.
 798  * @KDBUS_CMD_MSG_CANCEL:       Cancel a pending request of a message that
 799  *                              blocks while waiting for a reply. The parameter
 800  *                              denotes the cookie of the message in flight.
 801  * @KDBUS_CMD_FREE:             Release the allocated memory in the receiver's
 802  *                              pool.
 803  * @KDBUS_CMD_NAME_ACQUIRE:     Request a well-known bus name to associate with
 804  *                              the connection. Well-known names are used to
 805  *                              address a peer on the bus.
 806  * @KDBUS_CMD_NAME_RELEASE:     Release a well-known name the connection
 807  *                              currently owns.
 808  * @KDBUS_CMD_NAME_LIST:        Retrieve the list of all currently registered
 809  *                              well-known and unique names.
 810  * @KDBUS_CMD_CONN_INFO:        Retrieve credentials and properties of the
 811  *                              initial creator of the connection. The data was
 812  *                              stored at registration time and does not
 813  *                              necessarily represent the connected process or
 814  *                              the actual state of the process.
 815  * @KDBUS_CMD_CONN_UPDATE:      Update the properties of a connection. Used to
 816  *                              update the metadata subscription mask and
 817  *                              policy.
 818  * @KDBUS_CMD_ENDPOINT_UPDATE:  Update the properties of a custom enpoint. Used
 819  *                              to update the policy.
 820  * @KDBUS_CMD_MATCH_ADD:        Install a match which broadcast messages should
 821  *                              be delivered to the connection.
 822  * @KDBUS_CMD_MATCH_REMOVE:     Remove a current match for broadcast messages.
 823  */
 824 enum kdbus_ioctl_type {
 825         KDBUS_CMD_BUS_MAKE =            _IOW(KDBUS_IOCTL_MAGIC, 0x00,
 826                                              struct kdbus_cmd_make),
 827         KDBUS_CMD_DOMAIN_MAKE =         _IOW(KDBUS_IOCTL_MAGIC, 0x10,
 828                                              struct kdbus_cmd_make),
 829         KDBUS_CMD_ENDPOINT_MAKE =       _IOW(KDBUS_IOCTL_MAGIC, 0x20,
 830                                              struct kdbus_cmd_make),
 831
 832         KDBUS_CMD_HELLO =               _IOWR(KDBUS_IOCTL_MAGIC, 0x30,
 833                                               struct kdbus_cmd_hello),
 834         KDBUS_CMD_BYEBYE =              _IO(KDBUS_IOCTL_MAGIC, 0x31),
 835
 836         KDBUS_CMD_MSG_SEND =            _IOWR(KDBUS_IOCTL_MAGIC, 0x40,
 837                                               struct kdbus_msg),
 838         KDBUS_CMD_MSG_RECV =            _IOWR(KDBUS_IOCTL_MAGIC, 0x41,
 839                                               struct kdbus_cmd_recv),
 840         KDBUS_CMD_MSG_CANCEL =          _IOW(KDBUS_IOCTL_MAGIC, 0x42,
 841                                              struct kdbus_cmd_cancel),
 842         KDBUS_CMD_FREE =                _IOW(KDBUS_IOCTL_MAGIC, 0x43,
 843                                              struct kdbus_cmd_free),
 844
 845         KDBUS_CMD_NAME_ACQUIRE =        _IOWR(KDBUS_IOCTL_MAGIC, 0x50,
 846                                               struct kdbus_cmd_name),
 847         KDBUS_CMD_NAME_RELEASE =        _IOW(KDBUS_IOCTL_MAGIC, 0x51,
 848                                              struct kdbus_cmd_name),
 849         KDBUS_CMD_NAME_LIST =           _IOWR(KDBUS_IOCTL_MAGIC, 0x52,
 850                                               struct kdbus_cmd_name_list),
 851
 852         KDBUS_CMD_CONN_INFO =           _IOWR(KDBUS_IOCTL_MAGIC, 0x60,
 853                                               struct kdbus_cmd_conn_info),
 854         KDBUS_CMD_CONN_UPDATE =         _IOW(KDBUS_IOCTL_MAGIC, 0x61,
 855                                              struct kdbus_cmd_update),
 856
 857         KDBUS_CMD_ENDPOINT_UPDATE =     _IOW(KDBUS_IOCTL_MAGIC, 0x71,
 858                                              struct kdbus_cmd_update),
 859
 860         KDBUS_CMD_MATCH_ADD =           _IOW(KDBUS_IOCTL_MAGIC, 0x80,
 861                                              struct kdbus_cmd_match),
 862         KDBUS_CMD_MATCH_REMOVE =        _IOW(KDBUS_IOCTL_MAGIC, 0x81,
 863                                              struct kdbus_cmd_match),
 864 };
 865
 866 #endif /* _KDBUS_UAPI_H_ */