pcfs purposes
aboutsummaryrefslogtreecommitdiff
path: root/src/script/lua_api/l_async_events.cpp
blob: f5c27a235be023a5119f1d8b55c710f195618575 (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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
/*
Minetest
Copyright (C) 2013 sapier, <sapier AT gmx DOT net>

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/

extern "C" {
#include "lua.h"
#include "lauxlib.h"
#include "lualib.h"
int luaopen_marshal(lua_State *L);
}
#include <stdio.h>

#include "l_async_events.h"
#include "log.h"
#include "filesys.h"
#include "porting.h"
#include "common/c_internal.h"

/******************************************************************************/
AsyncEngine::AsyncEngine() :
	m_initDone(false),
	m_JobIdCounter(0)
{
}

/******************************************************************************/
AsyncEngine::~AsyncEngine()
{
	/** request all threads to stop **/
	for (std::vector<AsyncWorkerThread*>::iterator i= m_WorkerThreads.begin();
			i != m_WorkerThreads.end();i++) {
		(*i)->Stop();
	}


	/** wakeup all threads **/
	for (std::vector<AsyncWorkerThread*>::iterator i= m_WorkerThreads.begin();
				i != m_WorkerThreads.end();i++) {
		m_JobQueueCounter.Post();
	}

	/** wait for threads to finish **/
	for (std::vector<AsyncWorkerThread*>::iterator i= m_WorkerThreads.begin();
			i != m_WorkerThreads.end();i++) {
		(*i)->Wait();
	}

	/** force kill all threads **/
	for (std::vector<AsyncWorkerThread*>::iterator i= m_WorkerThreads.begin();
			i != m_WorkerThreads.end();i++) {
		(*i)->Kill();
		delete *i;
	}

	m_JobQueueMutex.Lock();
	m_JobQueue.clear();
	m_JobQueueMutex.Unlock();
	m_WorkerThreads.clear();
}

/******************************************************************************/
bool AsyncEngine::registerFunction(const char* name, lua_CFunction fct) {

	if (m_initDone) return false;
	m_FunctionList[name] = fct;
	return true;
}

/******************************************************************************/
void AsyncEngine::Initialize(unsigned int numengines) {
	m_initDone = true;

	for (unsigned int i=0; i < numengines; i ++) {

		AsyncWorkerThread* toadd = new AsyncWorkerThread(this,i);
		m_WorkerThreads.push_back(toadd);
		toadd->Start();
	}
}

/******************************************************************************/
unsigned int AsyncEngine::doAsyncJob(std::string fct, std::string params) {

	m_JobQueueMutex.Lock();
	LuaJobInfo toadd;
	toadd.JobId = m_JobIdCounter++;
	toadd.serializedFunction = fct;
	toadd.serializedParams = params;

	m_JobQueue.push_back(toadd);

	m_JobQueueCounter.Post();

	m_JobQueueMutex.Unlock();

	return toadd.JobId;
}

/******************************************************************************/
LuaJobInfo AsyncEngine::getJob() {

	m_JobQueueCounter.Wait();
	m_JobQueueMutex.Lock();

	LuaJobInfo retval;
	retval.valid = false;

	if (m_JobQueue.size() != 0) {
		retval = m_JobQueue.front();
		retval.valid = true;
		m_JobQueue.erase((m_JobQueue.begin()));
	}
	m_JobQueueMutex.Unlock();

	return retval;
}

/******************************************************************************/
void AsyncEngine::putJobResult(LuaJobInfo result) {
	m_ResultQueueMutex.Lock();
	m_ResultQueue.push_back(result);
	m_ResultQueueMutex.Unlock();
}

/******************************************************************************/
void AsyncEngine::Step(lua_State *L) {
	lua_pushcfunction(L, script_error_handler);
	int errorhandler = lua_gettop(L);
	lua_getglobal(L, "engine");
	m_ResultQueueMutex.Lock();
	while(!m_ResultQueue.empty()) {
		LuaJobInfo jobdone = m_ResultQueue.front();
		m_ResultQueue.erase(m_ResultQueue.begin());

		lua_getfield(L, -1, "async_event_handler");

		if(lua_isnil(L, -1))
			assert("Someone managed to destroy a async callback in engine!" == 0);

		luaL_checktype(L, -1, LUA_TFUNCTION);

		lua_pushinteger(L, jobdone.JobId);
		lua_pushlstring(L, jobdone.serializedResult.c_str(),
				jobdone.serializedResult.length());

		if(lua_pcall(L, 2, 0, errorhandler)) {
			script_error(L);
		}
	}
	m_ResultQueueMutex.Unlock();
	lua_pop(L, 2); // Pop engine and error handler
}

/******************************************************************************/
void AsyncEngine::PushFinishedJobs(lua_State* L) {
	//Result Table
	m_ResultQueueMutex.Lock();

	unsigned int index=1;
	lua_newtable(L);
	int top = lua_gettop(L);

	while(!m_ResultQueue.empty()) {

		LuaJobInfo jobdone = m_ResultQueue.front();
		m_ResultQueue.erase(m_ResultQueue.begin());

		lua_pushnumber(L,index);

		lua_newtable(L);
		int top_lvl2 = lua_gettop(L);

		lua_pushstring(L,"jobid");
		lua_pushnumber(L,jobdone.JobId);
		lua_settable(L, top_lvl2);

		lua_pushstring(L,"retval");
		lua_pushstring(L, jobdone.serializedResult.c_str());
		lua_settable(L, top_lvl2);

		lua_settable(L, top);
		index++;
	}

	m_ResultQueueMutex.Unlock();

}
/******************************************************************************/
void AsyncEngine::PrepareEnvironment(lua_State* L, int top) {
	for(std::map<std::string,lua_CFunction>::iterator i = m_FunctionList.begin();
			i != m_FunctionList.end(); i++) {

		lua_pushstring(L,i->first.c_str());
		lua_pushcfunction(L,i->second);
		lua_settable(L, top);

	}
}

/******************************************************************************/
int async_worker_ErrorHandler(lua_State *L) {
	lua_getfield(L, LUA_GLOBALSINDEX, "debug");
	if (!lua_istable(L, -1)) {
	lua_pop(L, 1);
	return 1;
	}
	lua_getfield(L, -1, "traceback");
	if (!lua_isfunction(L, -1)) {
	lua_pop(L, 2);
	return 1;
	}
	lua_pushvalue(L, 1);
	lua_pushinteger(L, 2);
	lua_call(L, 2, 1);
	return 1;
}

/******************************************************************************/
AsyncWorkerThread::AsyncWorkerThread(AsyncEngine* jobdispatcher,
									unsigned int numthreadnumber) :
	m_JobDispatcher(jobdispatcher),
	m_luaerrorhandler(-1),
	m_threadnum(numthreadnumber)
{
	// create luastack
	m_LuaStack = luaL_newstate();

	// load basic lua modules
	luaL_openlibs(m_LuaStack);

	// load serialization functions
	luaopen_marshal(m_LuaStack);
}

/******************************************************************************/
AsyncWorkerThread::~AsyncWorkerThread() {

	assert(IsRunning() == false);
	lua_close(m_LuaStack);
}

/******************************************************************************/
void* AsyncWorkerThread::worker_thread_main() {

	//register thread for error logging
	char number[21];
	snprintf(number,sizeof(number),"%d",m_threadnum);
	log_register_thread(std::string("AsyncWorkerThread_") + number);

	porting::setThreadName(
			std::string(std::string("AsyncWorkTh_") + number).c_str());

	/** prepare job lua environment **/
	lua_newtable(m_LuaStack);
	lua_setglobal(m_LuaStack, "engine");

	lua_getglobal(m_LuaStack, "engine");
	int top = lua_gettop(m_LuaStack);

	lua_pushstring(m_LuaStack, DIR_DELIM);
	lua_setglobal(m_LuaStack, "DIR_DELIM");

	lua_pushstring(m_LuaStack,
			std::string(porting::path_share + DIR_DELIM + "builtin").c_str());
	lua_setglobal(m_LuaStack, "SCRIPTDIR");


	m_JobDispatcher->PrepareEnvironment(m_LuaStack,top);

	std::string asyncscript =
	porting::path_share + DIR_DELIM + "builtin"
			+ DIR_DELIM + "async_env.lua";

	lua_pushcfunction(m_LuaStack, async_worker_ErrorHandler);
	m_luaerrorhandler = lua_gettop(m_LuaStack);

	if(!runScript(asyncscript)) {
		infostream
			<< "AsyncWorkderThread::worker_thread_main execution of async base environment failed!"
			<< std::endl;
			assert("no future with broken builtin async environment scripts" == 0);
	}
	/** main loop **/
	while(!StopRequested()) {
		//wait for job
		LuaJobInfo toprocess = m_JobDispatcher->getJob();

		if (toprocess.valid == false) { continue; }
		if (StopRequested()) { continue; }

		//first push error handler
		lua_pushcfunction(m_LuaStack, script_error_handler);
		int errorhandler = lua_gettop(m_LuaStack);

		lua_getglobal(m_LuaStack, "engine");
		if(lua_isnil(m_LuaStack, -1))
			assert("unable to find engine within async environment" == 0);

		lua_getfield(m_LuaStack, -1, "job_processor");
		if(lua_isnil(m_LuaStack, -1))
			assert("Someone managed to destroy a async worker engine!" == 0);

		luaL_checktype(m_LuaStack, -1, LUA_TFUNCTION);

		//call it
		lua_pushlstring(m_LuaStack,
						toprocess.serializedFunction.c_str(),
						toprocess.serializedFunction.length());
		lua_pushlstring(m_LuaStack,
						toprocess.serializedParams.c_str(),
						toprocess.serializedParams.length());

		if (StopRequested()) { continue; }
		if(lua_pcall(m_LuaStack, 2, 2, errorhandler)) {
			script_error(m_LuaStack);
			toprocess.serializedResult = "ERROR";
		} else {
			//fetch result
			const char *retval = lua_tostring(m_LuaStack, -2);
			unsigned int lenght = lua_tointeger(m_LuaStack,-1);
			toprocess.serializedResult = std::string(retval,lenght);
		}

		if (StopRequested()) { continue; }
		//put job result
		m_JobDispatcher->putJobResult(toprocess);
	}
	log_deregister_thread();
	return 0;
}

/******************************************************************************/
bool AsyncWorkerThread::runScript(std::string script) {

	int ret = 	luaL_loadfile(m_LuaStack, script.c_str()) ||
				lua_pcall(m_LuaStack, 0, 0, m_luaerrorhandler);
	if(ret){
		errorstream<<"==== ERROR FROM LUA WHILE INITIALIZING ASYNC ENVIRONMENT ====="<<std::endl;
		errorstream<<"Failed to load and run script from "<<std::endl;
		errorstream<<script<<":"<<std::endl;
		errorstream<<std::endl;
		errorstream<<lua_tostring(m_LuaStack, -1)<<std::endl;
		errorstream<<std::endl;
		errorstream<<"=================== END OF ERROR FROM LUA ===================="<<std::endl;
		lua_pop(m_LuaStack, 1); // Pop error message from stack
		lua_pop(m_LuaStack, 1); // Pop the error handler from stack
		return false;
	}
	return true;
}

/******************************************************************************/
void* AsyncWorkerThread::worker_thread_wrapper(void* thread) {
	return ((AsyncWorkerThread*) thread)->worker_thread_main();
}