1 /* -*- mode: C; c-file-style: "gnu" -*- */
2 /* services.c Service management
4 * Copyright (C) 2003 Red Hat, Inc.
5 * Copyright (C) 2003 CodeFactory AB
7 * Licensed under the Academic Free License version 2.1
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
24 #include <dbus/dbus-hash.h>
25 #include <dbus/dbus-list.h>
26 #include <dbus/dbus-mempool.h>
30 #include "connection.h"
32 #include "activation.h"
41 BusRegistry *registry;
45 unsigned int prohibit_replacement : 1;
54 DBusHashTable *service_hash;
55 DBusMemPool *service_pool;
57 DBusHashTable *service_sid_table;
61 bus_registry_new (BusContext *context)
63 BusRegistry *registry;
65 registry = dbus_new0 (BusRegistry, 1);
69 registry->refcount = 1;
70 registry->context = context;
72 registry->service_hash = _dbus_hash_table_new (DBUS_HASH_STRING,
74 if (registry->service_hash == NULL)
77 registry->service_pool = _dbus_mem_pool_new (sizeof (BusService),
79 if (registry->service_pool == NULL)
82 registry->service_sid_table = NULL;
87 bus_registry_unref (registry);
92 bus_registry_ref (BusRegistry *registry)
94 _dbus_assert (registry->refcount > 0);
95 registry->refcount += 1;
101 bus_registry_unref (BusRegistry *registry)
103 _dbus_assert (registry->refcount > 0);
104 registry->refcount -= 1;
106 if (registry->refcount == 0)
108 if (registry->service_hash)
109 _dbus_hash_table_unref (registry->service_hash);
110 if (registry->service_pool)
111 _dbus_mem_pool_free (registry->service_pool);
112 if (registry->service_sid_table)
113 _dbus_hash_table_unref (registry->service_sid_table);
115 dbus_free (registry);
120 bus_registry_lookup (BusRegistry *registry,
121 const DBusString *service_name)
125 service = _dbus_hash_table_lookup_string (registry->service_hash,
126 _dbus_string_get_const_data (service_name));
132 bus_registry_ensure (BusRegistry *registry,
133 const DBusString *service_name,
134 DBusConnection *owner_if_created,
135 BusTransaction *transaction,
140 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
142 _dbus_assert (owner_if_created != NULL);
143 _dbus_assert (transaction != NULL);
145 service = _dbus_hash_table_lookup_string (registry->service_hash,
146 _dbus_string_get_const_data (service_name));
150 service = _dbus_mem_pool_alloc (registry->service_pool);
157 service->registry = registry;
158 service->refcount = 1;
160 if (!_dbus_string_copy_data (service_name, &service->name))
162 _dbus_mem_pool_dealloc (registry->service_pool, service);
167 if (!bus_driver_send_service_owner_changed (service->name,
169 bus_connection_get_name (owner_if_created),
172 bus_service_unref (service);
176 if (!bus_activation_service_created (bus_context_get_activation (registry->context),
177 service->name, transaction, error))
179 bus_service_unref (service);
183 if (!bus_service_add_owner (service, owner_if_created,
186 bus_service_unref (service);
190 if (!_dbus_hash_table_insert_string (registry->service_hash,
194 /* The add_owner gets reverted on transaction cancel */
203 bus_registry_foreach (BusRegistry *registry,
204 BusServiceForeachFunction function,
209 _dbus_hash_iter_init (registry->service_hash, &iter);
210 while (_dbus_hash_iter_next (&iter))
212 BusService *service = _dbus_hash_iter_get_value (&iter);
214 (* function) (service, data);
219 bus_registry_list_services (BusRegistry *registry,
227 len = _dbus_hash_table_get_n_entries (registry->service_hash);
228 retval = dbus_new (char *, len + 1);
233 _dbus_hash_iter_init (registry->service_hash, &iter);
235 while (_dbus_hash_iter_next (&iter))
237 BusService *service = _dbus_hash_iter_get_value (&iter);
239 retval[i] = _dbus_strdup (service->name);
240 if (retval[i] == NULL)
255 for (j = 0; j < i; j++)
256 dbus_free (retval[i]);
263 bus_registry_acquire_service (BusRegistry *registry,
264 DBusConnection *connection,
265 const DBusString *service_name,
267 dbus_uint32_t *result,
268 BusTransaction *transaction,
272 DBusConnection *old_owner;
273 DBusConnection *current_owner;
274 BusClientPolicy *policy;
276 BusActivation *activation;
281 if (_dbus_string_get_length (service_name) == 0)
283 dbus_set_error (error, DBUS_ERROR_ACCESS_DENIED,
284 "Zero-length service name is not allowed");
286 _dbus_verbose ("Attempt to acquire zero-length service name\n");
291 if (_dbus_string_get_byte (service_name, 0) == ':')
293 /* Not allowed; only base services can start with ':' */
294 dbus_set_error (error, DBUS_ERROR_ACCESS_DENIED,
295 "Cannot acquire a service starting with ':' such as \"%s\"",
296 _dbus_string_get_const_data (service_name));
298 _dbus_verbose ("Attempt to acquire invalid base service name \"%s\"",
299 _dbus_string_get_const_data (service_name));
304 policy = bus_connection_get_policy (connection);
305 _dbus_assert (policy != NULL);
307 /* Note that if sid is #NULL then the bus's own context gets used
308 * in bus_connection_selinux_allows_acquire_service()
310 sid = bus_selinux_id_table_lookup (registry->service_sid_table,
313 if (!bus_selinux_allows_acquire_service (connection, sid,
314 _dbus_string_get_const_data (service_name)))
316 dbus_set_error (error, DBUS_ERROR_ACCESS_DENIED,
317 "Connection \"%s\" is not allowed to own the service \"%s\" due "
319 bus_connection_is_active (connection) ?
320 bus_connection_get_name (connection) :
322 _dbus_string_get_const_data (service_name));
326 if (!bus_client_policy_check_can_own (policy, connection,
329 dbus_set_error (error, DBUS_ERROR_ACCESS_DENIED,
330 "Connection \"%s\" is not allowed to own the service \"%s\" due "
331 "to security policies in the configuration file",
332 bus_connection_is_active (connection) ?
333 bus_connection_get_name (connection) :
335 _dbus_string_get_const_data (service_name));
339 if (bus_connection_get_n_services_owned (connection) >=
340 bus_context_get_max_services_per_connection (registry->context))
342 dbus_set_error (error, DBUS_ERROR_LIMITS_EXCEEDED,
343 "Connection \"%s\" is not allowed to own more services "
344 "(increase limits in configuration file if required)",
345 bus_connection_is_active (connection) ?
346 bus_connection_get_name (connection) :
351 service = bus_registry_lookup (registry, service_name);
354 old_owner = bus_service_get_primary_owner (service);
360 service = bus_registry_ensure (registry,
361 service_name, connection, transaction, error);
366 current_owner = bus_service_get_primary_owner (service);
368 if (old_owner == NULL)
370 _dbus_assert (current_owner == connection);
372 bus_service_set_prohibit_replacement (service,
373 (flags & DBUS_SERVICE_FLAG_PROHIBIT_REPLACEMENT));
375 *result = DBUS_SERVICE_REPLY_PRIMARY_OWNER;
377 else if (old_owner == connection)
378 *result = DBUS_SERVICE_REPLY_ALREADY_OWNER;
379 else if (!((flags & DBUS_SERVICE_FLAG_REPLACE_EXISTING)))
380 *result = DBUS_SERVICE_REPLY_SERVICE_EXISTS;
381 else if (bus_service_get_prohibit_replacement (service))
383 /* Queue the connection */
384 if (!bus_service_add_owner (service, connection,
388 *result = DBUS_SERVICE_REPLY_IN_QUEUE;
392 /* Replace the current owner */
394 /* We enqueue the new owner and remove the first one because
395 * that will cause ServiceAcquired and ServiceLost messages to
399 if (!bus_service_add_owner (service, connection,
403 if (!bus_service_remove_owner (service, old_owner,
407 _dbus_assert (connection == bus_service_get_primary_owner (service));
408 *result = DBUS_SERVICE_REPLY_PRIMARY_OWNER;
411 activation = bus_context_get_activation (registry->context);
412 retval = bus_activation_send_pending_auto_activation_messages (activation,
422 bus_registry_set_service_context_table (BusRegistry *registry,
423 DBusHashTable *table)
425 DBusHashTable *new_table;
428 new_table = bus_selinux_id_table_new ();
432 _dbus_hash_iter_init (table, &iter);
433 while (_dbus_hash_iter_next (&iter))
435 const char *service = _dbus_hash_iter_get_string_key (&iter);
436 const char *context = _dbus_hash_iter_get_value (&iter);
438 if (!bus_selinux_id_table_insert (new_table,
444 if (registry->service_sid_table)
445 _dbus_hash_table_unref (registry->service_sid_table);
446 registry->service_sid_table = new_table;
451 bus_service_unlink_owner (BusService *service,
452 DBusConnection *owner)
454 _dbus_list_remove_last (&service->owners, owner);
455 bus_connection_remove_owned_service (owner, service);
459 bus_service_unlink (BusService *service)
461 _dbus_assert (service->owners == NULL);
463 /* the service may not be in the hash, if
464 * the failure causing transaction cancel
465 * was in the right place, but that's OK
467 _dbus_hash_table_remove_string (service->registry->service_hash,
470 bus_service_unref (service);
474 bus_service_relink (BusService *service,
475 DBusPreallocatedHash *preallocated)
477 _dbus_assert (service->owners == NULL);
478 _dbus_assert (preallocated != NULL);
480 _dbus_hash_table_insert_string_preallocated (service->registry->service_hash,
485 bus_service_ref (service);
489 * Data used to represent an ownership cancellation in
494 DBusConnection *connection; /**< the connection */
495 BusService *service; /**< service to cancel ownership of */
496 } OwnershipCancelData;
499 cancel_ownership (void *data)
501 OwnershipCancelData *d = data;
503 /* We don't need to send messages notifying of these
504 * changes, since we're reverting something that was
505 * cancelled (effectively never really happened)
507 bus_service_unlink_owner (d->service, d->connection);
509 if (d->service->owners == NULL)
510 bus_service_unlink (d->service);
514 free_ownership_cancel_data (void *data)
516 OwnershipCancelData *d = data;
518 dbus_connection_unref (d->connection);
519 bus_service_unref (d->service);
525 add_cancel_ownership_to_transaction (BusTransaction *transaction,
527 DBusConnection *connection)
529 OwnershipCancelData *d;
531 d = dbus_new (OwnershipCancelData, 1);
535 d->service = service;
536 d->connection = connection;
538 if (!bus_transaction_add_cancel_hook (transaction, cancel_ownership, d,
539 free_ownership_cancel_data))
545 bus_service_ref (d->service);
546 dbus_connection_ref (d->connection);
551 /* this function is self-cancelling if you cancel the transaction */
553 bus_service_add_owner (BusService *service,
554 DBusConnection *owner,
555 BusTransaction *transaction,
558 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
560 /* Send service acquired message first, OOM will result
561 * in cancelling the transaction
563 if (service->owners == NULL)
565 if (!bus_driver_send_service_acquired (owner, service->name, transaction, error))
569 if (!_dbus_list_append (&service->owners,
576 if (!bus_connection_add_owned_service (owner, service))
578 _dbus_list_remove_last (&service->owners, owner);
583 if (!add_cancel_ownership_to_transaction (transaction,
587 bus_service_unlink_owner (service, owner);
597 DBusConnection *connection;
599 DBusConnection *before_connection; /* restore to position before this connection in owners list */
600 DBusList *connection_link;
601 DBusList *service_link;
602 DBusPreallocatedHash *hash_entry;
603 } OwnershipRestoreData;
606 restore_ownership (void *data)
608 OwnershipRestoreData *d = data;
611 _dbus_assert (d->service_link != NULL);
612 _dbus_assert (d->connection_link != NULL);
614 if (d->service->owners == NULL)
616 _dbus_assert (d->hash_entry != NULL);
617 bus_service_relink (d->service, d->hash_entry);
621 _dbus_assert (d->hash_entry == NULL);
624 /* We don't need to send messages notifying of these
625 * changes, since we're reverting something that was
626 * cancelled (effectively never really happened)
628 link = _dbus_list_get_first_link (&d->service->owners);
631 if (link->data == d->before_connection)
634 link = _dbus_list_get_next_link (&d->service->owners, link);
637 _dbus_list_insert_before_link (&d->service->owners, link, d->connection_link);
639 /* Note that removing then restoring this changes the order in which
640 * ServiceDeleted messages are sent on destruction of the
641 * connection. This should be OK as the only guarantee there is
642 * that the base service is destroyed last, and we never even
643 * tentatively remove the base service.
645 bus_connection_add_owned_service_link (d->connection, d->service_link);
647 d->hash_entry = NULL;
648 d->service_link = NULL;
649 d->connection_link = NULL;
653 free_ownership_restore_data (void *data)
655 OwnershipRestoreData *d = data;
658 _dbus_list_free_link (d->service_link);
659 if (d->connection_link)
660 _dbus_list_free_link (d->connection_link);
662 _dbus_hash_table_free_preallocated_entry (d->service->registry->service_hash,
665 dbus_connection_unref (d->connection);
666 bus_service_unref (d->service);
672 add_restore_ownership_to_transaction (BusTransaction *transaction,
674 DBusConnection *connection)
676 OwnershipRestoreData *d;
679 d = dbus_new (OwnershipRestoreData, 1);
683 d->service = service;
684 d->connection = connection;
685 d->service_link = _dbus_list_alloc_link (service);
686 d->connection_link = _dbus_list_alloc_link (connection);
687 d->hash_entry = _dbus_hash_table_preallocate_entry (service->registry->service_hash);
689 bus_service_ref (d->service);
690 dbus_connection_ref (d->connection);
692 d->before_connection = NULL;
693 link = _dbus_list_get_first_link (&service->owners);
696 if (link->data == connection)
698 link = _dbus_list_get_next_link (&service->owners, link);
701 d->before_connection = link->data;
706 link = _dbus_list_get_next_link (&service->owners, link);
709 if (d->service_link == NULL ||
710 d->connection_link == NULL ||
711 d->hash_entry == NULL ||
712 !bus_transaction_add_cancel_hook (transaction, restore_ownership, d,
713 free_ownership_restore_data))
715 free_ownership_restore_data (d);
722 /* this function is self-cancelling if you cancel the transaction */
724 bus_service_remove_owner (BusService *service,
725 DBusConnection *owner,
726 BusTransaction *transaction,
729 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
731 /* We send out notifications before we do any work we
732 * might have to undo if the notification-sending failed
735 /* Send service lost message */
736 if (bus_service_get_primary_owner (service) == owner)
738 if (!bus_driver_send_service_lost (owner, service->name,
743 if (service->owners == NULL)
745 _dbus_assert_not_reached ("Tried to remove owner of a service that has no owners");
747 else if (_dbus_list_length_is_one (&service->owners))
749 if (!bus_driver_send_service_owner_changed (service->name,
750 bus_connection_get_name (owner),
758 DBusConnection *new_owner;
759 link = _dbus_list_get_first_link (&service->owners);
760 _dbus_assert (link != NULL);
761 link = _dbus_list_get_next_link (&service->owners, link);
762 _dbus_assert (link != NULL);
764 new_owner = link->data;
766 if (!bus_driver_send_service_owner_changed (service->name,
767 bus_connection_get_name (owner),
768 bus_connection_get_name (new_owner),
772 /* This will be our new owner */
773 if (!bus_driver_send_service_acquired (new_owner,
780 if (!add_restore_ownership_to_transaction (transaction, service, owner))
786 bus_service_unlink_owner (service, owner);
788 if (service->owners == NULL)
789 bus_service_unlink (service);
795 bus_service_ref (BusService *service)
797 _dbus_assert (service->refcount > 0);
799 service->refcount += 1;
805 bus_service_unref (BusService *service)
807 _dbus_assert (service->refcount > 0);
809 service->refcount -= 1;
811 if (service->refcount == 0)
813 _dbus_assert (service->owners == NULL);
815 dbus_free (service->name);
816 _dbus_mem_pool_dealloc (service->registry->service_pool, service);
821 bus_service_get_primary_owner (BusService *service)
823 return _dbus_list_get_first (&service->owners);
827 bus_service_get_name (BusService *service)
829 return service->name;
833 bus_service_set_prohibit_replacement (BusService *service,
834 dbus_bool_t prohibit_replacement)
836 service->prohibit_replacement = prohibit_replacement != FALSE;
840 bus_service_get_prohibit_replacement (BusService *service)
842 return service->prohibit_replacement;
846 bus_service_has_owner (BusService *service,
847 DBusConnection *owner)
851 link = _dbus_list_get_first_link (&service->owners);
855 if (link->data == owner)
858 link = _dbus_list_get_next_link (&service->owners, link);