js/src/jscell.h

   1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 4 -*-
   2  *
   3  * ***** BEGIN LICENSE BLOCK *****
   4  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   5  *
   6  * The contents of this file are subject to the Mozilla Public License Version
   7  * 1.1 (the "License"); you may not use this file except in compliance with
   8  * the License. You may obtain a copy of the License at
   9  * http://www.mozilla.org/MPL/
  10  *
  11  * Software distributed under the License is distributed on an "AS IS" basis,
  12  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  13  * for the specific language governing rights and limitations under the
  14  * License.
  15  *
  16  * The Original Code is SpiderMonkey code.
  17  *
  18  * The Initial Developer of the Original Code is
  19  * Mozilla Corporation.
  20  * Portions created by the Initial Developer are Copyright (C) 2010
  21  * the Initial Developer. All Rights Reserved.
  22  *
  23  * Contributor(s):
  24  * Gregor Wagner <anygregor@gmail.com>
  25  *
  26  * Alternatively, the contents of this file may be used under the terms of
  27  * either of the GNU General Public License Version 2 or later (the "GPL"),
  28  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  29  * in which case the provisions of the GPL or the LGPL are applicable instead
  30  * of those above. If you wish to allow use of your version of this file only
  31  * under the terms of either the GPL or the LGPL, and not to allow others to
  32  * use your version of this file under the terms of the MPL, indicate your
  33  * decision by deleting the provisions above and replace them with the notice
  34  * and other provisions required by the GPL or the LGPL. If you do not delete
  35  * the provisions above, a recipient may use your version of this file under
  36  * the terms of any one of the MPL, the GPL or the LGPL.
  37  *
  38  * ***** END LICENSE BLOCK ***** */
  39
  40 #ifndef jscell_h___
  41 #define jscell_h___
  42
  43 struct JSCompartment;
  44
  45 namespace js {
  46 namespace gc {
  47
  48 template <typename T> struct Arena;
  49 struct ArenaBitmap;
  50 struct MarkingDelay;
  51 struct Chunk;
  52 struct FreeCell;
  53
  54 /*
  55  * A GC cell is the base class for GC Things like JSObject, JSShortString,
  56  * JSFunction, JSXML and for an empty cell called FreeCell. It helps avoiding
  57  * casts from an Object to a Cell whenever we call GC related mark functions.
  58  * Cell is not the base Class for JSString because static initialization
  59  * (used for unitStringTables) does not work with inheritance.
  60  */
  61
  62 struct Cell {
  63     static const size_t CellShift = 3;
  64     static const size_t CellSize = size_t(1) << CellShift;
  65     static const size_t CellMask = CellSize - 1;
  66
  67     inline Arena<Cell> *arena() const;
  68     inline Chunk *chunk() const;
  69     inline ArenaBitmap *bitmap() const;
  70     JS_ALWAYS_INLINE size_t cellIndex() const;
  71
  72     JS_ALWAYS_INLINE bool isMarked(uint32 color) const;
  73     JS_ALWAYS_INLINE bool markIfUnmarked(uint32 color) const;
  74     JS_ALWAYS_INLINE void unmark(uint32 color) const;
  75
  76     inline JSCompartment *compartment() const;
  77
  78     /* Needed for compatibility reasons because Cell can't be a base class of JSString */
  79     JS_ALWAYS_INLINE js::gc::Cell *asCell() { return this; }
  80
  81     JS_ALWAYS_INLINE js::gc::FreeCell *asFreeCell() {
  82         return reinterpret_cast<FreeCell *>(this);
  83     }
  84 };
  85
  86 /* FreeCell has always size 8 */
  87 struct FreeCell : Cell {
  88     union {
  89         FreeCell *link;
  90         double data;
  91     };
  92 };
  93
  94 JS_STATIC_ASSERT(sizeof(FreeCell) == 8);
  95
  96 } /* namespace gc */
  97 } /* namespace js */
  98
  99 #endif /* jscell_h___ */