persistency.h File Reference

#include <stdbool.h>
#include <stdint.h>

Go to the source code of this file.

Functions
void	persistency_init (void)
void	persistency_cleanup (void)
const char *	persistency_get_folder (void)
void	persistency_enable (const char *const object, bool enable)
bool	persistency_is_enabled (const char *const object)

Detailed Description

Functionality related to saving and querying the reboot persistent settings. The only read-write parameters in the BBF XPON DM which need to be reboot persistent are:

• XPON.ONU.{i}.Enable and
• XPON.ONU.{i}.ANI.{i}.Enable Hence functions in this header are related to saving and querying the values of those parameters. See doc at the top of persistency.c for more info about the implementation, more particularly why the implementation does not use the odl mechanism.

Definition in file persistency.h.

Function Documentation

persistency_cleanup()

void persistency_cleanup

(

void

)

Clean up the persistency part.

The plugin must call this function once when stopping.

Definition at line 198 of file persistency.c.

                               {
    if(s_storage_dir) {
        free(s_storage_dir);
        s_storage_dir = NULL;
    }
}

Here is the caller graph for this function:

persistency_enable()

void persistency_enable	(	const char *const	object,
		bool	enable
	)

Save whether object is enabled or disabled.

Parameters

[in]	object	path to object in DM being enabled/disabled, e.g., "XPON.ONU.1"
[in]	enable	true if object is enabled, else false

Definition at line 248 of file persistency.c.

                                                               {
 
    when_null_trace(s_storage_dir, exit, DEBUG, "No persistency");
    when_null(object, exit);
 
    amxc_string_t file_path;
    amxc_string_init(&file_path, 0);
    create_enabled_file_path(&file_path, object);
 
    const char* const file_path_cstr = amxc_string_get(&file_path, 0);
 
    SAH_TRACEZ_DEBUG(ME, "object='%s enable=%d", object, enable);
 
    if(enable) {
        touch_file(file_path_cstr);
    } else {
        unlink(file_path_cstr);
    }
 
    amxc_string_clean(&file_path);
 
exit:
    return;
}

Here is the call graph for this function:

Here is the caller graph for this function:

persistency_get_folder()

const char* persistency_get_folder

(

void

)

Get the folder for reboot persistent settings for this plugin.

It typically returns "/etc/config/tr181-xpon/".

Definition at line 210 of file persistency.c.

                                         {
    return s_storage_dir;
}

Here is the caller graph for this function:

persistency_init()

void persistency_init

(

void

)

Initialize the persistency part.

Ask the parser for the storage dir. If the parser returns NULL, take STORAGE_DIR as storage dir. Create the storage dir if it does not exist. Store the selected dir in s_storage_dir upon success, else set s_storage_dir to NULL.

Under normal circumstances the parser returns the storage dir, the dir exists, and this function sets s_storage_dir to that value.

The plugin must call this function once at startup.

mkdir() can not create all folders in a path at once. But we assume that all folders except for the last one in s_storage_dir exist. It's also unlikely we end up here. amxrt normally has already created the folder.

Definition at line 161 of file persistency.c.

                            {
 
    char* dir = get_storage_dir();
    SAH_TRACEZ_DEBUG(ME, "dir='%s'", dir ? dir : "NULL");
 
    s_storage_dir = strdup(dir ? dir : STORAGE_DIR);
 
    when_null_trace(s_storage_dir, exit, ERROR,
                    "Failed to allocate mem for s_storage_dir");
 
    if(access(s_storage_dir, R_OK | W_OK | X_OK) == 0) {
        goto exit;
    }
 
    SAH_TRACEZ_DEBUG(ME, "Create %s", s_storage_dir);
 
    if(mkdir(s_storage_dir, 0777) == -1) {
        SAH_TRACEZ_ERROR(ME, "Failed to create %s", s_storage_dir);
        free(s_storage_dir);
        s_storage_dir = NULL;
    }
 
exit:
    free(dir);
}

Here is the call graph for this function:

Here is the caller graph for this function:

persistency_is_enabled()

bool persistency_is_enabled

(

const char *const

object

)

Return true if object identified by 'object' is enabled.

Parameters

[in]

object

path to object in DM being queried, e.g. "XPON.ONU.1".

Returns

true if object is enabled, else false.

Definition at line 280 of file persistency.c.

                                                      {
 
    bool rv = false;
    when_null_trace(s_storage_dir, exit, DEBUG, "No persistency");
    when_null(object, exit);
 
    amxc_string_t file_path;
    amxc_string_init(&file_path, 0);
    create_enabled_file_path(&file_path, object);
 
    const char* const file_path_cstr = amxc_string_get(&file_path, 0);
 
    rv = (access(file_path_cstr, F_OK) == 0) ? true : false;
 
    amxc_string_clean(&file_path);
 
exit:
    return rv;
}

Here is the call graph for this function:

Here is the caller graph for this function: