/********************************************************************************************
* Supersingular Isogeny Key Encapsulation Library
*
* Abstract: internal header file for P610
*********************************************************************************************/  

#ifndef P610_INTERNAL_H
#define P610_INTERNAL_H

#include "../config.h"
 

#if (TARGET == TARGET_AMD64) || (TARGET == TARGET_ARM64) || (TARGET == TARGET_S390X)
    #define NWORDS_FIELD    10              // Number of words of a 610-bit field element
    #define p610_ZERO_WORDS 4               // Number of "0" digits in the least significant part of p610 + 1     
#elif (TARGET == TARGET_x86) || (TARGET == TARGET_ARM)
    #define NWORDS_FIELD    20 
    #define p610_ZERO_WORDS 9
#endif
    

// Basic constants

#define NBITS_FIELD             610  
#define MAXBITS_FIELD           640                
#define MAXWORDS_FIELD          ((MAXBITS_FIELD+RADIX-1)/RADIX)     // Max. number of words to represent field elements
#define NWORDS64_FIELD          ((NBITS_FIELD+63)/64)               // Number of 64-bit words of a 610-bit field element 
#define NBITS_ORDER             320
#define NWORDS_ORDER            ((NBITS_ORDER+RADIX-1)/RADIX)       // Number of words of oA and oB, where oA and oB are the subgroup orders of Alice and Bob, resp.
#define NWORDS64_ORDER          ((NBITS_ORDER+63)/64)               // Number of 64-bit words of a 320-bit element 
#define MAXBITS_ORDER           NBITS_ORDER
#define ALICE                   0
#define BOB                     1 
#define OALICE_BITS             305  
#define OBOB_BITS               305    
#define OBOB_EXPON              192 
#define MASK_ALICE              0x01
#define MASK_BOB                0xFF  
#define PRIME                   p610  
#define PARAM_A                 6  
#define PARAM_C                 1
// Fixed parameters for isogeny tree computation
#define MAX_INT_POINTS_ALICE    8      
#define MAX_INT_POINTS_BOB      10 
#define MAX_Alice               152
#define MAX_Bob                 192
#define MSG_BYTES               24
#define SECRETKEY_A_BYTES       ((OALICE_BITS + 7) / 8)
#define SECRETKEY_B_BYTES       ((OBOB_BITS - 1 + 7) / 8)
#define FP2_ENCODED_BYTES       2*((NBITS_FIELD + 7) / 8)

#ifdef COMPRESS
    #define MASK2_BOB               0x07
    #define MASK3_BOB               0xFF
    #define ORDER_A_ENCODED_BYTES   SECRETKEY_A_BYTES
    #define ORDER_B_ENCODED_BYTES   (SECRETKEY_B_BYTES + 1)
    #define PARTIALLY_COMPRESSED_CHUNK_CT     (4*ORDER_A_ENCODED_BYTES + FP2_ENCODED_BYTES + 2)
    #define COMPRESSED_CHUNK_CT     (3*ORDER_A_ENCODED_BYTES + FP2_ENCODED_BYTES + 2)
    #define UNCOMPRESSEDPK_BYTES    480
    // Table sizes used by the Entangled basis generation
    #define TABLE_R_LEN 17
    #define TABLE_V_LEN 34
    #define TABLE_V3_LEN 20
    // Parameters for discrete log computations
    // Binary Pohlig-Hellman reduced to smaller logs of order ell^W
    #define W_2 5
    #define W_3 3
    // ell^w    
    #define ELL2_W (1 << W_2)    
    #define ELL3_W 27
    // ell^(e mod w) 
    #define ELL2_EMODW (1 << (OALICE_BITS % W_2))    
    #define ELL3_EMODW 1
    // # of digits in the discrete log    
    #define DLEN_2 ((OALICE_BITS+W_2-1)/W_2)  // ceil(eA/W_2)
    #define DLEN_3 ((OBOB_EXPON+W_3-1)/W_3)   // ceil(eB/W_3)
    // Use compressed tables: FULL_SIGNED
    #define COMPRESSED_TABLES
    #define ELL2_FULL_SIGNED    // Uses signed digits to reduce table size by half
    #define ELL3_FULL_SIGNED    // Uses signed digits to reduce table size by half
    // Length of the optimal strategy path for Pohlig-Hellman
    #ifdef COMPRESSED_TABLES
        #ifdef ELL2_FULL_SIGNED
            #if W_2 == 5
                #define PLEN_2 62
            #endif
        #endif
        #ifdef ELL3_FULL_SIGNED
            #if W_3 == 3
                #define PLEN_3 65
            #endif
        #endif
    #endif
#endif



// SIDH's basic element definitions and point representations

typedef digit_t felm_t[NWORDS_FIELD];                                 // Datatype for representing 610-bit field elements (640-bit max.)
typedef digit_t dfelm_t[2*NWORDS_FIELD];                              // Datatype for representing double-precision 2x610-bit field elements (2x640-bit max.) 
typedef felm_t  f2elm_t[2];                                           // Datatype for representing quadratic extension field elements GF(p610^2)
        
typedef struct { f2elm_t X; f2elm_t Z; } point_proj;                  // Point representation in projective XZ Montgomery coordinates.
typedef point_proj point_proj_t[1]; 

#ifdef COMPRESS
    typedef struct { f2elm_t X; f2elm_t Y; f2elm_t Z; } point_full_proj;  // Point representation in full projective XYZ Montgomery coordinates 
    typedef point_full_proj point_full_proj_t[1]; 

    typedef struct { f2elm_t x; f2elm_t y; } point_affine;                // Point representation in affine coordinates.
    typedef point_affine point_t[1]; 

    typedef f2elm_t publickey_t[3];      
#endif


/**************** Function prototypes ****************/
/************* Multiprecision functions **************/

// 610-bit multiprecision addition, c = a+b
void mp_add610(const digit_t* a, const digit_t* b, digit_t* c);
void mp_add610_asm(const digit_t* a, const digit_t* b, digit_t* c);

// 610-bit multiprecision subtraction, c = a-b+2p or c = a-b+4p
extern void mp_sub610_p2(const digit_t* a, const digit_t* b, digit_t* c);
extern void mp_sub610_p4(const digit_t* a, const digit_t* b, digit_t* c);
void mp_sub610_p2_asm(const digit_t* a, const digit_t* b, digit_t* c); 
void mp_sub610_p4_asm(const digit_t* a, const digit_t* b, digit_t* c); 

// 2x610-bit multiprecision subtraction followed by addition with p610*2^640, c = a-b+(p610*2^640) if a-b < 0, otherwise c=a-b 
void mp_subaddx2_asm(const digit_t* a, const digit_t* b, digit_t* c);
void mp_subadd610x2_asm(const digit_t* a, const digit_t* b, digit_t* c);

// Double 2x610-bit multiprecision subtraction, c = c-a-b, where c > a and c > b
void mp_dblsub610x2_asm(const digit_t* a, const digit_t* b, digit_t* c);

/************ Field arithmetic functions *************/

// Copy of a field element, c = a
void fpcopy610(const digit_t* a, digit_t* c);

// Zeroing a field element, a = 0
void fpzero610(digit_t* a);

// Non constant-time comparison of two field elements. If a = b return TRUE, otherwise, return FALSE
bool fpequal610_non_constant_time(const digit_t* a, const digit_t* b); 

// Modular addition, c = a+b mod p610
extern void fpadd610(const digit_t* a, const digit_t* b, digit_t* c);
extern void fpadd610_asm(const digit_t* a, const digit_t* b, digit_t* c);

// Modular subtraction, c = a-b mod p610
extern void fpsub610(const digit_t* a, const digit_t* b, digit_t* c);
extern void fpsub610_asm(const digit_t* a, const digit_t* b, digit_t* c);

// Modular negation, a = -a mod p610        
extern void fpneg610(digit_t* a);  

// Modular division by two, c = a/2 mod p610.
void fpdiv2_610(const digit_t* a, digit_t* c);

// Modular correction to reduce field element a in [0, 2*p610-1] to [0, p610-1].
void fpcorrection610(digit_t* a);

// 610-bit Montgomery reduction, c = a mod p
void rdc610_asm(digit_t* ma, digit_t* mc);
            
// Field multiplication using Montgomery arithmetic, c = a*b*R^-1 mod p610, where R=2^640
void fpmul610_mont(const digit_t* a, const digit_t* b, digit_t* c);
void mul610_asm(const digit_t* a, const digit_t* b, digit_t* c);
   
// Field squaring using Montgomery arithmetic, c = a*b*R^-1 mod p610, where R=2^640
void fpsqr610_mont(const digit_t* ma, digit_t* mc);

// Field inversion, a = a^-1 in GF(p610)
void fpinv610_mont(digit_t* a);

// Field inversion, a = a^-1 in GF(p610) using the binary GCD 
void fpinv610_mont_bingcd(digit_t* a);

// Chain to compute (p610-3)/4 using Montgomery arithmetic
void fpinv610_chain_mont(digit_t* a);

/************ GF(p^2) arithmetic functions *************/
    
// Copy of a GF(p610^2) element, c = a
void fp2copy610(const f2elm_t a, f2elm_t c);

// Zeroing a GF(p610^2) element, a = 0
void fp2zero610(f2elm_t a);

// GF(p610^2) negation, a = -a in GF(p610^2)
void fp2neg610(f2elm_t a);

// GF(p610^2) addition, c = a+b in GF(p610^2)
extern void fp2add610(const f2elm_t a, const f2elm_t b, f2elm_t c);           

// GF(p610^2) subtraction, c = a-b in GF(p610^2)
extern void fp2sub610(const f2elm_t a, const f2elm_t b, f2elm_t c); 

// GF(p610^2) division by two, c = a/2  in GF(p610^2) 
void fp2div2_610(const f2elm_t a, f2elm_t c);

// Modular correction, a = a in GF(p610^2)
void fp2correction610(f2elm_t a);
            
// GF(p610^2) squaring using Montgomery arithmetic, c = a^2 in GF(p610^2)
void fp2sqr610_mont(const f2elm_t a, f2elm_t c);
 
// GF(p610^2) multiplication using Montgomery arithmetic, c = a*b in GF(p610^2)
void fp2mul610_mont(const f2elm_t a, const f2elm_t b, f2elm_t c);

// GF(p610^2) inversion using Montgomery arithmetic, a = (a0-i*a1)/(a0^2+a1^2)
void fp2inv610_mont(f2elm_t a);

// GF(p610^2) inversion, a = (a0-i*a1)/(a0^2+a1^2), GF(p610) inversion done using the binary GCD 
void fp2inv610_mont_bingcd(f2elm_t a);

// Multiprecision right shift by one
void mp_shiftr1(digit_t* x, const unsigned int nwords);

#endif
