CryptoPkg/CrtLibSupport: add MODULESDIR

[mirror_edk2.git] / CryptoPkg / Library / Include / CrtLibSupport.h

/** @file\r
  Root include file of C runtime library to support building the third-party\r
  cryptographic library.\r
\r
Copyright (c) 2010 - 2022, Intel Corporation. All rights reserved.<BR>\r
Copyright (c) 2020, Hewlett Packard Enterprise Development LP. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef __CRT_LIB_SUPPORT_H__\r
#define __CRT_LIB_SUPPORT_H__\r
\r
#include <Library/BaseLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/PrintLib.h>\r
\r
#define OPENSSLDIR  ""\r
#define ENGINESDIR  ""\r
#define MODULESDIR  ""\r
\r
#define MAX_STRING_SIZE  0x1000\r
\r
//\r
// We already have "no-ui" in out Configure invocation.\r
// but the code still fails to compile.\r
// Ref:  https://github.com/openssl/openssl/issues/8904\r
//\r
// This is defined in CRT library(stdio.h).\r
//\r
#ifndef BUFSIZ\r
#define BUFSIZ  8192\r
#endif\r
\r
//\r
// OpenSSL relies on explicit configuration for word size in crypto/bn,\r
// but we want it to be automatically inferred from the target. So we\r
// bypass what's in <openssl/opensslconf.h> for OPENSSL_SYS_UEFI, and\r
// define our own here.\r
//\r
#ifdef CONFIG_HEADER_BN_H\r
  #error CONFIG_HEADER_BN_H already defined\r
#endif\r
\r
#define CONFIG_HEADER_BN_H\r
\r
#if !defined (SIXTY_FOUR_BIT) && !defined (THIRTY_TWO_BIT)\r
  #if defined (MDE_CPU_X64) || defined (MDE_CPU_AARCH64) || defined (MDE_CPU_IA64) || defined (MDE_CPU_RISCV64)\r
//\r
// With GCC we would normally use SIXTY_FOUR_BIT_LONG, but MSVC needs\r
// SIXTY_FOUR_BIT, because 'long' is 32-bit and only 'long long' is\r
// 64-bit. Since using 'long long' works fine on GCC too, just do that.\r
//\r
#define SIXTY_FOUR_BIT\r
  #elif defined (MDE_CPU_IA32) || defined (MDE_CPU_ARM) || defined (MDE_CPU_EBC)\r
#define THIRTY_TWO_BIT\r
  #else\r
    #error Unknown target architecture\r
  #endif\r
#endif\r
\r
//\r
// Map all va_xxxx elements to VA_xxx defined in MdePkg/Include/Base.h\r
//\r
#if !defined (__CC_ARM) // if va_list is not already defined\r
#define va_list   VA_LIST\r
#define va_arg    VA_ARG\r
#define va_start  VA_START\r
#define va_end    VA_END\r
#else // __CC_ARM\r
#define va_start(Marker, Parameter)  __va_start(Marker, Parameter)\r
#define va_arg(Marker, TYPE)         __va_arg(Marker, TYPE)\r
#define va_end(Marker)               ((void)0)\r
#endif\r
\r
//\r
// Definitions for global constants used by CRT library routines\r
//\r
#define EINVAL        22              /* Invalid argument */\r
#define EAFNOSUPPORT  47              /* Address family not supported by protocol family */\r
#define INT_MAX       0x7FFFFFFF      /* Maximum (signed) int value */\r
#define INT_MIN       (-INT_MAX-1)    /* Minimum (signed) int value */\r
#define LONG_MAX      0X7FFFFFFFL     /* max value for a long */\r
#define LONG_MIN      (-LONG_MAX-1)   /* min value for a long */\r
#define UINT_MAX      0xFFFFFFFF      /* Maximum unsigned int value */\r
#define ULONG_MAX     0xFFFFFFFF      /* Maximum unsigned long value */\r
#define CHAR_BIT      8               /* Number of bits in a char */\r
\r
//\r
// Address families.\r
//\r
#define AF_INET   2     /* internetwork: UDP, TCP, etc. */\r
#define AF_INET6  24    /* IP version 6 */\r
\r
//\r
// Define constants based on RFC0883, RFC1034, RFC 1035\r
//\r
#define NS_INT16SZ    2   /*%< #/bytes of data in a u_int16_t */\r
#define NS_INADDRSZ   4   /*%< IPv4 T_A */\r
#define NS_IN6ADDRSZ  16  /*%< IPv6 T_AAAA */\r
\r
//\r
// Basic types mapping\r
//\r
typedef UINTN   size_t;\r
typedef UINTN   u_int;\r
typedef INTN    ptrdiff_t;\r
typedef INTN    ssize_t;\r
typedef INT32   time_t;\r
typedef UINT8   __uint8_t;\r
typedef UINT8   sa_family_t;\r
typedef UINT8   u_char;\r
typedef UINT32  uid_t;\r
typedef UINT32  gid_t;\r
typedef CHAR16  wchar_t;\r
\r
//\r
// File operations are not required for EFI building,\r
// so FILE is mapped to VOID * to pass build\r
//\r
typedef VOID *FILE;\r
\r
//\r
// Structures Definitions\r
//\r
struct tm {\r
  int     tm_sec;    /* seconds after the minute [0-60] */\r
  int     tm_min;    /* minutes after the hour [0-59] */\r
  int     tm_hour;   /* hours since midnight [0-23] */\r
  int     tm_mday;   /* day of the month [1-31] */\r
  int     tm_mon;    /* months since January [0-11] */\r
  int     tm_year;   /* years since 1900 */\r
  int     tm_wday;   /* days since Sunday [0-6] */\r
  int     tm_yday;   /* days since January 1 [0-365] */\r
  int     tm_isdst;  /* Daylight Savings Time flag */\r
  long    tm_gmtoff; /* offset from CUT in seconds */\r
  char    *tm_zone;  /* timezone abbreviation */\r
};\r
\r
struct timeval {\r
  long    tv_sec;   /* time value, in seconds */\r
  long    tv_usec;  /* time value, in microseconds */\r
};\r
\r
struct sockaddr {\r
  __uint8_t      sa_len;      /* total length */\r
  sa_family_t    sa_family;   /* address family */\r
  char           sa_data[14]; /* actually longer; address value */\r
};\r
\r
//\r
// Global variables\r
//\r
extern int   errno;\r
extern FILE  *stderr;\r
\r
//\r
// Function prototypes of CRT Library routines\r
//\r
void           *\r
malloc     (\r
  size_t\r
  );\r
\r
void           *\r
realloc    (\r
  void *,\r
  size_t\r
  );\r
\r
void\r
free        (\r
  void *\r
  );\r
\r
void           *\r
memset     (\r
  void *,\r
  int,\r
  size_t\r
  );\r
\r
int\r
memcmp      (\r
  const void *,\r
  const void *,\r
  size_t\r
  );\r
\r
int\r
isdigit     (\r
  int\r
  );\r
\r
int\r
isspace     (\r
  int\r
  );\r
\r
int\r
isxdigit    (\r
  int\r
  );\r
\r
int\r
isalnum     (\r
  int\r
  );\r
\r
int\r
isupper     (\r
  int\r
  );\r
\r
int\r
tolower     (\r
  int\r
  );\r
\r
int\r
strcmp      (\r
  const char *,\r
  const char *\r
  );\r
\r
int\r
strncasecmp (\r
  const char *,\r
  const char *,\r
  size_t\r
  );\r
\r
char           *\r
strchr     (\r
  const char *,\r
  int\r
  );\r
\r
char           *\r
strrchr    (\r
  const char *,\r
  int\r
  );\r
\r
unsigned long\r
strtoul     (\r
  const char *,\r
  char **,\r
  int\r
  );\r
\r
long\r
strtol      (\r
  const char *,\r
  char **,\r
  int\r
  );\r
\r
char           *\r
strerror   (\r
  int\r
  );\r
\r
size_t\r
strspn      (\r
  const char *,\r
  const char *\r
  );\r
\r
size_t\r
strcspn     (\r
  const char *,\r
  const char *\r
  );\r
\r
int\r
printf      (\r
  const char *,\r
  ...\r
  );\r
\r
int\r
sscanf      (\r
  const char *,\r
  const char *,\r
  ...\r
  );\r
\r
FILE           *\r
fopen      (\r
  const char *,\r
  const char *\r
  );\r
\r
size_t\r
fread       (\r
  void *,\r
  size_t,\r
  size_t,\r
  FILE *\r
  );\r
\r
size_t\r
fwrite      (\r
  const void *,\r
  size_t,\r
  size_t,\r
  FILE *\r
  );\r
\r
int\r
fclose      (\r
  FILE *\r
  );\r
\r
int\r
fprintf     (\r
  FILE *,\r
  const char *,\r
  ...\r
  );\r
\r
time_t\r
time        (\r
  time_t *\r
  );\r
\r
struct tm      *\r
gmtime     (\r
  const time_t *\r
  );\r
\r
uid_t\r
getuid      (\r
  void\r
  );\r
\r
uid_t\r
geteuid     (\r
  void\r
  );\r
\r
gid_t\r
getgid      (\r
  void\r
  );\r
\r
gid_t\r
getegid     (\r
  void\r
  );\r
\r
int\r
issetugid   (\r
  void\r
  );\r
\r
void\r
qsort       (\r
  void *,\r
  size_t,\r
  size_t,\r
  int (*)(const void *, const void *)\r
  );\r
\r
char           *\r
getenv     (\r
  const char *\r
  );\r
\r
char           *\r
secure_getenv (\r
  const char *\r
  );\r
\r
#if defined (__GNUC__) && (__GNUC__ >= 2)\r
void\r
abort       (\r
  void\r
  ) __attribute__ ((__noreturn__));\r
\r
#else\r
void\r
abort       (\r
  void\r
  );\r
\r
#endif\r
int\r
inet_pton   (\r
  int,\r
  const char *,\r
  void *\r
  );\r
\r
//\r
// Macros that directly map functions to BaseLib, BaseMemoryLib, and DebugLib functions\r
//\r
#define memcpy(dest, source, count)         CopyMem(dest,source,(UINTN)(count))\r
#define memset(dest, ch, count)             SetMem(dest,(UINTN)(count),(UINT8)(ch))\r
#define memchr(buf, ch, count)              ScanMem8(buf,(UINTN)(count),(UINT8)ch)\r
#define memcmp(buf1, buf2, count)           (int)(CompareMem(buf1,buf2,(UINTN)(count)))\r
#define memmove(dest, source, count)        CopyMem(dest,source,(UINTN)(count))\r
#define strlen(str)                         (size_t)(AsciiStrnLenS(str,MAX_STRING_SIZE))\r
#define strcpy(strDest, strSource)          AsciiStrCpyS(strDest,MAX_STRING_SIZE,strSource)\r
#define strncpy(strDest, strSource, count)  AsciiStrnCpyS(strDest,MAX_STRING_SIZE,strSource,(UINTN)count)\r
#define strcat(strDest, strSource)          AsciiStrCatS(strDest,MAX_STRING_SIZE,strSource)\r
#define strncmp(string1, string2, count)    (int)(AsciiStrnCmp(string1,string2,(UINTN)(count)))\r
#define strcasecmp(str1, str2)              (int)AsciiStriCmp(str1,str2)\r
#define strstr(s1, s2)                      AsciiStrStr(s1,s2)\r
#define sprintf(buf, ...)                   AsciiSPrint(buf,MAX_STRING_SIZE,__VA_ARGS__)\r
#define localtime(timer)                    NULL\r
#define assert(expression)\r
#define offsetof(type, member)  OFFSET_OF(type,member)\r
#define atoi(nptr)              AsciiStrDecimalToUintn(nptr)\r
#define gettimeofday(tvp, tz)   do { (tvp)->tv_sec = time(NULL); (tvp)->tv_usec = 0; } while (0)\r
\r
#endif\r