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 |
* |
* |
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) { |
ScriptVM::ScriptVM() : m_eventHandler(NULL), m_parserContext(NULL), m_autoSuspend(true) { |
135 |
m_fnMessage = new CoreVMFunction_message; |
m_fnMessage = new CoreVMFunction_message; |
136 |
m_fnExit = new CoreVMFunction_exit; |
m_fnExit = new CoreVMFunction_exit; |
137 |
m_fnWait = new CoreVMFunction_wait(this); |
m_fnWait = new CoreVMFunction_wait(this); |
140 |
m_fnNumElements = new CoreVMFunction_num_elements; |
m_fnNumElements = new CoreVMFunction_num_elements; |
141 |
m_fnInc = new CoreVMFunction_inc; |
m_fnInc = new CoreVMFunction_inc; |
142 |
m_fnDec = new CoreVMFunction_dec; |
m_fnDec = new CoreVMFunction_dec; |
143 |
|
m_fnInRange = new CoreVMFunction_in_range; |
144 |
m_varRealTimer = new CoreVMDynVar_NKSP_REAL_TIMER; |
m_varRealTimer = new CoreVMDynVar_NKSP_REAL_TIMER; |
145 |
m_varPerfTimer = new CoreVMDynVar_NKSP_PERF_TIMER; |
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 |
|
m_fnArrayEqual = new CoreVMFunction_array_equal; |
151 |
|
m_fnSearch = new CoreVMFunction_search; |
152 |
|
m_fnSort = new CoreVMFunction_sort; |
153 |
} |
} |
154 |
|
|
155 |
ScriptVM::~ScriptVM() { |
ScriptVM::~ScriptVM() { |
161 |
delete m_fnNumElements; |
delete m_fnNumElements; |
162 |
delete m_fnInc; |
delete m_fnInc; |
163 |
delete m_fnDec; |
delete m_fnDec; |
164 |
|
delete m_fnInRange; |
165 |
|
delete m_fnShLeft; |
166 |
|
delete m_fnShRight; |
167 |
|
delete m_fnMin; |
168 |
|
delete m_fnMax; |
169 |
|
delete m_fnArrayEqual; |
170 |
|
delete m_fnSearch; |
171 |
|
delete m_fnSort; |
172 |
delete m_varRealTimer; |
delete m_varRealTimer; |
173 |
delete m_varPerfTimer; |
delete m_varPerfTimer; |
174 |
} |
} |
270 |
else if (name == "num_elements") return m_fnNumElements; |
else if (name == "num_elements") return m_fnNumElements; |
271 |
else if (name == "inc") return m_fnInc; |
else if (name == "inc") return m_fnInc; |
272 |
else if (name == "dec") return m_fnDec; |
else if (name == "dec") return m_fnDec; |
273 |
|
else if (name == "in_range") return m_fnInRange; |
274 |
|
else if (name == "sh_left") return m_fnShLeft; |
275 |
|
else if (name == "sh_right") return m_fnShRight; |
276 |
|
else if (name == "min") return m_fnMin; |
277 |
|
else if (name == "max") return m_fnMax; |
278 |
|
else if (name == "array_equal") return m_fnArrayEqual; |
279 |
|
else if (name == "search") return m_fnSearch; |
280 |
|
else if (name == "sort") return m_fnSort; |
281 |
return NULL; |
return NULL; |
282 |
} |
} |
283 |
|
|
323 |
return m_parserContext->execContext; |
return m_parserContext->execContext; |
324 |
} |
} |
325 |
|
|
326 |
|
void ScriptVM::setAutoSuspendEnabled(bool b) { |
327 |
|
m_autoSuspend = b; |
328 |
|
} |
329 |
|
|
330 |
|
bool ScriptVM::isAutoSuspendEnabled() const { |
331 |
|
return m_autoSuspend; |
332 |
|
} |
333 |
|
|
334 |
VMExecStatus_t ScriptVM::exec(VMParserContext* parserContext, VMExecContext* execContex, VMEventHandler* handler) { |
VMExecStatus_t ScriptVM::exec(VMParserContext* parserContext, VMExecContext* execContex, VMEventHandler* handler) { |
335 |
m_parserContext = dynamic_cast<ParserContext*>(parserContext); |
m_parserContext = dynamic_cast<ParserContext*>(parserContext); |
336 |
if (!m_parserContext) { |
if (!m_parserContext) { |
353 |
m_parserContext->execContext = ctx; |
m_parserContext->execContext = ctx; |
354 |
|
|
355 |
ctx->status = VM_EXEC_RUNNING; |
ctx->status = VM_EXEC_RUNNING; |
356 |
|
ctx->instructionsCount = 0; |
357 |
StmtFlags_t flags = STMT_SUCCESS; |
StmtFlags_t flags = STMT_SUCCESS; |
358 |
|
int instructionsCounter = 0; |
359 |
|
|
360 |
int& frameIdx = ctx->stackFrame; |
int& frameIdx = ctx->stackFrame; |
361 |
if (frameIdx < 0) { // start condition ... |
if (frameIdx < 0) { // start condition ... |
432 |
ctx->pushStack( |
ctx->pushStack( |
433 |
whileStmt->statements() |
whileStmt->statements() |
434 |
); |
); |
435 |
|
if (flags == STMT_SUCCESS && m_autoSuspend && |
436 |
|
instructionsCounter > SCRIPTVM_MAX_INSTR_PER_CYCLE_SOFT) |
437 |
|
{ |
438 |
|
flags = StmtFlags_t(STMT_SUSPEND_SIGNALLED); |
439 |
|
ctx->suspendMicroseconds = SCRIPT_VM_FORCE_SUSPENSION_MICROSECONDS; |
440 |
|
} |
441 |
} else ctx->popStack(); |
} else ctx->popStack(); |
442 |
|
break; |
443 |
} |
} |
444 |
} |
} |
445 |
|
|
446 |
|
if (flags == STMT_SUCCESS && m_autoSuspend && |
447 |
|
instructionsCounter > SCRIPTVM_MAX_INSTR_PER_CYCLE_HARD) |
448 |
|
{ |
449 |
|
flags = StmtFlags_t(STMT_SUSPEND_SIGNALLED); |
450 |
|
ctx->suspendMicroseconds = SCRIPT_VM_FORCE_SUSPENSION_MICROSECONDS; |
451 |
|
} |
452 |
|
|
453 |
|
++instructionsCounter; |
454 |
} |
} |
455 |
|
|
456 |
if (flags & STMT_SUSPEND_SIGNALLED) { |
if (flags & STMT_SUSPEND_SIGNALLED) { |
462 |
ctx->reset(); |
ctx->reset(); |
463 |
} |
} |
464 |
|
|
465 |
|
ctx->instructionsCount = instructionsCounter; |
466 |
|
|
467 |
m_eventHandler = NULL; |
m_eventHandler = NULL; |
468 |
m_parserContext->execContext = NULL; |
m_parserContext->execContext = NULL; |
469 |
m_parserContext = NULL; |
m_parserContext = NULL; |