cne.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright (c) 2019-2022 Intel Corporation
 */
 
// IWYU pragma: no_include "cne_private.h"
 
#include <stdio.h>         // for FILE
#include <stdint.h>        // for uint16_t
 
#ifndef _CNE_H_
#define _CNE_H_
 
#include <cne_common.h>        // for CNDP_API
 
#ifdef __cplusplus
extern "C" {
#endif
 
enum {
    CNE_CAUGHT_SIGNAL, 
    CNE_CALLED_EXIT,   
    CNE_USER_EXIT,     
    MAX_EXIT_TYPES     
};
 
/* Maybe defined first in the cne_private.h file, so guard for this case. */
#ifndef _CNE_PRIVATE_H_
typedef void (*on_exit_fn_t)(int sig, void *arg, int exit_type);
#endif
 
#define COPYRIGHT_MSG       "Copyright (c) 2020-2022 Intel Corporation. All rights reserved."
#define COPYRIGHT_MSG_SHORT "Copyright (c) 2020-2022 Intel Corporation"
#define POWERED_BY_CNDP     "Powered by CNDP"
 
CNDP_API int cne_init(void);
 
CNDP_API int cne_on_exit(on_exit_fn_t exit_fn, void *arg, int *signals, int nb_signals);
 
CNDP_API int cne_initial_uid(void);
 
CNDP_API int cne_entry_uid(void);
 
CNDP_API int cne_register(const char *name);
 
CNDP_API int cne_unregister(int tidx);
 
CNDP_API int cne_set_private(int tidx, void *v);
 
CNDP_API int cne_get_private(int tidx, void **v);
 
CNDP_API int cne_id(void);
 
CNDP_API int cne_max_threads(void);
 
CNDP_API int cne_next_id(int uid, int skip, int wrap);
 
CNDP_API int cne_active_threads(void);
 
CNDP_API void cne_dump(FILE *f);
 
static inline const char *
copyright_msg(void)
{
    return COPYRIGHT_MSG;
}
 
static inline const char *
copyright_msg_short(void)
{
    return COPYRIGHT_MSG_SHORT;
}
 
static inline const char *
powered_by(void)
{
    return POWERED_BY_CNDP;
}
 
#ifdef __cplusplus
}
#endif
 
#endif /* _CNE_H_ */