dulink.h

Go to the documentation of this file.

/*
 * Copyright (c) 2019-2023, NVIDIA CORPORATION.  All rights reserved.
 *
 * NVIDIA CORPORATION and its licensors retain all intellectual property
 * and proprietary rights in and to this software, related documentation
 * and any modifications thereto.  Any use, reproduction, disclosure or
 * distribution of this software and related documentation without an express
 * license agreement from NVIDIA CORPORATION is strictly prohibited.
 */
 
#ifndef DULINK_H_
#define DULINK_H_
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ------------------------ DRIVE Update Includes --------------------------- */
#include "ducommon.h"
#include "dutransport.h"
/* ------------------------ Defines------------------------------------------ */
 
#define DULINK_SUID_LINK   (0U)
#define DULINK_SUID_CB     (1U)
 
#define DULINK_ECODE(err)         DU_ECODE(DU_UID_LINK, DULINK_SUID_LINK, (err))
#define DULINK_CB_ECODE(err)      DU_ECODE(DU_UID_LINK, DULINK_SUID_CB, (err))
 
// List type of DU Link Errors.
#define DULINK_ERR_GENERIC             DULINK_ECODE(1U)
#define DULINK_ERR_INVALID_ARGUMENT    DULINK_ECODE(2U)
#define DULINK_ERR_BUFFER_TOO_SMALL    DULINK_ECODE(3U)
#define DULINK_ERR_NOT_FOUND           DULINK_ECODE(4U)
#define DULINK_ERR_NOT_SUPPORTED       DULINK_ECODE(5U)
#define DULINK_ERR_NO_PERMISSION       DULINK_ECODE(6U)
#define DULINK_ERR_ALLOC_FAILED        DULINK_ECODE(7U)
#define DULINK_ERR_BUSY                DULINK_ECODE(8U)
#define DULINK_ERR_UPLINK_NOT_READY    DULINK_ECODE(9U)
#define DULINK_ERR_ROUTING             DULINK_ECODE(10U)
#define DULINK_ERR_TIMEOUT             DULINK_ECODE(11U)
#define DULINK_ERR_TRANSPORT           DULINK_ECODE(12U)
 
#define DULINK_ERR_ILLEGALMSG          DULINK_ECODE(13U)
#define DULINK_ERR_ROUTING_RETMSG      DULINK_ECODE(14U)
#define DULINK_ERR_NO_DST              DULINK_ECODE(15U)
#define DULINK_ERR_NO_MEMORY           DULINK_ECODE(16U)
#define DULINK_ERR_NO_P2P              DULINK_ECODE(17U)
#define DULINK_ERR_NO_CONNECT          DULINK_ECODE(18U)
#define DULINK_ERR_ILLEGAL_OP          DULINK_ECODE(19U)
#define DULINK_ERR_INIT                DULINK_ECODE(20U)
#define DULINK_ERR_CLOSE               DULINK_ECODE(21U)
#define DULINK_ERR_NOT_INIT            DULINK_ECODE(22U)
 
// Possible return values for DU Link callbacks.
#define DULINK_CB_RCODE                DU_RCODE
#define DULINK_CB_OK                   DU_OK
#define DULINK_CB_ERR_IO               DULINK_CB_ECODE(1U)
#define DULINK_CB_ERR_INVALID_ARGUMENT DULINK_CB_ECODE(2U)
#define DULINK_CB_ERR_SYNTAX           DULINK_CB_ECODE(3U)
#define DULINK_CB_ERR_UNKNOWN          DULINK_CB_ECODE(4U)
#define DULINK_CB_ERR_BUSY_RETRY       DULINK_CB_ECODE(5U)
 
#define DULINK_CB_ERR_NOT_SUPPORTED    DULINK_CB_ECODE(6U)
#define DULINK_CB_ERR_NO_NODE          DULINK_CB_ECODE(7U)
 
#define DULINK_IS_CB_ERR(rcode)    (DU_ECODE_GET_SUID(rcode) == DULINK_SUID_CB)
 
#define DULINK_GET_CB_ERR(rcode)   (DU_ECODE_GET_ERR(rcode))
 
#define DULINK_VERSION_STR "2"
 
#define DULINK_MAX_PATH              (256U)
#define DULINK_MAX_NODE_NAME         (DULINK_MAX_PATH)
#define DULINK_MAX_CHILDNODE         (256U)
#define DULINK_MAX_NODES             (256U)
#define DULINK_MAX_ACL               (16U)
#define DULINK_MAX_NOTIFY_NODES      (16U)
#define DULINK_MAX_NODES_TO_NOTIFY   (8U)
#define DULINK_MAX_NOTIFY_MSG_LEN    (1024U)
#define DULINK_MAX_DATA_SIZE         (1024U * 1024U)
 
#define DULINK_PERMISSION_NONE       (0x00U)
#define DULINK_PERMISSION_READ       (0x01U)
#define DULINK_PERMISSION_WRITE      (0x02U)
#define DULINK_PERMISSION_WRITE_MASK (0xFDU)
// Remaining Bits are reserved and must be 0.
#define DULINK_CLOSE_ALL             (0xFFFFFFFFU)
 
/* ------------------------ Types ------------------------------------------- */
 
typedef enum DULINK_NODE_TYPE
{
    DULINK_NODE_TYPE_ELEMENT = 0,
    DULINK_NODE_TYPE_DIRECTORY,
    DULINK_NODE_TYPE_FILE
} DULINK_NODE_TYPE;
 
typedef enum DULINK_CONNECTION_TYPE
{
    DULINK_CONNECT_UPLINK = 0,
    DULINK_CONNECT_DOWNLINK,
    DULINK_CONNECT_P2P
} DULINK_CONNECTION_TYPE;
 
 
typedef struct DULINK_ACL_ENTRY
{
    char    srcElement[DULINK_MAX_PATH];
    uint8_t allowMask; // DULINK_PERMISSION_READ | DULINK_PERMISSION_WRITE
    uint8_t denyMask;
} DULINK_ACL_ENTRY, *PDULINK_ACL_ENTRY;
 
typedef struct DULINK_ATTR
{
    DULINK_NODE_TYPE type;
    uint32_t         numACL;
    DULINK_ACL_ENTRY acl[DULINK_MAX_ACL];
} DULINK_ATTR, *PDULINK_ATTR;
 
typedef uint32_t DULINK_CB_OPERATION;
#define DULINK_CB_READ  (0U)
#define DULINK_CB_WRITE (1U)
#define DULINK_CB_SIZE  (2U)
#define DULINK_CB_ATTR  (3U)
 
typedef DULINK_CB_RCODE (*DULINK_CB)(const char* pRequestPath,
                         const char* pOriginPath, void *pCtx, uint64_t offset,
                         uint64_t length, void* pBuf,
                         DULINK_CB_OPERATION operation, uint64_t *pRetVal);
 
/* ------------------------ Function Declarations --------------------------- */
DU_RCODE dulinkInit
(
    const char *pName,
    const char *pParentPath
);
 
DU_RCODE dulinkOpen
(
    const char             *pRemotePath,
    DUTR_TR_TYPE            trType,
    DUTR_SEC_TYPE           seType,
    const void             *pTrParam,
    const void             *pSeParam,
    DULINK_CONNECTION_TYPE  connType,
    uint32_t               *pConnRefId
);
 
DU_RCODE dulinkClose
(
    uint32_t connRefId
);
 
DU_RCODE dulinkRead
(
    const char *pPath,
    uint64_t    offset,
    uint64_t    length,
    void       *pBuf,
    uint64_t   *pRetLen
);
 
DU_RCODE dulinkWrite
(
    const char *pPath,
    uint64_t    offset,
    uint64_t    length,
    void       *pBuf,
    uint64_t   *pRetLen
);
 
DU_RCODE dulinkGetSize
(
    const char *pPath,
    uint64_t   *pSize
);
 
DU_RCODE dulinkGetAttribute
(
    const char   *pPath,
    PDULINK_ATTR  pAttribute
);
 
DU_RCODE dulinkExportDirectory
(
    const char         *pPath,
    const DULINK_ATTR  *pAttribute
);
 
DU_RCODE dulinkExportFile
(
    const char         *pPath,
    const DULINK_ATTR  *pAttribute,
    DULINK_CB           callback,
    void               *pCtx
);
 
DU_RCODE dulinkUnlinkDirectory
(
    const char *pPath
);
 
DU_RCODE dulinkUnlinkFile
(
    const char *pPath
);
 
DU_RCODE dulinkExportNotifyNode
(
    const char *pNotifyPath
);
 
DU_RCODE dulinkTriggerNotify
(
    const char *pNotifyPath,
    void       *pBuf,
    uint64_t    bufSize
);
 
#ifdef NON_SAFETY_BUILD
 
DU_RCODE dulinkGetParamsSize
(
    uint32_t *pDulinkConnectionSize,
    uint32_t *pDulinkWorkerSize,
    uint32_t *pDulinkWaitObjSize
);
 
DU_RCODE dulinkSetInitParams
(
    uint32_t    numConnection,
    void       *pConnectionTable,
    uint32_t    numWorker,
    void       *pWorkerTable,
    void       *pWaitingTable
);
#endif
 
#ifdef __cplusplus
}
#endif
 
#endif