blob: 9568866964cf201b039d6d717025fe821f318791 [file] [log] [blame]
Theodore Ts'o3839e651997-04-26 13:21:57 +00001/*
2 * io.h --- the I/O manager abstraction
3 *
Theodore Ts'o19c78dc1997-04-29 16:17:09 +00004 * Copyright (C) 1993, 1994, 1995, 1996 Theodore Ts'o.
5 *
6 * %Begin-Header%
7 * This file may be redistributed under the terms of the GNU Public
8 * License.
9 * %End-Header%
Theodore Ts'o3839e651997-04-26 13:21:57 +000010 */
11
Theodore Ts'o9abd2ce1998-02-16 22:00:37 +000012#ifndef _EXT2FS_EXT2_IO_H
13#define _EXT2FS_EXT2_IO_H
14
Theodore Ts'of3db3561997-04-26 13:34:30 +000015/*
16 * ext2_loff_t is defined here since unix_io.c needs it.
17 */
18#if defined(__GNUC__) || defined(HAS_LONG_LONG)
19typedef long long ext2_loff_t;
20#else
21typedef long ext2_loff_t;
22#endif
23
24/* llseek.c */
Theodore Ts'o1c27cac1997-08-14 17:20:42 +000025ext2_loff_t ext2fs_llseek (int, ext2_loff_t, int);
Theodore Ts'of3db3561997-04-26 13:34:30 +000026
Theodore Ts'o3839e651997-04-26 13:21:57 +000027typedef struct struct_io_manager *io_manager;
28typedef struct struct_io_channel *io_channel;
29
30struct struct_io_channel {
Theodore Ts'o3cb6c501997-08-11 20:29:22 +000031 errcode_t magic;
Theodore Ts'o3839e651997-04-26 13:21:57 +000032 io_manager manager;
33 char *name;
34 int block_size;
35 errcode_t (*read_error)(io_channel channel,
36 unsigned long block,
37 int count,
38 void *data,
39 size_t size,
40 int actual_bytes_read,
41 errcode_t error);
42 errcode_t (*write_error)(io_channel channel,
43 unsigned long block,
44 int count,
45 const void *data,
46 size_t size,
47 int actual_bytes_written,
48 errcode_t error);
Theodore Ts'oa29f4d31997-04-29 21:26:48 +000049 int refcount;
50 int reserved[15];
Theodore Ts'o3839e651997-04-26 13:21:57 +000051 void *private_data;
Theodore Ts'oe9affb71997-08-24 02:57:55 +000052 void *app_data;
Theodore Ts'o3839e651997-04-26 13:21:57 +000053};
54
55struct struct_io_manager {
Theodore Ts'o3cb6c501997-08-11 20:29:22 +000056 errcode_t magic;
Theodore Ts'o3839e651997-04-26 13:21:57 +000057 const char *name;
58 errcode_t (*open)(const char *name, int flags, io_channel *channel);
59 errcode_t (*close)(io_channel channel);
60 errcode_t (*set_blksize)(io_channel channel, int blksize);
61 errcode_t (*read_blk)(io_channel channel, unsigned long block,
62 int count, void *data);
63 errcode_t (*write_blk)(io_channel channel, unsigned long block,
64 int count, const void *data);
65 errcode_t (*flush)(io_channel channel);
Theodore Ts'of3db3561997-04-26 13:34:30 +000066 int reserved[16];
Theodore Ts'o3839e651997-04-26 13:21:57 +000067};
68
69#define IO_FLAG_RW 1
70
71/*
72 * Convenience functions....
73 */
74#define io_channel_close(c) ((c)->manager->close((c)))
75#define io_channel_set_blksize(c,s) ((c)->manager->set_blksize((c),s))
76#define io_channel_read_blk(c,b,n,d) ((c)->manager->read_blk((c),b,n,d))
77#define io_channel_write_blk(c,b,n,d) ((c)->manager->write_blk((c),b,n,d))
78#define io_channel_flush(c) ((c)->manager->flush((c)))
Theodore Ts'oa29f4d31997-04-29 21:26:48 +000079#define io_channel_bumpcount(c) ((c)->refcount++)
Theodore Ts'o3839e651997-04-26 13:21:57 +000080
Theodore Ts'o19c78dc1997-04-29 16:17:09 +000081/* unix_io.c */
Theodore Ts'o3839e651997-04-26 13:21:57 +000082extern io_manager unix_io_manager;
83
Theodore Ts'o19c78dc1997-04-29 16:17:09 +000084/* test_io.c */
85extern io_manager test_io_manager, test_io_backing_manager;
86extern void (*test_io_cb_read_blk)
87 (unsigned long block, int count, errcode_t err);
88extern void (*test_io_cb_write_blk)
89 (unsigned long block, int count, errcode_t err);
90extern void (*test_io_cb_set_blksize)
91 (int blksize, errcode_t err);
Theodore Ts'o9abd2ce1998-02-16 22:00:37 +000092
93#endif /* _EXT2FS_EXT2_IO_H */
94