src/libsystemd-bus/kdbus.h

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