src/core/model/build-profile.h
author Peter D. Barnes, Jr. <barnes26@llnl.gov>
Tue, 28 Jul 2015 16:33:35 -0700
changeset 11544 cfaf2d65b33c
permissions -rw-r--r--
Build profile macros
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
11544
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
     1
/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
     2
/*
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
     3
 * Copyright (c) 2015 LLNL
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
     4
 *
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
     5
 * This program is free software; you can redistribute it and/or modify
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
     6
 * it under the terms of the GNU General Public License version 2 as
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
     7
 * published by the Free Software Foundation;
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
     8
 *
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
     9
 * This program is distributed in the hope that it will be useful,
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
    10
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
    11
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
    12
 * GNU General Public License for more details.
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
    13
 *
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
    14
 * You should have received a copy of the GNU General Public License
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
    15
 * along with this program; if not, write to the Free Software
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
    16
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
    17
 *
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
    18
 * Author: Peter D. Barnes, Jr. <pdbarnes@llnl.gov>
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
    19
 */
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
    20
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
    21
#ifndef NS3_BUILD_PROFILE_H
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
    22
#define NS3_BUILD_PROFILE_H
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
    23
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
    24
/**
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
    25
 * \file
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
    26
 * \ingroup debugging
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
    27
 * Definition of build profile macros NS_BUILD_DEBUG, NS_BUILD_RELEASE,
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
    28
 * and NS_BUILD_OPTIMIZED.
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
    29
 */
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
    30
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
    31
/**
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
    32
 * \ingroup debugging
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
    33
 * Build profile no-op macro.
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
    34
 * \param [in] code The code to skip.
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
    35
 */
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
    36
#define NS_BUILD_PROFILE_NOOP(code)             \
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
    37
  do                                            \
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
    38
      if (false)                                \
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
    39
        {                                       \
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
    40
          code ;                                \
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
    41
        }                                       \
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
    42
  while (false)
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
    43
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
    44
/**
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
    45
 * \ingroup debugging
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
    46
 * Build profile macro to execute a code snippet.
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
    47
 * \param [in] code The code to execute.
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
    48
 */
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
    49
#define NS_BUILD_PROFILE_OP(code) \
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
    50
  do                                            \
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
    51
    {                                           \
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
    52
      code ;                                    \
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
    53
    }                                           \
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
    54
  while (false)
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
    55
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
    56
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
    57
#ifdef NS3_BUILD_PROFILE_DEBUG
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
    58
/**
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
    59
 * \ingroup debugging
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
    60
 * Execute a code snippet in debug builds.
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
    61
 * \param [in] code The code to execute.
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
    62
 */
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
    63
#define NS_BUILD_DEBUG(code)     NS_BUILD_PROFILE_OP (code)
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
    64
#else
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
    65
#define NS_BUILD_DEBUG(code)     NS_BUILD_PROFILE_NOOP (code)
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
    66
#endif
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
    67
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
    68
#ifdef NS3_BUILD_PROFILE_RELEASE
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
    69
/**
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
    70
 * \ingroup debugging
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
    71
 * Execute a code snippet in release builds.
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
    72
 * \param [in] code The code to execute.
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
    73
 */
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
    74
#define NS_BUILD_RELEASE(code)   NS_BUILD_PROFILE_OP (code)
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
    75
#else
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
    76
#define NS_BUILD_RELEASE(code)   NS_BUILD_PROFILE_NOOP (code)
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
    77
#endif
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
    78
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
    79
#ifdef NS3_BUILD_PROFILE_OPTIMIZED
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
    80
/**
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
    81
 * \ingroup debugging
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
    82
 * Execute a code snippet in optimized builds.
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
    83
 * \param [in] code The code to execute.
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
    84
 */
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
    85
#define NS_BUILD_OPTIMIZED(code) NS_BUILD_PROFILE_OP (code)
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
    86
#else
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
    87
#define NS_BUILD_OPTIMIZED(code) NS_BUILD_PROFILE_NOOP (code)
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
    88
#endif
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
    89
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
    90
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
    91
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
    92
cfaf2d65b33c Build profile macros
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
diff changeset
    93
#endif /* NS3_BUILD_PROFILE_H */