wasm-micro-runtime/wamr-compiler/main.c

/*
 * Copyright (C) 2019 Intel Corporation. All rights reserved.
 * SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 */

#include <stdlib.h>
#include "bh_platform.h"
#include "bh_read_file.h"
#include "wasm_export.h"
#include "aot_export.h"

static int
print_help()
{
  printf("Usage: wamrc [options] -o output_file wasm_file\n");
  printf("  --target=<arch-name>      Set the target arch, which has the general format: <arch><sub>\n");
  printf("                            <arch> = x86_64, i386, aarch64, arm, thumb, xtensa, mips.\n");
  printf("                              Default is host arch, e.g. x86_64\n");
  printf("                            <sub> = for ex. on arm or thumb: v5, v6m, v7a, v7m, etc.\n");
  printf("                            Use --target=help to list supported targets\n");
  printf("  --target-abi=<abi>        Set the target ABI, e.g. gnu, eabi, gnueabihf, etc. (default: gnu)\n");
  printf("                            Use --target-abi=help to list all the ABI supported\n");
  printf("  --cpu=<cpu>               Set the target CPU (default: host CPU, e.g. skylake)\n");
  printf("                            Use --cpu=help to list all the CPU supported\n");
  printf("  --cpu-features=<features> Enable or disable the CPU features\n");
  printf("                            Use +feature to enable a feature, or -feature to disable it\n");
  printf("                            For example, --cpu-features=+feature1,-feature2\n");
  printf("                            Use --cpu-features=+help to list all the features supported\n");
  printf("  --opt-level=n             Set the optimization level (0 to 3, default is 3)\n");
  printf("  --size-level=n            Set the code size level (0 to 3, default is 3)\n");
  printf("  -sgx                      Generate code for SGX platform (Intel Software Guard Extention)\n");
  printf("  --bounds-checks=1/0       Enable or disable the bounds checks for memory access:\n");
  printf("                              by default it is disabled in all 64-bit platforms except SGX and\n");
  printf("                              in these platforms runtime does bounds checks with hardware trap,\n");
  printf("                              and by default it is enabled in all 32-bit platforms\n");
  printf("  --format=<format>         Specifies the format of the output file\n");
  printf("                            The format supported:\n");
  printf("                              aot (default)  AoT file\n");
  printf("                              object         Native object file\n");
  printf("                              llvmir-unopt   Unoptimized LLVM IR\n");
  printf("                              llvmir-opt     Optimized LLVM IR\n");
  printf("  --enable-bulk-memory      Enable the post-MVP bulk memory feature\n");
  printf("  --enable-multi-thread     Enable multi-thread feature, the dependent features bulk-memory and\n");
  printf("                            thread-mgr will be enabled automatically\n");
  printf("  -v=n                      Set log verbose level (0 to 5, default is 2), larger with more log\n");
  printf("Examples: wamrc -o test.aot test.wasm\n");
  printf("          wamrc --target=i386 -o test.aot test.wasm\n");
  printf("          wamrc --target=i386 --format=object -o test.o test.wasm\n");
  return 1;
}

int
main(int argc, char *argv[])
{
  char *wasm_file_name = NULL, *out_file_name = NULL;
  uint8 *wasm_file = NULL;
  uint32 wasm_file_size;
  wasm_module_t wasm_module = NULL;
  aot_comp_data_t comp_data = NULL;
  aot_comp_context_t comp_ctx = NULL;
  RuntimeInitArgs init_args;
  AOTCompOption option = { 0 };
  char error_buf[128];
  int log_verbose_level = 2;
  bool sgx_mode = false;

  option.opt_level = 3;
  option.size_level = 3;
  option.output_format = AOT_FORMAT_FILE;
  /* default value, enable or disable depends on the platform */
  option.bounds_checks = 2;

  /* Process options.  */
  for (argc--, argv++; argc > 0 && argv[0][0] == '-'; argc--, argv++) {
    if (!strcmp(argv[0], "-o")) {
      argc--, argv++;
      if (argc < 2)
        return print_help();
      out_file_name = argv[0];
    }
    else if (!strncmp(argv[0], "--target=", 9)) {
        if (argv[0][9] == '\0')
            return print_help();
        option.target_arch = argv[0] + 9;
    }
    else if (!strncmp(argv[0], "--target-abi=", 13)) {
        if (argv[0][13] == '\0')
            return print_help();
        option.target_abi = argv[0] + 13;
    }
    else if (!strncmp(argv[0], "--cpu=", 6)) {
        if (argv[0][6] == '\0')
            return print_help();
        option.target_cpu = argv[0] + 6;
    }
    else if (!strncmp(argv[0], "--cpu-features=", 15)) {
        if (argv[0][15] == '\0')
            return print_help();
        option.cpu_features = argv[0] + 15;
    }
    else if (!strncmp(argv[0], "--opt-level=", 12)) {
        if (argv[0][12] == '\0')
            return print_help();
        option.opt_level = (uint32)atoi(argv[0] + 12);
        if (option.opt_level > 3)
            option.opt_level = 3;
    }
    else if (!strncmp(argv[0], "--size-level=", 13)) {
        if (argv[0][13] == '\0')
            return print_help();
        option.size_level = (uint32)atoi(argv[0] + 13);
        if (option.size_level > 3)
            option.size_level = 3;
    }
    else if (!strcmp(argv[0], "-sgx")) {
        sgx_mode = true;
    }
    else if (!strncmp(argv[0], "--bounds-checks=", 16)) {
        option.bounds_checks = (atoi(argv[0] + 16) == 1) ? 1 : 0;
    }
    else if (!strncmp(argv[0], "--format=", 9)) {
        if (argv[0][9] == '\0')
            return print_help();
        if (!strcmp(argv[0] + 9, "aot"))
          option.output_format = AOT_FORMAT_FILE;
        else if (!strcmp(argv[0] + 9, "object"))
          option.output_format = AOT_OBJECT_FILE;
        else if (!strcmp(argv[0] + 9, "llvmir-unopt"))
          option.output_format = AOT_LLVMIR_UNOPT_FILE;
        else if (!strcmp(argv[0] + 9, "llvmir-opt"))
          option.output_format = AOT_LLVMIR_OPT_FILE;
        else {
            printf("Invalid format %s.\n", argv[0] + 9);
            return print_help();
        }
    }
    else if (!strncmp(argv[0], "-v=", 3)) {
        log_verbose_level = atoi(argv[0] + 3);
        if (log_verbose_level < 0 || log_verbose_level > 5)
            return print_help();
    }
    else if (!strcmp(argv[0], "--enable-bulk-memory")) {
        option.enable_bulk_memory = true;
    }
    else if (!strcmp(argv[0], "--enable-multi-thread")) {
        option.enable_bulk_memory = true;
        option.enable_thread_mgr = true;
    }
    else
      return print_help();
  }

  if (argc == 0)
    return print_help();

  if (sgx_mode) {
      option.size_level = 1;
      option.is_sgx_platform = true;
  }

  wasm_file_name = argv[0];

  memset(&init_args, 0, sizeof(RuntimeInitArgs));

  init_args.mem_alloc_type = Alloc_With_Allocator;
  init_args.mem_alloc_option.allocator.malloc_func = malloc;
  init_args.mem_alloc_option.allocator.realloc_func = realloc;
  init_args.mem_alloc_option.allocator.free_func = free;

  /* initialize runtime environment */
  if (!wasm_runtime_full_init(&init_args)) {
    printf("Init runtime environment failed.\n");
    return -1;
  }

  bh_log_set_verbose_level(log_verbose_level);

  bh_print_time("Begin to load wasm file");

  /* load WASM byte buffer from WASM bin file */
  if (!(wasm_file = (uint8*)
        bh_read_file_to_buffer(wasm_file_name, &wasm_file_size)))
    goto fail1;

  /* load WASM module */
  if (!(wasm_module = wasm_runtime_load(wasm_file, wasm_file_size,
                                        error_buf, sizeof(error_buf)))) {
    printf("%s\n", error_buf);
    goto fail2;
  }

  if (!(comp_data = aot_create_comp_data(wasm_module))) {
    printf("%s\n", aot_get_last_error());
    goto fail3;
  }

  bh_print_time("Begin to create compile context");

  if (!(comp_ctx = aot_create_comp_context(comp_data,
                                           &option))) {
    printf("%s\n", aot_get_last_error());
    goto fail4;
  }

  bh_print_time("Begin to compile");

  if (!aot_compile_wasm(comp_ctx)) {
    printf("%s\n", aot_get_last_error());
    goto fail5;
  }

  switch (option.output_format) {
      case AOT_LLVMIR_UNOPT_FILE:
      case AOT_LLVMIR_OPT_FILE:
          if (!aot_emit_llvm_file(comp_ctx, out_file_name)) {
              printf("%s\n", aot_get_last_error());
              goto fail5;
          }
          break;
      case AOT_OBJECT_FILE:
          if (!aot_emit_object_file(comp_ctx, out_file_name)) {
              printf("%s\n", aot_get_last_error());
              goto fail5;
          }
          break;
      case AOT_FORMAT_FILE:
          if (!aot_emit_aot_file(comp_ctx, comp_data, out_file_name)) {
              printf("%s\n", aot_get_last_error());
              goto fail5;
          }
          break;
      default:
          break;
  }

  bh_print_time("Compile end");

  printf("Compile success, file %s was generated.\n", out_file_name);

fail5:
  /* Destroy compiler context */
  aot_destroy_comp_context(comp_ctx);

fail4:
  /* Destroy compile data */
  aot_destroy_comp_data(comp_data);

fail3:
  /* Unload WASM module */
  wasm_runtime_unload(wasm_module);

fail2:
  /* free the file buffer */
  wasm_runtime_free(wasm_file);

fail1:
  /* Destroy runtime environment */
  wasm_runtime_destroy();

  bh_print_time("wamrc return");
  return 0;
}