]> git.saurik.com Git - apple/xnu.git/blob - bsd/nfs/nfs_bio.c
a58e5d866ab4899add3726b19fa39f0b408e2420
[apple/xnu.git] / bsd / nfs / nfs_bio.c
1 /*
2 * Copyright (c) 2000-2014 Apple Inc. All rights reserved.
3 *
4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5 *
6 * This file contains Original Code and/or Modifications of Original Code
7 * as defined in and that are subject to the Apple Public Source License
8 * Version 2.0 (the 'License'). You may not use this file except in
9 * compliance with the License. The rights granted to you under the License
10 * may not be used to create, or enable the creation or redistribution of,
11 * unlawful or unlicensed copies of an Apple operating system, or to
12 * circumvent, violate, or enable the circumvention or violation of, any
13 * terms of an Apple operating system software license agreement.
14 *
15 * Please obtain a copy of the License at
16 * http://www.opensource.apple.com/apsl/ and read it before using this file.
17 *
18 * The Original Code and all software distributed under the License are
19 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23 * Please see the License for the specific language governing rights and
24 * limitations under the License.
25 *
26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27 */
28 /* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
29 /*
30 * Copyright (c) 1989, 1993
31 * The Regents of the University of California. All rights reserved.
32 *
33 * This code is derived from software contributed to Berkeley by
34 * Rick Macklem at The University of Guelph.
35 *
36 * Redistribution and use in source and binary forms, with or without
37 * modification, are permitted provided that the following conditions
38 * are met:
39 * 1. Redistributions of source code must retain the above copyright
40 * notice, this list of conditions and the following disclaimer.
41 * 2. Redistributions in binary form must reproduce the above copyright
42 * notice, this list of conditions and the following disclaimer in the
43 * documentation and/or other materials provided with the distribution.
44 * 3. All advertising materials mentioning features or use of this software
45 * must display the following acknowledgement:
46 * This product includes software developed by the University of
47 * California, Berkeley and its contributors.
48 * 4. Neither the name of the University nor the names of its contributors
49 * may be used to endorse or promote products derived from this software
50 * without specific prior written permission.
51 *
52 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
53 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
54 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
55 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
56 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
57 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
58 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
59 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
60 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
61 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
62 * SUCH DAMAGE.
63 *
64 * @(#)nfs_bio.c 8.9 (Berkeley) 3/30/95
65 * FreeBSD-Id: nfs_bio.c,v 1.44 1997/09/10 19:52:25 phk Exp $
66 */
67 #include <sys/param.h>
68 #include <sys/systm.h>
69 #include <sys/resourcevar.h>
70 #include <sys/signalvar.h>
71 #include <sys/proc_internal.h>
72 #include <sys/kauth.h>
73 #include <sys/malloc.h>
74 #include <sys/vnode.h>
75 #include <sys/dirent.h>
76 #include <sys/mount_internal.h>
77 #include <sys/kernel.h>
78 #include <sys/ubc_internal.h>
79 #include <sys/uio_internal.h>
80 #include <sys/kpi_mbuf.h>
81
82 #include <sys/vm.h>
83 #include <sys/vmparam.h>
84
85 #include <sys/time.h>
86 #include <kern/clock.h>
87 #include <libkern/OSAtomic.h>
88 #include <kern/kalloc.h>
89 #include <kern/thread_call.h>
90
91 #include <nfs/rpcv2.h>
92 #include <nfs/nfsproto.h>
93 #include <nfs/nfs.h>
94 #include <nfs/nfs_gss.h>
95 #include <nfs/nfsmount.h>
96 #include <nfs/nfsnode.h>
97 #include <sys/buf_internal.h>
98 #include <libkern/OSAtomic.h>
99
100 kern_return_t thread_terminate(thread_t); /* XXX */
101
102 #define NFSBUFHASH(np, lbn) \
103 (&nfsbufhashtbl[((long)(np) / sizeof(*(np)) + (int)(lbn)) & nfsbufhash])
104 LIST_HEAD(nfsbufhashhead, nfsbuf) *nfsbufhashtbl;
105 struct nfsbuffreehead nfsbuffree, nfsbuffreemeta, nfsbufdelwri;
106 u_long nfsbufhash;
107 int nfsbufcnt, nfsbufmin, nfsbufmax, nfsbufmetacnt, nfsbufmetamax;
108 int nfsbuffreecnt, nfsbuffreemetacnt, nfsbufdelwricnt, nfsneedbuffer;
109 int nfs_nbdwrite;
110 int nfs_buf_timer_on = 0;
111 thread_t nfsbufdelwrithd = NULL;
112
113 lck_grp_t *nfs_buf_lck_grp;
114 lck_mtx_t *nfs_buf_mutex;
115
116 #define NFSBUF_FREE_PERIOD 30 /* seconds */
117 #define NFSBUF_LRU_STALE 120
118 #define NFSBUF_META_STALE 240
119
120 /* number of nfsbufs nfs_buf_freeup() should attempt to free from nfsbuffree list */
121 #define LRU_TO_FREEUP 6
122 /* number of nfsbufs nfs_buf_freeup() should attempt to free from nfsbuffreemeta list */
123 #define META_TO_FREEUP 3
124 /* total number of nfsbufs nfs_buf_freeup() should attempt to free */
125 #define TOTAL_TO_FREEUP (LRU_TO_FREEUP+META_TO_FREEUP)
126 /* fraction of nfsbufs nfs_buf_freeup() should attempt to free from nfsbuffree list when called from timer */
127 #define LRU_FREEUP_FRAC_ON_TIMER 8
128 /* fraction of nfsbufs nfs_buf_freeup() should attempt to free from nfsbuffreemeta list when called from timer */
129 #define META_FREEUP_FRAC_ON_TIMER 16
130 /* fraction of total nfsbufs that nfsbuffreecnt should exceed before bothering to call nfs_buf_freeup() */
131 #define LRU_FREEUP_MIN_FRAC 4
132 /* fraction of total nfsbufs that nfsbuffreemetacnt should exceed before bothering to call nfs_buf_freeup() */
133 #define META_FREEUP_MIN_FRAC 2
134
135 #define NFS_BUF_FREEUP() \
136 do { \
137 /* only call nfs_buf_freeup() if it has work to do: */ \
138 if (((nfsbuffreecnt > nfsbufcnt/LRU_FREEUP_MIN_FRAC) || \
139 (nfsbuffreemetacnt > nfsbufcnt/META_FREEUP_MIN_FRAC)) && \
140 ((nfsbufcnt - TOTAL_TO_FREEUP) > nfsbufmin)) \
141 nfs_buf_freeup(0); \
142 } while (0)
143
144 /*
145 * Initialize nfsbuf lists
146 */
147 void
148 nfs_nbinit(void)
149 {
150 nfs_buf_lck_grp = lck_grp_alloc_init("nfs_buf", LCK_GRP_ATTR_NULL);
151 nfs_buf_mutex = lck_mtx_alloc_init(nfs_buf_lck_grp, LCK_ATTR_NULL);
152
153 nfsbufcnt = nfsbufmetacnt =
154 nfsbuffreecnt = nfsbuffreemetacnt = nfsbufdelwricnt = 0;
155 nfsbufmin = 128;
156 /* size nfsbufmax to cover at most half sane_size (w/default buf size) */
157 nfsbufmax = (sane_size >> PAGE_SHIFT) / (2 * (NFS_RWSIZE >> PAGE_SHIFT));
158 nfsbufmetamax = nfsbufmax / 4;
159 nfsneedbuffer = 0;
160 nfs_nbdwrite = 0;
161
162 nfsbufhashtbl = hashinit(nfsbufmax/4, M_TEMP, &nfsbufhash);
163 TAILQ_INIT(&nfsbuffree);
164 TAILQ_INIT(&nfsbuffreemeta);
165 TAILQ_INIT(&nfsbufdelwri);
166
167 }
168
169 /*
170 * Check periodically for stale/unused nfs bufs
171 */
172 void
173 nfs_buf_timer(__unused void *param0, __unused void *param1)
174 {
175 nfs_buf_freeup(1);
176
177 lck_mtx_lock(nfs_buf_mutex);
178 if (nfsbufcnt <= nfsbufmin) {
179 nfs_buf_timer_on = 0;
180 lck_mtx_unlock(nfs_buf_mutex);
181 return;
182 }
183 lck_mtx_unlock(nfs_buf_mutex);
184
185 nfs_interval_timer_start(nfs_buf_timer_call,
186 NFSBUF_FREE_PERIOD * 1000);
187 }
188
189 /*
190 * try to free up some excess, unused nfsbufs
191 */
192 void
193 nfs_buf_freeup(int timer)
194 {
195 struct nfsbuf *fbp;
196 struct timeval now;
197 int count;
198 struct nfsbuffreehead nfsbuffreeup;
199
200 TAILQ_INIT(&nfsbuffreeup);
201
202 lck_mtx_lock(nfs_buf_mutex);
203
204 microuptime(&now);
205
206 FSDBG(320, nfsbufcnt, nfsbuffreecnt, nfsbuffreemetacnt, 0);
207
208 count = timer ? nfsbuffreecnt/LRU_FREEUP_FRAC_ON_TIMER : LRU_TO_FREEUP;
209 while ((nfsbufcnt > nfsbufmin) && (count-- > 0)) {
210 fbp = TAILQ_FIRST(&nfsbuffree);
211 if (!fbp)
212 break;
213 if (fbp->nb_refs)
214 break;
215 if (NBUFSTAMPVALID(fbp) &&
216 (fbp->nb_timestamp + (2*NFSBUF_LRU_STALE)) > now.tv_sec)
217 break;
218 nfs_buf_remfree(fbp);
219 /* disassociate buffer from any nfsnode */
220 if (fbp->nb_np) {
221 if (fbp->nb_vnbufs.le_next != NFSNOLIST) {
222 LIST_REMOVE(fbp, nb_vnbufs);
223 fbp->nb_vnbufs.le_next = NFSNOLIST;
224 }
225 fbp->nb_np = NULL;
226 }
227 LIST_REMOVE(fbp, nb_hash);
228 TAILQ_INSERT_TAIL(&nfsbuffreeup, fbp, nb_free);
229 nfsbufcnt--;
230 }
231
232 count = timer ? nfsbuffreemetacnt/META_FREEUP_FRAC_ON_TIMER : META_TO_FREEUP;
233 while ((nfsbufcnt > nfsbufmin) && (count-- > 0)) {
234 fbp = TAILQ_FIRST(&nfsbuffreemeta);
235 if (!fbp)
236 break;
237 if (fbp->nb_refs)
238 break;
239 if (NBUFSTAMPVALID(fbp) &&
240 (fbp->nb_timestamp + (2*NFSBUF_META_STALE)) > now.tv_sec)
241 break;
242 nfs_buf_remfree(fbp);
243 /* disassociate buffer from any nfsnode */
244 if (fbp->nb_np) {
245 if (fbp->nb_vnbufs.le_next != NFSNOLIST) {
246 LIST_REMOVE(fbp, nb_vnbufs);
247 fbp->nb_vnbufs.le_next = NFSNOLIST;
248 }
249 fbp->nb_np = NULL;
250 }
251 LIST_REMOVE(fbp, nb_hash);
252 TAILQ_INSERT_TAIL(&nfsbuffreeup, fbp, nb_free);
253 nfsbufcnt--;
254 nfsbufmetacnt--;
255 }
256
257 FSDBG(320, nfsbufcnt, nfsbuffreecnt, nfsbuffreemetacnt, 0);
258 NFSBUFCNTCHK();
259
260 lck_mtx_unlock(nfs_buf_mutex);
261
262 while ((fbp = TAILQ_FIRST(&nfsbuffreeup))) {
263 TAILQ_REMOVE(&nfsbuffreeup, fbp, nb_free);
264 /* nuke any creds */
265 if (IS_VALID_CRED(fbp->nb_rcred))
266 kauth_cred_unref(&fbp->nb_rcred);
267 if (IS_VALID_CRED(fbp->nb_wcred))
268 kauth_cred_unref(&fbp->nb_wcred);
269 /* if buf was NB_META, dump buffer */
270 if (ISSET(fbp->nb_flags, NB_META) && fbp->nb_data)
271 kfree(fbp->nb_data, fbp->nb_bufsize);
272 FREE(fbp, M_TEMP);
273 }
274
275 }
276
277 /*
278 * remove a buffer from the freelist
279 * (must be called with nfs_buf_mutex held)
280 */
281 void
282 nfs_buf_remfree(struct nfsbuf *bp)
283 {
284 if (bp->nb_free.tqe_next == NFSNOLIST)
285 panic("nfsbuf not on free list");
286 if (ISSET(bp->nb_flags, NB_DELWRI)) {
287 nfsbufdelwricnt--;
288 TAILQ_REMOVE(&nfsbufdelwri, bp, nb_free);
289 } else if (ISSET(bp->nb_flags, NB_META)) {
290 nfsbuffreemetacnt--;
291 TAILQ_REMOVE(&nfsbuffreemeta, bp, nb_free);
292 } else {
293 nfsbuffreecnt--;
294 TAILQ_REMOVE(&nfsbuffree, bp, nb_free);
295 }
296 bp->nb_free.tqe_next = NFSNOLIST;
297 NFSBUFCNTCHK();
298 }
299
300 /*
301 * check for existence of nfsbuf in cache
302 */
303 boolean_t
304 nfs_buf_is_incore(nfsnode_t np, daddr64_t blkno)
305 {
306 boolean_t rv;
307 lck_mtx_lock(nfs_buf_mutex);
308 if (nfs_buf_incore(np, blkno))
309 rv = TRUE;
310 else
311 rv = FALSE;
312 lck_mtx_unlock(nfs_buf_mutex);
313 return (rv);
314 }
315
316 /*
317 * return incore buffer (must be called with nfs_buf_mutex held)
318 */
319 struct nfsbuf *
320 nfs_buf_incore(nfsnode_t np, daddr64_t blkno)
321 {
322 /* Search hash chain */
323 struct nfsbuf * bp = NFSBUFHASH(np, blkno)->lh_first;
324 for (; bp != NULL; bp = bp->nb_hash.le_next)
325 if ((bp->nb_lblkno == blkno) && (bp->nb_np == np)) {
326 if (!ISSET(bp->nb_flags, NB_INVAL)) {
327 FSDBG(547, bp, blkno, bp->nb_flags, bp->nb_np);
328 return (bp);
329 }
330 }
331 return (NULL);
332 }
333
334 /*
335 * Check if it's OK to drop a page.
336 *
337 * Called by vnode_pager() on pageout request of non-dirty page.
338 * We need to make sure that it's not part of a delayed write.
339 * If it is, we can't let the VM drop it because we may need it
340 * later when/if we need to write the data (again).
341 */
342 int
343 nfs_buf_page_inval(vnode_t vp, off_t offset)
344 {
345 struct nfsmount *nmp = VTONMP(vp);
346 struct nfsbuf *bp;
347 int error = 0;
348
349 if (nfs_mount_gone(nmp))
350 return (ENXIO);
351
352 lck_mtx_lock(nfs_buf_mutex);
353 bp = nfs_buf_incore(VTONFS(vp), (daddr64_t)(offset / nmp->nm_biosize));
354 if (!bp)
355 goto out;
356 FSDBG(325, bp, bp->nb_flags, bp->nb_dirtyoff, bp->nb_dirtyend);
357 if (ISSET(bp->nb_lflags, NBL_BUSY)) {
358 error = EBUSY;
359 goto out;
360 }
361 /*
362 * If there's a dirty range in the buffer, check to
363 * see if this page intersects with the dirty range.
364 * If it does, we can't let the pager drop the page.
365 */
366 if (bp->nb_dirtyend > 0) {
367 int start = offset - NBOFF(bp);
368 if ((bp->nb_dirtyend > start) &&
369 (bp->nb_dirtyoff < (start + PAGE_SIZE))) {
370 /*
371 * Before returning the bad news, move the
372 * buffer to the start of the delwri list and
373 * give the list a push to try to flush the
374 * buffer out.
375 */
376 error = EBUSY;
377 nfs_buf_remfree(bp);
378 TAILQ_INSERT_HEAD(&nfsbufdelwri, bp, nb_free);
379 nfsbufdelwricnt++;
380 nfs_buf_delwri_push(1);
381 }
382 }
383 out:
384 lck_mtx_unlock(nfs_buf_mutex);
385 return (error);
386 }
387
388 /*
389 * set up the UPL for a buffer
390 * (must NOT be called with nfs_buf_mutex held)
391 */
392 int
393 nfs_buf_upl_setup(struct nfsbuf *bp)
394 {
395 kern_return_t kret;
396 upl_t upl;
397 int upl_flags;
398
399 if (ISSET(bp->nb_flags, NB_PAGELIST))
400 return (0);
401
402 upl_flags = UPL_PRECIOUS;
403 if (!ISSET(bp->nb_flags, NB_READ)) {
404 /*
405 * We're doing a "write", so we intend to modify
406 * the pages we're gathering.
407 */
408 upl_flags |= UPL_WILL_MODIFY;
409 }
410 kret = ubc_create_upl(NFSTOV(bp->nb_np), NBOFF(bp), bp->nb_bufsize,
411 &upl, NULL, upl_flags);
412 if (kret == KERN_INVALID_ARGUMENT) {
413 /* vm object probably doesn't exist any more */
414 bp->nb_pagelist = NULL;
415 return (EINVAL);
416 }
417 if (kret != KERN_SUCCESS) {
418 printf("nfs_buf_upl_setup(): failed to get pagelist %d\n", kret);
419 bp->nb_pagelist = NULL;
420 return (EIO);
421 }
422
423 FSDBG(538, bp, NBOFF(bp), bp->nb_bufsize, bp->nb_np);
424
425 bp->nb_pagelist = upl;
426 SET(bp->nb_flags, NB_PAGELIST);
427 return (0);
428 }
429
430 /*
431 * update buffer's valid/dirty info from UBC
432 * (must NOT be called with nfs_buf_mutex held)
433 */
434 void
435 nfs_buf_upl_check(struct nfsbuf *bp)
436 {
437 upl_page_info_t *pl;
438 off_t filesize, fileoffset;
439 int i, npages;
440
441 if (!ISSET(bp->nb_flags, NB_PAGELIST))
442 return;
443
444 npages = round_page_32(bp->nb_bufsize) / PAGE_SIZE;
445 filesize = ubc_getsize(NFSTOV(bp->nb_np));
446 fileoffset = NBOFF(bp);
447 if (fileoffset < filesize)
448 SET(bp->nb_flags, NB_CACHE);
449 else
450 CLR(bp->nb_flags, NB_CACHE);
451
452 pl = ubc_upl_pageinfo(bp->nb_pagelist);
453 bp->nb_valid = bp->nb_dirty = 0;
454
455 for (i=0; i < npages; i++, fileoffset += PAGE_SIZE_64) {
456 /* anything beyond the end of the file is not valid or dirty */
457 if (fileoffset >= filesize)
458 break;
459 if (!upl_valid_page(pl, i)) {
460 CLR(bp->nb_flags, NB_CACHE);
461 continue;
462 }
463 NBPGVALID_SET(bp,i);
464 if (upl_dirty_page(pl, i))
465 NBPGDIRTY_SET(bp, i);
466 }
467 fileoffset = NBOFF(bp);
468 if (ISSET(bp->nb_flags, NB_CACHE)) {
469 bp->nb_validoff = 0;
470 bp->nb_validend = bp->nb_bufsize;
471 if (fileoffset + bp->nb_validend > filesize)
472 bp->nb_validend = filesize - fileoffset;
473 } else {
474 bp->nb_validoff = bp->nb_validend = -1;
475 }
476 FSDBG(539, bp, fileoffset, bp->nb_valid, bp->nb_dirty);
477 FSDBG(539, bp->nb_validoff, bp->nb_validend, bp->nb_dirtyoff, bp->nb_dirtyend);
478 }
479
480 /*
481 * make sure that a buffer is mapped
482 * (must NOT be called with nfs_buf_mutex held)
483 */
484 int
485 nfs_buf_map(struct nfsbuf *bp)
486 {
487 kern_return_t kret;
488
489 if (bp->nb_data)
490 return (0);
491 if (!ISSET(bp->nb_flags, NB_PAGELIST))
492 return (EINVAL);
493
494 kret = ubc_upl_map(bp->nb_pagelist, (vm_offset_t *)&(bp->nb_data));
495 if (kret != KERN_SUCCESS)
496 panic("nfs_buf_map: ubc_upl_map() failed with (%d)", kret);
497 if (bp->nb_data == 0)
498 panic("ubc_upl_map mapped 0");
499 FSDBG(540, bp, bp->nb_flags, NBOFF(bp), bp->nb_data);
500 return (0);
501 }
502
503 /*
504 * normalize an nfsbuf's valid range
505 *
506 * the read/write code guarantees that we'll always have a valid
507 * region that is an integral number of pages. If either end
508 * of the valid range isn't page-aligned, it gets corrected
509 * here as we extend the valid range through all of the
510 * contiguous valid pages.
511 */
512 void
513 nfs_buf_normalize_valid_range(nfsnode_t np, struct nfsbuf *bp)
514 {
515 int pg, npg;
516 /* pull validoff back to start of contiguous valid page range */
517 pg = bp->nb_validoff/PAGE_SIZE;
518 while (pg >= 0 && NBPGVALID(bp,pg))
519 pg--;
520 bp->nb_validoff = (pg+1) * PAGE_SIZE;
521 /* push validend forward to end of contiguous valid page range */
522 npg = bp->nb_bufsize/PAGE_SIZE;
523 pg = bp->nb_validend/PAGE_SIZE;
524 while (pg < npg && NBPGVALID(bp,pg))
525 pg++;
526 bp->nb_validend = pg * PAGE_SIZE;
527 /* clip to EOF */
528 if (NBOFF(bp) + bp->nb_validend > (off_t)np->n_size)
529 bp->nb_validend = np->n_size % bp->nb_bufsize;
530 }
531
532 /*
533 * process some entries on the delayed write queue
534 * (must be called with nfs_buf_mutex held)
535 */
536 void
537 nfs_buf_delwri_service(void)
538 {
539 struct nfsbuf *bp;
540 nfsnode_t np;
541 int error, i = 0;
542
543 while (i < 8 && (bp = TAILQ_FIRST(&nfsbufdelwri)) != NULL) {
544 np = bp->nb_np;
545 nfs_buf_remfree(bp);
546 nfs_buf_refget(bp);
547 while ((error = nfs_buf_acquire(bp, 0, 0, 0)) == EAGAIN);
548 nfs_buf_refrele(bp);
549 if (error)
550 break;
551 if (!bp->nb_np) {
552 /* buffer is no longer valid */
553 nfs_buf_drop(bp);
554 continue;
555 }
556 if (ISSET(bp->nb_flags, NB_NEEDCOMMIT))
557 nfs_buf_check_write_verifier(np, bp);
558 if (ISSET(bp->nb_flags, NB_NEEDCOMMIT)) {
559 /* put buffer at end of delwri list */
560 TAILQ_INSERT_TAIL(&nfsbufdelwri, bp, nb_free);
561 nfsbufdelwricnt++;
562 nfs_buf_drop(bp);
563 lck_mtx_unlock(nfs_buf_mutex);
564 nfs_flushcommits(np, 1);
565 } else {
566 SET(bp->nb_flags, NB_ASYNC);
567 lck_mtx_unlock(nfs_buf_mutex);
568 nfs_buf_write(bp);
569 }
570 i++;
571 lck_mtx_lock(nfs_buf_mutex);
572 }
573 }
574
575 /*
576 * thread to service the delayed write queue when asked
577 */
578 void
579 nfs_buf_delwri_thread(__unused void *arg, __unused wait_result_t wr)
580 {
581 struct timespec ts = { 30, 0 };
582 int error = 0;
583
584 lck_mtx_lock(nfs_buf_mutex);
585 while (!error) {
586 nfs_buf_delwri_service();
587 error = msleep(&nfsbufdelwrithd, nfs_buf_mutex, 0, "nfsbufdelwri", &ts);
588 }
589 nfsbufdelwrithd = NULL;
590 lck_mtx_unlock(nfs_buf_mutex);
591 thread_terminate(nfsbufdelwrithd);
592 }
593
594 /*
595 * try to push out some delayed/uncommitted writes
596 * ("locked" indicates whether nfs_buf_mutex is already held)
597 */
598 void
599 nfs_buf_delwri_push(int locked)
600 {
601 if (TAILQ_EMPTY(&nfsbufdelwri))
602 return;
603 if (!locked)
604 lck_mtx_lock(nfs_buf_mutex);
605 /* wake up the delayed write service thread */
606 if (nfsbufdelwrithd)
607 wakeup(&nfsbufdelwrithd);
608 else if (kernel_thread_start(nfs_buf_delwri_thread, NULL, &nfsbufdelwrithd) == KERN_SUCCESS)
609 thread_deallocate(nfsbufdelwrithd);
610 /* otherwise, try to do some of the work ourselves */
611 if (!nfsbufdelwrithd)
612 nfs_buf_delwri_service();
613 if (!locked)
614 lck_mtx_unlock(nfs_buf_mutex);
615 }
616
617 /*
618 * Get an nfs buffer.
619 *
620 * Returns errno on error, 0 otherwise.
621 * Any buffer is returned in *bpp.
622 *
623 * If NBLK_ONLYVALID is set, only return buffer if found in cache.
624 * If NBLK_NOWAIT is set, don't wait for the buffer if it's marked BUSY.
625 *
626 * Check for existence of buffer in cache.
627 * Or attempt to reuse a buffer from one of the free lists.
628 * Or allocate a new buffer if we haven't already hit max allocation.
629 * Or wait for a free buffer.
630 *
631 * If available buffer found, prepare it, and return it.
632 *
633 * If the calling process is interrupted by a signal for
634 * an interruptible mount point, return EINTR.
635 */
636 int
637 nfs_buf_get(
638 nfsnode_t np,
639 daddr64_t blkno,
640 uint32_t size,
641 thread_t thd,
642 int flags,
643 struct nfsbuf **bpp)
644 {
645 vnode_t vp = NFSTOV(np);
646 struct nfsmount *nmp = VTONMP(vp);
647 struct nfsbuf *bp;
648 uint32_t bufsize;
649 int slpflag = PCATCH;
650 int operation = (flags & NBLK_OPMASK);
651 int error = 0;
652 struct timespec ts;
653
654 FSDBG_TOP(541, np, blkno, size, flags);
655 *bpp = NULL;
656
657 bufsize = size;
658 if (bufsize > NFS_MAXBSIZE)
659 panic("nfs_buf_get: buffer larger than NFS_MAXBSIZE requested");
660
661 if (nfs_mount_gone(nmp)) {
662 FSDBG_BOT(541, np, blkno, 0, ENXIO);
663 return (ENXIO);
664 }
665
666 if (!UBCINFOEXISTS(vp)) {
667 operation = NBLK_META;
668 } else if (bufsize < (uint32_t)nmp->nm_biosize) {
669 /* reg files should always have biosize blocks */
670 bufsize = nmp->nm_biosize;
671 }
672
673 /* if NBLK_WRITE, check for too many delayed/uncommitted writes */
674 if ((operation == NBLK_WRITE) && (nfs_nbdwrite > NFS_A_LOT_OF_DELAYED_WRITES)) {
675 FSDBG_TOP(542, np, blkno, nfs_nbdwrite, NFS_A_LOT_OF_DELAYED_WRITES);
676
677 /* poke the delwri list */
678 nfs_buf_delwri_push(0);
679
680 /* sleep to let other threads run... */
681 tsleep(&nfs_nbdwrite, PCATCH, "nfs_nbdwrite", 1);
682 FSDBG_BOT(542, np, blkno, nfs_nbdwrite, NFS_A_LOT_OF_DELAYED_WRITES);
683 }
684
685 loop:
686 lck_mtx_lock(nfs_buf_mutex);
687
688 /* wait for any buffer invalidation/flushing to complete */
689 while (np->n_bflag & NBINVALINPROG) {
690 np->n_bflag |= NBINVALWANT;
691 ts.tv_sec = 2;
692 ts.tv_nsec = 0;
693 msleep(&np->n_bflag, nfs_buf_mutex, slpflag, "nfs_buf_get_invalwait", &ts);
694 if ((error = nfs_sigintr(VTONMP(vp), NULL, thd, 0))) {
695 lck_mtx_unlock(nfs_buf_mutex);
696 FSDBG_BOT(541, np, blkno, 0, error);
697 return (error);
698 }
699 if (np->n_bflag & NBINVALINPROG)
700 slpflag = 0;
701 }
702
703 /* check for existence of nfsbuf in cache */
704 if ((bp = nfs_buf_incore(np, blkno))) {
705 /* if busy, set wanted and wait */
706 if (ISSET(bp->nb_lflags, NBL_BUSY)) {
707 if (flags & NBLK_NOWAIT) {
708 lck_mtx_unlock(nfs_buf_mutex);
709 FSDBG_BOT(541, np, blkno, bp, 0xbcbcbcbc);
710 return (0);
711 }
712 FSDBG_TOP(543, np, blkno, bp, bp->nb_flags);
713 SET(bp->nb_lflags, NBL_WANTED);
714
715 ts.tv_sec = 2;
716 ts.tv_nsec = 0;
717 msleep(bp, nfs_buf_mutex, slpflag|(PRIBIO+1)|PDROP,
718 "nfsbufget", (slpflag == PCATCH) ? NULL : &ts);
719 slpflag = 0;
720 FSDBG_BOT(543, np, blkno, bp, bp->nb_flags);
721 if ((error = nfs_sigintr(VTONMP(vp), NULL, thd, 0))) {
722 FSDBG_BOT(541, np, blkno, 0, error);
723 return (error);
724 }
725 goto loop;
726 }
727 if (bp->nb_bufsize != bufsize)
728 panic("nfsbuf size mismatch");
729 SET(bp->nb_lflags, NBL_BUSY);
730 SET(bp->nb_flags, NB_CACHE);
731 nfs_buf_remfree(bp);
732 /* additional paranoia: */
733 if (ISSET(bp->nb_flags, NB_PAGELIST))
734 panic("pagelist buffer was not busy");
735 goto buffer_setup;
736 }
737
738 if (flags & NBLK_ONLYVALID) {
739 lck_mtx_unlock(nfs_buf_mutex);
740 FSDBG_BOT(541, np, blkno, 0, 0x0000cace);
741 return (0);
742 }
743
744 /*
745 * where to get a free buffer:
746 * - if meta and maxmeta reached, must reuse meta
747 * - alloc new if we haven't reached min bufs
748 * - if free lists are NOT empty
749 * - if free list is stale, use it
750 * - else if freemeta list is stale, use it
751 * - else if max bufs allocated, use least-time-to-stale
752 * - alloc new if we haven't reached max allowed
753 * - start clearing out delwri list and try again
754 */
755
756 if ((operation == NBLK_META) && (nfsbufmetacnt >= nfsbufmetamax)) {
757 /* if we've hit max meta buffers, must reuse a meta buffer */
758 bp = TAILQ_FIRST(&nfsbuffreemeta);
759 } else if ((nfsbufcnt > nfsbufmin) &&
760 (!TAILQ_EMPTY(&nfsbuffree) || !TAILQ_EMPTY(&nfsbuffreemeta))) {
761 /* try to pull an nfsbuf off a free list */
762 struct nfsbuf *lrubp, *metabp;
763 struct timeval now;
764 microuptime(&now);
765
766 /* if the next LRU or META buffer is invalid or stale, use it */
767 lrubp = TAILQ_FIRST(&nfsbuffree);
768 if (lrubp && (!NBUFSTAMPVALID(lrubp) ||
769 ((lrubp->nb_timestamp + NFSBUF_LRU_STALE) < now.tv_sec)))
770 bp = lrubp;
771 metabp = TAILQ_FIRST(&nfsbuffreemeta);
772 if (!bp && metabp && (!NBUFSTAMPVALID(metabp) ||
773 ((metabp->nb_timestamp + NFSBUF_META_STALE) < now.tv_sec)))
774 bp = metabp;
775
776 if (!bp && (nfsbufcnt >= nfsbufmax)) {
777 /* we've already allocated all bufs, so */
778 /* choose the buffer that'll go stale first */
779 if (!metabp)
780 bp = lrubp;
781 else if (!lrubp)
782 bp = metabp;
783 else {
784 int32_t lru_stale_time, meta_stale_time;
785 lru_stale_time = lrubp->nb_timestamp + NFSBUF_LRU_STALE;
786 meta_stale_time = metabp->nb_timestamp + NFSBUF_META_STALE;
787 if (lru_stale_time <= meta_stale_time)
788 bp = lrubp;
789 else
790 bp = metabp;
791 }
792 }
793 }
794
795 if (bp) {
796 /* we have a buffer to reuse */
797 FSDBG(544, np, blkno, bp, bp->nb_flags);
798 nfs_buf_remfree(bp);
799 if (ISSET(bp->nb_flags, NB_DELWRI))
800 panic("nfs_buf_get: delwri");
801 SET(bp->nb_lflags, NBL_BUSY);
802 /* disassociate buffer from previous nfsnode */
803 if (bp->nb_np) {
804 if (bp->nb_vnbufs.le_next != NFSNOLIST) {
805 LIST_REMOVE(bp, nb_vnbufs);
806 bp->nb_vnbufs.le_next = NFSNOLIST;
807 }
808 bp->nb_np = NULL;
809 }
810 LIST_REMOVE(bp, nb_hash);
811 /* nuke any creds we're holding */
812 if (IS_VALID_CRED(bp->nb_rcred))
813 kauth_cred_unref(&bp->nb_rcred);
814 if (IS_VALID_CRED(bp->nb_wcred))
815 kauth_cred_unref(&bp->nb_wcred);
816 /* if buf will no longer be NB_META, dump old buffer */
817 if (operation == NBLK_META) {
818 if (!ISSET(bp->nb_flags, NB_META))
819 nfsbufmetacnt++;
820 } else if (ISSET(bp->nb_flags, NB_META)) {
821 if (bp->nb_data) {
822 kfree(bp->nb_data, bp->nb_bufsize);
823 bp->nb_data = NULL;
824 }
825 nfsbufmetacnt--;
826 }
827 /* re-init buf fields */
828 bp->nb_error = 0;
829 bp->nb_validoff = bp->nb_validend = -1;
830 bp->nb_dirtyoff = bp->nb_dirtyend = 0;
831 bp->nb_valid = 0;
832 bp->nb_dirty = 0;
833 bp->nb_verf = 0;
834 } else {
835 /* no buffer to reuse */
836 if ((nfsbufcnt < nfsbufmax) &&
837 ((operation != NBLK_META) || (nfsbufmetacnt < nfsbufmetamax))) {
838 /* just alloc a new one */
839 MALLOC(bp, struct nfsbuf *, sizeof(struct nfsbuf), M_TEMP, M_WAITOK);
840 if (!bp) {
841 lck_mtx_unlock(nfs_buf_mutex);
842 FSDBG_BOT(541, np, blkno, 0, error);
843 return (ENOMEM);
844 }
845 nfsbufcnt++;
846
847 /*
848 * If any excess bufs, make sure the timer
849 * is running to free them up later.
850 */
851 if (nfsbufcnt > nfsbufmin && !nfs_buf_timer_on) {
852 nfs_buf_timer_on = 1;
853 nfs_interval_timer_start(nfs_buf_timer_call,
854 NFSBUF_FREE_PERIOD * 1000);
855 }
856
857 if (operation == NBLK_META)
858 nfsbufmetacnt++;
859 NFSBUFCNTCHK();
860 /* init nfsbuf */
861 bzero(bp, sizeof(*bp));
862 bp->nb_free.tqe_next = NFSNOLIST;
863 bp->nb_validoff = bp->nb_validend = -1;
864 FSDBG(545, np, blkno, bp, 0);
865 } else {
866 /* too many bufs... wait for buffers to free up */
867 FSDBG_TOP(546, np, blkno, nfsbufcnt, nfsbufmax);
868
869 /* poke the delwri list */
870 nfs_buf_delwri_push(1);
871
872 nfsneedbuffer = 1;
873 msleep(&nfsneedbuffer, nfs_buf_mutex, PCATCH|PDROP, "nfsbufget", NULL);
874 FSDBG_BOT(546, np, blkno, nfsbufcnt, nfsbufmax);
875 if ((error = nfs_sigintr(VTONMP(vp), NULL, thd, 0))) {
876 FSDBG_BOT(541, np, blkno, 0, error);
877 return (error);
878 }
879 goto loop;
880 }
881 }
882
883 /* set up nfsbuf */
884 SET(bp->nb_lflags, NBL_BUSY);
885 bp->nb_flags = 0;
886 bp->nb_lblkno = blkno;
887 /* insert buf in hash */
888 LIST_INSERT_HEAD(NFSBUFHASH(np, blkno), bp, nb_hash);
889 /* associate buffer with new nfsnode */
890 bp->nb_np = np;
891 LIST_INSERT_HEAD(&np->n_cleanblkhd, bp, nb_vnbufs);
892
893 buffer_setup:
894
895 /* unlock hash */
896 lck_mtx_unlock(nfs_buf_mutex);
897
898 switch (operation) {
899 case NBLK_META:
900 SET(bp->nb_flags, NB_META);
901 if ((bp->nb_bufsize != bufsize) && bp->nb_data) {
902 kfree(bp->nb_data, bp->nb_bufsize);
903 bp->nb_data = NULL;
904 bp->nb_validoff = bp->nb_validend = -1;
905 bp->nb_dirtyoff = bp->nb_dirtyend = 0;
906 bp->nb_valid = 0;
907 bp->nb_dirty = 0;
908 CLR(bp->nb_flags, NB_CACHE);
909 }
910 if (!bp->nb_data)
911 bp->nb_data = kalloc(bufsize);
912 if (!bp->nb_data) {
913 /* Ack! couldn't allocate the data buffer! */
914 /* clean up buffer and return error */
915 lck_mtx_lock(nfs_buf_mutex);
916 LIST_REMOVE(bp, nb_vnbufs);
917 bp->nb_vnbufs.le_next = NFSNOLIST;
918 bp->nb_np = NULL;
919 /* invalidate usage timestamp to allow immediate freeing */
920 NBUFSTAMPINVALIDATE(bp);
921 if (bp->nb_free.tqe_next != NFSNOLIST)
922 panic("nfsbuf on freelist");
923 TAILQ_INSERT_HEAD(&nfsbuffree, bp, nb_free);
924 nfsbuffreecnt++;
925 lck_mtx_unlock(nfs_buf_mutex);
926 FSDBG_BOT(541, np, blkno, 0xb00, ENOMEM);
927 return (ENOMEM);
928 }
929 bp->nb_bufsize = bufsize;
930 break;
931
932 case NBLK_READ:
933 case NBLK_WRITE:
934 /*
935 * Set or clear NB_READ now to let the UPL subsystem know
936 * if we intend to modify the pages or not.
937 */
938 if (operation == NBLK_READ) {
939 SET(bp->nb_flags, NB_READ);
940 } else {
941 CLR(bp->nb_flags, NB_READ);
942 }
943 if (bufsize < PAGE_SIZE)
944 bufsize = PAGE_SIZE;
945 bp->nb_bufsize = bufsize;
946 bp->nb_validoff = bp->nb_validend = -1;
947
948 if (UBCINFOEXISTS(vp)) {
949 /* set up upl */
950 if (nfs_buf_upl_setup(bp)) {
951 /* unable to create upl */
952 /* vm object must no longer exist */
953 /* clean up buffer and return error */
954 lck_mtx_lock(nfs_buf_mutex);
955 LIST_REMOVE(bp, nb_vnbufs);
956 bp->nb_vnbufs.le_next = NFSNOLIST;
957 bp->nb_np = NULL;
958 /* invalidate usage timestamp to allow immediate freeing */
959 NBUFSTAMPINVALIDATE(bp);
960 if (bp->nb_free.tqe_next != NFSNOLIST)
961 panic("nfsbuf on freelist");
962 TAILQ_INSERT_HEAD(&nfsbuffree, bp, nb_free);
963 nfsbuffreecnt++;
964 lck_mtx_unlock(nfs_buf_mutex);
965 FSDBG_BOT(541, np, blkno, 0x2bc, EIO);
966 return (EIO);
967 }
968 nfs_buf_upl_check(bp);
969 }
970 break;
971
972 default:
973 panic("nfs_buf_get: %d unknown operation", operation);
974 }
975
976 *bpp = bp;
977
978 FSDBG_BOT(541, np, blkno, bp, bp->nb_flags);
979
980 return (0);
981 }
982
983 void
984 nfs_buf_release(struct nfsbuf *bp, int freeup)
985 {
986 nfsnode_t np = bp->nb_np;
987 vnode_t vp;
988 struct timeval now;
989 int wakeup_needbuffer, wakeup_buffer, wakeup_nbdwrite;
990
991 FSDBG_TOP(548, bp, NBOFF(bp), bp->nb_flags, bp->nb_data);
992 FSDBG(548, bp->nb_validoff, bp->nb_validend, bp->nb_dirtyoff, bp->nb_dirtyend);
993 FSDBG(548, bp->nb_valid, 0, bp->nb_dirty, 0);
994
995 vp = np ? NFSTOV(np) : NULL;
996 if (vp && UBCINFOEXISTS(vp) && bp->nb_bufsize) {
997 int upl_flags, rv;
998 upl_t upl;
999 uint32_t i;
1000
1001 if (!ISSET(bp->nb_flags, NB_PAGELIST) && !ISSET(bp->nb_flags, NB_INVAL)) {
1002 rv = nfs_buf_upl_setup(bp);
1003 if (rv)
1004 printf("nfs_buf_release: upl create failed %d\n", rv);
1005 else
1006 nfs_buf_upl_check(bp);
1007 }
1008 upl = bp->nb_pagelist;
1009 if (!upl)
1010 goto pagelist_cleanup_done;
1011 if (bp->nb_data) {
1012 if (ubc_upl_unmap(upl) != KERN_SUCCESS)
1013 panic("ubc_upl_unmap failed");
1014 bp->nb_data = NULL;
1015 }
1016 /*
1017 * Abort the pages on error or: if this is an invalid or
1018 * non-needcommit nocache buffer AND no pages are dirty.
1019 */
1020 if (ISSET(bp->nb_flags, NB_ERROR) || (!bp->nb_dirty && (ISSET(bp->nb_flags, NB_INVAL) ||
1021 (ISSET(bp->nb_flags, NB_NOCACHE) && !ISSET(bp->nb_flags, (NB_NEEDCOMMIT | NB_DELWRI)))))) {
1022 if (ISSET(bp->nb_flags, (NB_READ | NB_INVAL | NB_NOCACHE)))
1023 upl_flags = UPL_ABORT_DUMP_PAGES;
1024 else
1025 upl_flags = 0;
1026 ubc_upl_abort(upl, upl_flags);
1027 goto pagelist_cleanup_done;
1028 }
1029 for (i=0; i <= (bp->nb_bufsize - 1)/PAGE_SIZE; i++) {
1030 if (!NBPGVALID(bp,i))
1031 ubc_upl_abort_range(upl,
1032 i*PAGE_SIZE, PAGE_SIZE,
1033 UPL_ABORT_DUMP_PAGES |
1034 UPL_ABORT_FREE_ON_EMPTY);
1035 else {
1036 if (NBPGDIRTY(bp,i))
1037 upl_flags = UPL_COMMIT_SET_DIRTY;
1038 else
1039 upl_flags = UPL_COMMIT_CLEAR_DIRTY;
1040
1041 if (!ISSET(bp->nb_flags, (NB_NEEDCOMMIT | NB_DELWRI)))
1042 upl_flags |= UPL_COMMIT_CLEAR_PRECIOUS;
1043
1044 ubc_upl_commit_range(upl,
1045 i*PAGE_SIZE, PAGE_SIZE,
1046 upl_flags |
1047 UPL_COMMIT_INACTIVATE |
1048 UPL_COMMIT_FREE_ON_EMPTY);
1049 }
1050 }
1051 pagelist_cleanup_done:
1052 /* invalidate any pages past EOF */
1053 if (NBOFF(bp) + bp->nb_bufsize > (off_t)(np->n_size)) {
1054 off_t start, end;
1055 start = trunc_page_64(np->n_size) + PAGE_SIZE_64;
1056 end = trunc_page_64(NBOFF(bp) + bp->nb_bufsize);
1057 if (start < NBOFF(bp))
1058 start = NBOFF(bp);
1059 if (end > start) {
1060 if ((rv = ubc_msync(vp, start, end, NULL, UBC_INVALIDATE)))
1061 printf("nfs_buf_release(): ubc_msync failed!, error %d\n", rv);
1062 }
1063 }
1064 CLR(bp->nb_flags, NB_PAGELIST);
1065 bp->nb_pagelist = NULL;
1066 }
1067
1068 lck_mtx_lock(nfs_buf_mutex);
1069
1070 wakeup_needbuffer = wakeup_buffer = wakeup_nbdwrite = 0;
1071
1072 /* Wake up any processes waiting for any buffer to become free. */
1073 if (nfsneedbuffer) {
1074 nfsneedbuffer = 0;
1075 wakeup_needbuffer = 1;
1076 }
1077 /* Wake up any processes waiting for _this_ buffer to become free. */
1078 if (ISSET(bp->nb_lflags, NBL_WANTED)) {
1079 CLR(bp->nb_lflags, NBL_WANTED);
1080 wakeup_buffer = 1;
1081 }
1082
1083 /* If it's non-needcommit nocache, or an error, mark it invalid. */
1084 if (ISSET(bp->nb_flags, NB_ERROR) ||
1085 (ISSET(bp->nb_flags, NB_NOCACHE) && !ISSET(bp->nb_flags, (NB_NEEDCOMMIT | NB_DELWRI))))
1086 SET(bp->nb_flags, NB_INVAL);
1087
1088 if ((bp->nb_bufsize <= 0) || ISSET(bp->nb_flags, NB_INVAL)) {
1089 /* If it's invalid or empty, dissociate it from its nfsnode */
1090 if (bp->nb_vnbufs.le_next != NFSNOLIST) {
1091 LIST_REMOVE(bp, nb_vnbufs);
1092 bp->nb_vnbufs.le_next = NFSNOLIST;
1093 }
1094 bp->nb_np = NULL;
1095 /* if this was a delayed write, wakeup anyone */
1096 /* waiting for delayed writes to complete */
1097 if (ISSET(bp->nb_flags, NB_DELWRI)) {
1098 CLR(bp->nb_flags, NB_DELWRI);
1099 nfs_nbdwrite--;
1100 NFSBUFCNTCHK();
1101 wakeup_nbdwrite = 1;
1102 }
1103 /* invalidate usage timestamp to allow immediate freeing */
1104 NBUFSTAMPINVALIDATE(bp);
1105 /* put buffer at head of free list */
1106 if (bp->nb_free.tqe_next != NFSNOLIST)
1107 panic("nfsbuf on freelist");
1108 SET(bp->nb_flags, NB_INVAL);
1109 if (ISSET(bp->nb_flags, NB_META)) {
1110 TAILQ_INSERT_HEAD(&nfsbuffreemeta, bp, nb_free);
1111 nfsbuffreemetacnt++;
1112 } else {
1113 TAILQ_INSERT_HEAD(&nfsbuffree, bp, nb_free);
1114 nfsbuffreecnt++;
1115 }
1116 } else if (ISSET(bp->nb_flags, NB_DELWRI)) {
1117 /* put buffer at end of delwri list */
1118 if (bp->nb_free.tqe_next != NFSNOLIST)
1119 panic("nfsbuf on freelist");
1120 TAILQ_INSERT_TAIL(&nfsbufdelwri, bp, nb_free);
1121 nfsbufdelwricnt++;
1122 freeup = 0;
1123 } else {
1124 /* update usage timestamp */
1125 microuptime(&now);
1126 bp->nb_timestamp = now.tv_sec;
1127 /* put buffer at end of free list */
1128 if (bp->nb_free.tqe_next != NFSNOLIST)
1129 panic("nfsbuf on freelist");
1130 if (ISSET(bp->nb_flags, NB_META)) {
1131 TAILQ_INSERT_TAIL(&nfsbuffreemeta, bp, nb_free);
1132 nfsbuffreemetacnt++;
1133 } else {
1134 TAILQ_INSERT_TAIL(&nfsbuffree, bp, nb_free);
1135 nfsbuffreecnt++;
1136 }
1137 }
1138
1139 NFSBUFCNTCHK();
1140
1141 /* Unlock the buffer. */
1142 CLR(bp->nb_flags, (NB_ASYNC | NB_STABLE));
1143 CLR(bp->nb_lflags, NBL_BUSY);
1144
1145 FSDBG_BOT(548, bp, NBOFF(bp), bp->nb_flags, bp->nb_data);
1146
1147 lck_mtx_unlock(nfs_buf_mutex);
1148
1149 if (wakeup_needbuffer)
1150 wakeup(&nfsneedbuffer);
1151 if (wakeup_buffer)
1152 wakeup(bp);
1153 if (wakeup_nbdwrite)
1154 wakeup(&nfs_nbdwrite);
1155 if (freeup)
1156 NFS_BUF_FREEUP();
1157 }
1158
1159 /*
1160 * Wait for operations on the buffer to complete.
1161 * When they do, extract and return the I/O's error value.
1162 */
1163 int
1164 nfs_buf_iowait(struct nfsbuf *bp)
1165 {
1166 FSDBG_TOP(549, bp, NBOFF(bp), bp->nb_flags, bp->nb_error);
1167
1168 lck_mtx_lock(nfs_buf_mutex);
1169
1170 while (!ISSET(bp->nb_flags, NB_DONE))
1171 msleep(bp, nfs_buf_mutex, PRIBIO + 1, "nfs_buf_iowait", NULL);
1172
1173 lck_mtx_unlock(nfs_buf_mutex);
1174
1175 FSDBG_BOT(549, bp, NBOFF(bp), bp->nb_flags, bp->nb_error);
1176
1177 /* check for interruption of I/O, then errors. */
1178 if (ISSET(bp->nb_flags, NB_EINTR)) {
1179 CLR(bp->nb_flags, NB_EINTR);
1180 return (EINTR);
1181 } else if (ISSET(bp->nb_flags, NB_ERROR))
1182 return (bp->nb_error ? bp->nb_error : EIO);
1183 return (0);
1184 }
1185
1186 /*
1187 * Mark I/O complete on a buffer.
1188 */
1189 void
1190 nfs_buf_iodone(struct nfsbuf *bp)
1191 {
1192
1193 FSDBG_TOP(550, bp, NBOFF(bp), bp->nb_flags, bp->nb_error);
1194
1195 if (ISSET(bp->nb_flags, NB_DONE))
1196 panic("nfs_buf_iodone already");
1197
1198 if (!ISSET(bp->nb_flags, NB_READ)) {
1199 CLR(bp->nb_flags, NB_WRITEINPROG);
1200 /*
1201 * vnode_writedone() takes care of waking up
1202 * any throttled write operations
1203 */
1204 vnode_writedone(NFSTOV(bp->nb_np));
1205 nfs_node_lock_force(bp->nb_np);
1206 bp->nb_np->n_numoutput--;
1207 nfs_node_unlock(bp->nb_np);
1208 }
1209 if (ISSET(bp->nb_flags, NB_ASYNC)) { /* if async, release it */
1210 SET(bp->nb_flags, NB_DONE); /* note that it's done */
1211 nfs_buf_release(bp, 1);
1212 } else { /* or just wakeup the buffer */
1213 lck_mtx_lock(nfs_buf_mutex);
1214 SET(bp->nb_flags, NB_DONE); /* note that it's done */
1215 CLR(bp->nb_lflags, NBL_WANTED);
1216 lck_mtx_unlock(nfs_buf_mutex);
1217 wakeup(bp);
1218 }
1219
1220 FSDBG_BOT(550, bp, NBOFF(bp), bp->nb_flags, bp->nb_error);
1221 }
1222
1223 void
1224 nfs_buf_write_delayed(struct nfsbuf *bp)
1225 {
1226 nfsnode_t np = bp->nb_np;
1227
1228 FSDBG_TOP(551, bp, NBOFF(bp), bp->nb_flags, 0);
1229 FSDBG(551, bp, bp->nb_dirtyoff, bp->nb_dirtyend, bp->nb_dirty);
1230
1231 /*
1232 * If the block hasn't been seen before:
1233 * (1) Mark it as having been seen,
1234 * (2) Make sure it's on its node's correct block list,
1235 */
1236 if (!ISSET(bp->nb_flags, NB_DELWRI)) {
1237 SET(bp->nb_flags, NB_DELWRI);
1238 /* move to dirty list */
1239 lck_mtx_lock(nfs_buf_mutex);
1240 nfs_nbdwrite++;
1241 NFSBUFCNTCHK();
1242 if (bp->nb_vnbufs.le_next != NFSNOLIST)
1243 LIST_REMOVE(bp, nb_vnbufs);
1244 LIST_INSERT_HEAD(&np->n_dirtyblkhd, bp, nb_vnbufs);
1245 lck_mtx_unlock(nfs_buf_mutex);
1246 }
1247
1248 /*
1249 * If the vnode has "too many" write operations in progress
1250 * wait for them to finish the IO
1251 */
1252 vnode_waitforwrites(NFSTOV(np), VNODE_ASYNC_THROTTLE, 0, 0, "nfs_buf_write_delayed");
1253
1254 /* the file is in a modified state, so make sure the flag's set */
1255 nfs_node_lock_force(np);
1256 np->n_flag |= NMODIFIED;
1257 nfs_node_unlock(np);
1258
1259 /*
1260 * If we have too many delayed write buffers,
1261 * just fall back to doing the async write.
1262 */
1263 if (nfs_nbdwrite < 0)
1264 panic("nfs_buf_write_delayed: Negative nfs_nbdwrite");
1265 if (nfs_nbdwrite > NFS_A_LOT_OF_DELAYED_WRITES) {
1266 /* issue async write */
1267 SET(bp->nb_flags, NB_ASYNC);
1268 nfs_buf_write(bp);
1269 FSDBG_BOT(551, bp, NBOFF(bp), bp->nb_flags, bp->nb_error);
1270 return;
1271 }
1272
1273 /* Otherwise, the "write" is done, so mark and release the buffer. */
1274 SET(bp->nb_flags, NB_DONE);
1275 nfs_buf_release(bp, 1);
1276 FSDBG_BOT(551, bp, NBOFF(bp), bp->nb_flags, 0);
1277 return;
1278 }
1279
1280 /*
1281 * Check that a "needcommit" buffer can still be committed.
1282 * If the write verifier has changed, we need to clear the
1283 * the needcommit flag.
1284 */
1285 void
1286 nfs_buf_check_write_verifier(nfsnode_t np, struct nfsbuf *bp)
1287 {
1288 struct nfsmount *nmp;
1289
1290 if (!ISSET(bp->nb_flags, NB_NEEDCOMMIT))
1291 return;
1292
1293 nmp = NFSTONMP(np);
1294 if (nfs_mount_gone(nmp))
1295 return;
1296 if (!ISSET(bp->nb_flags, NB_STALEWVERF) && (bp->nb_verf == nmp->nm_verf))
1297 return;
1298
1299 /* write verifier changed, clear commit/wverf flags */
1300 CLR(bp->nb_flags, (NB_NEEDCOMMIT | NB_STALEWVERF));
1301 bp->nb_verf = 0;
1302 nfs_node_lock_force(np);
1303 np->n_needcommitcnt--;
1304 CHECK_NEEDCOMMITCNT(np);
1305 nfs_node_unlock(np);
1306 }
1307
1308 /*
1309 * add a reference to a buffer so it doesn't disappear while being used
1310 * (must be called with nfs_buf_mutex held)
1311 */
1312 void
1313 nfs_buf_refget(struct nfsbuf *bp)
1314 {
1315 bp->nb_refs++;
1316 }
1317 /*
1318 * release a reference on a buffer
1319 * (must be called with nfs_buf_mutex held)
1320 */
1321 void
1322 nfs_buf_refrele(struct nfsbuf *bp)
1323 {
1324 bp->nb_refs--;
1325 }
1326
1327 /*
1328 * mark a particular buffer as BUSY
1329 * (must be called with nfs_buf_mutex held)
1330 */
1331 errno_t
1332 nfs_buf_acquire(struct nfsbuf *bp, int flags, int slpflag, int slptimeo)
1333 {
1334 errno_t error;
1335 struct timespec ts;
1336
1337 if (ISSET(bp->nb_lflags, NBL_BUSY)) {
1338 /*
1339 * since the lck_mtx_lock may block, the buffer
1340 * may become BUSY, so we need to recheck for
1341 * a NOWAIT request
1342 */
1343 if (flags & NBAC_NOWAIT)
1344 return (EBUSY);
1345 SET(bp->nb_lflags, NBL_WANTED);
1346
1347 ts.tv_sec = (slptimeo/100);
1348 /* the hz value is 100; which leads to 10ms */
1349 ts.tv_nsec = (slptimeo % 100) * 10 * NSEC_PER_USEC * 1000;
1350
1351 error = msleep(bp, nfs_buf_mutex, slpflag | (PRIBIO + 1),
1352 "nfs_buf_acquire", &ts);
1353 if (error)
1354 return (error);
1355 return (EAGAIN);
1356 }
1357 if (flags & NBAC_REMOVE)
1358 nfs_buf_remfree(bp);
1359 SET(bp->nb_lflags, NBL_BUSY);
1360
1361 return (0);
1362 }
1363
1364 /*
1365 * simply drop the BUSY status of a buffer
1366 * (must be called with nfs_buf_mutex held)
1367 */
1368 void
1369 nfs_buf_drop(struct nfsbuf *bp)
1370 {
1371 int need_wakeup = 0;
1372
1373 if (!ISSET(bp->nb_lflags, NBL_BUSY))
1374 panic("nfs_buf_drop: buffer not busy!");
1375 if (ISSET(bp->nb_lflags, NBL_WANTED)) {
1376 /* delay the actual wakeup until after we clear NBL_BUSY */
1377 need_wakeup = 1;
1378 }
1379 /* Unlock the buffer. */
1380 CLR(bp->nb_lflags, (NBL_BUSY | NBL_WANTED));
1381
1382 if (need_wakeup)
1383 wakeup(bp);
1384 }
1385
1386 /*
1387 * prepare for iterating over an nfsnode's buffer list
1388 * this lock protects the queue manipulation
1389 * (must be called with nfs_buf_mutex held)
1390 */
1391 int
1392 nfs_buf_iterprepare(nfsnode_t np, struct nfsbuflists *iterheadp, int flags)
1393 {
1394 struct nfsbuflists *listheadp;
1395
1396 if (flags & NBI_DIRTY)
1397 listheadp = &np->n_dirtyblkhd;
1398 else
1399 listheadp = &np->n_cleanblkhd;
1400
1401 if ((flags & NBI_NOWAIT) && (np->n_bufiterflags & NBI_ITER)) {
1402 LIST_INIT(iterheadp);
1403 return(EWOULDBLOCK);
1404 }
1405
1406 while (np->n_bufiterflags & NBI_ITER) {
1407 np->n_bufiterflags |= NBI_ITERWANT;
1408 msleep(&np->n_bufiterflags, nfs_buf_mutex, 0, "nfs_buf_iterprepare", NULL);
1409 }
1410 if (LIST_EMPTY(listheadp)) {
1411 LIST_INIT(iterheadp);
1412 return(EINVAL);
1413 }
1414 np->n_bufiterflags |= NBI_ITER;
1415
1416 iterheadp->lh_first = listheadp->lh_first;
1417 listheadp->lh_first->nb_vnbufs.le_prev = &iterheadp->lh_first;
1418 LIST_INIT(listheadp);
1419
1420 return(0);
1421 }
1422
1423 /*
1424 * clean up after iterating over an nfsnode's buffer list
1425 * this lock protects the queue manipulation
1426 * (must be called with nfs_buf_mutex held)
1427 */
1428 void
1429 nfs_buf_itercomplete(nfsnode_t np, struct nfsbuflists *iterheadp, int flags)
1430 {
1431 struct nfsbuflists * listheadp;
1432 struct nfsbuf *bp;
1433
1434 if (flags & NBI_DIRTY)
1435 listheadp = &np->n_dirtyblkhd;
1436 else
1437 listheadp = &np->n_cleanblkhd;
1438
1439 while (!LIST_EMPTY(iterheadp)) {
1440 bp = LIST_FIRST(iterheadp);
1441 LIST_REMOVE(bp, nb_vnbufs);
1442 LIST_INSERT_HEAD(listheadp, bp, nb_vnbufs);
1443 }
1444
1445 np->n_bufiterflags &= ~NBI_ITER;
1446 if (np->n_bufiterflags & NBI_ITERWANT) {
1447 np->n_bufiterflags &= ~NBI_ITERWANT;
1448 wakeup(&np->n_bufiterflags);
1449 }
1450 }
1451
1452
1453 /*
1454 * Read an NFS buffer for a file.
1455 */
1456 int
1457 nfs_buf_read(struct nfsbuf *bp)
1458 {
1459 int error = 0;
1460 nfsnode_t np;
1461 thread_t thd;
1462 kauth_cred_t cred;
1463
1464 np = bp->nb_np;
1465 cred = bp->nb_rcred;
1466 if (IS_VALID_CRED(cred))
1467 kauth_cred_ref(cred);
1468 thd = ISSET(bp->nb_flags, NB_ASYNC) ? NULL : current_thread();
1469
1470 /* sanity checks */
1471 if (!ISSET(bp->nb_flags, NB_READ))
1472 panic("nfs_buf_read: !NB_READ");
1473 if (ISSET(bp->nb_flags, NB_DONE))
1474 CLR(bp->nb_flags, NB_DONE);
1475
1476 NFS_BUF_MAP(bp);
1477
1478 OSAddAtomic64(1, &nfsstats.read_bios);
1479
1480 error = nfs_buf_read_rpc(bp, thd, cred);
1481 /*
1482 * For async I/O, the callbacks will finish up the
1483 * read. Otherwise, the read has already been finished.
1484 */
1485
1486 if (IS_VALID_CRED(cred))
1487 kauth_cred_unref(&cred);
1488 return (error);
1489 }
1490
1491 /*
1492 * finish the reading of a buffer
1493 */
1494 void
1495 nfs_buf_read_finish(struct nfsbuf *bp)
1496 {
1497 nfsnode_t np = bp->nb_np;
1498 struct nfsmount *nmp;
1499
1500 if (!ISSET(bp->nb_flags, NB_ERROR)) {
1501 /* update valid range */
1502 bp->nb_validoff = 0;
1503 bp->nb_validend = bp->nb_endio;
1504 if (bp->nb_endio < (int)bp->nb_bufsize) {
1505 /*
1506 * The read may be short because we have unflushed writes
1507 * that are extending the file size and the reads hit the
1508 * (old) EOF on the server. So, just make sure nb_validend
1509 * correctly tracks EOF.
1510 * Note that the missing data should have already been zeroed
1511 * in nfs_buf_read_rpc_finish().
1512 */
1513 off_t boff = NBOFF(bp);
1514 if ((off_t)np->n_size >= (boff + bp->nb_bufsize))
1515 bp->nb_validend = bp->nb_bufsize;
1516 else if ((off_t)np->n_size >= boff)
1517 bp->nb_validend = np->n_size - boff;
1518 else
1519 bp->nb_validend = 0;
1520 }
1521 if ((nmp = NFSTONMP(np)) && (nmp->nm_vers == NFS_VER2) &&
1522 ((NBOFF(bp) + bp->nb_validend) > 0x100000000LL))
1523 bp->nb_validend = 0x100000000LL - NBOFF(bp);
1524 bp->nb_valid = (1 << (round_page_32(bp->nb_validend) / PAGE_SIZE)) - 1;
1525 if (bp->nb_validend & PAGE_MASK) {
1526 /* zero-fill remainder of last page */
1527 bzero(bp->nb_data + bp->nb_validend, PAGE_SIZE - (bp->nb_validend & PAGE_MASK));
1528 }
1529 }
1530 nfs_buf_iodone(bp);
1531 }
1532
1533 /*
1534 * initiate the NFS READ RPC(s) for a buffer
1535 */
1536 int
1537 nfs_buf_read_rpc(struct nfsbuf *bp, thread_t thd, kauth_cred_t cred)
1538 {
1539 struct nfsmount *nmp;
1540 nfsnode_t np = bp->nb_np;
1541 int error = 0, nfsvers, async;
1542 int offset, nrpcs;
1543 uint32_t nmrsize, length, len;
1544 off_t boff;
1545 struct nfsreq *req;
1546 struct nfsreq_cbinfo cb;
1547
1548 nmp = NFSTONMP(np);
1549 if (nfs_mount_gone(nmp)) {
1550 bp->nb_error = error = ENXIO;
1551 SET(bp->nb_flags, NB_ERROR);
1552 nfs_buf_iodone(bp);
1553 return (error);
1554 }
1555 nfsvers = nmp->nm_vers;
1556 nmrsize = nmp->nm_rsize;
1557
1558 boff = NBOFF(bp);
1559 offset = 0;
1560 length = bp->nb_bufsize;
1561
1562 if (nfsvers == NFS_VER2) {
1563 if (boff > 0xffffffffLL) {
1564 bp->nb_error = error = EFBIG;
1565 SET(bp->nb_flags, NB_ERROR);
1566 nfs_buf_iodone(bp);
1567 return (error);
1568 }
1569 if ((boff + length - 1) > 0xffffffffLL)
1570 length = 0x100000000LL - boff;
1571 }
1572
1573 /* Note: Can only do async I/O if nfsiods are configured. */
1574 async = (bp->nb_flags & NB_ASYNC);
1575 cb.rcb_func = async ? nfs_buf_read_rpc_finish : NULL;
1576 cb.rcb_bp = bp;
1577
1578 bp->nb_offio = bp->nb_endio = 0;
1579 bp->nb_rpcs = nrpcs = (length + nmrsize - 1) / nmrsize;
1580 if (async && (nrpcs > 1)) {
1581 SET(bp->nb_flags, NB_MULTASYNCRPC);
1582 } else {
1583 CLR(bp->nb_flags, NB_MULTASYNCRPC);
1584 }
1585
1586 while (length > 0) {
1587 if (ISSET(bp->nb_flags, NB_ERROR)) {
1588 error = bp->nb_error;
1589 break;
1590 }
1591 len = (length > nmrsize) ? nmrsize : length;
1592 cb.rcb_args[0] = offset;
1593 cb.rcb_args[1] = len;
1594 if (nmp->nm_vers >= NFS_VER4)
1595 cb.rcb_args[2] = nmp->nm_stategenid;
1596 req = NULL;
1597 error = nmp->nm_funcs->nf_read_rpc_async(np, boff + offset, len, thd, cred, &cb, &req);
1598 if (error)
1599 break;
1600 offset += len;
1601 length -= len;
1602 if (async)
1603 continue;
1604 nfs_buf_read_rpc_finish(req);
1605 if (ISSET(bp->nb_flags, NB_ERROR)) {
1606 error = bp->nb_error;
1607 break;
1608 }
1609 }
1610
1611 if (length > 0) {
1612 /*
1613 * Something bad happened while trying to send the RPC(s).
1614 * Wait for any outstanding requests to complete.
1615 */
1616 bp->nb_error = error;
1617 SET(bp->nb_flags, NB_ERROR);
1618 if (ISSET(bp->nb_flags, NB_MULTASYNCRPC)) {
1619 nrpcs = (length + nmrsize - 1) / nmrsize;
1620 lck_mtx_lock(nfs_buf_mutex);
1621 bp->nb_rpcs -= nrpcs;
1622 if (bp->nb_rpcs == 0) {
1623 /* No RPCs left, so the buffer's done */
1624 lck_mtx_unlock(nfs_buf_mutex);
1625 nfs_buf_iodone(bp);
1626 } else {
1627 /* wait for the last RPC to mark it done */
1628 while (bp->nb_rpcs > 0)
1629 msleep(&bp->nb_rpcs, nfs_buf_mutex, 0,
1630 "nfs_buf_read_rpc_cancel", NULL);
1631 lck_mtx_unlock(nfs_buf_mutex);
1632 }
1633 } else {
1634 nfs_buf_iodone(bp);
1635 }
1636 }
1637
1638 return (error);
1639 }
1640
1641 /*
1642 * finish up an NFS READ RPC on a buffer
1643 */
1644 void
1645 nfs_buf_read_rpc_finish(struct nfsreq *req)
1646 {
1647 struct nfsmount *nmp;
1648 size_t rlen;
1649 struct nfsreq_cbinfo cb;
1650 struct nfsbuf *bp;
1651 int error = 0, nfsvers, offset, length, eof = 0, multasyncrpc, finished;
1652 void *wakeme = NULL;
1653 struct nfsreq *rreq = NULL;
1654 nfsnode_t np;
1655 thread_t thd;
1656 kauth_cred_t cred;
1657 uio_t auio;
1658 char uio_buf [ UIO_SIZEOF(1) ];
1659
1660 finish:
1661 np = req->r_np;
1662 thd = req->r_thread;
1663 cred = req->r_cred;
1664 if (IS_VALID_CRED(cred))
1665 kauth_cred_ref(cred);
1666 cb = req->r_callback;
1667 bp = cb.rcb_bp;
1668 if (cb.rcb_func) /* take an extra reference on the nfsreq in case we want to resend it later due to grace error */
1669 nfs_request_ref(req, 0);
1670
1671 nmp = NFSTONMP(np);
1672 if (nfs_mount_gone(nmp)) {
1673 SET(bp->nb_flags, NB_ERROR);
1674 bp->nb_error = error = ENXIO;
1675 }
1676 if (error || ISSET(bp->nb_flags, NB_ERROR)) {
1677 /* just drop it */
1678 nfs_request_async_cancel(req);
1679 goto out;
1680 }
1681
1682 nfsvers = nmp->nm_vers;
1683 offset = cb.rcb_args[0];
1684 rlen = length = cb.rcb_args[1];
1685
1686 auio = uio_createwithbuffer(1, NBOFF(bp) + offset, UIO_SYSSPACE,
1687 UIO_READ, &uio_buf, sizeof(uio_buf));
1688 uio_addiov(auio, CAST_USER_ADDR_T(bp->nb_data + offset), length);
1689
1690 /* finish the RPC */
1691 error = nmp->nm_funcs->nf_read_rpc_async_finish(np, req, auio, &rlen, &eof);
1692 if ((error == EINPROGRESS) && cb.rcb_func) {
1693 /* async request restarted */
1694 if (cb.rcb_func)
1695 nfs_request_rele(req);
1696 if (IS_VALID_CRED(cred))
1697 kauth_cred_unref(&cred);
1698 return;
1699 }
1700 if ((nmp->nm_vers >= NFS_VER4) && nfs_mount_state_error_should_restart(error) && !ISSET(bp->nb_flags, NB_ERROR)) {
1701 lck_mtx_lock(&nmp->nm_lock);
1702 if ((error != NFSERR_OLD_STATEID) && (error != NFSERR_GRACE) && (cb.rcb_args[2] == nmp->nm_stategenid)) {
1703 NP(np, "nfs_buf_read_rpc_finish: error %d @ 0x%llx, 0x%x 0x%x, initiating recovery",
1704 error, NBOFF(bp)+offset, cb.rcb_args[2], nmp->nm_stategenid);
1705 nfs_need_recover(nmp, error);
1706 }
1707 lck_mtx_unlock(&nmp->nm_lock);
1708 if (np->n_flag & NREVOKE) {
1709 error = EIO;
1710 } else {
1711 if (error == NFSERR_GRACE) {
1712 if (cb.rcb_func) {
1713 /*
1714 * For an async I/O request, handle a grace delay just like
1715 * jukebox errors. Set the resend time and queue it up.
1716 */
1717 struct timeval now;
1718 if (req->r_nmrep.nmc_mhead) {
1719 mbuf_freem(req->r_nmrep.nmc_mhead);
1720 req->r_nmrep.nmc_mhead = NULL;
1721 }
1722 req->r_error = 0;
1723 microuptime(&now);
1724 lck_mtx_lock(&req->r_mtx);
1725 req->r_resendtime = now.tv_sec + 2;
1726 req->r_xid = 0; // get a new XID
1727 req->r_flags |= R_RESTART;
1728 req->r_start = 0;
1729 nfs_asyncio_resend(req);
1730 lck_mtx_unlock(&req->r_mtx);
1731 if (IS_VALID_CRED(cred))
1732 kauth_cred_unref(&cred);
1733 /* Note: nfsreq reference taken will be dropped later when finished */
1734 return;
1735 }
1736 /* otherwise, just pause a couple seconds and retry */
1737 tsleep(&nmp->nm_state, (PZERO-1), "nfsgrace", 2*hz);
1738 }
1739 if (!(error = nfs_mount_state_wait_for_recovery(nmp))) {
1740 rlen = 0;
1741 goto readagain;
1742 }
1743 }
1744 }
1745 if (error) {
1746 SET(bp->nb_flags, NB_ERROR);
1747 bp->nb_error = error;
1748 goto out;
1749 }
1750
1751 if ((rlen > 0) && (bp->nb_endio < (offset + (int)rlen)))
1752 bp->nb_endio = offset + rlen;
1753
1754 if ((nfsvers == NFS_VER2) || eof || (rlen == 0)) {
1755 /* zero out the remaining data (up to EOF) */
1756 off_t rpcrem, eofrem, rem;
1757 rpcrem = (length - rlen);
1758 eofrem = np->n_size - (NBOFF(bp) + offset + rlen);
1759 rem = (rpcrem < eofrem) ? rpcrem : eofrem;
1760 if (rem > 0)
1761 bzero(bp->nb_data + offset + rlen, rem);
1762 } else if (((int)rlen < length) && !ISSET(bp->nb_flags, NB_ERROR)) {
1763 /*
1764 * short read
1765 *
1766 * We haven't hit EOF and we didn't get all the data
1767 * requested, so we need to issue another read for the rest.
1768 * (Don't bother if the buffer already hit an error.)
1769 */
1770 readagain:
1771 offset += rlen;
1772 length -= rlen;
1773 cb.rcb_args[0] = offset;
1774 cb.rcb_args[1] = length;
1775 if (nmp->nm_vers >= NFS_VER4)
1776 cb.rcb_args[2] = nmp->nm_stategenid;
1777 error = nmp->nm_funcs->nf_read_rpc_async(np, NBOFF(bp) + offset, length, thd, cred, &cb, &rreq);
1778 if (!error) {
1779 if (IS_VALID_CRED(cred))
1780 kauth_cred_unref(&cred);
1781 if (!cb.rcb_func) {
1782 /* if !async we'll need to wait for this RPC to finish */
1783 req = rreq;
1784 rreq = NULL;
1785 goto finish;
1786 }
1787 nfs_request_rele(req);
1788 /*
1789 * We're done here.
1790 * Outstanding RPC count is unchanged.
1791 * Callback will be called when RPC is done.
1792 */
1793 return;
1794 }
1795 SET(bp->nb_flags, NB_ERROR);
1796 bp->nb_error = error;
1797 }
1798
1799 out:
1800 if (cb.rcb_func)
1801 nfs_request_rele(req);
1802 if (IS_VALID_CRED(cred))
1803 kauth_cred_unref(&cred);
1804
1805 /*
1806 * Decrement outstanding RPC count on buffer
1807 * and call nfs_buf_read_finish on last RPC.
1808 *
1809 * (Note: when there are multiple async RPCs issued for a
1810 * buffer we need nfs_buffer_mutex to avoid problems when
1811 * aborting a partially-initiated set of RPCs)
1812 */
1813
1814 multasyncrpc = ISSET(bp->nb_flags, NB_MULTASYNCRPC);
1815 if (multasyncrpc)
1816 lck_mtx_lock(nfs_buf_mutex);
1817
1818 bp->nb_rpcs--;
1819 finished = (bp->nb_rpcs == 0);
1820
1821 if (multasyncrpc)
1822 lck_mtx_unlock(nfs_buf_mutex);
1823
1824 if (finished) {
1825 if (multasyncrpc)
1826 wakeme = &bp->nb_rpcs;
1827 nfs_buf_read_finish(bp);
1828 if (wakeme)
1829 wakeup(wakeme);
1830 }
1831 }
1832
1833 /*
1834 * Do buffer readahead.
1835 * Initiate async I/O to read buffers not in cache.
1836 */
1837 int
1838 nfs_buf_readahead(nfsnode_t np, int ioflag, daddr64_t *rabnp, daddr64_t lastrabn, thread_t thd, kauth_cred_t cred)
1839 {
1840 struct nfsmount *nmp = NFSTONMP(np);
1841 struct nfsbuf *bp;
1842 int error = 0;
1843 uint32_t nra;
1844
1845 if (nfs_mount_gone(nmp))
1846 return (ENXIO);
1847 if (nmp->nm_readahead <= 0)
1848 return (0);
1849 if (*rabnp > lastrabn)
1850 return (0);
1851
1852 for (nra = 0; (nra < nmp->nm_readahead) && (*rabnp <= lastrabn); nra++, *rabnp = *rabnp + 1) {
1853 /* check if block exists and is valid. */
1854 if ((*rabnp * nmp->nm_biosize) >= (off_t)np->n_size) {
1855 /* stop reading ahead if we're beyond EOF */
1856 *rabnp = lastrabn;
1857 break;
1858 }
1859 error = nfs_buf_get(np, *rabnp, nmp->nm_biosize, thd, NBLK_READ|NBLK_NOWAIT, &bp);
1860 if (error)
1861 break;
1862 nfs_node_lock_force(np);
1863 np->n_lastrahead = *rabnp;
1864 nfs_node_unlock(np);
1865 if (!bp)
1866 continue;
1867 if ((ioflag & IO_NOCACHE) && ISSET(bp->nb_flags, NB_CACHE) &&
1868 !bp->nb_dirty && !ISSET(bp->nb_flags, (NB_DELWRI|NB_NCRDAHEAD))) {
1869 CLR(bp->nb_flags, NB_CACHE);
1870 bp->nb_valid = 0;
1871 bp->nb_validoff = bp->nb_validend = -1;
1872 }
1873 if ((bp->nb_dirtyend <= 0) && !bp->nb_dirty &&
1874 !ISSET(bp->nb_flags, (NB_CACHE|NB_DELWRI))) {
1875 SET(bp->nb_flags, (NB_READ|NB_ASYNC));
1876 if (ioflag & IO_NOCACHE)
1877 SET(bp->nb_flags, NB_NCRDAHEAD);
1878 if (!IS_VALID_CRED(bp->nb_rcred) && IS_VALID_CRED(cred)) {
1879 kauth_cred_ref(cred);
1880 bp->nb_rcred = cred;
1881 }
1882 if ((error = nfs_buf_read(bp)))
1883 break;
1884 continue;
1885 }
1886 nfs_buf_release(bp, 1);
1887 }
1888 return (error);
1889 }
1890
1891 /*
1892 * NFS buffer I/O for reading files.
1893 */
1894 int
1895 nfs_bioread(nfsnode_t np, uio_t uio, int ioflag, vfs_context_t ctx)
1896 {
1897 vnode_t vp = NFSTOV(np);
1898 struct nfsbuf *bp = NULL;
1899 struct nfsmount *nmp = VTONMP(vp);
1900 daddr64_t lbn, rabn = 0, lastrabn, maxrabn = -1;
1901 off_t diff;
1902 int error = 0, n = 0, on = 0;
1903 int nfsvers, biosize, modified, readaheads = 0;
1904 thread_t thd;
1905 kauth_cred_t cred;
1906 int64_t io_resid;
1907
1908 FSDBG_TOP(514, np, uio_offset(uio), uio_resid(uio), ioflag);
1909
1910 nfsvers = nmp->nm_vers;
1911 biosize = nmp->nm_biosize;
1912 thd = vfs_context_thread(ctx);
1913 cred = vfs_context_ucred(ctx);
1914
1915 if (vnode_vtype(vp) != VREG) {
1916 printf("nfs_bioread: type %x unexpected\n", vnode_vtype(vp));
1917 FSDBG_BOT(514, np, 0xd1e0016, 0, EINVAL);
1918 return (EINVAL);
1919 }
1920
1921 /*
1922 * For NFS, cache consistency can only be maintained approximately.
1923 * Although RFC1094 does not specify the criteria, the following is
1924 * believed to be compatible with the reference port.
1925 *
1926 * If the file has changed since the last read RPC or you have
1927 * written to the file, you may have lost data cache consistency
1928 * with the server. So, check for a change, and flush all of the
1929 * file's data out of the cache.
1930 * NB: This implies that cache data can be read when up to
1931 * NFS_MAXATTRTIMO seconds out of date. If you find that you
1932 * need current attributes, nfs_getattr() can be forced to fetch
1933 * new attributes (via NATTRINVALIDATE() or NGA_UNCACHED).
1934 */
1935
1936 if (ISSET(np->n_flag, NUPDATESIZE))
1937 nfs_data_update_size(np, 0);
1938
1939 if ((error = nfs_node_lock(np))) {
1940 FSDBG_BOT(514, np, 0xd1e0222, 0, error);
1941 return (error);
1942 }
1943
1944 if (np->n_flag & NNEEDINVALIDATE) {
1945 np->n_flag &= ~NNEEDINVALIDATE;
1946 nfs_node_unlock(np);
1947 error = nfs_vinvalbuf(vp, V_SAVE|V_IGNORE_WRITEERR, ctx, 1);
1948 if (!error)
1949 error = nfs_node_lock(np);
1950 if (error) {
1951 FSDBG_BOT(514, np, 0xd1e0322, 0, error);
1952 return (error);
1953 }
1954 }
1955
1956 modified = (np->n_flag & NMODIFIED);
1957 nfs_node_unlock(np);
1958 /* nfs_getattr() will check changed and purge caches */
1959 error = nfs_getattr(np, NULL, ctx, modified ? NGA_UNCACHED : NGA_CACHED);
1960 if (error) {
1961 FSDBG_BOT(514, np, 0xd1e0004, 0, error);
1962 return (error);
1963 }
1964
1965 if (uio_resid(uio) == 0) {
1966 FSDBG_BOT(514, np, 0xd1e0001, 0, 0);
1967 return (0);
1968 }
1969 if (uio_offset(uio) < 0) {
1970 FSDBG_BOT(514, np, 0xd1e0002, 0, EINVAL);
1971 return (EINVAL);
1972 }
1973
1974 /*
1975 * set up readahead - which may be limited by:
1976 * + current request length (for IO_NOCACHE)
1977 * + readahead setting
1978 * + file size
1979 */
1980 if (nmp->nm_readahead > 0) {
1981 off_t end = uio_offset(uio) + uio_resid(uio);
1982 if (end > (off_t)np->n_size)
1983 end = np->n_size;
1984 rabn = uio_offset(uio) / biosize;
1985 maxrabn = (end - 1) / biosize;
1986 nfs_node_lock_force(np);
1987 if (!(ioflag & IO_NOCACHE) &&
1988 (!rabn || (rabn == np->n_lastread) || (rabn == (np->n_lastread+1)))) {
1989 maxrabn += nmp->nm_readahead;
1990 if ((maxrabn * biosize) >= (off_t)np->n_size)
1991 maxrabn = ((off_t)np->n_size - 1)/biosize;
1992 }
1993 if (maxrabn < np->n_lastrahead)
1994 np->n_lastrahead = -1;
1995 if (rabn < np->n_lastrahead)
1996 rabn = np->n_lastrahead + 1;
1997 nfs_node_unlock(np);
1998 } else {
1999 rabn = maxrabn = 0;
2000 }
2001
2002 do {
2003
2004 nfs_data_lock(np, NFS_DATA_LOCK_SHARED);
2005 lbn = uio_offset(uio) / biosize;
2006
2007 /*
2008 * Copy directly from any cached pages without grabbing the bufs.
2009 * (If we are NOCACHE and we've issued readahead requests, we need
2010 * to grab the NB_NCRDAHEAD bufs to drop them.)
2011 */
2012 if ((!(ioflag & IO_NOCACHE) || !readaheads) &&
2013 ((uio->uio_segflg == UIO_USERSPACE32 ||
2014 uio->uio_segflg == UIO_USERSPACE64 ||
2015 uio->uio_segflg == UIO_USERSPACE))) {
2016 io_resid = uio_resid(uio);
2017 diff = np->n_size - uio_offset(uio);
2018 if (diff < io_resid)
2019 io_resid = diff;
2020 if (io_resid > 0) {
2021 int count = (io_resid > INT_MAX) ? INT_MAX : io_resid;
2022 error = cluster_copy_ubc_data(vp, uio, &count, 0);
2023 if (error) {
2024 nfs_data_unlock(np);
2025 FSDBG_BOT(514, np, uio_offset(uio), 0xcacefeed, error);
2026 return (error);
2027 }
2028 }
2029 /* count any biocache reads that we just copied directly */
2030 if (lbn != (uio_offset(uio)/biosize)) {
2031 OSAddAtomic64((uio_offset(uio)/biosize) - lbn, &nfsstats.biocache_reads);
2032 FSDBG(514, np, 0xcacefeed, uio_offset(uio), error);
2033 }
2034 }
2035
2036 lbn = uio_offset(uio) / biosize;
2037 on = uio_offset(uio) % biosize;
2038 nfs_node_lock_force(np);
2039 np->n_lastread = (uio_offset(uio) - 1) / biosize;
2040 nfs_node_unlock(np);
2041
2042 if ((uio_resid(uio) <= 0) || (uio_offset(uio) >= (off_t)np->n_size)) {
2043 nfs_data_unlock(np);
2044 FSDBG_BOT(514, np, uio_offset(uio), uio_resid(uio), 0xaaaaaaaa);
2045 return (0);
2046 }
2047
2048 /* adjust readahead block number, if necessary */
2049 if (rabn < lbn)
2050 rabn = lbn;
2051 lastrabn = MIN(maxrabn, lbn + nmp->nm_readahead);
2052 if (rabn <= lastrabn) { /* start readaheads */
2053 error = nfs_buf_readahead(np, ioflag, &rabn, lastrabn, thd, cred);
2054 if (error) {
2055 nfs_data_unlock(np);
2056 FSDBG_BOT(514, np, 0xd1e000b, 1, error);
2057 return (error);
2058 }
2059 readaheads = 1;
2060 }
2061
2062 OSAddAtomic64(1, &nfsstats.biocache_reads);
2063
2064 /*
2065 * If the block is in the cache and has the required data
2066 * in a valid region, just copy it out.
2067 * Otherwise, get the block and write back/read in,
2068 * as required.
2069 */
2070 again:
2071 io_resid = uio_resid(uio);
2072 n = (io_resid > (biosize - on)) ? (biosize - on) : io_resid;
2073 diff = np->n_size - uio_offset(uio);
2074 if (diff < n)
2075 n = diff;
2076
2077 error = nfs_buf_get(np, lbn, biosize, thd, NBLK_READ, &bp);
2078 if (error) {
2079 nfs_data_unlock(np);
2080 FSDBG_BOT(514, np, 0xd1e000c, 0, error);
2081 return (error);
2082 }
2083
2084 if ((ioflag & IO_NOCACHE) && ISSET(bp->nb_flags, NB_CACHE)) {
2085 /*
2086 * IO_NOCACHE found a cached buffer.
2087 * Flush the buffer if it's dirty.
2088 * Invalidate the data if it wasn't just read
2089 * in as part of a "nocache readahead".
2090 */
2091 if (bp->nb_dirty || (bp->nb_dirtyend > 0)) {
2092 /* so write the buffer out and try again */
2093 SET(bp->nb_flags, NB_NOCACHE);
2094 goto flushbuffer;
2095 }
2096 if (ISSET(bp->nb_flags, NB_NCRDAHEAD)) {
2097 CLR(bp->nb_flags, NB_NCRDAHEAD);
2098 SET(bp->nb_flags, NB_NOCACHE);
2099 }
2100 }
2101
2102 /* if any pages are valid... */
2103 if (bp->nb_valid) {
2104 /* ...check for any invalid pages in the read range */
2105 int pg, firstpg, lastpg, dirtypg;
2106 dirtypg = firstpg = lastpg = -1;
2107 pg = on/PAGE_SIZE;
2108 while (pg <= (on + n - 1)/PAGE_SIZE) {
2109 if (!NBPGVALID(bp,pg)) {
2110 if (firstpg < 0)
2111 firstpg = pg;
2112 lastpg = pg;
2113 } else if (firstpg >= 0 && dirtypg < 0 && NBPGDIRTY(bp,pg))
2114 dirtypg = pg;
2115 pg++;
2116 }
2117
2118 /* if there are no invalid pages, we're all set */
2119 if (firstpg < 0) {
2120 if (bp->nb_validoff < 0) {
2121 /* valid range isn't set up, so */
2122 /* set it to what we know is valid */
2123 bp->nb_validoff = trunc_page(on);
2124 bp->nb_validend = round_page(on+n);
2125 nfs_buf_normalize_valid_range(np, bp);
2126 }
2127 goto buffer_ready;
2128 }
2129
2130 /* there are invalid pages in the read range */
2131 if (((dirtypg > firstpg) && (dirtypg < lastpg)) ||
2132 (((firstpg*PAGE_SIZE) < bp->nb_dirtyend) && (((lastpg+1)*PAGE_SIZE) > bp->nb_dirtyoff))) {
2133 /* there are also dirty page(s) (or range) in the read range, */
2134 /* so write the buffer out and try again */
2135 flushbuffer:
2136 CLR(bp->nb_flags, (NB_DONE | NB_ERROR | NB_INVAL));
2137 SET(bp->nb_flags, NB_ASYNC);
2138 if (!IS_VALID_CRED(bp->nb_wcred)) {
2139 kauth_cred_ref(cred);
2140 bp->nb_wcred = cred;
2141 }
2142 error = nfs_buf_write(bp);
2143 if (error) {
2144 nfs_data_unlock(np);
2145 FSDBG_BOT(514, np, 0xd1e000d, 0, error);
2146 return (error);
2147 }
2148 goto again;
2149 }
2150 if (!bp->nb_dirty && bp->nb_dirtyend <= 0 &&
2151 (lastpg - firstpg + 1) > (biosize/PAGE_SIZE)/2) {
2152 /* we need to read in more than half the buffer and the */
2153 /* buffer's not dirty, so just fetch the whole buffer */
2154 bp->nb_valid = 0;
2155 } else {
2156 /* read the page range in */
2157 uio_t auio;
2158 char uio_buf[ UIO_SIZEOF(1) ];
2159
2160 NFS_BUF_MAP(bp);
2161 auio = uio_createwithbuffer(1, (NBOFF(bp) + firstpg * PAGE_SIZE_64),
2162 UIO_SYSSPACE, UIO_READ, &uio_buf[0], sizeof(uio_buf));
2163 if (!auio) {
2164 error = ENOMEM;
2165 } else {
2166 uio_addiov(auio, CAST_USER_ADDR_T(bp->nb_data + (firstpg * PAGE_SIZE)),
2167 ((lastpg - firstpg + 1) * PAGE_SIZE));
2168 error = nfs_read_rpc(np, auio, ctx);
2169 }
2170 if (error) {
2171 if (ioflag & IO_NOCACHE)
2172 SET(bp->nb_flags, NB_NOCACHE);
2173 nfs_buf_release(bp, 1);
2174 nfs_data_unlock(np);
2175 FSDBG_BOT(514, np, 0xd1e000e, 0, error);
2176 return (error);
2177 }
2178 /* Make sure that the valid range is set to cover this read. */
2179 bp->nb_validoff = trunc_page_32(on);
2180 bp->nb_validend = round_page_32(on+n);
2181 nfs_buf_normalize_valid_range(np, bp);
2182 if (uio_resid(auio) > 0) {
2183 /* if short read, must have hit EOF, */
2184 /* so zero the rest of the range */
2185 bzero(CAST_DOWN(caddr_t, uio_curriovbase(auio)), uio_resid(auio));
2186 }
2187 /* mark the pages (successfully read) as valid */
2188 for (pg=firstpg; pg <= lastpg; pg++)
2189 NBPGVALID_SET(bp,pg);
2190 }
2191 }
2192 /* if no pages are valid, read the whole block */
2193 if (!bp->nb_valid) {
2194 if (!IS_VALID_CRED(bp->nb_rcred) && IS_VALID_CRED(cred)) {
2195 kauth_cred_ref(cred);
2196 bp->nb_rcred = cred;
2197 }
2198 SET(bp->nb_flags, NB_READ);
2199 CLR(bp->nb_flags, (NB_DONE | NB_ERROR | NB_INVAL));
2200 error = nfs_buf_read(bp);
2201 if (ioflag & IO_NOCACHE)
2202 SET(bp->nb_flags, NB_NOCACHE);
2203 if (error) {
2204 nfs_data_unlock(np);
2205 nfs_buf_release(bp, 1);
2206 FSDBG_BOT(514, np, 0xd1e000f, 0, error);
2207 return (error);
2208 }
2209 }
2210 buffer_ready:
2211 /* validate read range against valid range and clip */
2212 if (bp->nb_validend > 0) {
2213 diff = (on >= bp->nb_validend) ? 0 : (bp->nb_validend - on);
2214 if (diff < n)
2215 n = diff;
2216 }
2217 if (n > 0) {
2218 NFS_BUF_MAP(bp);
2219 error = uiomove(bp->nb_data + on, n, uio);
2220 }
2221
2222 nfs_buf_release(bp, 1);
2223 nfs_data_unlock(np);
2224 nfs_node_lock_force(np);
2225 np->n_lastread = (uio_offset(uio) - 1) / biosize;
2226 nfs_node_unlock(np);
2227 } while (error == 0 && uio_resid(uio) > 0 && n > 0);
2228 FSDBG_BOT(514, np, uio_offset(uio), uio_resid(uio), error);
2229 return (error);
2230 }
2231
2232 /*
2233 * limit the number of outstanding async I/O writes
2234 */
2235 int
2236 nfs_async_write_start(struct nfsmount *nmp)
2237 {
2238 int error = 0, slpflag = NMFLAG(nmp, INTR) ? PCATCH : 0;
2239 struct timespec ts = {1, 0};
2240
2241 if (nfs_max_async_writes <= 0)
2242 return (0);
2243 lck_mtx_lock(&nmp->nm_lock);
2244 while ((nfs_max_async_writes > 0) && (nmp->nm_asyncwrites >= nfs_max_async_writes)) {
2245 if ((error = nfs_sigintr(nmp, NULL, current_thread(), 1)))
2246 break;
2247 msleep(&nmp->nm_asyncwrites, &nmp->nm_lock, slpflag|(PZERO-1), "nfsasyncwrites", &ts);
2248 slpflag = 0;
2249 }
2250 if (!error)
2251 nmp->nm_asyncwrites++;
2252 lck_mtx_unlock(&nmp->nm_lock);
2253 return (error);
2254 }
2255 void
2256 nfs_async_write_done(struct nfsmount *nmp)
2257 {
2258 if (nmp->nm_asyncwrites <= 0)
2259 return;
2260 lck_mtx_lock(&nmp->nm_lock);
2261 if (nmp->nm_asyncwrites-- >= nfs_max_async_writes)
2262 wakeup(&nmp->nm_asyncwrites);
2263 lck_mtx_unlock(&nmp->nm_lock);
2264 }
2265
2266 /*
2267 * write (or commit) the given NFS buffer
2268 *
2269 * Commit the buffer if we can.
2270 * Write out any dirty range.
2271 * If any dirty pages remain, write them out.
2272 * Mark buffer done.
2273 *
2274 * For async requests, all the work beyond sending the initial
2275 * write RPC is handled in the RPC callback(s).
2276 */
2277 int
2278 nfs_buf_write(struct nfsbuf *bp)
2279 {
2280 int error = 0, oldflags, async;
2281 nfsnode_t np;
2282 thread_t thd;
2283 kauth_cred_t cred;
2284 proc_t p = current_proc();
2285 int iomode, doff, dend, firstpg, lastpg;
2286 uint32_t pagemask;
2287
2288 FSDBG_TOP(553, bp, NBOFF(bp), bp->nb_flags, 0);
2289
2290 if (!ISSET(bp->nb_lflags, NBL_BUSY))
2291 panic("nfs_buf_write: buffer is not busy???");
2292
2293 np = bp->nb_np;
2294 async = ISSET(bp->nb_flags, NB_ASYNC);
2295 oldflags = bp->nb_flags;
2296
2297 CLR(bp->nb_flags, (NB_READ|NB_DONE|NB_ERROR|NB_DELWRI));
2298 if (ISSET(oldflags, NB_DELWRI)) {
2299 lck_mtx_lock(nfs_buf_mutex);
2300 nfs_nbdwrite--;
2301 NFSBUFCNTCHK();
2302 lck_mtx_unlock(nfs_buf_mutex);
2303 wakeup(&nfs_nbdwrite);
2304 }
2305
2306 /* move to clean list */
2307 if (ISSET(oldflags, (NB_ASYNC|NB_DELWRI))) {
2308 lck_mtx_lock(nfs_buf_mutex);
2309 if (bp->nb_vnbufs.le_next != NFSNOLIST)
2310 LIST_REMOVE(bp, nb_vnbufs);
2311 LIST_INSERT_HEAD(&np->n_cleanblkhd, bp, nb_vnbufs);
2312 lck_mtx_unlock(nfs_buf_mutex);
2313 }
2314 nfs_node_lock_force(np);
2315 np->n_numoutput++;
2316 nfs_node_unlock(np);
2317 vnode_startwrite(NFSTOV(np));
2318
2319 if (p && p->p_stats)
2320 OSIncrementAtomicLong(&p->p_stats->p_ru.ru_oublock);
2321
2322 cred = bp->nb_wcred;
2323 if (!IS_VALID_CRED(cred) && ISSET(bp->nb_flags, NB_READ))
2324 cred = bp->nb_rcred; /* shouldn't really happen, but... */
2325 if (IS_VALID_CRED(cred))
2326 kauth_cred_ref(cred);
2327 thd = async ? NULL : current_thread();
2328
2329 /* We need to make sure the pages are locked before doing I/O. */
2330 if (!ISSET(bp->nb_flags, NB_META)) {
2331 if (UBCINFOEXISTS(NFSTOV(np))) {
2332 if (!ISSET(bp->nb_flags, NB_PAGELIST)) {
2333 error = nfs_buf_upl_setup(bp);
2334 if (error) {
2335 printf("nfs_buf_write: upl create failed %d\n", error);
2336 SET(bp->nb_flags, NB_ERROR);
2337 bp->nb_error = error = EIO;
2338 nfs_buf_iodone(bp);
2339 goto out;
2340 }
2341 nfs_buf_upl_check(bp);
2342 }
2343 } else {
2344 /* We should never be in nfs_buf_write() with no UBCINFO. */
2345 printf("nfs_buf_write: ubcinfo already gone\n");
2346 SET(bp->nb_flags, NB_ERROR);
2347 bp->nb_error = error = EIO;
2348 nfs_buf_iodone(bp);
2349 goto out;
2350 }
2351 }
2352
2353 /* If NB_NEEDCOMMIT is set, a commit RPC may do the trick. */
2354 if (ISSET(bp->nb_flags, NB_NEEDCOMMIT))
2355 nfs_buf_check_write_verifier(np, bp);
2356 if (ISSET(bp->nb_flags, NB_NEEDCOMMIT)) {
2357 struct nfsmount *nmp = NFSTONMP(np);
2358 if (nfs_mount_gone(nmp)) {
2359 SET(bp->nb_flags, NB_ERROR);
2360 bp->nb_error = error = EIO;
2361 nfs_buf_iodone(bp);
2362 goto out;
2363 }
2364 SET(bp->nb_flags, NB_WRITEINPROG);
2365 error = nmp->nm_funcs->nf_commit_rpc(np, NBOFF(bp) + bp->nb_dirtyoff,
2366 bp->nb_dirtyend - bp->nb_dirtyoff, bp->nb_wcred, bp->nb_verf);
2367 CLR(bp->nb_flags, NB_WRITEINPROG);
2368 if (error) {
2369 if (error != NFSERR_STALEWRITEVERF) {
2370 SET(bp->nb_flags, NB_ERROR);
2371 bp->nb_error = error;
2372 }
2373 nfs_buf_iodone(bp);
2374 goto out;
2375 }
2376 bp->nb_dirtyoff = bp->nb_dirtyend = 0;
2377 CLR(bp->nb_flags, NB_NEEDCOMMIT);
2378 nfs_node_lock_force(np);
2379 np->n_needcommitcnt--;
2380 CHECK_NEEDCOMMITCNT(np);
2381 nfs_node_unlock(np);
2382 }
2383 if (!error && (bp->nb_dirtyend > 0)) {
2384 /* sanity check the dirty range */
2385 if (NBOFF(bp) + bp->nb_dirtyend > (off_t) np->n_size) {
2386 bp->nb_dirtyend = np->n_size - NBOFF(bp);
2387 if (bp->nb_dirtyoff >= bp->nb_dirtyend)
2388 bp->nb_dirtyoff = bp->nb_dirtyend = 0;
2389 }
2390 }
2391 if (!error && (bp->nb_dirtyend > 0)) {
2392 /* there's a dirty range that needs to be written out */
2393 NFS_BUF_MAP(bp);
2394
2395 doff = bp->nb_dirtyoff;
2396 dend = bp->nb_dirtyend;
2397
2398 /* if doff page is dirty, move doff to start of page */
2399 if (NBPGDIRTY(bp, doff / PAGE_SIZE))
2400 doff -= doff & PAGE_MASK;
2401 /* try to expand write range to include preceding dirty pages */
2402 if (!(doff & PAGE_MASK))
2403 while ((doff > 0) && NBPGDIRTY(bp, (doff - 1) / PAGE_SIZE))
2404 doff -= PAGE_SIZE;
2405 /* if dend page is dirty, move dend to start of next page */
2406 if ((dend & PAGE_MASK) && NBPGDIRTY(bp, dend / PAGE_SIZE))
2407 dend = round_page_32(dend);
2408 /* try to expand write range to include trailing dirty pages */
2409 if (!(dend & PAGE_MASK))
2410 while ((dend < (int)bp->nb_bufsize) && NBPGDIRTY(bp, dend / PAGE_SIZE))
2411 dend += PAGE_SIZE;
2412 /* make sure to keep dend clipped to EOF */
2413 if ((NBOFF(bp) + dend) > (off_t) np->n_size)
2414 dend = np->n_size - NBOFF(bp);
2415 /* calculate range of complete pages being written */
2416 firstpg = round_page_32(doff) / PAGE_SIZE;
2417 lastpg = (trunc_page_32(dend) - 1) / PAGE_SIZE;
2418 /* calculate mask for that page range */
2419 pagemask = ((1 << (lastpg + 1)) - 1) & ~((1 << firstpg) - 1);
2420
2421 /*
2422 * compare page mask to nb_dirty; if there are other dirty pages
2423 * then write FILESYNC; otherwise, write UNSTABLE if async and
2424 * not needcommit/stable; otherwise write FILESYNC
2425 */
2426 if (bp->nb_dirty & ~pagemask)
2427 iomode = NFS_WRITE_FILESYNC;
2428 else if ((bp->nb_flags & (NB_ASYNC | NB_NEEDCOMMIT | NB_STABLE)) == NB_ASYNC)
2429 iomode = NFS_WRITE_UNSTABLE;
2430 else
2431 iomode = NFS_WRITE_FILESYNC;
2432
2433 /* write the whole contiguous dirty range */
2434 bp->nb_offio = doff;
2435 bp->nb_endio = dend;
2436
2437 OSAddAtomic64(1, &nfsstats.write_bios);
2438
2439 SET(bp->nb_flags, NB_WRITEINPROG);
2440 error = nfs_buf_write_rpc(bp, iomode, thd, cred);
2441 /*
2442 * For async I/O, the callbacks will finish up the
2443 * write and push out any dirty pages. Otherwise,
2444 * the write has already been finished and any dirty
2445 * pages pushed out.
2446 */
2447 } else {
2448 if (!error && bp->nb_dirty) /* write out any dirty pages */
2449 error = nfs_buf_write_dirty_pages(bp, thd, cred);
2450 nfs_buf_iodone(bp);
2451 }
2452 /* note: bp is still valid only for !async case */
2453 out:
2454 if (!async) {
2455 error = nfs_buf_iowait(bp);
2456 /* move to clean list */
2457 if (oldflags & NB_DELWRI) {
2458 lck_mtx_lock(nfs_buf_mutex);
2459 if (bp->nb_vnbufs.le_next != NFSNOLIST)
2460 LIST_REMOVE(bp, nb_vnbufs);
2461 LIST_INSERT_HEAD(&np->n_cleanblkhd, bp, nb_vnbufs);
2462 lck_mtx_unlock(nfs_buf_mutex);
2463 }
2464 FSDBG_BOT(553, bp, NBOFF(bp), bp->nb_flags, error);
2465 nfs_buf_release(bp, 1);
2466 /* check if we need to invalidate (and we can) */
2467 if ((np->n_flag & NNEEDINVALIDATE) &&
2468 !(np->n_bflag & (NBINVALINPROG|NBFLUSHINPROG))) {
2469 int invalidate = 0;
2470 nfs_node_lock_force(np);
2471 if (np->n_flag & NNEEDINVALIDATE) {
2472 invalidate = 1;
2473 np->n_flag &= ~NNEEDINVALIDATE;
2474 }
2475 nfs_node_unlock(np);
2476 if (invalidate) {
2477 /*
2478 * There was a write error and we need to
2479 * invalidate attrs and flush buffers in
2480 * order to sync up with the server.
2481 * (if this write was extending the file,
2482 * we may no longer know the correct size)
2483 *
2484 * But we couldn't call vinvalbuf while holding
2485 * the buffer busy. So we call vinvalbuf() after
2486 * releasing the buffer.
2487 */
2488 nfs_vinvalbuf2(NFSTOV(np), V_SAVE|V_IGNORE_WRITEERR, thd, cred, 1);
2489 }
2490 }
2491 }
2492
2493 if (IS_VALID_CRED(cred))
2494 kauth_cred_unref(&cred);
2495 return (error);
2496 }
2497
2498 /*
2499 * finish the writing of a buffer
2500 */
2501 void
2502 nfs_buf_write_finish(struct nfsbuf *bp, thread_t thd, kauth_cred_t cred)
2503 {
2504 nfsnode_t np = bp->nb_np;
2505 int error = (bp->nb_flags & NB_ERROR) ? bp->nb_error : 0;
2506 int firstpg, lastpg;
2507 uint32_t pagemask;
2508
2509 if ((error == EINTR) || (error == ERESTART)) {
2510 CLR(bp->nb_flags, NB_ERROR);
2511 SET(bp->nb_flags, NB_EINTR);
2512 }
2513
2514 if (!error) {
2515 /* calculate range of complete pages being written */
2516 firstpg = round_page_32(bp->nb_offio) / PAGE_SIZE;
2517 lastpg = (trunc_page_32(bp->nb_endio) - 1) / PAGE_SIZE;
2518 /* calculate mask for that page range written */
2519 pagemask = ((1 << (lastpg + 1)) - 1) & ~((1 << firstpg) - 1);
2520 /* clear dirty bits for pages we've written */
2521 bp->nb_dirty &= ~pagemask;
2522 }
2523
2524 /* manage needcommit state */
2525 if (!error && (bp->nb_commitlevel == NFS_WRITE_UNSTABLE)) {
2526 if (!ISSET(bp->nb_flags, NB_NEEDCOMMIT)) {
2527 nfs_node_lock_force(np);
2528 np->n_needcommitcnt++;
2529 nfs_node_unlock(np);
2530 SET(bp->nb_flags, NB_NEEDCOMMIT);
2531 }
2532 /* make sure nb_dirtyoff/nb_dirtyend reflect actual range written */
2533 bp->nb_dirtyoff = bp->nb_offio;
2534 bp->nb_dirtyend = bp->nb_endio;
2535 } else if (ISSET(bp->nb_flags, NB_NEEDCOMMIT)) {
2536 nfs_node_lock_force(np);
2537 np->n_needcommitcnt--;
2538 CHECK_NEEDCOMMITCNT(np);
2539 nfs_node_unlock(np);
2540 CLR(bp->nb_flags, NB_NEEDCOMMIT);
2541 }
2542
2543 CLR(bp->nb_flags, NB_WRITEINPROG);
2544
2545 /*
2546 * For an unstable write, the buffer is still treated as dirty until
2547 * a commit (or stable (re)write) is performed. Buffers needing only
2548 * a commit are marked with the NB_DELWRI and NB_NEEDCOMMIT flags.
2549 *
2550 * If the write was interrupted we set NB_EINTR. Don't set NB_ERROR
2551 * because that would cause the buffer to be dropped. The buffer is
2552 * still valid and simply needs to be written again.
2553 */
2554 if ((error == EINTR) || (error == ERESTART) || (!error && (bp->nb_flags & NB_NEEDCOMMIT))) {
2555 CLR(bp->nb_flags, NB_INVAL);
2556 if (!ISSET(bp->nb_flags, NB_DELWRI)) {
2557 SET(bp->nb_flags, NB_DELWRI);
2558 lck_mtx_lock(nfs_buf_mutex);
2559 nfs_nbdwrite++;
2560 NFSBUFCNTCHK();
2561 lck_mtx_unlock(nfs_buf_mutex);
2562 }
2563 /*
2564 * Since for the NB_ASYNC case, we've reassigned the buffer to the
2565 * clean list, we have to reassign it back to the dirty one. Ugh.
2566 */
2567 if (ISSET(bp->nb_flags, NB_ASYNC)) {
2568 /* move to dirty list */
2569 lck_mtx_lock(nfs_buf_mutex);
2570 if (bp->nb_vnbufs.le_next != NFSNOLIST)
2571 LIST_REMOVE(bp, nb_vnbufs);
2572 LIST_INSERT_HEAD(&np->n_dirtyblkhd, bp, nb_vnbufs);
2573 lck_mtx_unlock(nfs_buf_mutex);
2574 }
2575 } else {
2576 /* either there's an error or we don't need to commit */
2577 if (error) {
2578 /*
2579 * There was a write error and we need to invalidate
2580 * attrs and flush buffers in order to sync up with the
2581 * server. (if this write was extending the file, we
2582 * may no longer know the correct size)
2583 *
2584 * But we can't call vinvalbuf while holding this
2585 * buffer busy. Set a flag to do it after releasing
2586 * the buffer.
2587 */
2588 nfs_node_lock_force(np);
2589 np->n_error = error;
2590 np->n_flag |= (NWRITEERR | NNEEDINVALIDATE);
2591 NATTRINVALIDATE(np);
2592 nfs_node_unlock(np);
2593 }
2594 /* clear the dirty range */
2595 bp->nb_dirtyoff = bp->nb_dirtyend = 0;
2596 }
2597
2598 if (!error && bp->nb_dirty)
2599 nfs_buf_write_dirty_pages(bp, thd, cred);
2600 nfs_buf_iodone(bp);
2601 }
2602
2603 /*
2604 * write out any pages marked dirty in a buffer
2605 *
2606 * We do use unstable writes and follow up with a commit.
2607 * If we catch the write verifier changing we'll restart
2608 * do the writes filesync.
2609 */
2610 int
2611 nfs_buf_write_dirty_pages(struct nfsbuf *bp, thread_t thd, kauth_cred_t cred)
2612 {
2613 nfsnode_t np = bp->nb_np;
2614 struct nfsmount *nmp = NFSTONMP(np);
2615 int error = 0, commit, iomode, iomode2, len, pg, count, npages, off;
2616 uint32_t dirty = bp->nb_dirty;
2617 uint64_t wverf;
2618 uio_t auio;
2619 char uio_buf [ UIO_SIZEOF(1) ];
2620
2621 if (!bp->nb_dirty)
2622 return (0);
2623
2624 /* there are pages marked dirty that need to be written out */
2625 OSAddAtomic64(1, &nfsstats.write_bios);
2626 NFS_BUF_MAP(bp);
2627 SET(bp->nb_flags, NB_WRITEINPROG);
2628 npages = bp->nb_bufsize / PAGE_SIZE;
2629 iomode = NFS_WRITE_UNSTABLE;
2630
2631 auio = uio_createwithbuffer(1, 0, UIO_SYSSPACE, UIO_WRITE,
2632 &uio_buf, sizeof(uio_buf));
2633
2634 again:
2635 dirty = bp->nb_dirty;
2636 wverf = bp->nb_verf;
2637 commit = NFS_WRITE_FILESYNC;
2638 for (pg = 0; pg < npages; pg++) {
2639 if (!NBPGDIRTY(bp, pg))
2640 continue;
2641 count = 1;
2642 while (((pg + count) < npages) && NBPGDIRTY(bp, pg + count))
2643 count++;
2644 /* write count pages starting with page pg */
2645 off = pg * PAGE_SIZE;
2646 len = count * PAGE_SIZE;
2647 /* clip writes to EOF */
2648 if (NBOFF(bp) + off + len > (off_t) np->n_size)
2649 len -= (NBOFF(bp) + off + len) - np->n_size;
2650 if (len > 0) {
2651 iomode2 = iomode;
2652 uio_reset(auio, NBOFF(bp) + off, UIO_SYSSPACE, UIO_WRITE);
2653 uio_addiov(auio, CAST_USER_ADDR_T(bp->nb_data + off), len);
2654 error = nfs_write_rpc2(np, auio, thd, cred, &iomode2, &bp->nb_verf);
2655 if (error)
2656 break;
2657 if (iomode2 < commit) /* Retain the lowest commitment level returned. */
2658 commit = iomode2;
2659 if ((commit != NFS_WRITE_FILESYNC) && (wverf != bp->nb_verf)) {
2660 /* verifier changed, redo all the writes filesync */
2661 iomode = NFS_WRITE_FILESYNC;
2662 goto again;
2663 }
2664 }
2665 /* clear dirty bits */
2666 while (count--) {
2667 dirty &= ~(1 << pg);
2668 if (count) /* leave pg on last page */
2669 pg++;
2670 }
2671 }
2672 CLR(bp->nb_flags, NB_WRITEINPROG);
2673
2674 if (!error && (commit != NFS_WRITE_FILESYNC)) {
2675 error = nmp->nm_funcs->nf_commit_rpc(np, NBOFF(bp), bp->nb_bufsize, cred, wverf);
2676 if (error == NFSERR_STALEWRITEVERF) {
2677 /* verifier changed, so we need to restart all the writes */
2678 iomode = NFS_WRITE_FILESYNC;
2679 goto again;
2680 }
2681 }
2682 if (!error) {
2683 bp->nb_dirty = dirty;
2684 } else {
2685 SET(bp->nb_flags, NB_ERROR);
2686 bp->nb_error = error;
2687 }
2688 return (error);
2689 }
2690
2691 /*
2692 * initiate the NFS WRITE RPC(s) for a buffer
2693 */
2694 int
2695 nfs_buf_write_rpc(struct nfsbuf *bp, int iomode, thread_t thd, kauth_cred_t cred)
2696 {
2697 struct nfsmount *nmp;
2698 nfsnode_t np = bp->nb_np;
2699 int error = 0, nfsvers, async;
2700 int offset, nrpcs;
2701 uint32_t nmwsize, length, len;
2702 struct nfsreq *req;
2703 struct nfsreq_cbinfo cb;
2704 uio_t auio;
2705 char uio_buf [ UIO_SIZEOF(1) ];
2706
2707 nmp = NFSTONMP(np);
2708 if (nfs_mount_gone(nmp)) {
2709 bp->nb_error = error = ENXIO;
2710 SET(bp->nb_flags, NB_ERROR);
2711 nfs_buf_iodone(bp);
2712 return (error);
2713 }
2714 nfsvers = nmp->nm_vers;
2715 nmwsize = nmp->nm_wsize;
2716
2717 offset = bp->nb_offio;
2718 length = bp->nb_endio - bp->nb_offio;
2719
2720 /* Note: Can only do async I/O if nfsiods are configured. */
2721 async = (bp->nb_flags & NB_ASYNC) && (NFSIOD_MAX > 0);
2722 bp->nb_commitlevel = NFS_WRITE_FILESYNC;
2723 cb.rcb_func = async ? nfs_buf_write_rpc_finish : NULL;
2724 cb.rcb_bp = bp;
2725
2726 if ((nfsvers == NFS_VER2) && ((NBOFF(bp) + bp->nb_endio) > 0xffffffffLL)) {
2727 bp->nb_error = error = EFBIG;
2728 SET(bp->nb_flags, NB_ERROR);
2729 nfs_buf_iodone(bp);
2730 return (error);
2731 }
2732
2733 auio = uio_createwithbuffer(1, NBOFF(bp) + offset, UIO_SYSSPACE,
2734 UIO_WRITE, &uio_buf, sizeof(uio_buf));
2735 uio_addiov(auio, CAST_USER_ADDR_T(bp->nb_data + offset), length);
2736
2737 bp->nb_rpcs = nrpcs = (length + nmwsize - 1) / nmwsize;
2738 if (async && (nrpcs > 1)) {
2739 SET(bp->nb_flags, NB_MULTASYNCRPC);
2740 } else {
2741 CLR(bp->nb_flags, NB_MULTASYNCRPC);
2742 }
2743
2744 while (length > 0) {
2745 if (ISSET(bp->nb_flags, NB_ERROR)) {
2746 error = bp->nb_error;
2747 break;
2748 }
2749 len = (length > nmwsize) ? nmwsize : length;
2750 cb.rcb_args[0] = offset;
2751 cb.rcb_args[1] = len;
2752 if (nmp->nm_vers >= NFS_VER4)
2753 cb.rcb_args[2] = nmp->nm_stategenid;
2754 if (async && ((error = nfs_async_write_start(nmp))))
2755 break;
2756 req = NULL;
2757 error = nmp->nm_funcs->nf_write_rpc_async(np, auio, len, thd, cred,
2758 iomode, &cb, &req);
2759 if (error) {
2760 if (async)
2761 nfs_async_write_done(nmp);
2762 break;
2763 }
2764 offset += len;
2765 length -= len;
2766 if (async)
2767 continue;
2768 nfs_buf_write_rpc_finish(req);
2769 }
2770
2771 if (length > 0) {
2772 /*
2773 * Something bad happened while trying to send the RPCs.
2774 * Wait for any outstanding requests to complete.
2775 */
2776 bp->nb_error = error;
2777 SET(bp->nb_flags, NB_ERROR);
2778 if (ISSET(bp->nb_flags, NB_MULTASYNCRPC)) {
2779 nrpcs = (length + nmwsize - 1) / nmwsize;
2780 lck_mtx_lock(nfs_buf_mutex);
2781 bp->nb_rpcs -= nrpcs;
2782 if (bp->nb_rpcs == 0) {
2783 /* No RPCs left, so the buffer's done */
2784 lck_mtx_unlock(nfs_buf_mutex);
2785 nfs_buf_write_finish(bp, thd, cred);
2786 } else {
2787 /* wait for the last RPC to mark it done */
2788 while (bp->nb_rpcs > 0)
2789 msleep(&bp->nb_rpcs, nfs_buf_mutex, 0,
2790 "nfs_buf_write_rpc_cancel", NULL);
2791 lck_mtx_unlock(nfs_buf_mutex);
2792 }
2793 } else {
2794 nfs_buf_write_finish(bp, thd, cred);
2795 }
2796 /* It may have just been an interrupt... that's OK */
2797 if (!ISSET(bp->nb_flags, NB_ERROR))
2798 error = 0;
2799 }
2800
2801 return (error);
2802 }
2803
2804 /*
2805 * finish up an NFS WRITE RPC on a buffer
2806 */
2807 void
2808 nfs_buf_write_rpc_finish(struct nfsreq *req)
2809 {
2810 int error = 0, nfsvers, offset, length, multasyncrpc, finished;
2811 int committed = NFS_WRITE_FILESYNC;
2812 uint64_t wverf = 0;
2813 size_t rlen;
2814 void *wakeme = NULL;
2815 struct nfsreq_cbinfo cb;
2816 struct nfsreq *wreq = NULL;
2817 struct nfsbuf *bp;
2818 struct nfsmount *nmp;
2819 nfsnode_t np;
2820 thread_t thd;
2821 kauth_cred_t cred;
2822 uio_t auio;
2823 char uio_buf [ UIO_SIZEOF(1) ];
2824
2825 finish:
2826 np = req->r_np;
2827 thd = req->r_thread;
2828 cred = req->r_cred;
2829 if (IS_VALID_CRED(cred))
2830 kauth_cred_ref(cred);
2831 cb = req->r_callback;
2832 bp = cb.rcb_bp;
2833 if (cb.rcb_func) /* take an extra reference on the nfsreq in case we want to resend it later due to grace error */
2834 nfs_request_ref(req, 0);
2835
2836 nmp = NFSTONMP(np);
2837 if (nfs_mount_gone(nmp)) {
2838 SET(bp->nb_flags, NB_ERROR);
2839 bp->nb_error = error = ENXIO;
2840 }
2841 if (error || ISSET(bp->nb_flags, NB_ERROR)) {
2842 /* just drop it */
2843 nfs_request_async_cancel(req);
2844 goto out;
2845 }
2846 nfsvers = nmp->nm_vers;
2847
2848 offset = cb.rcb_args[0];
2849 rlen = length = cb.rcb_args[1];
2850
2851 /* finish the RPC */
2852 error = nmp->nm_funcs->nf_write_rpc_async_finish(np, req, &committed, &rlen, &wverf);
2853 if ((error == EINPROGRESS) && cb.rcb_func) {
2854 /* async request restarted */
2855 if (cb.rcb_func)
2856 nfs_request_rele(req);
2857 if (IS_VALID_CRED(cred))
2858 kauth_cred_unref(&cred);
2859 return;
2860 }
2861 if ((nmp->nm_vers >= NFS_VER4) && nfs_mount_state_error_should_restart(error) && !ISSET(bp->nb_flags, NB_ERROR)) {
2862 lck_mtx_lock(&nmp->nm_lock);
2863 if ((error != NFSERR_OLD_STATEID) && (error != NFSERR_GRACE) && (cb.rcb_args[2] == nmp->nm_stategenid)) {
2864 NP(np, "nfs_buf_write_rpc_finish: error %d @ 0x%llx, 0x%x 0x%x, initiating recovery",
2865 error, NBOFF(bp)+offset, cb.rcb_args[2], nmp->nm_stategenid);
2866 nfs_need_recover(nmp, error);
2867 }
2868 lck_mtx_unlock(&nmp->nm_lock);
2869 if (np->n_flag & NREVOKE) {
2870 error = EIO;
2871 } else {
2872 if (error == NFSERR_GRACE) {
2873 if (cb.rcb_func) {
2874 /*
2875 * For an async I/O request, handle a grace delay just like
2876 * jukebox errors. Set the resend time and queue it up.
2877 */
2878 struct timeval now;
2879 if (req->r_nmrep.nmc_mhead) {
2880 mbuf_freem(req->r_nmrep.nmc_mhead);
2881 req->r_nmrep.nmc_mhead = NULL;
2882 }
2883 req->r_error = 0;
2884 microuptime(&now);
2885 lck_mtx_lock(&req->r_mtx);
2886 req->r_resendtime = now.tv_sec + 2;
2887 req->r_xid = 0; // get a new XID
2888 req->r_flags |= R_RESTART;
2889 req->r_start = 0;
2890 nfs_asyncio_resend(req);
2891 lck_mtx_unlock(&req->r_mtx);
2892 if (IS_VALID_CRED(cred))
2893 kauth_cred_unref(&cred);
2894 /* Note: nfsreq reference taken will be dropped later when finished */
2895 return;
2896 }
2897 /* otherwise, just pause a couple seconds and retry */
2898 tsleep(&nmp->nm_state, (PZERO-1), "nfsgrace", 2*hz);
2899 }
2900 if (!(error = nfs_mount_state_wait_for_recovery(nmp))) {
2901 rlen = 0;
2902 goto writeagain;
2903 }
2904 }
2905 }
2906 if (error) {
2907 SET(bp->nb_flags, NB_ERROR);
2908 bp->nb_error = error;
2909 }
2910 if (error || (nfsvers == NFS_VER2))
2911 goto out;
2912 if (rlen <= 0) {
2913 SET(bp->nb_flags, NB_ERROR);
2914 bp->nb_error = error = EIO;
2915 goto out;
2916 }
2917
2918 /* save lowest commit level returned */
2919 if (committed < bp->nb_commitlevel)
2920 bp->nb_commitlevel = committed;
2921
2922 /* check the write verifier */
2923 if (!bp->nb_verf) {
2924 bp->nb_verf = wverf;
2925 } else if (bp->nb_verf != wverf) {
2926 /* verifier changed, so buffer will need to be rewritten */
2927 bp->nb_flags |= NB_STALEWVERF;
2928 bp->nb_commitlevel = NFS_WRITE_UNSTABLE;
2929 bp->nb_verf = wverf;
2930 }
2931
2932 /*
2933 * check for a short write
2934 *
2935 * If the server didn't write all the data, then we
2936 * need to issue another write for the rest of it.
2937 * (Don't bother if the buffer hit an error or stale wverf.)
2938 */
2939 if (((int)rlen < length) && !(bp->nb_flags & (NB_STALEWVERF|NB_ERROR))) {
2940 writeagain:
2941 offset += rlen;
2942 length -= rlen;
2943
2944 auio = uio_createwithbuffer(1, NBOFF(bp) + offset, UIO_SYSSPACE,
2945 UIO_WRITE, &uio_buf, sizeof(uio_buf));
2946 uio_addiov(auio, CAST_USER_ADDR_T(bp->nb_data + offset), length);
2947
2948 cb.rcb_args[0] = offset;
2949 cb.rcb_args[1] = length;
2950 if (nmp->nm_vers >= NFS_VER4)
2951 cb.rcb_args[2] = nmp->nm_stategenid;
2952
2953 // XXX iomode should really match the original request
2954 error = nmp->nm_funcs->nf_write_rpc_async(np, auio, length, thd, cred,
2955 NFS_WRITE_FILESYNC, &cb, &wreq);
2956 if (!error) {
2957 if (IS_VALID_CRED(cred))
2958 kauth_cred_unref(&cred);
2959 if (!cb.rcb_func) {
2960 /* if !async we'll need to wait for this RPC to finish */
2961 req = wreq;
2962 wreq = NULL;
2963 goto finish;
2964 }
2965 nfs_request_rele(req);
2966 /*
2967 * We're done here.
2968 * Outstanding RPC count is unchanged.
2969 * Callback will be called when RPC is done.
2970 */
2971 return;
2972 }
2973 SET(bp->nb_flags, NB_ERROR);
2974 bp->nb_error = error;
2975 }
2976
2977 out:
2978 if (cb.rcb_func) {
2979 nfs_async_write_done(nmp);
2980 nfs_request_rele(req);
2981 }
2982 /*
2983 * Decrement outstanding RPC count on buffer
2984 * and call nfs_buf_write_finish on last RPC.
2985 *
2986 * (Note: when there are multiple async RPCs issued for a
2987 * buffer we need nfs_buffer_mutex to avoid problems when
2988 * aborting a partially-initiated set of RPCs)
2989 */
2990 multasyncrpc = ISSET(bp->nb_flags, NB_MULTASYNCRPC);
2991 if (multasyncrpc)
2992 lck_mtx_lock(nfs_buf_mutex);
2993
2994 bp->nb_rpcs--;
2995 finished = (bp->nb_rpcs == 0);
2996
2997 if (multasyncrpc)
2998 lck_mtx_unlock(nfs_buf_mutex);
2999
3000 if (finished) {
3001 if (multasyncrpc)
3002 wakeme = &bp->nb_rpcs;
3003 nfs_buf_write_finish(bp, thd, cred);
3004 if (wakeme)
3005 wakeup(wakeme);
3006 }
3007
3008 if (IS_VALID_CRED(cred))
3009 kauth_cred_unref(&cred);
3010 }
3011
3012 /*
3013 * Send commit(s) for the given node's "needcommit" buffers
3014 */
3015 int
3016 nfs_flushcommits(nfsnode_t np, int nowait)
3017 {
3018 struct nfsmount *nmp;
3019 struct nfsbuf *bp, *prevlbp, *lbp;
3020 struct nfsbuflists blist, commitlist;
3021 int error = 0, retv, wcred_set, flags, dirty;
3022 u_quad_t off, endoff, toff;
3023 uint64_t wverf;
3024 u_int32_t count;
3025 kauth_cred_t wcred = NULL;
3026
3027 FSDBG_TOP(557, np, 0, 0, 0);
3028
3029 /*
3030 * A nb_flags == (NB_DELWRI | NB_NEEDCOMMIT) block has been written to the
3031 * server, but nas not been committed to stable storage on the server
3032 * yet. The byte range is worked out for as many nfsbufs as we can handle
3033 * and the commit rpc is done.
3034 */
3035 if (!LIST_EMPTY(&np->n_dirtyblkhd)) {
3036 error = nfs_node_lock(np);
3037 if (error)
3038 goto done;
3039 np->n_flag |= NMODIFIED;
3040 nfs_node_unlock(np);
3041 }
3042
3043 off = (u_quad_t)-1;
3044 endoff = 0;
3045 wcred_set = 0;
3046 LIST_INIT(&commitlist);
3047
3048 nmp = NFSTONMP(np);
3049 if (nfs_mount_gone(nmp)) {
3050 error = ENXIO;
3051 goto done;
3052 }
3053 if (nmp->nm_vers == NFS_VER2) {
3054 error = EINVAL;
3055 goto done;
3056 }
3057
3058 flags = NBI_DIRTY;
3059 if (nowait)
3060 flags |= NBI_NOWAIT;
3061 lck_mtx_lock(nfs_buf_mutex);
3062 wverf = nmp->nm_verf;
3063 if (!nfs_buf_iterprepare(np, &blist, flags)) {
3064 while ((bp = LIST_FIRST(&blist))) {
3065 LIST_REMOVE(bp, nb_vnbufs);
3066 LIST_INSERT_HEAD(&np->n_dirtyblkhd, bp, nb_vnbufs);
3067 error = nfs_buf_acquire(bp, NBAC_NOWAIT, 0, 0);
3068 if (error)
3069 continue;
3070 if (ISSET(bp->nb_flags, NB_NEEDCOMMIT))
3071 nfs_buf_check_write_verifier(np, bp);
3072 if (((bp->nb_flags & (NB_DELWRI | NB_NEEDCOMMIT)) != (NB_DELWRI | NB_NEEDCOMMIT)) ||
3073 (bp->nb_verf != wverf)) {
3074 nfs_buf_drop(bp);
3075 continue;
3076 }
3077 nfs_buf_remfree(bp);
3078
3079 /* buffer UPLs will be grabbed *in order* below */
3080
3081 FSDBG(557, bp, bp->nb_flags, bp->nb_valid, bp->nb_dirty);
3082 FSDBG(557, bp->nb_validoff, bp->nb_validend,
3083 bp->nb_dirtyoff, bp->nb_dirtyend);
3084
3085 /*
3086 * Work out if all buffers are using the same cred
3087 * so we can deal with them all with one commit.
3088 *
3089 * Note: creds in bp's must be obtained by kauth_cred_ref
3090 * on the same original cred in order for them to be equal.
3091 */
3092 if (wcred_set == 0) {
3093 wcred = bp->nb_wcred;
3094 if (!IS_VALID_CRED(wcred))
3095 panic("nfs: needcommit w/out wcred");
3096 wcred_set = 1;
3097 } else if ((wcred_set == 1) && wcred != bp->nb_wcred) {
3098 wcred_set = -1;
3099 }
3100 SET(bp->nb_flags, NB_WRITEINPROG);
3101
3102 /*
3103 * Add this buffer to the list of buffers we are committing.
3104 * Buffers are inserted into the list in ascending order so that
3105 * we can take the UPLs in order after the list is complete.
3106 */
3107 prevlbp = NULL;
3108 LIST_FOREACH(lbp, &commitlist, nb_vnbufs) {
3109 if (bp->nb_lblkno < lbp->nb_lblkno)
3110 break;
3111 prevlbp = lbp;
3112 }
3113 LIST_REMOVE(bp, nb_vnbufs);
3114 if (prevlbp)
3115 LIST_INSERT_AFTER(prevlbp, bp, nb_vnbufs);
3116 else
3117 LIST_INSERT_HEAD(&commitlist, bp, nb_vnbufs);
3118
3119 /* update commit range start, end */
3120 toff = NBOFF(bp) + bp->nb_dirtyoff;
3121 if (toff < off)
3122 off = toff;
3123 toff += (u_quad_t)(bp->nb_dirtyend - bp->nb_dirtyoff);
3124 if (toff > endoff)
3125 endoff = toff;
3126 }
3127 nfs_buf_itercomplete(np, &blist, NBI_DIRTY);
3128 }
3129 lck_mtx_unlock(nfs_buf_mutex);
3130
3131 if (LIST_EMPTY(&commitlist)) {
3132 error = ENOBUFS;
3133 goto done;
3134 }
3135
3136 /*
3137 * We need a UPL to prevent others from accessing the buffers during
3138 * our commit RPC(s).
3139 *
3140 * We used to also check for dirty pages here; if there were any we'd
3141 * abort the commit and force the entire buffer to be written again.
3142 * Instead of doing that, we just go ahead and commit the dirty range,
3143 * and then leave the buffer around with dirty pages that will be
3144 * written out later.
3145 */
3146 LIST_FOREACH(bp, &commitlist, nb_vnbufs) {
3147 if (!ISSET(bp->nb_flags, NB_PAGELIST)) {
3148 retv = nfs_buf_upl_setup(bp);
3149 if (retv) {
3150 /* Unable to create the UPL, the VM object probably no longer exists. */
3151 printf("nfs_flushcommits: upl create failed %d\n", retv);
3152 bp->nb_valid = bp->nb_dirty = 0;
3153 }
3154 }
3155 nfs_buf_upl_check(bp);
3156 }
3157
3158 /*
3159 * Commit data on the server, as required.
3160 * If all bufs are using the same wcred, then use that with
3161 * one call for all of them, otherwise commit each one
3162 * separately.
3163 */
3164 if (wcred_set == 1) {
3165 /*
3166 * Note, it's possible the commit range could be >2^32-1.
3167 * If it is, we'll send one commit that covers the whole file.
3168 */
3169 if ((endoff - off) > 0xffffffff)
3170 count = 0;
3171 else
3172 count = (endoff - off);
3173 retv = nmp->nm_funcs->nf_commit_rpc(np, off, count, wcred, wverf);
3174 } else {
3175 retv = 0;
3176 LIST_FOREACH(bp, &commitlist, nb_vnbufs) {
3177 toff = NBOFF(bp) + bp->nb_dirtyoff;
3178 count = bp->nb_dirtyend - bp->nb_dirtyoff;
3179 retv = nmp->nm_funcs->nf_commit_rpc(np, toff, count, bp->nb_wcred, wverf);
3180 if (retv)
3181 break;
3182 }
3183 }
3184
3185 /*
3186 * Now, either mark the blocks I/O done or mark the
3187 * blocks dirty, depending on whether the commit
3188 * succeeded.
3189 */
3190 while ((bp = LIST_FIRST(&commitlist))) {
3191 LIST_REMOVE(bp, nb_vnbufs);
3192 FSDBG(557, bp, retv, bp->nb_flags, bp->nb_dirty);
3193 nfs_node_lock_force(np);
3194 CLR(bp->nb_flags, (NB_NEEDCOMMIT | NB_WRITEINPROG));
3195 np->n_needcommitcnt--;
3196 CHECK_NEEDCOMMITCNT(np);
3197 nfs_node_unlock(np);
3198
3199 if (retv) {
3200 /* move back to dirty list */
3201 lck_mtx_lock(nfs_buf_mutex);
3202 LIST_INSERT_HEAD(&np->n_dirtyblkhd, bp, nb_vnbufs);
3203 lck_mtx_unlock(nfs_buf_mutex);
3204 nfs_buf_release(bp, 1);
3205 continue;
3206 }
3207
3208 nfs_node_lock_force(np);
3209 np->n_numoutput++;
3210 nfs_node_unlock(np);
3211 vnode_startwrite(NFSTOV(np));
3212 if (ISSET(bp->nb_flags, NB_DELWRI)) {
3213 lck_mtx_lock(nfs_buf_mutex);
3214 nfs_nbdwrite--;
3215 NFSBUFCNTCHK();
3216 lck_mtx_unlock(nfs_buf_mutex);
3217 wakeup(&nfs_nbdwrite);
3218 }
3219 CLR(bp->nb_flags, (NB_READ|NB_DONE|NB_ERROR|NB_DELWRI));
3220 /* if block still has dirty pages, we don't want it to */
3221 /* be released in nfs_buf_iodone(). So, don't set NB_ASYNC. */
3222 if (!(dirty = bp->nb_dirty))
3223 SET(bp->nb_flags, NB_ASYNC);
3224 else
3225 CLR(bp->nb_flags, NB_ASYNC);
3226
3227 /* move to clean list */
3228 lck_mtx_lock(nfs_buf_mutex);
3229 LIST_INSERT_HEAD(&np->n_cleanblkhd, bp, nb_vnbufs);
3230 lck_mtx_unlock(nfs_buf_mutex);
3231
3232 bp->nb_dirtyoff = bp->nb_dirtyend = 0;
3233
3234 nfs_buf_iodone(bp);
3235 if (dirty) {
3236 /* throw it back in as a delayed write buffer */
3237 CLR(bp->nb_flags, NB_DONE);
3238 nfs_buf_write_delayed(bp);
3239 }
3240 }
3241
3242 done:
3243 FSDBG_BOT(557, np, 0, 0, error);
3244 return (error);
3245 }
3246
3247 /*
3248 * Flush all the blocks associated with a vnode.
3249 * Walk through the buffer pool and push any dirty pages
3250 * associated with the vnode.
3251 */
3252 int
3253 nfs_flush(nfsnode_t np, int waitfor, thread_t thd, int ignore_writeerr)
3254 {
3255 struct nfsbuf *bp;
3256 struct nfsbuflists blist;
3257 struct nfsmount *nmp = NFSTONMP(np);
3258 int error = 0, error2, slptimeo = 0, slpflag = 0;
3259 int nfsvers, flags, passone = 1;
3260
3261 FSDBG_TOP(517, np, waitfor, ignore_writeerr, 0);
3262
3263 if (nfs_mount_gone(nmp)) {
3264 error = ENXIO;
3265 goto out;
3266 }
3267 nfsvers = nmp->nm_vers;
3268 if (NMFLAG(nmp, INTR))
3269 slpflag = PCATCH;
3270
3271 if (!LIST_EMPTY(&np->n_dirtyblkhd)) {
3272 nfs_node_lock_force(np);
3273 np->n_flag |= NMODIFIED;
3274 nfs_node_unlock(np);
3275 }
3276
3277 lck_mtx_lock(nfs_buf_mutex);
3278 while (np->n_bflag & NBFLUSHINPROG) {
3279 np->n_bflag |= NBFLUSHWANT;
3280 error = msleep(&np->n_bflag, nfs_buf_mutex, slpflag, "nfs_flush", NULL);
3281 if ((error && (error != EWOULDBLOCK)) ||
3282 ((error = nfs_sigintr(NFSTONMP(np), NULL, thd, 0)))) {
3283 lck_mtx_unlock(nfs_buf_mutex);
3284 goto out;
3285 }
3286 }
3287 np->n_bflag |= NBFLUSHINPROG;
3288
3289 /*
3290 * On the first pass, start async/unstable writes on all
3291 * delayed write buffers. Then wait for all writes to complete
3292 * and call nfs_flushcommits() to commit any uncommitted buffers.
3293 * On all subsequent passes, start STABLE writes on any remaining
3294 * dirty buffers. Then wait for all writes to complete.
3295 */
3296 again:
3297 FSDBG(518, LIST_FIRST(&np->n_dirtyblkhd), np->n_flag, 0, 0);
3298 if (!NFSTONMP(np)) {
3299 lck_mtx_unlock(nfs_buf_mutex);
3300 error = ENXIO;
3301 goto done;
3302 }
3303
3304 /* Start/do any write(s) that are required. */
3305 if (!nfs_buf_iterprepare(np, &blist, NBI_DIRTY)) {
3306 while ((bp = LIST_FIRST(&blist))) {
3307 LIST_REMOVE(bp, nb_vnbufs);
3308 LIST_INSERT_HEAD(&np->n_dirtyblkhd, bp, nb_vnbufs);
3309 flags = (passone || !(waitfor == MNT_WAIT || waitfor == MNT_DWAIT)) ? NBAC_NOWAIT : 0;
3310 if (flags != NBAC_NOWAIT)
3311 nfs_buf_refget(bp);
3312 while ((error = nfs_buf_acquire(bp, flags, slpflag, slptimeo))) {
3313 FSDBG(524, bp, flags, bp->nb_lflags, bp->nb_flags);
3314 if (error == EBUSY)
3315 break;
3316 if (error) {
3317 error2 = nfs_sigintr(NFSTONMP(np), NULL, thd, 0);
3318 if (error2) {
3319 if (flags != NBAC_NOWAIT)
3320 nfs_buf_refrele(bp);
3321 nfs_buf_itercomplete(np, &blist, NBI_DIRTY);
3322 lck_mtx_unlock(nfs_buf_mutex);
3323 error = error2;
3324 goto done;
3325 }
3326 if (slpflag == PCATCH) {
3327 slpflag = 0;
3328 slptimeo = 2 * hz;
3329 }
3330 }
3331 }
3332 if (flags != NBAC_NOWAIT)
3333 nfs_buf_refrele(bp);
3334 if (error == EBUSY)
3335 continue;
3336 if (!bp->nb_np) {
3337 /* buffer is no longer valid */
3338 nfs_buf_drop(bp);
3339 continue;
3340 }
3341 if (ISSET(bp->nb_flags, NB_NEEDCOMMIT))
3342 nfs_buf_check_write_verifier(np, bp);
3343 if (!ISSET(bp->nb_flags, NB_DELWRI)) {
3344 /* buffer is no longer dirty */
3345 nfs_buf_drop(bp);
3346 continue;
3347 }
3348 FSDBG(525, bp, passone, bp->nb_lflags, bp->nb_flags);
3349 if ((passone || !(waitfor == MNT_WAIT || waitfor == MNT_DWAIT)) &&
3350 ISSET(bp->nb_flags, NB_NEEDCOMMIT)) {
3351 nfs_buf_drop(bp);
3352 continue;
3353 }
3354 nfs_buf_remfree(bp);
3355 lck_mtx_unlock(nfs_buf_mutex);
3356 if (ISSET(bp->nb_flags, NB_ERROR)) {
3357 nfs_node_lock_force(np);
3358 np->n_error = bp->nb_error ? bp->nb_error : EIO;
3359 np->n_flag |= NWRITEERR;
3360 nfs_node_unlock(np);
3361 nfs_buf_release(bp, 1);
3362 lck_mtx_lock(nfs_buf_mutex);
3363 continue;
3364 }
3365 SET(bp->nb_flags, NB_ASYNC);
3366 if (!passone) {
3367 /* NB_STABLE forces this to be written FILESYNC */
3368 SET(bp->nb_flags, NB_STABLE);
3369 }
3370 nfs_buf_write(bp);
3371 lck_mtx_lock(nfs_buf_mutex);
3372 }
3373 nfs_buf_itercomplete(np, &blist, NBI_DIRTY);
3374 }
3375 lck_mtx_unlock(nfs_buf_mutex);
3376
3377 if (waitfor == MNT_WAIT || waitfor == MNT_DWAIT) {
3378 while ((error = vnode_waitforwrites(NFSTOV(np), 0, slpflag, slptimeo, "nfsflush"))) {
3379 error2 = nfs_sigintr(NFSTONMP(np), NULL, thd, 0);
3380 if (error2) {
3381 error = error2;
3382 goto done;
3383 }
3384 if (slpflag == PCATCH) {
3385 slpflag = 0;
3386 slptimeo = 2 * hz;
3387 }
3388 }
3389 }
3390
3391 if (nfsvers != NFS_VER2) {
3392 /* loop while it looks like there are still buffers to be */
3393 /* commited and nfs_flushcommits() seems to be handling them. */
3394 while (np->n_needcommitcnt)
3395 if (nfs_flushcommits(np, 0))
3396 break;
3397 }
3398
3399 if (passone) {
3400 passone = 0;
3401 if (!LIST_EMPTY(&np->n_dirtyblkhd)) {
3402 nfs_node_lock_force(np);
3403 np->n_flag |= NMODIFIED;
3404 nfs_node_unlock(np);
3405 }
3406 lck_mtx_lock(nfs_buf_mutex);
3407 goto again;
3408 }
3409
3410 if (waitfor == MNT_WAIT || waitfor == MNT_DWAIT) {
3411 if (!LIST_EMPTY(&np->n_dirtyblkhd)) {
3412 nfs_node_lock_force(np);
3413 np->n_flag |= NMODIFIED;
3414 nfs_node_unlock(np);
3415 }
3416 lck_mtx_lock(nfs_buf_mutex);
3417 if (!LIST_EMPTY(&np->n_dirtyblkhd))
3418 goto again;
3419 lck_mtx_unlock(nfs_buf_mutex);
3420 nfs_node_lock_force(np);
3421 /*
3422 * OK, it looks like there are no dirty blocks. If we have no
3423 * writes in flight and no one in the write code, we can clear
3424 * the modified flag. In order to make sure we see the latest
3425 * attributes and size, we also invalidate the attributes and
3426 * advance the attribute cache XID to guarantee that attributes
3427 * newer than our clearing of NMODIFIED will get loaded next.
3428 * (If we don't do this, it's possible for the flush's final
3429 * write/commit (xid1) to be executed in parallel with a subsequent
3430 * getattr request (xid2). The getattr could return attributes
3431 * from *before* the write/commit completed but the stale attributes
3432 * would be preferred because of the xid ordering.)
3433 */
3434 if (!np->n_wrbusy && !np->n_numoutput) {
3435 np->n_flag &= ~NMODIFIED;
3436 NATTRINVALIDATE(np);
3437 nfs_get_xid(&np->n_xid);
3438 }
3439 } else {
3440 nfs_node_lock_force(np);
3441 }
3442
3443 FSDBG(526, np->n_flag, np->n_error, 0, 0);
3444 if (!ignore_writeerr && (np->n_flag & NWRITEERR)) {
3445 error = np->n_error;
3446 np->n_flag &= ~NWRITEERR;
3447 }
3448 nfs_node_unlock(np);
3449 done:
3450 lck_mtx_lock(nfs_buf_mutex);
3451 flags = np->n_bflag;
3452 np->n_bflag &= ~(NBFLUSHINPROG|NBFLUSHWANT);
3453 lck_mtx_unlock(nfs_buf_mutex);
3454 if (flags & NBFLUSHWANT)
3455 wakeup(&np->n_bflag);
3456 out:
3457 FSDBG_BOT(517, np, error, ignore_writeerr, 0);
3458 return (error);
3459 }
3460
3461 /*
3462 * Flush out and invalidate all buffers associated with a vnode.
3463 * Called with the underlying object locked.
3464 */
3465 int
3466 nfs_vinvalbuf_internal(
3467 nfsnode_t np,
3468 int flags,
3469 thread_t thd,
3470 kauth_cred_t cred,
3471 int slpflag,
3472 int slptimeo)
3473 {
3474 struct nfsbuf *bp;
3475 struct nfsbuflists blist;
3476 int list, error = 0;
3477
3478 if (flags & V_SAVE) {
3479 if ((error = nfs_flush(np, MNT_WAIT, thd, (flags & V_IGNORE_WRITEERR))))
3480 return (error);
3481 }
3482
3483 lck_mtx_lock(nfs_buf_mutex);
3484 for (;;) {
3485 list = NBI_CLEAN;
3486 if (nfs_buf_iterprepare(np, &blist, list)) {
3487 list = NBI_DIRTY;
3488 if (nfs_buf_iterprepare(np, &blist, list))
3489 break;
3490 }
3491 while ((bp = LIST_FIRST(&blist))) {
3492 LIST_REMOVE(bp, nb_vnbufs);
3493 if (list == NBI_CLEAN)
3494 LIST_INSERT_HEAD(&np->n_cleanblkhd, bp, nb_vnbufs);
3495 else
3496 LIST_INSERT_HEAD(&np->n_dirtyblkhd, bp, nb_vnbufs);
3497 nfs_buf_refget(bp);
3498 while ((error = nfs_buf_acquire(bp, NBAC_REMOVE, slpflag, slptimeo))) {
3499 FSDBG(556, np, bp, NBOFF(bp), bp->nb_flags);
3500 if (error != EAGAIN) {
3501 FSDBG(554, np, bp, -1, error);
3502 nfs_buf_refrele(bp);
3503 nfs_buf_itercomplete(np, &blist, list);
3504 lck_mtx_unlock(nfs_buf_mutex);
3505 return (error);
3506 }
3507 }
3508 nfs_buf_refrele(bp);
3509 FSDBG(554, np, bp, NBOFF(bp), bp->nb_flags);
3510 lck_mtx_unlock(nfs_buf_mutex);
3511 if ((flags & V_SAVE) && UBCINFOEXISTS(NFSTOV(np)) && bp->nb_np &&
3512 (NBOFF(bp) < (off_t)np->n_size)) {
3513 /* extra paranoia: make sure we're not */
3514 /* somehow leaving any dirty data around */
3515 int mustwrite = 0;
3516 int end = (NBOFF(bp) + bp->nb_bufsize > (off_t)np->n_size) ?
3517 ((off_t)np->n_size - NBOFF(bp)) : bp->nb_bufsize;
3518 if (!ISSET(bp->nb_flags, NB_PAGELIST)) {
3519 error = nfs_buf_upl_setup(bp);
3520 if (error == EINVAL) {
3521 /* vm object must no longer exist */
3522 /* hopefully we don't need to do */
3523 /* anything for this buffer */
3524 } else if (error)
3525 printf("nfs_vinvalbuf: upl setup failed %d\n", error);
3526 bp->nb_valid = bp->nb_dirty = 0;
3527 }
3528 nfs_buf_upl_check(bp);
3529 /* check for any dirty data before the EOF */
3530 if ((bp->nb_dirtyend > 0) && (bp->nb_dirtyoff < end)) {
3531 /* clip dirty range to EOF */
3532 if (bp->nb_dirtyend > end) {
3533 bp->nb_dirtyend = end;
3534 if (bp->nb_dirtyoff >= bp->nb_dirtyend)
3535 bp->nb_dirtyoff = bp->nb_dirtyend = 0;
3536 }
3537 if ((bp->nb_dirtyend > 0) && (bp->nb_dirtyoff < end))
3538 mustwrite++;
3539 }
3540 bp->nb_dirty &= (1 << (round_page_32(end)/PAGE_SIZE)) - 1;
3541 if (bp->nb_dirty)
3542 mustwrite++;
3543 /* also make sure we'll have a credential to do the write */
3544 if (mustwrite && !IS_VALID_CRED(bp->nb_wcred) && !IS_VALID_CRED(cred)) {
3545 printf("nfs_vinvalbuf: found dirty buffer with no write creds\n");
3546 mustwrite = 0;
3547 }
3548 if (mustwrite) {
3549 FSDBG(554, np, bp, 0xd00dee, bp->nb_flags);
3550 if (!ISSET(bp->nb_flags, NB_PAGELIST))
3551 panic("nfs_vinvalbuf: dirty buffer without upl");
3552 /* gotta write out dirty data before invalidating */
3553 /* (NB_STABLE indicates that data writes should be FILESYNC) */
3554 /* (NB_NOCACHE indicates buffer should be discarded) */
3555 CLR(bp->nb_flags, (NB_DONE | NB_ERROR | NB_INVAL | NB_ASYNC));
3556 SET(bp->nb_flags, NB_STABLE | NB_NOCACHE);
3557 if (!IS_VALID_CRED(bp->nb_wcred)) {
3558 kauth_cred_ref(cred);
3559 bp->nb_wcred = cred;
3560 }
3561 error = nfs_buf_write(bp);
3562 // Note: bp has been released
3563 if (error) {
3564 FSDBG(554, bp, 0xd00dee, 0xbad, error);
3565 nfs_node_lock_force(np);
3566 if ((error != EINTR) && (error != ERESTART)) {
3567 np->n_error = error;
3568 np->n_flag |= NWRITEERR;
3569 }
3570 /*
3571 * There was a write error and we need to
3572 * invalidate attrs to sync with server.
3573 * (if this write was extending the file,
3574 * we may no longer know the correct size)
3575 */
3576 NATTRINVALIDATE(np);
3577 nfs_node_unlock(np);
3578 if ((error == EINTR) || (error == ERESTART)) {
3579 /*
3580 * Abort on EINTR. If we don't, we could
3581 * be stuck in this loop forever because
3582 * the buffer will continue to stay dirty.
3583 */
3584 lck_mtx_lock(nfs_buf_mutex);
3585 nfs_buf_itercomplete(np, &blist, list);
3586 lck_mtx_unlock(nfs_buf_mutex);
3587 return (error);
3588 }
3589 error = 0;
3590 }
3591 lck_mtx_lock(nfs_buf_mutex);
3592 continue;
3593 }
3594 }
3595 SET(bp->nb_flags, NB_INVAL);
3596 // hold off on FREEUPs until we're done here
3597 nfs_buf_release(bp, 0);
3598 lck_mtx_lock(nfs_buf_mutex);
3599 }
3600 nfs_buf_itercomplete(np, &blist, list);
3601 }
3602 if (!LIST_EMPTY(&(np)->n_dirtyblkhd) || !LIST_EMPTY(&(np)->n_cleanblkhd))
3603 panic("nfs_vinvalbuf: flush/inval failed");
3604 lck_mtx_unlock(nfs_buf_mutex);
3605 nfs_node_lock_force(np);
3606 if (!(flags & V_SAVE))
3607 np->n_flag &= ~NMODIFIED;
3608 if (vnode_vtype(NFSTOV(np)) == VREG)
3609 np->n_lastrahead = -1;
3610 nfs_node_unlock(np);
3611 NFS_BUF_FREEUP();
3612 return (0);
3613 }
3614
3615
3616 /*
3617 * Flush and invalidate all dirty buffers. If another process is already
3618 * doing the flush, just wait for completion.
3619 */
3620 int
3621 nfs_vinvalbuf(vnode_t vp, int flags, vfs_context_t ctx, int intrflg)
3622 {
3623 return nfs_vinvalbuf2(vp, flags, vfs_context_thread(ctx), vfs_context_ucred(ctx), intrflg);
3624 }
3625
3626 int
3627 nfs_vinvalbuf2(vnode_t vp, int flags, thread_t thd, kauth_cred_t cred, int intrflg)
3628 {
3629 nfsnode_t np = VTONFS(vp);
3630 struct nfsmount *nmp = VTONMP(vp);
3631 int error, slpflag, slptimeo, nflags, retry = 0;
3632 int ubcflags = UBC_PUSHALL | UBC_SYNC | UBC_INVALIDATE;
3633 struct timespec ts = { 2, 0 };
3634 off_t size;
3635
3636 FSDBG_TOP(554, np, flags, intrflg, 0);
3637
3638 /*
3639 * If the mount is gone no sense to try and write anything.
3640 * and hang trying to do IO.
3641 */
3642 if (nfs_mount_gone(nmp)) {
3643 flags &= ~V_SAVE;
3644 ubcflags &= ~UBC_PUSHALL;
3645 }
3646
3647 if (nmp && !NMFLAG(nmp, INTR))
3648 intrflg = 0;
3649 if (intrflg) {
3650 slpflag = PCATCH;
3651 slptimeo = 2 * hz;
3652 } else {
3653 slpflag = 0;
3654 slptimeo = 0;
3655 }
3656
3657 /* First wait for any other process doing a flush to complete. */
3658 lck_mtx_lock(nfs_buf_mutex);
3659 while (np->n_bflag & NBINVALINPROG) {
3660 np->n_bflag |= NBINVALWANT;
3661 msleep(&np->n_bflag, nfs_buf_mutex, slpflag, "nfs_vinvalbuf", &ts);
3662 if ((error = nfs_sigintr(VTONMP(vp), NULL, thd, 0))) {
3663 lck_mtx_unlock(nfs_buf_mutex);
3664 return (error);
3665 }
3666 if (np->n_bflag & NBINVALINPROG)
3667 slpflag = 0;
3668 }
3669 np->n_bflag |= NBINVALINPROG;
3670 lck_mtx_unlock(nfs_buf_mutex);
3671
3672 /* Now, flush as required. */
3673 again:
3674 error = nfs_vinvalbuf_internal(np, flags, thd, cred, slpflag, 0);
3675 while (error) {
3676 FSDBG(554, np, 0, 0, error);
3677 if ((error = nfs_sigintr(VTONMP(vp), NULL, thd, 0)))
3678 goto done;
3679 error = nfs_vinvalbuf_internal(np, flags, thd, cred, 0, slptimeo);
3680 }
3681
3682 /* get the pages out of vm also */
3683 if (UBCINFOEXISTS(vp) && (size = ubc_getsize(vp)))
3684 if ((error = ubc_msync(vp, 0, size, NULL, ubcflags))) {
3685 if (error == EINVAL)
3686 panic("nfs_vinvalbuf(): ubc_msync failed!, error %d", error);
3687 if (retry++ < 10) { /* retry invalidating a few times */
3688 if (retry > 1 || error == ENXIO)
3689 ubcflags &= ~UBC_PUSHALL;
3690 goto again;
3691 }
3692 /* give up */
3693 printf("nfs_vinvalbuf(): ubc_msync failed!, error %d\n", error);
3694 }
3695 done:
3696 lck_mtx_lock(nfs_buf_mutex);
3697 nflags = np->n_bflag;
3698 np->n_bflag &= ~(NBINVALINPROG|NBINVALWANT);
3699 lck_mtx_unlock(nfs_buf_mutex);
3700 if (nflags & NBINVALWANT)
3701 wakeup(&np->n_bflag);
3702
3703 FSDBG_BOT(554, np, flags, intrflg, error);
3704 return (error);
3705 }
3706
3707 /*
3708 * Wait for any busy buffers to complete.
3709 */
3710 void
3711 nfs_wait_bufs(nfsnode_t np)
3712 {
3713 struct nfsbuf *bp;
3714 struct nfsbuflists blist;
3715 int error = 0;
3716
3717 lck_mtx_lock(nfs_buf_mutex);
3718 if (!nfs_buf_iterprepare(np, &blist, NBI_CLEAN)) {
3719 while ((bp = LIST_FIRST(&blist))) {
3720 LIST_REMOVE(bp, nb_vnbufs);
3721 LIST_INSERT_HEAD(&np->n_cleanblkhd, bp, nb_vnbufs);
3722 nfs_buf_refget(bp);
3723 while ((error = nfs_buf_acquire(bp, 0, 0, 0))) {
3724 if (error != EAGAIN) {
3725 nfs_buf_refrele(bp);
3726 nfs_buf_itercomplete(np, &blist, NBI_CLEAN);
3727 lck_mtx_unlock(nfs_buf_mutex);
3728 return;
3729 }
3730 }
3731 nfs_buf_refrele(bp);
3732 nfs_buf_drop(bp);
3733 }
3734 nfs_buf_itercomplete(np, &blist, NBI_CLEAN);
3735 }
3736 if (!nfs_buf_iterprepare(np, &blist, NBI_DIRTY)) {
3737 while ((bp = LIST_FIRST(&blist))) {
3738 LIST_REMOVE(bp, nb_vnbufs);
3739 LIST_INSERT_HEAD(&np->n_dirtyblkhd, bp, nb_vnbufs);
3740 nfs_buf_refget(bp);
3741 while ((error = nfs_buf_acquire(bp, 0, 0, 0))) {
3742 if (error != EAGAIN) {
3743 nfs_buf_refrele(bp);
3744 nfs_buf_itercomplete(np, &blist, NBI_DIRTY);
3745 lck_mtx_unlock(nfs_buf_mutex);
3746 return;
3747 }
3748 }
3749 nfs_buf_refrele(bp);
3750 nfs_buf_drop(bp);
3751 }
3752 nfs_buf_itercomplete(np, &blist, NBI_DIRTY);
3753 }
3754 lck_mtx_unlock(nfs_buf_mutex);
3755 }
3756
3757
3758 /*
3759 * Add an async I/O request to the mount's async I/O queue and make
3760 * sure that an nfsiod will service it.
3761 */
3762 void
3763 nfs_asyncio_finish(struct nfsreq *req)
3764 {
3765 struct nfsmount *nmp;
3766 struct nfsiod *niod;
3767 int started = 0;
3768
3769 FSDBG_TOP(552, nmp, 0, 0, 0);
3770 again:
3771 nmp = req->r_nmp;
3772
3773 if (nmp == NULL)
3774 return;
3775
3776 lck_mtx_lock(nfsiod_mutex);
3777 niod = nmp->nm_niod;
3778
3779 /* grab an nfsiod if we don't have one already */
3780 if (!niod) {
3781 niod = TAILQ_FIRST(&nfsiodfree);
3782 if (niod) {
3783 TAILQ_REMOVE(&nfsiodfree, niod, niod_link);
3784 TAILQ_INSERT_TAIL(&nfsiodwork, niod, niod_link);
3785 niod->niod_nmp = nmp;
3786 } else if (((nfsiod_thread_count < NFSIOD_MAX) || (nfsiod_thread_count <= 0)) && (started < 4)) {
3787 /*
3788 * Try starting a new thread.
3789 * We may try a couple times if other callers
3790 * get the new threads before we do.
3791 */
3792 lck_mtx_unlock(nfsiod_mutex);
3793 started++;
3794 if (!nfsiod_start())
3795 goto again;
3796 lck_mtx_lock(nfsiod_mutex);
3797 }
3798 }
3799
3800 if (req->r_achain.tqe_next == NFSREQNOLIST)
3801 TAILQ_INSERT_TAIL(&nmp->nm_iodq, req, r_achain);
3802
3803 /* If this mount doesn't already have an nfsiod working on it... */
3804 if (!nmp->nm_niod) {
3805 if (niod) { /* give it the nfsiod we just grabbed */
3806 nmp->nm_niod = niod;
3807 lck_mtx_unlock(nfsiod_mutex);
3808 wakeup(niod);
3809 } else if (nfsiod_thread_count > 0) {
3810 /* just queue it up on nfsiod mounts queue if needed */
3811 if (nmp->nm_iodlink.tqe_next == NFSNOLIST)
3812 TAILQ_INSERT_TAIL(&nfsiodmounts, nmp, nm_iodlink);
3813 lck_mtx_unlock(nfsiod_mutex);
3814 } else {
3815 printf("nfs_asyncio(): no nfsiods? %d %d (%d)\n", nfsiod_thread_count, NFSIOD_MAX, started);
3816 lck_mtx_unlock(nfsiod_mutex);
3817 /* we have no other option but to be persistent */
3818 started = 0;
3819 goto again;
3820 }
3821 } else {
3822 lck_mtx_unlock(nfsiod_mutex);
3823 }
3824
3825 FSDBG_BOT(552, nmp, 0, 0, 0);
3826 }
3827
3828 /*
3829 * queue up async I/O request for resend
3830 */
3831 void
3832 nfs_asyncio_resend(struct nfsreq *req)
3833 {
3834 struct nfsmount *nmp = req->r_nmp;
3835
3836 if (nfs_mount_gone(nmp))
3837 return;
3838 nfs_gss_clnt_rpcdone(req);
3839 lck_mtx_lock(&nmp->nm_lock);
3840 if (!(req->r_flags & R_RESENDQ)) {
3841 TAILQ_INSERT_TAIL(&nmp->nm_resendq, req, r_rchain);
3842 req->r_flags |= R_RESENDQ;
3843 }
3844 nfs_mount_sock_thread_wake(nmp);
3845 lck_mtx_unlock(&nmp->nm_lock);
3846 }
3847
3848 /*
3849 * Read directory data into a buffer.
3850 *
3851 * Buffer will be filled (unless EOF is hit).
3852 * Buffers after this one may also be completely/partially filled.
3853 */
3854 int
3855 nfs_buf_readdir(struct nfsbuf *bp, vfs_context_t ctx)
3856 {
3857 nfsnode_t np = bp->nb_np;
3858 struct nfsmount *nmp = NFSTONMP(np);
3859 int error = 0;
3860
3861 if (nfs_mount_gone(nmp))
3862 return (ENXIO);
3863
3864 if (nmp->nm_vers < NFS_VER4)
3865 error = nfs3_readdir_rpc(np, bp, ctx);
3866 else
3867 error = nfs4_readdir_rpc(np, bp, ctx);
3868
3869 if (error && (error != NFSERR_DIRBUFDROPPED)) {
3870 SET(bp->nb_flags, NB_ERROR);
3871 bp->nb_error = error;
3872 }
3873 return (error);
3874 }