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