PyForTool
Python-fortran-tool
Loading...
Searching...
No Matches
scripting.py
1"""
2This module contains functions usefull to build scripts around the pyfortool library
3"""
4
5import sys
6from multiprocessing import cpu_count, Pool
7from multiprocessing.managers import BaseManager
8import re
9import shlex
10import os
11import argparse
12import logging
13import traceback
14
15from pyfortool.pyfortool import PYFT
16from pyfortool.tree import Tree
17from pyfortool.util import isint, PYFTError
18from pyfortool import __version__
19
20
21def task(filename):
22 """
23 Function to use on each file
24 :param clsPYFT: PYFT class to use
25 :param filename: file name
26 """
27 global PYFT
28 global allFileArgs
29 allArgs, orderedOptions = allFileArgs[filename]
30 try:
31 # Opening and reading of the FORTRAN file
32 with PYFT(filename, filename,
33 parserOptions=getParserOptions(allArgs), verbosity=allArgs.logLevel,
34 wrapH=allArgs.wrapH,
35 enableCache=allArgs.enableCache) as pft:
36
37 # apply the transformation in the order they were specified
38 for arg in orderedOptions:
39 logging.debug('Applying %s on %s', arg, filename)
40 applyTransfo(pft, arg, allArgs,
41 filename if filename == allArgs.plotCentralFile else None)
42 logging.debug(' -> Done')
43
44 # Writing
45 if not allArgs.dryRun:
46 pft.write()
47
48 # Reporting
49 return (0, filename)
50
51 except Exception as exc: # pylint: disable=broad-except
52 logging.error("The following error has occurred in the file %s", filename)
53 traceback.print_exception(exc, file=sys.stdout)
54 sys.stdout.flush()
55 return (1, filename)
56
57
59 """
60 Core of the pyfortool_parallel.py command
61 """
62
63 class MyManager(BaseManager):
64 """
65 Custom manager to deal with Tree instances
66 """
67
68 MyManager.register('Tree', Tree)
69
70 def init(cls, afa):
71 """
72 Pool initializer
73 """
74 # After many, many attempts, it seems very difficult (if not impossible)
75 # to do without global variables
76 global PYFT # pylint: disable=global-statement
77 global allFileArgs # pylint: disable=global-statement
78 PYFT = cls
79 allFileArgs = afa
80
81 parser = argparse.ArgumentParser(description='Python FORTRAN tool', allow_abbrev=False,
82 epilog="The argument order matters.")
83
84 updateParser(parser, withInput=False, withOutput=False, withXml=False, withPlotCentralFile=True,
85 treeIsOptional=False, nbPar=True, restrictScope=False)
86 commonArgs, getFileArgs = getArgs(parser)
87
88 # Manager to share the Tree instance
89 with MyManager() as manager:
90 # Set-up the Tree instance
91 sharedTree = getDescTree(commonArgs, manager.Tree)
92
93 # Prepare PYFT to be used in parallel
94 PYFT.setParallel(sharedTree)
95
96 # Set-up the processes
97 allFileArgs = {file: getFileArgs(file) for file in sharedTree.getFiles()}
98 logging.info('Executing in parallel on %i files with a maximum of %i processes',
99 len(allFileArgs), commonArgs.nbPar)
100 with Pool(commonArgs.nbPar, initializer=init, initargs=(PYFT, allFileArgs)) as pool:
101 result = pool.map(task, sharedTree.getFiles())
102
103 # Writting the descTree object
104 sharedTree.toJson(commonArgs.descTree)
105
106 # General error
107 errors = [item[1] for item in result if item[0] != 0]
108 status = len(errors)
109 if status != 0:
110 logging.error('List of files with error:')
111 for error in errors:
112 logging.error(' - %s', error)
113 raise PYFTError(f"Errors have been reported in {status} file(s).")
114
115
116def main():
117 """
118 Core of the pyfortool.py command
119 """
120 parser = argparse.ArgumentParser(description='Python FORTRAN tool', allow_abbrev=False,
121 epilog="The argument order matters.")
122
123 updateParser(parser, withInput=True, withOutput=True, withXml=True, withPlotCentralFile=False,
124 treeIsOptional=True, nbPar=False, restrictScope=True)
125 args, orderedOptions = getArgs(parser)[1]()
126
127 parserOptions = getParserOptions(args)
128 descTree = getDescTree(args)
129
130 try:
131 # Opening and reading of the FORTRAN file
132 pft = PYFT(args.INPUT, args.OUTPUT, parserOptions=parserOptions,
133 verbosity=args.logLevel, wrapH=args.wrapH, tree=descTree,
134 enableCache=args.enableCache)
135 if args.restrictScope != '':
136 pft = pft.getScopeNode(args.restrictScope)
137
138 # apply the transformation in the order they were specified
139 for arg in orderedOptions:
140 logging.debug('Applying %s on %s', arg, args.INPUT)
141 applyTransfo(pft, arg, args, plotCentralFile=args.INPUT)
142 logging.debug(' -> Done')
143
144 # Writing
145 if descTree is not None:
146 descTree.toJson(args.descTree)
147 if args.xml is not None:
148 pft.mainScope.writeXML(args.xml)
149 if not args.dryRun:
150 pft.mainScope.write()
151
152 # Closing
153 pft.mainScope.close()
154
155 except: # noqa E722
156 # 'exept' everything and re-raise error systematically
157 logging.error("The following error has occurred in the file %s", args.INPUT)
158 raise
159
160
161ARG_UPDATE_CNT = ('--alignContinuation', '--addBeginContinuation',
162 '--removeBeginContinuation',
163 '--emoveALLContinuation')
164
165
166def getArgs(parser):
167 """
168 Parse arguments and interpret the --optsByEnv option
169 :param parser: argparse parser
170 :return: a tuple with
171 - an argparse namespace containing common arguments (not using the --optsEnv option)
172 - a function taking a filename as input and returning
173 - an argparse namespace with the common arguments and the ones added by
174 interpreting the --optsEnv option
175 - an ordered list of arguments
176 """
177 args = parser.parse_args()
178
179 def getFileArgs(filename=args.INPUT if hasattr(args, 'INPUT') else None):
180 """
181 :param filename: name of source code file
182 :return: argparse namespace to use with this file and
183 a list given the order in which the arguments were provided
184 """
185 # Decode the --optsByEnv option
186 arguments = sys.argv[1:]
187 if args.optsByEnv is not None:
188 extra = ''
189 for line in [] if args.optsByEnv is None else os.environ[args.optsByEnv].split('\n'):
190 if ':=:' in line:
191 if re.match(line.split(':=:')[0], filename):
192 extra = line.split(':=:')[1]
193 else:
194 extra = line
195 index = arguments.index('--optsByEnv')
196 arguments = arguments[:index] + shlex.split(extra) + arguments[index + 2:] # keep order
197
198 # Compute the ordered list
199 updateCnt = False
200 optList = []
201 for arg in arguments:
202 if arg.startswith('--') and arg not in optList:
203 if arg in ARG_UPDATE_CNT:
204 if not updateCnt:
205 updateCnt = True
206 optList.append(arg)
207 else:
208 optList.append(arg)
209
210 return parser.parse_args(arguments), optList
211
212 return args, getFileArgs
213
214
216 """
217 Get the options to use for the fxtran parser
218 :param args: arguments parsed by the argparse parser
219 """
220 if args.parserOption is None:
221 parserOptions = PYFT.DEFAULT_FXTRAN_OPTIONS.copy()
222 else:
223 parserOptions = [el for elements in args.parserOption for el in elements]
224 if args.addIncludes:
225 parserOptions = [opt for opt in parserOptions if opt not in ('-no-include', '-noinclude')]
226 return parserOptions
227
228
229def getDescTree(args, cls=Tree):
230 """
231 get the Tree object built with the parsed arguments
232 :param args: arguments parsed by the argparse parser
233 :param cls: class to use (usefull for manager)
234 :return: a Tree instance
235 """
236 parserOptions = getParserOptions(args)
237 if args.descTree:
238 descTree = cls(tree=args.tree, descTreeFile=args.descTree,
239 parserOptions=parserOptions,
240 wrapH=args.wrapH, verbosity=args.logLevel)
241 else:
242 descTree = None
243 return descTree
244
245
246def updateParser(parser, withInput, withOutput, withXml, withPlotCentralFile, treeIsOptional,
247 nbPar, restrictScope):
248 """
249 Updates an argparse parser with arguments common to all the different tools
250 :param parser: parser in which arguments are added
251 :param withOutput: do we need the INPUT argument
252 :param withOutput: do we need the OUTPUT argument
253 :param withXml: do we need to be able to define an XML output file
254 :param withPlotCentralFile: to add the --plotCentralFile argument
255 :param treeIsOptional: is the --tree argument optional?
256 :param nbPar: number of parallel processes
257 :param restrictScope: can we specify the scope path
258 """
259
260 # ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! !
261 # IMPORTANT NOTE
262 # Argument order matters but argparse is not able to give the order
263 # Therefore, arguments are processed twice. The first time by argparse to fully decode them.
264 # The a second pass is made direcly on sys.argv. This mechanism has two implications:
265 # allow_abbrev must be set to False in ArgumentParser
266 # only long argument options are allowed (begining with two dashes)
267 # ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! !
268 assert not parser.allow_abbrev, 'parser must be created with allow_abbrev=False'
269
270 parser.add_argument('--version', action='version',
271 version='%(prog)s {version}'.format(version=__version__))
272 parser.add_argument('--simplify', default=False, action='store_true',
273 help='After a deletion, recursively deletes the code ' +
274 'and variables that have become useless')
275 parser.add_argument('--logLevel', default='warning',
276 help='Provide logging level. Example --logLevel debug (default is warning)')
277 parser.add_argument('--enableCache', default=False, action='store_true',
278 help='Precompute parent of each xml node and store the result')
279 if nbPar:
280 parser.add_argument('--nbPar', default=cpu_count(), type=int,
281 help='Number of parallel processes, 0 to get as many processes ' +
282 'as the number of cores (default=0)')
283 parser.add_argument('--optsByEnv', default=None, type=str,
284 help='Name of the environment variable containing additional arguments ' +
285 'to use. These arguments are processed after all other arguments. ' +
286 'The variable can contain a multi-lines string. The ' +
287 'variable is read line by line and the last applicable line is ' +
288 'used. A line can take one of these two forms: ' +
289 '1) "FILE_DESCRIPTOR:=:OPTIONS" (where FILE_DESCRIPTOR is a ' +
290 'regular expression to test against the filename. If there ' +
291 'is a match, the OPTIONS can be used for the file) and ' +
292 '2) "OPTIONS" (if the line doesn\'t contain the FILE_DESCRIPTOR ' +
293 'part, it applies to all source code).')
294
295 if restrictScope:
296 parser.add_argument('--restrictScope', default='', type=str, metavar='SCOPEPATH',
297 help="Limit the action to this scope path (SUBROUTINE/FUNCTION/" +
298 "MODULE/TYPE). It is '/'-separated path with each element " +
299 "having the form 'module:<name of the module>', " +
300 "'sub:<name of the subroutine>', " +
301 "'func:<name of the function>' or 'type:<name of the type>'.")
302
303 # Inputs and outputs
304 updateParserInputsOutputs(parser, withInput, withOutput, withXml)
305
306 # fxtran
307 updateParserFxtran(parser)
308
309 # Variables
311
312 # Cosmetics
314
315 # Applications
317
318 # openACC
319 updateParserOpenACC(parser)
320
321 # Checks
322 updateParserChecks(parser)
323
324 # Statements
326
327 # Misc
328 updateParserMisc(parser)
329
330 # Tree
331 updateParserTree(parser, withPlotCentralFile, treeIsOptional)
332
333 # Preprocessot
335
336
337def updateParserInputsOutputs(parser, withInput, withOutput, withXml):
338 """
339 Updates an argparse parser with input/output arguments
340 :param parser: parser in which arguments are added
341 :param withOutput: do we need the INPUT argument
342 :param withOutput: do we need the OUTPUT argument
343 :param withXml: do we need to be able to define an XML output file
344 """
345 gInOut = parser.add_argument_group('Input and output')
346 if withInput:
347 gInOut.add_argument('INPUT', help='FORTRAN input file')
348 if withOutput:
349 gInOut.add_argument('OUTPUT', default=None, help='FORTRAN output file', nargs='?')
350 gInOut.add_argument('--renamefF', default=False, action='store_true',
351 help='Put file extension in upper case')
352 gInOut.add_argument('--renameFf', default=False, action='store_true',
353 help='Put file extension in lower case')
354 if withXml:
355 gInOut.add_argument('--xml', default=None, type=str,
356 help='Output file for xml')
357 gInOut.add_argument('--dryRun', default=False, action='store_true',
358 help='Dry run without writing the FORTRAN file (the xml ' +
359 'is still written')
360
361
363 """
364 Updates an argparse parser with fxtran arguments
365 """
366 gParser = parser.add_argument_group('fxtran parser relative options')
367 gParser.add_argument('--parserOption', nargs='*', action='append',
368 help='Option to pass to fxtran, defaults ' +
369 f'to {PYFT.DEFAULT_FXTRAN_OPTIONS}')
370 gParser.add_argument('--wrapH', default=False, action='store_true',
371 help='Wrap .h file content into a MODULE to enable the reading')
372
373
375 """
376 Updates an argparse parser with variables arguments
377 """
378 gVariables = parser.add_argument_group('Options to deal with variables')
379 gVariables.add_argument('--showVariables', default=False, action='store_true',
380 help='Show the declared variables')
381 gVariables.add_argument('--removeVariable', nargs=2, action='append',
382 metavar=('SCOPEPATH', 'VARNAME'),
383 help="Variable to remove from declaration. The first argument " +
384 "is the SUBROUTINE/FUNCTION/MODULE/TYPE where the variable " +
385 "is declared. It is '/'-separated path with each element having " +
386 "the form 'module:<name of the module>', " +
387 "'sub:<name of the subroutine>', " +
388 "'func:<name of the function>' or 'type:<name of the type>'. " +
389 "The second argument is the variable name")
390 gVariables.add_argument('--attachArraySpecToEntity', default=False, action='store_true',
391 help='Find all T-decl-stmt elements that have a child element ' +
392 'attribute with attribute-N=DIMENSION and move the attribute ' +
393 'into EN-N elements')
394 gVariables.add_argument('--addVariable', nargs=4, action='append',
395 metavar=('SCOPEPATH', 'VARNAME', 'DECLARATION', 'POSITION'),
396 help='Add a variable. First argument is the scope path (as for ' +
397 'the --removeVariable option. The second is the variable ' +
398 'name, the third is the declarative statement to insert, ' +
399 'the fourth is the position (python indexing) the new ' +
400 'variable will have in the calling statment of the ' +
401 'routine (non-integer value for a local variable).')
402 gVariables.add_argument('--addModuleVariable', nargs=3, action='append',
403 metavar=('SCOPEPATH', 'MODULENAME', 'VARNAME'),
404 help='Add a USE statement. The first argument is the scope path ' +
405 '(as for the --removeVariable option). The second is the module ' +
406 'name; the third is the variable name.')
407 gVariables.add_argument('--showUnusedVariables', default=False, action='store_true',
408 help='Show a list of unused variables.')
409 gVariables.add_argument('--removeUnusedLocalVariables',
410 help='Remove unused local variables, excluding some variables (comma-' +
411 'separated list or NONE to exclude nothing).')
412 gVariables.add_argument('--removePHYEXUnusedLocalVariables',
413 help='Remove unused local variables, excluding some variables (comma-' +
414 'separated list or NONE to exclude nothing). This option takes ' +
415 'into account the mnh_expand directives to prevent from ' +
416 'removing useful variables.')
417 gVariables.add_argument('--addExplicitArrayBounds', action='store_true',
418 help='Adds explicit bounds to arrays that already have parentheses.')
419 gVariables.add_argument('--addArrayParentheses', action='store_true',
420 help='Adds parentheses to arrays (A => A(:))')
421 gVariables.add_argument('--modifyAutomaticArrays', metavar="DECL#START#END",
422 help='Transform all automatic arrays declaration using the templates.' +
423 ' The DECL part of the template will replace the declaration ' +
424 'statement, the START part will be inserted as the first ' +
425 'executable statement while the END part will be inserted as ' +
426 'the last executable statement. Each part ' +
427 'of the template can use the following place holders: ' +
428 '"{doubledotshape}", "{shape}", "{lowUpList}", "{name}" and ' +
429 '"{type}" which are, respectively modified into ' +
430 '":, :, :", "I, I:J, 0:I", "1, I, I, J, 0, I", "A", "REAL" ' +
431 'if the original declaration statement ' +
432 'was "A(I, I:J, 0:I)". For example, the template ' +
433 '"{type}, DIMENSION({doubledotshape}), ALLOCATABLE :: ' +
434 '{name}#ALLOCATE({name}({shape}))#DEALLOCATE({name})"' +
435 'will replace automatic arrays by allocatables.')
436 gVariables.add_argument('--replaceAutomaticWithAllocatable', action='store_true',
437 help='Replace all automatic arrays with allocatable arrays.')
438 gVariables.add_argument('--addArgInTree', default=None, action='append', nargs=3,
439 metavar=('VARNAME', 'DECLARATION', 'POSITION'),
440 help='Add an argument variable. The first argument is the variable ' +
441 'name, the second one is the declarative statement to insert, ' +
442 'the third one is the position (python indexing) the new ' +
443 'variable will have in the calling statement of the ' +
444 'routine. Needs the --stopScopes argument')
445
446
448 """
449 Updates an argparse parser with cosmetics arguments
450 """
451 gCosmetics = parser.add_argument_group('Cosmetics options')
452 gCosmetics.add_argument('--upperCase', default=False, action='store_true',
453 help='Put FORTRAN code in upper case letters')
454 gCosmetics.add_argument('--lowerCase', default=False, action='store_true',
455 help='Put FORTRAN code in lower case letters')
456 gCosmetics.add_argument('--changeIfStatementsInIfConstructs', default=False,
457 action='store_true',
458 help='Find all if-statement and convert it to if-then-statement')
459 gCosmetics.add_argument('--indent', default=False, action='store_true',
460 help='Correct indentation')
461 gCosmetics.add_argument('--removeIndent', default=False, action='store_true',
462 help='Remove indentation')
463 gCosmetics.add_argument('--removeEmptyLines', default=False, action='store_true',
464 help='Remove empty lines')
465 gCosmetics.add_argument('--removeComments', default=False, action='store_true',
466 help='Remove comments')
467 gCosmetics.add_argument('--updateSpaces', default=False, action='store_true',
468 help='Updates spaces around operators, commas, parenthesis and ' +
469 'at the end of line')
470 gCosmetics.add_argument('--alignContinuation', default=False, action='store_true',
471 help='Align the beginings of continued lines')
472 gCosmetics.add_argument('--addBeginContinuation', default=False, action='store_true',
473 help='Add missing continuation characters (\'&\') at the ' +
474 'begining of lines')
475 gCosmetics.add_argument('--removeBeginContinuation', default=False, action='store_true',
476 help='Remove continuation characters (\'&\') at the begining of lines')
477 gCosmetics.add_argument('--removeALLContinuation', default=False, action='store_true',
478 help='Remove all continuation characters(\'&\')')
479 gCosmetics.add_argument('--prettify', default=False, action='store_true',
480 help='Prettify the source code (indentation, spaces...)')
481 gCosmetics.add_argument('--minify', default=False, action='store_true',
482 help='Simplify the source code (indentation, spaces...)')
483 gCosmetics.add_argument('--removeEmptyCONTAINS', default=False, action='store_true',
484 help='Remove useless CONTAINS statements')
485
486
488 """
489 Updates an argparse parser with applications arguments
490 """
491 gApplications = parser.add_argument_group('Options to apply upper level transformation')
492 gApplications.add_argument('--deleteDrHook', default=False, action='store_true',
493 help='Delete DR HOOK use')
494 gApplications.add_argument('--addDrHook', default=False, action='store_true',
495 help='Add DR HOOK')
496 gApplications.add_argument('--deleteBudgetDDH', default=False, action='store_true',
497 help='Delete Budget/DDH use')
498 gApplications.add_argument('--deleteRoutineCallsMesoNHGPU', default=False, action='store_true',
499 help='Delete parts of the code not compatible with MesoNH-OpenACC' +
500 'such as OCND2 blocks')
501 gApplications.add_argument('--splitModuleRoutineFile', default=False, action='store_true',
502 help='Split a file')
503 gApplications.add_argument('--deleteNonColumnCallsPHYEX', default=False, action='store_true',
504 help='Delete call to PHYEX routines that needs information on ' +
505 'horizontal points (multiple column dependency')
506 gApplications.add_argument('--removeIJDim', default=False, action='store_true',
507 help='Remove I and J dimensions (1, KLON). ' +
508 'Needs the --stopScopes argument.')
509 gApplications.add_argument('--expandAllArraysPHYEX', default=False, action='store_true',
510 help='Expand all array syntax (computing and where block) ' +
511 'using PHYEX conventions')
512 gApplications.add_argument('--expandAllArraysPHYEXConcurrent', default=False,
513 action='store_true',
514 help='Expand all array syntax with DO CONCURRENT loops ' +
515 '(computing and where block) using PHYEX conventions')
516 gApplications.add_argument('--expandAllArrays', default=False, action='store_true',
517 help='Expand all array syntax (computing and where block) ' +
518 'using mnh directives if present')
519 gApplications.add_argument('--expandAllArraysConcurrent', default=False, action='store_true',
520 help='Expand all array syntax with DO CONCURRENT loops ' +
521 '(computing and where block) using mnh directives if present')
522 gApplications.add_argument('--inlineContainedSubroutinesPHYEX', default=False,
523 action='store_true',
524 help='Inline containted subroutines in main routine, using ' +
525 'PHYEX conventions')
526 gApplications.add_argument('--addStack', metavar='MODEL', type=str,
527 help='Add local arrays to the stack. The argument is the ' +
528 'the model name in which stack must be added ("AROME" ' +
529 'or "MESONH"). Needs the --stopScopes argument for AROME.')
530 gApplications.add_argument('--addIncludes', default=False, action='store_true',
531 help='Add .h includes in the file and remove the INCLUDE statement')
532 gApplications.add_argument('--addSubmodulePHYEX', default=False, action='store_true',
533 help='Add SUBMODULE and INTERFACE of subroutines in PHYEX')
534 gApplications.add_argument('--mnhExpand', default=False, action='store_true',
535 help='Apply the mnh_expand directives with DO loops')
536 gApplications.add_argument('--mnhExpandConcurrent', default=False, action='store_true',
537 help='Apply the mnh_expand directives with DO CONCURRENT loops')
538 gApplications.add_argument('--addMPPDB_CHECKS', default=False, action='store_true',
539 help='Add MPPDB_CHEKS bit-repro checking routines of MesoNH for ' +
540 'all in and inout arrays in subroutines')
541 gApplications.add_argument('--addPrints', default=False, action='store_true',
542 help='Add Prints of min/maxval and shape of all in, out, inout ' +
543 'arguments of all scopes')
544 gApplications.add_argument('--shumanFUNCtoCALL', default=False, action='store_true',
545 help='Transform shuman functions to call statements')
546 gApplications.add_argument('--mathFunctoBRFunc', default=False, action='store_true',
547 help='Convert intrinsic math functions **, LOG, ATAN, **2, **3, ' +
548 '**4, EXP, COS, SIN, ATAN2 into a self defined function BR_ ' +
549 'for MesoNH bit-repro.')
550 gApplications.add_argument('--convertTypesInCompute', default=False, action='store_true',
551 help='Use single variable instead of variable contained in ' +
552 'structure in compute statement for optimization issue ')
553 gApplications.add_argument('--buildModi', default=False, action='store_true',
554 help='Builds the corresponding modi_ file')
555
556
558 """
559 Updates an argparse parser with openACC arguments
560 """
561 gOpenACC = parser.add_argument_group('OpenACC')
562 gOpenACC.add_argument('--addACCData', default=False, action='store_true',
563 help='Add !$acc data present and !$acc end data directives')
564 gOpenACC.add_argument('--addACCRoutineSeq', default=False, action='store_true',
565 help='Add "!$acc routine seq" to routines under stopScopes')
566 gOpenACC.add_argument('--craybyPassDOCONCURRENT', default=False, action='store_true',
567 help='remove acc loop independant collapse for BR_ fonctions and ' +
568 'mnh_undef(OPENACC) macro' +
569 ' use DO CONCURRENT with mnh_undef(LOOP)')
570 gOpenACC.add_argument('--removeACC', default=False, action='store_true',
571 help='remove all ACC directives')
572 gOpenACC.add_argument('--removebyPassDOCONCURRENT', default=False, action='store_true',
573 help='remove macro !$mnh_(un)def(OPENACC) and !$mnh_(un)def(LOOP) ' +
574 'directives')
575 gOpenACC.add_argument('--buildACCTypeHelpers', default=False, action='store_true',
576 help='build module files containing helpers to copy user ' +
577 'type structures')
578 gOpenACC.add_argument('--allocatetoHIP', default=False, action='store_true',
579 help='convert (DE)ALLOCATE to (DE)ALLOCATE_HIP on variables only sent ' +
580 'to the GPU via acc enter data copyin/create (for GPU AMD MI250X)')
581
582
584 """
585 Updates an argparse parser with checks arguments
586 """
587
588 gChecks = parser.add_argument_group('Check options')
589 gChecks.add_argument('--checkIMPLICIT', choices={'Warn', 'Err'}, default=None,
590 help='Send a warning or raise an error if the "IMPLICIT NONE" ' +
591 'is missing')
592 gChecks.add_argument('--checkINTENT', choices={'Warn', 'Err'}, default=None,
593 help='Send a warning or raise an error if the "INTENT" ' +
594 'attribute is missing for a dummy argument')
595 gChecks.add_argument('--checkOpInCall', choices={'Warn', 'Err'}, default=None,
596 help='Send a warning or raise an error if a call argument is an '
597 'operation.')
598 gChecks.add_argument('--checkUnusedLocalVar', choices={'Warn', 'Err'}, default=None,
599 help='Send a warning or raise an error if some local '
600 'variables are unused.')
601 gChecks.add_argument('--checkPHYEXUnusedLocalVar', choices={'Warn', 'Err'}, default=None,
602 help='Send a warning or raise an error if some local '
603 'variables are unused (excluding variables needed '
604 'for mnh_expand directives).')
605 gChecks.add_argument('--checkEmptyParensInCall', choices={'Warn', 'Err'}, default=None,
606 help='Send a warning or raise an error if a call argument is an '
607 'array with empty parens.')
608
609
611 """
612 Updates an argparse parser with statements arguments
613 """
614
615 gStatement = parser.add_argument_group('Statements options')
616 gStatement.add_argument('--removeCall', action='append',
617 help="Call to remove from the source code. The argument " +
618 "is the subprogram name")
619 gStatement.add_argument('--removePrints', default=False, action='store_true',
620 help="Remove print statements from the source code.")
621 gStatement.add_argument('--inlineContainedSubroutines', default=False, action='store_true',
622 help='Inline containted subroutines in main routine')
623 gStatement.add_argument('--setFalseIfStmt', default=None,
624 help='Replace this value by .FALSE. in if statements')
625
626
628 """
629 Updates an argparse parser with misc arguments
630 """
631 gMisc = parser.add_argument_group('Miscellaneous')
632 gMisc.add_argument('--showScopes', default=False, action='store_true',
633 help='Show the different scopes found in the source code')
634 gMisc.add_argument('--empty', default=False, action='store_true',
635 help='Empty the different scopes')
636
637
638def updateParserTree(parser, withPlotCentralFile, treeIsOptional):
639 """
640 Updates an argparse parser with statements arguments
641 :param withPlotCentralFile: to add the --plotCentralFile argumen
642 :param treeIsOptional: is the --tree argument optional?
643 """
644 gTree = parser.add_argument_group('Tree')
645 gTree.add_argument('--tree', default=None, action='append', required=not treeIsOptional,
646 help='Directories where source code must be searched for')
647 gTree.add_argument('--descTree', default=None, required=not treeIsOptional,
648 help='File to write and/or read the description of the tree.')
649 if withPlotCentralFile:
650 gTree.add_argument('--plotCentralFile', default=None, type=str,
651 help='Central file of the plot')
652 gTree.add_argument('--plotCompilTree', default=None,
653 help='File name for compilation dependency graph (.dot or image extension)')
654 gTree.add_argument('--plotExecTree', default=None,
655 help='File name for execution dependency graph (.dot or image extension)')
656 gTree.add_argument('--plotMaxUpper', default=None, type=int,
657 help='Maximum number of upper elements in the plot tree')
658 gTree.add_argument('--plotMaxLower', default=None, type=int,
659 help='Maximum number of lower elements in the plot tree')
660 gTree.add_argument('--stopScopes', default=None, type=str,
661 help='#-separated list of scopes ' +
662 'where the recursive inclusion of an argument variable ' +
663 'must stop (needed for some transformations).')
664
665
667 """
668 Updates an argparse parser with statements arguments
669 """
670 gCpp = parser.add_argument_group('Preprocessor')
671 gCpp.add_argument('--applyCPPifdef', nargs='*', action='append',
672 help="This option is followed by the list of defined or undefined " +
673 "CPP keys. " +
674 "All #ifdef and #ifndef concerning these keys are evaluated. " +
675 "Undefined keys are preceded by a percentage sign.")
676
677
678def applyTransfo(pft, arg, args, plotCentralFile):
679 """
680 Apply transformation on a PYFT instance
681 :param pft: PYFT instance
682 :param arg: argument to deal with
683 :param args: parsed argparsed arguments
684 :param plotCentralFile: central file for plots
685 """
686 simplify = {'simplify': args.simplify}
687 parserOptions = getParserOptions(args)
688 stopScopes = args.stopScopes.split('#') if args.stopScopes is not None else None
689
690 # File name manipulations
691 applyTransfoFileName(pft, arg)
692
693 # Variables
694 applyTransfoVariables(pft, arg, args, simplify, parserOptions, stopScopes)
695
696 # Applications
697 applyTransfoApplications(pft, arg, args, simplify, parserOptions, stopScopes)
698
699 # OpenACC
700 applyTransfoOpenACC(pft, arg, args, stopScopes)
701
702 # Cosmetics
703 applyTransfoCosmetics(pft, arg, args)
704
705 # Checks
706 applyTransfoChecks(pft, arg, args)
707
708 # Statements
709 applyTransfoStatements(pft, arg, args, simplify)
710
711 # Misc
712 applyTransfoMisc(pft, arg, args, simplify)
713
714 # Tree
715 applyTransfoTree(pft, arg, args, plotCentralFile)
716
717 # Preprocessor
718 applyTransfoPreprocessor(pft, arg, args)
719
720
722 """
723 Apply file name transformations on a PYFT instance
724 :param pft: PYFT instance
725 :param arg: argument to deal with
726 :param args: parsed argparsed arguments
727 """
728
729 # File name manipulations
730 if arg == '--renamefF':
731 pft.renameUpper()
732 elif arg == '--renameFf':
733 pft.renameLower()
734
735
736def applyTransfoVariables(pft, arg, args, simplify, parserOptions, stopScopes):
737 """
738 Apply variables transformations on a PYFT instance
739 :param pft: PYFT instance
740 :param arg: argument to deal with
741 :param args: parsed argparsed arguments
742 :param simplify: kwargs to simplify
743 :param parserOptions: fxtran parser options
744 :param stopScopes: upper limit in call tree for some transformations
745 """
746 if arg == '--showVariables':
747 pft.varList.showVarList()
748 elif arg == '--attachArraySpecToEntity':
749 pft.attachArraySpecToEntity()
750 elif arg == '--removeVariable':
751 pft.removeVar(args.removeVariable, **simplify)
752 elif arg == '--addVariable':
753 pft.addVar([[v[0], v[1], v[2], (int(v[3]) if isint(v[3]) else None)]
754 for v in args.addVariable])
755 elif arg == '--addModuleVariable':
756 pft.addModuleVar([[v[0], v[1], v[2]] for v in args.addModuleVariable])
757 elif arg == '--showUnusedVariables':
758 pft.showUnusedVar()
759 elif arg == '--removeUnusedLocalVariables':
760 pft.removeUnusedLocalVar(
761 [item.strip() for item in args.removeUnusedLocalVariables.split(',')]
762 if args.removeUnusedLocalVariables != 'NONE' else None, **simplify)
763 elif arg == '--removePHYEXUnusedLocalVariables':
764 pft.removePHYEXUnusedLocalVar(
765 [item.strip() for item in args.removePHYEXUnusedLocalVariables.split(',')]
766 if args.removePHYEXUnusedLocalVariables != 'NONE' else None, **simplify)
767 elif arg == '--addExplicitArrayBounds':
768 pft.addExplicitArrayBounds()
769 elif arg == '--addArrayParentheses':
770 pft.addArrayParentheses()
771 elif arg == '--modifyAutomaticArrays':
772 pft.modifyAutomaticArrays(*(args.modifyAutomaticArrays.split('#')))
773 elif arg == '--replaceAutomaticWithAllocatable':
774 pft.modifyAutomaticArrays(
775 "{type}, DIMENSION({doubledotshape}), ALLOCATABLE :: {name}",
776 "ALLOCATE({name}({shape}))", "DEALLOCATE({name})")
777 elif arg == '--addArgInTree':
778 for varName, declStmt, pos in args.addArgInTree:
779 pft.addArgInTree(varName, declStmt, int(pos), stopScopes,
780 parserOptions=parserOptions,
781 wrapH=args.wrapH)
782
783
784def applyTransfoApplications(pft, arg, args, simplify, parserOptions, stopScopes):
785 """
786 Apply applications transformations on a PYFT instance
787 :param pft: PYFT instance
788 :param arg: argument to deal with
789 :param args: parsed argparsed arguments
790 :param simplify: kwargs to simplify
791 :param parserOptions: fxtran parser options
792 :param stopScopes: upper limit in call tree for some transformations
793 """
794 if arg == '--addStack':
795 pft.addStack(args.addStack, stopScopes,
796 parserOptions=parserOptions,
797 wrapH=args.wrapH)
798 elif arg == '--deleteDrHook':
799 pft.deleteDrHook(**simplify)
800 elif arg == '--addDrHook':
801 pft.addDrHook()
802 elif arg == '--deleteBudgetDDH':
803 pft.deleteBudgetDDH(**simplify)
804 elif arg == '--deleteRoutineCallsMesoNHGPU':
805 pft.deleteRoutineCallsMesoNHGPU(**simplify)
806 elif arg == '--deleteNonColumnCallsPHYEX':
807 pft.deleteNonColumnCallsPHYEX(**simplify)
808 elif arg == '--addMPPDB_CHECKS':
809 pft.addMPPDB_CHECKS()
810 elif arg == '--addPrints':
811 pft.addMPPDB_CHECKS(printsMode=True)
812 elif arg == '--addSubmodulePHYEX':
813 pft.addSubmodulePHYEX()
814 # mnhExpand must be before inlineContainedSubroutines as inlineContainedSubroutines
815 # can change variable names used by mnh_expand directives
816 assert not (args.mnhExpand and args.mnhExpandConcurrent), \
817 "Only one of --mnhExpand and --mnhExpandConcurrent"
818 if arg == '--mnhExpand':
819 pft.removeArraySyntax(everywhere=False, addAccIndependentCollapse=False)
820 elif arg == '--mnhExpandConcurrent':
821 pft.removeArraySyntax(concurrent=True, everywhere=False)
822 elif arg == '--inlineContainedSubroutines':
823 pft.inlineContainedSubroutines(**simplify)
824 elif arg == '--inlineContainedSubroutinesPHYEX':
825 pft.inlineContainedSubroutinesPHYEX(**simplify)
826 elif arg == '--expandAllArrays':
827 pft.removeArraySyntax()
828 elif arg == '--expandAllArraysConcurrent':
829 pft.removeArraySyntax(concurrent=True)
830 elif arg == '--expandAllArraysPHYEX':
831 pft.expandAllArraysPHYEX()
832 elif arg == '--expandAllArraysPHYEXConcurrent':
833 pft.expandAllArraysPHYEX(concurrent=True)
834 elif arg == '--removeIJDim':
835 pft.removeIJDim(stopScopes,
836 parserOptions=parserOptions,
837 wrapH=args.wrapH, **simplify)
838 elif arg == '--shumanFUNCtoCALL':
839 pft.shumanFUNCtoCALL()
840 elif arg == '--buildACCTypeHelpers':
841 pft.buildACCTypeHelpers()
842 elif arg == '--mathFunctoBRFunc':
843 pft.mathFunctoBRFunc()
844 elif arg == '--convertTypesInCompute':
845 pft.convertTypesInCompute()
846 elif arg == '--buildModi':
847 pft.buildModi()
848 elif arg == '--splitModuleRoutineFile':
849 pft.splitModuleRoutineFile()
850
851
852def applyTransfoOpenACC(pft, arg, args, stopScopes): # pylint: disable=unused-argument
853 """
854 Apply openACC transformations on a PYFT instance
855 :param pft: PYFT instance
856 :param arg: argument to deal with
857 :param args: parsed argparsed arguments
858 :param stopScopes: upper limit in call tree for some transformations
859 """
860 if arg == '--addACCData':
861 pft.addACCData()
862 elif arg == '--craybyPassDOCONCURRENT':
863 pft.craybyPassDOCONCURRENT()
864 elif arg == '--removebyPassDOCONCURRENT':
865 pft.removebyPassDOCONCURRENT()
866 elif arg == '--addACCRoutineSeq':
867 pft.addACCRoutineSeq(stopScopes)
868 elif arg == '--removeACC':
869 pft.removeACC()
870 elif arg == '--allocatetoHIP':
871 pft.allocatetoHIP()
872
873
874def applyTransfoCosmetics(pft, arg, args):
875 """
876 Apply cosmetics transformations on a PYFT instance
877 :param pft: PYFT instance
878 :param arg: argument to deal with
879 :param args: parsed argparsed arguments
880 """
881 if arg == '--upperCase':
882 pft.upperCase()
883 elif arg == '--lowerCase':
884 pft.lowerCase()
885 elif arg == '--changeIfStatementsInIfConstructs':
886 pft.changeIfStatementsInIfConstructs()
887 elif arg == '--indent':
888 pft.indent()
889 elif arg == '--removeIndent':
890 pft.indent(indentProgramunit=0, indentBranch=0)
891 elif arg == '--removeEmptyLines':
892 pft.removeEmptyLines()
893 elif arg == '--removeComments':
894 pft.removeComments()
895 elif arg == '--updateSpaces':
896 pft.updateSpaces()
897 elif arg in ARG_UPDATE_CNT:
898 pft.updateContinuation(align=args.alignContinuation,
899 addBegin=args.addBeginContinuation,
900 removeBegin=args.removeBeginContinuation,
901 removeALL=args.removeALLContinuation)
902 elif arg == '--prettify':
903 pft.indent()
904 pft.upperCase()
905 pft.removeEmptyLines()
906 pft.updateSpaces()
907 pft.updateContinuation()
908 elif arg == '--minify':
909 pft.indent(indentProgramunit=0, indentBranch=0)
910 pft.upperCase()
911 pft.removeComments()
912 pft.removeEmptyLines()
913 pft.updateSpaces()
914 pft.updateContinuation(align=False, removeALL=True, addBegin=False)
915 elif arg == '--removeEmptyCONTAINS':
916 pft.removeEmptyCONTAINS()
917
918
919def applyTransfoChecks(pft, arg, args):
920 """
921 Apply checks transformations on a PYFT instance
922 :param pft: PYFT instance
923 :param arg: argument to deal with
924 :param args: parsed argparsed arguments
925 """
926 if arg == '--checkIMPLICIT':
927 pft.checkImplicitNone(args.checkIMPLICIT == 'Err')
928 elif arg == '--checkINTENT':
929 pft.checkIntent(args.checkINTENT == 'Err')
930 elif arg == '--checkOpInCall':
931 pft.checkOpInCall(args.checkOpInCall == 'Err')
932 elif arg == '--checkUnusedLocalVar':
933 pft.checkUnusedLocalVar(args.checkUnusedLocalVar == 'Err')
934 elif arg == '--checkPHYEXUnusedLocalVar':
935 pft.checkPHYEXUnusedLocalVar(args.checkPHYEXUnusedLocalVar == 'Err')
936 elif arg == '--checkEmptyParensInCall':
937 pft.checkEmptyParensInCall(args.checkEmptyParensInCall == 'Err')
938
939
940def applyTransfoStatements(pft, arg, args, simplify):
941 """
942 Apply statements transformations on a PYFT instance
943 :param pft: PYFT instance
944 :param arg: argument to deal with
945 :param args: parsed argparsed arguments
946 :param simplify: kwargs to simplify
947 """
948 if arg == '--removeCall':
949 for rc in args.removeCall:
950 pft.removeCall(rc, **simplify)
951 elif arg == '--removePrints':
952 pft.removePrints(**simplify)
953 elif arg == '--setFalseIfStmt':
954 pft.setFalseIfStmt(args.setFalseIfStmt, **simplify)
955
956
957def applyTransfoMisc(pft, arg, args, simplify): # pylint: disable=unused-argument
958 """
959 Apply misc transformations on a PYFT instance
960 :param pft: PYFT instance
961 :param arg: argument to deal with
962 :param args: parsed argparsed arguments
963 :param simplify: kwargs to simplify
964 """
965 if arg == '--showScopes':
966 pft.showScopesList()
967 elif arg == '--empty':
968 pft.empty(**simplify)
969
970
971def applyTransfoTree(pft, arg, args, plotCentralFile):
972 """
973 Apply tree transformations on a PYFT instance
974 :param pft: PYFT instance
975 :param arg: argument to deal with
976 :param args: parsed argparsed arguments
977 :param plotCentralFile: central file for plots
978 """
979 if arg == '--plotCompilTree' and plotCentralFile is not None:
980 pft.tree.plotCompilTreeFromFile(plotCentralFile, args.plotCompilTree,
981 args.plotMaxUpper, args.plotMaxLower)
982 elif arg == '--plotExecTree' and plotCentralFile is not None:
983 pft.tree.plotExecTreeFromFile(plotCentralFile, args.plotExecTree,
984 args.plotMaxUpper, args.plotMaxLower)
985
986
987def applyTransfoPreprocessor(pft, arg, args):
988 """
989 Apply preprocessor transformations on a PYFT instance
990 :param pft: PYFT instance
991 :param arg: argument to deal with
992 :param args: parsed argparsed arguments
993 """
994 if arg == '--applyCPPifdef':
995 pft.applyCPPifdef([k for aList in args.applyCPPifdef for k in aList])
applyTransfoApplications(pft, arg, args, simplify, parserOptions, stopScopes)
Definition scripting.py:784
updateParserVariables(parser)
Definition scripting.py:374
applyTransfoStatements(pft, arg, args, simplify)
Definition scripting.py:940
applyTransfoTree(pft, arg, args, plotCentralFile)
Definition scripting.py:971
applyTransfoPreprocessor(pft, arg, args)
Definition scripting.py:987
updateParserCosmetics(parser)
Definition scripting.py:447
applyTransfoVariables(pft, arg, args, simplify, parserOptions, stopScopes)
Definition scripting.py:736
updateParserInputsOutputs(parser, withInput, withOutput, withXml)
Definition scripting.py:337
updateParserApplications(parser)
Definition scripting.py:487
updateParserFxtran(parser)
Definition scripting.py:362
updateParserChecks(parser)
Definition scripting.py:583
updateParserOpenACC(parser)
Definition scripting.py:557
updateParserPreprocessor(parser)
Definition scripting.py:666
applyTransfoOpenACC(pft, arg, args, stopScopes)
Definition scripting.py:852
updateParserStatements(parser)
Definition scripting.py:610
applyTransfoChecks(pft, arg, args)
Definition scripting.py:919
applyTransfo(pft, arg, args, plotCentralFile)
Definition scripting.py:678
getDescTree(args, cls=Tree)
Definition scripting.py:229
applyTransfoMisc(pft, arg, args, simplify)
Definition scripting.py:957
updateParser(parser, withInput, withOutput, withXml, withPlotCentralFile, treeIsOptional, nbPar, restrictScope)
Definition scripting.py:247
applyTransfoCosmetics(pft, arg, args)
Definition scripting.py:874
applyTransfoFileName(pft, arg)
Definition scripting.py:721
updateParserTree(parser, withPlotCentralFile, treeIsOptional)
Definition scripting.py:638
updateParserMisc(parser)
Definition scripting.py:627