bsl_sal.h

/*
 * This file is part of the openHiTLS project.
 *
 * openHiTLS is licensed under the Mulan PSL v2.
 * You can use this software according to the terms and conditions of the Mulan PSL v2.
 * You may obtain a copy of Mulan PSL v2 at:
 *
 *     http://license.coscl.org.cn/MulanPSL2
 *
 * THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND,
 * EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT,
 * MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
 * See the Mulan PSL v2 for more details.
 */

 
#ifndef BSL_SAL_H
#define BSL_SAL_H
 
#include <stdint.h>
#include <stdbool.h>
#include <stddef.h>
 
#ifdef __cplusplus
extern "C" {
#endif

#if defined(__linux__) || defined(__APPLE__) || defined(__unix__)
    #include <pthread.h>
    typedef pthread_once_t BSL_SAL_OnceControl;
    #define BSL_SAL_ONCE_INIT PTHREAD_ONCE_INIT
#else
    // Fallback for no threading support
    typedef struct {
        volatile int status;  // 0=not initialized, 1=initializing, 2=done
    } BSL_SAL_OnceControl;
    #define BSL_SAL_ONCE_INIT {0}
#endif
 
#define BSL_TIME_CMP_ERROR   0   /* The comparison between two dates is incorrect. */
#define BSL_TIME_CMP_EQUAL   1   /* The two dates are the same. */
#define BSL_TIME_DATE_BEFORE 2   /* The first date is earlier than the second date */
#define BSL_TIME_DATE_AFTER  3   /* The first date is later than the second date. */

typedef void *BSL_SAL_ThreadLockHandle;

typedef void *BSL_SAL_ThreadId;

typedef void *BSL_SAL_Mutex;

typedef void *BSL_SAL_CondVar;


typedef void (*BSL_SAL_ThreadInitRoutine)(void);

typedef int32_t (*BslThreadRunOnce)(BSL_SAL_OnceControl *onceControl, BSL_SAL_ThreadInitRoutine initFunc);

typedef int32_t (*BslThreadCreate)(BSL_SAL_ThreadId *thread, void *(*startFunc)(void *), void *arg);

typedef void (*BslThreadClose)(BSL_SAL_ThreadId thread);

typedef int32_t (*BslCreateCondVar)(BSL_SAL_CondVar *condVar);

typedef int32_t (*BslCondSignal)(BSL_SAL_CondVar condVar);

typedef int32_t (*BslCondTimedwaitMs)(BSL_SAL_Mutex condMutex, BSL_SAL_CondVar condVar, int32_t timeout);

typedef int32_t (*BslDeleteCondVar)(BSL_SAL_CondVar condVar);

void *BSL_SAL_Malloc(uint32_t size);

void *BSL_SAL_Calloc(uint32_t num, uint32_t size);

void *BSL_SAL_Dump(const void *src, uint32_t size);

void BSL_SAL_Free(void *value);

void *BSL_SAL_Realloc(void *addr, uint32_t newSize, uint32_t oldSize);

void BSL_SAL_CleanseData(void *ptr, uint32_t size);

void BSL_SAL_ClearFree(void *ptr, uint32_t size);
 
#define BSL_SAL_FREE(value_)                    \
    do {                                        \
        BSL_SAL_Free((void *)(value_));     \
        (value_) = NULL;                    \
    } while (0)

#define BSL_SAL_DECLARE_THREAD_ONCE(name) static BSL_SAL_OnceControl name = BSL_SAL_ONCE_INIT

int32_t BSL_SAL_ThreadLockNew(BSL_SAL_ThreadLockHandle *lock);

int32_t BSL_SAL_ThreadReadLock(BSL_SAL_ThreadLockHandle lock);

int32_t BSL_SAL_ThreadWriteLock(BSL_SAL_ThreadLockHandle lock);

int32_t BSL_SAL_ThreadUnlock(BSL_SAL_ThreadLockHandle lock);

void BSL_SAL_ThreadLockFree(BSL_SAL_ThreadLockHandle lock);

uint64_t BSL_SAL_ThreadGetId(void);

int32_t BSL_SAL_GetPid(void);

int32_t BSL_SAL_ThreadRunOnce(BSL_SAL_OnceControl *onceControl, BSL_SAL_ThreadInitRoutine initFunc);

int32_t BSL_SAL_ThreadCreate(BSL_SAL_ThreadId *thread, void *(*startFunc)(void *), void *arg);

void BSL_SAL_ThreadClose(BSL_SAL_ThreadId thread);

int32_t BSL_SAL_CreateCondVar(BSL_SAL_CondVar *condVar);

int32_t BSL_SAL_CondSignal(BSL_SAL_CondVar condVar);

int32_t BSL_SAL_CondTimedwaitMs(BSL_SAL_Mutex condMutex, BSL_SAL_CondVar condVar, int32_t timeout);

int32_t BSL_SAL_DeleteCondVar(BSL_SAL_CondVar condVar);
 
typedef void *bsl_sal_file_handle; // Pointer to file handle

int32_t BSL_SAL_FileOpen(bsl_sal_file_handle *stream, const char *path, const char *mode);

void BSL_SAL_FileClose(bsl_sal_file_handle stream);

int32_t BSL_SAL_FileRead(bsl_sal_file_handle stream, void *buffer, size_t size, size_t num, size_t *len);

int32_t BSL_SAL_FileWrite(bsl_sal_file_handle stream, const void *buffer, size_t size, size_t num);

int32_t BSL_SAL_FileLength(const char *path, size_t *len);

typedef struct {
    uint16_t year;      
    uint8_t  month;     
    uint8_t  day;       
    uint8_t  hour;      
    uint8_t  minute;    
    uint16_t millSec;   
    uint8_t  second;    
    uint16_t microSec;  
} BSL_TIME;

typedef int64_t BslUnixTime;

typedef BslUnixTime (*BslTimeFunc)(void);

void BSL_SAL_SysTimeFuncReg(BslTimeFunc func);

int32_t BSL_SAL_DateTimeCompare(const BSL_TIME *dateA, const BSL_TIME *dateB, int64_t *diffSec);

int32_t BSL_SAL_SysTimeGet(BSL_TIME *sysTime);

BslUnixTime BSL_SAL_CurrentSysTimeGet(void);

int32_t BSL_SAL_DateToUtcTimeConvert(const BSL_TIME *dateTime, int64_t *utcTime);

int32_t BSL_SAL_UtcTimeToDateConvert(int64_t utcTime, BSL_TIME *sysTime);

int32_t BSL_SAL_DateTimeCompareByUs(const BSL_TIME *dateA, const BSL_TIME *dateB);

void BSL_SAL_Sleep(uint32_t time);

long BSL_SAL_Tick(void);

long BSL_SAL_TicksPerSec(void);

uint64_t BSL_SAL_TIME_GetNSec(void);

typedef void *BSL_SAL_SockAddr;
 

typedef int32_t (*BslSalSockAddrNew)(BSL_SAL_SockAddr *sockAddr);

typedef void (*BslSalSockAddrFree)(BSL_SAL_SockAddr sockAddr);
 
#define SAL_NET_SEEK_SET        0
#define SAL_NET_SEEK_CUR        1
#define SAL_NET_SEEK_END        2
 
#define SAL_NET_IPV4            2   /* IPv4 Internet protocols */
#define SAL_NET_IPV6            10  /* IPv6 Internet protocols */
#define SAL_NET_IPUNIX          1   /* UNIX domain socket */
#define SAL_NET_IPANY           0   /* Any protocol */
 
#define SAL_NET_SOCK_STREAM     1
#define SAL_NET_SOCK_DGRAM      2
#define SAL_NET_SOCK_ALL        0   /* Indicates both SAL_NET_SOCK_STREAM and SAL_NET_SOCK_DGRAM. */
 
#define SAL_NET_IPPROTO_IP      0   /* IPV4 level, It is used in conjunction with the SAL_NET_SOL_* option. */
#define SAL_NET_IPPROTO_IPV6    41  /* IPV6 level, It is used in conjunction with the SAL_NET_IPV6_* option. */
#define SAL_NET_IPPROTO_TCP     6   /* It is used in conjunction with the SAL_NET_TCP_* option. */
#define SAL_NET_IPPROTO_UDP     17
#define SAL_NET_IPPROTO_SCTP    132
#define SAL_NET_IPPROTO_UNSPEC  0
#define SAL_NET_SOL_SOCKET      1   /* It is used in conjunction with the SAL_NET_SO_* option. */
 
#define SAL_NET_SO_REUSEADDR    2
#define SAL_NET_SO_KEEPALIVE    9
#define SAL_NET_SO_ERROR        4
#define SAL_NET_TCP_NODELAY     1
#define SAL_NET_IPV6_V6ONLY     26
#define SAL_NET_IP_MTU          14 /* Retrive the current known path MTU of the current socket. */
#define SAL_NET_IPV6_MTU        24 /* Retrive the current known path MTU of the current socket for IPV6. */
 
#define SAL_IPV4 2 /* IPv4 Internet protocols */
#define SAL_IPV6 10 /* IPv6 Internet protocols */

typedef int32_t (*BslSalSockAddrGetFamily)(const BSL_SAL_SockAddr sockAddr);

typedef uint32_t (*BslSalSockAddrSize)(const BSL_SAL_SockAddr sockAddr);

typedef void (*BslSalSockAddrCopy)(BSL_SAL_SockAddr dst, const BSL_SAL_SockAddr src);

int32_t BSL_SAL_Socket(int32_t af, int32_t type, int32_t protocol);

int32_t BSL_SAL_SockClose(int32_t sockId);

int32_t BSL_SAL_SetSockopt(int32_t sockId, int32_t level, int32_t name, const void *val, int32_t len);
 
#define SAL_PROTO_IP_LEVEL 0 /* IPv4 level */
#define SAL_PROTO_IPV6_LEVEL 41 /* IPv6 level */
#define SAL_MTU_OPTION 14  /* Retrieve the current known path MTU of the current socket */
#define SAL_IPV6_MTU_OPTION 24 /* Retrieve the current known path MTU of the current socket for IPv6 */
int32_t BSL_SAL_GetSockopt(int32_t sockId, int32_t level, int32_t name, void *val, int32_t *len);

int32_t BSL_SAL_SockListen(int32_t sockId, int32_t backlog);

int32_t BSL_SAL_SockBind(int32_t sockId, BSL_SAL_SockAddr addr, size_t len);

int32_t BSL_SAL_SockConnect(int32_t sockId, BSL_SAL_SockAddr addr, size_t len);

int32_t BSL_SAL_SockSend(int32_t sockId, const void *msg, size_t len, int32_t flags);

int32_t BSL_SAL_SockRecv(int32_t sockfd, void *buff, size_t len, int32_t flags);
 
typedef enum {
    BSL_SAL_MEM_MALLOC = 0x0100,
    BSL_SAL_MEM_FREE,
 
    BSL_SAL_THREAD_LOCK_NEW_CB_FUNC = 0x0200,
    BSL_SAL_THREAD_LOCK_FREE_CB_FUNC,
    BSL_SAL_THREAD_LOCK_READ_LOCK_CB_FUNC,
    BSL_SAL_THREAD_LOCK_WRITE_LOCK_CB_FUNC,
    BSL_SAL_THREAD_LOCK_UNLOCK_CB_FUNC,
    BSL_SAL_THREAD_GET_ID_CB_FUNC,
    BSL_SAL_THREAD_RUN_ONCE_CB_FUNC,
    BSL_SAL_THREAD_CREATE_CB_FUNC,
    BSL_SAL_THREAD_CLOSE_CB_FUNC,
    BSL_SAL_THREAD_CONDVAR_CREATE_LOCK_CB_FUNC,
    BSL_SAL_THREAD_CONDVAR_SIGNAL_CB_FUNC,
    BSL_SAL_THREAD_CONDVAR_WAIT_CB_FUNC,
    BSL_SAL_THREAD_CONDVAR_DELETE_CB_FUNC,
 
    BSL_SAL_NET_WRITE_CB_FUNC = 0x0300,                 /* BslSalNetWrite */
    BSL_SAL_NET_READ_CB_FUNC,                           /* BslSalNetRead */
    BSL_SAL_NET_SOCK_CB_FUNC,                           /* BslSalSocket */
    BSL_SAL_NET_SOCK_CLOSE_CB_FUNC,                     /* BslSalSockClose */
    BSL_SAL_NET_SET_SOCK_OPT_CB_FUNC,                   /* BslSalSetSockopt */
    BSL_SAL_NET_GET_SOCK_OPT_CB_FUNC,                   /* BslSalGetSockopt */
    BSL_SAL_NET_SOCK_LISTEN_CB_FUNC,                    /* BslSalSockListen */
    BSL_SAL_NET_SOCK_BIND_CB_FUNC,                      /* BslSalSockBind  */
    BSL_SAL_NET_SOCK_CONNECT_CB_FUNC,                   /* BslSalSockConnect */
    BSL_SAL_NET_SOCK_SEND_CB_FUNC,                      /* BslSalSockSend */
    BSL_SAL_NET_SOCK_RECV_CB_FUNC,                      /* BslSalSockRecv */
    BSL_SAL_NET_SELECT_CB_FUNC,                         /* BslSelect */
    BSL_SAL_NET_IOCTL_CB_FUNC,                          /* BslIoctlSocket */
    BSL_SAL_NET_GET_ERRNO_CB_FUNC,                      /* BslGetErrno */
    BSL_SAL_NET_SOCKADDR_NEW_CB_FUNC,                   /* BslSalSockAddrNew */
    BSL_SAL_NET_SOCKADDR_FREE_CB_FUNC,                  /* BslSalSockAddrFree */
    BSL_SAL_NET_SOCKADDR_SIZE_CB_FUNC,                  /* BslSalSockAddrSize */
    BSL_SAL_NET_SOCKADDR_COPY_CB_FUNC,                  /* BslSalSockAddrCopy */
    BSL_SAL_NET_SENDTO_CB_FUNC,                         /* BslSalNetSendTo */
    BSL_SAL_NET_RECVFROM_CB_FUNC,                       /* BslSalNetRecvFrom */
    BSL_SAL_NET_GETFAMILY_CB_FUNC,                      /* BslSalSockAddrGetFamily */
 
    BSL_SAL_TIME_GET_UTC_TIME_CB_FUNC = 0X0400,
    BSL_SAL_TIME_GET_BSL_TIME_CB_FUNC,                  /* BslGetBslTime */
    BSL_SAL_TIME_UTC_TO_BSL_TIME_CB_FUNC,               /* BslUtcTimeToBslTime */
    BSL_SAL_TIME_SLEEP_CB_FUNC,
    BSL_SAL_TIME_TICK_CB_FUNC,
    BSL_SAL_TIME_TICK_PER_SEC_CB_FUNC,
    BSL_SAL_TIME_GET_TIME_IN_NS,
 
    BSL_SAL_FILE_OPEN_CB_FUNC = 0X0500,                 /* BslSalFileOpen */
    BSL_SAL_FILE_READ_CB_FUNC,                          /* BslSalFileRead */
    BSL_SAL_FILE_WRITE_CB_FUNC,                         /* BslSalFileWrite */
    BSL_SAL_FILE_CLOSE_CB_FUNC,                         /* BslSalFileClose */
    BSL_SAL_FILE_LENGTH_CB_FUNC,                        /* BslSalFileLength */
    BSL_SAL_FILE_ERROR_CB_FUNC,                         /* BslSalFileError */
    BSL_SAL_FILE_TELL_CB_FUNC,                          /* BslSalFileTell */
    BSL_SAL_FILE_SEEK_CB_FUNC,                          /* BslSalFileSeek */
    BSL_SAL_FILE_GETS_CB_FUNC,                          /* BslSalFGets */
    BSL_SAL_FILE_PUTS_CB_FUNC,                          /* BslSalFPuts */
    BSL_SAL_FILE_FLUSH_CB_FUNC,                         /* BslSalFlush */
    BSL_SAL_FILE_EOF_CB_FUNC,                           /* BslSalFeof */
    BSL_SAL_FILE_SET_ATTR_FUNC,                         /* BslSalFSetAttr */
    BSL_SAL_FILE_GET_ATTR_FUNC,                         /* BslSalFGetAttr */
 
    BSL_SAL_DL_OPEN_CB_FUNC = 0x0700,
    BSL_SAL_DL_CLOSE_CB_FUNC,
    BSL_SAL_DL_SYM_CB_FUNC,
 
    BSL_SAL_PID_GET_ID_CB_FUNC = 0x0800,
 
    BSL_SAL_MAX_FUNC_CB = 0xffff
} BSL_SAL_CB_FUNC_TYPE;


typedef int32_t (*BslSalNetWrite)(int32_t fd, const void *buf, uint32_t len, int32_t *err);

typedef int32_t (*BslSalNetRead)(int32_t fd, void *buf, uint32_t len, int32_t *err);

typedef int64_t (*BslSalNetLSeek)(int32_t fd, int64_t offset, uint32_t origin);

typedef int32_t (*BslSalNetOpen)(const char *path, int32_t flag);

typedef int32_t (*BslSalNetClose)(int32_t fd);

typedef int32_t (*BslSalSocket)(int32_t af, int32_t type, int32_t protocol);

typedef int32_t (*BslSalSockClose)(int32_t sockId);

typedef int32_t (*BslSalSetSockopt)(int32_t sockId, int32_t level, int32_t name, const void *val, int32_t len);

typedef int32_t (*BslSalGetSockopt)(int32_t sockId, int32_t level, int32_t name, void *val, int32_t *len);

typedef int32_t (*BslSalGetSockName)(int32_t sockId, BSL_SAL_SockAddr addr, size_t *len);

typedef int32_t (*BslSalSockListen)(int32_t sockId, int32_t backlog);

typedef int32_t (*BslSalSockBind)(int32_t sockId, BSL_SAL_SockAddr addr, size_t len);

typedef int32_t (*BslSalSockConnect)(int32_t sockId, BSL_SAL_SockAddr addr, size_t len);

typedef int32_t (*BslSalSockAccept)(int32_t sockId, BSL_SAL_SockAddr addr, size_t *len);

typedef int32_t (*BslSalSockSend)(int32_t sockId, const void *msg, size_t len, int32_t flags);

typedef int32_t (*BslSalSockRecv)(int32_t sockfd, void *buff, size_t len, int32_t flags);

typedef int32_t (*BslSalNetSendTo)(int32_t sock, const void *buf, size_t len, int32_t flags, void *address,
    int32_t addrLen, int32_t *err);

typedef int32_t (*BslSalNetRecvFrom)(int32_t sock, void *buf, size_t len, int32_t flags, void *address,
    int32_t *addrLen, int32_t *err);

typedef int32_t (*BslSelect)(int32_t nfds, void *readfds, void *writefds, void *exceptfds, void *timeout);

typedef int32_t (*BslIoctlSocket)(int32_t sockId, long cmd, unsigned long *arg);

typedef int32_t (*BslGetErrno)(void);

typedef int32_t (*BslSetBlockMode)(int32_t fd, int32_t isBlock);

typedef int32_t (*BslSocketWait)(int32_t fd, int32_t forRead, int64_t maxTime);

typedef int32_t (*BslSocketError)(int32_t fd);


typedef BslUnixTime (*BslGetUtcTime)(void);

typedef int32_t (*BslGetBslTime)(BSL_TIME *bslTime);

typedef int32_t (*BslUtcTimeToBslTime)(int64_t utcTime, BSL_TIME *sysTime);

typedef void (*BslSleep)(uint32_t time);

typedef long (*BslTick)(void);

typedef long (*BslTicksPerSec)(void);

typedef uint64_t (*BslGetTimeInNS)(void);


typedef int32_t (*BslSalFileOpen)(bsl_sal_file_handle *stream, const char *path, const char *mode);

typedef int32_t (*BslSalFileRead)(bsl_sal_file_handle stream, void *buffer, size_t size, size_t num, size_t *len);

typedef int32_t (*BslSalFileWrite)(bsl_sal_file_handle stream, const void *buffer, size_t size, size_t num);

typedef void (*BslSalFileClose)(bsl_sal_file_handle stream);

typedef int32_t (*BslSalFileLength)(const char *path, size_t *len);

typedef bool (*BslSalFileError)(bsl_sal_file_handle stream);

typedef int32_t (*BslSalFileTell)(bsl_sal_file_handle stream, long *pos);

typedef int32_t (*BslSalFileSeek)(bsl_sal_file_handle stream, long offset, int32_t origin);

typedef char *(*BslSalFGets)(bsl_sal_file_handle stream, char *buf, int32_t readLen);

typedef bool (*BslSalFPuts)(bsl_sal_file_handle stream, const char *buf);

typedef bool (*BslSalFlush)(bsl_sal_file_handle stream);

typedef int32_t (*BslSalFeof)(bsl_sal_file_handle stream);

typedef int32_t (*BslSalFSetAttr)(bsl_sal_file_handle stream, int cmd, const void *arg);

typedef int32_t (*BslSalFGetAttr)(bsl_sal_file_handle stream, void *arg);

typedef int32_t (*BslDlOpen)(const char *fileName, void **handle);

typedef int32_t (*BslDlClose)(void *handle);

typedef int32_t (*BslDlSym)(void *handle, const char *funcName, void **func);

int32_t BSL_SAL_CallBack_Ctrl(BSL_SAL_CB_FUNC_TYPE funcType, void *funcCb);

int32_t BSL_SAL_Select(int32_t nfds, void *readfds, void *writefds, void *exceptfds, void *timeout);

int32_t BSL_SAL_Ioctlsocket(int32_t sockId, long cmd, unsigned long *arg);

int32_t BSL_SAL_SockGetLastSocketError(void);

int32_t BSL_SAL_StrcaseCmp(const char *str1, const char *str2);

void *BSL_SAL_Memchr(const char *str, int32_t character, size_t count);

int32_t BSL_SAL_Atoi(const char *str);

uint32_t BSL_SAL_Strnlen(const char *string, uint32_t count);

int32_t BSL_SAL_LoadLib(const char *fileName, void **handle);

int32_t BSL_SAL_UnLoadLib(void *handle);

int32_t BSL_SAL_GetFuncAddress(void *handle, const char *funcName, void **func);
 
// Define command enumeration
typedef enum {
    BSL_SAL_LIB_FMT_OFF = 0, /* Do not enable named conversion */
    BSL_SAL_LIB_FMT_SO = 1,
    BSL_SAL_LIB_FMT_LIBSO = 2,
    BSL_SAL_LIB_FMT_LIBDLL = 3,
    BSL_SAL_LIB_FMT_DLL = 4
} BSL_SAL_LibFmtCmd;

int32_t BSL_SAL_LibNameFormat(BSL_SAL_LibFmtCmd cmd, const char *fileName, char **name);

typedef int32_t (*BslSalLoadLib)(const char *fileName, void **handle);

typedef int32_t (*BslSalUnLoadLib)(void *handle);

typedef int32_t (*BslSalGetFunc)(void *handle, const char *funcName, void **func);
 
#ifdef __cplusplus
}
#endif
 
#endif // BSL_SAL_H