*
*/
/** \ingroup GEN_PERS */
-/** \defgroup PERS_CLIENT Client: initialization access
+/** \defgroup PERS_CLIENT Client: initialisation access
* \{
*/
/** \defgroup PERS_CLIENT_INTERFACE API document
#define EPERS_SHUTDOWN_MAX_CANCEL (-40)
/// not permitted to use this function
#define EPERS_SHUTDOWN_NO_PERMIT (-42)
+/// requested handle is not valid. \since PCL v7.0.3
+#define EPERS_INVALID_HANDLE (-1000)
#ifdef __cplusplus
}
/** definition of the change callback
*
- * @param notifyStruct structure for notifcation
+ * @param notifyStruct structure for notification
*
* @return positive value (0 or greater): success;
* On error a negative value will be returned with the following error codes: ::EPERS_LOCKFS
*
* @param ldbid logical database ID
* @param resource_id the resource ID
- * @param user_no the user ID; user_no=0 can not be used as user-ID beacause ‘0’ is defined as System/node
+ * @param user_no the user ID; user_no=0 can not be used as user-ID because ‘0’ is defined as System/node
* @param seat_no the seat number
*
* @return positive value (0 or greater) : success;
*
* @param ldbid logical database ID
* @param resource_id the resource ID
- * @param user_no the user ID; user_no=0 can not be used as user-ID beacause ‘0’ is defined as System/node
+ * @param user_no the user ID; user_no=0 can not be used as user-ID because ‘0’ is defined as System/node
* @param seat_no the seat number
*
* @return positive value (0 or greater): the size;
*
* @param ldbid logical database ID
* @param resource_id the resource ID
- * @param user_no the user ID; user_no=0 can not be used as user-ID beacause ‘0’ is defined as System/node
+ * @param user_no the user ID; user_no=0 can not be used as user-ID because ‘0’ is defined as System/node
* @param seat_no the seat number
*
* @return positive value (0 or greater): the key handle to access the value;
*
* @param ldbid logical database ID
* @param resource_id the resource ID
- * @param user_no the user ID; user_no=0 can not be used as user-ID beacause ‘0’ is defined as System/node
+ * @param user_no the user ID; user_no=0 can not be used as user-ID because ‘0’ is defined as System/node
* @param seat_no the seat number
* @param buffer the buffer to read the persistent data
* @param buffer_size size of buffer for reading
*
* @param ldbid logical database ID of the resource to monitor
* @param resource_id the resource ID
- * @param user_no the user ID; user_no=0 can not be used as user-ID beacause ‘0’ is defined as System/node
+ * @param user_no the user ID; user_no=0 can not be used as user-ID because ‘0’ is defined as System/node
* @param seat_no the seat number
* @param callback notification callback
*
*
* @param ldbid logical database ID of the resource to monitor
* @param resource_id the resource ID
- * @param user_no the user ID; user_no=0 can not be used as user-ID beacause ‘0’ is defined as System/node
+ * @param user_no the user ID; user_no=0 can not be used as user-ID because ‘0’ is defined as System/node
* @param seat_no the seat number
* @param callback notification callback
*
*
* @param ldbid logical database ID
* @param resource_id the resource ID
- * @param user_no the user ID; user_no=0 can not be used as user-ID beacause ‘0’ is defined as System/node
+ * @param user_no the user ID; user_no=0 can not be used as user-ID because ‘0’ is defined as System/node
* @param seat_no the seat number
* @param buffer the buffer containing the persistent data to write
* @param buffer_size the number of bytes to write (default max size is set to 16kB)
gShutdownMode = shutdownMode;
DLT_REGISTER_CONTEXT(gPclDLTContext,"PCL","Context for persistence client library logging");
- DLT_LOG(gPclDLTContext, DLT_LOG_INFO, DLT_STRING("pclInitLibrary => I N I T Persistence Client Library - "), DLT_STRING(gAppId),
- DLT_STRING("- init counter: "), DLT_INT(gPclInitialized) );
+ DLT_LOG(gPclDLTContext, DLT_LOG_INFO, DLT_STRING("pclInitLibrary => I N I T Persistence Client Library - "), DLT_STRING(appName),
+ DLT_STRING("- init counter: "), DLT_INT(gPclInitialized) );
/// environment variable for on demand loading of custom libraries
const char *pOnDemandLoad = getenv("PERS_CUSTOM_LIB_LOAD_ON_DEMAND");
pfcInitCache(appName);
#endif
-
-#if USE_PASINTERFACE == 1
- DLT_LOG(gPclDLTContext, DLT_LOG_INFO, DLT_STRING("PAS interface is enabled!!"));
-#else
- DLT_LOG(gPclDLTContext, DLT_LOG_WARN, DLT_STRING("PAS interface is not enabled, enable with \"./configure --enable-pasinterface\""));
-#endif
-
-
pthread_mutex_lock(&gDbusPendingRegMtx); // block until pending received
if(pDataSize != NULL)
if(gShutdownMode != PCL_SHUTDOWN_TYPE_NONE)
{
- // register for lifecycle and persistence admin service dbus messages
+ // register for lifecycle dbus messages
if(register_lifecycle(shutdownMode) == -1)
{
DLT_LOG(gPclDLTContext, DLT_LOG_ERROR, DLT_STRING("pclInitLibrary => Failed to register to lifecycle dbus interface"));
}
}
#if USE_PASINTERFACE == 1
+ DLT_LOG(gPclDLTContext, DLT_LOG_INFO, DLT_STRING("PAS interface is enabled!!"));
if(register_pers_admin_service() == -1)
{
DLT_LOG(gPclDLTContext, DLT_LOG_ERROR, DLT_STRING("pclInitLibrary => Failed to register to pers admin dbus interface"));
pthread_mutex_unlock(&gDbusPendingRegMtx);
return EPERS_REGISTER_ADMIN;
}
+ else
+ {
+ DLT_LOG(gDLTContext, DLT_LOG_INFO, DLT_STRING("pclInitLibrary => Successfully established IPC protocol for PCL."));
+ }
+#else
+ DLT_LOG(gPclDLTContext, DLT_LOG_WARN, DLT_STRING("PAS interface is not enabled, enable with \"./configure --enable-pasinterface\""));
#endif
/// get custom library names to load
DLT_LOG(gPclDLTContext, DLT_LOG_INFO, DLT_STRING("pclDeinitLibrary -> D E I N I T client library - "), DLT_STRING(gAppId),
DLT_STRING("- init counter: "), DLT_INT(gPclInitialized));
- // unregister for lifecycle and persistence admin service dbus messages
+ // unregister for lifecycle dbus messages
if(gShutdownMode != PCL_SHUTDOWN_TYPE_NONE)
rval = unregister_lifecycle(gShutdownMode);
#if USE_PASINTERFACE == 1
rval = unregister_pers_admin_service();
+ if(0 != rval)
+ {
+ DLT_LOG(gDLTContext, DLT_LOG_ERROR, DLT_STRING("pclDeinitLibrary => Failed to de-initialize IPC protocol for PCL."));
+ }
+ else
+ {
+ DLT_LOG(gDLTContext, DLT_LOG_INFO, DLT_STRING("pclDeinitLibrary => Successfully de-initialized IPC protocol for PCL."));
+ }
#endif
// unload custom client libraries
*
* @return the array position or -1 if the position can't be found
*/
-inline int check_valid_idx(int idx);
+int check_valid_idx(int idx);
*
* @return the name of the custom library ot NULL if invalid
*/
-inline char* get_custom_client_lib_name(int idx);
+char* get_custom_client_lib_name(int idx);
/**
#include <stdio.h>
#include <stdlib.h>
-// rrsource configuration database name
-const char* gResTableCfg = "/resource-table-cfg.itz";
-
/// configurable default database name
const char* gConfigDefault = "/configurable-default-data.itz";
-
/// default database name
const char* gDefault = "/default-data.itz";
-
/// write through database name
const char* gWt = "/wt.itz";
/// cached database name
const char* gCached = "/cached.itz";
-
-/// directory structure node name definition
-const char* gNode = "/node";
-/// directory structure user name definition
-const char* gUser = "/user/";
-/// directory structure seat name definition
-const char* gSeat = "/seat/";
-/// default data folder name definition
const char* gDefDataFolder = "/defaultData/";
+
+// define PERS_ORG_ROOT_PATH comes form persistence common object
+
/// cached path location
-#define CACHEPREFIX "/Data/mnt-c/"
+#define CACHEPREFIX PERS_ORG_ROOT_PATH "/mnt-c/"
/// write through path location
-#define WTPREFIX "/Data/mnt-wt/"
+#define WTPREFIX PERS_ORG_ROOT_PATH "/mnt-wt/"
+/// path for the backup location
+const char* gBackupPrefix = PERS_ORG_ROOT_PATH "/mnt-backup/";
/// size of cached path string
const int gCPathPrefixSize = sizeof(CACHEPREFIX)-1;
/// size of write through string
const int gWTPathPrefixSize = sizeof(WTPREFIX)-1;
-/// path for the backup location
-const char* gBackupPrefix = "/Data/mnt-backup/";
+
+/// backup filename postfix
+const char* gBackupPostfix = "~";
+/// backup checksum filename postfix
+const char* gBackupCsPostfix = "~.crc";
/// path prefix for local cached database: /Data/mnt_c/<appId>/ (<database_name>
const char* gLocalCachePath = CACHEPREFIX "%s";
defaultMaxKeyValDataSize = PERS_DB_MAX_SIZE_KEY_DATA /// default limit the key-value data size to 16kB
};
-
-/// resource configuration table name
-extern const char* gResTableCfg;
-
/// configurable default database name
extern const char* gConfigDefault;
/// write through database name
extern const char* gWt;
-
-/// directory structure node name definition
-extern const char* gNode;
-/// directory structure user name definition
-extern const char* gUser;
-/// directory structure seat name definition
-extern const char* gSeat;
-
/// default data folder name definition
extern const char* gDefDataFolder;
/// path for the backup location
extern const char* gBackupPrefix;
+/// backup filename postfix
+extern const char* gBackupPostfix;
+/// backup checksum filename postfix
+extern const char* gBackupCsPostfix;
/// size of cached prefix string
extern const int gCPathPrefixSize;
PersDefaultType_e i = PersDefaultType_Configurable;
int handleDefaultDB = -1;
int read_size = EPERS_NOKEY;
+ char dltMessage[DbPathMaxLen] = {0};
key = pers_get_raw_key(key); /* We need only the raw key without a prefixed '/node/' or '/user/1/seat/0' etc... */
if(read_size < 0) // check read_size
{
- if (PersDefaultType_Configurable == i)
- {
- DLT_LOG(gPclDLTContext, DLT_LOG_INFO, DLT_STRING("Key '"),
- DLT_STRING(key),
- DLT_STRING("' not found in "),
- DLT_STRING(dbPath),
- DLT_STRING(gLocalConfigurableDefault));
- }
- else if (PersDefaultType_Factory == i)
- {
- DLT_LOG(gPclDLTContext, DLT_LOG_INFO, DLT_STRING("Key '"),
- DLT_STRING(key),
- DLT_STRING("' not found in "),
- DLT_STRING(dbPath),
- DLT_STRING(gLocalFactoryDefault));
- }
- else
- {
- DLT_LOG(gPclDLTContext, DLT_LOG_ERROR, DLT_STRING("pers_get_defaults ==> unknown PersDefaultType: "),
- DLT_INT(i));
- }
-
if(PERS_COM_ERR_NOT_FOUND == read_size)
{
read_size = EPERS_NOKEY;
}
}
- else
+ else /* read_size >= 0 --> default value found */
{
+ if (PersDefaultType_Configurable == i)
+ {
+ snprintf(dltMessage, DbPathMaxLen, "%s%s", dbPath, gLocalConfigurableDefault);
+ }
+ if (PersDefaultType_Factory == i)
+ {
+ snprintf(dltMessage, DbPathMaxLen, "%s%s", dbPath, gLocalFactoryDefault);
+ }
+ DLT_LOG(gPclDLTContext, DLT_LOG_INFO, DLT_STRING("Default data will be used for Key"),
+ DLT_STRING(key),
+ DLT_STRING("from"),
+ DLT_STRING(dltMessage));
break;
}
}
}
- return read_size;
+ if (read_size < 0)
+ {
+ DLT_LOG(gPclDLTContext, DLT_LOG_INFO, DLT_STRING("Default data not available for Key"),
+ DLT_STRING(key),
+ DLT_STRING("Path:"),
+ DLT_STRING(dbPath));
+ }
+ return read_size;
}
read_size = EPERS_NOPLUGINFUNCT;
}
- if (1 > read_size)
+ if (1 > read_size) /* Try to get default values */
{
info->configKey.policy = PersistencePolicy_wc; /* Set the policy */
info->configKey.type = PersistenceResourceType_key; /* Set the type */
(void)get_db_path_and_key(info, key, NULL, dbPath);
- DLT_LOG(gPclDLTContext, DLT_LOG_INFO, DLT_STRING("Custom Key not available. Try to get default keys from:"),
- DLT_STRING(dbPath),
+ DLT_LOG(gPclDLTContext, DLT_LOG_INFO, DLT_STRING("Plugin data not available. Try to get default data of key:"),
DLT_STRING(key));
ret_defaults = pers_get_defaults(dbPath, key, buffer, buffer_size, PersGetDefault_Data);
if (0 < ret_defaults)
{
DLT_LOG(gPclDLTContext, DLT_LOG_ERROR, DLT_STRING("persistence_set_data ==> persComDbWriteKey() failure"));
}
-
- if(PersistenceStorage_shared == info->configKey.storage)
+ else
{
- int rval = pers_send_Notification_Signal(key, &info->context, pclNotifyStatus_changed);
- if(rval <= 0)
+ if(PersistenceStorage_shared == info->configKey.storage)
{
- DLT_LOG(gPclDLTContext, DLT_LOG_ERROR, DLT_STRING("persistence_set_data ==> failed to send notification signal"));
- write_size = rval;
+ int rval = pers_send_Notification_Signal(key, &info->context, pclNotifyStatus_changed);
+ if(rval <= 0)
+ {
+ DLT_LOG(gPclDLTContext, DLT_LOG_ERROR, DLT_STRING("persistence_set_data ==> failed to send notification signal"));
+ write_size = rval;
+ }
}
}
}
write_size = gPersCustomFuncs[idx].custom_plugin_set_data(pathKeyString, (char*)buffer, buffer_size);
- if (write_size == buffer_size) /* Check return value and send notification if OK */
+ if ((0 < write_size) && ((unsigned int)write_size == buffer_size)) /* Check return value and send notification if OK */
{
int rval = pers_send_Notification_Signal(key, &info->context, pclNotifyStatus_changed);
if(rval <= 0)
info->configKey.policy = PersistencePolicy_wc; /* Set the policy */
info->configKey.type = PersistenceResourceType_key; /* Set the type */
(void)get_db_path_and_key(info, key, NULL, dbPath);
- DLT_LOG(gPclDLTContext, DLT_LOG_INFO, DLT_STRING("Custom Key not available. Try to get default keys from:"),
- DLT_STRING(dbPath),
+ DLT_LOG(gPclDLTContext, DLT_LOG_INFO, DLT_STRING("Plugin data not available. Try to get size of default data for key:"),
DLT_STRING(key));
ret_defaults = pers_get_defaults(dbPath, key, NULL, 0, PersGetDefault_Size);
if (0 < ret_defaults)
{
int i = 0;
- // close open persistence resource configuration table
+ // close all open persistence resource configuration tables
for(i=0; i< PrctDbTableSize; i++)
{
if(gResource_table[i] != -1)
{
- if(persComRctClose(i) == -1)
+ if(persComRctClose(i) != 0)
{
DLT_LOG(gPclDLTContext, DLT_LOG_ERROR, DLT_STRING("process_prepare_shutdown => failed to close db => index:"), DLT_INT(i));
}
*/
int pers_send_Notification_Signal(const char* key, PersistenceDbContext_s* context, pclNotifyStatus_e reason);
-
+/**
+ * @brief close all open persistence resource configuration tables
+ *
+ */
void pers_rct_close_all();
#ifdef __cplusplus
* @see
*/
+#include <errno.h>
+#include <dlfcn.h> /* For dlclose() */
#include "persistence_client_library_dbus_cmd.h"
#include "persistence_client_library_handle.h"
#include "persistence_client_library_custom_loader.h"
+#include "persistence_client_library_prct_access.h"
#include "persistence_client_library_pas_interface.h"
-
#include "persistence_client_library_data_organization.h"
#include "persistence_client_library_db_access.h"
-#include <dlfcn.h>
-#include <errno.h>
-
// function prototype
void msg_pending_func(DBusPendingCall *call, void *data);
dbus_bus_add_match(conn, ruleChanged, NULL);
dbus_bus_add_match(conn, ruleDeleted, NULL);
dbus_bus_add_match(conn, ruleCreated, NULL);
+ DLT_LOG(gPclDLTContext, DLT_LOG_VERBOSE, DLT_STRING("Registered for change notifications:"), DLT_STRING(ruleChanged));
}
else if(gNotifyPolicy == Notify_unregister)
{
dbus_bus_remove_match(conn, ruleChanged, NULL);
dbus_bus_remove_match(conn, ruleDeleted, NULL);
dbus_bus_remove_match(conn, ruleCreated, NULL);
+ DLT_LOG(gPclDLTContext, DLT_LOG_VERBOSE, DLT_STRING("Unregistered for change notifications:"), DLT_STRING(ruleChanged));
}
dbus_connection_flush(conn); // flush the connection to add the match
/**
* @brief process a shutdown message (close all open files, open databases, ...
- */
-void process_prepare_shutdown(int complete);
-
-
-/**
- * @brief block persistence access and write data back to device
*
- * @param requestId the requestID
- * @param status the status
+ * @param complete The mode: Shutdown_Partial=0; Shutdown_Full=1
*/
-void process_block_and_write_data_back(unsigned int requestID, unsigned int status);
+void process_prepare_shutdown(int complete);
/**
void process_reg_notification_signal(DBusConnection* conn);
+void process_send_lifecycle_request(DBusConnection* conn, int requestId, int status);
+
+
+void process_send_lifecycle_register(DBusConnection* conn, int regType, int shutdownMode);
+
+
+
+/**
+ * @brief block persistence access and write data back to device
+ *
+ * @param requestId the requestID
+ * @param status the status
+ */
+void process_block_and_write_data_back(unsigned int requestID, unsigned int status);
+
+
/**
* @brief process a request of the persistence admin service
void process_send_pas_request(DBusConnection* conn, unsigned int requestID, int status);
+
/**
* @brief process a request of the persistence admin service
*
-void process_send_lifecycle_request(DBusConnection* conn, int requestId, int status);
-
-
-void process_send_lifecycle_register(DBusConnection* conn, int regType, int shutdownMode);
-
-
-
#endif /* PERSISTENCE_CLIENT_LIBRARY_DBUS_CMD_H_ */
}
strncpy(fileSubPath, dbPath+length, DbPathMaxLen);
- snprintf(backupPath, DbPathMaxLen-1, "%s%s", gBackupPrefix, fileSubPath);
- snprintf(csumPath, DbPathMaxLen-1, "%s%s%s", gBackupPrefix, fileSubPath, ".crc");
+ snprintf(backupPath, DbPathMaxLen-1, "%s%s%s", gBackupPrefix, fileSubPath, gBackupPostfix);
+ snprintf(csumPath, DbPathMaxLen-1, "%s%s%s", gBackupPrefix, fileSubPath, gBackupCsPostfix);
if(shared_DB >= 0) // check valid database context
{
snprintf(dbPath, DbPathMaxLen, gLocalCacheFilePath, gAppId, user_no, seat_no, resource_id);
handle = pclCreateFile(dbPath);
- if(handle < MaxPersHandle && handle > 0)
- {
- __sync_fetch_and_add(&gOpenFdArray[handle], FileOpen); // set open flag
-
- strcpy(gFileHandleArray[handle].backupPath, backupPath);
- strcpy(gFileHandleArray[handle].csumPath, csumPath);
- gFileHandleArray[handle].backupCreated = 0;
- gFileHandleArray[handle].permission = PersistencePermission_ReadWrite; // make it writable
- }
- else
+ if(handle != -1)
{
- close(handle);
- handle = EPERS_MAXHANDLE;
+ if(handle < MaxPersHandle)
+ {
+ __sync_fetch_and_add(&gOpenFdArray[handle], FileOpen); // set open flag
+
+ strcpy(gFileHandleArray[handle].backupPath, backupPath);
+ strcpy(gFileHandleArray[handle].csumPath, csumPath);
+ gFileHandleArray[handle].backupCreated = 0;
+ gFileHandleArray[handle].permission = PersistencePermission_ReadWrite; // make it writable
+ }
+ else
+ {
+ close(handle);
+ handle = EPERS_MAXHANDLE;
+ }
}
}
}
if( dbContext.configKey.permission != PersistencePermission_ReadOnly
&& pclBackupNeeded(dbPath) )
{
- snprintf(backupPath, DbPathMaxLen-1, "%s%s", dbPath, "~");
- snprintf(csumPath, DbPathMaxLen-1, "%s%s", dbPath, "~.crc");
+ snprintf(backupPath, DbPathMaxLen-1, "%s%s", dbPath, gBackupPostfix);
+ snprintf(csumPath, DbPathMaxLen-1, "%s%s", dbPath, gBackupCsPostfix);
if((handle = pclVerifyConsistency(dbPath, backupPath, csumPath, flags)) == -1)
{
*size = strlen(dbPath);
*path = malloc((*size)+1); // allocate 1 byte for the string termination
- memcpy(*path, dbPath, (*size));
- (*path)[(*size)] = '\0'; // terminate string
- gOssHandleArray[handle].filePath = *path;
- if(access(*path, F_OK) == -1)
+ /* Check if malloc was successful */
+ if(NULL != (*path))
{
- // file does not exist, create it.
- int handle = 0;
- if((handle = pclCreateFile(*path)) == -1)
- {
- DLT_LOG(gPclDLTContext, DLT_LOG_ERROR, DLT_STRING("pclFileCreatePath: error => failed to create file: "), DLT_STRING(*path));
- }
- else
+ memcpy(*path, dbPath, (*size));
+ (*path)[(*size)] = '\0'; // terminate string
+ gOssHandleArray[handle].filePath = *path;
+
+ if(access(*path, F_OK) == -1)
{
- if(pclFileGetDefaultData(handle, resource_id, dbContext.configKey.policy) == -1) // try to get default data
+ // file does not exist, create it.
+ int handle = 0;
+ if((handle = pclCreateFile(*path)) == -1)
+ {
+ DLT_LOG(gPclDLTContext, DLT_LOG_ERROR, DLT_STRING("pclFileCreatePath: error => failed to create file: "), DLT_STRING(*path));
+ }
+ else
{
- DLT_LOG(gPclDLTContext, DLT_LOG_WARN, DLT_STRING("pclFileCreatePath => no default data available: "), DLT_STRING(resource_id));
+ if(pclFileGetDefaultData(handle, resource_id, dbContext.configKey.policy) == -1) // try to get default data
+ {
+ DLT_LOG(gPclDLTContext, DLT_LOG_WARN, DLT_STRING("pclFileCreatePath => no default data available: "), DLT_STRING(resource_id));
+ }
+ close(handle); // don't need the open file
}
}
- close(handle); // don't need the open file
+ }
+ else
+ {
+ handle = EPERS_DESER_ALLOCMEM;
+ DLT_LOG(gPclDLTContext, DLT_LOG_ERROR,
+ DLT_STRING("pclFileCreatePath: malloc() failed for path:"),
+ DLT_STRING(dbPath),
+ DLT_STRING("With the size:"),
+ DLT_UINT(*size));
}
}
else
- {
- set_persistence_handle_close_idx(handle);
- handle = EPERS_MAXHANDLE;
- }
+ {
+ set_persistence_handle_close_idx(handle);
+ handle = EPERS_MAXHANDLE;
+ }
}
}
else // requested resource is not in the RCT, so create resource as local/cached.
{
if(handle < MaxPersHandle)
{
- snprintf(backupPath, DbPathMaxLen, "%s%s", dbPath, "~");
- snprintf(csumPath, DbPathMaxLen, "%s%s", dbPath, "~.crc");
+ snprintf(backupPath, DbPathMaxLen, "%s%s", dbPath, gBackupPostfix);
+ snprintf(csumPath, DbPathMaxLen, "%s%s", dbPath, gBackupCsPostfix);
__sync_fetch_and_add(&gOpenHandleArray[handle], FileOpen); // set open flag
strncpy(gOssHandleArray[handle].backupPath, backupPath, DbPathMaxLen);
/**
* @brief get persistence handle
*
- * @return a new handle or 0 if an error occured
+ * @return a new handle or 0 if an error occured or EPERS_MAXHANDLE if max no of handles is reached
*/
int get_persistence_handle_idx();
void set_persistence_handle_close_idx(int handle);
+/**
+ * @brief close open key handles
+ *
+ */
void close_all_persistence_handle();
-
-
#endif /* PERSISTENCY_CLIENT_LIBRARY_HANDLE_H */
char dbKey[DbKeyMaxLen] = {0}; // database key
char dbPath[DbPathMaxLen] = {0}; // database location
- //DLT_LOG(gDLTContext, DLT_LOG_INFO, DLT_STRING("pclKeyHandleOpen: "), DLT_INT(ldbid), DLT_STRING(resource_id) );
dbContext.context.ldbid = ldbid;
dbContext.context.seat_no = seat_no;
dbContext.context.user_no = user_no;
// get database context: database path and database key
handle = get_db_context(&dbContext, resource_id, ResIsNoFile, dbKey, dbPath);
- if( (handle >= 0)
- && (dbContext.configKey.type == PersistenceResourceType_key) ) // check if type matches
+ if( (handle >= 0) && (dbContext.configKey.type == PersistenceResourceType_key) ) // check if type matches
{
if(dbContext.configKey.storage < PersistenceStorage_LastEntry) // check if store policy is valid
{
- if(PersistenceStorage_custom == dbContext.configKey.storage)
- {
- int idx = custom_client_name_to_id(dbPath, 1);
- char workaroundPath[128]; // workaround, because /sys/ can not be accessed on host!!!!
- snprintf(workaroundPath, 128, "%s%s", "/Data", dbPath );
-
- if( (idx < PersCustomLib_LastEntry) && (gPersCustomFuncs[idx].custom_plugin_handle_open != NULL) )
- {
- int flag = 0, mode = 0;
- gPersCustomFuncs[idx].custom_plugin_handle_open(workaroundPath, flag, mode);
- }
- else
- {
- handle = EPERS_NOPLUGINFUNCT;
- }
- }
-
// generate handle for custom and for normal key
handle = get_persistence_handle_idx();
- if((handle < MaxPersHandle) && (0 <= handle))
+ if((handle < MaxPersHandle) && (0 < handle))
{
// remember data in handle array
strncpy(gKeyHandleArray[handle].dbPath, dbPath, DbPathMaxLen);
DLT_LOG(gPclDLTContext, DLT_LOG_ERROR, DLT_STRING("pclKeyHandleOpen: error - handleId out of bounds:"), DLT_INT(handle));
}
}
+ else
+ {
+ handle = EPERS_BADPOL;
+ }
}
else
{
}
}
-
return handle;
}
{
int rval = EPERS_NOT_INITIALIZED;
- //DLT_LOG(gDLTContext, DLT_LOG_INFO, DLT_STRING("pclKeyHandleClose: "),
- // DLT_INT(gKeyHandleArray[key_handle].info.context.ldbid), DLT_STRING(gKeyHandleArray[key_handle].resourceID) );
-
if(gPclInitialized >= PCLinitialized)
{
- if(key_handle < MaxPersHandle && key_handle > 0)
+ if((key_handle < MaxPersHandle) && (key_handle > 0))
{
- if(PersistenceStorage_custom == gKeyHandleArray[key_handle].info.configKey.storage )
+ if ('\0' != gKeyHandleArray[key_handle].resourceID[0])
{
- int idx = custom_client_name_to_id(gKeyHandleArray[key_handle].dbPath, 1);
-
- if( (idx < PersCustomLib_LastEntry) && (gPersCustomFuncs[idx].custom_plugin_handle_close != NULL) )
- {
- rval = gPersCustomFuncs[idx].custom_plugin_handle_close(key_handle);
- }
- else
- {
- rval = EPERS_NOPLUGINFUNCT;
- }
+ /* Invalidate key handle data */
+ set_persistence_handle_close_idx(key_handle);
+ memset(&gKeyHandleArray[key_handle], 0, sizeof(gKeyHandleArray[key_handle]));
+ rval = 1;
}
-
- if(rval != EPERS_NOPLUGINFUNCT)
+ else
{
- set_persistence_handle_close_idx(key_handle);
- rval = 1;
-
- // invalidate entries
- memset(gKeyHandleArray[key_handle].dbPath, 0, DbPathMaxLen);
- memset(gKeyHandleArray[key_handle].dbKey ,0, DbKeyMaxLen);
- gKeyHandleArray[key_handle].info.configKey.storage = -1;
+ rval = EPERS_INVALID_HANDLE;
}
}
else
{
int size = EPERS_NOT_INITIALIZED;
- //DLT_LOG(gDLTContext, DLT_LOG_INFO, DLT_STRING("pclKeyHandleGetSize: "),
- // DLT_INT(gKeyHandleArray[key_handle].info.context.ldbid), DLT_STRING(gKeyHandleArray[key_handle].resourceID) );
-
if(gPclInitialized >= PCLinitialized)
{
- if(key_handle < MaxPersHandle && key_handle > 0)
+ if((key_handle < MaxPersHandle) && (key_handle > 0))
{
- if(PersistenceStorage_custom == gKeyHandleArray[key_handle].info.configKey.storage)
+ if ('\0' != gKeyHandleArray[key_handle].resourceID[0])
{
- int idx = custom_client_name_to_id(gKeyHandleArray[key_handle].dbPath, 1);
-
- if( (idx < PersCustomLib_LastEntry) && (gPersCustomFuncs[idx].custom_plugin_get_size != NULL) )
- {
- size = gPersCustomFuncs[idx].custom_plugin_get_size(gKeyHandleArray[key_handle].dbPath);
- }
- else
- {
- size = EPERS_NOPLUGINFUNCT;
- }
+ size = pclKeyGetSize(gKeyHandleArray[key_handle].info.context.ldbid,
+ gKeyHandleArray[key_handle].resourceID,
+ gKeyHandleArray[key_handle].info.context.user_no,
+ gKeyHandleArray[key_handle].info.context.seat_no);
}
else
{
- size = persistence_get_data_size(gKeyHandleArray[key_handle].dbPath, gKeyHandleArray[key_handle].dbKey,
- &gKeyHandleArray[key_handle].info);
+ size = EPERS_INVALID_HANDLE;
}
}
else
{
int size = EPERS_NOT_INITIALIZED;
- //DLT_LOG(gDLTContext, DLT_LOG_INFO, DLT_STRING("pclKeyHandleReadData: "),
- // DLT_INT(gKeyHandleArray[key_handle].info.context.ldbid), DLT_STRING(gKeyHandleArray[key_handle].resourceID) );
-
if(gPclInitialized >= PCLinitialized)
{
- if(key_handle < MaxPersHandle && key_handle > 0)
+ if((key_handle < MaxPersHandle) && (key_handle > 0))
{
- if(PersistenceStorage_custom == gKeyHandleArray[key_handle].info.configKey.storage)
+ if ('\0' != gKeyHandleArray[key_handle].resourceID[0])
{
- int idx = custom_client_name_to_id(gKeyHandleArray[key_handle].dbPath, 1);
-
- if( (idx < PersCustomLib_LastEntry) && (gPersCustomFuncs[idx].custom_plugin_handle_get_data != NULL) )
- {
- size = gPersCustomFuncs[idx].custom_plugin_handle_get_data(key_handle, (char*)buffer, buffer_size-1);
- }
- else
- {
- size = EPERS_NOPLUGINFUNCT;
- }
+ size = pclKeyReadData(gKeyHandleArray[key_handle].info.context.ldbid,
+ gKeyHandleArray[key_handle].resourceID,
+ gKeyHandleArray[key_handle].info.context.user_no,
+ gKeyHandleArray[key_handle].info.context.seat_no,
+ buffer,
+ buffer_size);
}
else
{
- size = persistence_get_data(gKeyHandleArray[key_handle].dbPath, gKeyHandleArray[key_handle].dbKey,
- &gKeyHandleArray[key_handle].info, buffer, buffer_size);
+ size = EPERS_INVALID_HANDLE;
}
}
else
int pclKeyHandleRegisterNotifyOnChange(int key_handle, pclChangeNotifyCallback_t callback)
{
- //DLT_LOG(gDLTContext, DLT_LOG_INFO, DLT_STRING("pclKeyHandleRegisterNotifyOnChange: "),
- // DLT_INT(gKeyHandleArray[key_handle].info.context.ldbid), DLT_STRING(gKeyHandleArray[key_handle].resourceID) );
-
return handleRegNotifyOnChange(key_handle, callback, Notify_register);
}
int pclKeyHandleUnRegisterNotifyOnChange(int key_handle, pclChangeNotifyCallback_t callback)
{
- //DLT_LOG(gDLTContext, DLT_LOG_INFO, DLT_STRING("pclKeyHandleUnRegisterNotifyOnChange: "),
- // DLT_INT(gKeyHandleArray[key_handle].info.context.ldbid), DLT_STRING(gKeyHandleArray[key_handle].resourceID) );
-
return handleRegNotifyOnChange(key_handle, callback, Notify_unregister);
}
if(gPclInitialized >= PCLinitialized)
{
- if(key_handle < MaxPersHandle && key_handle > 0)
+ if((key_handle < MaxPersHandle) && (key_handle > 0))
{
- rval = regNotifyOnChange(gKeyHandleArray[key_handle].info.context.ldbid,
- gKeyHandleArray[key_handle].resourceID,
- gKeyHandleArray[key_handle].info.context.user_no,
- gKeyHandleArray[key_handle].info.context.seat_no,
- callback,
- regPolicy);
+ if ('\0' != gKeyHandleArray[key_handle].resourceID[0])
+ {
+ rval = regNotifyOnChange(gKeyHandleArray[key_handle].info.context.ldbid,
+ gKeyHandleArray[key_handle].resourceID,
+ gKeyHandleArray[key_handle].info.context.user_no,
+ gKeyHandleArray[key_handle].info.context.seat_no,
+ callback,
+ regPolicy);
+ }
+ else
+ {
+ rval = EPERS_INVALID_HANDLE;
+ }
}
else
{
{
int size = EPERS_NOT_INITIALIZED;
- //DLT_LOG(gDLTContext, DLT_LOG_INFO, DLT_STRING("pclKeyHandleWriteData: "),
- // DLT_INT(gKeyHandleArray[key_handle].info.context.ldbid), DLT_STRING(gKeyHandleArray[key_handle].resourceID) );
-
if(gPclInitialized >= PCLinitialized)
{
- if(AccessNoLock != isAccessLocked() ) // check if access to persistent data is locked
+ if((key_handle < MaxPersHandle) && (key_handle > 0))
{
- if(buffer_size <= gMaxKeyValDataSize) // check data size
+ if ('\0' != gKeyHandleArray[key_handle].resourceID[0])
{
- if(key_handle < MaxPersHandle && key_handle > 0)
- {
- if(gKeyHandleArray[key_handle].info.configKey.permission != PersistencePermission_ReadOnly) // don't write to a read only resource
- {
- if(PersistenceStorage_custom == gKeyHandleArray[key_handle].info.configKey.storage)
- {
- int idx = custom_client_name_to_id(gKeyHandleArray[key_handle].dbPath, 1);
-
- if( (idx < PersCustomLib_LastEntry) && (gPersCustomFuncs[idx].custom_plugin_handle_set_data != NULL) )
- {
- size = gPersCustomFuncs[idx].custom_plugin_handle_set_data(key_handle, (char*)buffer, buffer_size-1);
-
- if(size >= 0) // success ==> send change notification
- {
- int rval = pers_send_Notification_Signal(gKeyHandleArray[key_handle].dbKey,
- &(gKeyHandleArray[key_handle].info.context), pclNotifyStatus_changed);
-
- if(rval <= 0)
- {
- DLT_LOG(gPclDLTContext, DLT_LOG_ERROR, DLT_STRING("pclKeyHandleWriteData: error - failed to send notification"));
- size = rval;
- }
- }
- }
- else
- {
- size = EPERS_NOPLUGINFUNCT;
- }
- }
- else
- {
- size = persistence_set_data(gKeyHandleArray[key_handle].dbPath, gKeyHandleArray[key_handle].dbKey,
- &gKeyHandleArray[key_handle].info, buffer, buffer_size);
- }
- }
- else
- {
- size = EPERS_RESOURCE_READ_ONLY;
- }
-
- }
- else
- {
- size = EPERS_MAXHANDLE;
- }
+ size = pclKeyWriteData(gKeyHandleArray[key_handle].info.context.ldbid,
+ gKeyHandleArray[key_handle].resourceID,
+ gKeyHandleArray[key_handle].info.context.user_no,
+ gKeyHandleArray[key_handle].info.context.seat_no,
+ buffer,
+ buffer_size);
}
else
{
- DLT_LOG(gPclDLTContext, DLT_LOG_ERROR, DLT_STRING("pclKeyHandleWriteData: error - buffer_size to big, limit is [bytes]:"), DLT_INT(gMaxKeyValDataSize));
- size = EPERS_MAX_BUFF_SIZE;
+ size = EPERS_INVALID_HANDLE;
}
}
else
{
- size = EPERS_LOCKFS;
+ size = EPERS_MAXHANDLE;
}
}
{
int rval = EPERS_NOT_INITIALIZED;
- //DLT_LOG(gDLTContext, DLT_LOG_INFO, DLT_STRING("pclKeyDelete: "), DLT_INT(ldbid), DLT_STRING(resource_id) );
-
if(gPclInitialized >= PCLinitialized)
{
if(AccessNoLock != isAccessLocked() ) // check if access to persistent data is locked
if( (rval >= 0)
&& (dbContext.configKey.type == PersistenceResourceType_key) ) // check if type is matching
{
- if( dbContext.configKey.storage < PersistenceStorage_LastEntry
- && dbContext.configKey.storage >= PersistenceStorage_local) // check if store policy is valid
+ if( dbContext.configKey.storage < PersistenceStorage_LastEntry) // check if store policy is valid
{
rval = persistence_delete_data(dbPath, dbKey, &dbContext);
}
dbContext.context.seat_no = seat_no;
dbContext.context.user_no = user_no;
- //DLT_LOG(gDLTContext, DLT_LOG_INFO, DLT_STRING("pclKeyGetSize: "), DLT_INT(ldbid), DLT_STRING(resource_id) );
-
// get database context: database path and database key
data_size = get_db_context(&dbContext, resource_id, ResIsNoFile, dbKey, dbPath);
if( (data_size >= 0)
&& (dbContext.configKey.type == PersistenceResourceType_key) ) // check if type matches
{
- if( dbContext.configKey.storage < PersistenceStorage_LastEntry
- && dbContext.configKey.storage >= PersistenceStorage_local) // check if store policy is valid
+ if( dbContext.configKey.storage < PersistenceStorage_LastEntry) // check if store policy is valid
{
data_size = persistence_get_data_size(dbPath, dbKey, &dbContext);
}
{
int data_size = EPERS_NOT_INITIALIZED;
- //DLT_LOG(gDLTContext, DLT_LOG_INFO, DLT_STRING("pclKeyReadData: "), DLT_INT(ldbid), DLT_STRING(resource_id) );
-
if(gPclInitialized >= PCLinitialized)
{
if(AccessNoLock != isAccessLocked() ) // check if access to persistent data is locked
&& (dbContext.configKey.type == PersistenceResourceType_key) )
{
- if( dbContext.configKey.storage < PersistenceStorage_LastEntry
- && dbContext.configKey.storage >= PersistenceStorage_local) // check if store policy is valid
+ if( dbContext.configKey.storage < PersistenceStorage_LastEntry) // check if store policy is valid
{
data_size = persistence_get_data(dbPath, dbKey, &dbContext, buffer, buffer_size);
}
{
int data_size = EPERS_NOT_INITIALIZED;
- //DLT_LOG(gDLTContext, DLT_LOG_INFO, DLT_STRING("pclKeyWriteData: "), DLT_INT(ldbid), DLT_STRING(resource_id) );
-
if(gPclInitialized >= PCLinitialized)
{
if(AccessNoLock != isAccessLocked() ) // check if access to persistent data is locked
hash_val_data = pclCrc32(hash_val_data, buffer, buffer_size);
// store data
- if( dbContext.configKey.storage < PersistenceStorage_LastEntry
- && dbContext.configKey.storage >= PersistenceStorage_local) // check if store policy is valid
+ if( dbContext.configKey.storage < PersistenceStorage_LastEntry) // check if store policy is valid
{
data_size = persistence_set_data(dbPath, dbKey, &dbContext, buffer, buffer_size);
}
int pclKeyUnRegisterNotifyOnChange( unsigned int ldbid, const char * resource_id, unsigned int user_no, unsigned int seat_no, pclChangeNotifyCallback_t callback)
{
- //DLT_LOG(gDLTContext, DLT_LOG_INFO, DLT_STRING("pclKeyUnRegisterNotifyOnChange: "),
- // DLT_INT(ldbid), DLT_STRING(resource_id) );
-
return regNotifyOnChange(ldbid, resource_id, user_no, seat_no, callback, Notify_unregister);
}
int pclKeyRegisterNotifyOnChange(unsigned int ldbid, const char* resource_id, unsigned int user_no, unsigned int seat_no, pclChangeNotifyCallback_t callback)
{
- //DLT_LOG(gDLTContext, DLT_LOG_INFO, DLT_STRING("pclKeyRegisterNotifyOnChange: "),
- // DLT_INT(ldbid), DLT_STRING(resource_id) );
-
return regNotifyOnChange(ldbid, resource_id, user_no, seat_no, callback, Notify_register);
}
char dbKey[DbKeyMaxLen] = {0}; // database key
char dbPath[DbPathMaxLen] = {0}; // database location
- //DLT_LOG(gDLTContext, DLT_LOG_INFO, DLT_STRING("pclKeyRegisterNotifyOnChange: "), DLT_INT(ldbid), DLT_STRING(resource_id) );
-
dbContext.context.ldbid = ldbid;
dbContext.context.seat_no = seat_no;
dbContext.context.user_no = user_no;
// get database context: database path and database key
rval = get_db_context(&dbContext, resource_id, ResIsNoFile, dbKey, dbPath);
- // registration is only on shared and custom keys possible
- if( (dbContext.configKey.storage != PersistenceStorage_local)
- && (dbContext.configKey.type == PersistenceResourceType_key) )
- {
- rval = persistence_notify_on_change(dbKey, ldbid, user_no, seat_no, callback, regPolicy);
+ if (rval==0) // no error, key found
+ {
+ // registration is only on shared and custom keys possible
+ if( (dbContext.configKey.storage != PersistenceStorage_local)
+ && (dbContext.configKey.type == PersistenceResourceType_key) )
+ {
+ rval = persistence_notify_on_change(dbKey, ldbid, user_no, seat_no, callback, regPolicy);
+ }
+ else
+ {
+ DLT_LOG(gPclDLTContext, DLT_LOG_ERROR,
+ DLT_STRING("regNotifyOnChange: Not allowed! Resource is local or it is a file:"),
+ DLT_STRING(resource_id));
+ rval = EPERS_NOTIFY_NOT_ALLOWED;
+ }
}
else
{
- DLT_LOG(gPclDLTContext, DLT_LOG_ERROR, DLT_STRING("pclKeyRegisterNotifyOnChange: error - resource is not a shared resource or resource is not a key"));
- rval = EPERS_NOTIFY_NOT_ALLOWED;
+ DLT_LOG(gPclDLTContext, DLT_LOG_ERROR,
+ DLT_STRING("regNotifyOnChange: Not possible! get_db_context() returned:"),
+ DLT_INT(rval));
}
}
if((resourceFound == 0) && (dbContext->context.ldbid == 0xFF) ) // create only when the resource is local data
{
- DLT_LOG(gPclDLTContext, DLT_LOG_INFO, DLT_STRING("get_db_context => resource in rct table not found: "), DLT_STRING(resource_id) );
//
// resource NOT found in resource table ==> default is local cached key
//
DLT_LOG(gPclDLTContext, DLT_LOG_INFO, DLT_STRING("get_db_context => create resource not in PRCT => key:"), DLT_STRING(resource_id) );
- // send create notification
- rval = pers_send_Notification_Signal(dbKey, &dbContext->context, pclNotifyStatus_created);
-
rval = get_db_path_and_key(dbContext, resource_id, dbKey, dbPath);
}
+ /* rval contains the return value of function get_db_path_and_key() if positive structure content 'dbContext' is valid.
+ * rval can be 0,1 or 2 but get_db_context should only return '0' for success. */
+ if (0 < rval)
+ {
+ rval = 0;
+ }
return rval;
}
//
// create resource database key
//
- if((dbContext->context.ldbid < 0x80) || (dbContext->context.ldbid == 0xFF) )
+ if(((dbContext->context.ldbid < 0x80) || (dbContext->context.ldbid == 0xFF)) && (NULL != dbKey))
{
// The LDBID is used to find the DBID in the resource table.
if((dbContext->context.user_no == 0) && (dbContext->context.seat_no == 0))
storePolicy = PersistenceStorage_local;
}
- if((dbContext->context.ldbid >= 0x80) && (dbContext->context.ldbid != 0xFF))
+ if((dbContext->context.ldbid >= 0x80) && (dbContext->context.ldbid != 0xFF) && (NULL != dbKey))
{
// The LDBID is used to find the DBID in the resource table.
// /<LDBID parameter> is added in front of the resource ID as the key string.
projects / profile / ivi / persistence-client-library.git / commitdiff