CryptoPkg/Library/Include/CrtLibSupport.h

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