2 * @brief Thread functions.
10 #include "threads-model.h"
13 /* global "model" object */
16 /** Allocate a stack for a new thread. */
17 static void * stack_allocate(size_t size)
19 return Thread_malloc(size);
22 /** Free a stack for a terminated thread. */
23 static void stack_free(void *stack)
29 * @brief Get the current Thread
31 * Must be called from a user context
33 * @return The currently executing thread
35 Thread * thread_current(void)
38 return model->get_current_thread();
42 * Provides a startup wrapper for each thread, allowing some initial
43 * model-checking data to be recorded. This method also gets around makecontext
44 * not being 64-bit clean
48 Thread * curr_thread = thread_current();
50 /* Add dummy "start" action, just to create a first clock vector */
51 model->switch_to_master(new ModelAction(THREAD_START, std::memory_order_seq_cst, curr_thread));
53 /* Call the actual thread function */
54 curr_thread->start_routine(curr_thread->arg);
55 /* Finish thread properly */
56 model->switch_to_master(new ModelAction(THREAD_FINISH, std::memory_order_seq_cst, curr_thread));
60 * Create a thread context for a new thread so we can use
61 * setcontext/getcontext/swapcontext to swap it out.
62 * @return 0 on success; otherwise, non-zero error condition
64 int Thread::create_context()
68 ret = getcontext(&context);
72 /* Initialize new managed context */
73 stack = stack_allocate(STACK_SIZE);
74 context.uc_stack.ss_sp = stack;
75 context.uc_stack.ss_size = STACK_SIZE;
76 context.uc_stack.ss_flags = 0;
77 context.uc_link = model->get_system_context();
78 makecontext(&context, thread_startup, 0);
84 * Swaps the current context to another thread of execution. This form switches
85 * from a user Thread to a system context.
86 * @param t Thread representing the currently-running thread. The current
87 * context is saved here.
88 * @param ctxt Context to which we will swap. Must hold a valid system context.
89 * @return Does not return, unless we return to Thread t's context. See
90 * swapcontext(3) (returns 0 for success, -1 for failure).
92 int Thread::swap(Thread *t, ucontext_t *ctxt)
94 t->set_state(THREAD_READY);
95 return model_swapcontext(&t->context, ctxt);
99 * Swaps the current context to another thread of execution. This form switches
100 * from a system context to a user Thread.
101 * @param ctxt System context variable to which to save the current context.
102 * @param t Thread to which we will swap. Must hold a valid user context.
103 * @return Does not return, unless we return to the system context (ctxt). See
104 * swapcontext(3) (returns 0 for success, -1 for failure).
106 int Thread::swap(ucontext_t *ctxt, Thread *t)
108 t->set_state(THREAD_RUNNING);
109 return model_swapcontext(ctxt, &t->context);
113 /** Terminate a thread and free its stack. */
114 void Thread::complete()
116 ASSERT(!is_complete());
117 DEBUG("completed thread %d\n", id_to_int(get_id()));
118 state = THREAD_COMPLETED;
124 * @brief Construct a new model-checker Thread
126 * A model-checker Thread is used for accounting purposes only. It will never
127 * have its own stack, and it should never be inserted into the Scheduler.
129 * @param tid The thread ID to assign
131 Thread::Thread(thread_id_t tid) :
140 state(THREAD_READY), /* Thread is always ready? */
144 memset(&context, 0, sizeof(context));
148 * Construct a new thread.
149 * @param t The thread identifier of the newly created thread.
150 * @param func The function that the thread will call.
151 * @param a The parameter to pass to this function.
153 Thread::Thread(thread_id_t tid, thrd_t *t, void (*func)(void *), void *a, Thread *parent) :
161 state(THREAD_CREATED),
162 last_action_val(VALUE_NONE),
167 /* Initialize state */
168 ret = create_context();
170 model_print("Error in create_context\n");
172 // user_thread->priv = this; // WL
176 * Construct a new thread for pthread.
177 * @param t The thread identifier of the newly created thread.
178 * @param func The function that the thread will call.
179 * @param a The parameter to pass to this function.
181 Thread::Thread(thread_id_t tid, thrd_t *t, void *(*func)(void *), void *a, Thread *parent) :
186 pstart_routine(func),
190 state(THREAD_CREATED),
191 last_action_val(VALUE_NONE),
196 /* Initialize state */
197 ret = create_context();
199 model_print("Error in create_context\n");
210 /** @return The thread_id_t corresponding to this Thread object. */
211 thread_id_t Thread::get_id() const
217 * Set a thread's THREAD_* state (@see thread_state)
218 * @param s The state to enter
220 void Thread::set_state(thread_state s)
222 ASSERT(s == THREAD_COMPLETED || state != THREAD_COMPLETED);
227 * Get the Thread that this Thread is immediately waiting on
228 * @return The thread we are waiting on, if any; otherwise NULL
230 Thread * Thread::waiting_on() const
235 if (pending->get_type() == THREAD_JOIN)
236 return pending->get_thread_operand();
237 else if (pending->get_type() == PTHREAD_JOIN) {
240 else if (pending->is_lock())
241 return (Thread *)pending->get_mutex()->get_state()->locked;
246 * Check if this Thread is waiting (blocking) on a given Thread, directly or
247 * indirectly (via a chain of waiting threads)
249 * @param t The Thread on which we may be waiting
250 * @return True if we are waiting on Thread t; false otherwise
252 bool Thread::is_waiting_on(const Thread *t) const
255 for (wait = waiting_on(); wait != NULL; wait = wait->waiting_on())