persistency.c File Reference

#include "persistency.h"
#include <errno.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <sys/stat.h>
#include <sys/types.h>
#include <unistd.h>
#include <amxc/amxc_macros.h>
#include "dm_xpon_mngr.h"
#include "xpon_trace.h"

Go to the source code of this file.

Macros
#define	_GNU_SOURCE

Functions
static char *	get_storage_dir (void)
void	persistency_init (void)
void	persistency_cleanup (void)
const char *	persistency_get_folder (void)
static void	touch_file (const char *const file)
static void	create_enabled_file_path (amxc_string_t *const file_path, const char *const object)
void	persistency_enable (const char *const object, bool enable)
bool	persistency_is_enabled (const char *const object)

Variables
static const char *const	STORAGE_DIR = "/etc/config/tr181-xpon/"
static char *	s_storage_dir = NULL

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

The object instances do not exist right after the plugin has loaded the odl files defining the DM, and the _defaults.odl file. The plugin creates them afterwards, while querying the state in the HAL, or when it receives a notification from the HAL to create such an instance. Therefore the plugin does not use the odl mechanism (via a _save.odl file) to save and restore the values of the Enable parameters above.

If one of the Enable parameters is set to true, the persistency part creates an empty file in the storage dir of this plugin. E.g., if XPON.ONU.1.Enable is set to true, it creates XPON.ONU.1_enabled.txt. If the plugin after reboot creates the instance XPON.ONU.1, it checks if that file exists to determine if it should set XPON.ONU.1.Enable to true.

Definition in file persistency.c.

Macro Definition Documentation

_GNU_SOURCE

#define _GNU_SOURCE

Define _GNU_SOURCE to avoid following error: implicit declaration of function ‘strdup’

Definition at line 92 of file persistency.c.

Function Documentation

create_enabled_file_path()

static void create_enabled_file_path ( amxc_string_t *const  file_path, const char *const  object  )

static

Definition at line 234 of file persistency.c.

                                                               {
 
    amxc_string_set(file_path, s_storage_dir);
    amxc_string_appendf(file_path, "%s", object);
    amxc_string_append(file_path, "_enabled.txt", 12);
}

Here is the caller graph for this function:

get_storage_dir()

static char* get_storage_dir ( void  )

static

Return the storage dir.

The returned pointer must be freed.

Returns

the storage dir upon success, else NULL

Definition at line 127 of file persistency.c.

                                   {
 
    char* result = NULL;
    amxo_parser_t* parser = xpon_mngr_get_parser();
    when_null(parser, exit);
 
    amxc_string_t dir;
    amxc_string_init(&dir, 0);
    const char* storage_dir = GETP_CHAR(&parser->config, "storage-path");
    if(!storage_dir) {
        amxc_string_clean(&dir);
        goto exit;
    }
    amxc_string_setf(&dir, "%s", storage_dir);
    amxc_string_resolve(&dir, &parser->config);
    result = amxc_string_take_buffer(&dir);
 
exit:
    return result;
}

Here is the call graph for this function:

Here is the caller graph for this function:

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:

touch_file()

static void touch_file ( const char *const  file )

static

Touch file if it does not exist yet.

Parameters

[in]

file

file path

Definition at line 219 of file persistency.c.

                                               {
    /* Avoid writing the file if it already exists */
    if(access(file, F_OK) == 0) {
        SAH_TRACEZ_DEBUG2(ME, "%s already exists", file);
        return;
    }
 
    FILE* f = fopen(file, "w");
    if(NULL == f) {
        SAH_TRACEZ_ERROR(ME, "Failed to create '%s': %s", file, strerror(errno));
    } else {
        fclose(f);
    }
}

Here is the caller graph for this function:

Variable Documentation

s_storage_dir

char* s_storage_dir = NULL

static

Definition at line 118 of file persistency.c.

STORAGE_DIR

const char* const STORAGE_DIR = "/etc/config/tr181-xpon/"

static

Definition at line 115 of file persistency.c.