annotate src/share/vm/libadt/dict.hpp @ 4710:41406797186b

7113012: G1: rename not-fully-young GCs as "mixed" Summary: Renamed partially-young GCs as mixed and fully-young GCs as young. Change all external output that includes those terms (GC log and GC ergo log) as well as any comments, fields, methods, etc. The changeset also includes very minor code tidying up (added some curly brackets). Reviewed-by: johnc, brutisso
author tonyp
date Fri, 16 Dec 2011 02:14:27 -0500
parents f95d63e2154a
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
a61af66fc99e Initial load
duke
parents:
diff changeset
1 /*
1972
f95d63e2154a 6989984: Use standard include model for Hospot
stefank
parents: 1552
diff changeset
2 * Copyright (c) 1997, 2010, Oracle and/or its affiliates. All rights reserved.
0
a61af66fc99e Initial load
duke
parents:
diff changeset
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
a61af66fc99e Initial load
duke
parents:
diff changeset
4 *
a61af66fc99e Initial load
duke
parents:
diff changeset
5 * This code is free software; you can redistribute it and/or modify it
a61af66fc99e Initial load
duke
parents:
diff changeset
6 * under the terms of the GNU General Public License version 2 only, as
a61af66fc99e Initial load
duke
parents:
diff changeset
7 * published by the Free Software Foundation.
a61af66fc99e Initial load
duke
parents:
diff changeset
8 *
a61af66fc99e Initial load
duke
parents:
diff changeset
9 * This code is distributed in the hope that it will be useful, but WITHOUT
a61af66fc99e Initial load
duke
parents:
diff changeset
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
a61af66fc99e Initial load
duke
parents:
diff changeset
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
a61af66fc99e Initial load
duke
parents:
diff changeset
12 * version 2 for more details (a copy is included in the LICENSE file that
a61af66fc99e Initial load
duke
parents:
diff changeset
13 * accompanied this code).
a61af66fc99e Initial load
duke
parents:
diff changeset
14 *
a61af66fc99e Initial load
duke
parents:
diff changeset
15 * You should have received a copy of the GNU General Public License version
a61af66fc99e Initial load
duke
parents:
diff changeset
16 * 2 along with this work; if not, write to the Free Software Foundation,
a61af66fc99e Initial load
duke
parents:
diff changeset
17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
a61af66fc99e Initial load
duke
parents:
diff changeset
18 *
1552
c18cbe5936b8 6941466: Oracle rebranding changes for Hotspot repositories
trims
parents: 605
diff changeset
19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
c18cbe5936b8 6941466: Oracle rebranding changes for Hotspot repositories
trims
parents: 605
diff changeset
20 * or visit www.oracle.com if you need additional information or have any
c18cbe5936b8 6941466: Oracle rebranding changes for Hotspot repositories
trims
parents: 605
diff changeset
21 * questions.
0
a61af66fc99e Initial load
duke
parents:
diff changeset
22 *
a61af66fc99e Initial load
duke
parents:
diff changeset
23 */
a61af66fc99e Initial load
duke
parents:
diff changeset
24
1972
f95d63e2154a 6989984: Use standard include model for Hospot
stefank
parents: 1552
diff changeset
25 #ifndef SHARE_VM_LIBADT_DICT_HPP
f95d63e2154a 6989984: Use standard include model for Hospot
stefank
parents: 1552
diff changeset
26 #define SHARE_VM_LIBADT_DICT_HPP
f95d63e2154a 6989984: Use standard include model for Hospot
stefank
parents: 1552
diff changeset
27
f95d63e2154a 6989984: Use standard include model for Hospot
stefank
parents: 1552
diff changeset
28 #include "libadt/port.hpp"
f95d63e2154a 6989984: Use standard include model for Hospot
stefank
parents: 1552
diff changeset
29
0
a61af66fc99e Initial load
duke
parents:
diff changeset
30 // Dictionaries - An Abstract Data Type
a61af66fc99e Initial load
duke
parents:
diff changeset
31 //INTERFACE
a61af66fc99e Initial load
duke
parents:
diff changeset
32 class ostream;
a61af66fc99e Initial load
duke
parents:
diff changeset
33 class Dict;
a61af66fc99e Initial load
duke
parents:
diff changeset
34
a61af66fc99e Initial load
duke
parents:
diff changeset
35 // These dictionaries define a key-value mapping. They can be inserted to,
a61af66fc99e Initial load
duke
parents:
diff changeset
36 // searched or deleted from. They grow and shrink as needed. The key is a
a61af66fc99e Initial load
duke
parents:
diff changeset
37 // pointer to something (or anything which can be stored in a pointer). A
a61af66fc99e Initial load
duke
parents:
diff changeset
38 // key comparison routine determines if two keys are equal or not. A hash
a61af66fc99e Initial load
duke
parents:
diff changeset
39 // function can be provided; if it's not provided the key itself is used
a61af66fc99e Initial load
duke
parents:
diff changeset
40 // instead. A nice string hash function is included.
a61af66fc99e Initial load
duke
parents:
diff changeset
41 typedef int32 (*CmpKey)(const void *key1, const void *key2);
a61af66fc99e Initial load
duke
parents:
diff changeset
42 typedef int (*Hash)(const void *key);
a61af66fc99e Initial load
duke
parents:
diff changeset
43 typedef void (*FuncDict)(const void *key, const void *val, Dict *d);
a61af66fc99e Initial load
duke
parents:
diff changeset
44
a61af66fc99e Initial load
duke
parents:
diff changeset
45 class Dict : public ResourceObj { // Dictionary structure
a61af66fc99e Initial load
duke
parents:
diff changeset
46 private:
a61af66fc99e Initial load
duke
parents:
diff changeset
47 class Arena *_arena; // Where to draw storage from
a61af66fc99e Initial load
duke
parents:
diff changeset
48 class bucket *_bin; // Hash table is array of buckets
a61af66fc99e Initial load
duke
parents:
diff changeset
49 uint _size; // Size (# of slots) in hash table
a61af66fc99e Initial load
duke
parents:
diff changeset
50 uint32 _cnt; // Number of key-value pairs in hash table
a61af66fc99e Initial load
duke
parents:
diff changeset
51 const Hash _hash; // Hashing function
a61af66fc99e Initial load
duke
parents:
diff changeset
52 const CmpKey _cmp; // Key comparison function
a61af66fc99e Initial load
duke
parents:
diff changeset
53 void doubhash( void ); // Double hash table size
a61af66fc99e Initial load
duke
parents:
diff changeset
54
a61af66fc99e Initial load
duke
parents:
diff changeset
55 public:
a61af66fc99e Initial load
duke
parents:
diff changeset
56 friend class DictI; // Friendly iterator function
a61af66fc99e Initial load
duke
parents:
diff changeset
57
a61af66fc99e Initial load
duke
parents:
diff changeset
58 // cmp is a key comparision routine. hash is a routine to hash a key.
a61af66fc99e Initial load
duke
parents:
diff changeset
59 Dict( CmpKey cmp, Hash hash );
a61af66fc99e Initial load
duke
parents:
diff changeset
60 Dict( CmpKey cmp, Hash hash, Arena *arena, int size=16 );
a61af66fc99e Initial load
duke
parents:
diff changeset
61 ~Dict();
a61af66fc99e Initial load
duke
parents:
diff changeset
62
a61af66fc99e Initial load
duke
parents:
diff changeset
63 Dict( const Dict & ); // Deep-copy guts
a61af66fc99e Initial load
duke
parents:
diff changeset
64 Dict &operator =( const Dict & );
a61af66fc99e Initial load
duke
parents:
diff changeset
65
a61af66fc99e Initial load
duke
parents:
diff changeset
66 // Zap to empty; ready for re-use
a61af66fc99e Initial load
duke
parents:
diff changeset
67 void Clear();
a61af66fc99e Initial load
duke
parents:
diff changeset
68
a61af66fc99e Initial load
duke
parents:
diff changeset
69 // Return # of key-value pairs in dict
a61af66fc99e Initial load
duke
parents:
diff changeset
70 uint32 Size(void) const { return _cnt; }
a61af66fc99e Initial load
duke
parents:
diff changeset
71
a61af66fc99e Initial load
duke
parents:
diff changeset
72 // Insert inserts the given key-value pair into the dictionary. The prior
a61af66fc99e Initial load
duke
parents:
diff changeset
73 // value of the key is returned; NULL if the key was not previously defined.
a61af66fc99e Initial load
duke
parents:
diff changeset
74 void *Insert(void *key, void *val, bool replace = true); // A new key-value
a61af66fc99e Initial load
duke
parents:
diff changeset
75 void *Delete(void *key); // Delete & return old
a61af66fc99e Initial load
duke
parents:
diff changeset
76
a61af66fc99e Initial load
duke
parents:
diff changeset
77 // Find finds the value of a given key; or NULL if not found.
a61af66fc99e Initial load
duke
parents:
diff changeset
78 // The dictionary is NOT changed.
a61af66fc99e Initial load
duke
parents:
diff changeset
79 void *operator [](const void *key) const; // Do a lookup
a61af66fc99e Initial load
duke
parents:
diff changeset
80
a61af66fc99e Initial load
duke
parents:
diff changeset
81 // == compares two dictionaries; they must have the same keys (their keys
a61af66fc99e Initial load
duke
parents:
diff changeset
82 // must match using CmpKey) and they must have the same values (pointer
a61af66fc99e Initial load
duke
parents:
diff changeset
83 // comparison). If so 1 is returned, if not 0 is returned.
a61af66fc99e Initial load
duke
parents:
diff changeset
84 int32 operator ==(const Dict &d) const; // Compare dictionaries for equal
a61af66fc99e Initial load
duke
parents:
diff changeset
85
a61af66fc99e Initial load
duke
parents:
diff changeset
86 // Print out the dictionary contents as key-value pairs
a61af66fc99e Initial load
duke
parents:
diff changeset
87 void print();
a61af66fc99e Initial load
duke
parents:
diff changeset
88 };
a61af66fc99e Initial load
duke
parents:
diff changeset
89
a61af66fc99e Initial load
duke
parents:
diff changeset
90 // Hashing functions
a61af66fc99e Initial load
duke
parents:
diff changeset
91 int hashstr(const void *s); // Nice string hash
605
98cb887364d3 6810672: Comment typos
twisti
parents: 0
diff changeset
92 // Slimey cheap hash function; no guaranteed performance. Better than the
0
a61af66fc99e Initial load
duke
parents:
diff changeset
93 // default for pointers, especially on MS-DOS machines.
a61af66fc99e Initial load
duke
parents:
diff changeset
94 int hashptr(const void *key);
605
98cb887364d3 6810672: Comment typos
twisti
parents: 0
diff changeset
95 // Slimey cheap hash function; no guaranteed performance.
0
a61af66fc99e Initial load
duke
parents:
diff changeset
96 int hashkey(const void *key);
a61af66fc99e Initial load
duke
parents:
diff changeset
97
a61af66fc99e Initial load
duke
parents:
diff changeset
98 // Key comparators
a61af66fc99e Initial load
duke
parents:
diff changeset
99 int32 cmpstr(const void *k1, const void *k2);
a61af66fc99e Initial load
duke
parents:
diff changeset
100 // Slimey cheap key comparator.
a61af66fc99e Initial load
duke
parents:
diff changeset
101 int32 cmpkey(const void *key1, const void *key2);
a61af66fc99e Initial load
duke
parents:
diff changeset
102
a61af66fc99e Initial load
duke
parents:
diff changeset
103 //------------------------------Iteration--------------------------------------
a61af66fc99e Initial load
duke
parents:
diff changeset
104 // The class of dictionary iterators. Fails in the presences of modifications
a61af66fc99e Initial load
duke
parents:
diff changeset
105 // to the dictionary during iteration (including searches).
a61af66fc99e Initial load
duke
parents:
diff changeset
106 // Usage: for( DictI i(dict); i.test(); ++i ) { body = i.key; body = i.value;}
a61af66fc99e Initial load
duke
parents:
diff changeset
107 class DictI {
a61af66fc99e Initial load
duke
parents:
diff changeset
108 private:
a61af66fc99e Initial load
duke
parents:
diff changeset
109 const Dict *_d; // Dictionary being iterated over
a61af66fc99e Initial load
duke
parents:
diff changeset
110 uint _i; // Counter over the bins
a61af66fc99e Initial load
duke
parents:
diff changeset
111 uint _j; // Counter inside each bin
a61af66fc99e Initial load
duke
parents:
diff changeset
112 public:
a61af66fc99e Initial load
duke
parents:
diff changeset
113 const void *_key, *_value; // Easy access to the key-value pair
a61af66fc99e Initial load
duke
parents:
diff changeset
114 DictI( const Dict *d ) {reset(d);}; // Create a new iterator
a61af66fc99e Initial load
duke
parents:
diff changeset
115 void reset( const Dict *dict ); // Reset existing iterator
a61af66fc99e Initial load
duke
parents:
diff changeset
116 void operator ++(void); // Increment iterator
a61af66fc99e Initial load
duke
parents:
diff changeset
117 int test(void) { return _i<_d->_size;} // Test for end of iteration
a61af66fc99e Initial load
duke
parents:
diff changeset
118 };
a61af66fc99e Initial load
duke
parents:
diff changeset
119
1972
f95d63e2154a 6989984: Use standard include model for Hospot
stefank
parents: 1552
diff changeset
120 #endif // SHARE_VM_LIBADT_DICT_HPP