e576bb2002-10-11Martin Nilsson /* || 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.
7b62e22011-04-25Martin Stjernholm || $Id$
e576bb2002-10-11Martin Nilsson */
24ddc71998-03-28Henrik Grubbström (Grubba) 
5267b71995-08-09Fredrik Hübinette (Hubbe) #ifndef MAPPING_H #define MAPPING_H
38ac332003-11-14Martin Stjernholm #include "svalue.h"
52fefa2004-09-27Martin Stjernholm #include "dmalloc.h"
59e53e2000-01-31Fredrik Hübinette (Hubbe) #include "block_alloc_h.h"
5267b71995-08-09Fredrik Hübinette (Hubbe) 
0b5d2b2001-06-05Martin Stjernholm /* 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. */
3b589f1999-02-04Fredrik Hübinette (Hubbe) 
0cde281998-05-14Fredrik Hübinette (Hubbe) struct keypair { struct keypair *next;
54beb22000-02-01Fredrik Hübinette (Hubbe)  unsigned INT32 hval;
0cde281998-05-14Fredrik Hübinette (Hubbe)  struct svalue ind, val; };
57a4ab2000-01-27Fredrik Hübinette (Hubbe) struct mapping_data {
45637c2001-04-07Fredrik Hübinette (Hubbe)  PIKE_MEMORY_OBJECT_MEMBERS;
57a4ab2000-01-27Fredrik Hübinette (Hubbe)  INT32 valrefs; /* lock values too */ INT32 hardlinks; INT32 size, hashsize; INT32 num_keypairs; TYPE_FIELD ind_types, val_types;
ee7b382000-09-04Martin Stjernholm  INT16 flags;
57a4ab2000-01-27Fredrik Hübinette (Hubbe)  struct keypair *free_list; struct keypair *hash[1 /* hashsize */ ]; /* struct keypair data_block[ hashsize * AVG_LINK_LENGTH ] */ };
ee7b382000-09-04Martin Stjernholm #undef MAPPING_SIZE_DEBUG
c835122000-12-14Martin Stjernholm /* This debug doesn't work with weak mappings in the gc. */
ee7b382000-09-04Martin Stjernholm 
5267b71995-08-09Fredrik Hübinette (Hubbe) struct mapping {
45637c2001-04-07Fredrik Hübinette (Hubbe)  PIKE_MEMORY_OBJECT_MEMBERS;
ee7b382000-09-04Martin Stjernholm #ifdef MAPPING_SIZE_DEBUG
20b19f2000-02-09Fredrik Hübinette (Hubbe)  INT32 debug_size;
9e398c2000-02-08Fredrik Hübinette (Hubbe) #endif
57a4ab2000-01-27Fredrik Hübinette (Hubbe)  struct mapping_data *data;
515b6c1996-06-09Fredrik Hübinette (Hubbe)  struct mapping *next, *prev;
5267b71995-08-09Fredrik Hübinette (Hubbe) };
57a4ab2000-01-27Fredrik Hübinette (Hubbe) 
62971d1998-01-19Fredrik Hübinette (Hubbe) extern struct mapping *first_mapping;
e2d9e62000-06-10Martin Stjernholm extern struct mapping *gc_internal_mapping;
62971d1998-01-19Fredrik Hübinette (Hubbe) 
ea0be61999-11-11Fredrik Hübinette (Hubbe) #define map_delete(m,key) map_delete_no_free(m, key, 0)
57a4ab2000-01-27Fredrik Hübinette (Hubbe) #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)
ee7b382000-09-04Martin Stjernholm #define mapping_get_flags(m) ((m)->data->flags)
1945142004-02-10Martin Stjernholm #define mapping_data_is_shared(m) ((m)->data->refs > 1)
57a4ab2000-01-27Fredrik Hübinette (Hubbe) 
df9b622001-05-27Henrik Grubbström (Grubba) #define MD_KEYPAIRS(MD, HSIZE) \
d2361e2003-06-30Martin Stjernholm  ( (struct keypair *) \ DO_ALIGN( PTR_TO_INT(((struct mapping_data *)(MD))->hash + HSIZE), \ ALIGNOF(struct keypair)) )
57a4ab2000-01-27Fredrik Hübinette (Hubbe) 
df9b622001-05-27Henrik Grubbström (Grubba) #ifndef PIKE_MAPPING_KEYPAIR_LOOP
57a4ab2000-01-27Fredrik Hübinette (Hubbe) #define NEW_MAPPING_LOOP(md) \
821f942001-06-30Martin Stjernholm  for((e=0) DO_IF_DMALLOC( ?0:(debug_malloc_touch(md)) ) ;e<(md)->hashsize;e++) for(k=(md)->hash[e];k;k=k->next)
57a4ab2000-01-27Fredrik Hübinette (Hubbe)  /* WARNING: this should not be used */ #define MAPPING_LOOP(m) \
821f942001-06-30Martin Stjernholm  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)
df9b622001-05-27Henrik Grubbström (Grubba) #else /* PIKE_MAPPING_KEYPAIR_LOOP */ #define NEW_MAPPING_LOOP(md) \
821f942001-06-30Martin Stjernholm  for(((k = MD_KEYPAIRS(md, (md)->hashsize)), e=0) DO_IF_DMALLOC( ?0:(debug_malloc_touch(md)) ) ; e<(md)->size; e++,k++)
df9b622001-05-27Henrik Grubbström (Grubba) /* WARNING: this should not be used */ #define MAPPING_LOOP(m) \
821f942001-06-30Martin Stjernholm  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++)
df9b622001-05-27Henrik Grubbström (Grubba) #endif /* PIKE_MAPPING_KEYPAIR_LOOP */
515b6c1996-06-09Fredrik Hübinette (Hubbe) 
4fab5f2004-04-18Martin Stjernholm #define free_mapping(M) do{ \ struct mapping *m_=(M); \ debug_malloc_touch(m_); \
b0eec22004-09-27Martin Stjernholm  DO_IF_DEBUG ( \
a741a72004-09-29Martin Stjernholm  DO_IF_PIKE_CLEANUP ( \ if (gc_external_refs_zapped) \ gc_check_zapped (m_, PIKE_T_MAPPING, __FILE__, __LINE__))); \
4fab5f2004-04-18Martin Stjernholm  if(!sub_ref(m_)) \ really_free_mapping(m_); \ }while(0)
54beb22000-02-01Fredrik Hübinette (Hubbe)  #define free_mapping_data(M) do{ \ struct mapping_data *md_=(M); \ debug_malloc_touch(md_); \
45637c2001-04-07Fredrik Hübinette (Hubbe)  if(!sub_ref(md_)) really_free_mapping_data(md_); \
7a76e82000-03-28Henrik Grubbström (Grubba)  /* FIXME: What about valrefs & hardlinks? */ \
54beb22000-02-01Fredrik Hübinette (Hubbe) }while(0)
5267b71995-08-09Fredrik Hübinette (Hubbe) 
1f21332000-07-28Fredrik Hübinette (Hubbe) PMOD_PROTO void really_free_mapping(struct mapping *md);
5267b71995-08-09Fredrik Hübinette (Hubbe) /* Prototypes begin here */
4dcaf52002-11-25Martin Stjernholm BLOCK_ALLOC_FILL_PAGES(mapping, 2)
59e53e2000-01-31Fredrik Hübinette (Hubbe) 
84387d2001-09-24Fredrik Hübinette (Hubbe) 
6f0d752000-12-16Marcus Comstedt PMOD_EXPORT struct mapping *debug_allocate_mapping(int size); PMOD_EXPORT void really_free_mapping_data(struct mapping_data *md); PMOD_EXPORT void do_free_mapping(struct mapping *m);
59e53e2000-01-31Fredrik Hübinette (Hubbe) struct mapping_data *copy_mapping_data(struct mapping_data *md);
6f0d752000-12-16Marcus Comstedt 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,
59e53e2000-01-31Fredrik Hübinette (Hubbe)  struct svalue *key, struct svalue *val, int overwrite);
6f0d752000-12-16Marcus Comstedt PMOD_EXPORT void mapping_insert(struct mapping *m,
515b6c1996-06-09Fredrik Hübinette (Hubbe)  struct svalue *key, struct svalue *val);
6f0d752000-12-16Marcus Comstedt PMOD_EXPORT union anything *mapping_get_item_ptr(struct mapping *m,
515b6c1996-06-09Fredrik Hübinette (Hubbe)  struct svalue *key,
5267b71995-08-09Fredrik Hübinette (Hubbe)  TYPE_T t);
6f0d752000-12-16Marcus Comstedt PMOD_EXPORT void map_delete_no_free(struct mapping *m,
ea0be61999-11-11Fredrik Hübinette (Hubbe)  struct svalue *key, struct svalue *to);
6f0d752000-12-16Marcus Comstedt PMOD_EXPORT void check_mapping_for_destruct(struct mapping *m); PMOD_EXPORT struct svalue *low_mapping_lookup(struct mapping *m,
06983f1996-09-22Fredrik Hübinette (Hubbe)  struct svalue *key);
6f0d752000-12-16Marcus Comstedt PMOD_EXPORT struct svalue *low_mapping_string_lookup(struct mapping *m,
14dae91997-01-26Fredrik Hübinette (Hubbe)  struct pike_string *p);
6f0d752000-12-16Marcus Comstedt PMOD_EXPORT void mapping_string_insert(struct mapping *m,
a28dd21998-04-23Fredrik Hübinette (Hubbe)  struct pike_string *p, struct svalue *val);
6f0d752000-12-16Marcus Comstedt PMOD_EXPORT void mapping_string_insert_string(struct mapping *m,
ea0be61999-11-11Fredrik Hübinette (Hubbe)  struct pike_string *p, struct pike_string *val);
6f0d752000-12-16Marcus Comstedt PMOD_EXPORT struct svalue *simple_mapping_string_lookup(struct mapping *m,
adb3b12004-03-22Martin Stjernholm  const char *p);
6f0d752000-12-16Marcus Comstedt PMOD_EXPORT struct svalue *mapping_mapping_lookup(struct mapping *m,
8a5d441999-10-19Fredrik Hübinette (Hubbe)  struct svalue *key1, struct svalue *key2, int create);
6f0d752000-12-16Marcus Comstedt PMOD_EXPORT struct svalue *mapping_mapping_string_lookup(struct mapping *m,
8a5d441999-10-19Fredrik Hübinette (Hubbe)  struct pike_string *key1, struct pike_string *key2, int create);
6f0d752000-12-16Marcus Comstedt PMOD_EXPORT void mapping_index_no_free(struct svalue *dest,
515b6c1996-06-09Fredrik Hübinette (Hubbe)  struct mapping *m, struct svalue *key);
6f0d752000-12-16Marcus Comstedt 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,
59e53e2000-01-31Fredrik Hübinette (Hubbe)  struct array *b, INT32 op);
6f0d752000-12-16Marcus Comstedt PMOD_EXPORT struct mapping *merge_mapping_array_unordered(struct mapping *a,
59e53e2000-01-31Fredrik Hübinette (Hubbe)  struct array *b, INT32 op);
6f0d752000-12-16Marcus Comstedt 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);
5267b71995-08-09Fredrik Hübinette (Hubbe) void describe_mapping(struct mapping *m,struct processing *p,int indent);
59e53e2000-01-31Fredrik Hübinette (Hubbe) node *make_node_from_mapping(struct mapping *m);
6f0d752000-12-16Marcus Comstedt PMOD_EXPORT void f_aggregate_mapping(INT32 args); PMOD_EXPORT struct mapping *copy_mapping_recursively(struct mapping *m,
84387d2001-09-24Fredrik Hübinette (Hubbe)  struct processing *p);
6f0d752000-12-16Marcus Comstedt PMOD_EXPORT void mapping_search_no_free(struct svalue *to,
5267b71995-08-09Fredrik Hübinette (Hubbe)  struct mapping *m, struct svalue *look_for,
59e53e2000-01-31Fredrik Hübinette (Hubbe)  struct svalue *key );
624d091996-02-24Fredrik Hübinette (Hubbe) void check_mapping(struct mapping *m);
be478c1997-08-30Henrik Grubbström (Grubba) void check_all_mappings(void);
c94c371996-03-28Fredrik Hübinette (Hubbe) void gc_mark_mapping_as_referenced(struct mapping *m);
84387d2001-09-24Fredrik Hübinette (Hubbe) void real_gc_cycle_check_mapping(struct mapping *m, int weak);
e2d9e62000-06-10Martin Stjernholm unsigned gc_touch_all_mappings(void);
be478c1997-08-30Henrik Grubbström (Grubba) void gc_check_all_mappings(void); void gc_mark_all_mappings(void);
e2d9e62000-06-10Martin Stjernholm void gc_cycle_check_all_mappings(void);
45d87e2000-07-18Martin Stjernholm void gc_zap_ext_weak_refs_in_mappings(void);
88cf4f2003-01-11Martin Stjernholm size_t gc_free_all_unreferenced_mappings(void);
61e9a01998-01-25Fredrik Hübinette (Hubbe) void simple_describe_mapping(struct mapping *m); void debug_dump_mapping(struct mapping *m);
84387d2001-09-24Fredrik Hübinette (Hubbe) int mapping_is_constant(struct mapping *m, struct processing *p);
5267b71995-08-09Fredrik Hübinette (Hubbe) /* Prototypes end here */
616b622000-01-31Fredrik Hübinette (Hubbe)  #define allocate_mapping(X) dmalloc_touch(struct mapping *,debug_allocate_mapping(X))
45d87e2000-07-18Martin Stjernholm #define gc_cycle_check_mapping(X, WEAK) \ gc_cycle_enqueue((gc_cycle_check_cb *) real_gc_cycle_check_mapping, (X), (WEAK))
e2d9e62000-06-10Martin Stjernholm  #endif /* MAPPING_H */