1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
|
/******************************************************************************
* Project Persistency
* (c) copyright 2012
* Company XS Embedded GmbH
*****************************************************************************/
/******************************************************************************
* This Source Code Form is subject to the terms of the
* Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed
* with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
******************************************************************************/
/**
* @file persistence_client_library.c
* @ingroup Persistence client library
* @author Ingo Huerner
* @brief Implementation of the persistence client library.
* Library provides an API to access persistent data
* @see
*/
#include "persistence_client_library_lc_interface.h"
#include "persistence_client_library_pas_interface.h"
#include "persistence_client_library_dbus_service.h"
#include "persistence_client_library_handle.h"
#include "persistence_client_library_custom_loader.h"
#include "persistence_client_library.h"
#include "persistence_client_library_backup_filelist.h"
#include "persistence_client_library_db_access.h"
#if USE_FILECACHE
#include <persistence_file_cache.h>
#endif
#include <string.h>
#include <errno.h>
#include <stdlib.h>
#include <dlfcn.h>
#include <dbus/dbus.h>
/// debug log and trace (DLT) setup
DLT_DECLARE_CONTEXT(gPclDLTContext);
static int gShutdownMode = 0;
static int gCancelCounter = 0;
int pclInitLibrary(const char* appName, int shutdownMode)
{
int status = 0;
int i = 0, rval = 1;
if(gPclInitialized == PCLnotInitialized)
{
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) );
/// environment variable for on demand loading of custom libraries
const char *pOnDemandLoad = getenv("PERS_CUSTOM_LIB_LOAD_ON_DEMAND");
/// environment variable for max key value data
const char *pDataSize = getenv("PERS_MAX_KEY_VAL_DATA_SIZE");
/// blacklist path environment variable
const char *pBlacklistPath = getenv("PERS_BLACKLIST_PATH");
#if USE_FILECACHE
printf("* * * * * * Using the filecache! * * * * * * * * *\n");
pfcInitCache(appName);
#else
printf("* * * * * * N O T using the filecache! * * * * * *\n");
#endif
#if USE_PASINTERFACE == 1
//printf("* ADMIN INTERFACE is - e n a b l e d - \n");
DLT_LOG(gPclDLTContext, DLT_LOG_INFO, DLT_STRING("PAS interface is enabled!!"));
#else
//printf("* ADMIN INTERFACE is - d i s a b l e d - enable with \"./configure --enable-pasinterface\"\n");
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)
{
gMaxKeyValDataSize = atoi(pDataSize);
}
if(pBlacklistPath == NULL)
{
pBlacklistPath = "/etc/pclBackupBlacklist.txt"; // default path
}
if(readBlacklistConfigFile(pBlacklistPath) == -1)
{
DLT_LOG(gPclDLTContext, DLT_LOG_WARN, DLT_STRING("pclInitLibrary -> failed to access blacklist:"), DLT_STRING(pBlacklistPath));
}
if(setup_dbus_mainloop() == -1)
{
DLT_LOG(gPclDLTContext, DLT_LOG_ERROR, DLT_STRING("pclInitLibrary => Failed to setup main loop"));
pthread_mutex_unlock(&gDbusPendingRegMtx);
return EPERS_DBUS_MAINLOOP;
}
if(gShutdownMode != PCL_SHUTDOWN_TYPE_NONE)
{
// register for lifecycle and persistence admin service dbus messages
if(register_lifecycle(shutdownMode) == -1)
{
DLT_LOG(gPclDLTContext, DLT_LOG_ERROR, DLT_STRING("pclInitLibrary => Failed to register to lifecycle dbus interface"));
pthread_mutex_unlock(&gDbusPendingRegMtx);
return EPERS_REGISTER_LIFECYCLE;
}
}
#if USE_PASINTERFACE == 1
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;
}
#endif
/// get custom library names to load
status = get_custom_libraries();
if(status >= 0)
{
// initialize custom library structure
for(i = 0; i < PersCustomLib_LastEntry; i++)
{
invalidate_custom_plugin(i);
}
if(pOnDemandLoad == NULL) // load all available libraries now
{
for(i=0; i < PersCustomLib_LastEntry; i++ )
{
if(check_valid_idx(i) != -1)
{
if(load_custom_library(i, &gPersCustomFuncs[i] ) == 1)
{
if( (gPersCustomFuncs[i].custom_plugin_init) != NULL)
{
DLT_LOG(gPclDLTContext, DLT_LOG_INFO, DLT_STRING("pclInitLibrary => Loaded plugin: "),
DLT_STRING(get_custom_client_lib_name(i)));
gPersCustomFuncs[i].custom_plugin_init();
}
else
{
DLT_LOG(gPclDLTContext, DLT_LOG_ERROR, DLT_STRING("pclInitLibrary => E r r o r could not load plugin functions: "),
DLT_STRING(get_custom_client_lib_name(i)));
}
}
else
{
DLT_LOG(gPclDLTContext, DLT_LOG_ERROR, DLT_STRING("pclInitLibrary => E r r o r could not load plugin: "),
DLT_STRING(get_custom_client_lib_name(i)));
}
}
else
{
continue;
}
}
}
}
else
{
DLT_LOG(gPclDLTContext, DLT_LOG_WARN, DLT_STRING("pclInit => Failed to load custom library config table => error number:"), DLT_INT(status));
}
pers_unlock_access();
// assign application name
strncpy(gAppId, appName, MaxAppNameLen);
gAppId[MaxAppNameLen-1] = '\0';
gPclInitialized++;
}
else if(gPclInitialized >= PCLinitialized)
{
gPclInitialized++; // increment init counter
DLT_LOG(gPclDLTContext, DLT_LOG_INFO, DLT_STRING("pclInitLibrary => I N I T Persistence Client Library - "), DLT_STRING(gAppId),
DLT_STRING("- ONLY INCREMENT init counter: "), DLT_INT(gPclInitialized) );
}
return rval;
}
int pclDeinitLibrary(void)
{
int i = 0, rval = 1;
if(gPclInitialized == PCLinitialized)
{
int* retval;
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
if(gShutdownMode != PCL_SHUTDOWN_TYPE_NONE)
rval = unregister_lifecycle(gShutdownMode);
#if USE_PASINTERFACE == 1
rval = unregister_pers_admin_service();
#endif
// unload custom client libraries
for(i=0; i<PersCustomLib_LastEntry; i++)
{
if(gPersCustomFuncs[i].custom_plugin_deinit != NULL)
{
// deinitialize plugin
gPersCustomFuncs[i].custom_plugin_deinit();
// close library handle
dlclose(gPersCustomFuncs[i].handle);
invalidate_custom_plugin(i);
}
}
process_prepare_shutdown(Shutdown_Full); // close all db's and fd's and block access
// end dbus library
bContinue = 0;
// send quit command to dbus mainloop
deliverToMainloop_NM(CMD_QUIT, 0, 0);
// wait until the dbus mainloop has ended
pthread_join(gMainLoopThread, (void**)&retval);
pthread_mutex_unlock(&gDbusPendingRegMtx);
pthread_mutex_unlock(&gDbusInitializedMtx);
gPclInitialized = PCLnotInitialized;
DLT_UNREGISTER_CONTEXT(gPclDLTContext);
}
else if(gPclInitialized > PCLinitialized)
{
DLT_LOG(gPclDLTContext, DLT_LOG_INFO, DLT_STRING("pclDeinitLibrary -> D E I N I T client library - "), DLT_STRING(gAppId),
DLT_STRING("- ONLY DECREMENT init counter: "), DLT_INT(gPclInitialized));
gPclInitialized--; // decrement init counter
}
else
{
rval = EPERS_NOT_INITIALIZED;
}
return rval;
}
int pclLifecycleSet(int shutdown)
{
int rval = 0;
if(gShutdownMode == PCL_SHUTDOWN_TYPE_NONE)
{
if(PCL_SHUTDOWN)
{
process_prepare_shutdown(Shutdown_Partial); // close all db's and fd's and block access
}
else if(PCL_SHUTDOWN_CANEL)
{
if(gCancelCounter < Shutdown_MaxCount)
{
pers_unlock_access();
}
else
{
rval = EPERS_SHUTDOWN_MAX_CANCEL;
}
}
else
{
rval = EPERS_COMMON;
}
}
else
{
rval = EPERS_SHUTDOWN_NO_PERMIT;
}
return rval;
}
|