1*3cab2bb3Spatrick //===-- xray_fdr_logging.h ------------------------------------------------===//
2*3cab2bb3Spatrick //
3*3cab2bb3Spatrick // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4*3cab2bb3Spatrick // See https://llvm.org/LICENSE.txt for license information.
5*3cab2bb3Spatrick // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6*3cab2bb3Spatrick //
7*3cab2bb3Spatrick //===----------------------------------------------------------------------===//
8*3cab2bb3Spatrick //
9*3cab2bb3Spatrick // This file is a part of XRay, a function call tracing system.
10*3cab2bb3Spatrick //
11*3cab2bb3Spatrick //===----------------------------------------------------------------------===//
12*3cab2bb3Spatrick #ifndef XRAY_XRAY_FDR_LOGGING_H
13*3cab2bb3Spatrick #define XRAY_XRAY_FDR_LOGGING_H
14*3cab2bb3Spatrick 
15*3cab2bb3Spatrick #include "xray/xray_log_interface.h"
16*3cab2bb3Spatrick #include "xray_fdr_log_records.h"
17*3cab2bb3Spatrick 
18*3cab2bb3Spatrick // FDR (Flight Data Recorder) Mode
19*3cab2bb3Spatrick // ===============================
20*3cab2bb3Spatrick //
21*3cab2bb3Spatrick // The XRay whitepaper describes a mode of operation for function call trace
22*3cab2bb3Spatrick // logging that involves writing small records into an in-memory circular
23*3cab2bb3Spatrick // buffer, that then gets logged to disk on demand. To do this efficiently and
24*3cab2bb3Spatrick // capture as much data as we can, we use smaller records compared to the
25*3cab2bb3Spatrick // default mode of always writing fixed-size records.
26*3cab2bb3Spatrick 
27*3cab2bb3Spatrick namespace __xray {
28*3cab2bb3Spatrick XRayLogInitStatus fdrLoggingInit(size_t BufferSize, size_t BufferMax,
29*3cab2bb3Spatrick                                  void *Options, size_t OptionsSize);
30*3cab2bb3Spatrick XRayLogInitStatus fdrLoggingFinalize();
31*3cab2bb3Spatrick void fdrLoggingHandleArg0(int32_t FuncId, XRayEntryType Entry);
32*3cab2bb3Spatrick void fdrLoggingHandleArg1(int32_t FuncId, XRayEntryType Entry, uint64_t Arg1);
33*3cab2bb3Spatrick XRayLogFlushStatus fdrLoggingFlush();
34*3cab2bb3Spatrick XRayLogInitStatus fdrLoggingReset();
35*3cab2bb3Spatrick 
36*3cab2bb3Spatrick } // namespace __xray
37*3cab2bb3Spatrick 
38*3cab2bb3Spatrick #endif // XRAY_XRAY_FDR_LOGGING_H
39