X-Git-Url: http://git.lttng.org/?a=blobdiff_plain;f=tools%2Flttng-gen-tp;h=4ab91f367057ebf89290bb101e22039c650fd009;hb=2eb235ecd28828cef90ff371a96cd532e92ba9f6;hp=2f468cbb79abde4fbf580208cc4728df91af548a;hpb=45f399e86471695f8fb0f55d31197b02b3197bf9;p=lttng-ust.git diff --git a/tools/lttng-gen-tp b/tools/lttng-gen-tp index 2f468cbb..4ab91f36 100755 --- a/tools/lttng-gen-tp +++ b/tools/lttng-gen-tp @@ -1,4 +1,4 @@ -#!/usr/bin/python +#!/usr/bin/env python # # Copyright (c) 2012 Yannick Brosseau # @@ -16,62 +16,59 @@ # with this program; if not, write to the Free Software Foundation, Inc., # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. +from __future__ import print_function import sys import getopt import re import os import subprocess + class Usage(Exception): def __init__(self, msg): self.msg = msg + class HeaderFile: - HEADER_TPL=""" + HEADER_TPL = """ #undef TRACEPOINT_PROVIDER #define TRACEPOINT_PROVIDER {providerName} #undef TRACEPOINT_INCLUDE #define TRACEPOINT_INCLUDE "./{headerFilename}" -#ifdef __cplusplus -extern "C"{{ -#endif /* __cplusplus */ - - #if !defined({includeGuard}) || defined(TRACEPOINT_HEADER_MULTI_READ) #define {includeGuard} #include """ - FOOTER_TPL=""" + FOOTER_TPL = """ #endif /* {includeGuard} */ #include - -#ifdef __cplusplus -}} -#endif /* __cplusplus */ - """ + def __init__(self, filename, template): self.outputFilename = filename self.template = template def write(self): - outputFile = open(self.outputFilename,"w") - includeGuard = self.outputFilename.upper().replace(".","_") + outputFile = open(self.outputFilename, "w") + # Include guard macro will be created by uppercasing the filename and + # replacing all non alphanumeric characters with '_' + includeGuard = re.sub('[^0-9a-zA-Z]', '_', self.outputFilename.upper()) outputFile.write(HeaderFile.HEADER_TPL.format(providerName=self.template.domain, - includeGuard = includeGuard, - headerFilename = self.outputFilename)) + includeGuard=includeGuard, + headerFilename=self.outputFilename)) outputFile.write(self.template.text) - outputFile.write(HeaderFile.FOOTER_TPL.format(includeGuard = includeGuard)) + outputFile.write(HeaderFile.FOOTER_TPL.format(includeGuard=includeGuard)) outputFile.close() + class CFile: - FILE_TPL=""" + FILE_TPL = """ #define TRACEPOINT_CREATE_PROBES /* * The header containing our TRACEPOINT_EVENTs. @@ -79,33 +76,38 @@ class CFile: #define TRACEPOINT_DEFINE #include "{headerFilename}" """ + def __init__(self, filename, template): self.outputFilename = filename self.template = template def write(self): - outputFile = open(self.outputFilename,"w") + outputFile = open(self.outputFilename, "w") - headerFilename = self.outputFilename.replace(".c",".h") + headerFilename = self.outputFilename + if headerFilename.endswith(".c"): + headerFilename = headerFilename[:-2] + ".h" outputFile.write(CFile.FILE_TPL.format( - headerFilename = headerFilename)) + headerFilename=headerFilename)) outputFile.close() + class ObjFile: def __init__(self, filename, template): self.outputFilename = filename self.template = template + def _detectCC(self): cc = "" - if os.environ.has_key('CC'): + if 'CC' in os.environ: cc = os.environ['CC'] try: - subprocess.call(cc, + subprocess.call(cc.split(), stdout=subprocess.PIPE, stderr=subprocess.PIPE) - except OSError, msg: - print "Invalid CC environment variable" + except OSError as msg: + print("Invalid CC environment variable") cc = "" else: @@ -115,7 +117,7 @@ class ObjFile: subprocess.call("cc", stdout=subprocess.PIPE, stderr=subprocess.PIPE) - except OSError, msg: + except OSError as msg: useCC = False if useCC: cc = "cc" @@ -126,48 +128,65 @@ class ObjFile: subprocess.call("gcc", stdout=subprocess.PIPE, stderr=subprocess.PIPE) - except OSError, msg: + except OSError as msg: useGCC = False if useGCC: cc = "gcc" return cc def write(self): - cFilename = self.outputFilename.replace(".o",".c") + cFilename = self.outputFilename + if cFilename.endswith(".o"): + cFilename = cFilename[:-2] + ".c" + cc = self._detectCC() if cc == "": raise RuntimeError("No C Compiler detected") - if os.environ.has_key('CFLAGS'): - cflags = os.environ['CFLAGS'] + if 'CPPFLAGS' in os.environ: + cppflags = " " + os.environ['CPPFLAGS'] + else: + cppflags = "" + if 'CFLAGS' in os.environ: + cflags = " " + os.environ['CFLAGS'] else: cflags = "" + if 'LDFLAGS' in os.environ: + ldflags = " " + os.environ['LDFLAGS'] + else: + ldflags = "" - command = cc + " -c " + cflags + " -I. -llttng-ust" + " -o " + self.outputFilename + " " + cFilename + command = cc + " -c" + cppflags + cflags + ldflags + " -I. -llttng-ust" + " -o " + self.outputFilename + " " + cFilename + if verbose: + print("Compile command: " + command) subprocess.call(command.split()) + class TemplateFile: def __init__(self, filename): self.domain = "" self.inputFilename = filename self.parseTemplate() - def parseTemplate(self): - f = open(self.inputFilename,"r") + f = open(self.inputFilename, "r") self.text = f.read() - #Remove # comments (from input and output file - removeComments = re.compile("#.*$",flags=re.MULTILINE) - self.text = removeComments.sub("",self.text) - #Remove // comments - removeLineComment = re.compile("\/\/.*$",flags=re.MULTILINE) - nolinecomment = removeLineComment.sub("",self.text) - #Remove all spaces and lines - cleantext = re.sub("\s*","",nolinecomment) - #Remove multine C style comments - nocomment = re.sub("/\*.*?\*/","",cleantext) - entries = re.split("TRACEPOINT_.*?",nocomment) + # Remove # comments (from input and output file) but keep + # #include in the output file + removeComments = re.compile("#[^include].*$", flags=re.MULTILINE) + self.text = removeComments.sub("", self.text) + # Remove #include directive from the parsed text + removePreprocess = re.compile("#.*$", flags=re.MULTILINE) + noPreprocess = removePreprocess.sub("", self.text) + # Remove // comments + removeLineComment = re.compile("\/\/.*$", flags=re.MULTILINE) + nolinecomment = removeLineComment.sub("", noPreprocess) + # Remove all spaces and lines + cleantext = re.sub("\s*", "", nolinecomment) + # Remove multine C style comments + nocomment = re.sub("/\*.*?\*/", "", cleantext) + entries = re.split("TRACEPOINT_.*?", nocomment) for entry in entries: if entry != '': @@ -180,9 +199,12 @@ class TemplateFile: self.domain = domain else: if self.domain != domain: - print "Warning: different domain provided (%s,%s)" % (self.domain, domain) + print("Warning: different domain provided (%s,%s)" % (self.domain, domain)) + -usage=""" +verbose = False + +usage = """ lttng-gen-tp - Generate the LTTng-UST header and source based on a simple template usage: lttng-gen-tp TEMPLATE_FILE [-o OUTPUT_FILE][-o OUTPUT_FILE] @@ -198,37 +220,42 @@ usage=""" as per defined in the lttng/tracepoint.h file. See the lttng-ust(3) man page for more details on the format. """ + + def main(argv=None): if argv is None: argv = sys.argv try: try: - opts, args = getopt.gnu_getopt(argv[1:], "ho:a", ["help"]) - except getopt.error, msg: - raise Usage(msg) + opts, args = getopt.gnu_getopt(argv[1:], "ho:av", ["help", "verbose"]) + except getopt.error as msg: + raise Usage(msg) - except Usage, err: - print >>sys.stderr, err.msg - print >>sys.stderr, "for help use --help" + except Usage as err: + print(err.msg, file=sys.stderr) + print("for help use --help", file=sys.stderr) return 2 outputNames = [] for o, a in opts: if o in ("-h", "--help"): - print usage + print(usage) return(0) - if o in ("-o",""): + if o in ("-o", ""): outputNames.append(a) - if o in ("-a",""): + if o in ("-a", ""): all = True + if o in ("-v", "--verbose"): + global verbose + verbose = True try: if len(args) == 0: raise Usage("No template file given") - except Usage, err: - print >>sys.stderr, err.msg - print >>sys.stderr, "for help use --help" + except Usage as err: + print(err.msg, file=sys.stderr) + print("for help use --help", file=sys.stderr) return 2 doCFile = None @@ -240,7 +267,7 @@ def main(argv=None): if len(outputNames) > 0: if len(args) > 1: - print "Cannot process more than one input if you specify an output" + print("Cannot process more than one input if you specify an output") return(3) for outputName in outputNames: @@ -254,7 +281,7 @@ def main(argv=None): doObj = True objFilename = outputName else: - print "output file type unsupported" + print("output file type unsupported") return(4) else: doHeader = True @@ -264,40 +291,41 @@ def main(argv=None): # process arguments for arg in args: if arg[-3:] != ".tp": - print arg + " does not end in .tp. Skipping." + print(arg + " does not end in .tp. Skipping.") continue tpl = None try: tpl = TemplateFile(arg) except IOError as args: - print "Cannot read input file " + args.filename + " " + args.strerror + print("Cannot read input file " + args.filename + " " + args.strerror) return -1 try: if doHeader: if headerFilename: curFilename = headerFilename else: - curFilename = re.sub("\.tp$",".h",arg) + curFilename = re.sub("\.tp$", ".h", arg) doth = HeaderFile(curFilename, tpl) doth.write() if doCFile: if cFilename: curFilename = cFilename else: - curFilename = re.sub("\.tp$",".c",arg) + curFilename = re.sub("\.tp$", ".c", arg) dotc = CFile(curFilename, tpl) dotc.write() if doObj: if objFilename: curFilename = objFilename else: - curFilename = re.sub("\.tp$",".o",arg) + curFilename = re.sub("\.tp$", ".o", arg) dotobj = ObjFile(curFilename, tpl) dotobj.write() except IOError as args: - print "Cannot write output file " + args.filename + " " + args.strerror + print("Cannot write output file " + args.filename + " " + args.strerror) return -1 - + + if __name__ == "__main__": sys.exit(main())