cpl_multiproc.h

00001 /**********************************************************************
00002  * $Id: cpl_multiproc.h 23729 2012-01-08 01:11:14Z 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  *
00011  * Permission is hereby granted, free of charge, to any person obtaining a
00012  * copy of this software and associated documentation files (the "Software"),
00013  * to deal in the Software without restriction, including without limitation
00014  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
00015  * and/or sell copies of the Software, and to permit persons to whom the
00016  * Software is furnished to do so, subject to the following conditions:
00017  * 
00018  * The above copyright notice and this permission notice shall be included
00019  * in all copies or substantial portions of the Software.
00020  * 
00021  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
00022  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
00023  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
00024  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
00025  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
00026  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 
00027  * DEALINGS IN THE SOFTWARE.
00028  ****************************************************************************/
00029 
00030 #ifndef _CPL_MULTIPROC_H_INCLUDED_
00031 #define _CPL_MULTIPROC_H_INCLUDED_
00032 
00033 #include "cpl_port.h"
00034 
00035 /*
00036 ** There are three primary implementations of the multi-process support
00037 ** controlled by one of CPL_MULTIPROC_WIN32, CPL_MULTIPROC_PTHREAD or
00038 ** CPL_MULTIPROC_STUB being defined.  If none are defined, the stub
00039 ** implementation will be used.
00040 */
00041 
00042 #if defined(WIN32) && !defined(CPL_MULTIPROC_STUB)
00043 #  define CPL_MULTIPROC_WIN32
00044 /* MinGW can have pthread support, so disable it to avoid issues */
00045 /* in cpl_multiproc.cpp */
00046 #  undef  CPL_MULTIPROC_PTHREAD
00047 #endif
00048 
00049 #if !defined(CPL_MULTIPROC_WIN32) && !defined(CPL_MULTIPROC_PTHREAD) \
00050  && !defined(CPL_MULTIPROC_STUB) && !defined(CPL_MULTIPROC_NONE)
00051 #  define CPL_MULTIPROC_STUB
00052 #endif
00053 
00054 CPL_C_START
00055 
00056 typedef void (*CPLThreadFunc)(void *);
00057 
00058 void CPL_DLL *CPLLockFile( const char *pszPath, double dfWaitInSeconds );
00059 void  CPL_DLL CPLUnlockFile( void *hLock );
00060 
00061 void CPL_DLL *CPLCreateMutex();
00062 int   CPL_DLL CPLCreateOrAcquireMutex( void **, double dfWaitInSeconds );
00063 int   CPL_DLL CPLAcquireMutex( void *hMutex, double dfWaitInSeconds );
00064 void  CPL_DLL CPLReleaseMutex( void *hMutex );
00065 void  CPL_DLL CPLDestroyMutex( void *hMutex );
00066 
00067 GIntBig CPL_DLL CPLGetPID();
00068 int   CPL_DLL CPLCreateThread( CPLThreadFunc pfnMain, void *pArg );
00069 void  CPL_DLL CPLSleep( double dfWaitInSeconds );
00070 
00071 const char CPL_DLL *CPLGetThreadingModel();
00072 
00073 CPL_C_END
00074 
00075 #ifdef __cplusplus
00076 
00077 #define CPLMutexHolderD(x)  CPLMutexHolder oHolder(x,1000.0,__FILE__,__LINE__);
00078 
00079 class CPL_DLL CPLMutexHolder
00080 {
00081   private:
00082     void       *hMutex;
00083     const char *pszFile;
00084     int         nLine;
00085 
00086   public:
00087 
00088     CPLMutexHolder( void **phMutex, double dfWaitInSeconds = 1000.0,
00089                     const char *pszFile = __FILE__,
00090                     int nLine = __LINE__ );
00091     ~CPLMutexHolder();
00092 };
00093 #endif /* def __cplusplus */
00094 
00095 /* -------------------------------------------------------------------- */
00096 /*      Thread local storage.                                           */
00097 /* -------------------------------------------------------------------- */
00098 
00099 #define CTLS_RLBUFFERINFO               1         /* cpl_conv.cpp */
00100 #define CTLS_DECDMSBUFFER               2         /* cpl_conv.cpp */
00101 #define CTLS_CSVTABLEPTR                3         /* cpl_csv.cpp */
00102 #define CTLS_CSVDEFAULTFILENAME         4         /* cpl_csv.cpp */
00103 #define CTLS_ERRORCONTEXT               5         /* cpl_error.cpp */
00104 #define CTLS_UNUSED1                    6
00105 #define CTLS_PATHBUF                    7         /* cpl_path.cpp */
00106 #define CTLS_SPRINTFBUF                 8         /* cpl_string.cpp */
00107 #define CTLS_SWQ_ERRBUF                 9         /* swq.c */
00108 #define CTLS_CPLSPRINTF                10         /* cpl_string.h */
00109 #define CTLS_RESPONSIBLEPID            11         /* gdaldataset.cpp */
00110 #define CTLS_VERSIONINFO               12         /* gdal_misc.cpp */
00111 #define CTLS_VERSIONINFO_LICENCE       13         /* gdal_misc.cpp */
00112 #define CTLS_CONFIGOPTIONS             14         /* cpl_conv.cpp */
00113 #define CTLS_FINDFILE                  15         /* cpl_findfile.cpp */
00114 
00115 #define CTLS_MAX                       32         
00116 
00117 CPL_C_START
00118 void CPL_DLL * CPLGetTLS( int nIndex );
00119 void CPL_DLL CPLSetTLS( int nIndex, void *pData, int bFreeOnExit );
00120 
00121 /* Warning : the CPLTLSFreeFunc must not in any case directly or indirectly */
00122 /* use or fetch any TLS data, or a terminating thread will hang ! */
00123 typedef void (*CPLTLSFreeFunc)( void* pData );
00124 void CPL_DLL CPLSetTLSWithFreeFunc( int nIndex, void *pData, CPLTLSFreeFunc pfnFree );
00125 
00126 void CPL_DLL CPLCleanupTLS();
00127 CPL_C_END
00128 
00129 #endif /* _CPL_MULTIPROC_H_INCLUDED_ */

Generated for GDAL by doxygen 1.6.1.