cpl_multiproc.h

00001 /**********************************************************************
00002  * $Id: cpl_multiproc.h 27044 2014-03-16 23:41:27Z rouault $
00003  *
00004  * Project:  CPL - Common Portability Library
00005  * Purpose:  CPL Multi-Threading, and process handling portability functions.
00006  * Author:   Frank Warmerdam, warmerdam@pobox.com
00007  *
00008  **********************************************************************
00009  * Copyright (c) 2002, Frank Warmerdam
00010  * Copyright (c) 2008-2013, Even Rouault <even dot rouault at mines-paris dot org>
00011  *
00012  * Permission is hereby granted, free of charge, to any person obtaining a
00013  * copy of this software and associated documentation files (the "Software"),
00014  * to deal in the Software without restriction, including without limitation
00015  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
00016  * and/or sell copies of the Software, and to permit persons to whom the
00017  * Software is furnished to do so, subject to the following conditions:
00018  * 
00019  * The above copyright notice and this permission notice shall be included
00020  * in all copies or substantial portions of the Software.
00021  * 
00022  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
00023  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
00024  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
00025  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
00026  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
00027  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 
00028  * DEALINGS IN THE SOFTWARE.
00029  ****************************************************************************/
00030 
00031 #ifndef _CPL_MULTIPROC_H_INCLUDED_
00032 #define _CPL_MULTIPROC_H_INCLUDED_
00033 
00034 #include "cpl_port.h"
00035 
00036 /*
00037 ** There are three primary implementations of the multi-process support
00038 ** controlled by one of CPL_MULTIPROC_WIN32, CPL_MULTIPROC_PTHREAD or
00039 ** CPL_MULTIPROC_STUB being defined.  If none are defined, the stub
00040 ** implementation will be used.
00041 */
00042 
00043 #if defined(WIN32) && !defined(CPL_MULTIPROC_STUB)
00044 #  define CPL_MULTIPROC_WIN32
00045 /* MinGW can have pthread support, so disable it to avoid issues */
00046 /* in cpl_multiproc.cpp */
00047 #  undef  CPL_MULTIPROC_PTHREAD
00048 #endif
00049 
00050 #if !defined(CPL_MULTIPROC_WIN32) && !defined(CPL_MULTIPROC_PTHREAD) \
00051  && !defined(CPL_MULTIPROC_STUB) && !defined(CPL_MULTIPROC_NONE)
00052 #  define CPL_MULTIPROC_STUB
00053 #endif
00054 
00055 CPL_C_START
00056 
00057 typedef void (*CPLThreadFunc)(void *);
00058 
00059 void CPL_DLL *CPLLockFile( const char *pszPath, double dfWaitInSeconds );
00060 void  CPL_DLL CPLUnlockFile( void *hLock );
00061 
00062 void CPL_DLL *CPLCreateMutex( void );
00063 int   CPL_DLL CPLCreateOrAcquireMutex( void **, double dfWaitInSeconds );
00064 int   CPL_DLL CPLAcquireMutex( void *hMutex, double dfWaitInSeconds );
00065 void  CPL_DLL CPLReleaseMutex( void *hMutex );
00066 void  CPL_DLL CPLDestroyMutex( void *hMutex );
00067 void  CPL_DLL CPLCleanupMasterMutex( void );
00068 
00069 void  CPL_DLL *CPLCreateCond( void );
00070 void  CPL_DLL  CPLCondWait( void *hCond, void* hMutex );
00071 void  CPL_DLL  CPLCondSignal( void *hCond );
00072 void  CPL_DLL  CPLCondBroadcast( void *hCond );
00073 void  CPL_DLL  CPLDestroyCond( void *hCond );
00074 
00075 GIntBig CPL_DLL CPLGetPID( void );
00076 int   CPL_DLL CPLCreateThread( CPLThreadFunc pfnMain, void *pArg );
00077 void  CPL_DLL* CPLCreateJoinableThread( CPLThreadFunc pfnMain, void *pArg );
00078 void  CPL_DLL CPLJoinThread(void* hJoinableThread); 
00079 void  CPL_DLL CPLSleep( double dfWaitInSeconds );
00080 
00081 const char CPL_DLL *CPLGetThreadingModel( void );
00082 
00083 int CPL_DLL CPLGetNumCPUs( void );
00084 
00085 CPL_C_END
00086 
00087 #ifdef __cplusplus
00088 
00089 /* Instanciates the mutex if not already done */
00090 #define CPLMutexHolderD(x)  CPLMutexHolder oHolder(x,1000.0,__FILE__,__LINE__);
00091 
00092 /* This variant assumes the the mutex has already been created. If not, it will */
00093 /* be a no-op */
00094 #define CPLMutexHolderOptionalLockD(x)  CPLMutexHolder oHolder(x,1000.0,__FILE__,__LINE__);
00095 
00096 class CPL_DLL CPLMutexHolder
00097 {
00098   private:
00099     void       *hMutex;
00100     const char *pszFile;
00101     int         nLine;
00102 
00103   public:
00104 
00105     /* Instanciates the mutex if not already done */
00106     CPLMutexHolder( void **phMutex, double dfWaitInSeconds = 1000.0,
00107                     const char *pszFile = __FILE__,
00108                     int nLine = __LINE__ );
00109 
00110     /* This variant assumes the the mutex has already been created. If not, it will */
00111     /* be a no-op */
00112     CPLMutexHolder( void* hMutex, double dfWaitInSeconds = 1000.0,
00113                     const char *pszFile = __FILE__,
00114                     int nLine = __LINE__ );
00115 
00116     ~CPLMutexHolder();
00117 };
00118 #endif /* def __cplusplus */
00119 
00120 /* -------------------------------------------------------------------- */
00121 /*      Thread local storage.                                           */
00122 /* -------------------------------------------------------------------- */
00123 
00124 #define CTLS_RLBUFFERINFO               1         /* cpl_conv.cpp */
00125 #define CTLS_WIN32_COND                 2         /* cpl_multiproc.cpp */
00126 #define CTLS_CSVTABLEPTR                3         /* cpl_csv.cpp */
00127 #define CTLS_CSVDEFAULTFILENAME         4         /* cpl_csv.cpp */
00128 #define CTLS_ERRORCONTEXT               5         /* cpl_error.cpp */
00129 #define CTLS_GDALDATASET_REC_PROTECT_MAP 6        /* gdaldataset.cpp */
00130 #define CTLS_PATHBUF                    7         /* cpl_path.cpp */
00131 #define CTLS_UNUSED3                    8
00132 #define CTLS_UNUSED4                    9
00133 #define CTLS_CPLSPRINTF                10         /* cpl_string.h */
00134 #define CTLS_RESPONSIBLEPID            11         /* gdaldataset.cpp */
00135 #define CTLS_VERSIONINFO               12         /* gdal_misc.cpp */
00136 #define CTLS_VERSIONINFO_LICENCE       13         /* gdal_misc.cpp */
00137 #define CTLS_CONFIGOPTIONS             14         /* cpl_conv.cpp */
00138 #define CTLS_FINDFILE                  15         /* cpl_findfile.cpp */
00139 
00140 #define CTLS_MAX                       32         
00141 
00142 CPL_C_START
00143 void CPL_DLL * CPLGetTLS( int nIndex );
00144 void CPL_DLL CPLSetTLS( int nIndex, void *pData, int bFreeOnExit );
00145 
00146 /* Warning : the CPLTLSFreeFunc must not in any case directly or indirectly */
00147 /* use or fetch any TLS data, or a terminating thread will hang ! */
00148 typedef void (*CPLTLSFreeFunc)( void* pData );
00149 void CPL_DLL CPLSetTLSWithFreeFunc( int nIndex, void *pData, CPLTLSFreeFunc pfnFree );
00150 
00151 void CPL_DLL CPLCleanupTLS( void );
00152 CPL_C_END
00153 
00154 #endif /* _CPL_MULTIPROC_H_INCLUDED_ */

Generated for GDAL by doxygen 1.7.1.