bsl_uio.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_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 int32_t BSL_UIO_InfoCb(BSL_UIO *, int32_t, int32_t);
 
 
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 int32_t (*BslUioCbCtrlCb)(BSL_UIO *uio, int cmd, BSL_UIO_InfoCb *callback);
 
typedef struct BSL_UIO_MethodStruct BSL_UIO_Method;

typedef enum {
    BSL_UIO_TCP,
    BSL_UIO_UDP,
    BSL_UIO_SCTP,
    BSL_UIO_MEM,
    BSL_UIO_FILE,
    BSL_UIO_BUFFER,
    BSL_UIO_UNKNOWN, /* Unknown protocol should not appear */
 
    BSL_UIO_EXTEND = 10000, /* extension value */
} BSL_UIO_TransportType;
 
#define IS_TRANSTYPE_DATAGRAM(transportType) ((transportType) == BSL_UIO_SCTP || (transportType) == BSL_UIO_UDP)

typedef struct {
    uint16_t shareKeyId;
    uint16_t authKeySize;
    const uint8_t *authKey;
} BSL_UIO_SctpAuthKey;

typedef void (*BSL_UIO_USERDATA_FREE_FUNC)(void *);

typedef enum {
    /* The cmd(0-0x99) used by the abstraction layer and the uio
     * implemented by the user cannot reuse these values. */
 
    /* Public use 0x000 */
    /* larg equals the length of array, parg is a pointer type array */
    BSL_UIO_SET_PEER_IP_ADDR = 0x000,
    /* larg equals the length of BSL_UIO_CtrlGetPeerIpAddrParam structure,
     * parg is a pointer type BSL_UIO_CtrlGetPeerIpAddrParam
     */
    BSL_UIO_GET_PEER_IP_ADDR,
    /* larg equals the length of 32-bit integer, parg is a pointer type 32-bit integer */
    BSL_UIO_SET_FD,
    /* larg equals the length of 32-bit integer, parg is a pointer type 32-bit integer */
    BSL_UIO_GET_FD,
    /* larg equals the length of 64-bit integer, parg is a pointer type 64-bit integer */
    BSL_UIO_PENDING,
    /* not need to set larg and parg. the default values are 0 and null */
    BSL_UIO_FLUSH,
    /* larg equals the length of 64-bit integer, parg is a pointer type 64-bit integer */
    BSL_UIO_WPENDING,
    /* larg equals the length of 64-bit integer,  parg is a pointer type 64-bit integer */
    BSL_UIO_SEEK,
    /* not need to set larg and parg. the default values are 0 and null */
    BSL_UIO_RESET,
    /* larg equals the length of bool,  parg is a pointer type bool */
    BSL_UIO_GET_INIT,
    /* larg equals the length of 64-bit integer, parg is a pointer type 64-bit integer */
    BSL_UIO_GET_WRITE_NUM,
    /* larg equals the length of 64-bit integer, parg is a pointer type 64-bit integer */
    BSL_UIO_GET_READ_NUM,
    /* larg equals the length of 32-bit integer, parg is a pointer type 32-bit integer */
    BSL_UIO_GET_PTO_LEN,
    BSL_UIO_INFO,
    BIO_UIO_SET_CALLBACK,
    BSL_UIO_SET_CONNECT,
    BSL_UIO_GET_CONNECT,
    BSL_UIO_SET_NOBLOCK,
    BSL_UIO_DO_HANDSHAKE,
    BSL_UIO_SET_CTX,
    BSL_UIO_GET_CTX,
    BSL_UIO_SET_SSL_RENEGOTIATE_TIMEOUT,
    BSL_UIO_SET_SSL_RENEGOTIATE_BYTES,
    BSL_UIO_UDP_SET_CONNECTED,
    BSL_UIO_SET_BUFFER_SIZE,
    BSL_UIO_UDP_GET_MTU_OVERHEAD,
    BSL_UIO_UDP_QUERY_MTU,
    BSL_UIO_UDP_MTU_EXCEEDED,
    BSL_UIO_CIPHER_IS_FINISHED,
    BSL_UIO_SET_CONNECT_MODE,
    BSL_UIO_SET_ACCEPT,
    BSL_UIO_GET_ACCEPT,
    BSL_UIO_SET_BIND_MODE,
    BSL_UIO_GET_BIND_MODE,
    BSL_UIO_APPEND,
 
    /* 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_RECV_BUFF_IS_EMPTY,          
    BSL_UIO_SCTP_GET_SEND_STREAM_ID,
    /* larg equals the length of unsigned 16-bit integer, parg is a pointer type unsigned 16-bit integer */
    BSL_UIO_SCTP_SET_APP_STREAM_ID,
    /* larg equals the length of bool, parg is a pointer type bool */
    BSL_UIO_SCTP_MASK_APP_MESSAGE,
    /* larg is a func callback type BSL_UIO_METHOD_TYPE,  parg is a pointer type func callback */
    BSL_UIO_SCTP_SET_CALLBACK,
 
    /* MEMʹÓÃ0x4XX */
    /* larg equals the length of array, parg is a pointer type array */
    BSL_UIO_MEM_NEW_BUF = 0x400,
    /* larg equals the length of pointer, parg is a pointer's pointer type BSL_BufMem */
    BSL_UIO_MEM_GET_PTR,
    /* larg equals the length of 32-bit integer, parg is a pointer type 32-bit integer */
    BSL_UIO_MEM_SET_EOF,
    /* larg equals the length of 32-bit integer, parg is a pointer type 32-bit integer */
    BSL_UIO_MEM_GET_EOF,
    /* larg equals the length of BSL_UIO_CtrlGetInfoParam,  parg is a pointer type BSL_UIO_CtrlGetInfoParam */
    BSL_UIO_MEM_GET_INFO,
 
    /* FILEʹÓÃ0x5xx */
    /* larg is the mode for opening a file, parg is a pointer type string */
    BSL_UIO_FILE_OPEN = 0x500,
    /* larg is of the Boolean type and is used to indicate whether the handle is closed with the release of uio,
     * parg is a pointer type file */
    BSL_UIO_FILE_PTR,
    BSL_UIO_FILE_GET_EOF,
    BSL_UIO_FILE_SEEK,
    BSL_UIO_FILE_TELL,
    BSL_UIO_FILE_GET_PTR,
 
    /* FDʹÓÃ0x6xx */
    /* larg equals the length of 64-bit integer, parg is a pointer type 64-bit integer */
 
    BSL_UIO_FD_GET_INFO = 0x600,
 
    /* Pair uses 0x7xx */
    BSL_UIO_PAIR_MAKE = 0x700,
    BSL_UIO_PAIR_SET_BUFFER_SIZE,
    BSL_UIO_PAIR_GET_BUFFER_SIZE,
 
    /* TTO uses 0x8xx */
    BSL_UIO_TTO_SET_READ_CB = 0x800,
    BSL_UIO_TTO_SET_WRITE_CB,
    BSL_UIO_TTO_SET_READ_APP_DATA,
    BSL_UIO_TTO_SET_WRITE_APP_DATA,
 
    /* DTO uses 0x10xx */
    BSL_UIO_DTO_SET_KEY = 0x1001,
    BSL_UIO_DTO_SET_EPOCH_SEQUENCE,
} BSL_UIO_CtrlParameter;
 
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;
 
typedef struct {
    uint8_t *addr;
    uint32_t size;
} BSL_UIO_CtrlGetPeerIpAddrParam;
 
#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
 
 

BSL_UIO_Method *BSL_UIO_NewMethod(void);

int32_t BSL_UIO_SetMethodType(BSL_UIO_Method *meth, BSL_UIO_TransportType 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_MemMethod(void);

const BSL_UIO_Method *BSL_UIO_FileMethod(void);

const BSL_UIO_Method *BSL_UIO_SctpMethod(void);

const BSL_UIO_Method *BSL_UIO_TcpMethod(void);

const BSL_UIO_Method *BSL_UIO_UdpMethod(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);

void BSL_UIO_SetInit(BSL_UIO *uio, bool init);

BSL_UIO_TransportType BSL_UIO_GetTransportType(const BSL_UIO *uio);

bool BSL_UIO_GetUioChainTransportType(BSL_UIO *uio, const BSL_UIO_TransportType uioType);

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);
 
#ifdef __cplusplus
}
#endif
 
#endif // BSL_UIO_H