File: itkMultiThreaderBaseTest.cxx

package info (click to toggle)
insighttoolkit5 5.4.3-5
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 704,384 kB
  • sloc: cpp: 783,592; ansic: 628,724; xml: 44,704; fortran: 34,250; python: 22,874; sh: 4,078; pascal: 2,636; lisp: 2,158; makefile: 464; yacc: 328; asm: 205; perl: 203; lex: 146; tcl: 132; javascript: 98; csh: 81
file content (183 lines) | stat: -rw-r--r-- 6,718 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *         https://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  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.
 *
 *=========================================================================*/

#include <set>
#include "itkMultiThreaderBase.h"
#include "itkPlatformMultiThreader.h"
#include "itkPoolMultiThreader.h"
#ifdef ITK_USE_TBB
#  include "itkTBBMultiThreader.h"
#endif
#include "itkTestingMacros.h"

bool
VerifyRange(int value, int min, int max, const char * msg)
{
  if (value < min)
  {
    std::cerr << msg << std::endl;
    return false;
  }

  if (value > max)
  {
    std::cerr << msg << std::endl;
    return false;
  }
  return true;
}


bool
SetAndVerifyGlobalMaximumNumberOfThreads(int value)
{
  itk::MultiThreaderBase::SetGlobalMaximumNumberOfThreads(value);
  return VerifyRange(itk::MultiThreaderBase::GetGlobalMaximumNumberOfThreads(),
                     1,
                     itk::ITK_MAX_THREADS,
                     "Range error in MaximumNumberOfThreads");
}

bool
SetAndVerifyGlobalDefaultNumberOfThreads(int value)
{
  itk::MultiThreaderBase::SetGlobalDefaultNumberOfThreads(value);
  return VerifyRange(itk::MultiThreaderBase::GetGlobalDefaultNumberOfThreads(),
                     1,
                     itk::MultiThreaderBase::GetGlobalMaximumNumberOfThreads(),
                     "Range error in DefaultNumberOfThreads");
}

bool
SetAndVerifyMaximumNumberOfThreads(int value, itk::MultiThreaderBase * threader)
{
  threader->SetMaximumNumberOfThreads(value);
  return VerifyRange(threader->GetMaximumNumberOfThreads(),
                     1,
                     itk::MultiThreaderBase::GetGlobalMaximumNumberOfThreads(),
                     "Range error in MaximumNumberOfThreads");
}

bool
SetAndVerify(int number)
{
  bool result = true;
  result &= SetAndVerifyGlobalMaximumNumberOfThreads(number);
  result &= SetAndVerifyGlobalDefaultNumberOfThreads(number);
  itk::MultiThreaderBase::Pointer threader = itk::MultiThreaderBase::New();
  // PoolMultiThreader can only increase number of threads
  // so make sure to increase this before testing thread count
  itk::MultiThreaderBase::SetGlobalMaximumNumberOfThreads(itk::ITK_MAX_THREADS);
  result &= SetAndVerifyMaximumNumberOfThreads(number, threader);
  // number of Work Units is not max-limited by TBBMultiThreader
  return result;
}

#define TEST_SINGLE_CLASS(ClassName)                                           \
  {                                                                            \
    itk::ClassName::Pointer threader = itk::ClassName::New();                  \
    if (threader.IsNull())                                                     \
    {                                                                          \
      result = false;                                                          \
    }                                                                          \
                                                                               \
    ITK_EXERCISE_BASIC_OBJECT_METHODS(threader, ClassName, MultiThreaderBase); \
  }                                                                            \
  ITK_MACROEND_NOOP_STATEMENT

int
itkMultiThreaderBaseTest(int argc, char * argv[])
{
  bool result = true;

  itk::MultiThreaderBase::SetGlobalMaximumNumberOfThreads(1);
  result &= itk::MultiThreaderBase::GetGlobalMaximumNumberOfThreads() == 1;
  result &= itk::MultiThreaderBase::GetGlobalDefaultNumberOfThreads() == 1;

  // Choose a number of threads.
  int numberOfThreads = 10;
  if (argc > 1)
  {
    const int nt = std::stoi(argv[1]);
    if (nt > 1)
    {
      numberOfThreads = nt;
    }
  }

  TEST_SINGLE_CLASS(PlatformMultiThreader);
  TEST_SINGLE_CLASS(PoolMultiThreader);
#ifdef ITK_USE_TBB
  TEST_SINGLE_CLASS(TBBMultiThreader);
#endif


  itk::MultiThreaderBase::SetGlobalMaximumNumberOfThreads(2);
  result &= VerifyRange(
    itk::MultiThreaderBase::GetGlobalMaximumNumberOfThreads(), 1, 2, "Range error in MaximumNumberOfThreads");
  itk::MultiThreaderBase::SetGlobalDefaultNumberOfThreads(4);
  result &= VerifyRange(
    itk::MultiThreaderBase::GetGlobalDefaultNumberOfThreads(), 1, 2, "Range error in DefaultNumberOfThreads");


  itk::MultiThreaderBase::SetGlobalDefaultNumberOfThreads(numberOfThreads);

  result &= SetAndVerify(-1);
  result &= SetAndVerify(0);
  result &= SetAndVerify(1);
  result &= SetAndVerify(2);
  result &= SetAndVerify(itk::ITK_MAX_THREADS);
  result &= SetAndVerify(itk::ITK_MAX_THREADS - 1);
  result &= SetAndVerify(itk::ITK_MAX_THREADS + 1);
  result &= SetAndVerify(itk::MultiThreaderBase::GetGlobalMaximumNumberOfThreads());
  result &= SetAndVerify(itk::MultiThreaderBase::GetGlobalMaximumNumberOfThreads() - 1);
  result &= SetAndVerify(itk::MultiThreaderBase::GetGlobalMaximumNumberOfThreads() + 1);

  // Test streaming enumeration for MultiThreaderBaseEnums::Threader elements
  const std::set<itk::MultiThreaderBaseEnums::Threader> allThreader{
    itk::MultiThreaderBaseEnums::Threader::Platform,
    //            itk::MultiThreaderBaseEnums::Threader::First,
    itk::MultiThreaderBaseEnums::Threader::Pool,
    itk::MultiThreaderBaseEnums::Threader::TBB,
    //            itk::MultiThreaderBaseEnums::Threader::Last,
    itk::MultiThreaderBaseEnums::Threader::Unknown
  };
  for (const auto & ee : allThreader)
  {
    std::cout << "STREAMED ENUM VALUE MultiThreaderBaseEnums::Threader: " << ee << std::endl;
  }

  // Test streaming enumeration for MultiThreaderBaseEnums::ThreadExitCode elements
  const std::set<itk::MultiThreaderBaseEnums::ThreadExitCode> allThreadExitCode{
    itk::MultiThreaderBaseEnums::ThreadExitCode::SUCCESS,
    itk::MultiThreaderBaseEnums::ThreadExitCode::ITK_EXCEPTION,
    itk::MultiThreaderBaseEnums::ThreadExitCode::ITK_PROCESS_ABORTED_EXCEPTION,
    itk::MultiThreaderBaseEnums::ThreadExitCode::STD_EXCEPTION,
    itk::MultiThreaderBaseEnums::ThreadExitCode::UNKNOWN
  };
  for (const auto & ee : allThreadExitCode)
  {
    std::cout << "STREAMED ENUM VALUE MultiThreaderBaseEnums::ThreadExitCode: " << ee << std::endl;
  }

  if (!result)
  {
    return EXIT_FAILURE;
  }
  return EXIT_SUCCESS;
}