thread.h

Go to the documentation of this file.

/*
 * Copyright (C) 2001-2004 Jakub Jermar
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * - Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * - 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.
 * - The name of the author may not be used to endorse or promote products
 *   derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 THE AUTHOR 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 __THREAD_H__
#define __THREAD_H__

#include <arch/proc/thread.h>
#include <synch/spinlock.h>
#include <arch/context.h>
#include <fpu_context.h>
#include <arch/types.h>
#include <typedefs.h>
#include <time/timeout.h>
#include <synch/rwlock.h>
#include <synch/synch.h>
#include <config.h>
#include <adt/btree.h>
#include <adt/list.h>
#include <mm/slab.h>
#include <proc/uarg.h>

#define THREAD_STACK_SIZE       STACK_SIZE

enum state {
        Invalid,        
        Running,        
        Sleeping,       
        Ready,          
        Entering,       
        Exiting,        
        Undead          
};

extern char *thread_states[];

typedef enum {
        None,
        TaskClnp,       
        TaskGC          
} thread_join_type_t;

#define X_WIRED         (1<<0)
#define X_STOLEN        (1<<1)

#define THREAD_NAME_BUFLEN      20

struct thread {
        link_t rq_link;                         
        link_t wq_link;                         
        link_t th_link;                         
        SPINLOCK_DECLARE(lock);

        char name[THREAD_NAME_BUFLEN];

        void (* thread_code)(void *);           
        void *thread_arg;                       
        context_t saved_context;
        context_t sleep_timeout_context;
        context_t sleep_interruption_context;

        bool sleep_interruptible;               
        waitq_t *sleep_queue;                   
        timeout_t sleep_timeout;                
        volatile int timeout_pending;           
        bool in_copy_from_uspace;
        bool in_copy_to_uspace;
        
        bool interrupted;                       
        
        thread_join_type_t      join_type;      
        bool detached;                          
        waitq_t join_wq;                        
        fpu_context_t *saved_fpu_context;
        int fpu_context_exists;

        /*
         * Defined only if thread doesn't run.
         * It means that fpu context is in CPU that last time executes this thread.
         * This disables migration
         */
        int fpu_context_engaged;

        rwlock_type_t rwlock_holder_type;

        void (* call_me)(void *);               
        void *call_me_with;                     
        state_t state;                          
        int flags;                              
        cpu_t *cpu;                             
        task_t *task;                           
        __u64 ticks;                            
        int priority;                           
        __u32 tid;                              
        thread_arch_t arch;                     
        __u8 *kstack;                           
};

extern spinlock_t threads_lock;

extern btree_t threads_btree;                   
extern void thread_init(void);
extern thread_t *thread_create(void (* func)(void *), void *arg, task_t *task, int flags, char *name);
extern void thread_ready(thread_t *t);
extern void thread_exit(void) __attribute__((noreturn));

#ifndef thread_create_arch
extern void thread_create_arch(thread_t *t);
#endif

extern void thread_sleep(__u32 sec);
extern void thread_usleep(__u32 usec);

#define thread_join(t)  thread_join_timeout((t), SYNCH_NO_TIMEOUT, SYNCH_FLAGS_NONE)
extern int thread_join_timeout(thread_t *t, __u32 usec, int flags);
extern void thread_detach(thread_t *t);

extern void thread_register_call_me(void (* call_me)(void *), void *call_me_with);
extern void thread_print_list(void);
extern void thread_destroy(thread_t *t);
extern bool thread_exists(thread_t *t);

/* Fpu context slab cache */
extern slab_cache_t *fpu_context_slab;

__native sys_thread_create(uspace_arg_t *uspace_uarg, char *uspace_name);
__native sys_thread_exit(int uspace_status);

#endif

---