blob: d20ebf0189a7f4dccacb689312c57435335965c9 [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'of3db3561997-04-26 13:34:30 +000012/*
13 * ext2_loff_t is defined here since unix_io.c needs it.
14 */
15#if defined(__GNUC__) || defined(HAS_LONG_LONG)
16typedef long long ext2_loff_t;
17#else
18typedef long ext2_loff_t;
19#endif
20
21/* llseek.c */
Theodore Ts'o1c27cac1997-08-14 17:20:42 +000022ext2_loff_t ext2fs_llseek (int, ext2_loff_t, int);
Theodore Ts'of3db3561997-04-26 13:34:30 +000023
Theodore Ts'o3839e651997-04-26 13:21:57 +000024typedef struct struct_io_manager *io_manager;
25typedef struct struct_io_channel *io_channel;
26
27struct struct_io_channel {
Theodore Ts'o3cb6c501997-08-11 20:29:22 +000028 errcode_t magic;
Theodore Ts'o3839e651997-04-26 13:21:57 +000029 io_manager manager;
30 char *name;
31 int block_size;
32 errcode_t (*read_error)(io_channel channel,
33 unsigned long block,
34 int count,
35 void *data,
36 size_t size,
37 int actual_bytes_read,
38 errcode_t error);
39 errcode_t (*write_error)(io_channel channel,
40 unsigned long block,
41 int count,
42 const void *data,
43 size_t size,
44 int actual_bytes_written,
45 errcode_t error);
Theodore Ts'oa29f4d31997-04-29 21:26:48 +000046 int refcount;
47 int reserved[15];
Theodore Ts'o3839e651997-04-26 13:21:57 +000048 void *private_data;
Theodore Ts'oe9affb71997-08-24 02:57:55 +000049 void *app_data;
Theodore Ts'o3839e651997-04-26 13:21:57 +000050};
51
52struct struct_io_manager {
Theodore Ts'o3cb6c501997-08-11 20:29:22 +000053 errcode_t magic;
Theodore Ts'o3839e651997-04-26 13:21:57 +000054 const char *name;
55 errcode_t (*open)(const char *name, int flags, io_channel *channel);
56 errcode_t (*close)(io_channel channel);
57 errcode_t (*set_blksize)(io_channel channel, int blksize);
58 errcode_t (*read_blk)(io_channel channel, unsigned long block,
59 int count, void *data);
60 errcode_t (*write_blk)(io_channel channel, unsigned long block,
61 int count, const void *data);
62 errcode_t (*flush)(io_channel channel);
Theodore Ts'of3db3561997-04-26 13:34:30 +000063 int reserved[16];
Theodore Ts'o3839e651997-04-26 13:21:57 +000064};
65
66#define IO_FLAG_RW 1
67
68/*
69 * Convenience functions....
70 */
71#define io_channel_close(c) ((c)->manager->close((c)))
72#define io_channel_set_blksize(c,s) ((c)->manager->set_blksize((c),s))
73#define io_channel_read_blk(c,b,n,d) ((c)->manager->read_blk((c),b,n,d))
74#define io_channel_write_blk(c,b,n,d) ((c)->manager->write_blk((c),b,n,d))
75#define io_channel_flush(c) ((c)->manager->flush((c)))
Theodore Ts'oa29f4d31997-04-29 21:26:48 +000076#define io_channel_bumpcount(c) ((c)->refcount++)
Theodore Ts'o3839e651997-04-26 13:21:57 +000077
Theodore Ts'o19c78dc1997-04-29 16:17:09 +000078/* unix_io.c */
Theodore Ts'o3839e651997-04-26 13:21:57 +000079extern io_manager unix_io_manager;
80
Theodore Ts'o19c78dc1997-04-29 16:17:09 +000081/* test_io.c */
82extern io_manager test_io_manager, test_io_backing_manager;
83extern void (*test_io_cb_read_blk)
84 (unsigned long block, int count, errcode_t err);
85extern void (*test_io_cb_write_blk)
86 (unsigned long block, int count, errcode_t err);
87extern void (*test_io_cb_set_blksize)
88 (int blksize, errcode_t err);