149 lines
4.8 KiB
Python
149 lines
4.8 KiB
Python
# Output C #defines for errors into wiredtiger.in and the associated error
|
|
# message code in strerror.c.
|
|
|
|
import re, textwrap
|
|
from dist import compare_srcfile
|
|
|
|
class Error:
|
|
def __init__(self, name, value, desc, long_desc=None, **flags):
|
|
self.name = name
|
|
self.value = value
|
|
self.desc = desc
|
|
self.long_desc = long_desc
|
|
self.flags = flags
|
|
|
|
# We don't want our error returns to conflict with any other package,
|
|
# so use an uncommon range, specifically, -31,800 to -31,999.
|
|
#
|
|
# These numbers cannot change without breaking backward compatibility,
|
|
# and are listed in error value order.
|
|
errors = [
|
|
Error('WT_ROLLBACK', -31800,
|
|
'conflict between concurrent operations', '''
|
|
This error is generated when an operation cannot be completed
|
|
due to a conflict with concurrent operations. The operation
|
|
may be retried; if a transaction is in progress, it should be
|
|
rolled back and the operation retried in a new transaction.'''),
|
|
Error('WT_DUPLICATE_KEY', -31801,
|
|
'attempt to insert an existing key', '''
|
|
This error is generated when the application attempts to insert
|
|
a record with the same key as an existing record without the
|
|
'overwrite' configuration to WT_SESSION::open_cursor.'''),
|
|
Error('WT_ERROR', -31802,
|
|
'non-specific WiredTiger error', '''
|
|
This error is returned when an error is not covered by a
|
|
specific error return.'''),
|
|
Error('WT_NOTFOUND', -31803,
|
|
'item not found', '''
|
|
This error indicates an operation did not find a value to
|
|
return. This includes cursor search and other operations
|
|
where no record matched the cursor's search key such as
|
|
WT_CURSOR::update or WT_CURSOR::remove.'''),
|
|
Error('WT_PANIC', -31804,
|
|
'WiredTiger library panic', '''
|
|
This error indicates an underlying problem that requires the
|
|
application exit and restart. The application can exit
|
|
immediately when \c WT_PANIC is returned from a WiredTiger
|
|
interface, no further WiredTiger calls are required.'''),
|
|
Error('WT_RESTART', -31805,
|
|
'restart the operation (internal)', undoc=True),
|
|
]
|
|
|
|
# Update the #defines in the wiredtiger.in file.
|
|
tmp_file = '__tmp'
|
|
tfile = open(tmp_file, 'w')
|
|
skip = 0
|
|
for line in open('../src/include/wiredtiger.in', 'r'):
|
|
if not skip:
|
|
tfile.write(line)
|
|
if line.count('Error return section: END'):
|
|
tfile.write(line)
|
|
skip = 0
|
|
elif line.count('Error return section: BEGIN'):
|
|
tfile.write(' */\n')
|
|
skip = 1
|
|
for err in errors:
|
|
if 'undoc' in err.flags:
|
|
tfile.write('/*! @cond internal */\n')
|
|
tfile.write('/*!%s.%s */\n' %
|
|
(('\n * ' if err.long_desc else ' ') +
|
|
err.desc[0].upper() + err.desc[1:],
|
|
''.join('\n * ' + l for l in textwrap.wrap(
|
|
textwrap.dedent(err.long_desc).strip(), 77)) +
|
|
'\n' if err.long_desc else ''))
|
|
tfile.write('#define\t%s\t%d\n' % (err.name, err.value))
|
|
if 'undoc' in err.flags:
|
|
tfile.write('/*! @endcond */\n')
|
|
tfile.write('/*\n')
|
|
tfile.close()
|
|
compare_srcfile(tmp_file, '../src/include/wiredtiger.in')
|
|
|
|
# Output the wiredtiger_strerror code.
|
|
tmp_file = '__tmp'
|
|
tfile = open(tmp_file, 'w')
|
|
tfile.write('''/* DO NOT EDIT: automatically built by dist/api_err.py. */
|
|
|
|
#include "wt_internal.h"
|
|
|
|
/*
|
|
* wiredtiger_strerror --
|
|
*\tReturn a string for any error value.
|
|
*/
|
|
const char *
|
|
wiredtiger_strerror(int error)
|
|
{
|
|
\tstatic char errbuf[64];
|
|
\tchar *p;
|
|
|
|
\tif (error == 0)
|
|
\t\treturn ("Successful return: 0");
|
|
|
|
\tswitch (error) {
|
|
''')
|
|
|
|
for err in errors:
|
|
tfile.write('\tcase ' + err.name + ':\n')
|
|
tfile.write('\t\treturn ("' + err.name + ': ' + err.desc + '");\n')
|
|
|
|
tfile.write('''\
|
|
\tdefault:
|
|
\t\tif (error > 0 && (p = strerror(error)) != NULL)
|
|
\t\t\treturn (p);
|
|
\t\tbreak;
|
|
\t}
|
|
|
|
\t/*
|
|
\t * !!!
|
|
\t * Not thread-safe, but this is never supposed to happen.
|
|
\t */
|
|
\t(void)snprintf(errbuf, sizeof(errbuf), "Unknown error: %d", error);
|
|
\treturn (errbuf);
|
|
}
|
|
''')
|
|
tfile.close()
|
|
compare_srcfile(tmp_file, '../src/conn/api_strerror.c')
|
|
|
|
# Update the error documentation block.
|
|
doc = '../src/docs/error-handling.dox'
|
|
tmp_file = '__tmp'
|
|
tfile = open(tmp_file, 'w')
|
|
skip = 0
|
|
for line in open(doc, 'r'):
|
|
if not skip:
|
|
tfile.write(line)
|
|
if line.count('IGNORE_BUILT_BY_API_ERR_END'):
|
|
tfile.write(line)
|
|
skip = 0
|
|
elif line.count('IGNORE_BUILT_BY_API_ERR_BEGIN'):
|
|
tfile.write('@endif\n\n')
|
|
skip = 1
|
|
|
|
for err in errors:
|
|
if 'undoc' in err.flags:
|
|
continue
|
|
tfile.write(
|
|
'@par <code>' + err.name.upper() + '</code>\n' +
|
|
" ".join(err.long_desc.split()) + '\n\n')
|
|
tfile.close()
|
|
compare_srcfile(tmp_file, doc)
|