mcbsp-affinity.h

Go to the documentation of this file.

/*
 * Copyright (c) 2013
 *
 * File written by A. N. Yzelman, 2013.
 * 
 * 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_MCBSP_AFFINITY
#define _H_MCBSP_AFFINITY

#include <stdlib.h>

enum mcbsp_affinity_mode {

        SCATTER = 0,

        COMPACT,

        MANUAL
};

enum mcbsp_thread_numbering {

        CONSECUTIVE = 0,

        WRAPPED
};

void mcbsp_set_maximum_threads( const size_t max );

void mcbsp_set_affinity_mode( const enum mcbsp_affinity_mode mode );

void mcbsp_set_available_cores( const size_t num_cores );

void mcbsp_set_threads_per_core( const size_t threads_per_core );

void mcbsp_set_unused_threads_per_core( const size_t unused_threads_per_core );

void mcbsp_set_thread_numbering( const enum mcbsp_thread_numbering numbering );

void mcbsp_set_pinning( const size_t * const pinning, const size_t length );

void mcbsp_set_reserved_cores( const size_t * const reserved, const size_t length );

size_t mcbsp_get_maximum_threads( void );

enum mcbsp_affinity_mode mcbsp_get_affinity_mode( void );

size_t mcbsp_get_available_cores( void );

size_t mcbsp_get_threads_per_core( void );

size_t mcbsp_get_unused_threads_per_core( void );

enum mcbsp_thread_numbering mcbsp_get_thread_numbering( void );

size_t * mcbsp_get_pinning( void );

size_t mcbsp_get_reserved_cores_number( void );

size_t * mcbsp_get_reserved_cores( void );

//Default values

extern enum mcbsp_affinity_mode MCBSP_DEFAULT_AFFINITY;

extern size_t MCBSP_DEFAULT_THREADS_PER_CORE;

extern enum mcbsp_thread_numbering MCBSP_DEFAULT_THREAD_NUMBERING;

#endif