Function NxLoadConfig() (universal configuration file loader) added to libnetxms
[public/netxms.git] / include / nms_util.h
CommitLineData
e9246d26 1/*
7ac71e60 2** NetXMS - Network Management System
e9246d26
VK
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
64584976
VK
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
e9246d26
VK
37#include <nms_common.h>
38#include <nms_cscp.h>
5fad5c32 39#include <nms_threads.h>
64584976 40#include <time.h>
e9246d26 41
f52be742
VK
42#if HAVE_BYTESWAP_H
43#include <byteswap.h>
44#endif
45
5d63b3c1
VK
46#define INVALID_INDEX 0xFFFFFFFF
47#define CSCP_TEMP_BUF_SIZE 4096
89bfdd9c 48#define MD5_DIGEST_SIZE 16
d0b249a8 49#define SHA1_DIGEST_SIZE 20
5d63b3c1
VK
50
51
66c04cc7
VK
52//
53// Return codes for IcmpPing()
54//
55
56#define ICMP_SUCCESS 0
57#define ICMP_UNREACHEABLE 1
58#define ICMP_TIMEOUT 2
59#define ICMP_RAW_SOCK_FAILED 3
60
61
dcb44c9a 62//
4826c8a5 63// Token types for configuration loader
dcb44c9a
VK
64//
65
4826c8a5
VK
66#define CT_LONG 0
67#define CT_STRING 1
68#define CT_STRING_LIST 2
69#define CT_END_OF_LIST 3
70#define CT_BOOLEAN 4
71#define CT_WORD 5
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
87typedef struct
88{
89 char 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;
dcb44c9a
VK
97
98
3046f9a4
VK
99//
100// getopt() prototype if needed
101//
102
103#ifdef _WIN32
104#include <getopt.h>
105#endif
106
107
e9246d26
VK
108//
109// Functions
110//
111
43d92b4c
VK
112
113#if __BYTE_ORDER == __LITTLE_ENDIAN
114#define htonq(x) __bswap_64(x)
115#define ntohq(x) __bswap_64(x)
9f20696e
VK
116#define htond(x) __bswap_double(x)
117#define ntohd(x) __bswap_double(x)
43d92b4c
VK
118#else
119#define htonq(x) (x)
120#define ntohq(x) (x)
9f20696e
VK
121#define htond(x) (x)
122#define ntohd(x) (x)
43d92b4c 123#endif
15929b31 124
e9246d26
VK
125extern "C"
126{
f52be742 127#if defined(_WIN32) || !(HAVE_DECL___BSWAP_64)
64584976
VK
128 QWORD LIBNETXMS_EXPORTABLE __bswap_64(QWORD qwVal);
129#endif
9f20696e 130 double LIBNETXMS_EXPORTABLE __bswap_double(double dVal);
64584976
VK
131
132#ifndef _WIN32
133 void LIBNETXMS_EXPORTABLE strupr(char *in);
7e679c4b 134#endif
ab588c84 135
670c7f3d
VK
136 INT64 LIBNETXMS_EXPORTABLE GetCurrentTimeMs(void);
137
64584976
VK
138 int LIBNETXMS_EXPORTABLE BitsInMask(DWORD dwMask);
139 char LIBNETXMS_EXPORTABLE *IpToStr(DWORD dwAddr, char *szBuffer);
a1dc75b0 140
64584976
VK
141 void LIBNETXMS_EXPORTABLE *MemAlloc(DWORD dwSize);
142 void LIBNETXMS_EXPORTABLE *MemReAlloc(void *pBlock, DWORD dwNewSize);
143 void LIBNETXMS_EXPORTABLE MemFree(void *pBlock);
93b18807 144
64584976
VK
145 void LIBNETXMS_EXPORTABLE *nx_memdup(const void *pData, DWORD dwSize);
146 char LIBNETXMS_EXPORTABLE *nx_strdup(const char *pSrc);
31521248 147
64584976
VK
148 void LIBNETXMS_EXPORTABLE StrStrip(char *pszStr);
149 BOOL LIBNETXMS_EXPORTABLE MatchString(const char *pattern, const char *string, BOOL matchCase);
7774d71f 150 char LIBNETXMS_EXPORTABLE *ExtractWord(char *line, char *buffer);
64584976
VK
151
152 DWORD LIBNETXMS_EXPORTABLE CalculateCRC32(const unsigned char *data, DWORD nbytes);
a48063fc
VK
153 void LIBNETXMS_EXPORTABLE CalculateMD5Hash(const unsigned char *data, int nbytes, unsigned char *hash);
154 void LIBNETXMS_EXPORTABLE CalculateSHA1Hash(unsigned char *data, int nbytes, unsigned char *hash);
a7d07192 155 BOOL LIBNETXMS_EXPORTABLE CalculateFileMD5Hash(char *pszFileName, BYTE *pHash);
66c04cc7
VK
156
157 DWORD LIBNETXMS_EXPORTABLE IcmpPing(DWORD dwAddr, int iNumRetries, DWORD dwTimeout, DWORD *pdwRTT);
4826c8a5
VK
158
159 DWORD LIBNETXMS_EXPORTABLE NxLoadConfig(char *pszFileName, NX_CFG_TEMPLATE *pTemplateList, BOOL bPrint);
e9246d26
VK
160}
161
162#endif /* _nms_util_h_ */