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