Detailed Description
the type definitions for the SCIP parallel interface
Definition in file tpi.h.
#include "scip/def.h"
#include "scip/pub_message.h"
#include "tpi/def_openmp.h"
#include "tpi/type_tpi.h"
#include "tpi/tpi_openmp.h"
#include "tpi/tpi_tnycthrd.h"
#include "tpi/tpi_none.h"
Go to the source code of this file.
Functions | |
SCIP_RETCODE | SCIPtpiInitLock (SCIP_LOCK *lock) |
void | SCIPtpiDestroyLock (SCIP_LOCK *lock) |
SCIP_RETCODE | SCIPtpiAcquireLock (SCIP_LOCK *lock) |
SCIP_RETCODE | SCIPtpiReleaseLock (SCIP_LOCK *lock) |
SCIP_RETCODE | SCIPtpiInitCondition (SCIP_LOCK *lock) |
void | SCIPtpiDestroyCondition (SCIP_LOCK *lock) |
SCIP_RETCODE | SCIPtpiSignalCondition (SCIP_CONDITION *condition) |
SCIP_RETCODE | SCIPtpiBroadcastCondition (SCIP_CONDITION *condition) |
SCIP_RETCODE | SCIPtpiWaitCondition (SCIP_CONDITION *condition, SCIP_LOCK *lock) |
int | SCIPtpiGetNumThreads (void) |
int | SCIPtpiGetThreadNum (void) |
SCIP_RETCODE | SCIPtpiCreateJob (SCIP_JOB **job, int jobid, SCIP_RETCODE(*jobfunc)(void *args), void *jobarg) |
int | SCIPtpiGetNewJobID (void) |
SCIP_RETCODE | SCIPtpiSumbitJob (SCIP_JOB *job, SCIP_SUBMITSTATUS *status) |
SCIP_RETCODE | SCIPtpiCollectJobs (int jobid) |
SCIP_RETCODE | SCIPtpiInit (int nthreads, int queuesize, SCIP_Bool blockwhenfull) |
SCIP_RETCODE | SCIPtpiExit (void) |
Function Documentation
◆ SCIPtpiInitLock()
SCIP_RETCODE SCIPtpiInitLock | ( | SCIP_LOCK * | lock | ) |
initializes the given lock
- Parameters
-
lock the lock
Referenced by createThreadPool(), SCIPsyncstoreCreate(), and SCIPsyncstoreInit().
◆ SCIPtpiDestroyLock()
void SCIPtpiDestroyLock | ( | SCIP_LOCK * | lock | ) |
destroys the given lock
- Parameters
-
lock the lock
Referenced by freeThreadPool(), SCIPsyncstoreExit(), and SCIPsyncstoreRelease().
◆ SCIPtpiAcquireLock()
SCIP_RETCODE SCIPtpiAcquireLock | ( | SCIP_LOCK * | lock | ) |
acquires the given lock
- Parameters
-
lock the lock
Referenced by executeJob(), freeThreadPool(), jobQueueAddJob(), jobQueueProcessJob(), SCIPsyncstoreCapture(), SCIPsyncstoreEnsureAllSynced(), SCIPsyncstoreRelease(), SCIPsyncstoreSetSolveIsStopped(), SCIPsyncstoreSolveIsStopped(), SCIPsyncstoreStartSync(), SCIPtpiBroadcastCondition(), SCIPtpiCollectJobs(), SCIPtpiSignalCondition(), and SCIPtpiWaitCondition().
◆ SCIPtpiReleaseLock()
SCIP_RETCODE SCIPtpiReleaseLock | ( | SCIP_LOCK * | lock | ) |
releases the given lock
- Parameters
-
lock the lock
Referenced by freeThreadPool(), SCIPsyncstoreCapture(), SCIPsyncstoreEnsureAllSynced(), SCIPsyncstoreFinishSync(), SCIPsyncstoreRelease(), SCIPsyncstoreSetSolveIsStopped(), SCIPsyncstoreSolveIsStopped(), SCIPtpiBroadcastCondition(), SCIPtpiSignalCondition(), and SCIPtpiWaitCondition().
◆ SCIPtpiInitCondition()
SCIP_RETCODE SCIPtpiInitCondition | ( | SCIP_LOCK * | lock | ) |
initializes the given condition variable
- Parameters
-
lock the lock
Referenced by createThreadPool(), and SCIPsyncstoreInit().
◆ SCIPtpiDestroyCondition()
void SCIPtpiDestroyCondition | ( | SCIP_LOCK * | lock | ) |
destroys the given condition variable
- Parameters
-
lock the lock
Referenced by freeThreadPool(), and SCIPsyncstoreExit().
◆ SCIPtpiSignalCondition()
SCIP_RETCODE SCIPtpiSignalCondition | ( | SCIP_CONDITION * | condition | ) |
signals one waiting thread
signal a condition
- Parameters
-
condition condition to signal
Definition at line 271 of file tpi_openmp.c.
References NULL, SCIP_CALL, SCIP_OKAY, SCIPtpiAcquireLock(), and SCIPtpiReleaseLock().
Referenced by jobQueueAddJob().
◆ SCIPtpiBroadcastCondition()
SCIP_RETCODE SCIPtpiBroadcastCondition | ( | SCIP_CONDITION * | condition | ) |
signals all waiting threads
broadcase a condition
- Parameters
-
condition broadcast a condition
Definition at line 289 of file tpi_openmp.c.
References NULL, SCIP_CALL, SCIP_OKAY, SCIPtpiAcquireLock(), and SCIPtpiReleaseLock().
Referenced by freeThreadPool(), and SCIPsyncstoreFinishSync().
◆ SCIPtpiWaitCondition()
SCIP_RETCODE SCIPtpiWaitCondition | ( | SCIP_CONDITION * | condition, |
SCIP_LOCK * | lock | ||
) |
waits on a condition variable. The given lock must be held by the caller and will be held when this function returns.
wait for a condition
- Parameters
-
condition condition to wait for lock corresponding lock
Definition at line 304 of file tpi_openmp.c.
References SCIP_CALL, SCIP_OKAY, SCIPtpiAcquireLock(), and SCIPtpiReleaseLock().
Referenced by freeThreadPool(), and SCIPsyncstoreEnsureAllSynced().
◆ SCIPtpiGetNumThreads()
int SCIPtpiGetNumThreads | ( | void | ) |
returns the number of threads
Definition at line 342 of file tpi_openmp.c.
◆ SCIPtpiGetThreadNum()
int SCIPtpiGetThreadNum | ( | void | ) |
returns the thread number
Definition at line 349 of file tpi_openmp.c.
Referenced by applyBoundChanges(), execConcsolver(), and executeJob().
◆ SCIPtpiCreateJob()
SCIP_RETCODE SCIPtpiCreateJob | ( | SCIP_JOB ** | job, |
int | jobid, | ||
SCIP_RETCODE(*)(void *args) | jobfunc, | ||
void * | jobarg | ||
) |
creates a job for parallel processing
- Parameters
-
job pointer to the job that will be created jobid the id for the current job jobfunc pointer to the job function jobarg the job's argument
Definition at line 37 of file tpi_none.c.
References BMSallocMemory, SCIP_Job::jobfunc, SCIP_Job::jobid, NULL, SCIP_ALLOC, SCIP_ERROR, SCIP_OKAY, and SCIP_UNUSED.
Referenced by SCIPconcurrentSolve().
◆ SCIPtpiGetNewJobID()
int SCIPtpiGetNewJobID | ( | void | ) |
get a new job id for a new set of jobs
get a new job id for the new set of submitted jobs
Definition at line 374 of file tpi_openmp.c.
References SCIP_Job::jobid.
Referenced by SCIPconcurrentSolve().
◆ SCIPtpiSumbitJob()
SCIP_RETCODE SCIPtpiSumbitJob | ( | SCIP_JOB * | job, |
SCIP_SUBMITSTATUS * | status | ||
) |
submit a job for parallel processing; the return value is a globally defined status
- Parameters
-
job pointer to the job to be submitted status pointer to store the job's submit status
Definition at line 53 of file tpi_none.c.
References SCIP_Job::jobid, NULL, SCIP_ERROR, and SCIP_UNUSED.
Referenced by SCIPconcurrentSolve().
◆ SCIPtpiCollectJobs()
SCIP_RETCODE SCIPtpiCollectJobs | ( | int | jobid | ) |
blocks until all jobs of the given jobid have finished and then returns the smallest SCIP_RETCODE of all the jobs
Blocks until all jobs with the given jobid have finished and then returns the smallest SCIP_RETCODE of all the jobs
- Parameters
-
jobid the jobid of the jobs to wait for
Definition at line 66 of file tpi_none.c.
References SCIP_Job::retcode, SCIP_CALL, SCIP_ERROR, SCIP_OKAY, SCIP_UNUSED, and SCIPtpiAcquireLock().
Referenced by SCIPconcurrentSolve().
◆ SCIPtpiInit()
SCIP_RETCODE SCIPtpiInit | ( | int | nthreads, |
int | queuesize, | ||
SCIP_Bool | blockwhenfull | ||
) |
initializes tpi
- Parameters
-
nthreads the number of threads to be used queuesize the size of the queue blockwhenfull should the queue block when full
Definition at line 76 of file tpi_none.c.
References SCIP_ERROR, and SCIP_UNUSED.
Referenced by SCIPsyncstoreInit().
◆ SCIPtpiExit()
SCIP_RETCODE SCIPtpiExit | ( | void | ) |
deinitializes the tpi
deinitializes tpi
Definition at line 90 of file tpi_none.c.
References SCIP_ERROR.
Referenced by SCIPsyncstoreExit().