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.
1eb9852008-05-11Martin Stjernholm || $Id: mapping.h,v 1.68 2008/05/11 14:55:53 mast Exp $
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"
72389e2004-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)
ea7fc72004-04-30Martin Nilsson 
df9b622001-05-27Henrik Grubbström (Grubba) #else /* PIKE_MAPPING_KEYPAIR_LOOP */
ea7fc72004-04-30Martin Nilsson 
df9b622001-05-27Henrik Grubbström (Grubba) #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++)
ea7fc72004-04-30Martin Nilsson 
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++)
ea7fc72004-04-30Martin Nilsson 
df9b622001-05-27Henrik Grubbström (Grubba) #endif /* PIKE_MAPPING_KEYPAIR_LOOP */
515b6c1996-06-09Fredrik Hübinette (Hubbe) 
488ce02006-07-05Martin Stjernholm 
6c21922006-08-06Martin Stjernholm void really_free_mapping(struct mapping *md);
466b662008-01-05Martin Nilsson #define inl_free_mapping(M) do{ \
4fab5f2004-04-18Martin Stjernholm  struct mapping *m_=(M); \ debug_malloc_touch(m_); \
31a8682004-09-27Martin Stjernholm  DO_IF_DEBUG ( \
dbcb292004-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) 
466b662008-01-05Martin Nilsson #if defined(USE_DLL) && defined(DYNAMIC_MODULE) /* Use the function in modules so we don't have to export the block * alloc stuff. */ #define free_mapping(M) do_free_mapping (M) #else /** 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) inl_free_mapping(M)
1abbfb2006-07-05Martin Stjernholm #endif /* !(USE_DLL && DYNAMIC_MODULE) */
488ce02006-07-05Martin Stjernholm 
466b662008-01-05Martin Nilsson 
2dff752005-09-10Marek Habersack /** 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 */
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)  /* Prototypes begin here */
13af4a2005-04-08Henrik Grubbström (Grubba) 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);
2dff752005-09-10Marek Habersack  /** 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 */
6f0d752000-12-16Marcus Comstedt PMOD_EXPORT void really_free_mapping_data(struct mapping_data *md);
2dff752005-09-10Marek Habersack  /** 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 */
6f0d752000-12-16Marcus Comstedt PMOD_EXPORT void do_free_mapping(struct mapping *m);
2dff752005-09-10Marek Habersack  /** 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 */
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);
b14b412005-09-11Marek Habersack  /** This function inserts key:val into the mapping m. * Same as doing m[key]=val; in pike. * * @param overwrite how to deal with existing values@n * @b 0: Do not replace the value if the entry exists.@n * @b 1: Replace the value if the entry exists.@n * @b 2: Replace both the index and the value if the entry exists. */
6f0d752000-12-16Marcus Comstedt PMOD_EXPORT void low_mapping_insert(struct mapping *m,
9cc28d2004-05-28Henrik Grubbström (Grubba)  const struct svalue *key, const struct svalue *val, int overwrite);
2dff752005-09-10Marek Habersack  /** 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 */
6f0d752000-12-16Marcus Comstedt PMOD_EXPORT void mapping_insert(struct mapping *m,
9cc28d2004-05-28Henrik Grubbström (Grubba)  const struct svalue *key, const struct svalue *val);
6f0d752000-12-16Marcus Comstedt PMOD_EXPORT union anything *mapping_get_item_ptr(struct mapping *m,
466b662008-01-05Martin Nilsson  const struct svalue *key,
5267b71995-08-09Fredrik Hübinette (Hubbe)  TYPE_T t);
b14b412005-09-11Marek Habersack  /** Deletes the specified entry from the indicated mapping and frees * the memory associated with it unless the @b to parameter is not * NULL, in which case the deleted item's value is assigned to the * @b to @ref svalue. * * @param m mapping containing the entry to delete * @param key the key which indexes the entry to delete * @param to if not NULL will contain the deleted item's value */
6f0d752000-12-16Marcus Comstedt PMOD_EXPORT void map_delete_no_free(struct mapping *m,
466b662008-01-05Martin Nilsson  const struct svalue *key,
ea0be61999-11-11Fredrik Hübinette (Hubbe)  struct svalue *to);
6f0d752000-12-16Marcus Comstedt PMOD_EXPORT void check_mapping_for_destruct(struct mapping *m);
b14b412005-09-11Marek Habersack  /** Look up the specified key in the indicated mapping and return * the corresponding @ref svalue representing the value of the * entry. * * @param m mapping to check for the key presence * @param key key to look up in the mapping * @return an svalue representing the looked up entry's value or * NULL if the key was not found in the mapping. * @see low_mapping_string_lookup * @see simple_mapping_string_lookup */
6f0d752000-12-16Marcus Comstedt PMOD_EXPORT struct svalue *low_mapping_lookup(struct mapping *m,
9cc28d2004-05-28Henrik Grubbström (Grubba)  const struct svalue *key);
b14b412005-09-11Marek Habersack  /** Look up an entry in the indicated mapping indexed by the passed @b Pike * string. It is a shortcut for the common case when the mapping is indexed * on Pike strings instead of using an @ref svalue and the @ref low_mapping_lookup * function. * * @param m mapping to check for the key presence * @param p a Pike string to use as the lookup key * @return an svalue representing the looked up entry's value or NULL of no such * item was found. * @see low_mapping_lookup * @see simple_mapping_string_lookup */
6f0d752000-12-16Marcus Comstedt PMOD_EXPORT struct svalue *low_mapping_string_lookup(struct mapping *m,
466b662008-01-05Martin Nilsson  struct pike_string *p);
b14b412005-09-11Marek Habersack  /** A shortcut function for inserting an entry into a mapping for cases * where the key is a Pike string. * * @param m mapping to insert the new entry into * @param p a Pike string to be used as the new entry key * @param val an svalue representing the new entry's value * @see mapping_insert * @see low_mapping_insert * @see mapping_string_insert_string */
6f0d752000-12-16Marcus Comstedt PMOD_EXPORT void mapping_string_insert(struct mapping *m,
466b662008-01-05Martin Nilsson  struct pike_string *p, const struct svalue *val);
b14b412005-09-11Marek Habersack  /** A shortcut function for inserting an entry into a mapping for cases * where both the key and the value are Pike strings. * * @param m mapping to insert the new entry into * @param p a Pike string to be used as the new entry key * @param val a Pike string to be used as the new entry's value * @see mapping_string_insert * @see low_mapping_insert * @see mapping_string_insert */
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);
b14b412005-09-11Marek Habersack  /** A shortcut function to look up an entry in a mapping using a C string * as the key. The function converts the C string into a Pike string and * then calls @ref low_mapping_string_lookup to do the work. If your code * looks up an item in mappings very often and you are using a constant C * string for that, it will be more beneficial to allocate a Pike string * yourself in the initialization section of your module and then use it * with @ref low_mapping_string_lookup instead of calling simple_mapping_string_lookup. * The advantage is not very big since this function allocates the Pike * string only once, the first time it is used (or when it gets garbage- * collected), but it is a small optimization nevertheless. * * @param m mapping to look up the entry in * @param p string to be used as the lookup key * @return an svalue representing the looked up entry's value or NULL if no * such entry was found * @see low_mapping_string_lookup * @see simple_mapping_string_lookup * @see low_mapping_lookup */
6f0d752000-12-16Marcus Comstedt PMOD_EXPORT struct svalue *simple_mapping_string_lookup(struct mapping *m,
adb3b12004-03-22Martin Stjernholm  const char *p);
b14b412005-09-11Marek Habersack  /** First look up @b key1 in the passed mapping and check whether the returned * value, if any, is a mapping itself. If it is a mapping, look it up using * @b key2 and return the retrieved entry's value, if any. If key1 lookup in * the @b m mapping doesn't return a mapping and @b create is not 0 allocate * a new mapping, insert it in @b m and use for lookup with @b key2. If @b key2 * lookup doesn't yield a value in neither of the above cases and @b create is not * 0, allocate a new svalue representing an undefined number, insert it into the * mapping retrieved (or allocated) during the @b key1 lookup and then perform a * @b key2 lookup on the mapping retrieved (or allocated) during the @b key1 and * return the result. * * @param m primary mapping to perform a @b key1 lookup on * @param key1 key used to lookup an entry in the primary mapping @b m * @param key2 key used to lookup an entry in the secondary mapping retrieved * (or allocated) as the result of the @b key1 lookup * @param create 0 to not insert an entry into neither mapping if it cannot be * found in the mapping, not 0 to insert such entry. * @return the result of the @b key2 lookup or 0 if either @b key1 or @b key2 * returned no value and @b create was 0 * * @see low_mapping_lookup */
6f0d752000-12-16Marcus Comstedt PMOD_EXPORT struct svalue *mapping_mapping_lookup(struct mapping *m,
466b662008-01-05Martin Nilsson  const struct svalue *key1, const struct svalue *key2,
8a5d441999-10-19Fredrik Hübinette (Hubbe)  int create);
b14b412005-09-11Marek Habersack  /** A shortcut for @ref mapping_mapping_lookup when both keys are Pike strings. * For the (complicated) description of what the function does, see the documentation * of the @ref mapping_mapping_lookup. * * @param m primary mapping to perform a @b key1 lookup on * @param key1 Pike string used to lookup an entry in the primary mapping @b m * @param key2 Pike string used to lookup an entry in the secondary mapping retrieved * (or allocated) as the result of the @b key1 lookup * @param create 0 to not insert an entry into neither mapping if it cannot be * found in the mapping, not 0 to insert such entry. * @return the result of the @b key2 lookup or 0 if either @b key1 or @b key2 * returned no value and @b create was 0 * * @see low_mapping_lookup * @see mapping_mapping_lookup */
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,
466b662008-01-05Martin Nilsson  const 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,
9cc28d2004-05-28Henrik Grubbström (Grubba)  struct mapping *p);
6f0d752000-12-16Marcus Comstedt PMOD_EXPORT void mapping_search_no_free(struct svalue *to,
5267b71995-08-09Fredrik Hübinette (Hubbe)  struct mapping *m,
466b662008-01-05Martin Nilsson  const struct svalue *look_for, const struct svalue *key ); #ifdef PIKE_DEBUG void check_mapping(const struct mapping *m);
be478c1997-08-30Henrik Grubbström (Grubba) void check_all_mappings(void);
466b662008-01-05Martin Nilsson #endif
1eb9852008-05-11Martin Stjernholm PMOD_EXPORT void visit_mapping (struct mapping *m, int action);
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))
5e83442008-05-11Martin Stjernholm #define visit_mapping_ref(M, REF_TYPE) \ visit_ref (pass_mapping (M), (REF_TYPE), \ (visit_thing_fn *) &visit_mapping, NULL)
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 */