Skip to content

Commit 93c073c

Browse files
daboehmedaboehme
committed
docs: Improve build option table
1 parent 47edbbb commit 93c073c

File tree

1 file changed

+83
-73
lines changed

1 file changed

+83
-73
lines changed

‎doc/sphinx/build.rst

+83-73
Original file line numberDiff line numberDiff line change
@@ -149,95 +149,105 @@ with the given Caliper and spack build options.
149149

150150
+----------------+---------------+---------------------------+--------------------+
151151
| CMake option | Spack option | Enabled features/recipes | Enabled services |
152-
+----------------+---------------+---------------------------+--------------------+
152+
+================+===============+===========================+====================+
153153
| WITH_ADIAK | +adiak | Import adiak metadata in | adiak_import, |
154154
| | | most config recipes | adiak_export |
155155
+----------------+---------------+---------------------------+--------------------+
156-
| WITH_MPI | +mpi | mpi-report recipe; | mpi, mpireport |
157-
| | | profile.mpi, | |
158-
| | | mpi.message.count, | |
159-
| | | mpi.message.size | |
160-
| | | recipe options; | |
161-
| | | Cross-process aggregation | |
162-
+----------------+---------------+---------------------------+--------------------+
163-
| WITH_PAPI | +papi | topdown.all, | papi, topdown |
164-
| | | topdown.toplevel, | |
165-
| | | topdown-counters.all, | |
166-
| | | topdown-counters.toplevel | |
167-
| | | recipe options for some | |
168-
| | | x86 systems; | |
169-
| | | PAPI counter collection | |
170-
+----------------+---------------+---------------------------+--------------------+
171-
| WITH_LIBDW | +libdw | source.module, | symbollookup |
172-
| | | source.function, | |
173-
| | | source.location recipe | |
174-
| | | options; | |
175-
| | | Symbol name lookup | |
156+
| WITH_MPI | +mpi | - mpi-report recipe | mpi, mpireport |
157+
| | | - profile.mpi, | |
158+
| | | mpi.message.count, | |
159+
| | | mpi.message.size | |
160+
| | | recipe options | |
161+
| | | - Cross-process | |
162+
| | | aggregation | |
163+
+----------------+---------------+---------------------------+--------------------+
164+
| WITH_PAPI | +papi | - topdown.all, | papi, topdown |
165+
| | | topdown.toplevel, | |
166+
| | | topdown-counters.* | |
167+
| | | recipe options for some | |
168+
| | | x86 systems | |
169+
| | | - PAPI counter collection | |
170+
+----------------+---------------+---------------------------+--------------------+
171+
| WITH_LIBDW | +libdw | - source.module, | symbollookup |
172+
| | | source.function, | |
173+
| | | source.location | |
174+
| | | recipe options | |
175+
| | | - Symbol name lookup | |
176176
+----------------+---------------+---------------------------+--------------------+
177177
| WITH_LIBPFM | +libpfm | PerfEvent counter | libpfm |
178178
| | | collection and precise | |
179179
| | | event sampling | |
180180
+----------------+---------------+---------------------------+--------------------+
181-
| WITH_LIBUNWIND | +libunwind | callpath option for | callpath |
182-
| | | sample-report and | |
183-
| | | event-trace recipes (also | |
184-
| | | requires libdw); | |
185-
| | | Stack unwinding | |
186-
+----------------+---------------+---------------------------+--------------------+
187-
| WITH_SAMPLER | +sampler | sample-report, | sampler |
188-
| | | hatchet-sample-profile | |
189-
| | | recipes; sampling option | |
190-
| | | for event-trace | |
191-
+----------------+---------------+---------------------------+--------------------+
192-
| WITH_CUPTI | +cuda | cuda-activity-report, | cupti, cuptitrace |
193-
| | | cuda-activity-profile | |
194-
| | | recipes; profile.cuda, | |
195-
| | | cuda.gputime, | |
196-
| | | cuda.memcpy recipe | |
197-
| | | options | |
181+
| WITH_LIBUNWIND | +libunwind | - callpath option for | callpath |
182+
| | | sample-report and | |
183+
| | | event-trace recipes | |
184+
| | | (requires libdw) | |
185+
| | | - Call stack unwinding | |
186+
+----------------+---------------+---------------------------+--------------------+
187+
| WITH_SAMPLER | +sampler | - sample-report, | sampler |
188+
| | | hatchet-sample-profile | |
189+
| | | recipes | |
190+
| | | - sampling option for | |
191+
| | | event-trace recipe | |
192+
| | | - Linux sampling support | |
193+
+----------------+---------------+---------------------------+--------------------+
194+
| WITH_CUPTI | +cuda | - cuda-activity-report | cupti, cuptitrace |
195+
| | | cuda-activity-profile | |
196+
| | | recipes | |
197+
| | | - profile.cuda, | |
198+
| | | cuda.gputime, | |
199+
| | | cuda.memcpy recipe | |
200+
| | | options | |
201+
| | | - CUDA API profiling | |
202+
| | | - CUDA activity tracing | |
198203
+----------------+ +---------------------------+--------------------+
199-
| WITH_NVTX | | nvtx recipe; | nvtx |
200-
| | | Caliper-to-NVTX region | |
201-
| | | forwarding | |
202-
+----------------+---------------+---------------------------+--------------------+
203-
| WITH_ROCTRACER | +rocm | rocm-activity-report, | roctracer |
204-
| | | rocm-activity-profile | |
205-
| | | recipes; profile.hip, | |
206-
| | | rocm.gputime, | |
207-
| | | rocm.memcpy options | |
204+
| WITH_NVTX | | - nvtx recipe | nvtx |
205+
| | | - Caliper-to-NVTX region | |
206+
| | | forwarding | |
207+
+----------------+---------------+---------------------------+--------------------+
208+
| WITH_ROCTRACER | +rocm | - rocm-activity-report, | roctracer |
209+
| | | rocm-activity-profile | |
210+
| | | recipes | |
211+
| | | - profile.hip | |
212+
| | | rocm.gputime, | |
213+
| | | rocm.memcpy recipe | |
214+
| | | options | |
215+
| | | - ROCm/HIP API profiling | |
216+
| | | - ROCm activity tracing | |
208217
+----------------+ +---------------------------+--------------------+
209-
| WITH_ROCTX | | roctx recipe; | roctx |
210-
| | | Caliper-to-ROCTX region | |
211-
| | | forwarding | |
212-
+----------------+---------------+---------------------------+--------------------+
213-
| WITH_OMPT | not available | openmp-report recipe; | ompt |
214-
| | yet | openmp.times, | |
215-
| | | openmp.threads, | |
216-
| | | openmp.efficiency recipe | |
217-
| | | options; | |
218-
| | | OpenMP tool interface | |
219-
| | | support (CPU only, no | |
220-
| | | target offload) | |
221-
+----------------+---------------+---------------------------+--------------------+
222-
| WITH_GOTCHA | +gotcha | io.bytes.*, | io, pthread, |
223-
| | | io.*.bandwidth, | sysalloc |
224-
| | | mem.highwatermark, | |
225-
| | | main_thread_only options; | |
226-
| | | Use Gotcha | |
227-
| | | for MPI function wrapping | |
228-
| | | instead of PMPI | |
218+
| WITH_ROCTX | | - roctx recipe | roctx |
219+
| | | - Caliper-to-ROCTX region | |
220+
| | | forwarding | |
221+
+----------------+---------------+---------------------------+--------------------+
222+
| WITH_OMPT | not available | - openmp-report recipe | ompt |
223+
| | yet | - openmp.times, | |
224+
| | | openmp.threads, | |
225+
| | | openmp.efficiency | |
226+
| | | recipe options | |
227+
| | | - OpenMP tools interface | |
228+
| | | support (CPU only, no | |
229+
| | | target offload) | |
230+
+----------------+---------------+---------------------------+--------------------+
231+
| WITH_GOTCHA | +gotcha | - io.bytes.*, | io, pthread, |
232+
| | | io.*.bandwidth, | sysalloc |
233+
| | | mem.highwatermark, | |
234+
| | | main_thread_only | |
235+
| | | recipe options | |
236+
| | | - Use Gotcha for MPI | |
237+
| | | MPI function wrapping | |
238+
| | | instead of PMPI | |
229239
+----------------+---------------+---------------------------+--------------------+
230240
| WITH_UMPIRE | not available | umpire.totals, | umpire |
231241
| | yet | umpire.allocators options | |
232242
+----------------+---------------+---------------------------+--------------------+
233243
| WITH_VARIORUM | +variorum | Read variorum counters | variorum |
234244
+----------------+---------------+---------------------------+--------------------+
235-
| WITH_PCP | not available | mem.*.bandwidth, | pcp, pcp.memory |
236-
| | yet | mem.*.bytes recipe | |
237-
| | | options on some LLNL LC | |
238-
| | | systems; | |
239-
| | | Read Performance CoPilot | |
240-
| | | counters | |
245+
| WITH_PCP | not available | - mem.*.bandwidth, | pcp, pcp.memory |
246+
| | yet | mem.*.bytes recipe | |
247+
| | | options on some LLNL | |
248+
| | | LC systems | |
249+
| | | - Read Performance | |
250+
| | | CoPilot counters | |
241251
+----------------+---------------+---------------------------+--------------------+
242252
| WITH_VTUNE | not available | Intel ITT API annotation | vtune |
243253
| | yet | forwarding | |

0 commit comments

Comments
 (0)