4 * The contents of this file are subject to the terms of the
5 * Common Development and Distribution License (the "License").
6 * You may not use this file except in compliance with the License.
8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9 * or http://www.opensolaris.org/os/licensing.
10 * See the License for the specific language governing permissions
11 * and limitations under the License.
13 * When distributing Covered Code, include this CDDL HEADER in each
14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15 * If applicable, add the following below this CDDL HEADER, with the
16 * fields enclosed by brackets "[]" replaced with your own identifying
17 * information: Portions Copyright [yyyy] [name of copyright owner]
23 * Copyright (c) 2004, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Copyright (c) 2013, Joyent, Inc. All rights reserved.
28 * restarter.c - service manipulation
30 * This component manages services whose restarter is svc.startd, the standard
31 * restarter. It translates restarter protocol events from the graph engine
32 * into actions on processes, as a delegated restarter would do.
34 * The master restarter manages a number of always-running threads:
35 * - restarter event thread: events from the graph engine
36 * - timeout thread: thread to fire queued timeouts
37 * - contract thread: thread to handle contract events
38 * - wait thread: thread to handle wait-based services
40 * The other threads are created as-needed:
41 * - per-instance method threads
42 * - per-instance event processing threads
44 * The interaction of all threads must result in the following conditions
45 * being satisfied (on a per-instance basis):
46 * - restarter events must be processed in order
47 * - method execution must be serialized
48 * - instance delete must be held until outstanding methods are complete
49 * - contract events shouldn't be processed while a method is running
50 * - timeouts should fire even when a method is running
52 * Service instances are represented by restarter_inst_t's and are kept in the
56 * The current state of a service instance is kept in
57 * restarter_inst_t->ri_i.i_state. If transition to a new state could take
58 * some time, then before we effect the transition we set
59 * restarter_inst_t->ri_i.i_next_state to the target state, and afterwards we
60 * rotate i_next_state to i_state and set i_next_state to
61 * RESTARTER_STATE_NONE. So usually i_next_state is _NONE when ri_lock is not
62 * held. The exception is when we launch methods, which are done with
63 * a separate thread. To keep any other threads from grabbing ri_lock before
64 * method_thread() does, we set ri_method_thread to the thread id of the
65 * method thread, and when it is nonzero any thread with a different thread id
66 * waits on ri_method_cv.
68 * Method execution is serialized by blocking on ri_method_cv in
69 * inst_lookup_by_id() and waiting for a 0 value of ri_method_thread. This
70 * also prevents the instance structure from being deleted until all
71 * outstanding operations such as method_thread() have finished.
75 * dgraph_lock [can be held when taking:]
77 * dictionary->dict_lock
80 * ru->restarter_update_lock
81 * restarter_queue->rpeq_lock
82 * instance_list.ril_lock
84 * st->st_configd_live_lock
86 * instance_list.ril_lock
87 * graph_queue->gpeq_lock
89 * st->st_configd_live_lock
90 * dictionary->dict_lock
92 * graph_queue->gpeq_lock
101 * single_user_thread_lock
107 * logbuf_mutex nests inside pretty much everything.
110 #include <sys/contract/process.h>
111 #include <sys/ctfs.h>
112 #include <sys/stat.h>
113 #include <sys/time.h>
114 #include <sys/types.h>
116 #include <sys/wait.h>
120 #include <libcontract.h>
121 #include <libcontract_priv.h>
123 #include <librestart.h>
124 #include <librestart_priv.h>
125 #include <libuutil.h>
136 #include "protocol.h"
138 static uu_list_pool_t
*restarter_instance_pool
;
139 static restarter_instance_list_t instance_list
;
141 static uu_list_pool_t
*restarter_queue_pool
;
143 #define WT_SVC_ERR_THROTTLE 1 /* 1 sec delay for erroring wait svc */
146 * Function used to reset the restart times for an instance, when
147 * an administrative task comes along and essentially makes the times
148 * in this array ineffective.
151 reset_start_times(restarter_inst_t
*inst
)
153 inst
->ri_start_index
= 0;
154 bzero(inst
->ri_start_time
, sizeof (inst
->ri_start_time
));
159 restarter_instance_compare(const void *lc_arg
, const void *rc_arg
,
162 int lc_id
= ((const restarter_inst_t
*)lc_arg
)->ri_id
;
163 int rc_id
= *(int *)rc_arg
;
172 static restarter_inst_t
*
173 inst_lookup_by_name(const char *name
)
177 id
= dict_lookup_byname(name
);
181 return (inst_lookup_by_id(id
));
185 inst_lookup_by_id(int id
)
187 restarter_inst_t
*inst
;
189 MUTEX_LOCK(&instance_list
.ril_lock
);
190 inst
= uu_list_find(instance_list
.ril_instance_list
, &id
, NULL
, NULL
);
192 MUTEX_LOCK(&inst
->ri_lock
);
193 MUTEX_UNLOCK(&instance_list
.ril_lock
);
196 while (inst
->ri_method_thread
!= 0 &&
197 !pthread_equal(inst
->ri_method_thread
, pthread_self())) {
198 ++inst
->ri_method_waiters
;
199 (void) pthread_cond_wait(&inst
->ri_method_cv
,
201 assert(inst
->ri_method_waiters
> 0);
202 --inst
->ri_method_waiters
;
209 static restarter_inst_t
*
210 inst_lookup_queue(const char *name
)
213 restarter_inst_t
*inst
;
215 id
= dict_lookup_byname(name
);
219 MUTEX_LOCK(&instance_list
.ril_lock
);
220 inst
= uu_list_find(instance_list
.ril_instance_list
, &id
, NULL
, NULL
);
222 MUTEX_LOCK(&inst
->ri_queue_lock
);
223 MUTEX_UNLOCK(&instance_list
.ril_lock
);
229 service_style(int flags
)
231 switch (flags
& RINST_STYLE_MASK
) {
232 case RINST_CONTRACT
: return ("contract");
233 case RINST_TRANSIENT
: return ("transient");
234 case RINST_WAIT
: return ("wait");
238 uu_warn("%s:%d: Bad flags 0x%x.\n", __FILE__
, __LINE__
, flags
);
246 * Fails with ECONNABORTED or ECANCELED.
249 check_contract(restarter_inst_t
*inst
, boolean_t primary
,
250 scf_instance_t
*scf_inst
)
255 ctidp
= primary
? &inst
->ri_i
.i_primary_ctid
:
256 &inst
->ri_i
.i_transient_ctid
;
260 fd
= contract_open(*ctidp
, NULL
, "status", O_RDONLY
);
267 r
= restarter_remove_contract(scf_inst
, *ctidp
, primary
?
268 RESTARTER_CONTRACT_PRIMARY
: RESTARTER_CONTRACT_TRANSIENT
);
277 uu_die("Out of memory\n");
281 uu_die("Insufficient privilege.\n");
285 uu_die("Repository backend access denied.\n");
289 log_error(LOG_INFO
, "Could not remove unusable contract id %ld "
290 "for %s from repository.\n", *ctidp
, inst
->ri_i
.i_fmri
);
302 static int stop_instance(scf_handle_t
*, restarter_inst_t
*, stop_cause_t
);
305 * int restarter_insert_inst(scf_handle_t *, char *)
306 * If the inst is already in the restarter list, return its id. If the inst
307 * is not in the restarter list, initialize a restarter_inst_t, initialize its
308 * states, insert it into the list, and return 0.
311 * ENOENT - name is not in the repository
314 restarter_insert_inst(scf_handle_t
*h
, const char *name
)
317 restarter_inst_t
*inst
;
319 scf_service_t
*scf_svc
;
320 scf_instance_t
*scf_inst
;
321 scf_snapshot_t
*snap
= NULL
;
322 scf_propertygroup_t
*pg
;
323 char *svc_name
, *inst_name
;
324 char logfilebuf
[PATH_MAX
];
326 boolean_t do_commit_states
;
327 restarter_instance_state_t state
, next_state
;
328 protocol_states_t
*ps
;
330 restarter_str_t reason
= restarter_str_insert_in_graph
;
332 MUTEX_LOCK(&instance_list
.ril_lock
);
335 * We don't use inst_lookup_by_name() here because we want the lookup
336 * & insert to be atomic.
338 id
= dict_lookup_byname(name
);
340 inst
= uu_list_find(instance_list
.ril_instance_list
, &id
, NULL
,
343 MUTEX_UNLOCK(&instance_list
.ril_lock
);
348 /* Allocate an instance */
349 inst
= startd_zalloc(sizeof (restarter_inst_t
));
350 inst
->ri_utmpx_prefix
= startd_alloc(max_scf_value_size
);
351 inst
->ri_utmpx_prefix
[0] = '\0';
353 inst
->ri_i
.i_fmri
= startd_alloc(strlen(name
) + 1);
354 (void) strcpy((char *)inst
->ri_i
.i_fmri
, name
);
356 inst
->ri_queue
= startd_list_create(restarter_queue_pool
, inst
, 0);
359 * id shouldn't be -1 since we use the same dictionary as graph.c, but
362 inst
->ri_id
= (id
!= -1 ? id
: dict_insert(name
));
364 special_online_hooks_get(name
, &inst
->ri_pre_online_hook
,
365 &inst
->ri_post_online_hook
, &inst
->ri_post_offline_hook
);
367 scf_svc
= safe_scf_service_create(h
);
368 scf_inst
= safe_scf_instance_create(h
);
369 pg
= safe_scf_pg_create(h
);
370 svc_name
= startd_alloc(max_scf_name_size
);
371 inst_name
= startd_alloc(max_scf_name_size
);
375 scf_snapshot_destroy(snap
);
376 if (inst
->ri_logstem
!= NULL
)
377 startd_free(inst
->ri_logstem
, PATH_MAX
);
378 if (inst
->ri_common_name
!= NULL
)
379 free(inst
->ri_common_name
);
380 if (inst
->ri_C_common_name
!= NULL
)
381 free(inst
->ri_C_common_name
);
383 inst
->ri_logstem
= NULL
;
384 inst
->ri_common_name
= NULL
;
385 inst
->ri_C_common_name
= NULL
;
387 if (scf_handle_decode_fmri(h
, name
, NULL
, scf_svc
, scf_inst
, NULL
,
388 NULL
, SCF_DECODE_FMRI_EXACT
) != 0) {
389 switch (scf_error()) {
390 case SCF_ERROR_CONNECTION_BROKEN
:
391 libscf_handle_rebind(h
);
394 case SCF_ERROR_NOT_FOUND
:
398 uu_die("Can't decode FMRI %s: %s\n", name
,
399 scf_strerror(scf_error()));
403 * If there's no running snapshot, then we execute using the editing
404 * snapshot. Pending snapshots will be taken later.
406 snap
= libscf_get_running_snapshot(scf_inst
);
408 if ((scf_service_get_name(scf_svc
, svc_name
, max_scf_name_size
) < 0) ||
409 (scf_instance_get_name(scf_inst
, inst_name
, max_scf_name_size
) <
411 switch (scf_error()) {
412 case SCF_ERROR_NOT_SET
:
415 case SCF_ERROR_CONNECTION_BROKEN
:
416 libscf_handle_rebind(h
);
427 (void) snprintf(logfilebuf
, PATH_MAX
, "%s:%s", svc_name
, inst_name
);
428 for (c
= logfilebuf
; *c
!= '\0'; c
++)
432 inst
->ri_logstem
= startd_alloc(PATH_MAX
);
433 (void) snprintf(inst
->ri_logstem
, PATH_MAX
, "%s%s", logfilebuf
,
437 * If the restarter group is missing, use uninit/none. Otherwise,
438 * we're probably being restarted & don't want to mess up the states
441 state
= RESTARTER_STATE_UNINIT
;
442 next_state
= RESTARTER_STATE_NONE
;
444 r
= scf_instance_get_pg(scf_inst
, SCF_PG_RESTARTER
, pg
);
446 switch (scf_error()) {
447 case SCF_ERROR_CONNECTION_BROKEN
:
448 libscf_handle_rebind(h
);
451 case SCF_ERROR_NOT_SET
:
454 case SCF_ERROR_NOT_FOUND
:
456 * This shouldn't happen since the graph engine should
457 * have initialized the state to uninitialized/none if
458 * there was no restarter pg. In case somebody
459 * deleted it, though....
461 do_commit_states
= B_TRUE
;
469 r
= libscf_read_states(pg
, &state
, &next_state
);
471 do_commit_states
= B_TRUE
;
473 if (next_state
!= RESTARTER_STATE_NONE
) {
475 * Force next_state to _NONE since we
476 * don't look for method processes.
478 next_state
= RESTARTER_STATE_NONE
;
479 do_commit_states
= B_TRUE
;
482 * The reason for transition will depend on
485 if (st
->st_initial
== 0)
486 reason
= restarter_str_startd_restart
;
487 else if (state
== RESTARTER_STATE_MAINT
)
488 reason
= restarter_str_bad_repo_state
;
490 * Inform the restarter of our state without
491 * changing the STIME in the repository.
493 ps
= startd_alloc(sizeof (*ps
));
494 inst
->ri_i
.i_state
= ps
->ps_state
= state
;
495 inst
->ri_i
.i_next_state
= ps
->ps_state_next
=
497 ps
->ps_reason
= reason
;
499 graph_protocol_send_event(inst
->ri_i
.i_fmri
,
500 GRAPH_UPDATE_STATE_CHANGE
, ps
);
502 do_commit_states
= B_FALSE
;
507 switch (libscf_get_startd_properties(scf_inst
, snap
, &inst
->ri_flags
,
508 &inst
->ri_utmpx_prefix
)) {
513 libscf_handle_rebind(h
);
521 * This is odd, because the graph engine should have required
522 * the general property group. So we'll just use default
523 * flags in anticipation of the graph engine sending us
524 * REMOVE_INSTANCE when it finds out that the general property
525 * group has been deleted.
527 inst
->ri_flags
= RINST_CONTRACT
;
535 r
= libscf_get_template_values(scf_inst
, snap
,
536 &inst
->ri_common_name
, &inst
->ri_C_common_name
);
539 * Copy our names to smaller buffers to reduce our memory footprint.
541 if (inst
->ri_common_name
!= NULL
) {
542 char *tmp
= safe_strdup(inst
->ri_common_name
);
543 startd_free(inst
->ri_common_name
, max_scf_value_size
);
544 inst
->ri_common_name
= tmp
;
547 if (inst
->ri_C_common_name
!= NULL
) {
548 char *tmp
= safe_strdup(inst
->ri_C_common_name
);
549 startd_free(inst
->ri_C_common_name
, max_scf_value_size
);
550 inst
->ri_C_common_name
= tmp
;
558 libscf_handle_rebind(h
);
573 switch (libscf_read_method_ids(h
, scf_inst
, inst
->ri_i
.i_fmri
,
574 &inst
->ri_i
.i_primary_ctid
, &inst
->ri_i
.i_transient_ctid
,
580 libscf_handle_rebind(h
);
591 if (inst
->ri_i
.i_primary_ctid
>= 1) {
592 contract_hash_store(inst
->ri_i
.i_primary_ctid
, inst
->ri_id
);
594 switch (check_contract(inst
, B_TRUE
, scf_inst
)) {
599 libscf_handle_rebind(h
);
611 if (inst
->ri_i
.i_transient_ctid
>= 1) {
612 switch (check_contract(inst
, B_FALSE
, scf_inst
)) {
617 libscf_handle_rebind(h
);
629 /* No more failures we live through, so add it to the list. */
630 (void) pthread_mutex_init(&inst
->ri_lock
, &mutex_attrs
);
631 (void) pthread_mutex_init(&inst
->ri_queue_lock
, &mutex_attrs
);
632 MUTEX_LOCK(&inst
->ri_lock
);
633 MUTEX_LOCK(&inst
->ri_queue_lock
);
635 (void) pthread_cond_init(&inst
->ri_method_cv
, NULL
);
637 uu_list_node_init(inst
, &inst
->ri_link
, restarter_instance_pool
);
638 uu_list_insert(instance_list
.ril_instance_list
, inst
, idx
);
639 MUTEX_UNLOCK(&instance_list
.ril_lock
);
641 if (start_pid
!= -1 &&
642 (inst
->ri_flags
& RINST_STYLE_MASK
) == RINST_WAIT
) {
644 ret
= wait_register(start_pid
, inst
->ri_i
.i_fmri
, 0, 1);
647 * Implication: if we can't reregister the
648 * instance, we will start another one. Two
649 * instances may or may not result in a resource
652 log_error(LOG_WARNING
,
653 "%s: couldn't reregister %ld for wait\n",
654 inst
->ri_i
.i_fmri
, start_pid
);
655 } else if (ret
== 1) {
657 * Leading PID has exited.
659 (void) stop_instance(h
, inst
, RSTOP_EXIT
);
666 if (do_commit_states
)
667 (void) restarter_instance_update_states(h
, inst
, state
,
668 next_state
, RERR_NONE
, reason
);
670 log_framework(LOG_DEBUG
, "%s is a %s-style service\n", name
,
671 service_style(inst
->ri_flags
));
673 MUTEX_UNLOCK(&inst
->ri_queue_lock
);
674 MUTEX_UNLOCK(&inst
->ri_lock
);
676 startd_free(svc_name
, max_scf_name_size
);
677 startd_free(inst_name
, max_scf_name_size
);
678 scf_snapshot_destroy(snap
);
679 scf_instance_destroy(scf_inst
);
680 scf_service_destroy(scf_svc
);
682 log_framework(LOG_DEBUG
, "%s: inserted instance into restarter list\n",
688 MUTEX_UNLOCK(&instance_list
.ril_lock
);
689 startd_free(inst_name
, max_scf_name_size
);
690 startd_free(svc_name
, max_scf_name_size
);
692 scf_snapshot_destroy(snap
);
694 scf_instance_destroy(scf_inst
);
695 scf_service_destroy(scf_svc
);
696 startd_free((void *)inst
->ri_i
.i_fmri
, strlen(inst
->ri_i
.i_fmri
) + 1);
697 uu_list_destroy(inst
->ri_queue
);
698 if (inst
->ri_logstem
!= NULL
)
699 startd_free(inst
->ri_logstem
, PATH_MAX
);
700 if (inst
->ri_common_name
!= NULL
)
701 free(inst
->ri_common_name
);
702 if (inst
->ri_C_common_name
!= NULL
)
703 free(inst
->ri_C_common_name
);
704 startd_free(inst
->ri_utmpx_prefix
, max_scf_value_size
);
705 startd_free(inst
, sizeof (restarter_inst_t
));
710 restarter_delete_inst(restarter_inst_t
*ri
)
713 restarter_inst_t
*rip
;
715 restarter_instance_qentry_t
*e
;
717 assert(MUTEX_HELD(&ri
->ri_lock
));
720 * Must drop the instance lock so we can pick up the instance_list
721 * lock & remove the instance.
724 MUTEX_UNLOCK(&ri
->ri_lock
);
726 MUTEX_LOCK(&instance_list
.ril_lock
);
728 rip
= uu_list_find(instance_list
.ril_instance_list
, &id
, NULL
, NULL
);
730 MUTEX_UNLOCK(&instance_list
.ril_lock
);
736 uu_list_remove(instance_list
.ril_instance_list
, ri
);
738 log_framework(LOG_DEBUG
, "%s: deleted instance from restarter list\n",
741 MUTEX_UNLOCK(&instance_list
.ril_lock
);
744 * We can lock the instance without holding the instance_list lock
745 * since we removed the instance from the list.
747 MUTEX_LOCK(&ri
->ri_lock
);
748 MUTEX_LOCK(&ri
->ri_queue_lock
);
750 if (ri
->ri_i
.i_primary_ctid
>= 1)
751 contract_hash_remove(ri
->ri_i
.i_primary_ctid
);
753 while (ri
->ri_method_thread
!= 0 || ri
->ri_method_waiters
> 0)
754 (void) pthread_cond_wait(&ri
->ri_method_cv
, &ri
->ri_lock
);
756 while ((e
= uu_list_teardown(ri
->ri_queue
, &cookie
)) != NULL
)
757 startd_free(e
, sizeof (*e
));
758 uu_list_destroy(ri
->ri_queue
);
760 startd_free((void *)ri
->ri_i
.i_fmri
, strlen(ri
->ri_i
.i_fmri
) + 1);
761 startd_free(ri
->ri_logstem
, PATH_MAX
);
762 if (ri
->ri_common_name
!= NULL
)
763 free(ri
->ri_common_name
);
764 if (ri
->ri_C_common_name
!= NULL
)
765 free(ri
->ri_C_common_name
);
766 startd_free(ri
->ri_utmpx_prefix
, max_scf_value_size
);
767 (void) pthread_mutex_destroy(&ri
->ri_lock
);
768 (void) pthread_mutex_destroy(&ri
->ri_queue_lock
);
769 startd_free(ri
, sizeof (restarter_inst_t
));
773 * instance_is_wait_style()
775 * Returns 1 if the given instance is a "wait-style" service instance.
778 instance_is_wait_style(restarter_inst_t
*inst
)
780 assert(MUTEX_HELD(&inst
->ri_lock
));
781 return ((inst
->ri_flags
& RINST_STYLE_MASK
) == RINST_WAIT
);
785 * instance_is_transient_style()
787 * Returns 1 if the given instance is a transient service instance.
790 instance_is_transient_style(restarter_inst_t
*inst
)
792 assert(MUTEX_HELD(&inst
->ri_lock
));
793 return ((inst
->ri_flags
& RINST_STYLE_MASK
) == RINST_TRANSIENT
);
797 * instance_in_transition()
798 * Returns 1 if instance is in transition, 0 if not
801 instance_in_transition(restarter_inst_t
*inst
)
803 assert(MUTEX_HELD(&inst
->ri_lock
));
804 if (inst
->ri_i
.i_next_state
== RESTARTER_STATE_NONE
)
810 * returns 1 if instance is already started, 0 if not
813 instance_started(restarter_inst_t
*inst
)
817 assert(MUTEX_HELD(&inst
->ri_lock
));
819 if (inst
->ri_i
.i_state
== RESTARTER_STATE_ONLINE
||
820 inst
->ri_i
.i_state
== RESTARTER_STATE_DEGRADED
)
831 * ECONNRESET - success, but h was rebound
834 restarter_instance_update_states(scf_handle_t
*h
, restarter_inst_t
*ri
,
835 restarter_instance_state_t new_state
,
836 restarter_instance_state_t new_state_next
, restarter_error_t err
,
837 restarter_str_t reason
)
839 protocol_states_t
*states
;
841 uint_t retry_count
= 0, msecs
= ALLOC_DELAY
;
842 boolean_t rebound
= B_FALSE
;
843 int prev_state_online
;
846 assert(MUTEX_HELD(&ri
->ri_lock
));
848 prev_state_online
= instance_started(ri
);
851 e
= _restarter_commit_states(h
, &ri
->ri_i
, new_state
, new_state_next
,
852 restarter_get_str_short(reason
));
859 if (retry_count
< ALLOC_RETRY
) {
860 (void) poll(NULL
, 0, msecs
);
861 msecs
*= ALLOC_DELAY_MULT
;
865 /* Like startd_alloc(). */
866 uu_die("Insufficient memory.\n");
870 libscf_handle_rebind(h
);
877 log_error(LOG_NOTICE
, "Could not commit state change for %s "
878 "to repository: %s.\n", ri
->ri_i
.i_fmri
, strerror(e
));
882 ri
->ri_i
.i_state
= new_state
;
883 ri
->ri_i
.i_next_state
= new_state_next
;
888 bad_error("_restarter_commit_states", e
);
891 states
= startd_alloc(sizeof (protocol_states_t
));
892 states
->ps_state
= new_state
;
893 states
->ps_state_next
= new_state_next
;
894 states
->ps_err
= err
;
895 states
->ps_reason
= reason
;
896 graph_protocol_send_event(ri
->ri_i
.i_fmri
, GRAPH_UPDATE_STATE_CHANGE
,
899 state_online
= instance_started(ri
);
901 if (prev_state_online
&& !state_online
)
902 ri
->ri_post_offline_hook();
903 else if (!prev_state_online
&& state_online
)
904 ri
->ri_post_online_hook();
906 return (rebound
? ECONNRESET
: 0);
910 restarter_mark_pending_snapshot(const char *fmri
, uint_t flag
)
912 restarter_inst_t
*inst
;
914 assert(flag
== RINST_RETAKE_RUNNING
|| flag
== RINST_RETAKE_START
);
916 inst
= inst_lookup_by_name(fmri
);
920 inst
->ri_flags
|= flag
;
922 MUTEX_UNLOCK(&inst
->ri_lock
);
926 restarter_take_pending_snapshots(scf_handle_t
*h
)
928 restarter_inst_t
*inst
;
931 MUTEX_LOCK(&instance_list
.ril_lock
);
933 for (inst
= uu_list_first(instance_list
.ril_instance_list
);
935 inst
= uu_list_next(instance_list
.ril_instance_list
, inst
)) {
937 scf_instance_t
*sinst
= NULL
;
939 MUTEX_LOCK(&inst
->ri_lock
);
942 * This is where we'd check inst->ri_method_thread and if it
943 * were nonzero we'd wait in anticipation of another thread
944 * executing a method for inst. Doing so with the instance_list
945 * locked, though, leads to deadlock. Since taking a snapshot
946 * during that window won't hurt anything, we'll just continue.
949 fmri
= inst
->ri_i
.i_fmri
;
951 if (inst
->ri_flags
& RINST_RETAKE_RUNNING
) {
952 scf_snapshot_t
*rsnap
;
954 (void) libscf_fmri_get_instance(h
, fmri
, &sinst
);
956 rsnap
= libscf_get_or_make_running_snapshot(sinst
,
959 scf_instance_destroy(sinst
);
962 inst
->ri_flags
&= ~RINST_RETAKE_RUNNING
;
964 scf_snapshot_destroy(rsnap
);
967 if (inst
->ri_flags
& RINST_RETAKE_START
) {
968 switch (r
= libscf_snapshots_poststart(h
, fmri
,
972 inst
->ri_flags
&= ~RINST_RETAKE_START
;
980 bad_error("libscf_snapshots_poststart", r
);
984 MUTEX_UNLOCK(&inst
->ri_lock
);
987 MUTEX_UNLOCK(&instance_list
.ril_lock
);
992 restarter_post_fsminimal_thread(void *unused
)
997 h
= libscf_handle_create_bound_loop();
1000 r
= libscf_create_self(h
);
1004 assert(r
== ECONNABORTED
);
1005 libscf_handle_rebind(h
);
1008 restarter_take_pending_snapshots(h
);
1010 (void) scf_handle_unbind(h
);
1011 scf_handle_destroy(h
);
1017 * int stop_instance()
1019 * Stop the instance identified by the instance given as the second argument,
1020 * for the cause stated.
1024 * -1 - inst is in transition
1027 stop_instance(scf_handle_t
*local_handle
, restarter_inst_t
*inst
,
1033 restarter_error_t re
;
1034 restarter_str_t reason
;
1035 restarter_instance_state_t new_state
;
1037 assert(MUTEX_HELD(&inst
->ri_lock
));
1038 assert(inst
->ri_method_thread
== 0);
1043 reason
= restarter_str_ct_ev_exit
;
1044 cp
= "all processes in service exited";
1048 reason
= restarter_str_method_failed
;
1049 cp
= "service exited with a configuration error";
1051 case RSTOP_ERR_EXIT
:
1053 reason
= restarter_str_ct_ev_exit
;
1054 cp
= "service exited with an error";
1058 reason
= restarter_str_ct_ev_core
;
1059 cp
= "process dumped core";
1063 reason
= restarter_str_ct_ev_signal
;
1064 cp
= "process received fatal signal from outside the service";
1068 reason
= restarter_str_ct_ev_hwerr
;
1069 cp
= "process killed due to uncorrectable hardware error";
1071 case RSTOP_DEPENDENCY
:
1073 reason
= restarter_str_dependency_activity
;
1074 cp
= "dependency activity requires stop";
1078 reason
= restarter_str_disable_request
;
1079 cp
= "service disabled";
1083 reason
= restarter_str_restart_request
;
1084 cp
= "service restarting";
1088 (void) fprintf(stderr
, "Unknown cause %d at %s:%d.\n",
1089 cause
, __FILE__
, __LINE__
);
1094 /* Services in the disabled and maintenance state are ignored */
1095 if (inst
->ri_i
.i_state
== RESTARTER_STATE_MAINT
||
1096 inst
->ri_i
.i_state
== RESTARTER_STATE_DISABLED
) {
1097 log_framework(LOG_DEBUG
,
1098 "%s: stop_instance -> is maint/disabled\n",
1103 /* Already stopped instances are left alone */
1104 if (instance_started(inst
) == 0) {
1105 log_framework(LOG_DEBUG
, "Restarter: %s is already stopped.\n",
1110 if (instance_in_transition(inst
)) {
1111 /* requeue event by returning -1 */
1112 log_framework(LOG_DEBUG
,
1113 "Restarter: Not stopping %s, in transition.\n",
1118 log_instance(inst
, B_TRUE
, "Stopping because %s.", cp
);
1120 log_framework(re
== RERR_FAULT
? LOG_INFO
: LOG_DEBUG
,
1121 "%s: Instance stopping because %s.\n", inst
->ri_i
.i_fmri
, cp
);
1123 if (instance_is_wait_style(inst
) &&
1124 (cause
== RSTOP_EXIT
||
1125 cause
== RSTOP_ERR_CFG
||
1126 cause
== RSTOP_ERR_EXIT
)) {
1128 * No need to stop instance, as child has exited; remove
1129 * contract and move the instance to the offline state.
1131 switch (err
= restarter_instance_update_states(local_handle
,
1132 inst
, inst
->ri_i
.i_state
, RESTARTER_STATE_OFFLINE
, re
,
1139 bad_error("restarter_instance_update_states", err
);
1142 if (cause
== RSTOP_ERR_EXIT
) {
1144 * The RSTOP_ERR_EXIT cause is set via the
1145 * wait_thread -> wait_remove code path when we have
1146 * a "wait" style svc that exited with an error. If
1147 * the svc is failing too quickly, we throttle it so
1148 * that we don't restart it more than once/second.
1149 * Since we know we're running in the wait thread its
1150 * ok to throttle it right here.
1152 (void) update_fault_count(inst
, FAULT_COUNT_INCR
);
1153 if (method_rate_critical(inst
)) {
1154 log_instance(inst
, B_TRUE
, "Failing too "
1155 "quickly, throttling.");
1156 (void) sleep(WT_SVC_ERR_THROTTLE
);
1159 (void) update_fault_count(inst
, FAULT_COUNT_RESET
);
1160 reset_start_times(inst
);
1163 if (inst
->ri_i
.i_primary_ctid
!= 0) {
1165 safe_scf_instance_create(local_handle
);
1166 inst
->ri_mi_deleted
= B_FALSE
;
1168 libscf_reget_instance(inst
);
1169 method_remove_contract(inst
, B_TRUE
, B_TRUE
);
1171 scf_instance_destroy(inst
->ri_m_inst
);
1172 inst
->ri_m_inst
= NULL
;
1175 switch (err
= restarter_instance_update_states(local_handle
,
1176 inst
, inst
->ri_i
.i_next_state
, RESTARTER_STATE_NONE
, re
,
1183 bad_error("restarter_instance_update_states", err
);
1186 if (cause
!= RSTOP_ERR_CFG
)
1188 } else if (instance_is_wait_style(inst
) && re
== RERR_RESTART
) {
1190 * Stopping a wait service through means other than the pid
1191 * exiting should keep wait_thread() from restarting the
1192 * service, by removing it from the wait list.
1193 * We cannot remove it right now otherwise the process will
1194 * end up <defunct> so mark it to be ignored.
1196 wait_ignore_by_fmri(inst
->ri_i
.i_fmri
);
1200 * There are some configuration errors which we cannot detect until we
1201 * try to run the method. For example, see exec_method() where the
1202 * restarter_set_method_context() call can return SMF_EXIT_ERR_CONFIG
1203 * in several cases. If this happens for a "wait-style" svc,
1204 * wait_remove() sets the cause as RSTOP_ERR_CFG so that we can detect
1205 * the configuration error and go into maintenance, even though it is
1206 * a "wait-style" svc.
1208 if (cause
== RSTOP_ERR_CFG
)
1209 new_state
= RESTARTER_STATE_MAINT
;
1211 new_state
= inst
->ri_i
.i_enabled
?
1212 RESTARTER_STATE_OFFLINE
: RESTARTER_STATE_DISABLED
;
1214 switch (err
= restarter_instance_update_states(local_handle
, inst
,
1215 inst
->ri_i
.i_state
, new_state
, RERR_NONE
, reason
)) {
1221 bad_error("restarter_instance_update_states", err
);
1224 info
= startd_zalloc(sizeof (fork_info_t
));
1226 info
->sf_id
= inst
->ri_id
;
1227 info
->sf_method_type
= METHOD_STOP
;
1228 info
->sf_event_type
= re
;
1229 info
->sf_reason
= reason
;
1230 inst
->ri_method_thread
= startd_thread_create(method_thread
, info
);
1237 * ENOENT - fmri is not in instance_list
1239 * ECONNRESET - success, though handle was rebound
1240 * -1 - instance is in transition
1243 stop_instance_fmri(scf_handle_t
*h
, const char *fmri
, uint_t flags
)
1245 restarter_inst_t
*rip
;
1248 rip
= inst_lookup_by_name(fmri
);
1252 r
= stop_instance(h
, rip
, flags
);
1254 MUTEX_UNLOCK(&rip
->ri_lock
);
1260 unmaintain_instance(scf_handle_t
*h
, restarter_inst_t
*rip
,
1261 unmaint_cause_t cause
)
1264 scf_instance_t
*inst
;
1266 uint_t tries
= 0, msecs
= ALLOC_DELAY
;
1268 restarter_str_t reason
;
1270 assert(MUTEX_HELD(&rip
->ri_lock
));
1272 if (rip
->ri_i
.i_state
!= RESTARTER_STATE_MAINT
) {
1273 log_error(LOG_DEBUG
, "Restarter: "
1274 "Ignoring maintenance off command because %s is not in the "
1275 "maintenance state.\n", rip
->ri_i
.i_fmri
);
1280 case RUNMAINT_CLEAR
:
1281 cp
= "clear requested";
1282 reason
= restarter_str_clear_request
;
1284 case RUNMAINT_DISABLE
:
1285 cp
= "disable requested";
1286 reason
= restarter_str_disable_request
;
1290 (void) fprintf(stderr
, "Uncaught case for %d at %s:%d.\n",
1291 cause
, __FILE__
, __LINE__
);
1296 log_instance(rip
, B_TRUE
, "Leaving maintenance because %s.",
1298 log_framework(LOG_DEBUG
, "%s: Instance leaving maintenance because "
1299 "%s.\n", rip
->ri_i
.i_fmri
, cp
);
1301 (void) restarter_instance_update_states(h
, rip
, RESTARTER_STATE_UNINIT
,
1302 RESTARTER_STATE_NONE
, RERR_RESTART
, reason
);
1305 * If we did ADMIN_MAINT_ON_IMMEDIATE, then there might still be
1306 * a primary contract.
1308 if (rip
->ri_i
.i_primary_ctid
== 0)
1311 ctid
= rip
->ri_i
.i_primary_ctid
;
1312 contract_abandon(ctid
);
1313 rip
->ri_i
.i_primary_ctid
= 0;
1316 switch (r
= libscf_fmri_get_instance(h
, rip
->ri_i
.i_fmri
, &inst
)) {
1321 libscf_handle_rebind(h
);
1325 /* Must have been deleted. */
1331 bad_error("libscf_handle_rebind", r
);
1335 r
= restarter_remove_contract(inst
, ctid
, RESTARTER_CONTRACT_PRIMARY
);
1342 if (tries
< ALLOC_RETRY
) {
1343 (void) poll(NULL
, 0, msecs
);
1344 msecs
*= ALLOC_DELAY_MULT
;
1348 uu_die("Insufficient memory.\n");
1352 scf_instance_destroy(inst
);
1353 libscf_handle_rebind(h
);
1363 "Could not remove contract id %lu for %s (%s).\n", ctid
,
1364 rip
->ri_i
.i_fmri
, strerror(r
));
1370 bad_error("restarter_remove_contract", r
);
1373 scf_instance_destroy(inst
);
1378 * Set inst->ri_i.i_enabled. Expects 'e' to be _ENABLE, _DISABLE, or
1379 * _ADMIN_DISABLE. If the event is _ENABLE and inst is uninitialized or
1380 * disabled, move it to offline. If the event is _DISABLE or
1381 * _ADMIN_DISABLE, make sure inst will move to disabled.
1385 * ECONNRESET - h was rebound
1388 enable_inst(scf_handle_t
*h
, restarter_inst_t
*inst
,
1389 restarter_instance_qentry_t
*riq
)
1391 restarter_instance_state_t state
;
1392 restarter_event_type_t e
= riq
->riq_type
;
1393 restarter_str_t reason
= restarter_str_per_configuration
;
1396 assert(MUTEX_HELD(&inst
->ri_lock
));
1397 assert(e
== RESTARTER_EVENT_TYPE_ADMIN_DISABLE
||
1398 e
== RESTARTER_EVENT_TYPE_DISABLE
||
1399 e
== RESTARTER_EVENT_TYPE_ENABLE
);
1400 assert(instance_in_transition(inst
) == 0);
1402 state
= inst
->ri_i
.i_state
;
1404 if (e
== RESTARTER_EVENT_TYPE_ENABLE
) {
1405 inst
->ri_i
.i_enabled
= 1;
1407 if (state
== RESTARTER_STATE_UNINIT
||
1408 state
== RESTARTER_STATE_DISABLED
) {
1410 * B_FALSE: Don't log an error if the log_instance()
1411 * fails because it will fail on the miniroot before
1412 * install-discovery runs.
1414 log_instance(inst
, B_FALSE
, "Enabled.");
1415 log_framework(LOG_DEBUG
, "%s: Instance enabled.\n",
1419 * If we are coming from DISABLED, it was obviously an
1420 * enable request. If we are coming from UNINIT, it may
1421 * have been a sevice in MAINT that was cleared.
1423 if (riq
->riq_reason
== restarter_str_clear_request
)
1424 reason
= restarter_str_clear_request
;
1425 else if (state
== RESTARTER_STATE_DISABLED
)
1426 reason
= restarter_str_enable_request
;
1427 (void) restarter_instance_update_states(h
, inst
,
1428 RESTARTER_STATE_OFFLINE
, RESTARTER_STATE_NONE
,
1431 log_framework(LOG_DEBUG
, "Restarter: "
1432 "Not changing state of %s for enable command.\n",
1436 inst
->ri_i
.i_enabled
= 0;
1439 case RESTARTER_STATE_ONLINE
:
1440 case RESTARTER_STATE_DEGRADED
:
1441 r
= stop_instance(h
, inst
, RSTOP_DISABLE
);
1442 return (r
== ECONNRESET
? 0 : r
);
1444 case RESTARTER_STATE_OFFLINE
:
1445 case RESTARTER_STATE_UNINIT
:
1446 if (inst
->ri_i
.i_primary_ctid
!= 0) {
1447 inst
->ri_m_inst
= safe_scf_instance_create(h
);
1448 inst
->ri_mi_deleted
= B_FALSE
;
1450 libscf_reget_instance(inst
);
1451 method_remove_contract(inst
, B_TRUE
, B_TRUE
);
1453 scf_instance_destroy(inst
->ri_m_inst
);
1455 /* B_FALSE: See log_instance(..., "Enabled."); above */
1456 log_instance(inst
, B_FALSE
, "Disabled.");
1457 log_framework(LOG_DEBUG
, "%s: Instance disabled.\n",
1461 * If we are coming from OFFLINE, it was obviously a
1462 * disable request. But if we are coming from
1463 * UNINIT, it may have been a disable request for a
1466 if (riq
->riq_reason
== restarter_str_disable_request
||
1467 state
== RESTARTER_STATE_OFFLINE
)
1468 reason
= restarter_str_disable_request
;
1469 (void) restarter_instance_update_states(h
, inst
,
1470 RESTARTER_STATE_DISABLED
, RESTARTER_STATE_NONE
,
1471 RERR_RESTART
, reason
);
1474 case RESTARTER_STATE_DISABLED
:
1477 case RESTARTER_STATE_MAINT
:
1479 * We only want to pull the instance out of maintenance
1480 * if the disable is on adminstrative request. The
1481 * graph engine sends _DISABLE events whenever a
1482 * service isn't in the disabled state, and we don't
1483 * want to pull the service out of maintenance if,
1484 * for example, it is there due to a dependency cycle.
1486 if (e
== RESTARTER_EVENT_TYPE_ADMIN_DISABLE
)
1487 unmaintain_instance(h
, inst
, RUNMAINT_DISABLE
);
1492 (void) fprintf(stderr
, "Restarter instance %s has "
1493 "unknown state %d.\n", inst
->ri_i
.i_fmri
, state
);
1503 start_instance(scf_handle_t
*local_handle
, restarter_inst_t
*inst
,
1507 restarter_str_t new_reason
;
1509 assert(MUTEX_HELD(&inst
->ri_lock
));
1510 assert(instance_in_transition(inst
) == 0);
1511 assert(inst
->ri_method_thread
== 0);
1513 log_framework(LOG_DEBUG
, "%s: trying to start instance\n",
1517 * We want to keep the original reason for restarts and clear actions
1520 case restarter_str_restart_request
:
1521 case restarter_str_clear_request
:
1522 new_reason
= reason
;
1525 new_reason
= restarter_str_dependencies_satisfied
;
1528 /* Services in the disabled and maintenance state are ignored */
1529 if (inst
->ri_i
.i_state
== RESTARTER_STATE_MAINT
||
1530 inst
->ri_i
.i_state
== RESTARTER_STATE_DISABLED
||
1531 inst
->ri_i
.i_enabled
== 0) {
1532 log_framework(LOG_DEBUG
,
1533 "%s: start_instance -> is maint/disabled\n",
1538 /* Already started instances are left alone */
1539 if (instance_started(inst
) == 1) {
1540 log_framework(LOG_DEBUG
,
1541 "%s: start_instance -> is already started\n",
1546 log_framework(LOG_DEBUG
, "%s: starting instance.\n", inst
->ri_i
.i_fmri
);
1548 (void) restarter_instance_update_states(local_handle
, inst
,
1549 inst
->ri_i
.i_state
, RESTARTER_STATE_ONLINE
, RERR_NONE
, new_reason
);
1551 info
= startd_zalloc(sizeof (fork_info_t
));
1553 info
->sf_id
= inst
->ri_id
;
1554 info
->sf_method_type
= METHOD_START
;
1555 info
->sf_event_type
= RERR_NONE
;
1556 info
->sf_reason
= new_reason
;
1557 inst
->ri_method_thread
= startd_thread_create(method_thread
, info
);
1561 event_from_tty(scf_handle_t
*h
, restarter_inst_t
*rip
)
1563 scf_instance_t
*inst
;
1566 if (libscf_fmri_get_instance(h
, rip
->ri_i
.i_fmri
, &inst
))
1569 ret
= restarter_inst_ractions_from_tty(inst
);
1571 scf_instance_destroy(inst
);
1576 restart_dump(scf_handle_t
*h
, restarter_inst_t
*rip
)
1578 scf_instance_t
*inst
;
1579 boolean_t ret
= B_FALSE
;
1581 if (libscf_fmri_get_instance(h
, rip
->ri_i
.i_fmri
, &inst
))
1584 if (restarter_inst_dump(inst
) == 1)
1587 scf_instance_destroy(inst
);
1592 maintain_instance(scf_handle_t
*h
, restarter_inst_t
*rip
, int immediate
,
1593 restarter_str_t reason
)
1596 scf_instance_t
*scf_inst
= NULL
;
1598 assert(MUTEX_HELD(&rip
->ri_lock
));
1599 assert(reason
!= restarter_str_none
);
1600 assert(rip
->ri_method_thread
== 0);
1602 log_instance(rip
, B_TRUE
, "Stopping for maintenance due to %s.",
1603 restarter_get_str_short(reason
));
1604 log_framework(LOG_DEBUG
, "%s: stopping for maintenance due to %s.\n",
1605 rip
->ri_i
.i_fmri
, restarter_get_str_short(reason
));
1607 /* Services in the maintenance state are ignored */
1608 if (rip
->ri_i
.i_state
== RESTARTER_STATE_MAINT
) {
1609 log_framework(LOG_DEBUG
,
1610 "%s: maintain_instance -> is already in maintenance\n",
1616 * If reason state is restarter_str_service_request and
1617 * restarter_actions/auxiliary_fmri property is set with a valid fmri,
1618 * copy the fmri to restarter/auxiliary_fmri so svcs -x can use.
1620 if (reason
== restarter_str_service_request
&&
1621 libscf_fmri_get_instance(h
, rip
->ri_i
.i_fmri
, &scf_inst
) == 0) {
1622 if (restarter_inst_validate_ractions_aux_fmri(scf_inst
) == 0) {
1623 if (restarter_inst_set_aux_fmri(scf_inst
))
1624 log_framework(LOG_DEBUG
, "%s: "
1625 "restarter_inst_set_aux_fmri failed: ",
1628 log_framework(LOG_DEBUG
, "%s: "
1629 "restarter_inst_validate_ractions_aux_fmri "
1630 "failed: ", rip
->ri_i
.i_fmri
);
1632 if (restarter_inst_reset_aux_fmri(scf_inst
))
1633 log_framework(LOG_DEBUG
, "%s: "
1634 "restarter_inst_reset_aux_fmri failed: ",
1637 scf_instance_destroy(scf_inst
);
1640 if (immediate
|| !instance_started(rip
)) {
1641 if (rip
->ri_i
.i_primary_ctid
!= 0) {
1642 rip
->ri_m_inst
= safe_scf_instance_create(h
);
1643 rip
->ri_mi_deleted
= B_FALSE
;
1645 libscf_reget_instance(rip
);
1646 method_remove_contract(rip
, B_TRUE
, B_TRUE
);
1648 scf_instance_destroy(rip
->ri_m_inst
);
1651 (void) restarter_instance_update_states(h
, rip
,
1652 RESTARTER_STATE_MAINT
, RESTARTER_STATE_NONE
, RERR_RESTART
,
1657 (void) restarter_instance_update_states(h
, rip
, rip
->ri_i
.i_state
,
1658 RESTARTER_STATE_MAINT
, RERR_NONE
, reason
);
1660 log_transition(rip
, MAINT_REQUESTED
);
1662 info
= startd_zalloc(sizeof (*info
));
1663 info
->sf_id
= rip
->ri_id
;
1664 info
->sf_method_type
= METHOD_STOP
;
1665 info
->sf_event_type
= RERR_RESTART
;
1666 info
->sf_reason
= reason
;
1667 rip
->ri_method_thread
= startd_thread_create(method_thread
, info
);
1671 refresh_instance(scf_handle_t
*h
, restarter_inst_t
*rip
)
1673 scf_instance_t
*inst
;
1674 scf_snapshot_t
*snap
;
1678 assert(MUTEX_HELD(&rip
->ri_lock
));
1680 log_instance(rip
, B_TRUE
, "Rereading configuration.");
1681 log_framework(LOG_DEBUG
, "%s: rereading configuration.\n",
1685 r
= libscf_fmri_get_instance(h
, rip
->ri_i
.i_fmri
, &inst
);
1691 libscf_handle_rebind(h
);
1695 /* Must have been deleted. */
1701 bad_error("libscf_fmri_get_instance", r
);
1704 snap
= libscf_get_running_snapshot(inst
);
1706 r
= libscf_get_startd_properties(inst
, snap
, &rip
->ri_flags
,
1707 &rip
->ri_utmpx_prefix
);
1710 log_framework(LOG_DEBUG
, "%s is a %s-style service\n",
1711 rip
->ri_i
.i_fmri
, service_style(rip
->ri_flags
));
1715 scf_instance_destroy(inst
);
1716 scf_snapshot_destroy(snap
);
1717 libscf_handle_rebind(h
);
1722 /* Succeed in anticipation of REMOVE_INSTANCE. */
1726 bad_error("libscf_get_startd_properties", r
);
1729 if (instance_started(rip
)) {
1730 /* Refresh does not change the state. */
1731 (void) restarter_instance_update_states(h
, rip
,
1732 rip
->ri_i
.i_state
, rip
->ri_i
.i_state
, RERR_NONE
,
1733 restarter_str_refresh
);
1735 info
= startd_zalloc(sizeof (*info
));
1736 info
->sf_id
= rip
->ri_id
;
1737 info
->sf_method_type
= METHOD_REFRESH
;
1738 info
->sf_event_type
= RERR_REFRESH
;
1739 info
->sf_reason
= NULL
;
1741 assert(rip
->ri_method_thread
== 0);
1742 rip
->ri_method_thread
=
1743 startd_thread_create(method_thread
, info
);
1746 scf_snapshot_destroy(snap
);
1747 scf_instance_destroy(inst
);
1750 const char *event_names
[] = { "INVALID", "ADD_INSTANCE", "REMOVE_INSTANCE",
1751 "ENABLE", "DISABLE", "ADMIN_DEGRADED", "ADMIN_REFRESH",
1752 "ADMIN_RESTART", "ADMIN_MAINT_OFF", "ADMIN_MAINT_ON",
1753 "ADMIN_MAINT_ON_IMMEDIATE", "STOP", "START", "DEPENDENCY_CYCLE",
1754 "INVALID_DEPENDENCY", "ADMIN_DISABLE", "STOP_RESET"
1758 * void *restarter_process_events()
1760 * Called in a separate thread to process the events on an instance's
1761 * queue. Empties the queue completely, and tries to keep the thread
1762 * around for a little while after the queue is empty to save on
1766 restarter_process_events(void *arg
)
1769 restarter_instance_qentry_t
*event
;
1770 restarter_inst_t
*rip
;
1771 char *fmri
= (char *)arg
;
1774 assert(fmri
!= NULL
);
1776 h
= libscf_handle_create_bound_loop();
1778 /* grab the queue lock */
1779 rip
= inst_lookup_queue(fmri
);
1785 while ((event
= uu_list_first(rip
->ri_queue
)) != NULL
) {
1786 restarter_inst_t
*inst
;
1788 /* drop the queue lock */
1789 MUTEX_UNLOCK(&rip
->ri_queue_lock
);
1792 * Grab the inst lock -- this waits until any outstanding
1793 * method finishes running.
1795 inst
= inst_lookup_by_name(fmri
);
1797 /* Getting deleted in the middle isn't an error. */
1801 assert(instance_in_transition(inst
) == 0);
1803 /* process the event */
1804 switch (event
->riq_type
) {
1805 case RESTARTER_EVENT_TYPE_ENABLE
:
1806 case RESTARTER_EVENT_TYPE_DISABLE
:
1807 (void) enable_inst(h
, inst
, event
);
1810 case RESTARTER_EVENT_TYPE_ADMIN_DISABLE
:
1811 if (enable_inst(h
, inst
, event
) == 0)
1812 reset_start_times(inst
);
1815 case RESTARTER_EVENT_TYPE_REMOVE_INSTANCE
:
1816 restarter_delete_inst(inst
);
1820 case RESTARTER_EVENT_TYPE_STOP_RESET
:
1821 reset_start_times(inst
);
1823 case RESTARTER_EVENT_TYPE_STOP
:
1824 (void) stop_instance(h
, inst
, RSTOP_DEPENDENCY
);
1827 case RESTARTER_EVENT_TYPE_START
:
1828 start_instance(h
, inst
, event
->riq_reason
);
1831 case RESTARTER_EVENT_TYPE_DEPENDENCY_CYCLE
:
1832 maintain_instance(h
, inst
, 0,
1833 restarter_str_dependency_cycle
);
1836 case RESTARTER_EVENT_TYPE_INVALID_DEPENDENCY
:
1837 maintain_instance(h
, inst
, 0,
1838 restarter_str_invalid_dependency
);
1841 case RESTARTER_EVENT_TYPE_ADMIN_MAINT_ON
:
1842 if (event_from_tty(h
, inst
) == 0)
1843 maintain_instance(h
, inst
, 0,
1844 restarter_str_service_request
);
1846 maintain_instance(h
, inst
, 0,
1847 restarter_str_administrative_request
);
1850 case RESTARTER_EVENT_TYPE_ADMIN_MAINT_ON_IMMEDIATE
:
1851 if (event_from_tty(h
, inst
) == 0)
1852 maintain_instance(h
, inst
, 1,
1853 restarter_str_service_request
);
1855 maintain_instance(h
, inst
, 1,
1856 restarter_str_administrative_request
);
1859 case RESTARTER_EVENT_TYPE_ADMIN_MAINT_OFF
:
1860 unmaintain_instance(h
, inst
, RUNMAINT_CLEAR
);
1861 reset_start_times(inst
);
1864 case RESTARTER_EVENT_TYPE_ADMIN_REFRESH
:
1865 refresh_instance(h
, inst
);
1868 case RESTARTER_EVENT_TYPE_ADMIN_DEGRADED
:
1869 log_framework(LOG_WARNING
, "Restarter: "
1870 "%s command (for %s) unimplemented.\n",
1871 event_names
[event
->riq_type
], inst
->ri_i
.i_fmri
);
1874 case RESTARTER_EVENT_TYPE_ADMIN_RESTART
:
1875 if (!instance_started(inst
)) {
1876 log_framework(LOG_DEBUG
, "Restarter: "
1877 "Not restarting %s; not running.\n",
1881 * Stop the instance. If it can be restarted,
1882 * the graph engine will send a new event.
1884 if (restart_dump(h
, inst
)) {
1885 (void) contract_kill(
1886 inst
->ri_i
.i_primary_ctid
, SIGABRT
,
1888 } else if (stop_instance(h
, inst
,
1889 RSTOP_RESTART
) == 0) {
1890 reset_start_times(inst
);
1895 case RESTARTER_EVENT_TYPE_ADD_INSTANCE
:
1898 uu_warn("%s:%d: Bad restarter event %d. "
1899 "Aborting.\n", __FILE__
, __LINE__
, event
->riq_type
);
1904 assert(inst
!= NULL
);
1905 MUTEX_UNLOCK(&inst
->ri_lock
);
1908 /* grab the queue lock */
1909 rip
= inst_lookup_queue(fmri
);
1913 /* delete the event */
1914 uu_list_remove(rip
->ri_queue
, event
);
1915 startd_free(event
, sizeof (restarter_instance_qentry_t
));
1918 assert(rip
!= NULL
);
1921 * Try to preserve the thread for a little while for future use.
1925 (void) pthread_cond_reltimedwait_np(&rip
->ri_queue_cv
,
1926 &rip
->ri_queue_lock
, &to
);
1928 if (uu_list_first(rip
->ri_queue
) != NULL
)
1931 rip
->ri_queue_thread
= 0;
1932 MUTEX_UNLOCK(&rip
->ri_queue_lock
);
1935 (void) scf_handle_unbind(h
);
1936 scf_handle_destroy(h
);
1942 is_admin_event(restarter_event_type_t t
) {
1945 case RESTARTER_EVENT_TYPE_ADMIN_MAINT_ON
:
1946 case RESTARTER_EVENT_TYPE_ADMIN_MAINT_ON_IMMEDIATE
:
1947 case RESTARTER_EVENT_TYPE_ADMIN_MAINT_OFF
:
1948 case RESTARTER_EVENT_TYPE_ADMIN_REFRESH
:
1949 case RESTARTER_EVENT_TYPE_ADMIN_DEGRADED
:
1950 case RESTARTER_EVENT_TYPE_ADMIN_RESTART
:
1958 restarter_queue_event(restarter_inst_t
*ri
, restarter_protocol_event_t
*e
)
1960 restarter_instance_qentry_t
*qe
;
1963 assert(MUTEX_HELD(&ri
->ri_queue_lock
));
1964 assert(!MUTEX_HELD(&ri
->ri_lock
));
1966 qe
= startd_zalloc(sizeof (restarter_instance_qentry_t
));
1967 qe
->riq_type
= e
->rpe_type
;
1968 qe
->riq_reason
= e
->rpe_reason
;
1970 uu_list_node_init(qe
, &qe
->riq_link
, restarter_queue_pool
);
1971 r
= uu_list_insert_before(ri
->ri_queue
, NULL
, qe
);
1976 * void *restarter_event_thread()
1978 * Handle incoming graph events by placing them on a per-instance
1979 * queue. We can't lock the main part of the instance structure, so
1980 * just modify the seprarately locked event queue portion.
1984 restarter_event_thread(void *unused
)
1989 * This is a new thread, and thus, gets its own handle
1990 * to the repository.
1992 h
= libscf_handle_create_bound_loop();
1994 MUTEX_LOCK(&ru
->restarter_update_lock
);
1998 restarter_protocol_event_t
*e
;
2000 while (ru
->restarter_update_wakeup
== 0)
2001 (void) pthread_cond_wait(&ru
->restarter_update_cv
,
2002 &ru
->restarter_update_lock
);
2004 ru
->restarter_update_wakeup
= 0;
2006 while ((e
= restarter_event_dequeue()) != NULL
) {
2007 restarter_inst_t
*rip
;
2010 MUTEX_UNLOCK(&ru
->restarter_update_lock
);
2013 * ADD_INSTANCE is special: there's likely no
2014 * instance structure yet, so we need to handle the
2015 * addition synchronously.
2017 switch (e
->rpe_type
) {
2018 case RESTARTER_EVENT_TYPE_ADD_INSTANCE
:
2019 if (restarter_insert_inst(h
, e
->rpe_inst
) != 0)
2020 log_error(LOG_INFO
, "Restarter: "
2021 "Could not add %s.\n", e
->rpe_inst
);
2023 MUTEX_LOCK(&st
->st_load_lock
);
2024 if (--st
->st_load_instances
== 0)
2025 (void) pthread_cond_broadcast(
2027 MUTEX_UNLOCK(&st
->st_load_lock
);
2033 * Lookup the instance, locking only the event queue.
2034 * Can't grab ri_lock here because it might be held
2035 * by a long-running method.
2037 rip
= inst_lookup_queue(e
->rpe_inst
);
2039 log_error(LOG_INFO
, "Restarter: "
2040 "Ignoring %s command for unknown service "
2041 "%s.\n", event_names
[e
->rpe_type
],
2046 /* Keep ADMIN events from filling up the queue. */
2047 if (is_admin_event(e
->rpe_type
) &&
2048 uu_list_numnodes(rip
->ri_queue
) >
2049 RINST_QUEUE_THRESHOLD
) {
2050 MUTEX_UNLOCK(&rip
->ri_queue_lock
);
2051 log_instance(rip
, B_TRUE
, "Instance event "
2052 "queue overflow. Dropping administrative "
2054 log_framework(LOG_DEBUG
, "%s: Instance event "
2055 "queue overflow. Dropping administrative "
2056 "request.\n", rip
->ri_i
.i_fmri
);
2060 /* Now add the event to the instance queue. */
2061 restarter_queue_event(rip
, e
);
2063 if (rip
->ri_queue_thread
== 0) {
2065 * Start a thread if one isn't already
2068 fmri
= safe_strdup(e
->rpe_inst
);
2069 rip
->ri_queue_thread
= startd_thread_create(
2070 restarter_process_events
, (void *)fmri
);
2073 * Signal the existing thread that there's
2076 (void) pthread_cond_broadcast(
2080 MUTEX_UNLOCK(&rip
->ri_queue_lock
);
2082 restarter_event_release(e
);
2084 MUTEX_LOCK(&ru
->restarter_update_lock
);
2089 * Unreachable for now -- there's currently no graceful cleanup
2092 (void) scf_handle_unbind(h
);
2093 scf_handle_destroy(h
);
2097 static restarter_inst_t
*
2098 contract_to_inst(ctid_t ctid
)
2100 restarter_inst_t
*inst
;
2103 id
= lookup_inst_by_contract(ctid
);
2107 inst
= inst_lookup_by_id(id
);
2110 * Since ri_lock isn't held by the contract id lookup, this
2111 * instance may have been restarted and now be in a new
2112 * contract, making the old contract no longer valid for this
2115 if (ctid
!= inst
->ri_i
.i_primary_ctid
) {
2116 MUTEX_UNLOCK(&inst
->ri_lock
);
2124 * void contract_action()
2125 * Take action on contract events.
2128 contract_action(scf_handle_t
*h
, restarter_inst_t
*inst
, ctid_t id
,
2131 const char *fmri
= inst
->ri_i
.i_fmri
;
2133 assert(MUTEX_HELD(&inst
->ri_lock
));
2136 * If startd has stopped this contract, there is no need to
2139 if (inst
->ri_i
.i_primary_ctid
> 0 &&
2140 inst
->ri_i
.i_primary_ctid_stopped
)
2143 if ((type
& (CT_PR_EV_EMPTY
| CT_PR_EV_CORE
| CT_PR_EV_SIGNAL
2144 | CT_PR_EV_HWERR
)) == 0) {
2146 * There shouldn't be other events, since that's not how we set
2147 * the terms. Thus, just log an error and drive on.
2149 log_framework(LOG_NOTICE
,
2150 "%s: contract %ld received unexpected critical event "
2151 "(%d)\n", fmri
, id
, type
);
2155 assert(instance_in_transition(inst
) == 0);
2157 if (instance_is_wait_style(inst
)) {
2159 * We ignore all events; if they impact the
2160 * process we're monitoring, then the
2161 * wait_thread will stop the instance.
2163 log_framework(LOG_DEBUG
,
2164 "%s: ignoring contract event on wait-style service\n",
2168 * A CT_PR_EV_EMPTY event is an RSTOP_EXIT request.
2171 case CT_PR_EV_EMPTY
:
2172 (void) stop_instance(h
, inst
, RSTOP_EXIT
);
2175 (void) stop_instance(h
, inst
, RSTOP_CORE
);
2177 case CT_PR_EV_SIGNAL
:
2178 (void) stop_instance(h
, inst
, RSTOP_SIGNAL
);
2180 case CT_PR_EV_HWERR
:
2181 (void) stop_instance(h
, inst
, RSTOP_HWERR
);
2188 * void *restarter_contract_event_thread(void *)
2189 * Listens to the process contract bundle for critical events, taking action
2190 * on events from contracts we know we are responsible for.
2194 restarter_contracts_event_thread(void *unused
)
2197 scf_handle_t
*local_handle
;
2200 * Await graph load completion. That is, stop here, until we've scanned
2201 * the repository for contract - instance associations.
2203 MUTEX_LOCK(&st
->st_load_lock
);
2204 while (!(st
->st_load_complete
&& st
->st_load_instances
== 0))
2205 (void) pthread_cond_wait(&st
->st_load_cv
, &st
->st_load_lock
);
2206 MUTEX_UNLOCK(&st
->st_load_lock
);
2209 * This is a new thread, and thus, gets its own handle
2210 * to the repository.
2212 if ((local_handle
= libscf_handle_create_bound(SCF_VERSION
)) == NULL
)
2213 uu_die("Unable to bind a new repository handle: %s\n",
2214 scf_strerror(scf_error()));
2216 fd
= open64(CTFS_ROOT
"/process/pbundle", O_RDONLY
);
2218 uu_die("process bundle open failed");
2221 * Make sure we get all events (including those generated by configd
2222 * before this thread was started).
2224 err
= ct_event_reset(fd
);
2232 ct_stathdl_t status
;
2234 restarter_inst_t
*inst
;
2237 if (err
= ct_event_read_critical(fd
, &ev
)) {
2238 log_error(LOG_WARNING
,
2239 "Error reading next contract event: %s",
2244 evid
= ct_event_get_evid(ev
);
2245 ctid
= ct_event_get_ctid(ev
);
2246 type
= ct_event_get_type(ev
);
2249 if ((sfd
= contract_open(ctid
, "process", "status", O_RDONLY
))
2255 if (err
= ct_status_read(sfd
, CTD_COMMON
, &status
)) {
2256 log_framework(LOG_WARNING
, "Could not get status for "
2257 "contract %ld: %s\n", ctid
, strerror(err
));
2264 cookie
= ct_status_get_cookie(status
);
2266 log_framework(LOG_DEBUG
, "Received event %d for ctid %ld "
2267 "cookie %lld\n", type
, ctid
, cookie
);
2269 ct_status_free(status
);
2274 * svc.configd(1M) restart handling performed by the
2275 * fork_configd_thread. We don't acknowledge, as that thread
2278 if (cookie
== CONFIGD_COOKIE
) {
2284 if (storing_contract
!= 0 &&
2285 (inst
= contract_to_inst(ctid
)) == NULL
) {
2287 * This can happen for two reasons:
2288 * - method_run() has not yet stored the
2289 * the contract into the internal hash table.
2290 * - we receive an EMPTY event for an abandoned
2292 * If there is any contract in the process of
2293 * being stored into the hash table then re-read
2296 log_framework(LOG_DEBUG
,
2297 "Reset event %d for unknown "
2298 "contract id %ld\n", type
, ctid
);
2300 /* don't go too fast */
2301 (void) poll(NULL
, 0, 100);
2303 (void) ct_event_reset(fd
);
2309 * Do not call contract_to_inst() again if first
2313 inst
= contract_to_inst(ctid
);
2316 * This can happen if we receive an EMPTY
2317 * event for an abandoned contract.
2319 log_framework(LOG_DEBUG
,
2320 "Received event %d for unknown contract id "
2321 "%ld\n", type
, ctid
);
2323 log_framework(LOG_DEBUG
,
2324 "Received event %d for contract id "
2325 "%ld (%s)\n", type
, ctid
,
2328 contract_action(local_handle
, inst
, ctid
, type
);
2330 MUTEX_UNLOCK(&inst
->ri_lock
);
2333 efd
= contract_open(ct_event_get_ctid(ev
), "process", "ctl",
2336 (void) ct_ctl_ack(efd
, evid
);
2349 * Timeout queue, processed by restarter_timeouts_event_thread().
2351 timeout_queue_t
*timeouts
;
2352 static uu_list_pool_t
*timeout_pool
;
2354 typedef struct timeout_update
{
2355 pthread_mutex_t tu_lock
;
2356 pthread_cond_t tu_cv
;
2360 timeout_update_t
*tu
;
2362 static const char *timeout_ovr_svcs
[] = {
2363 "svc:/system/manifest-import:default",
2364 "svc:/network/initial:default",
2365 "svc:/network/service:default",
2366 "svc:/system/rmtmpfiles:default",
2367 "svc:/network/loopback:default",
2368 "svc:/network/physical:default",
2369 "svc:/system/device/local:default",
2370 "svc:/system/filesystem/usr:default",
2371 "svc:/system/filesystem/minimal:default",
2372 "svc:/system/filesystem/local:default",
2377 is_timeout_ovr(restarter_inst_t
*inst
)
2381 for (i
= 0; timeout_ovr_svcs
[i
] != NULL
; ++i
) {
2382 if (strcmp(inst
->ri_i
.i_fmri
, timeout_ovr_svcs
[i
]) == 0) {
2383 log_instance(inst
, B_TRUE
, "Timeout override by "
2384 "svc.startd. Using infinite timeout.");
2394 timeout_compare(const void *lc_arg
, const void *rc_arg
, void *private)
2396 hrtime_t t1
= ((const timeout_entry_t
*)lc_arg
)->te_timeout
;
2397 hrtime_t t2
= ((const timeout_entry_t
*)rc_arg
)->te_timeout
;
2409 timeouts
= startd_zalloc(sizeof (timeout_queue_t
));
2411 (void) pthread_mutex_init(&timeouts
->tq_lock
, &mutex_attrs
);
2413 timeout_pool
= startd_list_pool_create("timeouts",
2414 sizeof (timeout_entry_t
), offsetof(timeout_entry_t
, te_link
),
2415 timeout_compare
, UU_LIST_POOL_DEBUG
);
2416 assert(timeout_pool
!= NULL
);
2418 timeouts
->tq_list
= startd_list_create(timeout_pool
,
2419 timeouts
, UU_LIST_SORTED
);
2420 assert(timeouts
->tq_list
!= NULL
);
2422 tu
= startd_zalloc(sizeof (timeout_update_t
));
2423 (void) pthread_cond_init(&tu
->tu_cv
, NULL
);
2424 (void) pthread_mutex_init(&tu
->tu_lock
, &mutex_attrs
);
2428 timeout_insert(restarter_inst_t
*inst
, ctid_t cid
, uint64_t timeout_sec
)
2430 hrtime_t now
, timeout
;
2431 timeout_entry_t
*entry
;
2432 uu_list_index_t idx
;
2434 assert(MUTEX_HELD(&inst
->ri_lock
));
2439 * If we overflow LLONG_MAX, we're never timing out anyways, so
2442 if (timeout_sec
>= (LLONG_MAX
- now
) / 1000000000LL) {
2443 log_instance(inst
, B_TRUE
, "timeout_seconds too large, "
2444 "treating as infinite.");
2448 /* hrtime is in nanoseconds. Convert timeout_sec. */
2449 timeout
= now
+ (timeout_sec
* 1000000000LL);
2451 entry
= startd_alloc(sizeof (timeout_entry_t
));
2452 entry
->te_timeout
= timeout
;
2453 entry
->te_ctid
= cid
;
2454 entry
->te_fmri
= safe_strdup(inst
->ri_i
.i_fmri
);
2455 entry
->te_logstem
= safe_strdup(inst
->ri_logstem
);
2456 entry
->te_fired
= 0;
2457 /* Insert the calculated timeout time onto the queue. */
2458 MUTEX_LOCK(&timeouts
->tq_lock
);
2459 (void) uu_list_find(timeouts
->tq_list
, entry
, NULL
, &idx
);
2460 uu_list_node_init(entry
, &entry
->te_link
, timeout_pool
);
2461 uu_list_insert(timeouts
->tq_list
, entry
, idx
);
2462 MUTEX_UNLOCK(&timeouts
->tq_lock
);
2464 assert(inst
->ri_timeout
== NULL
);
2465 inst
->ri_timeout
= entry
;
2467 MUTEX_LOCK(&tu
->tu_lock
);
2469 (void) pthread_cond_broadcast(&tu
->tu_cv
);
2470 MUTEX_UNLOCK(&tu
->tu_lock
);
2475 timeout_remove(restarter_inst_t
*inst
, ctid_t cid
)
2477 assert(MUTEX_HELD(&inst
->ri_lock
));
2479 if (inst
->ri_timeout
== NULL
)
2482 assert(inst
->ri_timeout
->te_ctid
== cid
);
2484 MUTEX_LOCK(&timeouts
->tq_lock
);
2485 uu_list_remove(timeouts
->tq_list
, inst
->ri_timeout
);
2486 MUTEX_UNLOCK(&timeouts
->tq_lock
);
2488 free(inst
->ri_timeout
->te_fmri
);
2489 free(inst
->ri_timeout
->te_logstem
);
2490 startd_free(inst
->ri_timeout
, sizeof (timeout_entry_t
));
2491 inst
->ri_timeout
= NULL
;
2504 * Walk through the (sorted) timeouts list. While the timeout
2505 * at the head of the list is <= the current time, kill the
2508 MUTEX_LOCK(&timeouts
->tq_lock
);
2510 for (e
= uu_list_first(timeouts
->tq_list
);
2511 e
!= NULL
&& e
->te_timeout
<= now
;
2512 e
= uu_list_next(timeouts
->tq_list
, e
)) {
2513 log_framework(LOG_WARNING
, "%s: Method or service exit timed "
2514 "out. Killing contract %ld.\n", e
->te_fmri
, e
->te_ctid
);
2515 log_instance_fmri(e
->te_fmri
, e
->te_logstem
, B_TRUE
,
2516 "Method or service exit timed out. Killing contract %ld.",
2519 (void) contract_kill(e
->te_ctid
, SIGKILL
, e
->te_fmri
);
2522 if (uu_list_numnodes(timeouts
->tq_list
) > 0)
2527 MUTEX_UNLOCK(&timeouts
->tq_lock
);
2533 * void *restarter_timeouts_event_thread(void *)
2534 * Responsible for monitoring the method timeouts. This thread must
2535 * be started before any methods are called.
2539 restarter_timeouts_event_thread(void *unused
)
2542 * Timeouts are entered on a priority queue, which is processed by
2543 * this thread. As timeouts are specified in seconds, we'll do
2544 * the necessary processing every second, as long as the queue
2551 * As long as the timeout list isn't empty, process it
2554 if (timeout_now() == 0) {
2559 /* The list is empty, wait until we have more timeouts. */
2560 MUTEX_LOCK(&tu
->tu_lock
);
2562 while (tu
->tu_wakeup
== 0)
2563 (void) pthread_cond_wait(&tu
->tu_cv
, &tu
->tu_lock
);
2566 MUTEX_UNLOCK(&tu
->tu_lock
);
2575 (void) startd_thread_create(restarter_timeouts_event_thread
, NULL
);
2576 (void) startd_thread_create(restarter_event_thread
, NULL
);
2577 (void) startd_thread_create(restarter_contracts_event_thread
, NULL
);
2578 (void) startd_thread_create(wait_thread
, NULL
);
2585 restarter_instance_pool
= startd_list_pool_create("restarter_instances",
2586 sizeof (restarter_inst_t
), offsetof(restarter_inst_t
,
2587 ri_link
), restarter_instance_compare
, UU_LIST_POOL_DEBUG
);
2588 (void) memset(&instance_list
, 0, sizeof (instance_list
));
2590 (void) pthread_mutex_init(&instance_list
.ril_lock
, &mutex_attrs
);
2591 instance_list
.ril_instance_list
= startd_list_create(
2592 restarter_instance_pool
, &instance_list
, UU_LIST_SORTED
);
2594 restarter_queue_pool
= startd_list_pool_create(
2595 "restarter_instance_queue", sizeof (restarter_instance_qentry_t
),
2596 offsetof(restarter_instance_qentry_t
, riq_link
), NULL
,
2597 UU_LIST_POOL_DEBUG
);
2599 contract_list_pool
= startd_list_pool_create(
2600 "contract_list", sizeof (contract_entry_t
),
2601 offsetof(contract_entry_t
, ce_link
), NULL
,
2602 UU_LIST_POOL_DEBUG
);
2603 contract_hash_init();
2605 log_framework(LOG_DEBUG
, "Initialized restarter\n");