# The MIT License (MIT)
#
-# Copyright (c) 2014 Philippe Proulx <philippe.proulx@efficios.com>
+# Copyright (c) 2014-2020 Philippe Proulx <pproulx@efficios.com>
#
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
#
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
-from termcolor import cprint, colored
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+# CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+# TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+import pkg_resources
+import collections
+import termcolor
import argparse
-import pytsdl.tsdl
-import pytsdl.parser
+import os.path
+import barectf
+import barectf.config_parse_common as barectf_config_parse_common
+import barectf.argpar as barectf_argpar
import sys
import os
-import re
-def _perror(msg, exit_code=1):
- cprint('Error: {}'.format(msg), 'red', attrs=['bold'], file=sys.stderr)
- sys.exit(exit_code)
+# Colors and prints the error message `msg` and exits with status code
+# 1.
+def _print_error(msg):
+ termcolor.cprint('Error: ', 'red', end='', file=sys.stderr)
+ termcolor.cprint(msg, 'red', attrs=['bold'], file=sys.stderr)
+ sys.exit(1)
-def _pinfo(msg):
- cprint(':: {}'.format(msg), 'blue', attrs=['bold'], file=sys.stderr)
+# Pretty-prints the barectf configuration error `exc` and exits with
+# status code 1.
+def _print_config_error(exc):
+ # reverse: most precise message comes last
+ for ctx in reversed(exc.context):
+ msg = ''
+ if ctx.message is not None:
+ msg = f' {ctx.message}'
-def _parse_args():
- ap = argparse.ArgumentParser()
+ color = 'red'
+ termcolor.cprint(f'{ctx.name}', color, attrs=['bold'], file=sys.stderr, end='')
+ termcolor.cprint(':', color, file=sys.stderr, end='')
+ termcolor.cprint(msg, color, file=sys.stderr)
- ap.add_argument('-O', '--output', metavar='OUTPUT', action='store',
- default=os.getcwd(),
- help='output directory of C files')
- ap.add_argument('-p', '--prefix', metavar='PREFIX', action='store',
- default='barectf',
- help='custom prefix for C function and structure names')
- ap.add_argument('-s', '--static-inline', action='store_true',
- help='generate static inline C functions')
- ap.add_argument('-c', '--manual-clock', action='store_true',
- help='do not use a clock callback: pass clock value to tracing functions')
- ap.add_argument('metadata', metavar='METADATA', action='store',
- help='CTF metadata input file')
+ sys.exit(1)
- # parse args
- args = ap.parse_args()
- # validate output directory
- if not os.path.isdir(args.output):
- _perror('"{}" is not an existing directory'.format(args.output))
+# Pretty-prints the unknown exception `exc`.
+def _print_unknown_exc(exc):
+ import traceback
- # validate prefix
- if not re.match(r'^[a-zA-Z_][a-zA-Z0-9_]*$', args.prefix):
- _perror('"{}" is not a valid C identifier'.format(args.prefix))
+ traceback.print_exc()
+ _print_error(f'Unknown exception: {exc}')
- # validate that metadata file exists
- if not os.path.isfile(args.metadata):
- _perror('"{}" is not an existing file'.format(args.metadata))
- return args
+# Finds and returns all the option items in `items` having the long name
+# `long_name`.
+def _find_opt_items(items, long_name):
+ ret_items = []
+ for item in items:
+ if type(item) is barectf_argpar._OptItem and item.descr.long_name == long_name:
+ ret_items.append(item)
-def _validate_struct(struct):
- if type(struct) is not pytsdl.tsdl.Struct:
- raise RuntimeError('expecting a struct')
+ return ret_items
- for name, ftype in struct.fields.items():
- if type(ftype) is pytsdl.tsdl.Sequence:
- raise RuntimeError('field "{}" is a dynamic array'.format(name))
- elif type(ftype) is pytsdl.tsdl.Array:
- end = False
- element = ftype.element
- while not end:
- if type(element) is pytsdl.tsdl.Sequence:
- raise RuntimeError('field "{}" contains a dynamic array'.format(name))
- elif type(element) is pytsdl.tsdl.Variant:
- raise RuntimeError('field "{}" contains a variant (unsupported)'.format(name))
- elif type(element) is pytsdl.tsdl.String:
- raise RuntimeError('field "{}" contains a string'.format(name))
- elif type(element) is pytsdl.tsdl.Struct:
- _validate_struct(element)
+# Returns:
+#
+# For an option item without an argument:
+# `True`.
+#
+# For an option item with an argument:
+# Its argument.
+#
+# Uses the last option item having the long name `long_name` found in
+# `items`.
+#
+# Returns `default` if there's no such option item.
+def _opt_item_val(items, long_name, default=None):
+ opt_items = _find_opt_items(items, long_name)
- if type(element) is pytsdl.tsdl.Array:
- element = element.element
- else:
- end = True
- elif type(ftype) is pytsdl.tsdl.Variant:
- raise RuntimeError('field "{}" is a variant (unsupported)'.format(name))
- elif type(ftype) is pytsdl.tsdl.String:
- raise RuntimeError('field "{}" is a string'.format(name))
- elif type(ftype) is pytsdl.tsdl.Struct:
- _validate_struct(ftype)
+ if len(opt_items) == 0:
+ return default
+ opt_item = opt_items[-1]
-def _validate_context_field(struct):
- if type(struct) is not pytsdl.tsdl.Struct:
- raise RuntimeError('expecting a struct')
+ if opt_item.descr.has_arg:
+ return opt_item.arg_text
- for name, ftype in struct.fields.items():
- if type(ftype) is pytsdl.tsdl.Variant:
- raise RuntimeError('field "{}" is a variant (unsupported)'.format(name))
- elif type(ftype) is pytsdl.tsdl.Struct:
- _validate_struct(ftype)
+ return True
-def _validate_integer(integer, size=None, align=None, signed=None):
- if type(integer) is not pytsdl.tsdl.Integer:
- raise RuntimeError('expected integer')
+class _CliError(Exception):
+ pass
- if size is not None:
- if integer.size != size:
- raise RuntimeError('expected {}-bit integer'.format(size))
- if align is not None:
- if integer.align != align:
- raise RuntimeError('expected integer with {}-bit alignment'.format(align))
+def _cfg_file_path_from_parse_res(parse_res):
+ cfg_file_path = None
- if signed is not None:
- if integer.signed != signed:
- raise RuntimeError('expected {} integer'.format('signed' if signed else 'unsigned'))
+ for item in parse_res.items:
+ if type(item) is barectf_argpar._NonOptItem:
+ if cfg_file_path is not None:
+ raise _CliError('Multiple configuration file paths provided')
+ cfg_file_path = item.text
-def _validate_packet_header(packet_header):
- try:
- _validate_struct(packet_header)
- except RuntimeError as e:
- _perror('packet header: {}'.format(e))
-
- # magic must be the first field
- if 'magic' in packet_header.fields:
- if list(packet_header.fields.keys())[0] != 'magic':
- _perror('packet header: "magic" must be the first field')
- else:
- _perror('packet header: missing "magic" field')
+ if cfg_file_path is None:
+ raise _CliError('Missing configuration file path')
- # magic must be a 32-bit unsigned integer, 32-bit aligned
- try:
- _validate_integer(packet_header['magic'], 32, 32, False)
- except RuntimeError as e:
- _perror('packet header: "magic": {}'.format(e))
+ if not os.path.isfile(cfg_file_path):
+ raise _CliError(f'`{cfg_file_path}` is not an existing, regular file')
+
+ return cfg_file_path
+
+
+# Returns a `_CfgCmdCfg` object from the command-line parsing results
+# `parse_res`.
+def _cfg_cmd_cfg_from_parse_res(parse_res):
+ # check configuration file path
+ cfg_file_path = _cfg_file_path_from_parse_res(parse_res)
+
+ # inclusion directories
+ inclusion_dirs = [item.arg_text for item in _find_opt_items(parse_res.items, 'include-dir')]
+
+ for dir in inclusion_dirs:
+ if not os.path.isdir(dir):
+ raise _CliError(f'`{dir}` is not an existing directory')
- # mandatory stream_id
- if 'stream_id' not in packet_header.fields:
- _perror('packet header: missing "stream_id" field')
+ inclusion_dirs.append(os.getcwd())
+
+ # other options
+ ignore_inclusion_file_not_found = _opt_item_val(parse_res.items, 'ignore-include-not-found',
+ False)
+
+ return _CfgCmdCfg(cfg_file_path, inclusion_dirs, ignore_inclusion_file_not_found)
+
+
+def _print_gen_cmd_usage():
+ print('''Usage: barectf generate [--code-dir=DIR] [--headers-dir=DIR]
+ [--metadata-dir=DIR] [--prefix=PREFIX]
+ [--include-dir=DIR]... [--ignore-include-not-found]
+ CONFIG-FILE-PATH
+ barectf generate --help
+
+Generate the C source and CTF metadata stream files of a tracer from the
+configuration file CONFIG-FILE-PATH.
+
+Options:
+ -c DIR, --code-dir=DIR Write C source files to DIR instead of the CWD
+ -H DIR, --headers-dir=DIR Write C header files to DIR instead of the CWD
+ -h, --help Show this help and quit
+ --ignore-include-not-found Continue to process the configuration file when
+ included files are not found
+ -I DIR, --include-dir=DIR Add DIR to the list of directories to be
+ searched for inclusion files
+ -m DIR, --metadata-dir=DIR Write the metadata stream file to DIR instead of
+ the CWD
+ -p PREFIX, --prefix=PREFIX Set the configuration prefix to PREFIX''')
+
+
+# Returns a source and metadata stream file generating command object
+# from the specific command-line arguments `orig_args`.
+def _gen_cmd_cfg_from_args(orig_args):
+ # parse original arguments
+ opt_descrs = [
+ barectf_argpar.OptDescr('h', 'help'),
+ barectf_argpar.OptDescr('c', 'code-dir', True),
+ barectf_argpar.OptDescr('H', 'headers-dir', True),
+ barectf_argpar.OptDescr('I', 'include-dir', True),
+ barectf_argpar.OptDescr('m', 'metadata-dir', True),
+ barectf_argpar.OptDescr('p', 'prefix', True),
+ barectf_argpar.OptDescr(long_name='dump-config'),
+ barectf_argpar.OptDescr(long_name='ignore-include-not-found'),
+ ]
+ res = barectf_argpar.parse(orig_args, opt_descrs)
+ assert len(res.ingested_orig_args) == len(orig_args)
+
+ # command help?
+ if len(_find_opt_items(res.items, 'help')) > 0:
+ _print_gen_cmd_usage()
+ sys.exit()
+
+ # get common configuration file command CLI configuration
+ cfg_cmd_cfg = _cfg_cmd_cfg_from_parse_res(res)
+
+ # directories
+ c_source_dir = _opt_item_val(res.items, 'code-dir', os.getcwd())
+ c_header_dir = _opt_item_val(res.items, 'headers-dir', os.getcwd())
+ metadata_stream_dir = _opt_item_val(res.items, 'metadata-dir', os.getcwd())
+
+ for dir in [c_source_dir, c_header_dir, metadata_stream_dir]:
+ if not os.path.isdir(dir):
+ raise _CliError(f'`{dir}` is not an existing directory')
+
+ # other options
+ dump_config = _opt_item_val(res.items, 'dump-config', False)
+ v2_prefix = _opt_item_val(res.items, 'prefix')
+
+ return _GenCmd(_GenCmdCfg(cfg_cmd_cfg.cfg_file_path, c_source_dir, c_header_dir,
+ metadata_stream_dir, cfg_cmd_cfg.inclusion_dirs,
+ cfg_cmd_cfg.ignore_inclusion_file_not_found, dump_config, v2_prefix))
+
+
+def _show_effective_cfg_cmd_usage():
+ print('''Usage: barectf show-effective-configuration [--include-dir=DIR]...
+ [--ignore-include-not-found]
+ [--indent-spaces=COUNT] CONFIG-FILE-PATH
+ barectf show-effective-configuration --help
+
+Print the effective configuration file for a the configuration file
+CONFIG-FILE-PATH.
+
+Options:
+ -h, --help Show this help and quit
+ --ignore-include-not-found Continue to process the configuration file when
+ included files are not found
+ -I DIR, --include-dir=DIR Add DIR to the list of directories to be
+ searched for inclusion files
+ --indent-spaces=COUNT Use COUNT spaces at a time to indent YAML lines
+ instead of 2''')
+
+
+# Returns an effective configuration showing command object from the
+# specific command-line arguments `orig_args`.
+def _show_effective_cfg_cfg_from_args(orig_args):
+ # parse original arguments
+ opt_descrs = [
+ barectf_argpar.OptDescr('h', 'help'),
+ barectf_argpar.OptDescr('I', 'include-dir', True),
+ barectf_argpar.OptDescr(long_name='indent-spaces', has_arg=True),
+ barectf_argpar.OptDescr(long_name='ignore-include-not-found'),
+ ]
+ res = barectf_argpar.parse(orig_args, opt_descrs)
+ assert len(res.ingested_orig_args) == len(orig_args)
+
+ # command help?
+ if len(_find_opt_items(res.items, 'help')) > 0:
+ _show_effective_cfg_cmd_usage()
+ sys.exit()
+
+ # get common configuration command CLI configuration
+ cfg_cmd_cfg = _cfg_cmd_cfg_from_parse_res(res)
+
+ # other options
+ indent_space_count = _opt_item_val(res.items, 'indent-spaces', 2)
- # stream_id must be an unsigned integer
try:
- _validate_integer(packet_header['stream_id'], signed=False)
- except RuntimeError as e:
- _perror('packet header: "stream_id": {}'.format(e))
+ indent_space_count = int(indent_space_count)
+ except (ValueError, TypeError):
+ raise _CliError(f'Invalid `--indent-spaces` option argument: `{indent_space_count}`')
+ if indent_space_count < 1 or indent_space_count > 8:
+ raise _CliError(f'Invalid `--indent-spaces` option argument (`{indent_space_count}`): expecting a value in [1, 8]')
-def _dot_name_to_str(name):
- return '.'.join(name)
+ return _ShowEffectiveCfgCmd(_ShowEffectiveCfgCmdCfg(cfg_cmd_cfg.cfg_file_path,
+ cfg_cmd_cfg.inclusion_dirs,
+ cfg_cmd_cfg.ignore_inclusion_file_not_found,
+ indent_space_count))
-def _validate_clock(doc, name):
- msg = '"{}" does not name an existing clock'.format(_dot_name_to_str(name))
+def _show_cfg_version_cmd_usage():
+ print('''Usage: barectf show-configuration-version CONFIG-FILE-PATH
+ barectf show-configuration-version --help
- if len(name) != 3:
- raise RuntimeError(msg)
+Print the major version (2 or 3) of the configuration file CONFIG-FILE-PATH.
- if name[0] != 'clock' or name[2] != 'value':
- raise RuntimeError()
+Options:
+ -h, --help Show this help and quit''')
- if name[1] not in doc.clocks:
- raise RuntimeError(msg)
+# Returns a configuration version showing command object from the
+# specific command-line arguments `orig_args`.
+def _show_cfg_version_cfg_from_args(orig_args):
+ # parse original arguments
+ opt_descrs = [
+ barectf_argpar.OptDescr('h', 'help'),
+ ]
+ res = barectf_argpar.parse(orig_args, opt_descrs)
+ assert len(res.ingested_orig_args) == len(orig_args)
-def _compare_integers(int1, int2):
- if type(int1) is not pytsdl.tsdl.Integer:
- return False
+ # command help?
+ if len(_find_opt_items(res.items, 'help')) > 0:
+ _show_cfg_version_cmd_usage()
+ sys.exit()
- if type(int2) is not pytsdl.tsdl.Integer:
- return False
+ # check configuration file path
+ cfg_file_path = _cfg_file_path_from_parse_res(res)
- size = int1.size == int2.size
- align = int1.align == int2.align
- cmap = int1.map == int2.map
- base = int1.base == int2.base
- encoding = int1.encoding == int2.encoding
- signed = int1.signed == int2.signed
- comps = (size, align, cmap, base, encoding, signed)
+ return _ShowCfgVersionCmd(_ShowCfgVersionCmdCfg(cfg_file_path))
- return sum(comps) == len(comps)
+def _print_general_usage():
+ print('''Usage: barectf COMMAND COMMAND-ARGS
+ barectf --help
+ barectf --version
-def _validate_packet_context(doc, stream):
- packet_context = stream.packet_context
- sid = stream.id
+General options:
+ -h, --help Show this help and quit
+ -V, --version Show version and quit
- try:
- _validate_struct(packet_context)
- except RuntimeError as e:
- _perror('stream {}: packet context: {}'.format(sid, e))
+Available commands:
+ gen:
+ generate:
+ Generate the C source and CTF metadata stream files of a tracer from a
+ configuration file.
+
+ show-effective-configuration:
+ show-effective-config:
+ show-effective-cfg:
+ Print the effective configuration file for a given configuration file and
+ inclusion directories.
+
+ show-configuration-version:
+ show-config-version:
+ show-cfg-version
+ Print the major version of a given configuration file.
- fields = packet_context.fields
+Run `barectf COMMAND --help` to show the help of COMMAND.''')
- # if timestamp_begin exists, timestamp_end must exist
- if 'timestamp_begin' in fields or 'timestamp_end' in fields:
- if 'timestamp_begin' not in fields or 'timestamp_end' not in fields:
- _perror('stream {}: packet context: "timestamp_begin" must exist if "timestamp_end" exists'.format(sid))
+
+# Returns a command object from the command-line arguments `orig_args`.
+#
+# All the `orig_args` elements are considered.
+def _cmd_from_args(orig_args):
+ # We use our `argpar` module here instead of Python's `argparse`
+ # because we need to support the two following use cases:
+ #
+ # $ barectf config.yaml
+ # $ barectf generate config.yaml
+ #
+ # In other words, the default command is `generate` (for backward
+ # compatibility reasons). The argument parser must not consider
+ # `config.yaml` as being a command name.
+ general_opt_descrs = [
+ barectf_argpar.OptDescr('V', 'version'),
+ barectf_argpar.OptDescr('h', 'help'),
+ ]
+ res = barectf_argpar.parse(orig_args, general_opt_descrs, False)
+
+ # find command name, collecting preceding (common) option items
+ cmd_from_args_funcs = {
+ 'generate': _gen_cmd_cfg_from_args,
+ 'gen': _gen_cmd_cfg_from_args,
+ 'show-effective-configuration': _show_effective_cfg_cfg_from_args,
+ 'show-effective-config': _show_effective_cfg_cfg_from_args,
+ 'show-effective-cfg': _show_effective_cfg_cfg_from_args,
+ 'show-configuration-version': _show_cfg_version_cfg_from_args,
+ 'show-config-version': _show_cfg_version_cfg_from_args,
+ 'show-cfg-version': _show_cfg_version_cfg_from_args,
+ }
+ general_opt_items = []
+ cmd_first_orig_arg_index = None
+ cmd_from_args_func = None
+
+ for item in res.items:
+ if type(item) is barectf_argpar._NonOptItem:
+ cmd_from_args_func = cmd_from_args_funcs.get(item.text)
+
+ if cmd_from_args_func is None:
+ cmd_first_orig_arg_index = item.orig_arg_index
+ else:
+ cmd_first_orig_arg_index = item.orig_arg_index + 1
+
+ break
else:
- # timestamp_begin and timestamp_end must have the same integer
- # as the event header's timestamp field (should exist by now)
- timestamp = stream.event_header['timestamp']
+ assert type(item) is barectf_argpar._OptItem
+ general_opt_items.append(item)
- if not _compare_integers(fields['timestamp_begin'], timestamp):
- _perror('stream {}: packet context: "timestamp_begin": integer type different from event header\'s "timestamp" field'.format(sid))
+ # general help?
+ if len(_find_opt_items(general_opt_items, 'help')) > 0:
+ _print_general_usage()
+ sys.exit()
- if not _compare_integers(fields['timestamp_end'], timestamp):
- _perror('stream {}: packet context: "timestamp_end": integer type different from event header\'s "timestamp" field'.format(sid))
+ # version?
+ if len(_find_opt_items(general_opt_items, 'version')) > 0:
+ print(f'barectf {barectf.__version__}')
+ sys.exit()
- # content_size must exist and be an unsigned integer
- if 'content_size' not in fields:
- _perror('stream {}: packet context: missing "content_size" field'.format(sid))
+ # execute command
+ cmd_orig_args = orig_args[cmd_first_orig_arg_index:]
- try:
- _validate_integer(fields['content_size'], 32, 32, False)
- except:
- try:
- _validate_integer(fields['content_size'], 64, 64, False)
- except:
- _perror('stream {}: packet context: "content_size": expecting unsigned 32-bit/64-bit integer'.format(sid))
+ if cmd_from_args_func is None:
+ # default `generate` command
+ return _gen_cmd_cfg_from_args(cmd_orig_args)
+ else:
+ return cmd_from_args_func(cmd_orig_args)
- # packet_size must exist and be an unsigned integer
- if 'packet_size' not in fields:
- _perror('stream {}: packet context: missing "packet_size" field'.format(sid))
- try:
- _validate_integer(fields['packet_size'], 32, 32, False)
- except:
- try:
- _validate_integer(fields['packet_size'], 64, 64, False)
- except:
- _perror('stream {}: packet context: "packet_size": expecting unsigned 32-bit/64-bit integer'.format(sid))
+class _CmdCfg:
+ pass
- # if cpu_id exists, must be an unsigned integer
- if 'cpu_id' in fields:
- try:
- _validate_integer(fields['cpu_id'], signed=False)
- except RuntimeError as e:
- _perror('stream {}: packet context: "cpu_id": {}'.format(sid, e))
+class _CfgCmdCfg(_CmdCfg):
+ def __init__(self, cfg_file_path, inclusion_dirs, ignore_inclusion_file_not_found):
+ self._cfg_file_path = cfg_file_path
+ self._inclusion_dirs = inclusion_dirs
+ self._ignore_inclusion_file_not_found = ignore_inclusion_file_not_found
-def _validate_event_header(doc, stream):
- event_header = stream.event_header
- sid = stream.id
+ @property
+ def cfg_file_path(self):
+ return self._cfg_file_path
- try:
- _validate_struct(event_header)
- except RuntimeError as e:
- _perror('stream {}: event header: {}'.format(sid, e))
+ @property
+ def inclusion_dirs(self):
+ return self._inclusion_dirs
- fields = event_header.fields
+ @property
+ def ignore_inclusion_file_not_found(self):
+ return self._ignore_inclusion_file_not_found
- # id must exist and be an unsigned integer
- if 'id' not in fields:
- _perror('stream {}: event header: missing "id" field'.format(sid))
- try:
- _validate_integer(fields['id'], signed=False)
- except RuntimeError as e:
- _perror('stream {}: "id": {}'.format(sid, format(e)))
+class _Cmd:
+ def __init__(self, cfg):
+ self._cfg = cfg
+ @property
+ def cfg(self):
+ return self._cfg
- # timestamp must exist, be an unsigned integer and be mapped to a valid clock
- if 'timestamp' not in fields:
- _perror('stream {}: event header: missing "timestamp" field'.format(sid))
+ def exec(self):
+ raise NotImplementedError
- try:
- _validate_integer(fields['timestamp'], signed=False)
- except RuntimeError as e:
- _perror('stream {}: "timestamp": {}'.format(sid, format(e)))
- if fields['timestamp'].map is None:
- _perror('stream {}: "timestamp": integer must be mapped to an existing clock'.format(sid))
+class _GenCmdCfg(_CfgCmdCfg):
+ def __init__(self, cfg_file_path, c_source_dir, c_header_dir, metadata_stream_dir,
+ inclusion_dirs, ignore_inclusion_file_not_found, dump_config, v2_prefix):
+ super().__init__(cfg_file_path, inclusion_dirs, ignore_inclusion_file_not_found)
+ self._c_source_dir = c_source_dir
+ self._c_header_dir = c_header_dir
+ self._metadata_stream_dir = metadata_stream_dir
+ self._dump_config = dump_config
+ self._v2_prefix = v2_prefix
- try:
- _validate_clock(doc, fields['timestamp'].map)
- except RuntimeError as e:
- _perror('stream {}: "timestamp": integer must be mapped to an existing clock'.format(sid))
+ @property
+ def c_source_dir(self):
+ return self._c_source_dir
+ @property
+ def c_header_dir(self):
+ return self._c_header_dir
-def _validate_stream_event_context(doc, stream):
- stream_event_context = stream.event_context
- sid = stream.id
+ @property
+ def metadata_stream_dir(self):
+ return self._metadata_stream_dir
- if stream_event_context is None:
- return
+ @property
+ def dump_config(self):
+ return self._dump_config
+
+ @property
+ def v2_prefix(self):
+ return self._v2_prefix
- try:
- _validate_context_field(stream_event_context)
- except RuntimeError as e:
- _perror('stream {}: event context: {}'.format(sid, e))
+# Source and metadata stream file generating command.
+class _GenCmd(_Cmd):
+ def exec(self):
+ # create configuration
+ try:
+ with open(self.cfg.cfg_file_path) as f:
+ if self.cfg.dump_config:
+ # print effective configuration file
+ print(barectf.effective_configuration_file(f, True, self.cfg.inclusion_dirs,
+ self.cfg.ignore_inclusion_file_not_found))
+
+ # barectf.configuration_from_file() reads the file again
+ # below: rewind.
+ f.seek(0)
+
+ config = barectf.configuration_from_file(f, True, self.cfg.inclusion_dirs,
+ self.cfg.ignore_inclusion_file_not_found)
+ except barectf._ConfigurationParseError as exc:
+ _print_config_error(exc)
+ except Exception as exc:
+ _print_unknown_exc(exc)
+
+ if self.cfg.v2_prefix is not None:
+ # Override prefixes.
+ #
+ # For historical reasons, the `--prefix` option applies the
+ # barectf 2 configuration prefix rules. Therefore, get the
+ # equivalent barectf 3 prefixes first.
+ v3_prefixes = barectf_config_parse_common._v3_prefixes_from_v2_prefix(self.cfg.v2_prefix)
+ cg_opts = config.options.code_generation_options
+ cg_opts = barectf.ConfigurationCodeGenerationOptions(v3_prefixes.identifier,
+ v3_prefixes.file_name,
+ cg_opts.default_stream_type,
+ cg_opts.header_options,
+ cg_opts.clock_type_c_types)
+ config = barectf.Configuration(config.trace, barectf.ConfigurationOptions(cg_opts))
+
+ # create a barectf code generator
+ code_gen = barectf.CodeGenerator(config)
+
+ def write_file(dir, file):
+ with open(os.path.join(dir, file.name), 'w') as f:
+ f.write(file.contents)
+
+ def write_files(dir, files):
+ for file in files:
+ write_file(dir, file)
-def _validate_headers_contexts(doc):
- # packet header
- _validate_packet_header(doc.trace.packet_header)
+ try:
+ # generate and write metadata stream file
+ write_file(self.cfg.metadata_stream_dir, code_gen.generate_metadata_stream())
- # stream stuff
- for stream_id, stream in doc.streams.items():
- _validate_event_header(doc, stream)
- _validate_packet_context(doc, stream)
- _validate_stream_event_context(doc, stream)
+ # generate and write C header files
+ write_files(self.cfg.c_header_dir, code_gen.generate_c_headers())
+ # generate and write C source files
+ write_files(self.cfg.c_source_dir, code_gen.generate_c_sources())
+ except Exception as exc:
+ # We know `config` is valid, therefore the code generator cannot
+ # fail for a reason known to barectf.
+ _print_unknown_exc(exc)
-def _validate_metadata(doc):
- _validate_headers_contexts(doc)
+class _ShowEffectiveCfgCmdCfg(_CfgCmdCfg):
+ def __init__(self, cfg_file_path, inclusion_dirs, ignore_inclusion_file_not_found,
+ indent_space_count):
+ super().__init__(cfg_file_path, inclusion_dirs, ignore_inclusion_file_not_found)
+ self._indent_space_count = indent_space_count
-def gen_barectf(metadata, output, prefix, static_inline, manual_clock):
- # open CTF metadata file
- try:
- with open(metadata) as f:
- tsdl = f.read()
- except:
- _perror('cannot open/read CTF metadata file "{}"'.format(metadata))
+ @property
+ def indent_space_count(self):
+ return self._indent_space_count
- # parse CTF metadata
- parser = pytsdl.parser.Parser()
- try:
- doc = parser.parse(tsdl)
- except pytsdl.parser.ParseError as e:
- _perror('parse error: {}'.format(e))
+# Effective configuration showing command.
+class _ShowEffectiveCfgCmd(_Cmd):
+ def exec(self):
+ try:
+ with open(self.cfg.cfg_file_path) as f:
+ print(barectf.effective_configuration_file(f, True, self.cfg.inclusion_dirs,
+ self.cfg.ignore_inclusion_file_not_found,
+ self.cfg.indent_space_count))
+ except barectf._ConfigurationParseError as exc:
+ _print_config_error(exc)
+ except Exception as exc:
+ _print_unknown_exc(exc)
+
+
+class _ShowCfgVersionCmdCfg(_CmdCfg):
+ def __init__(self, cfg_file_path):
+ self._cfg_file_path = cfg_file_path
- # validate CTF metadata against barectf constraints
- _validate_metadata(doc)
+ @property
+ def cfg_file_path(self):
+ return self._cfg_file_path
- _pinfo(metadata)
- _pinfo(output)
- _pinfo(prefix)
- _pinfo(static_inline)
- _pinfo(manual_clock)
+
+class _ShowCfgVersionCmd(_Cmd):
+ def exec(self):
+ try:
+ with open(self.cfg.cfg_file_path) as f:
+ print(barectf.configuration_file_major_version(f))
+ except barectf._ConfigurationParseError as exc:
+ _print_config_error(exc)
+ except Exception as exc:
+ _print_unknown_exc(exc)
-def run():
- args = _parse_args()
- gen_barectf(args.metadata, args.output, args.prefix, args.static_inline,
- args.manual_clock)
+def _run():
+ # create command from arguments
+ try:
+ cmd = _cmd_from_args(sys.argv[1:])
+ except barectf_argpar._Error as exc:
+ _print_error(f'Command-line: For argument `{exc.orig_arg}`: {exc.msg}')
+ except _CliError as exc:
+ _print_error(f'Command-line: {exc}')
+
+ # execute command
+ cmd.exec()
projects / deliverable / barectf.git / blobdiff