data_model.c File Reference

#include "data_model.h"
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <amxc/amxc.h>
#include <amxp/amxp.h>
#include <amxd/amxd_object.h>
#include <amxd/amxd_transaction.h>
#include "ani.h"
#include "dm_actions.h"
#include "dm_info.h"
#include "dm_xpon_mngr.h"
#include "onu_priv.h"
#include "persistency.h"
#include "password.h"
#include "restore_to_hal.h"
#include "xpon_trace.h"

Go to the source code of this file.

Data Structures
struct	_dm_action_info

Macros
#define	ADD_INST_N_ARGS_REQUIRED   3
#define	REMOVE_INST_N_ARGS_REQUIRED   2
#define	CHANGE_OBJ_N_ARGS_REQUIRED   2
#define	ADD_OR_CHANGE_INST_N_ARGS_REQUIRED   2

Typedefs
typedef struct _dm_action_info	dm_action_info_t

Functions
static void	init_dm_action_info (dm_action_info_t *const info)
static amxd_object_t *	dm_get_xpon_object (void)
void	dm_set_vendor_module (const char *name)
void	dm_set_module_error (void)
static bool	get_ref_to_params (const amxc_var_t *const args, const amxc_var_t **params)
static bool	process_args_common (const amxc_var_t *const args, dm_action_info_t *info, const char **keys_required, int n_keys_required)
static bool	process_add_instance_args (const amxc_var_t *const args, dm_action_info_t *info)
static bool	prepare_adding_instance (const char *const path, uint32_t index, amxd_object_t **templ)
static bool	add_params_to_transaction (amxd_trans_t *transaction, const amxc_var_t *const params, object_id_t id)
static void	update_enable (amxd_trans_t *transaction, const char *const path, uint32_t index)
static void	add_private_data_to_onu (const char *const path, uint32_t index)
static bool	add_instance (const dm_action_info_t *const info)
static bool	process_remove_instance_args (const amxc_var_t *const args, dm_action_info_t *info)
static bool	remove_instance (const dm_action_info_t *const info)
int	dm_add_instance (const amxc_var_t *const args)
int	dm_remove_instance (const amxc_var_t *const args)
int	dm_change_object (const amxc_var_t *const args)
int	dm_add_or_change_instance_impl (const amxc_var_t *const args)
static bool	remove_all_instances (amxd_object_t *templ)
static void	set_ethernet_uni_status_to_down (const amxd_object_t *const onu_instance, const char *const path)
int	dm_omci_reset_mib (const amxc_var_t *const args)
int	dm_set_xpon_parameter_impl (const amxc_var_t *const args)
bool	dm_does_instance_exist (const char *const path, uint32_t index)
static uint32_t	get_nr_of_instances (const char *const path)
uint32_t	dm_get_nr_of_ethernet_uni_instances (const char *const onu_path)
uint32_t	dm_get_nr_of_ani_instances (const char *const onu_path)
bool	dm_get_param (const char *path, const char *name, amxc_var_t *resp)
bool	dm_is_hex_password (const char *const ani_path, bool *is_hex)
bool	dm_get_ani_pon_mode (const char *const ani_path, pon_mode_t *pon_mode)

Variables
static const char *	ADD_INST_PARAMS_REQUIRED [3]
static const char *	REMOVE_INST_ARGS_REQUIRED [2]
static const char *	CHANGE_OBJ_ARGS_REQUIRED [2]
static const char *	ADD_OR_CHANGE_INST_ARGS_REQUIRED [2]

Macro Definition Documentation

ADD_INST_N_ARGS_REQUIRED

#define ADD_INST_N_ARGS_REQUIRED   3

Include amxp.h to include amxp_signal.h, which defines amxp_signal_mngr_t. amxd_object.h and amxd_transaction.h need it: they include amxd_types.h, which uses amxp_signal_mngr_t.

Definition at line 94 of file data_model.c.

ADD_OR_CHANGE_INST_N_ARGS_REQUIRED

#define ADD_OR_CHANGE_INST_N_ARGS_REQUIRED   2

Definition at line 109 of file data_model.c.

CHANGE_OBJ_N_ARGS_REQUIRED

#define CHANGE_OBJ_N_ARGS_REQUIRED   2

Definition at line 104 of file data_model.c.

REMOVE_INST_N_ARGS_REQUIRED

#define REMOVE_INST_N_ARGS_REQUIRED   2

Definition at line 99 of file data_model.c.

Typedef Documentation

dm_action_info_t

typedef struct _dm_action_info dm_action_info_t

Info related to actions done on the DM.

The actions are:

• add an instance
• remove an instance
• update/change an object

Meaning of the fields:

• path: object path of a singleton or template object
• index: instance index for the instance of a template object. 0 if not applicable.
• obj_id: object ID (derived from 'path' with dm_get_object_id())
• key_value: for an instance of a template object, it is the value of the unique key for that instance. The variant normally has a string or an uint32_t.
• params: values for the params of the object

Function Documentation

add_instance()

static bool add_instance ( const dm_action_info_t *const  info )

static

Add an instance to the XPON DM.

Parameters

[in]

info

all the info needed to create the instance

If the instance to be created has a read-write Enable parameter, and if that instance is enabled according to the persistent data, create the instance with that Enable parameter set to true, and schedule a timer to let this know to the vendor module in 100 ms.

If the instance created is an ONU instance, create and attach private data to the instance to indicate the persistency of the RW Enable parameter has been handled. The ANI also a has RW Enable parameter. The approach with the private data is only done for an ONU because the PON vendor modules create an ONU instance in 2 different ways:

• via this add_instance() call: then this add_instance() call attaches the private data to the ONU instance. If dm_change_object() is called afterwards, it notices the private data is already present, and then it knows this process already checked if it should enable the ONU according to the persistent data.
• via defaults.odl file: then add_instance() is not triggered, but dm_change_object() is. dm_change_object() will see that there is no private data attached to the ONU. Then that function will attach the private data and check if it should enable the ONU.

If the instance created is an ANI instance, restore its PON password if there is one.

Returns

true on success, else false

Definition at line 589 of file data_model.c.

                                                             {
 
    bool rv = false;
    amxd_object_t* templ = NULL;
 
    SAH_TRACEZ_INFO(ME, "Create %s.%d", info->path, info->index);
 
    const object_info_t* const obj_info = dm_get_object_info(info->obj_id);
    when_null_trace(obj_info, exit_no_cleanup, ERROR,
                    "obj_info is NULL for obj_id=%d", info->obj_id);
 
    if(!prepare_adding_instance(info->path, info->index, &templ)) {
        return false;
    }
 
    amxd_dm_t* const dm = xpon_mngr_get_dm();
    when_null(dm, exit_no_cleanup);
 
    amxd_trans_t transaction;
    amxd_trans_init(&transaction);
    amxd_trans_set_attr(&transaction, amxd_tattr_change_ro, true);
 
    const char* const key_name = obj_info->key_name; /* alias */
 
    amxd_status_t rc = amxd_trans_select_object(&transaction, templ);
    when_failed_trace(rc, exit, ERROR, "Failed to select %s for transaction (rc=%d)",
                      info->path, rc);
 
    rc = amxd_trans_add_inst(&transaction, info->index, NULL);
    when_failed_trace(rc, exit, ERROR,
                      "Failed to add creation of %s.%d to transaction (rc=%d)",
                      info->path, info->index, rc);
 
    rc = amxd_trans_set_param(&transaction, key_name, info->key_value);
    when_failed_trace(rc, exit, ERROR,
                      "Failed to add value for key to transaction (rc=%d)", rc);
 
    if(info->params) {
        add_params_to_transaction(&transaction, info->params, info->obj_id);
    }
 
    if(obj_info->has_rw_enable) {
        update_enable(&transaction, info->path, info->index);
    }
 
    rc = amxd_trans_apply(&transaction, dm);
    when_failed_trace(rc, exit, ERROR, "Failed to create %s.%d (rc=%d)",
                      info->path, info->index, rc);
 
    SAH_TRACEZ_DEBUG(ME, "Created %s.%d", info->path, info->index);
 
    if(obj_info->id == obj_id_onu) {
        add_private_data_to_onu(info->path, info->index);
    } else if(obj_info->id == obj_id_ani) {
        amxc_string_t ani_instance;
        amxc_string_init(&ani_instance, 0);
        amxc_string_setf(&ani_instance, "%s.%d", info->path, info->index);
        passwd_restore_password(amxc_string_get(&ani_instance, 0));
        amxc_string_clean(&ani_instance);
    }
 
    rv = true;
 
exit:
    amxd_trans_clean(&transaction);
 
exit_no_cleanup:
    return rv;
}

Here is the call graph for this function:

Here is the caller graph for this function:

add_params_to_transaction()

static bool add_params_to_transaction ( amxd_trans_t *  transaction, const amxc_var_t *const  params, object_id_t  id  )

static

Add set value actions to a transaction to set params of an object.

Parameters

[in,out]	transaction	transaction to add set value actions to
[in]	params	htable with values for one or more params of an object
[in]	id	object ID

The function iterates over all elements in params. It adds a set value action to transaction for each known element.

Returns

true on success, else false

Definition at line 430 of file data_model.c.

                                                      {
    bool rv = false;
 
    const amxc_htable_t* const params_table = amxc_var_constcast(amxc_htable_t, params);
    when_null(params_table, exit);
 
    const object_info_t* const obj_info = dm_get_object_info(id);
    when_null(obj_info, exit);
 
    const param_info_t* param_info;
    const param_info_t* single_param;
    uint32_t n_params;
 
    if(!dm_get_object_param_info(id, &param_info, &n_params)) {
        SAH_TRACEZ_ERROR(ME, "%s: failed to get info about its params", obj_info->name);
        goto exit;
    }
 
    amxc_var_t* param_value = NULL;
    uint32_t i;
    const char* key;
 
    amxc_htable_for_each(it, params_table) {
        single_param = NULL;
        key = amxc_htable_it_get_key(it);
        if(!key) {
            continue;
        }
        for(i = 0; i < n_params; ++i) {
            if((strncmp(key, param_info[i].name, strlen(key)) == 0) &&
               (strlen(key) == strlen(param_info[i].name))) {
                single_param = &param_info[i];
                break; /* out of for loop */
            }
        }
        if(NULL == single_param) {
            SAH_TRACEZ_WARNING(ME, "%s: unknown param name: %s", obj_info->name, key);
            continue;
        }
        param_value = GET_ARG(params, key);
        if(NULL == param_value) {
            SAH_TRACEZ_ERROR(ME, "%s: failed to get value for %s", obj_info->name, key);
            continue;
        }
        if(amxc_var_type_of(param_value) != single_param->type) {
            SAH_TRACEZ_ERROR(ME, "%s: type of parameter %s: %d != expected=%d",
                             obj_info->name, key, amxc_var_type_of(param_value),
                             single_param->type);
            continue;
        }
        if(amxd_trans_set_param(transaction, key, param_value)) {
            SAH_TRACEZ_ERROR(ME, "%s: failed to add value for %s to transaction",
                             obj_info->name, key);
        } else {
            SAH_TRACEZ_DEBUG(ME, "%s: added value for %s to transaction",
                             obj_info->name, key);
        }
    }
    rv = true;
 
exit:
    return rv;
}

Here is the call graph for this function:

Here is the caller graph for this function:

add_private_data_to_onu()

static void add_private_data_to_onu ( const char *const  path, uint32_t  index  )

static

Create and attach private data to the ONU instance.

Parameters

[in]	path	path of the XPON.ONU template. This must be "XPON.ONU".
[in]	index	index of the ONU instance

Definition at line 538 of file data_model.c.

                                                                            {
 
    SAH_TRACEZ_DEBUG(ME, "%s.%d", path, index);
 
    amxd_dm_t* const dm = xpon_mngr_get_dm();
    when_null(dm, exit);
 
    amxd_object_t* templ = amxd_dm_findf(dm, "%s", path);
    when_null_trace(templ, exit, ERROR, "Failed to find %s", path);
 
    amxd_object_t* const obj = amxd_object_get_instance(templ, NULL, index);
    when_null_trace(obj, exit, ERROR, "Instance %s.%d does not exist", path, index);
 
    onu_priv_attach_private_data(obj);
 
exit:
    return;
}

Here is the call graph for this function:

Here is the caller graph for this function:

dm_add_instance()

int dm_add_instance

(

const amxc_var_t *const

args

)

Add an instance to the XPON DM.

Parameters

[in]

args

: must be htable with the keys 'path', 'index' and 'keys'. The htable normally also has an entry with the key 'parameters'.

Returns

0 on success, else -1.

Definition at line 762 of file data_model.c.

                                                  {
 
    int rc = -1;
    dm_action_info_t info;
 
    SAH_TRACEZ_DEBUG2(ME, "called");
 
    if(!process_add_instance_args(args, &info)) {
        goto exit;
    }
    if(!add_instance(&info)) {
        goto exit;
    }
 
    rc = 0;
exit:
    return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

dm_add_or_change_instance_impl()

int dm_add_or_change_instance_impl

(

const amxc_var_t *const

args

)

Add or update an instance in the XPON DM.

Parameters

[in]

args

: must be htable with the keys 'path' and 'index'. It must also have the key 'keys' if the instance does not yet exist, else it must have the key 'parameters'. It's recommended that 'args' has all those 4 keys. See below for more info.

The function checks if the instance exists. If the instance does not exist, the function calls 'dm_add_instance()', else it calls 'dm_change_object()'.

More info about the parameter args: The path in args must be the template path, e.g. "XPON.ONU.1.SoftwareImage".

If the function finds out the instance does not exist yet, it demands the same from args as dm_instance_added(): it must be an htable with the keys 'path', 'index' and 'keys'.

If the function finds out the instance already exists, it demands the same from args as dm_object_changed(): it must be an htable with the keys 'path' and 'parameters'. If dm_object_changed() sees that args has a value for 'index', it assumes the caller wants to change path.index, not path.

Hence when calling this function, it's recommended args is htable with the keys 'path', 'index', 'keys' and 'parameters'. Then the function finds the required keys, independent from whether the instance already exists or not.

Returns

0 on success, else -1.

Definition at line 922 of file data_model.c.

                                                                 {
 
    int rc = -1;
 
    SAH_TRACEZ_DEBUG2(ME, "called");
 
    amxd_dm_t* const dm = xpon_mngr_get_dm();
    when_null(dm, exit);
 
    dm_action_info_t info;
    if(!process_args_common(args, &info, ADD_OR_CHANGE_INST_ARGS_REQUIRED,
                            ADD_OR_CHANGE_INST_N_ARGS_REQUIRED)) {
        goto exit;
    }
 
    if(dm_does_instance_exist(info.path, info.index)) {
        SAH_TRACEZ_DEBUG(ME, "Change %s.%d", info.path, info.index);
        return dm_change_object(args);
    } else {
        SAH_TRACEZ_DEBUG(ME, "Add %s.%d", info.path, info.index);
        return dm_add_instance(args);
    }
 
exit:
    return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

dm_change_object()

int dm_change_object

(

const amxc_var_t *const

args

)

Update one of more params of an object in the XPON DM.

Parameters

[in]

args

: must be htable with the keys 'path' and 'parameters'. If it has a non-zero value for 'index', the function assumes the caller wants to update the instance 'path'.'index'.

If the object is an ONU instance, check if the instance has private data. If it doesn't, attach private data, and call update_enable() for that instance. If the ONU instance has no private data yet, this process did not check yet the persistent data to find out if the ONU instance should be enabled.

Returns

0 on success, else -1.

Definition at line 821 of file data_model.c.

                                                   {
 
    int rc = -1;
 
    SAH_TRACEZ_DEBUG2(ME, "called");
 
    amxd_dm_t* const dm = xpon_mngr_get_dm();
    when_null(dm, exit);
 
    dm_action_info_t info;
    if(!process_args_common(args, &info, CHANGE_OBJ_ARGS_REQUIRED,
                            CHANGE_OBJ_N_ARGS_REQUIRED)) {
        goto exit;
    }
 
    amxc_string_t path;
    amxc_string_init(&path, 0);
    amxc_string_set(&path, info.path);
 
    SAH_TRACEZ_DEBUG(ME, "path='%s' index=%d", info.path, info.index);
 
    if(info.index) {
        /* Assume caller wants to update 'path'.'index' */
        amxc_string_appendf(&path, ".%d", info.index);
    }
    const char* const path_cstr = amxc_string_get(&path, 0);
 
    amxd_object_t* object = amxd_dm_findf(dm, "%s", path_cstr);
    if(!object) {
        SAH_TRACEZ_WARNING(ME, "%s does not exist: ignore object-changed", path_cstr);
        amxc_string_clean(&path);
        rc = 0;
        goto exit;
    }
 
    amxd_trans_t transaction;
    amxd_trans_init(&transaction);
    amxd_trans_set_attr(&transaction, amxd_tattr_change_ro, true);
 
    amxd_status_t status = amxd_trans_select_object(&transaction, object);
    when_failed_trace(status, exit_cleanup, ERROR,
                      "Failed to select %s for transaction (status=%d)",
                      info.path, status);
 
    add_params_to_transaction(&transaction, info.params, info.obj_id);
 
    if(info.obj_id == obj_id_onu) {
        if(object->priv == NULL) {
            SAH_TRACEZ_DEBUG(ME, "%s has no private data", path_cstr);
            onu_priv_attach_private_data(object);
            update_enable(&transaction, info.path, info.index);
        } else {
            SAH_TRACEZ_DEBUG(ME, "%s already has private data", path_cstr);
        }
    }
 
    status = amxd_trans_apply(&transaction, dm);
    when_failed_trace(status, exit_cleanup, ERROR, "Failed to update %s (status=%d)",
                      info.path, status);
 
    rc = 0;
 
exit_cleanup:
    amxc_string_clean(&path);
    amxd_trans_clean(&transaction);
exit:
    return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

dm_does_instance_exist()

bool dm_does_instance_exist	(	const char *const	path,
		uint32_t	index
	)

Return true if a certain instance of a template object exists.

Parameters

[in]	path	object path, e.g., "XPON.ONU"
[in]	index	the instance index, e.g., 1

Returns

true if instance exists, else false

Definition at line 1141 of file data_model.c.

                                                                    {
 
    bool rv = false;
    amxd_dm_t* const dm = xpon_mngr_get_dm();
    when_null(dm, exit);
 
    const amxd_object_t* const templ = amxd_dm_findf(dm, "%s", path);
    if(!templ) {
        goto exit;
    }
 
    if(amxd_object_get_instance(templ, NULL, index)) {
        rv = true;
    }
 
exit:
    return rv;
}

Here is the call graph for this function:

Here is the caller graph for this function:

dm_get_ani_pon_mode()

bool dm_get_ani_pon_mode	(	const char *const	ani_path,
		pon_mode_t *	pon_mode
	)

Find out the PON Mode of an ANI.

Parameters

[in]	ani_path	path to ANI instance, e.g. "XPON.ONU.1.ANI.1"
[in,out]	pon_mode	function sets this to the PON mode of the ANI referred to by ani_path

Returns

true on success, else false

Definition at line 1280 of file data_model.c.

                                                                           {
 
    bool rv = false;
    amxc_var_t pon_mode_var;
    amxc_var_init(&pon_mode_var);
 
    amxd_dm_t* const dm = xpon_mngr_get_dm();
    when_null(dm, exit);
    when_null(pon_mode, exit);
 
    amxd_object_t* const object = amxd_dm_findf(dm, "%s", ani_path);
    when_null_trace(object, exit, WARNING, "%s does not exist", ani_path);
 
    if(amxd_status_ok != amxd_object_get_param(object, "PONMode",
                                               &pon_mode_var)) {
        SAH_TRACEZ_ERROR(ME, "Failed to get %s.PONMode", ani_path);
        goto exit;
    }
 
    const char* const pon_mode_cstr = amxc_var_constcast(cstring_t, &pon_mode_var);
    if(strncmp(pon_mode_cstr, "Unknown", 7) == 0) {
        *pon_mode = pon_mode_unknown;
    } else if(strncmp(pon_mode_cstr, "G-PON", 5) == 0) {
        *pon_mode = pon_mode_gpon;
    } else if(strncmp(pon_mode_cstr, "XG-PON", 6) == 0) {
        *pon_mode = pon_mode_xg_pon;
    } else if(strncmp(pon_mode_cstr, "NG-PON2", 7) == 0) {
        *pon_mode = pon_mode_ng_pon2;
    } else if(strncmp(pon_mode_cstr, "XGS-PON", 7) == 0) {
        *pon_mode = pon_mode_xgs_pon;
    } else {
        SAH_TRACEZ_ERROR(ME, "Invalid PON mode: %s", pon_mode_cstr);
        *pon_mode = pon_mode_unknown;
        goto exit;
    }
 
    rv = true;
 
exit:
    amxc_var_clean(&pon_mode_var);
    return rv;
}

Here is the call graph for this function:

Here is the caller graph for this function:

dm_get_nr_of_ani_instances()

uint32_t dm_get_nr_of_ani_instances

(

const char *const

onu_path

)

Return the number of ANI instances for a certain XPON.ONU instance.

Parameters

[in]

path

path of a certain XPON.ONU instance, e.g. "XPON.ONU.1"

Definition at line 1198 of file data_model.c.

                                                                {
    char path[64];
    snprintf(path, 64, "%s.ANI", onu_path);
    return get_nr_of_instances(path);
}

Here is the call graph for this function:

Here is the caller graph for this function:

dm_get_nr_of_ethernet_uni_instances()

uint32_t dm_get_nr_of_ethernet_uni_instances

(

const char *const

onu_path

)

Return the number of EthernetUNI instances for a certain XPON.ONU instance.

Parameters

[in]

path

path of a certain XPON.ONU instance, e.g. "XPON.ONU.1"

Definition at line 1187 of file data_model.c.

                                                                         {
    char path[64];
    snprintf(path, 64, "%s.EthernetUNI", onu_path);
    return get_nr_of_instances(path);
}

Here is the call graph for this function:

Here is the caller graph for this function:

dm_get_param()

bool dm_get_param	(	const char *	path,
		const char *	name,
		amxc_var_t *	resp
	)

Definition at line 1204 of file data_model.c.

                                                                        {
    SAH_TRACEZ_DEBUG(ME, "get value of dm parameter path=%s.%s", path, name);
 
    amxd_dm_t* const dm = xpon_mngr_get_dm();
    when_null(dm, exit);
 
    amxd_object_t* const param_object = amxd_dm_findf(dm, "%s", path);
    if(!param_object) {
        SAH_TRACEZ_WARNING(ME, "%s does not exist!", path);
        goto exit;
    }
 
    if(amxd_status_ok != amxd_object_get_param(param_object, name, resp)) {
        SAH_TRACEZ_WARNING(ME, "Failed to get param from object: %s.%s", path, name);
        goto exit;
    }
 
    return true;
exit:
    return false;
}

Here is the call graph for this function:

Here is the caller graph for this function:

dm_get_xpon_object()

static amxd_object_t* dm_get_xpon_object ( void  )

static

Return the "XPON" object from the XPON DM.

Definition at line 153 of file data_model.c.

                                               {
 
    amxd_dm_t* const dm = xpon_mngr_get_dm();
    if(!dm) {
        SAH_TRACEZ_ERROR(ME, "Failed to get DM");
        return NULL;
    }
 
 
    amxd_object_t* xpon = amxd_dm_get_object(dm, "XPON");
    if(!xpon) {
        SAH_TRACEZ_ERROR(ME, "Failed to get XPON object");
        return NULL;
    }
    return xpon;
}

Here is the call graph for this function:

Here is the caller graph for this function:

dm_is_hex_password()

bool dm_is_hex_password	(	const char *const	ani_path,
		bool *	is_hex
	)

Find out if password for an ANI instance is in hex format or not.

Parameters

[in]	ani_path	path to ANI instance, e.g. "XPON.ONU.1.ANI.1"
[in,out]	is_hex	function sets this to true if the parameter 'HexadecimalPassword' of the ANI instance referred to by ani_path is true

Returns

true on success, else false

Definition at line 1236 of file data_model.c.

                                                                  {
 
    bool rv = false;
    amxc_var_t is_hex_variant;
    amxc_string_t ani_auth_path;
    amxc_var_init(&is_hex_variant);
    amxc_string_init(&ani_auth_path, 0);
 
    amxd_dm_t* const dm = xpon_mngr_get_dm();
    when_null(dm, exit);
    when_null(is_hex, exit);
 
    ani_append_tc_authentication(ani_path, &ani_auth_path);
    const char* const ani_auth_path_cstr = amxc_string_get(&ani_auth_path, 0);
 
    amxd_object_t* const object = amxd_dm_findf(dm, "%s", ani_auth_path_cstr);
    when_null_trace(object, exit, WARNING, "%s does not exist",
                    ani_auth_path_cstr);
 
    if(amxd_status_ok != amxd_object_get_param(object, "HexadecimalPassword",
                                               &is_hex_variant)) {
        SAH_TRACEZ_ERROR(ME, "Failed to get %s.HexadecimalPassword",
                         ani_auth_path_cstr);
        goto exit;
    }
 
    *is_hex = amxc_var_constcast(bool, &is_hex_variant);
    rv = true;
 
exit:
    amxc_var_clean(&is_hex_variant);
    amxc_string_clean(&ani_auth_path);
    return rv;
}

Here is the call graph for this function:

Here is the caller graph for this function:

dm_omci_reset_mib()

int dm_omci_reset_mib

(

const amxc_var_t *const

args

)

Handle an OMCI reset MIB message.

Parameters

[in]

args

: must be htable with the key 'index'. The 'index' must indicate for which XPON.ONU instance an OMCI reset MIB is received

The function does the following:

• For all EthernetUNI instances of the ONU, set Status to Down if it is Up now.
• For all ANI instances of the ONU, remove all TC.GEM.Port instances.

Returns

0 on success, else -1

Definition at line 1049 of file data_model.c.

                                                    {
 
    int rc = -1;
 
    SAH_TRACEZ_DEBUG2(ME, "called");
 
    when_null_trace(args, exit, ERROR, "args is NULL");
 
    amxd_dm_t* const dm = xpon_mngr_get_dm();
    when_null(dm, exit);
 
    const uint32_t index = GET_UINT32(args, "index");
    when_false_trace(index != 0, exit, ERROR, "Failed to extract valid index from args");
 
    char path[16];
    snprintf(path, 16, "XPON.ONU.%d", index);
    const amxd_object_t* onu_instance = amxd_dm_findf(dm, "%s", path);
    if(!onu_instance) {
        SAH_TRACEZ_WARNING(ME, "%s does not exist: ignore omci:reset-mib", path);
        rc = 0;
        goto exit;
    }
 
    set_ethernet_uni_status_to_down(onu_instance, path);
 
    /* Remove GEM ports */
    const amxd_object_t* ani = amxd_object_get_child(onu_instance, "ANI");
    if(ani) {
        amxd_object_iterate(instance, it, ani) {
            amxd_object_t* const ani_inst = amxc_container_of(it, amxd_object_t, it);
            amxd_object_t* const port_templ = amxd_object_findf(ani_inst, "TC.GEM.Port");
            if(!port_templ) {
                SAH_TRACEZ_ERROR(ME, "%s: failed to find TC.GEM.Port for ANI.%d",
                                 path, amxd_object_get_index(ani_inst));
                continue;
            }
            if(!remove_all_instances(port_templ)) {
                SAH_TRACEZ_ERROR(ME, "%s: failed to delete GEM ports for ANI.%d",
                                 path, amxd_object_get_index(ani_inst));
            }
        }
    } else {
        SAH_TRACEZ_ERROR(ME, "%s.ANI does not exist", path);
    }
 
    rc = 0;
exit:
    return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

dm_remove_instance()

int dm_remove_instance

(

const amxc_var_t *const

args

)

Remove an instance from the XPON DM.

Parameters

[in]

args

: must be htable with the keys 'path' and 'index'

Returns

0 on success, else -1.

Definition at line 788 of file data_model.c.

                                                     {
 
    int rc = -1;
    dm_action_info_t info;
 
    SAH_TRACEZ_DEBUG2(ME, "called");
 
    if(!process_remove_instance_args(args, &info)) {
        goto exit;
    }
    if(!remove_instance(&info)) {
        goto exit;
    }
 
    rc = 0;
exit:
    return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

dm_set_module_error()

void dm_set_module_error

(

void

)

Set XPON.ModuleError to true.

Definition at line 192 of file data_model.c.

                               {
 
    amxd_object_t* xpon = dm_get_xpon_object();
    when_null(xpon, exit);
    if(amxd_object_set_value(bool, xpon, "ModuleError", true)) {
        SAH_TRACEZ_ERROR(ME, "Failed to set XPON.ModuleError to true");
    }
exit:
    return;
}

Here is the call graph for this function:

Here is the caller graph for this function:

dm_set_vendor_module()

void dm_set_vendor_module

(

const char *

name

)

Set XPON.ModuleName to name.

Parameters

[in]

name

name of the vendor module, e.g. "mod-xpon-prpl".

The component should call this function once at startup, after determining which vendor module it should load.

Definition at line 178 of file data_model.c.

                                            {
 
    amxd_object_t* xpon = dm_get_xpon_object();
    when_null(xpon, exit);
    if(amxd_object_set_value(cstring_t, xpon, "ModuleName", name)) {
        SAH_TRACEZ_ERROR(ME, "Failed to update XPON.ModuleName");
    }
exit:
    return;
}

Here is the call graph for this function:

Here is the caller graph for this function:

dm_set_xpon_parameter_impl()

int dm_set_xpon_parameter_impl

(

const amxc_var_t *const

args

)

Update a parameter of the XPON object.

Parameters

[in]

args

must be htable with the keys 'name' and 'value'.

Returns

0 on success, else -1

Definition at line 1106 of file data_model.c.

                                                             {
    int rc = -1;
    amxd_object_t* const xpon = dm_get_xpon_object();
    when_null(xpon, exit);
 
    const amxc_htable_t* const htable = amxc_var_constcast(amxc_htable_t, args);
    when_null_trace(htable, exit, ERROR, "args is not an htable");
 
    const char* const name = GET_CHAR(args, "name");
    when_null_trace(name, exit, ERROR, "Failed to get name");
 
    if(strncmp(name, "FsmState", 8) != 0) {
        SAH_TRACEZ_WARNING(ME, "dm_set_xpon_parameter() only supports XPON.FsmState");
        goto exit;
    }
 
    amxc_var_t* const value = GET_ARG(args, "value");
    when_null_trace(value, exit, ERROR, "Failed to get value");
 
    const amxd_status_t status = amxd_object_set_param(xpon, name, value);
    when_true_trace(status != amxd_status_ok, exit, ERROR,
                    "Failed to update %s: status=%d", name, status);
    rc = 0;
exit:
    return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

get_nr_of_instances()

static uint32_t get_nr_of_instances ( const char *const  path )

static

Return the number of instances of a template object.

Parameters

[in]

path

path of a template object, e.g., "XPON.ONU" or "XPON.ONU.1.ANI"

Definition at line 1166 of file data_model.c.

                                                            {
 
    uint32_t result = 0;
 
    amxd_dm_t* const dm = xpon_mngr_get_dm();
    when_null(dm, exit);
 
    const amxd_object_t* const object = amxd_dm_findf(dm, "%s", path);
    when_null_trace(object, exit, ERROR, "%s not found", path);
 
    result = amxd_object_get_instance_count(object);
 
exit:
    return result;
}

Here is the call graph for this function:

Here is the caller graph for this function:

get_ref_to_params()

static bool get_ref_to_params ( const amxc_var_t *const  args, const amxc_var_t **  params  )

static

Definition at line 203 of file data_model.c.

                                                         {
    bool rv = false;
 
    const amxc_var_t* const params_var =
        amxc_var_get_key(args, "parameters", AMXC_VAR_FLAG_DEFAULT);
    when_null_trace(params_var, exit, ERROR, "Failed to get 'parameters' from 'args'");
 
    const uint32_t params_type = amxc_var_type_of(params_var);
    when_false_trace(AMXC_VAR_ID_HTABLE == params_type, exit, ERROR,
                     "Type of 'parameters' = %d != htable", params_type);
 
    *params = params_var;
 
    rv = true;
exit:
    return rv;
}

Here is the caller graph for this function:

init_dm_action_info()

static void init_dm_action_info ( dm_action_info_t *const  info )

static

Definition at line 141 of file data_model.c.

                                                              {
 
    info->path = NULL;
    info->index = 0;
    info->obj_id = obj_id_unknown;
    info->key_value = NULL;
    info->params = NULL;
}

Here is the caller graph for this function:

prepare_adding_instance()

static bool prepare_adding_instance ( const char *const  path, uint32_t  index, amxd_object_t **  templ  )

static

Prepare adding an instance to the XPON DM.

Parameters

[in]	path	object path of a template object, e.g. "XPON.ONU"
[in]	index	index of instance to be added
[in,out]	templ	function assigns pointer to template object if instance does not yet exist

Returns

true on success and if instance does not yet exist, else false

Definition at line 389 of file data_model.c.

                                                           {
 
    bool rv = false;
    when_null(path, exit);
    when_null(templ, exit);
 
    amxd_dm_t* const dm = xpon_mngr_get_dm();
    when_null(dm, exit);
 
    amxd_object_t* templ_candidate = amxd_dm_findf(dm, "%s", path);
    when_null_trace(templ_candidate, exit, ERROR, "%s does not exist", path);
 
    const amxd_object_type_t type = amxd_object_get_type(templ_candidate);
    when_false_trace(amxd_object_template == type, exit, ERROR,
                     "%s is not a template object", path);
 
    if(amxd_object_get_instance(templ_candidate, NULL, index) != NULL) {
        SAH_TRACEZ_ERROR(ME, "%s.%d already exists", path, index);
        goto exit;
    }
 
    *templ = templ_candidate;
    rv = true;
 
exit:
    return rv;
}

Here is the call graph for this function:

Here is the caller graph for this function:

process_add_instance_args()

static bool process_add_instance_args ( const amxc_var_t *const  args, dm_action_info_t *  info  )

static

Process the arguments of dm_add_instance() function call.

Parameters

[in]	args	must be htable with keys specified by ADD_INST_PARAMS_REQUIRED. The htable normally also has an entry with the key 'parameters'.
[in,out]	info	the function extracts info from args and assigns it to the fields of this parameter

It calls process_args_common() with args = ADD_INST_PARAMS_REQUIRED.

In addition it extracts the key value from args and assigns it info->key_value.

Returns

true on success, else false

Definition at line 326 of file data_model.c.

                                                              {
 
    bool rv = false;
    SAH_TRACEZ_DEBUG2(ME, "called");
 
    if(!process_args_common(args, info, ADD_INST_PARAMS_REQUIRED,
                            ADD_INST_N_ARGS_REQUIRED)) {
        goto exit;
    }
 
    const object_id_t obj_id = info->obj_id;
    const object_info_t* const obj_info = dm_get_object_info(obj_id);
    when_null_trace(obj_info, exit, ERROR, "obj_info is NULL for obj_id=%d", obj_id);
 
    const char* key_name = obj_info->key_name; /* alias */
 
    const amxc_var_t* const keys_var = amxc_var_get_key(args, "keys", AMXC_VAR_FLAG_DEFAULT);
    when_null_trace(keys_var, exit, ERROR, "%s.%d: failed to get 'keys' from args",
                    info->path, info->index);
 
    if(amxc_var_type_of(keys_var) != AMXC_VAR_ID_HTABLE) {
        SAH_TRACEZ_ERROR(ME, "%s.%d: variant 'keys' is not an htable",
                         info->path, info->index);
        goto exit;
    }
    amxc_var_t* key_value =
        amxc_var_get_key(keys_var, key_name, AMXC_VAR_FLAG_DEFAULT);
    when_null_trace(key_value, exit, ERROR, "%s.%d: failed to get value for key='%s'",
                    info->path, info->index, key_name);
 
    /* If the key name is "Name", its value is of type string, else its value
     * is of type uint32_t. */
    const bool key_is_uint32 =
        strncmp(key_name, NAME_PARAM, NAME_PARAM_LEN) != 0;
 
    if(key_is_uint32) {
        const uint32_t key_uint32 = amxc_var_constcast(uint32_t, key_value);
        if(key_uint32 > obj_info->key_max_value) {
            SAH_TRACEZ_ERROR(ME, "%s.%d: key: %s: value=%d > max=%d",
                             info->path, info->index, key_name, key_uint32,
                             obj_info->key_max_value);
            goto exit;
        }
    }
 
    info->key_value = key_value;
 
    rv = true;
exit:
    return rv;
}

Here is the call graph for this function:

Here is the caller graph for this function:

process_args_common()

static bool process_args_common ( const amxc_var_t *const  args, dm_action_info_t *  info, const char **  keys_required, int  n_keys_required  )

static

Process the arguments of a function implemented in this file.

Parameters

[in]	args	must be htable with keys specified by keys_required
[in,out]	info	the function extracts info from args and assigns it to the fields of this parameter
[in]	keys_required	list of keys which must be present in args
[in]	n_keys_required	number of elements in keys_required

args must always have an entry with key 'path'. The function assigns its value to info->path. It derives the object ID from the path with dm_get_object_id() and assigns it to info->obj_id.

If args contains entries with the key 'index' and/or 'parameters', the function assigns their values to info->index and info->params respectively.

The function returns false if one of the keys specified in keys_required does not occur in args.

Returns

true on success, else false

Definition at line 244 of file data_model.c.

                                                     {
    bool rv = false;
    uint32_t index = 0;
    const amxc_var_t* params = NULL;
 
    SAH_TRACEZ_DEBUG2(ME, "called");
 
    when_null_trace(args, exit, ERROR, "args is NULL");
 
#ifdef _DEBUG_
    printf("tr181-xpon: process_args_common(): dump(args):\n");
    amxc_var_dump(args, STDOUT_FILENO);
#endif
 
    init_dm_action_info(info);
 
    const amxc_htable_t* const htable = amxc_var_constcast(amxc_htable_t, args);
    when_null_trace(htable, exit, ERROR, "args is not an htable");
 
    int i;
    for(i = 0; i < n_keys_required; ++i) {
        if(!amxc_htable_contains(htable, keys_required[i])) {
            SAH_TRACEZ_ERROR(ME, "args does not contain key '%s'", keys_required[i]);
            goto exit;
        }
        if((index == 0) && (strncmp(keys_required[i], "index", 5) == 0)) {
            index = GET_UINT32(args, "index");
            if(0 == index) {
                SAH_TRACEZ_ERROR(ME, "Failed to get valid index");
                goto exit;
            }
        }
    }
 
    const char* const path = GET_CHAR(args, "path");
    when_null_trace(path, exit, ERROR, "Failed to get path");
 
    const object_id_t obj_id = dm_get_object_id(path);
    when_false_trace(obj_id_unknown != obj_id, exit, ERROR,
                     "path='%s': failed to get ID", path);
 
    /* Get 'index' if it's in 'args' even it's not required */
    if((index == 0) && amxc_htable_contains(htable, "index")) {
        index = GET_UINT32(args, "index");
        if(0 == index) {
            SAH_TRACEZ_ERROR(ME, "Failed to get valid index");
        }
    }
 
    info->path = path;
    info->index = index;
    info->obj_id = obj_id;
 
    if(amxc_htable_contains(htable, "parameters")) {
        if(get_ref_to_params(args, &params)) {
            info->params = params;
        }
    }
    rv = true;
exit:
    return rv;
}

Here is the call graph for this function:

Here is the caller graph for this function:

process_remove_instance_args()

static bool process_remove_instance_args ( const amxc_var_t *const  args, dm_action_info_t *  info  )

static

Process the arguments of dm_remove_instance() function call.

Parameters

[in]	args	must be htable with keys specified by REMOVE_INST_ARGS_REQUIRED
[in,out]	info	the function extracts info from args and assigns it to the fields of this parameter

Returns

true on success, else false

Definition at line 669 of file data_model.c.

                                                                 {
 
    bool rv = false;
    SAH_TRACEZ_DEBUG2(ME, "called");
 
    if(!process_args_common(args, info, REMOVE_INST_ARGS_REQUIRED,
                            REMOVE_INST_N_ARGS_REQUIRED)) {
        goto exit;
    }
 
    rv = true;
 
exit:
    return rv;
}

Here is the call graph for this function:

Here is the caller graph for this function:

remove_all_instances()

static bool remove_all_instances ( amxd_object_t *  templ )

static

Remove all instances from a template object.

Parameters

[in]

templ

template object to remove all instances from

Example: template can refer to "XPON.ONU.1.ANI.1.TC.GEM.Port".

Returns

true on success, else false

Definition at line 958 of file data_model.c.

                                                       {
 
    bool rv = false;
 
    when_null(templ, exit_no_cleanup);
 
    amxd_dm_t* const dm = xpon_mngr_get_dm();
    when_null(dm, exit_no_cleanup);
 
    if(amxd_object_get_type(templ) != amxd_object_template) {
        SAH_TRACEZ_ERROR(ME, "Parameter 'templ' is not a template");
        goto exit_no_cleanup;
    }
 
    const uint32_t nr_instances = amxd_object_get_instance_count(templ);
    if(0 == nr_instances) {
        SAH_TRACEZ_DEBUG(ME, "No instances");
        rv = true;
        goto exit_no_cleanup;
    }
 
    amxd_trans_t transaction;
    amxd_trans_init(&transaction);
    amxd_trans_set_attr(&transaction, amxd_tattr_change_ro, true);
 
    int rc = amxd_trans_select_object(&transaction, templ);
    when_failed_trace(rc, exit, ERROR, "Failed to select template object");
 
    uint32_t index;
    amxd_object_t* obj_inst = NULL;
 
    amxd_object_iterate(instance, it, templ) {
        obj_inst = amxc_container_of(it, amxd_object_t, it);
        index = amxd_object_get_index(obj_inst);
        rc = amxd_trans_del_inst(&transaction, index, NULL);
        when_failed_trace(rc, exit, ERROR, "Failed to add deletion to transaction");
    }
 
    rc = amxd_trans_apply(&transaction, dm);
    when_failed_trace(rc, exit, ERROR, "Failed to apply transaction (rc=%d)", rc);
 
    rv = true;
 
exit:
    amxd_trans_clean(&transaction);
 
exit_no_cleanup:
    return rv;
}

Here is the call graph for this function:

Here is the caller graph for this function:

remove_instance()

static bool remove_instance ( const dm_action_info_t *const  info )

static

Remove an from instance from to the XPON DM.

Parameters

[in]

info

all the info needed to remove the instance

The function logs a warning and returns true if the instance does not exist.

Returns

true on success, else false

Definition at line 695 of file data_model.c.

                                                                {
 
    bool rv = false;
    amxd_object_t* obj;
 
    SAH_TRACEZ_INFO(ME, "Delete %s.%d", info->path, info->index);
 
    amxd_dm_t* const dm = xpon_mngr_get_dm();
    when_null(dm, exit_no_cleanup);
 
    amxd_object_t* templ = amxd_dm_findf(dm, "%s", info->path);
    if(!templ) {
        SAH_TRACEZ_WARNING(ME, "Failed to find %s", info->path);
        return true;
    }
 
    const amxd_object_type_t type = amxd_object_get_type(templ);
    when_false_trace(amxd_object_template == type, exit_no_cleanup, ERROR,
                     "%s is not a template object", info->path);
 
    obj = amxd_object_get_instance(templ, NULL, info->index);
    if(!obj) {
        SAH_TRACEZ_WARNING(ME, "Instance %s.%d does not exist", info->path,
                           info->index);
        return true;
    }
 
    amxd_trans_t transaction;
    amxd_trans_init(&transaction);
    amxd_trans_set_attr(&transaction, amxd_tattr_change_ro, true);
 
    amxd_status_t rc = amxd_trans_select_object(&transaction, templ);
    when_failed_trace(rc, exit, ERROR, "Failed to select %s for transaction (rc=%d)",
                      info->path, rc);
 
    rc = amxd_trans_del_inst(&transaction, info->index, NULL);
    when_failed_trace(rc, exit, ERROR,
                      "Failed to add %s.%d for deletion to transaction (rc=%d)",
                      info->path, info->index, rc);
 
    dm_actions_set_ignore_param_reads(true);
    rc = amxd_trans_apply(&transaction, dm);
    when_failed_trace(rc, exit, ERROR, "Failed to delete %s.%d (rc=%d)",
                      info->path, info->index, rc);
 
    SAH_TRACEZ_DEBUG(ME, "Deleted %s.%d", info->path, info->index);
 
    rv = true;
 
exit:
    amxd_trans_clean(&transaction);
    dm_actions_set_ignore_param_reads(false);
 
exit_no_cleanup:
    return rv;
}

Here is the call graph for this function:

Here is the caller graph for this function:

set_ethernet_uni_status_to_down()

static void set_ethernet_uni_status_to_down ( const amxd_object_t *const  onu_instance, const char *const  path  )

static

For all EthernetUNI instances of the ONU, set Status to Down if it is Up now.

Definition at line 1011 of file data_model.c.

                                                                    {
 
    const amxd_object_t* ethernet_uni = amxd_object_get_child(onu_instance, "EthernetUNI");
    when_null_trace(ethernet_uni, exit, ERROR, "%s.EthernetUNI does not exist", path);
 
    char* current_status_cstr;
    amxd_object_iterate(instance, it, ethernet_uni) {
        amxd_object_t* const eth_uni_inst = amxc_container_of(it, amxd_object_t, it);
        if(NULL == eth_uni_inst) {
            SAH_TRACEZ_ERROR(ME, "Failed to get EthernetUNI object");
            continue;
        }
        current_status_cstr = amxd_object_get_value(cstring_t, eth_uni_inst, "Status", NULL);
        if(current_status_cstr) {
            if(strncmp(current_status_cstr, "Up", 2) == 0) {
                amxd_object_set_value(cstring_t, eth_uni_inst, "Status", "Down");
            }
            free(current_status_cstr);
        }
    }
exit:
    return;
}

Here is the caller graph for this function:

update_enable()

static void update_enable ( amxd_trans_t *  transaction, const char *const  path, uint32_t  index  )

static

Set the Enable param to true if the object is enabled according to persistency.

Also call rth_schedule_enable().

Parameters

[in]	transaction	transaction which is going to add an instance
[in]	path	object path, e.g. "XPON.ONU"
[in]	index	the index of the object instance

Definition at line 505 of file data_model.c.

                                                                  {
 
    when_false_trace(index != 0, exit, ERROR, "index is 0");
 
    amxc_string_t full_path;
    amxc_string_init(&full_path, 0);
    amxc_string_set(&full_path, path);
    amxc_string_appendf(&full_path, ".%d", index);
 
    const char* const full_path_cstr = amxc_string_get(&full_path, 0);
 
    if(persistency_is_enabled(full_path_cstr)) {
        amxc_var_t enabled;
        amxc_var_init(&enabled);
        amxc_var_set(bool, &enabled, true);
        amxd_trans_set_param(transaction, ENABLE_PARAM, &enabled);
        amxc_var_clean(&enabled);
 
        rth_schedule_enable(full_path_cstr);
    }
    amxc_string_clean(&full_path);
 
exit:
    return;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

ADD_INST_PARAMS_REQUIRED

const char* ADD_INST_PARAMS_REQUIRED[3]

static

Initial value:

= {
    "path", "index", "keys"
}

Definition at line 95 of file data_model.c.

ADD_OR_CHANGE_INST_ARGS_REQUIRED

const char* ADD_OR_CHANGE_INST_ARGS_REQUIRED[2]

static

Initial value:

= {
    "path", "index"
}

Definition at line 110 of file data_model.c.

CHANGE_OBJ_ARGS_REQUIRED

const char* CHANGE_OBJ_ARGS_REQUIRED[2]

static

Initial value:

= {
    "path", "parameters"
}

Definition at line 105 of file data_model.c.

REMOVE_INST_ARGS_REQUIRED

const char* REMOVE_INST_ARGS_REQUIRED[2]

static

Initial value:

= {
    "path", "index"
}

Definition at line 100 of file data_model.c.