src/pmc/addrregistry.pmc

   1 /*
   2 Copyright (C) 2005-2009, Parrot Foundation.
   3 $Id$
   4
   5 =head1 NAME
   6
   7 src/pmc/addrregistry.pmc - A GC Registry PMC
   8
   9 =head1 DESCRIPTION
  10
  11 The AddrRegistry class provides the equivalence of reference counts
  12 mainly for extenders and embedders of Parrot. The hash keys are the
  13 addresses of the key PMC, values are reference counts, i.e. the
  14 difference of (set_pmc_keyed - delete_pmc_keyed). If the reference
  15 goes to zero, the entry is deleted physically.
  16
  17 Please note that you have to anchor an instance of AddrRegistry yourself with
  18 C<Parrot_register_pmc> if it isn't visible to Parrot.
  19
  20 =head2 Functions
  21
  22 =over 4
  23
  24 =cut
  25
  26 */
  27
  28 #include "parrot/hash.h"
  29 #include "pmc/pmc_hash.h"
  30
  31 /* HEADERIZER HFILE: none */
  32 /* HEADERIZER BEGIN: static */
  33 /* HEADERIZER END: static */
  34
  35 pmclass AddrRegistry extends Hash provides hash auto_attrs {
  36 /*
  37
  38 =item C<void init()>
  39
  40 Initializes the instance.
  41
  42 =cut
  43
  44 */
  45
  46     VTABLE void init() {
  47         Hash  *registry = parrot_create_hash(INTERP,
  48                 enum_type_int,
  49                 Hash_key_type_PMC_ptr);
  50
  51         SET_ATTR_hash(INTERP, SELF, registry);
  52         PObj_custom_mark_destroy_SETALL(SELF);
  53
  54     }
  55
  56 /*
  57
  58 =item C<INTVAL get_integer_keyed(PMC *key)>
  59
  60 Returns the reference count for C<key> or 0 if the key doesn't exist.
  61
  62 =item C<INTVAL elements()>
  63
  64 Returns the number of elements in the hash.
  65
  66 =item C<INTVAL get_bool()>
  67
  68 Returns true if the hash size is not zero.
  69
  70 =cut
  71
  72 */
  73
  74     VTABLE INTVAL get_integer_keyed(PMC *key) {
  75         Hash       *hash;
  76         const void *value;
  77
  78         GET_ATTR_hash(INTERP, SELF, hash);
  79         value = parrot_hash_get(INTERP, hash, key);
  80
  81         if (value)
  82             return (INTVAL)value;
  83
  84         return 0;
  85     }
  86
  87     VTABLE INTVAL elements() {
  88         const Hash *hash;
  89
  90         GET_ATTR_hash(INTERP, SELF, hash);
  91
  92         return parrot_hash_size(INTERP, hash);
  93     }
  94
  95     VTABLE INTVAL get_bool() {
  96         const Hash *hash;
  97
  98         GET_ATTR_hash(INTERP, SELF, hash);
  99
 100         return parrot_hash_size(INTERP, hash) != 0;
 101     }
 102 /*
 103
 104 =item C<void set_pmc_keyed(PMC *key, PMC *value)>
 105
 106 Increment the reference count of C<key>. If the entry doesn't exist
 107 create it. The C<value> is always ignored.
 108
 109 =item C<void set_integer_keyed(PMC *key, INTVAL value)>
 110
 111 Set the given value.
 112
 113 =item C<void delete_keyed(PMC *key)>
 114
 115 Decrement the reference count of C<key>. If the reference count
 116 reaches 0, delete the entry.
 117
 118
 119 =cut
 120
 121 */
 122
 123     VTABLE void set_pmc_keyed(PMC *key, PMC *value) {
 124         const void *oldval;
 125         long        newval = 1;
 126         Hash       *hash;
 127         UNUSED(value);
 128
 129         GET_ATTR_hash(INTERP, SELF, hash);
 130
 131         oldval = parrot_hash_get(INTERP, hash, key);
 132
 133         if (oldval)
 134             newval += (long)oldval;
 135
 136         parrot_hash_put(INTERP, hash, key, (void *)newval);
 137     }
 138
 139     VTABLE void set_integer_keyed(PMC *key, INTVAL value) {
 140         Hash *hash;
 141         GET_ATTR_hash(INTERP, SELF, hash);
 142         parrot_hash_put(INTERP, hash, key, (void *)value);
 143     }
 144
 145     VTABLE void delete_keyed(PMC *key) {
 146         Hash       *hash;
 147         void       *value;
 148
 149         GET_ATTR_hash(INTERP, SELF, hash);
 150         value = parrot_hash_get(INTERP, hash, key);
 151
 152         /* these casts look bad, but they avoid type punning warnings with -O */
 153         if (value) {
 154             long val = (long)value;
 155             if (val == 1L)
 156                 parrot_hash_delete(INTERP, hash, key);
 157             else {
 158                 value = (void *)(--val);
 159                 parrot_hash_put(INTERP, hash, key, value);
 160             }
 161         }
 162     }
 163
 164 }
 165
 166 /*
 167
 168 =back
 169
 170 =head1 SEE ALSO
 171
 172 F<src/pmc.c:gc_register_pmc()>
 173
 174 =cut
 175
 176 */
 177
 178 /*
 179  * Local variables:
 180  *   c-file-style: "parrot"
 181  * End:
 182  * vim: expandtab shiftwidth=4:
 183  */