blob: 35ca8b79790c615edae4e79456be2d51f56edb29 [file] [log] [blame]
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 4 -*-
* vim: set ts=8 sts=4 et sw=4 tw=99:
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#ifndef jscntxtinlines_h
#define jscntxtinlines_h
#include "jscntxt.h"
#include "jscompartment.h"
#include "jsfriendapi.h"
#include "jsgc.h"
#include "jsiter.h"
#include "builtin/Object.h" // For js::obj_construct
#include "frontend/ParseMaps.h"
#include "jit/IonFrames.h" // For GetPcScript
#include "vm/Interpreter.h"
#include "vm/Probes.h"
#include "vm/RegExpObject.h"
#include "jsgcinlines.h"
#include "vm/ObjectImpl-inl.h"
namespace js {
inline void
NewObjectCache::staticAsserts()
{
JS_STATIC_ASSERT(NewObjectCache::MAX_OBJ_SIZE == sizeof(JSObject_Slots16));
JS_STATIC_ASSERT(gc::FINALIZE_OBJECT_LAST == gc::FINALIZE_OBJECT16_BACKGROUND);
}
inline bool
NewObjectCache::lookup(Class *clasp, gc::Cell *key, gc::AllocKind kind, EntryIndex *pentry)
{
uintptr_t hash = (uintptr_t(clasp) ^ uintptr_t(key)) + kind;
*pentry = hash % mozilla::ArrayLength(entries);
Entry *entry = &entries[*pentry];
/* N.B. Lookups with the same clasp/key but different kinds map to different entries. */
return (entry->clasp == clasp && entry->key == key);
}
inline bool
NewObjectCache::lookupProto(Class *clasp, JSObject *proto, gc::AllocKind kind, EntryIndex *pentry)
{
JS_ASSERT(!proto->is<GlobalObject>());
return lookup(clasp, proto, kind, pentry);
}
inline bool
NewObjectCache::lookupGlobal(Class *clasp, js::GlobalObject *global, gc::AllocKind kind, EntryIndex *pentry)
{
return lookup(clasp, global, kind, pentry);
}
inline bool
NewObjectCache::lookupType(Class *clasp, js::types::TypeObject *type, gc::AllocKind kind, EntryIndex *pentry)
{
return lookup(clasp, type, kind, pentry);
}
inline void
NewObjectCache::fill(EntryIndex entry_, Class *clasp, gc::Cell *key, gc::AllocKind kind, JSObject *obj)
{
JS_ASSERT(unsigned(entry_) < mozilla::ArrayLength(entries));
Entry *entry = &entries[entry_];
JS_ASSERT(!obj->hasDynamicSlots() && !obj->hasDynamicElements());
entry->clasp = clasp;
entry->key = key;
entry->kind = kind;
entry->nbytes = gc::Arena::thingSize(kind);
js_memcpy(&entry->templateObject, obj, entry->nbytes);
}
inline void
NewObjectCache::fillGlobal(EntryIndex entry, Class *clasp, js::GlobalObject *global, gc::AllocKind kind, JSObject *obj)
{
//JS_ASSERT(global == obj->getGlobal());
return fill(entry, clasp, global, kind, obj);
}
inline void
NewObjectCache::fillType(EntryIndex entry, Class *clasp, js::types::TypeObject *type, gc::AllocKind kind, JSObject *obj)
{
JS_ASSERT(obj->type() == type);
return fill(entry, clasp, type, kind, obj);
}
inline void
NewObjectCache::copyCachedToObject(JSObject *dst, JSObject *src, gc::AllocKind kind)
{
js_memcpy(dst, src, gc::Arena::thingSize(kind));
#ifdef JSGC_GENERATIONAL
Shape::writeBarrierPost(dst->shape_, &dst->shape_);
types::TypeObject::writeBarrierPost(dst->type_, &dst->type_);
#endif
}
inline JSObject *
NewObjectCache::newObjectFromHit(JSContext *cx, EntryIndex entry_, js::gc::InitialHeap heap)
{
// The new object cache does not account for metadata attached via callbacks.
JS_ASSERT(!cx->compartment()->objectMetadataCallback);
JS_ASSERT(unsigned(entry_) < mozilla::ArrayLength(entries));
Entry *entry = &entries[entry_];
JSObject *obj = js_NewGCObject<NoGC>(cx, entry->kind, heap);
if (obj) {
copyCachedToObject(obj, reinterpret_cast<JSObject *>(&entry->templateObject), entry->kind);
Probes::createObject(cx, obj);
return obj;
}
return NULL;
}
#ifdef JS_CRASH_DIAGNOSTICS
class CompartmentChecker
{
JSContext *context;
JSCompartment *compartment;
public:
explicit CompartmentChecker(JSContext *cx)
: context(cx), compartment(cx->compartment())
{}
/*
* Set a breakpoint here (break js::CompartmentChecker::fail) to debug
* compartment mismatches.
*/
static void fail(JSCompartment *c1, JSCompartment *c2) {
printf("*** Compartment mismatch %p vs. %p\n", (void *) c1, (void *) c2);
MOZ_CRASH();
}
static void fail(JS::Zone *z1, JS::Zone *z2) {
printf("*** Zone mismatch %p vs. %p\n", (void *) z1, (void *) z2);
MOZ_CRASH();
}
/* Note: should only be used when neither c1 nor c2 may be the default compartment. */
static void check(JSCompartment *c1, JSCompartment *c2) {
JS_ASSERT(c1 != c1->rt->atomsCompartment);
JS_ASSERT(c2 != c2->rt->atomsCompartment);
if (c1 != c2)
fail(c1, c2);
}
void check(JSCompartment *c) {
if (c && c != context->runtime()->atomsCompartment) {
if (!compartment)
compartment = c;
else if (c != compartment)
fail(compartment, c);
}
}
void checkZone(JS::Zone *z) {
if (compartment && z != compartment->zone())
fail(compartment->zone(), z);
}
void check(JSObject *obj) {
if (obj)
check(obj->compartment());
}
template<typename T>
void check(Handle<T> handle) {
check(handle.get());
}
void check(JSString *str) {
if (!str->isAtom())
checkZone(str->zone());
}
void check(const js::Value &v) {
if (v.isObject())
check(&v.toObject());
else if (v.isString())
check(v.toString());
}
void check(const ValueArray &arr) {
for (size_t i = 0; i < arr.length; i++)
check(arr.array[i]);
}
void check(const JSValueArray &arr) {
for (size_t i = 0; i < arr.length; i++)
check(arr.array[i]);
}
void check(const CallArgs &args) {
for (Value *p = args.base(); p != args.end(); ++p)
check(*p);
}
void check(jsid id) {
if (JSID_IS_OBJECT(id))
check(JSID_TO_OBJECT(id));
}
void check(JSIdArray *ida) {
if (ida) {
for (int i = 0; i < ida->length; i++) {
if (JSID_IS_OBJECT(ida->vector[i]))
check(ida->vector[i]);
}
}
}
void check(JSScript *script) {
if (script)
check(script->compartment());
}
void check(StackFrame *fp);
void check(AbstractFramePtr frame);
};
#endif /* JS_CRASH_DIAGNOSTICS */
/*
* Don't perform these checks when called from a finalizer. The checking
* depends on other objects not having been swept yet.
*/
#define START_ASSERT_SAME_COMPARTMENT() \
JS_ASSERT(cx->compartment()->zone() == cx->zone()); \
if (cx->runtime()->isHeapBusy()) \
return; \
CompartmentChecker c(cx)
template <class T1> inline void
assertSameCompartment(JSContext *cx, const T1 &t1)
{
#ifdef JS_CRASH_DIAGNOSTICS
START_ASSERT_SAME_COMPARTMENT();
c.check(t1);
#endif
}
template <class T1> inline void
assertSameCompartmentDebugOnly(JSContext *cx, const T1 &t1)
{
#ifdef DEBUG
START_ASSERT_SAME_COMPARTMENT();
c.check(t1);
#endif
}
template <class T1, class T2> inline void
assertSameCompartment(JSContext *cx, const T1 &t1, const T2 &t2)
{
#ifdef JS_CRASH_DIAGNOSTICS
START_ASSERT_SAME_COMPARTMENT();
c.check(t1);
c.check(t2);
#endif
}
template <class T1, class T2, class T3> inline void
assertSameCompartment(JSContext *cx, const T1 &t1, const T2 &t2, const T3 &t3)
{
#ifdef JS_CRASH_DIAGNOSTICS
START_ASSERT_SAME_COMPARTMENT();
c.check(t1);
c.check(t2);
c.check(t3);
#endif
}
template <class T1, class T2, class T3, class T4> inline void
assertSameCompartment(JSContext *cx, const T1 &t1, const T2 &t2, const T3 &t3, const T4 &t4)
{
#ifdef JS_CRASH_DIAGNOSTICS
START_ASSERT_SAME_COMPARTMENT();
c.check(t1);
c.check(t2);
c.check(t3);
c.check(t4);
#endif
}
template <class T1, class T2, class T3, class T4, class T5> inline void
assertSameCompartment(JSContext *cx, const T1 &t1, const T2 &t2, const T3 &t3, const T4 &t4, const T5 &t5)
{
#ifdef JS_CRASH_DIAGNOSTICS
START_ASSERT_SAME_COMPARTMENT();
c.check(t1);
c.check(t2);
c.check(t3);
c.check(t4);
c.check(t5);
#endif
}
#undef START_ASSERT_SAME_COMPARTMENT
STATIC_PRECONDITION_ASSUME(ubound(args.argv_) >= argc)
JS_ALWAYS_INLINE bool
CallJSNative(JSContext *cx, Native native, const CallArgs &args)
{
JS_CHECK_RECURSION(cx, return false);
#ifdef DEBUG
bool alreadyThrowing = cx->isExceptionPending();
#endif
assertSameCompartment(cx, args);
bool ok = native(cx, args.length(), args.base());
if (ok) {
assertSameCompartment(cx, args.rval());
JS_ASSERT_IF(!alreadyThrowing, !cx->isExceptionPending());
}
return ok;
}
STATIC_PRECONDITION_ASSUME(ubound(args.argv_) >= argc)
JS_ALWAYS_INLINE bool
CallNativeImpl(JSContext *cx, NativeImpl impl, const CallArgs &args)
{
#ifdef DEBUG
bool alreadyThrowing = cx->isExceptionPending();
#endif
assertSameCompartment(cx, args);
bool ok = impl(cx, args);
if (ok) {
assertSameCompartment(cx, args.rval());
JS_ASSERT_IF(!alreadyThrowing, !cx->isExceptionPending());
}
return ok;
}
STATIC_PRECONDITION(ubound(args.argv_) >= argc)
JS_ALWAYS_INLINE bool
CallJSNativeConstructor(JSContext *cx, Native native, const CallArgs &args)
{
TRACK_MEMORY_SCOPE("Javascript");
#ifdef DEBUG
RootedObject callee(cx, &args.callee());
#endif
JS_ASSERT(args.thisv().isMagic());
if (!CallJSNative(cx, native, args))
return false;
/*
* Native constructors must return non-primitive values on success.
* Although it is legal, if a constructor returns the callee, there is a
* 99.9999% chance it is a bug. If any valid code actually wants the
* constructor to return the callee, the assertion can be removed or
* (another) conjunct can be added to the antecedent.
*
* Exceptions:
*
* - Proxies are exceptions to both rules: they can return primitives and
* they allow content to return the callee.
*
* - CallOrConstructBoundFunction is an exception as well because we might
* have used bind on a proxy function.
*
* - new Iterator(x) is user-hookable; it returns x.__iterator__() which
* could be any object.
*
* - (new Object(Object)) returns the callee.
*/
JS_ASSERT_IF(native != FunctionProxyClass.construct &&
native != js::CallOrConstructBoundFunction &&
native != js::IteratorConstructor &&
(!callee->is<JSFunction>() || callee->as<JSFunction>().native() != obj_construct),
!args.rval().isPrimitive() && callee != &args.rval().toObject());
return true;
}
JS_ALWAYS_INLINE bool
CallJSPropertyOp(JSContext *cx, PropertyOp op, HandleObject receiver, HandleId id, MutableHandleValue vp)
{
JS_CHECK_RECURSION(cx, return false);
assertSameCompartment(cx, receiver, id, vp);
JSBool ok = op(cx, receiver, id, vp);
if (ok)
assertSameCompartment(cx, vp);
return ok;
}
JS_ALWAYS_INLINE bool
CallJSPropertyOpSetter(JSContext *cx, StrictPropertyOp op, HandleObject obj, HandleId id,
JSBool strict, MutableHandleValue vp)
{
JS_CHECK_RECURSION(cx, return false);
assertSameCompartment(cx, obj, id, vp);
return op(cx, obj, id, strict, vp);
}
static inline bool
CallJSDeletePropertyOp(JSContext *cx, JSDeletePropertyOp op, HandleObject receiver, HandleId id,
JSBool *succeeded)
{
JS_CHECK_RECURSION(cx, return false);
assertSameCompartment(cx, receiver, id);
return op(cx, receiver, id, succeeded);
}
inline bool
CallSetter(JSContext *cx, HandleObject obj, HandleId id, StrictPropertyOp op, unsigned attrs,
unsigned shortid, JSBool strict, MutableHandleValue vp)
{
if (attrs & JSPROP_SETTER) {
RootedValue opv(cx, CastAsObjectJsval(op));
return InvokeGetterOrSetter(cx, obj, opv, 1, vp.address(), vp.address());
}
if (attrs & JSPROP_GETTER)
return js_ReportGetterOnlyAssignment(cx);
if (!(attrs & JSPROP_SHORTID))
return CallJSPropertyOpSetter(cx, op, obj, id, strict, vp);
RootedId nid(cx, INT_TO_JSID(shortid));
return CallJSPropertyOpSetter(cx, op, obj, nid, strict, vp);
}
} /* namespace js */
inline js::LifoAlloc &
JSContext::analysisLifoAlloc()
{
return compartment()->analysisLifoAlloc;
}
inline js::LifoAlloc &
JSContext::typeLifoAlloc()
{
return zone()->types.typeLifoAlloc;
}
inline void
JSContext::setPendingException(js::Value v) {
JS_ASSERT(!IsPoisonedValue(v));
this->throwing = true;
this->exception = v;
js::assertSameCompartment(this, v);
}
inline js::PropertyTree&
JSContext::propertyTree()
{
return compartment()->propertyTree;
}
inline void
JSContext::setDefaultCompartmentObject(JSObject *obj)
{
defaultCompartmentObject_ = obj;
}
inline void
JSContext::setDefaultCompartmentObjectIfUnset(JSObject *obj)
{
if (!defaultCompartmentObject_)
setDefaultCompartmentObject(obj);
}
inline void
JSContext::enterCompartment(JSCompartment *c)
{
enterCompartmentDepth_++;
c->enter();
setCompartment(c);
if (throwing)
wrapPendingException();
}
inline void
JSContext::leaveCompartment(JSCompartment *oldCompartment)
{
JS_ASSERT(hasEnteredCompartment());
enterCompartmentDepth_--;
// Only call leave() after we've setCompartment()-ed away from the current
// compartment.
JSCompartment *startingCompartment = compartment();
setCompartment(oldCompartment);
startingCompartment->leave();
if (throwing && oldCompartment)
wrapPendingException();
}
inline void
JSContext::setCompartment(JSCompartment *comp)
{
// Both the current and the new compartment should be properly marked as
// entered at this point.
JS_ASSERT_IF(compartment_, compartment_->hasBeenEntered());
JS_ASSERT_IF(comp, comp->hasBeenEntered());
compartment_ = comp;
zone_ = comp ? comp->zone() : NULL;
allocator_ = zone_ ? &zone_->allocator : NULL;
}
inline JSScript *
JSContext::currentScript(jsbytecode **ppc,
MaybeAllowCrossCompartment allowCrossCompartment) const
{
if (ppc)
*ppc = NULL;
js::Activation *act = mainThread().activation();
while (act && (act->cx() != this || (act->isJit() && !act->asJit()->isActive())))
act = act->prev();
if (!act)
return NULL;
JS_ASSERT(act->cx() == this);
#ifdef JS_ION
if (act->isJit()) {
JSScript *script = NULL;
js::jit::GetPcScript(const_cast<JSContext *>(this), &script, ppc);
if (!allowCrossCompartment && script->compartment() != compartment())
return NULL;
return script;
}
#endif
JS_ASSERT(act->isInterpreter());
js::StackFrame *fp = act->asInterpreter()->current();
JS_ASSERT(!fp->runningInJit());
JSScript *script = fp->script();
if (!allowCrossCompartment && script->compartment() != compartment())
return NULL;
if (ppc) {
*ppc = act->asInterpreter()->regs().pc;
JS_ASSERT(*ppc >= script->code && *ppc < script->code + script->length);
}
return script;
}
template <typename T>
inline bool
js::ThreadSafeContext::isInsideCurrentZone(T thing) const
{
return thing->isInsideZone(zone_);
}
inline js::AllowGC
js::ThreadSafeContext::allowGC() const
{
switch (contextKind_) {
case Context_JS:
return CanGC;
case Context_ForkJoin:
return NoGC;
default:
/* Silence warnings. */
JS_NOT_REACHED("Bad context kind");
return NoGC;
}
}
#endif /* jscntxtinlines_h */