mcutil.h

Go to the documentation of this file.

/*
 * Copyright (c) 2012 by Albert-Jan N. Yzelman
 *
 * This file is part of MulticoreBSP in C --
 *        a port of the original Java-based MulticoreBSP.
 *
 * MulticoreBSP for C is distributed as part of the original
 * MulticoreBSP and is free software: you can redistribute
 * it and/or modify it under the terms of the GNU Lesser 
 * General Public License as published by the Free Software 
 * Foundation, either version 3 of the License, or 
 * (at your option) any later version.
 * MulticoreBSP is distributed in the hope that it will be
 * useful, but WITHOUT ANY WARRANTY; without even the 
 * implied warranty of MERCHANTABILITY or FITNESS FOR A 
 * PARTICULAR PURPOSE. See the GNU Lesser General Public 
 * License for more details.
 *
 * You should have received a copy of the GNU Lesser General 
 * Public License along with MulticoreBSP. If not, see
 * <http://www.gnu.org/licenses/>.
 */

#ifndef _H_MCUTIL
#define _H_MCUTIL

#include <stdio.h>
#include <stdlib.h>
#include <assert.h>
#include <limits.h>
#include <string.h>
#include <unistd.h>
#include <stdlib.h>
#include <pthread.h>
#include <stdbool.h>

#ifdef _WIN32
 #include <windows.h>
#endif

#include "mcbsp.h"
#include "mcbsp-affinity.h"

struct mcbsp_util_machine_info {

        bool Tset;

        bool Aset;

        bool Cset;

        bool TpCset;

        bool TNset;

        bool Pset;

        bool Rset;

        size_t threads;

        enum mcbsp_affinity_mode affinity;

        size_t cores;

        size_t threads_per_core;
        
        enum mcbsp_thread_numbering thread_numbering;

        size_t *manual_affinity;

        size_t num_reserved_cores;

        size_t *reserved_cores;

};

struct mcbsp_util_address_map {

        unsigned long int cap;

        unsigned long int size;

        void * * keys;

        unsigned long int * values;

};

struct mcbsp_util_address_table_entry {

        void * address;

        size_t size;

};

struct mcbsp_util_stack {

        size_t cap;

        size_t top;

        size_t size;

        void * array;

};

struct mcbsp_util_address_table {
        
        pthread_mutex_t mutex;

        unsigned long int cap;

        unsigned long int P;

#ifdef MCBSP_ALLOW_MULTIPLE_REGS
        struct mcbsp_util_stack ** table;
#else
        struct mcbsp_util_address_table_entry ** table;
#endif
};

void mcbsp_util_stack_initialise( struct mcbsp_util_stack * const stack, const size_t elementSize );

void mcbsp_util_stack_grow( struct mcbsp_util_stack * const stack );

bool mcbsp_util_stack_empty( const struct mcbsp_util_stack * const stack );

void * mcbsp_util_stack_pop( struct mcbsp_util_stack * const stack );

void * mcbsp_util_stack_peek( const struct mcbsp_util_stack * const stack );

void mcbsp_util_stack_push( struct mcbsp_util_stack * const stack, const void * const item );

void mcbsp_util_stack_destroy( struct mcbsp_util_stack * const stack );

void mcbsp_util_varstack_grow( struct mcbsp_util_stack * const stack );

void * mcbsp_util_varstack_pop( struct mcbsp_util_stack * const stack, const size_t size );

void * mcbsp_util_varstack_regpop( struct mcbsp_util_stack * const stack );

void * mcbsp_util_varstack_peek( const struct mcbsp_util_stack * const stack, const size_t size );

void mcbsp_util_varstack_push( struct mcbsp_util_stack * const stack, const void * const item, const size_t size );

void mcbsp_util_varstack_regpush( struct mcbsp_util_stack * const stack, const void * const item );

void mcbsp_util_address_table_initialise( struct mcbsp_util_address_table * const table, const unsigned long int P );

void mcbsp_util_address_table_grow( struct mcbsp_util_address_table * const table );

void mcbsp_util_address_setsize( struct mcbsp_util_address_table * const table, const unsigned long int target_size );

void mcbsp_util_address_table_destroy( struct mcbsp_util_address_table * const table );

void mcbsp_util_address_table_set( struct mcbsp_util_address_table * const table, const unsigned long int key, const unsigned long int version, void * const value, const size_t size );

const struct mcbsp_util_address_table_entry * mcbsp_util_address_table_get( const struct mcbsp_util_address_table * const table, const unsigned long int key, const unsigned long int version );

bool mcbsp_util_address_table_delete( struct mcbsp_util_address_table * const table, const unsigned long int key, const unsigned long int version );

void mcbsp_util_address_map_initialise( struct mcbsp_util_address_map * const address_map );

void mcbsp_util_address_map_grow( struct mcbsp_util_address_map * const address_map );

void mcbsp_util_address_map_destroy( struct mcbsp_util_address_map * const address_map );

unsigned long int mcbsp_util_address_map_get( const struct mcbsp_util_address_map * const address_map, const void * const key );

void mcbsp_util_address_map_insert( struct mcbsp_util_address_map * const address_map, void * const key, unsigned long int value );

void mcbsp_util_address_map_remove( struct mcbsp_util_address_map * const address_map, void * const key );

size_t mcbsp_util_address_map_binsearch( const struct mcbsp_util_address_map * const address_map, const void * const key, size_t lo, size_t hi );

size_t mcbsp_util_detect_hardware_threads();

struct mcbsp_util_machine_info *mcbsp_util_createMachineInfo();

void mcbsp_util_destroyMachineInfo( void * machine_info );

int mcbsp_util_int_compare( const void * a, const void * b );

size_t mcbsp_util_log2( size_t x );

size_t mcbsp_util_sort_unique_integers( size_t * const array, const size_t length, const size_t lower_bound, const size_t upper_bound );

bool mcbsp_util_contains( const size_t * const array, const size_t value, const size_t lo, const size_t hi );

int* mcbsp_util_pinning( const MCBSP_PROCESSOR_INDEX_DATATYPE P, struct mcbsp_util_machine_info * const machine );

void mcbsp_util_fatal();

#endif