CryptoPkg/Include/OpenSslSupport.h

   1 /** @file
   2   Root include file to support building OpenSSL Crypto Library.
   3
   4 Copyright (c) 2010 - 2015, Intel Corporation. All rights reserved.<BR>
   5 This program and the accompanying materials
   6 are licensed and made available under the terms and conditions of the BSD License
   7 which accompanies this distribution.  The full text of the license may be found at
   8 http://opensource.org/licenses/bsd-license.php
   9
  10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15 #ifndef __OPEN_SSL_SUPPORT_H__
  16 #define __OPEN_SSL_SUPPORT_H__
  17
  18 #include <Base.h>
  19 #include <Library/BaseLib.h>
  20 #include <Library/BaseMemoryLib.h>
  21 #include <Library/MemoryAllocationLib.h>
  22 #include <Library/DebugLib.h>
  23
  24 #define MAX_STRING_SIZE  0x1000
  25
  26 //
  27 // OpenSSL relies on explicit configuration for word size in crypto/bn,
  28 // but we want it to be automatically inferred from the target. So we
  29 // bypass what's in <openssl/opensslconf.h> for OPENSSL_SYS_UEFI, and
  30 // define our own here.
  31 //
  32 #ifdef CONFIG_HEADER_BN_H
  33 #error CONFIG_HEADER_BN_H already defined
  34 #endif
  35
  36 #define CONFIG_HEADER_BN_H
  37
  38 #if defined(MDE_CPU_X64) || defined(MDE_CPU_AARCH64) || defined(MDE_CPU_IA64)
  39 //
  40 // With GCC we would normally use SIXTY_FOUR_BIT_LONG, but MSVC needs
  41 // SIXTY_FOUR_BIT, because 'long' is 32-bit and only 'long long' is
  42 // 64-bit. Since using 'long long' works fine on GCC too, just do that.
  43 //
  44 #define SIXTY_FOUR_BIT
  45 #elif defined(MDE_CPU_IA32) || defined(MDE_CPU_ARM) || defined(MDE_CPU_EBC)
  46 #define THIRTY_TWO_BIT
  47 #else
  48 #error Unknown target architecture
  49 #endif
  50
  51 //
  52 // File operations are not required for building Open SSL,
  53 // so FILE is mapped to VOID * to pass build
  54 //
  55 typedef VOID  *FILE;
  56
  57 //
  58 // Map all va_xxxx elements to VA_xxx defined in MdePkg/Include/Base.h
  59 //
  60 #if !defined(__CC_ARM) // if va_list is not already defined
  61 #define va_list   VA_LIST
  62 #define va_arg    VA_ARG
  63 #define va_start  VA_START
  64 #define va_end    VA_END
  65 #else // __CC_ARM
  66 #define va_start(Marker, Parameter)   __va_start(Marker, Parameter)
  67 #define va_arg(Marker, TYPE)          __va_arg(Marker, TYPE)
  68 #define va_end(Marker)                ((void)0)
  69 #endif
  70
  71 //
  72 // #defines from EFI Application Toolkit required to build Open SSL
  73 //
  74 #define ENOMEM       12               /* Cannot allocate memory */
  75 #define EINVAL       22               /* Invalid argument */
  76 #define BUFSIZ       1024             /* size of buffer used by setbuf */
  77 #define INT_MAX      2147483647       /* max value for an int */
  78 #define INT_MIN      (-2147483647-1)  /* min value for an int */
  79 #define LONG_MAX     2147483647L      /* max value for a long */
  80 #define LONG_MIN     (-2147483647-1)  /* min value for a long */
  81 #define ULONG_MAX    0xffffffff       /* max value for an unsigned long */
  82 #define LOG_DAEMON   (3<<3)           /* system daemons */
  83 #define LOG_EMERG    0                /* system is unusable */
  84 #define LOG_ALERT    1                /* action must be taken immediately */
  85 #define LOG_CRIT     2                /* critical conditions */
  86 #define LOG_ERR      3                /* error conditions */
  87 #define LOG_WARNING  4                /* warning conditions */
  88 #define LOG_NOTICE   5                /* normal but significant condition */
  89 #define LOG_INFO     6                /* informational */
  90 #define LOG_DEBUG    7                /* debug-level messages */
  91 #define LOG_PID      0x01             /* log the pid with each message */
  92 #define LOG_CONS     0x02             /* log on the console if errors in sending */
  93
  94 //
  95 // Macros from EFI Application Toolkit required to build Open SSL
  96 //
  97 /* The offsetof() macro calculates the offset of a structure member
  98    in its structure.  Unfortunately this cannot be written down
  99    portably, hence it is provided by a Standard C header file.
 100    For pre-Standard C compilers, here is a version that usually works
 101    (but watch out!): */
 102 #define offsetof(type, member) OFFSET_OF (type, member)
 103
 104 //
 105 // Basic types from EFI Application Toolkit required to build Open SSL
 106 //
 107 typedef UINTN          size_t;
 108 typedef INTN           ssize_t;
 109 typedef INT64          off_t;
 110 typedef UINT16         mode_t;
 111 typedef long           time_t;
 112 typedef unsigned long  clock_t;
 113 typedef UINT32         uid_t;
 114 typedef UINT32         gid_t;
 115 typedef UINT32         ino_t;
 116 typedef UINT32         dev_t;
 117 typedef UINT16         nlink_t;
 118 typedef int            pid_t;
 119 typedef void           *DIR;
 120 typedef void           __sighandler_t (int);
 121
 122 //
 123 // Structures from EFI Application Toolkit required to build Open SSL
 124 //
 125 struct tm {
 126   int   tm_sec;     /* seconds after the minute [0-60] */
 127   int   tm_min;     /* minutes after the hour [0-59] */
 128   int   tm_hour;    /* hours since midnight [0-23] */
 129   int   tm_mday;    /* day of the month [1-31] */
 130   int   tm_mon;     /* months since January [0-11] */
 131   int   tm_year;    /* years since 1900 */
 132   int   tm_wday;    /* days since Sunday [0-6] */
 133   int   tm_yday;    /* days since January 1 [0-365] */
 134   int   tm_isdst;   /* Daylight Savings Time flag */
 135   long  tm_gmtoff;  /* offset from CUT in seconds */
 136   char  *tm_zone;   /* timezone abbreviation */
 137 };
 138
 139 struct timeval {
 140   long tv_sec;      /* time value, in seconds */
 141   long tv_usec;     /* time value, in microseconds */
 142 };
 143
 144 struct dirent {
 145   UINT32  d_fileno;         /* file number of entry */
 146   UINT16  d_reclen;         /* length of this record */
 147   UINT8   d_type;           /* file type, see below */
 148   UINT8   d_namlen;         /* length of string in d_name */
 149   char    d_name[255 + 1];  /* name must be no longer than this */
 150 };
 151
 152 struct stat {
 153   dev_t    st_dev;          /* inode's device */
 154   ino_t    st_ino;          /* inode's number */
 155   mode_t   st_mode;         /* inode protection mode */
 156   nlink_t  st_nlink;        /* number of hard links */
 157   uid_t    st_uid;          /* user ID of the file's owner */
 158   gid_t    st_gid;          /* group ID of the file's group */
 159   dev_t    st_rdev;         /* device type */
 160   time_t   st_atime;        /* time of last access */
 161   long     st_atimensec;    /* nsec of last access */
 162   time_t   st_mtime;        /* time of last data modification */
 163   long     st_mtimensec;    /* nsec of last data modification */
 164   time_t   st_ctime;        /* time of last file status change */
 165   long     st_ctimensec;    /* nsec of last file status change */
 166   off_t    st_size;         /* file size, in bytes */
 167   INT64    st_blocks;       /* blocks allocated for file */
 168   UINT32   st_blksize;      /* optimal blocksize for I/O */
 169   UINT32   st_flags;        /* user defined flags for file */
 170   UINT32   st_gen;          /* file generation number */
 171   INT32    st_lspare;
 172   INT64    st_qspare[2];
 173 };
 174
 175 //
 176 // Externs from EFI Application Toolkit required to build Open SSL
 177 //
 178 extern int errno;
 179
 180 //
 181 // Function prototypes from EFI Application Toolkit required to build Open SSL
 182 //
 183 void           *malloc     (size_t);
 184 void           *realloc    (void *, size_t);
 185 void           free        (void *);
 186 int            isdigit     (int);
 187 int            isspace     (int);
 188 int            tolower     (int);
 189 int            isupper     (int);
 190 int            isxdigit    (int);
 191 int            isalnum     (int);
 192 void           *memcpy     (void *, const void *, size_t);
 193 void           *memset     (void *, int, size_t);
 194 void           *memchr     (const void *, int, size_t);
 195 int            memcmp      (const void *, const void *, size_t);
 196 void           *memmove    (void *, const void *, size_t);
 197 int            strcmp      (const char *, const char *);
 198 int            strncmp     (const char *, const char *, size_t);
 199 char           *strcpy     (char *, const char *);
 200 char           *strncpy    (char *, const char *, size_t);
 201 size_t         strlen      (const char *);
 202 char           *strcat     (char *, const char *);
 203 char           *strchr     (const char *, int);
 204 int            strcasecmp  (const char *, const char *);
 205 int            strncasecmp (const char *, const char *, size_t);
 206 char           *strncpy    (char *, const char *, size_t);
 207 int            strncmp     (const char *, const char *, size_t);
 208 char           *strrchr    (const char *, int);
 209 unsigned long  strtoul     (const char *, char **, int);
 210 long           strtol      (const char *, char **, int);
 211 int            printf      (const char *, ...);
 212 int            sscanf      (const char *, const char *, ...);
 213 int            open        (const char *, int, ...);
 214 int            chmod       (const char *, mode_t);
 215 int            stat        (const char *, struct stat *);
 216 off_t          lseek       (int, off_t, int);
 217 ssize_t        read        (int, void *, size_t);
 218 ssize_t        write       (int, const void *, size_t);
 219 int            close       (int);
 220 FILE           *fopen      (const char *, const char *);
 221 size_t         fread       (void *, size_t, size_t, FILE *);
 222 size_t         fwrite      (const void *, size_t, size_t, FILE *);
 223 char           *fgets      (char *, int, FILE *);
 224 int            fputs       (const char *, FILE *);
 225 int            fprintf     (FILE *, const char *, ...);
 226 int            vfprintf    (FILE *, const char *, VA_LIST);
 227 int            fflush      (FILE *);
 228 int            fclose      (FILE *);
 229 DIR            *opendir    (const char *);
 230 struct dirent  *readdir    (DIR *);
 231 int            closedir    (DIR *);
 232 void           openlog     (const char *, int, int);
 233 void           closelog    (void);
 234 void           syslog      (int, const char *, ...);
 235 time_t         time        (time_t *);
 236 struct tm      *localtime  (const time_t *);
 237 struct tm      *gmtime     (const time_t *);
 238 struct tm      *gmtime_r   (const time_t *, struct tm *);
 239 uid_t          getuid      (void);
 240 uid_t          geteuid     (void);
 241 gid_t          getgid      (void);
 242 gid_t          getegid     (void);
 243 void           qsort       (void *, size_t, size_t, int (*)(const void *, const void *));
 244 char           *getenv     (const char *);
 245 void           exit        (int);
 246 void           abort       (void);
 247 __sighandler_t *signal     (int, __sighandler_t *);
 248
 249 //
 250 // Global variables from EFI Application Toolkit required to build Open SSL
 251 //
 252 extern FILE  *stderr;
 253 extern FILE  *stdin;
 254 extern FILE  *stdout;
 255
 256 //
 257 // Macros that directly map functions to BaseLib, BaseMemoryLib, and DebugLib functions
 258 //
 259 #define memcpy(dest,source,count)         CopyMem(dest,source,(UINTN)(count))
 260 #define memset(dest,ch,count)             SetMem(dest,(UINTN)(count),(UINT8)(ch))
 261 #define memchr(buf,ch,count)              ScanMem8(buf,(UINTN)(count),(UINT8)ch)
 262 #define memcmp(buf1,buf2,count)           (int)(CompareMem(buf1,buf2,(UINTN)(count)))
 263 #define memmove(dest,source,count)        CopyMem(dest,source,(UINTN)(count))
 264 #define strcmp                            AsciiStrCmp
 265 #define strncmp(string1,string2,count)    (int)(AsciiStrnCmp(string1,string2,(UINTN)(count)))
 266 #define strcpy(strDest,strSource)         AsciiStrCpyS(strDest,MAX_STRING_SIZE,strSource)
 267 #define strncpy(strDest,strSource,count)  AsciiStrnCpyS(strDest,MAX_STRING_SIZE,strSource,(UINTN)count)
 268 #define strlen(str)                       (size_t)(AsciiStrnLenS(str,MAX_STRING_SIZE))
 269 #define strcat(strDest,strSource)         AsciiStrCatS(strDest,MAX_STRING_SIZE,strSource)
 270 #define strchr(str,ch)                    ScanMem8((VOID *)(str),AsciiStrSize(str),(UINT8)ch)
 271 #define abort()                           ASSERT (FALSE)
 272 #define assert(expression)
 273 #define localtime(timer)                  NULL
 274 #define gmtime_r(timer,result)            (result = NULL)
 275 #define atoi(nptr)                        AsciiStrDecimalToUintn(nptr)
 276
 277 #endif