/////////////////////////////////////////////////////////////////////////
// $Id: aes.cc,v 1.1 2008/05/30 20:37:52 sshwarts Exp $
/////////////////////////////////////////////////////////////////////////
//
//   Copyright (c) 2008 Stanislav Shwartsman
//          Written by Stanislav Shwartsman [sshwarts at sourceforge net]
//
//  This library is free software; you can redistribute it and/or
//  modify it under the terms of the GNU Lesser General Public
//  License as published by the Free Software Foundation; either
//  version 2 of the License, or (at your option) any later version.
//
//  This library is distributed in the hope that it will be useful,
//  but WITHOUT ANY WARRANTY; without even the implied warranty of
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
//  Lesser General Public License for more details.
//
//  You should have received a copy of the GNU Lesser General Public
//  License along with this library; if not, write to the Free Software
//  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
//
/////////////////////////////////////////////////////////////////////////

#define NEED_CPU_REG_SHORTCUTS 1
#include "bochs.h"
#include "cpu.h"
#define LOG_THIS BX_CPU_THIS_PTR

#if BX_SUPPORT_AES

//
// XMM - Byte Representation of a 128-bit AES State
//
//      F E D C B A
//      1 1 1 1 1 1
//      5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0
//     --+-+-+-+-+-+-+-+-+-+-+-+-+-+-+--
//      P O N M L K J I H G F E D C B A
//
//
// XMM - Matrix Representation of a 128-bit AES State
//
// | A E I M |   | S(0,0) S(0,1) S(0,2) S(0,3) |   | S(0) S(4) S(8) S(C) |
// | B F J N | = | S(1,0) S(1,1) S(1,2) S(1,3) | = | S(1) S(5) S(9) S(D) |
// | C G K O |   | S(2,0) S(2,1) S(2,2) S(2,3) |   | S(2) S(6) S(A) S(E) |
// | D H L P |   | S(3,0) S(3,1) S(2,3) S(3,3) |   | S(3) S(7) S(B) S(F) |
//

//
// AES ShiftRows transformation
//
// | A E I M |    | A E I M |
// | B F J N | => | F J N B | 
// | C G K O |    | K O C G |
// | D H L P |    | P D H L |
//

BX_CPP_INLINE void AES_ShiftRows(BxPackedXmmRegister &state)
{
  BxPackedXmmRegister tmp = state;

  state.xmmubyte(0x0) = tmp.xmmubyte(0x0); // A => A
  state.xmmubyte(0x1) = tmp.xmmubyte(0x5);
  state.xmmubyte(0x2) = tmp.xmmubyte(0xA);
  state.xmmubyte(0x3) = tmp.xmmubyte(0xF);
  state.xmmubyte(0x4) = tmp.xmmubyte(0x4); // E => E
  state.xmmubyte(0x5) = tmp.xmmubyte(0x9);
  state.xmmubyte(0x6) = tmp.xmmubyte(0xE);
  state.xmmubyte(0x7) = tmp.xmmubyte(0x3);
  state.xmmubyte(0x8) = tmp.xmmubyte(0x8); // I => I
  state.xmmubyte(0x9) = tmp.xmmubyte(0xD);
  state.xmmubyte(0xA) = tmp.xmmubyte(0x2);
  state.xmmubyte(0xB) = tmp.xmmubyte(0x7);
  state.xmmubyte(0xC) = tmp.xmmubyte(0xC); // M => M
  state.xmmubyte(0xD) = tmp.xmmubyte(0x1);
  state.xmmubyte(0xE) = tmp.xmmubyte(0x6);
  state.xmmubyte(0xF) = tmp.xmmubyte(0xB);
}

//
// AES InverseShiftRows transformation
//
// | A E I M |    | A E I M |
// | B F J N | => | N B F J | 
// | C G K O |    | K O C G |
// | D H L P |    | H L P D |
//

BX_CPP_INLINE void AES_InverseShiftRows(BxPackedXmmRegister &state)
{
  BxPackedXmmRegister tmp = state;

  state.xmmubyte(0x0) = tmp.xmmubyte(0x0); // A => A
  state.xmmubyte(0x1) = tmp.xmmubyte(0xD);
  state.xmmubyte(0x2) = tmp.xmmubyte(0xA);
  state.xmmubyte(0x3) = tmp.xmmubyte(0x7);
  state.xmmubyte(0x4) = tmp.xmmubyte(0x4); // E => E
  state.xmmubyte(0x5) = tmp.xmmubyte(0x1);
  state.xmmubyte(0x6) = tmp.xmmubyte(0xE);
  state.xmmubyte(0x7) = tmp.xmmubyte(0xB);
  state.xmmubyte(0x8) = tmp.xmmubyte(0x8); // I => I
  state.xmmubyte(0x9) = tmp.xmmubyte(0x5);
  state.xmmubyte(0xA) = tmp.xmmubyte(0x2);
  state.xmmubyte(0xB) = tmp.xmmubyte(0xF);
  state.xmmubyte(0xC) = tmp.xmmubyte(0xC); // M => M
  state.xmmubyte(0xD) = tmp.xmmubyte(0x9);
  state.xmmubyte(0xE) = tmp.xmmubyte(0x6);
  state.xmmubyte(0xF) = tmp.xmmubyte(0x3);
}

static Bit8u sbox_transformation[256] = {
  0x63, 0x7c, 0x77, 0x7b, 0xf2, 0x6b, 0x6f, 0xc5,
  0x30, 0x01, 0x67, 0x2b, 0xfe, 0xd7, 0xab, 0x76,
  0xca, 0x82, 0xc9, 0x7d, 0xfa, 0x59, 0x47, 0xf0,
  0xad, 0xd4, 0xa2, 0xaf, 0x9c, 0xa4, 0x72, 0xc0,
  0xb7, 0xfd, 0x93, 0x26, 0x36, 0x3f, 0xf7, 0xcc,
  0x34, 0xa5, 0xe5, 0xf1, 0x71, 0xd8, 0x31, 0x15,
  0x04, 0xc7, 0x23, 0xc3, 0x18, 0x96, 0x05, 0x9a,
  0x07, 0x12, 0x80, 0xe2, 0xeb, 0x27, 0xb2, 0x75,
  0x09, 0x83, 0x2c, 0x1a, 0x1b, 0x6e, 0x5a, 0xa0,
  0x52, 0x3b, 0xd6, 0xb3, 0x29, 0xe3, 0x2f, 0x84,
  0x53, 0xd1, 0x00, 0xed, 0x20, 0xfc, 0xb1, 0x5b,
  0x6a, 0xcb, 0xbe, 0x39, 0x4a, 0x4c, 0x58, 0xcf,
  0xd0, 0xef, 0xaa, 0xfb, 0x43, 0x4d, 0x33, 0x85,
  0x45, 0xf9, 0x02, 0x7f, 0x50, 0x3c, 0x9f, 0xa8,
  0x51, 0xa3, 0x40, 0x8f, 0x92, 0x9d, 0x38, 0xf5,
  0xbc, 0xb6, 0xda, 0x21, 0x10, 0xff, 0xf3, 0xd2,
  0xcd, 0x0c, 0x13, 0xec, 0x5f, 0x97, 0x44, 0x17,
  0xc4, 0xa7, 0x7e, 0x3d, 0x64, 0x5d, 0x19, 0x73,
  0x60, 0x81, 0x4f, 0xdc, 0x22, 0x2a, 0x90, 0x88,
  0x46, 0xee, 0xb8, 0x14, 0xde, 0x5e, 0x0b, 0xdb,
  0xe0, 0x32, 0x3a, 0x0a, 0x49, 0x06, 0x24, 0x5c,
  0xc2, 0xd3, 0xac, 0x62, 0x91, 0x95, 0xe4, 0x79,
  0xe7, 0xc8, 0x37, 0x6d, 0x8d, 0xd5, 0x4e, 0xa9,
  0x6c, 0x56, 0xf4, 0xea, 0x65, 0x7a, 0xae, 0x08,
  0xba, 0x78, 0x25, 0x2e, 0x1c, 0xa6, 0xb4, 0xc6,
  0xe8, 0xdd, 0x74, 0x1f, 0x4b, 0xbd, 0x8b, 0x8a,
  0x70, 0x3e, 0xb5, 0x66, 0x48, 0x03, 0xf6, 0x0e,
  0x61, 0x35, 0x57, 0xb9, 0x86, 0xc1, 0x1d, 0x9e,
  0xe1, 0xf8, 0x98, 0x11, 0x69, 0xd9, 0x8e, 0x94,
  0x9b, 0x1e, 0x87, 0xe9, 0xce, 0x55, 0x28, 0xdf,
  0x8c, 0xa1, 0x89, 0x0d, 0xbf, 0xe6, 0x42, 0x68,
  0x41, 0x99, 0x2d, 0x0f, 0xb0, 0x54, 0xbb, 0x16
};

static Bit8u inverse_sbox_transformation[256] = {
  0x52, 0x09, 0x6a, 0xd5, 0x30, 0x36, 0xa5, 0x38,
  0xbf, 0x40, 0xa3, 0x9e, 0x81, 0xf3, 0xd7, 0xfb,
  0x7c, 0xe3, 0x39, 0x82, 0x9b, 0x2f, 0xff, 0x87,
  0x34, 0x8e, 0x43, 0x44, 0xc4, 0xde, 0xe9, 0xcb,
  0x54, 0x7b, 0x94, 0x32, 0xa6, 0xc2, 0x23, 0x3d,
  0xee, 0x4c, 0x95, 0x0b, 0x42, 0xfa, 0xc3, 0x4e,
  0x08, 0x2e, 0xa1, 0x66, 0x28, 0xd9, 0x24, 0xb2,
  0x76, 0x5b, 0xa2, 0x49, 0x6d, 0x8b, 0xd1, 0x25,
  0x72, 0xf8, 0xf6, 0x64, 0x86, 0x68, 0x98, 0x16,
  0xd4, 0xa4, 0x5c, 0xcc, 0x5d, 0x65, 0xb6, 0x92,
  0x6c, 0x70, 0x48, 0x50, 0xfd, 0xed, 0xb9, 0xda,
  0x5e, 0x15, 0x46, 0x57, 0xa7, 0x8d, 0x9d, 0x84,
  0x90, 0xd8, 0xab, 0x00, 0x8c, 0xbc, 0xd3, 0x0a,
  0xf7, 0xe4, 0x58, 0x05, 0xb8, 0xb3, 0x45, 0x06,
  0xd0, 0x2c, 0x1e, 0x8f, 0xca, 0x3f, 0x0f, 0x02,
  0xc1, 0xaf, 0xbd, 0x03, 0x01, 0x13, 0x8a, 0x6b,
  0x3a, 0x91, 0x11, 0x41, 0x4f, 0x67, 0xdc, 0xea,
  0x97, 0xf2, 0xcf, 0xce, 0xf0, 0xb4, 0xe6, 0x73,
  0x96, 0xac, 0x74, 0x22, 0xe7, 0xad, 0x35, 0x85,
  0xe2, 0xf9, 0x37, 0xe8, 0x1c, 0x75, 0xdf, 0x6e,
  0x47, 0xf1, 0x1a, 0x71, 0x1d, 0x29, 0xc5, 0x89,
  0x6f, 0xb7, 0x62, 0x0e, 0xaa, 0x18, 0xbe, 0x1b,
  0xfc, 0x56, 0x3e, 0x4b, 0xc6, 0xd2, 0x79, 0x20,
  0x9a, 0xdb, 0xc0, 0xfe, 0x78, 0xcd, 0x5a, 0xf4,
  0x1f, 0xdd, 0xa8, 0x33, 0x88, 0x07, 0xc7, 0x31,
  0xb1, 0x12, 0x10, 0x59, 0x27, 0x80, 0xec, 0x5f,
  0x60, 0x51, 0x7f, 0xa9, 0x19, 0xb5, 0x4a, 0x0d,
  0x2d, 0xe5, 0x7a, 0x9f, 0x93, 0xc9, 0x9c, 0xef,
  0xa0, 0xe0, 0x3b, 0x4d, 0xae, 0x2a, 0xf5, 0xb0,
  0xc8, 0xeb, 0xbb, 0x3c, 0x83, 0x53, 0x99, 0x61,
  0x17, 0x2b, 0x04, 0x7e, 0xba, 0x77, 0xd6, 0x26,
  0xe1, 0x69, 0x14, 0x63, 0x55, 0x21, 0x0c, 0x7d
};

BX_CPP_INLINE void AES_SubstituteBytes(BxPackedXmmRegister &state)
{
  for (int i=0; i<16; i++)
    state.xmmubyte(i) = sbox_transformation[state.xmmubyte(i)];
}

BX_CPP_INLINE void AES_InverseSubstituteBytes(BxPackedXmmRegister &state)
{
  for (int i=0; i<16; i++)
    state.xmmubyte(i) = inverse_sbox_transformation[state.xmmubyte(i)];
}

/*
 * Galois Field multiplication of a by b, modulo m.
 * Just like arithmetic multiplication, except that additions and
 * subtractions are replaced by XOR.
 * The code was taken from: http://www.darkside.com.au/ice/index.html
 */

BX_CPP_INLINE unsigned gf_mul(unsigned a, unsigned b)
{
  unsigned res = 0, m = 0x11b;

  while (b) {
    if (b & 1)
      res ^= a;

    a <<= 1;
    b >>= 1;

    if (a >= 256)
      a ^= m;
  }

  return res;
}

#define AES_STATE(s,a,b) (s.xmmubyte((b)*4+(a)))

static void AES_MixColumns(BxPackedXmmRegister &state)
{
  BxPackedXmmRegister tmp = state;
  
  for(int j=0; j<4; j++) {
    AES_STATE(state, 0, j) = gf_mul(0x2, AES_STATE(tmp, 0, j)) ^
                             gf_mul(0x3, AES_STATE(tmp, 1, j)) ^
                             AES_STATE(tmp, 2, j) ^
                             AES_STATE(tmp, 3, j);

    AES_STATE(state, 1, j) = AES_STATE(tmp, 0, j) ^
                             gf_mul(0x2, AES_STATE(tmp, 1, j)) ^
                             gf_mul(0x3, AES_STATE(tmp, 2, j)) ^
                             AES_STATE(tmp, 3, j);

    AES_STATE(state, 2, j) = AES_STATE(tmp, 0, j) ^
                             AES_STATE(tmp, 1, j);
                             gf_mul(0x2, AES_STATE(tmp, 2, j)) ^
                             gf_mul(0x3, AES_STATE(tmp, 3, j));

    AES_STATE(state, 3, j) = gf_mul(0x3, AES_STATE(tmp, 0, j)) ^
                             AES_STATE(tmp, 1, j) ^
                             AES_STATE(tmp, 2, j) ^
                             gf_mul(0x2, AES_STATE(tmp, 3, j));
  }
}

static void AES_InverseMixColumns(BxPackedXmmRegister &state)
{
  BxPackedXmmRegister tmp = state;
  
  for(int j=0; j<4; j++) {
    AES_STATE(state, 0, j) = gf_mul(0xE, AES_STATE(tmp, 0, j)) ^
                             gf_mul(0xB, AES_STATE(tmp, 1, j)) ^
                             gf_mul(0xD, AES_STATE(tmp, 2, j)) ^
                             gf_mul(0x9, AES_STATE(tmp, 3, j));

    AES_STATE(state, 1, j) = gf_mul(0x9, AES_STATE(tmp, 0, j)) ^
                             gf_mul(0xE, AES_STATE(tmp, 1, j)) ^
                             gf_mul(0xB, AES_STATE(tmp, 2, j)) ^
                             gf_mul(0xD, AES_STATE(tmp, 3, j));

    AES_STATE(state, 2, j) = gf_mul(0xD, AES_STATE(tmp, 0, j)) ^
                             gf_mul(0x9, AES_STATE(tmp, 1, j)) ^
                             gf_mul(0xE, AES_STATE(tmp, 2, j)) ^
                             gf_mul(0xB, AES_STATE(tmp, 3, j));

    AES_STATE(state, 3, j) = gf_mul(0xB, AES_STATE(tmp, 0, j)) ^
                             gf_mul(0xD, AES_STATE(tmp, 1, j)) ^
                             gf_mul(0x9, AES_STATE(tmp, 2, j)) ^
                             gf_mul(0xE, AES_STATE(tmp, 3, j));
  }
}

BX_CPP_INLINE Bit32u AES_SubWord(Bit32u x)
{
  Bit8u b0 = sbox_transformation[(x)     & 0xff];
  Bit8u b1 = sbox_transformation[(x>>8)  & 0xff];
  Bit8u b2 = sbox_transformation[(x>>16) & 0xff];
  Bit8u b3 = sbox_transformation[(x>>24) & 0xff];

  return b0 | ((Bit32u)(b1) <<  8) | 
              ((Bit32u)(b2) << 16) | ((Bit32u)(b3) << 24);
}

BX_CPP_INLINE Bit32u AES_RotWord(Bit32u x)
{
  return (x >> 8) | (x << 24);
}

#endif

/* 66 0F 38 DB */
void BX_CPP_AttrRegparmN(1) BX_CPU_C::AESIMC_VdqWdq(bxInstruction_c *i)
{
#if BX_SUPPORT_AES
  BX_CPU_THIS_PTR prepareSSE();

  BxPackedXmmRegister op;

  /* op is a register or memory reference */
  if (i->modC0()) {
    op = BX_READ_XMM_REG(i->rm());
  }
  else {
    BX_CPU_CALL_METHODR(i->ResolveModrm, (i));
    /* pointer, segment address pair */
    readVirtualDQwordAligned(i->seg(), RMAddr(i), (Bit8u *) &op);
  }

  AES_InverseMixColumns(op);

  BX_WRITE_XMM_REG(i->nnn(), op);
#else
  BX_INFO(("AESIMC_VdqWdq: required AES support, use --enable-aes option"));
  UndefinedOpcode(i);
#endif
}

/* 66 0F 38 DC */
void BX_CPP_AttrRegparmN(1) BX_CPU_C::AESENC_VdqWdq(bxInstruction_c *i)
{
#if BX_SUPPORT_AES
  BX_CPU_THIS_PTR prepareSSE();

  BxPackedXmmRegister op1 = BX_READ_XMM_REG(i->nnn()), op2;

  /* op is a register or memory reference */
  if (i->modC0()) {
    op2 = BX_READ_XMM_REG(i->rm());
  }
  else {
    BX_CPU_CALL_METHODR(i->ResolveModrm, (i));
    /* pointer, segment address pair */
    readVirtualDQwordAligned(i->seg(), RMAddr(i), (Bit8u *) &op2);
  }

  AES_ShiftRows(op1);
  AES_SubstituteBytes(op1);
  AES_MixColumns(op1);

  op1.xmm64u(0) ^= op2.xmm64u(0);
  op1.xmm64u(1) ^= op2.xmm64u(1);

  BX_WRITE_XMM_REG(i->nnn(), op1);
#else
  BX_INFO(("AESENC_VdqWdq: required AES support, use --enable-aes option"));
  UndefinedOpcode(i);
#endif
}

/* 66 0F 38 DD */
void BX_CPP_AttrRegparmN(1) BX_CPU_C::AESENCLAST_VdqWdq(bxInstruction_c *i)
{
#if BX_SUPPORT_AES
  BX_CPU_THIS_PTR prepareSSE();

  BxPackedXmmRegister op1 = BX_READ_XMM_REG(i->nnn()), op2;

  /* op is a register or memory reference */
  if (i->modC0()) {
    op2 = BX_READ_XMM_REG(i->rm());
  }
  else {
    BX_CPU_CALL_METHODR(i->ResolveModrm, (i));
    /* pointer, segment address pair */
    readVirtualDQwordAligned(i->seg(), RMAddr(i), (Bit8u *) &op2);
  }

  AES_ShiftRows(op1);
  AES_SubstituteBytes(op1);

  op1.xmm64u(0) ^= op2.xmm64u(0);
  op1.xmm64u(1) ^= op2.xmm64u(1);

  BX_WRITE_XMM_REG(i->nnn(), op1);
#else
  BX_INFO(("AESENCLAST_VdqWdq: required AES support, use --enable-aes option"));
  UndefinedOpcode(i);
#endif
}

/* 66 0F 38 DE */
void BX_CPP_AttrRegparmN(1) BX_CPU_C::AESDEC_VdqWdq(bxInstruction_c *i)
{
#if BX_SUPPORT_AES
  BX_CPU_THIS_PTR prepareSSE();

  BxPackedXmmRegister op1 = BX_READ_XMM_REG(i->nnn()), op2;

  /* op is a register or memory reference */
  if (i->modC0()) {
    op2 = BX_READ_XMM_REG(i->rm());
  }
  else {
    BX_CPU_CALL_METHODR(i->ResolveModrm, (i));
    /* pointer, segment address pair */
    readVirtualDQwordAligned(i->seg(), RMAddr(i), (Bit8u *) &op2);
  }

  AES_InverseShiftRows(op1);
  AES_InverseSubstituteBytes(op1);
  AES_InverseMixColumns(op1);

  op1.xmm64u(0) ^= op2.xmm64u(0);
  op1.xmm64u(1) ^= op2.xmm64u(1);

  BX_WRITE_XMM_REG(i->nnn(), op1);
#else
  BX_INFO(("AESDEC_VdqWdq: required AES support, use --enable-aes option"));
  UndefinedOpcode(i);
#endif
}

/* 66 0F 38 DF */
void BX_CPP_AttrRegparmN(1) BX_CPU_C::AESDECLAST_VdqWdq(bxInstruction_c *i)
{
#if BX_SUPPORT_AES
  BX_CPU_THIS_PTR prepareSSE();

  BxPackedXmmRegister op1 = BX_READ_XMM_REG(i->nnn()), op2;

  /* op is a register or memory reference */
  if (i->modC0()) {
    op2 = BX_READ_XMM_REG(i->rm());
  }
  else {
    BX_CPU_CALL_METHODR(i->ResolveModrm, (i));
    /* pointer, segment address pair */
    readVirtualDQwordAligned(i->seg(), RMAddr(i), (Bit8u *) &op2);
  }

  AES_InverseShiftRows(op1);
  AES_InverseSubstituteBytes(op1);

  op1.xmm64u(0) ^= op2.xmm64u(0);
  op1.xmm64u(1) ^= op2.xmm64u(1);

  BX_WRITE_XMM_REG(i->nnn(), op1);
#else
  BX_INFO(("AESDECLAST_VdqWdq: required AES support, use --enable-aes option"));
  UndefinedOpcode(i);
#endif
}

/* 66 0F 3A DF */
void BX_CPP_AttrRegparmN(1) BX_CPU_C::AESKEYGENASSIST_VdqWdqIb(bxInstruction_c *i)
{
#if BX_SUPPORT_AES
  BX_CPU_THIS_PTR prepareSSE();

  BxPackedXmmRegister op, result;

  /* op is a register or memory reference */
  if (i->modC0()) {
    op = BX_READ_XMM_REG(i->rm());
  }
  else {
    BX_CPU_CALL_METHODR(i->ResolveModrm, (i));
    /* pointer, segment address pair */
    readVirtualDQwordAligned(i->seg(), RMAddr(i), (Bit8u *) &op);
  }

  Bit32u rcon32 = i->Ib();

  result.xmm32u(0) = AES_SubWord(op.xmm32u(1));
  result.xmm32u(1) = AES_RotWord(result.xmm32u(0)) ^ rcon32;
  result.xmm32u(2) = AES_SubWord(op.xmm32u(3));
  result.xmm32u(3) = AES_RotWord(result.xmm32u(2)) ^ rcon32;

  BX_WRITE_XMM_REG(i->nnn(), result);
#else
  BX_INFO(("AESKEYGENASSIST_VdqWdqIb: required AES support, use --enable-aes option"));
  UndefinedOpcode(i);
#endif
}
