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