cne_thread.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright (c) 2020-2022 Intel Corporation
 */
 
#ifndef _CNE_THREAD_H_
#define _CNE_THREAD_H_
 
// IWYU pragma: no_include "thread_private.h"
#include <stdio.h>        // for FILE
#include <pthread.h>
#include <cne_common.h>        // for CNDP_API, CNE_STD_C11
#include <stdint.h>            // for uint16_t, uint64_t, uint8_t
#include <uid.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define THREAD_WAIT_FOREVER    0
#define THREAD_DEFAULT_TIMEOUT 1000        // 1ms timeout
#define THREAD_DEFAULT_NAME    "Initial-thread"
 
typedef void *thd_t; 
#ifndef _THREAD_PRIVATE_H_
/* Define the function prototype if pubicly included */
typedef void (*thd_func_t)(void *);
#endif
 
#define DISPLAY_FLAG 0x00
#define RX_ONLY_FLAG 0x01
#define TX_ONLY_FLAG 0x02
#define RXTX_FLAG    (RX_ONLY_FLAG | TX_ONLY_FLAG)
 
typedef union thread_cfg {
    uint64_t data; 
    void *arg;     
    CNE_STD_C11
    struct {
        uint16_t core; 
        uint16_t pid;  
        uint16_t qid;  
        uint8_t flags; 
        uint8_t pad0;
    };
} thread_cfg_t;
 
CNDP_API int thread_id(void);
 
CNDP_API thd_t thread_get(int tidx);
 
CNDP_API int thread_create(const char *name, thd_func_t func, void *arg);
 
CNDP_API int thread_register(const char *name, uint64_t pid);
 
CNDP_API int thread_unregister(int tidx);
 
CNDP_API int thread_wait(int tid, unsigned int checks, unsigned int usec);
 
CNDP_API int thread_wait_all(unsigned int checks, unsigned int usec, int skip);
 
CNDP_API int thread_stop_running(int tidx);
 
CNDP_API int thread_running(int tidx);
 
CNDP_API int thread_set_private(int tidx, void *priv_);
 
CNDP_API void *thread_get_private(int tidx);
 
CNDP_API int thread_set_affinity(int cpu);
 
CNDP_API const char *thread_name(int tidx);
 
CNDP_API void thread_dump(FILE *f);
 
#ifdef __cplusplus
}
#endif
 
#endif /* _CNE_THREAD_H_ */