global_setup.c

/*
Copyright (C) 2001-2010, Parrot Foundation.

=head1 NAME

src/global_setup.c - Global setup

=head1 DESCRIPTION

Performs all the global setting up of things. This includes the very
few global variables that Parrot totes around.

I<What are these global variables?>

=head2 Functions

=over 4

=cut

*/

#define INSIDE_GLOBAL_SETUP
#include "parrot/parrot.h"
#include "parrot/oplib/core_ops.h"
#include "global_setup.str"
#include "parrot/api.h"

/* These functions are defined in the auto-generated file core_pmcs.c */
/* XXX Get it into some public place */
extern void Parrot_gbl_initialize_core_pmcs(PARROT_INTERP, int pass);
void Parrot_gbl_register_core_pmcs(PARROT_INTERP, PMC* registry);

static const unsigned char* parrot_config_stored = NULL;
static unsigned int parrot_config_size_stored = 0;
static PMC * parrot_config_hash_global = NULL;

/* HEADERIZER HFILE: include/parrot/global_setup.h */

/* HEADERIZER BEGIN: static */
/* Don't modify between HEADERIZER BEGIN / HEADERIZER END.  Your changes will be lost. */

static void Parrot_gbl_set_config_hash_interpreter(PARROT_INTERP)
        __attribute__nonnull__(1);

static void Parrot_gbl_setup_2(PARROT_INTERP)
        __attribute__nonnull__(1);

#define ASSERT_ARGS_Parrot_gbl_set_config_hash_interpreter \
     __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
       PARROT_ASSERT_ARG(interp))
#define ASSERT_ARGS_Parrot_gbl_setup_2 __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
       PARROT_ASSERT_ARG(interp))
/* Don't modify between HEADERIZER BEGIN / HEADERIZER END.  Your changes will be lost. */
/* HEADERIZER END: static */


/*

=item C<void Parrot_gbl_set_config_hash_internal(const unsigned char*
parrot_config, unsigned int parrot_config_size)>

Called by Parrot_set_config_hash with the serialized hash which
will be used in subsequently created Interpreters.

=cut

*/

void
Parrot_gbl_set_config_hash_internal(ARGIN(const unsigned char* parrot_config),
                                 unsigned int parrot_config_size)
{
    ASSERT_ARGS(Parrot_gbl_set_config_hash_internal)
    if (parrot_config_stored != NULL) {
        parrot_config_stored      = parrot_config;
        parrot_config_size_stored = parrot_config_size;
    }
}

/*

=item C<void Parrot_set_config_hash_pmc(PARROT_INTERP, PMC *config)>

Called by embed API with the pmc hash which will be used in subsequently created
Interpreters.

=cut

*/

void
Parrot_set_config_hash_pmc(PARROT_INTERP, ARGIN(PMC *config))
{
    ASSERT_ARGS(Parrot_set_config_hash_pmc)
    parrot_config_hash_global = config;
    if (!PMC_IS_NULL(config))
        Parrot_gbl_set_config_hash_interpreter(interp);
}

/*

=item C<static void Parrot_gbl_set_config_hash_interpreter(PARROT_INTERP)>

Used internally to associate the config hash with an Interpreter
using the last registered config data.

=cut

*/

static void
Parrot_gbl_set_config_hash_interpreter(PARROT_INTERP)
{
    ASSERT_ARGS(Parrot_gbl_set_config_hash_interpreter)
    PMC * const iglobals = interp->iglobals;

    PMC *config_hash = parrot_config_hash_global;
    if (config_hash == NULL)
        config_hash = Parrot_pmc_new(interp, enum_class_Hash);
    else {
        /* On initialization, we probably set up an empty hash for our first
           interpreter. We should use this branch here to insert some sane
           defaults so that things do not go crazy if the user forgets to set
           the config hash later */
    }

    VTABLE_set_pmc_keyed_int(interp, iglobals,
                             (INTVAL) IGLOBALS_CONFIG_HASH, config_hash);
    if (!PMC_IS_NULL(config_hash) && VTABLE_elements(interp, config_hash))
        Parrot_lib_update_paths_from_config_hash(interp);
}

/*

=item C<void Parrot_gbl_init_world_once(PARROT_INTERP)>

Call init_world() if it hasn't been called before.

C<interp> should be the root interpreter created in C<Parrot_new(NULL)>.

=cut

*/

void
Parrot_gbl_init_world_once(PARROT_INTERP)
{
    ASSERT_ARGS(Parrot_gbl_init_world_once)
    if (!interp->world_inited) {
        /* init_world() sets up some vtable stuff.
         * It must only be called once.
         */

        interp->world_inited = 1;
        init_world(interp);
    }
}


/*

=item C<void init_world(PARROT_INTERP)>

This is the actual initialization code called by C<Parrot_gbl_init_world_once()>.

It sets up the Parrot system, running any platform-specific init code if
necessary, then initializing the string subsystem, and setting up the
base vtables and core PMCs.

C<interp> should be the root interpreter created in C<Parrot_new(NULL)>.

=cut

*/

void
init_world(PARROT_INTERP)
{
    ASSERT_ARGS(init_world)
    PMC *iglobals, *self, *pmc;

    /* Check assumptions about our config */
    PARROT_STATIC_ASSERT(sizeof (INTVAL) == sizeof (opcode_t));

    Parrot_platform_init_code();

    /* Call base vtable class constructor methods */
    Parrot_gbl_setup_2(interp);
    Parrot_gbl_initialize_core_pmcs(interp, 1);

    iglobals = interp->iglobals;
    VTABLE_set_pmc_keyed_int(interp, iglobals,
            (INTVAL)IGLOBALS_CLASSNAME_HASH, interp->class_hash);

    self           = Parrot_pmc_new_noinit(interp, enum_class_ParrotInterpreter);
    VTABLE_set_pointer(interp, self, interp);
    /* PMC_data(self) = interp; */

    VTABLE_set_pmc_keyed_int(interp, iglobals,
            (INTVAL)IGLOBALS_INTERPRETER, self);

    /* lib search paths */
    parrot_init_library_paths(interp);

    Parrot_gbl_set_config_hash_interpreter(interp);

    /* load_bytecode and dynlib loaded hash */
    pmc = Parrot_pmc_new(interp, enum_class_Hash);
    VTABLE_set_pmc_keyed_int(interp, iglobals, IGLOBALS_PBC_LIBS, pmc);

    pmc = Parrot_pmc_new(interp, enum_class_Hash);
    VTABLE_set_pmc_keyed_int(interp, iglobals, IGLOBALS_LOADED_PBCS, pmc);

    pmc = Parrot_pmc_new(interp, enum_class_Hash);
    VTABLE_set_pmc_keyed_int(interp, iglobals, IGLOBALS_DYN_LIBS, pmc);

    pmc = Parrot_pmc_new(interp, enum_class_Hash);
    VTABLE_set_pointer(interp, pmc, Parrot_hash_create(interp, enum_type_PMC, Hash_key_type_PMC));
    VTABLE_set_pmc_keyed_int(interp, iglobals, IGLOBALS_NCI_FUNCS, pmc);
#ifdef PARROT_HAS_CORE_NCI_THUNKS
    Parrot_nci_load_core_thunks(interp);
#endif
#ifdef PARROT_HAS_EXTRA_NCI_THUNKS
    Parrot_nci_load_extra_thunks(interp);
#endif
#ifdef PARROT_HAS_LIBFFI
    Parrot_nci_libffi_register(interp);
#endif
}

/*

=item C<static void Parrot_gbl_setup_2(PARROT_INTERP)>

called from inmidst of PMC bootstrapping between pass 0 and 1

=cut

*/

static void
Parrot_gbl_setup_2(PARROT_INTERP)
{
    ASSERT_ARGS(Parrot_gbl_setup_2)
    PMC *classname_hash;

    create_initial_context(interp);

    /* initialize the ops hash */
    if (interp->parent_interpreter) {
        interp->op_hash = interp->parent_interpreter->op_hash;
    }
    else {
        op_lib_t * const core_ops = PARROT_CORE_OPLIB_INIT(interp, 1);
        interp->op_hash     = Parrot_hash_create_sized(interp, enum_type_ptr,
                                    Hash_key_type_cstring, core_ops->op_count);
        parrot_hash_oplib(interp, core_ops);
    }

    /* create the namespace root stash */
    interp->root_namespace = Parrot_pmc_new(interp, enum_class_NameSpace);
    Parrot_hll_init_HLL(interp);

    Parrot_pcc_set_namespace(interp, CURRENT_CONTEXT(interp),
        VTABLE_get_pmc_keyed_int(interp, interp->HLL_namespace, 0));

    /* We need a class hash */
    interp->class_hash = classname_hash = Parrot_pmc_new(interp, enum_class_NameSpace);
    Parrot_gbl_register_core_pmcs(interp, classname_hash);

    /* init the interpreter globals array */
    interp->iglobals = Parrot_pmc_new_init_int(interp,
            enum_class_FixedPMCArray, (INTVAL)IGLOBALS_SIZE);
}

/*

=back

=head1 SEE ALSO

F<include/parrot/global_setup.h>

=cut

*/

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