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))
315 dbus_set_error (error, DBUS_ERROR_ACCESS_DENIED,
316 "Connection \"%s\" is not allowed to own the service \"%s\" due "
318 bus_connection_is_active (connection) ?
319 bus_connection_get_name (connection) :
321 _dbus_string_get_const_data (service_name));
325 if (!bus_client_policy_check_can_own (policy, connection,
328 dbus_set_error (error, DBUS_ERROR_ACCESS_DENIED,
329 "Connection \"%s\" is not allowed to own the service \"%s\" due "
330 "to security policies in the configuration file",
331 bus_connection_is_active (connection) ?
332 bus_connection_get_name (connection) :
334 _dbus_string_get_const_data (service_name));
338 if (bus_connection_get_n_services_owned (connection) >=
339 bus_context_get_max_services_per_connection (registry->context))
341 dbus_set_error (error, DBUS_ERROR_LIMITS_EXCEEDED,
342 "Connection \"%s\" is not allowed to own more services "
343 "(increase limits in configuration file if required)",
344 bus_connection_is_active (connection) ?
345 bus_connection_get_name (connection) :
350 service = bus_registry_lookup (registry, service_name);
353 old_owner = bus_service_get_primary_owner (service);
359 service = bus_registry_ensure (registry,
360 service_name, connection, transaction, error);
365 current_owner = bus_service_get_primary_owner (service);
367 if (old_owner == NULL)
369 _dbus_assert (current_owner == connection);
371 bus_service_set_prohibit_replacement (service,
372 (flags & DBUS_SERVICE_FLAG_PROHIBIT_REPLACEMENT));
374 *result = DBUS_SERVICE_REPLY_PRIMARY_OWNER;
376 else if (old_owner == connection)
377 *result = DBUS_SERVICE_REPLY_ALREADY_OWNER;
378 else if (!((flags & DBUS_SERVICE_FLAG_REPLACE_EXISTING)))
379 *result = DBUS_SERVICE_REPLY_SERVICE_EXISTS;
380 else if (bus_service_get_prohibit_replacement (service))
382 /* Queue the connection */
383 if (!bus_service_add_owner (service, connection,
387 *result = DBUS_SERVICE_REPLY_IN_QUEUE;
391 /* Replace the current owner */
393 /* We enqueue the new owner and remove the first one because
394 * that will cause ServiceAcquired and ServiceLost messages to
398 if (!bus_service_add_owner (service, connection,
402 if (!bus_service_remove_owner (service, old_owner,
406 _dbus_assert (connection == bus_service_get_primary_owner (service));
407 *result = DBUS_SERVICE_REPLY_PRIMARY_OWNER;
410 activation = bus_context_get_activation (registry->context);
411 retval = bus_activation_send_pending_auto_activation_messages (activation,
421 bus_registry_set_service_sid_table (BusRegistry *registry,
422 DBusHashTable *table)
424 _dbus_assert (registry->service_sid_table != table);
426 if (registry->service_sid_table)
427 _dbus_hash_table_unref (registry->service_sid_table);
429 registry->service_sid_table = table;
430 _dbus_hash_table_ref (table);
434 bus_service_unlink_owner (BusService *service,
435 DBusConnection *owner)
437 _dbus_list_remove_last (&service->owners, owner);
438 bus_connection_remove_owned_service (owner, service);
442 bus_service_unlink (BusService *service)
444 _dbus_assert (service->owners == NULL);
446 /* the service may not be in the hash, if
447 * the failure causing transaction cancel
448 * was in the right place, but that's OK
450 _dbus_hash_table_remove_string (service->registry->service_hash,
453 bus_service_unref (service);
457 bus_service_relink (BusService *service,
458 DBusPreallocatedHash *preallocated)
460 _dbus_assert (service->owners == NULL);
461 _dbus_assert (preallocated != NULL);
463 _dbus_hash_table_insert_string_preallocated (service->registry->service_hash,
468 bus_service_ref (service);
472 * Data used to represent an ownership cancellation in
477 DBusConnection *connection; /**< the connection */
478 BusService *service; /**< service to cancel ownership of */
479 } OwnershipCancelData;
482 cancel_ownership (void *data)
484 OwnershipCancelData *d = data;
486 /* We don't need to send messages notifying of these
487 * changes, since we're reverting something that was
488 * cancelled (effectively never really happened)
490 bus_service_unlink_owner (d->service, d->connection);
492 if (d->service->owners == NULL)
493 bus_service_unlink (d->service);
497 free_ownership_cancel_data (void *data)
499 OwnershipCancelData *d = data;
501 dbus_connection_unref (d->connection);
502 bus_service_unref (d->service);
508 add_cancel_ownership_to_transaction (BusTransaction *transaction,
510 DBusConnection *connection)
512 OwnershipCancelData *d;
514 d = dbus_new (OwnershipCancelData, 1);
518 d->service = service;
519 d->connection = connection;
521 if (!bus_transaction_add_cancel_hook (transaction, cancel_ownership, d,
522 free_ownership_cancel_data))
528 bus_service_ref (d->service);
529 dbus_connection_ref (d->connection);
534 /* this function is self-cancelling if you cancel the transaction */
536 bus_service_add_owner (BusService *service,
537 DBusConnection *owner,
538 BusTransaction *transaction,
541 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
543 /* Send service acquired message first, OOM will result
544 * in cancelling the transaction
546 if (service->owners == NULL)
548 if (!bus_driver_send_service_acquired (owner, service->name, transaction, error))
552 if (!_dbus_list_append (&service->owners,
559 if (!bus_connection_add_owned_service (owner, service))
561 _dbus_list_remove_last (&service->owners, owner);
566 if (!add_cancel_ownership_to_transaction (transaction,
570 bus_service_unlink_owner (service, owner);
580 DBusConnection *connection;
582 DBusConnection *before_connection; /* restore to position before this connection in owners list */
583 DBusList *connection_link;
584 DBusList *service_link;
585 DBusPreallocatedHash *hash_entry;
586 } OwnershipRestoreData;
589 restore_ownership (void *data)
591 OwnershipRestoreData *d = data;
594 _dbus_assert (d->service_link != NULL);
595 _dbus_assert (d->connection_link != NULL);
597 if (d->service->owners == NULL)
599 _dbus_assert (d->hash_entry != NULL);
600 bus_service_relink (d->service, d->hash_entry);
604 _dbus_assert (d->hash_entry == NULL);
607 /* We don't need to send messages notifying of these
608 * changes, since we're reverting something that was
609 * cancelled (effectively never really happened)
611 link = _dbus_list_get_first_link (&d->service->owners);
614 if (link->data == d->before_connection)
617 link = _dbus_list_get_next_link (&d->service->owners, link);
620 _dbus_list_insert_before_link (&d->service->owners, link, d->connection_link);
622 /* Note that removing then restoring this changes the order in which
623 * ServiceDeleted messages are sent on destruction of the
624 * connection. This should be OK as the only guarantee there is
625 * that the base service is destroyed last, and we never even
626 * tentatively remove the base service.
628 bus_connection_add_owned_service_link (d->connection, d->service_link);
630 d->hash_entry = NULL;
631 d->service_link = NULL;
632 d->connection_link = NULL;
636 free_ownership_restore_data (void *data)
638 OwnershipRestoreData *d = data;
641 _dbus_list_free_link (d->service_link);
642 if (d->connection_link)
643 _dbus_list_free_link (d->connection_link);
645 _dbus_hash_table_free_preallocated_entry (d->service->registry->service_hash,
648 dbus_connection_unref (d->connection);
649 bus_service_unref (d->service);
655 add_restore_ownership_to_transaction (BusTransaction *transaction,
657 DBusConnection *connection)
659 OwnershipRestoreData *d;
662 d = dbus_new (OwnershipRestoreData, 1);
666 d->service = service;
667 d->connection = connection;
668 d->service_link = _dbus_list_alloc_link (service);
669 d->connection_link = _dbus_list_alloc_link (connection);
670 d->hash_entry = _dbus_hash_table_preallocate_entry (service->registry->service_hash);
672 bus_service_ref (d->service);
673 dbus_connection_ref (d->connection);
675 d->before_connection = NULL;
676 link = _dbus_list_get_first_link (&service->owners);
679 if (link->data == connection)
681 link = _dbus_list_get_next_link (&service->owners, link);
684 d->before_connection = link->data;
689 link = _dbus_list_get_next_link (&service->owners, link);
692 if (d->service_link == NULL ||
693 d->connection_link == NULL ||
694 d->hash_entry == NULL ||
695 !bus_transaction_add_cancel_hook (transaction, restore_ownership, d,
696 free_ownership_restore_data))
698 free_ownership_restore_data (d);
705 /* this function is self-cancelling if you cancel the transaction */
707 bus_service_remove_owner (BusService *service,
708 DBusConnection *owner,
709 BusTransaction *transaction,
712 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
714 /* We send out notifications before we do any work we
715 * might have to undo if the notification-sending failed
718 /* Send service lost message */
719 if (bus_service_get_primary_owner (service) == owner)
721 if (!bus_driver_send_service_lost (owner, service->name,
726 if (service->owners == NULL)
728 _dbus_assert_not_reached ("Tried to remove owner of a service that has no owners");
730 else if (_dbus_list_length_is_one (&service->owners))
732 if (!bus_driver_send_service_owner_changed (service->name,
733 bus_connection_get_name (owner),
741 DBusConnection *new_owner;
742 link = _dbus_list_get_first_link (&service->owners);
743 _dbus_assert (link != NULL);
744 link = _dbus_list_get_next_link (&service->owners, link);
745 _dbus_assert (link != NULL);
747 new_owner = link->data;
749 if (!bus_driver_send_service_owner_changed (service->name,
750 bus_connection_get_name (owner),
751 bus_connection_get_name (new_owner),
755 /* This will be our new owner */
756 if (!bus_driver_send_service_acquired (new_owner,
763 if (!add_restore_ownership_to_transaction (transaction, service, owner))
769 bus_service_unlink_owner (service, owner);
771 if (service->owners == NULL)
772 bus_service_unlink (service);
778 bus_service_ref (BusService *service)
780 _dbus_assert (service->refcount > 0);
782 service->refcount += 1;
788 bus_service_unref (BusService *service)
790 _dbus_assert (service->refcount > 0);
792 service->refcount -= 1;
794 if (service->refcount == 0)
796 _dbus_assert (service->owners == NULL);
798 dbus_free (service->name);
799 _dbus_mem_pool_dealloc (service->registry->service_pool, service);
804 bus_service_get_primary_owner (BusService *service)
806 return _dbus_list_get_first (&service->owners);
810 bus_service_get_name (BusService *service)
812 return service->name;
816 bus_service_set_prohibit_replacement (BusService *service,
817 dbus_bool_t prohibit_replacement)
819 service->prohibit_replacement = prohibit_replacement != FALSE;
823 bus_service_get_prohibit_replacement (BusService *service)
825 return service->prohibit_replacement;
829 bus_service_has_owner (BusService *service,
830 DBusConnection *owner)
834 link = _dbus_list_get_first_link (&service->owners);
838 if (link->data == owner)
841 link = _dbus_list_get_next_link (&service->owners, link);