addrregistry.pmc

/*
Copyright (C) 2005-2012, Parrot Foundation.

=head1 NAME

src/pmc/addrregistry.pmc - A GC Registry PMC

=head1 DESCRIPTION

The AddrRegistry class provides the equivalence of reference counts
mainly for extenders and embedders of Parrot. The hash keys are the
addresses of the key PMC, values are reference counts, i.e. the
difference of (set_pmc_keyed - delete_pmc_keyed). If the reference
goes to zero, the entry is deleted physically.

Please note that you have to anchor an instance of AddrRegistry yourself with
C<Parrot_register_pmc> if it isn't visible to Parrot.

=head2 Functions

=over 4

=cut

*/

#include "parrot/hash.h"
#include "pmc/pmc_hash.h"

/* HEADERIZER HFILE: none */
/* HEADERIZER BEGIN: static */
/* HEADERIZER END: static */

pmclass AddrRegistry provides hash auto_attrs {
ATTR Hash *pmc_registry;
ATTR Hash *str_registry;

/*

=item C<void init()>

Initializes the instance.

=cut

*/

    VTABLE void init() {
        Hash * const pmc_registry = Parrot_hash_create(INTERP,
                enum_type_int,
                Hash_key_type_PMC_ptr);

        Hash * const str_registry = Parrot_hash_create(INTERP,
                enum_type_int,
                Hash_key_type_STRING);

        SET_ATTR_pmc_registry(INTERP, SELF, pmc_registry);
        SET_ATTR_str_registry(INTERP, SELF, str_registry);
        PObj_custom_mark_destroy_SETALL(SELF);

    }

/*

=item C<void mark()>

Mark any PMCs and STRINGs in this registry.

=cut

*/


    VTABLE void mark() {
        Hash *str_registry, *pmc_registry;

        GET_ATTR_str_registry(INTERP, SELF, str_registry);
        GET_ATTR_pmc_registry(INTERP, SELF, pmc_registry);

        Parrot_hash_mark(interp, pmc_registry);
        Parrot_hash_mark(interp, str_registry);

    }


/*

=item C<void destroy()>

Destroy this PMC.

=cut

*/

    VTABLE void destroy() {
        Hash *str_registry, *pmc_registry;

        GET_ATTR_str_registry(INTERP, SELF, str_registry);
        GET_ATTR_pmc_registry(INTERP, SELF, pmc_registry);

        Parrot_hash_destroy(interp, pmc_registry);
        Parrot_hash_destroy(interp, str_registry);

        SET_ATTR_str_registry(INTERP, SELF, NULL);
        SET_ATTR_pmc_registry(INTERP, SELF, NULL);

    }



/*

=item C<INTVAL get_integer_keyed(PMC *key)>

Returns the reference count for C<key> or 0 if the key doesn't exist.

=item C<INTVAL elements()>

Returns the number of elements in the hash.

=item C<INTVAL get_bool()>

Returns true if the hash size is not zero.

=cut

*/

    VTABLE INTVAL get_integer_keyed(PMC *key) {
        Hash       *hash;
        const void *value;

        GET_ATTR_pmc_registry(INTERP, SELF, hash);
        value = Parrot_hash_get(INTERP, hash, key);

        if (value)
            return (INTVAL)value;

        return 0;
    }

    VTABLE INTVAL elements() {
        const Hash *pmc_registry, *str_registry;

        GET_ATTR_pmc_registry(INTERP, SELF, pmc_registry);
        GET_ATTR_str_registry(INTERP, SELF, str_registry);

        return Parrot_hash_size(INTERP, pmc_registry) +
               Parrot_hash_size(INTERP, str_registry);
    }

    VTABLE INTVAL get_bool() {
        const Hash *pmc_registry, *str_registry;

        GET_ATTR_pmc_registry(INTERP, SELF, pmc_registry);
        GET_ATTR_str_registry(INTERP, SELF, str_registry);

        return (Parrot_hash_size(INTERP, pmc_registry) +
                Parrot_hash_size(INTERP, str_registry)) != 0;
    }
/*

=item C<void set_pmc_keyed(PMC *key, PMC *value)>

Increment the reference count of C<key>. If the entry doesn't exist
create it. The C<value> is always ignored.

=item C<void set_integer_keyed(PMC *key, INTVAL value)>

Set the given value.

=item C<void delete_keyed(PMC *key)>

=item C<void delete_keyed_str(STRING *key)>

Decrement the reference count of C<key>. If the reference count
reaches 0, delete the entry.


=cut

*/

    VTABLE void set_pmc_keyed(PMC *key, PMC *value) {
        UNUSED(value)
        const void *oldval;
        ptrcast_t   newval = 1;
        Hash       *hash;

        GET_ATTR_pmc_registry(INTERP, SELF, hash);

        oldval = Parrot_hash_get(INTERP, hash, key);

        if (oldval)
            newval += (ptrcast_t)oldval;

        Parrot_hash_put(INTERP, hash, key, (void *)newval);
    }

    VTABLE void set_pmc_keyed_str(STRING *key, PMC *value) {
        UNUSED(value)
        const void *oldval;
        ptrcast_t   newval = 1;
        Hash       *hash;

        GET_ATTR_str_registry(INTERP, SELF, hash);

        oldval = Parrot_hash_get(INTERP, hash, key);

        if (oldval)
            newval += (ptrcast_t)oldval;

        Parrot_hash_put(INTERP, hash, key, (void *)newval);
    }

    VTABLE void set_integer_keyed(PMC *key, INTVAL value) {
        Hash *hash;
        GET_ATTR_pmc_registry(INTERP, SELF, hash);
        Parrot_hash_put(INTERP, hash, key, (void *)value);
    }

    VTABLE void delete_keyed(PMC *key) {
        Hash       *hash;
        void       *value;

        GET_ATTR_pmc_registry(INTERP, SELF, hash);
        value = Parrot_hash_get(INTERP, hash, key);

        /* these casts look bad, but they avoid type punning warnings with -O */
        if (value) {
            ptrcast_t val = (ptrcast_t)value;
            if (val == 1)
                Parrot_hash_delete(INTERP, hash, key);
            else {
                value = (void *)(--val);
                Parrot_hash_put(INTERP, hash, key, value);
            }
        }
    }

    VTABLE void delete_keyed_str(STRING *key) {
        Hash       *hash;
        void       *value;

        GET_ATTR_str_registry(INTERP, SELF, hash);
        value = Parrot_hash_get(INTERP, hash, key);

        /* these casts look bad, but they avoid type punning warnings with -O */
        if (value) {
            ptrcast_t val = (ptrcast_t)value;
            if (val == 1)
                Parrot_hash_delete(INTERP, hash, key);
            else {
                value = (void *)(--val);
                Parrot_hash_put(INTERP, hash, key, value);
            }
        }
    }

}

/*

=back

=head1 SEE ALSO

F<src/pmc.c:gc_register_pmc()>

=cut

*/

/*
 * Local variables:
 *   c-file-style: "parrot"
 * End:
 * vim: expandtab shiftwidth=4 cinoptions='\:2=2' :
 */