module_mgmt.c File Reference

#include "module_mgmt.h"
#include <dlfcn.h>
#include <stdlib.h>
#include <unistd.h>
#include <amxc/amxc_macros.h>
#include <amxc/amxc.h>
#include <amxm/amxm.h>
#include <amxp/amxp_dir.h>
#include "data_model.h"
#include "pon_stat.h"
#include "pon_cfg.h"
#include "xpon_trace.h"

Go to the source code of this file.

Data Structures
struct	_pon_stat_function

Macros
#define	MOD_PON_STAT   "pon_stat"
#define	MOD_PON_CFG   "pon_cfg"

Typedefs
typedef struct _pon_stat_function	pon_stat_function_t

Functions
static bool	register_pon_stat_module (void)
static bool	register_pon_cfg_module (void)
static int	handle_vendor_module_match (const char *name, void *priv UNUSED)
static bool	find_vendor_module (void)
static bool	load_vendor_module (void)
bool	mod_module_mgmt_init (bool *module_error)
const char *	mod_get_vendor_module_loaded (void)
void	mod_module_mgmt_cleanup (void)

Variables
static const char *const	MODULES_PATH = "/usr/lib/amx/tr181-xpon/modules/"
static amxm_module_t *	s_pon_stat_module = NULL
static amxm_module_t *	s_pon_cfg_module = NULL
static amxc_string_t	s_module_name
static amxm_shared_object_t *	s_module_so = NULL
static const pon_stat_function_t	PON_STAT_FUNCTIONS []
static const pon_stat_function_t	PON_CFG_FUNCTIONS []

Macro Definition Documentation

MOD_PON_CFG

#define MOD_PON_CFG   "pon_cfg"

Definition at line 84 of file module_mgmt.c.

MOD_PON_STAT

#define MOD_PON_STAT   "pon_stat"

Definition at line 83 of file module_mgmt.c.

Typedef Documentation

pon_stat_function_t

typedef struct _pon_stat_function pon_stat_function_t

Function Documentation

find_vendor_module()

static bool find_vendor_module ( void  )

static

Find vendor module in MODULES_PATH and assign its name to s_module_name.

Definition at line 213 of file module_mgmt.c.

                                     {
 
    const char* const filter = "d_type == DT_REG && d_name matches 'mod-xpon-.*\\.so'";
 
    if(amxp_dir_scan(MODULES_PATH, filter, false, handle_vendor_module_match, NULL) != 0) {
        /* handle_vendor_module_match() already logged error */
        return false;
    }
 
    if(amxc_string_is_empty(&s_module_name)) {
        SAH_TRACEZ_ERROR(ME, "Failed to find vendor module");
        return false;
    }
    return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

handle_vendor_module_match()

static int handle_vendor_module_match ( const char *  name, void *priv  UNUSED  )

static

Handle a module found by amxp_dir_scan() in find_vendor_module().

Parameters

[in]

name

path to the vendor module, e.g., "/usr/lib/amx/tr181-xpon/modules/mod-xpon-prpl.so"

Returns

0 on success: amxp_dir_scan() should continue scanning

1 on error: amxp_dir_scan() should stop scanning

Definition at line 183 of file module_mgmt.c.

                                                                           {
    SAH_TRACEZ_DEBUG(ME, "match: '%s'", name);
 
    int rc = 0; /* keep scanning */
 
    amxc_string_t module;
    amxc_string_init(&module, 0);
    amxc_string_setf(&module, "%s", name);
    amxc_string_replace(&module, MODULES_PATH, "", /*max= */ 1);
    amxc_string_replace(&module, ".so", "", /*max= */ 1);
    const char* const module_cstr = amxc_string_get(&module, 0);
 
    if(amxc_string_is_empty(&s_module_name)) {
        amxc_string_copy(&s_module_name, &module);
        SAH_TRACEZ_DEBUG(ME, "Found vendor module: '%s.so'", module_cstr);
        dm_set_vendor_module(module_cstr);
    } else {
        SAH_TRACEZ_ERROR(ME, "Found more than one vendor module");
        SAH_TRACEZ_ERROR(ME, "  modules found: %s.so, %s.so",
                         amxc_string_get(&s_module_name, 0), module_cstr);
        rc = 1; /* error, stop scanning */
    }
 
    amxc_string_clean(&module);
    return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

load_vendor_module()

static bool load_vendor_module ( void  )

static

Find module with pattern 'mod-xpon-*.so' in MODULES_PATH and load it.

If the function finds a module:

• set s_module_name to the name of the module found, e.g. 'mod-xpon-prpl' if the function found 'mod-xpon-prpl.so' as vendor module in MODULES_PATH.
• set XPON.ModuleName in DM to the same name.

Set XPON.ModuleError to true if the function encounters one of the following errors:

• It fails to find a vendor module.
• It finds more than one vendor module. An image must only install 1 vendor module.
• It fails to load the module.

Returns

true on success, else false

Definition at line 246 of file module_mgmt.c.

                                     {
 
    bool rv = false;
 
    amxc_string_t mod_path;
    amxc_string_init(&mod_path, 0);
 
    if(!find_vendor_module()) {
        goto exit;
    }
    const char* const module = amxc_string_get(&s_module_name, 0);
    amxc_string_setf(&mod_path, "%s%s.so", MODULES_PATH, module);
 
    const char* const path_to_so = amxc_string_get(&mod_path, /*offset=*/ 0);
 
    if(access(path_to_so, F_OK) != 0) {
        SAH_TRACEZ_ERROR(ME, "%s does not exist", path_to_so);
        goto exit;
    }
 
    if(amxm_so_open(&s_module_so, module, path_to_so)) {
        const char* error = dlerror();
        SAH_TRACEZ_ERROR(ME, "Failed to load %s module", module);
        SAH_TRACEZ_ERROR(ME, "dlerror(): '%s'", error ? error : "No error");
        goto exit;
    }
 
    rv = true;
 
exit:
    if(!rv) {
        dm_set_module_error();
    }
    amxc_string_clean(&mod_path);
    return rv;
}

Here is the call graph for this function:

Here is the caller graph for this function:

mod_get_vendor_module_loaded()

const char* mod_get_vendor_module_loaded

(

void

)

Return the name of the vendor module the plugin loaded at startup.

Returns

the name of that vendor module upon success

NULL if the plugin failed to load the vendor module at startup

Definition at line 326 of file module_mgmt.c.

                                               {
 
    return s_module_so ? amxc_string_get(&s_module_name, 0) : NULL;
}

Here is the caller graph for this function:

mod_module_mgmt_cleanup()

void mod_module_mgmt_cleanup

(

void

)

Clean up the module_mgmt part of this plugin.

The function does the reverse of mod_module_mgmt_init():

• unload the vendor module
• unregisters the namespaces 'pon_stat' and 'pon_cfg'

The plugin must call this function once when stopping.

Definition at line 340 of file module_mgmt.c.

                                   {
 
    if(s_module_so) {
        if(amxm_so_close(&s_module_so)) {
            SAH_TRACEZ_ERROR(ME, "Failed to close module");
        }
    }
 
    if(s_pon_stat_module) {
        amxm_module_deregister(&s_pon_stat_module);
    }
    if(s_pon_cfg_module) {
        amxm_module_deregister(&s_pon_cfg_module);
    }
    amxc_string_clean(&s_module_name);
}

Here is the caller graph for this function:

mod_module_mgmt_init()

bool mod_module_mgmt_init

(

bool *

module_error

)

Initialize the module_mgmt part of this plugin.

The function:

• registers the namespaces 'pon_stat' and 'pon_cfg'. The namespaces have functions which can be called by the vendor module.
• loads the vendor module.

The plugin must call this function once at startup.

Parameters

[in,out]

module_error

the function sets it to true if it encounters an error regarding (the loading of) the vendor module

Returns

true on success, else false

Definition at line 299 of file module_mgmt.c.

                                              {
 
    amxc_string_init(&s_module_name, 0);
 
    if(!register_pon_stat_module()) {
        return false;
    }
 
    if(!register_pon_cfg_module()) {
        return false;
    }
 
    if(!load_vendor_module()) {
        if(module_error) {
            *module_error = true;
        }
        return false;
    }
    return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

register_pon_cfg_module()

static bool register_pon_cfg_module ( void  )

static

Definition at line 145 of file module_mgmt.c.

                                          {
 
    bool rv = false;
    amxm_shared_object_t* so = amxm_get_so("self");
    if(!so) {
        SAH_TRACEZ_ERROR(ME, "Failed to get amxm_shared_object_t for self");
        goto exit;
    }
 
    if(amxm_module_register(&s_pon_cfg_module, so, MOD_PON_CFG)) {
        SAH_TRACEZ_ERROR(ME, "Failed to register %s module namespace", MOD_PON_CFG);
        goto exit;
    }
 
    int i;
    for(i = 0; PON_CFG_FUNCTIONS[i].name != NULL; ++i) {
        if(amxm_module_add_function(s_pon_cfg_module, PON_CFG_FUNCTIONS[i].name,
                                    PON_CFG_FUNCTIONS[i].impl)) {
            SAH_TRACEZ_ERROR(ME, "Failed to register self.%s.%s()", MOD_PON_CFG,
                             PON_CFG_FUNCTIONS[i].name);
        }
    }
    rv = true;
 
exit:
    return rv;
}

Here is the caller graph for this function:

register_pon_stat_module()

static bool register_pon_stat_module ( void  )

static

Definition at line 117 of file module_mgmt.c.

                                           {
 
    bool rv = false;
    amxm_shared_object_t* so = amxm_get_so("self");
    if(!so) {
        SAH_TRACEZ_ERROR(ME, "Failed to get amxm_shared_object_t for self");
        goto exit;
    }
 
    if(amxm_module_register(&s_pon_stat_module, so, MOD_PON_STAT)) {
        SAH_TRACEZ_ERROR(ME, "Failed to register %s module namespace", MOD_PON_STAT);
        goto exit;
    }
 
    int i;
    for(i = 0; PON_STAT_FUNCTIONS[i].name != NULL; ++i) {
        if(amxm_module_add_function(s_pon_stat_module, PON_STAT_FUNCTIONS[i].name,
                                    PON_STAT_FUNCTIONS[i].impl)) {
            SAH_TRACEZ_ERROR(ME, "Failed to register self.%s.%s()", MOD_PON_STAT,
                             PON_STAT_FUNCTIONS[i].name);
        }
    }
    rv = true;
 
exit:
    return rv;
}

Here is the caller graph for this function:

Variable Documentation

MODULES_PATH

const char* const MODULES_PATH = "/usr/lib/amx/tr181-xpon/modules/"

static

Definition at line 86 of file module_mgmt.c.

PON_CFG_FUNCTIONS

const pon_stat_function_t PON_CFG_FUNCTIONS[]

static

Initial value:

= {
 
    { .name = "pon_cfg_get_param_value", .impl = pon_cfg_get_param_value },
    { .name = NULL, .impl = NULL } 
}

Definition at line 111 of file module_mgmt.c.

PON_STAT_FUNCTIONS

const pon_stat_function_t PON_STAT_FUNCTIONS[]

static

Initial value:

= {
 
    { .name = "dm_instance_added", .impl = dm_instance_added   },
    { .name = "dm_instance_removed", .impl = dm_instance_removed },
    { .name = "dm_object_changed", .impl = dm_object_changed   },
    { .name = "dm_add_or_change_instance", .impl = dm_add_or_change_instance },
    { .name = "omci_reset_mib", .impl = omci_reset_mib      },
    { .name = "watch_file_descriptor_start", .impl = watch_file_descriptor_start },
    { .name = "watch_file_descriptor_stop", .impl = watch_file_descriptor_stop },
    { .name = "dm_set_xpon_parameter", .impl = dm_set_xpon_parameter },
    { .name = NULL, .impl = NULL } 
}

Definition at line 98 of file module_mgmt.c.

s_module_name

amxc_string_t s_module_name

static

Definition at line 90 of file module_mgmt.c.

s_module_so

amxm_shared_object_t* s_module_so = NULL

static

Definition at line 91 of file module_mgmt.c.

s_pon_cfg_module

amxm_module_t* s_pon_cfg_module = NULL

static

Definition at line 89 of file module_mgmt.c.

s_pon_stat_module

amxm_module_t* s_pon_stat_module = NULL

static

Definition at line 88 of file module_mgmt.c.