src/persistence_client_library.c

   1 /******************************************************************************
   2  * Project         Persistency
   3  * (c) copyright   2012
   4  * Company         XS Embedded GmbH
   5  *****************************************************************************/
   6 /******************************************************************************
   7  * This Source Code Form is subject to the terms of the
   8  * Mozilla Public License, v. 2.0. If a  copy of the MPL was not distributed
   9  * with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
  10 ******************************************************************************/
  11  /**
  12  * @file           persistence_client_library.c
  13  * @ingroup        Persistence client library
  14  * @author         Ingo Huerner
  15  * @brief          Implementation of the persistence client library.
  16  *                 Library provides an API to access persistent data
  17  * @see
  18  */
  19
  20
  21 #include "persistence_client_library_lc_interface.h"
  22 #include "persistence_client_library_pas_interface.h"
  23 #include "persistence_client_library_dbus_service.h"
  24 #include "persistence_client_library_handle.h"
  25 #include "persistence_client_library_custom_loader.h"
  26 #include "persistence_client_library.h"
  27 #include "persistence_client_library_backup_filelist.h"
  28
  29 #include <string.h>
  30 #include <errno.h>
  31 #include <stdlib.h>
  32 #include <dlfcn.h>
  33
  34 #include <dlt/dlt.h>
  35 #include <dlt/dlt_common.h>
  36
  37 #include <dbus/dbus.h>
  38
  39 /// debug log and trace (DLT) setup
  40 DLT_DECLARE_CONTEXT(gDLTContext);
  41
  42 // declared in persistence_client_library_dbus_service.c
  43 // used to end dbus library
  44 extern int bContinue;
  45
  46 static int gShutdownMode = 0;
  47
  48 /// loical function declaration
  49 void invalidateCustomPlugin(int idx);
  50
  51 int pclInitLibrary(const char* appName, int shutdownMode)
  52 {
  53    int status = 0;
  54    int i = 0, rval = 1;
  55
  56    if(gPclInitialized == PCLnotInitialized)
  57    {
  58       gShutdownMode = shutdownMode;
  59
  60       DLT_REGISTER_CONTEXT(gDLTContext,"pers","Context for persistence client library logging");
  61       DLT_LOG(gDLTContext, DLT_LOG_INFO, DLT_STRING("pclInitLibrary => I N I T  Persistence Client Library - "), DLT_STRING(gAppId),
  62                            DLT_STRING("- init counter: "), DLT_INT(gPclInitialized) );
  63
  64       /// environment variable for on demand loading of custom libraries
  65       const char *pOnDemandLoad = getenv("PERS_CUSTOM_LIB_LOAD_ON_DEMAND");
  66
  67       /// environment variable for max key value data
  68       const char *pDataSize = getenv("PERS_MAX_KEY_VAL_DATA_SIZE");
  69
  70       /// blacklist path environment variable
  71       const char *pBlacklistPath = getenv("PERS_BLACKLIST_PATH");
  72
  73       if(pDataSize != NULL)
  74       {
  75          gMaxKeyValDataSize = atoi(pDataSize);
  76       }
  77
  78       if(pBlacklistPath == NULL)
  79       {
  80          pBlacklistPath = "/etc/pclBackupBlacklist.txt";   // default path
  81       }
  82
  83       if(readBlacklistConfigFile(pBlacklistPath) == -1)
  84       {
  85          DLT_LOG(gDLTContext, DLT_LOG_WARN, DLT_STRING("pclInitLibrary -> failed to access blacklist:"), DLT_STRING(pBlacklistPath));
  86       }
  87
  88
  89       if(setup_dbus_mainloop() == -1)
  90       {
  91          DLT_LOG(gDLTContext, DLT_LOG_ERROR, DLT_STRING("pclInitLibrary => Failed to setup main loop"));
  92          return EPERS_DBUS_MAINLOOP;
  93       }
  94
  95       // register for lifecycle and persistence admin service dbus messages
  96       if(register_lifecycle(shutdownMode) == -1)
  97       {
  98          DLT_LOG(gDLTContext, DLT_LOG_ERROR, DLT_STRING("pclInitLibrary => Failed to register to lifecycle dbus interface"));
  99          return EPERS_REGISTER_LIFECYCLE;
 100       }
 101       if(register_pers_admin_service() == -1)
 102       {
 103          DLT_LOG(gDLTContext, DLT_LOG_ERROR, DLT_STRING("pclInitLibrary => Failed to register to pers admin dbus interface"));
 104          return EPERS_REGISTER_ADMIN;
 105       }
 106
 107       /// get custom library names to load
 108       status = get_custom_libraries();
 109       if(status >= 0)
 110       {
 111          // initialize custom library structure
 112          for(i = 0; i < PersCustomLib_LastEntry; i++)
 113          {
 114             invalidateCustomPlugin(i);
 115          }
 116
 117          if(pOnDemandLoad == NULL)  // load all available libraries now
 118          {
 119             for(i=0; i < PersCustomLib_LastEntry; i++ )
 120             {
 121                if(check_valid_idx(i) != -1)
 122                {
 123                   if(load_custom_library(i, &gPersCustomFuncs[i] ) == 1)
 124                   {
 125                      if( (gPersCustomFuncs[i].custom_plugin_init) != NULL)
 126                      {
 127                         DLT_LOG(gDLTContext, DLT_LOG_INFO, DLT_STRING("pclInitLibrary => Loaded plugin: "),
 128                                                            DLT_STRING(get_custom_client_lib_name(i)));
 129                         gPersCustomFuncs[i].custom_plugin_init();
 130                      }
 131                      else
 132                      {
 133                         DLT_LOG(gDLTContext, DLT_LOG_ERROR, DLT_STRING("pclInitLibrary => E r r o r could not load plugin functions: "),
 134                                                             DLT_STRING(get_custom_client_lib_name(i)));
 135                      }
 136                   }
 137                   else
 138                   {
 139                      DLT_LOG(gDLTContext, DLT_LOG_ERROR, DLT_STRING("pclInitLibrary => E r r o r could not load plugin: "),
 140                                           DLT_STRING(get_custom_client_lib_name(i)));
 141                   }
 142                }
 143                else
 144                {
 145                   continue;
 146                }
 147             }
 148          }
 149       }
 150       else
 151       {
 152          DLT_LOG(gDLTContext, DLT_LOG_WARN, DLT_STRING("pclInit => Failed to load custom library config table => error number:"), DLT_INT(status));
 153       }
 154
 155       // assign application name
 156       strncpy(gAppId, appName, MaxAppNameLen);
 157       gAppId[MaxAppNameLen-1] = '\0';
 158
 159       // destory mutex
 160       pthread_mutex_destroy(&gDbusInitializedMtx);
 161       pthread_cond_destroy(&gDbusInitializedCond);
 162
 163       gPclInitialized++;
 164    }
 165    else if(gPclInitialized >= PCLinitialized)
 166    {
 167       gPclInitialized++; // increment init counter
 168       DLT_LOG(gDLTContext, DLT_LOG_INFO, DLT_STRING("pclInitLibrary => I N I T  Persistence Client Library - "), DLT_STRING(gAppId),
 169                            DLT_STRING("- ONLY INCREMENT init counter: "), DLT_INT(gPclInitialized) );
 170    }
 171
 172    return rval;
 173 }
 174
 175
 176
 177 int pclDeinitLibrary(void)
 178 {
 179    int i = 0, rval = 1;
 180
 181    if(gPclInitialized == PCLinitialized)
 182    {
 183       DLT_LOG(gDLTContext, DLT_LOG_INFO, DLT_STRING("pclDeinitLibrary -> D E I N I T  client library - "), DLT_STRING(gAppId),
 184                                            DLT_STRING("- init counter: "), DLT_INT(gPclInitialized));
 185
 186       // unregister for lifecycle and persistence admin service dbus messages
 187       rval = unregister_lifecycle(gShutdownMode);
 188       rval = unregister_pers_admin_service();
 189
 190       // unload custom client libraries
 191       for(i=0; i<PersCustomLib_LastEntry; i++)
 192       {
 193          if(gPersCustomFuncs[i].custom_plugin_deinit != NULL)
 194          {
 195             // deinitialize plugin
 196             gPersCustomFuncs[i].custom_plugin_deinit();
 197             // close library handle
 198             dlclose(gPersCustomFuncs[i].handle);
 199
 200             invalidateCustomPlugin(i);
 201          }
 202       }
 203
 204       gPclInitialized = PCLnotInitialized;
 205
 206       DLT_UNREGISTER_CONTEXT(gDLTContext);
 207    }
 208    else if(gPclInitialized > PCLinitialized)
 209    {
 210       DLT_LOG(gDLTContext, DLT_LOG_INFO, DLT_STRING("pclDeinitLibrary -> D E I N I T  client library - "), DLT_STRING(gAppId),
 211                                            DLT_STRING("- ONLY DECREMENT init counter: "), DLT_INT(gPclInitialized));
 212       gPclInitialized--;   // decrement init counter
 213    }
 214
 215    // end dbus library
 216    bContinue = FALSE;
 217
 218    return rval;
 219 }
 220
 221
 222
 223 void invalidateCustomPlugin(int idx)
 224 {
 225    gPersCustomFuncs[idx].handle  = NULL;
 226    gPersCustomFuncs[idx].custom_plugin_init = NULL;
 227    gPersCustomFuncs[idx].custom_plugin_deinit = NULL;
 228    gPersCustomFuncs[idx].custom_plugin_handle_open = NULL;
 229    gPersCustomFuncs[idx].custom_plugin_handle_close = NULL;
 230    gPersCustomFuncs[idx].custom_plugin_handle_get_data = NULL;
 231    gPersCustomFuncs[idx].custom_plugin_handle_set_data  = NULL;
 232    gPersCustomFuncs[idx].custom_plugin_get_data = NULL;
 233    gPersCustomFuncs[idx].custom_plugin_set_data = NULL;
 234    gPersCustomFuncs[idx].custom_plugin_delete_data = NULL;
 235    gPersCustomFuncs[idx].custom_plugin_get_status_notification_clbk = NULL;
 236    gPersCustomFuncs[idx].custom_plugin_handle_get_size = NULL;
 237    gPersCustomFuncs[idx].custom_plugin_get_size = NULL;
 238    gPersCustomFuncs[idx].custom_plugin_create_backup = NULL;
 239    gPersCustomFuncs[idx].custom_plugin_get_backup = NULL;
 240    gPersCustomFuncs[idx].custom_plugin_restore_backup = NULL;
 241 }
 242
 243
 244
 245
 246