/*
 * Copyright (c) Huawei Technologies Co., Ltd. 2021. All rights reserved.
 * 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 TRACE_FILE_HEADER_H
#define TRACE_FILE_HEADER_H

#include "plugin_module_api.h"

enum DataType {
    HIPROFILER_PROTOBUF_BIN = 0,
    HIPERF_DATA,
    STANDALONE_DATA = 1000,
};

struct TraceFileHeader {
    static constexpr uint32_t HEADER_SIZE = 1024; // 预留了一些空间，方便后续在头部添加字段
    static constexpr uint32_t SHA256_SIZE = 256 / 8;
    static constexpr uint64_t HEADER_MAGIC = 0x464F5250534F484FuLL;
    static constexpr uint32_t V_MAJOR = 0x0001;
    static constexpr uint32_t V_MAJOR_BITS = 16;
    static constexpr uint32_t V_MINOR = 0x0000;
    static constexpr uint32_t TRACE_VERSION = (V_MAJOR << V_MAJOR_BITS) | V_MINOR;

    struct HeaderData {
        uint64_t magic = HEADER_MAGIC;  // 魔数，用于区分离线文件
        uint64_t length = HEADER_SIZE;  // 总长度，可用于检验文件是否被截断；
        uint32_t version = TRACE_VERSION;
        uint32_t segments = 0; // 载荷数据中的段个数, 段个数为偶数，一个描述长度 L，一个描述接下来的数据 V
        uint8_t sha256[SHA256_SIZE] = {}; // 载荷数据 的 SHA256 ，用于校验 载荷数据是否完整；
        uint32_t dataType = DataType::HIPROFILER_PROTOBUF_BIN; // 存储数据类型
        uint64_t boottime = 0;
        uint64_t realtime = 0;
        uint64_t realtimeCoarse = 0;
        uint64_t monotonic = 0;
        uint64_t monotonicCoarse = 0;
        uint64_t monotonicRaw = 0;
        char standalonePluginName[PLUGIN_MODULE_NAME_MAX + 1] = "";
        char pluginVersion[PLUGIN_MODULE_VERSION_MAX + 1] = "";
        uint64_t durationNs = 0;
    } __attribute__((packed));
    HeaderData data_ = {};
    static_assert(sizeof(data_) < HEADER_SIZE, "The max length of the reserved header is 1024 bytes");
    uint8_t padding_[HEADER_SIZE - sizeof(data_)] = {};
};

#endif  // TRACE_FILE_HEADER_H