doca_error.h

Go to the documentation of this file.

/*
 * Copyright (c) 2022-2023 NVIDIA CORPORATION & AFFILIATES, ALL RIGHTS RESERVED.
 *
 * This software product is a proprietary product of NVIDIA CORPORATION &
 * AFFILIATES (the "Company") and all right, title, and interest in and to the
 * software product, including all associated intellectual property rights, are
 * and shall remain exclusively with the Company.
 *
 * This software product is governed by the End User License Agreement
 * provided with the software product.
 *
 */
 
#ifndef DOCA_ERROR_H_
#define DOCA_ERROR_H_
 
#include <doca_compat.h>
#include <doca_common_defines.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef enum doca_error {
    DOCA_SUCCESS = 0,              
    DOCA_ERROR_UNKNOWN = 1,            
    DOCA_ERROR_NOT_PERMITTED = 2,          
    DOCA_ERROR_IN_USE = 3,             
    DOCA_ERROR_NOT_SUPPORTED = 4,          
    DOCA_ERROR_AGAIN = 5,              
    DOCA_ERROR_INVALID_VALUE = 6,          
    DOCA_ERROR_NO_MEMORY = 7,          
    DOCA_ERROR_INITIALIZATION = 8,         
    DOCA_ERROR_TIME_OUT = 9,           
    DOCA_ERROR_SHUTDOWN = 10,          
    DOCA_ERROR_CONNECTION_RESET = 11,      
    DOCA_ERROR_CONNECTION_ABORTED = 12,    
    DOCA_ERROR_CONNECTION_INPROGRESS = 13, 
    DOCA_ERROR_NOT_CONNECTED = 14,         
    DOCA_ERROR_NO_LOCK = 15,           
    DOCA_ERROR_NOT_FOUND = 16,         
    DOCA_ERROR_IO_FAILED = 17,         
    DOCA_ERROR_BAD_STATE = 18,         
    DOCA_ERROR_UNSUPPORTED_VERSION = 19,   
    DOCA_ERROR_OPERATING_SYSTEM = 20,      
    DOCA_ERROR_DRIVER = 21,            
    DOCA_ERROR_UNEXPECTED = 22,        
    DOCA_ERROR_ALREADY_EXIST = 23,         
    DOCA_ERROR_FULL = 24,              
    DOCA_ERROR_EMPTY = 25,             
    DOCA_ERROR_IN_PROGRESS = 26,           
    DOCA_ERROR_TOO_BIG = 27,           
    DOCA_ERROR_AUTHENTICATION = 28,        
    DOCA_ERROR_BAD_CONFIG = 29,        
    DOCA_ERROR_SKIPPED = 30,           
} doca_error_t;
 
#define DOCA_IS_ERROR(r) doca_unlikely((r) != DOCA_SUCCESS)
 
#define DOCA_ERROR_PROPAGATE(r, t) \
    do { \
        if (r == DOCA_SUCCESS) \
            r = t; \
    } while (0)
 
DOCA_STABLE
const char *doca_error_get_name(doca_error_t error);
 
DOCA_STABLE
const char *doca_error_get_descr(doca_error_t error);
 
#ifdef __cplusplus
}
#endif
 
#endif /* DOCA_ERROR_H_ */