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 2010 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 35 extern "C" { 36 #endif 37 38 typedef struct scf_version *scf_version_t; 39 #define SCF_VERSION ((scf_version_t)1UL) 40 41 /* 42 * Opaque structures 43 */ 44 typedef struct scf_handle scf_handle_t; 45 typedef struct scf_scope scf_scope_t; 46 typedef struct scf_service scf_service_t; 47 typedef struct scf_instance scf_instance_t; 48 typedef struct scf_propertygroup scf_propertygroup_t; 49 typedef struct scf_property scf_property_t; 50 51 typedef struct scf_snapshot scf_snapshot_t; 52 typedef struct scf_snaplevel scf_snaplevel_t; 53 54 typedef struct scf_transaction scf_transaction_t; 55 typedef struct scf_transaction_entry scf_transaction_entry_t; 56 typedef struct scf_value scf_value_t; 57 58 typedef struct scf_iter scf_iter_t; 59 60 typedef struct scf_pg_tmpl scf_pg_tmpl_t; 61 typedef struct scf_prop_tmpl scf_prop_tmpl_t; 62 typedef struct scf_tmpl_errors scf_tmpl_errors_t; 63 64 typedef struct scf_simple_app_props scf_simple_app_props_t; 65 typedef struct scf_simple_prop scf_simple_prop_t; 66 67 /* 68 * Types 69 */ 70 typedef 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 91 typedef 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 */ 101 typedef 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 117 typedef 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 123 typedef 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 136 typedef 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 */ 168 typedef 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 196 typedef 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 #define SCF_INSTANCE_EMI ((const char *) \ 215 "svc:/system/early-manifest-import:default") 216 #define SCF_INSTANCE_FS_MINIMAL ((const char *) \ 217 "svc:/system/filesystem/minimal:default") 218 #define SCF_INSTANCE_MI ((const char *) \ 219 "svc:/system/manifest-import:default") 220 221 /* 222 * Major milestones 223 */ 224 #define SCF_MILESTONE_SINGLE_USER \ 225 ((const char *) "svc:/milestone/single-user:default") 226 #define SCF_MILESTONE_MULTI_USER \ 227 ((const char *) "svc:/milestone/multi-user:default") 228 #define SCF_MILESTONE_MULTI_USER_SERVER \ 229 ((const char *) "svc:/milestone/multi-user-server:default") 230 231 /* 232 * standard scope names 233 */ 234 #define SCF_SCOPE_LOCAL ((const char *)"localhost") 235 236 /* 237 * Property group types 238 */ 239 #define SCF_GROUP_APPLICATION ((const char *)"application") 240 #define SCF_GROUP_FRAMEWORK ((const char *)"framework") 241 #define SCF_GROUP_DEPENDENCY ((const char *)"dependency") 242 #define SCF_GROUP_METHOD ((const char *)"method") 243 #define SCF_GROUP_TEMPLATE ((const char *)"template") 244 #define SCF_GROUP_TEMPLATE_PG_PATTERN ((const char *)"template_pg_pattern") 245 #define SCF_GROUP_TEMPLATE_PROP_PATTERN ((const char *)"template_prop_pattern") 246 247 /* 248 * Dependency types 249 */ 250 #define SCF_DEP_REQUIRE_ALL ((const char *)"require_all") 251 #define SCF_DEP_REQUIRE_ANY ((const char *)"require_any") 252 #define SCF_DEP_EXCLUDE_ALL ((const char *)"exclude_all") 253 #define SCF_DEP_OPTIONAL_ALL ((const char *)"optional_all") 254 255 #define SCF_DEP_RESET_ON_ERROR ((const char *)"error") 256 #define SCF_DEP_RESET_ON_RESTART ((const char *)"restart") 257 #define SCF_DEP_RESET_ON_REFRESH ((const char *)"refresh") 258 #define SCF_DEP_RESET_ON_NONE ((const char *)"none") 259 260 /* 261 * Standard property group names 262 */ 263 #define SCF_PG_GENERAL ((const char *)"general") 264 #define SCF_PG_GENERAL_OVR ((const char *)"general_ovr") 265 #define SCF_PG_RESTARTER ((const char *)"restarter") 266 #define SCF_PG_RESTARTER_ACTIONS ((const char *)"restarter_actions") 267 #define SCF_PG_METHOD_CONTEXT ((const char *)"method_context") 268 #define SCF_PG_APP_DEFAULT ((const char *)"application") 269 #define SCF_PG_DEPENDENTS ((const char *)"dependents") 270 #define SCF_PG_OPTIONS ((const char *)"options") 271 #define SCF_PG_OPTIONS_OVR ((const char *)"options_ovr") 272 #define SCF_PG_STARTD ((const char *)"startd") 273 #define SCF_PG_STARTD_PRIVATE ((const char *)"svc-startd-private") 274 #define SCF_PG_DEATHROW ((const char *)"deathrow") 275 #define SCF_PG_MANIFESTFILES ((const char *)"manifestfiles") 276 277 /* 278 * Template property group names and prefixes 279 */ 280 #define SCF_PG_TM_COMMON_NAME ((const char *)"tm_common_name") 281 #define SCF_PG_TM_DESCRIPTION ((const char *)"tm_description") 282 283 #define SCF_PG_TM_MAN_PREFIX ((const char *)"tm_man_") 284 #define SCF_PG_TM_DOC_PREFIX ((const char *)"tm_doc_") 285 286 /* 287 * Standard property names 288 */ 289 #define SCF_PROPERTY_AUX_STATE ((const char *)"auxiliary_state") 290 #define SCF_PROPERTY_AUX_FMRI ((const char *)"auxiliary_fmri") 291 #define SCF_PROPERTY_AUX_TTY ((const char *)"auxiliary_tty") 292 #define SCF_PROPERTY_CONTRACT ((const char *)"contract") 293 #define SCF_PROPERTY_COREFILE_PATTERN ((const char *)"corefile_pattern") 294 #define SCF_PROPERTY_DEGRADED ((const char *)"degraded") 295 #define SCF_PROPERTY_DEGRADE_IMMEDIATE ((const char *)"degrade_immediate") 296 #define SCF_PROPERTY_DURATION ((const char *)"duration") 297 #define SCF_PROPERTY_ENABLED ((const char *)"enabled") 298 #define SCF_PROPERTY_DEATHROW ((const char *)"deathrow") 299 #define SCF_PROPERTY_ENTITY_STABILITY ((const char *)"entity_stability") 300 #define SCF_PROPERTY_ENTITIES ((const char *)"entities") 301 #define SCF_PROPERTY_EXEC ((const char *)"exec") 302 #define SCF_PROPERTY_GROUP ((const char *)"group") 303 #define SCF_PROPERTY_GROUPING ((const char *)"grouping") 304 #define SCF_PROPERTY_IGNORE ((const char *)"ignore_error") 305 #define SCF_PROPERTY_INTERNAL_SEPARATORS ((const char *)"internal_separators") 306 #define SCF_PROPERTY_LIMIT_PRIVILEGES ((const char *)"limit_privileges") 307 #define SCF_PROPERTY_MAINT_OFF ((const char *)"maint_off") 308 #define SCF_PROPERTY_MAINT_ON ((const char *)"maint_on") 309 #define SCF_PROPERTY_MAINT_ON_IMMEDIATE ((const char *)"maint_on_immediate") 310 #define SCF_PROPERTY_MAINT_ON_IMMTEMP ((const char *)"maint_on_immtemp") 311 #define SCF_PROPERTY_MAINT_ON_TEMPORARY ((const char *)"maint_on_temporary") 312 #define SCF_PROPERTY_METHOD_PID ((const char *)"method_pid") 313 #define SCF_PROPERTY_MILESTONE ((const char *)"milestone") 314 #define SCF_PROPERTY_NEED_SESSION ((const char *)"need_session") 315 #define SCF_PROPERTY_NEXT_STATE ((const char *)"next_state") 316 #define SCF_PROPERTY_PACKAGE ((const char *)"package") 317 #define SCF_PROPERTY_PRIVILEGES ((const char *)"privileges") 318 #define SCF_PROPERTY_PROFILE ((const char *)"profile") 319 #define SCF_PROPERTY_PROJECT ((const char *)"project") 320 #define SCF_PROPERTY_REFRESH ((const char *)"refresh") 321 #define SCF_PROPERTY_RESOURCE_POOL ((const char *)"resource_pool") 322 #define SCF_PROPERTY_ENVIRONMENT ((const char *)"environment") 323 #define SCF_PROPERTY_RESTART ((const char *)"restart") 324 #define SCF_PROPERTY_RESTARTER ((const char *)"restarter") 325 #define SCF_PROPERTY_RESTART_INTERVAL ((const char *)"restart_interval") 326 #define SCF_PROPERTY_RESTART_ON ((const char *)"restart_on") 327 #define SCF_PROPERTY_RESTORE ((const char *)"restore") 328 #define SCF_PROPERTY_SINGLE_INSTANCE ((const char *)"single_instance") 329 #define SCF_PROPERTY_START_METHOD_TIMESTAMP \ 330 ((const char *)"start_method_timestamp") 331 #define SCF_PROPERTY_START_METHOD_WAITSTATUS \ 332 ((const char *)"start_method_waitstatus") 333 #define SCF_PROPERTY_START_PID ((const char *)"start_pid") 334 #define SCF_PROPERTY_STATE ((const char *)"state") 335 #define SCF_PROPERTY_STABILITY ((const char *)"stability") 336 #define SCF_PROPERTY_STATE_TIMESTAMP ((const char *)"state_timestamp") 337 #define SCF_PROPERTY_SUPP_GROUPS ((const char *)"supp_groups") 338 #define SCF_PROPERTY_TIMEOUT ((const char *)"timeout_seconds") 339 #define SCF_PROPERTY_TIMEOUT_RETRY ((const char *)"timeout_retry") 340 #define SCF_PROPERTY_TRANSIENT_CONTRACT ((const char *)"transient_contract") 341 #define SCF_PROPERTY_TYPE ((const char *)"type") 342 #define SCF_PROPERTY_USE_PROFILE ((const char *)"use_profile") 343 #define SCF_PROPERTY_USER ((const char *)"user") 344 #define SCF_PROPERTY_UTMPX_PREFIX ((const char *)"utmpx_prefix") 345 #define SCF_PROPERTY_WORKING_DIRECTORY ((const char *)"working_directory") 346 347 /* 348 * Template property names 349 */ 350 #define SCF_PROPERTY_TM_CARDINALITY_MIN ((const char *)"cardinality_min") 351 #define SCF_PROPERTY_TM_CARDINALITY_MAX ((const char *)"cardinality_max") 352 #define SCF_PROPERTY_TM_CHOICES_INCLUDE_VALUES ((const char *) \ 353 "choices_include_values") 354 #define SCF_PROPERTY_TM_CHOICES_NAME ((const char *)"choices_name") 355 #define SCF_PROPERTY_TM_CHOICES_RANGE ((const char *)"choices_range") 356 #define SCF_PROPERTY_TM_CONSTRAINT_NAME ((const char *)"constraint_name") 357 #define SCF_PROPERTY_TM_CONSTRAINT_RANGE ((const char *)"constraint_range") 358 #define SCF_PROPERTY_TM_MANPATH ((const char *)"manpath") 359 #define SCF_PROPERTY_TM_NAME ((const char *)"name") 360 #define SCF_PROPERTY_TM_PG_PATTERN ((const char *)"pg_pattern") 361 #define SCF_PROPERTY_TM_REQUIRED ((const char *)"required") 362 #define SCF_PROPERTY_TM_SECTION ((const char *)"section") 363 #define SCF_PROPERTY_TM_TARGET ((const char *)"target") 364 #define SCF_PROPERTY_TM_TITLE ((const char *)"title") 365 #define SCF_PROPERTY_TM_TYPE ((const char *)"type") 366 #define SCF_PROPERTY_TM_URI ((const char *)"uri") 367 #define SCF_PROPERTY_TM_VALUE_PREFIX ((const char *)"value_") 368 #define SCF_PROPERTY_TM_VALUES_NAME ((const char *)"values_name") 369 #define SCF_PROPERTY_TM_VISIBILITY ((const char *)"visibility") 370 #define SCF_PROPERTY_TM_COMMON_NAME_PREFIX ((const char *)"common_name_") 371 #define SCF_PROPERTY_TM_DESCRIPTION_PREFIX ((const char *)"description_") 372 #define SCF_PROPERTY_TM_UNITS_PREFIX ((const char *)"units_") 373 374 /* 375 * Templates wildcard string 376 */ 377 #define SCF_TMPL_WILDCARD ((const char *)"*") 378 379 /* 380 * Strings used by restarters for state and next_state properties. 381 * MAX_SCF_STATE_STRING holds the max length of a state string, including the 382 * terminating null. 383 */ 384 385 #define MAX_SCF_STATE_STRING_SZ 14 386 387 #define SCF_STATE_STRING_NONE ((const char *)"none") 388 #define SCF_STATE_STRING_UNINIT ((const char *)"uninitialized") 389 #define SCF_STATE_STRING_MAINT ((const char *)"maintenance") 390 #define SCF_STATE_STRING_OFFLINE ((const char *)"offline") 391 #define SCF_STATE_STRING_DISABLED ((const char *)"disabled") 392 #define SCF_STATE_STRING_ONLINE ((const char *)"online") 393 #define SCF_STATE_STRING_DEGRADED ((const char *)"degraded") 394 #define SCF_STATE_STRING_LEGACY ((const char *)"legacy_run") 395 396 #define SCF_STATE_UNINIT 0x00000001 397 #define SCF_STATE_MAINT 0x00000002 398 #define SCF_STATE_OFFLINE 0x00000004 399 #define SCF_STATE_DISABLED 0x00000008 400 #define SCF_STATE_ONLINE 0x00000010 401 #define SCF_STATE_DEGRADED 0x00000020 402 #define SCF_STATE_ALL 0x0000003F 403 404 #define SCF_PG_FLAG_NONPERSISTENT 0x1 405 406 #define SCF_TRACE_LIBRARY 0x1 407 #define SCF_TRACE_DAEMON 0x2 408 409 #define SMF_IMMEDIATE 0x1 410 #define SMF_TEMPORARY 0x2 411 #define SMF_AT_NEXT_BOOT 0x4 412 413 scf_error_t scf_error(void); 414 const char *scf_strerror(scf_error_t); 415 416 ssize_t scf_limit(uint32_t code); 417 #define SCF_LIMIT_MAX_NAME_LENGTH -2000U 418 #define SCF_LIMIT_MAX_VALUE_LENGTH -2001U 419 #define SCF_LIMIT_MAX_PG_TYPE_LENGTH -2002U 420 #define SCF_LIMIT_MAX_FMRI_LENGTH -2003U 421 422 scf_handle_t *scf_handle_create(scf_version_t); 423 424 int scf_handle_decorate(scf_handle_t *, const char *, scf_value_t *); 425 #define SCF_DECORATE_CLEAR ((scf_value_t *)0) 426 427 int scf_handle_bind(scf_handle_t *); 428 int scf_handle_unbind(scf_handle_t *); 429 void scf_handle_destroy(scf_handle_t *); 430 431 int scf_type_base_type(scf_type_t type, scf_type_t *out); 432 const char *scf_type_to_string(scf_type_t); 433 scf_type_t scf_string_to_type(const char *); 434 435 /* values */ 436 scf_value_t *scf_value_create(scf_handle_t *); 437 scf_handle_t *scf_value_handle(const scf_value_t *); 438 void scf_value_destroy(scf_value_t *); 439 440 scf_type_t scf_value_base_type(const scf_value_t *); 441 scf_type_t scf_value_type(const scf_value_t *); 442 int scf_value_is_type(const scf_value_t *, scf_type_t); 443 444 void scf_value_reset(scf_value_t *); 445 446 int scf_value_get_boolean(const scf_value_t *, uint8_t *); 447 int scf_value_get_count(const scf_value_t *, uint64_t *); 448 int scf_value_get_integer(const scf_value_t *, int64_t *); 449 int scf_value_get_time(const scf_value_t *, int64_t *, int32_t *); 450 ssize_t scf_value_get_astring(const scf_value_t *, char *, size_t); 451 ssize_t scf_value_get_ustring(const scf_value_t *, char *, size_t); 452 ssize_t scf_value_get_opaque(const scf_value_t *, void *, size_t); 453 454 void scf_value_set_boolean(scf_value_t *, uint8_t); 455 void scf_value_set_count(scf_value_t *, uint64_t); 456 void scf_value_set_integer(scf_value_t *, int64_t); 457 int scf_value_set_time(scf_value_t *, int64_t, int32_t); 458 int scf_value_set_astring(scf_value_t *, const char *); 459 int scf_value_set_ustring(scf_value_t *, const char *); 460 int scf_value_set_opaque(scf_value_t *, const void *, size_t); 461 462 ssize_t scf_value_get_as_string(const scf_value_t *, char *, size_t); 463 ssize_t scf_value_get_as_string_typed(const scf_value_t *, scf_type_t, 464 char *, size_t); 465 int scf_value_set_from_string(scf_value_t *, scf_type_t, const char *); 466 467 scf_iter_t *scf_iter_create(scf_handle_t *); 468 scf_handle_t *scf_iter_handle(const scf_iter_t *); 469 void scf_iter_reset(scf_iter_t *); 470 void scf_iter_destroy(scf_iter_t *); 471 472 int scf_iter_handle_scopes(scf_iter_t *, const scf_handle_t *); 473 int scf_iter_scope_services(scf_iter_t *, const scf_scope_t *); 474 int scf_iter_service_instances(scf_iter_t *, const scf_service_t *); 475 int scf_iter_service_pgs(scf_iter_t *, const scf_service_t *); 476 int scf_iter_instance_pgs(scf_iter_t *, const scf_instance_t *); 477 int scf_iter_instance_pgs_composed(scf_iter_t *, const scf_instance_t *, 478 const scf_snapshot_t *); 479 int scf_iter_service_pgs_typed(scf_iter_t *, const scf_service_t *, 480 const char *); 481 int scf_iter_instance_pgs_typed(scf_iter_t *, const scf_instance_t *, 482 const char *); 483 int scf_iter_instance_pgs_typed_composed(scf_iter_t *, const scf_instance_t *, 484 const scf_snapshot_t *, const char *); 485 int scf_iter_snaplevel_pgs(scf_iter_t *, const scf_snaplevel_t *); 486 int scf_iter_snaplevel_pgs_typed(scf_iter_t *, const scf_snaplevel_t *, 487 const char *); 488 int scf_iter_instance_snapshots(scf_iter_t *, const scf_instance_t *); 489 int scf_iter_pg_properties(scf_iter_t *, const scf_propertygroup_t *); 490 int scf_iter_property_values(scf_iter_t *, const scf_property_t *); 491 492 int scf_iter_next_scope(scf_iter_t *, scf_scope_t *); 493 int scf_iter_next_service(scf_iter_t *, scf_service_t *); 494 int scf_iter_next_instance(scf_iter_t *, scf_instance_t *); 495 int scf_iter_next_pg(scf_iter_t *, scf_propertygroup_t *); 496 int scf_iter_next_property(scf_iter_t *, scf_property_t *); 497 int scf_iter_next_snapshot(scf_iter_t *, scf_snapshot_t *); 498 int scf_iter_next_value(scf_iter_t *, scf_value_t *); 499 500 scf_scope_t *scf_scope_create(scf_handle_t *); 501 scf_handle_t *scf_scope_handle(const scf_scope_t *); 502 503 /* XXX eventually remove this */ 504 #define scf_handle_get_local_scope(h, s) \ 505 scf_handle_get_scope((h), SCF_SCOPE_LOCAL, (s)) 506 507 int scf_handle_get_scope(scf_handle_t *, const char *, scf_scope_t *); 508 void scf_scope_destroy(scf_scope_t *); 509 ssize_t scf_scope_get_name(const scf_scope_t *, char *, size_t); 510 511 ssize_t scf_scope_to_fmri(const scf_scope_t *, char *, size_t); 512 513 scf_service_t *scf_service_create(scf_handle_t *); 514 scf_handle_t *scf_service_handle(const scf_service_t *); 515 void scf_service_destroy(scf_service_t *); 516 int scf_scope_get_parent(const scf_scope_t *, scf_scope_t *); 517 ssize_t scf_service_get_name(const scf_service_t *, char *, size_t); 518 ssize_t scf_service_to_fmri(const scf_service_t *, char *, size_t); 519 int scf_service_get_parent(const scf_service_t *, scf_scope_t *); 520 int scf_scope_get_service(const scf_scope_t *, const char *, scf_service_t *); 521 int scf_scope_add_service(const scf_scope_t *, const char *, scf_service_t *); 522 int scf_service_delete(scf_service_t *); 523 524 scf_instance_t *scf_instance_create(scf_handle_t *); 525 scf_handle_t *scf_instance_handle(const scf_instance_t *); 526 void scf_instance_destroy(scf_instance_t *); 527 ssize_t scf_instance_get_name(const scf_instance_t *, char *, size_t); 528 ssize_t scf_instance_to_fmri(const scf_instance_t *, char *, size_t); 529 int scf_service_get_instance(const scf_service_t *, const char *, 530 scf_instance_t *); 531 int scf_service_add_instance(const scf_service_t *, const char *, 532 scf_instance_t *); 533 int scf_instance_delete(scf_instance_t *); 534 535 scf_snapshot_t *scf_snapshot_create(scf_handle_t *); 536 scf_handle_t *scf_snapshot_handle(const scf_snapshot_t *); 537 void scf_snapshot_destroy(scf_snapshot_t *); 538 ssize_t scf_snapshot_get_name(const scf_snapshot_t *, char *, size_t); 539 int scf_snapshot_get_parent(const scf_snapshot_t *, scf_instance_t *); 540 int scf_instance_get_snapshot(const scf_instance_t *, const char *, 541 scf_snapshot_t *); 542 int scf_snapshot_update(scf_snapshot_t *); 543 544 scf_snaplevel_t *scf_snaplevel_create(scf_handle_t *); 545 scf_handle_t *scf_snaplevel_handle(const scf_snaplevel_t *); 546 void scf_snaplevel_destroy(scf_snaplevel_t *); 547 int scf_snaplevel_get_parent(const scf_snaplevel_t *, scf_snapshot_t *); 548 ssize_t scf_snaplevel_get_scope_name(const scf_snaplevel_t *, char *, size_t); 549 ssize_t scf_snaplevel_get_service_name(const scf_snaplevel_t *, char *, size_t); 550 ssize_t scf_snaplevel_get_instance_name(const scf_snaplevel_t *, char *, 551 size_t); 552 int scf_snaplevel_get_pg(const scf_snaplevel_t *, const char *, 553 scf_propertygroup_t *pg); 554 int scf_snapshot_get_base_snaplevel(const scf_snapshot_t *, scf_snaplevel_t *); 555 int scf_snaplevel_get_next_snaplevel(const scf_snaplevel_t *, 556 scf_snaplevel_t *); 557 558 scf_propertygroup_t *scf_pg_create(scf_handle_t *); 559 scf_handle_t *scf_pg_handle(const scf_propertygroup_t *); 560 void scf_pg_destroy(scf_propertygroup_t *); 561 ssize_t scf_pg_to_fmri(const scf_propertygroup_t *, char *, size_t); 562 ssize_t scf_pg_get_name(const scf_propertygroup_t *, char *, size_t); 563 ssize_t scf_pg_get_type(const scf_propertygroup_t *, char *, size_t); 564 int scf_pg_get_flags(const scf_propertygroup_t *, uint32_t *); 565 int scf_pg_get_parent_service(const scf_propertygroup_t *, scf_service_t *); 566 int scf_pg_get_parent_instance(const scf_propertygroup_t *, scf_instance_t *); 567 int scf_pg_get_parent_snaplevel(const scf_propertygroup_t *, scf_snaplevel_t *); 568 int scf_service_get_pg(const scf_service_t *, const char *, 569 scf_propertygroup_t *); 570 int scf_instance_get_pg(const scf_instance_t *, const char *, 571 scf_propertygroup_t *); 572 int scf_instance_get_pg_composed(const scf_instance_t *, const scf_snapshot_t *, 573 const char *, scf_propertygroup_t *); 574 int scf_service_add_pg(const scf_service_t *, const char *, const char *, 575 uint32_t, scf_propertygroup_t *); 576 int scf_instance_add_pg(const scf_instance_t *, const char *, const char *, 577 uint32_t, scf_propertygroup_t *); 578 int scf_pg_delete(scf_propertygroup_t *); 579 580 int scf_pg_get_underlying_pg(const scf_propertygroup_t *, 581 scf_propertygroup_t *); 582 int scf_instance_get_parent(const scf_instance_t *, scf_service_t *); 583 584 int scf_pg_update(scf_propertygroup_t *); 585 586 scf_property_t *scf_property_create(scf_handle_t *); 587 scf_handle_t *scf_property_handle(const scf_property_t *); 588 void scf_property_destroy(scf_property_t *); 589 int scf_property_is_type(const scf_property_t *, scf_type_t); 590 int scf_property_type(const scf_property_t *, scf_type_t *); 591 ssize_t scf_property_get_name(const scf_property_t *, char *, size_t); 592 int scf_property_get_value(const scf_property_t *, scf_value_t *); 593 ssize_t scf_property_to_fmri(const scf_property_t *, char *, size_t); 594 int scf_pg_get_property(const scf_propertygroup_t *, const char *, 595 scf_property_t *); 596 597 scf_transaction_t *scf_transaction_create(scf_handle_t *); 598 scf_handle_t *scf_transaction_handle(const scf_transaction_t *); 599 int scf_transaction_start(scf_transaction_t *, scf_propertygroup_t *); 600 void scf_transaction_destroy(scf_transaction_t *); 601 void scf_transaction_destroy_children(scf_transaction_t *); 602 603 void scf_transaction_reset(scf_transaction_t *); 604 void scf_transaction_reset_all(scf_transaction_t *); 605 606 int scf_transaction_commit(scf_transaction_t *); 607 608 scf_transaction_entry_t *scf_entry_create(scf_handle_t *); 609 scf_handle_t *scf_entry_handle(const scf_transaction_entry_t *); 610 void scf_entry_reset(scf_transaction_entry_t *); 611 void scf_entry_destroy(scf_transaction_entry_t *); 612 void scf_entry_destroy_children(scf_transaction_entry_t *); 613 614 int scf_transaction_property_change(scf_transaction_t *, 615 scf_transaction_entry_t *, const char *, scf_type_t); 616 int scf_transaction_property_delete(scf_transaction_t *, 617 scf_transaction_entry_t *, const char *); 618 int scf_transaction_property_new(scf_transaction_t *, 619 scf_transaction_entry_t *, const char *, scf_type_t); 620 int scf_transaction_property_change_type(scf_transaction_t *, 621 scf_transaction_entry_t *, const char *, scf_type_t); 622 623 int scf_entry_add_value(scf_transaction_entry_t *, scf_value_t *); 624 625 int scf_handle_decode_fmri(scf_handle_t *, const char *, scf_scope_t *, 626 scf_service_t *, scf_instance_t *, scf_propertygroup_t *, scf_property_t *, 627 int); 628 #define SCF_DECODE_FMRI_EXACT 0x00000001 629 #define SCF_DECODE_FMRI_TRUNCATE 0x00000002 630 #define SCF_DECODE_FMRI_REQUIRE_INSTANCE 0x00000004 631 #define SCF_DECODE_FMRI_REQUIRE_NO_INSTANCE 0x00000008 632 633 ssize_t scf_myname(scf_handle_t *, char *, size_t); 634 635 /* 636 * Property group template interfaces. 637 */ 638 scf_pg_tmpl_t *scf_tmpl_pg_create(scf_handle_t *); 639 void scf_tmpl_pg_destroy(scf_pg_tmpl_t *); 640 void scf_tmpl_pg_reset(scf_pg_tmpl_t *); 641 int scf_tmpl_get_by_pg(scf_propertygroup_t *, scf_pg_tmpl_t *, int); 642 int scf_tmpl_get_by_pg_name(const char *, const char *, 643 const char *, const char *, scf_pg_tmpl_t *, int); 644 int scf_tmpl_iter_pgs(scf_pg_tmpl_t *, const char *, const char *, 645 const char *, int); 646 #define SCF_PG_TMPL_FLAG_REQUIRED 0x1 647 #define SCF_PG_TMPL_FLAG_EXACT 0x2 648 #define SCF_PG_TMPL_FLAG_CURRENT 0x4 649 650 ssize_t scf_tmpl_pg_name(const scf_pg_tmpl_t *, char **); 651 ssize_t scf_tmpl_pg_common_name(const scf_pg_tmpl_t *, const char *, char **); 652 ssize_t scf_tmpl_pg_description(const scf_pg_tmpl_t *, const char *, char **); 653 ssize_t scf_tmpl_pg_type(const scf_pg_tmpl_t *, char **); 654 655 ssize_t scf_tmpl_pg_target(const scf_pg_tmpl_t *, char **); 656 #define SCF_TM_TARGET_ALL ((const char *)"all") 657 #define SCF_TM_TARGET_DELEGATE ((const char *)"delegate") 658 #define SCF_TM_TARGET_INSTANCE ((const char *)"instance") 659 #define SCF_TM_TARGET_THIS ((const char *)"this") 660 661 int scf_tmpl_pg_required(const scf_pg_tmpl_t *, uint8_t *); 662 663 /* 664 * Property template interfaces. 665 */ 666 scf_prop_tmpl_t *scf_tmpl_prop_create(scf_handle_t *); 667 void scf_tmpl_prop_destroy(scf_prop_tmpl_t *); 668 void scf_tmpl_prop_reset(scf_prop_tmpl_t *); 669 int scf_tmpl_get_by_prop(scf_pg_tmpl_t *, const char *, 670 scf_prop_tmpl_t *, int); 671 int scf_tmpl_iter_props(scf_pg_tmpl_t *, scf_prop_tmpl_t *, int); 672 #define SCF_PROP_TMPL_FLAG_REQUIRED 0x1 673 674 ssize_t scf_tmpl_prop_name(const scf_prop_tmpl_t *, char **); 675 int scf_tmpl_prop_type(const scf_prop_tmpl_t *, scf_type_t *); 676 int scf_tmpl_prop_required(const scf_prop_tmpl_t *, uint8_t *); 677 ssize_t scf_tmpl_prop_common_name(const scf_prop_tmpl_t *, const char *, 678 char **); 679 ssize_t scf_tmpl_prop_description(const scf_prop_tmpl_t *, const char *, 680 char **); 681 ssize_t scf_tmpl_prop_units(const scf_prop_tmpl_t *, const char *, char **); 682 int scf_tmpl_prop_cardinality(const scf_prop_tmpl_t *prop, uint64_t *, 683 uint64_t *); 684 int scf_tmpl_prop_internal_seps(const scf_prop_tmpl_t *, scf_values_t *); 685 686 int scf_tmpl_prop_visibility(const scf_prop_tmpl_t *, uint8_t *); 687 #define SCF_TMPL_VISIBILITY_HIDDEN 1 688 #define SCF_TMPL_VISIBILITY_READONLY 2 689 #define SCF_TMPL_VISIBILITY_READWRITE 3 690 691 const char *scf_tmpl_visibility_to_string(uint8_t); 692 #define SCF_TM_VISIBILITY_HIDDEN ((const char *)"hidden") 693 #define SCF_TM_VISIBILITY_READONLY ((const char *)"readonly") 694 #define SCF_TM_VISIBILITY_READWRITE ((const char *)"readwrite") 695 696 int scf_tmpl_value_name_constraints(const scf_prop_tmpl_t *prop, 697 scf_values_t *vals); 698 void scf_count_ranges_destroy(scf_count_ranges_t *); 699 void scf_int_ranges_destroy(scf_int_ranges_t *); 700 int scf_tmpl_value_count_range_constraints(const scf_prop_tmpl_t *, 701 scf_count_ranges_t *); 702 int scf_tmpl_value_int_range_constraints(const scf_prop_tmpl_t *, 703 scf_int_ranges_t *); 704 int scf_tmpl_value_count_range_choices(const scf_prop_tmpl_t *, 705 scf_count_ranges_t *); 706 int scf_tmpl_value_int_range_choices(const scf_prop_tmpl_t *, 707 scf_int_ranges_t *); 708 int scf_tmpl_value_name_choices(const scf_prop_tmpl_t *prop, 709 scf_values_t *vals); 710 711 void scf_values_destroy(scf_values_t *); 712 713 ssize_t scf_tmpl_value_common_name(const scf_prop_tmpl_t *, const char *, 714 const char *, char **); 715 ssize_t scf_tmpl_value_description(const scf_prop_tmpl_t *, const char *, 716 const char *, char **); 717 718 int scf_tmpl_value_in_constraint(const scf_prop_tmpl_t *pt, scf_value_t *value, 719 scf_tmpl_errors_t **errs); 720 721 /* 722 * Template validation interfaces 723 */ 724 int scf_tmpl_validate_fmri(scf_handle_t *, const char *, 725 const char *, scf_tmpl_errors_t **, int); 726 #define SCF_TMPL_VALIDATE_FLAG_CURRENT 0x1 727 728 void scf_tmpl_errors_destroy(scf_tmpl_errors_t *errs); 729 scf_tmpl_error_t *scf_tmpl_next_error(scf_tmpl_errors_t *); 730 void scf_tmpl_reset_errors(scf_tmpl_errors_t *errs); 731 int scf_tmpl_strerror(scf_tmpl_error_t *err, char *s, size_t n, int flag); 732 int scf_tmpl_error_source_fmri(const scf_tmpl_error_t *, char **); 733 int scf_tmpl_error_type(const scf_tmpl_error_t *, scf_tmpl_error_type_t *); 734 int scf_tmpl_error_pg_tmpl(const scf_tmpl_error_t *, char **, char **); 735 int scf_tmpl_error_pg(const scf_tmpl_error_t *, char **, char **); 736 int scf_tmpl_error_prop_tmpl(const scf_tmpl_error_t *, char **, char **); 737 int scf_tmpl_error_prop(const scf_tmpl_error_t *, char **, char **); 738 int scf_tmpl_error_value(const scf_tmpl_error_t *, char **); 739 740 /* 741 * Simplified calls 742 */ 743 int smf_enable_instance(const char *, int); 744 int smf_disable_instance(const char *, int); 745 int smf_refresh_instance(const char *); 746 int smf_restart_instance(const char *); 747 int smf_maintain_instance(const char *, int); 748 int smf_degrade_instance(const char *, int); 749 int smf_restore_instance(const char *); 750 char *smf_get_state(const char *); 751 752 int scf_simple_walk_instances(uint_t, void *, 753 int (*inst_callback)(scf_handle_t *, scf_instance_t *, void *)); 754 755 scf_simple_prop_t *scf_simple_prop_get(scf_handle_t *, const char *, 756 const char *, const char *); 757 void scf_simple_prop_free(scf_simple_prop_t *); 758 scf_simple_app_props_t *scf_simple_app_props_get(scf_handle_t *, const char *); 759 void scf_simple_app_props_free(scf_simple_app_props_t *); 760 const scf_simple_prop_t *scf_simple_app_props_next( 761 const scf_simple_app_props_t *, scf_simple_prop_t *); 762 const scf_simple_prop_t *scf_simple_app_props_search( 763 const scf_simple_app_props_t *, const char *, const char *); 764 ssize_t scf_simple_prop_numvalues(const scf_simple_prop_t *); 765 scf_type_t scf_simple_prop_type(const scf_simple_prop_t *); 766 char *scf_simple_prop_name(const scf_simple_prop_t *); 767 char *scf_simple_prop_pgname(const scf_simple_prop_t *); 768 uint8_t *scf_simple_prop_next_boolean(scf_simple_prop_t *); 769 uint64_t *scf_simple_prop_next_count(scf_simple_prop_t *); 770 int64_t *scf_simple_prop_next_integer(scf_simple_prop_t *); 771 int64_t *scf_simple_prop_next_time(scf_simple_prop_t *, int32_t *); 772 char *scf_simple_prop_next_astring(scf_simple_prop_t *); 773 char *scf_simple_prop_next_ustring(scf_simple_prop_t *); 774 void *scf_simple_prop_next_opaque(scf_simple_prop_t *, size_t *); 775 void scf_simple_prop_next_reset(scf_simple_prop_t *); 776 777 /* 778 * SMF exit status definitions 779 */ 780 #define SMF_EXIT_OK 0 781 #define SMF_EXIT_ERR_FATAL 95 782 #define SMF_EXIT_ERR_CONFIG 96 783 #define SMF_EXIT_MON_DEGRADE 97 784 #define SMF_EXIT_MON_OFFLINE 98 785 #define SMF_EXIT_ERR_NOSMF 99 786 #define SMF_EXIT_ERR_PERM 100 787 788 #ifdef __cplusplus 789 } 790 #endif 791 792 #endif /* _LIBSCF_H */ 793