Compiler interface for compiler options (llvm#1167)

Add runtime support to set options: command line options can also be given by env variable ONNX_MLIR_FLAG S and ONNX_MLIR_OPT_FLAGS. In addition, the compiler interface was augmented to enable the setting of options using either command line and/or an environment variable.

Signed-off-by: Alexandre Eichenberger <[email protected]>

Author: AlexandreEichenberger

README.md

@@ -100,6 +100,8 @@ These are frontend options.
 The full list of options is given by the `--help` option. Note that just as most compilers, the default optimization level is `-O0`. 
 We recommend using `-O3` for most applications.
 
+Options are also read from the `ONNX_MLIR_FLAGS` environment variable. For example, `ONNX_MLIR_FLAGS="-O3"` will ensure `-O3` for all compilations.
+
 ### Simple Example
 
 For example, use the following command to lower an ONNX model (e.g., add.onnx) to ONNX dialect:

include/OnnxMlirCompiler.h

@@ -13,6 +13,12 @@
 #define ONNX_MLIR_ONNXMLIRCOMPILER_H
 
 #include <onnx-mlir/Compiler/OMCompilerTypes.h>
+#ifdef __cplusplus
+#include <cstdint>
+#else
+#include <stdint.h>
+#endif // #ifdef __cplusplus
+
 
 #ifdef ONNX_MLIR_BUILT_AS_STATIC
 #define ONNX_MLIR_EXPORT
@@ -33,47 +39,104 @@
 
 #ifdef __cplusplus
 extern "C" {
+namespace onnx_mlir {
 #endif
 
-namespace onnx_mlir {
+/*!
+ *  Define ONNX-MLIR compiler options with options defined by
+ *  the envVarName (default ONNX_MLIR_FLAGS) environment variable.
+ *  Values not recognized as compiler options result in an error.
+ *  Only a single call to omSetCompilerOptionsFromEnv,
+ *  omSetCompilerOptionsFromArgs, or omSetCompilerOptionsFromEnvAndArgs
+ *  is allowed.
+ *  @param envVarName Environment variable name, use default when null.
+ *  @return 0 on success or non-zero error code on failure.
+ */
+ONNX_MLIR_EXPORT int64_t omSetCompilerOptionsFromEnv(
+    const char *envVarName);
+
+/*!
+ *  Define ONNX-MLIR compiler options with options defined by
+ *  the argc/argv parameters. Call expects argv[0] to contain the program
+ *  name. Values not recognized as compiler options result in an error.
+ *  Only a single call to omSetCompilerOptionsFromEnv,
+ *  omSetCompilerOptionsFromArgs, or omSetCompilerOptionsFromEnvAndArgs
+ *  is allowed.
+ *  @param argc Number of input parameters in argv.
+ *  @param argv Array of strings, some of which may be compiler options.
+ *  First argv is ignored as it contains the name of the program.
+ *  @return 0 on success or non-zero error code on failure.
+ */
+ONNX_MLIR_EXPORT int64_t omSetCompilerOptionsFromArgs(
+    int64_t argc, char *argv[]);
+
+/*!
+ *  Define ONNX-MLIR compiler options with options defined by
+ *  the envVarName (default ONNX_MLIR_FLAGS) environment variable
+ *  and the argc/argv parameters. Call expects argv[0] to contain the program
+ *  name. Values not recognized as compiler options result in an error.
+ *  Only a single call to omSetCompilerOptionsFromEnv,
+ *  omSetCompilerOptionsFromArgs, or omSetCompilerOptionsFromEnvAndArgs
+ *  is allowed.
+ *  @param argc Number of input parameters in argv.
+ *  @param argv Array of strings, some of which may be compiler options.
+ *  First argv is ignored as it contains the name of the program.
+ *  @param envVarName Environment variable name, use default when null.
+ *  @return 0 on success or non-zero error code on failure.
+ */
+ONNX_MLIR_EXPORT int64_t omSetCompilerOptionsFromArgsAndEnv(
+    int64_t argc, char *argv[], const char *envVarName);
+
+/*!
+ *  Overwrite the compiler option defined by input parameters.
+ *  Set default value by calling this function before a call to
+ *  omSetCompilerOptionsFromEnv, omSetCompilerOptionsFromArgs, or
+ *  omSetCompilerOptionsFromEnvAndArgs. Or overwrite the current value
+ *  by calling this function after one of the above 3 setter functions.
+ *  @param kind Describe which option kind is being set.
+ *  @param val Value of the option being set. Null pointer reset the
+ *  option.
+ *  @return 0 on success or non-zero error code on failure.
+ */
+ONNX_MLIR_EXPORT int64_t omSetCompilerOption(
+    const OptionKind kind, const char *val);
+
+/*!
+ *  Get the compiler options.
+ *  @param kind Describe which option kind is being set.
+ *  @return Value of compiler option.
+ */
+ONNX_MLIR_EXPORT const char *omGetCompilerOption(
+    const OptionKind kind);
 
 /*!
  *  Compile an onnx model from a file containing MLIR or ONNX protobuf.
  *  @param inputFilename File name pointing onnx model protobuf or MLIR.
  *  @param outputBaseName File name without extension to write output.
  *  @param emissionTarget Target format to compile to.
- *  @param optionKey List of keys specified for the compiler options.
- *  @param optionVal List of string values for corresponding keys.
- *  @param optionNum Number of keys and strings.
  *  @param errorMessage Error message.
  *  @return 0 on success or non-zero error code on failure.
  */
-ONNX_MLIR_EXPORT int omCompileFromFile(const char *inputFilename,
+ONNX_MLIR_EXPORT int64_t omCompileFromFile(const char *inputFilename,
     const char *outputBaseName, EmissionTargetType emissionTarget,
-    const onnx_mlir::OptionKind *optionKey, const char **optionVal,
-    const int optionNum, const char **errorMessage);
+    const char **errorMessage);
 
 /*!
  *  Compile an onnx model from an ONNX protobuf array.
  *  @param inputBuffer ONNX protobuf array.
  *  @param bufferSize Size of ONNX protobuf array.
  *  @param outputBaseName File name without extension to write output.
  *  @param emissionTarget Target format to compile to.
- *  @param optionKey List of keys specified for the compiler options.
- *  @param optionVal List of string values for corresponding keys.
- *  @param optionNum Number of keys and strings.
+ *  @param errorMessage Error message.
  *  @return 0 on success or non-zero error code on failure
  */
-ONNX_MLIR_EXPORT int omCompileFromArray(const void *inputBuffer, int bufferSize,
-    const char *outputBaseName, EmissionTargetType emissionTarget,
-    const onnx_mlir::OptionKind *optionKey, const char **optionVal,
-    const int optionNum
-);
-
-} // namespace onnx_mlir
+ONNX_MLIR_EXPORT int64_t omCompileFromArray(const void *inputBuffer,
+    int bufferSize, const char *outputBaseName,
+    EmissionTargetType emissionTarget, const char **errorMessage);
 
 #ifdef __cplusplus
-}
+} // namespace onnx_mlir
+} // extern C
 #endif
 
 #endif

include/onnx-mlir/Compiler/OMCompilerTypes.h

@@ -38,7 +38,7 @@ typedef enum {
   CompilerOptLevel, /* Kind for '0'...'3' string describing OptLevel. */
   OPTFlag,          /* Kind for -Xopt string. */
   LLCFlag,          /* Kind for -Xllc string. */
-  LLVMFlag          /* Kind for -mllvm string. */
+  LLVMFlag,         /* Kind for -mllvm string. */
 } OptionKind;
 
 #ifdef __cplusplus