amxrt_priv.h File Reference

Go to the source code of this file.

Data Structures
struct	_runtime
struct	_runtime_options

Macros
#define	AMXRT_CVAL_PLUGIN_DIR   "/usr/lib/amx"
#define	AMXRT_CVAL_CFG_DIR   "/etc/amx"
#define	AMXRT_CVAL_BACKEND_DIR   "/usr/bin/mods/amxb"
#define	AMXRT_CVAL_STORAGE_TYPE   "odl"
#define	COLOR_BLACK   "\033[30m"
#define	COLOR_RED   "\033[31m"
#define	COLOR_GREEN   "\033[32m"
#define	COLOR_YELLOW   "\033[33m"
#define	COLOR_BLUE   "\033[34m"
#define	COLOR_MAGENTA   "\033[35m"
#define	COLOR_CYAN   "\033[36m"
#define	COLOR_WHITE   "\033[37m"
#define	COLOR_BRIGHT_BLACK   "\033[30;1m"
#define	COLOR_BRIGHT_RED   "\033[31;1m"
#define	COLOR_BRIGHT_GREEN   "\033[32;1m"
#define	COLOR_BRIGHT_YELLOW   "\033[33;1m"
#define	COLOR_BRIGHT_BLUE   "\033[34;1m"
#define	COLOR_BRIGHT_MAGENTA   "\033[35;1m"
#define	COLOR_BRIGHT_CYAN   "\033[36;1m"
#define	COLOR_BRIGHT_WHITE   "\033[37;1m"
#define	COLOR_RESET   "\033[0m"
#define	BLUE   0
#define	GREEN   1
#define	RED   2
#define	WHITE   3
#define	CYAN   4
#define	YELLOW   5
#define	RESET   6
#define	c(x)   get_color(x)

Typedefs
typedef struct _runtime	amxrt_t
typedef struct _runtime_options	amxrt_arg_t

Functions
PRIVATE const char *	get_color (uint32_t cc)
PRIVATE amxrt_t *	amxrt_get (void)
PRIVATE void	amxrt_cmd_line_add_default_options (void)
PRIVATE void	amxrt_print_help (void)
PRIVATE void	amxrt_print_configuration (void)
PRIVATE void	amxrt_print_error (const char *fmt,...)
PRIVATE void	amxrt_print_message (const char *fmt,...)
PRIVATE void	amxrt_print_failure (amxo_parser_t *parser, const char *string)
PRIVATE void	amxrt_config_add_options (amxo_parser_t *parser)
PRIVATE void	amxrt_connection_detect_sockets (amxc_var_t *config)
PRIVATE int	amxrt_connection_load_backends (amxc_var_t *config)
PRIVATE int	amxrt_connection_connect_all (amxo_parser_t *parser)
PRIVATE int	amxrt_connection_listen_all (amxo_parser_t *parser)
PRIVATE int	amxrt_connection_register_dm (amxo_parser_t *parser, amxd_dm_t *dm)
PRIVATE amxp_connection_t *	amxrt_el_get_connection (amxc_llist_t *cons, int fd)
PRIVATE int	amxrt_dm_create_dir (amxo_parser_t *parser, uid_t uid, gid_t gid)

Macro Definition Documentation

AMXRT_CVAL_BACKEND_DIR

#define AMXRT_CVAL_BACKEND_DIR   "/usr/bin/mods/amxb"

Definition at line 66 of file amxrt_priv.h.

AMXRT_CVAL_CFG_DIR

#define AMXRT_CVAL_CFG_DIR   "/etc/amx"

Definition at line 65 of file amxrt_priv.h.

AMXRT_CVAL_PLUGIN_DIR

#define AMXRT_CVAL_PLUGIN_DIR   "/usr/lib/amx"

Definition at line 64 of file amxrt_priv.h.

AMXRT_CVAL_STORAGE_TYPE

#define AMXRT_CVAL_STORAGE_TYPE   "odl"

Definition at line 67 of file amxrt_priv.h.

BLUE

#define BLUE   0

Definition at line 89 of file amxrt_priv.h.

c

#define c

(

x

)

get_color(x)

Definition at line 97 of file amxrt_priv.h.

COLOR_BLACK

#define COLOR_BLACK   "\033[30m"

Definition at line 69 of file amxrt_priv.h.

COLOR_BLUE

#define COLOR_BLUE   "\033[34m"

Definition at line 73 of file amxrt_priv.h.

COLOR_BRIGHT_BLACK

#define COLOR_BRIGHT_BLACK   "\033[30;1m"

Definition at line 78 of file amxrt_priv.h.

COLOR_BRIGHT_BLUE

#define COLOR_BRIGHT_BLUE   "\033[34;1m"

Definition at line 82 of file amxrt_priv.h.

COLOR_BRIGHT_CYAN

#define COLOR_BRIGHT_CYAN   "\033[36;1m"

Definition at line 84 of file amxrt_priv.h.

COLOR_BRIGHT_GREEN

#define COLOR_BRIGHT_GREEN   "\033[32;1m"

Definition at line 80 of file amxrt_priv.h.

COLOR_BRIGHT_MAGENTA

#define COLOR_BRIGHT_MAGENTA   "\033[35;1m"

Definition at line 83 of file amxrt_priv.h.

COLOR_BRIGHT_RED

#define COLOR_BRIGHT_RED   "\033[31;1m"

Definition at line 79 of file amxrt_priv.h.

COLOR_BRIGHT_WHITE

#define COLOR_BRIGHT_WHITE   "\033[37;1m"

Definition at line 85 of file amxrt_priv.h.

COLOR_BRIGHT_YELLOW

#define COLOR_BRIGHT_YELLOW   "\033[33;1m"

Definition at line 81 of file amxrt_priv.h.

COLOR_CYAN

#define COLOR_CYAN   "\033[36m"

Definition at line 75 of file amxrt_priv.h.

COLOR_GREEN

#define COLOR_GREEN   "\033[32m"

Definition at line 71 of file amxrt_priv.h.

COLOR_MAGENTA

#define COLOR_MAGENTA   "\033[35m"

Definition at line 74 of file amxrt_priv.h.

COLOR_RED

#define COLOR_RED   "\033[31m"

Definition at line 70 of file amxrt_priv.h.

COLOR_RESET

#define COLOR_RESET   "\033[0m"

Definition at line 87 of file amxrt_priv.h.

COLOR_WHITE

#define COLOR_WHITE   "\033[37m"

Definition at line 76 of file amxrt_priv.h.

COLOR_YELLOW

#define COLOR_YELLOW   "\033[33m"

Definition at line 72 of file amxrt_priv.h.

CYAN

#define CYAN   4

Definition at line 93 of file amxrt_priv.h.

GREEN

#define GREEN   1

Definition at line 90 of file amxrt_priv.h.

RED

#define RED   2

Definition at line 91 of file amxrt_priv.h.

RESET

#define RESET   6

Definition at line 95 of file amxrt_priv.h.

WHITE

#define WHITE   3

Definition at line 92 of file amxrt_priv.h.

YELLOW

#define YELLOW   5

Definition at line 94 of file amxrt_priv.h.

Typedef Documentation

amxrt_arg_t

typedef struct _runtime_options amxrt_arg_t

amxrt_t

typedef struct _runtime amxrt_t

Function Documentation

amxrt_cmd_line_add_default_options()

PRIVATE void amxrt_cmd_line_add_default_options

(

void

)

Definition at line 178 of file amxrt_args.c.

                                              {
    amxrt_cmd_line_add_option(0, 'h', "help", no_argument, "Print usage help and exit", NULL);
    amxrt_cmd_line_add_option(0, 'H', "HELP", no_argument, "Print extended help and exit", NULL);
    amxrt_cmd_line_add_option(0, 'B', "backend", required_argument, "Loads the shared object as bus backend", "so file");
    amxrt_cmd_line_add_option(0, 'u', "uri", required_argument, "Adds an uri to the list of uris", "uri");
    amxrt_cmd_line_add_option(0, 'A', "no-auto-detect", no_argument, "Do not auto detect unix domain sockets and back-ends", NULL);
    amxrt_cmd_line_add_option(0, 'C', "no-connect", no_argument, "Do not auto connect the provided or detected uris", NULL);
    amxrt_cmd_line_add_option(0, 'I', "include-dir", required_argument, "Adds include directory for odl parser, multiple allowed", "dir");
    amxrt_cmd_line_add_option(0, 'L', "import-dir", required_argument, "Adds import directory for odl parser, multiple allowed", "dir");
    amxrt_cmd_line_add_option(0, 'o', "option", required_argument, "Adds a configuration option", "name=value");
    amxrt_cmd_line_add_option(0, 'F', "forced-option", required_argument, "Adds a configuration option, which can not be overwritten by odl files", "name=value");
    amxrt_cmd_line_add_option(0, 'O', "ODL", required_argument, "An ODL in string format, only one ODL string allowed", "odl-string");
    amxrt_cmd_line_add_option(0, 'D', "daemon", no_argument, "Daemonize the process", NULL);
    amxrt_cmd_line_add_option(0, 'p', "priority", required_argument, "Sets the process nice level", "nice level");
    amxrt_cmd_line_add_option(0, 'N', "no-pid-file", no_argument, "Disables the creation of a pid-file in /var/run", NULL);
    amxrt_cmd_line_add_option(0, 'E', "eventing", no_argument, "Enables eventing during loading of ODL files", NULL);
    amxrt_cmd_line_add_option(0, 'd', "dump", optional_argument, "Dumps configuration options or capabilities at start-up", "[caps|config]");
    amxrt_cmd_line_add_option(0, 'l', "log", no_argument, "Write to syslog instead of stdout and stderr", NULL);
    amxrt_cmd_line_add_option(0, 'R', "requires", required_argument, "Checks if datamodel objects are available or waits until they are available", "root object");
}

amxrt_config_add_options()

PRIVATE void amxrt_config_add_options

(

amxo_parser_t *

parser

)

Definition at line 183 of file amxrt_config.c.

                                                     {
    amxc_var_t* config = &parser->config;
 
    amxc_var_add_key(amxc_llist_t, config, AMXRT_COPT_BACKENDS, NULL);
    amxc_var_add_key(amxc_llist_t, config, AMXRT_COPT_URIS, NULL);
    amxc_var_add_key(amxc_llist_t, config, AMXRT_COPT_DATA_URIS, NULL);
    amxc_var_add_key(bool, config, AMXRT_COPT_AUTO_DETECT, true);
    amxc_var_add_key(bool, config, AMXRT_COPT_AUTO_CONNECT, true);
    amxc_var_add_key(bool, config, AMXRT_COPT_DAEMON, false);
    amxc_var_add_key(uint32_t, config, AMXRT_COPT_PRIORITY, 0);
    amxc_var_add_key(bool, config, AMXRT_COPT_PID_FILE, true);
    amxc_var_add_key(cstring_t, config, AMXRT_COPT_PREFIX_PATH, "");
    amxc_var_add_key(cstring_t, config, AMXRT_COPT_PLUGIN_DIR, AMXRT_CVAL_PLUGIN_DIR);
    amxc_var_add_key(cstring_t, config, AMXRT_COPT_CFG_DIR, AMXRT_CVAL_CFG_DIR);
    amxc_var_add_key(amxc_llist_t, config, AMXRT_COPT_LIBDIRS, NULL);
    amxc_var_add_key(amxc_llist_t, config, AMXRT_COPT_INCDIRS, NULL);
    amxc_var_add_key(amxc_llist_t, config, AMXRT_COPT_MIBDIRS, NULL);
    amxc_var_add_key(amxc_llist_t, config, AMXRT_COPT_LISTEN, NULL);
    amxc_var_add_key(bool, config, AMXRT_COPT_EVENT, false);
    amxc_var_add_key(bool, config, AMXRT_COPT_DUMP_CONFIG, false);
    amxc_var_add_key(bool, config, AMXRT_COPT_DUMP_CAPS, false);
    amxc_var_add_key(cstring_t, config, AMXRT_COPT_BACKENDS_DIR, AMXRT_CVAL_BACKEND_DIR);
    amxc_var_add_key(cstring_t, config, AMXRT_COPT_STORAGE_TYPE, AMXRT_CVAL_STORAGE_TYPE);
    amxc_var_add_key(bool, config, AMXRT_COPT_LOG, false);
    amxc_var_add_key(cstring_t, config, AMXRT_COPT_RW_DATA_PATH, "${prefix}" RWDATAPATH);
    amxc_var_add_key(cstring_t, config, AMXRT_COPT_STORAGE_DIR, "${rw_data_path}/${name}/");
    amxc_var_add_key(amxc_llist_t, config, AMXRT_COPT_REQUIRES, NULL);
    amxc_var_add_key(cstring_t, config, AMXRT_COPT_EXT_DIR, "extensions/");
 
    // set hooks to monitor config option changes
    amxo_parser_set_hooks(parser, &amxrt_config_hooks);
}

amxrt_connection_connect_all()

PRIVATE int amxrt_connection_connect_all

(

amxo_parser_t *

parser

)

Definition at line 342 of file amxrt_connections.c.

                                                        {
    int retval = 0;
    const amxc_llist_t* uris = amxc_var_constcast(amxc_llist_t, GET_ARG(&parser->config, AMXRT_COPT_URIS));
    const amxc_llist_t* data_uris = amxc_var_constcast(amxc_llist_t, GET_ARG(&parser->config, AMXRT_COPT_DATA_URIS));
    bool connect = amxc_var_constcast(bool, GET_ARG(&parser->config, AMXRT_COPT_AUTO_CONNECT));
    if(!connect) {
        goto leave;
    }
 
    amxrt_connection_filter_uris(uris, data_uris);
    retval = amxrt_connection_connect_all_type(uris, AMXP_CONNECTION_BUS);
    when_failed(retval, leave);
    amxrt_connection_connect_all_type(data_uris, AMXP_CONNECTION_CUSTOM);
 
leave:
    return retval;
}

amxrt_connection_detect_sockets()

PRIVATE void amxrt_connection_detect_sockets

(

amxc_var_t *

config

)

Definition at line 256 of file amxrt_connections.c.

                                                         {
    amxc_var_t* uris = GET_ARG(config, AMXRT_COPT_URIS);
    bool auto_detect = GET_BOOL(config, AMXRT_COPT_AUTO_DETECT);
    amxc_array_t* backends = amxb_be_list();
    size_t size = amxc_array_size(backends);
 
    // when auto-detect is on use the socket uris that:
    // 1. are provided by the back-ends (these are the back-end default uris)
    // 2. are known to libamxrt
    // never add uris that are already defined in the config, make sure
    // no double entries are added.
 
    if(auto_detect) {
        // loop over all loaded backends and fetch uris and data-uris
        // check if they are not already added to top-level uris or data-uris
        // if not found in top level move them to top level otherwise delete them
        for(size_t i = 0; i < size; i++) {
            const char* be_name = (const char*) amxc_array_get_data_at(backends, i);
            amxc_var_t* backend_settings = GET_ARG(config, be_name);
            amxrt_move_backend_uris(config, backend_settings);
        }
        // last step - check known unix domain sockets - this for backwards compatibility
        amxrt_add_known_uris(uris);
    } else {
        for(size_t i = 0; i < size; i++) {
            const char* be_name = (const char*) amxc_array_get_data_at(backends, i);
            amxc_var_t* backend_settings = GET_ARG(config, be_name);
            amxc_var_t* be_uris = GET_ARG(backend_settings, AMXRT_COPT_URIS);
            amxc_var_t* be_data_uris = GET_ARG(backend_settings, AMXRT_COPT_DATA_URIS);
            amxc_var_delete(&be_uris);
            amxc_var_delete(&be_data_uris);
        }
    }
 
    amxc_array_delete(&backends, NULL);
}

amxrt_connection_listen_all()

PRIVATE int amxrt_connection_listen_all

(

amxo_parser_t *

parser

)

Definition at line 360 of file amxrt_connections.c.

                                                       {
    int retval = 0;
    const amxc_llist_t* listen = amxc_var_constcast(amxc_llist_t, GET_ARG(&parser->config, AMXRT_COPT_LISTEN));
 
    amxc_llist_for_each(it, listen) {
        amxb_bus_ctx_t* bus_ctx = NULL;
        int fd = -1;
        const char* uri = amxc_var_constcast(cstring_t,
                                             amxc_var_from_llist_it(it));
 
        retval = amxrt_connection_listen_bus_uri(uri, &bus_ctx);
        if(retval != 0) {
            amxrt_print_error("Failed to listen on %s", uri);
        } else {
            fd = amxb_get_fd(bus_ctx);
            amxp_connection_add(fd, amxrt_connection_read, uri, AMXP_CONNECTION_LISTEN, bus_ctx);
        }
    }
 
    return retval;
}

amxrt_connection_load_backends()

PRIVATE int amxrt_connection_load_backends

(

amxc_var_t *

config

)

Definition at line 293 of file amxrt_connections.c.

                                                       {
    int retval = 0;
    const char* name = GET_CHAR(config, AMXRT_COPT_NAME);
    amxc_array_t* backend_names = NULL;
    size_t size = 0;
    amxc_var_t* backends = amxc_var_get_key(config, AMXRT_COPT_BACKENDS, AMXC_VAR_FLAG_COPY);
 
    if(amxc_var_type_of(backends) == AMXC_VAR_ID_LIST) {
        const amxc_llist_t* bel = amxc_var_constcast(amxc_llist_t, backends);
        if(amxc_llist_is_empty(bel)) {
            amxrt_print_error("No backends specified\n");
            retval = 2;
        }
    } else {
        char* str = amxc_var_dyncast(cstring_t, backends);
        if((str == NULL) || (str[0] == 0)) {
            amxrt_print_error("No backends specified\n");
            retval = 2;
        }
        free(str);
    }
 
    if(retval == 0) {
        retval = amxb_be_load_multiple(backends);
        if(retval != 0) {
            amxrt_print_error("Failed to load backends\n");
            retval = 2;
        }
    }
 
    /*
       Create backend config section if not existing
       For backwards compatibility set `register-name` if not existing
       Needed for pcb backend if loaded
     */
    backend_names = amxb_be_list();
    size = amxc_array_size(backend_names);
    for(size_t i = 0; i < size; i++) {
        const char* be_name = (const char*) amxc_array_get_data_at(backend_names, i);
        amxrt_set_backend_setting(config, be_name, "register-name", name);
    }
    amxc_array_delete(&backend_names, NULL);
 
    amxb_set_config(config);
 
    amxc_var_delete(&backends);
    return retval;
}

amxrt_connection_register_dm()

PRIVATE int amxrt_connection_register_dm	(	amxo_parser_t *	parser,
		amxd_dm_t *	dm
	)

amxrt_dm_create_dir()

PRIVATE int amxrt_dm_create_dir	(	amxo_parser_t *	parser,
		uid_t	uid,
		gid_t	gid
	)

Definition at line 436 of file amxrt_save_load.c.

                                                                     {
    int rv = -1;
    char* directory = NULL;
 
    when_null(parser, exit);
 
    if(!amxrt_is_odl_storage_enabled(parser)) {
        goto exit;
    }
 
    directory = amxrt_get_directory(parser);
    rv = amxp_dir_owned_make(directory, 0777, uid, gid);
    if(rv != 0) {
        amxrt_print_error("Failed to create directory %s", directory);
    }
    free(directory);
 
exit:
    return rv;
}

amxrt_el_get_connection()

PRIVATE amxp_connection_t* amxrt_el_get_connection	(	amxc_llist_t *	cons,
		int	fd
	)

Definition at line 240 of file amxrt_el_libevent.c.

                                                                       {
    amxp_connection_t* con = NULL;
    amxc_llist_for_each(it, cons) {
        con = amxc_llist_it_get_data(it, amxp_connection_t, it);
        if(con->fd == fd) {
            break;
        }
        con = NULL;
    }
 
    return con;
}

amxrt_get()

PRIVATE amxrt_t* amxrt_get

(

void

)

Definition at line 297 of file amxrt.c.

                         {
    return &rt;
}

amxrt_print_configuration()

PRIVATE void amxrt_print_configuration

(

void

)

Definition at line 166 of file amxrt_user_output.c.

                                     {
    amxrt_t* rt = amxrt_get();
 
    fprintf(stderr, "\n%sConfiguration:%s\n", c(GREEN), c(RESET));
    fflush(stderr);
    amxc_var_dump(&rt->parser.config, STDERR_FILENO);
}

amxrt_print_error()

PRIVATE void amxrt_print_error	(	const char *	fmt,
			...
	)

Definition at line 174 of file amxrt_user_output.c.

                                             {
    amxc_var_t* config = amxrt_get_config();
    va_list args;
 
    if(GET_BOOL(config, AMXRT_COPT_LOG)) {
        va_start(args, fmt);
        vsyslog(LOG_USER | LOG_ERR, fmt, args);
        va_end(args);
    } else {
        fprintf(stderr, "%sERROR%s -- %s", c(RED), c(RESET), c(WHITE));
 
        va_start(args, fmt);
        vfprintf(stderr, fmt, args);
        va_end(args);
 
        fprintf(stderr, "%s\n", c(RESET));
    }
}

amxrt_print_failure()

PRIVATE void amxrt_print_failure	(	amxo_parser_t *	parser,
		const char *	string
	)

Definition at line 213 of file amxrt_user_output.c.

                                                                    {
    amxc_var_t* config = amxrt_get_config();
    const char* msg = amxo_parser_get_message(parser);
 
    if(GET_BOOL(config, AMXRT_COPT_LOG)) {
        syslog(LOG_USER | LOG_CRIT, "Failed parsing - %s", string == NULL ? "###" : string);
        syslog(LOG_USER | LOG_CRIT, "Reason - %s", msg == NULL ? "###" : msg);
    } else {
        fprintf(stderr, "%sERROR%s -- Failed parsing %s%s%s\n",
                c(RED), c(RESET),
                c(CYAN), string == NULL ? "###" : string, c(RESET));
 
        fprintf(stderr, "%sREASON%s -- %s%s%s\n",
                c(BLUE), c(RESET),
                c(CYAN), msg == NULL ? "###" : msg, c(RESET));
    }
}

amxrt_print_help()

PRIVATE void amxrt_print_help

(

void

)

Definition at line 160 of file amxrt_user_output.c.

                            {
    amxrt_print_usage();
    amxrt_print_notes();
    amxrt_print_config_example();
}

amxrt_print_message()

PRIVATE void amxrt_print_message	(	const char *	fmt,
			...
	)

Definition at line 193 of file amxrt_user_output.c.

                                               {
    amxc_var_t* config = amxrt_get_config();
    va_list args;
 
    if(GET_BOOL(config, AMXRT_COPT_LOG)) {
        va_start(args, fmt);
        vsyslog(LOG_USER | LOG_NOTICE, "%s", args);
        va_end(args);
    } else {
        fprintf(stderr, "%sINFO%s -- %s", c(YELLOW), c(RESET), c(WHITE));
 
        va_start(args, fmt);
        vfprintf(stderr, fmt, args);
        va_end(args);
 
        fprintf(stderr, "%s\n", c(RESET));
    }
}

get_color()

PRIVATE const char* get_color

(

uint32_t

cc

)

Definition at line 130 of file amxrt_user_output.c.

                                   {
    if(cc < RESET) {
        return colors[cc];
    }
    return colors[RESET];
}