/[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 2970 by schoenebeck, Thu Jul 21 16:22:55 2016 UTC revision 3260 by schoenebeck, Wed May 31 21:07:44 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;          m_fnShLeft = new CoreVMFunction_sh_left;
159          m_fnShRight = new CoreVMFunction_sh_right;          m_fnShRight = new CoreVMFunction_sh_right;
160          m_fnMin = new CoreVMFunction_min;          m_fnMin = new CoreVMFunction_min;
161          m_fnMax = new CoreVMFunction_max;          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 118  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;          delete m_fnShLeft;
178          delete m_fnShRight;          delete m_fnShRight;
179          delete m_fnMin;          delete m_fnMin;
180          delete m_fnMax;          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 223  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;          else if (name == "sh_left") return m_fnShLeft;
287          else if (name == "sh_right") return m_fnShRight;          else if (name == "sh_right") return m_fnShRight;
288          else if (name == "min") return m_fnMin;          else if (name == "min") return m_fnMin;
289          else if (name == "max") return m_fnMax;          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    
# Line 272  namespace LinuxSampler { Line 335  namespace LinuxSampler {
335          return m_parserContext->execContext;          return m_parserContext->execContext;
336      }      }
337    
338        void ScriptVM::setAutoSuspendEnabled(bool b) {
339            m_autoSuspend = b;
340        }
341    
342        bool ScriptVM::isAutoSuspendEnabled() const {
343            return m_autoSuspend;
344        }
345    
346      VMExecStatus_t ScriptVM::exec(VMParserContext* parserContext, VMExecContext* execContex, VMEventHandler* handler) {      VMExecStatus_t ScriptVM::exec(VMParserContext* parserContext, VMExecContext* execContex, VMEventHandler* handler) {
347          m_parserContext = dynamic_cast<ParserContext*>(parserContext);          m_parserContext = dynamic_cast<ParserContext*>(parserContext);
348          if (!m_parserContext) {          if (!m_parserContext) {
# Line 294  namespace LinuxSampler { Line 365  namespace LinuxSampler {
365          m_parserContext->execContext = ctx;          m_parserContext->execContext = ctx;
366    
367          ctx->status = VM_EXEC_RUNNING;          ctx->status = VM_EXEC_RUNNING;
368            ctx->instructionsCount = 0;
369          StmtFlags_t flags = STMT_SUCCESS;          StmtFlags_t flags = STMT_SUCCESS;
370            int instructionsCounter = 0;
371            int synced = m_autoSuspend ? 0 : 1;
372    
373          int& frameIdx = ctx->stackFrame;          int& frameIdx = ctx->stackFrame;
374          if (frameIdx < 0) { // start condition ...          if (frameIdx < 0) { // start condition ...
# Line 371  namespace LinuxSampler { Line 445  namespace LinuxSampler {
445                          ctx->pushStack(                          ctx->pushStack(
446                              whileStmt->statements()                              whileStmt->statements()
447                          );                          );
448                            if (flags == STMT_SUCCESS && !synced &&
449                                instructionsCounter > SCRIPTVM_MAX_INSTR_PER_CYCLE_SOFT)
450                            {
451                                flags = StmtFlags_t(STMT_SUSPEND_SIGNALLED);
452                                ctx->suspendMicroseconds = SCRIPT_VM_FORCE_SUSPENSION_MICROSECONDS;
453                            }
454                      } else ctx->popStack();                      } else ctx->popStack();
455                        break;
456                    }
457    
458                    case STMT_SYNC: {
459                        #if DEBUG_SCRIPTVM_CORE
460                        _printIndents(frameIdx);
461                        printf("-> STMT_SYNC\n");
462                        #endif
463                        SyncBlock* syncStmt = (SyncBlock*) frame.statement;
464                        if (!frame.subindex++ && syncStmt->statements()) {
465                            ++synced;
466                            ctx->pushStack(
467                                syncStmt->statements()
468                            );
469                        } else {
470                            ctx->popStack();
471                            --synced;
472                        }
473                        break;
474                  }                  }
475              }              }
476    
477                if (flags == STMT_SUCCESS && !synced &&
478                    instructionsCounter > SCRIPTVM_MAX_INSTR_PER_CYCLE_HARD)
479                {
480                    flags = StmtFlags_t(STMT_SUSPEND_SIGNALLED);
481                    ctx->suspendMicroseconds = SCRIPT_VM_FORCE_SUSPENSION_MICROSECONDS;
482                }
483    
484                ++instructionsCounter;
485          }          }
486    
487          if (flags & STMT_SUSPEND_SIGNALLED) {          if (flags & STMT_SUSPEND_SIGNALLED) {
# Line 385  namespace LinuxSampler { Line 493  namespace LinuxSampler {
493              ctx->reset();              ctx->reset();
494          }          }
495    
496            ctx->instructionsCount = instructionsCounter;
497    
498          m_eventHandler = NULL;          m_eventHandler = NULL;
499          m_parserContext->execContext = NULL;          m_parserContext->execContext = NULL;
500          m_parserContext = NULL;          m_parserContext = NULL;
Legend:
Removed from v.2970  
changed lines
  Added in v.3260
  ViewVC Help
Powered by ViewVC