D-BUS Tutorial
Version 0.3
18 January 2005
Havoc
Pennington
Red Hat, Inc.
hp@pobox.com
David
Wheeler
What is D-BUS?
D-BUS is a system for interprocess communication
(IPC). Architecturally, it has several layers:
A library, libdbus, that allows two
applications to connect to each other and exchange messages.
A message bus daemon executable, built on
libdbus, that multiple applications can connect to. The daemon can
route messages from one application to zero or more other
applications.
Wrapper libraries based on particular
application frameworks. For example, libdbus-glib and
libdbus-qt. There are also bindings to languages such as
Python. These wrapper libraries are the API most people should use,
as they simplify the details of D-BUS programming. libdbus is
intended to be a low-level backend for the higher level bindings.
Much of the libdbus API is only useful for binding implementation.
If you just want to use D-BUS and don't care how it works, jump directly
to .
Otherwise, read on.
libdbus only supports one-to-one connections, just like a raw network
socket. However, rather than sending byte streams over the connection, you
send messages. Messages have a header identifying
the kind of message, and a body containing a data payload. libdbus also
abstracts the exact transport used (sockets vs. whatever else), and
handles details such as authentication.
The message bus daemon forms the hub of a wheel. Each spoke of the wheel
is a one-to-one connection to an application using libdbus. An
application sends a message to the bus daemon over its spoke, and the bus
daemon forwards the message to other connected applications as
appropriate. Think of the daemon as a router.
The bus daemon has multiple instances on a typical computer. The
first instance is a machine-global singleton, that is, a system daemon
similar to sendmail or Apache. This instance has heavy security
restrictions on what messages it will accept, and is used for systemwide
communication. The other instances are created one per user login session.
These instances allow applications in the user's session to communicate
with one another.
The systemwide and per-user daemons are separate. Normal within-session
IPC does not involve the systemwide message bus process and vice versa.
D-BUS applications
There are many, many technologies in the world that have "Inter-process
communication" or "networking" in their stated purpose: CORBA, DCE, DCOM, DCOP, XML-RPC, SOAP, MBUS, Internet Communications Engine (ICE),
and probably hundreds more.
Each of these is tailored for particular kinds of application.
D-BUS is designed for two specific cases:
Communication between desktop applications in the same desktop
session; to allow integration of the desktop session as a whole,
and address issues of process lifecycle (when do desktop components
start and stop running).
Communication between the desktop session and the operating system,
where the operating system would typically include the kernel
and any system daemons or processes.
For the within-desktop-session use case, the GNOME and KDE desktops
have significant previous experience with different IPC solutions
such as CORBA and DCOP. D-BUS is built on that experience and
carefully tailored to meet the needs of these desktop projects
in particular. D-BUS may or may not be appropriate for other
applications; the FAQ has some comparisons to other IPC systems.
The problem solved by the systemwide or communication-with-the-OS case
is explained well by the following text from the Linux Hotplug project:
A gap in current Linux support is that policies with any sort of
dynamic "interact with user" component aren't currently
supported. For example, that's often needed the first time a network
adapter or printer is connected, and to determine appropriate places
to mount disk drives. It would seem that such actions could be
supported for any case where a responsible human can be identified:
single user workstations, or any system which is remotely
administered.
This is a classic "remote sysadmin" problem, where in this case
hotplugging needs to deliver an event from one security domain
(operating system kernel, in this case) to another (desktop for
logged-in user, or remote sysadmin). Any effective response must go
the other way: the remote domain taking some action that lets the
kernel expose the desired device capabilities. (The action can often
be taken asynchronously, for example letting new hardware be idle
until a meeting finishes.) At this writing, Linux doesn't have
widely adopted solutions to such problems. However, the new D-Bus
work may begin to solve that problem.
D-BUS may happen to be useful for purposes other than the one it was
designed for. Its general properties that distinguish it from
other forms of IPC are:
Binary protocol designed to be used asynchronously
(similar in spirit to the X Window System protocol).
Stateful, reliable connections held open over time.
The message bus is a daemon, not a "swarm" or
distributed architecture.
Many implementation and deployment issues are specified rather
than left ambiguous.
Semantics are similar to the existing DCOP system, allowing
KDE to adopt it more easily.
Security features to support the systemwide mode of the
message bus.
Concepts
Some basic concepts apply no matter what application framework you're
using to write a D-BUS application. The exact code you write will be
different for GLib vs. Qt vs. Python applications, however.
Here is a diagram (png svg) that may help you visualize the concepts
that follow.
Objects and Object Paths
Each application using D-BUS contains objects,
which generally map to GObject, QObject, C++ objects, or Python objects
(but need not). An object is an instance rather
than a type. When messages are received over a D-BUS connection, they
are sent to a specific object, not to the application as a whole.
To allow messages to specify their destination object, there has to be a
way to refer to an object. In your favorite programming language, this
is normally called a pointer or
reference. However, these references are
implemented as memory addresses relative to the address space of your
application, and thus can't be passed from one application to another.
To solve this, D-BUS introduces a name for each object. The name
looks like a filesystem path, for example an object could be
named /org/kde/kspread/sheets/3/cells/4/5.
Human-readable paths are nice, but you are free to create an
object named /com/mycompany/c5yo817y0c1y1c5b
if it makes sense for your application.
Namespacing object paths is smart, by starting them with the components
of a domain name you own (e.g. /org/kde). This
keeps different code modules in the same process from stepping
on one another's toes.
Interfaces
Each object supports one or more interfaces.
Think of an interface as a named group of methods and signals,
just as it is in GLib or Qt or Java. Interfaces define the
type of an object instance.
Message Types
Messages are not all the same; in particular, D-BUS has
4 built-in message types:
Method call messages ask to invoke a method
on an object.
Method return messages return the results
of invoking a method.
Error messages return an exception caused by
invoking a method.
Signal messages are notifications that a given signal
has been emitted (that an event has occurred).
You could also think of these as "event" messages.
A method call maps very simply to messages, then: you send a method call
message, and receive either a method return message or an error message
in reply.
Bus Names
Object paths, interfaces, and messages exist on the level of
libdbus and the D-BUS protocol; they are used even in the
1-to-1 case with no message bus involved.
Bus names, on the other hand, are a property of the message bus daemon.
The bus maintains a mapping from names to message bus connections.
These names are used to specify the origin and destination
of messages passing through the message bus. When a name is mapped
to a particular application's connection, that application is said to
own that name.
On connecting to the bus daemon, each application immediately owns a
special name called the unique connection name.
A unique name begins with a ':' (colon) character; no other names are
allowed to begin with that character. Unique names are special because
they are created dynamically, and are never re-used during the lifetime
of the same bus daemon. You know that a given unique name will have the
same owner at all times. An example of a unique name might be
:34-907. The numbers after the colon have
no meaning other than their uniqueness.
Applications may ask to own additional well-known
names. For example, you could write a specification to
define a name called com.mycompany.TextEditor.
Your definition could specify that to own this name, an application
should have an object at the path
/com/mycompany/TextFileManager supporting the
interface org.freedesktop.FileHandler.
Applications could then send messages to this bus name,
object, and interface to execute method calls.
You could think of the unique names as IP addresses, and the
well-known names as domain names. So
com.mycompany.TextEditor might map to something like
:34-907 just as mycompany.com maps
to something like 192.168.0.5.
Names have a second important use, other than routing messages. They
are used to track lifecycle. When an application exits (or crashes), its
connection to the message bus will be closed by the operating system
kernel. The message bus then sends out notification messages telling
remaining applications that the application's names have lost their
owner. By tracking these notifications, your application can reliably
monitor the lifetime of other applications.
Addresses
Applications using D-BUS are either servers or clients. A server
listens for incoming connections; a client connects to a server. Once
the connection is established, it is a symmetric flow of messages; the
client-server distinction only matters when setting up the
connection.
A D-BUS address specifies where a server will
listen, and where a client will connect. For example, the address
unix:path=/tmp/abcdef specifies that the server will
listen on a UNIX domain socket at the path
/tmp/abcdef and the client will connect to that
socket. An address can also specify TCP/IP sockets, or any other
transport defined in future iterations of the D-BUS specification.
When using D-BUS with a message bus, the bus daemon is a server
and all other applications are clients of the bus daemon.
libdbus automatically discovers the address of the per-session bus
daemon by reading an environment variable. It discovers the
systemwide bus daemon by checking a well-known UNIX domain socket path
(though you can override this address with an environment variable).
If you're using D-BUS without a bus daemon, it's up to you to
define which application will be the server and which will be
the client, and specify a mechanism for them to agree on
the server's address.
Big Conceptual Picture
Pulling all these concepts together, to specify a particular
method call on a particular object instance, a number of
nested components have to be named:
Address -> [Bus Name] -> Path -> Interface -> Method
The bus name is in brackets to indicate that it's optional -- you only
provide a name to route the method call to the right application
when using the bus daemon. If you have a direct connection to another
application, bus names aren't used; there's no bus daemon.
The interface is also optional, primarily for historical
reasons; DCOP does not require specifying the interface,
instead simply forbidding duplicate method names
on the same object instance. D-BUS will thus let you
omit the interface, but if your method name is ambiguous
it is undefined which method will be invoked.
GLib API: Using Remote Objects
The GLib binding is defined in the header file
<dbus/dbus-glib.h>.
D-BUS - GLib type mappings
The heart of the GLib bindings for D-BUS is the mapping it
provides between D-BUS "type signatures" and GLib types
(GType). The D-BUS type system is composed of
a number of "basic" types, along with several "container" types.
Basic type mappings
Below is a list of the basic types, along with their associated
mapping to a GType.
D-BUS basic type
GType
Free function
Notes
BYTE
G_TYPE_UCHAR
BOOLEAN
G_TYPE_BOOLEAN
INT16
G_TYPE_INT
Will be changed to a G_TYPE_INT16 once GLib has it
UINT16
G_TYPE_UINT
Will be changed to a G_TYPE_UINT16 once GLib has it
INT32
G_TYPE_INT
Will be changed to a G_TYPE_INT32 once GLib has it
UINT32
G_TYPE_UINT
Will be changed to a G_TYPE_UINT32 once GLib has it
INT64
G_TYPE_GINT64
UINT64
G_TYPE_GUINT64
DOUBLE
G_TYPE_DOUBLE
STRING
G_TYPE_STRING
g_free
OBJECT_PATH
DBUS_TYPE_G_PROXY
g_object_unref
The returned proxy does not have an interface set; use dbus_g_proxy_set_interface to invoke methods
As you can see, the basic mapping is fairly straightforward.
Container type mappings
The D-BUS type system also has a number of "container"
types, such as DBUS_TYPE_ARRAY and
DBUS_TYPE_STRUCT. The D-BUS type system
is fully recursive, so one can for example have an array of
array of strings (i.e. type signature
aas).
However, not all of these types are in common use; for
example, at the time of this writing the author knows of no
one using DBUS_TYPE_STRUCT, or a
DBUS_TYPE_ARRAY containing any non-basic
type. The approach the GLib bindings take is pragmatic; try
to map the most common types in the most obvious way, and
let using less common and more complex types be less
"natural".
First, D-BUS type signatures which have an "obvious"
corresponding builtin GLib type are mapped using that type:
D-BUS type signature
Description
GType
C typedef
Free function
Notes
as
Array of strings
G_TYPE_STRV
char **
g_strfreev
v
Generic value container
G_TYPE_VALUE
GValue *
g_value_unset
The calling conventions for values expect that method callers have allocated return values; see below.
The next most common recursive type signatures are arrays of
basic values. The most obvious mapping for arrays of basic
types is a GArray. Now, GLib does not
provide a builtin GType for
GArray. However, we actually need more than
that - we need a "parameterized" type which includes the
contained type. Why we need this we will see below.
The approach taken is to create these types in the D-BUS GLib
bindings; however, there is nothing D-BUS specific about them.
In the future, we hope to include such "fundamental" types in GLib
itself.
D-BUS type signature
Description
GType
C typedef
Free function
Notes
ay
Array of bytes
DBUS_TYPE_G_BYTE_ARRAY
GArray *
g_array_free
au
Array of uint
DBUS_TYPE_G_UINT_ARRAY
GArray *
g_array_free
ai
Array of int
DBUS_TYPE_G_INT_ARRAY
GArray *
g_array_free
ax
Array of int64
DBUS_TYPE_G_INT64_ARRAY
GArray *
g_array_free
at
Array of uint64
DBUS_TYPE_G_UINT64_ARRAY
GArray *
g_array_free
ad
Array of double
DBUS_TYPE_G_DOUBLE_ARRAY
GArray *
g_array_free
ab
Array of boolean
DBUS_TYPE_G_BOOLEAN_ARRAY
GArray *
g_array_free
D-BUS also includes a special type DBUS_TYPE_DICT_ENTRY which
is only valid in arrays. It's intended to be mapped to a "dictionary"
type by bindings. The obvious GLib mapping here is GHashTable. Again,
however, there is no builtin GType for a GHashTable.
Moreover, just like for arrays, we need a parameterized type so that
the bindings can communiate which types are contained in the hash table.
At present, only strings are supported. Work is in progress to
include more types.
D-BUS type signature
Description
GType
C typedef
Free function
Notes
a{ss}
Dictionary mapping strings to strings
DBUS_TYPE_G_STRING_STRING_HASHTABLE
GHashTable *
g_hash_table_destroy
Arbitrarily recursive type mappings
Finally, it is possible users will want to write or invoke D-BUS
methods which have arbitrarily complex type signatures not
directly supported by these bindings. For this case, we have a
DBusGValue which acts as a kind of special
variant value which may be iterated over manually. The
GType associated is
DBUS_TYPE_G_VALUE.
TODO insert usage of DBUS_TYPE_G_VALUE here.
A sample program
Here is a D-BUS program using the GLib bindings.
int
main (int argc, char **argv)
{
DBusGConnection *connection;
GError *error;
DBusGProxy *proxy;
char **name_list;
char **name_list_ptr;
g_type_init ();
error = NULL;
connection = dbus_g_bus_get (DBUS_BUS_SESSION,
&error);
if (connection == NULL)
{
g_printerr ("Failed to open connection to bus: %s\n",
error->message);
g_error_free (error);
exit (1);
}
/* Create a proxy object for the "bus driver" (name "org.freedesktop.DBus") */
proxy = dbus_g_proxy_new_for_name (connection,
DBUS_SERVICE_ORG_FREEDESKTOP_DBUS,
DBUS_PATH_ORG_FREEDESKTOP_DBUS,
DBUS_INTERFACE_ORG_FREEDESKTOP_DBUS);
/* Call ListNames method, wait for reply */
error = NULL;
if (!dbus_g_proxy_invoke (proxy, "ListNames", &error, G_TYPE_INVALID,
G_TYPE_STRV, &name_list, G_TYPE_INVALID))
{
g_printerr ("Failed to complete ListNames call: %s\n",
error->message);
g_error_free (error);
exit (1);
}
/* Print the results */
g_print ("Names on the message bus:\n");
for (name_list_ptr = name_list; *name_list_ptr; name_list_ptr++)
{
g_print (" %s\n", *name_list_ptr);
}
g_strfreev (name_list);
g_object_unref (proxy);
return 0;
}
Program initalization
A connection to the bus is acquired using
dbus_g_bus_get. Next, a proxy
is created for the object "/org/freedesktop/DBus" with
interface org.freedesktop.DBus
on the service org.freedesktop.DBus.
This is a proxy for the message bus itself.
Understanding method invocation
You have a number of choices for method invocation. First, as
used above, dbus_g_proxy_invoke sends a
method call to the remote object, and blocks until reply is
recieved. The outgoing arguments are specified in the varargs
array, terminated with G_TYPE_INVALID.
Next, pointers to return values are specified, followed again
by G_TYPE_INVALID.
To invoke a method asynchronously, use
dbus_g_proxy_begin_call. This returns a
DBusGPendingCall object; you may then set a
notification function using
dbus_g_pending_call_set_notify.
Connecting to object signals
You may connect to signals using
dbus_g_proxy_add_signal and
dbus_g_proxy_connect_signal. At the
moment, dbus_g_proxy_add_signal requires
the D-BUS types of the remote object; this will likely be
changed later.
More examples of method invocation
Sending an integer and string, receiving an array of bytes
GArray *arr;
error = NULL;
if (!dbus_g_proxy_invoke (proxy, "Foobar", &error,
G_TYPE_INT, 42, G_TYPE_STRING, "hello",
G_TYPE_INVALID,
DBUS_TYPE_G_UCHAR_ARRAY, &arr, G_TYPE_INVALID))
{
g_printerr ("Failed to complete Foobar: %s\n",
error->message);
g_error_free (error);
exit (1);
}
g_assert (arr != NULL);
printf ("got back %u values", arr->len);
Sending a GHashTable
GHashTable *hash = g_hash_table_new (g_str_hash, g_str_equal);
guint32 ret;
g_hash_table_insert (hash, "foo", "bar");
g_hash_table_insert (hash, "baz", "whee");
error = NULL;
if (!dbus_g_proxy_invoke (proxy, "HashSize", &error,
DBUS_TYPE_G_STRING_STRING_HASH, hash, G_TYPE_INVALID,
G_TYPE_UINT, &ret, G_TYPE_INVALID))
{
g_printerr ("Failed to complete HashSize: %s\n",
error->message);
g_error_free (error);
exit (1);
}
g_assert (ret == 2);
g_hash_table_destroy (hash);
Receiving a boolean and a string
gboolean boolret;
char *strret;
error = NULL;
if (!dbus_g_proxy_invoke (proxy, "GetStuff", &error,
G_TYPE_INVALID,
G_TYPE_BOOLEAN, &boolret,
G_TYPE_STRING, &strret,
G_TYPE_INVALID))
{
g_printerr ("Failed to complete GetStuff: %s\n",
error->message);
g_error_free (error);
exit (1);
}
printf ("%s %s", boolret ? "TRUE" : "FALSE", strret);
g_free (strret);
Sending two arrays of strings
/* NULL terminate */
char *strs_static[] = {"foo", "bar", "baz", NULL};
/* Take pointer to array; cannot pass array directly */
char **strs_static_p = strs_static;
char **strs_dynamic;
strs_dynamic = g_new (char *, 4);
strs_dynamic[0] = g_strdup ("hello");
strs_dynamic[1] = g_strdup ("world");
strs_dynamic[2] = g_strdup ("!");
/* NULL terminate */
strs_dynamic[3] = NULL;
error = NULL;
if (!dbus_g_proxy_invoke (proxy, "TwoStrArrays", &error,
G_TYPE_STRV, strs_static_p,
G_TYPE_STRV, strs_dynamic,
G_TYPE_INVALID,
G_TYPE_INVALID))
{
g_printerr ("Failed to complete TwoStrArrays: %s\n",
error->message);
g_error_free (error);
exit (1);
}
g_strfreev (strs_dynamic);
Sending a boolean, receiving an array of strings
char **strs;
char **strs_p;
gboolean blah;
error = NULL;
blah = TRUE;
if (!dbus_g_proxy_invoke (proxy, "GetStrs", &error,
G_TYPE_BOOLEAN, blah,
G_TYPE_INVALID,
G_TYPE_STRV, &strs,
G_TYPE_INVALID))
{
g_printerr ("Failed to complete GetStrs: %s\n",
error->message);
g_error_free (error);
exit (1);
}
for (strs_p = strs; *strs_p; strs_p++)
printf ("got string: \"%s\"", *strs_p);
g_strfreev (strs);
Sending a variant
GValue val = {0, };
g_value_init (&val, G_TYPE_STRING);
g_value_set_string (&val, "hello world");
error = NULL;
if (!dbus_g_proxy_invoke (proxy, "SendVariant", &error,
G_TYPE_VALUE, &val, G_TYPE_INVALID,
G_TYPE_INVALID))
{
g_printerr ("Failed to complete SendVariant: %s\n",
error->message);
g_error_free (error);
exit (1);
}
g_assert (ret == 2);
g_value_unset (&val);
Receiving a variant
GValue val = {0, };
error = NULL;
if (!dbus_g_proxy_invoke (proxy, "GetVariant", &error, G_TYPE_INVALID,
G_TYPE_VALUE, &val, G_TYPE_INVALID))
{
g_printerr ("Failed to complete GetVariant: %s\n",
error->message);
g_error_free (error);
exit (1);
}
if (G_VALUE_TYPE (&val) == G_TYPE_STRING)
printf ("%s\n", g_value_get_string (&val));
else if (G_VALUE_TYPE (&val) == G_TYPE_INT)
printf ("%d\n", g_value_get_int (&val));
else
...
g_value_unset (&val);
GLib API: Implementing Objects
At the moment, to expose a GObject via D-BUS, you must
write XML by hand which describes the methods exported
by the object. In the future, this manual step will
be obviated by the upcoming GLib introspection support.
Here is a sample XML file which describes an object that exposes
one method, named ManyArgs.
<?xml version="1.0" encoding="UTF-8" ?>
<node name="/com/example/MyObject">
<interface name="com.example.MyObject">
<annotation name="org.freedesktop.DBus.GLib.CSymbol" value="my_object"/>
<method name="ManyArgs">
<!-- This is optional, and in this case is redunundant -->
<annotation name="org.freedesktop.DBus.GLib.CSymbol" value="my_object_many_args"/>
<arg type="u" name="x" direction="in" />
<arg type="s" name="str" direction="in" />
<arg type="d" name="trouble" direction="in" />
<arg type="d" name="d_ret" direction="out" />
<arg type="s" name="str_ret" direction="out" />
</method>
</interface>
</node>
This XML is in the same format as the D-BUS introspection XML
format. Except we must include an "annotation" which give the C
symbols corresponding to the object implementation prefix
(my_object). In addition, if particular
methods symbol names deviate from C convention
(i.e. ManyArgs ->
many_args), you may specify an annotation
giving the C symbol.
Once you have written this XML, run dbus-binding-tool --mode=glib-server FILENAME > HEADER_NAME. to
generate a header file. For example: dbus-binding-tool --mode=glib-server my-objet.xml > my-object-glue.h.
Next, include the generated header in your program, and invoke
dbus_g_object_class_install_info, passing the
object class and "object info" included in the header. For
example:
dbus_g_object_type_install_info (COM_FOO_TYPE_MY_OBJECT, &com_foo_my_object_info);
This should be done exactly once per object class.
To actually implement the method, just define a C function named e.g.
my_object_many_args in the same file as the info
header is included. At the moment, it is required that this function
conform to the following rules:
The function must return a value of type gboolean;
TRUE on success, and FALSE
otherwise.
The first parameter is a pointer to an instance of the object.
Following the object instance pointer are the method
input values.
Following the input values are pointers to return values.
The final parameter must be a GError **.
If the function returns FALSE for an
error, the error parameter must be initalized with
g_set_error.
Finally, you can export an object using dbus_g_connection_register_g_object. For example:
dbus_g_connection_register_g_object (connection,
"/com/foo/MyObject",
obj);
Qt API: Using Remote Objects
The Qt bindings are not yet documented.
Qt API: Implementing Objects
The Qt bindings are not yet documented.
Python API: Using Remote Objects
The Python bindings are not yet documented, but the
bindings themselves are in good shape.
Python API: Implementing Objects
The Python bindings are not yet documented, but the
bindings themselves are in good shape.