diff options
Diffstat (limited to 'src/scripts/genDummyProvider.py')
| -rw-r--r-- | src/scripts/genDummyProvider.py | 211 |
1 files changed, 211 insertions, 0 deletions
diff --git a/src/scripts/genDummyProvider.py b/src/scripts/genDummyProvider.py new file mode 100644 index 0000000000..0704554263 --- /dev/null +++ b/src/scripts/genDummyProvider.py @@ -0,0 +1,211 @@ +## +## Licensed to the .NET Foundation under one or more agreements. +## The .NET Foundation licenses this file to you under the MIT license. +## See the LICENSE file in the project root for more information. +## +## This script exists to create a dummy implementaion of the eventprovider +## interface from a manifest file +## +## The intended use if for platforms which support event pipe +## but do not have a an eventing platform to recieve report events + +import os +from genEventing import * +from utilities import open_for_update + +stdprolog_cpp=""" +// Licensed to the .NET Foundation under one or more agreements. +// The .NET Foundation licenses this file to you under the MIT license. +// See the LICENSE file in the project root for more information. + +/****************************************************************** + +DO NOT MODIFY. AUTOGENERATED FILE. +This file is generated using the logic from <root>/src/scripts/genDummyProvider.py + +******************************************************************/ +""" +stdprolog_cmake=""" +# +# +#****************************************************************** + +#DO NOT MODIFY. AUTOGENERATED FILE. +#This file is generated using the logic from <root>/src/scripts/genDummyProvider.py + +#****************************************************************** +""" + +def trimProvName(name): + name = name.replace("Windows-",'') + name = name.replace("Microsoft-",'') + name = name.replace('-','_') + return name + +def escapeProvFilename(name): + name = name.replace('_','') + name = name.lower() + return name + +def generateDummyProvider(providerName, eventNodes, allTemplates, extern): + impl = [] + for eventNode in eventNodes: + eventName = eventNode.getAttribute('symbol') + templateName = eventNode.getAttribute('template') + + #generate EventXplatEnabled + if extern: impl.append('extern "C" ') + impl.append("BOOL EventXplatEnabled%s(){ return FALSE; }\n\n" % (eventName,)) + + #generate FireEtw functions + fnptype = [] + linefnptype = [] + if extern: fnptype.append('extern "C" ') + fnptype.append("ULONG FireEtXplat") + fnptype.append(eventName) + fnptype.append("(\n") + + + if templateName: + template = allTemplates[templateName] + else: + template = None + + if template: + fnSig = template.signature + for paramName in fnSig.paramlist: + fnparam = fnSig.getParam(paramName) + wintypeName = fnparam.winType + typewName = palDataTypeMapping[wintypeName] + winCount = fnparam.count + countw = palDataTypeMapping[winCount] + + if paramName in template.structs: + linefnptype.append("%sint %s_ElementSize,\n" % (lindent, paramName)) + + linefnptype.append(lindent) + linefnptype.append(typewName) + if countw != " ": + linefnptype.append(countw) + + linefnptype.append(" ") + linefnptype.append(fnparam.name) + linefnptype.append(",\n") + + if len(linefnptype) > 0 : + del linefnptype[-1] + + fnptype.extend(linefnptype) + fnptype.append(")\n{\n") + impl.extend(fnptype) + + #start of fn body + impl.append(" return ERROR_SUCCESS;\n") + impl.append("}\n\n") + + return ''.join(impl) + +def generateDummyFiles(etwmanifest, out_dirname, extern): + tree = DOM.parse(etwmanifest) + + #keep these relative + dummy_directory = "dummy" + dummyevntprovPre = os.path.join(dummy_directory, "eventprov") + + if not os.path.exists(out_dirname): + os.makedirs(out_dirname) + + if not os.path.exists(os.path.join(out_dirname, dummy_directory)): + os.makedirs(os.path.join(out_dirname, dummy_directory)) + + # Cmake + with open_for_update(os.path.join(out_dirname, "CMakeLists.txt")) as cmake: + cmake.write(stdprolog_cmake + "\n") + cmake.write("\ncmake_minimum_required(VERSION 2.8.12.2)\n") + if extern: cmake.write("\nproject(eventprovider)\n") + cmake.write(""" + +set(CMAKE_INCLUDE_CURRENT_DIR ON) + +if(FEATURE_PAL) + add_definitions(-DPAL_STDCPP_COMPAT=1) + include_directories(${COREPAL_SOURCE_DIR}/inc/rt) +endif(FEATURE_PAL) +include_directories(dummy) + +""") + if extern: cmake.write("add_library") + else: cmake.write("add_library_clr") + cmake.write("""(eventprovider + STATIC\n""") + + for providerNode in tree.getElementsByTagName('provider'): + providerName = trimProvName(providerNode.getAttribute('name')) + providerName_File = escapeProvFilename(providerName) + + cmake.write(' "%s%s.cpp"\n' % (dummyevntprovPre, providerName_File)) + + cmake.write(")") + if extern: cmake.write(""" + +# Install the static eventprovider library +install(TARGETS eventprovider DESTINATION lib) +""") + + # Dummy Instrumentation + for providerNode in tree.getElementsByTagName('provider'): + providerName = trimProvName(providerNode.getAttribute('name')) + providerName_File = escapeProvFilename(providerName) + + dummyevntprov = os.path.join(out_dirname, dummyevntprovPre + providerName_File + ".cpp") + + with open_for_update(dummyevntprov) as impl: + impl.write(stdprolog_cpp + "\n") + + impl.write(""" +#ifdef PLATFORM_UNIX +#include "pal_mstypes.h" +#include "pal_error.h" +#include "pal.h" +#define PAL_free free +#define PAL_realloc realloc +#include "pal/stackstring.hpp" +#endif + + +""") + + templateNodes = providerNode.getElementsByTagName('template') + eventNodes = providerNode.getElementsByTagName('event') + + allTemplates = parseTemplateNodes(templateNodes) + + #create the implementation of eventing functions : dummyeventprov*.cp + impl.write(generateDummyProvider(providerName, eventNodes, allTemplates, extern) + "\n") + +def main(argv): + + #parse the command line + parser = argparse.ArgumentParser(description="Generates the Code required to instrument LTTtng logging mechanism") + + required = parser.add_argument_group('required arguments') + required.add_argument('--man', type=str, required=True, + help='full path to manifest containig the description of events') + required.add_argument('--intermediate', type=str, required=True, + help='full path to eventprovider intermediate directory') + required.add_argument('--nonextern', action='store_true', + help='if specified, will generate files to be compiled into the CLR rather than externaly' ) + args, unknown = parser.parse_known_args(argv) + if unknown: + print('Unknown argument(s): ', ', '.join(unknown)) + return 1 + + sClrEtwAllMan = args.man + intermediate = args.intermediate + extern = not args.nonextern + + generateDummyFiles(sClrEtwAllMan, intermediate, extern) + +if __name__ == '__main__': + return_code = main(sys.argv[1:]) + sys.exit(return_code)
\ No newline at end of file |