git.sur5r.net Git - bacula/bacula/blob - bacula/src/findlib/bfile.h

   1 /*
   2  *  Bacula low level File I/O routines.  This routine simulates
   3  *    open(), read(), write(), and close(), but using native routines.
   4  *    I.e. on Windows, we use Windows APIs.
   5  *
   6  *     Kern Sibbald May MMIII
   7  */
   8 /*
   9    Copyright (C) 2003-2006 Kern Sibbald
  10
  11    This program is free software; you can redistribute it and/or
  12    modify it under the terms of the GNU General Public License
  13    version 2 as amended with additional clauses defined in the
  14    file LICENSE in the main source directory.
  15
  16    This program is distributed in the hope that it will be useful,
  17    but WITHOUT ANY WARRANTY; without even the implied warranty of
  18    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  19    the file LICENSE for additional details.
  20
  21  */
  22
  23 #ifndef __BFILE_H
  24 #define __BFILE_H
  25
  26 #ifdef HAVE_PYTHON
  27 #undef _POSIX_C_SOURCE
  28 #include <Python.h>
  29 struct Python_IO {
  30    PyObject *fo;
  31    PyObject *fr;
  32    PyObject *fc;
  33 };
  34 #else
  35 struct Python_IO {
  36 };
  37 #endif
  38
  39
  40 /* this should physically correspond to WIN32_STREAM_ID
  41  * from winbase.h on Win32. We didn't inlcude cStreamName
  42  * as we don't use it and don't need it for a correct struct size.
  43  */
  44
  45 #define WIN32_BACKUP_DATA 1
  46
  47 typedef struct _BWIN32_STREAM_ID {
  48         int32_t        dwStreamId;
  49         int32_t        dwStreamAttributes;
  50         int64_t        Size;
  51         int32_t        dwStreamNameSize;
  52 } BWIN32_STREAM_ID, *LPBWIN32_STREAM_ID ;
  53
  54
  55 typedef struct _PROCESS_WIN32_BACKUPAPIBLOCK_CONTEXT {
  56         int64_t          liNextHeader;
  57         bool             bIsInData;
  58         BWIN32_STREAM_ID header_stream;
  59 } PROCESS_WIN32_BACKUPAPIBLOCK_CONTEXT;
  60
  61 /*  =======================================================
  62  *
  63  *   W I N D O W S
  64  *
  65  *  =======================================================
  66  */
  67 #if defined(HAVE_WIN32)
  68
  69 enum {
  70    BF_CLOSED,
  71    BF_READ,                           /* BackupRead */
  72    BF_WRITE                           /* BackupWrite */
  73 };
  74
  75 /* In bfile.c */
  76
  77 /* Basic Win32 low level I/O file packet */
  78 struct BFILE {
  79    bool use_backup_api;               /* set if using BackupRead/Write */
  80    int mode;                          /* set if file is open */
  81    HANDLE fh;                         /* Win32 file handle */
  82    int fid;                           /* fd if doing Unix style */
  83    LPVOID lpContext;                  /* BackupRead/Write context */
  84    POOLMEM *errmsg;                   /* error message buffer */
  85    DWORD rw_bytes;                    /* Bytes read or written */
  86    DWORD lerror;                      /* Last error code */
  87    int berrno;                        /* errno */
  88    char *prog;                        /* reader/writer program if any */
  89    JCR *jcr;                          /* jcr for editing job codes */
  90    Python_IO pio;                     /* Python I/O routines */
  91    PROCESS_WIN32_BACKUPAPIBLOCK_CONTEXT win32DecompContext; /* context for decomposition of win32 backup streams */
  92    int use_backup_decomp;             /* set if using BackupRead Stream Decomposition */
  93 };
  94
  95 HANDLE bget_handle(BFILE *bfd);
  96
  97 #else   /* Linux/Unix systems */
  98
  99 /*  =======================================================
 100  *
 101  *   U N I X
 102  *
 103  *  =======================================================
 104  */
 105
 106 /* Basic Unix low level I/O file packet */
 107 struct BFILE {
 108    int fid;                           /* file id on Unix */
 109    int berrno;
 110    char *prog;                        /* reader/writer program if any */
 111    JCR *jcr;                          /* jcr for editing job codes */
 112    Python_IO pio;                     /* Python I/O routines */
 113    PROCESS_WIN32_BACKUPAPIBLOCK_CONTEXT win32DecompContext; /* context for decomposition of win32 backup streams */
 114    int use_backup_decomp;             /* set if using BackupRead Stream Decomposition */
 115 };
 116
 117 #endif
 118
 119 void    binit(BFILE *bfd);
 120 bool    is_bopen(BFILE *bfd);
 121 bool    set_win32_backup(BFILE *bfd);
 122 bool    set_portable_backup(BFILE *bfd);
 123 bool    set_prog(BFILE *bfd, char *prog, JCR *jcr);
 124 bool    have_win32_api();
 125 bool    is_portable_backup(BFILE *bfd);
 126 bool    is_restore_stream_supported(int stream);
 127 bool    is_win32_stream(int stream);
 128 char   *xberror(BFILE *bfd);          /* DO NOT USE  -- use berrno class */
 129 int     bopen(BFILE *bfd, const char *fname, int flags, mode_t mode);
 130 #ifdef HAVE_DARWIN_OS
 131 int     bopen_rsrc(BFILE *bfd, const char *fname, int flags, mode_t mode);
 132 #endif
 133 int     bclose(BFILE *bfd);
 134 ssize_t bread(BFILE *bfd, void *buf, size_t count);
 135 ssize_t bwrite(BFILE *bfd, void *buf, size_t count);
 136 boffset_t blseek(BFILE *bfd, boffset_t offset, int whence);
 137 const char   *stream_to_ascii(int stream);
 138
 139 bool processWin32BackupAPIBlock (BFILE *bfd, void *pBuffer, ssize_t dwSize);
 140
 141 #endif /* __BFILE_H */