Fix for misunderstanding of fsync added when vfs layer
[tprouty/samba.git] / source / smbd / fileio.c
1 /* 
2    Unix SMB/Netbios implementation.
3    Version 1.9.
4    read/write to a files_struct
5    Copyright (C) Andrew Tridgell 1992-1998
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 2 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, write to the Free Software
19    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 */
21
22 #include "includes.h"
23
24 extern int DEBUGLEVEL;
25
26 static BOOL setup_write_cache(files_struct *, SMB_OFF_T);
27
28 /****************************************************************************
29 seek a file. Try to avoid the seek if possible
30 ****************************************************************************/
31
32 SMB_OFF_T seek_file(files_struct *fsp,SMB_OFF_T pos)
33 {
34   SMB_OFF_T offset = 0;
35   SMB_OFF_T seek_ret;
36
37   if (fsp->print_file && lp_postscript(fsp->conn->service))
38     offset = 3;
39
40   seek_ret = fsp->conn->vfs_ops.lseek(fsp->fd,pos+offset,SEEK_SET);
41
42   /*
43    * We want to maintain the fiction that we can seek
44    * on a fifo for file system purposes. This allows 
45    * people to set up UNIX fifo's that feed data to Windows
46    * applications. JRA.
47    */
48
49   if((seek_ret == -1) && (errno == ESPIPE)) {
50     seek_ret = pos+offset;
51     errno = 0;
52   }
53
54   if((seek_ret == -1) || (seek_ret != pos+offset)) {
55     DEBUG(0,("seek_file: sys_lseek failed. Error was %s\n", strerror(errno) ));
56     fsp->pos = -1;
57     return -1;
58   }
59
60   fsp->pos = seek_ret - offset;
61
62   DEBUG(10,("seek_file: requested pos = %.0f, new pos = %.0f\n",
63         (double)(pos+offset), (double)fsp->pos ));
64
65   return(fsp->pos);
66 }
67
68 /****************************************************************************
69  Read from write cache if we can.
70 ****************************************************************************/
71
72 static unsigned int cache_read_hits;
73
74 BOOL read_from_write_cache(files_struct *fsp,char *data,SMB_OFF_T pos,size_t n)
75 {
76   write_cache *wcp = fsp->wcp;
77
78   if(!wcp)
79     return False;
80
81   if(n > wcp->data_size || pos < wcp->offset || pos + n > wcp->offset + wcp->data_size)
82     return False;
83
84   memcpy(data, wcp->data + (pos - wcp->offset), n);
85
86   cache_read_hits++;
87
88   return True;
89 }
90
91 /****************************************************************************
92 read from a file
93 ****************************************************************************/
94
95 ssize_t read_file(files_struct *fsp,char *data,SMB_OFF_T pos,size_t n)
96 {
97   ssize_t ret=0,readret;
98
99   /* you can't read from print files */
100   if (fsp->print_file) {
101           return -1;
102   }
103
104   /*
105    * Serve from write cache if we can.
106    */
107   if(read_from_write_cache(fsp, data, pos, n))
108     return n;
109
110   flush_write_cache(fsp, READ_FLUSH);
111
112   if (seek_file(fsp,pos) == -1) {
113     DEBUG(3,("read_file: Failed to seek to %.0f\n",(double)pos));
114     return(ret);
115   }
116   
117   if (n > 0) {
118     readret = fsp->conn->vfs_ops.read(fsp->fd,data,n);
119     if (readret == -1)
120       return -1;
121     if (readret > 0) ret += readret;
122   }
123
124   return(ret);
125 }
126
127 /* Write cache static counters. */
128
129 static unsigned int abutted_writes;
130 static unsigned int total_writes;
131 static unsigned int non_oplock_writes;
132 static unsigned int direct_writes;
133 static unsigned int init_writes;
134 static unsigned int flushed_writes;
135 static unsigned int num_perfect_writes;
136 static unsigned int flush_reasons[NUM_FLUSH_REASONS];
137
138 /* how many write cache buffers have been allocated */
139 static unsigned int allocated_write_caches;
140 static unsigned int num_write_caches;
141
142 /****************************************************************************
143  *Really* write to a file
144 ****************************************************************************/
145
146 static ssize_t real_write_file(files_struct *fsp,char *data,SMB_OFF_T pos, size_t n)
147 {
148   if ((pos != -1) && (seek_file(fsp,pos) == -1))
149     return -1;
150
151   return write_data(fsp->fd,data,n);
152 }
153
154 /****************************************************************************
155 write to a file
156 ****************************************************************************/
157
158 ssize_t write_file(files_struct *fsp, char *data, SMB_OFF_T pos, size_t n)
159 {
160   write_cache *wcp = fsp->wcp;
161   ssize_t total_written = 0;
162   int write_path = -1; 
163
164   if (fsp->print_file) {
165           return print_job_write(fsp->print_jobid, data, n);
166   }
167
168   if (!fsp->can_write) {
169     errno = EPERM;
170     return(0);
171   }
172
173   if (!fsp->modified) {
174     SMB_STRUCT_STAT st;
175     fsp->modified = True;
176
177     if (fsp->conn->vfs_ops.fstat(fsp->fd,&st) == 0) {
178       int dosmode = dos_mode(fsp->conn,fsp->fsp_name,&st);
179       if (MAP_ARCHIVE(fsp->conn) && !IS_DOS_ARCHIVE(dosmode)) { 
180         file_chmod(fsp->conn,fsp->fsp_name,dosmode | aARCH,&st);
181       }
182
183       /*
184        * If this is the first write and we have an exclusive oplock then setup
185        * the write cache.
186        */
187
188       if ((fsp->oplock_type == EXCLUSIVE_OPLOCK) && !wcp) {
189         setup_write_cache(fsp, st.st_size);
190         wcp = fsp->wcp;
191       } 
192     }  
193   }
194
195   total_writes++;
196   if (!fsp->oplock_type) {
197     non_oplock_writes++;
198   }
199
200   /*
201    * If this file is level II oplocked then we need
202    * to grab the shared memory lock and inform all
203    * other files with a level II lock that they need
204    * to flush their read caches. We keep the lock over
205    * the shared memory area whilst doing this.
206    */
207
208   if (LEVEL_II_OPLOCK_TYPE(fsp->oplock_type)) {
209     share_mode_entry *share_list = NULL;
210     pid_t pid = sys_getpid();
211     int token = -1;
212     int num_share_modes = 0;
213     int i;
214
215     if (lock_share_entry_fsp(fsp) == False) {
216       DEBUG(0,("write_file: failed to lock share mode entry for file %s.\n", fsp->fsp_name ));
217     }
218
219     num_share_modes = get_share_modes(fsp->conn, fsp->dev, fsp->inode, &share_list);
220
221     for(i = 0; i < num_share_modes; i++) {
222       share_mode_entry *share_entry = &share_list[i];
223
224       /*
225        * As there could have been multiple writes waiting at the lock_share_entry
226        * gate we may not be the first to enter. Hence the state of the op_types
227        * in the share mode entries may be partly NO_OPLOCK and partly LEVEL_II
228        * oplock. It will do no harm to re-send break messages to those smbd's
229        * that are still waiting their turn to remove their LEVEL_II state, and
230        * also no harm to ignore existing NO_OPLOCK states. JRA.
231        */
232
233       if (share_entry->op_type == NO_OPLOCK)
234         continue;
235
236       /* Paranoia .... */
237       if (EXCLUSIVE_OPLOCK_TYPE(share_entry->op_type)) {
238         DEBUG(0,("write_file: PANIC. share mode entry %d is an exlusive oplock !\n", i ));
239         unlock_share_entry(fsp->conn, fsp->dev, fsp->inode);
240         abort();
241       }
242
243       /*
244        * Check if this is a file we have open (including the
245        * file we've been called to do write_file on. If so
246        * then break it directly without releasing the lock.
247        */
248
249       if (pid == share_entry->pid) {
250         files_struct *new_fsp = file_find_dit(fsp->dev, fsp->inode, &share_entry->time);
251
252         /* Paranoia check... */
253         if(new_fsp == NULL) {
254           DEBUG(0,("write_file: PANIC. share mode entry %d is not a local file !\n", i ));
255           unlock_share_entry(fsp->conn, fsp->dev, fsp->inode);
256           abort();
257         }
258         oplock_break_level2(new_fsp, True, token);
259
260       } else {
261
262         /*
263          * This is a remote file and so we send an asynchronous
264          * message.
265          */
266
267         request_oplock_break(share_entry, fsp->dev, fsp->inode);
268       }
269     }
270  
271     free((char *)share_list);
272     unlock_share_entry_fsp(fsp);
273   }
274
275   /* Paranoia check... */
276   if (LEVEL_II_OPLOCK_TYPE(fsp->oplock_type)) {
277     DEBUG(0,("write_file: PANIC. File %s still has a level II oplock.\n", fsp->fsp_name));
278     abort();
279   }
280
281   if (total_writes % 500 == 0) {
282     DEBUG(3,("WRITECACHE: initwrites=%u abutted=%u flushes=%u total=%u \
283 nonop=%u allocated=%u active=%u direct=%u perfect=%u readhits=%u\n",
284          init_writes, abutted_writes, flushed_writes, total_writes, non_oplock_writes,
285          allocated_write_caches,
286          num_write_caches, direct_writes, num_perfect_writes, cache_read_hits ));
287
288     DEBUG(3,("WRITECACHE: SEEK=%d, READ=%d, WRITE=%d, READRAW=%d, OPLOCK=%d, CLOSE=%d, SYNC=%d\n",
289     flush_reasons[SEEK_FLUSH],
290     flush_reasons[READ_FLUSH],
291     flush_reasons[WRITE_FLUSH],
292     flush_reasons[READRAW_FLUSH],
293     flush_reasons[OPLOCK_RELEASE_FLUSH],
294     flush_reasons[CLOSE_FLUSH],
295     flush_reasons[SYNC_FLUSH] ));
296   }
297
298   if(!wcp) {
299     direct_writes++;
300     return real_write_file(fsp, data, pos, n);
301   }
302
303   DEBUG(9,("write_file(fd=%d pos=%d size=%d) wofs=%d wsize=%d\n",
304            fsp->fd, (int)pos, (int)n, (int)wcp->offset, (int)wcp->data_size));
305
306   /* 
307    * If we have active cache and it isn't contiguous then we flush.
308    * NOTE: There is a small problem with running out of disk ....
309    */
310
311   if (wcp->data_size) {
312
313     BOOL cache_flush_needed = False;
314
315     if ((pos >= wcp->offset) && (pos <= wcp->offset + wcp->data_size)) {
316       
317       /*
318        * Start of write overlaps or abutts the existing data.
319        */
320
321       size_t data_used = MIN((wcp->alloc_size - (pos - wcp->offset)), n);
322
323       memcpy(wcp->data + (pos - wcp->offset), data, data_used);
324
325       /*
326        * Update the current buffer size with the new data.
327        */
328
329       if(pos + data_used > wcp->offset + wcp->data_size)
330         wcp->data_size = pos + data_used - wcp->offset;
331
332       /*
333        * If we used all the data then
334        * return here.
335        */
336
337       if(n == data_used)
338         return n;
339       else
340         cache_flush_needed = True;
341
342       /*
343        * Move the start of data forward by the amount used,
344        * cut down the amount left by the same amount.
345        */
346
347       data += data_used;
348       pos += data_used;
349       n -= data_used;
350
351       abutted_writes++;
352       total_written = data_used;
353
354       write_path = 1;
355
356     } else if ((pos < wcp->offset) && (pos + n > wcp->offset) && 
357                (pos + n <= wcp->offset + wcp->alloc_size)) {
358
359       /*
360        * End of write overlaps the existing data.
361        */
362
363       size_t data_used = pos + n - wcp->offset;
364
365       memcpy(wcp->data, data + n - data_used, data_used);
366
367       /*
368        * Update the current buffer size with the new data.
369        */
370
371       if(pos + n > wcp->offset + wcp->data_size)
372         wcp->data_size = pos + n - wcp->offset;
373
374       /*
375        * We don't need to move the start of data, but we
376        * cut down the amount left by the amount used.
377        */
378
379       n -= data_used;
380
381       /*
382        * We cannot have used all the data here.
383        */
384
385       cache_flush_needed = True;
386
387       abutted_writes++;
388       total_written = data_used;
389
390       write_path = 2;
391
392     } else if ( (pos >= wcp->file_size) && 
393                 (pos > wcp->offset + wcp->data_size) && 
394                 (pos < wcp->offset + wcp->alloc_size) ) {
395
396       /*
397        * Non-contiguous write part of which fits within
398        * the cache buffer and is extending the file.
399        */
400
401       size_t data_used;
402
403       if(pos + n <= wcp->offset + wcp->alloc_size)
404         data_used = n;
405       else
406         data_used = wcp->offset + wcp->alloc_size - pos;
407
408       /*
409        * Fill in the non-continuous area with zeros.
410        */
411
412       memset(wcp->data + wcp->data_size, '\0',
413              pos - (wcp->offset + wcp->data_size) );
414
415       memcpy(wcp->data + (pos - wcp->offset), data, data_used);
416
417       /*
418        * Update the current buffer size with the new data.
419        */
420
421       if(pos + data_used > wcp->offset + wcp->data_size)
422         wcp->data_size = pos + data_used - wcp->offset;
423
424       /*
425        * Update the known file length.
426        */
427
428       wcp->file_size = wcp->offset + wcp->data_size;
429
430 #if 0
431       if (set_filelen(fsp->fd, wcp->file_size) == -1) {
432         DEBUG(0,("write_file: error %s in setting file to length %.0f\n",
433           strerror(errno), (double)wcp->file_size ));
434         return -1;
435       }
436 #endif
437
438       /*
439        * If we used all the data then
440        * return here.
441        */
442
443       if(n == data_used)
444         return n;
445       else
446         cache_flush_needed = True;
447
448       /*
449        * Move the start of data forward by the amount used,
450        * cut down the amount left by the same amount.
451        */
452
453       data += data_used;
454       pos += data_used;
455       n -= data_used;
456
457       abutted_writes++;
458       total_written = data_used;
459
460       write_path = 3;
461
462     } else {
463
464       /*
465        * Write is bigger than buffer, or there is no overlap on the
466        * low or high ends.
467        */
468
469       DEBUG(9,("write_file: non cacheable write : fd = %d, pos = %.0f, len = %u, current cache pos = %.0f \
470 len = %u\n",fsp->fd, (double)pos, (unsigned int)n, (double)wcp->offset, (unsigned int)wcp->data_size ));
471
472       /*
473        * Update the file size if needed.
474        */
475
476       if(pos + n > wcp->file_size)
477         wcp->file_size = pos + n;
478
479       /*
480        * If write would fit in the cache, and is larger than
481        * the data already in the cache, flush the cache and
482        * preferentially copy the data new data into it. Otherwise
483        * just write the data directly.
484        */
485
486       if ( n <= wcp->alloc_size && n > wcp->data_size) {
487         cache_flush_needed = True;
488       } else {
489         direct_writes++;
490         return real_write_file(fsp, data, pos, n);
491       }
492
493       write_path = 4;
494
495     }
496
497     if(wcp->data_size > wcp->file_size)
498       wcp->file_size = wcp->data_size;
499
500     if (cache_flush_needed) {
501       flushed_writes++;
502
503       DEBUG(3,("WRITE_FLUSH:%d: due to noncontinuous write: fd = %d, size = %.0f, pos = %.0f, \
504 n = %u, wcp->offset=%.0f, wcp->data_size=%u\n",
505              write_path, fsp->fd, (double)wcp->file_size, (double)pos, (unsigned int)n,
506              (double)wcp->offset, (unsigned int)wcp->data_size ));
507
508       flush_write_cache(fsp, WRITE_FLUSH);
509     }
510   }
511
512   /*
513    * If the write request is bigger than the cache
514    * size, write it all out.
515    */
516
517   if (n > wcp->alloc_size ) {
518     if(real_write_file(fsp, data, pos, n) == -1)
519       return -1;
520     direct_writes++;
521     return total_written + n;
522   }
523
524   /*
525    * If there's any data left, cache it.
526    */
527
528   if (n) {
529     if (wcp->data_size) {
530       abutted_writes++;
531       DEBUG(9,("abutted write (%u)\n", abutted_writes));
532     } else {
533       init_writes++;
534     }
535     memcpy(wcp->data+wcp->data_size, data, n);
536     if (wcp->data_size == 0) {
537       wcp->offset = pos;
538       num_write_caches++;
539     }
540     wcp->data_size += n;
541     DEBUG(9,("cache return %u\n", (unsigned int)n));
542     total_written += n;
543     return total_written; /* .... that's a write :) */
544   }
545   
546   return total_written;
547 }
548
549 /****************************************************************************
550  Delete the write cache structure.
551 ****************************************************************************/
552
553 void delete_write_cache(files_struct *fsp)
554 {
555   write_cache *wcp;
556
557   if(!fsp)
558     return;
559
560   if(!(wcp = fsp->wcp))
561     return;
562
563   allocated_write_caches--;
564
565   SMB_ASSERT(wcp->data_size == 0);
566
567   free(wcp->data);
568   free(wcp);
569
570   fsp->wcp = NULL;
571 }
572
573 /****************************************************************************
574  Setup the write cache structure.
575 ****************************************************************************/
576
577 static BOOL setup_write_cache(files_struct *fsp, SMB_OFF_T file_size)
578 {
579   ssize_t alloc_size = lp_write_cache_size(SNUM(fsp->conn));
580   write_cache *wcp;
581
582   if (allocated_write_caches >= MAX_WRITE_CACHES) return False;
583
584   if(alloc_size == 0 || fsp->wcp)
585     return False;
586
587   if((wcp = (write_cache *)malloc(sizeof(write_cache))) == NULL) {
588     DEBUG(0,("setup_write_cache: malloc fail.\n"));
589     return False;
590   }
591
592   wcp->file_size = file_size;
593   wcp->offset = 0;
594   wcp->alloc_size = alloc_size;
595   wcp->data_size = 0;
596   if((wcp->data = malloc(wcp->alloc_size)) == NULL) {
597     DEBUG(0,("setup_write_cache: malloc fail for buffer size %u.\n",
598           (unsigned int)wcp->alloc_size ));
599     free(wcp);
600     return False;
601   }
602
603   fsp->wcp = wcp;
604   allocated_write_caches++;
605
606   return True;
607 }
608
609 /****************************************************************************
610  Cope with a size change.
611 ****************************************************************************/
612
613 void set_filelen_write_cache(files_struct *fsp, SMB_OFF_T file_size)
614 {
615   if(fsp->wcp) {
616     flush_write_cache(fsp, SIZECHANGE_FLUSH);
617     fsp->wcp->file_size = file_size;
618   }
619 }
620
621 /*******************************************************************
622  Flush a write cache struct to disk.
623 ********************************************************************/
624
625 ssize_t flush_write_cache(files_struct *fsp, enum flush_reason_enum reason)
626 {
627   write_cache *wcp = fsp->wcp;
628   size_t data_size;
629
630   if(!wcp || !wcp->data_size)
631     return 0;
632
633   data_size = wcp->data_size;
634   wcp->data_size = 0;
635
636   num_write_caches--;
637
638   flush_reasons[(int)reason]++;
639
640   DEBUG(9,("flushing write cache: fd = %d, off=%.0f, size=%u\n",
641            fsp->fd, (double)wcp->offset, (unsigned int)data_size));
642
643   if(data_size == wcp->alloc_size)
644     num_perfect_writes++;
645
646   return real_write_file(fsp, wcp->data, wcp->offset, data_size);
647 }
648
649 /*******************************************************************
650 sync a file
651 ********************************************************************/
652
653 void sync_file(connection_struct *conn, files_struct *fsp)
654 {
655     if(lp_strict_sync(SNUM(conn)) && fsp->fd != -1) {
656       flush_write_cache(fsp, SYNC_FLUSH);
657       conn->vfs_ops.fsync(fsp->fd);
658     }
659 }