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