File.h

Go to the documentation of this file.

/*
 * Copyright 2022 HEAVY.AI, Inc.
 *
 * 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.
 */

#pragma once

#define DATA_FILE_EXT ".data"

#include <cstdint>
#include <cstdio>
#include <iostream>
#include <string>

#include "Shared/types.h"

namespace File_Namespace {

constexpr auto kLegacyDataFileExtension{".mapd"};

std::string get_data_file_path(const std::string& base_path,
                               int file_id,
                               size_t page_size);

std::string get_legacy_data_file_path(const std::string& new_data_file_path);

std::pair<FILE*, std::string> create(const std::string& basePath,
                                     const int fileId,
                                     const size_t pageSize,
                                     const size_t npages);

FILE* create(const std::string& fullPath, const size_t requestedFileSize);

FILE* open(int fileId);

FILE* open(const std::string& path);

void close(FILE* f);

bool removeFile(const std::string basePath, const std::string filename);

size_t read(FILE* f,
            const size_t offset,
            const size_t size,
            int8_t* buf,
            const std::string& file_path);

size_t write(FILE* f, const size_t offset, const size_t size, const int8_t* buf);

size_t append(FILE* f, const size_t size, const int8_t* buf);

size_t readPage(FILE* f,
                const size_t pageSize,
                const size_t pageNum,
                int8_t* buf,
                const std::string& file_path);

size_t writePage(FILE* f, const size_t pageSize, const size_t pageNum, int8_t* buf);

size_t appendPage(FILE* f, const size_t pageSize, int8_t* buf);

size_t fileSize(FILE* f);

void renameForDelete(const std::string directoryName);

}  // namespace File_Namespace