condTimedWait fixed
[public/netxms.git] / include / nms_util.h
1 /*
2 ** NetXMS - Network Management System
3 ** Copyright (C) 2003 Victor Kirhenshtein
4 **
5 ** This program is free software; you can redistribute it and/or modify
6 ** it under the terms of the GNU General Public License as published by
7 ** the Free Software Foundation; either version 2 of the License, or
8 ** (at your option) any later version.
9 **
10 ** This program is distributed in the hope that it will be useful,
11 ** but WITHOUT ANY WARRANTY; without even the implied warranty of
12 ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 ** GNU General Public License for more details.
14 **
15 ** You should have received a copy of the GNU General Public License
16 ** along with this program; if not, write to the Free Software
17 ** Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
18 **
19 ** $module: nms_util.h
20 **
21 **/
22
23 #ifndef _nms_util_h_
24 #define _nms_util_h_
25
26 #ifdef _WIN32
27 #ifdef LIBNETXMS_EXPORTS
28 #define LIBNETXMS_EXPORTABLE __declspec(dllexport)
29 #else
30 #define LIBNETXMS_EXPORTABLE __declspec(dllimport)
31 #endif
32 #else /* _WIN32 */
33 #define LIBNETXMS_EXPORTABLE
34 #endif
35
36
37 #include <nms_common.h>
38 #include <nms_cscp.h>
39 #include <time.h>
40
41 #if HAVE_BYTESWAP_H
42 #include <byteswap.h>
43 #endif
44
45 #define INVALID_INDEX 0xFFFFFFFF
46 #define CSCP_TEMP_BUF_SIZE 65536
47 #define MD5_DIGEST_SIZE 16
48 #define SHA1_DIGEST_SIZE 20
49
50
51 //
52 // Return codes for IcmpPing()
53 //
54
55 #define ICMP_SUCCESS 0
56 #define ICMP_UNREACHEABLE 1
57 #define ICMP_TIMEOUT 2
58 #define ICMP_RAW_SOCK_FAILED 3
59
60
61 //
62 // Token types for configuration loader
63 //
64
65 #define CT_LONG 0
66 #define CT_STRING 1
67 #define CT_STRING_LIST 2
68 #define CT_END_OF_LIST 3
69 #define CT_BOOLEAN 4
70 #define CT_WORD 5
71 #define CT_IGNORE 6
72
73
74 //
75 // Return codes for NxLoadConfig()
76 //
77
78 #define NXCFG_ERR_OK 0
79 #define NXCFG_ERR_NOFILE 1
80 #define NXCFG_ERR_SYNTAX 2
81
82
83 //
84 // Configuration item template for configuration loader
85 //
86
87 typedef struct
88 {
89 TCHAR szToken[64];
90 BYTE iType;
91 BYTE cSeparator; // Separator character for lists
92 WORD wListElements; // Number of list elements, should be set to 0 before calling NxLoadConfig()
93 DWORD dwBufferSize; // Buffer size for strings or flag to be set for CT_BOOLEAN
94 DWORD dwBufferPos; // Should be set to 0
95 void *pBuffer;
96 } NX_CFG_TEMPLATE;
97
98
99 //
100 // getopt() prototype if needed
101 //
102
103 #ifdef _WIN32
104 #include <getopt.h>
105 #endif
106
107
108 //
109 // Win32 API functions missing under WinCE
110 //
111
112 #ifdef UNDER_CE
113
114 inline void GetSystemTimeAsFileTime(LPFILETIME pFt)
115 {
116 SYSTEMTIME sysTime;
117
118 GetSystemTime(&sysTime);
119 SystemTimeToFileTime(&sysTime, pFt);
120 }
121
122 #endif // UNDER_CE
123
124
125 //
126 // Structures for opendir() / readdir() / closedir()
127 //
128
129 #ifdef _WIN32
130
131 typedef struct dirent
132 {
133 long d_ino; /* inode number (not used by MS-DOS) */
134 int d_namlen; /* Name length */
135 char d_name[257]; /* file name */
136 } _DIRECT;
137
138 typedef struct _dir_struc
139 {
140 char *start; /* Starting position */
141 char *curr; /* Current position */
142 long size; /* Size of string table */
143 long nfiles; /* number if filenames in table */
144 struct dirent dirstr; /* Directory structure to return */
145 } DIR;
146
147 #endif /* _WIN32 */
148
149
150 //
151 // Functions
152 //
153
154
155 #if WORDS_BIGENDIAN
156 #define htonq(x) (x)
157 #define ntohq(x) (x)
158 #define htond(x) (x)
159 #define ntohd(x) (x)
160 #define SwapWideString(x)
161 #else
162 #define htonq(x) __bswap_64(x)
163 #define ntohq(x) __bswap_64(x)
164 #define htond(x) __bswap_double(x)
165 #define ntohd(x) __bswap_double(x)
166 #define SwapWideString(x) __bswap_wstr(x)
167 #endif
168
169 #ifdef __cplusplus
170 extern "C"
171 {
172 #endif
173 int SendEx(int, const void *, size_t, int);
174 #if defined(_WIN32) || !(HAVE_DECL___BSWAP_64)
175 QWORD LIBNETXMS_EXPORTABLE __bswap_64(QWORD qwVal);
176 #endif
177 double LIBNETXMS_EXPORTABLE __bswap_double(double dVal);
178 void LIBNETXMS_EXPORTABLE __bswap_wstr(WCHAR *pStr);
179
180 #if !defined(_WIN32) && !defined(_NETWARE)
181 void LIBNETXMS_EXPORTABLE strupr(TCHAR *in);
182 #endif
183
184 INT64 LIBNETXMS_EXPORTABLE GetCurrentTimeMs(void);
185 QWORD LIBNETXMS_EXPORTABLE FileSize(TCHAR *pszFileName);
186
187 int LIBNETXMS_EXPORTABLE BitsInMask(DWORD dwMask);
188 TCHAR LIBNETXMS_EXPORTABLE *IpToStr(DWORD dwAddr, TCHAR *szBuffer);
189
190 void LIBNETXMS_EXPORTABLE *nx_memdup(const void *pData, DWORD dwSize);
191 void LIBNETXMS_EXPORTABLE nx_memswap(void *pBlock1, void *pBlock2, DWORD dwSize);
192
193 void LIBNETXMS_EXPORTABLE BinToStr(BYTE *pData, DWORD dwSize, char *pStr);
194 DWORD LIBNETXMS_EXPORTABLE StrToBin(char *pStr, BYTE *pData, DWORD dwSize);
195
196 void LIBNETXMS_EXPORTABLE StrStrip(TCHAR *pszStr);
197 BOOL LIBNETXMS_EXPORTABLE MatchString(const TCHAR *pattern, const TCHAR *string, BOOL matchCase);
198 TCHAR LIBNETXMS_EXPORTABLE *ExtractWord(TCHAR *line, TCHAR *buffer);
199 BOOL LIBNETXMS_EXPORTABLE IsValidObjectName(TCHAR *pszName);
200 void LIBNETXMS_EXPORTABLE TranslateStr(TCHAR *pszString, TCHAR *pszSubStr, TCHAR *pszReplace);
201 TCHAR LIBNETXMS_EXPORTABLE *GetCleanFileName(TCHAR *pszFileName);
202
203 DWORD LIBNETXMS_EXPORTABLE CalculateCRC32(const unsigned char *pData, DWORD dwSize, DWORD dwCRC);
204 void LIBNETXMS_EXPORTABLE CalculateMD5Hash(const unsigned char *data, int nbytes, unsigned char *hash);
205 void LIBNETXMS_EXPORTABLE CalculateSHA1Hash(unsigned char *data, int nbytes, unsigned char *hash);
206 BOOL LIBNETXMS_EXPORTABLE CalculateFileMD5Hash(TCHAR *pszFileName, BYTE *pHash);
207 BOOL LIBNETXMS_EXPORTABLE CalculateFileSHA1Hash(TCHAR *pszFileName, BYTE *pHash);
208 BOOL LIBNETXMS_EXPORTABLE CalculateFileCRC32(TCHAR *pszFileName, DWORD *pResult);
209
210 DWORD LIBNETXMS_EXPORTABLE IcmpPing(DWORD dwAddr, int iNumRetries, DWORD dwTimeout, DWORD *pdwRTT);
211
212 DWORD LIBNETXMS_EXPORTABLE NxLoadConfig(TCHAR *pszFileName, TCHAR *pszSection,
213 NX_CFG_TEMPLATE *pTemplateList, BOOL bPrint);
214 int LIBNETXMS_EXPORTABLE NxDCIDataTypeFromText(TCHAR *pszText);
215
216 HMODULE LIBNETXMS_EXPORTABLE DLOpen(TCHAR *szLibName, TCHAR *pszErrorText);
217 void LIBNETXMS_EXPORTABLE DLClose(HMODULE hModule);
218 void LIBNETXMS_EXPORTABLE *DLGetSymbolAddr(HMODULE hModule, TCHAR *szSymbol, TCHAR *pszErrorText);
219
220 void LIBNETXMS_EXPORTABLE InitSubAgentsLogger(void (* pFunc)(int, TCHAR *));
221
222 #ifdef _WIN32
223 TCHAR LIBNETXMS_EXPORTABLE *GetSystemErrorText(DWORD dwError, TCHAR *pszBuffer, int iBufSize);
224 #endif
225
226 #if !(HAVE_DAEMON)
227 int LIBNETXMS_EXPORTABLE daemon(int nochdir, int noclose);
228 #endif
229
230 DWORD LIBNETXMS_EXPORTABLE inet_addr_w(WCHAR *pszAddr);
231
232 #ifndef _WIN32
233 #if !(HAVE_WCSLEN)
234 int LIBNETXMS_EXPORTABLE wcslen(WCHAR *pStr);
235 #endif
236 int LIBNETXMS_EXPORTABLE WideCharToMultiByte(int iCodePage, DWORD dwFlags, WCHAR *pWideCharStr,
237 int cchWideChar, char *pByteStr, int cchByteChar,
238 char *pDefaultChar, BOOL *pbUsedDefChar);
239 int LIBNETXMS_EXPORTABLE MultiByteToWideChar(int iCodePage, DWORD dwFlags, char *pByteStr,
240 int cchByteChar, WCHAR *pWideCharStr,
241 int cchWideChar);
242 #endif
243
244 #if !(HAVE_STRTOLL)
245 INT64 LIBNETXMS_EXPORTABLE strtoll(const char *nptr, char **endptr, int base);
246 #endif
247 #if !(HAVE_STRTOULL)
248 QWORD LIBNETXMS_EXPORTABLE strtoull(const char *nptr, char **endptr, int base);
249 #endif
250
251 #ifdef _WIN32
252 DIR LIBNETXMS_EXPORTABLE *opendir(const char *filename);
253 struct dirent LIBNETXMS_EXPORTABLE *readdir(DIR *dirp);
254 int LIBNETXMS_EXPORTABLE closedir(DIR *dirp);
255 #endif
256
257 #if defined(_WIN32) || !(HAVE_SCANDIR)
258 int LIBNETXMS_EXPORTABLE scandir(const char *dir, struct dirent ***namelist,
259 int (*select)(const struct dirent *),
260 int (*compar)(const struct dirent **, const struct dirent **));
261 int LIBNETXMS_EXPORTABLE alphasort(const struct dirent **a, const struct dirent **b);
262 #endif
263
264 #ifdef __cplusplus
265 }
266 #endif
267
268 #endif /* _nms_util_h_ */