xref: /base/hiviewdfx/faultloggerd/tools/process_dump/dfx_ring_buffer_wrapper.h

/*
 * Copyright (c) 2021-2023 Huawei Device Co., Ltd.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef DFX_RING_BUFFER_WRAPPER_H
#define DFX_RING_BUFFER_WRAPPER_H

#include <cinttypes>
#include <condition_variable>
#include <memory>
#include <mutex>
#include <string>
#include "dfx_ring_buffer.h"
#include "nocopyable.h"

namespace OHOS {
namespace HiviewDFX {

#define BACK_TRACE_RING_BUFFER_SIZE (32 * 1024)

typedef int (*RingBufferWriteFunc) (int32_t fd, const char *buf, const int len);

class DfxRingBufferWrapper final {
public:
    static DfxRingBufferWrapper &GetInstance();
    ~DfxRingBufferWrapper() = default;

    void StartThread();
    void StopThread();

    void SetWriteBufFd(int32_t fd);
    void SetWriteFunc(RingBufferWriteFunc func);

    void AppendMsg(const std::string& msg);
    int AppendBuf(const char *format, ...);

    void AppendBaseInfo(const std::string& info);
    void PrintBaseInfo();
private:
    static void LoopPrintRingBuffer();
    static int DefaultWrite(int32_t fd, const char *buf, const int len);

    DfxRingBufferWrapper() = default;
    DISALLOW_COPY_AND_MOVE(DfxRingBufferWrapper);

    RingBufferWriteFunc writeFunc_ = nullptr;

    DfxRingBuffer<BACK_TRACE_RING_BUFFER_SIZE, std::string> ringBuffer_;
    int32_t fd_ = -1;
    volatile bool hasFinished_ = false;
    std::vector<std::string> crashBaseInfo_;

    static std::condition_variable printCV_;
    static std::mutex printMutex_;
};
} // namespace HiviewDFX
} // namespace OHOS

#endif  // DFX_PROCESSDUMP_H