/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License (the "License").
 * You may not use this file except in compliance with the License.
 *
 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
 * or http://www.opensolaris.org/os/licensing.
 * See the License for the specific language governing permissions
 * and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL HEADER in each
 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
 * If applicable, add the following below this CDDL HEADER, with the
 * fields enclosed by brackets "[]" replaced with your own identifying
 * information: Portions Copyright [yyyy] [name of copyright owner]
 *
 * CDDL HEADER END
 */

/*
 * Copyright (c) 2004, 2010, Oracle and/or its affiliates. All rights reserved.
 * Copyright (c) 2015, Joyent, Inc. All rights reserved.
 * Copyright 2023 Oxide Computer Company
 */

#ifndef _CMD_SVCCFG_H
#define _CMD_SVCCFG_H


#include <sys/types.h>

#include <libxml/tree.h>

#include <libscf.h>
#include <libscf_priv.h>
#include <libtecla.h>
#include <libuutil.h>

#ifdef  __cplusplus
extern "C" {
#endif

/* Command scope bits for command tab completion */
#define CS_SCOPE        0x01
#define CS_SVC          0x02
#define CS_INST         0x04
#define CS_SNAP         0x08
#define CS_GLOBAL       0x0f

/* Flags for lscf_bundle_import() & co. */
#define SCI_NOREFRESH   0x01            /* Don't refresh instances */
#define SCI_GENERALLAST 0x04            /* Add general property group last */
#define SCI_NOENABLED   0x08            /* Don't import general/enabled. */
#define SCI_FRESH       0x10            /* Freshly imported service */
#define SCI_FORCE       0x20            /* Override-import. */
#define SCI_KEEP        0x40            /* Don't delete when SCI_FORCEing */
#define SCI_NOSNAP      0x80            /* Don't take last-import snapshot */
#define SCI_DELAYENABLE 0x100           /* Delay the general/enable property */

#define SCI_OP_IMPORT   0x1000
#define SCI_OP_APPLY    0x2000
#define SCI_OP_RESTORE  0x4000

#define HASH_SVC                "smf/manifest"

/*
 * If the filesystem/minimal service is not online, do not consider
 * manifests in the /var file system.
 */
#define IGNORE_VAR      (!est->sc_fs_minimal)

/* Flags for lscf_service_export() */
#define SCE_ALL_VALUES  0x01            /* Include all property values */

extern int yyerror(const char *);
extern int yyparse(void);

extern int lex_lineno;

#define MANIFEST_DTD_PATH       "/usr/share/lib/xml/dtd/service_bundle.dtd.1"
/*
 * The following list must be kept in the same order as that of
 * lxml_prop_types[]
 */
typedef enum element {
        SC_ASTRING = 0,
        SC_BOOLEAN,
        SC_CARDINALITY,
        SC_CHOICES,
        SC_COMMON_NAME,
        SC_CONSTRAINTS,
        SC_COUNT,
        SC_INSTANCE_CREATE_DEFAULT,
        SC_DEPENDENCY,
        SC_DEPENDENT,
        SC_DESCRIPTION,
        SC_DOC_LINK,
        SC_DOCUMENTATION,
        SC_ENABLED,
        SC_EVENT,
        SC_EXEC_METHOD,
        SC_FMRI,
        SC_HOST,
        SC_HOSTNAME,
        SC_INCLUDE_VALUES,
        SC_INSTANCE,
        SC_INTEGER,
        SC_INTERNAL_SEPARATORS,
        SC_LOCTEXT,
        SC_MANPAGE,
        SC_METHOD_CONTEXT,
        SC_METHOD_CREDENTIAL,
        SC_METHOD_PROFILE,
        SC_METHOD_ENVIRONMENT,
        SC_METHOD_ENVVAR,
        SC_NET_ADDR,
        SC_NET_ADDR_V4,
        SC_NET_ADDR_V6,
        SC_NOTIFICATION_PARAMETERS,
        SC_OPAQUE,
        SC_PARAMETER,
        SC_PARAMVAL,
        SC_PG_PATTERN,
        SC_PROP_PATTERN,
        SC_PROPERTY,
        SC_PROPERTY_GROUP,
        SC_PROPVAL,
        SC_RANGE,
        SC_RESTARTER,
        SC_SERVICE,
        SC_SERVICE_BUNDLE,
        SC_SERVICE_FMRI,
        SC_INSTANCE_SINGLE,
        SC_STABILITY,
        SC_TEMPLATE,
        SC_TIME,
        SC_TYPE,
        SC_UNITS,
        SC_URI,
        SC_USTRING,
        SC_VALUE,
        SC_VALUE_NODE,
        SC_VALUES,
        SC_VISIBILITY,
        SC_XI_FALLBACK,
        SC_XI_INCLUDE
} element_t;

typedef enum bundle_type {
        SVCCFG_UNKNOWN_BUNDLE, SVCCFG_MANIFEST, SVCCFG_PROFILE, SVCCFG_ARCHIVE
} bundle_type_t;

typedef struct bundle {
        uu_list_t       *sc_bundle_services;

        xmlChar         *sc_bundle_name;
        bundle_type_t   sc_bundle_type;
} bundle_t;

typedef enum service_type {
        SVCCFG_UNKNOWN_SERVICE = 0x0, SVCCFG_SERVICE, SVCCFG_RESTARTER,
        SVCCFG_MILESTONE
} service_type_t;

typedef enum entity_type {
        SVCCFG_SERVICE_OBJECT = 0x0, SVCCFG_INSTANCE_OBJECT
} entity_type_t;

enum import_state {
        IMPORT_NONE = 0,
        IMPORT_PREVIOUS,
        IMPORT_PROP_BEGUN,
        IMPORT_PROP_DONE,
        IMPORT_COMPLETE,
        IMPORT_REFRESHED
};

typedef enum svccfg_op {
        SVCCFG_OP_NONE = -1,
        SVCCFG_OP_IMPORT = 0,
        SVCCFG_OP_APPLY,
        SVCCFG_OP_RESTORE
} svccfg_op_t;

/*
 * Return values for functions that validate an entity against the templates.
 */
typedef enum tmpl_validate_status {
        TVS_SUCCESS = 0,
        /*
         * Either conversion of ASTRING property value to a number failed,
         * or base 32 decoding of a property value failed.
         */
        TVS_BAD_CONVERSION,
        /* Template is defective. */
        TVS_BAD_TEMPLATE,
        /* Template type spec is invalid. */
        TVS_INVALID_TYPE_SPECIFICATION,
        /* Property group is missing a type specification. */
        TVS_MISSING_PG_TYPE,
        /* Template with required == true is missing type specification. */
        TVS_MISSING_TYPE_SPECIFICATION,
        /* No match was found for specified item. */
        TVS_NOMATCH,
        /* Validation error occurred */
        TVS_VALIDATION,
        /* Validation error that should not inhibit import. */
        TVS_WARN,
        /* Could not validate because of fatal errors. */
        TVS_FATAL = -1
} tmpl_validate_status_t;

/*
 * The composed_pg structure is used for templates validation.  It is
 * defined in svccfg_tmpl.c
 */
typedef struct composed_pg composed_pg_t;

typedef struct entity {
        uu_list_node_t  sc_node;
        entity_type_t sc_etype;

        /* Common fields to all entities. */
        const char      *sc_name;
        const char      *sc_fmri;
        uu_list_t       *sc_pgroups;
        uu_list_t       *sc_dependents;
        struct entity   *sc_parent;
        enum import_state  sc_import_state;
        boolean_t       sc_miss_type;
        int             sc_seen;
        svccfg_op_t     sc_op;

        union {
                struct {
                        uu_list_t       *sc_service_instances;
                        service_type_t  sc_service_type;
                        uint_t          sc_service_version;
                        /* Following used by template validation */
                        struct entity   *sc_restarter;
                        struct entity   *sc_global;
                } sc_service;
                struct {
                        uu_avl_t *sc_composed;
                        /* Following used by template validation */
                        struct entity   *sc_instance_restarter;
                } sc_instance;
        } sc_u;
} entity_t;

/*
 * sc_pgroup_composed is only used for templates validation of properties.
 * It is created in build_composed_property_groups() and destroyed in
 * composed_pg_destroy().  It will only be set for property groups that are
 * part of an instance -- not for service property groups.
 */
typedef struct pgroup {
        uu_list_node_t  sc_node;
        uu_list_t       *sc_pgroup_props;
        composed_pg_t   *sc_pgroup_composed;    /* Composed properties */

        const char      *sc_pgroup_name;
        const char      *sc_pgroup_type;
        uint_t          sc_pgroup_flags;
        struct entity   *sc_parent;

        int             sc_pgroup_delete;
        int             sc_pgroup_override;
        const char      *sc_pgroup_fmri;        /* Used for dependents */

        int             sc_pgroup_seen;
} pgroup_t;

typedef struct property {
        uu_list_node_t  sc_node;
        uu_avl_node_t   sc_composed_node;       /* Composed props linkage */
        uu_list_t       *sc_property_values;

        char            *sc_property_name;
        scf_type_t      sc_value_type;

        int             sc_property_override;
        int             sc_seen;
} property_t;

typedef struct value {
        uu_list_node_t  sc_node;

        scf_type_t      sc_type;

        void (*sc_free)(struct value *);

        union {
                uint64_t        sc_count;
                int64_t         sc_integer;
                char            *sc_string;
        } sc_u;
} value_t;

typedef struct scf_callback {
        scf_handle_t    *sc_handle;
        void            *sc_parent;     /* immediate parent: scope, service,  */
                                        /* instance, property group, property */
        scf_transaction_t *sc_trans;
        int             sc_service;     /* True if sc_parent is a service. */
        uint_t          sc_flags;
        pgroup_t        *sc_general;    /* pointer to general property group */
        property_t      *sc_enable;     /* pointer to enable property */

        const char      *sc_source_fmri;
        const char      *sc_target_fmri;
        int             sc_err;
} scf_callback_t;

/*
 * Collection of template validation errors.
 */
typedef struct tmpl_errors tmpl_errors_t;

#define bad_error(func, err)                                            \
        uu_panic("%s:%d: %s() failed with unexpected "                  \
            "error %d.  Aborting.\n", __FILE__, __LINE__, (func), (err));

#define SC_CMD_LINE             0x0
#define SC_CMD_FILE             0x1
#define SC_CMD_EOF              0x2
#define SC_CMD_IACTIVE          0x4
#define SC_CMD_DONT_EXIT        0x8

typedef struct engine_state {
        uint_t          sc_cmd_flags;
        FILE            *sc_cmd_file;
        uint_t          sc_cmd_lineno;
        const char      *sc_cmd_filename;
        char            *sc_cmd_buf;
        size_t          sc_cmd_bufsz;
        off_t           sc_cmd_bufoff;
        GetLine         *sc_gl;
        boolean_t       sc_fs_minimal;  /* SCF_INSTANCE_FS_MINIMAL is online. */
        boolean_t       sc_in_emi;      /* During early import */
        boolean_t       sc_miss_type;   /* Apply profile found missing types */

        pid_t           sc_repo_pid;
        const char      *sc_repo_filename;
        const char      *sc_repo_doordir;
        const char      *sc_repo_doorname;
        const char      *sc_repo_server;
} engine_state_t;

extern engine_state_t *est;

typedef struct string_list {
        uu_list_node_t  node;
        char            *str;
} string_list_t;

extern uu_list_pool_t *string_pool;

struct help_message {
        int             token;
        const char      *message;
};

extern struct help_message help_messages[];

extern scf_handle_t *g_hndl;    /* global repcached connection handle */
extern int g_exitcode;
extern int g_verbose;
extern int g_do_zone;
extern char g_zonename[];

extern ssize_t max_scf_fmri_len;
extern ssize_t max_scf_name_len;
extern ssize_t max_scf_value_len;
extern ssize_t max_scf_pg_type_len;

/* Common strings */
extern const char * const name_attr;
extern const char * const type_attr;
extern const char * const value_attr;
extern const char * const enabled_attr;
extern const char * const active_attr;
extern const char * const scf_pg_general;
extern const char * const scf_group_framework;
extern const char * const true;
extern const char * const false;

#define uu_list_append(list, elem)      uu_list_insert_before(list, NULL, elem)
#define uu_list_prepend(list, elem)     uu_list_insert_after(list, NULL, elem)

extern void *safe_malloc(size_t);
extern char *safe_strdup(const char *);
extern void warn(const char *, ...);
extern void synerr(int);
extern void semerr(const char *, ...);

extern void internal_init(void);
extern void internal_dump(bundle_t *);

extern int value_cmp(const void *, const void *, void *);

extern bundle_t *internal_bundle_new(void);
extern void internal_bundle_free(bundle_t *);
extern entity_t *internal_service_new(const char *);
extern void internal_service_free(entity_t *);
extern entity_t *internal_instance_new(const char *);
extern void internal_instance_free(entity_t *);
extern entity_t *internal_template_new(void);
extern pgroup_t *internal_pgroup_new(void);
extern void internal_pgroup_free(pgroup_t *);
extern pgroup_t *internal_pgroup_find(entity_t *, const char *, const char *);
extern pgroup_t *internal_dependent_find(entity_t *, const char *);
extern pgroup_t *internal_pgroup_find_or_create(entity_t *, const char *,
    const char *);
extern pgroup_t *internal_pgroup_create_strict(entity_t *, const char *,
    const char *);
extern property_t *internal_property_new(void);
extern void internal_property_free(property_t *);
extern property_t *internal_property_find(pgroup_t *, const char *);
extern property_t *internal_property_create(const char *, scf_type_t,
    uint_t, ...);
extern value_t *internal_value_new(void);

extern int internal_attach_service(bundle_t *, entity_t *);
extern int internal_attach_entity(entity_t *, entity_t *);
extern int internal_attach_pgroup(entity_t *, pgroup_t *);
extern void internal_detach_pgroup(entity_t *, pgroup_t *);
extern int internal_attach_dependent(entity_t *, pgroup_t *);
extern int internal_attach_property(pgroup_t *, property_t *);
extern void internal_detach_property(pgroup_t *, property_t *);
extern void internal_attach_value(property_t *, value_t *);

extern int load_init(void);
extern void load_fini(void);
extern int load_instance(const char *, const char *, entity_t **);
extern int load_pg_attrs(const scf_propertygroup_t *, pgroup_t **);
extern int load_pg(const scf_propertygroup_t *, pgroup_t **, const char *,
    const char *);
extern int prop_equal(property_t *, property_t *, const char *, const char *,
    int);
extern int pg_attrs_equal(const pgroup_t *, const pgroup_t *, const char *,
    int);
extern int pg_equal(pgroup_t *, pgroup_t *);

extern void lscf_cleanup(void);
extern void lscf_prep_hndl(void);
extern void lscf_init(void);
extern int lscf_bundle_import(bundle_t *, const char *, uint_t);
extern int lscf_bundle_apply(bundle_t *, const char *);
extern void lscf_delete(const char *, int);
extern void lscf_list(const char *);
extern void lscf_select(const char *);
extern void lscf_unselect();
extern void lscf_get_selection_str(char *, size_t);
extern void lscf_add(const char *);
extern void lscf_listpg(const char *);
extern void lscf_addpg(const char *, const char *, const char *);
extern void lscf_delpg(char *);
extern void lscf_delhash(char *, int);
extern void lscf_listprop(const char *);
extern void lscf_addprop(char *, const char *, const uu_list_t *);
extern void lscf_delprop(char *);
extern int lscf_describe(uu_list_t *, int);
extern void lscf_listsnap();
extern void lscf_selectsnap(const char *);
extern void lscf_revert(const char *);
extern void lscf_refresh();
extern char *filename_to_propname(const char *);
extern int lscf_retrieve_hash(const char *, unsigned char *);
extern int lscf_store_hash(const char *, unsigned char *);
extern int lscf_service_cleanup(void *, scf_walkinfo_t *);
extern int lscf_hash_cleanup();
extern void lscf_delnotify(const char *, int);
extern void lscf_listnotify(const char *, int);
extern int lscf_setnotify(uu_list_t *);

CPL_MATCH_FN(complete_select);
CPL_MATCH_FN(complete_command);

extern int lxml_init(void);
extern int lxml_get_bundle_file(bundle_t *, const char *, svccfg_op_t);
extern void lxml_store_value(value_t *, element_t, const xmlChar *);
extern int lxml_inventory(const char *);
extern int lscf_editprop(void);
extern int lscf_addpropvalue(const char *, const char *, const char *);
extern int lscf_delpropvalue(const char *, const char *, int);
extern int lscf_setenv(uu_list_t *, int);
extern void lscf_validate(const char *);
extern void lscf_validate_fmri(const char *);
extern int lscf_service_export(char *, const char *, int);
extern int lscf_archive(const char *, int);
extern int lscf_profile_extract(const char *);
extern void lscf_set_repository(const char *, int);
extern int lscf_setprop(const char *, const char *, const char *,
    const uu_list_t *);

extern void engine_init(void);
extern int engine_exec_cmd(void);
extern int engine_exec(char *);
extern int add_cmd_matches(WordCompletion *, const char *, int, uint32_t);
extern int engine_interp(void);
extern int engine_source(const char *, boolean_t);
extern int engine_import(uu_list_t *);
extern int engine_cleanup(int);
extern int engine_set(uu_list_t *);
extern int engine_cmd_getc(engine_state_t *);
extern int engine_cmd_ungetc(engine_state_t *, char);
extern void engine_cmd_nputs(engine_state_t *, char *, size_t);
extern int engine_restore(const char *);
extern int engine_apply(const char *, int);

extern void help(int);

extern void tmpl_errors_destroy(tmpl_errors_t *);
extern void tmpl_errors_print(FILE *, tmpl_errors_t *, const char *);
extern void tmpl_init(void);
extern void tmpl_property_fini(property_t *);
extern void tmpl_property_init(property_t *);
extern tmpl_validate_status_t tmpl_validate_bundle(bundle_t *,
    tmpl_errors_t **);

#define FMA_TOKENS      0
#define MIXED_TOKENS    -1
#define INVALID_TOKENS  -2

extern char **tokenize(char *, const char *);
extern int32_t check_tokens(char **);
extern const char *de_tag(const char *);
extern const char *tset_to_string(int32_t);

#ifdef  __cplusplus
}
#endif

#endif  /* _CMD_SVCCFG_H */