aboutsummaryrefslogtreecommitdiffstats
path: root/library/cpp/lwtrace/probe.h
blob: 31fa282da3f7bc9ef4d0187fb0a966599f6c658d (plain) (blame)
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
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
#pragma once

#include "event.h"
#include "preprocessor.h"
#include "rwspinlock.h"
#include "shuttle.h"

#include <util/datetime/cputimer.h>
#include <util/generic/hide_ptr.h>
#include <util/generic/scope.h>
#include <util/system/atomic.h>

namespace NLWTrace {
    // Represents a chain (linked list) of steps for execution of a trace query block
    // NOTE: different executor objects are used on different probes (even for the same query block)
    class IExecutor {
    private:
        IExecutor* Next;

    public:
        IExecutor()
            : Next(nullptr)
        {
        }

        virtual ~IExecutor() {
            if (Next != nullptr) {
                delete Next;
            }
        }

        void Execute(TOrbit& orbit, const TParams& params) {
            if (DoExecute(orbit, params) && Next != nullptr) {
                Next->Execute(orbit, params);
            }
        }

        void SetNext(IExecutor* next) {
            Next = next;
        }

        IExecutor* GetNext() {
            return Next;
        }

        const IExecutor* GetNext() const {
            return Next;
        }

    protected:
        virtual bool DoExecute(TOrbit& orbit, const TParams& params) = 0;
    };

    // Common class for all probes
    struct TProbe {
        // Const configuration
        TEvent Event;

        // State that don't need any locking
        TAtomic ExecutorsCount;

        // State that must be accessed under lock
        TRWSpinLock Lock;
        IExecutor* Executors[LWTRACE_MAX_ACTIONS];
        IExecutor** Front; // Invalid if ExecutorsCount == 0
        IExecutor** Back;  // Invalid if ExecutorsCount == 0

        void Init() {
            ExecutorsCount = 0;
            Lock.Init();
            Zero(Executors);
            Front = nullptr;
            Back = nullptr;
        }

        IExecutor** First() {
            return Executors;
        }

        IExecutor** Last() {
            return Executors + LWTRACE_MAX_ACTIONS;
        }

        void Inc(IExecutor**& it) {
            it++;
            if (it == Last()) {
                it = First();
            }
        }

        intptr_t GetExecutorsCount() const {
            return AtomicGet(ExecutorsCount);
        }

        bool Attach(IExecutor* exec) {
            TWriteSpinLockGuard g(Lock);
            if (ExecutorsCount > 0) {
                for (IExecutor** it = Front;; Inc(it)) {
                    if (*it == nullptr) {
                        *it = exec;
                        AtomicIncrement(ExecutorsCount);
                        return true; // Inserted into free slot in [First; Last]
                    }
                    if (it == Back) {
                        break;
                    }
                }
                IExecutor** newBack = Back;
                Inc(newBack);
                if (newBack == Front) {
                    return false; // Buffer is full
                } else {
                    Back = newBack;
                    *Back = exec;
                    AtomicIncrement(ExecutorsCount);
                    return true; // Inserted after Last
                }
            } else {
                Front = Back = First();
                *Front = exec;
                AtomicIncrement(ExecutorsCount);
                return true; // Inserted as a first element
            }
        }

        bool Detach(IExecutor* exec) {
            TWriteSpinLockGuard g(Lock);
            for (IExecutor** it = First(); it != Last(); it++) {
                if ((*it) == exec) {
                    *it = nullptr;
                    AtomicDecrement(ExecutorsCount);
                    if (ExecutorsCount > 0) {
                        for (;; Inc(Front)) {
                            if (*Front != nullptr) {
                                break;
                            }
                            if (Front == Back) {
                                break;
                            }
                        }
                    }
                    return true;
                }
            }
            return false;
        }

        void RunExecutors(TOrbit& orbit, const TParams& params) {
            // Read lock is implied
            if (ExecutorsCount > 0) {
                for (IExecutor** it = Front;; Inc(it)) {
                    IExecutor* exec = *it;
                    if (exec) {
                        exec->Execute(orbit, params);
                    }
                    if (it == Back) {
                        break;
                    }
                }
            }
        }

        void RunShuttles(TOrbit& orbit, const TParams& params) {
            orbit.AddProbe(this, params);
        }
    };

#ifndef LWTRACE_DISABLE

    template <class T>
    inline void PreparePtr(const T& ref, const T*& ptr) {
        ptr = &ref;
    }

    template <>
    inline void PreparePtr<TNil>(const TNil&, const TNil*&) {
    }

#define LWTRACE_SCOPED_FUNCTION_PARAMS_I(i) (1) typename ::NLWTrace::TParamTraits<TP##i>::TFuncParam p##i = ERROR_not_enough_parameters() LWTRACE_COMMA
#define LWTRACE_SCOPED_FUNCTION_PARAMS LWTRACE_EXPAND(LWTRACE_EAT FOREACH_PARAMNUM(LWTRACE_SCOPED_FUNCTION_PARAMS_I)(0))
#define LWTRACE_SCOPED_FUNCTION_PARAMS_BY_REF_I(i) (1) typename ::NLWTrace::TParamTraits<TP##i>::TStoreType& p##i = *(ERROR_not_enough_parameters*)(HidePointerOrigin(nullptr))LWTRACE_COMMA
#define LWTRACE_SCOPED_FUNCTION_PARAMS_BY_REF LWTRACE_EXPAND(LWTRACE_EAT FOREACH_PARAMNUM(LWTRACE_SCOPED_FUNCTION_PARAMS_BY_REF_I)(0))
#define LWTRACE_SCOPED_PREPARE_PTRS_I(i) PreparePtr(p##i, P##i);
#define LWTRACE_SCOPED_PREPARE_PTRS()                   \
    do {                                                \
        FOREACH_PARAMNUM(LWTRACE_SCOPED_PREPARE_PTRS_I) \
    } while (false)
#define LWTRACE_SCOPED_PREPARE_PARAMS_I(i, params) params.Param[i].CopyConstruct<typename ::NLWTrace::TParamTraits<TP##i>::TStoreType>(*P##i);
#define LWTRACE_SCOPED_PREPARE_PARAMS(params)                     \
    do {                                                          \
        FOREACH_PARAMNUM(LWTRACE_SCOPED_PREPARE_PARAMS_I, params) \
    } while (false)

    template <LWTRACE_TEMPLATE_PARAMS>
    struct TUserProbe;

    template <LWTRACE_TEMPLATE_PARAMS>
    class TScopedDurationImpl {
    private:
        TUserProbe<LWTRACE_TEMPLATE_ARGS>* Probe;
        ui64 Started;
        TParams Params;

    public:
        explicit TScopedDurationImpl(TUserProbe<LWTRACE_TEMPLATE_ARGS>& probe, LWTRACE_SCOPED_FUNCTION_PARAMS) {
            if (probe.Probe.GetExecutorsCount() > 0) {
                Probe = &probe;
                LWTRACE_PREPARE_PARAMS(Params);
                Started = GetCycleCount();
            } else {
                Probe = nullptr;
            }
        }
        ~TScopedDurationImpl() {
            if (Probe) {
                if (Probe->Probe.GetExecutorsCount() > 0) {
                    TReadSpinLockGuard g(Probe->Probe.Lock);
                    if (Probe->Probe.GetExecutorsCount() > 0) {
                        ui64 duration = CyclesToDuration(GetCycleCount() - Started).MicroSeconds();
                        Params.Param[0].template CopyConstruct<typename TParamTraits<TP0>::TStoreType>(duration);
                        TOrbit orbit;
                        Probe->Probe.RunExecutors(orbit, Params);
                    }
                }
                TUserSignature<LWTRACE_TEMPLATE_ARGS>::DestroyParams(Params);
            }
        }
    };

    // Class representing a specific probe
    template <LWTRACE_TEMPLATE_PARAMS_NODEF>
    struct TUserProbe {
        TProbe Probe;

        inline void operator()(LWTRACE_FUNCTION_PARAMS) {
            TParams params;
            LWTRACE_PREPARE_PARAMS(params);
            Y_DEFER { TUserSignature<LWTRACE_TEMPLATE_ARGS>::DestroyParams(params); };

            TOrbit orbit;
            Probe.RunExecutors(orbit, params);
        }

        inline void Run(TOrbit& orbit, LWTRACE_FUNCTION_PARAMS) {
            TParams params;
            LWTRACE_PREPARE_PARAMS(params);
            Y_DEFER { TUserSignature<LWTRACE_TEMPLATE_ARGS>::DestroyParams(params); };

            Probe.RunExecutors(orbit, params);
            Probe.RunShuttles(orbit, params); // Executors can create shuttles
        }

        // Required to avoid running executors w/o lock
        inline void RunShuttles(TOrbit& orbit, LWTRACE_FUNCTION_PARAMS) {
            TParams params;
            LWTRACE_PREPARE_PARAMS(params);
            Probe.RunShuttles(orbit, params);
            TUserSignature<LWTRACE_TEMPLATE_ARGS>::DestroyParams(params);
        }

        typedef TScopedDurationImpl<LWTRACE_TEMPLATE_ARGS> TScopedDuration;
    };

#endif

}