xref: /freebsd/contrib/llvm-project/compiler-rt/lib/xray/xray_basic_logging.h (revision 0b57cec536236d46e3dba9bd041533462f33dbb7)
1*0b57cec5SDimitry Andric //===-- xray_basic_logging.h ----------------------------------------------===//
2*0b57cec5SDimitry Andric //
3*0b57cec5SDimitry Andric // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4*0b57cec5SDimitry Andric // See https://llvm.org/LICENSE.txt for license information.
5*0b57cec5SDimitry Andric // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6*0b57cec5SDimitry Andric //
7*0b57cec5SDimitry Andric //===----------------------------------------------------------------------===//
8*0b57cec5SDimitry Andric //
9*0b57cec5SDimitry Andric // This file is a part of XRay, a function call tracing system.
10*0b57cec5SDimitry Andric //
11*0b57cec5SDimitry Andric //===----------------------------------------------------------------------===//
12*0b57cec5SDimitry Andric #ifndef XRAY_XRAY_INMEMORY_LOG_H
13*0b57cec5SDimitry Andric #define XRAY_XRAY_INMEMORY_LOG_H
14*0b57cec5SDimitry Andric 
15*0b57cec5SDimitry Andric #include "xray/xray_log_interface.h"
16*0b57cec5SDimitry Andric 
17*0b57cec5SDimitry Andric /// Basic (Naive) Mode
18*0b57cec5SDimitry Andric /// ==================
19*0b57cec5SDimitry Andric ///
20*0b57cec5SDimitry Andric /// This implementation hooks in through the XRay logging implementation
21*0b57cec5SDimitry Andric /// framework. The Basic Mode implementation will keep appending to a file as
22*0b57cec5SDimitry Andric /// soon as the thread-local buffers are full. It keeps minimal in-memory state
23*0b57cec5SDimitry Andric /// and does the minimum filtering required to keep log files smaller.
24*0b57cec5SDimitry Andric 
25*0b57cec5SDimitry Andric namespace __xray {
26*0b57cec5SDimitry Andric 
27*0b57cec5SDimitry Andric XRayLogInitStatus basicLoggingInit(size_t BufferSize, size_t BufferMax,
28*0b57cec5SDimitry Andric                                    void *Options, size_t OptionsSize);
29*0b57cec5SDimitry Andric XRayLogInitStatus basicLoggingFinalize();
30*0b57cec5SDimitry Andric 
31*0b57cec5SDimitry Andric void basicLoggingHandleArg0RealTSC(int32_t FuncId, XRayEntryType Entry);
32*0b57cec5SDimitry Andric void basicLoggingHandleArg0EmulateTSC(int32_t FuncId, XRayEntryType Entry);
33*0b57cec5SDimitry Andric void basicLoggingHandleArg1RealTSC(int32_t FuncId, XRayEntryType Entry,
34*0b57cec5SDimitry Andric                                    uint64_t Arg1);
35*0b57cec5SDimitry Andric void basicLoggingHandleArg1EmulateTSC(int32_t FuncId, XRayEntryType Entry,
36*0b57cec5SDimitry Andric                                       uint64_t Arg1);
37*0b57cec5SDimitry Andric XRayLogFlushStatus basicLoggingFlush();
38*0b57cec5SDimitry Andric XRayLogInitStatus basicLoggingReset();
39*0b57cec5SDimitry Andric 
40*0b57cec5SDimitry Andric } // namespace __xray
41*0b57cec5SDimitry Andric 
42*0b57cec5SDimitry Andric #endif // XRAY_XRAY_INMEMORY_LOG_H
43