# Copyright (c) 2021-2022 Huawei Device Co., Ltd.
# 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
#
# http://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.

definitions: []
tests:
  - file-name: "div2"
    isa:
      title: Two address integer division and modulo on accumulator
      description: >
        Perform integer division or modulo on accumulator and register and store result into accumulator
      exceptions:
        - x_arith
    commands:
      - file-name: "op_vs_8_zero"
        isa:
          instructions:
            - sig: div2 v:in:i32
              acc: inout:i32
              format: [op_v_8]
        tags: ['irtoc_ignore']
        code-template: |
          #
              ldai 0
              movi v0, %s
              div2 v0
              movi v0, 0
              jne v0, set_failure
              ldai 0
              jmp fall_through
          set_failure:
              ldai 1
          fall_through:
        description: Check div2 with zero and various values.
        cases:
          - values:
              - "0"
            runner-options: ['run-failure']
            description: Division by zero causes to exception.
          - values:
              - "1"
          - values:
              - "-1"
          - values:
              - "0x7FFFFFFF"
          - values:
              - "0x80000000"
          - values:
              - "-0x7FFFFFFF"
          - values:
              - "-0x80000000"
          - values:
              - "0xFFFFFFFF"
          - values:
              - "-0xFFFFFFFF"

      - file-name: "op_vs_8_pone"
        isa:
          instructions:
            - sig: div2 v:in:i32
              acc: inout:i32
              format: [op_v_8]
        tags: ['irtoc_ignore']
        code-template: |
          #
              ldai 1
              movi v0, %s
              div2 v0
              movi v0, %s
              jne v0, set_failure
              ldai 0
              jmp fall_through
          set_failure:
              ldai 1
          fall_through:
        description: Check div2 with +1 and various values.
        cases:
          - values:
              - "0"
              - "0x0"
            runner-options: ['run-failure']
            description: Division by zero causes to exception.
          - values:
              - "1"
              - "0x1"
          - values:
              - "-1"
              - "0xFFFFFFFF"
          - values:
              - "0x7FFFFFFF"
              - "0x0"
          - values:
              - "0x80000000"
              - "0x0"
          - values:
              - "-0x7FFFFFFF"
              - "0x0"
          - values:
              - "-0x80000000"
              - "0x0"
          - values:
              - "0xFFFFFFFF"
              - "0xFFFFFFFF"
          - values:
              - "-0xFFFFFFFF"
              - "0x1"

      - file-name: "op_vs_8_none"
        isa:
          instructions:
            - sig: div2 v:in:i32
              acc: inout:i32
              format: [op_v_8]
        tags: ['irtoc_ignore']
        code-template: |
          #
              ldai -1
              movi v0, %s
              div2 v0
              movi v0, %s
              jne v0, set_failure
              ldai 0
              jmp fall_through
          set_failure:
              ldai 1
          fall_through:
        description: Check div2 with -1 and various values.
        cases:
          - values:
              - "0"
              - "0x0"
            runner-options: ['run-failure']
            description: Division by zero causes to exception.
          - values:
              - "1"
              - "0xFFFFFFFF"
          - values:
              - "-1"
              - "0x1"
          - values:
              - "0x7FFFFFFF"
              - "0x0"
          - values:
              - "0x80000000"
              - "0x0"
          - values:
              - "-0x7FFFFFFF"
              - "0x0"
          - values:
              - "-0x80000000"
              - "0x0"
          - values:
              - "0xFFFFFFFF"
              - "0x1"
          - values:
              - "-0xFFFFFFFF"
              - "0xFFFFFFFF"

      - file-name: "op_vs_8_pmax"
        isa:
          instructions:
            - sig: div2 v:in:i32
              acc: inout:i32
              format: [op_v_8]
        tags: ['irtoc_ignore']
        code-template: |
          #
              ldai 0x7FFFFFFF
              movi v0, %s
              div2 v0
              movi v0, %s
              jne v0, set_failure
              ldai 0
              jmp fall_through
          set_failure:
              ldai 1
          fall_through:
        description: Check div2 with +max and various values.
        cases:
          - values:
              - "0"
              - "0x0"
            runner-options: ['run-failure']
            description: Division by zero causes to exception.
          - values:
              - "1"
              - "0x7FFFFFFF"
          - values:
              - "-1"
              - "0x80000001"
          - values:
              - "0x7FFFFFFF"
              - "0x1"
          - values:
              - "0x80000000"
              - "0x0"
          - values:
              - "-0x7FFFFFFF"
              - "0xFFFFFFFF"
          - values:
              - "-0x80000000"
              - "0x0"
          - values:
              - "0xFFFFFFFF"
              - "0x80000001"
          - values:
              - "-0xFFFFFFFF"
              - "0x7FFFFFFF"

      - file-name: "op_vs_8_nmax"
        isa:
          instructions:
            - sig: div2 v:in:i32
              acc: inout:i32
              format: [op_v_8]
        tags: ['irtoc_ignore']
        code-template: |
          #
              ldai -0x80000000
              movi v0, %s
              div2 v0
              movi v0, %s
              jne v0, set_failure
              ldai 0
              jmp fall_through
          set_failure:
              ldai 1
          fall_through:
        description: Check div2 with -max and various values.
        cases:
          - values:
              - "0"
              - "0x0"
            runner-options: ['run-failure']
            description: Division by zero causes to exception.
          - values:
              - "1"
              - "0x80000000"
          - values:
              - "-1"
              - "0x80000000"
          - values:
              - "0x7FFFFFFF"
              - "0xFFFFFFFF"
          - values:
              - "0x80000000"
              - "0x1"
          - values:
              - "-0x7FFFFFFF"
              - "0x1"
          - values:
              - "-0x80000000"
              - "0x1"
          - values:
              - "0xFFFFFFFF"
              - "0x80000000"
          - values:
              - "-0xFFFFFFFF"
              - "0x80000000"

      - file-name: "vals"
        isa:
          instructions:
            - sig: div2 v:in:i32
              acc: inout:i32
              format: [op_v_8]
        code-template: |
          #
              ldai %s
              movi v0, %s
              div2 v0
              movi v0, %s
              jne v0, set_failure
              ldai 0
              jmp fall_through
          set_failure:
              ldai 1
          fall_through:
        description: Check div2 with various values.
        tags: ['tsan']
        cases:
          - values:
              - "0x5A2A7A20"
              - "0x92C42"
              - "0x9D4"
          - values:
              - "0x723F999F"
              - "0x6C589"
              - "0x10DF"
          - values:
              - "0x5B39A21C"
              - "0xDFD2A"
              - "0x685"
          - values:
              - "0xEC29B76A"
              - "0x6126B"
              - "0xFFFFFCBC"
          - values:
              - "0x9617582D"
              - "0x2BD45"
              - "0xFFFFD957"
          - values:
              - "0x9B35145B"
              - "0x9014F"
              - "0xFFFFF4CF"
          - values:
              - "0xA9D5C5AB"
              - "0xA2323"
              - "0xFFFFF781"
          - values:
              - "0xD90A7511"
              - "0x64F85"
              - "0xFFFFF9D4"
          - values:
              - "0x97C40EB3"
              - "0x7670F"
              - "0xFFFFF1EC"
          - values:
              - "0x3D0C14FE"
              - "0x89837"
              - "0x71A"
          - values: ["0x80000000", "-1", "0x80000000"]
          - values: ["-2147483648", "-1", "-2147483648"]


      - file-name: "op_v_8_exception"
        isa:
          instructions:
            - sig: div2 v:in:i32
              acc: inout:i32
              format: [op_v_8]
        tags: ['irtoc_ignore']
        header-template: [ArithmeticException, main]
        code-template: |
            #
                ldai %s
                movi v0, 0
            begin:
                div2 v0
            end:
                ldai 1 # Should not reach this line
                return

            catch_AE:
                ldai 0 # Expected panda.ArithmeticException
                return

            catch_all:
                ldai 1 # Unexpected exception, test failed
                return

            .catch panda.ArithmeticException, begin, end, catch_AE
            .catchall begin, end, catch_all
        check-type: none
        description: Check `div2` throws ArithmeticException when divides by zero.
        cases:
          - values: ["0"]
          - values: ["1"]
          - values: ["0x7FFF"]
          - values: ["0xFFFF"]
          - values: ["0x7FFFFFFF"]
          - values: ["0x80000000"]
          - values: ["0xFFFFFFFF"]
          - values: ["-1"]
          - values: ["-0x7FFF"]
          - values: ["-0xFFFF"]
          - values: ["-0x7FFFFFFF"]
          - values: ["-0x80000000"]
          - values: ["-0xFFFFFFFF"]

      - file-name: "vals_mod32_1"
        bugid: ['1324', '2072']
        tags: ['verifier']
        runner-options: ['verifier-failure', 'verifier-config']
        isa:
          instructions:
            - sig: div2 v:in:i32
              acc: inout:i32
              format: [op_v_8]
        code-template: |
          #
              ldai %s
              movi v0, %s
              div2 v0
              movi.64 v0, %s
              cmp.64 v0
        description: Check div2 with incorrect type of accumulator and register.
        cases:
          - values:
              - "0xFFFFFFFF"
              - "1"
              - "0xFFFFFFFFFFFFFFFF"
          - values:
              - "0x7FFFFFFF"
              - "-1"
              - "0xFFFFFFFF80000001"
          - values:
              - "0x80000000"
              - "-1"
              - "0xFFFFFFFF80000000"

      - file-name: "vals_mod32_2"
        bugid: ['1324']
        tags: ['verifier']
        runner-options: ['verifier-failure', 'verifier-config']
        isa:
          instructions:
            - sig: div2 v:in:i32
              acc: inout:i32
              format: [op_v_8]
        code-template: |
          #
              ldai.64 %s
              movi.64 v0, %s
              div2 v0
              movi.64 v0, %s
              cmp.64 v0
        description: Check div2 with incorrect type of accumulator and register.
        cases:
          - values:
              - "0x1FFFFFFFF"
              - "0xFFFFFFFF"
              - "1"
          - values:
              - "0x777777777FFFFFFF"
              - "0x11111111FFFFFFFF"
              - "0xFFFFFFFF80000001"
          - values:
              - "0x180000000"
              - "0x100000001"
              - "0xFFFFFFFF80000000"

      - file-name: "regs"
        isa:
          instructions:
            - sig: div2 v:in:i32
              acc: inout:i32
              format: [op_v_8]
        runner-options: ['compile-only']
        code-template: |
          #
              div2 %s
        check-type: none
        description: Check div2 with various register numbers.
        cases:
          - values:
              - "v255"
          - values:
              - "v256"
            runner-options: ['compile-failure']

      - file-name: "type"
        tags: ["verifier"]
        isa:
          verification:
            - acc_type
            - v1_type
        runner-options: ['verifier-failure', 'verifier-config']
        header-template: []
        code-template: |
          .record T {}
          .function i32 main() {
              %s
              *s
              div2 v0
        check-type: exit-positive
        description: Check 'div2' with incorrect accumulator and/or register types.
        cases:
          - values:
            - ldai 0
            id: acc_ok
          - values:
            - ldai.64 0
          - values:
            - fldai 0
          - values:
            - fldai.64 0
          - values:
            - lda.null
          - values:
            - |
              #
                  movi v1, 0
                  newarr v1, v1, i32[]
                  lda.obj v1
          - values:
            - lda.str "0"
          - values:
            - lda.type T
          - values:
            - |
              #
                  newobj v1, T
                  lda.obj v1
        template-cases:
          - values:
            - movi v0, 1
            exclude: [acc_ok]
          - values:
            - movi.64 v0, 1
          - values:
            - fmovi v0, 1
          - values:
            - fmovi.64 v0, 1
          - values:
            - mov.null v0
          - values:
            - |
              #
                  movi v0, 0
                  newarr v0, v0, i32[]
          - values:
            - |
              #
                  lda.str "0"
                  sta.obj v0
          - values:
            - |
              #
                  lda.type T
                  sta.obj v0
          - values:
            - newobj v0, T


      - file-name: uninitialized_regs
        isa:
          instructions:
            - sig: div2 v:in:i32
              acc: inout:i32
              format: [op_v_8]
        description: Check 'div2' with uninitialized registers.
        tags: ['verifier']
        runner-options: ['verifier-failure', 'verifier-config']
        code-template: |
          #
              %s
              *s
              div2 *s
        check-type: exit-positive
        template-cases:
          - values:
              - ''
          - values:
              - ldai 0
            exclude: [init]
        cases:
          - values:
              - ''
              - v0
          - values:
              - movi v1, 0
              - v1
            id: init
          - values:
              - ''
              - v8
          - values:
              - ''
              - v15
          - values:
              - movi v15, 0
              - v15
            id: init