/*
- * Copyright (C) 2013 Kay Sievers
- * Copyright (C) 2013 Greg Kroah-Hartman <gregkh@linuxfoundation.org>
- * Copyright (C) 2013 Linux Foundation
- * Copyright (C) 2013 Lennart Poettering
- * Copyright (C) 2013 Daniel Mack <daniel@zonque.org>
+ * Copyright (C) 2013-2014 Kay Sievers
+ * Copyright (C) 2013-2014 Greg Kroah-Hartman <gregkh@linuxfoundation.org>
+ * Copyright (C) 2013-2014 Linux Foundation
+ * Copyright (C) 2013-2014 Lennart Poettering
+ * Copyright (C) 2013-2014 Daniel Mack <daniel@zonque.org>
+ * Copyright (C) 2013-2014 David Herrmann <dh.herrmann@gmail.com>
*
* kdbus is free software; you can redistribute it and/or modify it under
* the terms of the GNU Lesser General Public License as published by the
* -- Albert Einstein
*/
-#ifndef _KDBUS_H_
-#define _KDBUS_H_
+#ifndef _KDBUS_UAPI_H_
+#define _KDBUS_UAPI_H_
-#ifndef __KERNEL__
-#include <sys/ioctl.h>
-#include <sys/types.h>
+#include <linux/ioctl.h>
#include <linux/types.h>
-#endif
#define KDBUS_IOCTL_MAGIC 0x95
#define KDBUS_SRC_ID_KERNEL (0)
/**
* struct kdbus_notify_name_change - name registry change message
- * @old: ID and flags of former owner of a name
- * @new: ID and flags of new owner of a name
+ * @old_id: ID and flags of former owner of a name
+ * @new_id: ID and flags of new owner of a name
* @name: Well-known name
*
* Sent from kernel to userspace when the owner or activator of
* KDBUS_ITEM_NAME_CHANGE
*/
struct kdbus_notify_name_change {
- struct kdbus_notify_id_change old;
- struct kdbus_notify_id_change new;
+ struct kdbus_notify_id_change old_id;
+ struct kdbus_notify_id_change new_id;
char name[0];
};
/**
* struct kdbus_vec - I/O vector for kdbus payload items
* @size: The size of the vector
- * @address: Memory address for memory addresses
+ * @address: Memory address of data buffer
* @offset: Offset in the in-message payload memory,
* relative to the message head
*
* Attached to:
- * KDBUS_ITEM_PAYLOAD_VEC
+ * KDBUS_ITEM_PAYLOAD_VEC, KDBUS_ITEM_PAYLOAD_OFF
*/
struct kdbus_vec {
__u64 size;
* struct kdbus_memfd - a kdbus memfd
* @size: The memfd's size
* @fd: The file descriptor number
- * @__pad: Padding to ensure proper alignement and size
+ * @__pad: Padding to ensure proper alignment and size
*
* Attached to:
* KDBUS_ITEM_PAYLOAD_MEMFD
* bloom filter
* @KDBUS_ITEM_DST_NAME: Destination's well-known name
* @KDBUS_ITEM_MAKE_NAME: Name of domain, bus, endpoint
- * @KDBUS_ITEM_MEMFD_NAME: The human readable name of a memfd (debugging)
* @KDBUS_ITEM_ATTACH_FLAGS: Attach-flags, used for updating which metadata
* a connection subscribes to
* @_KDBUS_ITEM_ATTACH_BASE: Start of metadata attach items
KDBUS_ITEM_BLOOM_MASK,
KDBUS_ITEM_DST_NAME,
KDBUS_ITEM_MAKE_NAME,
- KDBUS_ITEM_MEMFD_NAME,
KDBUS_ITEM_ATTACH_FLAGS,
_KDBUS_ITEM_ATTACH_BASE = 0x1000,
* name is not currently active
*/
enum kdbus_msg_flags {
- KDBUS_MSG_FLAGS_EXPECT_REPLY = 1 << 0,
- KDBUS_MSG_FLAGS_SYNC_REPLY = 1 << 1,
- KDBUS_MSG_FLAGS_NO_AUTO_START = 1 << 2,
+ KDBUS_MSG_FLAGS_EXPECT_REPLY = 1ULL << 0,
+ KDBUS_MSG_FLAGS_SYNC_REPLY = 1ULL << 1,
+ KDBUS_MSG_FLAGS_NO_AUTO_START = 1ULL << 2,
};
/**
* the priority value is ignored.
*/
enum kdbus_recv_flags {
- KDBUS_RECV_PEEK = 1 << 0,
- KDBUS_RECV_DROP = 1 << 1,
- KDBUS_RECV_USE_PRIORITY = 1 << 2,
+ KDBUS_RECV_PEEK = 1ULL << 0,
+ KDBUS_RECV_DROP = 1ULL << 1,
+ KDBUS_RECV_USE_PRIORITY = 1ULL << 2,
};
/**
__u64 offset;
} __attribute__((aligned(8)));
+/**
+ * struct kdbus_cmd_cancel - struct to cancel a synchronously pending message
+ * @cookie The cookie of the pending message
+ * @flags Flags for the free command. Currently unused.
+ *
+ * This struct is used with the KDBUS_CMD_CANCEL ioctl.
+ */
+struct kdbus_cmd_cancel {
+ __u64 cookie;
+ __u64 flags;
+} __attribute__((aligned(8)));
+
+/**
+ * struct kdbus_cmd_free - struct to free a slice of memory in the pool
+ * @offset The offset of the memory slice, as returned by other
+ * ioctls
+ * @flags Flags for the free command. Currently unused.
+ *
+ * This struct is used with the KDBUS_CMD_FREE ioctl.
+ */
+struct kdbus_cmd_free {
+ __u64 offset;
+ __u64 flags;
+} __attribute__((aligned(8)));
+
/**
* enum kdbus_policy_access_type - permissions of a policy record
* @_KDBUS_POLICY_ACCESS_NULL: Uninitialized/invalid
/**
* enum kdbus_hello_flags - flags for struct kdbus_cmd_hello
- * @KDBUS_HELLO_ACCEPT_FD: The connection allows the receiving of
+ * @KDBUS_HELLO_ACCEPT_FD: The connection allows the reception of
* any passed file descriptors
* @KDBUS_HELLO_ACTIVATOR: Special-purpose connection which registers
* a well-know name for a process to be started
* bus traffic
*/
enum kdbus_hello_flags {
- KDBUS_HELLO_ACCEPT_FD = 1 << 0,
- KDBUS_HELLO_ACTIVATOR = 1 << 1,
- KDBUS_HELLO_POLICY_HOLDER = 1 << 2,
- KDBUS_HELLO_MONITOR = 1 << 3,
+ KDBUS_HELLO_ACCEPT_FD = 1ULL << 0,
+ KDBUS_HELLO_ACTIVATOR = 1ULL << 1,
+ KDBUS_HELLO_POLICY_HOLDER = 1ULL << 2,
+ KDBUS_HELLO_MONITOR = 1ULL << 3,
};
/**
* @_KDBUS_ATTACH_ALL: All of the above
*/
enum kdbus_attach_flags {
- KDBUS_ATTACH_TIMESTAMP = 1 << 0,
- KDBUS_ATTACH_CREDS = 1 << 1,
- KDBUS_ATTACH_AUXGROUPS = 1 << 2,
- KDBUS_ATTACH_NAMES = 1 << 3,
- KDBUS_ATTACH_COMM = 1 << 4,
- KDBUS_ATTACH_EXE = 1 << 5,
- KDBUS_ATTACH_CMDLINE = 1 << 6,
- KDBUS_ATTACH_CGROUP = 1 << 7,
- KDBUS_ATTACH_CAPS = 1 << 8,
- KDBUS_ATTACH_SECLABEL = 1 << 9,
- KDBUS_ATTACH_AUDIT = 1 << 10,
- KDBUS_ATTACH_CONN_NAME = 1 << 11,
- _KDBUS_ATTACH_ALL = (1 << 12) - 1,
+ KDBUS_ATTACH_TIMESTAMP = 1ULL << 0,
+ KDBUS_ATTACH_CREDS = 1ULL << 1,
+ KDBUS_ATTACH_AUXGROUPS = 1ULL << 2,
+ KDBUS_ATTACH_NAMES = 1ULL << 3,
+ KDBUS_ATTACH_COMM = 1ULL << 4,
+ KDBUS_ATTACH_EXE = 1ULL << 5,
+ KDBUS_ATTACH_CMDLINE = 1ULL << 6,
+ KDBUS_ATTACH_CGROUP = 1ULL << 7,
+ KDBUS_ATTACH_CAPS = 1ULL << 8,
+ KDBUS_ATTACH_SECLABEL = 1ULL << 9,
+ KDBUS_ATTACH_AUDIT = 1ULL << 10,
+ KDBUS_ATTACH_CONN_NAME = 1ULL << 11,
+ _KDBUS_ATTACH_ALL = (1ULL << 12) - 1,
};
/**
* struct kdbus_cmd_hello - struct to say hello to kdbus
* @size: The total size of the structure
- * @conn_flags: Connection flags (KDBUS_HELLO_*). The kernel will
- * return its capabilities in that field.
+ * @conn_flags: Connection flags (KDBUS_HELLO_*).
* @attach_flags: Mask of metadata to attach to each message sent
* (KDBUS_ATTACH_*)
* @bus_flags: The flags field copied verbatim from the original
* @KDBUS_MAKE_ACCESS_WORLD: Make the device node world-accessible
*/
enum kdbus_make_flags {
- KDBUS_MAKE_ACCESS_GROUP = 1 << 0,
- KDBUS_MAKE_ACCESS_WORLD = 1 << 1,
+ KDBUS_MAKE_ACCESS_GROUP = 1ULL << 0,
+ KDBUS_MAKE_ACCESS_WORLD = 1ULL << 1,
};
/**
* @KDBUS_NAME_ACTIVATOR: Name is owned by a activator connection
*/
enum kdbus_name_flags {
- KDBUS_NAME_REPLACE_EXISTING = 1 << 0,
- KDBUS_NAME_ALLOW_REPLACEMENT = 1 << 1,
- KDBUS_NAME_QUEUE = 1 << 2,
- KDBUS_NAME_IN_QUEUE = 1 << 3,
- KDBUS_NAME_ACTIVATOR = 1 << 4,
+ KDBUS_NAME_REPLACE_EXISTING = 1ULL << 0,
+ KDBUS_NAME_ALLOW_REPLACEMENT = 1ULL << 1,
+ KDBUS_NAME_QUEUE = 1ULL << 2,
+ KDBUS_NAME_IN_QUEUE = 1ULL << 3,
+ KDBUS_NAME_ACTIVATOR = 1ULL << 4,
};
/**
* struct kdbus_cmd_name - struct to describe a well-known name
* @size: The total size of the struct
* @flags: Flags for a name entry (KDBUS_NAME_*)
- * @owner_id: The current owner of the name.
+ * @owner_id: The current owner of the name
* @conn_flags: The flags of the owning connection (KDBUS_HELLO_*)
- * @name: The well-known name
+ * @items: Item list, containing the well-known name as
+ * KDBUS_ITEM_NAME
*
* This structure is used with the KDBUS_CMD_NAME_ACQUIRE ioctl.
*/
__u64 flags;
__u64 owner_id;
__u64 conn_flags;
- char name[0];
+ struct kdbus_item items[0];
} __attribute__((aligned(8)));
/**
* @KDBUS_NAME_LIST_QUEUED: All queued-up names
*/
enum kdbus_name_list_flags {
- KDBUS_NAME_LIST_UNIQUE = 1 << 0,
- KDBUS_NAME_LIST_NAMES = 1 << 1,
- KDBUS_NAME_LIST_ACTIVATORS = 1 << 2,
- KDBUS_NAME_LIST_QUEUED = 1 << 3,
+ KDBUS_NAME_LIST_UNIQUE = 1ULL << 0,
+ KDBUS_NAME_LIST_NAMES = 1ULL << 1,
+ KDBUS_NAME_LIST_ACTIVATORS = 1ULL << 2,
+ KDBUS_NAME_LIST_QUEUED = 1ULL << 3,
};
/**
__u64 flags;
__u64 id;
__u64 offset;
- char name[0];
+ struct kdbus_item items[0];
} __attribute__((aligned(8)));
/**
*/
struct kdbus_cmd_update {
__u64 size;
+ __u64 flags;
struct kdbus_item items[0];
} __attribute__((aligned(8)));
+/**
+ * enum kdbus_cmd_match_flags - flags to control the KDBUS_CMD_MATCH_ADD ioctl
+ * @KDBUS_MATCH_REPLACE: If entries with the supplied cookie already
+ * exists, remove them before installing the new
+ * matches.
+ */
+enum kdbus_cmd_match_flags {
+ KDBUS_MATCH_REPLACE = 1ULL << 0,
+};
+
/**
* struct kdbus_cmd_match - struct to add or remove matches
* @size: The total size of the struct
struct kdbus_cmd_match {
__u64 size;
__u64 cookie;
+ __u64 flags;
struct kdbus_item items[0];
} __attribute__((aligned(8)));
* @KDBUS_CMD_HELLO: By opening the bus device node a connection is
* created. After a HELLO the opened connection
* becomes an active peer on the bus.
- * @KDBUS_CMD_BYEBYE: Disconnect a connection. If the connection's
- * message list is empty, the calls succeeds, and
- * the handle is rendered unusable. Otherwise,
- * -EAGAIN is returned without any further side-
- * effects.
+ * @KDBUS_CMD_BYEBYE: Disconnect a connection. If there are no
+ * messages queued up in the connection's pool,
+ * the call succeeds, and the handle is rendered
+ * unusable. Otherwise, -EBUSY is returned without
+ * any further side-effects.
* @KDBUS_CMD_MSG_SEND: Send a message and pass data from userspace to
* the kernel.
* @KDBUS_CMD_MSG_RECV: Receive a message from the kernel which is
struct kdbus_msg),
KDBUS_CMD_MSG_RECV = _IOWR(KDBUS_IOCTL_MAGIC, 0x41,
struct kdbus_cmd_recv),
- KDBUS_CMD_MSG_CANCEL = _IOW(KDBUS_IOCTL_MAGIC, 0x42, __u64 *),
- KDBUS_CMD_FREE = _IOW(KDBUS_IOCTL_MAGIC, 0x43, __u64 *),
+ KDBUS_CMD_MSG_CANCEL = _IOW(KDBUS_IOCTL_MAGIC, 0x42,
+ struct kdbus_cmd_cancel),
+ KDBUS_CMD_FREE = _IOW(KDBUS_IOCTL_MAGIC, 0x43,
+ struct kdbus_cmd_free),
KDBUS_CMD_NAME_ACQUIRE = _IOWR(KDBUS_IOCTL_MAGIC, 0x50,
struct kdbus_cmd_name),
KDBUS_CMD_NAME_RELEASE = _IOW(KDBUS_IOCTL_MAGIC, 0x51,
struct kdbus_cmd_name),
KDBUS_CMD_NAME_LIST = _IOWR(KDBUS_IOCTL_MAGIC, 0x52,
- struct kdbus_cmd_name_list),
+ struct kdbus_cmd_name_list),
KDBUS_CMD_CONN_INFO = _IOWR(KDBUS_IOCTL_MAGIC, 0x60,
struct kdbus_cmd_conn_info),
struct kdbus_cmd_match),
};
-/*
- * errno - api error codes
- * @E2BIG: A message contains too many records or items.
- * @EADDRINUSE: A well-known bus name is already taken by another
- * connection.
- * @EADDRNOTAVAIL: A message flagged not to activate a service, addressed
- * a service which is not currently running.
- * @EAGAIN: No messages are queued at the moment.
- * @EALREADY: A requested name is already owned by the connection,
- * a connection is already disconnected, memfd is already
- * sealed or has the requested size.
- * @EBADF: File descriptors passed with the message are not valid.
- * @EBADFD: A bus connection is in a corrupted state.
- * @EBADMSG: Passed data contains a combination of conflicting or
- * inconsistent types.
- * @EBUSY: The user tried to say BYEBYE to a connection, but the
- * connection had a non-empty message list.
- * @ECANCELED: A synchronous message sending was cancelled.
- * @ECONNRESET: A connection is shut down, no further operations are
- * possible.
- * @ECOMM: A peer does not accept the file descriptors addressed
- * to it.
- * @EDESTADDRREQ: The well-known bus name is required but missing.
- * @EDOM: The size of data does not match the expectations. Used
- * for bloom bit field sizes.
- * @EEXIST: A requested domain, bus or endpoint with the same
- * name already exists. A specific data type, which is
- * only expected once, is provided multiple times.
- * @EFAULT: The supplied memory could not be accessed, the data
- * is not properly aligned, or the current task's memory
- * is inaccessible.
- * @EINVAL: The provided data does not match its type or other
- * expectations, like a string which is not NUL terminated,
- * or a string length that points behind the first
- * \0-byte in the string.
- * @EMEDIUMTYPE: A file descriptor which is not a kdbus memfd was
- * refused to send as KDBUS_MSG_PAYLOAD_MEMFD.
- * @EMFILE: Too many file descriptors have been supplied with a
- * message.
- * Too many connections or buses are created for a given
- * user.
- * @EMLINK: Too many requests from this connection to other peers
- * are queued and waiting for a reply
- * @EMSGSIZE: The supplied data is larger than the allowed maximum
- * size.
- * @ENAMETOOLONG: The requested name is larger than the allowed maximum
- * size.
- * @ENOBUFS: There is no space left for the submitted data to fit
- * into the receiver's pool.
- * @ENOENT: The to be cancelled message was not found.
- * @ENOMEM: Out of memory.
- * @ENOMSG: The queue is not empty, but no message with a matching
- * priority is currently queued.
- * @ENOSYS: The requested functionality is not available.
- * @ENOTTY: An unknown ioctl command was received.
- * @ENOTUNIQ: A specific data type was addressed to a broadcast
- * address, but only direct addresses support this kind of
- * data.
- * @ENXIO: A unique address does not exist, or an offset in the
- * receiver's pool does not represent a queued message.
- * @EOPNOTSUPP: The feature negotiation failed, a not supported feature
- * was requested, or an unknown item type was received.
- * @EPERM: The policy prevented an operation. The requested
- * resource is owned by another entity.
- * @EPIPE: When sending a message, a synchronous reply from the
- * receiving connection was expected but the connection
- * died before answering.
- * @ESHUTDOWN: A domain, bus or endpoint is currently shutting down;
- * no further operations will be possible.
- * @ESRCH: A requested well-known bus name is not found.
- * @ETIMEDOUT: A synchronous wait for a message reply did not arrive
- * within the specified time frame.
- * @ETXTBSY: A kdbus memfd file cannot be sealed or the seal removed,
- * because it is shared with other processes or still
- * mmap()ed.
- * @EXFULL: The size limits in the pool are reached, no data of
- * the size tried to submit can be queued.
- */
-#endif
+#endif /* _KDBUS_UAPI_H_ */