f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey/*
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey * Copyright (c) 2000, 2010, Oracle and/or its affiliates. All rights reserved.
95732235d86b969f623d901cc4e92de6a4cfd515Tony Bamford * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey *
95732235d86b969f623d901cc4e92de6a4cfd515Tony Bamford * This code is free software; you can redistribute it and/or modify it
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey * under the terms of the GNU General Public License version 2 only, as
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey * published by the Free Software Foundation.
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey *
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey * This code is distributed in the hope that it will be useful, but WITHOUT
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey * version 2 for more details (a copy is included in the LICENSE file that
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey * accompanied this code).
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey *
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey * You should have received a copy of the GNU General Public License version
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey * 2 along with this work; if not, write to the Free Software Foundation,
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey *
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey * or visit www.oracle.com if you need additional information or have any
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey * questions.
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey *
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey */
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey#ifndef SHARE_VM_MEMORY_MEMREGION_HPP
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey#define SHARE_VM_MEMORY_MEMREGION_HPP
ea3b7fa21b9a3f8fcdeee368fce052effc1f9f54Mareks Malnacs
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey#include "memory/allocation.hpp"
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey#include "utilities/debug.hpp"
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey#include "utilities/globalDefinitions.hpp"
95732235d86b969f623d901cc4e92de6a4cfd515Tony Bamford
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey// A very simple data structure representing a contigous region
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey// region of address space.
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey// Note that MemRegions are passed by value, not by reference.
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey// The intent is that they remain very small and contain no
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey// objects.
3eeee725f0a0ffc6c28e338470c0dcfac0e6706eCharles Sparey
3eeee725f0a0ffc6c28e338470c0dcfac0e6706eCharles Spareyclass MemRegion VALUE_OBJ_CLASS_SPEC {
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey friend class VMStructs;
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Spareyprivate:
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey HeapWord* _start;
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey size_t _word_size;
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Spareypublic:
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey MemRegion() : _start(NULL), _word_size(0) {};
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey MemRegion(HeapWord* start, size_t word_size) :
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey _start(start), _word_size(word_size) {};
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey MemRegion(HeapWord* start, HeapWord* end) :
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey _start(start), _word_size(pointer_delta(end, start)) {
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey assert(end >= start, "incorrect constructor arguments");
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey }
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey MemRegion(const MemRegion& mr): _start(mr._start), _word_size(mr._word_size) {}
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey MemRegion intersection(const MemRegion mr2) const;
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey // regions must overlap or be adjacent
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey MemRegion _union(const MemRegion mr2) const;
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey // minus will fail a guarantee if mr2 is interior to this,
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey // since there's no way to return 2 disjoint regions.
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey MemRegion minus(const MemRegion mr2) const;
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey HeapWord* start() const { return _start; }
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey HeapWord* end() const { return _start + _word_size; }
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey HeapWord* last() const { return _start + _word_size - 1; }
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey void set_start(HeapWord* start) { _start = start; }
95732235d86b969f623d901cc4e92de6a4cfd515Tony Bamford void set_end(HeapWord* end) { _word_size = pointer_delta(end, _start); }
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey void set_word_size(size_t word_size) {
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey _word_size = word_size;
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey }
95732235d86b969f623d901cc4e92de6a4cfd515Tony Bamford
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey bool contains(const MemRegion mr2) const {
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey return _start <= mr2._start && end() >= mr2.end();
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey }
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey bool contains(const void* addr) const {
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey return addr >= (void*)_start && addr < (void*)end();
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey }
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey bool equals(const MemRegion mr2) const {
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey // first disjunct since we do not have a canonical empty set
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey return ((is_empty() && mr2.is_empty()) ||
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey (start() == mr2.start() && end() == mr2.end()));
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey }
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey size_t byte_size() const { return _word_size * sizeof(HeapWord); }
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey size_t word_size() const { return _word_size; }
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey bool is_empty() const { return word_size() == 0; }
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey};
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey// For iteration over MemRegion's.
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Spareyclass MemRegionClosure : public StackObj {
ea3b7fa21b9a3f8fcdeee368fce052effc1f9f54Mareks Malnacspublic:
95732235d86b969f623d901cc4e92de6a4cfd515Tony Bamford virtual void do_MemRegion(MemRegion mr) = 0;
95732235d86b969f623d901cc4e92de6a4cfd515Tony Bamford};
95732235d86b969f623d901cc4e92de6a4cfd515Tony Bamford
95732235d86b969f623d901cc4e92de6a4cfd515Tony Bamford// A ResourceObj version of MemRegionClosure
ea3b7fa21b9a3f8fcdeee368fce052effc1f9f54Mareks Malnacs
ea3b7fa21b9a3f8fcdeee368fce052effc1f9f54Mareks Malnacsclass MemRegionClosureRO: public MemRegionClosure {
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Spareypublic:
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey void* operator new(size_t size, ResourceObj::allocation_type type, MEMFLAGS flags) {
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey return ResourceObj::operator new(size, type, flags);
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey }
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey void* operator new(size_t size, Arena *arena) {
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey return ResourceObj::operator new(size, arena);
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey }
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey void* operator new(size_t size) {
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey return ResourceObj::operator new(size);
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey }
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey void operator delete(void* p) {} // nothing to do
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey};
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey
f9a8e3807f0a81f9bd514005d47bfcc41839b25cCharles Sparey#endif // SHARE_VM_MEMORY_MEMREGION_HPP
95732235d86b969f623d901cc4e92de6a4cfd515Tony Bamford