17c478bd9Sstevel@tonic-gate /* 27c478bd9Sstevel@tonic-gate * CDDL HEADER START 37c478bd9Sstevel@tonic-gate * 47c478bd9Sstevel@tonic-gate * The contents of this file are subject to the terms of the 570cbfe41SPhilippe Jung * Common Development and Distribution License (the "License"). 670cbfe41SPhilippe Jung * You may not use this file except in compliance with the License. 77c478bd9Sstevel@tonic-gate * 87c478bd9Sstevel@tonic-gate * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 97c478bd9Sstevel@tonic-gate * or http://www.opensolaris.org/os/licensing. 107c478bd9Sstevel@tonic-gate * See the License for the specific language governing permissions 117c478bd9Sstevel@tonic-gate * and limitations under the License. 127c478bd9Sstevel@tonic-gate * 137c478bd9Sstevel@tonic-gate * When distributing Covered Code, include this CDDL HEADER in each 147c478bd9Sstevel@tonic-gate * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 157c478bd9Sstevel@tonic-gate * If applicable, add the following below this CDDL HEADER, with the 167c478bd9Sstevel@tonic-gate * fields enclosed by brackets "[]" replaced with your own identifying 177c478bd9Sstevel@tonic-gate * information: Portions Copyright [yyyy] [name of copyright owner] 187c478bd9Sstevel@tonic-gate * 197c478bd9Sstevel@tonic-gate * CDDL HEADER END 207c478bd9Sstevel@tonic-gate */ 21*1f6eb021SLiane Praza 227c478bd9Sstevel@tonic-gate /* 2370cbfe41SPhilippe Jung * Copyright 2008 Sun Microsystems, Inc. All rights reserved. 247c478bd9Sstevel@tonic-gate * Use is subject to license terms. 257c478bd9Sstevel@tonic-gate */ 267c478bd9Sstevel@tonic-gate 277c478bd9Sstevel@tonic-gate #ifndef _LIBSCF_H 287c478bd9Sstevel@tonic-gate #define _LIBSCF_H 297c478bd9Sstevel@tonic-gate 307c478bd9Sstevel@tonic-gate 317c478bd9Sstevel@tonic-gate #include <stddef.h> 327c478bd9Sstevel@tonic-gate #include <sys/types.h> 337c478bd9Sstevel@tonic-gate 347c478bd9Sstevel@tonic-gate #ifdef __cplusplus 357c478bd9Sstevel@tonic-gate extern "C" { 367c478bd9Sstevel@tonic-gate #endif 377c478bd9Sstevel@tonic-gate 387c478bd9Sstevel@tonic-gate typedef struct scf_version *scf_version_t; 397c478bd9Sstevel@tonic-gate #define SCF_VERSION ((scf_version_t)1UL) 407c478bd9Sstevel@tonic-gate 417c478bd9Sstevel@tonic-gate /* 427c478bd9Sstevel@tonic-gate * Opaque structures 437c478bd9Sstevel@tonic-gate */ 447c478bd9Sstevel@tonic-gate typedef struct scf_handle scf_handle_t; 457c478bd9Sstevel@tonic-gate typedef struct scf_scope scf_scope_t; 467c478bd9Sstevel@tonic-gate typedef struct scf_service scf_service_t; 477c478bd9Sstevel@tonic-gate typedef struct scf_instance scf_instance_t; 487c478bd9Sstevel@tonic-gate typedef struct scf_propertygroup scf_propertygroup_t; 497c478bd9Sstevel@tonic-gate typedef struct scf_property scf_property_t; 507c478bd9Sstevel@tonic-gate 517c478bd9Sstevel@tonic-gate typedef struct scf_snapshot scf_snapshot_t; 527c478bd9Sstevel@tonic-gate typedef struct scf_snaplevel scf_snaplevel_t; 537c478bd9Sstevel@tonic-gate 547c478bd9Sstevel@tonic-gate typedef struct scf_transaction scf_transaction_t; 557c478bd9Sstevel@tonic-gate typedef struct scf_transaction_entry scf_transaction_entry_t; 567c478bd9Sstevel@tonic-gate typedef struct scf_value scf_value_t; 577c478bd9Sstevel@tonic-gate 587c478bd9Sstevel@tonic-gate typedef struct scf_iter scf_iter_t; 597c478bd9Sstevel@tonic-gate 60*1f6eb021SLiane Praza typedef struct scf_pg_tmpl scf_pg_tmpl_t; 61*1f6eb021SLiane Praza typedef struct scf_prop_tmpl scf_prop_tmpl_t; 62*1f6eb021SLiane Praza typedef struct scf_tmpl_errors scf_tmpl_errors_t; 63*1f6eb021SLiane Praza 647c478bd9Sstevel@tonic-gate typedef struct scf_simple_app_props scf_simple_app_props_t; 657c478bd9Sstevel@tonic-gate typedef struct scf_simple_prop scf_simple_prop_t; 667c478bd9Sstevel@tonic-gate 677c478bd9Sstevel@tonic-gate /* 687c478bd9Sstevel@tonic-gate * Types 697c478bd9Sstevel@tonic-gate */ 707c478bd9Sstevel@tonic-gate typedef enum { 717c478bd9Sstevel@tonic-gate SCF_TYPE_INVALID = 0, 727c478bd9Sstevel@tonic-gate 737c478bd9Sstevel@tonic-gate SCF_TYPE_BOOLEAN, 747c478bd9Sstevel@tonic-gate SCF_TYPE_COUNT, 757c478bd9Sstevel@tonic-gate SCF_TYPE_INTEGER, 767c478bd9Sstevel@tonic-gate SCF_TYPE_TIME, 777c478bd9Sstevel@tonic-gate SCF_TYPE_ASTRING, 787c478bd9Sstevel@tonic-gate SCF_TYPE_OPAQUE, 797c478bd9Sstevel@tonic-gate 807c478bd9Sstevel@tonic-gate SCF_TYPE_USTRING = 100, 817c478bd9Sstevel@tonic-gate 827c478bd9Sstevel@tonic-gate SCF_TYPE_URI = 200, 837c478bd9Sstevel@tonic-gate SCF_TYPE_FMRI, 847c478bd9Sstevel@tonic-gate 857c478bd9Sstevel@tonic-gate SCF_TYPE_HOST = 300, 867c478bd9Sstevel@tonic-gate SCF_TYPE_HOSTNAME, 877c478bd9Sstevel@tonic-gate SCF_TYPE_NET_ADDR_V4, 887c478bd9Sstevel@tonic-gate SCF_TYPE_NET_ADDR_V6 897c478bd9Sstevel@tonic-gate } scf_type_t; 907c478bd9Sstevel@tonic-gate 91*1f6eb021SLiane Praza typedef struct scf_time { 92*1f6eb021SLiane Praza int64_t t_seconds; 93*1f6eb021SLiane Praza int32_t t_ns; 94*1f6eb021SLiane Praza } scf_time_t; 95*1f6eb021SLiane Praza 96*1f6eb021SLiane Praza /* 97*1f6eb021SLiane Praza * There is no explicit initializer for this structure. Functions 98*1f6eb021SLiane Praza * which set or populate this structure assume that it is either 99*1f6eb021SLiane Praza * uninitialized or destroyed. 100*1f6eb021SLiane Praza */ 101*1f6eb021SLiane Praza typedef struct scf_values { 102*1f6eb021SLiane Praza scf_type_t value_type; 103*1f6eb021SLiane Praza void *reserved; /* reserved for future use */ 104*1f6eb021SLiane Praza int value_count; 105*1f6eb021SLiane Praza char **values_as_strings; 106*1f6eb021SLiane Praza union { 107*1f6eb021SLiane Praza uint64_t *v_count; 108*1f6eb021SLiane Praza uint8_t *v_boolean; 109*1f6eb021SLiane Praza int64_t *v_integer; 110*1f6eb021SLiane Praza char **v_astring; 111*1f6eb021SLiane Praza char **v_ustring; 112*1f6eb021SLiane Praza char **v_opaque; 113*1f6eb021SLiane Praza scf_time_t *v_time; 114*1f6eb021SLiane Praza } values; 115*1f6eb021SLiane Praza } scf_values_t; 116*1f6eb021SLiane Praza 117*1f6eb021SLiane Praza typedef struct scf_count_ranges { 118*1f6eb021SLiane Praza int scr_num_ranges; 119*1f6eb021SLiane Praza uint64_t *scr_min; 120*1f6eb021SLiane Praza uint64_t *scr_max; 121*1f6eb021SLiane Praza } scf_count_ranges_t; 122*1f6eb021SLiane Praza 123*1f6eb021SLiane Praza typedef struct scf_int_ranges { 124*1f6eb021SLiane Praza int sir_num_ranges; 125*1f6eb021SLiane Praza int64_t *sir_min; 126*1f6eb021SLiane Praza int64_t *sir_max; 127*1f6eb021SLiane Praza } scf_int_ranges_t; 128*1f6eb021SLiane Praza 1297c478bd9Sstevel@tonic-gate /* 1307c478bd9Sstevel@tonic-gate * Return codes 1317c478bd9Sstevel@tonic-gate */ 1327c478bd9Sstevel@tonic-gate #define SCF_SUCCESS 0 1337c478bd9Sstevel@tonic-gate #define SCF_COMPLETE 1 1347c478bd9Sstevel@tonic-gate #define SCF_FAILED -1 1357c478bd9Sstevel@tonic-gate 1367c478bd9Sstevel@tonic-gate typedef enum scf_error { 1377c478bd9Sstevel@tonic-gate SCF_ERROR_NONE = 1000, /* no error */ 1387c478bd9Sstevel@tonic-gate SCF_ERROR_NOT_BOUND, /* handle not bound */ 1397c478bd9Sstevel@tonic-gate SCF_ERROR_NOT_SET, /* cannot use unset argument */ 1407c478bd9Sstevel@tonic-gate SCF_ERROR_NOT_FOUND, /* nothing of that name found */ 1417c478bd9Sstevel@tonic-gate SCF_ERROR_TYPE_MISMATCH, /* type does not match value */ 1427c478bd9Sstevel@tonic-gate SCF_ERROR_IN_USE, /* cannot modify while in-use */ 1437c478bd9Sstevel@tonic-gate SCF_ERROR_CONNECTION_BROKEN, /* repository connection gone */ 1447c478bd9Sstevel@tonic-gate SCF_ERROR_INVALID_ARGUMENT, /* bad argument */ 1457c478bd9Sstevel@tonic-gate SCF_ERROR_NO_MEMORY, /* no memory available */ 1467c478bd9Sstevel@tonic-gate SCF_ERROR_CONSTRAINT_VIOLATED, /* required constraint not met */ 1477c478bd9Sstevel@tonic-gate SCF_ERROR_EXISTS, /* object already exists */ 1487c478bd9Sstevel@tonic-gate SCF_ERROR_NO_SERVER, /* repository server unavailable */ 1497c478bd9Sstevel@tonic-gate SCF_ERROR_NO_RESOURCES, /* server has insufficient resources */ 1507c478bd9Sstevel@tonic-gate SCF_ERROR_PERMISSION_DENIED, /* insufficient privileges for action */ 1517c478bd9Sstevel@tonic-gate SCF_ERROR_BACKEND_ACCESS, /* backend refused access */ 1527c478bd9Sstevel@tonic-gate SCF_ERROR_HANDLE_MISMATCH, /* mismatched SCF handles */ 1537c478bd9Sstevel@tonic-gate SCF_ERROR_HANDLE_DESTROYED, /* object bound to destroyed handle */ 1547c478bd9Sstevel@tonic-gate SCF_ERROR_VERSION_MISMATCH, /* incompatible SCF version */ 1557c478bd9Sstevel@tonic-gate SCF_ERROR_BACKEND_READONLY, /* backend is read-only */ 1567c478bd9Sstevel@tonic-gate SCF_ERROR_DELETED, /* object has been deleted */ 157*1f6eb021SLiane Praza SCF_ERROR_TEMPLATE_INVALID, /* template data is invalid */ 1587c478bd9Sstevel@tonic-gate 1597c478bd9Sstevel@tonic-gate SCF_ERROR_CALLBACK_FAILED = 1080, /* user callback function failed */ 1607c478bd9Sstevel@tonic-gate 1617c478bd9Sstevel@tonic-gate SCF_ERROR_INTERNAL = 1101 /* internal error */ 1627c478bd9Sstevel@tonic-gate } scf_error_t; 1637c478bd9Sstevel@tonic-gate 164*1f6eb021SLiane Praza /* 165*1f6eb021SLiane Praza * This enum MUST be kept in sync with 166*1f6eb021SLiane Praza * struct _scf_tmpl_error_desc em_desc() in scf_tmpl.c 167*1f6eb021SLiane Praza */ 168*1f6eb021SLiane Praza typedef enum scf_tmpl_error_type { 169*1f6eb021SLiane Praza SCF_TERR_MISSING_PG, /* property group missing */ 170*1f6eb021SLiane Praza SCF_TERR_WRONG_PG_TYPE, /* property group type incorrect */ 171*1f6eb021SLiane Praza SCF_TERR_MISSING_PROP, /* missing required property */ 172*1f6eb021SLiane Praza SCF_TERR_WRONG_PROP_TYPE, /* property type incorrect */ 173*1f6eb021SLiane Praza SCF_TERR_CARDINALITY_VIOLATION, /* wrong number of values */ 174*1f6eb021SLiane Praza SCF_TERR_VALUE_CONSTRAINT_VIOLATED, /* constraint violated for value */ 175*1f6eb021SLiane Praza SCF_TERR_RANGE_VIOLATION, /* value violated specified range */ 176*1f6eb021SLiane Praza SCF_TERR_PG_REDEFINE, /* global or restarter pg_pattern */ 177*1f6eb021SLiane Praza /* redefined by the instance */ 178*1f6eb021SLiane Praza SCF_TERR_PROP_TYPE_MISMATCH, /* property and value type mismatch */ 179*1f6eb021SLiane Praza SCF_TERR_VALUE_OUT_OF_RANGE, /* value is out of range in template */ 180*1f6eb021SLiane Praza SCF_TERR_INVALID_VALUE, /* value is not valid for the */ 181*1f6eb021SLiane Praza /* template */ 182*1f6eb021SLiane Praza SCF_TERR_PG_PATTERN_CONFLICT, /* pg_pattern conflicts with higher */ 183*1f6eb021SLiane Praza /* level definition */ 184*1f6eb021SLiane Praza SCF_TERR_PROP_PATTERN_CONFLICT, /* prop_pattern conflicts with higher */ 185*1f6eb021SLiane Praza /* level definition */ 186*1f6eb021SLiane Praza SCF_TERR_GENERAL_REDEFINE, /* global or restarter template */ 187*1f6eb021SLiane Praza /* redefined */ 188*1f6eb021SLiane Praza SCF_TERR_INCLUDE_VALUES, /* No supporting constraints or */ 189*1f6eb021SLiane Praza /* values for include_values */ 190*1f6eb021SLiane Praza SCF_TERR_PG_PATTERN_INCOMPLETE, /* Required pg_pattern is missing */ 191*1f6eb021SLiane Praza /* name or type attribute. */ 192*1f6eb021SLiane Praza SCF_TERR_PROP_PATTERN_INCOMPLETE /* Required prop_pattern is */ 193*1f6eb021SLiane Praza /* missing a type attribute. */ 194*1f6eb021SLiane Praza } scf_tmpl_error_type_t; 195*1f6eb021SLiane Praza 196*1f6eb021SLiane Praza typedef struct scf_tmpl_error scf_tmpl_error_t; 197*1f6eb021SLiane Praza 198*1f6eb021SLiane Praza /* 199*1f6eb021SLiane Praza * scf_tmpl_strerror() human readable flag 200*1f6eb021SLiane Praza */ 201*1f6eb021SLiane Praza #define SCF_TMPL_STRERROR_HUMAN 0x1 202*1f6eb021SLiane Praza 2037c478bd9Sstevel@tonic-gate /* 2047c478bd9Sstevel@tonic-gate * Standard services 2057c478bd9Sstevel@tonic-gate */ 2067c478bd9Sstevel@tonic-gate #define SCF_SERVICE_CONFIGD ((const char *) \ 2077c478bd9Sstevel@tonic-gate "svc:/system/svc/repository:default") 208*1f6eb021SLiane Praza #define SCF_INSTANCE_GLOBAL ((const char *) \ 209*1f6eb021SLiane Praza "svc:/system/svc/global:default") 210*1f6eb021SLiane Praza #define SCF_SERVICE_GLOBAL ((const char *) \ 211*1f6eb021SLiane Praza "svc:/system/svc/global") 212*1f6eb021SLiane Praza #define SCF_SERVICE_STARTD ((const char *) \ 213*1f6eb021SLiane Praza "svc:/system/svc/restarter:default") 2147c478bd9Sstevel@tonic-gate 2157c478bd9Sstevel@tonic-gate /* 2167c478bd9Sstevel@tonic-gate * Major milestones 2177c478bd9Sstevel@tonic-gate */ 2187c478bd9Sstevel@tonic-gate #define SCF_MILESTONE_SINGLE_USER \ 2197c478bd9Sstevel@tonic-gate ((const char *) "svc:/milestone/single-user:default") 2207c478bd9Sstevel@tonic-gate #define SCF_MILESTONE_MULTI_USER \ 2217c478bd9Sstevel@tonic-gate ((const char *) "svc:/milestone/multi-user:default") 2227c478bd9Sstevel@tonic-gate #define SCF_MILESTONE_MULTI_USER_SERVER \ 2237c478bd9Sstevel@tonic-gate ((const char *) "svc:/milestone/multi-user-server:default") 2247c478bd9Sstevel@tonic-gate 2257c478bd9Sstevel@tonic-gate /* 2267c478bd9Sstevel@tonic-gate * standard scope names 2277c478bd9Sstevel@tonic-gate */ 2287c478bd9Sstevel@tonic-gate #define SCF_SCOPE_LOCAL ((const char *)"localhost") 2297c478bd9Sstevel@tonic-gate 2307c478bd9Sstevel@tonic-gate /* 2317c478bd9Sstevel@tonic-gate * Property group types 2327c478bd9Sstevel@tonic-gate */ 2337c478bd9Sstevel@tonic-gate #define SCF_GROUP_APPLICATION ((const char *)"application") 2347c478bd9Sstevel@tonic-gate #define SCF_GROUP_FRAMEWORK ((const char *)"framework") 2357c478bd9Sstevel@tonic-gate #define SCF_GROUP_DEPENDENCY ((const char *)"dependency") 2367c478bd9Sstevel@tonic-gate #define SCF_GROUP_METHOD ((const char *)"method") 2377c478bd9Sstevel@tonic-gate #define SCF_GROUP_TEMPLATE ((const char *)"template") 238*1f6eb021SLiane Praza #define SCF_GROUP_TEMPLATE_PG_PATTERN ((const char *)"template_pg_pattern") 239*1f6eb021SLiane Praza #define SCF_GROUP_TEMPLATE_PROP_PATTERN ((const char *)"template_prop_pattern") 2407c478bd9Sstevel@tonic-gate 2417c478bd9Sstevel@tonic-gate /* 2427c478bd9Sstevel@tonic-gate * Dependency types 2437c478bd9Sstevel@tonic-gate */ 2447c478bd9Sstevel@tonic-gate #define SCF_DEP_REQUIRE_ALL ((const char *)"require_all") 2457c478bd9Sstevel@tonic-gate #define SCF_DEP_REQUIRE_ANY ((const char *)"require_any") 2467c478bd9Sstevel@tonic-gate #define SCF_DEP_EXCLUDE_ALL ((const char *)"exclude_all") 2477c478bd9Sstevel@tonic-gate #define SCF_DEP_OPTIONAL_ALL ((const char *)"optional_all") 2487c478bd9Sstevel@tonic-gate 2497c478bd9Sstevel@tonic-gate #define SCF_DEP_RESET_ON_ERROR ((const char *)"error") 2507c478bd9Sstevel@tonic-gate #define SCF_DEP_RESET_ON_RESTART ((const char *)"restart") 2517c478bd9Sstevel@tonic-gate #define SCF_DEP_RESET_ON_REFRESH ((const char *)"refresh") 2527c478bd9Sstevel@tonic-gate #define SCF_DEP_RESET_ON_NONE ((const char *)"none") 2537c478bd9Sstevel@tonic-gate 2547c478bd9Sstevel@tonic-gate /* 2557c478bd9Sstevel@tonic-gate * Standard property group names 2567c478bd9Sstevel@tonic-gate */ 2577c478bd9Sstevel@tonic-gate #define SCF_PG_GENERAL ((const char *)"general") 2587c478bd9Sstevel@tonic-gate #define SCF_PG_GENERAL_OVR ((const char *)"general_ovr") 2597c478bd9Sstevel@tonic-gate #define SCF_PG_RESTARTER ((const char *)"restarter") 2607c478bd9Sstevel@tonic-gate #define SCF_PG_RESTARTER_ACTIONS ((const char *)"restarter_actions") 2617c478bd9Sstevel@tonic-gate #define SCF_PG_METHOD_CONTEXT ((const char *)"method_context") 2627c478bd9Sstevel@tonic-gate #define SCF_PG_APP_DEFAULT ((const char *)"application") 2637c478bd9Sstevel@tonic-gate #define SCF_PG_DEPENDENTS ((const char *)"dependents") 2647c478bd9Sstevel@tonic-gate #define SCF_PG_OPTIONS ((const char *)"options") 2657c478bd9Sstevel@tonic-gate #define SCF_PG_OPTIONS_OVR ((const char *)"options_ovr") 2667c478bd9Sstevel@tonic-gate #define SCF_PG_STARTD ((const char *)"startd") 2677c478bd9Sstevel@tonic-gate #define SCF_PG_STARTD_PRIVATE ((const char *)"svc-startd-private") 26870cbfe41SPhilippe Jung #define SCF_PG_DEATHROW ((const char *)"deathrow") 2697c478bd9Sstevel@tonic-gate 2707c478bd9Sstevel@tonic-gate /* 271*1f6eb021SLiane Praza * Template property group names and prefixes 2727c478bd9Sstevel@tonic-gate */ 2737c478bd9Sstevel@tonic-gate #define SCF_PG_TM_COMMON_NAME ((const char *)"tm_common_name") 2747c478bd9Sstevel@tonic-gate #define SCF_PG_TM_DESCRIPTION ((const char *)"tm_description") 2757c478bd9Sstevel@tonic-gate 2767c478bd9Sstevel@tonic-gate #define SCF_PG_TM_MAN_PREFIX ((const char *)"tm_man_") 2777c478bd9Sstevel@tonic-gate #define SCF_PG_TM_DOC_PREFIX ((const char *)"tm_doc_") 2787c478bd9Sstevel@tonic-gate 2797c478bd9Sstevel@tonic-gate /* 2807c478bd9Sstevel@tonic-gate * Standard property names 2817c478bd9Sstevel@tonic-gate */ 2827c478bd9Sstevel@tonic-gate #define SCF_PROPERTY_AUX_STATE ((const char *)"auxiliary_state") 2837c478bd9Sstevel@tonic-gate #define SCF_PROPERTY_CONTRACT ((const char *)"contract") 2847c478bd9Sstevel@tonic-gate #define SCF_PROPERTY_COREFILE_PATTERN ((const char *)"corefile_pattern") 2857c478bd9Sstevel@tonic-gate #define SCF_PROPERTY_DEGRADED ((const char *)"degraded") 2867c478bd9Sstevel@tonic-gate #define SCF_PROPERTY_DEGRADE_IMMEDIATE ((const char *)"degrade_immediate") 2877c478bd9Sstevel@tonic-gate #define SCF_PROPERTY_DURATION ((const char *)"duration") 2887c478bd9Sstevel@tonic-gate #define SCF_PROPERTY_ENABLED ((const char *)"enabled") 28970cbfe41SPhilippe Jung #define SCF_PROPERTY_DEATHROW ((const char *)"deathrow") 2907c478bd9Sstevel@tonic-gate #define SCF_PROPERTY_ENTITY_STABILITY ((const char *)"entity_stability") 2917c478bd9Sstevel@tonic-gate #define SCF_PROPERTY_ENTITIES ((const char *)"entities") 2927c478bd9Sstevel@tonic-gate #define SCF_PROPERTY_EXEC ((const char *)"exec") 2937c478bd9Sstevel@tonic-gate #define SCF_PROPERTY_GROUP ((const char *)"group") 2947c478bd9Sstevel@tonic-gate #define SCF_PROPERTY_GROUPING ((const char *)"grouping") 2957c478bd9Sstevel@tonic-gate #define SCF_PROPERTY_IGNORE ((const char *)"ignore_error") 296*1f6eb021SLiane Praza #define SCF_PROPERTY_INTERNAL_SEPARATORS ((const char *)"internal_separators") 2977c478bd9Sstevel@tonic-gate #define SCF_PROPERTY_LIMIT_PRIVILEGES ((const char *)"limit_privileges") 2987c478bd9Sstevel@tonic-gate #define SCF_PROPERTY_MAINT_OFF ((const char *)"maint_off") 2997c478bd9Sstevel@tonic-gate #define SCF_PROPERTY_MAINT_ON ((const char *)"maint_on") 3007c478bd9Sstevel@tonic-gate #define SCF_PROPERTY_MAINT_ON_IMMEDIATE ((const char *)"maint_on_immediate") 3017c478bd9Sstevel@tonic-gate #define SCF_PROPERTY_MAINT_ON_IMMTEMP ((const char *)"maint_on_immtemp") 3027c478bd9Sstevel@tonic-gate #define SCF_PROPERTY_MAINT_ON_TEMPORARY ((const char *)"maint_on_temporary") 3037c478bd9Sstevel@tonic-gate #define SCF_PROPERTY_METHOD_PID ((const char *)"method_pid") 3047c478bd9Sstevel@tonic-gate #define SCF_PROPERTY_MILESTONE ((const char *)"milestone") 3057c478bd9Sstevel@tonic-gate #define SCF_PROPERTY_NEED_SESSION ((const char *)"need_session") 3067c478bd9Sstevel@tonic-gate #define SCF_PROPERTY_NEXT_STATE ((const char *)"next_state") 3077c478bd9Sstevel@tonic-gate #define SCF_PROPERTY_PACKAGE ((const char *)"package") 3087c478bd9Sstevel@tonic-gate #define SCF_PROPERTY_PRIVILEGES ((const char *)"privileges") 3097c478bd9Sstevel@tonic-gate #define SCF_PROPERTY_PROFILE ((const char *)"profile") 3107c478bd9Sstevel@tonic-gate #define SCF_PROPERTY_PROJECT ((const char *)"project") 3117c478bd9Sstevel@tonic-gate #define SCF_PROPERTY_REFRESH ((const char *)"refresh") 3127c478bd9Sstevel@tonic-gate #define SCF_PROPERTY_RESOURCE_POOL ((const char *)"resource_pool") 3137c478bd9Sstevel@tonic-gate #define SCF_PROPERTY_ENVIRONMENT ((const char *)"environment") 3147c478bd9Sstevel@tonic-gate #define SCF_PROPERTY_RESTART ((const char *)"restart") 3157c478bd9Sstevel@tonic-gate #define SCF_PROPERTY_RESTARTER ((const char *)"restarter") 3167c478bd9Sstevel@tonic-gate #define SCF_PROPERTY_RESTART_INTERVAL ((const char *)"restart_interval") 3177c478bd9Sstevel@tonic-gate #define SCF_PROPERTY_RESTART_ON ((const char *)"restart_on") 3187c478bd9Sstevel@tonic-gate #define SCF_PROPERTY_RESTORE ((const char *)"restore") 3197c478bd9Sstevel@tonic-gate #define SCF_PROPERTY_SINGLE_INSTANCE ((const char *)"single_instance") 3207c478bd9Sstevel@tonic-gate #define SCF_PROPERTY_START_METHOD_TIMESTAMP \ 3217c478bd9Sstevel@tonic-gate ((const char *)"start_method_timestamp") 3227c478bd9Sstevel@tonic-gate #define SCF_PROPERTY_START_METHOD_WAITSTATUS \ 3237c478bd9Sstevel@tonic-gate ((const char *)"start_method_waitstatus") 3247c478bd9Sstevel@tonic-gate #define SCF_PROPERTY_START_PID ((const char *)"start_pid") 3257c478bd9Sstevel@tonic-gate #define SCF_PROPERTY_STATE ((const char *)"state") 3267c478bd9Sstevel@tonic-gate #define SCF_PROPERTY_STABILITY ((const char *)"stability") 3277c478bd9Sstevel@tonic-gate #define SCF_PROPERTY_STATE_TIMESTAMP ((const char *)"state_timestamp") 3287c478bd9Sstevel@tonic-gate #define SCF_PROPERTY_SUPP_GROUPS ((const char *)"supp_groups") 3297c478bd9Sstevel@tonic-gate #define SCF_PROPERTY_TIMEOUT ((const char *)"timeout_seconds") 3307c478bd9Sstevel@tonic-gate #define SCF_PROPERTY_TIMEOUT_RETRY ((const char *)"timeout_retry") 3317c478bd9Sstevel@tonic-gate #define SCF_PROPERTY_TRANSIENT_CONTRACT ((const char *)"transient_contract") 3327c478bd9Sstevel@tonic-gate #define SCF_PROPERTY_TYPE ((const char *)"type") 3337c478bd9Sstevel@tonic-gate #define SCF_PROPERTY_USE_PROFILE ((const char *)"use_profile") 3347c478bd9Sstevel@tonic-gate #define SCF_PROPERTY_USER ((const char *)"user") 3357c478bd9Sstevel@tonic-gate #define SCF_PROPERTY_UTMPX_PREFIX ((const char *)"utmpx_prefix") 3367c478bd9Sstevel@tonic-gate #define SCF_PROPERTY_WORKING_DIRECTORY ((const char *)"working_directory") 3377c478bd9Sstevel@tonic-gate 3387c478bd9Sstevel@tonic-gate /* 3397c478bd9Sstevel@tonic-gate * Template property names 3407c478bd9Sstevel@tonic-gate */ 341*1f6eb021SLiane Praza #define SCF_PROPERTY_TM_CARDINALITY_MIN ((const char *)"cardinality_min") 342*1f6eb021SLiane Praza #define SCF_PROPERTY_TM_CARDINALITY_MAX ((const char *)"cardinality_max") 343*1f6eb021SLiane Praza #define SCF_PROPERTY_TM_CHOICES_INCLUDE_VALUES ((const char *) \ 344*1f6eb021SLiane Praza "choices_include_values") 345*1f6eb021SLiane Praza #define SCF_PROPERTY_TM_CHOICES_NAME ((const char *)"choices_name") 346*1f6eb021SLiane Praza #define SCF_PROPERTY_TM_CHOICES_RANGE ((const char *)"choices_range") 347*1f6eb021SLiane Praza #define SCF_PROPERTY_TM_CONSTRAINT_NAME ((const char *)"constraint_name") 348*1f6eb021SLiane Praza #define SCF_PROPERTY_TM_CONSTRAINT_RANGE ((const char *)"constraint_range") 3497c478bd9Sstevel@tonic-gate #define SCF_PROPERTY_TM_MANPATH ((const char *)"manpath") 350*1f6eb021SLiane Praza #define SCF_PROPERTY_TM_NAME ((const char *)"name") 351*1f6eb021SLiane Praza #define SCF_PROPERTY_TM_PG_PATTERN ((const char *)"pg_pattern") 352*1f6eb021SLiane Praza #define SCF_PROPERTY_TM_REQUIRED ((const char *)"required") 3537c478bd9Sstevel@tonic-gate #define SCF_PROPERTY_TM_SECTION ((const char *)"section") 354*1f6eb021SLiane Praza #define SCF_PROPERTY_TM_TARGET ((const char *)"target") 3557c478bd9Sstevel@tonic-gate #define SCF_PROPERTY_TM_TITLE ((const char *)"title") 356*1f6eb021SLiane Praza #define SCF_PROPERTY_TM_TYPE ((const char *)"type") 3577c478bd9Sstevel@tonic-gate #define SCF_PROPERTY_TM_URI ((const char *)"uri") 358*1f6eb021SLiane Praza #define SCF_PROPERTY_TM_VALUE_PREFIX ((const char *)"value_") 359*1f6eb021SLiane Praza #define SCF_PROPERTY_TM_VALUES_NAME ((const char *)"values_name") 360*1f6eb021SLiane Praza #define SCF_PROPERTY_TM_VISIBILITY ((const char *)"visibility") 361*1f6eb021SLiane Praza #define SCF_PROPERTY_TM_COMMON_NAME_PREFIX ((const char *)"common_name_") 362*1f6eb021SLiane Praza #define SCF_PROPERTY_TM_DESCRIPTION_PREFIX ((const char *)"description_") 363*1f6eb021SLiane Praza #define SCF_PROPERTY_TM_UNITS_PREFIX ((const char *)"units_") 364*1f6eb021SLiane Praza 365*1f6eb021SLiane Praza /* 366*1f6eb021SLiane Praza * Templates wildcard string 367*1f6eb021SLiane Praza */ 368*1f6eb021SLiane Praza #define SCF_TMPL_WILDCARD ((const char *)"*") 3697c478bd9Sstevel@tonic-gate 3707c478bd9Sstevel@tonic-gate /* 3717c478bd9Sstevel@tonic-gate * Strings used by restarters for state and next_state properties. 3727c478bd9Sstevel@tonic-gate * MAX_SCF_STATE_STRING holds the max length of a state string, including the 3737c478bd9Sstevel@tonic-gate * terminating null. 3747c478bd9Sstevel@tonic-gate */ 3757c478bd9Sstevel@tonic-gate 3767c478bd9Sstevel@tonic-gate #define MAX_SCF_STATE_STRING_SZ 14 3777c478bd9Sstevel@tonic-gate 3787c478bd9Sstevel@tonic-gate #define SCF_STATE_STRING_NONE ((const char *)"none") 3797c478bd9Sstevel@tonic-gate #define SCF_STATE_STRING_UNINIT ((const char *)"uninitialized") 3807c478bd9Sstevel@tonic-gate #define SCF_STATE_STRING_MAINT ((const char *)"maintenance") 3817c478bd9Sstevel@tonic-gate #define SCF_STATE_STRING_OFFLINE ((const char *)"offline") 3827c478bd9Sstevel@tonic-gate #define SCF_STATE_STRING_DISABLED ((const char *)"disabled") 3837c478bd9Sstevel@tonic-gate #define SCF_STATE_STRING_ONLINE ((const char *)"online") 3847c478bd9Sstevel@tonic-gate #define SCF_STATE_STRING_DEGRADED ((const char *)"degraded") 3857c478bd9Sstevel@tonic-gate #define SCF_STATE_STRING_LEGACY ((const char *)"legacy_run") 3867c478bd9Sstevel@tonic-gate 3877c478bd9Sstevel@tonic-gate #define SCF_STATE_UNINIT 0x00000001 3887c478bd9Sstevel@tonic-gate #define SCF_STATE_MAINT 0x00000002 3897c478bd9Sstevel@tonic-gate #define SCF_STATE_OFFLINE 0x00000004 3907c478bd9Sstevel@tonic-gate #define SCF_STATE_DISABLED 0x00000008 3917c478bd9Sstevel@tonic-gate #define SCF_STATE_ONLINE 0x00000010 3927c478bd9Sstevel@tonic-gate #define SCF_STATE_DEGRADED 0x00000020 3937c478bd9Sstevel@tonic-gate #define SCF_STATE_ALL 0x0000003F 3947c478bd9Sstevel@tonic-gate 3957c478bd9Sstevel@tonic-gate #define SCF_PG_FLAG_NONPERSISTENT 0x1 3967c478bd9Sstevel@tonic-gate 3977c478bd9Sstevel@tonic-gate #define SCF_TRACE_LIBRARY 0x1 3987c478bd9Sstevel@tonic-gate #define SCF_TRACE_DAEMON 0x2 3997c478bd9Sstevel@tonic-gate 4007c478bd9Sstevel@tonic-gate #define SMF_IMMEDIATE 0x1 4017c478bd9Sstevel@tonic-gate #define SMF_TEMPORARY 0x2 4027c478bd9Sstevel@tonic-gate #define SMF_AT_NEXT_BOOT 0x4 4037c478bd9Sstevel@tonic-gate 4047c478bd9Sstevel@tonic-gate scf_error_t scf_error(void); 4057c478bd9Sstevel@tonic-gate const char *scf_strerror(scf_error_t); 4067c478bd9Sstevel@tonic-gate 4077c478bd9Sstevel@tonic-gate ssize_t scf_limit(uint32_t code); 4087c478bd9Sstevel@tonic-gate #define SCF_LIMIT_MAX_NAME_LENGTH -2000U 4097c478bd9Sstevel@tonic-gate #define SCF_LIMIT_MAX_VALUE_LENGTH -2001U 4107c478bd9Sstevel@tonic-gate #define SCF_LIMIT_MAX_PG_TYPE_LENGTH -2002U 4117c478bd9Sstevel@tonic-gate #define SCF_LIMIT_MAX_FMRI_LENGTH -2003U 4127c478bd9Sstevel@tonic-gate 4137c478bd9Sstevel@tonic-gate scf_handle_t *scf_handle_create(scf_version_t); 4147c478bd9Sstevel@tonic-gate 4157c478bd9Sstevel@tonic-gate int scf_handle_decorate(scf_handle_t *, const char *, scf_value_t *); 4167c478bd9Sstevel@tonic-gate #define SCF_DECORATE_CLEAR ((scf_value_t *)0) 4177c478bd9Sstevel@tonic-gate 4187c478bd9Sstevel@tonic-gate int scf_handle_bind(scf_handle_t *); 4197c478bd9Sstevel@tonic-gate int scf_handle_unbind(scf_handle_t *); 4207c478bd9Sstevel@tonic-gate void scf_handle_destroy(scf_handle_t *); 4217c478bd9Sstevel@tonic-gate 4227c478bd9Sstevel@tonic-gate int scf_type_base_type(scf_type_t type, scf_type_t *out); 423*1f6eb021SLiane Praza const char *scf_type_to_string(scf_type_t); 424*1f6eb021SLiane Praza scf_type_t scf_string_to_type(const char *); 4257c478bd9Sstevel@tonic-gate 4267c478bd9Sstevel@tonic-gate /* values */ 4277c478bd9Sstevel@tonic-gate scf_value_t *scf_value_create(scf_handle_t *); 4287c478bd9Sstevel@tonic-gate scf_handle_t *scf_value_handle(const scf_value_t *); 4297c478bd9Sstevel@tonic-gate void scf_value_destroy(scf_value_t *); 4307c478bd9Sstevel@tonic-gate 4317c478bd9Sstevel@tonic-gate scf_type_t scf_value_base_type(const scf_value_t *); 4327c478bd9Sstevel@tonic-gate scf_type_t scf_value_type(const scf_value_t *); 4337c478bd9Sstevel@tonic-gate int scf_value_is_type(const scf_value_t *, scf_type_t); 4347c478bd9Sstevel@tonic-gate 4357c478bd9Sstevel@tonic-gate void scf_value_reset(scf_value_t *); 4367c478bd9Sstevel@tonic-gate 4377c478bd9Sstevel@tonic-gate int scf_value_get_boolean(const scf_value_t *, uint8_t *); 4387c478bd9Sstevel@tonic-gate int scf_value_get_count(const scf_value_t *, uint64_t *); 4397c478bd9Sstevel@tonic-gate int scf_value_get_integer(const scf_value_t *, int64_t *); 4407c478bd9Sstevel@tonic-gate int scf_value_get_time(const scf_value_t *, int64_t *, int32_t *); 4417c478bd9Sstevel@tonic-gate ssize_t scf_value_get_astring(const scf_value_t *, char *, size_t); 4427c478bd9Sstevel@tonic-gate ssize_t scf_value_get_ustring(const scf_value_t *, char *, size_t); 4437c478bd9Sstevel@tonic-gate ssize_t scf_value_get_opaque(const scf_value_t *, void *, size_t); 4447c478bd9Sstevel@tonic-gate 4457c478bd9Sstevel@tonic-gate void scf_value_set_boolean(scf_value_t *, uint8_t); 4467c478bd9Sstevel@tonic-gate void scf_value_set_count(scf_value_t *, uint64_t); 4477c478bd9Sstevel@tonic-gate void scf_value_set_integer(scf_value_t *, int64_t); 4487c478bd9Sstevel@tonic-gate int scf_value_set_time(scf_value_t *, int64_t, int32_t); 4497c478bd9Sstevel@tonic-gate int scf_value_set_astring(scf_value_t *, const char *); 4507c478bd9Sstevel@tonic-gate int scf_value_set_ustring(scf_value_t *, const char *); 4517c478bd9Sstevel@tonic-gate int scf_value_set_opaque(scf_value_t *, const void *, size_t); 4527c478bd9Sstevel@tonic-gate 4537c478bd9Sstevel@tonic-gate ssize_t scf_value_get_as_string(const scf_value_t *, char *, size_t); 4547c478bd9Sstevel@tonic-gate ssize_t scf_value_get_as_string_typed(const scf_value_t *, scf_type_t, 4557c478bd9Sstevel@tonic-gate char *, size_t); 4567c478bd9Sstevel@tonic-gate int scf_value_set_from_string(scf_value_t *, scf_type_t, const char *); 4577c478bd9Sstevel@tonic-gate 4587c478bd9Sstevel@tonic-gate scf_iter_t *scf_iter_create(scf_handle_t *); 4597c478bd9Sstevel@tonic-gate scf_handle_t *scf_iter_handle(const scf_iter_t *); 4607c478bd9Sstevel@tonic-gate void scf_iter_reset(scf_iter_t *); 4617c478bd9Sstevel@tonic-gate void scf_iter_destroy(scf_iter_t *); 4627c478bd9Sstevel@tonic-gate 4637c478bd9Sstevel@tonic-gate int scf_iter_handle_scopes(scf_iter_t *, const scf_handle_t *); 4647c478bd9Sstevel@tonic-gate int scf_iter_scope_services(scf_iter_t *, const scf_scope_t *); 4657c478bd9Sstevel@tonic-gate int scf_iter_service_instances(scf_iter_t *, const scf_service_t *); 4667c478bd9Sstevel@tonic-gate int scf_iter_service_pgs(scf_iter_t *, const scf_service_t *); 4677c478bd9Sstevel@tonic-gate int scf_iter_instance_pgs(scf_iter_t *, const scf_instance_t *); 4687c478bd9Sstevel@tonic-gate int scf_iter_instance_pgs_composed(scf_iter_t *, const scf_instance_t *, 4697c478bd9Sstevel@tonic-gate const scf_snapshot_t *); 4707c478bd9Sstevel@tonic-gate int scf_iter_service_pgs_typed(scf_iter_t *, const scf_service_t *, 4717c478bd9Sstevel@tonic-gate const char *); 4727c478bd9Sstevel@tonic-gate int scf_iter_instance_pgs_typed(scf_iter_t *, const scf_instance_t *, 4737c478bd9Sstevel@tonic-gate const char *); 4747c478bd9Sstevel@tonic-gate int scf_iter_instance_pgs_typed_composed(scf_iter_t *, const scf_instance_t *, 4757c478bd9Sstevel@tonic-gate const scf_snapshot_t *, const char *); 4767c478bd9Sstevel@tonic-gate int scf_iter_snaplevel_pgs(scf_iter_t *, const scf_snaplevel_t *); 4777c478bd9Sstevel@tonic-gate int scf_iter_snaplevel_pgs_typed(scf_iter_t *, const scf_snaplevel_t *, 4787c478bd9Sstevel@tonic-gate const char *); 4797c478bd9Sstevel@tonic-gate int scf_iter_instance_snapshots(scf_iter_t *, const scf_instance_t *); 4807c478bd9Sstevel@tonic-gate int scf_iter_pg_properties(scf_iter_t *, const scf_propertygroup_t *); 4817c478bd9Sstevel@tonic-gate int scf_iter_property_values(scf_iter_t *, const scf_property_t *); 4827c478bd9Sstevel@tonic-gate 4837c478bd9Sstevel@tonic-gate int scf_iter_next_scope(scf_iter_t *, scf_scope_t *); 4847c478bd9Sstevel@tonic-gate int scf_iter_next_service(scf_iter_t *, scf_service_t *); 4857c478bd9Sstevel@tonic-gate int scf_iter_next_instance(scf_iter_t *, scf_instance_t *); 4867c478bd9Sstevel@tonic-gate int scf_iter_next_pg(scf_iter_t *, scf_propertygroup_t *); 4877c478bd9Sstevel@tonic-gate int scf_iter_next_property(scf_iter_t *, scf_property_t *); 4887c478bd9Sstevel@tonic-gate int scf_iter_next_snapshot(scf_iter_t *, scf_snapshot_t *); 4897c478bd9Sstevel@tonic-gate int scf_iter_next_value(scf_iter_t *, scf_value_t *); 4907c478bd9Sstevel@tonic-gate 4917c478bd9Sstevel@tonic-gate scf_scope_t *scf_scope_create(scf_handle_t *); 4927c478bd9Sstevel@tonic-gate scf_handle_t *scf_scope_handle(const scf_scope_t *); 4937c478bd9Sstevel@tonic-gate 4947c478bd9Sstevel@tonic-gate /* XXX eventually remove this */ 4957c478bd9Sstevel@tonic-gate #define scf_handle_get_local_scope(h, s) \ 4967c478bd9Sstevel@tonic-gate scf_handle_get_scope((h), SCF_SCOPE_LOCAL, (s)) 4977c478bd9Sstevel@tonic-gate 4987c478bd9Sstevel@tonic-gate int scf_handle_get_scope(scf_handle_t *, const char *, scf_scope_t *); 4997c478bd9Sstevel@tonic-gate void scf_scope_destroy(scf_scope_t *); 5007c478bd9Sstevel@tonic-gate ssize_t scf_scope_get_name(const scf_scope_t *, char *, size_t); 5017c478bd9Sstevel@tonic-gate 5027c478bd9Sstevel@tonic-gate ssize_t scf_scope_to_fmri(const scf_scope_t *, char *, size_t); 5037c478bd9Sstevel@tonic-gate 5047c478bd9Sstevel@tonic-gate scf_service_t *scf_service_create(scf_handle_t *); 5057c478bd9Sstevel@tonic-gate scf_handle_t *scf_service_handle(const scf_service_t *); 5067c478bd9Sstevel@tonic-gate void scf_service_destroy(scf_service_t *); 5077c478bd9Sstevel@tonic-gate int scf_scope_get_parent(const scf_scope_t *, scf_scope_t *); 5087c478bd9Sstevel@tonic-gate ssize_t scf_service_get_name(const scf_service_t *, char *, size_t); 5097c478bd9Sstevel@tonic-gate ssize_t scf_service_to_fmri(const scf_service_t *, char *, size_t); 5107c478bd9Sstevel@tonic-gate int scf_service_get_parent(const scf_service_t *, scf_scope_t *); 5117c478bd9Sstevel@tonic-gate int scf_scope_get_service(const scf_scope_t *, const char *, scf_service_t *); 5127c478bd9Sstevel@tonic-gate int scf_scope_add_service(const scf_scope_t *, const char *, scf_service_t *); 5137c478bd9Sstevel@tonic-gate int scf_service_delete(scf_service_t *); 5147c478bd9Sstevel@tonic-gate 5157c478bd9Sstevel@tonic-gate scf_instance_t *scf_instance_create(scf_handle_t *); 5167c478bd9Sstevel@tonic-gate scf_handle_t *scf_instance_handle(const scf_instance_t *); 5177c478bd9Sstevel@tonic-gate void scf_instance_destroy(scf_instance_t *); 5187c478bd9Sstevel@tonic-gate ssize_t scf_instance_get_name(const scf_instance_t *, char *, size_t); 5197c478bd9Sstevel@tonic-gate ssize_t scf_instance_to_fmri(const scf_instance_t *, char *, size_t); 5207c478bd9Sstevel@tonic-gate int scf_service_get_instance(const scf_service_t *, const char *, 5217c478bd9Sstevel@tonic-gate scf_instance_t *); 5227c478bd9Sstevel@tonic-gate int scf_service_add_instance(const scf_service_t *, const char *, 5237c478bd9Sstevel@tonic-gate scf_instance_t *); 5247c478bd9Sstevel@tonic-gate int scf_instance_delete(scf_instance_t *); 5257c478bd9Sstevel@tonic-gate 5267c478bd9Sstevel@tonic-gate scf_snapshot_t *scf_snapshot_create(scf_handle_t *); 5277c478bd9Sstevel@tonic-gate scf_handle_t *scf_snapshot_handle(const scf_snapshot_t *); 5287c478bd9Sstevel@tonic-gate void scf_snapshot_destroy(scf_snapshot_t *); 5297c478bd9Sstevel@tonic-gate ssize_t scf_snapshot_get_name(const scf_snapshot_t *, char *, size_t); 5307c478bd9Sstevel@tonic-gate int scf_snapshot_get_parent(const scf_snapshot_t *, scf_instance_t *); 5317c478bd9Sstevel@tonic-gate int scf_instance_get_snapshot(const scf_instance_t *, const char *, 5327c478bd9Sstevel@tonic-gate scf_snapshot_t *); 5337c478bd9Sstevel@tonic-gate int scf_snapshot_update(scf_snapshot_t *); 5347c478bd9Sstevel@tonic-gate 5357c478bd9Sstevel@tonic-gate scf_snaplevel_t *scf_snaplevel_create(scf_handle_t *); 5367c478bd9Sstevel@tonic-gate scf_handle_t *scf_snaplevel_handle(const scf_snaplevel_t *); 5377c478bd9Sstevel@tonic-gate void scf_snaplevel_destroy(scf_snaplevel_t *); 5387c478bd9Sstevel@tonic-gate int scf_snaplevel_get_parent(const scf_snaplevel_t *, scf_snapshot_t *); 5397c478bd9Sstevel@tonic-gate ssize_t scf_snaplevel_get_scope_name(const scf_snaplevel_t *, char *, size_t); 5407c478bd9Sstevel@tonic-gate ssize_t scf_snaplevel_get_service_name(const scf_snaplevel_t *, char *, size_t); 5417c478bd9Sstevel@tonic-gate ssize_t scf_snaplevel_get_instance_name(const scf_snaplevel_t *, char *, 5427c478bd9Sstevel@tonic-gate size_t); 5437c478bd9Sstevel@tonic-gate int scf_snaplevel_get_pg(const scf_snaplevel_t *, const char *, 5447c478bd9Sstevel@tonic-gate scf_propertygroup_t *pg); 5457c478bd9Sstevel@tonic-gate int scf_snapshot_get_base_snaplevel(const scf_snapshot_t *, scf_snaplevel_t *); 5467c478bd9Sstevel@tonic-gate int scf_snaplevel_get_next_snaplevel(const scf_snaplevel_t *, 5477c478bd9Sstevel@tonic-gate scf_snaplevel_t *); 5487c478bd9Sstevel@tonic-gate 5497c478bd9Sstevel@tonic-gate scf_propertygroup_t *scf_pg_create(scf_handle_t *); 5507c478bd9Sstevel@tonic-gate scf_handle_t *scf_pg_handle(const scf_propertygroup_t *); 5517c478bd9Sstevel@tonic-gate void scf_pg_destroy(scf_propertygroup_t *); 5527c478bd9Sstevel@tonic-gate ssize_t scf_pg_to_fmri(const scf_propertygroup_t *, char *, size_t); 5537c478bd9Sstevel@tonic-gate ssize_t scf_pg_get_name(const scf_propertygroup_t *, char *, size_t); 5547c478bd9Sstevel@tonic-gate ssize_t scf_pg_get_type(const scf_propertygroup_t *, char *, size_t); 5557c478bd9Sstevel@tonic-gate int scf_pg_get_flags(const scf_propertygroup_t *, uint32_t *); 5567c478bd9Sstevel@tonic-gate int scf_pg_get_parent_service(const scf_propertygroup_t *, scf_service_t *); 5577c478bd9Sstevel@tonic-gate int scf_pg_get_parent_instance(const scf_propertygroup_t *, scf_instance_t *); 5587c478bd9Sstevel@tonic-gate int scf_pg_get_parent_snaplevel(const scf_propertygroup_t *, scf_snaplevel_t *); 5597c478bd9Sstevel@tonic-gate int scf_service_get_pg(const scf_service_t *, const char *, 5607c478bd9Sstevel@tonic-gate scf_propertygroup_t *); 5617c478bd9Sstevel@tonic-gate int scf_instance_get_pg(const scf_instance_t *, const char *, 5627c478bd9Sstevel@tonic-gate scf_propertygroup_t *); 5637c478bd9Sstevel@tonic-gate int scf_instance_get_pg_composed(const scf_instance_t *, const scf_snapshot_t *, 5647c478bd9Sstevel@tonic-gate const char *, scf_propertygroup_t *); 5657c478bd9Sstevel@tonic-gate int scf_service_add_pg(const scf_service_t *, const char *, const char *, 5667c478bd9Sstevel@tonic-gate uint32_t, scf_propertygroup_t *); 5677c478bd9Sstevel@tonic-gate int scf_instance_add_pg(const scf_instance_t *, const char *, const char *, 5687c478bd9Sstevel@tonic-gate uint32_t, scf_propertygroup_t *); 5697c478bd9Sstevel@tonic-gate int scf_pg_delete(scf_propertygroup_t *); 5707c478bd9Sstevel@tonic-gate 5717c478bd9Sstevel@tonic-gate int scf_pg_get_underlying_pg(const scf_propertygroup_t *, 5727c478bd9Sstevel@tonic-gate scf_propertygroup_t *); 5737c478bd9Sstevel@tonic-gate int scf_instance_get_parent(const scf_instance_t *, scf_service_t *); 5747c478bd9Sstevel@tonic-gate 5757c478bd9Sstevel@tonic-gate int scf_pg_update(scf_propertygroup_t *); 5767c478bd9Sstevel@tonic-gate 5777c478bd9Sstevel@tonic-gate scf_property_t *scf_property_create(scf_handle_t *); 5787c478bd9Sstevel@tonic-gate scf_handle_t *scf_property_handle(const scf_property_t *); 5797c478bd9Sstevel@tonic-gate void scf_property_destroy(scf_property_t *); 5807c478bd9Sstevel@tonic-gate int scf_property_is_type(const scf_property_t *, scf_type_t); 5817c478bd9Sstevel@tonic-gate int scf_property_type(const scf_property_t *, scf_type_t *); 5827c478bd9Sstevel@tonic-gate ssize_t scf_property_get_name(const scf_property_t *, char *, size_t); 5837c478bd9Sstevel@tonic-gate int scf_property_get_value(const scf_property_t *, scf_value_t *); 5847c478bd9Sstevel@tonic-gate ssize_t scf_property_to_fmri(const scf_property_t *, char *, size_t); 5857c478bd9Sstevel@tonic-gate int scf_pg_get_property(const scf_propertygroup_t *, const char *, 5867c478bd9Sstevel@tonic-gate scf_property_t *); 5877c478bd9Sstevel@tonic-gate 5887c478bd9Sstevel@tonic-gate scf_transaction_t *scf_transaction_create(scf_handle_t *); 5897c478bd9Sstevel@tonic-gate scf_handle_t *scf_transaction_handle(const scf_transaction_t *); 5907c478bd9Sstevel@tonic-gate int scf_transaction_start(scf_transaction_t *, scf_propertygroup_t *); 5917c478bd9Sstevel@tonic-gate void scf_transaction_destroy(scf_transaction_t *); 5927c478bd9Sstevel@tonic-gate void scf_transaction_destroy_children(scf_transaction_t *); 5937c478bd9Sstevel@tonic-gate 5947c478bd9Sstevel@tonic-gate void scf_transaction_reset(scf_transaction_t *); 5957c478bd9Sstevel@tonic-gate void scf_transaction_reset_all(scf_transaction_t *); 5967c478bd9Sstevel@tonic-gate 5977c478bd9Sstevel@tonic-gate int scf_transaction_commit(scf_transaction_t *); 5987c478bd9Sstevel@tonic-gate 5997c478bd9Sstevel@tonic-gate scf_transaction_entry_t *scf_entry_create(scf_handle_t *); 6007c478bd9Sstevel@tonic-gate scf_handle_t *scf_entry_handle(const scf_transaction_entry_t *); 6017c478bd9Sstevel@tonic-gate void scf_entry_reset(scf_transaction_entry_t *); 6027c478bd9Sstevel@tonic-gate void scf_entry_destroy(scf_transaction_entry_t *); 6037c478bd9Sstevel@tonic-gate void scf_entry_destroy_children(scf_transaction_entry_t *); 6047c478bd9Sstevel@tonic-gate 6057c478bd9Sstevel@tonic-gate int scf_transaction_property_change(scf_transaction_t *, 6067c478bd9Sstevel@tonic-gate scf_transaction_entry_t *, const char *, scf_type_t); 6077c478bd9Sstevel@tonic-gate int scf_transaction_property_delete(scf_transaction_t *, 6087c478bd9Sstevel@tonic-gate scf_transaction_entry_t *, const char *); 6097c478bd9Sstevel@tonic-gate int scf_transaction_property_new(scf_transaction_t *, 6107c478bd9Sstevel@tonic-gate scf_transaction_entry_t *, const char *, scf_type_t); 6117c478bd9Sstevel@tonic-gate int scf_transaction_property_change_type(scf_transaction_t *, 6127c478bd9Sstevel@tonic-gate scf_transaction_entry_t *, const char *, scf_type_t); 6137c478bd9Sstevel@tonic-gate 6147c478bd9Sstevel@tonic-gate int scf_entry_add_value(scf_transaction_entry_t *, scf_value_t *); 6157c478bd9Sstevel@tonic-gate 6167c478bd9Sstevel@tonic-gate int scf_handle_decode_fmri(scf_handle_t *, const char *, scf_scope_t *, 6177c478bd9Sstevel@tonic-gate scf_service_t *, scf_instance_t *, scf_propertygroup_t *, scf_property_t *, 6187c478bd9Sstevel@tonic-gate int); 6197c478bd9Sstevel@tonic-gate #define SCF_DECODE_FMRI_EXACT 0x00000001 6207c478bd9Sstevel@tonic-gate #define SCF_DECODE_FMRI_TRUNCATE 0x00000002 6217c478bd9Sstevel@tonic-gate #define SCF_DECODE_FMRI_REQUIRE_INSTANCE 0x00000004 6227c478bd9Sstevel@tonic-gate #define SCF_DECODE_FMRI_REQUIRE_NO_INSTANCE 0x00000008 6237c478bd9Sstevel@tonic-gate 6247c478bd9Sstevel@tonic-gate ssize_t scf_myname(scf_handle_t *, char *, size_t); 6257c478bd9Sstevel@tonic-gate 6267c478bd9Sstevel@tonic-gate /* 627*1f6eb021SLiane Praza * Property group template interfaces. 6287c478bd9Sstevel@tonic-gate */ 629*1f6eb021SLiane Praza scf_pg_tmpl_t *scf_tmpl_pg_create(scf_handle_t *); 630*1f6eb021SLiane Praza void scf_tmpl_pg_destroy(scf_pg_tmpl_t *); 631*1f6eb021SLiane Praza void scf_tmpl_pg_reset(scf_pg_tmpl_t *); 632*1f6eb021SLiane Praza int scf_tmpl_get_by_pg(scf_propertygroup_t *, scf_pg_tmpl_t *, int); 633*1f6eb021SLiane Praza int scf_tmpl_get_by_pg_name(const char *, const char *, 634*1f6eb021SLiane Praza const char *, const char *, scf_pg_tmpl_t *, int); 635*1f6eb021SLiane Praza int scf_tmpl_iter_pgs(scf_pg_tmpl_t *, const char *, const char *, 636*1f6eb021SLiane Praza const char *, int); 637*1f6eb021SLiane Praza #define SCF_PG_TMPL_FLAG_REQUIRED 0x1 638*1f6eb021SLiane Praza #define SCF_PG_TMPL_FLAG_EXACT 0x2 639*1f6eb021SLiane Praza #define SCF_PG_TMPL_FLAG_CURRENT 0x4 640*1f6eb021SLiane Praza 641*1f6eb021SLiane Praza ssize_t scf_tmpl_pg_name(const scf_pg_tmpl_t *, char **); 642*1f6eb021SLiane Praza ssize_t scf_tmpl_pg_common_name(const scf_pg_tmpl_t *, const char *, char **); 643*1f6eb021SLiane Praza ssize_t scf_tmpl_pg_description(const scf_pg_tmpl_t *, const char *, char **); 644*1f6eb021SLiane Praza ssize_t scf_tmpl_pg_type(const scf_pg_tmpl_t *, char **); 645*1f6eb021SLiane Praza 646*1f6eb021SLiane Praza ssize_t scf_tmpl_pg_target(const scf_pg_tmpl_t *, char **); 647*1f6eb021SLiane Praza #define SCF_TM_TARGET_ALL ((const char *)"all") 648*1f6eb021SLiane Praza #define SCF_TM_TARGET_DELEGATE ((const char *)"delegate") 649*1f6eb021SLiane Praza #define SCF_TM_TARGET_INSTANCE ((const char *)"instance") 650*1f6eb021SLiane Praza #define SCF_TM_TARGET_THIS ((const char *)"this") 651*1f6eb021SLiane Praza 652*1f6eb021SLiane Praza int scf_tmpl_pg_required(const scf_pg_tmpl_t *, uint8_t *); 6537c478bd9Sstevel@tonic-gate 654*1f6eb021SLiane Praza /* 655*1f6eb021SLiane Praza * Property template interfaces. 656*1f6eb021SLiane Praza */ 657*1f6eb021SLiane Praza scf_prop_tmpl_t *scf_tmpl_prop_create(scf_handle_t *); 658*1f6eb021SLiane Praza void scf_tmpl_prop_destroy(scf_prop_tmpl_t *); 659*1f6eb021SLiane Praza void scf_tmpl_prop_reset(scf_prop_tmpl_t *); 660*1f6eb021SLiane Praza int scf_tmpl_get_by_prop(scf_pg_tmpl_t *, const char *, 661*1f6eb021SLiane Praza scf_prop_tmpl_t *, int); 662*1f6eb021SLiane Praza int scf_tmpl_iter_props(scf_pg_tmpl_t *, scf_prop_tmpl_t *, int); 663*1f6eb021SLiane Praza #define SCF_PROP_TMPL_FLAG_REQUIRED 0x1 664*1f6eb021SLiane Praza 665*1f6eb021SLiane Praza ssize_t scf_tmpl_prop_name(const scf_prop_tmpl_t *, char **); 666*1f6eb021SLiane Praza int scf_tmpl_prop_type(const scf_prop_tmpl_t *, scf_type_t *); 667*1f6eb021SLiane Praza int scf_tmpl_prop_required(const scf_prop_tmpl_t *, uint8_t *); 668*1f6eb021SLiane Praza ssize_t scf_tmpl_prop_common_name(const scf_prop_tmpl_t *, const char *, 669*1f6eb021SLiane Praza char **); 670*1f6eb021SLiane Praza ssize_t scf_tmpl_prop_description(const scf_prop_tmpl_t *, const char *, 671*1f6eb021SLiane Praza char **); 672*1f6eb021SLiane Praza ssize_t scf_tmpl_prop_units(const scf_prop_tmpl_t *, const char *, char **); 673*1f6eb021SLiane Praza int scf_tmpl_prop_cardinality(const scf_prop_tmpl_t *prop, uint64_t *, 674*1f6eb021SLiane Praza uint64_t *); 675*1f6eb021SLiane Praza int scf_tmpl_prop_internal_seps(const scf_prop_tmpl_t *, scf_values_t *); 676*1f6eb021SLiane Praza 677*1f6eb021SLiane Praza int scf_tmpl_prop_visibility(const scf_prop_tmpl_t *, uint8_t *); 678*1f6eb021SLiane Praza #define SCF_TMPL_VISIBILITY_HIDDEN 1 679*1f6eb021SLiane Praza #define SCF_TMPL_VISIBILITY_READONLY 2 680*1f6eb021SLiane Praza #define SCF_TMPL_VISIBILITY_READWRITE 3 681*1f6eb021SLiane Praza 682*1f6eb021SLiane Praza const char *scf_tmpl_visibility_to_string(uint8_t); 683*1f6eb021SLiane Praza #define SCF_TM_VISIBILITY_HIDDEN ((const char *)"hidden") 684*1f6eb021SLiane Praza #define SCF_TM_VISIBILITY_READONLY ((const char *)"readonly") 685*1f6eb021SLiane Praza #define SCF_TM_VISIBILITY_READWRITE ((const char *)"readwrite") 686*1f6eb021SLiane Praza 687*1f6eb021SLiane Praza int scf_tmpl_value_name_constraints(const scf_prop_tmpl_t *prop, 688*1f6eb021SLiane Praza scf_values_t *vals); 689*1f6eb021SLiane Praza void scf_count_ranges_destroy(scf_count_ranges_t *); 690*1f6eb021SLiane Praza void scf_int_ranges_destroy(scf_int_ranges_t *); 691*1f6eb021SLiane Praza int scf_tmpl_value_count_range_constraints(const scf_prop_tmpl_t *, 692*1f6eb021SLiane Praza scf_count_ranges_t *); 693*1f6eb021SLiane Praza int scf_tmpl_value_int_range_constraints(const scf_prop_tmpl_t *, 694*1f6eb021SLiane Praza scf_int_ranges_t *); 695*1f6eb021SLiane Praza int scf_tmpl_value_count_range_choices(const scf_prop_tmpl_t *, 696*1f6eb021SLiane Praza scf_count_ranges_t *); 697*1f6eb021SLiane Praza int scf_tmpl_value_int_range_choices(const scf_prop_tmpl_t *, 698*1f6eb021SLiane Praza scf_int_ranges_t *); 699*1f6eb021SLiane Praza int scf_tmpl_value_name_choices(const scf_prop_tmpl_t *prop, 700*1f6eb021SLiane Praza scf_values_t *vals); 701*1f6eb021SLiane Praza 702*1f6eb021SLiane Praza void scf_values_destroy(scf_values_t *); 703*1f6eb021SLiane Praza 704*1f6eb021SLiane Praza ssize_t scf_tmpl_value_common_name(const scf_prop_tmpl_t *, const char *, 705*1f6eb021SLiane Praza const char *, char **); 706*1f6eb021SLiane Praza ssize_t scf_tmpl_value_description(const scf_prop_tmpl_t *, const char *, 707*1f6eb021SLiane Praza const char *, char **); 708*1f6eb021SLiane Praza 709*1f6eb021SLiane Praza int scf_tmpl_value_in_constraint(const scf_prop_tmpl_t *pt, scf_value_t *value, 710*1f6eb021SLiane Praza scf_tmpl_errors_t **errs); 711*1f6eb021SLiane Praza 712*1f6eb021SLiane Praza /* 713*1f6eb021SLiane Praza * Template validation interfaces 714*1f6eb021SLiane Praza */ 715*1f6eb021SLiane Praza int scf_tmpl_validate_fmri(scf_handle_t *, const char *, 716*1f6eb021SLiane Praza const char *, scf_tmpl_errors_t **, int); 717*1f6eb021SLiane Praza #define SCF_TMPL_VALIDATE_FLAG_CURRENT 0x1 718*1f6eb021SLiane Praza 719*1f6eb021SLiane Praza void scf_tmpl_errors_destroy(scf_tmpl_errors_t *errs); 720*1f6eb021SLiane Praza scf_tmpl_error_t *scf_tmpl_next_error(scf_tmpl_errors_t *); 721*1f6eb021SLiane Praza void scf_tmpl_reset_errors(scf_tmpl_errors_t *errs); 722*1f6eb021SLiane Praza int scf_tmpl_strerror(scf_tmpl_error_t *err, char *s, size_t n, int flag); 723*1f6eb021SLiane Praza int scf_tmpl_error_source_fmri(const scf_tmpl_error_t *, char **); 724*1f6eb021SLiane Praza int scf_tmpl_error_type(const scf_tmpl_error_t *, scf_tmpl_error_type_t *); 725*1f6eb021SLiane Praza int scf_tmpl_error_pg_tmpl(const scf_tmpl_error_t *, char **, char **); 726*1f6eb021SLiane Praza int scf_tmpl_error_pg(const scf_tmpl_error_t *, char **, char **); 727*1f6eb021SLiane Praza int scf_tmpl_error_prop_tmpl(const scf_tmpl_error_t *, char **, char **); 728*1f6eb021SLiane Praza int scf_tmpl_error_prop(const scf_tmpl_error_t *, char **, char **); 729*1f6eb021SLiane Praza int scf_tmpl_error_value(const scf_tmpl_error_t *, char **); 730*1f6eb021SLiane Praza 731*1f6eb021SLiane Praza /* 732*1f6eb021SLiane Praza * Simplified calls 733*1f6eb021SLiane Praza */ 7347c478bd9Sstevel@tonic-gate int smf_enable_instance(const char *, int); 7357c478bd9Sstevel@tonic-gate int smf_disable_instance(const char *, int); 7367c478bd9Sstevel@tonic-gate int smf_refresh_instance(const char *); 7377c478bd9Sstevel@tonic-gate int smf_restart_instance(const char *); 7387c478bd9Sstevel@tonic-gate int smf_maintain_instance(const char *, int); 7397c478bd9Sstevel@tonic-gate int smf_degrade_instance(const char *, int); 7407c478bd9Sstevel@tonic-gate int smf_restore_instance(const char *); 7417c478bd9Sstevel@tonic-gate char *smf_get_state(const char *); 7427c478bd9Sstevel@tonic-gate 7437c478bd9Sstevel@tonic-gate int scf_simple_walk_instances(uint_t, void *, 7447c478bd9Sstevel@tonic-gate int (*inst_callback)(scf_handle_t *, scf_instance_t *, void *)); 7457c478bd9Sstevel@tonic-gate 7467c478bd9Sstevel@tonic-gate scf_simple_prop_t *scf_simple_prop_get(scf_handle_t *, const char *, 7477c478bd9Sstevel@tonic-gate const char *, const char *); 7487c478bd9Sstevel@tonic-gate void scf_simple_prop_free(scf_simple_prop_t *); 7497c478bd9Sstevel@tonic-gate scf_simple_app_props_t *scf_simple_app_props_get(scf_handle_t *, const char *); 7507c478bd9Sstevel@tonic-gate void scf_simple_app_props_free(scf_simple_app_props_t *); 7517c478bd9Sstevel@tonic-gate const scf_simple_prop_t *scf_simple_app_props_next( 7527c478bd9Sstevel@tonic-gate const scf_simple_app_props_t *, scf_simple_prop_t *); 7537c478bd9Sstevel@tonic-gate const scf_simple_prop_t *scf_simple_app_props_search( 7547c478bd9Sstevel@tonic-gate const scf_simple_app_props_t *, const char *, const char *); 7557c478bd9Sstevel@tonic-gate ssize_t scf_simple_prop_numvalues(const scf_simple_prop_t *); 7567c478bd9Sstevel@tonic-gate scf_type_t scf_simple_prop_type(const scf_simple_prop_t *); 7577c478bd9Sstevel@tonic-gate char *scf_simple_prop_name(const scf_simple_prop_t *); 7587c478bd9Sstevel@tonic-gate char *scf_simple_prop_pgname(const scf_simple_prop_t *); 7597c478bd9Sstevel@tonic-gate uint8_t *scf_simple_prop_next_boolean(scf_simple_prop_t *); 7607c478bd9Sstevel@tonic-gate uint64_t *scf_simple_prop_next_count(scf_simple_prop_t *); 7617c478bd9Sstevel@tonic-gate int64_t *scf_simple_prop_next_integer(scf_simple_prop_t *); 7627c478bd9Sstevel@tonic-gate int64_t *scf_simple_prop_next_time(scf_simple_prop_t *, int32_t *); 7637c478bd9Sstevel@tonic-gate char *scf_simple_prop_next_astring(scf_simple_prop_t *); 7647c478bd9Sstevel@tonic-gate char *scf_simple_prop_next_ustring(scf_simple_prop_t *); 7657c478bd9Sstevel@tonic-gate void *scf_simple_prop_next_opaque(scf_simple_prop_t *, size_t *); 7667c478bd9Sstevel@tonic-gate void scf_simple_prop_next_reset(scf_simple_prop_t *); 7677c478bd9Sstevel@tonic-gate 7687c478bd9Sstevel@tonic-gate /* 7697c478bd9Sstevel@tonic-gate * SMF exit status definitions 7707c478bd9Sstevel@tonic-gate */ 7717c478bd9Sstevel@tonic-gate #define SMF_EXIT_OK 0 7727c478bd9Sstevel@tonic-gate #define SMF_EXIT_ERR_FATAL 95 7737c478bd9Sstevel@tonic-gate #define SMF_EXIT_ERR_CONFIG 96 7747c478bd9Sstevel@tonic-gate #define SMF_EXIT_MON_DEGRADE 97 7757c478bd9Sstevel@tonic-gate #define SMF_EXIT_MON_OFFLINE 98 7767c478bd9Sstevel@tonic-gate #define SMF_EXIT_ERR_NOSMF 99 7777c478bd9Sstevel@tonic-gate #define SMF_EXIT_ERR_PERM 100 7787c478bd9Sstevel@tonic-gate 7797c478bd9Sstevel@tonic-gate #ifdef __cplusplus 7807c478bd9Sstevel@tonic-gate } 7817c478bd9Sstevel@tonic-gate #endif 7827c478bd9Sstevel@tonic-gate 7837c478bd9Sstevel@tonic-gate #endif /* _LIBSCF_H */ 784