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.
6 * Kern Sibbald, April MMIII
12 Copyright (C) 2000-2003 Kern Sibbald and John Walker
14 This program is free software; you can redistribute it and/or
15 modify it under the terms of the GNU General Public License as
16 published by the Free Software Foundation; either version 2 of
17 the License, or (at your option) any later version.
19 This program is distributed in the hope that it will be useful,
20 but WITHOUT ANY WARRANTY; without even the implied warranty of
21 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
22 General Public License for more details.
24 You should have received a copy of the GNU General Public
25 License along with this program; if not, write to the Free
26 Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
34 /* ===============================================================
36 * U N I X AND W I N D O W S
38 * ===============================================================
41 int is_win32_stream(int stream)
44 case STREAM_WIN32_DATA:
45 case STREAM_WIN32_GZIP_DATA:
51 const char *stream_to_ascii(int stream)
56 case STREAM_GZIP_DATA:
58 case STREAM_SPARSE_GZIP_DATA:
59 return "GZIP sparse data";
60 case STREAM_WIN32_DATA:
62 case STREAM_WIN32_GZIP_DATA:
63 return "Win32 GZIP data";
64 case STREAM_UNIX_ATTRIBUTES:
65 return "File attributes";
66 case STREAM_FILE_DATA:
68 case STREAM_MD5_SIGNATURE:
69 return "MD5 signature";
70 case STREAM_UNIX_ATTRIBUTES_EX:
71 return "Extended attributes";
72 case STREAM_SPARSE_DATA:
74 case STREAM_PROGRAM_NAMES:
75 return "Program names";
76 case STREAM_PROGRAM_DATA:
77 return "Program data";
78 case STREAM_SHA1_SIGNATURE:
79 return "SHA1 signature";
81 sprintf(buf, "%d", stream);
82 return (const char *)buf;
88 /* ===============================================================
92 * ===============================================================
95 #if defined(HAVE_CYGWIN) || defined(HAVE_WIN32)
97 void unix_name_to_win32(POOLMEM **win32_name, char *name);
98 extern "C" HANDLE get_osfhandle(int fd);
102 void binit(BFILE *bfd)
105 bfd->mode = BF_CLOSED;
106 bfd->use_backup_api = have_win32_api();
108 bfd->lpContext = NULL;
113 * Enables using the Backup API (win32_data).
114 * Returns 1 if function worked
115 * Returns 0 if failed (i.e. do not have Backup API on this machine)
117 int set_win32_backup(BFILE *bfd)
119 /* We enable if possible here */
120 bfd->use_backup_api = have_win32_api();
121 return bfd->use_backup_api;
125 int set_portable_backup(BFILE *bfd)
127 bfd->use_backup_api = 0;
132 * Return 1 if we are NOT using Win32 BackupWrite()
135 int is_portable_backup(BFILE *bfd)
137 return !bfd->use_backup_api;
142 return p_BackupRead && p_BackupWrite;
148 * Return 1 if we support the stream
149 * 0 if we do not support the stream
151 int is_stream_supported(int stream)
153 /* No Win32 backup on this machine */
156 case STREAM_GZIP_DATA:
157 case STREAM_SPARSE_GZIP_DATA:
160 case STREAM_WIN32_DATA:
161 case STREAM_WIN32_GZIP_DATA:
162 return have_win32_api();
166 case STREAM_GZIP_DATA:
167 case STREAM_SPARSE_GZIP_DATA:
169 case STREAM_UNIX_ATTRIBUTES:
170 case STREAM_FILE_DATA:
171 case STREAM_MD5_SIGNATURE:
172 case STREAM_UNIX_ATTRIBUTES_EX:
173 case STREAM_SPARSE_DATA:
174 case STREAM_PROGRAM_NAMES:
175 case STREAM_PROGRAM_DATA:
176 case STREAM_SHA1_SIGNATURE:
177 case 0: /* compatibility with old tapes */
183 HANDLE bget_handle(BFILE *bfd)
188 int bopen(BFILE *bfd, const char *fname, int flags, mode_t mode)
190 POOLMEM *win32_fname;
191 DWORD dwaccess, dwflags;
193 /* Convert to Windows path format */
194 win32_fname = get_pool_memory(PM_FNAME);
195 unix_name_to_win32(&win32_fname, (char *)fname);
197 if (flags & O_CREAT) { /* Create */
198 if (bfd->use_backup_api) {
199 dwaccess = GENERIC_WRITE|FILE_ALL_ACCESS|WRITE_OWNER|WRITE_DAC|ACCESS_SYSTEM_SECURITY;
200 dwflags = FILE_FLAG_BACKUP_SEMANTICS;
202 dwaccess = GENERIC_WRITE;
205 bfd->fh = CreateFile(win32_fname,
206 dwaccess, /* Requested access */
208 NULL, /* SecurityAttributes */
209 CREATE_ALWAYS, /* CreationDisposition */
210 dwflags, /* Flags and attributes */
211 NULL); /* TemplateFile */
212 bfd->mode = BF_WRITE;
214 } else if (flags & O_WRONLY) { /* Open existing for write */
215 if (bfd->use_backup_api) {
217 dwaccess = GENERIC_WRITE|/*FILE_ALL_ACCESS|*/WRITE_OWNER|WRITE_DAC/*|ACCESS_SYSTEM_SECURITY*/;
219 dwaccess = GENERIC_WRITE|FILE_ALL_ACCESS|WRITE_OWNER|WRITE_DAC|ACCESS_SYSTEM_SECURITY;
221 dwflags = FILE_FLAG_BACKUP_SEMANTICS;
223 dwaccess = GENERIC_WRITE;
226 bfd->fh = CreateFile(win32_fname,
227 dwaccess, /* Requested access */
229 NULL, /* SecurityAttributes */
230 OPEN_EXISTING, /* CreationDisposition */
231 dwflags, /* Flags and attributes */
232 NULL); /* TemplateFile */
233 bfd->mode = BF_WRITE;
236 if (bfd->use_backup_api) {
237 dwaccess = GENERIC_READ|READ_CONTROL|ACCESS_SYSTEM_SECURITY;
238 dwflags = FILE_FLAG_BACKUP_SEMANTICS;
240 dwaccess = GENERIC_READ;
243 bfd->fh = CreateFile(win32_fname,
244 dwaccess, /* Requested access */
245 FILE_SHARE_READ, /* Shared mode */
246 NULL, /* SecurityAttributes */
247 OPEN_EXISTING, /* CreationDisposition */
248 dwflags, /* Flags and attributes */
249 NULL); /* TemplateFile */
253 if (bfd->fh == INVALID_HANDLE_VALUE) {
254 bfd->lerror = GetLastError();
255 bfd->mode = BF_CLOSED;
258 bfd->lpContext = NULL;
259 free_pool_memory(win32_fname);
260 return bfd->mode == BF_CLOSED ? -1 : 1;
264 * Returns 0 on success
267 int bclose(BFILE *bfd)
272 free_pool_memory(bfd->errmsg);
275 if (bfd->mode == BF_CLOSED) {
278 if (bfd->use_backup_api && bfd->mode == BF_READ) {
280 if (!bfd->lpContext && !p_BackupRead(bfd->fh,
282 (DWORD)0, /* bytes to read */
283 &bfd->rw_bytes, /* bytes read */
285 1, /* ProcessSecurity */
286 &bfd->lpContext)) { /* Read context */
289 } else if (bfd->use_backup_api && bfd->mode == BF_WRITE) {
291 if (!bfd->lpContext && !p_BackupWrite(bfd->fh,
293 (DWORD)0, /* bytes to read */
294 &bfd->rw_bytes, /* bytes written */
296 1, /* ProcessSecurity */
297 &bfd->lpContext)) { /* Write context */
301 if (!CloseHandle(bfd->fh)) {
304 bfd->mode = BF_CLOSED;
305 bfd->lpContext = NULL;
310 * Generate error message
312 char *berror(BFILE *bfd)
316 FormatMessage(FORMAT_MESSAGE_ALLOCATE_BUFFER|
317 FORMAT_MESSAGE_FROM_SYSTEM,
324 strip_trailing_junk(msg);
326 bfd->errmsg = get_pool_memory(PM_FNAME);
328 pm_strcpy(&bfd->errmsg, msg);
333 /* Returns: bytes read on success
337 ssize_t bread(BFILE *bfd, void *buf, size_t count)
341 if (bfd->use_backup_api) {
342 if (!p_BackupRead(bfd->fh,
347 1, /* Process Security */
348 &bfd->lpContext)) { /* Context */
349 bfd->lerror = GetLastError();
353 if (!ReadFile(bfd->fh,
358 bfd->lerror = GetLastError();
363 return (ssize_t)bfd->rw_bytes;
366 ssize_t bwrite(BFILE *bfd, void *buf, size_t count)
370 if (bfd->use_backup_api) {
371 if (!p_BackupWrite(bfd->fh,
376 1, /* Process Security */
377 &bfd->lpContext)) { /* Context */
378 bfd->lerror = GetLastError();
382 if (!WriteFile(bfd->fh,
387 bfd->lerror = GetLastError();
391 return (ssize_t)bfd->rw_bytes;
394 int is_bopen(BFILE *bfd)
396 return bfd->mode != BF_CLOSED;
399 off_t blseek(BFILE *bfd, off_t offset, int whence)
401 /* ****FIXME**** this is needed if we want to read Win32 Archives */
405 #else /* Unix systems */
407 /* ===============================================================
411 * ===============================================================
413 void binit(BFILE *bfd)
420 return 0; /* no can do */
424 * Enables using the Backup API (win32_data).
425 * Returns 1 if function worked
426 * Returns 0 if failed (i.e. do not have Backup API on this machine)
428 int set_win32_backup(BFILE *bfd)
430 return 0; /* no can do */
434 int set_portable_backup(BFILE *bfd)
436 return 1; /* no problem */
440 * Return 1 if we are writing in portable format
443 int is_portable_backup(BFILE *bfd)
445 return 1; /* portable by definition */
448 int is_stream_supported(int stream)
450 /* No Win32 backup on this machine */
453 case STREAM_GZIP_DATA:
454 case STREAM_SPARSE_GZIP_DATA:
456 case STREAM_WIN32_DATA:
457 case STREAM_WIN32_GZIP_DATA:
462 case STREAM_GZIP_DATA:
463 case STREAM_SPARSE_GZIP_DATA:
465 case STREAM_UNIX_ATTRIBUTES:
466 case STREAM_FILE_DATA:
467 case STREAM_MD5_SIGNATURE:
468 case STREAM_UNIX_ATTRIBUTES_EX:
469 case STREAM_SPARSE_DATA:
470 case STREAM_PROGRAM_NAMES:
471 case STREAM_PROGRAM_DATA:
472 case STREAM_SHA1_SIGNATURE:
473 case 0: /* compatibility with old tapes */
480 int bopen(BFILE *bfd, const char *fname, int flags, mode_t mode)
482 bfd->fid = open(fname, flags, mode);
484 Dmsg1(400, "Open file %d\n", bfd->fid);
488 int bclose(BFILE *bfd)
491 Dmsg1(400, "Close file %d\n", bfd->fid);
492 if (bfd->fid == -1) {
495 stat = close(bfd->fid);
502 ssize_t bread(BFILE *bfd, void *buf, size_t count)
505 stat = read(bfd->fid, buf, count);
510 ssize_t bwrite(BFILE *bfd, void *buf, size_t count)
513 stat = write(bfd->fid, buf, count);
518 int is_bopen(BFILE *bfd)
520 return bfd->fid >= 0;
523 off_t blseek(BFILE *bfd, off_t offset, int whence)
526 pos = lseek(bfd->fid, offset, whence);
531 char *berror(BFILE *bfd)
533 return strerror(bfd->berrno);