Merge pull request #149 from github/max_threads

Use all available threads for analysis

analyze/action.yml

@@ -19,7 +19,6 @@ inputs:
   threads:
     description: The number of threads to be used by CodeQL.
     required: false
-    default: "1"
   checkout_path:
     description: "The path at which the analyzed repository was checked out. Used to relativeize any absolute paths in the uploaded SARIF file."
     required: false

lib/util.js

@@ -319,28 +319,36 @@ function getMemoryFlag() {
 }
 exports.getMemoryFlag = getMemoryFlag;
 /**
- * Get the codeql `--threads` value specified for the `threads` input. The value
+ * Get the codeql `--threads` value specified for the `threads` input.
- * defaults to 1. The value will be capped to the number of available CPUs.
+ * If not value was specified, all available threads will be used.
+ *
+ * The value will be capped to the number of available CPUs.
  *
  * @returns string
  */
 function getThreadsFlag() {
-    let numThreads = 1;
+    let numThreads;
     const numThreadsString = core.getInput("threads");
+    const maxThreads = os.cpus().length;
     if (numThreadsString) {
         numThreads = Number(numThreadsString);
         if (Number.isNaN(numThreads)) {
             throw new Error(`Invalid threads setting "${numThreadsString}", specified.`);
         }
-        const maxThreads = os.cpus().length;
         if (numThreads > maxThreads) {
+            core.info(`Clamping desired number of threads (${numThreads}) to max available (${maxThreads}).`);
             numThreads = maxThreads;
         }
         const minThreads = -maxThreads;
         if (numThreads < minThreads) {
+            core.info(`Clamping desired number of free threads (${numThreads}) to max available (${minThreads}).`);
             numThreads = minThreads;
         }
     }
+    else {
+        // Default to using all threads
+        numThreads = maxThreads;
+    }
     return `--threads=${numThreads}`;
 }
 exports.getThreadsFlag = getThreadsFlag;

src/util.ts

@@ -375,27 +375,34 @@ export function getMemoryFlag(): string {
 }
 
 /**
- * Get the codeql `--threads` value specified for the `threads` input. The value
+ * Get the codeql `--threads` value specified for the `threads` input.
- * defaults to 1. The value will be capped to the number of available CPUs.
+ * If not value was specified, all available threads will be used.
+ *
+ * The value will be capped to the number of available CPUs.
  *
  * @returns string
  */
 export function getThreadsFlag(): string {
-  let numThreads = 1;
+  let numThreads: number;
   const numThreadsString = core.getInput("threads");
+  const maxThreads = os.cpus().length;
   if (numThreadsString) {
     numThreads = Number(numThreadsString);
     if (Number.isNaN(numThreads)) {
       throw new Error(`Invalid threads setting "${numThreadsString}", specified.`);
     }
-    const maxThreads = os.cpus().length;
     if (numThreads > maxThreads) {
+      core.info(`Clamping desired number of threads (${numThreads}) to max available (${maxThreads}).`);
       numThreads = maxThreads;
     }
     const minThreads = -maxThreads;
     if (numThreads < minThreads) {
+      core.info(`Clamping desired number of free threads (${numThreads}) to max available (${minThreads}).`);
       numThreads = minThreads;
     }
+  } else {
+    // Default to using all threads
+    numThreads = maxThreads;
   }
   return `--threads=${numThreads}`;
 }