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