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
|
/* Copyright (C) 2003 MySQL AB
This program 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; version 2 of the License.
This program 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 this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA */
#ifndef ConfigInfo_H
#define ConfigInfo_H
#ifndef NDB_MGMAPI
#include <kernel_types.h>
#include <Properties.hpp>
#include <ndb_limits.h>
#include <NdbOut.hpp>
#include "InitConfigFileParser.hpp"
#endif /* NDB_MGMAPI */
/**
* A MANDATORY parameters must be specified in the config file
* An UNDEFINED parameter may or may not be specified in the config file
*/
// Default value for mandatory params.
#define MANDATORY ((char*)~(UintPtr)0)
// Default value for undefined params.
#define UNDEFINED ((char*) 0)
/**
* @class ConfigInfo
* @brief Metainformation about ALL cluster configuration parameters
*
* Use the getters to find out metainformation about parameters.
*/
class ConfigInfo {
public:
enum Type { CI_BOOL, CI_INT, CI_INT64, CI_STRING, CI_SECTION };
enum Status { CI_USED, ///< Active
CI_DEPRICATED, ///< Can be, but shouldn't
CI_NOTIMPLEMENTED, ///< Is ignored.
CI_INTERNAL ///< Not configurable by the user
};
/**
* Entry for one configuration parameter
*/
struct ParamInfo {
Uint32 _paramId;
const char* _fname;
const char* _section;
const char* _description;
Status _status;
bool _updateable;
Type _type;
const char* _default;
const char* _min;
const char* _max;
};
#ifndef NDB_MGMAPI
struct AliasPair{
const char * name;
const char * alias;
};
/**
* Entry for one section rule
*/
struct SectionRule {
const char * m_section;
bool (* m_sectionRule)(struct InitConfigFileParser::Context &,
const char * m_ruleData);
const char * m_ruleData;
};
/**
* Entry for config rule
*/
struct ConfigRuleSection {
BaseString m_sectionType;
Properties * m_sectionData;
};
struct ConfigRule {
bool (* m_configRule)(Vector<ConfigRuleSection>&,
struct InitConfigFileParser::Context &,
const char * m_ruleData);
const char * m_ruleData;
};
ConfigInfo();
/**
* Checks if the suggested value is valid for the suggested parameter
* (i.e. if it is >= than min and <= than max).
*
* @param section Init Config file section name
* @param fname Name of parameter
* @param value Value to check
* @return true if parameter value is valid.
*
* @note Result is not defined if section/name are wrong!
*/
bool verify(const Properties* secti, const char* fname, Uint64 value) const;
static const char* nameToAlias(const char*);
static const char* getAlias(const char*);
bool isSection(const char*) const;
const char* getDescription(const Properties * sec, const char* fname) const;
Type getType(const Properties * section, const char* fname) const;
Status getStatus(const Properties* section, const char* fname) const;
Uint64 getMin(const Properties * section, const char* fname) const;
Uint64 getMax(const Properties * section, const char* fname) const;
Uint64 getDefault(const Properties * section, const char* fname) const;
const Properties * getInfo(const char * section) const;
const Properties * getDefaults(const char * section) const;
void print() const;
void print(const char* section) const;
void print(const Properties * section, const char* parameter) const;
private:
Properties m_info;
Properties m_systemDefaults;
static const AliasPair m_sectionNameAliases[];
static const char* m_sectionNames[];
static const int m_noOfSectionNames;
#endif /* NDB_MGMAPI */
public:
static const ParamInfo m_ParamInfo[];
static const int m_NoOfParams;
#ifndef NDB_MGMAPI
static const SectionRule m_SectionRules[];
static const ConfigRule m_ConfigRules[];
static const int m_NoOfRules;
#endif /* NDB_MGMAPI */
};
#endif // ConfigInfo_H
|
