src/scriptvm/ScriptVM.cpp

/*
 * Copyright (c) 2014 - 2016 Christian Schoenebeck
 *
 * http://www.linuxsampler.org
 *
 * This file is part of LinuxSampler and released under the same terms.
 * See README file for details.
 */

#include "ScriptVM.h"

#include <string.h>
#include <assert.h>
#include "../common/global_private.h"
#include "tree.h"
#include "CoreVMFunctions.h"
#include "CoreVMDynVars.h"
#include "editor/NkspScanner.h"

#define DEBUG_SCRIPTVM_CORE 0

/**
 * Maximum amount of VM instructions to be executed per ScriptVM::exec() call
 * in case loops are involved, before the script got automatically suspended
 * for a certain amount of time to avoid any RT instability issues.
 *
 * The following value takes a max. execution time of 300 microseconds as aimed
 * target, assuming an execution time of approximately 5 microseconds per
 * instruction this leads to the very approximate value set below.
 */
#define SCRIPTVM_MAX_INSTR_PER_CYCLE_SOFT 70

/**
 * Absolute maximum amount of VM instructions to be executed per
 * ScriptVM::exec() call (even if no loops are involved), before the script got
 * automatically suspended for a certain amount of time to avoid any RT
 * instability issues.
 *
 * A distinction between "soft" and "hard" limit is done here ATM because a
 * script author typically expects that his script might be interrupted
 * automatically if he is using while() loops, however he might not be
 * prepared that his script might also be interrupted if no loop is involved
 * (i.e. on very large scripts).
 *
 * The following value takes a max. execution time of 1000 microseconds as
 * aimed target, assuming an execution time of approximately 5 microseconds per
 * instruction this leads to the very approximate value set below.
 */
#define SCRIPTVM_MAX_INSTR_PER_CYCLE_HARD 210

/**
 * In case either SCRIPTVM_MAX_INSTR_PER_CYCLE_SOFT or
 * SCRIPTVM_MAX_INSTR_PER_CYCLE_HARD was exceeded when calling
 * ScriptVM::exec() : the amount of microseconds the respective script
 * execution instance should be automatically suspended by the VM.
 */
#define SCRIPT_VM_FORCE_SUSPENSION_MICROSECONDS 1000

int InstrScript_parse(LinuxSampler::ParserContext*);

namespace LinuxSampler {

    static void _printIndents(int n) {
        for (int i = 0; i < n; ++i) printf("  ");
        fflush(stdout);
    }

    static int _requiredMaxStackSizeFor(Statement* statement, int depth = 0) {
        if (!statement) return 1;

        switch (statement->statementType()) {
            case STMT_LEAF:
                #if DEBUG_SCRIPTVM_CORE
                _printIndents(depth);
                printf("-> STMT_LEAF\n");
                #endif
                return 1;

            case STMT_LIST: {
                #if DEBUG_SCRIPTVM_CORE
                _printIndents(depth);
                printf("-> STMT_LIST\n");
                #endif
                Statements* stmts = (Statements*) statement;
                int max = 0;
                for (int i = 0; stmts->statement(i); ++i) {
                    int size = _requiredMaxStackSizeFor( stmts->statement(i), depth+1 );
                    if (max < size) max = size;
                }
                return max + 1;
            }

            case STMT_BRANCH: {
                #if DEBUG_SCRIPTVM_CORE
                _printIndents(depth);
                printf("-> STMT_BRANCH\n");
                #endif
                BranchStatement* branchStmt = (BranchStatement*) statement;
                int max = 0;
                for (int i = 0; branchStmt->branch(i); ++i) {
                    int size = _requiredMaxStackSizeFor( branchStmt->branch(i), depth+1 );
                    if (max < size) max = size;
                }
                return max + 1;
            }

            case STMT_LOOP: {
                #if DEBUG_SCRIPTVM_CORE
                _printIndents(depth);
                printf("-> STMT_LOOP\n");
                #endif
                While* whileStmt = (While*) statement;
                if (whileStmt->statements())
                    return _requiredMaxStackSizeFor( whileStmt->statements() ) + 1;
                else
                    return 1;
            }
        }

        return 1; // actually just to avoid compiler warning
    }

    static int _requiredMaxStackSizeFor(EventHandlers* handlers) {
        int max = 1;
        for (int i = 0; i < handlers->size(); ++i) {
            int size = _requiredMaxStackSizeFor(handlers->eventHandler(i));
            if (max < size) max = size;
        }
        return max;
    }

    ScriptVM::ScriptVM() : m_eventHandler(NULL), m_parserContext(NULL), m_autoSuspend(true) {
        m_fnMessage = new CoreVMFunction_message;
        m_fnExit = new CoreVMFunction_exit;
        m_fnWait = new CoreVMFunction_wait(this);
        m_fnAbs = new CoreVMFunction_abs;
        m_fnRandom = new CoreVMFunction_random;
        m_fnNumElements = new CoreVMFunction_num_elements;
        m_fnInc = new CoreVMFunction_inc;
        m_fnDec = new CoreVMFunction_dec;
        m_varRealTimer = new CoreVMDynVar_NKSP_REAL_TIMER;
        m_varPerfTimer = new CoreVMDynVar_NKSP_PERF_TIMER;
        m_fnShLeft = new CoreVMFunction_sh_left;
        m_fnShRight = new CoreVMFunction_sh_right;
        m_fnMin = new CoreVMFunction_min;
        m_fnMax = new CoreVMFunction_max;
    }

    ScriptVM::~ScriptVM() {
        delete m_fnMessage;
        delete m_fnExit;
        delete m_fnWait;
        delete m_fnAbs;
        delete m_fnRandom;
        delete m_fnNumElements;
        delete m_fnInc;
        delete m_fnDec;
        delete m_fnShLeft;
        delete m_fnShRight;
        delete m_fnMin;
        delete m_fnMax;
        delete m_varRealTimer;
        delete m_varPerfTimer;
    }

    VMParserContext* ScriptVM::loadScript(const String& s) {
        std::istringstream iss(s);
        return loadScript(&iss);
    }
    
    VMParserContext* ScriptVM::loadScript(std::istream* is) {
        ParserContext* context = new ParserContext(this);
        //printf("parserCtx=0x%lx\n", (uint64_t)context);

        context->registerBuiltInConstIntVariables( builtInConstIntVariables() );
        context->registerBuiltInIntVariables( builtInIntVariables() );
        context->registerBuiltInIntArrayVariables( builtInIntArrayVariables() );
        context->registerBuiltInDynVariables( builtInDynamicVariables() );

        context->createScanner(is);

        InstrScript_parse(context);
        dmsg(2,("Allocating %ld bytes of global int VM memory.\n", long(context->globalIntVarCount * sizeof(int))));
        dmsg(2,("Allocating %d of global VM string variables.\n", context->globalStrVarCount));
        if (!context->globalIntMemory)
            context->globalIntMemory = new ArrayList<int>();
        if (!context->globalStrMemory)
            context->globalStrMemory = new ArrayList<String>();
        context->globalIntMemory->resize(context->globalIntVarCount);
        memset(&((*context->globalIntMemory)[0]), 0, context->globalIntVarCount * sizeof(int));
        
        context->globalStrMemory->resize(context->globalStrVarCount);

        context->destroyScanner();

        return context;
    }

    void ScriptVM::dumpParsedScript(VMParserContext* context) {
        ParserContext* ctx = dynamic_cast<ParserContext*>(context);
        if (!ctx) {
            std::cerr << "No VM context. So nothing to dump.\n";
            return;
        }
        if (!ctx->handlers) {
            std::cerr << "No event handlers defined in script. So nothing to dump.\n";
            return;
        }
        if (!ctx->globalIntMemory) {
            std::cerr << "Internal error: no global memory assigend to script VM.\n";
            return;
        }
        ctx->handlers->dump();
    }

    VMExecContext* ScriptVM::createExecContext(VMParserContext* parserContext) {
        ParserContext* parserCtx = dynamic_cast<ParserContext*>(parserContext);
        ExecContext* execCtx = new ExecContext();
        
        if (parserCtx->requiredMaxStackSize < 0) {
             parserCtx->requiredMaxStackSize =
                _requiredMaxStackSizeFor(&*parserCtx->handlers);
        }
        execCtx->stack.resize(parserCtx->requiredMaxStackSize);
        dmsg(2,("Created VM exec context with %ld bytes VM stack size.\n",
                long(parserCtx->requiredMaxStackSize * sizeof(ExecContext::StackFrame))));
        //printf("execCtx=0x%lx\n", (uint64_t)execCtx);
        const int polySize = parserCtx->polyphonicIntVarCount;
        execCtx->polyphonicIntMemory.resize(polySize);
        memset(&execCtx->polyphonicIntMemory[0], 0, polySize * sizeof(int));

        dmsg(2,("Allocated %ld bytes polyphonic memory.\n", long(polySize * sizeof(int))));
        return execCtx;
    }

    std::vector<VMSourceToken> ScriptVM::syntaxHighlighting(const String& s) {
        std::istringstream iss(s);
        return syntaxHighlighting(&iss);
    }

    std::vector<VMSourceToken> ScriptVM::syntaxHighlighting(std::istream* is) {
        NkspScanner scanner(is);
        std::vector<SourceToken> tokens = scanner.tokens();
        std::vector<VMSourceToken> result;
        result.resize(tokens.size());
        for (int i = 0; i < tokens.size(); ++i) {
            SourceToken* st = new SourceToken;
            *st = tokens[i];
            result[i] = VMSourceToken(st);
        }
        return result;
    }

    VMFunction* ScriptVM::functionByName(const String& name) {
        if (name == "message") return m_fnMessage;
        else if (name == "exit") return m_fnExit;
        else if (name == "wait") return m_fnWait;
        else if (name == "abs") return m_fnAbs;
        else if (name == "random") return m_fnRandom;
        else if (name == "num_elements") return m_fnNumElements;
        else if (name == "inc") return m_fnInc;
        else if (name == "dec") return m_fnDec;
        else if (name == "sh_left") return m_fnShLeft;
        else if (name == "sh_right") return m_fnShRight;
        else if (name == "min") return m_fnMin;
        else if (name == "max") return m_fnMax;
        return NULL;
    }

    std::map<String,VMIntRelPtr*> ScriptVM::builtInIntVariables() {
        return std::map<String,VMIntRelPtr*>();
    }

    std::map<String,VMInt8Array*> ScriptVM::builtInIntArrayVariables() {
        return std::map<String,VMInt8Array*>();
    }

    std::map<String,VMDynVar*> ScriptVM::builtInDynamicVariables() {
        std::map<String,VMDynVar*> m;

        m["$NKSP_PERF_TIMER"] = m_varPerfTimer;
        m["$NKSP_REAL_TIMER"] = m_varRealTimer;
        m["$KSP_TIMER"] = m_varRealTimer;

        return m;
    }

    std::map<String,int> ScriptVM::builtInConstIntVariables() {
        std::map<String,int> m;

        m["$NI_CB_TYPE_INIT"] = VM_EVENT_HANDLER_INIT;
        m["$NI_CB_TYPE_NOTE"] = VM_EVENT_HANDLER_NOTE;
        m["$NI_CB_TYPE_RELEASE"] = VM_EVENT_HANDLER_RELEASE;
        m["$NI_CB_TYPE_CONTROLLER"] = VM_EVENT_HANDLER_CONTROLLER;

        return m;
    }

    VMEventHandler* ScriptVM::currentVMEventHandler() {
        return m_eventHandler;
    }

    VMParserContext* ScriptVM::currentVMParserContext() {
        return m_parserContext;
    }

    VMExecContext* ScriptVM::currentVMExecContext() {
        if (!m_parserContext) return NULL;
        return m_parserContext->execContext;
    }

    void ScriptVM::setAutoSuspendEnabled(bool b) {
        m_autoSuspend = b;
    }

    bool ScriptVM::isAutoSuspendEnabled() const {
        return m_autoSuspend;
    }

    VMExecStatus_t ScriptVM::exec(VMParserContext* parserContext, VMExecContext* execContex, VMEventHandler* handler) {
        m_parserContext = dynamic_cast<ParserContext*>(parserContext);
        if (!m_parserContext) {
            std::cerr << "No VM parser context provided. Did you load a script?.\n";
            return VMExecStatus_t(VM_EXEC_NOT_RUNNING | VM_EXEC_ERROR);
        }

        // a ParserContext object is always tied to exactly one ScriptVM object
        assert(m_parserContext->functionProvider == this);

        ExecContext* ctx = dynamic_cast<ExecContext*>(execContex);
        if (!ctx) {
            std::cerr << "Invalid VM exec context.\n";
            return VMExecStatus_t(VM_EXEC_NOT_RUNNING | VM_EXEC_ERROR);
        }
        EventHandler* h = dynamic_cast<EventHandler*>(handler);
        if (!h) return VM_EXEC_NOT_RUNNING;
        m_eventHandler = handler;

        m_parserContext->execContext = ctx;

        ctx->status = VM_EXEC_RUNNING;
        StmtFlags_t flags = STMT_SUCCESS;
        int instructionsCounter = 0;

        int& frameIdx = ctx->stackFrame;
        if (frameIdx < 0) { // start condition ...
            frameIdx = -1;
            ctx->pushStack(h);
        }

        while (flags == STMT_SUCCESS && frameIdx >= 0) {
            if (frameIdx >= ctx->stack.size()) { // should never happen, otherwise it's a bug ...
                std::cerr << "CRITICAL: VM stack overflow! (" << frameIdx << ")\n";
                flags = StmtFlags_t(STMT_ABORT_SIGNALLED | STMT_ERROR_OCCURRED);
                break;
            }

            ExecContext::StackFrame& frame = ctx->stack[frameIdx];
            switch (frame.statement->statementType()) {
                case STMT_LEAF: {
                    #if DEBUG_SCRIPTVM_CORE
                    _printIndents(frameIdx);
                    printf("-> STMT_LEAF\n");
                    #endif
                    LeafStatement* leaf = (LeafStatement*) frame.statement;
                    flags = leaf->exec();
                    ctx->popStack();
                    break;
                }

                case STMT_LIST: {
                    #if DEBUG_SCRIPTVM_CORE
                    _printIndents(frameIdx);
                    printf("-> STMT_LIST subidx=%d\n", frame.subindex);
                    #endif
                    Statements* stmts = (Statements*) frame.statement;
                    if (stmts->statement(frame.subindex)) {
                        ctx->pushStack(
                            stmts->statement(frame.subindex++)
                        );
                    } else {
                        #if DEBUG_SCRIPTVM_CORE
                        _printIndents(frameIdx);
                        printf("[END OF LIST] subidx=%d\n", frame.subindex);
                        #endif
                        ctx->popStack();
                    }
                    break;
                }

                case STMT_BRANCH: {
                    #if DEBUG_SCRIPTVM_CORE
                    _printIndents(frameIdx);
                    printf("-> STMT_BRANCH\n");
                    #endif
                    if (frame.subindex < 0) ctx->popStack();
                    else {
                        BranchStatement* branchStmt = (BranchStatement*) frame.statement;
                        frame.subindex = branchStmt->evalBranch();
                        if (frame.subindex >= 0) {
                            ctx->pushStack(
                                branchStmt->branch(frame.subindex)
                            );
                            frame.subindex = -1;
                        } else ctx->popStack();
                    }
                    break;
                }

                case STMT_LOOP: {
                    #if DEBUG_SCRIPTVM_CORE
                    _printIndents(frameIdx);
                    printf("-> STMT_LOOP\n");
                    #endif
                    While* whileStmt = (While*) frame.statement;
                    if (whileStmt->evalLoopStartCondition() && whileStmt->statements()) {
                        ctx->pushStack(
                            whileStmt->statements()
                        );
                        if (flags == STMT_SUCCESS && m_autoSuspend &&
                            instructionsCounter > SCRIPTVM_MAX_INSTR_PER_CYCLE_SOFT)
                        {
                            flags = StmtFlags_t(STMT_SUSPEND_SIGNALLED);
                            ctx->suspendMicroseconds = SCRIPT_VM_FORCE_SUSPENSION_MICROSECONDS;
                        }
                    } else ctx->popStack();
                    break;
                }
            }

            if (flags == STMT_SUCCESS && m_autoSuspend &&
                instructionsCounter > SCRIPTVM_MAX_INSTR_PER_CYCLE_HARD)
            {
                flags = StmtFlags_t(STMT_SUSPEND_SIGNALLED);
                ctx->suspendMicroseconds = SCRIPT_VM_FORCE_SUSPENSION_MICROSECONDS;
            }

            ++instructionsCounter;
        }

        if (flags & STMT_SUSPEND_SIGNALLED) {
            ctx->status = VM_EXEC_SUSPENDED;
        } else {
            ctx->status = VM_EXEC_NOT_RUNNING;
            if (flags & STMT_ERROR_OCCURRED)
                ctx->status = VM_EXEC_ERROR;
            ctx->reset();
        }

        m_eventHandler = NULL;
        m_parserContext->execContext = NULL;
        m_parserContext = NULL;
        return ctx->status;
    }

} // namespace LinuxSampler
1	schoenebeck	2581	/*
2	schoenebeck	2879	* Copyright (c) 2014 - 2016 Christian Schoenebeck
3	schoenebeck	2581	*
4			* http://www.linuxsampler.org
5			*
6			* This file is part of LinuxSampler and released under the same terms.
7			* See README file for details.
8			*/
9
10			#include "ScriptVM.h"
11
12	schoenebeck	2588	#include <string.h>
13	schoenebeck	2619	#include <assert.h>
14	schoenebeck	2581	#include "../common/global_private.h"
15			#include "tree.h"
16	schoenebeck	2885	#include "CoreVMFunctions.h"
17	schoenebeck	2942	#include "CoreVMDynVars.h"
18	schoenebeck	2885	#include "editor/NkspScanner.h"
19	schoenebeck	2581
20			#define DEBUG_SCRIPTVM_CORE 0
21
22	schoenebeck	2974	/**
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	schoenebeck	2581	int InstrScript_parse(LinuxSampler::ParserContext*);
60
61			namespace LinuxSampler {
62
63			static void _printIndents(int n) {
64			for (int i = 0; i < n; ++i) printf(" ");
65			fflush(stdout);
66			}
67
68			static int _requiredMaxStackSizeFor(Statement* statement, int depth = 0) {
69			if (!statement) return 1;
70
71			switch (statement->statementType()) {
72			case STMT_LEAF:
73			#if DEBUG_SCRIPTVM_CORE
74			_printIndents(depth);
75			printf("-> STMT_LEAF\n");
76			#endif
77			return 1;
78
79			case STMT_LIST: {
80			#if DEBUG_SCRIPTVM_CORE
81			_printIndents(depth);
82			printf("-> STMT_LIST\n");
83			#endif
84			Statements* stmts = (Statements*) statement;
85			int max = 0;
86			for (int i = 0; stmts->statement(i); ++i) {
87			int size = _requiredMaxStackSizeFor( stmts->statement(i), depth+1 );
88			if (max < size) max = size;
89			}
90			return max + 1;
91			}
92
93			case STMT_BRANCH: {
94			#if DEBUG_SCRIPTVM_CORE
95			_printIndents(depth);
96			printf("-> STMT_BRANCH\n");
97			#endif
98			BranchStatement* branchStmt = (BranchStatement*) statement;
99			int max = 0;
100			for (int i = 0; branchStmt->branch(i); ++i) {
101			int size = _requiredMaxStackSizeFor( branchStmt->branch(i), depth+1 );
102			if (max < size) max = size;
103			}
104			return max + 1;
105			}
106
107			case STMT_LOOP: {
108			#if DEBUG_SCRIPTVM_CORE
109			_printIndents(depth);
110			printf("-> STMT_LOOP\n");
111			#endif
112			While* whileStmt = (While*) statement;
113			if (whileStmt->statements())
114			return _requiredMaxStackSizeFor( whileStmt->statements() ) + 1;
115			else
116			return 1;
117			}
118			}
119
120			return 1; // actually just to avoid compiler warning
121			}
122
123			static int _requiredMaxStackSizeFor(EventHandlers* handlers) {
124			int max = 1;
125			for (int i = 0; i < handlers->size(); ++i) {
126			int size = _requiredMaxStackSizeFor(handlers->eventHandler(i));
127			if (max < size) max = size;
128			}
129			return max;
130			}
131
132	schoenebeck	2974	ScriptVM::ScriptVM() : m_eventHandler(NULL), m_parserContext(NULL), m_autoSuspend(true) {
133	schoenebeck	2885	m_fnMessage = new CoreVMFunction_message;
134			m_fnExit = new CoreVMFunction_exit;
135			m_fnWait = new CoreVMFunction_wait(this);
136			m_fnAbs = new CoreVMFunction_abs;
137			m_fnRandom = new CoreVMFunction_random;
138			m_fnNumElements = new CoreVMFunction_num_elements;
139	schoenebeck	2945	m_fnInc = new CoreVMFunction_inc;
140			m_fnDec = new CoreVMFunction_dec;
141	schoenebeck	2942	m_varRealTimer = new CoreVMDynVar_NKSP_REAL_TIMER;
142			m_varPerfTimer = new CoreVMDynVar_NKSP_PERF_TIMER;
143	schoenebeck	2965	m_fnShLeft = new CoreVMFunction_sh_left;
144			m_fnShRight = new CoreVMFunction_sh_right;
145	schoenebeck	2970	m_fnMin = new CoreVMFunction_min;
146			m_fnMax = new CoreVMFunction_max;
147	schoenebeck	2581	}
148
149			ScriptVM::~ScriptVM() {
150	schoenebeck	2885	delete m_fnMessage;
151			delete m_fnExit;
152			delete m_fnWait;
153			delete m_fnAbs;
154			delete m_fnRandom;
155			delete m_fnNumElements;
156	schoenebeck	2945	delete m_fnInc;
157			delete m_fnDec;
158	schoenebeck	2965	delete m_fnShLeft;
159			delete m_fnShRight;
160	schoenebeck	2970	delete m_fnMin;
161			delete m_fnMax;
162	schoenebeck	2942	delete m_varRealTimer;
163			delete m_varPerfTimer;
164	schoenebeck	2581	}
165
166	schoenebeck	2588	VMParserContext* ScriptVM::loadScript(const String& s) {
167	schoenebeck	2581	std::istringstream iss(s);
168	schoenebeck	2588	return loadScript(&iss);
169	schoenebeck	2581	}
170
171	schoenebeck	2588	VMParserContext* ScriptVM::loadScript(std::istream* is) {
172			ParserContext* context = new ParserContext(this);
173			//printf("parserCtx=0x%lx\n", (uint64_t)context);
174	schoenebeck	2594
175			context->registerBuiltInConstIntVariables( builtInConstIntVariables() );
176			context->registerBuiltInIntVariables( builtInIntVariables() );
177			context->registerBuiltInIntArrayVariables( builtInIntArrayVariables() );
178	schoenebeck	2942	context->registerBuiltInDynVariables( builtInDynamicVariables() );
179	schoenebeck	2594
180	schoenebeck	2588	context->createScanner(is);
181	schoenebeck	2581
182	schoenebeck	2588	InstrScript_parse(context);
183	persson	2837	dmsg(2,("Allocating %ld bytes of global int VM memory.\n", long(context->globalIntVarCount * sizeof(int))));
184	schoenebeck	2611	dmsg(2,("Allocating %d of global VM string variables.\n", context->globalStrVarCount));
185	schoenebeck	2588	if (!context->globalIntMemory)
186			context->globalIntMemory = new ArrayList<int>();
187			if (!context->globalStrMemory)
188			context->globalStrMemory = new ArrayList<String>();
189			context->globalIntMemory->resize(context->globalIntVarCount);
190			memset(&((context->globalIntMemory)[0]), 0, context->globalIntVarCount sizeof(int));
191
192			context->globalStrMemory->resize(context->globalStrVarCount);
193	schoenebeck	2581
194	schoenebeck	2588	context->destroyScanner();
195	schoenebeck	2581
196	schoenebeck	2588	return context;
197	schoenebeck	2581	}
198
199	schoenebeck	2588	void ScriptVM::dumpParsedScript(VMParserContext* context) {
200			ParserContext* ctx = dynamic_cast<ParserContext*>(context);
201			if (!ctx) {
202	schoenebeck	2581	std::cerr << "No VM context. So nothing to dump.\n";
203			return;
204			}
205	schoenebeck	2588	if (!ctx->handlers) {
206	schoenebeck	2581	std::cerr << "No event handlers defined in script. So nothing to dump.\n";
207			return;
208			}
209	schoenebeck	2588	if (!ctx->globalIntMemory) {
210	schoenebeck	2581	std::cerr << "Internal error: no global memory assigend to script VM.\n";
211			return;
212			}
213	schoenebeck	2588	ctx->handlers->dump();
214	schoenebeck	2581	}
215
216	schoenebeck	2588	VMExecContext* ScriptVM::createExecContext(VMParserContext* parserContext) {
217			ParserContext* parserCtx = dynamic_cast<ParserContext*>(parserContext);
218			ExecContext* execCtx = new ExecContext();
219
220			if (parserCtx->requiredMaxStackSize < 0) {
221			parserCtx->requiredMaxStackSize =
222			_requiredMaxStackSizeFor(&*parserCtx->handlers);
223			}
224			execCtx->stack.resize(parserCtx->requiredMaxStackSize);
225	persson	2837	dmsg(2,("Created VM exec context with %ld bytes VM stack size.\n",
226			long(parserCtx->requiredMaxStackSize * sizeof(ExecContext::StackFrame))));
227	schoenebeck	2588	//printf("execCtx=0x%lx\n", (uint64_t)execCtx);
228			const int polySize = parserCtx->polyphonicIntVarCount;
229			execCtx->polyphonicIntMemory.resize(polySize);
230			memset(&execCtx->polyphonicIntMemory[0], 0, polySize * sizeof(int));
231
232	persson	2837	dmsg(2,("Allocated %ld bytes polyphonic memory.\n", long(polySize * sizeof(int))));
233	schoenebeck	2588	return execCtx;
234	schoenebeck	2581	}
235
236	schoenebeck	2885	std::vector<VMSourceToken> ScriptVM::syntaxHighlighting(const String& s) {
237			std::istringstream iss(s);
238			return syntaxHighlighting(&iss);
239			}
240
241			std::vector<VMSourceToken> ScriptVM::syntaxHighlighting(std::istream* is) {
242			NkspScanner scanner(is);
243			std::vector<SourceToken> tokens = scanner.tokens();
244			std::vector<VMSourceToken> result;
245			result.resize(tokens.size());
246			for (int i = 0; i < tokens.size(); ++i) {
247			SourceToken* st = new SourceToken;
248			*st = tokens[i];
249			result[i] = VMSourceToken(st);
250			}
251			return result;
252			}
253
254	schoenebeck	2581	VMFunction* ScriptVM::functionByName(const String& name) {
255	schoenebeck	2885	if (name == "message") return m_fnMessage;
256			else if (name == "exit") return m_fnExit;
257			else if (name == "wait") return m_fnWait;
258			else if (name == "abs") return m_fnAbs;
259			else if (name == "random") return m_fnRandom;
260			else if (name == "num_elements") return m_fnNumElements;
261	schoenebeck	2945	else if (name == "inc") return m_fnInc;
262			else if (name == "dec") return m_fnDec;
263	schoenebeck	2965	else if (name == "sh_left") return m_fnShLeft;
264			else if (name == "sh_right") return m_fnShRight;
265	schoenebeck	2970	else if (name == "min") return m_fnMin;
266			else if (name == "max") return m_fnMax;
267	schoenebeck	2581	return NULL;
268			}
269	schoenebeck	2588
270	schoenebeck	2594	std::map<String,VMIntRelPtr*> ScriptVM::builtInIntVariables() {
271			return std::map<String,VMIntRelPtr*>();
272			}
273
274			std::map<String,VMInt8Array*> ScriptVM::builtInIntArrayVariables() {
275			return std::map<String,VMInt8Array*>();
276			}
277
278	schoenebeck	2942	std::map<String,VMDynVar*> ScriptVM::builtInDynamicVariables() {
279			std::map<String,VMDynVar*> m;
280
281			m["$NKSP_PERF_TIMER"] = m_varPerfTimer;
282			m["$NKSP_REAL_TIMER"] = m_varRealTimer;
283			m["$KSP_TIMER"] = m_varRealTimer;
284
285			return m;
286			}
287
288	schoenebeck	2594	std::map<String,int> ScriptVM::builtInConstIntVariables() {
289	schoenebeck	2948	std::map<String,int> m;
290
291			m["$NI_CB_TYPE_INIT"] = VM_EVENT_HANDLER_INIT;
292			m["$NI_CB_TYPE_NOTE"] = VM_EVENT_HANDLER_NOTE;
293			m["$NI_CB_TYPE_RELEASE"] = VM_EVENT_HANDLER_RELEASE;
294			m["$NI_CB_TYPE_CONTROLLER"] = VM_EVENT_HANDLER_CONTROLLER;
295
296			return m;
297	schoenebeck	2594	}
298
299	schoenebeck	2879	VMEventHandler* ScriptVM::currentVMEventHandler() {
300			return m_eventHandler;
301			}
302
303	schoenebeck	2588	VMParserContext* ScriptVM::currentVMParserContext() {
304			return m_parserContext;
305			}
306
307	schoenebeck	2581	VMExecContext* ScriptVM::currentVMExecContext() {
308	schoenebeck	2588	if (!m_parserContext) return NULL;
309			return m_parserContext->execContext;
310	schoenebeck	2581	}
311
312	schoenebeck	2974	void ScriptVM::setAutoSuspendEnabled(bool b) {
313			m_autoSuspend = b;
314			}
315
316			bool ScriptVM::isAutoSuspendEnabled() const {
317			return m_autoSuspend;
318			}
319
320	schoenebeck	2588	VMExecStatus_t ScriptVM::exec(VMParserContext* parserContext, VMExecContext* execContex, VMEventHandler* handler) {
321			m_parserContext = dynamic_cast<ParserContext*>(parserContext);
322			if (!m_parserContext) {
323			std::cerr << "No VM parser context provided. Did you load a script?.\n";
324	schoenebeck	2581	return VMExecStatus_t(VM_EXEC_NOT_RUNNING \| VM_EXEC_ERROR);
325			}
326
327	schoenebeck	2611	// a ParserContext object is always tied to exactly one ScriptVM object
328			assert(m_parserContext->functionProvider == this);
329
330	schoenebeck	2581	ExecContext* ctx = dynamic_cast<ExecContext*>(execContex);
331			if (!ctx) {
332			std::cerr << "Invalid VM exec context.\n";
333			return VMExecStatus_t(VM_EXEC_NOT_RUNNING \| VM_EXEC_ERROR);
334			}
335			EventHandler* h = dynamic_cast<EventHandler*>(handler);
336			if (!h) return VM_EXEC_NOT_RUNNING;
337	schoenebeck	2879	m_eventHandler = handler;
338	schoenebeck	2581
339	schoenebeck	2588	m_parserContext->execContext = ctx;
340	schoenebeck	2581
341			ctx->status = VM_EXEC_RUNNING;
342			StmtFlags_t flags = STMT_SUCCESS;
343	schoenebeck	2974	int instructionsCounter = 0;
344	schoenebeck	2581
345			int& frameIdx = ctx->stackFrame;
346			if (frameIdx < 0) { // start condition ...
347			frameIdx = -1;
348			ctx->pushStack(h);
349			}
350
351			while (flags == STMT_SUCCESS && frameIdx >= 0) {
352			if (frameIdx >= ctx->stack.size()) { // should never happen, otherwise it's a bug ...
353			std::cerr << "CRITICAL: VM stack overflow! (" << frameIdx << ")\n";
354			flags = StmtFlags_t(STMT_ABORT_SIGNALLED \| STMT_ERROR_OCCURRED);
355			break;
356			}
357
358			ExecContext::StackFrame& frame = ctx->stack[frameIdx];
359			switch (frame.statement->statementType()) {
360			case STMT_LEAF: {
361			#if DEBUG_SCRIPTVM_CORE
362			_printIndents(frameIdx);
363			printf("-> STMT_LEAF\n");
364			#endif
365			LeafStatement* leaf = (LeafStatement*) frame.statement;
366			flags = leaf->exec();
367			ctx->popStack();
368			break;
369			}
370
371			case STMT_LIST: {
372			#if DEBUG_SCRIPTVM_CORE
373			_printIndents(frameIdx);
374			printf("-> STMT_LIST subidx=%d\n", frame.subindex);
375			#endif
376			Statements* stmts = (Statements*) frame.statement;
377			if (stmts->statement(frame.subindex)) {
378			ctx->pushStack(
379			stmts->statement(frame.subindex++)
380			);
381			} else {
382			#if DEBUG_SCRIPTVM_CORE
383			_printIndents(frameIdx);
384			printf("[END OF LIST] subidx=%d\n", frame.subindex);
385			#endif
386			ctx->popStack();
387			}
388			break;
389			}
390
391			case STMT_BRANCH: {
392			#if DEBUG_SCRIPTVM_CORE
393			_printIndents(frameIdx);
394			printf("-> STMT_BRANCH\n");
395			#endif
396			if (frame.subindex < 0) ctx->popStack();
397			else {
398			BranchStatement* branchStmt = (BranchStatement*) frame.statement;
399			frame.subindex = branchStmt->evalBranch();
400			if (frame.subindex >= 0) {
401			ctx->pushStack(
402			branchStmt->branch(frame.subindex)
403			);
404			frame.subindex = -1;
405			} else ctx->popStack();
406			}
407			break;
408			}
409
410			case STMT_LOOP: {
411			#if DEBUG_SCRIPTVM_CORE
412			_printIndents(frameIdx);
413			printf("-> STMT_LOOP\n");
414			#endif
415			While* whileStmt = (While*) frame.statement;
416			if (whileStmt->evalLoopStartCondition() && whileStmt->statements()) {
417			ctx->pushStack(
418			whileStmt->statements()
419			);
420	schoenebeck	2974	if (flags == STMT_SUCCESS && m_autoSuspend &&
421			instructionsCounter > SCRIPTVM_MAX_INSTR_PER_CYCLE_SOFT)
422			{
423			flags = StmtFlags_t(STMT_SUSPEND_SIGNALLED);
424			ctx->suspendMicroseconds = SCRIPT_VM_FORCE_SUSPENSION_MICROSECONDS;
425			}
426	schoenebeck	2581	} else ctx->popStack();
427	schoenebeck	2974	break;
428	schoenebeck	2581	}
429			}
430	schoenebeck	2974
431			if (flags == STMT_SUCCESS && m_autoSuspend &&
432			instructionsCounter > SCRIPTVM_MAX_INSTR_PER_CYCLE_HARD)
433			{
434			flags = StmtFlags_t(STMT_SUSPEND_SIGNALLED);
435			ctx->suspendMicroseconds = SCRIPT_VM_FORCE_SUSPENSION_MICROSECONDS;
436			}
437
438			++instructionsCounter;
439	schoenebeck	2581	}
440
441			if (flags & STMT_SUSPEND_SIGNALLED) {
442			ctx->status = VM_EXEC_SUSPENDED;
443			} else {
444			ctx->status = VM_EXEC_NOT_RUNNING;
445			if (flags & STMT_ERROR_OCCURRED)
446			ctx->status = VM_EXEC_ERROR;
447			ctx->reset();
448			}
449
450	schoenebeck	2879	m_eventHandler = NULL;
451	schoenebeck	2588	m_parserContext->execContext = NULL;
452			m_parserContext = NULL;
453	schoenebeck	2581	return ctx->status;
454			}
455
456			} // namespace LinuxSampler