threads-model.h

/** @file threads-model.h
 *  @brief Model Checker Thread class.
 */

#ifndef __THREADS_MODEL_H__
#define __THREADS_MODEL_H__

#include <stdint.h>
#include "mymemory.h"
#include "threads.h"
#include "modeltypes.h"
#include "stl-model.h"
#include "context.h"
#include "classlist.h"
#include "pthread.h"
#include <sys/epoll.h>

struct thread_params {
	thrd_start_t func;
	void *arg;
};

/** @brief Represents the state of a user Thread */
typedef enum thread_state {
	/** Thread was just created and hasn't run yet */
	THREAD_CREATED,
	/** Thread is running */
	THREAD_RUNNING,
	/** Thread is not currently running but is ready to run */
	THREAD_READY,
	/**
	 * Thread is waiting on another action (e.g., thread completion, lock
	 * release, etc.)
	 */
	THREAD_BLOCKED,
	/** Thread has completed its execution */
	THREAD_COMPLETED,
	THREAD_FREED
} thread_state;


/** @brief A Thread is created for each user-space thread */
class Thread {
public:
	Thread(thread_id_t tid);
	Thread(thread_id_t tid, thrd_t *t, void (*func)(void *), void *a, Thread *parent);
	Thread(thread_id_t tid, thrd_t *t, void *(*func)(void *), void *a, Thread *parent);

	~Thread();
	void complete();
	void freeResources();

	static int swap(ucontext_t *ctxt, Thread *t);
	static int swap(Thread *t, ucontext_t *ctxt);
	static int swap(Thread *t, Thread *t2);

	thread_state get_state() const { return state; }
	void set_state(thread_state s);
	thread_id_t get_id() const;
	thrd_t get_thrd_t() const { return *user_thread; }
	Thread * get_parent() const { return parent; }

	void set_creation(ModelAction *act) { creation = act; }
	ModelAction * get_creation() const { return creation; }

	/**
	 * Set a return value for the last action in this thread (e.g., for an
	 * atomic read).
	 * @param value The value to return
	 */
	void set_return_value(uint64_t value) { last_action_val = value; }

	/**
	 * Retrieve a return value for the last action in this thread. Used,
	 * for instance, for an atomic read to return the 'read' value. Should
	 * be called from a user context.
	 * @return The value 'returned' by the action
	 */
	uint64_t get_return_value() const { return last_action_val; }

	/** @set and get the return value from pthread functions */
	void set_pthread_return(void *ret) { pthread_return = ret; }
	void * get_pthread_return() { return pthread_return; }

	/** @return True if this thread is finished executing */
	bool is_complete() const { return state == THREAD_COMPLETED || state == THREAD_FREED; }

	/** @return True if this thread has finished and its resources have been freed */
	bool is_freed() const { return state == THREAD_FREED; }

	/** @return True if this thread is blocked */
	bool is_blocked() const { return state == THREAD_BLOCKED; }

	/** @return The pending (next) ModelAction for this Thread
	 *  @see Thread::pending */
	ModelAction * get_pending() const { return pending; }

	/** @brief Set the pending (next) ModelAction for this Thread
	 *  @param act The pending ModelAction
	 *  @see Thread::pending */
	void set_pending(ModelAction *act) { pending = act; }

	bool just_woken_up() { return wakeup_state; }
	void set_wakeup_state(bool state) { wakeup_state = state; }

	Thread * waiting_on() const;
	bool is_waiting_on(const Thread *t) const;

	bool is_model_thread() const { return model_thread; }

	void * get_stack_addr() { return stack; }
	ClockVector * get_acq_fence_cv() { return acq_fence_cv; }

	friend void thread_startup();
#ifdef TLS
	friend void setup_context();
	friend void * helper_thread(void *);
	friend void finalize_helper_thread();
#endif

	/**
	 * Intentionally NOT allocated with MODELALLOC or SNAPSHOTALLOC.
	 * Threads should be allocated on the user's normal (snapshotting) heap
	 * to allow their allocation/deallocation to follow the same pattern as
	 * the rest of the backtracked/replayed program.
	 */
	void * operator new(size_t size) {
		return Thread_malloc(size);
	}
	void operator delete(void *p, size_t size) {
		Thread_free(p);
	}
	void * operator new[](size_t size) {
		return Thread_malloc(size);
	}
	void operator delete[](void *p, size_t size) {
		Thread_free(p);
	}
#ifdef TLS
	void setTLS(char *_tls) { tls = _tls;}
#endif
private:
	int create_context();

	/** @brief The parent Thread which created this Thread */
	Thread * const parent;

	/** @brief Acquire fence cv */
	ClockVector *acq_fence_cv;

	/** @brief The THREAD_CREATE ModelAction which created this Thread */
	ModelAction *creation;

	/**
	 * @brief The next ModelAction to be run by this Thread
	 *
	 * This action should be kept updated by the ModelChecker, so that we
	 * always know what the next ModelAction's memory_order, action type,
	 * and location are.
	 */
	ModelAction *pending;

	/** @brief True if this thread was just woken up */
	bool wakeup_state;

	void (*start_routine)(void *);
	void *(*pstart_routine)(void *);

	void *arg;
	ucontext_t context;
	void *stack;
	uint32_t stack_size;
#ifdef TLS
	void * helper_stack;
public:
	char *tls;
	ucontext_t helpercontext;
	pthread_mutex_t mutex;
	pthread_mutex_t mutex2;
	pthread_t thread;
private:
#endif
	thrd_t *user_thread;
	thread_id_t id;
	thread_state state;

	/**
	 * The value returned by the last action in this thread
	 * @see Thread::set_return_value()
	 * @see Thread::get_return_value()
	 */
	uint64_t last_action_val;

	/** the value return from pthread functions */
	void * pthread_return;

	/** @brief Is this Thread a special model-checker thread? */
	const bool model_thread;
};

#ifdef TLS
uintptr_t get_tls_addr();
void tlsdestructor(void *v);
#endif

Thread * thread_current();
thread_id_t thread_current_id();
void thread_startup();
void initMainThread();

static inline thread_id_t thrd_to_id(thrd_t t)
{
	return t.priv->get_id();
}

/**
 * @brief Map a zero-based integer index to a unique thread ID
 *
 * This is the inverse of id_to_int
 */
static inline thread_id_t int_to_id(int i)
{
	return i;
}

/**
 * @brief Map a unique thread ID to a zero-based integer index
 *
 * This is the inverse of int_to_id
 */
static inline int id_to_int(thread_id_t id)
{
	return id;
}

int real_epoll_wait(int epfd, struct epoll_event *events, int maxevents, int timeout);
int real_pthread_mutex_init(pthread_mutex_t *__mutex, const pthread_mutexattr_t *__mutexattr);
int real_pthread_mutex_lock (pthread_mutex_t *__mutex);
int real_pthread_mutex_unlock (pthread_mutex_t *__mutex);
int real_pthread_create (pthread_t *__restrict __newthread, const pthread_attr_t *__restrict __attr, void *(*__start_routine)(void *), void *__restrict __arg);
int real_pthread_join (pthread_t __th, void ** __thread_return);
void real_pthread_exit (void * value_ptr) __attribute__((noreturn));
void real_init_all();

#endif	/* __THREADS_MODEL_H__ */