root/tools/perf/util/data.h
/* SPDX-License-Identifier: GPL-2.0 */
#ifndef __PERF_DATA_H
#define __PERF_DATA_H

#include <stdio.h>
#include <stdbool.h>
#include <unistd.h>
#include <linux/types.h>

enum perf_data_mode {
        PERF_DATA_MODE_WRITE,
        PERF_DATA_MODE_READ,
};

enum perf_dir_version {
        PERF_DIR_SINGLE_FILE    = 0,
        PERF_DIR_VERSION        = 1,
};

struct perf_data_file {
        char            *path;
        union {
                int      fd;
                FILE    *fptr;
        };
        unsigned long    size;
};

struct perf_data {
        const char              *path;
        struct perf_data_file    file;
        bool                     is_pipe;
        bool                     is_dir;
        bool                     force;
        bool                     use_stdio;
        bool                     in_place_update;
        enum perf_data_mode      mode;

        struct {
                u64                      version;
                struct perf_data_file   *files;
                int                      nr;
        } dir;
};

static inline bool perf_data__is_read(struct perf_data *data)
{
        return data->mode == PERF_DATA_MODE_READ;
}

static inline bool perf_data__is_write(struct perf_data *data)
{
        return data->mode == PERF_DATA_MODE_WRITE;
}

static inline int perf_data__is_pipe(struct perf_data *data)
{
        return data->is_pipe;
}

static inline bool perf_data__is_dir(struct perf_data *data)
{
        return data->is_dir;
}

static inline bool perf_data__is_single_file(struct perf_data *data)
{
        return data->dir.version == PERF_DIR_SINGLE_FILE;
}

static inline int perf_data__fd(struct perf_data *data)
{
        if (data->use_stdio)
                return fileno(data->file.fptr);

        return data->file.fd;
}

int perf_data__open(struct perf_data *data);
void perf_data__close(struct perf_data *data);
ssize_t perf_data__read(struct perf_data *data, void *buf, size_t size);
ssize_t perf_data__write(struct perf_data *data,
                         void *buf, size_t size);
ssize_t perf_data_file__write(struct perf_data_file *file,
                              void *buf, size_t size);
/*
 * If at_exit is set, only rename current perf.data to
 * perf.data.<postfix>, continue write on original data.
 * Set at_exit when flushing the last output.
 *
 * Return value is fd of new output.
 */
int perf_data__switch(struct perf_data *data,
                      const char *postfix,
                      size_t pos, bool at_exit, char **new_filepath);

int perf_data__create_dir(struct perf_data *data, int nr);
int perf_data__open_dir(struct perf_data *data);
void perf_data__close_dir(struct perf_data *data);
unsigned long perf_data__size(struct perf_data *data);
int perf_data__make_kcore_dir(struct perf_data *data, char *buf, size_t buf_sz);
bool has_kcore_dir(const char *path);
char *perf_data__kallsyms_name(struct perf_data *data);
char *perf_data__guest_kallsyms_name(struct perf_data *data, pid_t machine_pid);
bool is_perf_data(const char *path);
#endif /* __PERF_DATA_H */