aboutsummaryrefslogtreecommitdiffstats
path: root/library/cpp/lwtrace/control.h
blob: 478488e6530fadc97d642fc95cda5cec30572371 (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
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
#pragma once 
 
#include "custom_action.h"
#include "event.h"
#include "log.h"
#include "log_shuttle.h"
#include "probe.h"

#include <library/cpp/lwtrace/protos/lwtrace.pb.h>

#include <google/protobuf/repeated_field.h>

#include <util/generic/deque.h> 
#include <util/generic/hash.h> 
#include <util/generic/noncopyable.h> 
#include <util/generic/ptr.h> 
#include <util/generic/set.h> 
#include <util/generic/vector.h> 
 
namespace NLWTrace { 

    using TProbeMap = THashMap<std::pair<TString, TString>, TProbe*>;

    // Interface for probe ownership management 
    class IBox: public virtual TThrRefBase { 
    private: 
        bool Owns; 

    public: 
        explicit IBox(bool ownsProbe = false) 
            : Owns(ownsProbe) 
        {
        }
 
        bool OwnsProbe() { 
            return Owns; 
        } 
 
        virtual TProbe* GetProbe() = 0; 
    }; 
 
    using TBoxPtr = TIntrusivePtr<IBox>; 
 
    // Simple not-owning box, that just holds pointer to static/global probe (e.g. created by LWTRACE_DEFINE_PROVIDER) 
    class TStaticBox: public IBox { 
    private: 
        TProbe* Probe; 

    public: 
        explicit TStaticBox(TProbe* probe) 
            : IBox(false) 
            , Probe(probe) 
        {
        }
 
        TProbe* GetProbe() override { 
            return Probe; 
        } 
    }; 
 
    // Just a set of unique probes 
    // TODO[serxa]: get rid of different ProbeRegistries, use unique one (singleton) with auto registration 
    class TProbeRegistry: public TNonCopyable { 
    private: 
        TMutex Mutex; 
 
        // Probe* pointer uniquely identifies a probe and boxptr actually owns TProbe object (if required) 
        using TProbes = THashMap<TProbe*, TBoxPtr>; 
        TProbes Probes; 
 
        // Probe provider-name pairs must be unique, keep track of them 
        using TIds = TSet<std::pair<TString, TString>>; 
        TIds Ids; 
 
    public: 
        // Add probes from null-terminated array of probe pointers. Probe can be added multiple times. Thread-safe. 
        // Implies probes you pass will live forever (e.g. created by LWTRACE_DEFINE_PROVIDER) 
        void AddProbesList(TProbe** reg); 
 
        // Manage probes that are created/destructed dynamically 
        void AddProbe(const TBoxPtr& box); 
        void RemoveProbe(TProbe* probe); 
 
        // Helper class to make thread-safe iteration over probes 
        class TProbesAccessor { 
        private: 
            TGuard<TMutex> Guard; 
            TProbes& Probes; 
        public: 
            explicit TProbesAccessor(TProbeRegistry* registry) 
                : Guard(registry->Mutex) 
                , Probes(registry->Probes) 
            {} 
 
            explicit TProbesAccessor(TProbeRegistry& registry) 
                : TProbesAccessor(&registry) 
            {} 
 
            auto begin() { return Probes.begin(); } 
            auto end() { return Probes.end(); } 
        }; 
 
        friend class TProbesAccessor; 
 
    private: 
        void AddProbeNoLock(const TBoxPtr& box); 
        void RemoveProbeNoLock(TProbe* probe); 
    }; 
 
    // Represents a compiled trace query, holds executors attached to probes 
    class TSession: public TNonCopyable { 
    public: 
        typedef THashMap<TString, TAtomicBase> TTraceVariables; 
 
    private: 
        const TInstant StartTime; 
        const ui64 TraceIdx; 
        TProbeRegistry& Registry; 
        TDuration StoreDuration; 
        TDuration ReadDuration; 
        TCyclicLog CyclicLog; 
        TDurationLog DurationLog; 
        TCyclicDepot CyclicDepot; 
        TDurationDepot DurationDepot; 
        TAtomic LastTrackId; 
        TAtomic LastSpanId;
        typedef TVector<std::pair<TProbe*, IExecutor*>> TProbes; 
        TProbes Probes; 
        bool Attached; 
        NLWTrace::TQuery Query; 
        TTraceVariables TraceVariables; 
        TTraceResources TraceResources; 
        void InsertExecutor(TTraceVariables& traceVariables, 
                            size_t bi, const NLWTrace::TPredicate* pred, 
                            const google::protobuf::RepeatedPtrField<NLWTrace::TAction>& actions, 
                            TProbe* probe, const bool destructiveActionsAllowed, 
                            const TCustomActionFactory& customActionFactory); 
 
    private: 
        void Destroy(); 
 
    public: 
        TSession(ui64 traceIdx, 
               TProbeRegistry& registry, 
               const NLWTrace::TQuery& query, 
               const bool destructiveActionsAllowed, 
               const TCustomActionFactory& customActionFactory); 
        ~TSession(); 
        void Detach(); 
        size_t GetEventsCount() const; 
        size_t GetThreadsCount() const; 
        const NLWTrace::TQuery& GetQuery() const { 
            return Query; 
        } 
        TInstant GetStartTime() const { 
            return StartTime; 
        } 
        ui64 GetTraceIdx() const { 
            return TraceIdx; 
        } 
        TTraceResources& Resources() { 
            return TraceResources; 
        } 
        const TTraceResources& Resources() const { 
            return TraceResources; 
        } 
 
        template <class TReader> 
        void ReadThreads(TReader& r) const { 
            CyclicLog.ReadThreads(r); 
            DurationLog.ReadThreads(r); 
        } 
 
        template <class TReader> 
        void ReadItems(TReader& r) const { 
            CyclicLog.ReadItems(r); 
            DurationLog.ReadItems(GetCycleCount(), DurationToCycles(ReadDuration), r); 
        } 
 
        template <class TReader> 
        void ReadItems(ui64 now, ui64 duration, TReader& r) const { 
            CyclicLog.ReadItems(r); 
            DurationLog.ReadItems(now, duration, r); 
        } 
 
        template <class TReader> 
        void ReadDepotThreads(TReader& r) const { 
            CyclicDepot.ReadThreads(r); 
            DurationDepot.ReadThreads(r); 
        } 
 
        template <class TReader> 
        void ReadDepotItems(TReader& r) const { 
            CyclicDepot.ReadItems(r); 
            DurationDepot.ReadItems(GetCycleCount(), DurationToCycles(ReadDuration), r); 
        } 
 
        template <class TReader> 
        void ReadDepotItems(ui64 now, ui64 duration, TReader& r) const { 
            CyclicDepot.ReadItems(r); 
            DurationDepot.ReadItems(now, duration, r); 
        } 
        void ToProtobuf(TLogPb& pb) const; 
    }; 
 
    // Deserialization result.
    // Either IsSuccess is true or FailedEventNames contains event names
    // we were not able to deserialize.
    struct TTraceDeserializeStatus
    {
        bool IsSuccess = true;
        TVector<TString> FailedEventNames;

        void AddFailedEventName(const TString& name)
        {
            IsSuccess = false;
            FailedEventNames.emplace_back(name);
        }
    };

    // Just a registry of all active trace queries 
    // Facade for all interactions with probes/traces 
    class TManager: public TNonCopyable { 
    private: 
        TProbeRegistry& Registry; 
        TMutex Mtx; 
        ui64 LastTraceIdx = 1;
        typedef THashMap<TString, TSession*> TTraces; // traceId -> TSession 
        TTraces Traces; 
        bool DestructiveActionsAllowed; 
        TCustomActionFactory CustomActionFactory; 
        THolder<TRunLogShuttleActionExecutor<TCyclicDepot>> SerializingExecutor;
 
    public: 
        static constexpr ui64 RemoteTraceIdx = 0;

    public:
        TManager(TProbeRegistry& registry, bool allowDestructiveActions); 
        ~TManager(); 
        bool HasTrace(const TString& id) const; 
        const TSession* GetTrace(const TString& id) const; 
        void New(const TString& id, const NLWTrace::TQuery& query); 
        void Delete(const TString& id); 
        void Stop(const TString& id); 
 
        template <class TReader> 
        void ReadProbes(TReader& reader) const { 
            TProbeRegistry::TProbesAccessor probes(Registry); 
            for (auto& kv : probes) { 
                TProbe* probe = kv.first; 
                reader.Push(probe); 
            } 
        } 

        template <class TReader> 
        void ReadTraces(TReader& reader) const { 
            TGuard<TMutex> g(Mtx); 
            for (const auto& Trace : Traces) { 
                const TString& id = Trace.first; 
                const TSession* trace = Trace.second; 
                reader.Push(id, trace); 
            } 
        } 
 
        template <class TReader> 
        void ReadLog(const TString& id, TReader& reader) { 
            TGuard<TMutex> g(Mtx); 
            TTraces::iterator it = Traces.find(id); 
            if (it == Traces.end()) { 
                ythrow yexception() << "trace id '" << id << "' is not used"; 
            } else { 
                TSession* trace = it->second; 
                trace->ReadItems(reader); 
            } 
        } 
 
        template <class TReader> 
        void ReadLog(const TString& id, ui64 now, TReader& reader) { 
            TGuard<TMutex> g(Mtx); 
            TTraces::iterator it = Traces.find(id); 
            if (it == Traces.end()) { 
                ythrow yexception() << "trace id '" << id << "' is not used"; 
            } else { 
                TSession* trace = it->second; 
                trace->ReadItems(now, reader); 
            } 
        } 
 
        template <class TReader> 
        void ReadDepot(const TString& id, TReader& reader) { 
            TGuard<TMutex> g(Mtx); 
            TTraces::iterator it = Traces.find(id); 
            if (it == Traces.end()) { 
                ythrow yexception() << "trace id '" << id << "' is not used"; 
            } else { 
                TSession* trace = it->second; 
                trace->ReadDepotItems(reader); 
            } 
        } 
 
        template <class TReader> 
        void ReadDepot(const TString& id, ui64 now, TReader& reader) { 
            TGuard<TMutex> g(Mtx); 
            TTraces::iterator it = Traces.find(id); 
            if (it == Traces.end()) { 
                ythrow yexception() << "trace id '" << id << "' is not used"; 
            } else { 
                TSession* trace = it->second; 
                trace->ReadDepotItems(now, reader); 
            } 
        } 
 
        bool GetDestructiveActionsAllowed() { 
            return DestructiveActionsAllowed; 
        } 
 
        void RegisterCustomAction(const TString& name, const TCustomActionFactory::TCallback& callback) { 
            CustomActionFactory.Register(name, callback); 
        } 
 
        template <class T> 
        void RegisterCustomAction() { 
            CustomActionFactory.Register(T::GetActionName(), [=](TProbe* probe, const TCustomAction& action, TSession* trace) { 
                return new T(probe, action, trace); 
            }); 
        } 

        TProbeMap GetProbesMap();

        void CreateTraceRequest(TTraceRequest& msg, TOrbit& orbit);

        bool HandleTraceRequest(
            const TTraceRequest& msg,
            TOrbit& orbit);

        TTraceDeserializeStatus HandleTraceResponse(
            const TTraceResponse& msg,
            const TProbeMap& probesMap,
            TOrbit& orbit,
            i64 timeOffset = 0,
            double timeScale = 1);

        void CreateTraceResponse(
            TTraceResponse& msg,
            TOrbit& orbit);

        bool IsTraced(TOrbit& orbit) {
            return orbit.HasShuttle(TManager::RemoteTraceIdx);
        }
    }; 
}