cthread_int.h

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright (c) 2019-2022 Intel Corporation
 */
 
/*
 * Some portions of this software may have been derived from the
 * https://github.com/halayli/lthread which carrys the following license.
 *
 * Copyright (c) 2012, Hasan Alayli <halayli@gmail.com>
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 */
#ifndef _CTHREAD_INT_H
#define _CTHREAD_INT_H
 
#include <sys/queue.h>
#include <cne_per_thread.h>
#include <cne_spinlock.h>
#include <cne_timer.h>
#include <uid.h>
#include "cthread.h"
#include "ctx.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct cthread;
struct cthread_sched;
struct cthread_cond;
struct cthread_mutex;
struct cthread_key;
 
struct key_pool;
struct qnode;
struct qnode_pool;
struct cthread_sched;
struct cthread_tls;
 
#define BIT(x) (1ULL << (x))
 
#define POSIX_ERRNO(x) (x)
 
#define CTHREAD_NAME_SIZE 64
 
/* define some shorthand for current scheduler and current thread */
#define THIS_SCHED   CNE_PER_THREAD(this_sched)
#define THIS_CTHREAD CNE_PER_THREAD(this_sched)->current_cthread
 
struct cthread_sched {
    STAILQ_ENTRY(cthread_sched) next;           
    struct cthread *current_cthread;            
    cne_spinlock_recursive_t lock;              
    int sched_id;                               
    int run_flag;                               
    struct ctx ctx;                             
    uint64_t birth;                             
    u_id_t *uid_pool;                           
    uint64_t nb_blocked_threads;                
    STAILQ_HEAD(, cthread) threads;             
    CNE_ATOMIC(uint_least32_t) thread_count;    
    struct cthread_queue *ready;                
    struct cthread_queue *pready;               
    struct cthread_objcache *cthread_cache;     
    struct cthread_objcache *stack_cache;       
    struct cthread_objcache *per_cthread_cache; 
    struct cthread_objcache *tls_cache;         
    struct cthread_objcache *cond_cache;        
    struct cthread_objcache *sema_cache;        
    struct cthread_objcache *barr_cache;        
    struct cthread_objcache *mutex_cache;       
    struct cthread_objcache *once_cache;        
    struct qnode_pool *qnode_pool;              
    struct key_pool *key_pool;                  
    size_t stack_size;                          
} __cne_cache_aligned;
 
CNE_DECLARE_PER_THREAD(struct cthread_sched *, this_sched);
 
enum cthread_st {
    CT_STATE_INIT,          /* initial state */
    CT_STATE_READY,         /* cthread is ready to run */
    CT_STATE_EXITED,        /* cthread has exited and needs cleanup */
    CT_STATE_DETACH,        /* cthread frees on exit*/
    CT_STATE_CANCELLED,     /* cthread has been cancelled */
    CT_STATE_COND_WAITING,  /* cthread is blocked on condition var */
    CT_STATE_MUTEX_WAITING, /* cthread is blocked on mutex */
    CT_STATE_EXPIRED,       /* cthread timeout has expired  */
    CT_STATE_SLEEPING,      /* cthread is sleeping */
    NUM_STATES
};
 
#define CLEAR_STATE_BITS \
    (BIT(CT_STATE_COND_WAITING) | BIT(CT_STATE_MUTEX_WAITING) | BIT(CT_STATE_SLEEPING))
 
// clang-format off
#define CTHREAD_STATES  {   \
    "INIT",                 \
    "READY",                \
    "EXITED",               \
    "DETACH",               \
    "CANCELLED",            \
    "COND-WAITING",         \
    "MUTEX-WAITING",        \
    "EXPIRED",              \
    "SLEEPING",             \
    NULL                    \
    }
// clang-format on
 
enum join_st {
    CT_JOIN_INITIAL,      /* initial state */
    CT_JOIN_EXITING,      /* thread is exiting */
    CT_JOIN_THREAD_SET,   /* joining thread has been set */
    CT_JOIN_EXIT_VAL_SET, /* exiting thread has set ret val */
    CT_JOIN_EXIT_VAL_READ /* joining thread has collected ret val */
};
 
struct cthread_stack {
    struct cthread_sched *sched;
    size_t stack_size;
    uint8_t stack_start[0];
} __cne_cache_aligned;
 
struct cthread {
    struct ctx ctx;                         
    int cthread_id;                         
    uint64_t state;                         
    void *private_data;                     
    void *stack;                            
    size_t stack_size;                      
    size_t last_stack_size;                 
    cthread_func_t fun;                     
    void *arg;                              
    void *per_cthread_data;                 
    cthread_exit_func exit_handler;         
    uint64_t birth;                         
    struct cthread_queue *pending_wr_queue; 
    struct cthread *dt_join;                
    CNE_ATOMIC(uint_least64_t) join;        
    void **dt_exit_ptr;                     
    struct cthread_sched *sched;            
    struct queue_node *qnode;               
    struct cne_timer tim;                   
    struct cthread_tls *tls;                
    struct cthread_stack *stack_container;  
    struct cthread_cond *cond;              
    struct cthread_sema *sema;              
    char name[CTHREAD_NAME_SIZE];           
    STAILQ_ENTRY(cthread) next;             
} __cne_cache_aligned;
 
/* Internal functions */
void _cthread_wait(void);
 
void _cthread_mutex_wait(void);
 
#ifdef __cplusplus
}
#endif
 
#endif /* _CTHREAD_INT_H */