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