bsl_uio.h

浏览该文件的文档.

/*---------------------------------------------------------------------------------------------
 *  This file is part of the openHiTLS project.
 *  Copyright © 2023 Huawei Technologies Co.,Ltd. All rights reserved.
 *  Licensed under the openHiTLS Software license agreement 1.0. See LICENSE in the project root
 *  for license information.
 *---------------------------------------------------------------------------------------------
 */
 
#ifndef BSL_UIO_H
#define BSL_UIO_H
 
#include <stddef.h>
#include <stdint.h>
#include <stdbool.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct UIO_ControlBlock BSL_UIO;
 
typedef struct {
    size_t length;
    char *data;
    size_t max;
} BSL_UIO_BufMem;
 
typedef void (*BSL_UIO_USERDATA_FREE_FUNC)(void *);
 
typedef enum {
    BSL_UIO_TCP,
    BSL_UIO_SCTP,
    BSL_UIO_BUFFER,
    BSL_UIO_UNKNOWN, /* Unknown protocol should not appear */
 
    BSL_UIO_EXTEND = 10000, /* extension value */
} BSL_UIO_TransportType;
 
typedef struct {
    uint16_t shareKeyId;
    uint16_t authKeySize;
    const uint8_t *authKey;
} BSL_UIO_SctpAuthKey;
 
typedef enum {
    /* The cmd(0-0x99) used by the abstraction layer and the uio
     * implemented by the user cannot reuse these values. */
    BSL_UIO_GET_INIT = 0x0,
    BSL_UIO_GET_WRITE_NUM,
    BSL_UIO_GET_READ_NUM,
 
    /* Public use 0x100 */
    BSL_UIO_SET_PEER_IP_ADDR = 0x100,
    BSL_UIO_GET_PEER_IP_ADDR,
    BSL_UIO_SET_FD,
    BSL_UIO_GET_FD,
    BSL_UIO_FLUSH,
    BSL_UIO_RESET,
 
    /* SCTP uses 0x3XX */
    BSL_UIO_SCTP_CHECK_PEER_AUTH = 0x300,
    BSL_UIO_SCTP_ADD_AUTH_SHARED_KEY,
    BSL_UIO_SCTP_ACTIVE_AUTH_SHARED_KEY,
    BSL_UIO_SCTP_DEL_PRE_AUTH_SHARED_KEY,
    BSL_UIO_SCTP_SND_BUFF_IS_EMPTY,
    BSL_UIO_SCTP_GET_SEND_STREAM_ID,
    BSL_UIO_SCTP_SET_APP_STREAM_ID,
    BSL_UIO_SCTP_MARK_APP_MESSAGE,
} BSL_UIO_CtrlParameter;
 
#define BSL_UIO_FILE_READ             0x02
#define BSL_UIO_FILE_WRITE            0x04
#define BSL_UIO_FILE_APPEND           0x08
#define BSL_UIO_FILE_TEXT             0x10
 
#define BSL_UIO_FLAGS_READ          0x01
#define BSL_UIO_FLAGS_WRITE         0x02
#define BSL_UIO_FLAGS_IO_SPECIAL    0x04
#define BSL_UIO_FLAGS_RWS (BSL_UIO_FLAGS_READ | BSL_UIO_FLAGS_WRITE | BSL_UIO_FLAGS_IO_SPECIAL)
#define BSL_UIO_FLAGS_SHOULD_RETRY  0x08
 
#define BSL_UIO_FLAGS_MEM_READ_ONLY      0x10 /* This flag can be set only by uio_mem */
 
#define BSL_UIO_FLAGS_BASE64_NO_NEWLINE  0x20
#define BSL_UIO_FLAGS_BASE64_PEM         0x40
 
 
typedef struct {
    uint8_t *addr;
    uint32_t size;
} BSL_UIO_CtrlGetPeerIpAddrParam;
 
typedef int32_t (*BslUioWriteCb)(BSL_UIO *uio, const void *buf, uint32_t len, uint32_t *writeLen);
typedef int32_t (*BslUioReadCb)(BSL_UIO *uio, void *buf, uint32_t len, uint32_t *readLen);
typedef int32_t (*BslUioCtrlCb)(BSL_UIO *uio, int32_t cmd, int32_t larg, void *parg);
typedef int32_t (*BslUioCreateCb)(BSL_UIO *uio);
typedef int32_t (*BslUioDestroyCb)(BSL_UIO *uio);
typedef int32_t (*BslUioPutsCb)(BSL_UIO *uio, const char *buf, uint32_t *writeLen);
typedef int32_t (*BslUioGetsCb)(BSL_UIO *uio, char *buf, uint32_t *readLen);
 
typedef struct BSL_UIO_MethodStruct BSL_UIO_Method;
 
typedef enum {
    BSL_UIO_CREATE_CB,
    BSL_UIO_DESTROY_CB,
    BSL_UIO_WRITE_CB,
    BSL_UIO_READ_CB,
    BSL_UIO_CTRL_CB,
    BSL_UIO_PUTS_CB,
    BSL_UIO_GETS_CB,
} BSL_UIO_METHOD_TYPE;
 
BSL_UIO_Method *BSL_UIO_NewMethod(void);
 
int32_t BSL_UIO_SetMethodType(BSL_UIO_Method *meth, int32_t type);
 
int32_t BSL_UIO_SetMethod(BSL_UIO_Method *meth, int32_t type, void *func);
 
void BSL_UIO_FreeMethod(BSL_UIO_Method *meth);
 
const BSL_UIO_Method *BSL_UIO_TcpMethod(void);
 
const BSL_UIO_Method *BSL_UIO_SctpMethod(void);
 
const BSL_UIO_Method *BSL_UIO_BufferMethod(void);
 
BSL_UIO *BSL_UIO_New(const BSL_UIO_Method *method);
 
void BSL_UIO_Free(BSL_UIO *uio);
 
int32_t BSL_UIO_Write(BSL_UIO *uio, const void *data, uint32_t len, uint32_t *writeLen);
 
int32_t BSL_UIO_Read(BSL_UIO *uio, void *data, uint32_t len, uint32_t *readLen);
 
int32_t BSL_UIO_Ctrl(BSL_UIO *uio, int32_t cmd, int32_t larg, void *parg);
 
int32_t BSL_UIO_Puts(BSL_UIO *uio, const char *buf, uint32_t *writeLen);
 
int32_t BSL_UIO_Gets(BSL_UIO *uio, char *buf, uint32_t *readLen);
 
int32_t BSL_UIO_GetTransportType(const BSL_UIO *uio);
 
int32_t BSL_UIO_SetUserData(BSL_UIO *uio, void *data);
 
int32_t BSL_UIO_SetUserDataFreeFunc(BSL_UIO *uio, BSL_UIO_USERDATA_FREE_FUNC userDataFreeFunc);
 
void *BSL_UIO_GetUserData(const BSL_UIO *uio);
 
bool BSL_UIO_GetIsUnderlyingClosedByUio(const BSL_UIO *uio);
 
void BSL_UIO_SetIsUnderlyingClosedByUio(BSL_UIO *uio, bool close);
 
const BSL_UIO_Method *BSL_UIO_GetMethod(const BSL_UIO *uio);
 
void *BSL_UIO_GetCtx(const BSL_UIO *uio);
 
void BSL_UIO_SetCtx(BSL_UIO *uio, void *ctx);
 
void BSL_UIO_SetFd(BSL_UIO *uio, int fd);
 
int32_t BSL_UIO_SetFlags(BSL_UIO *uio, uint32_t flags);
 
int32_t BSL_UIO_ClearFlags(BSL_UIO *uio, uint32_t flags);
 
uint32_t BSL_UIO_TestFlags(const BSL_UIO *uio, uint32_t flags, uint32_t *out);
 
int32_t BSL_UIO_UpRef(BSL_UIO *uio);
 
int32_t BSL_UIO_Append(BSL_UIO *uio, BSL_UIO *tail);
 
BSL_UIO *BSL_UIO_PopCurrent(BSL_UIO *uio);
 
void BSL_UIO_FreeChain(BSL_UIO *uio);
 
BSL_UIO *BSL_UIO_Next(BSL_UIO *uio);
 
void BSL_UIO_SetInit(BSL_UIO *uio, bool init);
 
#ifdef __cplusplus
}
#endif
 
#endif // BSL_UIO_H