/** @file | |
Redfish CRT wrapper functions. | |
Copyright (c) 2019, Intel Corporation. All rights reserved.<BR> | |
(C) Copyright 2021 Hewlett Packard Enterprise Development LP<BR> | |
SPDX-License-Identifier: BSD-2-Clause-Patent | |
**/ | |
#ifndef REDFISH_CRT_LIB_H_ | |
#define REDFISH_CRT_LIB_H_ | |
#include <Library/BaseLib.h> | |
#include <Library/BaseMemoryLib.h> | |
#include <Library/DebugLib.h> | |
#include <Library/PrintLib.h> | |
#define MAX_STRING_SIZE 0x10000000 | |
// Minimum value for an object of type long long int. | |
#define LLONG_MIN MIN_INT64 | |
// Maximum value for an object of type long long int. | |
#define LLONG_MAX MAX_INT64 | |
// We dont support double on edk2 | |
#define HUGE_VAL 0 | |
#if defined(MDE_CPU_X64) || defined(MDE_CPU_AARCH64) || defined(MDE_CPU_RISCV64) | |
// | |
// With GCC we would normally use SIXTY_FOUR_BIT_LONG, but MSVC needs | |
// SIXTY_FOUR_BIT, because 'long' is 32-bit and only 'long long' is | |
// 64-bit. Since using 'long long' works fine on GCC too, just do that. | |
// | |
#define SIXTY_FOUR_BIT | |
#elif defined(MDE_CPU_IA32) || defined(MDE_CPU_ARM) || defined(MDE_CPU_EBC) | |
#define THIRTY_TWO_BIT | |
#endif | |
// | |
// Map all va_xxxx elements to VA_xxx defined in MdePkg/Include/Base.h | |
// | |
#if !defined(__CC_ARM) // if va_list is not already defined | |
#define va_list VA_LIST | |
#define va_arg VA_ARG | |
#define va_start VA_START | |
#define va_end VA_END | |
#else // __CC_ARM | |
#define va_start(Marker, Parameter) __va_start(Marker, Parameter) | |
#define va_arg(Marker, TYPE) __va_arg(Marker, TYPE) | |
#define va_end(Marker) ((void)0) | |
#endif | |
// | |
// Definitions for global constants used by CRT library routines | |
// | |
#define INT_MAX MAX_INT32 /* Maximum (signed) int value */ | |
#define LONG_MAX 0X7FFFFFFFL /* max value for a long */ | |
#define LONG_MIN (-LONG_MAX-1) /* min value for a long */ | |
#define ULONG_MAX 0xFFFFFFFF /* Maximum unsigned long value */ | |
#define CHAR_BIT 8 /* Number of bits in a char */ | |
// Maximum value for an object of type unsigned long long int. | |
#define ULLONG_MAX 0xFFFFFFFFFFFFFFFFULL // 2^64 - 1 | |
// Maximum value for an object of type unsigned char. | |
#define UCHAR_MAX 255 // 2^8 - 1 | |
// | |
// Basic types mapping | |
// | |
typedef UINTN size_t; | |
typedef INTN ssize_t; | |
typedef INT32 time_t; | |
typedef UINT8 __uint8_t; | |
typedef UINT8 sa_family_t; | |
typedef UINT32 uid_t; | |
typedef UINT32 gid_t; | |
typedef INT32 int32_t; | |
typedef UINT32 uint32_t; | |
typedef UINT16 uint16_t; | |
typedef UINT8 uint8_t; | |
typedef enum {false, true} bool; | |
// | |
// File operations are not required for EFI building, | |
// so FILE is mapped to VOID * to pass build | |
// | |
typedef VOID *FILE; | |
/** | |
This is the Redfish version of CRT snprintf function, this function replaces "%s" to | |
"%a" before invoking AsciiSPrint(). That is becasue "%s" is unicode base on edk2 | |
environment however "%s" is ascii code base on snprintf(). | |
See definitions of AsciiSPrint() for the details. | |
@param StartOfBuffer A pointer to the output buffer for the produced Null-terminated | |
ASCII string. | |
@param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer. | |
@param FormatString A Null-terminated ASCII format string. | |
@param ... Variable argument list whose contents are accessed based on the | |
format string specified by FormatString. | |
@return The number of ASCII characters in the produced output buffer not including the | |
Null-terminator. Zero means no string is produced or the error happens. | |
**/ | |
UINTN | |
EFIAPI | |
RedfishAsciiSPrint ( | |
OUT CHAR8 *StartOfBuffer, | |
IN UINTN BufferSize, | |
IN CONST CHAR8 *FormatString, | |
... | |
); | |
/** | |
This is the Redfish version of CRT vsnprintf function, this function replaces "%s" to | |
"%a" before invoking AsciiVSPrint(). That is because "%s" is unicode base on edk2 | |
environment however "%s" is ascii code base on vsnprintf(). | |
See definitions of AsciiVSPrint() for the details. | |
@param StartOfBuffer A pointer to the output buffer for the produced Null-terminated | |
ASCII string. | |
@param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer. | |
@param FormatString A Null-terminated ASCII format string. | |
@param Marker VA_LIST marker for the variable argument list. | |
@return The number of ASCII characters in the produced output buffer not including the | |
Null-terminator. | |
**/ | |
UINTN | |
EFIAPI | |
RedfishAsciiVSPrint ( | |
OUT CHAR8 *StartOfBuffer, | |
IN UINTN BufferSize, | |
IN CONST CHAR8 *FormatString, | |
IN VA_LIST Marker | |
); | |
// | |
// Global variables | |
// | |
extern int errno; | |
extern FILE *stderr; | |
// | |
// Function prototypes of CRT Library routines | |
// | |
void *malloc (size_t); | |
void *realloc (void *, size_t); | |
void *calloc (size_t Num, size_t Size); | |
void free (void *); | |
void *memset (void *, int, size_t); | |
int memcmp (const void *, const void *, size_t); | |
int isdigit (int); | |
int isspace (int); | |
int tolower (int); | |
int isupper (int); | |
int isxdigit (int); | |
int isalnum (int); | |
void *memcpy (void *, const void *, size_t); | |
void *memset (void *, int, size_t); | |
void *memchr (const void *, int, size_t); | |
int memcmp (const void *, const void *, size_t); | |
void *memmove (void *, const void *, size_t); | |
int strcmp (const char *, const char *); | |
int strncmp (const char *, const char *, size_t); | |
char *strcpy (char *, const char *); | |
size_t strlen (const char *); | |
char *strcat (char *, const char *); | |
char *strchr (const char *, int); | |
int strcasecmp (const char *, const char *); | |
int strncasecmp (const char *, const char *, size_t); | |
char *strncpy (char *, size_t, const char *, size_t); | |
int strncmp (const char *, const char *, size_t); | |
char *strrchr (const char *, int); | |
unsigned long strtoul (const char *, char **, int); | |
char * strstr (const char *s1 , const char *s2); | |
long strtol (const char *, char **, int); | |
char *strerror (int); | |
size_t strspn (const char *, const char *); | |
char * strdup (const char *str); | |
char * strpbrk (const char *s1, const char *s2); | |
unsigned long long strtoull(const char * nptr, char ** endptr, int base); | |
long long strtoll (const char * nptr, char ** endptr, int base); | |
long strtol (const char * nptr, char ** endptr, int base); | |
double strtod (const char * __restrict nptr, char ** __restrict endptr); | |
size_t strcspn (const char *, const char *); | |
int printf (const char *, ...); | |
int sscanf (const char *, const char *, ...); | |
FILE *fopen (const char *, const char *); | |
size_t fread (void *, size_t, size_t, FILE *); | |
size_t fwrite (const void *, size_t, size_t, FILE *); | |
int fclose (FILE *); | |
int fprintf (FILE *, const char *, ...); | |
int fgetc (FILE * _File); | |
uid_t getuid (void); | |
uid_t geteuid (void); | |
gid_t getgid (void); | |
gid_t getegid (void); | |
void qsort (void *, size_t, size_t, int (*)(const void *, const void *)); | |
char *getenv (const char *); | |
#if defined(__GNUC__) && (__GNUC__ >= 2) | |
void abort (void) __attribute__((__noreturn__)); | |
#else | |
void abort (void); | |
#endif | |
int toupper (int); | |
int Digit2Val (int); | |
time_t time (time_t *); | |
// | |
// Macros that directly map functions to BaseLib, BaseMemoryLib, and DebugLib functions | |
// | |
#define strcmp AsciiStrCmp | |
#define memcpy(dest,source,count) CopyMem(dest,source,(UINTN)(count)) | |
#define memset(dest,ch,count) SetMem(dest,(UINTN)(count),(UINT8)(ch)) | |
#define memchr(buf,ch,count) ScanMem8(buf,(UINTN)(count),(UINT8)ch) | |
#define memcmp(buf1,buf2,count) (int)(CompareMem(buf1,buf2,(UINTN)(count))) | |
#define memmove(dest,source,count) CopyMem(dest,source,(UINTN)(count)) | |
#define strlen(str) (size_t)(AsciiStrnLenS(str,MAX_STRING_SIZE)) | |
#define strcpy(strDest,strSource) AsciiStrCpyS(strDest,(strlen(strSource)+1),strSource) | |
#define strncpy(strDest,strSource,count) AsciiStrnCpyS(strDest,(UINTN)count,strSource,(UINTN)count) | |
#define strncpys(strDest, DestLen, strSource,count) AsciiStrnCpyS(strDest,DestLen,strSource,(UINTN)count) | |
#define strcat(strDest,strSource) AsciiStrCatS(strDest,(strlen(strSource)+strlen(strDest)+1),strSource) | |
#define strchr(str,ch) ScanMem8((VOID *)(str),AsciiStrSize(str),(UINT8)ch) | |
#define strcasecmp(str1,str2) (int)AsciiStriCmp(str1,str2) | |
#define strstr(s1,s2) AsciiStrStr(s1,s2) | |
#define snprintf(buf,len,...) RedfishAsciiSPrint(buf,len,__VA_ARGS__) | |
#define vsnprintf(buf,len,format,marker) RedfishAsciiVSPrint((buf),(len),(format),(marker)) | |
#define assert(expression) ASSERT(expression) | |
#define offsetof(type,member) OFFSET_OF(type,member) | |
#define EOF (-1) | |
extern int errno; | |
#define ERANGE 34 /* 34 Result too large */ | |
#endif |