duke@435: /* mikael@6198: * Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved. duke@435: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. duke@435: * duke@435: * This code is free software; you can redistribute it and/or modify it duke@435: * under the terms of the GNU General Public License version 2 only, as duke@435: * published by the Free Software Foundation. duke@435: * duke@435: * This code is distributed in the hope that it will be useful, but WITHOUT duke@435: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or duke@435: * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License duke@435: * version 2 for more details (a copy is included in the LICENSE file that duke@435: * accompanied this code). duke@435: * duke@435: * You should have received a copy of the GNU General Public License version duke@435: * 2 along with this work; if not, write to the Free Software Foundation, duke@435: * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. duke@435: * trims@1907: * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA trims@1907: * or visit www.oracle.com if you need additional information or have any trims@1907: * questions. duke@435: * duke@435: */ duke@435: stefank@2314: #ifndef SHARE_VM_UTILITIES_BITMAP_HPP stefank@2314: #define SHARE_VM_UTILITIES_BITMAP_HPP stefank@2314: stefank@2314: #include "memory/allocation.hpp" stefank@2314: #include "utilities/top.hpp" stefank@2314: ysr@777: // Forward decl; ysr@777: class BitMapClosure; duke@435: ysr@777: // Operations for bitmaps represented as arrays of unsigned integers. ysr@777: // Bit offsets are numbered from 0 to size-1. duke@435: duke@435: class BitMap VALUE_OBJ_CLASS_SPEC { duke@435: friend class BitMap2D; duke@435: duke@435: public: duke@435: typedef size_t idx_t; // Type used for bit and word indices. ysr@777: typedef uintptr_t bm_word_t; // Element type of array that represents ysr@777: // the bitmap. duke@435: duke@435: // Hints for range sizes. duke@435: typedef enum { duke@435: unknown_range, small_range, large_range duke@435: } RangeSizeHint; duke@435: duke@435: private: brutisso@5278: ArrayAllocator _map_allocator; ysr@777: bm_word_t* _map; // First word in bitmap ysr@777: idx_t _size; // Size of bitmap (in bits) duke@435: duke@435: // Puts the given value at the given offset, using resize() to size duke@435: // the bitmap appropriately if needed using factor-of-two expansion. duke@435: void at_put_grow(idx_t index, bool value); duke@435: duke@435: protected: duke@435: // Return the position of bit within the word that contains it (e.g., if duke@435: // bitmap words are 32 bits, return a number 0 <= n <= 31). duke@435: static idx_t bit_in_word(idx_t bit) { return bit & (BitsPerWord - 1); } duke@435: duke@435: // Return a mask that will select the specified bit, when applied to the word duke@435: // containing the bit. ysr@777: static bm_word_t bit_mask(idx_t bit) { return (bm_word_t)1 << bit_in_word(bit); } duke@435: duke@435: // Return the index of the word containing the specified bit. duke@435: static idx_t word_index(idx_t bit) { return bit >> LogBitsPerWord; } duke@435: duke@435: // Return the bit number of the first bit in the specified word. duke@435: static idx_t bit_index(idx_t word) { return word << LogBitsPerWord; } duke@435: duke@435: // Return the array of bitmap words, or a specific word from it. ysr@777: bm_word_t* map() const { return _map; } ysr@777: bm_word_t map(idx_t word) const { return _map[word]; } duke@435: duke@435: // Return a pointer to the word containing the specified bit. ysr@777: bm_word_t* word_addr(idx_t bit) const { return map() + word_index(bit); } duke@435: duke@435: // Set a word to a specified value or to all ones; clear a word. ysr@777: void set_word (idx_t word, bm_word_t val) { _map[word] = val; } duke@435: void set_word (idx_t word) { set_word(word, ~(uintptr_t)0); } duke@435: void clear_word(idx_t word) { _map[word] = 0; } duke@435: duke@435: // Utilities for ranges of bits. Ranges are half-open [beg, end). duke@435: duke@435: // Ranges within a single word. ysr@777: bm_word_t inverted_bit_mask_for_range(idx_t beg, idx_t end) const; ysr@777: void set_range_within_word (idx_t beg, idx_t end); ysr@777: void clear_range_within_word (idx_t beg, idx_t end); ysr@777: void par_put_range_within_word (idx_t beg, idx_t end, bool value); duke@435: duke@435: // Ranges spanning entire words. ysr@777: void set_range_of_words (idx_t beg, idx_t end); ysr@777: void clear_range_of_words (idx_t beg, idx_t end); ysr@777: void set_large_range_of_words (idx_t beg, idx_t end); ysr@777: void clear_large_range_of_words (idx_t beg, idx_t end); duke@435: duke@435: // The index of the first full word in a range. ysr@777: idx_t word_index_round_up(idx_t bit) const; duke@435: jcoomes@1244: // Verification. jcoomes@1244: inline void verify_index(idx_t index) const NOT_DEBUG_RETURN; jcoomes@1244: inline void verify_range(idx_t beg_index, idx_t end_index) const jcoomes@1244: NOT_DEBUG_RETURN; duke@435: jcoomes@1244: // Statistics. ysr@777: static idx_t* _pop_count_table; ysr@777: static void init_pop_count_table(); ysr@777: static idx_t num_set_bits(bm_word_t w); ysr@777: static idx_t num_set_bits_from_table(unsigned char c); duke@435: duke@435: public: duke@435: duke@435: // Constructs a bitmap with no map, and size 0. brutisso@5278: BitMap() : _map(NULL), _size(0), _map_allocator(false) {} duke@435: ysr@777: // Constructs a bitmap with the given map and size. ysr@777: BitMap(bm_word_t* map, idx_t size_in_bits); duke@435: ysr@777: // Constructs an empty bitmap of the given size (that is, this clears the ysr@777: // new bitmap). Allocates the map array in resource area if ysr@777: // "in_resource_area" is true, else in the C heap. ysr@777: BitMap(idx_t size_in_bits, bool in_resource_area = true); duke@435: ysr@777: // Set the map and size. ysr@777: void set_map(bm_word_t* map) { _map = map; } duke@435: void set_size(idx_t size_in_bits) { _size = size_in_bits; } duke@435: ysr@777: // Allocates necessary data structure, either in the resource area ysr@777: // or in the C heap, as indicated by "in_resource_area." duke@435: // Preserves state currently in bit map by copying data. duke@435: // Zeros any newly-addressable bits. ysr@777: // If "in_resource_area" is false, frees the current map. ysr@777: // (Note that this assumes that all calls to "resize" on the same BitMap ysr@777: // use the same value for "in_resource_area".) ysr@777: void resize(idx_t size_in_bits, bool in_resource_area = true); duke@435: duke@435: // Accessing duke@435: idx_t size() const { return _size; } duke@435: idx_t size_in_words() const { duke@435: return word_index(size() + BitsPerWord - 1); duke@435: } duke@435: duke@435: bool at(idx_t index) const { duke@435: verify_index(index); duke@435: return (*word_addr(index) & bit_mask(index)) != 0; duke@435: } duke@435: duke@435: // Align bit index up or down to the next bitmap word boundary, or check duke@435: // alignment. duke@435: static idx_t word_align_up(idx_t bit) { duke@435: return align_size_up(bit, BitsPerWord); duke@435: } duke@435: static idx_t word_align_down(idx_t bit) { duke@435: return align_size_down(bit, BitsPerWord); duke@435: } duke@435: static bool is_word_aligned(idx_t bit) { duke@435: return word_align_up(bit) == bit; duke@435: } duke@435: duke@435: // Set or clear the specified bit. duke@435: inline void set_bit(idx_t bit); tonyp@2968: inline void clear_bit(idx_t bit); duke@435: duke@435: // Atomically set or clear the specified bit. tonyp@2968: inline bool par_set_bit(idx_t bit); tonyp@2968: inline bool par_clear_bit(idx_t bit); duke@435: duke@435: // Put the given value at the given offset. The parallel version duke@435: // will CAS the value into the bitmap and is quite a bit slower. duke@435: // The parallel version also returns a value indicating if the duke@435: // calling thread was the one that changed the value of the bit. duke@435: void at_put(idx_t index, bool value); duke@435: bool par_at_put(idx_t index, bool value); duke@435: duke@435: // Update a range of bits. Ranges are half-open [beg, end). duke@435: void set_range (idx_t beg, idx_t end); duke@435: void clear_range (idx_t beg, idx_t end); duke@435: void set_large_range (idx_t beg, idx_t end); duke@435: void clear_large_range (idx_t beg, idx_t end); duke@435: void at_put_range(idx_t beg, idx_t end, bool value); duke@435: void par_at_put_range(idx_t beg, idx_t end, bool value); duke@435: void at_put_large_range(idx_t beg, idx_t end, bool value); duke@435: void par_at_put_large_range(idx_t beg, idx_t end, bool value); duke@435: duke@435: // Update a range of bits, using a hint about the size. Currently only duke@435: // inlines the predominant case of a 1-bit range. Works best when hint is a duke@435: // compile-time constant. ysr@777: void set_range(idx_t beg, idx_t end, RangeSizeHint hint); ysr@777: void clear_range(idx_t beg, idx_t end, RangeSizeHint hint); ysr@777: void par_set_range(idx_t beg, idx_t end, RangeSizeHint hint); ysr@777: void par_clear_range (idx_t beg, idx_t end, RangeSizeHint hint); ysr@777: duke@435: // Clearing duke@435: void clear_large(); ysr@777: inline void clear(); duke@435: ysr@777: // Iteration support. Returns "true" if the iteration completed, false ysr@777: // if the iteration terminated early (because the closure "blk" returned ysr@777: // false). ysr@777: bool iterate(BitMapClosure* blk, idx_t leftIndex, idx_t rightIndex); ysr@777: bool iterate(BitMapClosure* blk) { duke@435: // call the version that takes an interval ysr@777: return iterate(blk, 0, size()); duke@435: } duke@435: ysr@777: // Looking for 1's and 0's at indices equal to or greater than "l_index", ysr@777: // stopping if none has been found before "r_index", and returning ysr@777: // "r_index" (which must be at most "size") in that case. ysr@777: idx_t get_next_one_offset_inline (idx_t l_index, idx_t r_index) const; ysr@777: idx_t get_next_zero_offset_inline(idx_t l_index, idx_t r_index) const; ysr@777: ysr@777: // Like "get_next_one_offset_inline", except requires that "r_index" is ysr@777: // aligned to bitsizeof(bm_word_t). ysr@777: idx_t get_next_one_offset_inline_aligned_right(idx_t l_index, ysr@777: idx_t r_index) const; ysr@777: ysr@777: // Non-inline versionsof the above. duke@435: idx_t get_next_one_offset (idx_t l_index, idx_t r_index) const; duke@435: idx_t get_next_zero_offset(idx_t l_index, idx_t r_index) const; duke@435: duke@435: idx_t get_next_one_offset(idx_t offset) const { duke@435: return get_next_one_offset(offset, size()); duke@435: } duke@435: idx_t get_next_zero_offset(idx_t offset) const { duke@435: return get_next_zero_offset(offset, size()); duke@435: } duke@435: ysr@777: // Returns the number of bits set in the bitmap. ysr@777: idx_t count_one_bits() const; duke@435: duke@435: // Set operations. duke@435: void set_union(BitMap bits); duke@435: void set_difference(BitMap bits); duke@435: void set_intersection(BitMap bits); duke@435: // Returns true iff "this" is a superset of "bits". duke@435: bool contains(const BitMap bits) const; duke@435: // Returns true iff "this and "bits" have a non-empty intersection. duke@435: bool intersects(const BitMap bits) const; duke@435: duke@435: // Returns result of whether this map changed duke@435: // during the operation duke@435: bool set_union_with_result(BitMap bits); duke@435: bool set_difference_with_result(BitMap bits); duke@435: bool set_intersection_with_result(BitMap bits); duke@435: ysr@777: // Requires the submap of "bits" starting at offset to be at least as ysr@777: // large as "this". Modifies "this" to be the intersection of its ysr@777: // current contents and the submap of "bits" starting at "offset" of the ysr@777: // same length as "this." ysr@777: // (For expedience, currently requires the offset to be aligned to the ysr@777: // bitsize of a uintptr_t. This should go away in the future though it ysr@777: // will probably remain a good case to optimize.) ysr@777: void set_intersection_at_offset(BitMap bits, idx_t offset); ysr@777: duke@435: void set_from(BitMap bits); duke@435: duke@435: bool is_same(BitMap bits); duke@435: duke@435: // Test if all bits are set or cleared duke@435: bool is_full() const; duke@435: bool is_empty() const; duke@435: stefank@4904: void print_on_error(outputStream* st, const char* prefix) const; duke@435: duke@435: #ifndef PRODUCT duke@435: public: duke@435: // Printing duke@435: void print_on(outputStream* st) const; duke@435: #endif duke@435: }; duke@435: duke@435: // Convenience class wrapping BitMap which provides multiple bits per slot. duke@435: class BitMap2D VALUE_OBJ_CLASS_SPEC { duke@435: public: ysr@777: typedef BitMap::idx_t idx_t; // Type used for bit and word indices. ysr@777: typedef BitMap::bm_word_t bm_word_t; // Element type of array that ysr@777: // represents the bitmap. duke@435: private: duke@435: BitMap _map; duke@435: idx_t _bits_per_slot; duke@435: duke@435: idx_t bit_index(idx_t slot_index, idx_t bit_within_slot_index) const { duke@435: return slot_index * _bits_per_slot + bit_within_slot_index; duke@435: } duke@435: duke@435: void verify_bit_within_slot_index(idx_t index) const { duke@435: assert(index < _bits_per_slot, "bit_within_slot index out of bounds"); duke@435: } duke@435: duke@435: public: duke@435: // Construction. bits_per_slot must be greater than 0. ysr@777: BitMap2D(bm_word_t* map, idx_t size_in_slots, idx_t bits_per_slot); duke@435: duke@435: // Allocates necessary data structure in resource area. bits_per_slot must be greater than 0. duke@435: BitMap2D(idx_t size_in_slots, idx_t bits_per_slot); duke@435: duke@435: idx_t size_in_bits() { duke@435: return _map.size(); duke@435: } duke@435: duke@435: // Returns number of full slots that have been allocated duke@435: idx_t size_in_slots() { duke@435: // Round down duke@435: return _map.size() / _bits_per_slot; duke@435: } duke@435: duke@435: bool is_valid_index(idx_t slot_index, idx_t bit_within_slot_index) { duke@435: verify_bit_within_slot_index(bit_within_slot_index); duke@435: return (bit_index(slot_index, bit_within_slot_index) < size_in_bits()); duke@435: } duke@435: duke@435: bool at(idx_t slot_index, idx_t bit_within_slot_index) const { duke@435: verify_bit_within_slot_index(bit_within_slot_index); duke@435: return _map.at(bit_index(slot_index, bit_within_slot_index)); duke@435: } duke@435: duke@435: void set_bit(idx_t slot_index, idx_t bit_within_slot_index) { duke@435: verify_bit_within_slot_index(bit_within_slot_index); duke@435: _map.set_bit(bit_index(slot_index, bit_within_slot_index)); duke@435: } duke@435: duke@435: void clear_bit(idx_t slot_index, idx_t bit_within_slot_index) { duke@435: verify_bit_within_slot_index(bit_within_slot_index); duke@435: _map.clear_bit(bit_index(slot_index, bit_within_slot_index)); duke@435: } duke@435: duke@435: void at_put(idx_t slot_index, idx_t bit_within_slot_index, bool value) { duke@435: verify_bit_within_slot_index(bit_within_slot_index); duke@435: _map.at_put(bit_index(slot_index, bit_within_slot_index), value); duke@435: } duke@435: duke@435: void at_put_grow(idx_t slot_index, idx_t bit_within_slot_index, bool value) { duke@435: verify_bit_within_slot_index(bit_within_slot_index); duke@435: _map.at_put_grow(bit_index(slot_index, bit_within_slot_index), value); duke@435: } duke@435: ysr@777: void clear(); duke@435: }; duke@435: ysr@777: // Closure for iterating over BitMaps duke@435: ysr@777: class BitMapClosure VALUE_OBJ_CLASS_SPEC { ysr@777: public: ysr@777: // Callback when bit in map is set. Should normally return "true"; ysr@777: // return of false indicates that the bitmap iteration should terminate. ysr@777: virtual bool do_bit(BitMap::idx_t offset) = 0; ysr@777: }; stefank@2314: stefank@2314: #endif // SHARE_VM_UTILITIES_BITMAP_HPP