jit_code.cc

/* Copyright (c) 2018 PaddlePaddle Authors. All Rights Reserved.

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. */

#include "paddle/fluid/operators/math/jit_code.h"
#include "paddle/fluid/operators/math/jit_kernel.h"
#include "paddle/fluid/platform/cpu_info.h"

namespace paddle {
namespace operators {
namespace math {
namespace jitkernel {
namespace gen {

using namespace platform::jit;  // NOLINT

bool VXXJitCode::init(int d, int scalar_index) {
  // It's not necessary to use avx512 since it would slow down the frequency
  // and this kernel is not compute bound.
  return MayIUse(avx) && scalar_index >= 0 && scalar_index <= 2;
}

void VXXJitCode::generate() {
  // do not need push stack, and do not need save avx512reg if do not use avx512
  int offset = 0;
  if (with_relu_) {
    vxorps(ymm_zero, ymm_zero, ymm_zero);
  }
  if (scalar_index_ == 1) {
    vbroadcastss(ymm_src1, ptr[param1]);
  } else if (scalar_index_ == 2) {
    vbroadcastss(ymm_src2, ptr[param2]);
  }
  for (int i = 0; i < num_ / YMM_FLOAT_BLOCK; ++i) {
    if (scalar_index_ != 1) {
      vmovups(ymm_src1, ptr[param1 + offset]);
    }
    if (scalar_index_ != 2) {
      vmovups(ymm_src2, ptr[param2 + offset]);
    }
    if (type_ == operand_type::mul) {
      vmulps(ymm_dst, ymm_src1, ymm_src2);
    } else if (type_ == operand_type::add) {
      vaddps(ymm_dst, ymm_src1, ymm_src2);
    }
    if (with_relu_) {
      vmaxps(ymm_dst, ymm_zero, ymm_dst);
    }
    vmovups(ptr[param3 + offset], ymm_dst);
    offset += sizeof(float) * YMM_FLOAT_BLOCK;
  }
  int rest = num_ % YMM_FLOAT_BLOCK;
  int block = XMM_FLOAT_BLOCK;
  while (rest > 0) {
    if (rest >= 4) {
      if (scalar_index_ != 1) {
        vmovups(xmm_src1, ptr[param1 + offset]);
      }
      if (scalar_index_ != 2) {
        vmovups(xmm_src2, ptr[param2 + offset]);
      }
    } else if (rest >= 2) {
      if (scalar_index_ != 1) {
        vmovq(xmm_src1, ptr[param1 + offset]);
      }
      if (scalar_index_ != 2) {
        vmovq(xmm_src2, ptr[param2 + offset]);
      }
    } else {
      if (scalar_index_ != 1) {
        vmovss(xmm_src1, ptr[param1 + offset]);
      }
      if (scalar_index_ != 2) {
        vmovss(xmm_src2, ptr[param2 + offset]);
      }
    }
    switch (type_) {
      case operand_type::mul:
        vmulps(xmm_dst, xmm_src1, xmm_src2);
        break;
      case operand_type::add:
        vaddps(xmm_dst, xmm_src1, xmm_src2);
        break;
      default:
        break;
    }
    if (with_relu_) {
      vmaxps(xmm_dst, xmm_zero, xmm_dst);
    }
    if (rest >= 4) {
      vmovups(ptr[param3 + offset], xmm_dst);
    } else if (rest >= 2) {
      vmovq(ptr[param3 + offset], xmm_dst);
    } else {
      vmovss(ptr[param3 + offset], xmm_dst);
    }
    offset += sizeof(float) * block;
    rest -= block;
    block /= 2;
  }
  ret();
}

#define ALIGN32 __attribute__((aligned(32)))
#define EXP_HIG 88.3762626647949f
#define EXP_LOW -88.3762626647949f
#define CEPHES_LOG2EF 1.44269504088896341
#define CEPHES_EXP_C1 0.693359375
#define CEPHES_EXP_C2 -2.12194440e-4
#define CEPHES_EXP_P0 1.9875691500E-4
#define CEPHES_EXP_P1 1.3981999507E-3
#define CEPHES_EXP_P2 8.3334519073E-3
#define CEPHES_EXP_P3 4.1665795894E-2
#define CEPHES_EXP_P4 1.6666665459E-1
#define CEPHES_EXP_P5 5.0000001201E-1

#define REPEAT_8TIMES(val) val, val, val, val, val, val, val, val

#define OFFSET_EXP_ONE 0 * YMM_FLOAT_BLOCK * sizeof(float)
#define OFFSET_EXP_TWO 1 * YMM_FLOAT_BLOCK * sizeof(float)
#define OFFSET_EXP_0P5 2 * YMM_FLOAT_BLOCK * sizeof(float)
#define OFFSET_EXP_HIG 3 * YMM_FLOAT_BLOCK * sizeof(float)
#define OFFSET_EXP_LOW 4 * YMM_FLOAT_BLOCK * sizeof(float)
#define OFFSET_EXP_LOG2EF 5 * YMM_FLOAT_BLOCK * sizeof(float)
#define OFFSET_EXP_C1 6 * YMM_FLOAT_BLOCK * sizeof(float)
#define OFFSET_EXP_C2 7 * YMM_FLOAT_BLOCK * sizeof(float)
#define OFFSET_EXP_P0 8 * YMM_FLOAT_BLOCK * sizeof(float)
#define OFFSET_EXP_P1 9 * YMM_FLOAT_BLOCK * sizeof(float)
#define OFFSET_EXP_P2 10 * YMM_FLOAT_BLOCK * sizeof(float)
#define OFFSET_EXP_P3 11 * YMM_FLOAT_BLOCK * sizeof(float)
#define OFFSET_EXP_P4 12 * YMM_FLOAT_BLOCK * sizeof(float)
#define OFFSET_EXP_P5 13 * YMM_FLOAT_BLOCK * sizeof(float)
#define OFFSET_EXP_MAX_INPUT 14 * YMM_FLOAT_BLOCK * sizeof(float)
#define OFFSET_SIGMOID_MAX 15 * YMM_FLOAT_BLOCK * sizeof(float)
#define OFFSET_SIGMOID_MIN 16 * YMM_FLOAT_BLOCK * sizeof(float)

static const float exp_float_consts[] ALIGN32 = {
    REPEAT_8TIMES(1.f),
    REPEAT_8TIMES(2.f),
    REPEAT_8TIMES(0.5f),
    REPEAT_8TIMES(EXP_HIG),
    REPEAT_8TIMES(EXP_LOW),
    REPEAT_8TIMES(CEPHES_LOG2EF),
    REPEAT_8TIMES(CEPHES_EXP_C1),
    REPEAT_8TIMES(CEPHES_EXP_C2),
    REPEAT_8TIMES(CEPHES_EXP_P0),
    REPEAT_8TIMES(CEPHES_EXP_P1),
    REPEAT_8TIMES(CEPHES_EXP_P2),
    REPEAT_8TIMES(CEPHES_EXP_P3),
    REPEAT_8TIMES(CEPHES_EXP_P4),
    REPEAT_8TIMES(CEPHES_EXP_P5),
    REPEAT_8TIMES(EXP_MAX_INPUT),
    REPEAT_8TIMES(SIGMOID_THRESHOLD_MAX),
    REPEAT_8TIMES(SIGMOID_THRESHOLD_MIN)};

static const int exp_int_0x7f[] ALIGN32 = {REPEAT_8TIMES(0x7f)};
static int g_tmp_mem[16] ALIGN32 = {0};

bool VActJitCode::init(int d, operand_type type) {
  bool ok = MayIUse(avx);
  if (type == operand_type::relu || type == operand_type::exp) {
    // TODO(TJ): implement avx512, avx_exp is slower than mkl when d >= 256
    return ok;
  } else {
    // TODO(TJ): support more
    return ok && d % 8 == 0;
  }
}

void VActJitCode::exp_ymm(ymm_t& ymm_dst, ymm_t& ymm_src, int fx_idx,
                          int fy_idx, int mask_idx, int tmp_idx) {
  assert(ymm_src.getIdx() != ymm_dst.getIdx());  // TODO(TJ): use enfore
  // check all idx can not equal
  ymm_t ymm_fx = ymm_t(fx_idx);
  ymm_t ymm_fy = ymm_t(fy_idx);
  ymm_t ymm_mask = ymm_t(mask_idx);
  ymm_t ymm_tmp = ymm_t(tmp_idx);
  reg64_t reg_ptr_global = rax;
  push(reg_ptr_global);
  mov(reg_ptr_global, reinterpret_cast<size_t>(exp_float_consts));
  vmovaps(ymm_tmp, ptr[reg_ptr_global + OFFSET_EXP_HIG]);
  vminps(ymm_src, ymm_src, ymm_tmp);
  vmovaps(ymm_tmp, ptr[reg_ptr_global + OFFSET_EXP_LOW]);
  vmaxps(ymm_src, ymm_src, ymm_tmp);
  // express exp(x) as exp(g + n*log(2))
  vmovaps(ymm_tmp, ptr[reg_ptr_global + OFFSET_EXP_LOG2EF]);
  vmulps(ymm_fx, ymm_src, ymm_tmp);
  vmovaps(ymm_tmp, ptr[reg_ptr_global + OFFSET_EXP_0P5]);
  vaddps(ymm_fx, ymm_fx, ymm_tmp);
  vroundps(ymm_fy, ymm_fx, 0x01);
  // if greater, substract 1
  vcmpgtps(ymm_mask, ymm_fy, ymm_fx);
  vmovaps(ymm_tmp, ptr[reg_ptr_global]);
  vandps(ymm_mask, ymm_mask, ymm_tmp);
  vsubps(ymm_fx, ymm_fy, ymm_mask);
  vmovaps(ymm_tmp, ptr[reg_ptr_global + OFFSET_EXP_C1]);
  vmulps(ymm_fy, ymm_fx, ymm_tmp);
  vmovaps(ymm_tmp, ptr[reg_ptr_global + OFFSET_EXP_C2]);
  ymm_t ymm_z = ymm_t(ymm_mask.getIdx());
  vmulps(ymm_z, ymm_fx, ymm_tmp);
  vsubps(ymm_src, ymm_src, ymm_fy);
  vsubps(ymm_src, ymm_src, ymm_z);
  vmulps(ymm_z, ymm_src, ymm_src);
  vmovaps(ymm_tmp, ptr[reg_ptr_global + OFFSET_EXP_P0]);
  vmulps(ymm_dst, ymm_src, ymm_tmp);
  for (size_t i = OFFSET_EXP_P1; i < OFFSET_EXP_P5;
       i += (YMM_FLOAT_BLOCK * sizeof(float))) {
    vmovaps(ymm_tmp, ptr[reg_ptr_global + i]);  // P1~P4
    vaddps(ymm_dst, ymm_dst, ymm_tmp);
    vmulps(ymm_dst, ymm_dst, ymm_src);
  }
  vmovaps(ymm_tmp, ptr[reg_ptr_global + OFFSET_EXP_P5]);
  vaddps(ymm_dst, ymm_dst, ymm_tmp);
  vmulps(ymm_dst, ymm_dst, ymm_z);
  vaddps(ymm_dst, ymm_dst, ymm_src);
  vmovaps(ymm_tmp, ptr[reg_ptr_global]);
  vaddps(ymm_dst, ymm_dst, ymm_tmp);
  // build 2^n
  ymm_t ymm_int = ymm_fx;
  vcvttps2dq(ymm_int, ymm_fx);
  mov(reg_ptr_global, reinterpret_cast<size_t>(exp_int_0x7f));
  vmovdqa(ymm_tmp, ptr[reg_ptr_global]);
  if (MayIUse(avx2)) {
    vpaddd(ymm_int, ymm_int, ymm_tmp);
    vpslld(ymm_int, ymm_int, 23);
  } else if (MayIUse(avx)) {
    xmm_t xtmp1 = xmm_t(ymm_int.getIdx());
    xmm_t xtmp2 = xmm_t(ymm_tmp.getIdx());
    reg64_t reg_ptr_tmp = reg_ptr_global;
    mov(reg_ptr_tmp, reinterpret_cast<size_t>(g_tmp_mem));
    vmovdqa(ptr[reg_ptr_tmp], ymm_int);
    vmovdqa(ptr[reg_ptr_tmp + YMM_FLOAT_BLOCK * sizeof(float)], ymm_tmp);
    vpaddd(xtmp1, xtmp1, xtmp2);
    vpslld(xtmp1, xtmp1, 23);
    vmovdqa(ptr[reg_ptr_tmp], xtmp1);
    // next 128bits
    vmovdqa(xtmp1, ptr[reg_ptr_tmp + 4 /*xmm float block*/ * sizeof(float)]);
    vmovdqa(xtmp2,
            ptr[reg_ptr_tmp +
                (YMM_FLOAT_BLOCK + 4 /*xmm float block*/) * sizeof(float)]);
    vpaddd(xtmp1, xtmp1, xtmp2);
    vpslld(xtmp1, xtmp1, 23);
    vmovdqa(ptr[reg_ptr_tmp + 4 /*xmm float block*/ * sizeof(float)], xtmp1);
    // load out
    vmovdqa(ymm_int, ptr[reg_ptr_tmp]);
  }
  vmulps(ymm_dst, ymm_dst, ymm_int);
  pop(reg_ptr_global);
}

void VActJitCode::exp_xmm(xmm_t& ymm_dst, xmm_t& ymm_src, int fx_idx,
                          int fy_idx, int mask_idx, int tmp_idx) {
  assert(ymm_src.getIdx() != ymm_dst.getIdx());  // TODO(TJ): use enfore
  // check all idx can not equal
  xmm_t ymm_fx = xmm_t(fx_idx);
  xmm_t ymm_fy = xmm_t(fy_idx);
  xmm_t ymm_mask = xmm_t(mask_idx);
  xmm_t ymm_tmp = xmm_t(tmp_idx);
  reg64_t reg_ptr_global = rax;
  push(reg_ptr_global);
  mov(reg_ptr_global, reinterpret_cast<size_t>(exp_float_consts));
  vmovaps(ymm_tmp, ptr[reg_ptr_global + OFFSET_EXP_HIG]);
  vminps(ymm_src, ymm_src, ymm_tmp);
  vmovaps(ymm_tmp, ptr[reg_ptr_global + OFFSET_EXP_LOW]);
  vmaxps(ymm_src, ymm_src, ymm_tmp);
  // express exp(x) as exp(g + n*log(2))
  vmovaps(ymm_tmp, ptr[reg_ptr_global + OFFSET_EXP_LOG2EF]);
  vmulps(ymm_fx, ymm_src, ymm_tmp);
  vmovaps(ymm_tmp, ptr[reg_ptr_global + OFFSET_EXP_0P5]);
  vaddps(ymm_fx, ymm_fx, ymm_tmp);
  vroundps(ymm_fy, ymm_fx, 0x01);
  // if greater, substract 1
  vcmpgtps(ymm_mask, ymm_fy, ymm_fx);
  vmovaps(ymm_tmp, ptr[reg_ptr_global]);
  vandps(ymm_mask, ymm_mask, ymm_tmp);
  vsubps(ymm_fx, ymm_fy, ymm_mask);
  vmovaps(ymm_tmp, ptr[reg_ptr_global + OFFSET_EXP_C1]);
  vmulps(ymm_fy, ymm_fx, ymm_tmp);
  vmovaps(ymm_tmp, ptr[reg_ptr_global + OFFSET_EXP_C2]);
  xmm_t ymm_z = xmm_t(ymm_mask.getIdx());
  vmulps(ymm_z, ymm_fx, ymm_tmp);
  vsubps(ymm_src, ymm_src, ymm_fy);
  vsubps(ymm_src, ymm_src, ymm_z);
  vmulps(ymm_z, ymm_src, ymm_src);
  vmovaps(ymm_tmp, ptr[reg_ptr_global + OFFSET_EXP_P0]);
  vmulps(ymm_dst, ymm_src, ymm_tmp);
  for (size_t i = OFFSET_EXP_P1; i < OFFSET_EXP_P5;
       i += (YMM_FLOAT_BLOCK * sizeof(float))) {
    vmovaps(ymm_tmp, ptr[reg_ptr_global + i]);  // P1~P4
    vaddps(ymm_dst, ymm_dst, ymm_tmp);
    vmulps(ymm_dst, ymm_dst, ymm_src);
  }
  vmovaps(ymm_tmp, ptr[reg_ptr_global + OFFSET_EXP_P5]);
  vaddps(ymm_dst, ymm_dst, ymm_tmp);
  vmulps(ymm_dst, ymm_dst, ymm_z);
  vaddps(ymm_dst, ymm_dst, ymm_src);
  vmovaps(ymm_tmp, ptr[reg_ptr_global]);
  vaddps(ymm_dst, ymm_dst, ymm_tmp);
  // build 2^n
  xmm_t ymm_int = ymm_fx;
  vcvttps2dq(ymm_int, ymm_fx);
  mov(reg_ptr_global, reinterpret_cast<size_t>(exp_int_0x7f));
  vmovdqa(ymm_tmp, ptr[reg_ptr_global]);
  vpaddd(ymm_int, ymm_int, ymm_tmp);
  vpslld(ymm_int, ymm_int, 23);
  vmulps(ymm_dst, ymm_dst, ymm_int);
  pop(reg_ptr_global);
}

void VActJitCode::sigmoid_ymm(ymm_t& ymm_dst, ymm_t& ymm_src, int fx_idx,
                              int fy_idx, int mask_idx, int tmp_idx) {
  // y = 1 / (1 + e^-x)
  ymm_t ymm_tmp = ymm_t(tmp_idx);
  reg64_t reg_ptr_global = rax;
  push(reg_ptr_global);
  mov(reg_ptr_global, reinterpret_cast<size_t>(exp_float_consts));
  vmovaps(ymm_tmp, ptr[reg_ptr_global + OFFSET_SIGMOID_MAX]);
  vminps(ymm_src, ymm_src, ymm_tmp);
  vmovaps(ymm_tmp, ptr[reg_ptr_global + OFFSET_SIGMOID_MIN]);
  vmaxps(ymm_src, ymm_src, ymm_tmp);
  vxorps(ymm_tmp, ymm_tmp, ymm_tmp);
  vsubps(ymm_src, ymm_tmp, ymm_src);
  exp_ymm(ymm_dst, ymm_src, fx_idx, fy_idx, mask_idx, tmp_idx);
  vmovaps(ymm_tmp, ptr[reg_ptr_global + OFFSET_EXP_ONE]);
  vaddps(ymm_dst, ymm_dst, ymm_tmp);
  vdivps(ymm_dst, ymm_tmp, ymm_dst);
  pop(reg_ptr_global);
}

void VActJitCode::tanh_ymm(ymm_t& ymm_dst, ymm_t& ymm_src, int fx_idx,
                           int fy_idx, int mask_idx, int tmp_idx) {
  // y = 2 / (1 + e^(-2x)) - 1
  ymm_t ymm_tmp = ymm_t(tmp_idx);
  ymm_t ymm_zero = ymm_t(mask_idx);
  reg64_t reg_ptr_global = rax;
  push(reg_ptr_global);
  mov(reg_ptr_global, reinterpret_cast<size_t>(exp_float_consts));
  vmovaps(ymm_tmp, ptr[reg_ptr_global + OFFSET_EXP_TWO]);
  vxorps(ymm_zero, ymm_zero, ymm_zero);
  vsubps(ymm_tmp, ymm_zero, ymm_tmp);
  vmulps(ymm_src, ymm_src, ymm_tmp);
  exp_ymm(ymm_dst, ymm_src, fx_idx, fy_idx, mask_idx, tmp_idx);
  vmovaps(ymm_tmp, ptr[reg_ptr_global + OFFSET_EXP_ONE]);
  vaddps(ymm_dst, ymm_dst, ymm_tmp);
  vmovaps(ymm_tmp, ptr[reg_ptr_global + OFFSET_EXP_TWO]);
  vdivps(ymm_dst, ymm_tmp, ymm_dst);
  vmovaps(ymm_tmp, ptr[reg_ptr_global + OFFSET_EXP_ONE]);
  vsubps(ymm_dst, ymm_dst, ymm_tmp);
  pop(reg_ptr_global);
}

void VActJitCode::generate() {
  xmm_t xmm_zero = xmm_t(2);
  ymm_t ymm_zero = ymm_t(2);
  if (type_ == operand_type::relu) {
    vxorps(ymm_zero, ymm_zero, ymm_zero);
  }
  int offset = 0;
  for (int i = 0; i < num_ / YMM_FLOAT_BLOCK; ++i) {
    vmovups(ymm_src, ptr[param1 + offset]);
    switch (type_) {
      case operand_type::relu:
        relu_jmm<ymm_t>(ymm_dst, ymm_src, ymm_zero);
        break;
      case operand_type::exp:
        exp_ymm(ymm_dst, ymm_src, 2, 3, 4, 5);
        break;
      case operand_type::sigmoid:
        sigmoid_ymm(ymm_dst, ymm_src, 2, 3, 4, 5);
        break;
      case operand_type::tanh:
        tanh_ymm(ymm_dst, ymm_src, 2, 3, 4, 5);
        break;
      case operand_type::identity:
        break;
      default:
        break;
    }
    vmovups(ptr[param2 + offset], ymm_dst);
    offset += sizeof(float) * YMM_FLOAT_BLOCK;
  }
  if (type_ != operand_type::relu && type_ != operand_type::exp) {
    // TODO(TJ): remove me
    ret();
    return;
  }
  int rest = num_ % YMM_FLOAT_BLOCK;
  int block = XMM_FLOAT_BLOCK;
  while (rest > 0) {
    if (rest >= 4) {
      vmovups(xmm_src, ptr[param1 + offset]);
    } else if (rest >= 2) {
      vmovq(xmm_src, ptr[param1 + offset]);
    } else {
      vmovss(xmm_src, ptr[param1 + offset]);
    }
    switch (type_) {
      case operand_type::relu:
        relu_jmm<xmm_t>(xmm_dst, xmm_src, xmm_zero);
        break;
      case operand_type::exp:
        exp_xmm(xmm_dst, xmm_src, 2, 3, 4, 5);
        break;
      default:
        break;
    }
    if (rest >= 4) {
      vmovups(ptr[param2 + offset], xmm_dst);
    } else if (rest >= 2) {
      vmovq(ptr[param2 + offset], xmm_dst);
    } else {
      vmovss(ptr[param2 + offset], xmm_dst);
    }
    offset += sizeof(float) * block;
    rest -= block;
    block /= 2;
  }
  ret();
}

}  // namespace gen
}  // namespace jitkernel
}  // namespace math
}  // namespace operators
}  // namespace paddle