src/io.h

   1 /* io.h - Virtual disk input/output
   2
   3    Copyright (C) 1993 Werner Almesberger <werner.almesberger@lrc.di.epfl.ch>
   4    Copyright (C) 1998 Roman Hodek <Roman.Hodek@informatik.uni-erlangen.de>
   5    Copyright (C) 2008-2014 Daniel Baumann <mail@daniel-baumann.ch>
   6
   7    This program is free software: you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation, either version 3 of the License, or
  10    (at your option) any later version.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with this program. If not, see <http://www.gnu.org/licenses/>.
  19
  20    The complete text of the GNU General Public License
  21    can be found in /usr/share/common-licenses/GPL-3 file.
  22 */
  23
  24 /* FAT32, VFAT, Atari format support, and various fixes additions May 1998
  25  * by Roman Hodek <Roman.Hodek@informatik.uni-erlangen.de> */
  26
  27 #ifndef _IO_H
  28 #define _IO_H
  29
  30 #include <fcntl.h>              /* for off_t */
  31
  32 void fs_open(char *path, int rw);
  33
  34 /* Opens the filesystem PATH. If RW is zero, the filesystem is opened
  35    read-only, otherwise, it is opened read-write. */
  36
  37 void fs_read(off_t pos, int size, void *data);
  38
  39 /* Reads SIZE bytes starting at POS into DATA. Performs all applicable
  40    changes. */
  41
  42 int fs_test(off_t pos, int size);
  43
  44 /* Returns a non-zero integer if SIZE bytes starting at POS can be read without
  45    errors. Otherwise, it returns zero. */
  46
  47 void fs_write(off_t pos, int size, void *data);
  48
  49 /* If write_immed is non-zero, SIZE bytes are written from DATA to the disk,
  50    starting at POS. If write_immed is zero, the change is added to a list in
  51    memory. */
  52
  53 int fs_close(int write);
  54
  55 /* Closes the filesystem, performs all pending changes if WRITE is non-zero
  56    and removes the list of changes. Returns a non-zero integer if the file
  57    system has been changed since the last fs_open, zero otherwise. */
  58
  59 int fs_changed(void);
  60
  61 /* Determines whether the filesystem has changed. See fs_close. */
  62
  63 #endif