---

WKFThreads.h

Go to the documentation of this file.

/***************************************************************************
 * RCS INFORMATION:
 *
 *      $RCSfile: WKFThreads.h,v $
 *      $Author: johns $        $Locker:  $             $State: Exp $
 *      $Revision: 1.9 $       $Date: 2011/02/07 19:57:51 $
 *
 ***************************************************************************
 * WKFThreads.h - code for spawning threads on various platforms.
 *                Code donated by John Stone, john.stone@gmail.com
 *                This code was originally written for the
 *                Tachyon Parallel/Multiprocessor Ray Tracer.
 *                Improvements have been donated by Mr. Stone on an
 *                ongoing basis.  This code is provided under the
 *                three clause BSD Open Source License.
 *
 * NOTE: The latest version of this source file can be re-generated by
 *       running the sequence of 'sed' commands shown at the top of the
 *       "threads.c" file within the Tachyon source distribution.
 *
 ***************************************************************************/
/* Tachyon copyright reproduced below */
/*
 * Copyright (c) 1994-2011 John E. Stone
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. The name of the author may not be used to endorse or promote products
 *    derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS
 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 */

#ifndef WKF_THREADS_INC
#define WKF_THREADS_INC 1

#ifdef __cplusplus
extern "C" {
#endif

/* POSIX Threads */
#if defined(_AIX) || defined(__APPLE__) || defined(_CRAY) || defined(__hpux) || defined(__irix) || defined(__linux) || defined(__osf__) ||  defined(__PARAGON__)
#if !defined(USEPOSIXTHREADS)
#define USEPOSIXTHREADS
#endif
#endif

#ifdef WKFTHREADS
#ifdef USEPOSIXTHREADS
#include <pthread.h>

typedef pthread_t        wkf_thread_t;
typedef pthread_mutex_t   wkf_mutex_t;
typedef pthread_cond_t     wkf_cond_t;
#endif


#ifdef _MSC_VER
#include <windows.h>
typedef HANDLE wkf_thread_t;
typedef CRITICAL_SECTION wkf_mutex_t;

#if 0 && (NTDDI_VERSION >= NTDDI_WS08 || _WIN32_WINNT > 0x0600)
/* Use native condition variables only with Windows Server 2008 and newer... */
#define WKFUSEWIN2008CONDVARS 1
typedef CONDITION_VARIABLE wkf_cond_t;
#else
/* Every version of Windows prior to Vista/WS2008 must emulate */
/* variables using manually resettable events or other schemes */

/* For higher performance, use interlocked memory operations   */
/* rather than locking/unlocking mutexes when manipulating     */
/* internal state.                                             */
#if 1
#define WKFUSEINTERLOCKEDATOMICOPS 1
#endif
#define WKF_COND_SIGNAL    0
#define WKF_COND_BROADCAST 1
typedef struct {
  LONG waiters;                  
  CRITICAL_SECTION waiters_lock; 
  HANDLE events[2];              
} wkf_cond_t;
#endif

#endif
#endif /* _MSC_VER */


#ifndef WKFTHREADS
typedef int wkf_thread_t;
typedef int wkf_mutex_t;
typedef int wkf_cond_t;
#endif


typedef struct wkf_run_barrier_struct {
  int padding1[8];        
  wkf_mutex_t lock;        
  int n_clients;          
  int n_waiting;          
  int phase;              
  void * (*fctn)(void *); 
  void * parms;           
  void * (*rslt)(void *); 
  void * rsltparms;       
  wkf_cond_t wait_cv;      
  int padding2[8];        
} wkf_run_barrier_t;


/*
 * Routines for querying processor counts, and managing CPU affinity
 */
int wkf_thread_numphysprocessors(void);

int wkf_thread_numprocessors(void);

int * wkf_cpu_affinitylist(int *cpuaffinitycount);

int wkf_thread_set_self_cpuaffinity(int cpu);

int wkf_thread_setconcurrency(int);


/*
 * Thread management
 */
int wkf_thread_create(wkf_thread_t *, void * fctn(void *), void *);

int wkf_thread_join(wkf_thread_t, void **);


/*
 * Mutex management
 */
int wkf_mutex_init(wkf_mutex_t *);

int wkf_mutex_lock(wkf_mutex_t *);

int wkf_mutex_trylock(wkf_mutex_t *);

int wkf_mutex_spin_lock(wkf_mutex_t *);

int wkf_mutex_unlock(wkf_mutex_t *);

int wkf_mutex_destroy(wkf_mutex_t *);


/*
 * Condition variable management
 */
int wkf_cond_init(wkf_cond_t *);

int wkf_cond_destroy(wkf_cond_t *);

int wkf_cond_wait(wkf_cond_t *, wkf_mutex_t *);

int wkf_cond_signal(wkf_cond_t *);

int wkf_cond_broadcast(wkf_cond_t *);


/*
 * This is a symmetric barrier routine designed to be used
 * in implementing a sleepable thread pool.
 */
int wkf_thread_run_barrier_init(wkf_run_barrier_t *barrier, int n_clients);

void wkf_thread_run_barrier_destroy(wkf_run_barrier_t *barrier);

void * (*wkf_thread_run_barrier(wkf_run_barrier_t *barrier,
                                void * fctn(void*),
                                void * parms,
                                void **rsltparms))(void *);

int wkf_thread_run_barrier_poll(wkf_run_barrier_t *barrier);


typedef struct wkf_tasktile_struct {
  int start;         
  int end;           
} wkf_tasktile_t;


/*
 * tile stack
 */
#define WKF_TILESTACK_EMPTY -1

typedef struct {
  wkf_mutex_t mtx;    
  int growthrate;    
  int size;          
  int top;           
  wkf_tasktile_t *s;  
} wkf_tilestack_t;

int wkf_tilestack_init(wkf_tilestack_t *s, int size);

void wkf_tilestack_destroy(wkf_tilestack_t *);

int wkf_tilestack_compact(wkf_tilestack_t *);

int wkf_tilestack_push(wkf_tilestack_t *, const wkf_tasktile_t *);

int wkf_tilestack_pop(wkf_tilestack_t *, wkf_tasktile_t *);

int wkf_tilestack_popall(wkf_tilestack_t *);

int wkf_tilestack_empty(wkf_tilestack_t *);


#define WKF_SCHED_DONE     -1   
#define WKF_SCHED_CONTINUE  0   
typedef struct wkf_shared_iterator_struct {
  wkf_mutex_t mtx;      
  int start;           
  int end;             
  int current;         
  int fatalerror;      
} wkf_shared_iterator_t;

int wkf_shared_iterator_init(wkf_shared_iterator_t *it);

int wkf_shared_iterator_destroy(wkf_shared_iterator_t *it);

int wkf_shared_iterator_set(wkf_shared_iterator_t *it, wkf_tasktile_t *tile);

int wkf_shared_iterator_next_tile(wkf_shared_iterator_t *it, int reqsize,
                                 wkf_tasktile_t *tile);

int wkf_shared_iterator_setfatalerror(wkf_shared_iterator_t *it);

int wkf_shared_iterator_getfatalerror(wkf_shared_iterator_t *it);


/*
 * Thread pool.
 */
#define WKF_THREADPOOL_DEVLIST_CPUSONLY NULL

#define WKF_THREADPOOL_DEVID_CPU -1

typedef struct wkf_threadpool_workerdata_struct {
  int padding1[8];                        
  wkf_shared_iterator_t *iter;             
  wkf_tilestack_t *errorstack;             
  int threadid;                           
  int threadcount;                        
  int devid;                              
  float devspeed;                         
  void *parms;                            
  void *thrpool;                          
  int padding2[8];                        
} wkf_threadpool_workerdata_t;

typedef struct wkf_threadpool_struct {
  int workercount;                        
  int *devlist;                           
  wkf_shared_iterator_t iter;              
  wkf_tilestack_t errorstack;              
  wkf_thread_t *threads;                   
  wkf_threadpool_workerdata_t *workerdata; 
  wkf_run_barrier_t runbar;                
} wkf_threadpool_t;

wkf_threadpool_t * wkf_threadpool_create(int workercount, int *devlist);

int wkf_threadpool_launch(wkf_threadpool_t *thrpool,
                         void *fctn(void *), void *parms, int blocking);

int wkf_threadpool_wait(wkf_threadpool_t *thrpool);

int wkf_threadpool_destroy(wkf_threadpool_t *thrpool);

int wkf_threadpool_get_workercount(wkf_threadpool_t *thrpool);

int wkf_threadpool_worker_getid(void *voiddata, int *threadid, int *threadcount);

int wkf_threadpool_worker_getdevid(void *voiddata, int *devid);

int wkf_threadpool_worker_setdevspeed(void *voiddata, float speed);

int wkf_threadpool_worker_getdevspeed(void *voiddata, float *speed);

int wkf_threadpool_worker_devscaletile(void *voiddata, int *tilesize);

int wkf_threadpool_worker_getdata(void *voiddata, void **clientdata);

int wkf_threadpool_sched_dynamic(wkf_threadpool_t *thrpool, wkf_tasktile_t *tile);

int wkf_threadpool_next_tile(void *thrpool, int reqsize, wkf_tasktile_t *tile);

int wkf_threadpool_tile_failed(void *thrpool, wkf_tasktile_t *tile);

int wkf_threadpool_setfatalerror(void *thrparms);

int wkf_threadpool_getfatalerror(void *thrparms);


typedef struct wkf_threadlaunch_struct {
  int padding1[8];              
  wkf_shared_iterator_t *iter;   
  int threadid;                 
  int threadcount;              
  void * clientdata;            
  int padding2[8];              
} wkf_threadlaunch_t;

int wkf_threadlaunch(int numprocs, void *clientdata, void * fctn(void *),
                    wkf_tasktile_t *tile);

int wkf_threadlaunch_getid(void *thrparms, int *threadid, int *threadcount);

int wkf_threadlaunch_getdata(void *thrparms, void **clientdata);

int wkf_threadlaunch_next_tile(void *voidparms, int reqsize,
                              wkf_tasktile_t *tile);

int wkf_threadlaunch_setfatalerror(void *thrparms);


#ifdef __cplusplus
}
#endif

#endif

---