fileio.c

   1 /*
   2    Copyright (C) Andrew Tridgell 1998
   3    Copyright (C) 2002 by Martin Pool
   4
   5    This program is free software; you can redistribute it and/or modify
   6    it under the terms of the GNU General Public License as published by
   7    the Free Software Foundation; either version 2 of the License, or
   8    (at your option) any later version.
   9
  10    This program is distributed in the hope that it will be useful,
  11    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13    GNU General Public License for more details.
  14
  15    You should have received a copy of the GNU General Public License
  16    along with this program; if not, write to the Free Software
  17    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  18 */
  19
  20 /*
  21   File IO utilities used in rsync
  22   */
  23 #include "rsync.h"
  24
  25 static char last_byte;
  26 static int last_sparse;
  27 extern int sparse_files;
  28
  29 int sparse_end(int f)
  30 {
  31         if (last_sparse) {
  32                 do_lseek(f,-1,SEEK_CUR);
  33                 return (write(f,&last_byte,1) == 1 ? 0 : -1);
  34         }
  35         last_sparse = 0;
  36         return 0;
  37 }
  38
  39
  40 static int write_sparse(int f,char *buf,size_t len)
  41 {
  42         size_t l1=0, l2=0;
  43         int ret;
  44
  45         for (l1=0;l1<len && buf[l1]==0;l1++) ;
  46         for (l2=0;l2<(len-l1) && buf[len-(l2+1)]==0;l2++) ;
  47
  48         last_byte = buf[len-1];
  49
  50         if (l1 == len || l2 > 0)
  51                 last_sparse=1;
  52
  53         if (l1 > 0) {
  54                 do_lseek(f,l1,SEEK_CUR);
  55         }
  56
  57         if (l1 == len)
  58                 return len;
  59
  60         ret = write(f, buf + l1, len - (l1+l2));
  61         if (ret == -1 || ret == 0)
  62                 return ret;
  63         else if (ret != (int) (len - (l1+l2)))
  64                 return (l1+ret);
  65
  66         if (l2 > 0)
  67                 do_lseek(f,l2,SEEK_CUR);
  68
  69         return len;
  70 }
  71
  72
  73
  74 int write_file(int f,char *buf,size_t len)
  75 {
  76         int ret = 0;
  77
  78         if (!sparse_files) {
  79                 return write(f,buf,len);
  80         }
  81
  82         while (len>0) {
  83                 int len1 = MIN(len, SPARSE_WRITE_SIZE);
  84                 int r1 = write_sparse(f, buf, len1);
  85                 if (r1 <= 0) {
  86                         if (ret > 0) return ret;
  87                         return r1;
  88                 }
  89                 len -= r1;
  90                 buf += r1;
  91                 ret += r1;
  92         }
  93         return ret;
  94 }
  95
  96
  97
  98 /*
  99  * this provides functionality somewhat similar to mmap() but using
 100  * read(). It gives sliding window access to a file. mmap() is not
 101  * used because of the possibility of another program (such as a
 102  * mailer) truncating the file thus giving us a SIGBUS
 103  */
 104 struct map_struct *map_file(int fd, OFF_T len)
 105 {
 106         struct map_struct *map;
 107         map = (struct map_struct *) malloc_counted(sizeof(*map),
 108                                                    &stats.map_struct);
 109         if (!map)
 110                 out_of_memory("map_file");
 111
 112         map->fd = fd;
 113         map->file_size = len;
 114         map->p = NULL;
 115         map->p_size = 0;
 116         map->p_offset = 0;
 117         map->p_fd_offset = 0;
 118         map->p_len = 0;
 119
 120         return map;
 121 }
 122
 123
 124 /* slide the read window in the file */
 125 char *map_ptr(struct map_struct *map,OFF_T offset,int len)
 126 {
 127         int nread;
 128         OFF_T window_start, read_start;
 129         int window_size, read_size, read_offset;
 130
 131         if (len == 0) {
 132                 return NULL;
 133         }
 134
 135         /* can't go beyond the end of file */
 136         if (len > (map->file_size - offset)) {
 137                 len = map->file_size - offset;
 138         }
 139
 140         /* in most cases the region will already be available */
 141         if (offset >= map->p_offset &&
 142             offset+len <= map->p_offset+map->p_len) {
 143                 return (map->p + (offset - map->p_offset));
 144         }
 145
 146
 147         /* nope, we are going to have to do a read. Work out our desired window */
 148         if (offset > 2*CHUNK_SIZE) {
 149                 window_start = offset - 2*CHUNK_SIZE;
 150                 window_start &= ~((OFF_T)(CHUNK_SIZE-1)); /* assumes power of 2 */
 151         } else {
 152                 window_start = 0;
 153         }
 154         window_size = MAX_MAP_SIZE;
 155         if (window_start + window_size > map->file_size) {
 156                 window_size = map->file_size - window_start;
 157         }
 158         if (offset + len > window_start + window_size) {
 159                 window_size = (offset+len) - window_start;
 160         }
 161
 162         /* make sure we have allocated enough memory for the window */
 163         if (window_size > map->p_size) {
 164                 map->p = (char *)Realloc(map->p, window_size);
 165                 if (!map->p) out_of_memory("map_ptr");
 166                 map->p_size = window_size;
 167         }
 168
 169         /* now try to avoid re-reading any bytes by reusing any bytes from the previous
 170            buffer. */
 171         if (window_start >= map->p_offset &&
 172             window_start < map->p_offset + map->p_len &&
 173             window_start + window_size >= map->p_offset + map->p_len) {
 174                 read_start = map->p_offset + map->p_len;
 175                 read_offset = read_start - window_start;
 176                 read_size = window_size - read_offset;
 177                 memmove(map->p, map->p + (map->p_len - read_offset), read_offset);
 178         } else {
 179                 read_start = window_start;
 180                 read_size = window_size;
 181                 read_offset = 0;
 182         }
 183
 184         if (read_size <= 0) {
 185                 rprintf(FINFO,"Warning: unexpected read size of %d in map_ptr\n", read_size);
 186         } else {
 187                 if (map->p_fd_offset != read_start) {
 188                         if (do_lseek(map->fd,read_start,SEEK_SET) != read_start) {
 189                                 rprintf(FERROR,"lseek failed in map_ptr\n");
 190                                 exit_cleanup(RERR_FILEIO);
 191                         }
 192                         map->p_fd_offset = read_start;
 193                 }
 194
 195                 if ((nread=read(map->fd,map->p + read_offset,read_size)) != read_size) {
 196                         if (nread < 0) nread = 0;
 197                         /* the best we can do is zero the buffer - the file
 198                            has changed mid transfer! */
 199                         memset(map->p+read_offset+nread, 0, read_size - nread);
 200                 }
 201                 map->p_fd_offset += nread;
 202         }
 203
 204         map->p_offset = window_start;
 205         map->p_len = window_size;
 206
 207         return map->p + (offset - map->p_offset);
 208 }
 209
 210
 211 void unmap_file(struct map_struct *map)
 212 {
 213         if (map->p) {
 214                 free(map->p);
 215                 map->p = NULL;
 216         }
 217         memset(map, 0, sizeof(*map));
 218         free(map);
 219 }
 220