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