Files
microser/include/obs_sdk/securec.h

233 lines
8.9 KiB
C
Raw Permalink Normal View History

2025-01-16 16:17:01 +08:00
/*********************************************************************************
* Copyright 2019 Huawei Technologies Co.,Ltd.
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use
* this file except in compliance with the License. You may obtain a copy of the
* License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed
* under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the
* specific language governing permissions and limitations under the License.
**********************************************************************************
*/
#ifndef __SECUREC_H__5D13A042_DC3F_4ED9_A8D1_882811274C27
#define __SECUREC_H__5D13A042_DC3F_4ED9_A8D1_882811274C27
/* If you need high performance, enable the WITH_PERFORMANCE_ADDONS macro! */
#define WITH_PERFORMANCE_ADDONS
#include "securectype.h" /*lint !e537*/
#include <stdarg.h>
/* If stack size on some embedded platform is limited, you can define the following macro
* which will put some variables on heap instead of stack.
#define STACK_SIZE_LESS_THAN_1K
*/
/* for performance consideration, the following macro will call the corresponding API
* of libC for memcpy, memmove and memset
*/
#define CALL_LIBC_COR_API
/* codes should run under the macro COMPATIBLE_LINUX_FORMAT in unknow system on default,
and strtold. The function
strtold is referenced first at ISO9899:1999(C99), and some old compilers can
not support these functions. Here provides a macro to open these functions:
SECUREC_SUPPORT_STRTOLD -- if defined, strtold will be used
*/
/*define error code*/
#ifndef errno_t
typedef int errno_t;
#endif
/* success */
#ifndef EOK
#define EOK (0)
#endif
/* invalid parameter */
#ifdef EINVAL
#undef EINVAL
#endif
#define EINVAL (22)
#define EINVAL_AND_RESET (22 | 0X80)
/* invalid parameter range */
#ifdef ERANGE
#undef ERANGE /* to avoid redefinition */
#endif
#define ERANGE (34)
#define ERANGE_AND_RESET (34 | 0X80)
/* A wide-character code has been detected that does not correspond to a
* valid character, or a byte sequence does not form a valid wide-character code
*/
#ifdef EILSEQ
#undef EILSEQ
#endif
#define EILSEQ (42)
#ifdef EOVERLAP_AND_RESET
#undef EOVERLAP_AND_RESET
#endif
/*Once the buffer overlap is detected, the dest buffer must be reseted! */
#define EOVERLAP_AND_RESET (54 | 0X80)
/*if you need export the function of this library in Win32 dll, use __declspec(dllexport) */
#ifdef WIN32
#ifndef USE_STATIC_HUAWEI_SECURE_C
#ifdef HUAWEISECUREC_WXPORTS
#define HUAWEISECUREC_API __declspec(dllexport)
#else
#define HUAWEISECUREC_API __declspec(dllimport)
#endif
#else
#define HUAWEISECUREC_API
#endif // !USE_STATIC_HUAWEI_SECURE_C
#else
#define HUAWEISECUREC_API
#endif//WIN32
#ifdef __cplusplus
extern "C"
{
#endif
/* memset function*/
errno_t HUAWEISECUREC_API memset_s(void* dest, size_t destMax, int c, size_t count);
#if defined __GNUC__ || defined LINUX
/* memcpy function*/
errno_t memcpy_s(void* dest, size_t destMax, const void* src, size_t count);
/* return SecureC Version */
void getHwSecureCVersion(char* verStr, int bufSize, unsigned short* verNumber);
/* wmemcpy */
errno_t wmemcpy_s(wchar_t* dest, size_t destMax, const wchar_t* src, size_t count);
/* memmove */
errno_t memmove_s(void* dest, size_t destMax, const void* src, size_t count);
errno_t wmemmove_s(wchar_t* dest, size_t destMax, const wchar_t* src, size_t count);
errno_t wcscpy_s(wchar_t* strDest, size_t destMax, const wchar_t* strSrc);
errno_t wcsncpy_s(wchar_t* strDest, size_t destMax, const wchar_t* strSrc, size_t count);
errno_t wcscat_s(wchar_t* strDest, size_t destMax, const wchar_t* strSrc);
errno_t wcsncat_s(wchar_t* strDest, size_t destMax, const wchar_t* strSrc, size_t count);
/* strtok */
char* strtok_s(char* strToken, const char* strDelimit, char** context);
wchar_t* wcstok_s(wchar_t* strToken, const wchar_t* strDelimit, wchar_t** context);
/* sprintf */
int sprintf_s(char* strDest, size_t destMax, const char* format, ...) SECUREC_ATTRIBUTE(3,4);
int swprintf_s(wchar_t* strDest, size_t destMax, const wchar_t* format, ...);
/* vsprintf */
int vsprintf_s(char* strDest, size_t destMax, const char* format, va_list argptr) SECUREC_ATTRIBUTE(3,0);
int vswprintf_s(wchar_t* strDest, size_t destMax, const wchar_t* format, va_list argptr);
int vsnprintf_s(char* strDest, size_t destMax, size_t count, const char* format, va_list arglist) SECUREC_ATTRIBUTE(4,0);
/* snprintf */
int snprintf_s(char* strDest, size_t destMax, size_t count, const char* format, ...) SECUREC_ATTRIBUTE(4,5);
/* scanf */
int scanf_s(const char* format, ...);
int wscanf_s(const wchar_t* format, ...);
/* vscanf */
int vscanf_s(const char* format, va_list arglist);
int vwscanf_s(const wchar_t* format, va_list arglist);
/* fscanf */
int fscanf_s(FILE* stream, const char* format, ...);
int fwscanf_s(FILE* stream, const wchar_t* format, ...);
/* vfscanf */
int vfscanf_s(FILE* stream, const char* format, va_list arglist);
int vfwscanf_s(FILE* stream, const wchar_t* format, va_list arglist);
/* sscanf */
int sscanf_s(const char* buffer, const char* format, ...);
int swscanf_s(const wchar_t* buffer, const wchar_t* format, ...);
/* vsscanf */
int vsscanf_s(const char* buffer, const char* format, va_list argptr);
int vswscanf_s(const wchar_t* buffer, const wchar_t* format, va_list arglist);
/* gets */
char* gets_s(char* buffer, size_t destMax);
/* strcpy */
errno_t strcpy_s(char* strDest, size_t destMax, const char* strSrc);
/* strncpy */
errno_t strncpy_s(char* strDest, size_t destMax, const char* strSrc, size_t count);
/* strcat */
errno_t strcat_s(char* strDest, size_t destMax, const char* strSrc);
/* strncat */
errno_t strncat_s(char* strDest, size_t destMax, const char* strSrc, size_t count);
errno_t strncpy_error(char* strDest, size_t destMax, const char* strSrc, size_t count);
errno_t strcpy_error(char* strDest, size_t destMax, const char* strSrc);
#if defined(WITH_PERFORMANCE_ADDONS)
/* those functions are used by macro */
errno_t memset_sOptTc(void* dest, size_t destMax, int c, size_t count);
errno_t memcpy_sOptTc(void* dest, size_t destMax, const void* src, size_t count);
/* strcpy_sp is a macro, NOT a function in performance optimization mode. */
#define strcpy_sp(dest, destMax, src) /*lint -save -e506 -e1055 */ (( __builtin_constant_p((destMax)) && __builtin_constant_p((src))) ? \
STRCPY_SM((dest), (destMax), (src)) : strcpy_s((dest), (destMax), (src)) ) /*lint -restore */
/* strncpy_sp is a macro, NOT a function in performance optimization mode. */
#define strncpy_sp(dest, destMax, src, count) /*lint -save -e506 -e1055 */ ((__builtin_constant_p((count)) && __builtin_constant_p((destMax)) && __builtin_constant_p((src))) ? \
STRNCPY_SM((dest), (destMax), (src), (count)) : strncpy_s((dest), (destMax), (src), (count)) ) /*lint -restore */
/* strcat_sp is a macro, NOT a function in performance optimization mode. */
#define strcat_sp(dest, destMax, src) /*lint -save -e506 -e1055 */ (( __builtin_constant_p((destMax)) && __builtin_constant_p((src))) ? \
STRCAT_SM((dest), (destMax), (src)) : strcat_s((dest), (destMax), (src)) ) /*lint -restore */
/* strncat_sp is a macro, NOT a function in performance optimization mode. */
#define strncat_sp(dest, destMax, src, count) /*lint -save -e506 -e1055 */ ((__builtin_constant_p((count)) && __builtin_constant_p((destMax)) && __builtin_constant_p((src))) ? \
STRNCAT_SM((dest), (destMax), (src), (count)) : strncat_s((dest), (destMax), (src), (count)) ) /*lint -restore */
/* memcpy_sp is a macro, NOT a function in performance optimization mode. */
#define memcpy_sp(dest, destMax, src, count) /*lint -save -e506 -e1055 */ (__builtin_constant_p((count)) ? (MEMCPY_SM((dest), (destMax), (src), (count))) : \
(__builtin_constant_p((destMax)) ? (((size_t)(destMax) > 0 && (((UINT64T)(destMax) & (UINT64T)(-2)) < SECUREC_MEM_MAX_LEN)) ? memcpy_sOptTc((dest), (destMax), (src), (count)) : ERANGE ) : memcpy_s((dest), (destMax), (src), (count)))) /*lint -restore */
/* memset_sp is a macro, NOT a function in performance optimization mode. */
#define memset_sp(dest, destMax, c, count) /*lint -save -e506 -e1055 */ (__builtin_constant_p((count)) ? (MEMSET_SM((dest), (destMax), (c), (count))) : \
(__builtin_constant_p((destMax)) ? (((size_t)(destMax) > 0 && (((UINT64T)(destMax) & (UINT64T)(-2)) < SECUREC_MEM_MAX_LEN)) ? memset_sOptTc((dest), (destMax), (c), (count)) : ERANGE ) : memset_s((dest), (destMax), (c), (count)))) /*lint -restore */
#endif
#else
#endif
#ifdef __cplusplus
}
#endif /* __cplusplus */
#endif/* __SECUREC_H__5D13A042_DC3F_4ED9_A8D1_882811274C27 */