summary refs log tree commit diff
path: root/src/rt/rust_task_thread.h
blob: 6f1784311446f3cf40977303cdaf708ae7635388 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
#ifndef RUST_TASK_THREAD_H
#define RUST_TASK_THREAD_H

#include "rust_internal.h"
#include "sync/rust_thread.h"
#include "rust_stack.h"
#include "context.h"

#ifndef _WIN32
#include <pthread.h>
#else
#include <windows.h>
#endif

enum rust_task_state {
    task_state_newborn,
    task_state_running,
    task_state_blocked,
    task_state_dead
};

typedef indexed_list<rust_task> rust_task_list;

struct rust_task_thread : public kernel_owned<rust_task_thread>,
                        rust_thread
{
private:

    lock_and_signal lock;

    // Fields known only by the runtime:
    rust_log _log;

    const int id;

#ifndef __WIN32__
    static pthread_key_t task_key;
#else
    static DWORD task_key;
#endif

    static bool tls_initialized;
    context c_context;

    bool should_exit;

    stk_seg *cached_c_stack;
    stk_seg *extra_c_stack;

    rust_task_list running_tasks;
    rust_task_list blocked_tasks;
    rust_task *dead_task;

    void prepare_c_stack(rust_task *task);
    void unprepare_c_stack();

    rust_task_list *state_list(rust_task_state state);
    const char *state_name(rust_task_state state);

public:
    rust_kernel *kernel;
    rust_scheduler *sched;
    rust_srv *srv;

    // NB: this is used to filter *runtime-originating* debug
    // logging, on a per-scheduler basis. It's not likely what
    // you want to expose to the user in terms of per-task
    // or per-module logging control. By default all schedulers
    // are set to debug-level logging here, and filtered by
    // runtime category using the pseudo-modules ::rt::foo.
    uint32_t log_lvl;

    size_t min_stack_size;
    rust_env *env;

    randctx rctx;

    int32_t list_index;
    const char *const name;

    // Only a pointer to 'name' is kept, so it must live as long as this
    // domain.
    rust_task_thread(rust_scheduler *sched, rust_srv *srv, int id);
    void activate(rust_task *task);
    void log(rust_task *task, uint32_t level, char const *fmt, ...);
    rust_log & get_log();
    void fail();

    size_t number_of_live_tasks();

    void reap_dead_tasks();
    rust_task *schedule_task();

    void start_main_loop();

    void log_state();

    void kill_all_tasks();

    rust_task *create_task(rust_task *spawner, const char *name);

    void transition(rust_task *task,
                    rust_task_state src, rust_task_state dst,
                    rust_cond *cond, const char* cond_name);

    virtual void run();

    void init_tls();
    void place_task_in_tls(rust_task *task);

    static rust_task *get_task();

    // Called by each task when they are ready to be destroyed
    void release_task(rust_task *task);

    // Tells the scheduler to exit it's scheduling loop and thread
    void exit();

    // Called by tasks when they need a stack on which to run C code
    stk_seg *borrow_c_stack();
    void return_c_stack(stk_seg *stack);
};

inline rust_log &
rust_task_thread::get_log() {
    return _log;
}

// This stuff is on the stack-switching fast path

#ifndef __WIN32__

inline rust_task *
rust_task_thread::get_task() {
    if (!tls_initialized)
        return NULL;
    rust_task *task = reinterpret_cast<rust_task *>
        (pthread_getspecific(task_key));
    assert(task && "Couldn't get the task from TLS!");
    return task;
}

#else

inline rust_task *
rust_task_thread::get_task() {
    if (!tls_initialized)
        return NULL;
    rust_task *task = reinterpret_cast<rust_task *>(TlsGetValue(task_key));
    assert(task && "Couldn't get the task from TLS!");
    return task;
}

#endif

// NB: Runs on the Rust stack
inline stk_seg *
rust_task_thread::borrow_c_stack() {
    I(this, cached_c_stack);
    stk_seg *your_stack;
    if (extra_c_stack) {
        your_stack = extra_c_stack;
        extra_c_stack = NULL;
    } else {
        your_stack = cached_c_stack;
        cached_c_stack = NULL;
    }
    return your_stack;
}

// NB: Runs on the Rust stack
inline void
rust_task_thread::return_c_stack(stk_seg *stack) {
    I(this, !extra_c_stack);
    if (!cached_c_stack) {
        cached_c_stack = stack;
    } else {
        extra_c_stack = stack;
    }
}


//
// Local Variables:
// mode: C++
// fill-column: 78;
// indent-tabs-mode: nil
// c-basic-offset: 4
// buffer-file-coding-system: utf-8-unix
// compile-command: "make -k -C $RBUILD 2>&1 | sed -e 's/\\/x\\//x:\\//g'";
// End:
//

#endif /* RUST_TASK_THREAD_H */