summaryrefslogtreecommitdiffstats
path: root/doxygen/siphon-generate
blob: bdfd58d8bbbc6bd74e3fe7806826e224867d9362 (plain)
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
#!/usr/bin/env python
# Copyright (c) 2016 Comcast Cable Communications Management, LLC.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at:
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

# Looks for preprocessor macros with struct initializers and siphons them
# off into another file for later parsing; ostensibly to generate
# documentation from struct initializer data.

import os, sys, argparse, logging
import siphon

DEFAULT_LOGFILE = None
DEFAULT_LOGLEVEL = "info"
DEFAULT_OUTPUT = "build-root/docs/siphons"
DEFAULT_PREFIX = os.getcwd()

ap = argparse.ArgumentParser()
ap.add_argument("--log-file", default=DEFAULT_LOGFILE,
        help="Log file [%s]" % DEFAULT_LOGFILE)
ap.add_argument("--log-level", default=DEFAULT_LOGLEVEL,
        choices=["debug", "info", "warning", "error", "critical"],
        help="Logging level [%s]" % DEFAULT_LOGLEVEL)

ap.add_argument("--output", '-o', metavar="directory", default=DEFAULT_OUTPUT,
        help="Output directory for .siphon files [%s]" % DEFAULT_OUTPUT)
ap.add_argument("--input-prefix", metavar="path", default=DEFAULT_PREFIX,
        help="Prefix to strip from input pathnames [%s]" % DEFAULT_PREFIX)
ap.add_argument("input", nargs='+', metavar="input_file",
        help="Input C source files")
args = ap.parse_args()

logging.basicConfig(filename=args.log_file,
        level=getattr(logging, args.log_level.upper(), None))
log = logging.getLogger("siphon_generate")


generate = siphon.generate.Generate(output_directory=args.output,
    input_prefix=args.input_prefix)

# Pre-process file names in case they indicate a file with
# a list of files
files = []
for filename in args.input:
    if filename.startswith('@'):
        with open(filename[1:], 'r') as fp:
            lines = fp.readlines()
            for line in lines:
                file = line.strip()
                if file not in files:
                    files.append(file)
            lines = None
    else:
        if filename not in files:
            files.append(filename)

# Iterate all the input files we've been given
for filename in files:
    generate.parse(filename)

# Write the extracted data
generate.deliver()

# All done
%d;%s,%s" % (self.fib_table, self.localsid_prefix, self.behavior) class VppSRv6MobilePolicy(VppObject): """ SRv6 Policy """ def __init__( self, test, bsid_addr, sr_prefix, v6src_prefix, behavior, fib_table=0, local_fib_table=0, encap_src=None, drop_in=0, nhtype=SRv6MobileNhtype.SRV6_NHTYPE_API_NONE, ): self._test = test self.bsid_addr = bsid_addr self.sr_prefix = sr_prefix self.v6src_prefix = v6src_prefix self.behavior = behavior self.fib_table = fib_table self.local_fib_table = local_fib_table self.drop_in = drop_in self.nhtype = nhtype self.encap_src = encap_src self._configured = False def add_vpp_config(self): self._test.vapi.sr_mobile_policy_add( bsid_addr=self.bsid_addr, sr_prefix=self.sr_prefix, v6src_prefix=self.v6src_prefix, behavior=self.behavior, fib_table=self.fib_table, local_fib_table=self.local_fib_table, encap_src=self.encap_src, drop_in=self.drop_in, nhtype=self.nhtype, ) self._configured = True def remove_vpp_config(self): self._test.vapi.sr_policy_del(self.bsid_addr) self._configured = False def query_vpp_config(self): # no API to query SR Policies # use _configured flag for now return self._configured def object_id(self): return "%d;%s-><%s>;%d" % ( self.sr_type, self.bsid, ",".join(self.segments), self.is_encap, )