1/*
2 * Copyright 2004-2008, Haiku Inc. All Rights Reserved.
3 * Distributed under the terms of the MIT License.
4 */
5#ifndef _FSSH_FS_CACHE_H
6#define _FSSH_FS_CACHE_H
7
8//! File System File and Block Caches
9
10
11#include "fssh_fs_interface.h"
12
13
14enum {
15	FSSH_TRANSACTION_WRITTEN	= 0x01,
16	FSSH_TRANSACTION_ABORTED	= 0x02,
17	FSSH_TRANSACTION_ENDED		= 0x04,
18	FSSH_TRANSACTION_IDLE		= 0x08
19};
20
21/* file map modes */
22enum {
23	FSSH_FILE_MAP_CACHE_ON_DEMAND	= 0x01,	/* default mode */
24	FSSH_FILE_MAP_CACHE_ALL			= 0x02
25};
26
27typedef void (*fssh_transaction_notification_hook)(int32_t id, int32_t event,
28	void *data);
29
30#ifdef __cplusplus
31extern "C" {
32#endif
33
34/* transactions */
35extern int32_t			fssh_cache_start_transaction(void *_cache);
36extern fssh_status_t	fssh_cache_sync_transaction(void *_cache, int32_t id);
37extern fssh_status_t	fssh_cache_end_transaction(void *_cache, int32_t id,
38							fssh_transaction_notification_hook hook,
39							void *data);
40extern fssh_status_t	fssh_cache_abort_transaction(void *_cache, int32_t id);
41extern int32_t			fssh_cache_detach_sub_transaction(void *_cache,
42							int32_t id, fssh_transaction_notification_hook hook,
43							void *data);
44extern fssh_status_t	fssh_cache_abort_sub_transaction(void *_cache,
45							int32_t id);
46extern fssh_status_t	fssh_cache_start_sub_transaction(void *_cache,
47							int32_t id);
48extern fssh_status_t	fssh_cache_add_transaction_listener(void *_cache,
49							int32_t id, int32_t events,
50							fssh_transaction_notification_hook hook,
51							void *data);
52extern fssh_status_t	fssh_cache_remove_transaction_listener(void *_cache,
53							int32_t id, fssh_transaction_notification_hook hook,
54							void *data);
55extern fssh_status_t	fssh_cache_next_block_in_transaction(void *_cache,
56							int32_t id, bool mainOnly, long *_cookie,
57							fssh_off_t *_blockNumber, void **_data,
58							void **_unchangedData);
59extern int32_t			fssh_cache_blocks_in_transaction(void *_cache,
60							int32_t id);
61extern int32_t			fssh_cache_blocks_in_main_transaction(void *_cache,
62							int32_t id);
63extern int32_t			fssh_cache_blocks_in_sub_transaction(void *_cache,
64							int32_t id);
65
66/* block cache */
67extern void				fssh_block_cache_delete(void *_cache, bool allowWrites);
68extern void *			fssh_block_cache_create(int fd, fssh_off_t numBlocks,
69							fssh_size_t blockSize, bool readOnly);
70extern fssh_status_t	fssh_block_cache_sync(void *_cache);
71extern fssh_status_t	fssh_block_cache_sync_etc(void *_cache,
72							fssh_off_t blockNumber, fssh_size_t numBlocks);
73extern void				fssh_block_cache_discard(void *_cache,
74							fssh_off_t blockNumber, fssh_size_t numBlocks);
75extern fssh_status_t	fssh_block_cache_make_writable(void *_cache,
76							fssh_off_t blockNumber, int32_t transaction);
77extern void *			fssh_block_cache_get_writable_etc(void *_cache,
78							fssh_off_t blockNumber, fssh_off_t base,
79							fssh_off_t length, int32_t transaction);
80extern void *			fssh_block_cache_get_writable(void *_cache,
81							fssh_off_t blockNumber, int32_t transaction);
82extern void *			fssh_block_cache_get_empty(void *_cache,
83							fssh_off_t blockNumber, int32_t transaction);
84extern const void *		fssh_block_cache_get_etc(void *_cache,
85							fssh_off_t blockNumber, fssh_off_t base,
86							fssh_off_t length);
87extern const void *		fssh_block_cache_get(void *_cache,
88							fssh_off_t blockNumber);
89extern fssh_status_t	fssh_block_cache_set_dirty(void *_cache,
90							fssh_off_t blockNumber, bool isDirty,
91							int32_t transaction);
92extern void				fssh_block_cache_put(void *_cache,
93							fssh_off_t blockNumber);
94
95/* file cache */
96extern void *			fssh_file_cache_create(fssh_mount_id mountID,
97							fssh_vnode_id vnodeID, fssh_off_t size);
98extern void				fssh_file_cache_delete(void *_cacheRef);
99extern void				fssh_file_cache_enable(void *_cacheRef);
100extern fssh_status_t	fssh_file_cache_disable(void *_cacheRef);
101extern bool				fssh_file_cache_is_enabled(void *_cacheRef);
102extern fssh_status_t	fssh_file_cache_set_size(void *_cacheRef,
103							fssh_off_t size);
104extern fssh_status_t	fssh_file_cache_sync(void *_cache);
105
106extern fssh_status_t	fssh_file_cache_read(void *_cacheRef, void *cookie,
107							fssh_off_t offset, void *bufferBase,
108							fssh_size_t *_size);
109extern fssh_status_t	fssh_file_cache_write(void *_cacheRef, void *cookie,
110							fssh_off_t offset, const void *buffer,
111							fssh_size_t *_size);
112
113/* file map */
114extern void *			fssh_file_map_create(fssh_mount_id mountID,
115							fssh_vnode_id vnodeID, fssh_off_t size);
116extern void				fssh_file_map_delete(void *_map);
117extern void				fssh_file_map_set_size(void *_map, fssh_off_t size);
118extern void				fssh_file_map_invalidate(void *_map, fssh_off_t offset,
119							fssh_off_t size);
120extern fssh_status_t	fssh_file_map_set_mode(void *_map, uint32_t mode);
121extern fssh_status_t	fssh_file_map_translate(void *_map, fssh_off_t offset,
122							fssh_size_t size, struct fssh_file_io_vec *vecs,
123							fssh_size_t *_count, fssh_size_t align);
124
125/* entry cache */
126extern fssh_status_t	fssh_entry_cache_add(fssh_dev_t mountID,
127							fssh_ino_t dirID, const char* name,
128							fssh_ino_t nodeID);
129extern fssh_status_t	fssh_entry_cache_remove(fssh_dev_t mountID,
130							fssh_ino_t dirID, const char* name);
131
132#ifdef __cplusplus
133}
134#endif
135
136#endif	/* _FSSH_FS_CACHE_H */
137