[thirdparty/systemd.git] / src / libsystemd / sd-bus / bus-protocol.h

/* SPDX-License-Identifier: LGPL-2.1+ */
#pragma once

/***
  Copyright 2013 Lennart Poettering
***/

#include <endian.h>

#include "macro.h"

/* Packet header */

struct _packed_ bus_header {
        /* The first four fields are identical for dbus1, and dbus2 */
        uint8_t endian;
        uint8_t type;
        uint8_t flags;
        uint8_t version;

        union _packed_ {
                /* dbus1: Used for SOCK_STREAM connections */
                struct _packed_ {
                        uint32_t body_size;

                        /* Note that what the bus spec calls "serial" we'll call
                           "cookie" instead, because we don't want to imply that the
                           cookie was in any way monotonically increasing. */
                        uint32_t serial;
                        uint32_t fields_size;
                } dbus1;

                /* dbus2: Used for kdbus connections */
                struct _packed_ {
                        uint32_t _reserved;
                        uint64_t cookie;
                } dbus2;

                /* Note that both header versions have the same size! */
        };
};

/* Endianness */

enum {
        _BUS_INVALID_ENDIAN = 0,
        BUS_LITTLE_ENDIAN   = 'l',
        BUS_BIG_ENDIAN      = 'B',
#if __BYTE_ORDER == __BIG_ENDIAN
        BUS_NATIVE_ENDIAN   = BUS_BIG_ENDIAN,
        BUS_REVERSE_ENDIAN  = BUS_LITTLE_ENDIAN
#else
        BUS_NATIVE_ENDIAN   = BUS_LITTLE_ENDIAN,
        BUS_REVERSE_ENDIAN  = BUS_BIG_ENDIAN
#endif
};

/* Flags */

enum {
        BUS_MESSAGE_NO_REPLY_EXPECTED = 1,
        BUS_MESSAGE_NO_AUTO_START = 2,
        BUS_MESSAGE_ALLOW_INTERACTIVE_AUTHORIZATION = 4,
};

/* Header fields */

enum {
        _BUS_MESSAGE_HEADER_INVALID = 0,
        BUS_MESSAGE_HEADER_PATH,
        BUS_MESSAGE_HEADER_INTERFACE,
        BUS_MESSAGE_HEADER_MEMBER,
        BUS_MESSAGE_HEADER_ERROR_NAME,
        BUS_MESSAGE_HEADER_REPLY_SERIAL,
        BUS_MESSAGE_HEADER_DESTINATION,
        BUS_MESSAGE_HEADER_SENDER,
        BUS_MESSAGE_HEADER_SIGNATURE,
        BUS_MESSAGE_HEADER_UNIX_FDS,
        _BUS_MESSAGE_HEADER_MAX
};

/* RequestName parameters */

enum  {
        BUS_NAME_ALLOW_REPLACEMENT = 1,
        BUS_NAME_REPLACE_EXISTING = 2,
        BUS_NAME_DO_NOT_QUEUE = 4
};

/* RequestName returns */
enum  {
        BUS_NAME_PRIMARY_OWNER = 1,
        BUS_NAME_IN_QUEUE = 2,
        BUS_NAME_EXISTS = 3,
        BUS_NAME_ALREADY_OWNER = 4
};

/* ReleaseName returns */
enum {
        BUS_NAME_RELEASED = 1,
        BUS_NAME_NON_EXISTENT = 2,
        BUS_NAME_NOT_OWNER = 3,
};

/* StartServiceByName returns */
enum {
        BUS_START_REPLY_SUCCESS = 1,
        BUS_START_REPLY_ALREADY_RUNNING = 2,
};

#define BUS_INTROSPECT_DOCTYPE                                       \
        "<!DOCTYPE node PUBLIC \"-//freedesktop//DTD D-BUS Object Introspection 1.0//EN\"\n" \
        "\"http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd\">\n"

#define BUS_INTROSPECT_INTERFACE_PEER                                \
        " <interface name=\"org.freedesktop.DBus.Peer\">\n"             \
        "  <method name=\"Ping\"/>\n"                                   \
        "  <method name=\"GetMachineId\">\n"                            \
        "   <arg type=\"s\" name=\"machine_uuid\" direction=\"out\"/>\n" \
        "  </method>\n"                                                 \
        " </interface>\n"

#define BUS_INTROSPECT_INTERFACE_INTROSPECTABLE                      \
        " <interface name=\"org.freedesktop.DBus.Introspectable\">\n"   \
        "  <method name=\"Introspect\">\n"                              \
        "   <arg name=\"data\" type=\"s\" direction=\"out\"/>\n"        \
        "  </method>\n"                                                 \
        " </interface>\n"

#define BUS_INTROSPECT_INTERFACE_PROPERTIES                          \
        " <interface name=\"org.freedesktop.DBus.Properties\">\n"       \
        "  <method name=\"Get\">\n"                                     \
        "   <arg name=\"interface\" direction=\"in\" type=\"s\"/>\n"    \
        "   <arg name=\"property\" direction=\"in\" type=\"s\"/>\n"     \
        "   <arg name=\"value\" direction=\"out\" type=\"v\"/>\n"       \
        "  </method>\n"                                                 \
        "  <method name=\"GetAll\">\n"                                  \
        "   <arg name=\"interface\" direction=\"in\" type=\"s\"/>\n"    \
        "   <arg name=\"properties\" direction=\"out\" type=\"a{sv}\"/>\n" \
        "  </method>\n"                                                 \
        "  <method name=\"Set\">\n"                                     \
        "   <arg name=\"interface\" direction=\"in\" type=\"s\"/>\n"    \
        "   <arg name=\"property\" direction=\"in\" type=\"s\"/>\n"     \
        "   <arg name=\"value\" direction=\"in\" type=\"v\"/>\n"        \
        "  </method>\n"                                                 \
        "  <signal name=\"PropertiesChanged\">\n"                       \
        "   <arg type=\"s\" name=\"interface\"/>\n"                     \
        "   <arg type=\"a{sv}\" name=\"changed_properties\"/>\n"        \
        "   <arg type=\"as\" name=\"invalidated_properties\"/>\n"       \
        "  </signal>\n"                                                 \
        " </interface>\n"

#define BUS_INTROSPECT_INTERFACE_OBJECT_MANAGER                      \
        " <interface name=\"org.freedesktop.DBus.ObjectManager\">\n"    \
        "  <method name=\"GetManagedObjects\">\n"                       \
        "   <arg type=\"a{oa{sa{sv}}}\" name=\"object_paths_interfaces_and_properties\" direction=\"out\"/>\n" \
        "  </method>\n"                                                 \
        "  <signal name=\"InterfacesAdded\">\n"                         \
        "   <arg type=\"o\" name=\"object_path\"/>\n"                   \
        "   <arg type=\"a{sa{sv}}\" name=\"interfaces_and_properties\"/>\n" \
        "  </signal>\n"                                                 \
        "  <signal name=\"InterfacesRemoved\">\n"                       \
        "   <arg type=\"o\" name=\"object_path\"/>\n"                   \
        "   <arg type=\"as\" name=\"interfaces\"/>\n"                   \
        "  </signal>\n"                                                 \
        " </interface>\n"
Commit	Line	Data
53e1b683	1	/* SPDX-License-Identifier: LGPL-2.1+ */
0461f8cd LP	2	#pragma once
	3
	4	/***
0461f8cd	5	Copyright 2013 Lennart Poettering
0461f8cd LP	6	***/
0461f8cd LP	7
6017365a	8	#include <endian.h>
0461f8cd	9
2ac7c17f LP	10	#include "macro.h"
2ac7c17f LP	11
22d097a6 LP	12	/* Packet header */
22d097a6 LP	13
2ac7c17f LP	14	struct _packed_ bus_header {
2ac7c17f LP	15	/* The first four fields are identical for dbus1, and dbus2 */
22d097a6 LP	16	uint8_t endian;
	17	uint8_t type;
	18	uint8_t flags;
	19	uint8_t version;
2ac7c17f LP	20
	21	union _packed_ {
	22	/* dbus1: Used for SOCK_STREAM connections */
	23	struct _packed_ {
	24	uint32_t body_size;
	25
	26	/* Note that what the bus spec calls "serial" we'll call
	27	"cookie" instead, because we don't want to imply that the
	28	cookie was in any way monotonically increasing. */
	29	uint32_t serial;
	30	uint32_t fields_size;
	31	} dbus1;
	32
	33	/* dbus2: Used for kdbus connections */
	34	struct _packed_ {
	35	uint32_t _reserved;
	36	uint64_t cookie;
	37	} dbus2;
	38
	39	/* Note that both header versions have the same size! */
	40	};
	41	};
22d097a6	42
0461f8cd LP	43	/* Endianness */
	44
	45	enum {
	46	_BUS_INVALID_ENDIAN = 0,
	47	BUS_LITTLE_ENDIAN = 'l',
	48	BUS_BIG_ENDIAN = 'B',
	49	#if __BYTE_ORDER == __BIG_ENDIAN
	50	BUS_NATIVE_ENDIAN = BUS_BIG_ENDIAN,
	51	BUS_REVERSE_ENDIAN = BUS_LITTLE_ENDIAN
	52	#else
	53	BUS_NATIVE_ENDIAN = BUS_LITTLE_ENDIAN,
	54	BUS_REVERSE_ENDIAN = BUS_BIG_ENDIAN
	55	#endif
	56	};
	57
	58	/* Flags */
	59
	60	enum {
	61	BUS_MESSAGE_NO_REPLY_EXPECTED = 1,
53a83f4b LP	62	BUS_MESSAGE_NO_AUTO_START = 2,
53a83f4b LP	63	BUS_MESSAGE_ALLOW_INTERACTIVE_AUTHORIZATION = 4,
0461f8cd LP	64	};
	65
	66	/* Header fields */
	67
	68	enum {
	69	_BUS_MESSAGE_HEADER_INVALID = 0,
	70	BUS_MESSAGE_HEADER_PATH,
	71	BUS_MESSAGE_HEADER_INTERFACE,
	72	BUS_MESSAGE_HEADER_MEMBER,
	73	BUS_MESSAGE_HEADER_ERROR_NAME,
	74	BUS_MESSAGE_HEADER_REPLY_SERIAL,
	75	BUS_MESSAGE_HEADER_DESTINATION,
	76	BUS_MESSAGE_HEADER_SENDER,
	77	BUS_MESSAGE_HEADER_SIGNATURE,
	78	BUS_MESSAGE_HEADER_UNIX_FDS,
	79	_BUS_MESSAGE_HEADER_MAX
	80	};
	81
29a07cdb LP	82	/* RequestName parameters */
	83
	84	enum {
	85	BUS_NAME_ALLOW_REPLACEMENT = 1,
	86	BUS_NAME_REPLACE_EXISTING = 2,
	87	BUS_NAME_DO_NOT_QUEUE = 4
	88	};
	89
0461f8cd LP	90	/* RequestName returns */
	91	enum {
	92	BUS_NAME_PRIMARY_OWNER = 1,
	93	BUS_NAME_IN_QUEUE = 2,
	94	BUS_NAME_EXISTS = 3,
	95	BUS_NAME_ALREADY_OWNER = 4
	96	};
	97
	98	/* ReleaseName returns */
	99	enum {
	100	BUS_NAME_RELEASED = 1,
	101	BUS_NAME_NON_EXISTENT = 2,
	102	BUS_NAME_NOT_OWNER = 3,
	103	};
	104
71ebe743 LP	105	/* StartServiceByName returns */
	106	enum {
	107	BUS_START_REPLY_SUCCESS = 1,
	108	BUS_START_REPLY_ALREADY_RUNNING = 2,
	109	};
	110
0461f8cd LP	111	#define BUS_INTROSPECT_DOCTYPE \
	112	"<!DOCTYPE node PUBLIC \"-//freedesktop//DTD D-BUS Object Introspection 1.0//EN\"\n" \
	113	"\"http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd\">\n"
	114
	115	#define BUS_INTROSPECT_INTERFACE_PEER \
	116	" <interface name=\"org.freedesktop.DBus.Peer\">\n" \
	117	" <method name=\"Ping\"/>\n" \
	118	" <method name=\"GetMachineId\">\n" \
	119	" <arg type=\"s\" name=\"machine_uuid\" direction=\"out\"/>\n" \
	120	" </method>\n" \
	121	" </interface>\n"
	122
	123	#define BUS_INTROSPECT_INTERFACE_INTROSPECTABLE \
	124	" <interface name=\"org.freedesktop.DBus.Introspectable\">\n" \
	125	" <method name=\"Introspect\">\n" \
	126	" <arg name=\"data\" type=\"s\" direction=\"out\"/>\n" \
	127	" </method>\n" \
	128	" </interface>\n"
	129
	130	#define BUS_INTROSPECT_INTERFACE_PROPERTIES \
	131	" <interface name=\"org.freedesktop.DBus.Properties\">\n" \
	132	" <method name=\"Get\">\n" \
	133	" <arg name=\"interface\" direction=\"in\" type=\"s\"/>\n" \
	134	" <arg name=\"property\" direction=\"in\" type=\"s\"/>\n" \
	135	" <arg name=\"value\" direction=\"out\" type=\"v\"/>\n" \
	136	" </method>\n" \
	137	" <method name=\"GetAll\">\n" \
	138	" <arg name=\"interface\" direction=\"in\" type=\"s\"/>\n" \
	139	" <arg name=\"properties\" direction=\"out\" type=\"a{sv}\"/>\n" \
	140	" </method>\n" \
	141	" <method name=\"Set\">\n" \
	142	" <arg name=\"interface\" direction=\"in\" type=\"s\"/>\n" \
	143	" <arg name=\"property\" direction=\"in\" type=\"s\"/>\n" \
	144	" <arg name=\"value\" direction=\"in\" type=\"v\"/>\n" \
	145	" </method>\n" \
	146	" <signal name=\"PropertiesChanged\">\n" \
	147	" <arg type=\"s\" name=\"interface\"/>\n" \
	148	" <arg type=\"a{sv}\" name=\"changed_properties\"/>\n" \
	149	" <arg type=\"as\" name=\"invalidated_properties\"/>\n" \
	150	" </signal>\n" \
	151	" </interface>\n"
	152
	153	#define BUS_INTROSPECT_INTERFACE_OBJECT_MANAGER \
	154	" <interface name=\"org.freedesktop.DBus.ObjectManager\">\n" \
	155	" <method name=\"GetManagedObjects\">\n" \
	156	" <arg type=\"a{oa{sa{sv}}}\" name=\"object_paths_interfaces_and_properties\" direction=\"out\"/>\n" \
	157	" </method>\n" \
	158	" <signal name=\"InterfacesAdded\">\n" \
	159	" <arg type=\"o\" name=\"object_path\"/>\n" \
	160	" <arg type=\"a{sa{sv}}\" name=\"interfaces_and_properties\"/>\n" \
	161	" </signal>\n" \
	162	" <signal name=\"InterfacesRemoved\">\n" \
	163	" <arg type=\"o\" name=\"object_path\"/>\n" \
	164	" <arg type=\"as\" name=\"interfaces\"/>\n" \
	165	" </signal>\n" \
	166	" </interface>\n"