/[svn]/linuxsampler/trunk/src/scriptvm/ScriptVM.cpp
ViewVC logotype

Diff of /linuxsampler/trunk/src/scriptvm/ScriptVM.cpp

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 2948 by schoenebeck, Fri Jul 15 15:29:04 2016 UTC revision 3311 by schoenebeck, Sat Jul 15 16:24:59 2017 UTC
# Line 1  Line 1 
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   *   *
# Line 19  Line 19 
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;
# Line 78  namespace LinuxSampler { Line 117  namespace LinuxSampler {
117                  else                  else
118                      return 1;                      return 1;
119              }              }
120    
121                case STMT_SYNC: {
122                    #if DEBUG_SCRIPTVM_CORE
123                    _printIndents(depth);
124                    printf("-> STMT_SYNC\n");
125                    #endif
126                    SyncBlock* syncStmt = (SyncBlock*) statement;
127                    if (syncStmt->statements())
128                        return _requiredMaxStackSizeFor( syncStmt->statements() ) + 1;
129                    else
130                        return 1;
131                }
132          }          }
133    
134          return 1; // actually just to avoid compiler warning          return 1; // actually just to avoid compiler warning
# Line 92  namespace LinuxSampler { Line 143  namespace LinuxSampler {
143          return max;          return max;
144      }      }
145    
146      ScriptVM::ScriptVM() : m_eventHandler(NULL), m_parserContext(NULL) {      ScriptVM::ScriptVM() : m_eventHandler(NULL), m_parserContext(NULL), m_autoSuspend(true) {
147          m_fnMessage = new CoreVMFunction_message;          m_fnMessage = new CoreVMFunction_message;
148          m_fnExit = new CoreVMFunction_exit;          m_fnExit = new CoreVMFunction_exit;
149          m_fnWait = new CoreVMFunction_wait(this);          m_fnWait = new CoreVMFunction_wait(this);
# Line 101  namespace LinuxSampler { Line 152  namespace LinuxSampler {
152          m_fnNumElements = new CoreVMFunction_num_elements;          m_fnNumElements = new CoreVMFunction_num_elements;
153          m_fnInc = new CoreVMFunction_inc;          m_fnInc = new CoreVMFunction_inc;
154          m_fnDec = new CoreVMFunction_dec;          m_fnDec = new CoreVMFunction_dec;
155            m_fnInRange = new CoreVMFunction_in_range;
156          m_varRealTimer = new CoreVMDynVar_NKSP_REAL_TIMER;          m_varRealTimer = new CoreVMDynVar_NKSP_REAL_TIMER;
157          m_varPerfTimer = new CoreVMDynVar_NKSP_PERF_TIMER;          m_varPerfTimer = new CoreVMDynVar_NKSP_PERF_TIMER;
158            m_fnShLeft = new CoreVMFunction_sh_left;
159            m_fnShRight = new CoreVMFunction_sh_right;
160            m_fnMin = new CoreVMFunction_min;
161            m_fnMax = new CoreVMFunction_max;
162            m_fnArrayEqual = new CoreVMFunction_array_equal;
163            m_fnSearch = new CoreVMFunction_search;
164            m_fnSort = new CoreVMFunction_sort;
165      }      }
166    
167      ScriptVM::~ScriptVM() {      ScriptVM::~ScriptVM() {
# Line 114  namespace LinuxSampler { Line 173  namespace LinuxSampler {
173          delete m_fnNumElements;          delete m_fnNumElements;
174          delete m_fnInc;          delete m_fnInc;
175          delete m_fnDec;          delete m_fnDec;
176            delete m_fnInRange;
177            delete m_fnShLeft;
178            delete m_fnShRight;
179            delete m_fnMin;
180            delete m_fnMax;
181            delete m_fnArrayEqual;
182            delete m_fnSearch;
183            delete m_fnSort;
184          delete m_varRealTimer;          delete m_varRealTimer;
185          delete m_varPerfTimer;          delete m_varPerfTimer;
186      }      }
# Line 215  namespace LinuxSampler { Line 282  namespace LinuxSampler {
282          else if (name == "num_elements") return m_fnNumElements;          else if (name == "num_elements") return m_fnNumElements;
283          else if (name == "inc") return m_fnInc;          else if (name == "inc") return m_fnInc;
284          else if (name == "dec") return m_fnDec;          else if (name == "dec") return m_fnDec;
285            else if (name == "in_range") return m_fnInRange;
286            else if (name == "sh_left") return m_fnShLeft;
287            else if (name == "sh_right") return m_fnShRight;
288            else if (name == "min") return m_fnMin;
289            else if (name == "max") return m_fnMax;
290            else if (name == "array_equal") return m_fnArrayEqual;
291            else if (name == "search") return m_fnSearch;
292            else if (name == "sort") return m_fnSort;
293          return NULL;          return NULL;
294      }      }
295    
296        bool ScriptVM::isFunctionDisabled(VMFunction* fn, VMParserContext* ctx) {
297            ParserContext* parserCtx = dynamic_cast<ParserContext*>(ctx);
298            if (!parserCtx) return false;
299    
300            if (fn == m_fnMessage && parserCtx->userPreprocessorConditions.count("NKSP_NO_MESSAGE"))
301                return true;
302    
303            return false;
304        }
305    
306      std::map<String,VMIntRelPtr*> ScriptVM::builtInIntVariables() {      std::map<String,VMIntRelPtr*> ScriptVM::builtInIntVariables() {
307          return std::map<String,VMIntRelPtr*>();          return std::map<String,VMIntRelPtr*>();
308      }      }
# Line 260  namespace LinuxSampler { Line 345  namespace LinuxSampler {
345          return m_parserContext->execContext;          return m_parserContext->execContext;
346      }      }
347    
348        void ScriptVM::setAutoSuspendEnabled(bool b) {
349            m_autoSuspend = b;
350        }
351    
352        bool ScriptVM::isAutoSuspendEnabled() const {
353            return m_autoSuspend;
354        }
355    
356      VMExecStatus_t ScriptVM::exec(VMParserContext* parserContext, VMExecContext* execContex, VMEventHandler* handler) {      VMExecStatus_t ScriptVM::exec(VMParserContext* parserContext, VMExecContext* execContex, VMEventHandler* handler) {
357          m_parserContext = dynamic_cast<ParserContext*>(parserContext);          m_parserContext = dynamic_cast<ParserContext*>(parserContext);
358          if (!m_parserContext) {          if (!m_parserContext) {
# Line 282  namespace LinuxSampler { Line 375  namespace LinuxSampler {
375          m_parserContext->execContext = ctx;          m_parserContext->execContext = ctx;
376    
377          ctx->status = VM_EXEC_RUNNING;          ctx->status = VM_EXEC_RUNNING;
378          StmtFlags_t flags = STMT_SUCCESS;          ctx->instructionsCount = 0;
379            StmtFlags_t& flags = ctx->flags;
380            int instructionsCounter = 0;
381            int synced = m_autoSuspend ? 0 : 1;
382    
383          int& frameIdx = ctx->stackFrame;          int& frameIdx = ctx->stackFrame;
384          if (frameIdx < 0) { // start condition ...          if (frameIdx < 0) { // start condition ...
# Line 359  namespace LinuxSampler { Line 455  namespace LinuxSampler {
455                          ctx->pushStack(                          ctx->pushStack(
456                              whileStmt->statements()                              whileStmt->statements()
457                          );                          );
458                            if (flags == STMT_SUCCESS && !synced &&
459                                instructionsCounter > SCRIPTVM_MAX_INSTR_PER_CYCLE_SOFT)
460                            {
461                                flags = StmtFlags_t(STMT_SUSPEND_SIGNALLED);
462                                ctx->suspendMicroseconds = SCRIPT_VM_FORCE_SUSPENSION_MICROSECONDS;
463                            }
464                      } else ctx->popStack();                      } else ctx->popStack();
465                        break;
466                    }
467    
468                    case STMT_SYNC: {
469                        #if DEBUG_SCRIPTVM_CORE
470                        _printIndents(frameIdx);
471                        printf("-> STMT_SYNC\n");
472                        #endif
473                        SyncBlock* syncStmt = (SyncBlock*) frame.statement;
474                        if (!frame.subindex++ && syncStmt->statements()) {
475                            ++synced;
476                            ctx->pushStack(
477                                syncStmt->statements()
478                            );
479                        } else {
480                            ctx->popStack();
481                            --synced;
482                        }
483                        break;
484                  }                  }
485              }              }
486    
487                if (flags == STMT_SUCCESS && !synced &&
488                    instructionsCounter > SCRIPTVM_MAX_INSTR_PER_CYCLE_HARD)
489                {
490                    flags = StmtFlags_t(STMT_SUSPEND_SIGNALLED);
491                    ctx->suspendMicroseconds = SCRIPT_VM_FORCE_SUSPENSION_MICROSECONDS;
492                }
493    
494                ++instructionsCounter;
495          }          }
496    
497          if (flags & STMT_SUSPEND_SIGNALLED) {          if ((flags & STMT_SUSPEND_SIGNALLED) && !(flags & STMT_ABORT_SIGNALLED)) {
498              ctx->status = VM_EXEC_SUSPENDED;              ctx->status = VM_EXEC_SUSPENDED;
499                ctx->flags  = STMT_SUCCESS;
500          } else {          } else {
501              ctx->status = VM_EXEC_NOT_RUNNING;              ctx->status = VM_EXEC_NOT_RUNNING;
502              if (flags & STMT_ERROR_OCCURRED)              if (flags & STMT_ERROR_OCCURRED)
# Line 373  namespace LinuxSampler { Line 504  namespace LinuxSampler {
504              ctx->reset();              ctx->reset();
505          }          }
506    
507            ctx->instructionsCount = instructionsCounter;
508    
509          m_eventHandler = NULL;          m_eventHandler = NULL;
510          m_parserContext->execContext = NULL;          m_parserContext->execContext = NULL;
511          m_parserContext = NULL;          m_parserContext = NULL;
Legend:
Removed from v.2948  
changed lines
  Added in v.3311
  ViewVC Help
Powered by ViewVC