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 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366
|
#!/usr/bin/env python
from __future__ import print_function
import os, re, sys, textwrap
import api_data
from dist import compare_srcfile, format_srcfile
# Temporary file.
tmp_file = '__tmp'
#####################################################################
# Update wiredtiger.in with doxygen comments
#####################################################################
f='../src/include/wiredtiger.in'
tfile = open(tmp_file, 'w')
whitespace_re = re.compile(r'\s+')
cbegin_re = re.compile(r'(\s*\*\s*)@config(?:empty|start)\{(.*?),.*\}')
def gettype(c):
'''Derive the type of a config item'''
checks = c.flags
ctype = checks.get('type', None)
if not ctype and ('min' in checks or 'max' in checks):
ctype = 'int'
return ctype or 'string'
def typedesc(c):
'''Descripe what type of value is expected for the given config item'''
checks = c.flags
cmin = str(checks.get('min', ''))
cmax = str(checks.get('max', ''))
choices = checks.get('choices', [])
ctype = gettype(c)
desc = {
'boolean' : 'a boolean flag',
'format' : 'a format string',
'int' : 'an integer',
'list' : 'a list',
'category': 'a set of related configuration options defined below',
'string' : 'a string'}[ctype]
if cmin and cmax:
desc += ' between ' + cmin + ' and ' + cmax
elif cmin:
desc += ' greater than or equal to ' + cmin
elif cmax:
desc += ' no more than ' + cmax
if choices:
if ctype == 'list':
desc += ', with values chosen from the following options: '
else:
desc += ', chosen from the following options: '
desc += ', '.join('\\c "' + c + '"' for c in choices)
elif ctype == 'list':
desc += ' of strings'
return desc
def parseconfig(c, method_name, name_indent=''):
c.method_name = method_name
ctype = gettype(c)
desc = whitespace_re.sub(' ', c.desc.strip())
desc = desc.strip('.') + '.'
desc = desc.replace(',', '\\,')
default = '\\c ' + str(c.default) if c.default or ctype == 'int' \
else 'empty'
name = name_indent + c.name
tdesc = typedesc(c)
if ctype != 'category':
tdesc += '; default ' + default
else:
name += ' = ('
tdesc += '.'
tdesc = tdesc.replace(',', '\\,')
output = '@config{' + ', '.join((name, desc, tdesc)) + '}\n'
if ctype == 'category':
for subc in sorted(c.subconfig):
output += parseconfig(subc, method_name, \
name_indent + (' ' * 4))
output += '@config{ ),,}\n'
return output
def getconfcheck(c):
check = '{ "' + c.name + '", "' + gettype(c) + '",'
cstr = checkstr(c)
sstr = getsubconfigstr(c)
if cstr != 'NULL':
cstr = '"\n\t "'.join(w.wrap(cstr))
# Manually re-wrap when there is a check string to avoid ugliness
# between string and non-string wrapping
if len(check + ' ' + cstr + ',\n\t ' + sstr + '},') >= 68:
check = check + '\n\t ' + cstr + ',\n\t ' + sstr + ' },'
else:
check = check + ' ' + cstr + ', ' + sstr + ' },'
else:
check = '\n\t '.join(
w.wrap(check + ' ' + cstr + ', ' + sstr + ' },'))
return check
skip = False
for line in open(f, 'r'):
if skip:
if '@configend' in line:
skip = False
continue
m = cbegin_re.match(line)
if not m:
tfile.write(line)
continue
prefix, config_name = m.groups()
if config_name not in api_data.methods:
print("Missing configuration for " + config_name, file=sys.stderr)
tfile.write(line)
continue
skip = ('@configstart' in line)
if not api_data.methods[config_name].config:
tfile.write(prefix + '@configempty{' + config_name +
', see dist/api_data.py}\n')
continue
tfile.write(prefix + '@configstart{' + config_name +
', see dist/api_data.py}\n')
w = textwrap.TextWrapper(width=100-len(prefix.expandtabs()),
break_on_hyphens=False,
break_long_words=False,
replace_whitespace=False,
fix_sentence_endings=True)
# Separate at spaces, and after a set of non-breaking space indicators.
w.wordsep_re = w.wordsep_simple_re = \
re.compile(r'(\s+|(?<= )[\w_,.;:]*)')
for c in api_data.methods[config_name].config:
if 'undoc' in c.flags:
continue
output = parseconfig(c, config_name)
for l in w.wrap(output):
tfile.write(prefix + l.replace('\n', '\n' + prefix) + '\n')
tfile.write(prefix + '@configend\n')
tfile.close()
compare_srcfile(tmp_file, f)
#####################################################################
# Create config_def.c with defaults for each config string
#####################################################################
f='../src/config/config_def.c'
tfile = open(tmp_file, 'w')
tfile.write('''/* DO NOT EDIT: automatically built by dist/api_config.py. */
#include "wt_internal.h"
''')
# Make a TextWrapper that wraps at commas.
w = textwrap.TextWrapper(width=64, break_on_hyphens=False,
break_long_words=False)
w.wordsep_re = w.wordsep_simple_re = re.compile(r'(,)')
# TextWrapper that wraps at whitespace.
ws = textwrap.TextWrapper(width=64, break_on_hyphens=False,
break_long_words=False)
def checkstr(c):
'''Generate the function reference and JSON string used by __wt_config_check
to validate the config string'''
checks = c.flags
cfunc = str(checks.get('func', ''))
if not cfunc:
cfunc = 'NULL';
cmin = str(checks.get('min', ''))
cmax = str(checks.get('max', ''))
choices = checks.get('choices', [])
result = []
if cmin:
result.append('min=' + cmin)
if cmax:
result.append('max=' + cmax)
if choices:
result.append('choices=' + '[' +
','.join('\\"' + s + '\\"' for s in choices) + ']')
if result:
return cfunc + ', "' + ','.join(result) + '"'
else:
return cfunc + ', NULL'
def get_default(c):
t = gettype(c)
if c.default == 'false':
return 'false'
elif c.default == 'true':
return 'true'
elif t == 'string' and c.default == 'none' and \
not c.flags.get('choices', []):
return ''
elif t == 'category':
return '(%s)' % (','.join('%s=%s' % (subc.name, get_default(subc))
for subc in sorted(c.subconfig)))
elif c.default or t == 'int':
return str(c.default).replace('"', '\\"')
else:
return ''
created_subconfigs=set()
def add_subconfig(c, cname):
if cname in created_subconfigs:
return
created_subconfigs.add(cname)
tfile.write('''
%(name)s[] = {
\t%(check)s
\t{ NULL, NULL, NULL, NULL, NULL, 0 }
};
''' % {
'name' : '\n '.join(ws.wrap(\
'static const WT_CONFIG_CHECK confchk_' + cname + '_subconfigs')),
'check' : '\n\t'.join(getconfcheck(subc) for subc in sorted(c.subconfig)),
})
def getcname(c):
'''Return the C name of a sub configuration'''
prefix = c.method_name.replace('.', '_') + '_' \
if hasattr(c, 'method_name') else ''
return prefix + c.name
def getsubconfigstr(c):
'''Return a string indicating if an item has sub configuration'''
ctype = gettype(c)
if ctype == 'category':
cname = getcname(c)
add_subconfig(c, cname)
return 'confchk_' + cname + '_subconfigs, ' + str(len(c.subconfig))
else:
return 'NULL, 0'
# Write structures of arrays of allowable configuration options, including a
# NULL as a terminator for iteration.
for name in sorted(api_data.methods.keys()):
config = api_data.methods[name].config
if config:
tfile.write('''
static const WT_CONFIG_CHECK confchk_%(name)s[] = {
\t%(check)s
\t{ NULL, NULL, NULL, NULL, NULL, 0 }
};
''' % {
'name' : name.replace('.', '_'),
'check' : '\n\t'.join(getconfcheck(c) for c in config),
})
# Write the initialized list of configuration entry structures.
tfile.write('\n')
tfile.write('static const WT_CONFIG_ENTRY config_entries[] = {')
slot=-1
config_defines = ''
for name in sorted(api_data.methods.keys()):
config = api_data.methods[name].config
slot += 1
# Build a list of #defines that reference specific slots in the list (the
# #defines are used to avoid a list search where we know the correct slot).
config_defines +=\
'#define\tWT_CONFIG_ENTRY_' + name.replace('.', '_') + '\t' * \
max(1, 6 - (len('WT_CONFIG_ENTRY_' + name) // 8)) + \
"%2s" % str(slot) + '\n'
# Write the method name and base.
tfile.write('''
\t{ "%(name)s",
%(config)s,''' % {
'config' : '\n'.join('\t "%s"' % line
for line in w.wrap(','.join('%s=%s' % (c.name, get_default(c))
for c in config)) or [""]),
'name' : name
})
# Write the checks reference, or NULL if no related checks structure.
tfile.write('\n\t ')
if config:
tfile.write(
'confchk_' + name.replace('.', '_') + ', ' + str(len(config)))
else:
tfile.write('NULL, 0')
tfile.write('\n\t},')
# Write a NULL as a terminator for iteration.
tfile.write('\n\t{ NULL, NULL, NULL, 0 }')
tfile.write('\n};\n')
# Write the routine that connects the WT_CONNECTION_IMPL structure to the list
# of configuration entry structures.
tfile.write('''
int
__wt_conn_config_init(WT_SESSION_IMPL *session)
{
\tWT_CONNECTION_IMPL *conn;
\tconst WT_CONFIG_ENTRY *ep, **epp;
\tconn = S2C(session);
\t/* Build a list of pointers to the configuration information. */
\tWT_RET(__wt_calloc_def(session, WT_ELEMENTS(config_entries), &epp));
\tconn->config_entries = epp;
\t/* Fill in the list to reference the default information. */
\tfor (ep = config_entries;;) {
\t\t*epp++ = ep++;
\t\tif (ep->method == NULL)
\t\t\tbreak;
\t}
\treturn (0);
}
void
__wt_conn_config_discard(WT_SESSION_IMPL *session)
{
\tWT_CONNECTION_IMPL *conn;
\tconn = S2C(session);
\t__wt_free(session, conn->config_entries);
}
/*
* __wt_conn_config_match --
* Return the static configuration entry for a method.
*/
const WT_CONFIG_ENTRY *
__wt_conn_config_match(const char *method)
{
\tconst WT_CONFIG_ENTRY *ep;
\tfor (ep = config_entries; ep->method != NULL; ++ep)
\t\tif (strcmp(method, ep->method) == 0)
\t\t\treturn (ep);
\treturn (NULL);
}
''')
tfile.close()
format_srcfile(tmp_file)
compare_srcfile(tmp_file, f)
# Update the config.h file with the #defines for the configuration entries.
tfile = open(tmp_file, 'w')
skip = 0
for line in open('../src/include/config.h', 'r'):
if skip:
if 'configuration section: END' in line:
tfile.write('/*\n' + line)
skip = 0
else:
tfile.write(line)
if 'configuration section: BEGIN' in line:
skip = 1
tfile.write(' */\n')
tfile.write(config_defines)
tfile.close()
format_srcfile(tmp_file)
compare_srcfile(tmp_file, '../src/include/config.h')
|