libscf.h revision 8823:000507e9108d
1/* 2 * CDDL HEADER START 3 * 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. 7 * 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. 12 * 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] 18 * 19 * CDDL HEADER END 20 */ 21 22/* 23 * Copyright 2009 Sun Microsystems, Inc. All rights reserved. 24 * Use is subject to license terms. 25 */ 26 27#ifndef _LIBSCF_H 28#define _LIBSCF_H 29 30 31#include <stddef.h> 32#include <sys/types.h> 33 34#ifdef __cplusplus 35extern "C" { 36#endif 37 38typedef struct scf_version *scf_version_t; 39#define SCF_VERSION ((scf_version_t)1UL) 40 41/* 42 * Opaque structures 43 */ 44typedef struct scf_handle scf_handle_t; 45typedef struct scf_scope scf_scope_t; 46typedef struct scf_service scf_service_t; 47typedef struct scf_instance scf_instance_t; 48typedef struct scf_propertygroup scf_propertygroup_t; 49typedef struct scf_property scf_property_t; 50 51typedef struct scf_snapshot scf_snapshot_t; 52typedef struct scf_snaplevel scf_snaplevel_t; 53 54typedef struct scf_transaction scf_transaction_t; 55typedef struct scf_transaction_entry scf_transaction_entry_t; 56typedef struct scf_value scf_value_t; 57 58typedef struct scf_iter scf_iter_t; 59 60typedef struct scf_pg_tmpl scf_pg_tmpl_t; 61typedef struct scf_prop_tmpl scf_prop_tmpl_t; 62typedef struct scf_tmpl_errors scf_tmpl_errors_t; 63 64typedef struct scf_simple_app_props scf_simple_app_props_t; 65typedef struct scf_simple_prop scf_simple_prop_t; 66 67/* 68 * Types 69 */ 70typedef enum { 71 SCF_TYPE_INVALID = 0, 72 73 SCF_TYPE_BOOLEAN, 74 SCF_TYPE_COUNT, 75 SCF_TYPE_INTEGER, 76 SCF_TYPE_TIME, 77 SCF_TYPE_ASTRING, 78 SCF_TYPE_OPAQUE, 79 80 SCF_TYPE_USTRING = 100, 81 82 SCF_TYPE_URI = 200, 83 SCF_TYPE_FMRI, 84 85 SCF_TYPE_HOST = 300, 86 SCF_TYPE_HOSTNAME, 87 SCF_TYPE_NET_ADDR_V4, 88 SCF_TYPE_NET_ADDR_V6 89} scf_type_t; 90 91typedef struct scf_time { 92 int64_t t_seconds; 93 int32_t t_ns; 94} scf_time_t; 95 96/* 97 * There is no explicit initializer for this structure. Functions 98 * which set or populate this structure assume that it is either 99 * uninitialized or destroyed. 100 */ 101typedef struct scf_values { 102 scf_type_t value_type; 103 void *reserved; /* reserved for future use */ 104 int value_count; 105 char **values_as_strings; 106 union { 107 uint64_t *v_count; 108 uint8_t *v_boolean; 109 int64_t *v_integer; 110 char **v_astring; 111 char **v_ustring; 112 char **v_opaque; 113 scf_time_t *v_time; 114 } values; 115} scf_values_t; 116 117typedef struct scf_count_ranges { 118 int scr_num_ranges; 119 uint64_t *scr_min; 120 uint64_t *scr_max; 121} scf_count_ranges_t; 122 123typedef struct scf_int_ranges { 124 int sir_num_ranges; 125 int64_t *sir_min; 126 int64_t *sir_max; 127} scf_int_ranges_t; 128 129/* 130 * Return codes 131 */ 132#define SCF_SUCCESS 0 133#define SCF_COMPLETE 1 134#define SCF_FAILED -1 135 136typedef enum scf_error { 137 SCF_ERROR_NONE = 1000, /* no error */ 138 SCF_ERROR_NOT_BOUND, /* handle not bound */ 139 SCF_ERROR_NOT_SET, /* cannot use unset argument */ 140 SCF_ERROR_NOT_FOUND, /* nothing of that name found */ 141 SCF_ERROR_TYPE_MISMATCH, /* type does not match value */ 142 SCF_ERROR_IN_USE, /* cannot modify while in-use */ 143 SCF_ERROR_CONNECTION_BROKEN, /* repository connection gone */ 144 SCF_ERROR_INVALID_ARGUMENT, /* bad argument */ 145 SCF_ERROR_NO_MEMORY, /* no memory available */ 146 SCF_ERROR_CONSTRAINT_VIOLATED, /* required constraint not met */ 147 SCF_ERROR_EXISTS, /* object already exists */ 148 SCF_ERROR_NO_SERVER, /* repository server unavailable */ 149 SCF_ERROR_NO_RESOURCES, /* server has insufficient resources */ 150 SCF_ERROR_PERMISSION_DENIED, /* insufficient privileges for action */ 151 SCF_ERROR_BACKEND_ACCESS, /* backend refused access */ 152 SCF_ERROR_HANDLE_MISMATCH, /* mismatched SCF handles */ 153 SCF_ERROR_HANDLE_DESTROYED, /* object bound to destroyed handle */ 154 SCF_ERROR_VERSION_MISMATCH, /* incompatible SCF version */ 155 SCF_ERROR_BACKEND_READONLY, /* backend is read-only */ 156 SCF_ERROR_DELETED, /* object has been deleted */ 157 SCF_ERROR_TEMPLATE_INVALID, /* template data is invalid */ 158 159 SCF_ERROR_CALLBACK_FAILED = 1080, /* user callback function failed */ 160 161 SCF_ERROR_INTERNAL = 1101 /* internal error */ 162} scf_error_t; 163 164/* 165 * This enum MUST be kept in sync with 166 * struct _scf_tmpl_error_desc em_desc() in scf_tmpl.c 167 */ 168typedef enum scf_tmpl_error_type { 169 SCF_TERR_MISSING_PG, /* property group missing */ 170 SCF_TERR_WRONG_PG_TYPE, /* property group type incorrect */ 171 SCF_TERR_MISSING_PROP, /* missing required property */ 172 SCF_TERR_WRONG_PROP_TYPE, /* property type incorrect */ 173 SCF_TERR_CARDINALITY_VIOLATION, /* wrong number of values */ 174 SCF_TERR_VALUE_CONSTRAINT_VIOLATED, /* constraint violated for value */ 175 SCF_TERR_RANGE_VIOLATION, /* value violated specified range */ 176 SCF_TERR_PG_REDEFINE, /* global or restarter pg_pattern */ 177 /* redefined by the instance */ 178 SCF_TERR_PROP_TYPE_MISMATCH, /* property and value type mismatch */ 179 SCF_TERR_VALUE_OUT_OF_RANGE, /* value is out of range in template */ 180 SCF_TERR_INVALID_VALUE, /* value is not valid for the */ 181 /* template */ 182 SCF_TERR_PG_PATTERN_CONFLICT, /* pg_pattern conflicts with higher */ 183 /* level definition */ 184 SCF_TERR_PROP_PATTERN_CONFLICT, /* prop_pattern conflicts with higher */ 185 /* level definition */ 186 SCF_TERR_GENERAL_REDEFINE, /* global or restarter template */ 187 /* redefined */ 188 SCF_TERR_INCLUDE_VALUES, /* No supporting constraints or */ 189 /* values for include_values */ 190 SCF_TERR_PG_PATTERN_INCOMPLETE, /* Required pg_pattern is missing */ 191 /* name or type attribute. */ 192 SCF_TERR_PROP_PATTERN_INCOMPLETE /* Required prop_pattern is */ 193 /* missing a type attribute. */ 194} scf_tmpl_error_type_t; 195 196typedef struct scf_tmpl_error scf_tmpl_error_t; 197 198/* 199 * scf_tmpl_strerror() human readable flag 200 */ 201#define SCF_TMPL_STRERROR_HUMAN 0x1 202 203/* 204 * Standard services 205 */ 206#define SCF_SERVICE_CONFIGD ((const char *) \ 207 "svc:/system/svc/repository:default") 208#define SCF_INSTANCE_GLOBAL ((const char *) \ 209 "svc:/system/svc/global:default") 210#define SCF_SERVICE_GLOBAL ((const char *) \ 211 "svc:/system/svc/global") 212#define SCF_SERVICE_STARTD ((const char *) \ 213 "svc:/system/svc/restarter:default") 214 215/* 216 * Major milestones 217 */ 218#define SCF_MILESTONE_SINGLE_USER \ 219 ((const char *) "svc:/milestone/single-user:default") 220#define SCF_MILESTONE_MULTI_USER \ 221 ((const char *) "svc:/milestone/multi-user:default") 222#define SCF_MILESTONE_MULTI_USER_SERVER \ 223 ((const char *) "svc:/milestone/multi-user-server:default") 224 225/* 226 * standard scope names 227 */ 228#define SCF_SCOPE_LOCAL ((const char *)"localhost") 229 230/* 231 * Property group types 232 */ 233#define SCF_GROUP_APPLICATION ((const char *)"application") 234#define SCF_GROUP_FRAMEWORK ((const char *)"framework") 235#define SCF_GROUP_DEPENDENCY ((const char *)"dependency") 236#define SCF_GROUP_METHOD ((const char *)"method") 237#define SCF_GROUP_TEMPLATE ((const char *)"template") 238#define SCF_GROUP_TEMPLATE_PG_PATTERN ((const char *)"template_pg_pattern") 239#define SCF_GROUP_TEMPLATE_PROP_PATTERN ((const char *)"template_prop_pattern") 240 241/* 242 * Dependency types 243 */ 244#define SCF_DEP_REQUIRE_ALL ((const char *)"require_all") 245#define SCF_DEP_REQUIRE_ANY ((const char *)"require_any") 246#define SCF_DEP_EXCLUDE_ALL ((const char *)"exclude_all") 247#define SCF_DEP_OPTIONAL_ALL ((const char *)"optional_all") 248 249#define SCF_DEP_RESET_ON_ERROR ((const char *)"error") 250#define SCF_DEP_RESET_ON_RESTART ((const char *)"restart") 251#define SCF_DEP_RESET_ON_REFRESH ((const char *)"refresh") 252#define SCF_DEP_RESET_ON_NONE ((const char *)"none") 253 254/* 255 * Standard property group names 256 */ 257#define SCF_PG_GENERAL ((const char *)"general") 258#define SCF_PG_GENERAL_OVR ((const char *)"general_ovr") 259#define SCF_PG_RESTARTER ((const char *)"restarter") 260#define SCF_PG_RESTARTER_ACTIONS ((const char *)"restarter_actions") 261#define SCF_PG_METHOD_CONTEXT ((const char *)"method_context") 262#define SCF_PG_APP_DEFAULT ((const char *)"application") 263#define SCF_PG_DEPENDENTS ((const char *)"dependents") 264#define SCF_PG_OPTIONS ((const char *)"options") 265#define SCF_PG_OPTIONS_OVR ((const char *)"options_ovr") 266#define SCF_PG_STARTD ((const char *)"startd") 267#define SCF_PG_STARTD_PRIVATE ((const char *)"svc-startd-private") 268#define SCF_PG_DEATHROW ((const char *)"deathrow") 269 270/* 271 * Template property group names and prefixes 272 */ 273#define SCF_PG_TM_COMMON_NAME ((const char *)"tm_common_name") 274#define SCF_PG_TM_DESCRIPTION ((const char *)"tm_description") 275 276#define SCF_PG_TM_MAN_PREFIX ((const char *)"tm_man_") 277#define SCF_PG_TM_DOC_PREFIX ((const char *)"tm_doc_") 278 279/* 280 * Standard property names 281 */ 282#define SCF_PROPERTY_AUX_STATE ((const char *)"auxiliary_state") 283#define SCF_PROPERTY_AUX_FMRI ((const char *)"auxiliary_fmri") 284#define SCF_PROPERTY_AUX_TTY ((const char *)"auxiliary_tty") 285#define SCF_PROPERTY_CONTRACT ((const char *)"contract") 286#define SCF_PROPERTY_COREFILE_PATTERN ((const char *)"corefile_pattern") 287#define SCF_PROPERTY_DEGRADED ((const char *)"degraded") 288#define SCF_PROPERTY_DEGRADE_IMMEDIATE ((const char *)"degrade_immediate") 289#define SCF_PROPERTY_DURATION ((const char *)"duration") 290#define SCF_PROPERTY_ENABLED ((const char *)"enabled") 291#define SCF_PROPERTY_DEATHROW ((const char *)"deathrow") 292#define SCF_PROPERTY_ENTITY_STABILITY ((const char *)"entity_stability") 293#define SCF_PROPERTY_ENTITIES ((const char *)"entities") 294#define SCF_PROPERTY_EXEC ((const char *)"exec") 295#define SCF_PROPERTY_GROUP ((const char *)"group") 296#define SCF_PROPERTY_GROUPING ((const char *)"grouping") 297#define SCF_PROPERTY_IGNORE ((const char *)"ignore_error") 298#define SCF_PROPERTY_INTERNAL_SEPARATORS ((const char *)"internal_separators") 299#define SCF_PROPERTY_LIMIT_PRIVILEGES ((const char *)"limit_privileges") 300#define SCF_PROPERTY_MAINT_OFF ((const char *)"maint_off") 301#define SCF_PROPERTY_MAINT_ON ((const char *)"maint_on") 302#define SCF_PROPERTY_MAINT_ON_IMMEDIATE ((const char *)"maint_on_immediate") 303#define SCF_PROPERTY_MAINT_ON_IMMTEMP ((const char *)"maint_on_immtemp") 304#define SCF_PROPERTY_MAINT_ON_TEMPORARY ((const char *)"maint_on_temporary") 305#define SCF_PROPERTY_METHOD_PID ((const char *)"method_pid") 306#define SCF_PROPERTY_MILESTONE ((const char *)"milestone") 307#define SCF_PROPERTY_NEED_SESSION ((const char *)"need_session") 308#define SCF_PROPERTY_NEXT_STATE ((const char *)"next_state") 309#define SCF_PROPERTY_PACKAGE ((const char *)"package") 310#define SCF_PROPERTY_PRIVILEGES ((const char *)"privileges") 311#define SCF_PROPERTY_PROFILE ((const char *)"profile") 312#define SCF_PROPERTY_PROJECT ((const char *)"project") 313#define SCF_PROPERTY_REFRESH ((const char *)"refresh") 314#define SCF_PROPERTY_RESOURCE_POOL ((const char *)"resource_pool") 315#define SCF_PROPERTY_ENVIRONMENT ((const char *)"environment") 316#define SCF_PROPERTY_RESTART ((const char *)"restart") 317#define SCF_PROPERTY_RESTARTER ((const char *)"restarter") 318#define SCF_PROPERTY_RESTART_INTERVAL ((const char *)"restart_interval") 319#define SCF_PROPERTY_RESTART_ON ((const char *)"restart_on") 320#define SCF_PROPERTY_RESTORE ((const char *)"restore") 321#define SCF_PROPERTY_SINGLE_INSTANCE ((const char *)"single_instance") 322#define SCF_PROPERTY_START_METHOD_TIMESTAMP \ 323 ((const char *)"start_method_timestamp") 324#define SCF_PROPERTY_START_METHOD_WAITSTATUS \ 325 ((const char *)"start_method_waitstatus") 326#define SCF_PROPERTY_START_PID ((const char *)"start_pid") 327#define SCF_PROPERTY_STATE ((const char *)"state") 328#define SCF_PROPERTY_STABILITY ((const char *)"stability") 329#define SCF_PROPERTY_STATE_TIMESTAMP ((const char *)"state_timestamp") 330#define SCF_PROPERTY_SUPP_GROUPS ((const char *)"supp_groups") 331#define SCF_PROPERTY_TIMEOUT ((const char *)"timeout_seconds") 332#define SCF_PROPERTY_TIMEOUT_RETRY ((const char *)"timeout_retry") 333#define SCF_PROPERTY_TRANSIENT_CONTRACT ((const char *)"transient_contract") 334#define SCF_PROPERTY_TYPE ((const char *)"type") 335#define SCF_PROPERTY_USE_PROFILE ((const char *)"use_profile") 336#define SCF_PROPERTY_USER ((const char *)"user") 337#define SCF_PROPERTY_UTMPX_PREFIX ((const char *)"utmpx_prefix") 338#define SCF_PROPERTY_WORKING_DIRECTORY ((const char *)"working_directory") 339 340/* 341 * Template property names 342 */ 343#define SCF_PROPERTY_TM_CARDINALITY_MIN ((const char *)"cardinality_min") 344#define SCF_PROPERTY_TM_CARDINALITY_MAX ((const char *)"cardinality_max") 345#define SCF_PROPERTY_TM_CHOICES_INCLUDE_VALUES ((const char *) \ 346 "choices_include_values") 347#define SCF_PROPERTY_TM_CHOICES_NAME ((const char *)"choices_name") 348#define SCF_PROPERTY_TM_CHOICES_RANGE ((const char *)"choices_range") 349#define SCF_PROPERTY_TM_CONSTRAINT_NAME ((const char *)"constraint_name") 350#define SCF_PROPERTY_TM_CONSTRAINT_RANGE ((const char *)"constraint_range") 351#define SCF_PROPERTY_TM_MANPATH ((const char *)"manpath") 352#define SCF_PROPERTY_TM_NAME ((const char *)"name") 353#define SCF_PROPERTY_TM_PG_PATTERN ((const char *)"pg_pattern") 354#define SCF_PROPERTY_TM_REQUIRED ((const char *)"required") 355#define SCF_PROPERTY_TM_SECTION ((const char *)"section") 356#define SCF_PROPERTY_TM_TARGET ((const char *)"target") 357#define SCF_PROPERTY_TM_TITLE ((const char *)"title") 358#define SCF_PROPERTY_TM_TYPE ((const char *)"type") 359#define SCF_PROPERTY_TM_URI ((const char *)"uri") 360#define SCF_PROPERTY_TM_VALUE_PREFIX ((const char *)"value_") 361#define SCF_PROPERTY_TM_VALUES_NAME ((const char *)"values_name") 362#define SCF_PROPERTY_TM_VISIBILITY ((const char *)"visibility") 363#define SCF_PROPERTY_TM_COMMON_NAME_PREFIX ((const char *)"common_name_") 364#define SCF_PROPERTY_TM_DESCRIPTION_PREFIX ((const char *)"description_") 365#define SCF_PROPERTY_TM_UNITS_PREFIX ((const char *)"units_") 366 367/* 368 * Templates wildcard string 369 */ 370#define SCF_TMPL_WILDCARD ((const char *)"*") 371 372/* 373 * Strings used by restarters for state and next_state properties. 374 * MAX_SCF_STATE_STRING holds the max length of a state string, including the 375 * terminating null. 376 */ 377 378#define MAX_SCF_STATE_STRING_SZ 14 379 380#define SCF_STATE_STRING_NONE ((const char *)"none") 381#define SCF_STATE_STRING_UNINIT ((const char *)"uninitialized") 382#define SCF_STATE_STRING_MAINT ((const char *)"maintenance") 383#define SCF_STATE_STRING_OFFLINE ((const char *)"offline") 384#define SCF_STATE_STRING_DISABLED ((const char *)"disabled") 385#define SCF_STATE_STRING_ONLINE ((const char *)"online") 386#define SCF_STATE_STRING_DEGRADED ((const char *)"degraded") 387#define SCF_STATE_STRING_LEGACY ((const char *)"legacy_run") 388 389#define SCF_STATE_UNINIT 0x00000001 390#define SCF_STATE_MAINT 0x00000002 391#define SCF_STATE_OFFLINE 0x00000004 392#define SCF_STATE_DISABLED 0x00000008 393#define SCF_STATE_ONLINE 0x00000010 394#define SCF_STATE_DEGRADED 0x00000020 395#define SCF_STATE_ALL 0x0000003F 396 397#define SCF_PG_FLAG_NONPERSISTENT 0x1 398 399#define SCF_TRACE_LIBRARY 0x1 400#define SCF_TRACE_DAEMON 0x2 401 402#define SMF_IMMEDIATE 0x1 403#define SMF_TEMPORARY 0x2 404#define SMF_AT_NEXT_BOOT 0x4 405 406scf_error_t scf_error(void); 407const char *scf_strerror(scf_error_t); 408 409ssize_t scf_limit(uint32_t code); 410#define SCF_LIMIT_MAX_NAME_LENGTH -2000U 411#define SCF_LIMIT_MAX_VALUE_LENGTH -2001U 412#define SCF_LIMIT_MAX_PG_TYPE_LENGTH -2002U 413#define SCF_LIMIT_MAX_FMRI_LENGTH -2003U 414 415scf_handle_t *scf_handle_create(scf_version_t); 416 417int scf_handle_decorate(scf_handle_t *, const char *, scf_value_t *); 418#define SCF_DECORATE_CLEAR ((scf_value_t *)0) 419 420int scf_handle_bind(scf_handle_t *); 421int scf_handle_unbind(scf_handle_t *); 422void scf_handle_destroy(scf_handle_t *); 423 424int scf_type_base_type(scf_type_t type, scf_type_t *out); 425const char *scf_type_to_string(scf_type_t); 426scf_type_t scf_string_to_type(const char *); 427 428/* values */ 429scf_value_t *scf_value_create(scf_handle_t *); 430scf_handle_t *scf_value_handle(const scf_value_t *); 431void scf_value_destroy(scf_value_t *); 432 433scf_type_t scf_value_base_type(const scf_value_t *); 434scf_type_t scf_value_type(const scf_value_t *); 435int scf_value_is_type(const scf_value_t *, scf_type_t); 436 437void scf_value_reset(scf_value_t *); 438 439int scf_value_get_boolean(const scf_value_t *, uint8_t *); 440int scf_value_get_count(const scf_value_t *, uint64_t *); 441int scf_value_get_integer(const scf_value_t *, int64_t *); 442int scf_value_get_time(const scf_value_t *, int64_t *, int32_t *); 443ssize_t scf_value_get_astring(const scf_value_t *, char *, size_t); 444ssize_t scf_value_get_ustring(const scf_value_t *, char *, size_t); 445ssize_t scf_value_get_opaque(const scf_value_t *, void *, size_t); 446 447void scf_value_set_boolean(scf_value_t *, uint8_t); 448void scf_value_set_count(scf_value_t *, uint64_t); 449void scf_value_set_integer(scf_value_t *, int64_t); 450int scf_value_set_time(scf_value_t *, int64_t, int32_t); 451int scf_value_set_astring(scf_value_t *, const char *); 452int scf_value_set_ustring(scf_value_t *, const char *); 453int scf_value_set_opaque(scf_value_t *, const void *, size_t); 454 455ssize_t scf_value_get_as_string(const scf_value_t *, char *, size_t); 456ssize_t scf_value_get_as_string_typed(const scf_value_t *, scf_type_t, 457 char *, size_t); 458int scf_value_set_from_string(scf_value_t *, scf_type_t, const char *); 459 460scf_iter_t *scf_iter_create(scf_handle_t *); 461scf_handle_t *scf_iter_handle(const scf_iter_t *); 462void scf_iter_reset(scf_iter_t *); 463void scf_iter_destroy(scf_iter_t *); 464 465int scf_iter_handle_scopes(scf_iter_t *, const scf_handle_t *); 466int scf_iter_scope_services(scf_iter_t *, const scf_scope_t *); 467int scf_iter_service_instances(scf_iter_t *, const scf_service_t *); 468int scf_iter_service_pgs(scf_iter_t *, const scf_service_t *); 469int scf_iter_instance_pgs(scf_iter_t *, const scf_instance_t *); 470int scf_iter_instance_pgs_composed(scf_iter_t *, const scf_instance_t *, 471 const scf_snapshot_t *); 472int scf_iter_service_pgs_typed(scf_iter_t *, const scf_service_t *, 473 const char *); 474int scf_iter_instance_pgs_typed(scf_iter_t *, const scf_instance_t *, 475 const char *); 476int scf_iter_instance_pgs_typed_composed(scf_iter_t *, const scf_instance_t *, 477 const scf_snapshot_t *, const char *); 478int scf_iter_snaplevel_pgs(scf_iter_t *, const scf_snaplevel_t *); 479int scf_iter_snaplevel_pgs_typed(scf_iter_t *, const scf_snaplevel_t *, 480 const char *); 481int scf_iter_instance_snapshots(scf_iter_t *, const scf_instance_t *); 482int scf_iter_pg_properties(scf_iter_t *, const scf_propertygroup_t *); 483int scf_iter_property_values(scf_iter_t *, const scf_property_t *); 484 485int scf_iter_next_scope(scf_iter_t *, scf_scope_t *); 486int scf_iter_next_service(scf_iter_t *, scf_service_t *); 487int scf_iter_next_instance(scf_iter_t *, scf_instance_t *); 488int scf_iter_next_pg(scf_iter_t *, scf_propertygroup_t *); 489int scf_iter_next_property(scf_iter_t *, scf_property_t *); 490int scf_iter_next_snapshot(scf_iter_t *, scf_snapshot_t *); 491int scf_iter_next_value(scf_iter_t *, scf_value_t *); 492 493scf_scope_t *scf_scope_create(scf_handle_t *); 494scf_handle_t *scf_scope_handle(const scf_scope_t *); 495 496/* XXX eventually remove this */ 497#define scf_handle_get_local_scope(h, s) \ 498 scf_handle_get_scope((h), SCF_SCOPE_LOCAL, (s)) 499 500int scf_handle_get_scope(scf_handle_t *, const char *, scf_scope_t *); 501void scf_scope_destroy(scf_scope_t *); 502ssize_t scf_scope_get_name(const scf_scope_t *, char *, size_t); 503 504ssize_t scf_scope_to_fmri(const scf_scope_t *, char *, size_t); 505 506scf_service_t *scf_service_create(scf_handle_t *); 507scf_handle_t *scf_service_handle(const scf_service_t *); 508void scf_service_destroy(scf_service_t *); 509int scf_scope_get_parent(const scf_scope_t *, scf_scope_t *); 510ssize_t scf_service_get_name(const scf_service_t *, char *, size_t); 511ssize_t scf_service_to_fmri(const scf_service_t *, char *, size_t); 512int scf_service_get_parent(const scf_service_t *, scf_scope_t *); 513int scf_scope_get_service(const scf_scope_t *, const char *, scf_service_t *); 514int scf_scope_add_service(const scf_scope_t *, const char *, scf_service_t *); 515int scf_service_delete(scf_service_t *); 516 517scf_instance_t *scf_instance_create(scf_handle_t *); 518scf_handle_t *scf_instance_handle(const scf_instance_t *); 519void scf_instance_destroy(scf_instance_t *); 520ssize_t scf_instance_get_name(const scf_instance_t *, char *, size_t); 521ssize_t scf_instance_to_fmri(const scf_instance_t *, char *, size_t); 522int scf_service_get_instance(const scf_service_t *, const char *, 523 scf_instance_t *); 524int scf_service_add_instance(const scf_service_t *, const char *, 525 scf_instance_t *); 526int scf_instance_delete(scf_instance_t *); 527 528scf_snapshot_t *scf_snapshot_create(scf_handle_t *); 529scf_handle_t *scf_snapshot_handle(const scf_snapshot_t *); 530void scf_snapshot_destroy(scf_snapshot_t *); 531ssize_t scf_snapshot_get_name(const scf_snapshot_t *, char *, size_t); 532int scf_snapshot_get_parent(const scf_snapshot_t *, scf_instance_t *); 533int scf_instance_get_snapshot(const scf_instance_t *, const char *, 534 scf_snapshot_t *); 535int scf_snapshot_update(scf_snapshot_t *); 536 537scf_snaplevel_t *scf_snaplevel_create(scf_handle_t *); 538scf_handle_t *scf_snaplevel_handle(const scf_snaplevel_t *); 539void scf_snaplevel_destroy(scf_snaplevel_t *); 540int scf_snaplevel_get_parent(const scf_snaplevel_t *, scf_snapshot_t *); 541ssize_t scf_snaplevel_get_scope_name(const scf_snaplevel_t *, char *, size_t); 542ssize_t scf_snaplevel_get_service_name(const scf_snaplevel_t *, char *, size_t); 543ssize_t scf_snaplevel_get_instance_name(const scf_snaplevel_t *, char *, 544 size_t); 545int scf_snaplevel_get_pg(const scf_snaplevel_t *, const char *, 546 scf_propertygroup_t *pg); 547int scf_snapshot_get_base_snaplevel(const scf_snapshot_t *, scf_snaplevel_t *); 548int scf_snaplevel_get_next_snaplevel(const scf_snaplevel_t *, 549 scf_snaplevel_t *); 550 551scf_propertygroup_t *scf_pg_create(scf_handle_t *); 552scf_handle_t *scf_pg_handle(const scf_propertygroup_t *); 553void scf_pg_destroy(scf_propertygroup_t *); 554ssize_t scf_pg_to_fmri(const scf_propertygroup_t *, char *, size_t); 555ssize_t scf_pg_get_name(const scf_propertygroup_t *, char *, size_t); 556ssize_t scf_pg_get_type(const scf_propertygroup_t *, char *, size_t); 557int scf_pg_get_flags(const scf_propertygroup_t *, uint32_t *); 558int scf_pg_get_parent_service(const scf_propertygroup_t *, scf_service_t *); 559int scf_pg_get_parent_instance(const scf_propertygroup_t *, scf_instance_t *); 560int scf_pg_get_parent_snaplevel(const scf_propertygroup_t *, scf_snaplevel_t *); 561int scf_service_get_pg(const scf_service_t *, const char *, 562 scf_propertygroup_t *); 563int scf_instance_get_pg(const scf_instance_t *, const char *, 564 scf_propertygroup_t *); 565int scf_instance_get_pg_composed(const scf_instance_t *, const scf_snapshot_t *, 566 const char *, scf_propertygroup_t *); 567int scf_service_add_pg(const scf_service_t *, const char *, const char *, 568 uint32_t, scf_propertygroup_t *); 569int scf_instance_add_pg(const scf_instance_t *, const char *, const char *, 570 uint32_t, scf_propertygroup_t *); 571int scf_pg_delete(scf_propertygroup_t *); 572 573int scf_pg_get_underlying_pg(const scf_propertygroup_t *, 574 scf_propertygroup_t *); 575int scf_instance_get_parent(const scf_instance_t *, scf_service_t *); 576 577int scf_pg_update(scf_propertygroup_t *); 578 579scf_property_t *scf_property_create(scf_handle_t *); 580scf_handle_t *scf_property_handle(const scf_property_t *); 581void scf_property_destroy(scf_property_t *); 582int scf_property_is_type(const scf_property_t *, scf_type_t); 583int scf_property_type(const scf_property_t *, scf_type_t *); 584ssize_t scf_property_get_name(const scf_property_t *, char *, size_t); 585int scf_property_get_value(const scf_property_t *, scf_value_t *); 586ssize_t scf_property_to_fmri(const scf_property_t *, char *, size_t); 587int scf_pg_get_property(const scf_propertygroup_t *, const char *, 588 scf_property_t *); 589 590scf_transaction_t *scf_transaction_create(scf_handle_t *); 591scf_handle_t *scf_transaction_handle(const scf_transaction_t *); 592int scf_transaction_start(scf_transaction_t *, scf_propertygroup_t *); 593void scf_transaction_destroy(scf_transaction_t *); 594void scf_transaction_destroy_children(scf_transaction_t *); 595 596void scf_transaction_reset(scf_transaction_t *); 597void scf_transaction_reset_all(scf_transaction_t *); 598 599int scf_transaction_commit(scf_transaction_t *); 600 601scf_transaction_entry_t *scf_entry_create(scf_handle_t *); 602scf_handle_t *scf_entry_handle(const scf_transaction_entry_t *); 603void scf_entry_reset(scf_transaction_entry_t *); 604void scf_entry_destroy(scf_transaction_entry_t *); 605void scf_entry_destroy_children(scf_transaction_entry_t *); 606 607int scf_transaction_property_change(scf_transaction_t *, 608 scf_transaction_entry_t *, const char *, scf_type_t); 609int scf_transaction_property_delete(scf_transaction_t *, 610 scf_transaction_entry_t *, const char *); 611int scf_transaction_property_new(scf_transaction_t *, 612 scf_transaction_entry_t *, const char *, scf_type_t); 613int scf_transaction_property_change_type(scf_transaction_t *, 614 scf_transaction_entry_t *, const char *, scf_type_t); 615 616int scf_entry_add_value(scf_transaction_entry_t *, scf_value_t *); 617 618int scf_handle_decode_fmri(scf_handle_t *, const char *, scf_scope_t *, 619 scf_service_t *, scf_instance_t *, scf_propertygroup_t *, scf_property_t *, 620 int); 621#define SCF_DECODE_FMRI_EXACT 0x00000001 622#define SCF_DECODE_FMRI_TRUNCATE 0x00000002 623#define SCF_DECODE_FMRI_REQUIRE_INSTANCE 0x00000004 624#define SCF_DECODE_FMRI_REQUIRE_NO_INSTANCE 0x00000008 625 626ssize_t scf_myname(scf_handle_t *, char *, size_t); 627 628/* 629 * Property group template interfaces. 630 */ 631scf_pg_tmpl_t *scf_tmpl_pg_create(scf_handle_t *); 632void scf_tmpl_pg_destroy(scf_pg_tmpl_t *); 633void scf_tmpl_pg_reset(scf_pg_tmpl_t *); 634int scf_tmpl_get_by_pg(scf_propertygroup_t *, scf_pg_tmpl_t *, int); 635int scf_tmpl_get_by_pg_name(const char *, const char *, 636 const char *, const char *, scf_pg_tmpl_t *, int); 637int scf_tmpl_iter_pgs(scf_pg_tmpl_t *, const char *, const char *, 638 const char *, int); 639#define SCF_PG_TMPL_FLAG_REQUIRED 0x1 640#define SCF_PG_TMPL_FLAG_EXACT 0x2 641#define SCF_PG_TMPL_FLAG_CURRENT 0x4 642 643ssize_t scf_tmpl_pg_name(const scf_pg_tmpl_t *, char **); 644ssize_t scf_tmpl_pg_common_name(const scf_pg_tmpl_t *, const char *, char **); 645ssize_t scf_tmpl_pg_description(const scf_pg_tmpl_t *, const char *, char **); 646ssize_t scf_tmpl_pg_type(const scf_pg_tmpl_t *, char **); 647 648ssize_t scf_tmpl_pg_target(const scf_pg_tmpl_t *, char **); 649#define SCF_TM_TARGET_ALL ((const char *)"all") 650#define SCF_TM_TARGET_DELEGATE ((const char *)"delegate") 651#define SCF_TM_TARGET_INSTANCE ((const char *)"instance") 652#define SCF_TM_TARGET_THIS ((const char *)"this") 653 654int scf_tmpl_pg_required(const scf_pg_tmpl_t *, uint8_t *); 655 656/* 657 * Property template interfaces. 658 */ 659scf_prop_tmpl_t *scf_tmpl_prop_create(scf_handle_t *); 660void scf_tmpl_prop_destroy(scf_prop_tmpl_t *); 661void scf_tmpl_prop_reset(scf_prop_tmpl_t *); 662int scf_tmpl_get_by_prop(scf_pg_tmpl_t *, const char *, 663 scf_prop_tmpl_t *, int); 664int scf_tmpl_iter_props(scf_pg_tmpl_t *, scf_prop_tmpl_t *, int); 665#define SCF_PROP_TMPL_FLAG_REQUIRED 0x1 666 667ssize_t scf_tmpl_prop_name(const scf_prop_tmpl_t *, char **); 668int scf_tmpl_prop_type(const scf_prop_tmpl_t *, scf_type_t *); 669int scf_tmpl_prop_required(const scf_prop_tmpl_t *, uint8_t *); 670ssize_t scf_tmpl_prop_common_name(const scf_prop_tmpl_t *, const char *, 671 char **); 672ssize_t scf_tmpl_prop_description(const scf_prop_tmpl_t *, const char *, 673 char **); 674ssize_t scf_tmpl_prop_units(const scf_prop_tmpl_t *, const char *, char **); 675int scf_tmpl_prop_cardinality(const scf_prop_tmpl_t *prop, uint64_t *, 676 uint64_t *); 677int scf_tmpl_prop_internal_seps(const scf_prop_tmpl_t *, scf_values_t *); 678 679int scf_tmpl_prop_visibility(const scf_prop_tmpl_t *, uint8_t *); 680#define SCF_TMPL_VISIBILITY_HIDDEN 1 681#define SCF_TMPL_VISIBILITY_READONLY 2 682#define SCF_TMPL_VISIBILITY_READWRITE 3 683 684const char *scf_tmpl_visibility_to_string(uint8_t); 685#define SCF_TM_VISIBILITY_HIDDEN ((const char *)"hidden") 686#define SCF_TM_VISIBILITY_READONLY ((const char *)"readonly") 687#define SCF_TM_VISIBILITY_READWRITE ((const char *)"readwrite") 688 689int scf_tmpl_value_name_constraints(const scf_prop_tmpl_t *prop, 690 scf_values_t *vals); 691void scf_count_ranges_destroy(scf_count_ranges_t *); 692void scf_int_ranges_destroy(scf_int_ranges_t *); 693int scf_tmpl_value_count_range_constraints(const scf_prop_tmpl_t *, 694 scf_count_ranges_t *); 695int scf_tmpl_value_int_range_constraints(const scf_prop_tmpl_t *, 696 scf_int_ranges_t *); 697int scf_tmpl_value_count_range_choices(const scf_prop_tmpl_t *, 698 scf_count_ranges_t *); 699int scf_tmpl_value_int_range_choices(const scf_prop_tmpl_t *, 700 scf_int_ranges_t *); 701int scf_tmpl_value_name_choices(const scf_prop_tmpl_t *prop, 702 scf_values_t *vals); 703 704void scf_values_destroy(scf_values_t *); 705 706ssize_t scf_tmpl_value_common_name(const scf_prop_tmpl_t *, const char *, 707 const char *, char **); 708ssize_t scf_tmpl_value_description(const scf_prop_tmpl_t *, const char *, 709 const char *, char **); 710 711int scf_tmpl_value_in_constraint(const scf_prop_tmpl_t *pt, scf_value_t *value, 712 scf_tmpl_errors_t **errs); 713 714/* 715 * Template validation interfaces 716 */ 717int scf_tmpl_validate_fmri(scf_handle_t *, const char *, 718 const char *, scf_tmpl_errors_t **, int); 719#define SCF_TMPL_VALIDATE_FLAG_CURRENT 0x1 720 721void scf_tmpl_errors_destroy(scf_tmpl_errors_t *errs); 722scf_tmpl_error_t *scf_tmpl_next_error(scf_tmpl_errors_t *); 723void scf_tmpl_reset_errors(scf_tmpl_errors_t *errs); 724int scf_tmpl_strerror(scf_tmpl_error_t *err, char *s, size_t n, int flag); 725int scf_tmpl_error_source_fmri(const scf_tmpl_error_t *, char **); 726int scf_tmpl_error_type(const scf_tmpl_error_t *, scf_tmpl_error_type_t *); 727int scf_tmpl_error_pg_tmpl(const scf_tmpl_error_t *, char **, char **); 728int scf_tmpl_error_pg(const scf_tmpl_error_t *, char **, char **); 729int scf_tmpl_error_prop_tmpl(const scf_tmpl_error_t *, char **, char **); 730int scf_tmpl_error_prop(const scf_tmpl_error_t *, char **, char **); 731int scf_tmpl_error_value(const scf_tmpl_error_t *, char **); 732 733/* 734 * Simplified calls 735 */ 736int smf_enable_instance(const char *, int); 737int smf_disable_instance(const char *, int); 738int smf_refresh_instance(const char *); 739int smf_restart_instance(const char *); 740int smf_maintain_instance(const char *, int); 741int smf_degrade_instance(const char *, int); 742int smf_restore_instance(const char *); 743char *smf_get_state(const char *); 744 745int scf_simple_walk_instances(uint_t, void *, 746 int (*inst_callback)(scf_handle_t *, scf_instance_t *, void *)); 747 748scf_simple_prop_t *scf_simple_prop_get(scf_handle_t *, const char *, 749 const char *, const char *); 750void scf_simple_prop_free(scf_simple_prop_t *); 751scf_simple_app_props_t *scf_simple_app_props_get(scf_handle_t *, const char *); 752void scf_simple_app_props_free(scf_simple_app_props_t *); 753const scf_simple_prop_t *scf_simple_app_props_next( 754 const scf_simple_app_props_t *, scf_simple_prop_t *); 755const scf_simple_prop_t *scf_simple_app_props_search( 756 const scf_simple_app_props_t *, const char *, const char *); 757ssize_t scf_simple_prop_numvalues(const scf_simple_prop_t *); 758scf_type_t scf_simple_prop_type(const scf_simple_prop_t *); 759char *scf_simple_prop_name(const scf_simple_prop_t *); 760char *scf_simple_prop_pgname(const scf_simple_prop_t *); 761uint8_t *scf_simple_prop_next_boolean(scf_simple_prop_t *); 762uint64_t *scf_simple_prop_next_count(scf_simple_prop_t *); 763int64_t *scf_simple_prop_next_integer(scf_simple_prop_t *); 764int64_t *scf_simple_prop_next_time(scf_simple_prop_t *, int32_t *); 765char *scf_simple_prop_next_astring(scf_simple_prop_t *); 766char *scf_simple_prop_next_ustring(scf_simple_prop_t *); 767void *scf_simple_prop_next_opaque(scf_simple_prop_t *, size_t *); 768void scf_simple_prop_next_reset(scf_simple_prop_t *); 769 770/* 771 * SMF exit status definitions 772 */ 773#define SMF_EXIT_OK 0 774#define SMF_EXIT_ERR_FATAL 95 775#define SMF_EXIT_ERR_CONFIG 96 776#define SMF_EXIT_MON_DEGRADE 97 777#define SMF_EXIT_MON_OFFLINE 98 778#define SMF_EXIT_ERR_NOSMF 99 779#define SMF_EXIT_ERR_PERM 100 780 781#ifdef __cplusplus 782} 783#endif 784 785#endif /* _LIBSCF_H */ 786