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
|
#ifndef TARANTOOL_FIBER_H_INCLUDED
#define TARANTOOL_FIBER_H_INCLUDED
/*
* 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 <COPYRIGHT HOLDER> ``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
* <COPYRIGHT HOLDER> 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.
*/
#include "tarantool/config.h"
#include <stdbool.h>
#include <stdint.h>
#include <unistd.h>
#include <tarantool_ev.h>
#include <coro.h>
#include <tarantool/util.h>
#include "third_party/queue.h"
#if defined(__cplusplus)
#include "exception.h"
#endif /* defined(__cplusplus) */
#include "palloc.h"
#include <rlist.h>
#define FIBER_NAME_MAXLEN PALLOC_POOL_NAME_MAXLEN
#define FIBER_READING_INBOX (1 << 0)
/** This fiber can be cancelled synchronously. */
#define FIBER_CANCELLABLE (1 << 1)
/** Indicates that a fiber has been cancelled. */
#define FIBER_CANCEL (1 << 2)
/** This fiber was created via stored procedures API. */
#define FIBER_USER_MODE (1 << 3)
/** This fiber was marked as ready for wake up */
#define FIBER_READY (1 << 4)
/** This is thrown by fiber_* API calls when the fiber is
* cancelled.
*/
#if defined(__cplusplus)
class FiberCancelException: public Exception {
public:
FiberCancelException(const char *file, unsigned line)
: Exception(file, line) {
/* Nothing */
}
virtual void log() const {
say_debug("FiberCancelException");
}
};
#endif /* defined(__cplusplus) */
struct fiber {
#ifdef ENABLE_BACKTRACE
void *last_stack_frame;
#endif
int csw;
struct tarantool_coro coro;
/* A garbage-collected memory pool. */
struct palloc_pool *gc_pool;
/** Fiber id. */
uint32_t fid;
/**
* Session id of the session the fiber is running
* on behalf of. The concept of an associated session
* is similar to the concept of controlling tty
* in a UNIX process. When a fiber is created,
* its sid is 0. If it's running a request on behalf
* of a user connection, it's sid is changed to module-
* generated identifier of the session.
*/
uint32_t sid;
struct rlist link;
struct rlist state;
/* This struct is considered as non-POD when compiling by g++.
* You can safetly ignore all offset_of-related warnings.
* See http://gcc.gnu.org/bugzilla/show_bug.cgi?id=31488
*/
void (*f) (va_list);
va_list f_data;
uint32_t flags;
struct fiber *waiter;
uint64_t cookie;
};
extern __thread struct fiber *fiber;
void fiber_init(void);
void fiber_free(void);
typedef void(*fiber_func)(va_list);
struct fiber *fiber_new(const char *name, fiber_func f);
void fiber_set_name(struct fiber *fiber, const char *name);
int wait_for_child(pid_t pid);
static inline const char *
fiber_name(struct fiber *f)
{
return f->gc_pool ? palloc_name(f->gc_pool) : "(none)";
}
void
fiber_checkstack();
void fiber_yield(void);
void fiber_yield_to(struct fiber *f);
/**
* @brief yield & check for timeout
* @return true if timeout exceeded
*/
bool fiber_yield_timeout(ev_tstamp delay);
void fiber_destroy_all();
void fiber_gc(void);
void fiber_call(struct fiber *callee, ...);
void fiber_wakeup(struct fiber *f);
struct fiber *fiber_find(uint32_t fid);
/** Cancel a fiber. A cancelled fiber will have
* tnt_FiberCancelException raised in it.
*
* A fiber can be cancelled only if it is
* FIBER_CANCELLABLE flag is set.
*/
void fiber_cancel(struct fiber *f);
/** Check if the current fiber has been cancelled. Raises
* tnt_FiberCancelException
*/
void fiber_testcancel(void);
/** Make it possible or not possible to cancel the current
* fiber.
*
* return previous state.
*/
bool fiber_setcancellable(bool enable);
void fiber_sleep(ev_tstamp s);
struct tbuf;
void fiber_info(struct tbuf *out);
void fiber_schedule(ev_watcher *watcher, int event __attribute__((unused)));
/**
* Attach this fiber to a session identified by sid and to a cookie.
*/
static inline void
fiber_set_sid(struct fiber *f, uint32_t sid, uint64_t cookie)
{
f->sid = sid;
f->cookie = cookie;
}
#endif /* TARANTOOL_FIBER_H_INCLUDED */
|
