tpi_tnycthrd.c File Reference

Detailed Description

a TPI implementation using tinycthreads

Author

Stephen J. Maher

Leona Gottwald

Definition in file tpi_tnycthrd.c.

#include "tpi/tpi.h"
#include "blockmemshell/memory.h"

Go to the source code of this file.

Data Structures
struct	SCIP_Job
struct	SCIP_JobQueue
struct	SCIP_ThreadPool

Typedefs
typedef struct SCIP_ThreadPool	SCIP_THREADPOOL
typedef struct SCIP_JobQueue	SCIP_JOBQUEUE

Functions
static SCIP_RETCODE	threadPoolThreadRetcode (void *threadnum)
static int	threadPoolThread (void *threadnum)
static SCIP_RETCODE	createThreadPool (SCIP_THREADPOOL **thrdpool, int nthreads, int qsize, SCIP_Bool blockwhenfull)
static void	jobQueueAddJob (SCIP_THREADPOOL *threadpool, SCIP_JOB *newjob)
static SCIP_RETCODE	threadPoolAddWork (SCIP_JOB *newjob, SCIP_SUBMITSTATUS *status)
static void	freeJobQueue (SCIP_THREADPOOL *thrdpool)
static SCIP_RETCODE	freeThreadPool (SCIP_THREADPOOL **thrdpool, SCIP_Bool finishjobs, SCIP_Bool completequeue)
static SCIP_JOBSTATUS	checkJobQueue (SCIP_JOBQUEUE *jobqueue, int jobid)
static SCIP_Bool	isJobRunning (SCIP_JOBQUEUE *currentjobs, int jobid)
int	SCIPtpiGetNumThreads (void)
SCIP_RETCODE	SCIPtpiInit (int nthreads, int queuesize, SCIP_Bool blockwhenfull)
SCIP_RETCODE	SCIPtpiExit (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)

Typedef Documentation

SCIP_THREADPOOL

typedef struct SCIP_ThreadPool SCIP_THREADPOOL

Definition at line 37 of file tpi_tnycthrd.c.

SCIP_JOBQUEUE

typedef struct SCIP_JobQueue SCIP_JOBQUEUE

Definition at line 58 of file tpi_tnycthrd.c.

Function Documentation

threadPoolThreadRetcode()

static SCIP_RETCODE threadPoolThreadRetcode ( void *  threadnum )

static

this function controls the execution of each of the threads

Parameters

threadnum

thread number is passed in as argument stored inside a void pointer

Definition at line 91 of file tpi_tnycthrd.c.

Referenced by threadPoolThread().

threadPoolThread()

static int threadPoolThread ( void *  threadnum )

static

this function controls the execution of each of the threads

Parameters

threadnum

thread number is passed in as argument stored inside a void pointer

Definition at line 218 of file tpi_tnycthrd.c.

References threadPoolThreadRetcode().

Referenced by createThreadPool().

createThreadPool()

static SCIP_RETCODE createThreadPool ( SCIP_THREADPOOL **  thrdpool, int  nthreads, int  qsize, SCIP_Bool  blockwhenfull  )

static

creates a threadpool

Parameters

thrdpool	pointer to store threadpool
nthreads	number of threads in the threadpool
qsize	maximum size of the jobqueue
blockwhenfull	should the jobqueue block if it is full

Definition at line 227 of file tpi_tnycthrd.c.

References BMSallocMemory, BMSallocMemoryArray, FALSE, NULL, SCIP_ALLOC, SCIP_CALL, SCIP_ERROR, SCIPtpiInitCondition(), SCIPtpiInitLock(), threadPoolThread(), and TRUE.

jobQueueAddJob()

static void jobQueueAddJob ( SCIP_THREADPOOL *  threadpool, SCIP_JOB *  newjob  )

static

adding a job to the job queue.

This gives some more flexibility in the handling of new jobs. This function needs to be called from within a mutex.

Parameters

threadpool	pointer to store threadpool
newjob	pointer to new job

Definition at line 303 of file tpi_tnycthrd.c.

References SCIP_JobQueue::firstjob, SCIP_ThreadPool::jobqueue, SCIP_JobQueue::lastjob, SCIP_Job::nextjob, SCIP_JobQueue::njobs, NULL, SCIP_ThreadPool::queuenotempty, SCIP_ThreadPool::queuesize, SCIP_CALL_ABORT, and SCIPtpiSignalCondition().

threadPoolAddWork()

static SCIP_RETCODE threadPoolAddWork ( SCIP_JOB *  newjob, SCIP_SUBMITSTATUS *  status  )

static

adds a job to the threadpool

Parameters

newjob	job to add to threadpool
status	pointer to store the job's submit status

Definition at line 335 of file tpi_tnycthrd.c.

References NULL.

freeJobQueue()

static void freeJobQueue ( SCIP_THREADPOOL *  thrdpool )

static

frees the jobqueue of the threadpool

Parameters

thrdpool

pointer to thread pool

Definition at line 392 of file tpi_tnycthrd.c.

References BMSfreeMemory, SCIP_JobQueue::firstjob, SCIP_ThreadPool::jobqueue, SCIP_JobQueue::lastjob, SCIP_Job::nextjob, NULL, SCIP_ThreadPool::queueopen, and SCIP_ThreadPool::shutdown.

Referenced by freeThreadPool().

freeThreadPool()

static SCIP_RETCODE freeThreadPool ( SCIP_THREADPOOL **  thrdpool, SCIP_Bool  finishjobs, SCIP_Bool  completequeue  )

static

free the thread pool

Parameters

thrdpool	pointer to thread pool
finishjobs	currently unused
completequeue	Wait until the queue has complete?

Definition at line 417 of file tpi_tnycthrd.c.

References BMSfreeMemory, BMSfreeMemoryArray, FALSE, freeJobQueue(), SCIP_Job::retcode, SCIP_CALL, SCIP_ERROR, SCIP_OKAY, SCIP_UNUSED, SCIPtpiAcquireLock(), SCIPtpiBroadcastCondition(), SCIPtpiDestroyCondition(), SCIPtpiDestroyLock(), SCIPtpiReleaseLock(), SCIPtpiWaitCondition(), and TRUE.

checkJobQueue()

static SCIP_JOBSTATUS checkJobQueue ( SCIP_JOBQUEUE *  jobqueue, int  jobid  )

static

Parameters

jobqueue	pointer to the job queue
jobid	id of job to check

Definition at line 503 of file tpi_tnycthrd.c.

References SCIP_JobQueue::firstjob, SCIP_Job::jobid, SCIP_JobQueue::lastjob, SCIP_Job::nextjob, NULL, SCIP_JOB_DOESNOTEXIST, and SCIP_JOB_INQUEUE.

Referenced by isJobRunning().

isJobRunning()

static SCIP_Bool isJobRunning ( SCIP_JOBQUEUE *  currentjobs, int  jobid  )

static

returns whether the job id is running

Parameters

currentjobs	queue of current jobs
jobid	id of job to check

Definition at line 530 of file tpi_tnycthrd.c.

References checkJobQueue(), FALSE, SCIP_JOB_INQUEUE, and TRUE.

SCIPtpiGetNumThreads()

int SCIPtpiGetNumThreads

(

void

)

returns the number of threads

Definition at line 542 of file tpi_tnycthrd.c.

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 550 of file tpi_tnycthrd.c.

Referenced by SCIPsyncstoreInit().

SCIPtpiExit()

SCIP_RETCODE SCIPtpiExit

(

void

)

deinitializes tpi

Definition at line 562 of file tpi_tnycthrd.c.

Referenced by SCIPsyncstoreExit().

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 574 of file tpi_tnycthrd.c.

References BMSallocMemory, SCIP_Job::jobfunc, SCIP_Job::jobid, NULL, SCIP_ALLOC, and SCIP_OKAY.

Referenced by SCIPconcurrentSolve().

SCIPtpiGetNewJobID()

int SCIPtpiGetNewJobID

(

void

)

get a new job id for the new set of submitted jobs

Definition at line 592 of file tpi_tnycthrd.c.

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 607 of file tpi_tnycthrd.c.

References SCIP_Job::jobid, and NULL.

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

Parameters

jobid

the jobid of the jobs to wait for

Definition at line 624 of file tpi_tnycthrd.c.

References SCIP_Job::retcode, SCIP_CALL, and SCIPtpiAcquireLock().

Referenced by SCIPconcurrentSolve().