dlb_sp.h

Go to the documentation of this file.

/*********************************************************************************/
/*  Copyright 2009-2021 Barcelona Supercomputing Center                          */
/*                                                                               */
/*  This file is part of the DLB library.                                        */
/*                                                                               */
/*  DLB 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.                                          */
/*                                                                               */
/*  DLB 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 DLB.  If not, see <https://www.gnu.org/licenses/>.                */
/*********************************************************************************/
 
#ifndef DLB_SP_H
#define DLB_SP_H
 
#include "dlb_types.h"
#include "dlb_errors.h"
 
#ifdef __cplusplus
extern "C"
{
#endif
 
/*********************************************************************************/
/*    Status                                                                     */
/*********************************************************************************/
 
dlb_handler_t DLB_Init_sp(int ncpus, const_dlb_cpu_set_t mask, const char *dlb_args);
 
int DLB_Finalize_sp(dlb_handler_t handler);
 
int DLB_Enable_sp(dlb_handler_t handler);
 
int DLB_Disable_sp(dlb_handler_t handler);
 
int DLB_SetMaxParallelism_sp(dlb_handler_t handler, int max);
 
int DLB_UnsetMaxParallelism_sp(dlb_handler_t handler);
 
 
/*********************************************************************************/
/*    Callbacks                                                                  */
/*********************************************************************************/
 
int DLB_CallbackSet_sp(dlb_handler_t handler, dlb_callbacks_t which,
        dlb_callback_t callback, void *arg);
 
int DLB_CallbackGet_sp(dlb_handler_t handler, dlb_callbacks_t which,
        dlb_callback_t *callback, void **arg);
 
 
/*********************************************************************************/
/*    Lend                                                                       */
/*********************************************************************************/
 
int DLB_Lend_sp(dlb_handler_t handler);
 
int DLB_LendCpu_sp(dlb_handler_t handler, int cpuid);
 
int DLB_LendCpus_sp(dlb_handler_t handler, int ncpus);
 
int DLB_LendCpuMask_sp(dlb_handler_t handler, const_dlb_cpu_set_t mask);
 
 
/*********************************************************************************/
/*    Reclaim                                                                    */
/*********************************************************************************/
 
int DLB_Reclaim_sp(dlb_handler_t handler);
 
int DLB_ReclaimCpu_sp(dlb_handler_t handler, int cpuid);
 
int DLB_ReclaimCpus_sp(dlb_handler_t handler, int ncpus);
 
int DLB_ReclaimCpuMask_sp(dlb_handler_t handler, const_dlb_cpu_set_t mask);
 
 
/*********************************************************************************/
/*    Acquire                                                                    */
/*********************************************************************************/
 
int DLB_AcquireCpu_sp(dlb_handler_t handler, int cpuid);
 
int DLB_AcquireCpus_sp(dlb_handler_t handler, int ncpus);
 
int DLB_AcquireCpuMask_sp(dlb_handler_t handler, const_dlb_cpu_set_t mask);
 
int DLB_AcquireCpusInMask_sp(dlb_handler_t handler, int ncpus, const_dlb_cpu_set_t mask);
 
 
/*********************************************************************************/
/*    Borrow                                                                     */
/*********************************************************************************/
 
int DLB_Borrow_sp(dlb_handler_t handler);
 
int DLB_BorrowCpu_sp(dlb_handler_t handler, int cpuid);
 
int DLB_BorrowCpus_sp(dlb_handler_t handler, int ncpus);
 
int DLB_BorrowCpuMask_sp(dlb_handler_t handler, const_dlb_cpu_set_t mask);
 
int DLB_BorrowCpusInMask_sp(dlb_handler_t handler, int ncpus, const_dlb_cpu_set_t mask);
 
 
/*********************************************************************************/
/*    Return                                                                     */
/*********************************************************************************/
 
int DLB_Return_sp(dlb_handler_t handler);
 
int DLB_ReturnCpu_sp(dlb_handler_t handler, int cpuid);
 
int DLB_ReturnCpuMask_sp(dlb_handler_t handler, const_dlb_cpu_set_t mask);
 
 
/*********************************************************************************/
/*    DROM Responsive                                                            */
/*********************************************************************************/
 
int DLB_PollDROM_sp(dlb_handler_t handler, int *ncpus, dlb_cpu_set_t mask);
 
int DLB_PollDROM_Update_sp(dlb_handler_t handler);
 
 
/*********************************************************************************/
/*    Misc                                                                       */
/*********************************************************************************/
 
int DLB_CheckCpuAvailability_sp(dlb_handler_t handler, int cpuid);
 
int DLB_SetVariable_sp(dlb_handler_t handler, const char *variable, const char *value);
 
int DLB_GetVariable_sp(dlb_handler_t handler, const char *variable, char *value);
 
int DLB_PrintVariables_sp(dlb_handler_t handler, int print_extended);
 
 
#ifdef __cplusplus
}
#endif
 
#endif /* DLB_SP_H */