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
|
/* obj.c
*
* This file implements a generic object "class". All other classes can
* use the service of this base class here to include auto-destruction and
* other capabilities in a generic manner.
*
* File begun on 2008-01-04 by RGerhards
*
* Copyright 2008 Rainer Gerhards and Adiscon GmbH.
*
* This file is part of rsyslog.
*
* Rsyslog is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Rsyslog is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with Rsyslog. If not, see <http://www.gnu.org/licenses/>.
*
* A copy of the GPL can be found in the file "COPYING" in this distribution.
*/
#include "config.h"
#include <stdlib.h>
#include <string.h>
#include <assert.h>
#include "rsyslog.h"
#include "srUtils.h"
#include "obj.h"
/* static data */
/* methods */
/* This is a dummy method to be used when a standard method has not been
* implemented by an object. Having it allows us to simply call via the
* jump table without any NULL pointer checks - which gains quite
* some performance. -- rgerhards, 2008-01-04
*/
static rsRetVal objInfoNotImplementedDummy(void __attribute__((unused)) *pThis)
{
return RS_RET_NOT_IMPLEMENTED;
}
/* construct an object Info object. Each class shall do this on init. The
* resulting object shall be cached during the lifetime of the class and each
* object shall receive a reference. A constructor MUST be provided for all
* objects, thus it is in the parameter list.
* pszName must point to constant pool memory. It is never freed.
*/
rsRetVal objInfoConstruct(objInfo_t **ppThis, objID_t objID, uchar *pszName, int iObjVers, rsRetVal (*pDestruct)(void *))
{
DEFiRet;
int i;
objInfo_t *pThis;
assert(ppThis != NULL);
assert(pDestruct != NULL);
if((pThis = calloc(1, sizeof(objInfo_t))) == NULL)
ABORT_FINALIZE(RS_RET_OUT_OF_MEMORY);
pThis->pszName = pszName;
pThis->iObjVers = iObjVers;
pThis->objID = objID;
pThis->objMethods[0] = pDestruct;
for(i = 1 ; i < OBJ_NUM_METHODS ; ++i) {
pThis->objMethods[i] = objInfoNotImplementedDummy;
}
*ppThis = pThis;
finalize_it:
return iRet;
}
/* set a method handler */
rsRetVal objInfoSetMethod(objInfo_t *pThis, objMethod_t objMethod, rsRetVal (*pHandler)(void*))
{
assert(pThis != NULL);
assert(objMethod > 0 && objMethod < OBJ_NUM_METHODS);
pThis->objMethods[objMethod] = pHandler;
return RS_RET_OK;
}
/* --------------- object serializiation / deserialization support --------------- */
/* begin serialization of an object
*/
rsRetVal objBeginSerialize(rsCStrObj **ppCStr, obj_t *pObj)
{
DEFiRet;
rsCStrObj *pCStr;
assert(ppCStr != NULL);
assert(pObj != NULL);
if((pCStr = rsCStrConstruct()) == NULL)
ABORT_FINALIZE(RS_RET_OUT_OF_MEMORY);
/* cookie-char */
CHKiRet(rsCStrAppendChar(pCStr, '$'));
/* serializer version (so far always 1) */
CHKiRet(rsCStrAppendChar(pCStr, '1'));
CHKiRet(rsCStrAppendChar(pCStr, ':'));
/* object Name */
CHKiRet(rsCStrAppendStr(pCStr, objGetName(pObj)));
CHKiRet(rsCStrAppendChar(pCStr, ':'));
/* object version */
CHKiRet(rsCStrAppendInt(pCStr, objGetVersion(pObj)));
/* record trailer */
CHKiRet(rsCStrAppendChar(pCStr, '\n'));
*ppCStr = pCStr;
finalize_it:
return iRet;
}
/* append a property
*/
rsRetVal objSerializeProp(rsCStrObj *pCStr, uchar *pszPropName, propertyType_t propType, void *pUsr)
{
DEFiRet;
uchar *pszBuf;
size_t lenBuf;
uchar szBuf[64];
assert(pCStr != NULL);
assert(pszPropName != NULL);
/* if we have no user pointer, there is no need to write this property.
* TODO: think if that's the righ point of view
* rgerhards, 2008-01-06
*/
if(pUsr == NULL)
ABORT_FINALIZE(RS_RET_OK);
switch(propType) {
case PROPTYPE_PSZ:
pszBuf = (uchar*) pUsr;
lenBuf = strlen((char*) pszBuf);
break;
case PROPTYPE_SHORT:
CHKiRet(srUtilItoA((char*) szBuf, sizeof(szBuf), (long) *((short*) pUsr)));
pszBuf = szBuf;
lenBuf = strlen((char*) szBuf);
break;
case PROPTYPE_INT:
CHKiRet(srUtilItoA((char*) szBuf, sizeof(szBuf), (long) *((int*) pUsr)));
pszBuf = szBuf;
lenBuf = strlen((char*) szBuf);
break;
}
/* name */
CHKiRet(rsCStrAppendStr(pCStr, pszPropName));
CHKiRet(rsCStrAppendChar(pCStr, ':'));
/* type */
CHKiRet(rsCStrAppendInt(pCStr, (int) propType));
CHKiRet(rsCStrAppendChar(pCStr, ':'));
/* length */
CHKiRet(rsCStrAppendInt(pCStr, lenBuf));
CHKiRet(rsCStrAppendChar(pCStr, ':'));
/* data */
CHKiRet(rsCStrAppendStrWithLen(pCStr, (uchar*) pszBuf, lenBuf));
/* trailer */
CHKiRet(rsCStrAppendChar(pCStr, '\n'));
finalize_it:
return iRet;
}
/* end serialization of an object. The caller receives a
* standard C string, which he must free when no longer needed.
*/
rsRetVal objEndSerialize(rsCStrObj *pCStr, uchar **ppSz)
{
DEFiRet;
assert(pCStr != NULL);
assert(pCStr != NULL);
CHKiRet(rsCStrAppendStr(pCStr, (uchar*) ".EndObj.\n"));
CHKiRet(rsCStrFinish(pCStr));
CHKiRet(rsCStrConvSzStrAndDestruct(pCStr, ppSz, 0));
pCStr = NULL;
finalize_it:
if(pCStr != NULL)
rsCStrDestruct(pCStr);
return iRet;
}
/* --------------- end object serializiation / deserialization support --------------- */
/*
* vi:set ai:
*/
|
