data_model.h File Reference

#include <stdbool.h>
#include <stddef.h>
#include <amxc/amxc_variant.h>
#include "pon_mode.h"

Go to the source code of this file.

Functions
void	dm_set_vendor_module (const char *name)
void	dm_set_module_error (void)
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)
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 *path, uint32_t index)
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)

Detailed Description

Functionality related to accessing (set/get) the TR-181 XPON DM.

Definition in file data_model.h.

Function Documentation

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_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: