Ok - fixed a bug in our levelII oplock code. We need to break a level II on
[tprouty/samba.git] / source / smbd / fileio.c
1 #define OLD_NTDOMAIN 1
2 /* 
3    Unix SMB/Netbios implementation.
4    Version 1.9.
5    read/write to a files_struct
6    Copyright (C) Andrew Tridgell 1992-1998
7    
8    This program is free software; you can redistribute it and/or modify
9    it under the terms of the GNU General Public License as published by
10    the Free Software Foundation; either version 2 of the License, or
11    (at your option) any later version.
12    
13    This program is distributed in the hope that it will be useful,
14    but WITHOUT ANY WARRANTY; without even the implied warranty of
15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16    GNU General Public License for more details.
17    
18    You should have received a copy of the GNU General Public License
19    along with this program; if not, write to the Free Software
20    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 */
22
23 #include "includes.h"
24
25 extern int DEBUGLEVEL;
26
27 static BOOL setup_write_cache(files_struct *, SMB_OFF_T);
28
29 /****************************************************************************
30 seek a file. Try to avoid the seek if possible
31 ****************************************************************************/
32
33 SMB_OFF_T seek_file(files_struct *fsp,SMB_OFF_T pos)
34 {
35   SMB_OFF_T offset = 0;
36   SMB_OFF_T seek_ret;
37
38   if (fsp->print_file && lp_postscript(fsp->conn->service))
39     offset = 3;
40
41   seek_ret = fsp->conn->vfs_ops.lseek(fsp,fsp->fd,pos+offset,SEEK_SET);
42
43   /*
44    * We want to maintain the fiction that we can seek
45    * on a fifo for file system purposes. This allows 
46    * people to set up UNIX fifo's that feed data to Windows
47    * applications. JRA.
48    */
49
50   if((seek_ret == -1) && (errno == ESPIPE)) {
51     seek_ret = pos+offset;
52     errno = 0;
53   }
54
55   if((seek_ret == -1) || (seek_ret != pos+offset)) {
56     DEBUG(0,("seek_file: sys_lseek failed. Error was %s\n", strerror(errno) ));
57     fsp->pos = -1;
58     return -1;
59   }
60
61   fsp->pos = seek_ret - offset;
62
63   DEBUG(10,("seek_file: requested pos = %.0f, new pos = %.0f\n",
64         (double)(pos+offset), (double)fsp->pos ));
65
66   return(fsp->pos);
67 }
68
69 /****************************************************************************
70  Read from write cache if we can.
71 ****************************************************************************/
72
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   DO_PROFILE_INC(writecache_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,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 /* how many write cache buffers have been allocated */
128 static unsigned int allocated_write_caches;
129
130 /****************************************************************************
131  *Really* write to a file.
132 ****************************************************************************/
133
134 static ssize_t real_write_file(files_struct *fsp,char *data,SMB_OFF_T pos, size_t n)
135 {
136   if ((pos != -1) && (seek_file(fsp,pos) == -1))
137     return -1;
138
139   return vfs_write_data(fsp,data,n);
140 }
141
142 /****************************************************************************
143 write to a file
144 ****************************************************************************/
145
146 ssize_t write_file(files_struct *fsp, char *data, SMB_OFF_T pos, size_t n)
147 {
148   write_cache *wcp = fsp->wcp;
149   ssize_t total_written = 0;
150   int write_path = -1; 
151
152   if (fsp->print_file) {
153           return print_job_write(fsp->print_jobid, data, n);
154   }
155
156   if (!fsp->can_write) {
157     errno = EPERM;
158     return(0);
159   }
160
161   if (!fsp->modified) {
162     SMB_STRUCT_STAT st;
163     fsp->modified = True;
164
165     if (fsp->conn->vfs_ops.fstat(fsp,fsp->fd,&st) == 0) {
166       int dosmode = dos_mode(fsp->conn,fsp->fsp_name,&st);
167       if (MAP_ARCHIVE(fsp->conn) && !IS_DOS_ARCHIVE(dosmode)) { 
168         file_chmod(fsp->conn,fsp->fsp_name,dosmode | aARCH,&st);
169       }
170
171       /*
172        * If this is the first write and we have an exclusive oplock then setup
173        * the write cache.
174        */
175
176       if (EXCLUSIVE_OPLOCK_TYPE(fsp->oplock_type) && !wcp) {
177         setup_write_cache(fsp, st.st_size);
178         wcp = fsp->wcp;
179       } 
180     }  
181   }
182
183 #ifdef WITH_PROFILE
184   DO_PROFILE_INC(writecache_total_writes);
185   if (!fsp->oplock_type) {
186     DO_PROFILE_INC(writecache_non_oplock_writes);
187   }
188 #endif
189
190   /*
191    * If this file is level II oplocked then we need
192    * to grab the shared memory lock and inform all
193    * other files with a level II lock that they need
194    * to flush their read caches. We keep the lock over
195    * the shared memory area whilst doing this.
196    */
197
198   release_level_2_oplocks_on_change(fsp);
199
200 #ifdef WITH_PROFILE
201   if (profile_p && profile_p->writecache_total_writes % 500 == 0) {
202     DEBUG(3,("WRITECACHE: initwrites=%u abutted=%u total=%u \
203 nonop=%u allocated=%u active=%u direct=%u perfect=%u readhits=%u\n",
204         profile_p->writecache_init_writes,
205         profile_p->writecache_abutted_writes,
206         profile_p->writecache_total_writes,
207         profile_p->writecache_non_oplock_writes,
208         profile_p->writecache_allocated_write_caches,
209         profile_p->writecache_num_write_caches,
210         profile_p->writecache_direct_writes,
211         profile_p->writecache_num_perfect_writes,
212         profile_p->writecache_read_hits ));
213
214     DEBUG(3,("WRITECACHE: Flushes SEEK=%d, READ=%d, WRITE=%d, READRAW=%d, OPLOCK=%d, CLOSE=%d, SYNC=%d\n",
215         profile_p->writecache_flushed_writes[SEEK_FLUSH],
216         profile_p->writecache_flushed_writes[READ_FLUSH],
217         profile_p->writecache_flushed_writes[WRITE_FLUSH],
218         profile_p->writecache_flushed_writes[READRAW_FLUSH],
219         profile_p->writecache_flushed_writes[OPLOCK_RELEASE_FLUSH],
220         profile_p->writecache_flushed_writes[CLOSE_FLUSH],
221         profile_p->writecache_flushed_writes[SYNC_FLUSH] ));
222   }
223 #endif
224
225   if(!wcp) {
226     DO_PROFILE_INC(writecache_direct_writes);
227     return real_write_file(fsp, data, pos, n);
228   }
229
230   DEBUG(9,("write_file(fd=%d pos=%d size=%d) wofs=%d wsize=%d\n",
231            fsp->fd, (int)pos, (int)n, (int)wcp->offset, (int)wcp->data_size));
232
233   /* 
234    * If we have active cache and it isn't contiguous then we flush.
235    * NOTE: There is a small problem with running out of disk ....
236    */
237
238   if (wcp->data_size) {
239
240     BOOL cache_flush_needed = False;
241
242     if ((pos >= wcp->offset) && (pos <= wcp->offset + wcp->data_size)) {
243       
244       /*
245        * Start of write overlaps or abutts the existing data.
246        */
247
248       size_t data_used = MIN((wcp->alloc_size - (pos - wcp->offset)), n);
249
250       memcpy(wcp->data + (pos - wcp->offset), data, data_used);
251
252       /*
253        * Update the current buffer size with the new data.
254        */
255
256       if(pos + data_used > wcp->offset + wcp->data_size)
257         wcp->data_size = pos + data_used - wcp->offset;
258
259       /*
260        * If we used all the data then
261        * return here.
262        */
263
264       if(n == data_used)
265         return n;
266       else
267         cache_flush_needed = True;
268
269       /*
270        * Move the start of data forward by the amount used,
271        * cut down the amount left by the same amount.
272        */
273
274       data += data_used;
275       pos += data_used;
276       n -= data_used;
277
278       DO_PROFILE_INC(writecache_abutted_writes);
279       total_written = data_used;
280
281       write_path = 1;
282
283     } else if ((pos < wcp->offset) && (pos + n > wcp->offset) && 
284                (pos + n <= wcp->offset + wcp->alloc_size)) {
285
286       /*
287        * End of write overlaps the existing data.
288        */
289
290       size_t data_used = pos + n - wcp->offset;
291
292       memcpy(wcp->data, data + n - data_used, data_used);
293
294       /*
295        * Update the current buffer size with the new data.
296        */
297
298       if(pos + n > wcp->offset + wcp->data_size)
299         wcp->data_size = pos + n - wcp->offset;
300
301       /*
302        * We don't need to move the start of data, but we
303        * cut down the amount left by the amount used.
304        */
305
306       n -= data_used;
307
308       /*
309        * We cannot have used all the data here.
310        */
311
312       cache_flush_needed = True;
313
314       DO_PROFILE_INC(writecache_abutted_writes);
315       total_written = data_used;
316
317       write_path = 2;
318
319     } else if ( (pos >= wcp->file_size) && 
320                 (pos > wcp->offset + wcp->data_size) && 
321                 (pos < wcp->offset + wcp->alloc_size) ) {
322
323       /*
324        * Non-contiguous write part of which fits within
325        * the cache buffer and is extending the file.
326        */
327
328       size_t data_used;
329
330       if(pos + n <= wcp->offset + wcp->alloc_size)
331         data_used = n;
332       else
333         data_used = wcp->offset + wcp->alloc_size - pos;
334
335       /*
336        * Fill in the non-continuous area with zeros.
337        */
338
339       memset(wcp->data + wcp->data_size, '\0',
340              pos - (wcp->offset + wcp->data_size) );
341
342       memcpy(wcp->data + (pos - wcp->offset), data, data_used);
343
344       /*
345        * Update the current buffer size with the new data.
346        */
347
348       if(pos + data_used > wcp->offset + wcp->data_size)
349         wcp->data_size = pos + data_used - wcp->offset;
350
351       /*
352        * Update the known file length.
353        */
354
355       wcp->file_size = wcp->offset + wcp->data_size;
356
357       /*
358        * If we used all the data then
359        * return here.
360        */
361
362       if(n == data_used)
363         return n;
364       else
365         cache_flush_needed = True;
366
367       /*
368        * Move the start of data forward by the amount used,
369        * cut down the amount left by the same amount.
370        */
371
372       data += data_used;
373       pos += data_used;
374       n -= data_used;
375
376       DO_PROFILE_INC(writecache_abutted_writes);
377       total_written = data_used;
378
379       write_path = 3;
380
381     } else {
382
383       /*
384        * Write is bigger than buffer, or there is no overlap on the
385        * low or high ends.
386        */
387
388       DEBUG(9,("write_file: non cacheable write : fd = %d, pos = %.0f, len = %u, current cache pos = %.0f \
389 len = %u\n",fsp->fd, (double)pos, (unsigned int)n, (double)wcp->offset, (unsigned int)wcp->data_size ));
390
391       /*
392        * Update the file size if needed.
393        */
394
395       if(pos + n > wcp->file_size)
396         wcp->file_size = pos + n;
397
398       /*
399        * If write would fit in the cache, and is larger than
400        * the data already in the cache, flush the cache and
401        * preferentially copy the data new data into it. Otherwise
402        * just write the data directly.
403        */
404
405       if ( n <= wcp->alloc_size && n > wcp->data_size) {
406         cache_flush_needed = True;
407       } else {
408         DO_PROFILE_INC(writecache_direct_writes);
409         return real_write_file(fsp, data, pos, n);
410       }
411
412       write_path = 4;
413
414     }
415
416     if(wcp->data_size > wcp->file_size)
417       wcp->file_size = wcp->data_size;
418
419     if (cache_flush_needed) {
420       DEBUG(3,("WRITE_FLUSH:%d: due to noncontinuous write: fd = %d, size = %.0f, pos = %.0f, \
421 n = %u, wcp->offset=%.0f, wcp->data_size=%u\n",
422              write_path, fsp->fd, (double)wcp->file_size, (double)pos, (unsigned int)n,
423              (double)wcp->offset, (unsigned int)wcp->data_size ));
424
425       flush_write_cache(fsp, WRITE_FLUSH);
426     }
427   }
428
429   /*
430    * If the write request is bigger than the cache
431    * size, write it all out.
432    */
433
434   if (n > wcp->alloc_size ) {
435     if(real_write_file(fsp, data, pos, n) == -1)
436       return -1;
437     DO_PROFILE_INC(writecache_direct_writes);
438     return total_written + n;
439   }
440
441   /*
442    * If there's any data left, cache it.
443    */
444
445   if (n) {
446 #ifdef WITH_PROFILE
447     if (wcp->data_size) {
448       DO_PROFILE_INC(writecache_abutted_writes);
449     } else {
450       DO_PROFILE_INC(writecache_init_writes);
451     }
452 #endif
453     memcpy(wcp->data+wcp->data_size, data, n);
454     if (wcp->data_size == 0) {
455       wcp->offset = pos;
456       DO_PROFILE_INC(writecache_num_write_caches);
457     }
458     wcp->data_size += n;
459     DEBUG(9,("cache return %u\n", (unsigned int)n));
460     total_written += n;
461     return total_written; /* .... that's a write :) */
462   }
463   
464   return total_written;
465 }
466
467 /****************************************************************************
468  Delete the write cache structure.
469 ****************************************************************************/
470
471 void delete_write_cache(files_struct *fsp)
472 {
473   write_cache *wcp;
474
475   if(!fsp)
476     return;
477
478   if(!(wcp = fsp->wcp))
479     return;
480
481   DO_PROFILE_DEC(writecache_allocated_write_caches);
482   allocated_write_caches--;
483
484   SMB_ASSERT(wcp->data_size == 0);
485
486   free(wcp->data);
487   free(wcp);
488
489   fsp->wcp = NULL;
490
491   DEBUG(10,("delete_write_cache: File %s deleted write cache\n", fsp->fsp_name ));
492
493 }
494
495 /****************************************************************************
496  Setup the write cache structure.
497 ****************************************************************************/
498
499 static BOOL setup_write_cache(files_struct *fsp, SMB_OFF_T file_size)
500 {
501   ssize_t alloc_size = lp_write_cache_size(SNUM(fsp->conn));
502   write_cache *wcp;
503
504   if (allocated_write_caches >= MAX_WRITE_CACHES) 
505         return False;
506
507   if(alloc_size == 0 || fsp->wcp)
508     return False;
509
510   if((wcp = (write_cache *)malloc(sizeof(write_cache))) == NULL) {
511     DEBUG(0,("setup_write_cache: malloc fail.\n"));
512     return False;
513   }
514
515   wcp->file_size = file_size;
516   wcp->offset = 0;
517   wcp->alloc_size = alloc_size;
518   wcp->data_size = 0;
519   if((wcp->data = malloc(wcp->alloc_size)) == NULL) {
520     DEBUG(0,("setup_write_cache: malloc fail for buffer size %u.\n",
521           (unsigned int)wcp->alloc_size ));
522     free(wcp);
523     return False;
524   }
525
526   fsp->wcp = wcp;
527   DO_PROFILE_INC(writecache_allocated_write_caches);
528   allocated_write_caches++;
529
530   DEBUG(10,("setup_write_cache: File %s allocated write cache size %u\n",
531                 fsp->fsp_name, wcp->alloc_size ));
532
533   return True;
534 }
535
536 /****************************************************************************
537  Cope with a size change.
538 ****************************************************************************/
539
540 void set_filelen_write_cache(files_struct *fsp, SMB_OFF_T file_size)
541 {
542   if(fsp->wcp) {
543     flush_write_cache(fsp, SIZECHANGE_FLUSH);
544     fsp->wcp->file_size = file_size;
545   }
546 }
547
548 /*******************************************************************
549  Flush a write cache struct to disk.
550 ********************************************************************/
551
552 ssize_t flush_write_cache(files_struct *fsp, enum flush_reason_enum reason)
553 {
554   write_cache *wcp = fsp->wcp;
555   size_t data_size;
556
557   if(!wcp || !wcp->data_size)
558     return 0;
559
560   data_size = wcp->data_size;
561   wcp->data_size = 0;
562
563   DO_PROFILE_DEC_INC(writecache_num_write_caches,writecache_flushed_writes[reason]);
564
565   DEBUG(9,("flushing write cache: fd = %d, off=%.0f, size=%u\n",
566            fsp->fd, (double)wcp->offset, (unsigned int)data_size));
567
568 #ifdef WITH_PROFILE
569   if(data_size == wcp->alloc_size)
570     DO_PROFILE_INC(writecache_num_perfect_writes);
571 #endif
572
573   return real_write_file(fsp, wcp->data, wcp->offset, data_size);
574 }
575
576 /*******************************************************************
577 sync a file
578 ********************************************************************/
579
580 void sync_file(connection_struct *conn, files_struct *fsp)
581 {
582     if(lp_strict_sync(SNUM(conn)) && fsp->fd != -1) {
583       flush_write_cache(fsp, SYNC_FLUSH);
584       conn->vfs_ops.fsync(fsp,fsp->fd);
585     }
586 }
587 #undef OLD_NTDOMAIN