thread_macros.h

Go to the documentation of this file.

/**
 *  \file IMP/thread_macros.h
 *  \brief Control for OpenMP
 *
 *  Copyright 2007-2018 IMP Inventors. All rights reserved.
 *
 */

#ifndef IMPKERNEL_THREAD_MACROS_H
#define IMPKERNEL_THREAD_MACROS_H

#include "threads.h"
#include "utility_macros.h"
#include "log_macros.h"
#ifdef _OPENMP
#include <IMP/CreateLogContext.h>
#include <omp.h>
#endif

#if defined(IMP_DOXYGEN) || !defined(_OPENMP)

/** Start a new OpenMP task with the next block passing the
    list of passed variables.*/
#define IMP_TASK(privatev, action, name) action

/** Start a new OpenMP task with the next block passing the
    list of passed variables.*/
#define IMP_TASK_SHARED(privatev, sharedv, action, name) action

/** Start a parallel section if one is not already started.
 */
#define IMP_THREADS(variables, action) action

/** Pragma for OpenMP */
#define IMP_OMP_PRAGMA(x)

#else

#define IMP_OMP_PRAGMA(x) IMP_PRAGMA(omp x)

#define IMP_TASK(privatev, action, name)                                   \
  if (IMP::get_number_of_threads() > 1) {                            \
    IMP_OMP_PRAGMA(                                                        \
        task default(none) firstprivate privatev if (omp_in_parallel())) { \
      IMP::CreateLogContext task_context(name);                      \
      action;                                                              \
    }                                                                      \
  } else {                                                                 \
    action;                                                                \
  }

#define IMP_TASK_SHARED(privatev, sharedv, action, name)           \
  if (IMP::get_number_of_threads() > 1) {                    \
    IMP_OMP_PRAGMA(task default(none) firstprivate privatev shared \
                       sharedv if (omp_in_parallel())) {           \
      IMP::CreateLogContext task_context(name);              \
      action;                                                      \
    }                                                              \
  } else {                                                         \
    action;                                                        \
  }

#define IMP_THREADS(variables, action)                                    \
  if (IMP::get_number_of_threads() > 1) {                           \
    IMP_OMP_PRAGMA(parallel shared variables                              \
                       num_threads(IMP::get_number_of_threads())) { \
      IMP_PRAGMA(omp single) {                                            \
        IMP::CreateLogContext parallel_context("parallel");         \
        action;                                                           \
      }                                                                   \
    }                                                                     \
  } else {                                                                \
    action;                                                               \
  }
#endif

#endif /* IMPKERNEL_THREAD_MACROS_H */