libs-steptalk/Languages/Smalltalk/STBytecodeInterpreter.m

631 lines
18 KiB
Objective-C

/**
STBytecodeInterpreter.m
Copyright (c) 2002 Free Software Foundation
This file is part of the StepTalk project.
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
#import "STBytecodeInterpreter.h"
#import "Externs.h"
#import "STBlock.h"
#import "STBlockContext.h"
#import "STBytecodes.h"
#import "STCompiledMethod.h"
#import "STExecutionContext.h"
#import "STLiterals.h"
#import "STMessage.h"
#import "STMethodContext.h"
#import "STSmalltalkScriptObject.h"
#import "STStack.h"
#import <StepTalk/STEnvironment.h>
#import <StepTalk/STExterns.h>
#import <StepTalk/STFunctions.h>
#import <StepTalk/NSInvocation+additions.h>
#import <StepTalk/STScripting.h>
#import <Foundation/NSAutoreleasePool.h>
#import <Foundation/NSArray.h>
#import <Foundation/NSData.h>
#import <Foundation/NSDebug.h>
#import <Foundation/NSDictionary.h>
#import <Foundation/NSException.h>
#import <Foundation/NSInvocation.h>
#import <Foundation/NSValue.h>
@interface STBytecodeInterpreter(STPrivateMethods)
- (short)fetchBytecode;
- (BOOL)dispatchBytecode:(STBytecode)bytecode;
- (void)invalidBytecode:(STBytecode)bytecode;
- (void)setInstructionPointer:(NSUInteger)newIP;
- (NSUInteger)instructionPointer;
- (void)sendSelectorAtIndex:(NSUInteger)index withArgCount:(NSUInteger)argCount;
- (id)interpret;
- (void)returnValue:(id)value;
@end
static SEL sendSelectorAtIndexSel;
static IMP sendSelectorAtIndexImp;
static SEL pushSel;
static IMP pushImp;
static SEL popSel;
static IMP popImp;
static Class NSInvocation_class = nil;
@implementation STBytecodeInterpreter
+ (void)initialize
{
sendSelectorAtIndexSel = @selector(sendSelectorAtIndex:withArgCount:);
pushSel = @selector(push:);
popSel = @selector(pop);
sendSelectorAtIndexImp = [STBytecodeInterpreter instanceMethodForSelector:sendSelectorAtIndexSel];
pushImp = [STStack instanceMethodForSelector:pushSel];
popImp = [STStack instanceMethodForSelector:popSel];
NSInvocation_class = [NSInvocation class];
}
+ interpreterWithEnvrionment:(STEnvironment *)env
{
return AUTORELEASE([[self alloc] initWithEnvironment:env]);
}
- initWithEnvironment:(STEnvironment *)env
{
if ((self = [super init]) != nil)
environment = RETAIN(env);
return self;
}
- (void)dealloc
{
RELEASE(environment);
RELEASE(activeContext);
[super dealloc];
}
- (void)setEnvironment:(STEnvironment *)env
{
ASSIGN(environment,env);
}
- (id)interpretMethod:(STCompiledMethod *)method
forReceiver:(id)anObject
arguments:(NSArray*)args
{
// NSAutoreleasePool *pool = [NSAutoreleasePool new];
STExecutionContext *oldContext;
STMethodContext *newContext;
id retval;
if (!environment)
{
[NSException raise:STInterpreterGenericException
format:@"No execution environment set"];
return nil;
}
NSDebugLLog(@"STBytecodeInterpreter",@"Executing method %@ with %lu args",
[method selector],(unsigned long)[args count]);
if (!method)
{
return nil;
}
if ([args count] != [method argumentCount])
{
[NSException raise:STInterpreterGenericException
format:@"Invalid argument count %lu (should be %lu)"
@" for method %@ ",
(unsigned long)[args count],
(unsigned long)[method argumentCount],
[method selector]];
}
newContext = [[STMethodContext alloc] initWithMethod:method];
[newContext setArgumentsFromArray:args];
[newContext setReceiver:anObject];
oldContext = activeContext;
[self setContext:newContext];
NS_DURING
retval = [self interpret];
NS_HANDLER
if ([[localException name] isEqualToString:STInterpreterReturnException])
{
NSDictionary *userInfo = [localException userInfo];
if ([userInfo objectForKey: @"Context"] == newContext)
{
retval = [userInfo objectForKey:@"Value"];
}
else
{
RELEASE(newContext);
[localException raise];
}
}
else
{
RELEASE(newContext);
[localException raise];
}
NS_ENDHANDLER
[self setContext:oldContext];
RELEASE(newContext);
// RETAIN(retval);
// [pool release];
// AUTORELEASE(retval);
return retval;
}
/* ---------------------------------------------------------------------------
* Interpret
* ---------------------------------------------------------------------------
*/
- (void)setContext:(STExecutionContext *)newContext
{
NSDebugLLog(@"STExecutionContext", @"Switch from context %@ to context %@",
activeContext, newContext);
if(!newContext)
{
RELEASE(activeContext);
activeContext = nil;
stack = nil;
bytecodes = nil;
instructionPointer = 0;
receiver = nil;
return;
}
if( ![newContext isValid])
{
[NSException raise:STInterpreterGenericException
format:@"Trying to set an invalid context"];
}
[activeContext setInstructionPointer:instructionPointer];
ASSIGN(activeContext,newContext);
stack = [activeContext stack];
receiver = [activeContext receiver];
if(!stack)
{
[NSException raise:STInternalInconsistencyException
format:@"No execution stack"];
}
instructionPointer = [activeContext instructionPointer];
bytecodes = [activeContext bytecodes];
}
- (STExecutionContext *)context
{
return activeContext;
}
- (id)interpret
{
STBytecode bytecode;
id retval;
entry++;
NSDebugLLog(@"STBytecodeInterpreter", @"Interpreter entry %li", (long)entry);
NSDebugLLog(@"STBytecodeInterpreter", @"IP %lx %lx",
(unsigned long)instructionPointer,
(unsigned long)[bytecodes length]);
if(!bytecodes)
{
NSLog(@"Smalltalk: No bytecodes.");
return nil;
}
stopRequested = NO;
do
{
bytecode = [bytecodes fetchNextBytecodeAtPointer:&instructionPointer];
if(stopRequested)
{
break;
}
} while( [self dispatchBytecode:bytecode] );
if(!stopRequested)
{
retval = [stack pop];
}
else
{
NSDebugLLog(@"STBytecodeInterpreter",@"Stop requested");
retval = nil;
}
NSDebugLLog(@"STBytecodeInterpreter",
@"Returning '%@' from interpreter (entry %li)",
retval,(long)entry);
entry --;
return retval;
}
- (void)halt
{
NSDebugLLog(@"STBytecodeInterpreter",@"Halt!");
stopRequested = YES;
}
/* ---------------------------------------------------------------------------
* Return
* ---------------------------------------------------------------------------
*/
- (void)returnValue:(id)value
{
NSDebugLLog(@"STExecutionContext",
@"%@ return value '%@' from method",
activeContext,value);
[activeContext invalidate];
if (activeContext != [activeContext homeContext])
{
NSDictionary *userInfo;
/* FIXME Invalidate all contexts between the active context and the
home context as well. Note that the semantics presented in the
Blue Book doesn't get this right either. */
userInfo =
[NSDictionary dictionaryWithObjectsAndKeys:
/* Attention: Order is important here. The returned value
may be nil, so the context value must come first. */
[activeContext homeContext], @"Context", value, @"Value", nil];
[[NSException exceptionWithName:STInterpreterReturnException
reason:@"Block cannot return"
userInfo:userInfo] raise];
}
[stack push:value];
}
- (void)returnBlockValue:(id)value
{
NSDebugLLog(@"STExecutionContext",
@"%@ return value '%@' from block",
activeContext,value);
[activeContext invalidate];
[stack push:value];
}
- (NSUInteger)instructionPointer
{
return instructionPointer;
}
/* ---------------------------------------------------------------------------
* Block manipulation
* ---------------------------------------------------------------------------
*/
- (void)createBlockWithArgumentCount:(NSUInteger)argCount
stackSize:(NSUInteger)stackSize
{
NSUInteger ptr;
STBlock *block;
ptr = instructionPointer + STLongJumpBytecodeSize;
NSDebugLLog(@"STExecutionContext",
@"%@ Create block: argc:%lu stack:%lu ip:0x%04lx",
activeContext,
(unsigned long)argCount,
(unsigned long)stackSize,
(unsigned long)ptr);
block =
[[STBlock alloc] initWithInterpreter:self
homeContext:[activeContext homeContext]
initialIP:ptr
argumentCount:argCount
stackSize:stackSize];
[stack push:AUTORELEASE(block)];
}
/* ---------------------------------------------------------------------------
send selector (see also STEnvironment class)
* ---------------------------------------------------------------------------
*/
- (void)sendSelectorAtIndex:(NSUInteger)selIndex
withArgCount:(NSUInteger)argCount
{
NSString *selector;
NSInvocation *invocation;
id target;
NSInteger index;
id object;
NSDebugLLog(@"STSending",
@"send selector '%@' with %lu args'",
[activeContext literalObjectAtIndex:selIndex],
(unsigned long)argCount);
target = [stack valueFromTop:argCount];
/* FIXME */
if(!target)
{
target = STNil;
}
selector = [activeContext literalObjectAtIndex:selIndex];
NSDebugLLog(@"STSending",
@" %s receiver:%@ (%@) selector:%@",
[receiver isProxy] ? "proxy for" : "",
target,
NSStringFromClass([target class]),
selector);
/* FIXME: this is too slow */
selector = [environment translateSelector:selector forReceiver:target];
invocation = [NSInvocation_class invocationWithTarget:target
selectorName:selector];
if(!invocation)
{
[NSException raise:STInternalInconsistencyException
format:@"Should not send selector '%@' to "
@"receiver of type %@ (could not create invocation)",
selector,[target className]];
return;
}
for(index = argCount + 1; index > 1; index--)
{
object = [stack pop];
if(object == STNil)
{
object = nil;
}
NSDebugLLog(@"STSending",
@" argument %2li: '%@'",(long)(index - 2), object);
[invocation setArgumentAsObject:object atIndex:index];
}
/* ----------------------------
* invoke it!
* ----------------------------
*/
NSDebugLLog(@"STSending",@" invoking... (%@ %s)",invocation, [[invocation methodSignature] methodReturnType]);
[invocation invoke];
NSDebugLLog(@"STSending",@" done invoking.");
/* FIXME */
if(!stopRequested)
{
/* pop the receiver from the stack */
[stack pop];
[stack push: [invocation returnValueAsObject]];
}
}
/* ---------------------------------------------------------------------------
Bytecode manipulation
* ---------------------------------------------------------------------------
*/
#define STDebugBytecode(bc) \
NSDebugLLog(@"STBytecodeInterpreter", \
@"#%04lx %@", \
(unsigned long)(bc).pointer, \
STDissasembleBytecode(bc))
#define STDebugBytecodeWith(bc,object) \
NSDebugLLog(@"STBytecodeInterpreter", \
@"#%04lx %@ (%@)", \
(unsigned long)(bc).pointer, \
STDissasembleBytecode(bc), \
(object))
#define STPush(s, v) (*pushImp)(s, pushSel, v)
// #define STPush(s, v) [s push:v]
#define STPop(s) (*popImp)(s, popSel)
// #define STPop(s) [s pop]
- (BOOL)dispatchBytecode:(STBytecode)bytecode
{
NSString *refName;
id object;
switch(bytecode.code)
{
case STLongJumpBytecode:
{
/*
NSInteger offset =
STLongJumpOffset(bytecode.arg1,bytecode.arg2)
- STLongJumpBytecodeSize;
*/
NSInteger offset = bytecode.arg1 - STLongJumpBytecodeSize;
STDebugBytecode(bytecode);
instructionPointer+=offset;
break;
}
case STPushReceiverBytecode:
STDebugBytecodeWith(bytecode,receiver);
STPush(stack, receiver);
break;
case STPushNilBytecode:
STDebugBytecodeWith(bytecode,receiver);
STPush(stack,nil);
break;
case STPushTrueBytecode:
STDebugBytecodeWith(bytecode,receiver);
STPush(stack,[NSNumber numberWithBool:YES]);
break;
case STPushFalseBytecode:
STDebugBytecodeWith(bytecode,receiver);
STPush(stack,[NSNumber numberWithBool:NO]);
break;
case STPushRecVarBytecode:
refName = [activeContext referenceNameAtIndex:bytecode.arg1];
object = [receiver valueForKey:refName];
STDebugBytecodeWith(bytecode,object);
STPush(stack,object);
break;
case STPushExternBytecode:
// NSLog(@"PUSH EXTERN ctx(%@): %@ %@", [activeContext className], [[activeContext method] selector], [[activeContext method] namedReferences]);
refName = [activeContext referenceNameAtIndex:bytecode.arg1];
object = [environment objectWithName:refName];
STDebugBytecodeWith(bytecode,object);
STPush(stack,object);
break;
case STPushTemporaryBytecode:
object = [activeContext temporaryAtIndex:bytecode.arg1];
STPush(stack,object);
STDebugBytecodeWith(bytecode,object);
break;
case STPushLiteralBytecode:
object = [activeContext literalObjectAtIndex:bytecode.arg1];
STDebugBytecodeWith(bytecode,object);
STPush(stack,object);
break;
case STPopAndStoreRecVarBytecode:
STDebugBytecode(bytecode);
refName = [activeContext referenceNameAtIndex:bytecode.arg1];
object = STPop(stack);
[receiver setValue:object forKey:refName];
break;
case STPopAndStoreExternBytecode:
STDebugBytecode(bytecode);
refName = [activeContext referenceNameAtIndex:bytecode.arg1];
object = STPop(stack);
[environment setObject:object forName:refName];
break;
case STPopAndStoreTempBytecode:
STDebugBytecode(bytecode);
[activeContext setTemporary:STPop(stack) atIndex:bytecode.arg1];
break;
case STSendSelectorBytecode:
STDebugBytecodeWith(bytecode,
[activeContext literalObjectAtIndex:bytecode.arg1]);
(*sendSelectorAtIndexImp)(self, sendSelectorAtIndexSel,
bytecode.arg1,bytecode.arg2);
/*
[self sendSelectorAtIndex:bytecode.arg1
withArgCount:bytecode.arg2];
*/ break;
case STSuperSendSelectorBytecode: /* FIXME: not implemented */
[self invalidBytecode:bytecode];
break;
case STDupBytecode:
STDebugBytecode(bytecode);
[stack duplicateTop];
break;
case STPopStackBytecode:
STDebugBytecode(bytecode);
[stack pop];
break;
case STReturnBytecode:
STDebugBytecode(bytecode);
[self returnValue:[stack pop]];
return NO;
case STReturnBlockBytecode:
STDebugBytecode(bytecode);
[self returnBlockValue:[stack pop]];
return NO;
case STBlockCopyBytecode:
STDebugBytecode(bytecode);
{
STBlockLiteral *info = [stack pop];
[self createBlockWithArgumentCount:[info argumentCount]
stackSize:[info stackSize]];
}
break;
default:
[self invalidBytecode:bytecode];
break;
};
return YES;
}
- (void)invalidBytecode:(STBytecode)bytecode
{
[NSException raise:STInternalInconsistencyException
format:@"invalid bytecode (0x%02x) at 0x%06lx",
bytecode.code,(unsigned long)bytecode.pointer];
}
@end