Project
Loading...
Searching...
No Matches
Cursor.h
Go to the documentation of this file.
1// Copyright 2019-2026 CERN and copyright holders of ALICE O2.
2// See https://alice-o2.web.cern.ch/copyright for details of the copyright holders.
3// All rights not expressly granted are reserved.
4//
5// This software is distributed under the terms of the GNU General Public
6// License v3 (GPL Version 3), copied verbatim in the file "COPYING".
7//
8// In applying this license CERN does not waive the privileges and immunities
9// granted to it by virtue of its status as an Intergovernmental Organization
10// or submit itself to any jurisdiction.
11
12#ifndef O2_FRAMEWORK_AODNATIVE_CURSOR_H_
13#define O2_FRAMEWORK_AODNATIVE_CURSOR_H_
14
15#include "AODNative/Errors.h"
16#include "Endian.h"
17#include <bit>
18#include <cstdint>
19#include <cstring>
20#include <span>
21#include <string>
22
23namespace o2::aod::native
24{
25
31class Cursor
32{
33 public:
34 Cursor(std::span<const uint8_t> buf, std::string const& file, uint64_t fileOffset = 0, int64_t origin = 0)
35 : mBuf(buf), mFile(file), mFileOffset(fileOffset), mOrigin(origin)
36 {
37 }
38
39 size_t pos() const { return mPos; }
40 int64_t displacement() const { return (int64_t)mPos + mOrigin; }
41 size_t remaining() const { return mBuf.size() - mPos; }
42 std::span<const uint8_t> buffer() const { return mBuf; }
43
44 void seek(size_t p)
45 {
46 if (p > mBuf.size()) {
47 fail("seek past the end of the buffer");
48 }
49 mPos = p;
50 }
51 void skip(size_t n) { seek(need(n) + n); }
52 void back(size_t n)
53 {
54 if (n > mPos) {
55 fail("seek before the start of the buffer");
56 }
57 mPos -= n;
58 }
59
60 std::span<const uint8_t> bytes(size_t n)
61 {
62 auto p = need(n);
63 mPos += n;
64 return mBuf.subspan(p, n);
65 }
66
67 uint8_t u8() { return bytes(1)[0]; }
68 uint16_t u16() { return load<uint16_t>(); }
69 uint32_t u32() { return load<uint32_t>(); }
70 uint64_t u64() { return load<uint64_t>(); }
71 int16_t i16() { return (int16_t)u16(); }
72 int32_t i32() { return (int32_t)u32(); }
73 int64_t i64() { return (int64_t)u64(); }
74 double f64() { return std::bit_cast<double>(u64()); }
75
77 std::string string()
78 {
79 uint32_t n = u8();
80 if (n == 255) {
81 n = u32();
82 }
83 auto b = bytes(n);
84 return {(char const*)b.data(), b.size()};
85 }
86
88 std::string cstring()
89 {
90 auto start = mPos;
91 while (u8() != 0) {
92 }
93 return {(char const*)mBuf.data() + start, mPos - start - 1};
94 }
95
96 [[noreturn]] void fail(std::string const& what) const
97 {
98 throw CorruptData(mFile, mFileOffset + mPos, what);
99 }
100
101 std::string const& file() const { return mFile; }
102
103 private:
104 size_t need(size_t n) const
105 {
106 if (n > mBuf.size() - mPos) {
107 fail("read of " + std::to_string(n) + " bytes past the end of a " + std::to_string(mBuf.size()) + " byte buffer");
108 }
109 return mPos;
110 }
111
112 template <typename T>
113 T load()
114 {
115 T v;
116 std::memcpy(&v, bytes(sizeof(T)).data(), sizeof(T));
117 if constexpr (std::endian::native == std::endian::little) {
118 v = bswap(v);
119 }
120 return v;
121 }
122
123 std::span<const uint8_t> mBuf;
124 std::string const& mFile;
125 uint64_t mFileOffset;
126 int64_t mOrigin;
127 size_t mPos = 0;
128};
129
140
145{
146 auto start = c.pos();
148 h.nbytes = c.u32();
149 bool big = c.i16() > 1000;
150 h.objlen = c.u32();
151 c.u32(); // fDatime
152 h.keylen = c.u16();
153 c.u16(); // fCycle
154 c.skip(big ? 16 : 8); // fSeekKey, fSeekPdir
155 c.string(); // fClassName
156 c.string(); // fName
157 c.string(); // fTitle
158 h.version = c.u16();
159 c.i32(); // fBufferSize
160 if (c.i32() < 0) {
161 c.u8(); // fIOBits
162 }
163 h.nevbuf = c.i32();
164 h.last = c.i32();
165 h.flag = c.u8();
166 if (c.pos() != start + h.keylen) {
167 c.fail("TBasket key of " + std::to_string(c.pos() - start) + " bytes, but fKeylen is " + std::to_string(h.keylen));
168 }
169 return h;
170}
171
172} // namespace o2::aod::native
173
174#endif // O2_FRAMEWORK_AODNATIVE_CURSOR_H_
unsigned short int uint16_t
Timeframe settings Average distance in cm of events merged into Randomize distance around average distance of merged events Simulate correct bunch interactions instead of placing only the average number of events A value[n] sets TFlen for[n] collisions in Number of bunches per trainsort Number of bunch trains Instantaneous interaction rate Do not simulate border Total number of collisions to be placed in the interior of all time Do not select random but walk over array of events in stride steps h Event generator settings h configStandalone Use CPU for GPU Force usage of the specified GPU device no CPU fallback Continue processing after an error First event to Number of events to Number of iterations to Number of iterations to Number of initial iterations excluded from const char Directory with events to Events directory is and not inside events Show standalone event Run event generator maximum time bin of continuous for triggered for automatic continuous for automatic continuous triggered uint64_t
configStandalone Reconstruction rec_tpc multiplier for the combined cluster track error during track following area in cm for the search of for z only used if decrease removal by when above this local occupancy rowx Shift of TPC revert cluster flag edge bit distance to edge exceeds this ZOffset for secondary multiple of radius max P of electron K BB bands crossing max P of electron p BB bands crossing max P of electron d BB bands crossing max P of electron t BB bands crossing min accepted dEdxMaxTPC of the track Additive extra cluster error for Y2 if edge flag set Additive extra cluster error for Y2 if single set Additive extra cluster error for Y2 if or single set Additive extra cluster error for Z2 if or single set Extra errors to add to track when crossing depending on addErrorsCECrossing Inner portion of y range in sector that is not used in searching for extrapolated track candidates factor2YS for track merging factor2K for track merging Margin in cm of Y position when rejecting edge clusters based on uncorrected track Y Max fraction of shared clusters for tracklet Except pad from cluster finding if total number of charges in a fragment is above this Except pad from cluster finding if number of consecutive charges in a fragment is above this Threshold where a timebin is considered disabling the noisy pad check for that pad Treat signal above this minimum as saturated Smoothing factor for the exponential Highly Ionising Particle tail filter Number of timebins to use for the averaging Add additional custom track errors when crossing relative as fraction of Do N fit passes in final fit of< 0:reject at max -n hits") AddOptionRTC(rejectIFCLowRadiusCluster, uint8_t, 1, "", 0, "Reject clusters that get the IFC mask error during refit") AddOptionRTC(dEdxTruncLow, uint8_t, 2, "", 0, "Low truncation threshold, fraction of 128") AddOptionRTC(dEdxTruncHigh, uint8_t, 77, "", 0, "High truncation threshold, fraction of 128") AddOptionRTC(extrapolationTracking, int8_t, 1, "", 0, "Enable Extrapolation Tracking(prolong tracks to adjacent sectors to find short segments)") AddOptionRTC(disableRefitAttachment, uint8_t, 0, "", 0, "Bitmask to disable certain attachment steps during refit(1:attachment, 2:propagation, 4:loop following, 8:mirroring)") AddOptionRTC(rejectionStrategy, uint8_t, o2::gpu::GPUSettings::RejectionStrategyA, "", 0, "Enable rejection of TPC clusters for compression(0=no, 1=strategy A, 2=strategy B)") AddOptionRTC(mergeLoopersAfterburner, uint8_t, 1, "", 0, "Run afterburner for additional looper merging") AddOptionRTC(compressionTypeMask, uint8_t, o2::gpu::GPUSettings::CompressionFull, "", 0, "TPC Compression mode bits(1=truncate charge/width LSB, 2=differences, 4=track-model)") AddOptionRTC(compressionSortOrder, uint8_t, o2::gpu::GPUSettings::SortTime, "", 0, "Sort order of TPC compression(0=time, 1=pad, 2=Z-time-pad, 3=Z-pad-time, 4=no sorting(use incoming order))") AddOptionRTC(sigBitsCharge, uint8_t, 4, "", 0, "Number of significant bits for TPC cluster charge in compression mode 1") AddOptionRTC(sigBitsWidth, uint8_t, 3, "", 0, "Number of significant bits for TPC cluster width in compression mode 1") AddOptionRTC(dropLoopers, uint8_t, 0, "", 0, "Drop looping tracks starting from second loop") AddOptionRTC(mergerInterpolateErrors, uint8_t, 1, "", 0, "Use interpolation instead of extrapolation for chi2 based cluster rejection") AddOptionRTC(mergerInterpolateRejectAlsoOnCurrentPosition, uint8_t, 1, "", 0, "When using mergerInterpolateErrors, reject based on chi2 twice computed with interpolated and current track position starting from NDF > mergerNonInterpolateRejectMinNDF Merge tracks accross the central electrode Enable PID response Add sub threshold clusters in TPC dEdx computation OR mask of TPC flags that will reject the cluster in alternative dEdx Reject edge clusters based on uncorrected track Y during track fit Increase decrease removal by when on this number of pads from the edge h configStandalone Reconstruction rec_trd Max chi2 for TRD tracklets to be matched to a track Chi2 cut for strict matching mode Number of sigmas for ITS TPC track time error estimate Addition to search road around track prolongation along Y in cm Optimal tracklet rphi resolution in maximum chi2 per attached tracklet for TRD tracks take into account the full likelihood of the slope including exponential tails Tracks with less attached tracklets are discarded after the tracking Post trigger Pile up integration time in BCs fits all iterations but the last one in projections Use material lookup table for TPC refit Apply workarounds to avoid cyclic merge should not be needed tpc dyn configStandalone Processing proc_rtc Replace constant variables static by constexpr expressions Compile RTC in deterministic with NO_FAST_MATH flags and GPUCA_DETERMINISTIC_MODE define Use RTC to optimize GPU code h configStandalone Processing proc_rtctech Use a file lock to serialize access to the cache folder int32_t
uint32_t c
Definition RawData.h:2
size_t bytes
Class for time synchronization of RawReader instances.
std::span< const uint8_t > buffer() const
Definition Cursor.h:42
void back(size_t n)
Definition Cursor.h:52
std::span< const uint8_t > bytes(size_t n)
Definition Cursor.h:60
std::string const & file() const
Definition Cursor.h:101
size_t remaining() const
Definition Cursor.h:41
size_t pos() const
Definition Cursor.h:39
int64_t displacement() const
Definition Cursor.h:40
std::string string()
TString: 1-byte length, or 0xFF followed by a 4-byte length.
Definition Cursor.h:77
void fail(std::string const &what) const
Definition Cursor.h:96
Cursor(std::span< const uint8_t > buf, std::string const &file, uint64_t fileOffset=0, int64_t origin=0)
Definition Cursor.h:34
std::string cstring()
NUL-terminated string, as used for class names after kNewClassTag.
Definition Cursor.h:88
void seek(size_t p)
Definition Cursor.h:44
void skip(size_t n)
Definition Cursor.h:51
GLdouble n
Definition glcorearb.h:1982
const GLdouble * v
Definition glcorearb.h:832
GLboolean GLboolean GLboolean b
Definition glcorearb.h:1233
GLuint start
Definition glcorearb.h:469
GLenum GLuint GLenum GLsizei const GLchar * buf
Definition glcorearb.h:2514
BasketHeader readBasketHeader(Cursor &c)
Definition Cursor.h:144
constexpr T bswap(T v)
Definition Endian.h:22
consteval header::DataOrigin origin()
Definition ASoA.h:376
std::string to_string(gsl::span< T, Size > span)
Definition common.h:52
The key and header of a TBasket.
Definition Cursor.h:131