[mirror_edk2.git] / CryptoPkg / Include / OpenSslSupport.h

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