OSDN Git Service

2004-08-12 Ziemowit Laski <zlaski@apple.com>
[pf3gnuchains/gcc-fork.git] / libobjc / objc / sarray.h
1 /* Sparse Arrays for Objective C dispatch tables
2    Copyright (C) 1993, 1995, 1996, 2004 Free Software Foundation, Inc.
3    Contributed by Kresten Krab Thorup.
4
5 This file is part of GCC.
6
7 GCC is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
10 any later version.
11
12 GCC is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15 GNU General Public License for more details.
16
17 You should have received a copy of the GNU General Public License
18 along with GCC; see the file COPYING.  If not, write to
19 the Free Software Foundation, 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA.  */
21
22 /* As a special exception, if you link this library with files
23    compiled with GCC to produce an executable, this does not cause
24    the resulting executable to be covered by the GNU General Public License.
25    This exception does not however invalidate any other reasons why
26    the executable file might be covered by the GNU General Public License.  */
27
28 #ifndef __sarray_INCLUDE_GNU
29 #define __sarray_INCLUDE_GNU
30
31 #include <objc/thr.h>
32
33 #ifdef __cplusplus
34 extern "C" {
35 #endif /* __cplusplus */
36
37 #define OBJC_SPARSE2            /* 2-level sparse array */
38 /* #define OBJC_SPARSE3 */      /* 3-level sparse array */
39
40 #ifdef OBJC_SPARSE2
41 extern const char* __objc_sparse2_id;
42 #endif
43
44 #ifdef OBJC_SPARSE3
45 extern const char* __objc_sparse3_id;
46 #endif
47
48 #include <stddef.h>
49
50 extern int nbuckets;            /* for stats */
51 extern int nindices;
52 extern int narrays;
53 extern int idxsize;
54
55 #include <assert.h>
56
57 /* An unsigned integer of same size as a pointer */
58 #define SIZET_BITS (sizeof(size_t)*8)
59
60 #if defined(__sparc__) || defined(OBJC_SPARSE2)
61 #define PRECOMPUTE_SELECTORS
62 #endif
63
64 #ifdef OBJC_SPARSE3
65
66 /* Buckets are 8 words each */
67 #define BUCKET_BITS 3
68 #define BUCKET_SIZE (1<<BUCKET_BITS)
69 #define BUCKET_MASK (BUCKET_SIZE-1)
70
71 /* Indices are 16 words each */
72 #define INDEX_BITS 4
73 #define INDEX_SIZE (1<<INDEX_BITS)
74 #define INDEX_MASK (INDEX_SIZE-1)
75
76 #define INDEX_CAPACITY (BUCKET_SIZE*INDEX_SIZE)
77
78 #else /* OBJC_SPARSE2 */
79
80 /* Buckets are 32 words each */
81 #define BUCKET_BITS 5
82 #define BUCKET_SIZE (1<<BUCKET_BITS)
83 #define BUCKET_MASK (BUCKET_SIZE-1)
84
85 #endif /* OBJC_SPARSE2 */
86
87 typedef size_t sidx;
88
89 #ifdef PRECOMPUTE_SELECTORS
90
91 struct soffset {
92 #ifdef OBJC_SPARSE3
93   unsigned int unused : SIZET_BITS/4;
94   unsigned int eoffset : SIZET_BITS/4;
95   unsigned int boffset : SIZET_BITS/4;
96   unsigned int ioffset : SIZET_BITS/4;
97 #else /* OBJC_SPARSE2 */
98 #ifdef __sparc__
99   unsigned long boffset : (SIZET_BITS - 2) - BUCKET_BITS;
100   unsigned int eoffset : BUCKET_BITS;
101   unsigned int unused  : 2;
102 #else
103   unsigned int boffset : SIZET_BITS/2;
104   unsigned int eoffset : SIZET_BITS/2;
105 #endif
106 #endif /* OBJC_SPARSE2 */
107 };
108
109 union sofftype {
110   struct soffset off;
111   sidx idx;
112 };
113
114 #endif /* not PRECOMPUTE_SELECTORS */
115
116 union sversion {
117   int   version;
118   void *next_free;
119 };
120
121 struct sbucket {
122   void* elems[BUCKET_SIZE];     /* elements stored in array */
123   union sversion        version;                /* used for copy-on-write */
124 };
125
126 #ifdef OBJC_SPARSE3
127
128 struct sindex {
129   struct sbucket* buckets[INDEX_SIZE];
130   union sversion        version;                /* used for copy-on-write */
131 };
132
133 #endif /* OBJC_SPARSE3 */
134
135 struct sarray {
136 #ifdef OBJC_SPARSE3
137   struct sindex** indices;
138   struct sindex* empty_index;
139 #else /* OBJC_SPARSE2 */
140   struct sbucket** buckets;
141 #endif  /* OBJC_SPARSE2 */
142   struct sbucket* empty_bucket;
143   union sversion        version;                /* used for copy-on-write */
144   short ref_count;
145   struct sarray* is_copy_of;
146   size_t capacity;
147 };
148
149 struct sarray* sarray_new(int, void* default_element);
150 void sarray_free(struct sarray*);
151 struct sarray* sarray_lazy_copy(struct sarray*);
152 void sarray_realloc(struct sarray*, int new_size);
153 void sarray_at_put(struct sarray*, sidx indx, void* elem);
154 void sarray_at_put_safe(struct sarray*, sidx indx, void* elem);
155
156 struct sarray* sarray_hard_copy(struct sarray*); /* ... like the name? */
157 void sarray_remove_garbage(void);
158 \f
159
160 #ifdef PRECOMPUTE_SELECTORS
161 /* Transform soffset values to ints and vica verca */
162 static inline unsigned int
163 soffset_decode(sidx indx)
164 {
165   union sofftype x;
166   x.idx = indx;
167 #ifdef OBJC_SPARSE3
168   return x.off.eoffset
169     + (x.off.boffset*BUCKET_SIZE)
170       + (x.off.ioffset*INDEX_CAPACITY);
171 #else /* OBJC_SPARSE2 */
172   return x.off.eoffset + (x.off.boffset*BUCKET_SIZE);
173 #endif /* OBJC_SPARSE2 */
174 }
175
176 static inline sidx
177 soffset_encode(size_t offset)
178 {
179   union sofftype x;
180   x.off.eoffset = offset%BUCKET_SIZE;
181 #ifdef OBJC_SPARSE3
182   x.off.boffset = (offset/BUCKET_SIZE)%INDEX_SIZE;
183   x.off.ioffset = offset/INDEX_CAPACITY;
184 #else /* OBJC_SPARSE2 */
185   x.off.boffset = offset/BUCKET_SIZE;
186 #endif
187   return (sidx)x.idx;
188 }
189
190 #else /* not PRECOMPUTE_SELECTORS */
191
192 static inline size_t
193 soffset_decode(sidx indx)
194 {
195   return indx;
196 }
197
198 static inline sidx
199 soffset_encode(size_t offset)
200 {
201   return offset;
202 }
203 #endif /* not PRECOMPUTE_SELECTORS */
204
205 /* Get element from the Sparse array `array' at offset `indx' */
206
207 static inline void* sarray_get(struct sarray* array, sidx indx)
208 {
209 #ifdef PRECOMPUTE_SELECTORS
210   union sofftype x;
211   x.idx = indx;
212 #ifdef OBJC_SPARSE3
213   return 
214     array->
215       indices[x.off.ioffset]->
216         buckets[x.off.boffset]->
217           elems[x.off.eoffset];
218 #else /* OBJC_SPARSE2 */
219   return array->buckets[x.off.boffset]->elems[x.off.eoffset];
220 #endif /* OBJC_SPARSE2 */
221 #else /* not PRECOMPUTE_SELECTORS */
222 #ifdef OBJC_SPARSE3
223   return array->
224     indices[indx/INDEX_CAPACITY]->
225       buckets[(indx/BUCKET_SIZE)%INDEX_SIZE]->
226         elems[indx%BUCKET_SIZE];
227 #else /* OBJC_SPARSE2 */
228   return array->buckets[indx/BUCKET_SIZE]->elems[indx%BUCKET_SIZE];
229 #endif /* not OBJC_SPARSE3 */
230 #endif /* not PRECOMPUTE_SELECTORS */
231 }
232
233 static inline void* sarray_get_safe(struct sarray* array, sidx indx)
234 {
235   if(soffset_decode(indx) < array->capacity)
236     return sarray_get(array, indx);
237   else
238     return (array->empty_bucket->elems[0]);
239 }
240
241 #ifdef __cplusplus
242 }
243 #endif /* __cplusplus */
244
245 #endif /* __sarray_INCLUDE_GNU */