mirror of
https://github.com/amadvance/snapraid.git
synced 2026-10-26 10:51:54 -04:00
89 lines
3 KiB
C
89 lines
3 KiB
C
// SPDX-License-Identifier: GPL-3.0-or-later
|
|
// Copyright (C) 2011 Andrea Mazzoleni
|
|
|
|
#ifndef __HANDLE_H
|
|
#define __HANDLE_H
|
|
|
|
#include "state.h"
|
|
#include "support.h"
|
|
#include "bw.h"
|
|
|
|
/****************************************************************************/
|
|
/* handle */
|
|
|
|
struct snapraid_handle {
|
|
char path[PATH_MAX]; /**< Path of the file. */
|
|
struct snapraid_disk* disk; /**< Disk of the file. */
|
|
struct snapraid_file* file; /**< File opened. When the file is closed, it's set to 0. */
|
|
int f; /**< Handle of the file. */
|
|
struct stat st; /**< Stat info of the opened file. */
|
|
struct advise_struct advise; /**< Advise information. */
|
|
|
|
/**
|
|
* High-water mark size of the written/retained data.
|
|
*
|
|
* High-water size does not indicate that data below this offset is valid;
|
|
* it only marks the physical boundary beyond which data is known to be invalid
|
|
* and can be discarded upon truncation. Data within the physical_reach_size may
|
|
* or may not be valid. Final verification is determined independently by
|
|
* block states and hashes.
|
|
*/
|
|
data_off_t physical_reach_size;
|
|
int created; /**< If the file was created, otherwise it was already existing. */
|
|
int is_unrecoverable; /**< If the open descriptor refers to the .unrecoverable path. */
|
|
int readonly_errno; /**< Non-zero if opened read-only as fallback. */
|
|
struct snapraid_bw* bw; /**< Context for bandwidth limiting. */
|
|
};
|
|
|
|
/**
|
|
* Create a file.
|
|
* The file is created if missing, and opened with write access.
|
|
* If the file is created, the handle->created is set.
|
|
* If a previous .unrecoverable file is opened, the handle->is_unrecoverable is set.
|
|
* The initial size of the file is stored in the file->st struct.
|
|
* If the file cannot be opened for write access, it's opened with read-only access.
|
|
* The read-only access works only if the file has already the correct size and doesn't need to be modified.
|
|
*/
|
|
int handle_create(struct snapraid_handle* handle, struct snapraid_file* file, int mode);
|
|
|
|
/**
|
|
* Truncate a file if required.
|
|
*/
|
|
int handle_truncate(struct snapraid_handle* handle, struct snapraid_file* file);
|
|
|
|
/**
|
|
* Open a file.
|
|
* The file is opened for reading.
|
|
*/
|
|
int handle_open(struct snapraid_handle* handle, struct snapraid_file* file, int mode, log_ptr* out_missing);
|
|
|
|
/**
|
|
* Close a file.
|
|
*/
|
|
int handle_close(struct snapraid_handle* handle);
|
|
|
|
/**
|
|
* Read a block from a file.
|
|
* If the read block is shorter, it's padded with 0.
|
|
*/
|
|
ssize_t handle_read(struct snapraid_handle* handle, block_off_t file_pos, unsigned char* block_buffer, unsigned block_size, log_ptr* out_missing);
|
|
|
|
/**
|
|
* Write a block to a file.
|
|
*/
|
|
int handle_write(struct snapraid_handle* handle, block_off_t file_pos, unsigned char* block_buffer, unsigned block_size);
|
|
|
|
/**
|
|
* Change the modification time of the file to the saved value.
|
|
*/
|
|
int handle_utime(struct snapraid_handle* handle);
|
|
|
|
/**
|
|
* Map the unsorted list of disk to an ordered vector.
|
|
* \param diskmax The size of the vector.
|
|
* \return The allocated vector of pointers.
|
|
*/
|
|
struct snapraid_handle* handle_mapping(struct snapraid_state* state, unsigned* diskmax);
|
|
|
|
#endif
|
|
|