uds.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright (c) 2021-2022 Intel Corporation
 */
 
#ifndef _UDS_H_
#define _UDS_H_
 
#include <stdint.h>
#include <sys/socket.h>
#include <sys/un.h>        // for sockaddr_un
 
#include "cne_common.h"        // for CNDP_API
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define UDS_MAX_CMD_LEN      56
#define UDS_MAX_GRP_NAME_LEN 32
 
typedef struct uds_group {
    char name[UDS_MAX_GRP_NAME_LEN]; 
    void *priv;                      
} uds_group_t;
 
#define UDS_NO_OUTPUT -2
 
struct uds_client;
 
typedef struct uds_client uds_client_t;
typedef struct uds_client {
    char *buffer;                  
    const char *cmd;               
    const char *params;            
    const char *params2;           
    int buf_len;                   
    int used;                      
    int s;                         
    struct uds_info *info;         
    struct cmsghdr *cmsg;          
    const struct uds_group *group; 
    int socket_client;             
} uds_client_t;
 
typedef struct uds_info {
    volatile int running;   
    int sock;               
    struct sockaddr_un sun; 
    void *priv;             
    int xsk_uds_state;      
    int xsk_map_fd;         
} uds_info_t;
 
enum {
    UDS_START = 0,     
    UDS_CONNECTED,     
    UDS_HOST_OK,       
    UDS_GOT_FD,        
    UDS_FD_NAK,        
    UDS_FIN,           
    UDS_HOST_NAK,      
    UDS_HOST_ERR,      
    UDS_BUSY_POLL_ACK, 
    UDS_BUSY_POLL_NAK, 
};
 
#define UDS_CONNECT_MSG       "/connect"
#define UDS_HOST_OK_MSG       "/host_ok"
#define UDS_HOST_NAK_MSG      "/host_nak"
#define UDS_XSK_MAP_FD_MSG    "/xsk_map_fd"
#define UDS_XSK_SOCKET_MSG    "/xsk_socket"
#define UDS_FD_ACK_MSG        "/fd_ack"
#define UDS_FD_NAK_MSG        "/fd_nak"
#define UDS_FIN_MSG           "/fin"
#define UDS_FIN_ACK_MSG       "/fin_ack"
#define UDS_CFG_BUSY_POLL_MSG "/config_busy_poll"
#define UDS_CFG_BUSY_POLL_ACK "/config_busy_poll_ack"
#define UDS_CFG_BUSY_POLL_NAK "/config_busy_poll_nak"
 
typedef int (*uds_cb)(uds_client_t *client, const char *cmd, const char *params);
 
CNDP_API int uds_register(const uds_group_t *grp, const char *cmd, uds_cb fn);
 
CNDP_API uds_info_t *uds_create(const char *runtime_dir, const char *uds_name, const char **err_str,
                                void *priv);
 
CNDP_API uds_info_t *uds_get_default(void *priv);
 
CNDP_API const uds_group_t *uds_create_group(const uds_info_t *info, const char *group, void *priv);
 
CNDP_API int uds_destroy_group(const uds_group_t *group);
 
CNDP_API const uds_group_t *uds_get_group_by_name(const uds_info_t *info, const char *name);
 
CNDP_API uds_info_t *uds_connect(const char *uds_name, const char **err_str, void *priv);
 
CNDP_API void uds_destroy(uds_info_t *info);
 
CNDP_API int uds_append(uds_client_t *client, const char *format, ...);
 
CNDP_API const char *uds_cmd(uds_client_t *client);
 
CNDP_API const char *uds_params(uds_client_t *client);
 
#ifdef __cplusplus
}
#endif
 
#endif /* _UDS_H_ */