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