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