1
  
2
  
3
  
4
  
5
  
6
  
7
  
8
  
9
  
10
  
11
  
12
  
13
  
14
  
15
  
16
  
17
  
18
  
19
  
20
  
21
  
22
  
23
  
24
  
25
  
26
  
27
  
28
  
29
  
30
  
31
  
32
  
33
  
34
  
35
  
36
  
37
  
38
  
39
  
40
  
41
  
42
  
43
  
44
  
45
  
46
  
47
  
48
  
49
  
50
  
51
  
52
  
53
  
54
  
55
  
56
  
57
  
58
  
59
  
60
  
61
  
62
  
63
  
64
  
65
  
66
  
67
  
68
  
69
  
70
  
71
  
72
  
73
  
74
  
75
  
76
  
77
  
78
  
79
  
80
  
81
  
82
  
83
  
84
  
85
  
86
  
87
  
88
  
89
  
90
  
91
  
92
  
93
  
94
  
95
  
96
  
97
  
98
  
99
  
100
  
101
  
102
  
103
  
104
  
105
  
106
  
107
  
108
  
109
  
110
  
111
  
112
  
113
  
114
  
115
  
116
  
117
  
118
  
119
  
120
  
121
  
122
  
123
  
124
  
125
  
126
  
127
  
128
  
129
  
130
  
131
  
132
  
133
  
134
  
135
  
136
  
137
  
138
  
139
  
140
  
141
  
142
  
143
  
144
  
145
  
146
  
147
  
148
  
149
  
150
  
151
  
152
  
153
  
154
  
155
  
156
  
157
  
158
  
159
  
160
  
161
  
162
  
163
  
164
  
165
  
166
  
167
  
168
  
169
  
170
  
171
  
172
  
173
  
174
  
175
  
176
  
177
  
178
  
179
  
180
  
181
  
182
  
183
  
184
  
185
  
186
  
187
  
188
  
189
  
190
  
191
  
192
  
193
  
194
  
195
  
196
  
197
  
198
  
199
  
200
  
201
  
202
  
203
  
204
  
205
  
206
  
207
  
208
  
209
  
210
  
211
  
212
  
213
  
214
  
215
  
216
  
217
  
218
  
219
  
220
  
221
  
222
  
223
  
224
  
225
  
226
  
227
  
228
  
229
  
230
  
231
  
232
  
233
  
234
  
235
  
236
  
237
  
238
  
239
  
240
  
241
  
242
  
243
  
244
  
245
  
246
  
247
  
248
  
249
  
250
  
251
  
252
  
253
  
254
  
255
  
256
  
257
  
/* 
|| This file is part of Pike. For copyright information see COPYRIGHT. 
|| Pike is distributed under GPL, LGPL and MPL. See the file COPYING 
|| for more information. 
|| $Id: mapping.h,v 1.61 2005/09/10 02:15:45 grendel Exp $ 
*/ 
 
#ifndef MAPPING_H 
#define MAPPING_H 
 
#include "svalue.h" 
#include "dmalloc.h" 
#include "block_alloc_h.h" 
 
/* Compatible with PIKE_WEAK_INDICES and PIKE_WEAK_VALUES. */ 
#define MAPPING_WEAK_INDICES  2 
#define MAPPING_WEAK_VALUES 4 
#define MAPPING_WEAK                6 
#define MAPPING_FLAG_WEAK   6 /* Compat. */ 
 
struct keypair 
{ 
  struct keypair *next; 
  unsigned INT32 hval; 
  struct svalue ind, val; 
}; 
 
struct mapping_data 
{ 
  PIKE_MEMORY_OBJECT_MEMBERS; 
  INT32 valrefs; /* lock values too */ 
  INT32 hardlinks; 
  INT32 size, hashsize; 
  INT32 num_keypairs; 
  TYPE_FIELD ind_types, val_types; 
  INT16 flags; 
  struct keypair *free_list; 
  struct keypair *hash[1 /* hashsize */ ]; 
  /* struct keypair data_block[ hashsize * AVG_LINK_LENGTH ] */ 
}; 
 
#undef MAPPING_SIZE_DEBUG 
/* This debug doesn't work with weak mappings in the gc. */ 
 
struct mapping 
{ 
  PIKE_MEMORY_OBJECT_MEMBERS; 
#ifdef MAPPING_SIZE_DEBUG 
  INT32 debug_size; 
#endif 
  struct mapping_data *data; 
  struct mapping *next, *prev; 
}; 
 
 
extern struct mapping *first_mapping; 
extern struct mapping *gc_internal_mapping; 
 
#define map_delete(m,key) map_delete_no_free(m, key, 0) 
#define m_sizeof(m) ((m)->data->size) 
#define m_ind_types(m) ((m)->data->ind_types) 
#define m_val_types(m) ((m)->data->val_types) 
#define mapping_get_flags(m) ((m)->data->flags) 
#define mapping_data_is_shared(m) ((m)->data->refs > 1) 
 
#define MD_KEYPAIRS(MD, HSIZE) \ 
   ( (struct keypair *)                                                 \ 
     DO_ALIGN( PTR_TO_INT(((struct mapping_data *)(MD))->hash + HSIZE), \ 
               ALIGNOF(struct keypair)) ) 
 
#ifndef PIKE_MAPPING_KEYPAIR_LOOP 
#define NEW_MAPPING_LOOP(md) \ 
  for((e=0) DO_IF_DMALLOC( ?0:(debug_malloc_touch(md)) ) ;e<(md)->hashsize;e++) for(k=(md)->hash[e];k;k=k->next) 
 
/* WARNING: this should not be used */ 
#define MAPPING_LOOP(m) \ 
  for((e=0) DO_IF_DMALLOC( ?0:(debug_malloc_touch(m),debug_malloc_touch((m)->data))) ;e<(m)->data->hashsize;e++) for(k=(m)->data->hash[e];k;k=k->next) 
 
#else /* PIKE_MAPPING_KEYPAIR_LOOP */ 
 
#define NEW_MAPPING_LOOP(md) \ 
  for(((k = MD_KEYPAIRS(md, (md)->hashsize)), e=0) DO_IF_DMALLOC( ?0:(debug_malloc_touch(md)) ) ; e<(md)->size; e++,k++) 
 
/* WARNING: this should not be used */ 
#define MAPPING_LOOP(m) \ 
  for(((k = MD_KEYPAIRS((m)->data, (m)->data->hashsize)), e=0) DO_IF_DMALLOC( ?0:(debug_malloc_touch(m),debug_malloc_touch((m)->data)) ) ; e<(m)->data->size; e++,k++) 
 
#endif /* PIKE_MAPPING_KEYPAIR_LOOP */ 
 
/** Free a previously allocated mapping. The preferred method of freeing 
  * a mapping is by calling the @ref do_free_mapping function. 
  * 
  * @param M The mapping to be freed 
  * @see do_free_mapping 
  * @see free_mapping_data 
  */ 
#define free_mapping(M) do{                                           \ 
    struct mapping *m_=(M);                                             \ 
    debug_malloc_touch(m_);                                             \ 
    DO_IF_DEBUG (                                                       \ 
      DO_IF_PIKE_CLEANUP (                                              \ 
        if (gc_external_refs_zapped)                                    \ 
          gc_check_zapped (m_, PIKE_T_MAPPING, __FILE__, __LINE__)));   \ 
    if(!sub_ref(m_))                                                    \ 
      really_free_mapping(m_);                                          \ 
  }while(0) 
 
/** Free only the mapping data leaving the mapping structure itself intact. 
  * 
  * @param M The mapping structure 'data' member of the mapping whose data is to be removed 
  * @see free_mapping 
  * @see really_free_mapping_data 
  * @see mapping_data 
  * @see mapping 
  */ 
#define free_mapping_data(M) do{ \ 
 struct mapping_data *md_=(M); \ 
 debug_malloc_touch(md_); \ 
 if(!sub_ref(md_)) really_free_mapping_data(md_); \ 
 /* FIXME: What about valrefs & hardlinks? */ \ 
}while(0) 
 
PMOD_PROTO void really_free_mapping(struct mapping *md); 
 
/* Prototypes begin here */ 
BLOCK_ALLOC_FILL_PAGES(mapping, 2); 
 
 
 
 
 
 
PMOD_EXPORT struct mapping *debug_allocate_mapping(int size); 
 
/** Function that actually frees the mapping data, called by the wrapper 
  * macro free_mapping_data. 
  * 
  * @param M The mapping structure data member of the mapping whose data is to be removed 
  * @see free_mapping 
  * @see really_free_mapping_data 
  * @see mapping_data 
  * @see mapping 
  */ 
PMOD_EXPORT void really_free_mapping_data(struct mapping_data *md); 
 
/** A wrapper function for the free_mapping macro. Should be used instead of 
  * the macro as it checks whether the passed mapping is NULL or not. 
  * 
  * @param m The mapping to be freed 
  * @see free_mapping 
  */ 
PMOD_EXPORT void do_free_mapping(struct mapping *m); 
 
/** Makes a copy of the passed mapping data and returns it to the caller. 
  * 
  * @param md The mapping structure data member to be copied 
  * @return Copy of the passed data 
  * @see mapping 
  */ 
struct mapping_data *copy_mapping_data(struct mapping_data *md); 
PMOD_EXPORT void mapping_fix_type_field(struct mapping *m); 
PMOD_EXPORT void mapping_set_flags(struct mapping *m, int flags); 
PMOD_EXPORT void low_mapping_insert(struct mapping *m, 
                                    const struct svalue *key, 
                                    const struct svalue *val, 
                                    int overwrite); 
 
/** Inserts the specified key and value into the indicated mapping. If 
  * the key already exists in the mapping, its value is replaced with the 
  * new one. For other modes of dealing with existing keys you need to 
  * use the @ref low_mapping_insert function. 
  * 
  * @param m mapping the key/value are to be inserted to 
  * @param key the new entry key 
  * @param value the new entry value 
  * @see low_mapping_insert 
  */ 
PMOD_EXPORT void mapping_insert(struct mapping *m, 
                                const struct svalue *key, 
                                const struct svalue *val); 
PMOD_EXPORT union anything *mapping_get_item_ptr(struct mapping *m, 
                                     struct svalue *key, 
                                     TYPE_T t); 
PMOD_EXPORT void map_delete_no_free(struct mapping *m, 
                        struct svalue *key, 
                        struct svalue *to); 
PMOD_EXPORT void check_mapping_for_destruct(struct mapping *m); 
PMOD_EXPORT struct svalue *low_mapping_lookup(struct mapping *m, 
                                              const struct svalue *key); 
PMOD_EXPORT struct svalue *low_mapping_string_lookup(struct mapping *m, 
                                         struct pike_string *p); 
PMOD_EXPORT void mapping_string_insert(struct mapping *m, 
                           struct pike_string *p, 
                           struct svalue *val); 
PMOD_EXPORT void mapping_string_insert_string(struct mapping *m, 
                                  struct pike_string *p, 
                                  struct pike_string *val); 
PMOD_EXPORT struct svalue *simple_mapping_string_lookup(struct mapping *m, 
                                                        const char *p); 
PMOD_EXPORT struct svalue *mapping_mapping_lookup(struct mapping *m, 
                                      struct svalue *key1, 
                                      struct svalue *key2, 
                                      int create); 
PMOD_EXPORT struct svalue *mapping_mapping_string_lookup(struct mapping *m, 
                                      struct pike_string *key1, 
                                      struct pike_string *key2, 
                                      int create); 
PMOD_EXPORT void mapping_index_no_free(struct svalue *dest, 
                           struct mapping *m, 
                           struct svalue *key); 
PMOD_EXPORT struct array *mapping_indices(struct mapping *m); 
PMOD_EXPORT struct array *mapping_values(struct mapping *m); 
PMOD_EXPORT struct array *mapping_to_array(struct mapping *m); 
PMOD_EXPORT void mapping_replace(struct mapping *m,struct svalue *from, struct svalue *to); 
PMOD_EXPORT struct mapping *mkmapping(struct array *ind, struct array *val); 
PMOD_EXPORT struct mapping *copy_mapping(struct mapping *m); 
PMOD_EXPORT struct mapping *copy_mapping(struct mapping *m); 
PMOD_EXPORT struct mapping *merge_mappings(struct mapping *a, struct mapping *b, INT32 op); 
PMOD_EXPORT struct mapping *merge_mapping_array_ordered(struct mapping *a,  
                                            struct array *b, INT32 op); 
PMOD_EXPORT struct mapping *merge_mapping_array_unordered(struct mapping *a,  
                                              struct array *b, INT32 op); 
PMOD_EXPORT struct mapping *add_mappings(struct svalue *argp, INT32 args); 
PMOD_EXPORT int mapping_equal_p(struct mapping *a, struct mapping *b, struct processing *p); 
void describe_mapping(struct mapping *m,struct processing *p,int indent); 
node *make_node_from_mapping(struct mapping *m); 
PMOD_EXPORT void f_aggregate_mapping(INT32 args); 
PMOD_EXPORT struct mapping *copy_mapping_recursively(struct mapping *m, 
                                                     struct mapping *p); 
PMOD_EXPORT void mapping_search_no_free(struct svalue *to, 
                            struct mapping *m, 
                            struct svalue *look_for, 
                            struct svalue *key ); 
void check_mapping(struct mapping *m); 
void check_all_mappings(void); 
void gc_mark_mapping_as_referenced(struct mapping *m); 
void real_gc_cycle_check_mapping(struct mapping *m, int weak); 
unsigned gc_touch_all_mappings(void); 
void gc_check_all_mappings(void); 
void gc_mark_all_mappings(void); 
void gc_cycle_check_all_mappings(void); 
void gc_zap_ext_weak_refs_in_mappings(void); 
size_t gc_free_all_unreferenced_mappings(void); 
void simple_describe_mapping(struct mapping *m); 
void debug_dump_mapping(struct mapping *m); 
int mapping_is_constant(struct mapping *m, 
                        struct processing *p); 
/* Prototypes end here */ 
 
#define allocate_mapping(X) dmalloc_touch(struct mapping *,debug_allocate_mapping(X)) 
 
#define gc_cycle_check_mapping(X, WEAK) \ 
  gc_cycle_enqueue((gc_cycle_check_cb *) real_gc_cycle_check_mapping, (X), (WEAK)) 
 
#endif /* MAPPING_H */