Loading...
Searching...
No Matches
thread-private.h
/*
Copyright @ 1999 ImageMagick Studio LLC, a non-profit organization
dedicated to making software imaging solutions freely available.
You may not use this file except in compliance with the License. You may
obtain a copy of the License at
https://imagemagick.org/license/
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
MagickCore private methods for internal threading.
*/
#ifndef MAGICKCORE_THREAD_PRIVATE_H
#define MAGICKCORE_THREAD_PRIVATE_H
#include "MagickCore/cache.h"
#include "MagickCore/image-private.h"
#include "MagickCore/resource_.h"
#include "MagickCore/thread_.h"
#if defined(__cplusplus) || defined(c_plusplus)
extern "C" {
#endif
#define magick_number_threads(source,destination,chunk,factor) \
num_threads(GetMagickNumberThreads((source),(destination),(chunk),(factor)))
#if defined(__clang__) || (__GNUC__ > 3) || ((__GNUC__ == 3) && (__GNUC_MINOR__ > 10))
#define MagickCachePrefetch(address,mode,locality) \
__builtin_prefetch(address,mode,locality)
#else
#define MagickCachePrefetch(address,mode,locality) \
magick_unreferenced(address); \
magick_unreferenced(mode); \
magick_unreferenced(locality);
#endif
#if defined(MAGICKCORE_THREAD_SUPPORT)
typedef pthread_mutex_t MagickMutexType;
#elif defined(MAGICKCORE_WINDOWS_SUPPORT)
typedef CRITICAL_SECTION MagickMutexType;
#else
typedef size_t MagickMutexType;
#endif
static inline int GetMagickNumberThreads(const Image *source,
const Image *destination,const size_t chunk,const double factor)
{
const CacheType
destination_type = (CacheType) GetImagePixelCacheType(destination),
source_type = (CacheType) GetImagePixelCacheType(source);
size_t
max_threads = (size_t) GetMagickResourceLimit(ThreadResource),
number_threads = 1UL,
rows_per_thread = CastDoubleToSizeT(64.0*factor); /* workload */
/*
Determine number of threads based on rows per thread heuristic.
*/
if (rows_per_thread != 0)
number_threads=(chunk < rows_per_thread) ? 1UL : MagickMin(max_threads,
(chunk+rows_per_thread-1)/rows_per_thread);
/*
Limit threads for non-memory or non-map cache sources/destinations.
*/
if (((source_type != MemoryCache) && (source_type != MapCache)) ||
((destination_type != MemoryCache) && (destination_type != MapCache)))
number_threads=MagickMin(number_threads,4);
return((int) number_threads);
}
static inline MagickThreadType GetMagickThreadId(void)
{
#if defined(MAGICKCORE_THREAD_SUPPORT)
return(pthread_self());
#elif defined(MAGICKCORE_WINDOWS_SUPPORT)
return(GetCurrentThreadId());
#else
return(getpid());
#endif
}
static inline void GetMagickThreadFilename(const char *filename,
char *thread_filename)
{
MagickThreadType
id;
char
thread_id[2*sizeof(id)+1];
ssize_t
i;
unsigned char
bytes[sizeof(id)];
id=GetMagickThreadId();
(void) memcpy(bytes,&id,sizeof(id));
for (i=0; i < (ssize_t) sizeof(bytes); i++)
(void) FormatLocaleString(thread_id+2*i,MagickPathExtent,"%02x",bytes[i]);
thread_id[sizeof(thread_id)-1]='\0';
(void) FormatLocaleString(thread_filename,MagickPathExtent,"%s|%s",thread_id,
filename);
}
static inline size_t GetMagickThreadSignature(void)
{
#if defined(MAGICKCORE_THREAD_SUPPORT)
{
union
{
pthread_t
id;
size_t
signature;
} magick_thread;
magick_thread.signature=0UL;
magick_thread.id=pthread_self();
return(magick_thread.signature);
}
#elif defined(MAGICKCORE_WINDOWS_SUPPORT)
return((size_t) GetCurrentThreadId());
#else
return((size_t) getpid());
#endif
}
static inline MagickBooleanType IsMagickThreadEqual(const MagickThreadType id)
{
#if defined(MAGICKCORE_THREAD_SUPPORT)
if (pthread_equal(id,pthread_self()) != 0)
return(MagickTrue);
#elif defined(MAGICKCORE_WINDOWS_SUPPORT)
if (id == GetCurrentThreadId())
return(MagickTrue);
#else
if (id == getpid())
return(MagickTrue);
#endif
return(MagickFalse);
}
/*
Lightweight OpenMP methods.
*/
static inline size_t GetOpenMPMaximumThreads(void)
{
#if defined(MAGICKCORE_OPENMP_SUPPORT)
return((size_t) omp_get_max_threads());
#else
return(1);
#endif
}
static inline int GetOpenMPThreadId(void)
{
#if defined(MAGICKCORE_OPENMP_SUPPORT)
return(omp_get_thread_num());
#else
return(0);
#endif
}
#if defined(MAGICKCORE_OPENMP_SUPPORT)
static inline void SetOpenMPMaximumThreads(const int threads)
{
omp_set_num_threads(threads);
#else
static inline void SetOpenMPMaximumThreads(const int magick_unused(threads))
{
magick_unreferenced(threads);
#endif
}
#if defined(MAGICKCORE_OPENMP_SUPPORT)
static inline void SetOpenMPMaxActiveLevels(const int value)
{
#if defined(MAGICKCORE_WINDOWS_SUPPORT)
omp_set_nested(value);
#else
omp_set_max_active_levels(value ? 2 : 1);
#endif
#else
static inline void SetOpenMPMaxActiveLevels(const int magick_unused(value))
{
magick_unreferenced(value);
#endif
}
#if defined(__cplusplus) || defined(c_plusplus)
}
#endif
#endif