[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 - 2019, 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
\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(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
\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 LONG_MAX     0X7FFFFFFFL      /* max value for a long */\r
#define LONG_MIN     (-LONG_MAX-1)    /* min value for a long */\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           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
\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           *malloc     (size_t);\r
void           *realloc    (void *, size_t);\r
void           free        (void *);\r
void           *memset     (void *, int, size_t);\r
int            memcmp      (const void *, const void *, size_t);\r
int            isdigit     (int);\r
int            isspace     (int);\r
int            isxdigit    (int);\r
int            isalnum     (int);\r
int            isupper     (int);\r
int            tolower     (int);\r
int            strcmp      (const char *, const char *);\r
int            strncasecmp (const char *, const char *, size_t);\r
char           *strchr     (const char *, int);\r
char           *strrchr    (const char *, int);\r
unsigned long  strtoul     (const char *, char **, int);\r
long           strtol      (const char *, char **, int);\r
char           *strerror   (int);\r
size_t         strspn      (const char *, const char *);\r
size_t         strcspn     (const char *, const char *);\r
int            printf      (const char *, ...);\r
int            sscanf      (const char *, const char *, ...);\r
FILE           *fopen      (const char *, const char *);\r
size_t         fread       (void *, size_t, size_t, FILE *);\r
size_t         fwrite      (const void *, size_t, size_t, FILE *);\r
int            fclose      (FILE *);\r
int            fprintf     (FILE *, const char *, ...);\r
time_t         time        (time_t *);\r
struct tm      *gmtime     (const time_t *);\r
uid_t          getuid      (void);\r
uid_t          geteuid     (void);\r
gid_t          getgid      (void);\r
gid_t          getegid     (void);\r
int            issetugid   (void);\r
void           qsort       (void *, size_t, size_t, int (*)(const void *, const void *));\r
char           *getenv     (const char *);\r
char           *secure_getenv (const char *);\r
#if defined(__GNUC__) && (__GNUC__ >= 2)\r
void           abort       (void) __attribute__((__noreturn__));\r
#else\r
void           abort       (void);\r
#endif\r
int            inet_pton   (int, const char *, void *);\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 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
Commit	Line	Data
fc9fa685 QL	1	/** @file\r
	2	Root include file of C runtime library to support building the third-party\r
	3	cryptographic library.\r
	4	\r
456dd8b9	5	Copyright (c) 2010 - 2019, Intel Corporation. All rights reserved.<BR>\r
9025a014	6	Copyright (c) 2020, Hewlett Packard Enterprise Development LP. All rights reserved.<BR>\r
2009f6b4	7	SPDX-License-Identifier: BSD-2-Clause-Patent\r
fc9fa685 QL	8	\r
	9	**/\r
	10	\r
	11	#ifndef __CRT_LIB_SUPPORT_H__\r
	12	#define __CRT_LIB_SUPPORT_H__\r
	13	\r
	14	#include <Library/BaseLib.h>\r
	15	#include <Library/BaseMemoryLib.h>\r
	16	#include <Library/DebugLib.h>\r
	17	#include <Library/PrintLib.h>\r
	18	\r
	19	#define OPENSSLDIR ""\r
	20	#define ENGINESDIR ""\r
	21	\r
	22	#define MAX_STRING_SIZE 0x1000\r
	23	\r
456dd8b9 XL	24	//\r
	25	// We already have "no-ui" in out Configure invocation.\r
	26	// but the code still fails to compile.\r
	27	// Ref: https://github.com/openssl/openssl/issues/8904\r
	28	//\r
	29	// This is defined in CRT library(stdio.h).\r
	30	//\r
	31	#ifndef BUFSIZ\r
	32	#define BUFSIZ 8192\r
	33	#endif\r
	34	\r
fc9fa685 QL	35	//\r
	36	// OpenSSL relies on explicit configuration for word size in crypto/bn,\r
	37	// but we want it to be automatically inferred from the target. So we\r
	38	// bypass what's in <openssl/opensslconf.h> for OPENSSL_SYS_UEFI, and\r
	39	// define our own here.\r
	40	//\r
	41	#ifdef CONFIG_HEADER_BN_H\r
	42	#error CONFIG_HEADER_BN_H already defined\r
	43	#endif\r
	44	\r
	45	#define CONFIG_HEADER_BN_H\r
	46	\r
9025a014	47	#if defined(MDE_CPU_X64) \|\| defined(MDE_CPU_AARCH64) \|\| defined(MDE_CPU_IA64) \|\| defined(MDE_CPU_RISCV64)\r
fc9fa685 QL	48	//\r
	49	// With GCC we would normally use SIXTY_FOUR_BIT_LONG, but MSVC needs\r
	50	// SIXTY_FOUR_BIT, because 'long' is 32-bit and only 'long long' is\r
	51	// 64-bit. Since using 'long long' works fine on GCC too, just do that.\r
	52	//\r
	53	#define SIXTY_FOUR_BIT\r
	54	#elif defined(MDE_CPU_IA32) \|\| defined(MDE_CPU_ARM) \|\| defined(MDE_CPU_EBC)\r
	55	#define THIRTY_TWO_BIT\r
	56	#else\r
	57	#error Unknown target architecture\r
	58	#endif\r
	59	\r
	60	//\r
	61	// Map all va_xxxx elements to VA_xxx defined in MdePkg/Include/Base.h\r
	62	//\r
	63	#if !defined(__CC_ARM) // if va_list is not already defined\r
	64	#define va_list VA_LIST\r
	65	#define va_arg VA_ARG\r
	66	#define va_start VA_START\r
	67	#define va_end VA_END\r
	68	#else // __CC_ARM\r
	69	#define va_start(Marker, Parameter) __va_start(Marker, Parameter)\r
	70	#define va_arg(Marker, TYPE) __va_arg(Marker, TYPE)\r
	71	#define va_end(Marker) ((void)0)\r
	72	#endif\r
	73	\r
	74	//\r
	75	// Definitions for global constants used by CRT library routines\r
	76	//\r
	77	#define EINVAL 22 /* Invalid argument */\r
2ac41c12	78	#define EAFNOSUPPORT 47 /* Address family not supported by protocol family */\r
fc9fa685 QL	79	#define INT_MAX 0x7FFFFFFF /* Maximum (signed) int value */\r
	80	#define LONG_MAX 0X7FFFFFFFL /* max value for a long */\r
	81	#define LONG_MIN (-LONG_MAX-1) /* min value for a long */\r
	82	#define ULONG_MAX 0xFFFFFFFF /* Maximum unsigned long value */\r
	83	#define CHAR_BIT 8 /* Number of bits in a char */\r
	84	\r
2ac41c12 LE	85	//\r
	86	// Address families.\r
	87	//\r
	88	#define AF_INET 2 /* internetwork: UDP, TCP, etc. */\r
	89	#define AF_INET6 24 /* IP version 6 */\r
	90	\r
	91	//\r
	92	// Define constants based on RFC0883, RFC1034, RFC 1035\r
	93	//\r
	94	#define NS_INT16SZ 2 /%< #/bytes of data in a u_int16_t /\r
	95	#define NS_INADDRSZ 4 /%< IPv4 T_A /\r
	96	#define NS_IN6ADDRSZ 16 /%< IPv6 T_AAAA /\r
	97	\r
fc9fa685 QL	98	//\r
	99	// Basic types mapping\r
	100	//\r
	101	typedef UINTN size_t;\r
2ac41c12	102	typedef UINTN u_int;\r
fc9fa685 QL	103	typedef INTN ssize_t;\r
	104	typedef INT32 time_t;\r
	105	typedef UINT8 __uint8_t;\r
	106	typedef UINT8 sa_family_t;\r
2ac41c12	107	typedef UINT8 u_char;\r
fc9fa685 QL	108	typedef UINT32 uid_t;\r
	109	typedef UINT32 gid_t;\r
	110	\r
	111	//\r
	112	// File operations are not required for EFI building,\r
	113	// so FILE is mapped to VOID * to pass build\r
	114	//\r
	115	typedef VOID *FILE;\r
	116	\r
	117	//\r
	118	// Structures Definitions\r
	119	//\r
	120	struct tm {\r
	121	int tm_sec; /* seconds after the minute [0-60] */\r
	122	int tm_min; /* minutes after the hour [0-59] */\r
	123	int tm_hour; /* hours since midnight [0-23] */\r
	124	int tm_mday; /* day of the month [1-31] */\r
	125	int tm_mon; /* months since January [0-11] */\r
	126	int tm_year; /* years since 1900 */\r
	127	int tm_wday; /* days since Sunday [0-6] */\r
	128	int tm_yday; /* days since January 1 [0-365] */\r
	129	int tm_isdst; /* Daylight Savings Time flag */\r
	130	long tm_gmtoff; /* offset from CUT in seconds */\r
	131	char tm_zone; / timezone abbreviation */\r
	132	};\r
	133	\r
	134	struct timeval {\r
	135	long tv_sec; /* time value, in seconds */\r
	136	long tv_usec; /* time value, in microseconds */\r
	137	};\r
	138	\r
	139	struct sockaddr {\r
	140	__uint8_t sa_len; /* total length */\r
	141	sa_family_t sa_family; /* address family */\r
	142	char sa_data[14]; /* actually longer; address value */\r
	143	};\r
	144	\r
	145	//\r
	146	// Global variables\r
	147	//\r
	148	extern int errno;\r
	149	extern FILE *stderr;\r
	150	\r
	151	//\r
	152	// Function prototypes of CRT Library routines\r
	153	//\r
	154	void *malloc (size_t);\r
	155	void realloc (void , size_t);\r
	156	void free (void *);\r
	157	void memset (void , int, size_t);\r
5d7a1d63	158	int memcmp (const void , const void , size_t);\r
fc9fa685 QL	159	int isdigit (int);\r
	160	int isspace (int);\r
	161	int isxdigit (int);\r
	162	int isalnum (int);\r
	163	int isupper (int);\r
	164	int tolower (int);\r
	165	int strcmp (const char , const char );\r
	166	int strncasecmp (const char , const char , size_t);\r
eb520d94	167	char strchr (const char , int);\r
fc9fa685 QL	168	char strrchr (const char , int);\r
	169	unsigned long strtoul (const char , char *, int);\r
	170	long strtol (const char , char *, int);\r
	171	char *strerror (int);\r
	172	size_t strspn (const char , const char );\r
	173	size_t strcspn (const char , const char );\r
	174	int printf (const char *, ...);\r
	175	int sscanf (const char , const char , ...);\r
	176	FILE fopen (const char , const char *);\r
	177	size_t fread (void , size_t, size_t, FILE );\r
	178	size_t fwrite (const void , size_t, size_t, FILE );\r
	179	int fclose (FILE *);\r
	180	int fprintf (FILE , const char , ...);\r
	181	time_t time (time_t *);\r
	182	struct tm gmtime (const time_t );\r
	183	uid_t getuid (void);\r
	184	uid_t geteuid (void);\r
	185	gid_t getgid (void);\r
	186	gid_t getegid (void);\r
1a734ed8	187	int issetugid (void);\r
fc9fa685 QL	188	void qsort (void , size_t, size_t, int ()(const void , const void ));\r
fc9fa685 QL	189	char getenv (const char );\r
ee3198e6	190	char secure_getenv (const char );\r
fc9fa685 QL	191	#if defined(__GNUC__) && (__GNUC__ >= 2)\r
	192	void abort (void) __attribute__((__noreturn__));\r
	193	#else\r
	194	void abort (void);\r
	195	#endif\r
8d16ef82	196	int inet_pton (int, const char , void );\r
fc9fa685 QL	197	\r
	198	//\r
	199	// Macros that directly map functions to BaseLib, BaseMemoryLib, and DebugLib functions\r
	200	//\r
	201	#define memcpy(dest,source,count) CopyMem(dest,source,(UINTN)(count))\r
	202	#define memset(dest,ch,count) SetMem(dest,(UINTN)(count),(UINT8)(ch))\r
	203	#define memchr(buf,ch,count) ScanMem8(buf,(UINTN)(count),(UINT8)ch)\r
	204	#define memcmp(buf1,buf2,count) (int)(CompareMem(buf1,buf2,(UINTN)(count)))\r
	205	#define memmove(dest,source,count) CopyMem(dest,source,(UINTN)(count))\r
	206	#define strlen(str) (size_t)(AsciiStrnLenS(str,MAX_STRING_SIZE))\r
	207	#define strcpy(strDest,strSource) AsciiStrCpyS(strDest,MAX_STRING_SIZE,strSource)\r
	208	#define strncpy(strDest,strSource,count) AsciiStrnCpyS(strDest,MAX_STRING_SIZE,strSource,(UINTN)count)\r
	209	#define strcat(strDest,strSource) AsciiStrCatS(strDest,MAX_STRING_SIZE,strSource)\r
fc9fa685 QL	210	#define strncmp(string1,string2,count) (int)(AsciiStrnCmp(string1,string2,(UINTN)(count)))\r
	211	#define strcasecmp(str1,str2) (int)AsciiStriCmp(str1,str2)\r
	212	#define sprintf(buf,...) AsciiSPrint(buf,MAX_STRING_SIZE,__VA_ARGS__)\r
	213	#define localtime(timer) NULL\r
	214	#define assert(expression)\r
	215	#define offsetof(type,member) OFFSET_OF(type,member)\r
	216	#define atoi(nptr) AsciiStrDecimalToUintn(nptr)\r
	217	#define gettimeofday(tvp,tz) do { (tvp)->tv_sec = time(NULL); (tvp)->tv_usec = 0; } while (0)\r
	218	\r
	219	#endif\r