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 _dbus_verbose ("copying string %p '%s' to service->name\n",
161 service_name, _dbus_string_get_const_data (service_name));
162 if (!_dbus_string_copy_data (service_name, &service->name))
164 _dbus_mem_pool_dealloc (registry->service_pool, service);
168 _dbus_verbose ("copied string %p '%s' to '%s'\n",
169 service_name, _dbus_string_get_const_data (service_name),
172 if (!bus_driver_send_service_owner_changed (service->name,
174 bus_connection_get_name (owner_if_created),
177 bus_service_unref (service);
181 if (!bus_activation_service_created (bus_context_get_activation (registry->context),
182 service->name, transaction, error))
184 bus_service_unref (service);
188 if (!bus_service_add_owner (service, owner_if_created,
191 bus_service_unref (service);
195 if (!_dbus_hash_table_insert_string (registry->service_hash,
199 /* The add_owner gets reverted on transaction cancel */
208 bus_registry_foreach (BusRegistry *registry,
209 BusServiceForeachFunction function,
214 _dbus_hash_iter_init (registry->service_hash, &iter);
215 while (_dbus_hash_iter_next (&iter))
217 BusService *service = _dbus_hash_iter_get_value (&iter);
219 (* function) (service, data);
224 bus_registry_list_services (BusRegistry *registry,
232 len = _dbus_hash_table_get_n_entries (registry->service_hash);
233 retval = dbus_new (char *, len + 1);
238 _dbus_hash_iter_init (registry->service_hash, &iter);
240 while (_dbus_hash_iter_next (&iter))
242 BusService *service = _dbus_hash_iter_get_value (&iter);
244 retval[i] = _dbus_strdup (service->name);
245 if (retval[i] == NULL)
260 for (j = 0; j < i; j++)
261 dbus_free (retval[i]);
268 bus_registry_acquire_service (BusRegistry *registry,
269 DBusConnection *connection,
270 const DBusString *service_name,
272 dbus_uint32_t *result,
273 BusTransaction *transaction,
277 DBusConnection *old_owner;
278 DBusConnection *current_owner;
279 BusClientPolicy *policy;
281 BusActivation *activation;
286 if (_dbus_string_get_length (service_name) == 0)
288 dbus_set_error (error, DBUS_ERROR_ACCESS_DENIED,
289 "Zero-length service name is not allowed");
291 _dbus_verbose ("Attempt to acquire zero-length service name\n");
296 if (_dbus_string_get_byte (service_name, 0) == ':')
298 /* Not allowed; only base services can start with ':' */
299 dbus_set_error (error, DBUS_ERROR_ACCESS_DENIED,
300 "Cannot acquire a service starting with ':' such as \"%s\"",
301 _dbus_string_get_const_data (service_name));
303 _dbus_verbose ("Attempt to acquire invalid base service name \"%s\"",
304 _dbus_string_get_const_data (service_name));
309 policy = bus_connection_get_policy (connection);
310 _dbus_assert (policy != NULL);
312 /* Note that if sid is #NULL then the bus's own context gets used
313 * in bus_connection_selinux_allows_acquire_service()
315 sid = bus_selinux_id_table_lookup (registry->service_sid_table,
318 if (!bus_selinux_allows_acquire_service (connection, sid,
319 _dbus_string_get_const_data (service_name)))
321 dbus_set_error (error, DBUS_ERROR_ACCESS_DENIED,
322 "Connection \"%s\" is not allowed to own the service \"%s\" due "
324 bus_connection_is_active (connection) ?
325 bus_connection_get_name (connection) :
327 _dbus_string_get_const_data (service_name));
331 if (!bus_client_policy_check_can_own (policy, connection,
334 dbus_set_error (error, DBUS_ERROR_ACCESS_DENIED,
335 "Connection \"%s\" is not allowed to own the service \"%s\" due "
336 "to security policies in the configuration file",
337 bus_connection_is_active (connection) ?
338 bus_connection_get_name (connection) :
340 _dbus_string_get_const_data (service_name));
344 if (bus_connection_get_n_services_owned (connection) >=
345 bus_context_get_max_services_per_connection (registry->context))
347 dbus_set_error (error, DBUS_ERROR_LIMITS_EXCEEDED,
348 "Connection \"%s\" is not allowed to own more services "
349 "(increase limits in configuration file if required)",
350 bus_connection_is_active (connection) ?
351 bus_connection_get_name (connection) :
356 service = bus_registry_lookup (registry, service_name);
359 old_owner = bus_service_get_primary_owner (service);
365 service = bus_registry_ensure (registry,
366 service_name, connection, transaction, error);
371 current_owner = bus_service_get_primary_owner (service);
373 if (old_owner == NULL)
375 _dbus_assert (current_owner == connection);
377 bus_service_set_prohibit_replacement (service,
378 (flags & DBUS_NAME_FLAG_PROHIBIT_REPLACEMENT));
380 *result = DBUS_REQUEST_NAME_REPLY_PRIMARY_OWNER;
382 else if (old_owner == connection)
383 *result = DBUS_REQUEST_NAME_REPLY_ALREADY_OWNER;
384 else if (!((flags & DBUS_NAME_FLAG_REPLACE_EXISTING)))
385 *result = DBUS_REQUEST_NAME_REPLY_EXISTS;
386 else if (bus_service_get_prohibit_replacement (service))
388 /* Queue the connection */
389 if (!bus_service_add_owner (service, connection,
393 *result = DBUS_REQUEST_NAME_REPLY_IN_QUEUE;
397 /* Replace the current owner */
399 /* We enqueue the new owner and remove the first one because
400 * that will cause NameAcquired and NameLost messages to
404 if (!bus_service_add_owner (service, connection,
408 if (!bus_service_remove_owner (service, old_owner,
412 _dbus_assert (connection == bus_service_get_primary_owner (service));
413 *result = DBUS_REQUEST_NAME_REPLY_PRIMARY_OWNER;
416 activation = bus_context_get_activation (registry->context);
417 retval = bus_activation_send_pending_auto_activation_messages (activation,
427 bus_registry_set_service_context_table (BusRegistry *registry,
428 DBusHashTable *table)
430 DBusHashTable *new_table;
433 new_table = bus_selinux_id_table_new ();
437 _dbus_hash_iter_init (table, &iter);
438 while (_dbus_hash_iter_next (&iter))
440 const char *service = _dbus_hash_iter_get_string_key (&iter);
441 const char *context = _dbus_hash_iter_get_value (&iter);
443 if (!bus_selinux_id_table_insert (new_table,
449 if (registry->service_sid_table)
450 _dbus_hash_table_unref (registry->service_sid_table);
451 registry->service_sid_table = new_table;
456 bus_service_unlink_owner (BusService *service,
457 DBusConnection *owner)
459 _dbus_list_remove_last (&service->owners, owner);
460 bus_connection_remove_owned_service (owner, service);
464 bus_service_unlink (BusService *service)
466 _dbus_assert (service->owners == NULL);
468 /* the service may not be in the hash, if
469 * the failure causing transaction cancel
470 * was in the right place, but that's OK
472 _dbus_hash_table_remove_string (service->registry->service_hash,
475 bus_service_unref (service);
479 bus_service_relink (BusService *service,
480 DBusPreallocatedHash *preallocated)
482 _dbus_assert (service->owners == NULL);
483 _dbus_assert (preallocated != NULL);
485 _dbus_hash_table_insert_string_preallocated (service->registry->service_hash,
490 bus_service_ref (service);
494 * Data used to represent an ownership cancellation in
499 DBusConnection *connection; /**< the connection */
500 BusService *service; /**< service to cancel ownership of */
501 } OwnershipCancelData;
504 cancel_ownership (void *data)
506 OwnershipCancelData *d = data;
508 /* We don't need to send messages notifying of these
509 * changes, since we're reverting something that was
510 * cancelled (effectively never really happened)
512 bus_service_unlink_owner (d->service, d->connection);
514 if (d->service->owners == NULL)
515 bus_service_unlink (d->service);
519 free_ownership_cancel_data (void *data)
521 OwnershipCancelData *d = data;
523 dbus_connection_unref (d->connection);
524 bus_service_unref (d->service);
530 add_cancel_ownership_to_transaction (BusTransaction *transaction,
532 DBusConnection *connection)
534 OwnershipCancelData *d;
536 d = dbus_new (OwnershipCancelData, 1);
540 d->service = service;
541 d->connection = connection;
543 if (!bus_transaction_add_cancel_hook (transaction, cancel_ownership, d,
544 free_ownership_cancel_data))
550 bus_service_ref (d->service);
551 dbus_connection_ref (d->connection);
556 /* this function is self-cancelling if you cancel the transaction */
558 bus_service_add_owner (BusService *service,
559 DBusConnection *owner,
560 BusTransaction *transaction,
563 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
565 /* Send service acquired message first, OOM will result
566 * in cancelling the transaction
568 if (service->owners == NULL)
570 if (!bus_driver_send_service_acquired (owner, service->name, transaction, error))
574 if (!_dbus_list_append (&service->owners,
581 if (!bus_connection_add_owned_service (owner, service))
583 _dbus_list_remove_last (&service->owners, owner);
588 if (!add_cancel_ownership_to_transaction (transaction,
592 bus_service_unlink_owner (service, owner);
602 DBusConnection *connection;
604 DBusConnection *before_connection; /* restore to position before this connection in owners list */
605 DBusList *connection_link;
606 DBusList *service_link;
607 DBusPreallocatedHash *hash_entry;
608 } OwnershipRestoreData;
611 restore_ownership (void *data)
613 OwnershipRestoreData *d = data;
616 _dbus_assert (d->service_link != NULL);
617 _dbus_assert (d->connection_link != NULL);
619 if (d->service->owners == NULL)
621 _dbus_assert (d->hash_entry != NULL);
622 bus_service_relink (d->service, d->hash_entry);
626 _dbus_assert (d->hash_entry == NULL);
629 /* We don't need to send messages notifying of these
630 * changes, since we're reverting something that was
631 * cancelled (effectively never really happened)
633 link = _dbus_list_get_first_link (&d->service->owners);
636 if (link->data == d->before_connection)
639 link = _dbus_list_get_next_link (&d->service->owners, link);
642 _dbus_list_insert_before_link (&d->service->owners, link, d->connection_link);
644 /* Note that removing then restoring this changes the order in which
645 * ServiceDeleted messages are sent on destruction of the
646 * connection. This should be OK as the only guarantee there is
647 * that the base service is destroyed last, and we never even
648 * tentatively remove the base service.
650 bus_connection_add_owned_service_link (d->connection, d->service_link);
652 d->hash_entry = NULL;
653 d->service_link = NULL;
654 d->connection_link = NULL;
658 free_ownership_restore_data (void *data)
660 OwnershipRestoreData *d = data;
663 _dbus_list_free_link (d->service_link);
664 if (d->connection_link)
665 _dbus_list_free_link (d->connection_link);
667 _dbus_hash_table_free_preallocated_entry (d->service->registry->service_hash,
670 dbus_connection_unref (d->connection);
671 bus_service_unref (d->service);
677 add_restore_ownership_to_transaction (BusTransaction *transaction,
679 DBusConnection *connection)
681 OwnershipRestoreData *d;
684 d = dbus_new (OwnershipRestoreData, 1);
688 d->service = service;
689 d->connection = connection;
690 d->service_link = _dbus_list_alloc_link (service);
691 d->connection_link = _dbus_list_alloc_link (connection);
692 d->hash_entry = _dbus_hash_table_preallocate_entry (service->registry->service_hash);
694 bus_service_ref (d->service);
695 dbus_connection_ref (d->connection);
697 d->before_connection = NULL;
698 link = _dbus_list_get_first_link (&service->owners);
701 if (link->data == connection)
703 link = _dbus_list_get_next_link (&service->owners, link);
706 d->before_connection = link->data;
711 link = _dbus_list_get_next_link (&service->owners, link);
714 if (d->service_link == NULL ||
715 d->connection_link == NULL ||
716 d->hash_entry == NULL ||
717 !bus_transaction_add_cancel_hook (transaction, restore_ownership, d,
718 free_ownership_restore_data))
720 free_ownership_restore_data (d);
727 /* this function is self-cancelling if you cancel the transaction */
729 bus_service_remove_owner (BusService *service,
730 DBusConnection *owner,
731 BusTransaction *transaction,
734 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
736 /* We send out notifications before we do any work we
737 * might have to undo if the notification-sending failed
740 /* Send service lost message */
741 if (bus_service_get_primary_owner (service) == owner)
743 if (!bus_driver_send_service_lost (owner, service->name,
748 if (service->owners == NULL)
750 _dbus_assert_not_reached ("Tried to remove owner of a service that has no owners");
752 else if (_dbus_list_length_is_one (&service->owners))
754 if (!bus_driver_send_service_owner_changed (service->name,
755 bus_connection_get_name (owner),
763 DBusConnection *new_owner;
764 link = _dbus_list_get_first_link (&service->owners);
765 _dbus_assert (link != NULL);
766 link = _dbus_list_get_next_link (&service->owners, link);
767 _dbus_assert (link != NULL);
769 new_owner = link->data;
771 if (!bus_driver_send_service_owner_changed (service->name,
772 bus_connection_get_name (owner),
773 bus_connection_get_name (new_owner),
777 /* This will be our new owner */
778 if (!bus_driver_send_service_acquired (new_owner,
785 if (!add_restore_ownership_to_transaction (transaction, service, owner))
791 bus_service_unlink_owner (service, owner);
793 if (service->owners == NULL)
794 bus_service_unlink (service);
800 bus_service_ref (BusService *service)
802 _dbus_assert (service->refcount > 0);
804 service->refcount += 1;
810 bus_service_unref (BusService *service)
812 _dbus_assert (service->refcount > 0);
814 service->refcount -= 1;
816 if (service->refcount == 0)
818 _dbus_assert (service->owners == NULL);
820 dbus_free (service->name);
821 _dbus_mem_pool_dealloc (service->registry->service_pool, service);
826 bus_service_get_primary_owner (BusService *service)
828 return _dbus_list_get_first (&service->owners);
832 bus_service_get_name (BusService *service)
834 return service->name;
838 bus_service_set_prohibit_replacement (BusService *service,
839 dbus_bool_t prohibit_replacement)
841 service->prohibit_replacement = prohibit_replacement != FALSE;
845 bus_service_get_prohibit_replacement (BusService *service)
847 return service->prohibit_replacement;
851 bus_service_has_owner (BusService *service,
852 DBusConnection *owner)
856 link = _dbus_list_get_first_link (&service->owners);
860 if (link->data == owner)
863 link = _dbus_list_get_next_link (&service->owners, link);