dm_actions.c File Reference

#include "dm_actions.h"
#include <stdbool.h>
#include <stdlib.h>
#include <string.h>
#include <amxc/amxc_macros.h>
#include <amxc/amxc.h>
#include <amxp/amxp.h>
#include <amxd/amxd_action.h>
#include <amxd/amxd_object.h>
#include "ani.h"
#include "object_intf_priv.h"
#include "onu_priv.h"
#include "password.h"
#include "pon_ctrl.h"
#include "utils_time.h"
#include "xpon_trace.h"

Go to the source code of this file.

Typedefs
typedef enum _private_data_type	private_data_type_t

Enumerations
enum	_private_data_type { private_data_for_onu = 0 , private_data_for_object_interface }

Functions
void	dm_actions_set_ignore_param_reads (bool ignore)
static bool	process_param_value (const char *const param_name, const amxc_var_t *const ret, amxc_var_t *const retval)
amxd_status_t	_read_trx_param (amxd_object_t *object, amxd_param_t *param, amxd_action_t reason, const amxc_var_t *const args, amxc_var_t *const retval, void *priv)
amxd_status_t	_lastchange_on_read (amxd_object_t *const object, UNUSED amxd_param_t *const param, amxd_action_t reason, UNUSED const amxc_var_t *const args, amxc_var_t *const retval, UNUSED void *priv_unused)
amxd_status_t	object_destroyed_common (amxd_object_t *object, amxd_action_t reason, private_data_type_t private_data_type)
amxd_status_t	_onu_destroyed (amxd_object_t *object, UNUSED amxd_param_t *param, amxd_action_t reason, UNUSED const amxc_var_t *const args, UNUSED amxc_var_t *const retval, UNUSED void *priv_unused)
amxd_status_t	_interface_object_destroyed (amxd_object_t *object, UNUSED amxd_param_t *param, amxd_action_t reason, UNUSED const amxc_var_t *const args, UNUSED amxc_var_t *const retval, UNUSED void *priv_unused)
amxd_status_t	_check_password (amxd_object_t *object, UNUSED amxd_param_t *param, amxd_action_t reason, const amxc_var_t *const args, UNUSED amxc_var_t *const retval, UNUSED void *priv)

Variables
static bool	s_ignore_param_reads = false

Typedef Documentation

private_data_type_t

typedef enum _private_data_type private_data_type_t

Enumeration Type Documentation

_private_data_type

enum _private_data_type

Enumerator
private_data_for_onu
private_data_for_object_interface

Definition at line 285 of file dm_actions.c.

                                {
    private_data_for_onu = 0,
    private_data_for_object_interface
} private_data_type_t;

Function Documentation

_check_password()

amxd_status_t _check_password	(	amxd_object_t *	object,
		UNUSED amxd_param_t *	param,
		amxd_action_t	reason,
		const amxc_var_t *const	args,
		UNUSED amxc_var_t *const	retval,
		UNUSED void *	priv
	)

Called if Password parameter of an ANI instance is changed.

Parameters

[in]	object	the TC.Authentication object of an ANI instance whose Password parameter is changed
[in]	reason	this must be 'action_param_validate'
[in]	args	variant with cstring_t value for the Password

Returns

amxd_status_ok (=0) upon success, another value in case of an error

Definition at line 394 of file dm_actions.c.

                                                 {
    amxd_status_t status = amxd_status_unknown_error;
    const char* password = NULL;
    char* path = NULL;
    amxc_string_t ani_path;
    amxc_string_init(&ani_path, 0);
 
    when_null_status(object, exit, status = amxd_status_invalid_function_argument);
    when_null_status(args, exit, status = amxd_status_invalid_function_argument);
 
    when_true_status(reason != action_param_validate, exit,
                     status = amxd_status_function_not_implemented);
 
    password = amxc_var_constcast(cstring_t, args);
    when_null_trace(password, exit, ERROR, "password is NULL");
 
    if(strlen(password) != 0) {
 
        path = amxd_object_get_path(object, AMXD_OBJECT_INDEXED);
        when_null_trace(path, exit, ERROR, "path is NULL");
        if(!ani_strip_tc_authentication(path, &ani_path)) {
            SAH_TRACEZ_ERROR(ME, "%s: failed to check password", path);
            goto exit;
        }
 
        SAH_TRACEZ_DEBUG(ME, "path='%s' password='%s'", path, password);
 
        const char* const ani_path_cstr = amxc_string_get(&ani_path, 0);
        if(!passwd_check_password(ani_path_cstr, password)) {
            status = amxd_status_invalid_value;
            goto exit;
        }
    }
 
    status = amxd_status_ok;
 
exit:
    if(path) {
        free(path);
    }
    amxc_string_clean(&ani_path);
    return status;
}

Here is the call graph for this function:

_interface_object_destroyed()

amxd_status_t _interface_object_destroyed	(	amxd_object_t *	object,
		UNUSED amxd_param_t *	param,
		amxd_action_t	reason,
		UNUSED const amxc_var_t *const	args,
		UNUSED amxc_var_t *const	retval,
		UNUSED void *	priv_unused
	)

Called if an instance of an object interface is destroyed.

Parameters

[in]	object	the object/instance being destroyed
[in]	reason	this must be 'action_object_destroy'

The function deletes the private data attached to the instance.

Returns

amxd_status_ok (=0) upon success, another value in case of an error

Definition at line 372 of file dm_actions.c.

                                                                    {
 
    return object_destroyed_common(object, reason,
                                   private_data_for_object_interface);
}

Here is the call graph for this function:

_lastchange_on_read()

amxd_status_t _lastchange_on_read	(	amxd_object_t *const	object,
		UNUSED amxd_param_t *const	param,
		amxd_action_t	reason,
		UNUSED const amxc_var_t *const	args,
		amxc_var_t *const	retval,
		UNUSED void *	priv_unused
	)

Called if a LastChange parameter is read.

Parameters

[in]	object	object whose LastChange parameter is read
[in]	action	this must be 'action_param_read'
[in,out]	retval	the function returns the value for the LastChange parameter via this 'retval' parameter

Returns

amxd_status_ok (=0) upon success, another value in case of an error

This function is called when the object with the LastChange parameter is is being created. Then 'object->priv' is still NULL. Therefore do not log an error if 'object->priv' is NULL.

Definition at line 241 of file dm_actions.c.

                                                            {
    amxd_status_t rv = amxd_status_unknown_error;
    object_intf_priv_t* priv = NULL;
    uint32_t since_change = 0;
    uint32_t uptime = 0;
    char* path = NULL;
 
    if(reason != action_param_read) {
        SAH_TRACEZ_WARNING(ME, "wrong reason, expected action_param_read(%d) got %d",
                           action_param_read, reason);
        rv = amxd_status_invalid_action;
        goto exit;
    }
 
    when_null_trace(object, skip, ERROR, "object can not be NULL");
    path = amxd_object_get_path(object, AMXD_OBJECT_INDEXED);
    when_null_trace(object->priv, skip, DEBUG, "object %s has no private data", path);
    priv = (object_intf_priv_t*) object->priv;
    uptime = time_get_system_uptime();
    when_true_trace(uptime < priv->last_change, skip, ERROR,
                    "uptime is smaller than LastChange");
    since_change = uptime - priv->last_change;
    rv = amxd_status_ok;
 
skip:
    when_failed_trace(amxc_var_set_uint32_t(retval, since_change),
                      exit, ERROR, "Failed to set parameter LastChange");
exit:
    if(path) {
        free(path);
    }
    return rv;
}

Here is the call graph for this function:

_onu_destroyed()

amxd_status_t _onu_destroyed	(	amxd_object_t *	object,
		UNUSED amxd_param_t *	param,
		amxd_action_t	reason,
		UNUSED const amxc_var_t *const	args,
		UNUSED amxc_var_t *const	retval,
		UNUSED void *	priv_unused
	)

Called if an ONU instance is destroyed.

Parameters

[in]	object	the object/instance being destroyed
[in]	reason	this must be 'action_object_destroy'

The function deletes the private data attached to the instance.

Returns

amxd_status_ok (=0) upon success, another value in case of an error

Definition at line 351 of file dm_actions.c.

                                                       {
 
    return object_destroyed_common(object, reason, private_data_for_onu);
}

Here is the call graph for this function:

_read_trx_param()

amxd_status_t _read_trx_param	(	amxd_object_t *	object,
		amxd_param_t *	param,
		amxd_action_t	reason,
		const amxc_var_t *const	args,
		amxc_var_t *const	retval,
		void *	priv
	)

Read a parameter value.

The Ambiorix framework calls this function every time a parameter is read which has this function as custom read handler.

The function has 'trx' in its name because for now it's only used to query the values of the volatile params of an XPON.ONU.{i}.ANI.1.Transceiver.{i} instance. But the function is generic in the sense that it can be used for other parameters (of other objects) in the future.

Go to 'exit' if function is called for a template object.

It does not make sense to read the param values of a template object. Only read them for a singleton or an instance.

See also: ST-826 - [amx] custom param read handler called more often than expected

Definition at line 162 of file dm_actions.c.

                                          {
 
    amxd_status_t rv = amxd_status_unknown_error;
 
    SAH_TRACEZ_DEBUG2(ME, "called");
 
    when_null_status(object, exit, rv = amxd_status_invalid_function_argument);
    when_null_status(param, exit, rv = amxd_status_invalid_function_argument);
    when_null_status(retval, exit, rv = amxd_status_invalid_function_argument);
 
    rv = amxd_action_param_read(object, param, reason, args, retval, priv);
 
    when_failed_trace(rv, exit, ERROR, "amxd_action_param_read() failed");
 
    when_true(s_ignore_param_reads, exit);
 
    const amxd_object_type_t type = amxd_object_get_type(object);
    when_true(amxd_object_template == type, exit);
 
    const char* const param_name = amxd_param_get_name(param);
    when_null_trace(param_name, exit, ERROR, "param_name is NULL");
 
    char* path = amxd_object_get_path(object, AMXD_OBJECT_INDEXED);
    when_null_trace(path, exit, ERROR, "path is NULL");
 
    SAH_TRACEZ_DEBUG(ME, "path=%s param=%s", path, param_name);
 
    amxc_var_t ret;
    amxc_var_init(&ret);
 
    if(pon_ctrl_get_param_values(path, param_name, &ret) != 0) {
        SAH_TRACEZ_ERROR(ME, "Failed to query %s.%s", path, param_name);
        goto exit_cleanup;
    }
 
#ifdef _DEBUG_
    printf("tr181-xpon: read_trx_param():\n");
    amxc_var_dump(&ret, STDOUT_FILENO);
#endif
 
    /* Extract the parameter value from 'ret' and assign it to 'retval'. */
    if(!process_param_value(param_name, &ret, retval)) {
        goto exit_cleanup;
    }
 
    rv = 0;
 
exit_cleanup:
    free(path);
    amxc_var_clean(&ret);
 
exit:
    return rv;
}

Here is the call graph for this function:

dm_actions_set_ignore_param_reads()

void dm_actions_set_ignore_param_reads

(

bool

ignore

)

Set 's_ignore_param_reads' to ignore.

See doc in front of s_ignore_param_reads.

Definition at line 124 of file dm_actions.c.

                                                    {
    s_ignore_param_reads = ignore;
}

Here is the caller graph for this function:

object_destroyed_common()

amxd_status_t object_destroyed_common	(	amxd_object_t *	object,
		amxd_action_t	reason,
		private_data_type_t	private_data_type
	)

Helper function called when certain instances are deleted.

Parameters

[in]	object	the object/instance being destroyed
[in]	reason	this must be 'action_object_destroy'
[in]	private_data_type	type of the private data to be destroyed

The function deletes the private data attached to the instance.

Returns

amxd_status_ok (=0) upon success, another value in case of an error

Definition at line 302 of file dm_actions.c.

                                                                             {
 
    amxd_status_t rv = amxd_status_unknown_error;
    char* path = NULL;
 
    if(reason != action_object_destroy) {
        SAH_TRACEZ_WARNING(ME, "Wrong reason, expected action_object_destroy(%d) got %d",
                           action_object_destroy, reason);
        rv = amxd_status_invalid_action;
        goto exit;
    }
 
    when_null_trace(object, exit, ERROR, "object is NULL");
    path = amxd_object_get_path(object, AMXD_OBJECT_INDEXED);
    when_null_trace(object->priv, exit, WARNING,
                    "object %s has no private data", path);
    SAH_TRACEZ_DEBUG(ME, "Delete private data of %s", path);
    switch(private_data_type) {
    case private_data_for_onu:
        onu_priv_delete_private_data((onu_priv_t*) object->priv);
        break;
    case private_data_for_object_interface:
        oipriv_delete_private_data((object_intf_priv_t*) object->priv);
        break;
    default:
        break;
    }
    object->priv = NULL;
    rv = amxd_status_ok;
 
exit:
    if(path) {
        free(path);
    }
    return rv;
}

Here is the call graph for this function:

Here is the caller graph for this function:

process_param_value()

static bool process_param_value ( const char *const  param_name, const amxc_var_t *const  ret, amxc_var_t *const  retval  )

static

Definition at line 128 of file dm_actions.c.

                                                          {
    bool rv = false;
 
    const amxc_var_t* const params =
        amxc_var_get_key(ret, "parameters", AMXC_VAR_FLAG_DEFAULT);
    when_null_trace(params, exit, ERROR, "Failed to extract 'parameters'");
 
    const amxc_var_t* const param_value =
        amxc_var_get_key(params, param_name, AMXC_VAR_FLAG_DEFAULT);
    when_null_trace(param_value, exit, ERROR, "Failed to get value for '%s'", param_name);
 
    const int rc = amxc_var_copy(retval, param_value);
    when_failed_trace(rc, exit, ERROR, "Failed to copy value for '%s'", param_name);
 
    rv = true;
 
exit:
    return rv;
}

Here is the caller graph for this function:

Variable Documentation

s_ignore_param_reads

bool s_ignore_param_reads = false

static

Do not ask vendor module for param value if this setting is true.

When deleting a Transceiver instance, the custom read handler _read_trx_param() is called many times for the parameters RxPower, TxPower, etc. This seems not ok. It does not make sense to query the parameters of an instance being deleted. See:

ST-826 - [amx] custom param read handler called more often than expected

If the vendor module calls dm_remove_instance() to delete a Transceiver instance, the plugin querying the parameter values in the vendor module when deleting the instance causes errors: the vendor module already considers the Transceiver instance deleted.

To avoid those errors, the plugin sets s_ignore_param_reads to true just before deleting an instance, and sets it back to false immediately afterwards. The plugin still calls the custom read handler while deleting a Transceiver instance, but the handler will not query the value in the vendor module.

The plugin sets s_ignore_param_reads to true for each instance it deletes, not only for Transceiver instances. This makes the code more future proof. We might reuse _read_trx_param() in the future for the volatile parameters of other template objects.

Definition at line 117 of file dm_actions.c.