OmniSciDB  fe05a0c208
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
File.h
Go to the documentation of this file.
1 /*
2  * Copyright 2017 MapD Technologies, Inc.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
23 #pragma once
24 
25 #define MAPD_FILE_EXT ".mapd"
26 
27 #include <cstdint>
28 #include <cstdio>
29 #include <iostream>
30 #include <string>
31 
32 #include "Shared/types.h"
33 
34 namespace File_Namespace {
35 
36 std::string get_data_file_path(const std::string& base_path,
37  int file_id,
38  size_t page_size);
39 
40 FILE* create(const std::string& basePath,
41  const int fileId,
42  const size_t pageSize,
43  const size_t npages);
44 
45 FILE* create(const std::string& fullPath, const size_t requestedFileSize);
46 
53 FILE* open(int fileId);
54 
55 FILE* open(const std::string& path);
56 
62 void close(FILE* f);
63 
71 bool removeFile(const std::string basePath, const std::string filename);
72 
83 size_t read(FILE* f, const size_t offset, const size_t size, int8_t* buf);
84 
95 size_t write(FILE* f, const size_t offset, const size_t size, const int8_t* buf);
96 
106 size_t append(FILE* f, const size_t size, const int8_t* buf);
107 
118 size_t readPage(FILE* f, const size_t pageSize, const size_t pageNum, int8_t* buf);
119 
130 size_t writePage(FILE* f, const size_t pageSize, const size_t pageNum, int8_t* buf);
131 
141 size_t appendPage(FILE* f, const size_t pageSize, int8_t* buf);
142 
148 size_t fileSize(FILE* f);
149 
154 void renameForDelete(const std::string directoryName);
155 
156 } // namespace File_Namespace
size_t appendPage(FILE *f, const size_t pageSize, int8_t *buf)
Appends a page from buf to the file.
Definition: File.cpp:198
std::string filename(char const *path)
Definition: Logger.cpp:62
size_t append(FILE *f, const size_t size, const int8_t *buf)
Appends the specified number of bytes to the end of the file f from buf.
Definition: File.cpp:159
size_t writePage(FILE *f, const size_t pageSize, const size_t pageNum, int8_t *buf)
Writes a page from buf to the file.
Definition: File.cpp:179
FILE * create(const std::string &basePath, const int fileId, const size_t pageSize, const size_t numPages)
Definition: File.cpp:49
size_t write(FILE *f, const size_t offset, const size_t size, const int8_t *buf)
Writes the specified number of bytes to the offset position in file f from buf.
Definition: File.cpp:141
size_t read(FILE *f, const size_t offset, const size_t size, int8_t *buf)
Reads the specified number of bytes from the offset position in file f into buf.
Definition: File.cpp:133
size_t readPage(FILE *f, const size_t pageSize, const size_t pageNum, int8_t *buf)
Reads the specified page from the file f into buf.
Definition: File.cpp:166
size_t fileSize(FILE *f)
Returns the size of the specified file.
Definition: File.cpp:206
FILE * open(int fileId)
Opens/creates the file with the given id; returns NULL on error.
Definition: File.cpp:98
void close(FILE *f)
Closes the file pointed to by the FILE pointer.
Definition: File.cpp:119
char * f
bool removeFile(const std::string basePath, const std::string filename)
Deletes the file pointed to by the FILE pointer.
Definition: File.cpp:125
std::string get_data_file_path(const std::string &base_path, int file_id, size_t page_size)
Definition: File.cpp:42
void renameForDelete(const std::string directoryName)
Renames a directory to DELETE_ME_&lt;EPOCH&gt;_&lt;oldname&gt;.
Definition: File.cpp:218