1 |
/* |
/* |
2 |
* Copyright (c) 2014 - 2016 Christian Schoenebeck |
* Copyright (c) 2014 - 2017 Christian Schoenebeck |
3 |
* |
* |
4 |
* http://www.linuxsampler.org |
* http://www.linuxsampler.org |
5 |
* |
* |
13 |
#include <assert.h> |
#include <assert.h> |
14 |
#include "../common/global_private.h" |
#include "../common/global_private.h" |
15 |
#include "tree.h" |
#include "tree.h" |
16 |
|
#include "CoreVMFunctions.h" |
17 |
|
#include "CoreVMDynVars.h" |
18 |
|
#include "editor/NkspScanner.h" |
19 |
|
|
20 |
#define DEBUG_SCRIPTVM_CORE 0 |
#define DEBUG_SCRIPTVM_CORE 0 |
21 |
|
|
22 |
|
/** |
23 |
|
* Maximum amount of VM instructions to be executed per ScriptVM::exec() call |
24 |
|
* in case loops are involved, before the script got automatically suspended |
25 |
|
* for a certain amount of time to avoid any RT instability issues. |
26 |
|
* |
27 |
|
* The following value takes a max. execution time of 300 microseconds as aimed |
28 |
|
* target, assuming an execution time of approximately 5 microseconds per |
29 |
|
* instruction this leads to the very approximate value set below. |
30 |
|
*/ |
31 |
|
#define SCRIPTVM_MAX_INSTR_PER_CYCLE_SOFT 70 |
32 |
|
|
33 |
|
/** |
34 |
|
* Absolute maximum amount of VM instructions to be executed per |
35 |
|
* ScriptVM::exec() call (even if no loops are involved), before the script got |
36 |
|
* automatically suspended for a certain amount of time to avoid any RT |
37 |
|
* instability issues. |
38 |
|
* |
39 |
|
* A distinction between "soft" and "hard" limit is done here ATM because a |
40 |
|
* script author typically expects that his script might be interrupted |
41 |
|
* automatically if he is using while() loops, however he might not be |
42 |
|
* prepared that his script might also be interrupted if no loop is involved |
43 |
|
* (i.e. on very large scripts). |
44 |
|
* |
45 |
|
* The following value takes a max. execution time of 1000 microseconds as |
46 |
|
* aimed target, assuming an execution time of approximately 5 microseconds per |
47 |
|
* instruction this leads to the very approximate value set below. |
48 |
|
*/ |
49 |
|
#define SCRIPTVM_MAX_INSTR_PER_CYCLE_HARD 210 |
50 |
|
|
51 |
|
/** |
52 |
|
* In case either SCRIPTVM_MAX_INSTR_PER_CYCLE_SOFT or |
53 |
|
* SCRIPTVM_MAX_INSTR_PER_CYCLE_HARD was exceeded when calling |
54 |
|
* ScriptVM::exec() : the amount of microseconds the respective script |
55 |
|
* execution instance should be automatically suspended by the VM. |
56 |
|
*/ |
57 |
|
#define SCRIPT_VM_FORCE_SUSPENSION_MICROSECONDS 1000 |
58 |
|
|
59 |
int InstrScript_parse(LinuxSampler::ParserContext*); |
int InstrScript_parse(LinuxSampler::ParserContext*); |
60 |
|
|
61 |
namespace LinuxSampler { |
namespace LinuxSampler { |
62 |
|
|
63 |
|
#if DEBUG_SCRIPTVM_CORE |
64 |
static void _printIndents(int n) { |
static void _printIndents(int n) { |
65 |
for (int i = 0; i < n; ++i) printf(" "); |
for (int i = 0; i < n; ++i) printf(" "); |
66 |
fflush(stdout); |
fflush(stdout); |
67 |
} |
} |
68 |
|
#endif |
69 |
|
|
70 |
static int _requiredMaxStackSizeFor(Statement* statement, int depth = 0) { |
static int _requiredMaxStackSizeFor(Statement* statement, int depth = 0) { |
71 |
if (!statement) return 1; |
if (!statement) return 1; |
131 |
return max; |
return max; |
132 |
} |
} |
133 |
|
|
134 |
ScriptVM::ScriptVM() : m_eventHandler(NULL), m_parserContext(NULL), fnWait(this) { |
ScriptVM::ScriptVM() : m_eventHandler(NULL), m_parserContext(NULL), m_autoSuspend(true) { |
135 |
|
m_fnMessage = new CoreVMFunction_message; |
136 |
|
m_fnExit = new CoreVMFunction_exit; |
137 |
|
m_fnWait = new CoreVMFunction_wait(this); |
138 |
|
m_fnAbs = new CoreVMFunction_abs; |
139 |
|
m_fnRandom = new CoreVMFunction_random; |
140 |
|
m_fnNumElements = new CoreVMFunction_num_elements; |
141 |
|
m_fnInc = new CoreVMFunction_inc; |
142 |
|
m_fnDec = new CoreVMFunction_dec; |
143 |
|
m_fnInRange = new CoreVMFunction_in_range; |
144 |
|
m_varRealTimer = new CoreVMDynVar_NKSP_REAL_TIMER; |
145 |
|
m_varPerfTimer = new CoreVMDynVar_NKSP_PERF_TIMER; |
146 |
|
m_fnShLeft = new CoreVMFunction_sh_left; |
147 |
|
m_fnShRight = new CoreVMFunction_sh_right; |
148 |
|
m_fnMin = new CoreVMFunction_min; |
149 |
|
m_fnMax = new CoreVMFunction_max; |
150 |
} |
} |
151 |
|
|
152 |
ScriptVM::~ScriptVM() { |
ScriptVM::~ScriptVM() { |
153 |
|
delete m_fnMessage; |
154 |
|
delete m_fnExit; |
155 |
|
delete m_fnWait; |
156 |
|
delete m_fnAbs; |
157 |
|
delete m_fnRandom; |
158 |
|
delete m_fnNumElements; |
159 |
|
delete m_fnInc; |
160 |
|
delete m_fnDec; |
161 |
|
delete m_fnInRange; |
162 |
|
delete m_fnShLeft; |
163 |
|
delete m_fnShRight; |
164 |
|
delete m_fnMin; |
165 |
|
delete m_fnMax; |
166 |
|
delete m_varRealTimer; |
167 |
|
delete m_varPerfTimer; |
168 |
} |
} |
169 |
|
|
170 |
VMParserContext* ScriptVM::loadScript(const String& s) { |
VMParserContext* ScriptVM::loadScript(const String& s) { |
179 |
context->registerBuiltInConstIntVariables( builtInConstIntVariables() ); |
context->registerBuiltInConstIntVariables( builtInConstIntVariables() ); |
180 |
context->registerBuiltInIntVariables( builtInIntVariables() ); |
context->registerBuiltInIntVariables( builtInIntVariables() ); |
181 |
context->registerBuiltInIntArrayVariables( builtInIntArrayVariables() ); |
context->registerBuiltInIntArrayVariables( builtInIntArrayVariables() ); |
182 |
|
context->registerBuiltInDynVariables( builtInDynamicVariables() ); |
183 |
|
|
184 |
context->createScanner(is); |
context->createScanner(is); |
185 |
|
|
237 |
return execCtx; |
return execCtx; |
238 |
} |
} |
239 |
|
|
240 |
|
std::vector<VMSourceToken> ScriptVM::syntaxHighlighting(const String& s) { |
241 |
|
std::istringstream iss(s); |
242 |
|
return syntaxHighlighting(&iss); |
243 |
|
} |
244 |
|
|
245 |
|
std::vector<VMSourceToken> ScriptVM::syntaxHighlighting(std::istream* is) { |
246 |
|
NkspScanner scanner(is); |
247 |
|
std::vector<SourceToken> tokens = scanner.tokens(); |
248 |
|
std::vector<VMSourceToken> result; |
249 |
|
result.resize(tokens.size()); |
250 |
|
for (int i = 0; i < tokens.size(); ++i) { |
251 |
|
SourceToken* st = new SourceToken; |
252 |
|
*st = tokens[i]; |
253 |
|
result[i] = VMSourceToken(st); |
254 |
|
} |
255 |
|
return result; |
256 |
|
} |
257 |
|
|
258 |
VMFunction* ScriptVM::functionByName(const String& name) { |
VMFunction* ScriptVM::functionByName(const String& name) { |
259 |
if (name == "message") return &fnMessage; |
if (name == "message") return m_fnMessage; |
260 |
else if (name == "exit") return &fnExit; |
else if (name == "exit") return m_fnExit; |
261 |
else if (name == "wait") return &fnWait; |
else if (name == "wait") return m_fnWait; |
262 |
else if (name == "abs") return &fnAbs; |
else if (name == "abs") return m_fnAbs; |
263 |
else if (name == "random") return &fnRandom; |
else if (name == "random") return m_fnRandom; |
264 |
else if (name == "num_elements") return &fnNumElements; |
else if (name == "num_elements") return m_fnNumElements; |
265 |
|
else if (name == "inc") return m_fnInc; |
266 |
|
else if (name == "dec") return m_fnDec; |
267 |
|
else if (name == "in_range") return m_fnInRange; |
268 |
|
else if (name == "sh_left") return m_fnShLeft; |
269 |
|
else if (name == "sh_right") return m_fnShRight; |
270 |
|
else if (name == "min") return m_fnMin; |
271 |
|
else if (name == "max") return m_fnMax; |
272 |
return NULL; |
return NULL; |
273 |
} |
} |
274 |
|
|
280 |
return std::map<String,VMInt8Array*>(); |
return std::map<String,VMInt8Array*>(); |
281 |
} |
} |
282 |
|
|
283 |
|
std::map<String,VMDynVar*> ScriptVM::builtInDynamicVariables() { |
284 |
|
std::map<String,VMDynVar*> m; |
285 |
|
|
286 |
|
m["$NKSP_PERF_TIMER"] = m_varPerfTimer; |
287 |
|
m["$NKSP_REAL_TIMER"] = m_varRealTimer; |
288 |
|
m["$KSP_TIMER"] = m_varRealTimer; |
289 |
|
|
290 |
|
return m; |
291 |
|
} |
292 |
|
|
293 |
std::map<String,int> ScriptVM::builtInConstIntVariables() { |
std::map<String,int> ScriptVM::builtInConstIntVariables() { |
294 |
return std::map<String,int>(); |
std::map<String,int> m; |
295 |
|
|
296 |
|
m["$NI_CB_TYPE_INIT"] = VM_EVENT_HANDLER_INIT; |
297 |
|
m["$NI_CB_TYPE_NOTE"] = VM_EVENT_HANDLER_NOTE; |
298 |
|
m["$NI_CB_TYPE_RELEASE"] = VM_EVENT_HANDLER_RELEASE; |
299 |
|
m["$NI_CB_TYPE_CONTROLLER"] = VM_EVENT_HANDLER_CONTROLLER; |
300 |
|
|
301 |
|
return m; |
302 |
} |
} |
303 |
|
|
304 |
VMEventHandler* ScriptVM::currentVMEventHandler() { |
VMEventHandler* ScriptVM::currentVMEventHandler() { |
314 |
return m_parserContext->execContext; |
return m_parserContext->execContext; |
315 |
} |
} |
316 |
|
|
317 |
|
void ScriptVM::setAutoSuspendEnabled(bool b) { |
318 |
|
m_autoSuspend = b; |
319 |
|
} |
320 |
|
|
321 |
|
bool ScriptVM::isAutoSuspendEnabled() const { |
322 |
|
return m_autoSuspend; |
323 |
|
} |
324 |
|
|
325 |
VMExecStatus_t ScriptVM::exec(VMParserContext* parserContext, VMExecContext* execContex, VMEventHandler* handler) { |
VMExecStatus_t ScriptVM::exec(VMParserContext* parserContext, VMExecContext* execContex, VMEventHandler* handler) { |
326 |
m_parserContext = dynamic_cast<ParserContext*>(parserContext); |
m_parserContext = dynamic_cast<ParserContext*>(parserContext); |
327 |
if (!m_parserContext) { |
if (!m_parserContext) { |
345 |
|
|
346 |
ctx->status = VM_EXEC_RUNNING; |
ctx->status = VM_EXEC_RUNNING; |
347 |
StmtFlags_t flags = STMT_SUCCESS; |
StmtFlags_t flags = STMT_SUCCESS; |
348 |
|
int instructionsCounter = 0; |
349 |
|
|
350 |
int& frameIdx = ctx->stackFrame; |
int& frameIdx = ctx->stackFrame; |
351 |
if (frameIdx < 0) { // start condition ... |
if (frameIdx < 0) { // start condition ... |
422 |
ctx->pushStack( |
ctx->pushStack( |
423 |
whileStmt->statements() |
whileStmt->statements() |
424 |
); |
); |
425 |
|
if (flags == STMT_SUCCESS && m_autoSuspend && |
426 |
|
instructionsCounter > SCRIPTVM_MAX_INSTR_PER_CYCLE_SOFT) |
427 |
|
{ |
428 |
|
flags = StmtFlags_t(STMT_SUSPEND_SIGNALLED); |
429 |
|
ctx->suspendMicroseconds = SCRIPT_VM_FORCE_SUSPENSION_MICROSECONDS; |
430 |
|
} |
431 |
} else ctx->popStack(); |
} else ctx->popStack(); |
432 |
|
break; |
433 |
} |
} |
434 |
} |
} |
435 |
|
|
436 |
|
if (flags == STMT_SUCCESS && m_autoSuspend && |
437 |
|
instructionsCounter > SCRIPTVM_MAX_INSTR_PER_CYCLE_HARD) |
438 |
|
{ |
439 |
|
flags = StmtFlags_t(STMT_SUSPEND_SIGNALLED); |
440 |
|
ctx->suspendMicroseconds = SCRIPT_VM_FORCE_SUSPENSION_MICROSECONDS; |
441 |
|
} |
442 |
|
|
443 |
|
++instructionsCounter; |
444 |
} |
} |
445 |
|
|
446 |
if (flags & STMT_SUSPEND_SIGNALLED) { |
if (flags & STMT_SUSPEND_SIGNALLED) { |