Merge pull request #2090 from willend/cppcheck-hints

willend · web-flow · commit d96824241a5a · 2025-08-11T16:59:19.000+02:00
Implement 'cppcheck' linting support on Unix, can be utilised via mcrun or mctest
diff --git a/.github/workflows/mcstas-basictest.yml b/.github/workflows/mcstas-basictest.yml
@@ -175,7 +175,7 @@ jobs:
            ./install_mcstas/bin/${MCSTAS_EXECUTABLE} --version
            mkdir run_RNG && cd run_RNG
            cp ../install_mcstas/share/mcstas/resources/examples/Tests_RNG/Test_RNG_rand01/Test_RNG_rand01.instr .
-           ../install_mcstas/bin/${MCRUN_EXECUTABLE} Test_RNG_rand01.instr -s1000 seed=1000 -d RNGtest
+           ../install_mcstas/bin/${MCRUN_EXECUTABLE} Test_RNG_rand01.instr -s1000 Ncount=1000 -d RNGtest
            export SUM=`grep -v \# RNGtest/rngout.dat | ${MD5SUM} | cut -f1 -d\ `
            export EXPECTED="f192ce4609e2225bf9d42ce9c5fa5a86"
            if [ "${EXPECTED}" == "${SUM}" ];
diff --git a/.github/workflows/mcstas-winbasictest-mingw.yml b/.github/workflows/mcstas-winbasictest-mingw.yml
@@ -131,7 +131,7 @@ jobs:
 
     - name: Run rng instrument
       working-directory: run_rng
-      run: ..\install\bin\mcrun --verbose test.instr -s1000 seed=1000 -d RNGtest
+      run: ..\install\bin\mcrun --verbose test.instr -s1000 Ncount=1000 -d RNGtest
 
     - name: Test RNG instrument output
       working-directory: run_rng
diff --git a/.github/workflows/mcstas-winbasictest-msvc.yml b/.github/workflows/mcstas-winbasictest-msvc.yml
@@ -151,7 +151,7 @@ jobs:
 
     - name: Run rng instrument
       working-directory: run_rng
-      run: ..\install\bin\mcrun --verbose test.instr -s1000 seed=1000 -d RNGtest
+      run: ..\install\bin\mcrun --verbose test.instr -s1000 Ncount=1000 -d RNGtest
 
     - name: Test RNG instrument output
       working-directory: run_rng
diff --git a/.github/workflows/mcxtrace-basictest.yml b/.github/workflows/mcxtrace-basictest.yml
@@ -178,7 +178,7 @@ jobs:
            ./install_mcxtrace/bin/${MCXTRACE_EXECUTABLE} --version
            mkdir run_RNG && cd run_RNG
            cp ../install_mcxtrace/share/mcxtrace/resources/examples/Tests_RNG/Test_RNG_rand01/Test_RNG_rand01.instr .
-           ../install_mcxtrace/bin/${MXRUN_EXECUTABLE} Test_RNG_rand01.instr -s1000 seed=1000 -d RNGtest
+           ../install_mcxtrace/bin/${MXRUN_EXECUTABLE} Test_RNG_rand01.instr -s1000 Ncount=1000 -d RNGtest
            export SUM=`grep -v \# RNGtest/rngout.dat | ${MD5SUM} | cut -f1 -d\ `
            export EXPECTED="f192ce4609e2225bf9d42ce9c5fa5a86"
            if [ "${EXPECTED}" == "${SUM}" ];
diff --git a/.github/workflows/mcxtrace-winbasictest-mingw.yml b/.github/workflows/mcxtrace-winbasictest-mingw.yml
@@ -120,7 +120,7 @@ jobs:
 
     - name: Run rng instrument
       working-directory: run_rng
-      run: ..\install\bin\mxrun --verbose test.instr -s1000 seed=1000 -d RNGtest
+      run: ..\install\bin\mxrun --verbose test.instr -s1000 Ncount=1000 -d RNGtest
 
     - name: Test RNG instrument output
       working-directory: run_rng
diff --git a/.github/workflows/mcxtrace-winbasictest-msvc.yml b/.github/workflows/mcxtrace-winbasictest-msvc.yml
@@ -142,7 +142,7 @@ jobs:
 
     - name: Run rng instrument
       working-directory: run_rng
-      run: ..\install\bin\mxrun --verbose test.instr -s1000 seed=1000 -d RNGtest
+      run: ..\install\bin\mxrun --verbose test.instr -s1000 Ncount=1000 -d RNGtest
 
     - name: Test RNG instrument output
       working-directory: run_rng
diff --git a/common/lib/share/mccode-r.c b/common/lib/share/mccode-r.c
@@ -2009,8 +2009,17 @@ int mcdetector_out_axis_nexus(NXhandle f, char *label, char *var, int rank, long
   else {
     double *axis;
     axis=malloc(sizeof(double)*length);
+    if (!axis ) {
+      printf("Fatal memory error allocating NeXus axis of length %li, exiting!\n", length);
+      return(NX_ERROR);
+    }
     char *valid;
     valid=malloc(sizeof(char)*CHAR_BUF_LENGTH);
+    if (!valid ) {
+      printf("Fatal memory error allocating label axis of length %li, exiting!\n", CHAR_BUF_LENGTH);
+      free(axis);
+      return(NX_ERROR);
+    }
     int dim=(int)length;
     int i;
     int nprimary=1;
diff --git a/mccode/nlib/share/mcstas-r.c b/mccode/nlib/share/mcstas-r.c
@@ -80,6 +80,9 @@ _class_particle mcsetstate(double x, double y, double z, double vx, double vy, d
   mcneutron._mctmp_a = mcneutron._mctmp_b =  mcneutron._mctmp_c = 0;
   // what about mcneutron._logic ?
   mcneutron._logic.dummy=1;
+  // init uservars via cogen'd-function
+  particle_uservar_init(&mcneutron);
+
   return(mcneutron);
 } /* mcsetstate */
 
diff --git a/mccode/src/cogen.c.in b/mccode/src/cogen.c.in
@@ -2053,7 +2053,6 @@ int cogen_raytrace(struct instr_def *instr)
   coutf("      #endif");
   coutf("");
   coutf("      srandom(_hash((pidx+1)*(seed+1)));");
-  coutf("      particle_uservar_init(_particle);");
   coutf("");
   coutf("      raytrace(_particle);");
   coutf("    } /* inner for */");
@@ -2182,7 +2181,6 @@ int cogen_rt_funnel(struct instr_def *instr)
   coutf("      _particle->_uid += mpi_node_rank * ncount; ");
   coutf("      #endif");
   coutf("      srandom(_hash((pidx+1)*(seed+1))); // _particle->state usage built into srandom macro");
-  coutf("      particle_uservar_init(_particle);");
   coutf("    }");
   cout( "");
 
diff --git a/mccode/xlib/share/mcxtrace-r.c b/mccode/xlib/share/mcxtrace-r.c
@@ -59,6 +59,9 @@ _class_particle mcsetstate(double x, double y, double z, double kx, double ky, d
   mcphoton._restore   = 0;
   mcphoton._scattered = 0;
 
+  // init uservars via cogen'd-function
+  particle_uservar_init(&mcphoton);
+
   return(mcphoton);
 } /* mcsetstate */
 
diff --git a/tools/Python/mccodelib/mccode_config.json.in b/tools/Python/mccodelib/mccode_config.json.in
@@ -33,7 +33,9 @@
     "OACC": "@OACC@",
     "MPICC": "@MCCODE_FINAL_MPICC@",
     "MPIRUN": "@MCCODE_FINAL_MPIRUN@",
-    "MPINODES": "auto"
+    "MPINODES": "auto",
+    "CLINT": "cppcheck",
+    "CLINTERFLAGS": "--check-level=exhaustive --force -DMCDEFAULT_NCOUNT=1000000 -UMC_PORTABLE -DND_BUFFER=10000000 -UNOABSORB_INF_NAN -UOMPI_MPI_H -DSIGABRT -DSIGBREAK -DSIGBUS -DSIGPE -DSIGHUP -DSIGILL -DSIGINT -DSIGKILL -DSIGUSR1 -DSIGUSR2 -DSIGPIPE -DSIGQUIT -DSIGSEGV -DSIGTRAP -DSIGURG -DSIGFPE -DSIGKILL -DSIGTERM -UTEST -UUSE_OPENCL -UWIN32 -UOPENACC -UGCCOFFLOAD -U_MSC_VER -U_MSC_EXTENSIONS -U_WIN32 -UWIN32 -D__unix__ -UDANSE -UFUNNEL -UMC_ANCIENT_COMPATIBILITY -UMC_POL_COMPAT -UNEUTRONICS -Uisnan -Uisinf"
   },
   "platform": {
     "EXESUFFIX": "@MCCODE_EXE_SUFFIX_NEVEREMPTY@"
diff --git a/tools/Python/mcrun/mccode.py b/tools/Python/mcrun/mccode.py
@@ -174,13 +174,18 @@ def x_path(file):
             self.binpath = existingBin
             return  # skip recompilation
 
-        LOG.info('Recompiling: %s', self.binpath)
+        if options.c_lint:
+            LOG.info('Linting generated code: %s', self.cpath)
+        else:
+            LOG.info('Recompiling: %s', self.binpath)
 
-        # Setup cflags, use -lm anywhere else than Windows-conda with cl.exe
         cflags = ''
-        if not "cl.exe" in mccode_config.compilation['CC'].lower():
+        # Setup cflags, use -lm anywhere unless if we are linting or using Windows-conda with cl.exe:
+        if options.c_lint or "cl.exe" in mccode_config.compilation['CC'].lower():
+            pass
+        else:
             cflags += '-lm ' # math library
-
+            
         # Special support for conda environment with compilers included. To be
         # conservative we (for now?) only apply this when both CONDA_PREFIX and
         # LDFLAGS/CFLAGS are set (C++/Fortran would use CXXFLAGS/FFLAGS instead
@@ -306,12 +311,19 @@ def x_path(file):
             if "${CONDA_PREFIX}" in cflags:
                 cflags=cflags.replace("${CONDA_PREFIX}",os.environ.get('CONDA_PREFIX'))
 
-        # Final assembly of compiler commandline
-        if not "cl.exe" in mccode_config.compilation['CC'].lower():
-            args = ['-o', self.binpath, self.cpath] + lexer.split(cflags)
+        # Lint or compile?
+        if options.c_lint is not None:
+            args = [self.cpath] + lexer.split(mccode_config.compilation['CLINTERFLAGS'])
+            Process(lexer.quote(mccode_config.compilation['CLINT'])).run(args)
+            LOG.info('End of linting %s', self.cpath)
+            exit()
         else:
-            args = [self.cpath] + lexer.split(cflags)
-        Process(lexer.quote(options.cc)).run(args)
+            # Final assembly of compiler commandline
+            if not "cl.exe" in mccode_config.compilation['CC'].lower():
+                args = ['-o', self.binpath, self.cpath] + lexer.split(cflags)
+            else:
+                args = [self.cpath] + lexer.split(cflags)
+            Process(lexer.quote(options.cc)).run(args)
 
     def run(self, pipe=False, extra_opts=None, override_mpi=None):
         ''' Run simulation '''
diff --git a/tools/Python/mcrun/mcrun.py b/tools/Python/mcrun/mcrun.py
@@ -66,7 +66,11 @@ def add_mcrun_options(parser):
     add('--cogen',
         metavar='cogen',
         help='Choice of code-generator (implies -c)')
-    
+
+    add('-C','--c-lint',
+        action='store_true',
+        help='Use c-linter (e.g. cppcheck) to lint the generated code. Configure linter via mccode_config.json. Implies -c and -v, but also NO simulation will be run. ')
+
     add('-I',
         metavar='I',
         help='Append to McCode search path (implies -c)')
@@ -517,6 +521,10 @@ def main():
     # Fill out extra information
     expand_options(options)
 
+    if options.c_lint is not None:
+        options.force_compile = True
+        options.verbose = True
+
     if options.verbose:
         setLogLevel(DEBUG)
 
diff --git a/tools/Python/mctest/mctest.py b/tools/Python/mctest/mctest.py
@@ -64,11 +64,13 @@ def __init__(self, sourcefile, localfile, parvals=None, detector=None, targetval
         self.targetval = targetval
         self.testval = None
 
+        self.linted = None
         self.compiled = None
         self.compiletime = None
         self.didrun = None
         self.runtime = None
         self.errmsg = None
+
     def get_json_repr(self):
         return {
             "displayname"  : self.get_display_name(),
@@ -82,6 +84,7 @@ def get_json_repr(self):
             "targetval"    : self.targetval,
             "testval"      : self.testval,
 
+            "linted"       : self.linted,
             "compiled"     : self.compiled,
             "compiletime"  : self.compiletime,
             "didrun"       : self.didrun,
@@ -219,34 +222,45 @@ def mccode_test(branchdir, testdir, limitinstrs=None, instrfilter=None, version=
 
 
     # compile, record time
-    global ncount, mpi, openacc, suffix, nexus
+    global ncount, mpi, openacc, suffix, nexus, lint
     logging.info("")
-    logging.info("Compiling instruments [seconds]...")
+    if not lint:
+        logging.info("Compiling instruments [seconds]...")
+    else:
+        logging.info("c-lint'ing instruments [seconds]...")
+
     for test in tests:
         # if binary exists, set compile time = 0 and continue
         binfile = os.path.splitext(test.localfile)[0] + "." + mccode_config.platform["EXESUFFIX"].lower()
         failed=os.path.splitext(test.localfile)[0] + ".failed"
+        # if we linted, continue
+        linted=os.path.splitext(test.localfile)[0] + ".linted"
         if os.path.exists(failed):
             test.compiled = False
             test.compiletime = -1
         elif os.path.exists(binfile):
             test.compiled = True
             test.compiletime = 0
+        elif os.path.exists(linted):
+            test.linted = True
         else:
             if test.testnb > 0 or (not args.skipnontest):
                 log = LineLogger()
                 t1 = time.time()
                 cmd = mccode_config.configuration["MCRUN"]
-                if nexus:
-                    cmd = cmd + " --format=NeXus "
-                if version:
-                    cmd = cmd + " --override-config=" + join(os.path.dirname(__file__), mccode_config.configuration["MCCODE"] + "-test",version)
-                if openacc:
-                    cmd = cmd + " --openacc "
-                if mpi:
-                    cmd = cmd + " --mpi=1 "
+                if lint:
+                    cmd = cmd + " --verbose -C %s > compile_stdout.txt 2>&1" % test.instrname
+                else:
+                    if nexus:
+                        cmd = cmd + " --format=NeXus "
+                    if version:
+                        cmd = cmd + " --override-config=" + join(os.path.dirname(__file__), mccode_config.configuration["MCCODE"] + "-test",version)
+                    if openacc:
+                        cmd = cmd + " --openacc "
+                    if mpi:
+                        cmd = cmd + " --mpi=1 "
+                    cmd = cmd + " --verbose -c -n0 %s > compile_stdout.txt 2>&1" % test.instrname
 
-                cmd = cmd + " --verbose -c -n0 %s > compile_stdout.txt 2>&1" % test.instrname
                 utils.run_subtool_noread(cmd, cwd=join(testdir, test.instrname))
                 t2 = time.time()
                 test.compiled = os.path.exists(binfile)
@@ -258,21 +272,33 @@ def mccode_test(branchdir, testdir, limitinstrs=None, instrfilter=None, version=
                       "{:3d}.".format(math.floor(test.compiletime)) + str(test.compiletime-int(test.compiletime)).split('.')[1][:2]
                     logging.info(formatstr % test.get_display_name())
                 else:
-                    formatstr = "%-" + "%ds: COMPILE ERROR using:\n" % maxnamelen
-                    logging.info(formatstr % test.instrname + cmd)
-                    f = open(failed, "a")
-                    f.write(formatstr % test.instrname + cmd)
-                    f.close()
+                    if lint:
+                        formatstr = "%-" + "%ds: Linted using using:\n" % maxnamelen
+                        logging.info(formatstr % test.instrname + cmd)
+                        f = open(linted, "a")
+                        f.write(formatstr % test.instrname + cmd)
+                        f.close()
+                        test.linted = True
+                    else:
+                        formatstr = "%-" + "%ds: COMPILE ERROR using:\n" % maxnamelen
+                        logging.info(formatstr % test.instrname + cmd)
+                        f = open(failed, "a")
+                        f.write(formatstr % test.instrname + cmd)
+                        f.close()
             else:
                 logging.info("Skipping compile of " + test.instrname)
         # save (incomplete) test results to disk
         test.save(infolder=join(testdir, test.instrname))
 
     # run, record time
     logging.info("")
-    logging.info("Running tests...")
+    logging.info("Running tests / getting status...")
     for test in tests:
-        if not test.compiled:
+        if test.linted:
+            formatstr = "%-" + "%ds:  Linter only" % (maxnamelen+1)
+            logging.info(formatstr % test.instrname)
+            continue
+        elif not test.compiled:
             formatstr = "%-" + "%ds:   NO COMPILE" % (maxnamelen+1)
             logging.info(formatstr % test.instrname)
             continue
@@ -597,6 +623,7 @@ def print_to_console(str):
 openacc = None
 suffix = None
 nexus = None
+lint = None
 
 def main(args):
     # mutually excusive main branches
@@ -659,7 +686,7 @@ def main(args):
             quit(1)
     logging.debug("")
 
-    global ncount, mpi, skipnontest, openacc, nexus
+    global ncount, mpi, skipnontest, openacc, nexus, lint
     if args.ncount:
         ncount = args.ncount[0]
     elif args.n:
@@ -687,6 +714,10 @@ def main(args):
         nexus = True
         suffix = '_NeXus' + suffix
         logging.info("NeXus compilation / output format is enabled")
+    if args.lint:
+        lint = True
+        suffix = '_lint' + suffix
+        logging.info("c-linting enabled")
     # decide and run main branch
     if version and configs or version and vinfo or configs and vinfo:
         print("WARNING: version, --configs and --versions are mutually exclusive, exiting")
@@ -720,6 +751,7 @@ def main(args):
     parser.add_argument('--skipnontest', action='store_true', help='Skip compilation of instruments without a test')
     parser.add_argument('--suffix', nargs=1, help='Add suffix to test directory name, e.g. 3.x-dev_suffix')
     parser.add_argument('--nexus', action='store_true', help='Compile for / use NeXus output format everywhere')
+    parser.add_argument('--lint', action='store_true', help='Just run the c-linter')
     args = parser.parse_args()
 
     try:
diff --git a/tools/Python/mctest/mcviewtest.py b/tools/Python/mctest/mcviewtest.py
@@ -72,8 +72,12 @@ def get_cell_tuple(cellobj, refval=None):
         curl = label + "/" + cellobj["instrname"] +  "/compile_stdout.txt"
 
         if not cellobj["compiled"]:
-            state = 4
-            return (state, "<strong><font color=\"red\">! Compile error !</font></strong>", "", "", "", curl)
+            if cellobj["linted"]:
+                state = 4
+                return (state, "<strong><font color=\"#8B4000\">C-linter output</font></strong>", "", "", "", curl)
+            else:
+                state = 4
+                return (state, "<strong><font color=\"red\">! Compile error !</font></strong>", "", "", "", curl)
         elif not cellobj["didrun"]:
             state = 3
             compiletime = "%.2f s" % cellobj["compiletime"]
