# Copyright 2023 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

# This contains the test projects for the decoder.

load("@rules_cc//cc:cc_library.bzl", "cc_library")
load("@rules_cc//cc:cc_test.bzl", "cc_test")
load("//mpact/sim/decoder:mpact_sim_isa.bzl", "mpact_bin_fmt_decoder", "mpact_cc_library", "mpact_cc_test", "mpact_isa_decoder", "mpact_proto_fmt_decoder")

package(
    default_applicable_licenses = ["//:license"],
)

cc_library(
    name = "log_sink",
    testonly = True,
    hdrs = ["log_sink.h"],
    deps = [
        "@abseil-cpp//absl/base:log_severity",
        "@abseil-cpp//absl/log:log_entry",
        "@abseil-cpp//absl/log:log_sink",
        "@abseil-cpp//absl/strings",
    ],
)

mpact_cc_test(
    name = "instruction_set_test",
    size = "small",
    srcs = [
        "instruction_set_test.cc",
    ],
    deps = [
        "//mpact/sim/decoder:isa_parser",
        "@abseil-cpp//absl/memory",
        "@abseil-cpp//absl/strings",
        "@com_google_googletest//:gtest",
        "@com_google_googletest//:gtest_main",
    ],
)

mpact_cc_test(
    name = "bundle_test",
    size = "small",
    srcs = [
        "bundle_test.cc",
    ],
    deps = [
        "//mpact/sim/decoder:isa_parser",
        "@abseil-cpp//absl/memory",
        "@abseil-cpp//absl/strings",
        "@com_google_googletest//:gtest",
        "@com_google_googletest//:gtest_main",
    ],
)

mpact_cc_test(
    name = "slot_test",
    size = "small",
    srcs = [
        "slot_test.cc",
    ],
    deps = [
        "//mpact/sim/decoder:isa_parser",
        "@abseil-cpp//absl/memory",
        "@abseil-cpp//absl/strings",
        "@com_google_googletest//:gtest",
        "@com_google_googletest//:gtest_main",
    ],
)

mpact_cc_test(
    name = "opcode_test",
    size = "small",
    srcs = [
        "opcode_test.cc",
    ],
    deps = [
        "//mpact/sim/decoder:isa_parser",
        "@abseil-cpp//absl/memory",
        "@abseil-cpp//absl/status",
        "@abseil-cpp//absl/status:statusor",
        "@abseil-cpp//absl/strings",
        "@com_google_googletest//:gtest",
        "@com_google_googletest//:gtest_main",
    ],
)

mpact_cc_test(
    name = "resource_test",
    size = "small",
    srcs = [
        "resource_test.cc",
    ],
    deps = [
        "//mpact/sim/decoder:isa_parser",
        "@abseil-cpp//absl/container:btree",
        "@abseil-cpp//absl/status:statusor",
        "@com_google_googletest//:gtest",
        "@com_google_googletest//:gtest_main",
    ],
)

mpact_cc_test(
    name = "template_expression_test",
    size = "small",
    srcs = [
        "template_expression_test.cc",
    ],
    deps = [
        "//mpact/sim/decoder:isa_parser",
        "@abseil-cpp//absl/memory",
        "@abseil-cpp//absl/status",
        "@abseil-cpp//absl/status:statusor",
        "@abseil-cpp//absl/strings",
        "@abseil-cpp//absl/types:variant",
        "@com_google_googletest//:gtest",
        "@com_google_googletest//:gtest_main",
    ],
)

mpact_cc_test(
    name = "instruction_set_visitor_test",
    size = "small",
    srcs = [
        "instruction_set_visitor_test.cc",
    ],
    data = [
        # Local include files.
        "testfiles/bundle_b.isa",
        "testfiles/empty_file.isa",
        "testfiles/example.isa",
        "testfiles/example_with_recursive_include.isa",
        "testfiles/generator.isa",
        "testfiles/recursive_include.isa",
        "testfiles/resource.isa",
        "testfiles/undefined_errors.isa",
        "testfiles/disasm_formats.isa",
        # Project exported include files.
        "//mpact/sim/decoder/test/testfiles/include:bundle_a.isa",
        "//mpact/sim/decoder/test/testfiles/include:empty_include.isa",
    ],
    deps = [
        ":log_sink",
        "//mpact/sim/decoder:isa_parser",
        "@abseil-cpp//absl/flags:flag",
        "@abseil-cpp//absl/log:check",
        "@abseil-cpp//absl/log:log_sink_registry",
        "@abseil-cpp//absl/memory",
        "@abseil-cpp//absl/status",
        "@abseil-cpp//absl/status:statusor",
        "@abseil-cpp//absl/strings",
        "@com_google_googletest//:gtest",
        "@com_google_googletest//:gtest_main",
        "@com_googlesource_code_re2//:re2",
    ],
)

mpact_isa_decoder(
    name = "example_isa",
    srcs = [
        "testfiles/bundle_b.isa",
        "testfiles/example.isa",
    ],
    includes = [
        #":testfiles/bundle_b.isa",
        "//mpact/sim/decoder/test/testfiles/include:bundle_a.isa",
        "//mpact/sim/decoder/test/testfiles/include:empty_include.isa",
    ],
    isa_name = "Example",
    prefix = "example_isa",
)

mpact_isa_decoder(
    name = "combined_isa",
    srcs = [
        "testfiles/bundle_b.isa",
        "testfiles/part1.isa",
    ],
    includes = [
        "//mpact/sim/decoder/test/testfiles/include:bundle_a.isa",
        "//mpact/sim/decoder/test/testfiles/include:empty_include.isa",
    ],
    isa_name = "Example",
    prefix = "combined_isa",
)

mpact_cc_library(
    name = "riscv32i",
    hdrs = ["testfiles/riscv32i.h"],
    deps = [
        "//mpact/sim/generic:instruction",
    ],
)

mpact_isa_decoder(
    name = "derived_isa",
    src = "testfiles/derived.isa",
    includes = [
        ":testfiles/base.isa",
    ],
    isa_name = "RiscV32I",
    deps = ["riscv32i"],
)

# The point of this test is to actually run the generator on the
# testfiles/example.isa grammar file, generate source files, and then compile
# the generated files and link into this test case. Provided that succeeds,
# this test case succeeds. See the :example_isa build rule for build options.
mpact_cc_test(
    name = "example_decoder_test",
    size = "small",
    srcs = [
        "example_decoder_test.cc",
    ],
    deps = [
        ":example_isa",
        "//mpact/sim/generic:arch_state",
        "//mpact/sim/generic:instruction",
        "@abseil-cpp//absl/container:flat_hash_map",
        "@com_google_googletest//:gtest",
        "@com_google_googletest//:gtest_main",
    ],
)

# The point of this test is to actually run the generator on the
# testfiles/part1.isa grammar file, generate source files, and then compile
# the generated files and link into this test case. Provided that succeeds,
# this test case succeeds. See the :example_isa build rule for build options.
mpact_cc_test(
    name = "combined_decoder_test",
    size = "small",
    srcs = [
        "combined_decoder_test.cc",
    ],
    deps = [
        ":combined_isa",
        "//mpact/sim/generic:arch_state",
        "//mpact/sim/generic:instruction",
        "@abseil-cpp//absl/container:flat_hash_map",
        "@com_google_googletest//:gtest",
        "@com_google_googletest//:gtest_main",
    ],
)

mpact_cc_test(
    name = "extract_bits_test",
    size = "small",
    srcs = [
        "extract_bits_test.cc",
    ],
    deps = [
        "@abseil-cpp//absl/numeric:bits",
        "@com_google_googletest//:gtest",
        "@com_google_googletest//:gtest_main",
    ],
)

mpact_cc_test(
    name = "extract_test",
    size = "small",
    srcs = [
        "extract_test.cc",
    ],
    deps = [
        "//mpact/sim/decoder:bin_format_visitor",
        "@abseil-cpp//absl/strings",
        "@com_google_googletest//:gtest",
        "@com_google_googletest//:gtest_main",
    ],
)

mpact_cc_test(
    name = "overlay_test",
    size = "small",
    srcs = [
        "overlay_test.cc",
    ],
    deps = [
        "//mpact/sim/decoder:bin_format_visitor",
        "@abseil-cpp//absl/status",
        "@abseil-cpp//absl/strings",
        "@com_google_googletest//:gtest",
        "@com_google_googletest//:gtest_main",
    ],
)

mpact_cc_test(
    name = "format_test",
    size = "small",
    srcs = [
        "format_test.cc",
    ],
    deps = [
        "//mpact/sim/decoder:bin_format_visitor",
        "//mpact/sim/decoder:decoder_error_listener",
        "@abseil-cpp//absl/container:flat_hash_map",
        "@abseil-cpp//absl/status",
        "@abseil-cpp//absl/strings",
        "@com_google_googletest//:gtest",
        "@com_google_googletest//:gtest_main",
    ],
)

mpact_cc_test(
    name = "bin_encoding_info_test",
    size = "small",
    srcs = [
        "bin_encoding_info_test.cc",
    ],
    deps = [
        "//mpact/sim/decoder:bin_format_visitor",
        "//mpact/sim/decoder:decoder_error_listener",
        "@abseil-cpp//absl/container:btree",
        "@abseil-cpp//absl/log:check",
        "@abseil-cpp//absl/status",
        "@abseil-cpp//absl/status:statusor",
        "@abseil-cpp//absl/strings",
        "@com_google_googletest//:gtest",
        "@com_google_googletest//:gtest_main",
    ],
)

mpact_cc_test(
    name = "instruction_encoding_test",
    size = "small",
    srcs = [
        "instruction_encoding_test.cc",
    ],
    deps = [
        "//mpact/sim/decoder:bin_format_visitor",
        "//mpact/sim/decoder:decoder_error_listener",
        "@abseil-cpp//absl/status",
        "@abseil-cpp//absl/status:statusor",
        "@com_google_googletest//:gtest",
        "@com_google_googletest//:gtest_main",
    ],
)

mpact_cc_test(
    name = "bin_format_visitor_test",
    size = "small",
    srcs = [
        "bin_format_visitor_test.cc",
    ],
    data = [
        # Local include files.
        "testfiles/constraints.bin_fmt",
        "testfiles/empty_file.bin_fmt",
        "testfiles/example_with_recursive_include.bin_fmt",
        "testfiles/format_error.bin_fmt",
        "testfiles/format_error_undef.bin_fmt",
        "testfiles/generator.bin_fmt",
        "testfiles/instruction_group.bin_fmt",
        "testfiles/instruction_group_errors.bin_fmt",
        "testfiles/recursive_include.bin_fmt",
        "testfiles/riscv32_top.bin_fmt",
        "testfiles/riscv32c.bin_fmt",
        "testfiles/riscv32g.bin_fmt",
        "testfiles/syntax_error.bin_fmt",
        "testfiles/vliw.bin_fmt",
    ],
    deps = [
        ":log_sink",
        "//mpact/sim/decoder:bin_format_visitor",
        "@abseil-cpp//absl/flags:flag",
        "@abseil-cpp//absl/log:check",
        "@abseil-cpp//absl/log:log_sink_registry",
        "@abseil-cpp//absl/status",
        "@abseil-cpp//absl/status:statusor",
        "@abseil-cpp//absl/strings",
        "@com_google_googletest//:gtest",
        "@com_google_googletest//:gtest_main",
        "@com_googlesource_code_re2//:re2",
    ],
)

mpact_cc_test(
    name = "proto_format_visitor_test",
    size = "small",
    srcs = [
        "proto_format_visitor_test.cc",
    ],
    data = [
        # Local include files.
        "testfiles/empty_file.proto_fmt",
        "testfiles/riscv32i.proto_fmt",
        "testfiles/riscv32i.proto",
    ],
    deps = [
        ":log_sink",
        "//mpact/sim/decoder:proto_format_visitor",
        "@abseil-cpp//absl/flags:flag",
        "@abseil-cpp//absl/log",
        "@abseil-cpp//absl/log:check",
        "@abseil-cpp//absl/log:log_sink_registry",
        "@abseil-cpp//absl/status",
        "@abseil-cpp//absl/status:statusor",
        "@abseil-cpp//absl/strings",
        "@com_google_googletest//:gtest",
        "@com_google_googletest//:gtest_main",
        "@com_googlesource_code_re2//:re2",
    ],
)

mpact_cc_test(
    name = "proto_constraint_expression_test",
    size = "small",
    srcs = [
        "proto_constraint_expression_test.cc",
    ],
    data = [
        "testfiles/riscv32i.proto",
    ],
    deps = [
        "//mpact/sim/decoder:proto_format_visitor",
        "//mpact/sim/generic:type_helpers",
        "@abseil-cpp//absl/log",
        "@abseil-cpp//absl/log:check",
        "@abseil-cpp//absl/status",
        "@abseil-cpp//absl/status:statusor",
        "@abseil-cpp//absl/strings",
        "@com_google_googletest//:gtest",
        "@com_google_googletest//:gtest_main",
        "@com_google_protobuf//:protobuf",
    ],
)

mpact_proto_fmt_decoder(
    name = "riscv32i_proto_decoder",
    srcs = ["testfiles/riscv32i.proto_fmt"],
    decoder_name = "RiscV32IProto",
    includes = [],
    prefix = "riscv32i_proto",
    proto_files = ["testfiles/riscv32i.proto"],
    deps = [
        ":riscv32i_cc_proto",
        ":riscv32i_isa",
    ],
)

mpact_isa_decoder(
    name = "riscv32i_isa",
    src = "testfiles/riscv32i.isa",
    includes = [],
    isa_name = "RiscV32I",
    deps = [
        ":riscv32i_instructions",
        "@abseil-cpp//absl/functional:bind_front",
    ],
)

cc_library(
    name = "riscv32i_instructions",
    hdrs = [
        "riscv_i_instructions.h",
    ],
    deps = [
        "//mpact/sim/generic:instruction",
    ],
)

proto_library(
    name = "riscv32i_proto",
    srcs = ["testfiles/riscv32i.proto"],
)

cc_proto_library(
    name = "riscv32i_cc_proto",
    deps = [":riscv32i_proto"],
)

cc_test(
    name = "proto_constraint_value_set_test",
    size = "small",
    srcs = [
        "proto_constraint_value_set_test.cc",
    ],
    deps = [
        "//mpact/sim/decoder:proto_format_visitor",
        "@abseil-cpp//absl/log:check",
        "@com_google_googletest//:gtest",
        "@com_google_googletest//:gtest_main",
    ],
)

cc_library(
    name = "push_pop_instructions",
    srcs = [
        "push_pop.cc",
    ],
    hdrs = [
        "push_pop.h",
    ],
    deps = [
        "//mpact/sim/generic:instruction",
    ],
)

cc_library(
    name = "push_pop_decoder",
    srcs = [
        "push_pop_decoder.cc",
        "push_pop_encoding.cc",
    ],
    hdrs = [
        "push_pop_decoder.h",
        "push_pop_encoding.h",
    ],
    deps = [
        ":push_pop_bin_fmt",
        ":push_pop_isa",
        "//mpact/sim/generic:arch_state",
        "//mpact/sim/generic:core",
        "//mpact/sim/generic:instruction",
        "//mpact/sim/generic:type_helpers",
        "//mpact/sim/util/memory",
        "@abseil-cpp//absl/container:flat_hash_map",
        "@abseil-cpp//absl/functional:any_invocable",
        "@abseil-cpp//absl/log",
    ],
)

mpact_isa_decoder(
    name = "push_pop_isa",
    src = "push_pop.isa",
    includes = [],
    isa_name = "PushPopInst",
    prefix = "push_pop_inst",
    deps = [
        ":push_pop_instructions",
        "@abseil-cpp//absl/functional:bind_front",
    ],
)

mpact_bin_fmt_decoder(
    name = "push_pop_bin_fmt",
    src = "push_pop.bin_fmt",
    decoder_name = "PushPopInst",
    includes = [],
    prefix = "push_pop_inst",
    deps = [
        ":push_pop_isa",
    ],
)

mpact_cc_test(
    name = "array_operand_test",
    size = "small",
    srcs = [
        "array_operand_test.cc",
    ],
    deps = [
        ":push_pop_decoder",
        ":push_pop_isa",
        "//mpact/sim/generic:arch_state",
        "//mpact/sim/generic:core",
        "//mpact/sim/util/memory",
        "@abseil-cpp//absl/log:check",
        "@abseil-cpp//absl/strings",
        "@com_google_googletest//:gtest",
        "@com_google_googletest//:gtest_main",
    ],
)