]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - sys/cddl/contrib/opensolaris/uts/common/fs/zfs/arc.c
MFV r331400: 8484 Implement aggregate sum and use for arc counters
[FreeBSD/FreeBSD.git] / sys / cddl / contrib / opensolaris / uts / common / fs / zfs / arc.c
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License (the "License").
6  * You may not use this file except in compliance with the License.
7  *
8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9  * or http://www.opensolaris.org/os/licensing.
10  * See the License for the specific language governing permissions
11  * and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL HEADER in each
14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15  * If applicable, add the following below this CDDL HEADER, with the
16  * fields enclosed by brackets "[]" replaced with your own identifying
17  * information: Portions Copyright [yyyy] [name of copyright owner]
18  *
19  * CDDL HEADER END
20  */
21 /*
22  * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
23  * Copyright (c) 2018, Joyent, Inc.
24  * Copyright (c) 2011, 2017 by Delphix. All rights reserved.
25  * Copyright (c) 2014 by Saso Kiselkov. All rights reserved.
26  * Copyright 2017 Nexenta Systems, Inc.  All rights reserved.
27  */
28
29 /*
30  * DVA-based Adjustable Replacement Cache
31  *
32  * While much of the theory of operation used here is
33  * based on the self-tuning, low overhead replacement cache
34  * presented by Megiddo and Modha at FAST 2003, there are some
35  * significant differences:
36  *
37  * 1. The Megiddo and Modha model assumes any page is evictable.
38  * Pages in its cache cannot be "locked" into memory.  This makes
39  * the eviction algorithm simple: evict the last page in the list.
40  * This also make the performance characteristics easy to reason
41  * about.  Our cache is not so simple.  At any given moment, some
42  * subset of the blocks in the cache are un-evictable because we
43  * have handed out a reference to them.  Blocks are only evictable
44  * when there are no external references active.  This makes
45  * eviction far more problematic:  we choose to evict the evictable
46  * blocks that are the "lowest" in the list.
47  *
48  * There are times when it is not possible to evict the requested
49  * space.  In these circumstances we are unable to adjust the cache
50  * size.  To prevent the cache growing unbounded at these times we
51  * implement a "cache throttle" that slows the flow of new data
52  * into the cache until we can make space available.
53  *
54  * 2. The Megiddo and Modha model assumes a fixed cache size.
55  * Pages are evicted when the cache is full and there is a cache
56  * miss.  Our model has a variable sized cache.  It grows with
57  * high use, but also tries to react to memory pressure from the
58  * operating system: decreasing its size when system memory is
59  * tight.
60  *
61  * 3. The Megiddo and Modha model assumes a fixed page size. All
62  * elements of the cache are therefore exactly the same size.  So
63  * when adjusting the cache size following a cache miss, its simply
64  * a matter of choosing a single page to evict.  In our model, we
65  * have variable sized cache blocks (rangeing from 512 bytes to
66  * 128K bytes).  We therefore choose a set of blocks to evict to make
67  * space for a cache miss that approximates as closely as possible
68  * the space used by the new block.
69  *
70  * See also:  "ARC: A Self-Tuning, Low Overhead Replacement Cache"
71  * by N. Megiddo & D. Modha, FAST 2003
72  */
73
74 /*
75  * The locking model:
76  *
77  * A new reference to a cache buffer can be obtained in two
78  * ways: 1) via a hash table lookup using the DVA as a key,
79  * or 2) via one of the ARC lists.  The arc_read() interface
80  * uses method 1, while the internal ARC algorithms for
81  * adjusting the cache use method 2.  We therefore provide two
82  * types of locks: 1) the hash table lock array, and 2) the
83  * ARC list locks.
84  *
85  * Buffers do not have their own mutexes, rather they rely on the
86  * hash table mutexes for the bulk of their protection (i.e. most
87  * fields in the arc_buf_hdr_t are protected by these mutexes).
88  *
89  * buf_hash_find() returns the appropriate mutex (held) when it
90  * locates the requested buffer in the hash table.  It returns
91  * NULL for the mutex if the buffer was not in the table.
92  *
93  * buf_hash_remove() expects the appropriate hash mutex to be
94  * already held before it is invoked.
95  *
96  * Each ARC state also has a mutex which is used to protect the
97  * buffer list associated with the state.  When attempting to
98  * obtain a hash table lock while holding an ARC list lock you
99  * must use: mutex_tryenter() to avoid deadlock.  Also note that
100  * the active state mutex must be held before the ghost state mutex.
101  *
102  * Note that the majority of the performance stats are manipulated
103  * with atomic operations.
104  *
105  * The L2ARC uses the l2ad_mtx on each vdev for the following:
106  *
107  *      - L2ARC buflist creation
108  *      - L2ARC buflist eviction
109  *      - L2ARC write completion, which walks L2ARC buflists
110  *      - ARC header destruction, as it removes from L2ARC buflists
111  *      - ARC header release, as it removes from L2ARC buflists
112  */
113
114 /*
115  * ARC operation:
116  *
117  * Every block that is in the ARC is tracked by an arc_buf_hdr_t structure.
118  * This structure can point either to a block that is still in the cache or to
119  * one that is only accessible in an L2 ARC device, or it can provide
120  * information about a block that was recently evicted. If a block is
121  * only accessible in the L2ARC, then the arc_buf_hdr_t only has enough
122  * information to retrieve it from the L2ARC device. This information is
123  * stored in the l2arc_buf_hdr_t sub-structure of the arc_buf_hdr_t. A block
124  * that is in this state cannot access the data directly.
125  *
126  * Blocks that are actively being referenced or have not been evicted
127  * are cached in the L1ARC. The L1ARC (l1arc_buf_hdr_t) is a structure within
128  * the arc_buf_hdr_t that will point to the data block in memory. A block can
129  * only be read by a consumer if it has an l1arc_buf_hdr_t. The L1ARC
130  * caches data in two ways -- in a list of ARC buffers (arc_buf_t) and
131  * also in the arc_buf_hdr_t's private physical data block pointer (b_pabd).
132  *
133  * The L1ARC's data pointer may or may not be uncompressed. The ARC has the
134  * ability to store the physical data (b_pabd) associated with the DVA of the
135  * arc_buf_hdr_t. Since the b_pabd is a copy of the on-disk physical block,
136  * it will match its on-disk compression characteristics. This behavior can be
137  * disabled by setting 'zfs_compressed_arc_enabled' to B_FALSE. When the
138  * compressed ARC functionality is disabled, the b_pabd will point to an
139  * uncompressed version of the on-disk data.
140  *
141  * Data in the L1ARC is not accessed by consumers of the ARC directly. Each
142  * arc_buf_hdr_t can have multiple ARC buffers (arc_buf_t) which reference it.
143  * Each ARC buffer (arc_buf_t) is being actively accessed by a specific ARC
144  * consumer. The ARC will provide references to this data and will keep it
145  * cached until it is no longer in use. The ARC caches only the L1ARC's physical
146  * data block and will evict any arc_buf_t that is no longer referenced. The
147  * amount of memory consumed by the arc_buf_ts' data buffers can be seen via the
148  * "overhead_size" kstat.
149  *
150  * Depending on the consumer, an arc_buf_t can be requested in uncompressed or
151  * compressed form. The typical case is that consumers will want uncompressed
152  * data, and when that happens a new data buffer is allocated where the data is
153  * decompressed for them to use. Currently the only consumer who wants
154  * compressed arc_buf_t's is "zfs send", when it streams data exactly as it
155  * exists on disk. When this happens, the arc_buf_t's data buffer is shared
156  * with the arc_buf_hdr_t.
157  *
158  * Here is a diagram showing an arc_buf_hdr_t referenced by two arc_buf_t's. The
159  * first one is owned by a compressed send consumer (and therefore references
160  * the same compressed data buffer as the arc_buf_hdr_t) and the second could be
161  * used by any other consumer (and has its own uncompressed copy of the data
162  * buffer).
163  *
164  *   arc_buf_hdr_t
165  *   +-----------+
166  *   | fields    |
167  *   | common to |
168  *   | L1- and   |
169  *   | L2ARC     |
170  *   +-----------+
171  *   | l2arc_buf_hdr_t
172  *   |           |
173  *   +-----------+
174  *   | l1arc_buf_hdr_t
175  *   |           |              arc_buf_t
176  *   | b_buf     +------------>+-----------+      arc_buf_t
177  *   | b_pabd    +-+           |b_next     +---->+-----------+
178  *   +-----------+ |           |-----------|     |b_next     +-->NULL
179  *                 |           |b_comp = T |     +-----------+
180  *                 |           |b_data     +-+   |b_comp = F |
181  *                 |           +-----------+ |   |b_data     +-+
182  *                 +->+------+               |   +-----------+ |
183  *        compressed  |      |               |                 |
184  *           data     |      |<--------------+                 | uncompressed
185  *                    +------+          compressed,            |     data
186  *                                        shared               +-->+------+
187  *                                         data                    |      |
188  *                                                                 |      |
189  *                                                                 +------+
190  *
191  * When a consumer reads a block, the ARC must first look to see if the
192  * arc_buf_hdr_t is cached. If the hdr is cached then the ARC allocates a new
193  * arc_buf_t and either copies uncompressed data into a new data buffer from an
194  * existing uncompressed arc_buf_t, decompresses the hdr's b_pabd buffer into a
195  * new data buffer, or shares the hdr's b_pabd buffer, depending on whether the
196  * hdr is compressed and the desired compression characteristics of the
197  * arc_buf_t consumer. If the arc_buf_t ends up sharing data with the
198  * arc_buf_hdr_t and both of them are uncompressed then the arc_buf_t must be
199  * the last buffer in the hdr's b_buf list, however a shared compressed buf can
200  * be anywhere in the hdr's list.
201  *
202  * The diagram below shows an example of an uncompressed ARC hdr that is
203  * sharing its data with an arc_buf_t (note that the shared uncompressed buf is
204  * the last element in the buf list):
205  *
206  *                arc_buf_hdr_t
207  *                +-----------+
208  *                |           |
209  *                |           |
210  *                |           |
211  *                +-----------+
212  * l2arc_buf_hdr_t|           |
213  *                |           |
214  *                +-----------+
215  * l1arc_buf_hdr_t|           |
216  *                |           |                 arc_buf_t    (shared)
217  *                |    b_buf  +------------>+---------+      arc_buf_t
218  *                |           |             |b_next   +---->+---------+
219  *                |  b_pabd   +-+           |---------|     |b_next   +-->NULL
220  *                +-----------+ |           |         |     +---------+
221  *                              |           |b_data   +-+   |         |
222  *                              |           +---------+ |   |b_data   +-+
223  *                              +->+------+             |   +---------+ |
224  *                                 |      |             |               |
225  *                   uncompressed  |      |             |               |
226  *                        data     +------+             |               |
227  *                                    ^                 +->+------+     |
228  *                                    |       uncompressed |      |     |
229  *                                    |           data     |      |     |
230  *                                    |                    +------+     |
231  *                                    +---------------------------------+
232  *
233  * Writing to the ARC requires that the ARC first discard the hdr's b_pabd
234  * since the physical block is about to be rewritten. The new data contents
235  * will be contained in the arc_buf_t. As the I/O pipeline performs the write,
236  * it may compress the data before writing it to disk. The ARC will be called
237  * with the transformed data and will bcopy the transformed on-disk block into
238  * a newly allocated b_pabd. Writes are always done into buffers which have
239  * either been loaned (and hence are new and don't have other readers) or
240  * buffers which have been released (and hence have their own hdr, if there
241  * were originally other readers of the buf's original hdr). This ensures that
242  * the ARC only needs to update a single buf and its hdr after a write occurs.
243  *
244  * When the L2ARC is in use, it will also take advantage of the b_pabd. The
245  * L2ARC will always write the contents of b_pabd to the L2ARC. This means
246  * that when compressed ARC is enabled that the L2ARC blocks are identical
247  * to the on-disk block in the main data pool. This provides a significant
248  * advantage since the ARC can leverage the bp's checksum when reading from the
249  * L2ARC to determine if the contents are valid. However, if the compressed
250  * ARC is disabled, then the L2ARC's block must be transformed to look
251  * like the physical block in the main data pool before comparing the
252  * checksum and determining its validity.
253  */
254
255 #include <sys/spa.h>
256 #include <sys/zio.h>
257 #include <sys/spa_impl.h>
258 #include <sys/zio_compress.h>
259 #include <sys/zio_checksum.h>
260 #include <sys/zfs_context.h>
261 #include <sys/arc.h>
262 #include <sys/refcount.h>
263 #include <sys/vdev.h>
264 #include <sys/vdev_impl.h>
265 #include <sys/dsl_pool.h>
266 #include <sys/zio_checksum.h>
267 #include <sys/multilist.h>
268 #include <sys/abd.h>
269 #ifdef _KERNEL
270 #include <sys/dnlc.h>
271 #include <sys/racct.h>
272 #endif
273 #include <sys/callb.h>
274 #include <sys/kstat.h>
275 #include <sys/trim_map.h>
276 #include <zfs_fletcher.h>
277 #include <sys/sdt.h>
278 #include <sys/aggsum.h>
279 #include <sys/cityhash.h>
280
281 #include <machine/vmparam.h>
282
283 #ifdef illumos
284 #ifndef _KERNEL
285 /* set with ZFS_DEBUG=watch, to enable watchpoints on frozen buffers */
286 boolean_t arc_watch = B_FALSE;
287 int arc_procfd;
288 #endif
289 #endif /* illumos */
290
291 static kmutex_t         arc_reclaim_lock;
292 static kcondvar_t       arc_reclaim_thread_cv;
293 static boolean_t        arc_reclaim_thread_exit;
294 static kcondvar_t       arc_reclaim_waiters_cv;
295
296 static kmutex_t         arc_dnlc_evicts_lock;
297 static kcondvar_t       arc_dnlc_evicts_cv;
298 static boolean_t        arc_dnlc_evicts_thread_exit;
299
300 uint_t arc_reduce_dnlc_percent = 3;
301
302 /*
303  * The number of headers to evict in arc_evict_state_impl() before
304  * dropping the sublist lock and evicting from another sublist. A lower
305  * value means we're more likely to evict the "correct" header (i.e. the
306  * oldest header in the arc state), but comes with higher overhead
307  * (i.e. more invocations of arc_evict_state_impl()).
308  */
309 int zfs_arc_evict_batch_limit = 10;
310
311 /* number of seconds before growing cache again */
312 static int              arc_grow_retry = 60;
313
314 /* number of milliseconds before attempting a kmem-cache-reap */
315 static int              arc_kmem_cache_reap_retry_ms = 1000;
316
317 /* shift of arc_c for calculating overflow limit in arc_get_data_impl */
318 int             zfs_arc_overflow_shift = 8;
319
320 /* shift of arc_c for calculating both min and max arc_p */
321 static int              arc_p_min_shift = 4;
322
323 /* log2(fraction of arc to reclaim) */
324 static int              arc_shrink_shift = 7;
325
326 /*
327  * log2(fraction of ARC which must be free to allow growing).
328  * I.e. If there is less than arc_c >> arc_no_grow_shift free memory,
329  * when reading a new block into the ARC, we will evict an equal-sized block
330  * from the ARC.
331  *
332  * This must be less than arc_shrink_shift, so that when we shrink the ARC,
333  * we will still not allow it to grow.
334  */
335 int                     arc_no_grow_shift = 5;
336
337
338 /*
339  * minimum lifespan of a prefetch block in clock ticks
340  * (initialized in arc_init())
341  */
342 static int              arc_min_prefetch_lifespan;
343
344 /*
345  * If this percent of memory is free, don't throttle.
346  */
347 int arc_lotsfree_percent = 10;
348
349 static int arc_dead;
350 extern boolean_t zfs_prefetch_disable;
351
352 /*
353  * The arc has filled available memory and has now warmed up.
354  */
355 static boolean_t arc_warm;
356
357 /*
358  * log2 fraction of the zio arena to keep free.
359  */
360 int arc_zio_arena_free_shift = 2;
361
362 /*
363  * These tunables are for performance analysis.
364  */
365 uint64_t zfs_arc_max;
366 uint64_t zfs_arc_min;
367 uint64_t zfs_arc_meta_limit = 0;
368 uint64_t zfs_arc_meta_min = 0;
369 int zfs_arc_grow_retry = 0;
370 int zfs_arc_shrink_shift = 0;
371 int zfs_arc_no_grow_shift = 0;
372 int zfs_arc_p_min_shift = 0;
373 uint64_t zfs_arc_average_blocksize = 8 * 1024; /* 8KB */
374 u_int zfs_arc_free_target = 0;
375
376 /* Absolute min for arc min / max is 16MB. */
377 static uint64_t arc_abs_min = 16 << 20;
378
379 boolean_t zfs_compressed_arc_enabled = B_TRUE;
380
381 static int sysctl_vfs_zfs_arc_free_target(SYSCTL_HANDLER_ARGS);
382 static int sysctl_vfs_zfs_arc_meta_limit(SYSCTL_HANDLER_ARGS);
383 static int sysctl_vfs_zfs_arc_max(SYSCTL_HANDLER_ARGS);
384 static int sysctl_vfs_zfs_arc_min(SYSCTL_HANDLER_ARGS);
385 static int sysctl_vfs_zfs_arc_no_grow_shift(SYSCTL_HANDLER_ARGS);
386
387 #if defined(__FreeBSD__) && defined(_KERNEL)
388 static void
389 arc_free_target_init(void *unused __unused)
390 {
391
392         zfs_arc_free_target = (vm_cnt.v_free_min / 10) * 11;
393 }
394 SYSINIT(arc_free_target_init, SI_SUB_KTHREAD_PAGE, SI_ORDER_ANY,
395     arc_free_target_init, NULL);
396
397 TUNABLE_QUAD("vfs.zfs.arc_meta_limit", &zfs_arc_meta_limit);
398 TUNABLE_QUAD("vfs.zfs.arc_meta_min", &zfs_arc_meta_min);
399 TUNABLE_INT("vfs.zfs.arc_shrink_shift", &zfs_arc_shrink_shift);
400 TUNABLE_INT("vfs.zfs.arc_grow_retry", &zfs_arc_grow_retry);
401 TUNABLE_INT("vfs.zfs.arc_no_grow_shift", &zfs_arc_no_grow_shift);
402 SYSCTL_DECL(_vfs_zfs);
403 SYSCTL_PROC(_vfs_zfs, OID_AUTO, arc_max, CTLTYPE_U64 | CTLFLAG_RWTUN,
404     0, sizeof(uint64_t), sysctl_vfs_zfs_arc_max, "QU", "Maximum ARC size");
405 SYSCTL_PROC(_vfs_zfs, OID_AUTO, arc_min, CTLTYPE_U64 | CTLFLAG_RWTUN,
406     0, sizeof(uint64_t), sysctl_vfs_zfs_arc_min, "QU", "Minimum ARC size");
407 SYSCTL_PROC(_vfs_zfs, OID_AUTO, arc_no_grow_shift, CTLTYPE_U32 | CTLFLAG_RWTUN,
408     0, sizeof(uint32_t), sysctl_vfs_zfs_arc_no_grow_shift, "U",
409     "log2(fraction of ARC which must be free to allow growing)");
410 SYSCTL_UQUAD(_vfs_zfs, OID_AUTO, arc_average_blocksize, CTLFLAG_RDTUN,
411     &zfs_arc_average_blocksize, 0,
412     "ARC average blocksize");
413 SYSCTL_INT(_vfs_zfs, OID_AUTO, arc_shrink_shift, CTLFLAG_RW,
414     &arc_shrink_shift, 0,
415     "log2(fraction of arc to reclaim)");
416 SYSCTL_INT(_vfs_zfs, OID_AUTO, arc_grow_retry, CTLFLAG_RW,
417     &arc_grow_retry, 0,
418     "Wait in seconds before considering growing ARC");
419 SYSCTL_INT(_vfs_zfs, OID_AUTO, compressed_arc_enabled, CTLFLAG_RDTUN,
420     &zfs_compressed_arc_enabled, 0, "Enable compressed ARC");
421
422 /*
423  * We don't have a tunable for arc_free_target due to the dependency on
424  * pagedaemon initialisation.
425  */
426 SYSCTL_PROC(_vfs_zfs, OID_AUTO, arc_free_target,
427     CTLTYPE_UINT | CTLFLAG_MPSAFE | CTLFLAG_RW, 0, sizeof(u_int),
428     sysctl_vfs_zfs_arc_free_target, "IU",
429     "Desired number of free pages below which ARC triggers reclaim");
430
431 static int
432 sysctl_vfs_zfs_arc_free_target(SYSCTL_HANDLER_ARGS)
433 {
434         u_int val;
435         int err;
436
437         val = zfs_arc_free_target;
438         err = sysctl_handle_int(oidp, &val, 0, req);
439         if (err != 0 || req->newptr == NULL)
440                 return (err);
441
442         if (val < minfree)
443                 return (EINVAL);
444         if (val > vm_cnt.v_page_count)
445                 return (EINVAL);
446
447         zfs_arc_free_target = val;
448
449         return (0);
450 }
451
452 /*
453  * Must be declared here, before the definition of corresponding kstat
454  * macro which uses the same names will confuse the compiler.
455  */
456 SYSCTL_PROC(_vfs_zfs, OID_AUTO, arc_meta_limit,
457     CTLTYPE_U64 | CTLFLAG_MPSAFE | CTLFLAG_RW, 0, sizeof(uint64_t),
458     sysctl_vfs_zfs_arc_meta_limit, "QU",
459     "ARC metadata limit");
460 #endif
461
462 /*
463  * Note that buffers can be in one of 6 states:
464  *      ARC_anon        - anonymous (discussed below)
465  *      ARC_mru         - recently used, currently cached
466  *      ARC_mru_ghost   - recentely used, no longer in cache
467  *      ARC_mfu         - frequently used, currently cached
468  *      ARC_mfu_ghost   - frequently used, no longer in cache
469  *      ARC_l2c_only    - exists in L2ARC but not other states
470  * When there are no active references to the buffer, they are
471  * are linked onto a list in one of these arc states.  These are
472  * the only buffers that can be evicted or deleted.  Within each
473  * state there are multiple lists, one for meta-data and one for
474  * non-meta-data.  Meta-data (indirect blocks, blocks of dnodes,
475  * etc.) is tracked separately so that it can be managed more
476  * explicitly: favored over data, limited explicitly.
477  *
478  * Anonymous buffers are buffers that are not associated with
479  * a DVA.  These are buffers that hold dirty block copies
480  * before they are written to stable storage.  By definition,
481  * they are "ref'd" and are considered part of arc_mru
482  * that cannot be freed.  Generally, they will aquire a DVA
483  * as they are written and migrate onto the arc_mru list.
484  *
485  * The ARC_l2c_only state is for buffers that are in the second
486  * level ARC but no longer in any of the ARC_m* lists.  The second
487  * level ARC itself may also contain buffers that are in any of
488  * the ARC_m* states - meaning that a buffer can exist in two
489  * places.  The reason for the ARC_l2c_only state is to keep the
490  * buffer header in the hash table, so that reads that hit the
491  * second level ARC benefit from these fast lookups.
492  */
493
494 typedef struct arc_state {
495         /*
496          * list of evictable buffers
497          */
498         multilist_t *arcs_list[ARC_BUFC_NUMTYPES];
499         /*
500          * total amount of evictable data in this state
501          */
502         refcount_t arcs_esize[ARC_BUFC_NUMTYPES];
503         /*
504          * total amount of data in this state; this includes: evictable,
505          * non-evictable, ARC_BUFC_DATA, and ARC_BUFC_METADATA.
506          */
507         refcount_t arcs_size;
508 } arc_state_t;
509
510 /* The 6 states: */
511 static arc_state_t ARC_anon;
512 static arc_state_t ARC_mru;
513 static arc_state_t ARC_mru_ghost;
514 static arc_state_t ARC_mfu;
515 static arc_state_t ARC_mfu_ghost;
516 static arc_state_t ARC_l2c_only;
517
518 typedef struct arc_stats {
519         kstat_named_t arcstat_hits;
520         kstat_named_t arcstat_misses;
521         kstat_named_t arcstat_demand_data_hits;
522         kstat_named_t arcstat_demand_data_misses;
523         kstat_named_t arcstat_demand_metadata_hits;
524         kstat_named_t arcstat_demand_metadata_misses;
525         kstat_named_t arcstat_prefetch_data_hits;
526         kstat_named_t arcstat_prefetch_data_misses;
527         kstat_named_t arcstat_prefetch_metadata_hits;
528         kstat_named_t arcstat_prefetch_metadata_misses;
529         kstat_named_t arcstat_mru_hits;
530         kstat_named_t arcstat_mru_ghost_hits;
531         kstat_named_t arcstat_mfu_hits;
532         kstat_named_t arcstat_mfu_ghost_hits;
533         kstat_named_t arcstat_allocated;
534         kstat_named_t arcstat_deleted;
535         /*
536          * Number of buffers that could not be evicted because the hash lock
537          * was held by another thread.  The lock may not necessarily be held
538          * by something using the same buffer, since hash locks are shared
539          * by multiple buffers.
540          */
541         kstat_named_t arcstat_mutex_miss;
542         /*
543          * Number of buffers skipped because they have I/O in progress, are
544          * indrect prefetch buffers that have not lived long enough, or are
545          * not from the spa we're trying to evict from.
546          */
547         kstat_named_t arcstat_evict_skip;
548         /*
549          * Number of times arc_evict_state() was unable to evict enough
550          * buffers to reach it's target amount.
551          */
552         kstat_named_t arcstat_evict_not_enough;
553         kstat_named_t arcstat_evict_l2_cached;
554         kstat_named_t arcstat_evict_l2_eligible;
555         kstat_named_t arcstat_evict_l2_ineligible;
556         kstat_named_t arcstat_evict_l2_skip;
557         kstat_named_t arcstat_hash_elements;
558         kstat_named_t arcstat_hash_elements_max;
559         kstat_named_t arcstat_hash_collisions;
560         kstat_named_t arcstat_hash_chains;
561         kstat_named_t arcstat_hash_chain_max;
562         kstat_named_t arcstat_p;
563         kstat_named_t arcstat_c;
564         kstat_named_t arcstat_c_min;
565         kstat_named_t arcstat_c_max;
566         /* Not updated directly; only synced in arc_kstat_update. */
567         kstat_named_t arcstat_size;
568         /*
569          * Number of compressed bytes stored in the arc_buf_hdr_t's b_pabd.
570          * Note that the compressed bytes may match the uncompressed bytes
571          * if the block is either not compressed or compressed arc is disabled.
572          */
573         kstat_named_t arcstat_compressed_size;
574         /*
575          * Uncompressed size of the data stored in b_pabd. If compressed
576          * arc is disabled then this value will be identical to the stat
577          * above.
578          */
579         kstat_named_t arcstat_uncompressed_size;
580         /*
581          * Number of bytes stored in all the arc_buf_t's. This is classified
582          * as "overhead" since this data is typically short-lived and will
583          * be evicted from the arc when it becomes unreferenced unless the
584          * zfs_keep_uncompressed_metadata or zfs_keep_uncompressed_level
585          * values have been set (see comment in dbuf.c for more information).
586          */
587         kstat_named_t arcstat_overhead_size;
588         /*
589          * Number of bytes consumed by internal ARC structures necessary
590          * for tracking purposes; these structures are not actually
591          * backed by ARC buffers. This includes arc_buf_hdr_t structures
592          * (allocated via arc_buf_hdr_t_full and arc_buf_hdr_t_l2only
593          * caches), and arc_buf_t structures (allocated via arc_buf_t
594          * cache).
595          * Not updated directly; only synced in arc_kstat_update.
596          */
597         kstat_named_t arcstat_hdr_size;
598         /*
599          * Number of bytes consumed by ARC buffers of type equal to
600          * ARC_BUFC_DATA. This is generally consumed by buffers backing
601          * on disk user data (e.g. plain file contents).
602          * Not updated directly; only synced in arc_kstat_update.
603          */
604         kstat_named_t arcstat_data_size;
605         /*
606          * Number of bytes consumed by ARC buffers of type equal to
607          * ARC_BUFC_METADATA. This is generally consumed by buffers
608          * backing on disk data that is used for internal ZFS
609          * structures (e.g. ZAP, dnode, indirect blocks, etc).
610          * Not updated directly; only synced in arc_kstat_update.
611          */
612         kstat_named_t arcstat_metadata_size;
613         /*
614          * Number of bytes consumed by various buffers and structures
615          * not actually backed with ARC buffers. This includes bonus
616          * buffers (allocated directly via zio_buf_* functions),
617          * dmu_buf_impl_t structures (allocated via dmu_buf_impl_t
618          * cache), and dnode_t structures (allocated via dnode_t cache).
619          * Not updated directly; only synced in arc_kstat_update.
620          */
621         kstat_named_t arcstat_other_size;
622         /*
623          * Total number of bytes consumed by ARC buffers residing in the
624          * arc_anon state. This includes *all* buffers in the arc_anon
625          * state; e.g. data, metadata, evictable, and unevictable buffers
626          * are all included in this value.
627          * Not updated directly; only synced in arc_kstat_update.
628          */
629         kstat_named_t arcstat_anon_size;
630         /*
631          * Number of bytes consumed by ARC buffers that meet the
632          * following criteria: backing buffers of type ARC_BUFC_DATA,
633          * residing in the arc_anon state, and are eligible for eviction
634          * (e.g. have no outstanding holds on the buffer).
635          * Not updated directly; only synced in arc_kstat_update.
636          */
637         kstat_named_t arcstat_anon_evictable_data;
638         /*
639          * Number of bytes consumed by ARC buffers that meet the
640          * following criteria: backing buffers of type ARC_BUFC_METADATA,
641          * residing in the arc_anon state, and are eligible for eviction
642          * (e.g. have no outstanding holds on the buffer).
643          * Not updated directly; only synced in arc_kstat_update.
644          */
645         kstat_named_t arcstat_anon_evictable_metadata;
646         /*
647          * Total number of bytes consumed by ARC buffers residing in the
648          * arc_mru state. This includes *all* buffers in the arc_mru
649          * state; e.g. data, metadata, evictable, and unevictable buffers
650          * are all included in this value.
651          * Not updated directly; only synced in arc_kstat_update.
652          */
653         kstat_named_t arcstat_mru_size;
654         /*
655          * Number of bytes consumed by ARC buffers that meet the
656          * following criteria: backing buffers of type ARC_BUFC_DATA,
657          * residing in the arc_mru state, and are eligible for eviction
658          * (e.g. have no outstanding holds on the buffer).
659          * Not updated directly; only synced in arc_kstat_update.
660          */
661         kstat_named_t arcstat_mru_evictable_data;
662         /*
663          * Number of bytes consumed by ARC buffers that meet the
664          * following criteria: backing buffers of type ARC_BUFC_METADATA,
665          * residing in the arc_mru state, and are eligible for eviction
666          * (e.g. have no outstanding holds on the buffer).
667          * Not updated directly; only synced in arc_kstat_update.
668          */
669         kstat_named_t arcstat_mru_evictable_metadata;
670         /*
671          * Total number of bytes that *would have been* consumed by ARC
672          * buffers in the arc_mru_ghost state. The key thing to note
673          * here, is the fact that this size doesn't actually indicate
674          * RAM consumption. The ghost lists only consist of headers and
675          * don't actually have ARC buffers linked off of these headers.
676          * Thus, *if* the headers had associated ARC buffers, these
677          * buffers *would have* consumed this number of bytes.
678          * Not updated directly; only synced in arc_kstat_update.
679          */
680         kstat_named_t arcstat_mru_ghost_size;
681         /*
682          * Number of bytes that *would have been* consumed by ARC
683          * buffers that are eligible for eviction, of type
684          * ARC_BUFC_DATA, and linked off the arc_mru_ghost state.
685          * Not updated directly; only synced in arc_kstat_update.
686          */
687         kstat_named_t arcstat_mru_ghost_evictable_data;
688         /*
689          * Number of bytes that *would have been* consumed by ARC
690          * buffers that are eligible for eviction, of type
691          * ARC_BUFC_METADATA, and linked off the arc_mru_ghost state.
692          * Not updated directly; only synced in arc_kstat_update.
693          */
694         kstat_named_t arcstat_mru_ghost_evictable_metadata;
695         /*
696          * Total number of bytes consumed by ARC buffers residing in the
697          * arc_mfu state. This includes *all* buffers in the arc_mfu
698          * state; e.g. data, metadata, evictable, and unevictable buffers
699          * are all included in this value.
700          * Not updated directly; only synced in arc_kstat_update.
701          */
702         kstat_named_t arcstat_mfu_size;
703         /*
704          * Number of bytes consumed by ARC buffers that are eligible for
705          * eviction, of type ARC_BUFC_DATA, and reside in the arc_mfu
706          * state.
707          * Not updated directly; only synced in arc_kstat_update.
708          */
709         kstat_named_t arcstat_mfu_evictable_data;
710         /*
711          * Number of bytes consumed by ARC buffers that are eligible for
712          * eviction, of type ARC_BUFC_METADATA, and reside in the
713          * arc_mfu state.
714          * Not updated directly; only synced in arc_kstat_update.
715          */
716         kstat_named_t arcstat_mfu_evictable_metadata;
717         /*
718          * Total number of bytes that *would have been* consumed by ARC
719          * buffers in the arc_mfu_ghost state. See the comment above
720          * arcstat_mru_ghost_size for more details.
721          * Not updated directly; only synced in arc_kstat_update.
722          */
723         kstat_named_t arcstat_mfu_ghost_size;
724         /*
725          * Number of bytes that *would have been* consumed by ARC
726          * buffers that are eligible for eviction, of type
727          * ARC_BUFC_DATA, and linked off the arc_mfu_ghost state.
728          * Not updated directly; only synced in arc_kstat_update.
729          */
730         kstat_named_t arcstat_mfu_ghost_evictable_data;
731         /*
732          * Number of bytes that *would have been* consumed by ARC
733          * buffers that are eligible for eviction, of type
734          * ARC_BUFC_METADATA, and linked off the arc_mru_ghost state.
735          * Not updated directly; only synced in arc_kstat_update.
736          */
737         kstat_named_t arcstat_mfu_ghost_evictable_metadata;
738         kstat_named_t arcstat_l2_hits;
739         kstat_named_t arcstat_l2_misses;
740         kstat_named_t arcstat_l2_feeds;
741         kstat_named_t arcstat_l2_rw_clash;
742         kstat_named_t arcstat_l2_read_bytes;
743         kstat_named_t arcstat_l2_write_bytes;
744         kstat_named_t arcstat_l2_writes_sent;
745         kstat_named_t arcstat_l2_writes_done;
746         kstat_named_t arcstat_l2_writes_error;
747         kstat_named_t arcstat_l2_writes_lock_retry;
748         kstat_named_t arcstat_l2_evict_lock_retry;
749         kstat_named_t arcstat_l2_evict_reading;
750         kstat_named_t arcstat_l2_evict_l1cached;
751         kstat_named_t arcstat_l2_free_on_write;
752         kstat_named_t arcstat_l2_abort_lowmem;
753         kstat_named_t arcstat_l2_cksum_bad;
754         kstat_named_t arcstat_l2_io_error;
755         kstat_named_t arcstat_l2_lsize;
756         kstat_named_t arcstat_l2_psize;
757         /* Not updated directly; only synced in arc_kstat_update. */
758         kstat_named_t arcstat_l2_hdr_size;
759         kstat_named_t arcstat_l2_write_trylock_fail;
760         kstat_named_t arcstat_l2_write_passed_headroom;
761         kstat_named_t arcstat_l2_write_spa_mismatch;
762         kstat_named_t arcstat_l2_write_in_l2;
763         kstat_named_t arcstat_l2_write_hdr_io_in_progress;
764         kstat_named_t arcstat_l2_write_not_cacheable;
765         kstat_named_t arcstat_l2_write_full;
766         kstat_named_t arcstat_l2_write_buffer_iter;
767         kstat_named_t arcstat_l2_write_pios;
768         kstat_named_t arcstat_l2_write_buffer_bytes_scanned;
769         kstat_named_t arcstat_l2_write_buffer_list_iter;
770         kstat_named_t arcstat_l2_write_buffer_list_null_iter;
771         kstat_named_t arcstat_memory_throttle_count;
772         /* Not updated directly; only synced in arc_kstat_update. */
773         kstat_named_t arcstat_meta_used;
774         kstat_named_t arcstat_meta_limit;
775         kstat_named_t arcstat_meta_max;
776         kstat_named_t arcstat_meta_min;
777         kstat_named_t arcstat_sync_wait_for_async;
778         kstat_named_t arcstat_demand_hit_predictive_prefetch;
779 } arc_stats_t;
780
781 static arc_stats_t arc_stats = {
782         { "hits",                       KSTAT_DATA_UINT64 },
783         { "misses",                     KSTAT_DATA_UINT64 },
784         { "demand_data_hits",           KSTAT_DATA_UINT64 },
785         { "demand_data_misses",         KSTAT_DATA_UINT64 },
786         { "demand_metadata_hits",       KSTAT_DATA_UINT64 },
787         { "demand_metadata_misses",     KSTAT_DATA_UINT64 },
788         { "prefetch_data_hits",         KSTAT_DATA_UINT64 },
789         { "prefetch_data_misses",       KSTAT_DATA_UINT64 },
790         { "prefetch_metadata_hits",     KSTAT_DATA_UINT64 },
791         { "prefetch_metadata_misses",   KSTAT_DATA_UINT64 },
792         { "mru_hits",                   KSTAT_DATA_UINT64 },
793         { "mru_ghost_hits",             KSTAT_DATA_UINT64 },
794         { "mfu_hits",                   KSTAT_DATA_UINT64 },
795         { "mfu_ghost_hits",             KSTAT_DATA_UINT64 },
796         { "allocated",                  KSTAT_DATA_UINT64 },
797         { "deleted",                    KSTAT_DATA_UINT64 },
798         { "mutex_miss",                 KSTAT_DATA_UINT64 },
799         { "evict_skip",                 KSTAT_DATA_UINT64 },
800         { "evict_not_enough",           KSTAT_DATA_UINT64 },
801         { "evict_l2_cached",            KSTAT_DATA_UINT64 },
802         { "evict_l2_eligible",          KSTAT_DATA_UINT64 },
803         { "evict_l2_ineligible",        KSTAT_DATA_UINT64 },
804         { "evict_l2_skip",              KSTAT_DATA_UINT64 },
805         { "hash_elements",              KSTAT_DATA_UINT64 },
806         { "hash_elements_max",          KSTAT_DATA_UINT64 },
807         { "hash_collisions",            KSTAT_DATA_UINT64 },
808         { "hash_chains",                KSTAT_DATA_UINT64 },
809         { "hash_chain_max",             KSTAT_DATA_UINT64 },
810         { "p",                          KSTAT_DATA_UINT64 },
811         { "c",                          KSTAT_DATA_UINT64 },
812         { "c_min",                      KSTAT_DATA_UINT64 },
813         { "c_max",                      KSTAT_DATA_UINT64 },
814         { "size",                       KSTAT_DATA_UINT64 },
815         { "compressed_size",            KSTAT_DATA_UINT64 },
816         { "uncompressed_size",          KSTAT_DATA_UINT64 },
817         { "overhead_size",              KSTAT_DATA_UINT64 },
818         { "hdr_size",                   KSTAT_DATA_UINT64 },
819         { "data_size",                  KSTAT_DATA_UINT64 },
820         { "metadata_size",              KSTAT_DATA_UINT64 },
821         { "other_size",                 KSTAT_DATA_UINT64 },
822         { "anon_size",                  KSTAT_DATA_UINT64 },
823         { "anon_evictable_data",        KSTAT_DATA_UINT64 },
824         { "anon_evictable_metadata",    KSTAT_DATA_UINT64 },
825         { "mru_size",                   KSTAT_DATA_UINT64 },
826         { "mru_evictable_data",         KSTAT_DATA_UINT64 },
827         { "mru_evictable_metadata",     KSTAT_DATA_UINT64 },
828         { "mru_ghost_size",             KSTAT_DATA_UINT64 },
829         { "mru_ghost_evictable_data",   KSTAT_DATA_UINT64 },
830         { "mru_ghost_evictable_metadata", KSTAT_DATA_UINT64 },
831         { "mfu_size",                   KSTAT_DATA_UINT64 },
832         { "mfu_evictable_data",         KSTAT_DATA_UINT64 },
833         { "mfu_evictable_metadata",     KSTAT_DATA_UINT64 },
834         { "mfu_ghost_size",             KSTAT_DATA_UINT64 },
835         { "mfu_ghost_evictable_data",   KSTAT_DATA_UINT64 },
836         { "mfu_ghost_evictable_metadata", KSTAT_DATA_UINT64 },
837         { "l2_hits",                    KSTAT_DATA_UINT64 },
838         { "l2_misses",                  KSTAT_DATA_UINT64 },
839         { "l2_feeds",                   KSTAT_DATA_UINT64 },
840         { "l2_rw_clash",                KSTAT_DATA_UINT64 },
841         { "l2_read_bytes",              KSTAT_DATA_UINT64 },
842         { "l2_write_bytes",             KSTAT_DATA_UINT64 },
843         { "l2_writes_sent",             KSTAT_DATA_UINT64 },
844         { "l2_writes_done",             KSTAT_DATA_UINT64 },
845         { "l2_writes_error",            KSTAT_DATA_UINT64 },
846         { "l2_writes_lock_retry",       KSTAT_DATA_UINT64 },
847         { "l2_evict_lock_retry",        KSTAT_DATA_UINT64 },
848         { "l2_evict_reading",           KSTAT_DATA_UINT64 },
849         { "l2_evict_l1cached",          KSTAT_DATA_UINT64 },
850         { "l2_free_on_write",           KSTAT_DATA_UINT64 },
851         { "l2_abort_lowmem",            KSTAT_DATA_UINT64 },
852         { "l2_cksum_bad",               KSTAT_DATA_UINT64 },
853         { "l2_io_error",                KSTAT_DATA_UINT64 },
854         { "l2_size",                    KSTAT_DATA_UINT64 },
855         { "l2_asize",                   KSTAT_DATA_UINT64 },
856         { "l2_hdr_size",                KSTAT_DATA_UINT64 },
857         { "l2_write_trylock_fail",      KSTAT_DATA_UINT64 },
858         { "l2_write_passed_headroom",   KSTAT_DATA_UINT64 },
859         { "l2_write_spa_mismatch",      KSTAT_DATA_UINT64 },
860         { "l2_write_in_l2",             KSTAT_DATA_UINT64 },
861         { "l2_write_io_in_progress",    KSTAT_DATA_UINT64 },
862         { "l2_write_not_cacheable",     KSTAT_DATA_UINT64 },
863         { "l2_write_full",              KSTAT_DATA_UINT64 },
864         { "l2_write_buffer_iter",       KSTAT_DATA_UINT64 },
865         { "l2_write_pios",              KSTAT_DATA_UINT64 },
866         { "l2_write_buffer_bytes_scanned", KSTAT_DATA_UINT64 },
867         { "l2_write_buffer_list_iter",  KSTAT_DATA_UINT64 },
868         { "l2_write_buffer_list_null_iter", KSTAT_DATA_UINT64 },
869         { "memory_throttle_count",      KSTAT_DATA_UINT64 },
870         { "arc_meta_used",              KSTAT_DATA_UINT64 },
871         { "arc_meta_limit",             KSTAT_DATA_UINT64 },
872         { "arc_meta_max",               KSTAT_DATA_UINT64 },
873         { "arc_meta_min",               KSTAT_DATA_UINT64 },
874         { "sync_wait_for_async",        KSTAT_DATA_UINT64 },
875         { "demand_hit_predictive_prefetch", KSTAT_DATA_UINT64 },
876 };
877
878 #define ARCSTAT(stat)   (arc_stats.stat.value.ui64)
879
880 #define ARCSTAT_INCR(stat, val) \
881         atomic_add_64(&arc_stats.stat.value.ui64, (val))
882
883 #define ARCSTAT_BUMP(stat)      ARCSTAT_INCR(stat, 1)
884 #define ARCSTAT_BUMPDOWN(stat)  ARCSTAT_INCR(stat, -1)
885
886 #define ARCSTAT_MAX(stat, val) {                                        \
887         uint64_t m;                                                     \
888         while ((val) > (m = arc_stats.stat.value.ui64) &&               \
889             (m != atomic_cas_64(&arc_stats.stat.value.ui64, m, (val)))) \
890                 continue;                                               \
891 }
892
893 #define ARCSTAT_MAXSTAT(stat) \
894         ARCSTAT_MAX(stat##_max, arc_stats.stat.value.ui64)
895
896 /*
897  * We define a macro to allow ARC hits/misses to be easily broken down by
898  * two separate conditions, giving a total of four different subtypes for
899  * each of hits and misses (so eight statistics total).
900  */
901 #define ARCSTAT_CONDSTAT(cond1, stat1, notstat1, cond2, stat2, notstat2, stat) \
902         if (cond1) {                                                    \
903                 if (cond2) {                                            \
904                         ARCSTAT_BUMP(arcstat_##stat1##_##stat2##_##stat); \
905                 } else {                                                \
906                         ARCSTAT_BUMP(arcstat_##stat1##_##notstat2##_##stat); \
907                 }                                                       \
908         } else {                                                        \
909                 if (cond2) {                                            \
910                         ARCSTAT_BUMP(arcstat_##notstat1##_##stat2##_##stat); \
911                 } else {                                                \
912                         ARCSTAT_BUMP(arcstat_##notstat1##_##notstat2##_##stat);\
913                 }                                                       \
914         }
915
916 kstat_t                 *arc_ksp;
917 static arc_state_t      *arc_anon;
918 static arc_state_t      *arc_mru;
919 static arc_state_t      *arc_mru_ghost;
920 static arc_state_t      *arc_mfu;
921 static arc_state_t      *arc_mfu_ghost;
922 static arc_state_t      *arc_l2c_only;
923
924 /*
925  * There are several ARC variables that are critical to export as kstats --
926  * but we don't want to have to grovel around in the kstat whenever we wish to
927  * manipulate them.  For these variables, we therefore define them to be in
928  * terms of the statistic variable.  This assures that we are not introducing
929  * the possibility of inconsistency by having shadow copies of the variables,
930  * while still allowing the code to be readable.
931  */
932 #define arc_p           ARCSTAT(arcstat_p)      /* target size of MRU */
933 #define arc_c           ARCSTAT(arcstat_c)      /* target size of cache */
934 #define arc_c_min       ARCSTAT(arcstat_c_min)  /* min target cache size */
935 #define arc_c_max       ARCSTAT(arcstat_c_max)  /* max target cache size */
936 #define arc_meta_limit  ARCSTAT(arcstat_meta_limit) /* max size for metadata */
937 #define arc_meta_min    ARCSTAT(arcstat_meta_min) /* min size for metadata */
938 #define arc_meta_max    ARCSTAT(arcstat_meta_max) /* max size of metadata */
939
940 /* compressed size of entire arc */
941 #define arc_compressed_size     ARCSTAT(arcstat_compressed_size)
942 /* uncompressed size of entire arc */
943 #define arc_uncompressed_size   ARCSTAT(arcstat_uncompressed_size)
944 /* number of bytes in the arc from arc_buf_t's */
945 #define arc_overhead_size       ARCSTAT(arcstat_overhead_size)
946
947 /*
948  * There are also some ARC variables that we want to export, but that are
949  * updated so often that having the canonical representation be the statistic
950  * variable causes a performance bottleneck. We want to use aggsum_t's for these
951  * instead, but still be able to export the kstat in the same way as before.
952  * The solution is to always use the aggsum version, except in the kstat update
953  * callback.
954  */
955 aggsum_t arc_size;
956 aggsum_t arc_meta_used;
957 aggsum_t astat_data_size;
958 aggsum_t astat_metadata_size;
959 aggsum_t astat_hdr_size;
960 aggsum_t astat_other_size;
961 aggsum_t astat_l2_hdr_size;
962
963 static int              arc_no_grow;    /* Don't try to grow cache size */
964 static uint64_t         arc_tempreserve;
965 static uint64_t         arc_loaned_bytes;
966
967 typedef struct arc_callback arc_callback_t;
968
969 struct arc_callback {
970         void                    *acb_private;
971         arc_done_func_t         *acb_done;
972         arc_buf_t               *acb_buf;
973         boolean_t               acb_compressed;
974         zio_t                   *acb_zio_dummy;
975         arc_callback_t          *acb_next;
976 };
977
978 typedef struct arc_write_callback arc_write_callback_t;
979
980 struct arc_write_callback {
981         void            *awcb_private;
982         arc_done_func_t *awcb_ready;
983         arc_done_func_t *awcb_children_ready;
984         arc_done_func_t *awcb_physdone;
985         arc_done_func_t *awcb_done;
986         arc_buf_t       *awcb_buf;
987 };
988
989 /*
990  * ARC buffers are separated into multiple structs as a memory saving measure:
991  *   - Common fields struct, always defined, and embedded within it:
992  *       - L2-only fields, always allocated but undefined when not in L2ARC
993  *       - L1-only fields, only allocated when in L1ARC
994  *
995  *           Buffer in L1                     Buffer only in L2
996  *    +------------------------+          +------------------------+
997  *    | arc_buf_hdr_t          |          | arc_buf_hdr_t          |
998  *    |                        |          |                        |
999  *    |                        |          |                        |
1000  *    |                        |          |                        |
1001  *    +------------------------+          +------------------------+
1002  *    | l2arc_buf_hdr_t        |          | l2arc_buf_hdr_t        |
1003  *    | (undefined if L1-only) |          |                        |
1004  *    +------------------------+          +------------------------+
1005  *    | l1arc_buf_hdr_t        |
1006  *    |                        |
1007  *    |                        |
1008  *    |                        |
1009  *    |                        |
1010  *    +------------------------+
1011  *
1012  * Because it's possible for the L2ARC to become extremely large, we can wind
1013  * up eating a lot of memory in L2ARC buffer headers, so the size of a header
1014  * is minimized by only allocating the fields necessary for an L1-cached buffer
1015  * when a header is actually in the L1 cache. The sub-headers (l1arc_buf_hdr and
1016  * l2arc_buf_hdr) are embedded rather than allocated separately to save a couple
1017  * words in pointers. arc_hdr_realloc() is used to switch a header between
1018  * these two allocation states.
1019  */
1020 typedef struct l1arc_buf_hdr {
1021         kmutex_t                b_freeze_lock;
1022         zio_cksum_t             *b_freeze_cksum;
1023 #ifdef ZFS_DEBUG
1024         /*
1025          * Used for debugging with kmem_flags - by allocating and freeing
1026          * b_thawed when the buffer is thawed, we get a record of the stack
1027          * trace that thawed it.
1028          */
1029         void                    *b_thawed;
1030 #endif
1031
1032         arc_buf_t               *b_buf;
1033         uint32_t                b_bufcnt;
1034         /* for waiting on writes to complete */
1035         kcondvar_t              b_cv;
1036         uint8_t                 b_byteswap;
1037
1038         /* protected by arc state mutex */
1039         arc_state_t             *b_state;
1040         multilist_node_t        b_arc_node;
1041
1042         /* updated atomically */
1043         clock_t                 b_arc_access;
1044
1045         /* self protecting */
1046         refcount_t              b_refcnt;
1047
1048         arc_callback_t          *b_acb;
1049         abd_t                   *b_pabd;
1050 } l1arc_buf_hdr_t;
1051
1052 typedef struct l2arc_dev l2arc_dev_t;
1053
1054 typedef struct l2arc_buf_hdr {
1055         /* protected by arc_buf_hdr mutex */
1056         l2arc_dev_t             *b_dev;         /* L2ARC device */
1057         uint64_t                b_daddr;        /* disk address, offset byte */
1058
1059         list_node_t             b_l2node;
1060 } l2arc_buf_hdr_t;
1061
1062 struct arc_buf_hdr {
1063         /* protected by hash lock */
1064         dva_t                   b_dva;
1065         uint64_t                b_birth;
1066
1067         arc_buf_contents_t      b_type;
1068         arc_buf_hdr_t           *b_hash_next;
1069         arc_flags_t             b_flags;
1070
1071         /*
1072          * This field stores the size of the data buffer after
1073          * compression, and is set in the arc's zio completion handlers.
1074          * It is in units of SPA_MINBLOCKSIZE (e.g. 1 == 512 bytes).
1075          *
1076          * While the block pointers can store up to 32MB in their psize
1077          * field, we can only store up to 32MB minus 512B. This is due
1078          * to the bp using a bias of 1, whereas we use a bias of 0 (i.e.
1079          * a field of zeros represents 512B in the bp). We can't use a
1080          * bias of 1 since we need to reserve a psize of zero, here, to
1081          * represent holes and embedded blocks.
1082          *
1083          * This isn't a problem in practice, since the maximum size of a
1084          * buffer is limited to 16MB, so we never need to store 32MB in
1085          * this field. Even in the upstream illumos code base, the
1086          * maximum size of a buffer is limited to 16MB.
1087          */
1088         uint16_t                b_psize;
1089
1090         /*
1091          * This field stores the size of the data buffer before
1092          * compression, and cannot change once set. It is in units
1093          * of SPA_MINBLOCKSIZE (e.g. 2 == 1024 bytes)
1094          */
1095         uint16_t                b_lsize;        /* immutable */
1096         uint64_t                b_spa;          /* immutable */
1097
1098         /* L2ARC fields. Undefined when not in L2ARC. */
1099         l2arc_buf_hdr_t         b_l2hdr;
1100         /* L1ARC fields. Undefined when in l2arc_only state */
1101         l1arc_buf_hdr_t         b_l1hdr;
1102 };
1103
1104 #if defined(__FreeBSD__) && defined(_KERNEL)
1105 static int
1106 sysctl_vfs_zfs_arc_meta_limit(SYSCTL_HANDLER_ARGS)
1107 {
1108         uint64_t val;
1109         int err;
1110
1111         val = arc_meta_limit;
1112         err = sysctl_handle_64(oidp, &val, 0, req);
1113         if (err != 0 || req->newptr == NULL)
1114                 return (err);
1115
1116         if (val <= 0 || val > arc_c_max)
1117                 return (EINVAL);
1118
1119         arc_meta_limit = val;
1120         return (0);
1121 }
1122
1123 static int
1124 sysctl_vfs_zfs_arc_no_grow_shift(SYSCTL_HANDLER_ARGS)
1125 {
1126         uint32_t val;
1127         int err;
1128
1129         val = arc_no_grow_shift;
1130         err = sysctl_handle_32(oidp, &val, 0, req);
1131         if (err != 0 || req->newptr == NULL)
1132                 return (err);
1133
1134         if (val >= arc_shrink_shift)
1135                 return (EINVAL);
1136
1137         arc_no_grow_shift = val;
1138         return (0);
1139 }
1140
1141 static int
1142 sysctl_vfs_zfs_arc_max(SYSCTL_HANDLER_ARGS)
1143 {
1144         uint64_t val;
1145         int err;
1146
1147         val = zfs_arc_max;
1148         err = sysctl_handle_64(oidp, &val, 0, req);
1149         if (err != 0 || req->newptr == NULL)
1150                 return (err);
1151
1152         if (zfs_arc_max == 0) {
1153                 /* Loader tunable so blindly set */
1154                 zfs_arc_max = val;
1155                 return (0);
1156         }
1157
1158         if (val < arc_abs_min || val > kmem_size())
1159                 return (EINVAL);
1160         if (val < arc_c_min)
1161                 return (EINVAL);
1162         if (zfs_arc_meta_limit > 0 && val < zfs_arc_meta_limit)
1163                 return (EINVAL);
1164
1165         arc_c_max = val;
1166
1167         arc_c = arc_c_max;
1168         arc_p = (arc_c >> 1);
1169
1170         if (zfs_arc_meta_limit == 0) {
1171                 /* limit meta-data to 1/4 of the arc capacity */
1172                 arc_meta_limit = arc_c_max / 4;
1173         }
1174
1175         /* if kmem_flags are set, lets try to use less memory */
1176         if (kmem_debugging())
1177                 arc_c = arc_c / 2;
1178
1179         zfs_arc_max = arc_c;
1180
1181         return (0);
1182 }
1183
1184 static int
1185 sysctl_vfs_zfs_arc_min(SYSCTL_HANDLER_ARGS)
1186 {
1187         uint64_t val;
1188         int err;
1189
1190         val = zfs_arc_min;
1191         err = sysctl_handle_64(oidp, &val, 0, req);
1192         if (err != 0 || req->newptr == NULL)
1193                 return (err);
1194
1195         if (zfs_arc_min == 0) {
1196                 /* Loader tunable so blindly set */
1197                 zfs_arc_min = val;
1198                 return (0);
1199         }
1200
1201         if (val < arc_abs_min || val > arc_c_max)
1202                 return (EINVAL);
1203
1204         arc_c_min = val;
1205
1206         if (zfs_arc_meta_min == 0)
1207                 arc_meta_min = arc_c_min / 2;
1208
1209         if (arc_c < arc_c_min)
1210                 arc_c = arc_c_min;
1211
1212         zfs_arc_min = arc_c_min;
1213
1214         return (0);
1215 }
1216 #endif
1217
1218 #define GHOST_STATE(state)      \
1219         ((state) == arc_mru_ghost || (state) == arc_mfu_ghost ||        \
1220         (state) == arc_l2c_only)
1221
1222 #define HDR_IN_HASH_TABLE(hdr)  ((hdr)->b_flags & ARC_FLAG_IN_HASH_TABLE)
1223 #define HDR_IO_IN_PROGRESS(hdr) ((hdr)->b_flags & ARC_FLAG_IO_IN_PROGRESS)
1224 #define HDR_IO_ERROR(hdr)       ((hdr)->b_flags & ARC_FLAG_IO_ERROR)
1225 #define HDR_PREFETCH(hdr)       ((hdr)->b_flags & ARC_FLAG_PREFETCH)
1226 #define HDR_COMPRESSION_ENABLED(hdr)    \
1227         ((hdr)->b_flags & ARC_FLAG_COMPRESSED_ARC)
1228
1229 #define HDR_L2CACHE(hdr)        ((hdr)->b_flags & ARC_FLAG_L2CACHE)
1230 #define HDR_L2_READING(hdr)     \
1231         (((hdr)->b_flags & ARC_FLAG_IO_IN_PROGRESS) &&  \
1232         ((hdr)->b_flags & ARC_FLAG_HAS_L2HDR))
1233 #define HDR_L2_WRITING(hdr)     ((hdr)->b_flags & ARC_FLAG_L2_WRITING)
1234 #define HDR_L2_EVICTED(hdr)     ((hdr)->b_flags & ARC_FLAG_L2_EVICTED)
1235 #define HDR_L2_WRITE_HEAD(hdr)  ((hdr)->b_flags & ARC_FLAG_L2_WRITE_HEAD)
1236 #define HDR_SHARED_DATA(hdr)    ((hdr)->b_flags & ARC_FLAG_SHARED_DATA)
1237
1238 #define HDR_ISTYPE_METADATA(hdr)        \
1239         ((hdr)->b_flags & ARC_FLAG_BUFC_METADATA)
1240 #define HDR_ISTYPE_DATA(hdr)    (!HDR_ISTYPE_METADATA(hdr))
1241
1242 #define HDR_HAS_L1HDR(hdr)      ((hdr)->b_flags & ARC_FLAG_HAS_L1HDR)
1243 #define HDR_HAS_L2HDR(hdr)      ((hdr)->b_flags & ARC_FLAG_HAS_L2HDR)
1244
1245 /* For storing compression mode in b_flags */
1246 #define HDR_COMPRESS_OFFSET     (highbit64(ARC_FLAG_COMPRESS_0) - 1)
1247
1248 #define HDR_GET_COMPRESS(hdr)   ((enum zio_compress)BF32_GET((hdr)->b_flags, \
1249         HDR_COMPRESS_OFFSET, SPA_COMPRESSBITS))
1250 #define HDR_SET_COMPRESS(hdr, cmp) BF32_SET((hdr)->b_flags, \
1251         HDR_COMPRESS_OFFSET, SPA_COMPRESSBITS, (cmp));
1252
1253 #define ARC_BUF_LAST(buf)       ((buf)->b_next == NULL)
1254 #define ARC_BUF_SHARED(buf)     ((buf)->b_flags & ARC_BUF_FLAG_SHARED)
1255 #define ARC_BUF_COMPRESSED(buf) ((buf)->b_flags & ARC_BUF_FLAG_COMPRESSED)
1256
1257 /*
1258  * Other sizes
1259  */
1260
1261 #define HDR_FULL_SIZE ((int64_t)sizeof (arc_buf_hdr_t))
1262 #define HDR_L2ONLY_SIZE ((int64_t)offsetof(arc_buf_hdr_t, b_l1hdr))
1263
1264 /*
1265  * Hash table routines
1266  */
1267
1268 #define HT_LOCK_PAD     CACHE_LINE_SIZE
1269
1270 struct ht_lock {
1271         kmutex_t        ht_lock;
1272 #ifdef _KERNEL
1273         unsigned char   pad[(HT_LOCK_PAD - sizeof (kmutex_t))];
1274 #endif
1275 };
1276
1277 #define BUF_LOCKS 256
1278 typedef struct buf_hash_table {
1279         uint64_t ht_mask;
1280         arc_buf_hdr_t **ht_table;
1281         struct ht_lock ht_locks[BUF_LOCKS] __aligned(CACHE_LINE_SIZE);
1282 } buf_hash_table_t;
1283
1284 static buf_hash_table_t buf_hash_table;
1285
1286 #define BUF_HASH_INDEX(spa, dva, birth) \
1287         (buf_hash(spa, dva, birth) & buf_hash_table.ht_mask)
1288 #define BUF_HASH_LOCK_NTRY(idx) (buf_hash_table.ht_locks[idx & (BUF_LOCKS-1)])
1289 #define BUF_HASH_LOCK(idx)      (&(BUF_HASH_LOCK_NTRY(idx).ht_lock))
1290 #define HDR_LOCK(hdr) \
1291         (BUF_HASH_LOCK(BUF_HASH_INDEX(hdr->b_spa, &hdr->b_dva, hdr->b_birth)))
1292
1293 uint64_t zfs_crc64_table[256];
1294
1295 /*
1296  * Level 2 ARC
1297  */
1298
1299 #define L2ARC_WRITE_SIZE        (8 * 1024 * 1024)       /* initial write max */
1300 #define L2ARC_HEADROOM          2                       /* num of writes */
1301 /*
1302  * If we discover during ARC scan any buffers to be compressed, we boost
1303  * our headroom for the next scanning cycle by this percentage multiple.
1304  */
1305 #define L2ARC_HEADROOM_BOOST    200
1306 #define L2ARC_FEED_SECS         1               /* caching interval secs */
1307 #define L2ARC_FEED_MIN_MS       200             /* min caching interval ms */
1308
1309 #define l2arc_writes_sent       ARCSTAT(arcstat_l2_writes_sent)
1310 #define l2arc_writes_done       ARCSTAT(arcstat_l2_writes_done)
1311
1312 /* L2ARC Performance Tunables */
1313 uint64_t l2arc_write_max = L2ARC_WRITE_SIZE;    /* default max write size */
1314 uint64_t l2arc_write_boost = L2ARC_WRITE_SIZE;  /* extra write during warmup */
1315 uint64_t l2arc_headroom = L2ARC_HEADROOM;       /* number of dev writes */
1316 uint64_t l2arc_headroom_boost = L2ARC_HEADROOM_BOOST;
1317 uint64_t l2arc_feed_secs = L2ARC_FEED_SECS;     /* interval seconds */
1318 uint64_t l2arc_feed_min_ms = L2ARC_FEED_MIN_MS; /* min interval milliseconds */
1319 boolean_t l2arc_noprefetch = B_TRUE;            /* don't cache prefetch bufs */
1320 boolean_t l2arc_feed_again = B_TRUE;            /* turbo warmup */
1321 boolean_t l2arc_norw = B_TRUE;                  /* no reads during writes */
1322
1323 SYSCTL_UQUAD(_vfs_zfs, OID_AUTO, l2arc_write_max, CTLFLAG_RW,
1324     &l2arc_write_max, 0, "max write size");
1325 SYSCTL_UQUAD(_vfs_zfs, OID_AUTO, l2arc_write_boost, CTLFLAG_RW,
1326     &l2arc_write_boost, 0, "extra write during warmup");
1327 SYSCTL_UQUAD(_vfs_zfs, OID_AUTO, l2arc_headroom, CTLFLAG_RW,
1328     &l2arc_headroom, 0, "number of dev writes");
1329 SYSCTL_UQUAD(_vfs_zfs, OID_AUTO, l2arc_feed_secs, CTLFLAG_RW,
1330     &l2arc_feed_secs, 0, "interval seconds");
1331 SYSCTL_UQUAD(_vfs_zfs, OID_AUTO, l2arc_feed_min_ms, CTLFLAG_RW,
1332     &l2arc_feed_min_ms, 0, "min interval milliseconds");
1333
1334 SYSCTL_INT(_vfs_zfs, OID_AUTO, l2arc_noprefetch, CTLFLAG_RW,
1335     &l2arc_noprefetch, 0, "don't cache prefetch bufs");
1336 SYSCTL_INT(_vfs_zfs, OID_AUTO, l2arc_feed_again, CTLFLAG_RW,
1337     &l2arc_feed_again, 0, "turbo warmup");
1338 SYSCTL_INT(_vfs_zfs, OID_AUTO, l2arc_norw, CTLFLAG_RW,
1339     &l2arc_norw, 0, "no reads during writes");
1340
1341 SYSCTL_UQUAD(_vfs_zfs, OID_AUTO, anon_size, CTLFLAG_RD,
1342     &ARC_anon.arcs_size.rc_count, 0, "size of anonymous state");
1343 SYSCTL_UQUAD(_vfs_zfs, OID_AUTO, anon_metadata_esize, CTLFLAG_RD,
1344     &ARC_anon.arcs_esize[ARC_BUFC_METADATA].rc_count, 0,
1345     "size of anonymous state");
1346 SYSCTL_UQUAD(_vfs_zfs, OID_AUTO, anon_data_esize, CTLFLAG_RD,
1347     &ARC_anon.arcs_esize[ARC_BUFC_DATA].rc_count, 0,
1348     "size of anonymous state");
1349
1350 SYSCTL_UQUAD(_vfs_zfs, OID_AUTO, mru_size, CTLFLAG_RD,
1351     &ARC_mru.arcs_size.rc_count, 0, "size of mru state");
1352 SYSCTL_UQUAD(_vfs_zfs, OID_AUTO, mru_metadata_esize, CTLFLAG_RD,
1353     &ARC_mru.arcs_esize[ARC_BUFC_METADATA].rc_count, 0,
1354     "size of metadata in mru state");
1355 SYSCTL_UQUAD(_vfs_zfs, OID_AUTO, mru_data_esize, CTLFLAG_RD,
1356     &ARC_mru.arcs_esize[ARC_BUFC_DATA].rc_count, 0,
1357     "size of data in mru state");
1358
1359 SYSCTL_UQUAD(_vfs_zfs, OID_AUTO, mru_ghost_size, CTLFLAG_RD,
1360     &ARC_mru_ghost.arcs_size.rc_count, 0, "size of mru ghost state");
1361 SYSCTL_UQUAD(_vfs_zfs, OID_AUTO, mru_ghost_metadata_esize, CTLFLAG_RD,
1362     &ARC_mru_ghost.arcs_esize[ARC_BUFC_METADATA].rc_count, 0,
1363     "size of metadata in mru ghost state");
1364 SYSCTL_UQUAD(_vfs_zfs, OID_AUTO, mru_ghost_data_esize, CTLFLAG_RD,
1365     &ARC_mru_ghost.arcs_esize[ARC_BUFC_DATA].rc_count, 0,
1366     "size of data in mru ghost state");
1367
1368 SYSCTL_UQUAD(_vfs_zfs, OID_AUTO, mfu_size, CTLFLAG_RD,
1369     &ARC_mfu.arcs_size.rc_count, 0, "size of mfu state");
1370 SYSCTL_UQUAD(_vfs_zfs, OID_AUTO, mfu_metadata_esize, CTLFLAG_RD,
1371     &ARC_mfu.arcs_esize[ARC_BUFC_METADATA].rc_count, 0,
1372     "size of metadata in mfu state");
1373 SYSCTL_UQUAD(_vfs_zfs, OID_AUTO, mfu_data_esize, CTLFLAG_RD,
1374     &ARC_mfu.arcs_esize[ARC_BUFC_DATA].rc_count, 0,
1375     "size of data in mfu state");
1376
1377 SYSCTL_UQUAD(_vfs_zfs, OID_AUTO, mfu_ghost_size, CTLFLAG_RD,
1378     &ARC_mfu_ghost.arcs_size.rc_count, 0, "size of mfu ghost state");
1379 SYSCTL_UQUAD(_vfs_zfs, OID_AUTO, mfu_ghost_metadata_esize, CTLFLAG_RD,
1380     &ARC_mfu_ghost.arcs_esize[ARC_BUFC_METADATA].rc_count, 0,
1381     "size of metadata in mfu ghost state");
1382 SYSCTL_UQUAD(_vfs_zfs, OID_AUTO, mfu_ghost_data_esize, CTLFLAG_RD,
1383     &ARC_mfu_ghost.arcs_esize[ARC_BUFC_DATA].rc_count, 0,
1384     "size of data in mfu ghost state");
1385
1386 SYSCTL_UQUAD(_vfs_zfs, OID_AUTO, l2c_only_size, CTLFLAG_RD,
1387     &ARC_l2c_only.arcs_size.rc_count, 0, "size of mru state");
1388
1389 /*
1390  * L2ARC Internals
1391  */
1392 struct l2arc_dev {
1393         vdev_t                  *l2ad_vdev;     /* vdev */
1394         spa_t                   *l2ad_spa;      /* spa */
1395         uint64_t                l2ad_hand;      /* next write location */
1396         uint64_t                l2ad_start;     /* first addr on device */
1397         uint64_t                l2ad_end;       /* last addr on device */
1398         boolean_t               l2ad_first;     /* first sweep through */
1399         boolean_t               l2ad_writing;   /* currently writing */
1400         kmutex_t                l2ad_mtx;       /* lock for buffer list */
1401         list_t                  l2ad_buflist;   /* buffer list */
1402         list_node_t             l2ad_node;      /* device list node */
1403         refcount_t              l2ad_alloc;     /* allocated bytes */
1404 };
1405
1406 static list_t L2ARC_dev_list;                   /* device list */
1407 static list_t *l2arc_dev_list;                  /* device list pointer */
1408 static kmutex_t l2arc_dev_mtx;                  /* device list mutex */
1409 static l2arc_dev_t *l2arc_dev_last;             /* last device used */
1410 static list_t L2ARC_free_on_write;              /* free after write buf list */
1411 static list_t *l2arc_free_on_write;             /* free after write list ptr */
1412 static kmutex_t l2arc_free_on_write_mtx;        /* mutex for list */
1413 static uint64_t l2arc_ndev;                     /* number of devices */
1414
1415 typedef struct l2arc_read_callback {
1416         arc_buf_hdr_t           *l2rcb_hdr;             /* read header */
1417         blkptr_t                l2rcb_bp;               /* original blkptr */
1418         zbookmark_phys_t        l2rcb_zb;               /* original bookmark */
1419         int                     l2rcb_flags;            /* original flags */
1420         abd_t                   *l2rcb_abd;             /* temporary buffer */
1421 } l2arc_read_callback_t;
1422
1423 typedef struct l2arc_write_callback {
1424         l2arc_dev_t     *l2wcb_dev;             /* device info */
1425         arc_buf_hdr_t   *l2wcb_head;            /* head of write buflist */
1426 } l2arc_write_callback_t;
1427
1428 typedef struct l2arc_data_free {
1429         /* protected by l2arc_free_on_write_mtx */
1430         abd_t           *l2df_abd;
1431         size_t          l2df_size;
1432         arc_buf_contents_t l2df_type;
1433         list_node_t     l2df_list_node;
1434 } l2arc_data_free_t;
1435
1436 static kmutex_t l2arc_feed_thr_lock;
1437 static kcondvar_t l2arc_feed_thr_cv;
1438 static uint8_t l2arc_thread_exit;
1439
1440 static abd_t *arc_get_data_abd(arc_buf_hdr_t *, uint64_t, void *);
1441 static void *arc_get_data_buf(arc_buf_hdr_t *, uint64_t, void *);
1442 static void arc_get_data_impl(arc_buf_hdr_t *, uint64_t, void *);
1443 static void arc_free_data_abd(arc_buf_hdr_t *, abd_t *, uint64_t, void *);
1444 static void arc_free_data_buf(arc_buf_hdr_t *, void *, uint64_t, void *);
1445 static void arc_free_data_impl(arc_buf_hdr_t *hdr, uint64_t size, void *tag);
1446 static void arc_hdr_free_pabd(arc_buf_hdr_t *);
1447 static void arc_hdr_alloc_pabd(arc_buf_hdr_t *);
1448 static void arc_access(arc_buf_hdr_t *, kmutex_t *);
1449 static boolean_t arc_is_overflowing();
1450 static void arc_buf_watch(arc_buf_t *);
1451
1452 static arc_buf_contents_t arc_buf_type(arc_buf_hdr_t *);
1453 static uint32_t arc_bufc_to_flags(arc_buf_contents_t);
1454 static inline void arc_hdr_set_flags(arc_buf_hdr_t *hdr, arc_flags_t flags);
1455 static inline void arc_hdr_clear_flags(arc_buf_hdr_t *hdr, arc_flags_t flags);
1456
1457 static boolean_t l2arc_write_eligible(uint64_t, arc_buf_hdr_t *);
1458 static void l2arc_read_done(zio_t *);
1459
1460 static void
1461 l2arc_trim(const arc_buf_hdr_t *hdr)
1462 {
1463         l2arc_dev_t *dev = hdr->b_l2hdr.b_dev;
1464
1465         ASSERT(HDR_HAS_L2HDR(hdr));
1466         ASSERT(MUTEX_HELD(&dev->l2ad_mtx));
1467
1468         if (HDR_GET_PSIZE(hdr) != 0) {
1469                 trim_map_free(dev->l2ad_vdev, hdr->b_l2hdr.b_daddr,
1470                     HDR_GET_PSIZE(hdr), 0);
1471         }
1472 }
1473
1474 /*
1475  * We use Cityhash for this. It's fast, and has good hash properties without
1476  * requiring any large static buffers.
1477  */
1478 static uint64_t
1479 buf_hash(uint64_t spa, const dva_t *dva, uint64_t birth)
1480 {
1481         return (cityhash4(spa, dva->dva_word[0], dva->dva_word[1], birth));
1482 }
1483
1484 #define HDR_EMPTY(hdr)                                          \
1485         ((hdr)->b_dva.dva_word[0] == 0 &&                       \
1486         (hdr)->b_dva.dva_word[1] == 0)
1487
1488 #define HDR_EQUAL(spa, dva, birth, hdr)                         \
1489         ((hdr)->b_dva.dva_word[0] == (dva)->dva_word[0]) &&     \
1490         ((hdr)->b_dva.dva_word[1] == (dva)->dva_word[1]) &&     \
1491         ((hdr)->b_birth == birth) && ((hdr)->b_spa == spa)
1492
1493 static void
1494 buf_discard_identity(arc_buf_hdr_t *hdr)
1495 {
1496         hdr->b_dva.dva_word[0] = 0;
1497         hdr->b_dva.dva_word[1] = 0;
1498         hdr->b_birth = 0;
1499 }
1500
1501 static arc_buf_hdr_t *
1502 buf_hash_find(uint64_t spa, const blkptr_t *bp, kmutex_t **lockp)
1503 {
1504         const dva_t *dva = BP_IDENTITY(bp);
1505         uint64_t birth = BP_PHYSICAL_BIRTH(bp);
1506         uint64_t idx = BUF_HASH_INDEX(spa, dva, birth);
1507         kmutex_t *hash_lock = BUF_HASH_LOCK(idx);
1508         arc_buf_hdr_t *hdr;
1509
1510         mutex_enter(hash_lock);
1511         for (hdr = buf_hash_table.ht_table[idx]; hdr != NULL;
1512             hdr = hdr->b_hash_next) {
1513                 if (HDR_EQUAL(spa, dva, birth, hdr)) {
1514                         *lockp = hash_lock;
1515                         return (hdr);
1516                 }
1517         }
1518         mutex_exit(hash_lock);
1519         *lockp = NULL;
1520         return (NULL);
1521 }
1522
1523 /*
1524  * Insert an entry into the hash table.  If there is already an element
1525  * equal to elem in the hash table, then the already existing element
1526  * will be returned and the new element will not be inserted.
1527  * Otherwise returns NULL.
1528  * If lockp == NULL, the caller is assumed to already hold the hash lock.
1529  */
1530 static arc_buf_hdr_t *
1531 buf_hash_insert(arc_buf_hdr_t *hdr, kmutex_t **lockp)
1532 {
1533         uint64_t idx = BUF_HASH_INDEX(hdr->b_spa, &hdr->b_dva, hdr->b_birth);
1534         kmutex_t *hash_lock = BUF_HASH_LOCK(idx);
1535         arc_buf_hdr_t *fhdr;
1536         uint32_t i;
1537
1538         ASSERT(!DVA_IS_EMPTY(&hdr->b_dva));
1539         ASSERT(hdr->b_birth != 0);
1540         ASSERT(!HDR_IN_HASH_TABLE(hdr));
1541
1542         if (lockp != NULL) {
1543                 *lockp = hash_lock;
1544                 mutex_enter(hash_lock);
1545         } else {
1546                 ASSERT(MUTEX_HELD(hash_lock));
1547         }
1548
1549         for (fhdr = buf_hash_table.ht_table[idx], i = 0; fhdr != NULL;
1550             fhdr = fhdr->b_hash_next, i++) {
1551                 if (HDR_EQUAL(hdr->b_spa, &hdr->b_dva, hdr->b_birth, fhdr))
1552                         return (fhdr);
1553         }
1554
1555         hdr->b_hash_next = buf_hash_table.ht_table[idx];
1556         buf_hash_table.ht_table[idx] = hdr;
1557         arc_hdr_set_flags(hdr, ARC_FLAG_IN_HASH_TABLE);
1558
1559         /* collect some hash table performance data */
1560         if (i > 0) {
1561                 ARCSTAT_BUMP(arcstat_hash_collisions);
1562                 if (i == 1)
1563                         ARCSTAT_BUMP(arcstat_hash_chains);
1564
1565                 ARCSTAT_MAX(arcstat_hash_chain_max, i);
1566         }
1567
1568         ARCSTAT_BUMP(arcstat_hash_elements);
1569         ARCSTAT_MAXSTAT(arcstat_hash_elements);
1570
1571         return (NULL);
1572 }
1573
1574 static void
1575 buf_hash_remove(arc_buf_hdr_t *hdr)
1576 {
1577         arc_buf_hdr_t *fhdr, **hdrp;
1578         uint64_t idx = BUF_HASH_INDEX(hdr->b_spa, &hdr->b_dva, hdr->b_birth);
1579
1580         ASSERT(MUTEX_HELD(BUF_HASH_LOCK(idx)));
1581         ASSERT(HDR_IN_HASH_TABLE(hdr));
1582
1583         hdrp = &buf_hash_table.ht_table[idx];
1584         while ((fhdr = *hdrp) != hdr) {
1585                 ASSERT3P(fhdr, !=, NULL);
1586                 hdrp = &fhdr->b_hash_next;
1587         }
1588         *hdrp = hdr->b_hash_next;
1589         hdr->b_hash_next = NULL;
1590         arc_hdr_clear_flags(hdr, ARC_FLAG_IN_HASH_TABLE);
1591
1592         /* collect some hash table performance data */
1593         ARCSTAT_BUMPDOWN(arcstat_hash_elements);
1594
1595         if (buf_hash_table.ht_table[idx] &&
1596             buf_hash_table.ht_table[idx]->b_hash_next == NULL)
1597                 ARCSTAT_BUMPDOWN(arcstat_hash_chains);
1598 }
1599
1600 /*
1601  * Global data structures and functions for the buf kmem cache.
1602  */
1603 static kmem_cache_t *hdr_full_cache;
1604 static kmem_cache_t *hdr_l2only_cache;
1605 static kmem_cache_t *buf_cache;
1606
1607 static void
1608 buf_fini(void)
1609 {
1610         int i;
1611
1612         kmem_free(buf_hash_table.ht_table,
1613             (buf_hash_table.ht_mask + 1) * sizeof (void *));
1614         for (i = 0; i < BUF_LOCKS; i++)
1615                 mutex_destroy(&buf_hash_table.ht_locks[i].ht_lock);
1616         kmem_cache_destroy(hdr_full_cache);
1617         kmem_cache_destroy(hdr_l2only_cache);
1618         kmem_cache_destroy(buf_cache);
1619 }
1620
1621 /*
1622  * Constructor callback - called when the cache is empty
1623  * and a new buf is requested.
1624  */
1625 /* ARGSUSED */
1626 static int
1627 hdr_full_cons(void *vbuf, void *unused, int kmflag)
1628 {
1629         arc_buf_hdr_t *hdr = vbuf;
1630
1631         bzero(hdr, HDR_FULL_SIZE);
1632         cv_init(&hdr->b_l1hdr.b_cv, NULL, CV_DEFAULT, NULL);
1633         refcount_create(&hdr->b_l1hdr.b_refcnt);
1634         mutex_init(&hdr->b_l1hdr.b_freeze_lock, NULL, MUTEX_DEFAULT, NULL);
1635         multilist_link_init(&hdr->b_l1hdr.b_arc_node);
1636         arc_space_consume(HDR_FULL_SIZE, ARC_SPACE_HDRS);
1637
1638         return (0);
1639 }
1640
1641 /* ARGSUSED */
1642 static int
1643 hdr_l2only_cons(void *vbuf, void *unused, int kmflag)
1644 {
1645         arc_buf_hdr_t *hdr = vbuf;
1646
1647         bzero(hdr, HDR_L2ONLY_SIZE);
1648         arc_space_consume(HDR_L2ONLY_SIZE, ARC_SPACE_L2HDRS);
1649
1650         return (0);
1651 }
1652
1653 /* ARGSUSED */
1654 static int
1655 buf_cons(void *vbuf, void *unused, int kmflag)
1656 {
1657         arc_buf_t *buf = vbuf;
1658
1659         bzero(buf, sizeof (arc_buf_t));
1660         mutex_init(&buf->b_evict_lock, NULL, MUTEX_DEFAULT, NULL);
1661         arc_space_consume(sizeof (arc_buf_t), ARC_SPACE_HDRS);
1662
1663         return (0);
1664 }
1665
1666 /*
1667  * Destructor callback - called when a cached buf is
1668  * no longer required.
1669  */
1670 /* ARGSUSED */
1671 static void
1672 hdr_full_dest(void *vbuf, void *unused)
1673 {
1674         arc_buf_hdr_t *hdr = vbuf;
1675
1676         ASSERT(HDR_EMPTY(hdr));
1677         cv_destroy(&hdr->b_l1hdr.b_cv);
1678         refcount_destroy(&hdr->b_l1hdr.b_refcnt);
1679         mutex_destroy(&hdr->b_l1hdr.b_freeze_lock);
1680         ASSERT(!multilist_link_active(&hdr->b_l1hdr.b_arc_node));
1681         arc_space_return(HDR_FULL_SIZE, ARC_SPACE_HDRS);
1682 }
1683
1684 /* ARGSUSED */
1685 static void
1686 hdr_l2only_dest(void *vbuf, void *unused)
1687 {
1688         arc_buf_hdr_t *hdr = vbuf;
1689
1690         ASSERT(HDR_EMPTY(hdr));
1691         arc_space_return(HDR_L2ONLY_SIZE, ARC_SPACE_L2HDRS);
1692 }
1693
1694 /* ARGSUSED */
1695 static void
1696 buf_dest(void *vbuf, void *unused)
1697 {
1698         arc_buf_t *buf = vbuf;
1699
1700         mutex_destroy(&buf->b_evict_lock);
1701         arc_space_return(sizeof (arc_buf_t), ARC_SPACE_HDRS);
1702 }
1703
1704 /*
1705  * Reclaim callback -- invoked when memory is low.
1706  */
1707 /* ARGSUSED */
1708 static void
1709 hdr_recl(void *unused)
1710 {
1711         dprintf("hdr_recl called\n");
1712         /*
1713          * umem calls the reclaim func when we destroy the buf cache,
1714          * which is after we do arc_fini().
1715          */
1716         if (!arc_dead)
1717                 cv_signal(&arc_reclaim_thread_cv);
1718 }
1719
1720 static void
1721 buf_init(void)
1722 {
1723         uint64_t *ct;
1724         uint64_t hsize = 1ULL << 12;
1725         int i, j;
1726
1727         /*
1728          * The hash table is big enough to fill all of physical memory
1729          * with an average block size of zfs_arc_average_blocksize (default 8K).
1730          * By default, the table will take up
1731          * totalmem * sizeof(void*) / 8K (1MB per GB with 8-byte pointers).
1732          */
1733         while (hsize * zfs_arc_average_blocksize < (uint64_t)physmem * PAGESIZE)
1734                 hsize <<= 1;
1735 retry:
1736         buf_hash_table.ht_mask = hsize - 1;
1737         buf_hash_table.ht_table =
1738             kmem_zalloc(hsize * sizeof (void*), KM_NOSLEEP);
1739         if (buf_hash_table.ht_table == NULL) {
1740                 ASSERT(hsize > (1ULL << 8));
1741                 hsize >>= 1;
1742                 goto retry;
1743         }
1744
1745         hdr_full_cache = kmem_cache_create("arc_buf_hdr_t_full", HDR_FULL_SIZE,
1746             0, hdr_full_cons, hdr_full_dest, hdr_recl, NULL, NULL, 0);
1747         hdr_l2only_cache = kmem_cache_create("arc_buf_hdr_t_l2only",
1748             HDR_L2ONLY_SIZE, 0, hdr_l2only_cons, hdr_l2only_dest, hdr_recl,
1749             NULL, NULL, 0);
1750         buf_cache = kmem_cache_create("arc_buf_t", sizeof (arc_buf_t),
1751             0, buf_cons, buf_dest, NULL, NULL, NULL, 0);
1752
1753         for (i = 0; i < 256; i++)
1754                 for (ct = zfs_crc64_table + i, *ct = i, j = 8; j > 0; j--)
1755                         *ct = (*ct >> 1) ^ (-(*ct & 1) & ZFS_CRC64_POLY);
1756
1757         for (i = 0; i < BUF_LOCKS; i++) {
1758                 mutex_init(&buf_hash_table.ht_locks[i].ht_lock,
1759                     NULL, MUTEX_DEFAULT, NULL);
1760         }
1761 }
1762
1763 /*
1764  * This is the size that the buf occupies in memory. If the buf is compressed,
1765  * it will correspond to the compressed size. You should use this method of
1766  * getting the buf size unless you explicitly need the logical size.
1767  */
1768 int32_t
1769 arc_buf_size(arc_buf_t *buf)
1770 {
1771         return (ARC_BUF_COMPRESSED(buf) ?
1772             HDR_GET_PSIZE(buf->b_hdr) : HDR_GET_LSIZE(buf->b_hdr));
1773 }
1774
1775 int32_t
1776 arc_buf_lsize(arc_buf_t *buf)
1777 {
1778         return (HDR_GET_LSIZE(buf->b_hdr));
1779 }
1780
1781 enum zio_compress
1782 arc_get_compression(arc_buf_t *buf)
1783 {
1784         return (ARC_BUF_COMPRESSED(buf) ?
1785             HDR_GET_COMPRESS(buf->b_hdr) : ZIO_COMPRESS_OFF);
1786 }
1787
1788 #define ARC_MINTIME     (hz>>4) /* 62 ms */
1789
1790 static inline boolean_t
1791 arc_buf_is_shared(arc_buf_t *buf)
1792 {
1793         boolean_t shared = (buf->b_data != NULL &&
1794             buf->b_hdr->b_l1hdr.b_pabd != NULL &&
1795             abd_is_linear(buf->b_hdr->b_l1hdr.b_pabd) &&
1796             buf->b_data == abd_to_buf(buf->b_hdr->b_l1hdr.b_pabd));
1797         IMPLY(shared, HDR_SHARED_DATA(buf->b_hdr));
1798         IMPLY(shared, ARC_BUF_SHARED(buf));
1799         IMPLY(shared, ARC_BUF_COMPRESSED(buf) || ARC_BUF_LAST(buf));
1800
1801         /*
1802          * It would be nice to assert arc_can_share() too, but the "hdr isn't
1803          * already being shared" requirement prevents us from doing that.
1804          */
1805
1806         return (shared);
1807 }
1808
1809 /*
1810  * Free the checksum associated with this header. If there is no checksum, this
1811  * is a no-op.
1812  */
1813 static inline void
1814 arc_cksum_free(arc_buf_hdr_t *hdr)
1815 {
1816         ASSERT(HDR_HAS_L1HDR(hdr));
1817         mutex_enter(&hdr->b_l1hdr.b_freeze_lock);
1818         if (hdr->b_l1hdr.b_freeze_cksum != NULL) {
1819                 kmem_free(hdr->b_l1hdr.b_freeze_cksum, sizeof (zio_cksum_t));
1820                 hdr->b_l1hdr.b_freeze_cksum = NULL;
1821         }
1822         mutex_exit(&hdr->b_l1hdr.b_freeze_lock);
1823 }
1824
1825 /*
1826  * Return true iff at least one of the bufs on hdr is not compressed.
1827  */
1828 static boolean_t
1829 arc_hdr_has_uncompressed_buf(arc_buf_hdr_t *hdr)
1830 {
1831         for (arc_buf_t *b = hdr->b_l1hdr.b_buf; b != NULL; b = b->b_next) {
1832                 if (!ARC_BUF_COMPRESSED(b)) {
1833                         return (B_TRUE);
1834                 }
1835         }
1836         return (B_FALSE);
1837 }
1838
1839 /*
1840  * If we've turned on the ZFS_DEBUG_MODIFY flag, verify that the buf's data
1841  * matches the checksum that is stored in the hdr. If there is no checksum,
1842  * or if the buf is compressed, this is a no-op.
1843  */
1844 static void
1845 arc_cksum_verify(arc_buf_t *buf)
1846 {
1847         arc_buf_hdr_t *hdr = buf->b_hdr;
1848         zio_cksum_t zc;
1849
1850         if (!(zfs_flags & ZFS_DEBUG_MODIFY))
1851                 return;
1852
1853         if (ARC_BUF_COMPRESSED(buf)) {
1854                 ASSERT(hdr->b_l1hdr.b_freeze_cksum == NULL ||
1855                     arc_hdr_has_uncompressed_buf(hdr));
1856                 return;
1857         }
1858
1859         ASSERT(HDR_HAS_L1HDR(hdr));
1860
1861         mutex_enter(&hdr->b_l1hdr.b_freeze_lock);
1862         if (hdr->b_l1hdr.b_freeze_cksum == NULL || HDR_IO_ERROR(hdr)) {
1863                 mutex_exit(&hdr->b_l1hdr.b_freeze_lock);
1864                 return;
1865         }
1866
1867         fletcher_2_native(buf->b_data, arc_buf_size(buf), NULL, &zc);
1868         if (!ZIO_CHECKSUM_EQUAL(*hdr->b_l1hdr.b_freeze_cksum, zc))
1869                 panic("buffer modified while frozen!");
1870         mutex_exit(&hdr->b_l1hdr.b_freeze_lock);
1871 }
1872
1873 static boolean_t
1874 arc_cksum_is_equal(arc_buf_hdr_t *hdr, zio_t *zio)
1875 {
1876         enum zio_compress compress = BP_GET_COMPRESS(zio->io_bp);
1877         boolean_t valid_cksum;
1878
1879         ASSERT(!BP_IS_EMBEDDED(zio->io_bp));
1880         VERIFY3U(BP_GET_PSIZE(zio->io_bp), ==, HDR_GET_PSIZE(hdr));
1881
1882         /*
1883          * We rely on the blkptr's checksum to determine if the block
1884          * is valid or not. When compressed arc is enabled, the l2arc
1885          * writes the block to the l2arc just as it appears in the pool.
1886          * This allows us to use the blkptr's checksum to validate the
1887          * data that we just read off of the l2arc without having to store
1888          * a separate checksum in the arc_buf_hdr_t. However, if compressed
1889          * arc is disabled, then the data written to the l2arc is always
1890          * uncompressed and won't match the block as it exists in the main
1891          * pool. When this is the case, we must first compress it if it is
1892          * compressed on the main pool before we can validate the checksum.
1893          */
1894         if (!HDR_COMPRESSION_ENABLED(hdr) && compress != ZIO_COMPRESS_OFF) {
1895                 ASSERT3U(HDR_GET_COMPRESS(hdr), ==, ZIO_COMPRESS_OFF);
1896                 uint64_t lsize = HDR_GET_LSIZE(hdr);
1897                 uint64_t csize;
1898
1899                 abd_t *cdata = abd_alloc_linear(HDR_GET_PSIZE(hdr), B_TRUE);
1900                 csize = zio_compress_data(compress, zio->io_abd,
1901                     abd_to_buf(cdata), lsize);
1902
1903                 ASSERT3U(csize, <=, HDR_GET_PSIZE(hdr));
1904                 if (csize < HDR_GET_PSIZE(hdr)) {
1905                         /*
1906                          * Compressed blocks are always a multiple of the
1907                          * smallest ashift in the pool. Ideally, we would
1908                          * like to round up the csize to the next
1909                          * spa_min_ashift but that value may have changed
1910                          * since the block was last written. Instead,
1911                          * we rely on the fact that the hdr's psize
1912                          * was set to the psize of the block when it was
1913                          * last written. We set the csize to that value
1914                          * and zero out any part that should not contain
1915                          * data.
1916                          */
1917                         abd_zero_off(cdata, csize, HDR_GET_PSIZE(hdr) - csize);
1918                         csize = HDR_GET_PSIZE(hdr);
1919                 }
1920                 zio_push_transform(zio, cdata, csize, HDR_GET_PSIZE(hdr), NULL);
1921         }
1922
1923         /*
1924          * Block pointers always store the checksum for the logical data.
1925          * If the block pointer has the gang bit set, then the checksum
1926          * it represents is for the reconstituted data and not for an
1927          * individual gang member. The zio pipeline, however, must be able to
1928          * determine the checksum of each of the gang constituents so it
1929          * treats the checksum comparison differently than what we need
1930          * for l2arc blocks. This prevents us from using the
1931          * zio_checksum_error() interface directly. Instead we must call the
1932          * zio_checksum_error_impl() so that we can ensure the checksum is
1933          * generated using the correct checksum algorithm and accounts for the
1934          * logical I/O size and not just a gang fragment.
1935          */
1936         valid_cksum = (zio_checksum_error_impl(zio->io_spa, zio->io_bp,
1937             BP_GET_CHECKSUM(zio->io_bp), zio->io_abd, zio->io_size,
1938             zio->io_offset, NULL) == 0);
1939         zio_pop_transforms(zio);
1940         return (valid_cksum);
1941 }
1942
1943 /*
1944  * Given a buf full of data, if ZFS_DEBUG_MODIFY is enabled this computes a
1945  * checksum and attaches it to the buf's hdr so that we can ensure that the buf
1946  * isn't modified later on. If buf is compressed or there is already a checksum
1947  * on the hdr, this is a no-op (we only checksum uncompressed bufs).
1948  */
1949 static void
1950 arc_cksum_compute(arc_buf_t *buf)
1951 {
1952         arc_buf_hdr_t *hdr = buf->b_hdr;
1953
1954         if (!(zfs_flags & ZFS_DEBUG_MODIFY))
1955                 return;
1956
1957         ASSERT(HDR_HAS_L1HDR(hdr));
1958
1959         mutex_enter(&buf->b_hdr->b_l1hdr.b_freeze_lock);
1960         if (hdr->b_l1hdr.b_freeze_cksum != NULL) {
1961                 ASSERT(arc_hdr_has_uncompressed_buf(hdr));
1962                 mutex_exit(&hdr->b_l1hdr.b_freeze_lock);
1963                 return;
1964         } else if (ARC_BUF_COMPRESSED(buf)) {
1965                 mutex_exit(&hdr->b_l1hdr.b_freeze_lock);
1966                 return;
1967         }
1968
1969         ASSERT(!ARC_BUF_COMPRESSED(buf));
1970         hdr->b_l1hdr.b_freeze_cksum = kmem_alloc(sizeof (zio_cksum_t),
1971             KM_SLEEP);
1972         fletcher_2_native(buf->b_data, arc_buf_size(buf), NULL,
1973             hdr->b_l1hdr.b_freeze_cksum);
1974         mutex_exit(&hdr->b_l1hdr.b_freeze_lock);
1975 #ifdef illumos
1976         arc_buf_watch(buf);
1977 #endif
1978 }
1979
1980 #ifdef illumos
1981 #ifndef _KERNEL
1982 typedef struct procctl {
1983         long cmd;
1984         prwatch_t prwatch;
1985 } procctl_t;
1986 #endif
1987
1988 /* ARGSUSED */
1989 static void
1990 arc_buf_unwatch(arc_buf_t *buf)
1991 {
1992 #ifndef _KERNEL
1993         if (arc_watch) {
1994                 int result;
1995                 procctl_t ctl;
1996                 ctl.cmd = PCWATCH;
1997                 ctl.prwatch.pr_vaddr = (uintptr_t)buf->b_data;
1998                 ctl.prwatch.pr_size = 0;
1999                 ctl.prwatch.pr_wflags = 0;
2000                 result = write(arc_procfd, &ctl, sizeof (ctl));
2001                 ASSERT3U(result, ==, sizeof (ctl));
2002         }
2003 #endif
2004 }
2005
2006 /* ARGSUSED */
2007 static void
2008 arc_buf_watch(arc_buf_t *buf)
2009 {
2010 #ifndef _KERNEL
2011         if (arc_watch) {
2012                 int result;
2013                 procctl_t ctl;
2014                 ctl.cmd = PCWATCH;
2015                 ctl.prwatch.pr_vaddr = (uintptr_t)buf->b_data;
2016                 ctl.prwatch.pr_size = arc_buf_size(buf);
2017                 ctl.prwatch.pr_wflags = WA_WRITE;
2018                 result = write(arc_procfd, &ctl, sizeof (ctl));
2019                 ASSERT3U(result, ==, sizeof (ctl));
2020         }
2021 #endif
2022 }
2023 #endif /* illumos */
2024
2025 static arc_buf_contents_t
2026 arc_buf_type(arc_buf_hdr_t *hdr)
2027 {
2028         arc_buf_contents_t type;
2029         if (HDR_ISTYPE_METADATA(hdr)) {
2030                 type = ARC_BUFC_METADATA;
2031         } else {
2032                 type = ARC_BUFC_DATA;
2033         }
2034         VERIFY3U(hdr->b_type, ==, type);
2035         return (type);
2036 }
2037
2038 boolean_t
2039 arc_is_metadata(arc_buf_t *buf)
2040 {
2041         return (HDR_ISTYPE_METADATA(buf->b_hdr) != 0);
2042 }
2043
2044 static uint32_t
2045 arc_bufc_to_flags(arc_buf_contents_t type)
2046 {
2047         switch (type) {
2048         case ARC_BUFC_DATA:
2049                 /* metadata field is 0 if buffer contains normal data */
2050                 return (0);
2051         case ARC_BUFC_METADATA:
2052                 return (ARC_FLAG_BUFC_METADATA);
2053         default:
2054                 break;
2055         }
2056         panic("undefined ARC buffer type!");
2057         return ((uint32_t)-1);
2058 }
2059
2060 void
2061 arc_buf_thaw(arc_buf_t *buf)
2062 {
2063         arc_buf_hdr_t *hdr = buf->b_hdr;
2064
2065         ASSERT3P(hdr->b_l1hdr.b_state, ==, arc_anon);
2066         ASSERT(!HDR_IO_IN_PROGRESS(hdr));
2067
2068         arc_cksum_verify(buf);
2069
2070         /*
2071          * Compressed buffers do not manipulate the b_freeze_cksum or
2072          * allocate b_thawed.
2073          */
2074         if (ARC_BUF_COMPRESSED(buf)) {
2075                 ASSERT(hdr->b_l1hdr.b_freeze_cksum == NULL ||
2076                     arc_hdr_has_uncompressed_buf(hdr));
2077                 return;
2078         }
2079
2080         ASSERT(HDR_HAS_L1HDR(hdr));
2081         arc_cksum_free(hdr);
2082
2083         mutex_enter(&hdr->b_l1hdr.b_freeze_lock);
2084 #ifdef ZFS_DEBUG
2085         if (zfs_flags & ZFS_DEBUG_MODIFY) {
2086                 if (hdr->b_l1hdr.b_thawed != NULL)
2087                         kmem_free(hdr->b_l1hdr.b_thawed, 1);
2088                 hdr->b_l1hdr.b_thawed = kmem_alloc(1, KM_SLEEP);
2089         }
2090 #endif
2091
2092         mutex_exit(&hdr->b_l1hdr.b_freeze_lock);
2093
2094 #ifdef illumos
2095         arc_buf_unwatch(buf);
2096 #endif
2097 }
2098
2099 void
2100 arc_buf_freeze(arc_buf_t *buf)
2101 {
2102         arc_buf_hdr_t *hdr = buf->b_hdr;
2103         kmutex_t *hash_lock;
2104
2105         if (!(zfs_flags & ZFS_DEBUG_MODIFY))
2106                 return;
2107
2108         if (ARC_BUF_COMPRESSED(buf)) {
2109                 ASSERT(hdr->b_l1hdr.b_freeze_cksum == NULL ||
2110                     arc_hdr_has_uncompressed_buf(hdr));
2111                 return;
2112         }
2113
2114         hash_lock = HDR_LOCK(hdr);
2115         mutex_enter(hash_lock);
2116
2117         ASSERT(HDR_HAS_L1HDR(hdr));
2118         ASSERT(hdr->b_l1hdr.b_freeze_cksum != NULL ||
2119             hdr->b_l1hdr.b_state == arc_anon);
2120         arc_cksum_compute(buf);
2121         mutex_exit(hash_lock);
2122 }
2123
2124 /*
2125  * The arc_buf_hdr_t's b_flags should never be modified directly. Instead,
2126  * the following functions should be used to ensure that the flags are
2127  * updated in a thread-safe way. When manipulating the flags either
2128  * the hash_lock must be held or the hdr must be undiscoverable. This
2129  * ensures that we're not racing with any other threads when updating
2130  * the flags.
2131  */
2132 static inline void
2133 arc_hdr_set_flags(arc_buf_hdr_t *hdr, arc_flags_t flags)
2134 {
2135         ASSERT(MUTEX_HELD(HDR_LOCK(hdr)) || HDR_EMPTY(hdr));
2136         hdr->b_flags |= flags;
2137 }
2138
2139 static inline void
2140 arc_hdr_clear_flags(arc_buf_hdr_t *hdr, arc_flags_t flags)
2141 {
2142         ASSERT(MUTEX_HELD(HDR_LOCK(hdr)) || HDR_EMPTY(hdr));
2143         hdr->b_flags &= ~flags;
2144 }
2145
2146 /*
2147  * Setting the compression bits in the arc_buf_hdr_t's b_flags is
2148  * done in a special way since we have to clear and set bits
2149  * at the same time. Consumers that wish to set the compression bits
2150  * must use this function to ensure that the flags are updated in
2151  * thread-safe manner.
2152  */
2153 static void
2154 arc_hdr_set_compress(arc_buf_hdr_t *hdr, enum zio_compress cmp)
2155 {
2156         ASSERT(MUTEX_HELD(HDR_LOCK(hdr)) || HDR_EMPTY(hdr));
2157
2158         /*
2159          * Holes and embedded blocks will always have a psize = 0 so
2160          * we ignore the compression of the blkptr and set the
2161          * arc_buf_hdr_t's compression to ZIO_COMPRESS_OFF.
2162          * Holes and embedded blocks remain anonymous so we don't
2163          * want to uncompress them. Mark them as uncompressed.
2164          */
2165         if (!zfs_compressed_arc_enabled || HDR_GET_PSIZE(hdr) == 0) {
2166                 arc_hdr_clear_flags(hdr, ARC_FLAG_COMPRESSED_ARC);
2167                 HDR_SET_COMPRESS(hdr, ZIO_COMPRESS_OFF);
2168                 ASSERT(!HDR_COMPRESSION_ENABLED(hdr));
2169                 ASSERT3U(HDR_GET_COMPRESS(hdr), ==, ZIO_COMPRESS_OFF);
2170         } else {
2171                 arc_hdr_set_flags(hdr, ARC_FLAG_COMPRESSED_ARC);
2172                 HDR_SET_COMPRESS(hdr, cmp);
2173                 ASSERT3U(HDR_GET_COMPRESS(hdr), ==, cmp);
2174                 ASSERT(HDR_COMPRESSION_ENABLED(hdr));
2175         }
2176 }
2177
2178 /*
2179  * Looks for another buf on the same hdr which has the data decompressed, copies
2180  * from it, and returns true. If no such buf exists, returns false.
2181  */
2182 static boolean_t
2183 arc_buf_try_copy_decompressed_data(arc_buf_t *buf)
2184 {
2185         arc_buf_hdr_t *hdr = buf->b_hdr;
2186         boolean_t copied = B_FALSE;
2187
2188         ASSERT(HDR_HAS_L1HDR(hdr));
2189         ASSERT3P(buf->b_data, !=, NULL);
2190         ASSERT(!ARC_BUF_COMPRESSED(buf));
2191
2192         for (arc_buf_t *from = hdr->b_l1hdr.b_buf; from != NULL;
2193             from = from->b_next) {
2194                 /* can't use our own data buffer */
2195                 if (from == buf) {
2196                         continue;
2197                 }
2198
2199                 if (!ARC_BUF_COMPRESSED(from)) {
2200                         bcopy(from->b_data, buf->b_data, arc_buf_size(buf));
2201                         copied = B_TRUE;
2202                         break;
2203                 }
2204         }
2205
2206         /*
2207          * There were no decompressed bufs, so there should not be a
2208          * checksum on the hdr either.
2209          */
2210         EQUIV(!copied, hdr->b_l1hdr.b_freeze_cksum == NULL);
2211
2212         return (copied);
2213 }
2214
2215 /*
2216  * Given a buf that has a data buffer attached to it, this function will
2217  * efficiently fill the buf with data of the specified compression setting from
2218  * the hdr and update the hdr's b_freeze_cksum if necessary. If the buf and hdr
2219  * are already sharing a data buf, no copy is performed.
2220  *
2221  * If the buf is marked as compressed but uncompressed data was requested, this
2222  * will allocate a new data buffer for the buf, remove that flag, and fill the
2223  * buf with uncompressed data. You can't request a compressed buf on a hdr with
2224  * uncompressed data, and (since we haven't added support for it yet) if you
2225  * want compressed data your buf must already be marked as compressed and have
2226  * the correct-sized data buffer.
2227  */
2228 static int
2229 arc_buf_fill(arc_buf_t *buf, boolean_t compressed)
2230 {
2231         arc_buf_hdr_t *hdr = buf->b_hdr;
2232         boolean_t hdr_compressed = (HDR_GET_COMPRESS(hdr) != ZIO_COMPRESS_OFF);
2233         dmu_object_byteswap_t bswap = hdr->b_l1hdr.b_byteswap;
2234
2235         ASSERT3P(buf->b_data, !=, NULL);
2236         IMPLY(compressed, hdr_compressed);
2237         IMPLY(compressed, ARC_BUF_COMPRESSED(buf));
2238
2239         if (hdr_compressed == compressed) {
2240                 if (!arc_buf_is_shared(buf)) {
2241                         abd_copy_to_buf(buf->b_data, hdr->b_l1hdr.b_pabd,
2242                             arc_buf_size(buf));
2243                 }
2244         } else {
2245                 ASSERT(hdr_compressed);
2246                 ASSERT(!compressed);
2247                 ASSERT3U(HDR_GET_LSIZE(hdr), !=, HDR_GET_PSIZE(hdr));
2248
2249                 /*
2250                  * If the buf is sharing its data with the hdr, unlink it and
2251                  * allocate a new data buffer for the buf.
2252                  */
2253                 if (arc_buf_is_shared(buf)) {
2254                         ASSERT(ARC_BUF_COMPRESSED(buf));
2255
2256                         /* We need to give the buf it's own b_data */
2257                         buf->b_flags &= ~ARC_BUF_FLAG_SHARED;
2258                         buf->b_data =
2259                             arc_get_data_buf(hdr, HDR_GET_LSIZE(hdr), buf);
2260                         arc_hdr_clear_flags(hdr, ARC_FLAG_SHARED_DATA);
2261
2262                         /* Previously overhead was 0; just add new overhead */
2263                         ARCSTAT_INCR(arcstat_overhead_size, HDR_GET_LSIZE(hdr));
2264                 } else if (ARC_BUF_COMPRESSED(buf)) {
2265                         /* We need to reallocate the buf's b_data */
2266                         arc_free_data_buf(hdr, buf->b_data, HDR_GET_PSIZE(hdr),
2267                             buf);
2268                         buf->b_data =
2269                             arc_get_data_buf(hdr, HDR_GET_LSIZE(hdr), buf);
2270
2271                         /* We increased the size of b_data; update overhead */
2272                         ARCSTAT_INCR(arcstat_overhead_size,
2273                             HDR_GET_LSIZE(hdr) - HDR_GET_PSIZE(hdr));
2274                 }
2275
2276                 /*
2277                  * Regardless of the buf's previous compression settings, it
2278                  * should not be compressed at the end of this function.
2279                  */
2280                 buf->b_flags &= ~ARC_BUF_FLAG_COMPRESSED;
2281
2282                 /*
2283                  * Try copying the data from another buf which already has a
2284                  * decompressed version. If that's not possible, it's time to
2285                  * bite the bullet and decompress the data from the hdr.
2286                  */
2287                 if (arc_buf_try_copy_decompressed_data(buf)) {
2288                         /* Skip byteswapping and checksumming (already done) */
2289                         ASSERT3P(hdr->b_l1hdr.b_freeze_cksum, !=, NULL);
2290                         return (0);
2291                 } else {
2292                         int error = zio_decompress_data(HDR_GET_COMPRESS(hdr),
2293                             hdr->b_l1hdr.b_pabd, buf->b_data,
2294                             HDR_GET_PSIZE(hdr), HDR_GET_LSIZE(hdr));
2295
2296                         /*
2297                          * Absent hardware errors or software bugs, this should
2298                          * be impossible, but log it anyway so we can debug it.
2299                          */
2300                         if (error != 0) {
2301                                 zfs_dbgmsg(
2302                                     "hdr %p, compress %d, psize %d, lsize %d",
2303                                     hdr, HDR_GET_COMPRESS(hdr),
2304                                     HDR_GET_PSIZE(hdr), HDR_GET_LSIZE(hdr));
2305                                 return (SET_ERROR(EIO));
2306                         }
2307                 }
2308         }
2309
2310         /* Byteswap the buf's data if necessary */
2311         if (bswap != DMU_BSWAP_NUMFUNCS) {
2312                 ASSERT(!HDR_SHARED_DATA(hdr));
2313                 ASSERT3U(bswap, <, DMU_BSWAP_NUMFUNCS);
2314                 dmu_ot_byteswap[bswap].ob_func(buf->b_data, HDR_GET_LSIZE(hdr));
2315         }
2316
2317         /* Compute the hdr's checksum if necessary */
2318         arc_cksum_compute(buf);
2319
2320         return (0);
2321 }
2322
2323 int
2324 arc_decompress(arc_buf_t *buf)
2325 {
2326         return (arc_buf_fill(buf, B_FALSE));
2327 }
2328
2329 /*
2330  * Return the size of the block, b_pabd, that is stored in the arc_buf_hdr_t.
2331  */
2332 static uint64_t
2333 arc_hdr_size(arc_buf_hdr_t *hdr)
2334 {
2335         uint64_t size;
2336
2337         if (HDR_GET_COMPRESS(hdr) != ZIO_COMPRESS_OFF &&
2338             HDR_GET_PSIZE(hdr) > 0) {
2339                 size = HDR_GET_PSIZE(hdr);
2340         } else {
2341                 ASSERT3U(HDR_GET_LSIZE(hdr), !=, 0);
2342                 size = HDR_GET_LSIZE(hdr);
2343         }
2344         return (size);
2345 }
2346
2347 /*
2348  * Increment the amount of evictable space in the arc_state_t's refcount.
2349  * We account for the space used by the hdr and the arc buf individually
2350  * so that we can add and remove them from the refcount individually.
2351  */
2352 static void
2353 arc_evictable_space_increment(arc_buf_hdr_t *hdr, arc_state_t *state)
2354 {
2355         arc_buf_contents_t type = arc_buf_type(hdr);
2356
2357         ASSERT(HDR_HAS_L1HDR(hdr));
2358
2359         if (GHOST_STATE(state)) {
2360                 ASSERT0(hdr->b_l1hdr.b_bufcnt);
2361                 ASSERT3P(hdr->b_l1hdr.b_buf, ==, NULL);
2362                 ASSERT3P(hdr->b_l1hdr.b_pabd, ==, NULL);
2363                 (void) refcount_add_many(&state->arcs_esize[type],
2364                     HDR_GET_LSIZE(hdr), hdr);
2365                 return;
2366         }
2367
2368         ASSERT(!GHOST_STATE(state));
2369         if (hdr->b_l1hdr.b_pabd != NULL) {
2370                 (void) refcount_add_many(&state->arcs_esize[type],
2371                     arc_hdr_size(hdr), hdr);
2372         }
2373         for (arc_buf_t *buf = hdr->b_l1hdr.b_buf; buf != NULL;
2374             buf = buf->b_next) {
2375                 if (arc_buf_is_shared(buf))
2376                         continue;
2377                 (void) refcount_add_many(&state->arcs_esize[type],
2378                     arc_buf_size(buf), buf);
2379         }
2380 }
2381
2382 /*
2383  * Decrement the amount of evictable space in the arc_state_t's refcount.
2384  * We account for the space used by the hdr and the arc buf individually
2385  * so that we can add and remove them from the refcount individually.
2386  */
2387 static void
2388 arc_evictable_space_decrement(arc_buf_hdr_t *hdr, arc_state_t *state)
2389 {
2390         arc_buf_contents_t type = arc_buf_type(hdr);
2391
2392         ASSERT(HDR_HAS_L1HDR(hdr));
2393
2394         if (GHOST_STATE(state)) {
2395                 ASSERT0(hdr->b_l1hdr.b_bufcnt);
2396                 ASSERT3P(hdr->b_l1hdr.b_buf, ==, NULL);
2397                 ASSERT3P(hdr->b_l1hdr.b_pabd, ==, NULL);
2398                 (void) refcount_remove_many(&state->arcs_esize[type],
2399                     HDR_GET_LSIZE(hdr), hdr);
2400                 return;
2401         }
2402
2403         ASSERT(!GHOST_STATE(state));
2404         if (hdr->b_l1hdr.b_pabd != NULL) {
2405                 (void) refcount_remove_many(&state->arcs_esize[type],
2406                     arc_hdr_size(hdr), hdr);
2407         }
2408         for (arc_buf_t *buf = hdr->b_l1hdr.b_buf; buf != NULL;
2409             buf = buf->b_next) {
2410                 if (arc_buf_is_shared(buf))
2411                         continue;
2412                 (void) refcount_remove_many(&state->arcs_esize[type],
2413                     arc_buf_size(buf), buf);
2414         }
2415 }
2416
2417 /*
2418  * Add a reference to this hdr indicating that someone is actively
2419  * referencing that memory. When the refcount transitions from 0 to 1,
2420  * we remove it from the respective arc_state_t list to indicate that
2421  * it is not evictable.
2422  */
2423 static void
2424 add_reference(arc_buf_hdr_t *hdr, void *tag)
2425 {
2426         ASSERT(HDR_HAS_L1HDR(hdr));
2427         if (!MUTEX_HELD(HDR_LOCK(hdr))) {
2428                 ASSERT(hdr->b_l1hdr.b_state == arc_anon);
2429                 ASSERT(refcount_is_zero(&hdr->b_l1hdr.b_refcnt));
2430                 ASSERT3P(hdr->b_l1hdr.b_buf, ==, NULL);
2431         }
2432
2433         arc_state_t *state = hdr->b_l1hdr.b_state;
2434
2435         if ((refcount_add(&hdr->b_l1hdr.b_refcnt, tag) == 1) &&
2436             (state != arc_anon)) {
2437                 /* We don't use the L2-only state list. */
2438                 if (state != arc_l2c_only) {
2439                         multilist_remove(state->arcs_list[arc_buf_type(hdr)],
2440                             hdr);
2441                         arc_evictable_space_decrement(hdr, state);
2442                 }
2443                 /* remove the prefetch flag if we get a reference */
2444                 arc_hdr_clear_flags(hdr, ARC_FLAG_PREFETCH);
2445         }
2446 }
2447
2448 /*
2449  * Remove a reference from this hdr. When the reference transitions from
2450  * 1 to 0 and we're not anonymous, then we add this hdr to the arc_state_t's
2451  * list making it eligible for eviction.
2452  */
2453 static int
2454 remove_reference(arc_buf_hdr_t *hdr, kmutex_t *hash_lock, void *tag)
2455 {
2456         int cnt;
2457         arc_state_t *state = hdr->b_l1hdr.b_state;
2458
2459         ASSERT(HDR_HAS_L1HDR(hdr));
2460         ASSERT(state == arc_anon || MUTEX_HELD(hash_lock));
2461         ASSERT(!GHOST_STATE(state));
2462
2463         /*
2464          * arc_l2c_only counts as a ghost state so we don't need to explicitly
2465          * check to prevent usage of the arc_l2c_only list.
2466          */
2467         if (((cnt = refcount_remove(&hdr->b_l1hdr.b_refcnt, tag)) == 0) &&
2468             (state != arc_anon)) {
2469                 multilist_insert(state->arcs_list[arc_buf_type(hdr)], hdr);
2470                 ASSERT3U(hdr->b_l1hdr.b_bufcnt, >, 0);
2471                 arc_evictable_space_increment(hdr, state);
2472         }
2473         return (cnt);
2474 }
2475
2476 /*
2477  * Move the supplied buffer to the indicated state. The hash lock
2478  * for the buffer must be held by the caller.
2479  */
2480 static void
2481 arc_change_state(arc_state_t *new_state, arc_buf_hdr_t *hdr,
2482     kmutex_t *hash_lock)
2483 {
2484         arc_state_t *old_state;
2485         int64_t refcnt;
2486         uint32_t bufcnt;
2487         boolean_t update_old, update_new;
2488         arc_buf_contents_t buftype = arc_buf_type(hdr);
2489
2490         /*
2491          * We almost always have an L1 hdr here, since we call arc_hdr_realloc()
2492          * in arc_read() when bringing a buffer out of the L2ARC.  However, the
2493          * L1 hdr doesn't always exist when we change state to arc_anon before
2494          * destroying a header, in which case reallocating to add the L1 hdr is
2495          * pointless.
2496          */
2497         if (HDR_HAS_L1HDR(hdr)) {
2498                 old_state = hdr->b_l1hdr.b_state;
2499                 refcnt = refcount_count(&hdr->b_l1hdr.b_refcnt);
2500                 bufcnt = hdr->b_l1hdr.b_bufcnt;
2501                 update_old = (bufcnt > 0 || hdr->b_l1hdr.b_pabd != NULL);
2502         } else {
2503                 old_state = arc_l2c_only;
2504                 refcnt = 0;
2505                 bufcnt = 0;
2506                 update_old = B_FALSE;
2507         }
2508         update_new = update_old;
2509
2510         ASSERT(MUTEX_HELD(hash_lock));
2511         ASSERT3P(new_state, !=, old_state);
2512         ASSERT(!GHOST_STATE(new_state) || bufcnt == 0);
2513         ASSERT(old_state != arc_anon || bufcnt <= 1);
2514
2515         /*
2516          * If this buffer is evictable, transfer it from the
2517          * old state list to the new state list.
2518          */
2519         if (refcnt == 0) {
2520                 if (old_state != arc_anon && old_state != arc_l2c_only) {
2521                         ASSERT(HDR_HAS_L1HDR(hdr));
2522                         multilist_remove(old_state->arcs_list[buftype], hdr);
2523
2524                         if (GHOST_STATE(old_state)) {
2525                                 ASSERT0(bufcnt);
2526                                 ASSERT3P(hdr->b_l1hdr.b_buf, ==, NULL);
2527                                 update_old = B_TRUE;
2528                         }
2529                         arc_evictable_space_decrement(hdr, old_state);
2530                 }
2531                 if (new_state != arc_anon && new_state != arc_l2c_only) {
2532
2533                         /*
2534                          * An L1 header always exists here, since if we're
2535                          * moving to some L1-cached state (i.e. not l2c_only or
2536                          * anonymous), we realloc the header to add an L1hdr
2537                          * beforehand.
2538                          */
2539                         ASSERT(HDR_HAS_L1HDR(hdr));
2540                         multilist_insert(new_state->arcs_list[buftype], hdr);
2541
2542                         if (GHOST_STATE(new_state)) {
2543                                 ASSERT0(bufcnt);
2544                                 ASSERT3P(hdr->b_l1hdr.b_buf, ==, NULL);
2545                                 update_new = B_TRUE;
2546                         }
2547                         arc_evictable_space_increment(hdr, new_state);
2548                 }
2549         }
2550
2551         ASSERT(!HDR_EMPTY(hdr));
2552         if (new_state == arc_anon && HDR_IN_HASH_TABLE(hdr))
2553                 buf_hash_remove(hdr);
2554
2555         /* adjust state sizes (ignore arc_l2c_only) */
2556
2557         if (update_new && new_state != arc_l2c_only) {
2558                 ASSERT(HDR_HAS_L1HDR(hdr));
2559                 if (GHOST_STATE(new_state)) {
2560                         ASSERT0(bufcnt);
2561
2562                         /*
2563                          * When moving a header to a ghost state, we first
2564                          * remove all arc buffers. Thus, we'll have a
2565                          * bufcnt of zero, and no arc buffer to use for
2566                          * the reference. As a result, we use the arc
2567                          * header pointer for the reference.
2568                          */
2569                         (void) refcount_add_many(&new_state->arcs_size,
2570                             HDR_GET_LSIZE(hdr), hdr);
2571                         ASSERT3P(hdr->b_l1hdr.b_pabd, ==, NULL);
2572                 } else {
2573                         uint32_t buffers = 0;
2574
2575                         /*
2576                          * Each individual buffer holds a unique reference,
2577                          * thus we must remove each of these references one
2578                          * at a time.
2579                          */
2580                         for (arc_buf_t *buf = hdr->b_l1hdr.b_buf; buf != NULL;
2581                             buf = buf->b_next) {
2582                                 ASSERT3U(bufcnt, !=, 0);
2583                                 buffers++;
2584
2585                                 /*
2586                                  * When the arc_buf_t is sharing the data
2587                                  * block with the hdr, the owner of the
2588                                  * reference belongs to the hdr. Only
2589                                  * add to the refcount if the arc_buf_t is
2590                                  * not shared.
2591                                  */
2592                                 if (arc_buf_is_shared(buf))
2593                                         continue;
2594
2595                                 (void) refcount_add_many(&new_state->arcs_size,
2596                                     arc_buf_size(buf), buf);
2597                         }
2598                         ASSERT3U(bufcnt, ==, buffers);
2599
2600                         if (hdr->b_l1hdr.b_pabd != NULL) {
2601                                 (void) refcount_add_many(&new_state->arcs_size,
2602                                     arc_hdr_size(hdr), hdr);
2603                         } else {
2604                                 ASSERT(GHOST_STATE(old_state));
2605                         }
2606                 }
2607         }
2608
2609         if (update_old && old_state != arc_l2c_only) {
2610                 ASSERT(HDR_HAS_L1HDR(hdr));
2611                 if (GHOST_STATE(old_state)) {
2612                         ASSERT0(bufcnt);
2613                         ASSERT3P(hdr->b_l1hdr.b_pabd, ==, NULL);
2614
2615                         /*
2616                          * When moving a header off of a ghost state,
2617                          * the header will not contain any arc buffers.
2618                          * We use the arc header pointer for the reference
2619                          * which is exactly what we did when we put the
2620                          * header on the ghost state.
2621                          */
2622
2623                         (void) refcount_remove_many(&old_state->arcs_size,
2624                             HDR_GET_LSIZE(hdr), hdr);
2625                 } else {
2626                         uint32_t buffers = 0;
2627
2628                         /*
2629                          * Each individual buffer holds a unique reference,
2630                          * thus we must remove each of these references one
2631                          * at a time.
2632                          */
2633                         for (arc_buf_t *buf = hdr->b_l1hdr.b_buf; buf != NULL;
2634                             buf = buf->b_next) {
2635                                 ASSERT3U(bufcnt, !=, 0);
2636                                 buffers++;
2637
2638                                 /*
2639                                  * When the arc_buf_t is sharing the data
2640                                  * block with the hdr, the owner of the
2641                                  * reference belongs to the hdr. Only
2642                                  * add to the refcount if the arc_buf_t is
2643                                  * not shared.
2644                                  */
2645                                 if (arc_buf_is_shared(buf))
2646                                         continue;
2647
2648                                 (void) refcount_remove_many(
2649                                     &old_state->arcs_size, arc_buf_size(buf),
2650                                     buf);
2651                         }
2652                         ASSERT3U(bufcnt, ==, buffers);
2653                         ASSERT3P(hdr->b_l1hdr.b_pabd, !=, NULL);
2654                         (void) refcount_remove_many(
2655                             &old_state->arcs_size, arc_hdr_size(hdr), hdr);
2656                 }
2657         }
2658
2659         if (HDR_HAS_L1HDR(hdr))
2660                 hdr->b_l1hdr.b_state = new_state;
2661
2662         /*
2663          * L2 headers should never be on the L2 state list since they don't
2664          * have L1 headers allocated.
2665          */
2666         ASSERT(multilist_is_empty(arc_l2c_only->arcs_list[ARC_BUFC_DATA]) &&
2667             multilist_is_empty(arc_l2c_only->arcs_list[ARC_BUFC_METADATA]));
2668 }
2669
2670 void
2671 arc_space_consume(uint64_t space, arc_space_type_t type)
2672 {
2673         ASSERT(type >= 0 && type < ARC_SPACE_NUMTYPES);
2674
2675         switch (type) {
2676         case ARC_SPACE_DATA:
2677                 aggsum_add(&astat_data_size, space);
2678                 break;
2679         case ARC_SPACE_META:
2680                 aggsum_add(&astat_metadata_size, space);
2681                 break;
2682         case ARC_SPACE_OTHER:
2683                 aggsum_add(&astat_other_size, space);
2684                 break;
2685         case ARC_SPACE_HDRS:
2686                 aggsum_add(&astat_hdr_size, space);
2687                 break;
2688         case ARC_SPACE_L2HDRS:
2689                 aggsum_add(&astat_l2_hdr_size, space);
2690                 break;
2691         }
2692
2693         if (type != ARC_SPACE_DATA)
2694                 aggsum_add(&arc_meta_used, space);
2695
2696         aggsum_add(&arc_size, space);
2697 }
2698
2699 void
2700 arc_space_return(uint64_t space, arc_space_type_t type)
2701 {
2702         ASSERT(type >= 0 && type < ARC_SPACE_NUMTYPES);
2703
2704         switch (type) {
2705         case ARC_SPACE_DATA:
2706                 aggsum_add(&astat_data_size, -space);
2707                 break;
2708         case ARC_SPACE_META:
2709                 aggsum_add(&astat_metadata_size, -space);
2710                 break;
2711         case ARC_SPACE_OTHER:
2712                 aggsum_add(&astat_other_size, -space);
2713                 break;
2714         case ARC_SPACE_HDRS:
2715                 aggsum_add(&astat_hdr_size, -space);
2716                 break;
2717         case ARC_SPACE_L2HDRS:
2718                 aggsum_add(&astat_l2_hdr_size, -space);
2719                 break;
2720         }
2721
2722         if (type != ARC_SPACE_DATA) {
2723                 ASSERT(aggsum_compare(&arc_meta_used, space) >= 0);
2724                 /*
2725                  * We use the upper bound here rather than the precise value
2726                  * because the arc_meta_max value doesn't need to be
2727                  * precise. It's only consumed by humans via arcstats.
2728                  */
2729                 if (arc_meta_max < aggsum_upper_bound(&arc_meta_used))
2730                         arc_meta_max = aggsum_upper_bound(&arc_meta_used);
2731                 aggsum_add(&arc_meta_used, -space);
2732         }
2733
2734         ASSERT(aggsum_compare(&arc_size, space) >= 0);
2735         aggsum_add(&arc_size, -space);
2736 }
2737
2738 /*
2739  * Given a hdr and a buf, returns whether that buf can share its b_data buffer
2740  * with the hdr's b_pabd.
2741  */
2742 static boolean_t
2743 arc_can_share(arc_buf_hdr_t *hdr, arc_buf_t *buf)
2744 {
2745         /*
2746          * The criteria for sharing a hdr's data are:
2747          * 1. the hdr's compression matches the buf's compression
2748          * 2. the hdr doesn't need to be byteswapped
2749          * 3. the hdr isn't already being shared
2750          * 4. the buf is either compressed or it is the last buf in the hdr list
2751          *
2752          * Criterion #4 maintains the invariant that shared uncompressed
2753          * bufs must be the final buf in the hdr's b_buf list. Reading this, you
2754          * might ask, "if a compressed buf is allocated first, won't that be the
2755          * last thing in the list?", but in that case it's impossible to create
2756          * a shared uncompressed buf anyway (because the hdr must be compressed
2757          * to have the compressed buf). You might also think that #3 is
2758          * sufficient to make this guarantee, however it's possible
2759          * (specifically in the rare L2ARC write race mentioned in
2760          * arc_buf_alloc_impl()) there will be an existing uncompressed buf that
2761          * is sharable, but wasn't at the time of its allocation. Rather than
2762          * allow a new shared uncompressed buf to be created and then shuffle
2763          * the list around to make it the last element, this simply disallows
2764          * sharing if the new buf isn't the first to be added.
2765          */
2766         ASSERT3P(buf->b_hdr, ==, hdr);
2767         boolean_t hdr_compressed = HDR_GET_COMPRESS(hdr) != ZIO_COMPRESS_OFF;
2768         boolean_t buf_compressed = ARC_BUF_COMPRESSED(buf) != 0;
2769         return (buf_compressed == hdr_compressed &&
2770             hdr->b_l1hdr.b_byteswap == DMU_BSWAP_NUMFUNCS &&
2771             !HDR_SHARED_DATA(hdr) &&
2772             (ARC_BUF_LAST(buf) || ARC_BUF_COMPRESSED(buf)));
2773 }
2774
2775 /*
2776  * Allocate a buf for this hdr. If you care about the data that's in the hdr,
2777  * or if you want a compressed buffer, pass those flags in. Returns 0 if the
2778  * copy was made successfully, or an error code otherwise.
2779  */
2780 static int
2781 arc_buf_alloc_impl(arc_buf_hdr_t *hdr, void *tag, boolean_t compressed,
2782     boolean_t fill, arc_buf_t **ret)
2783 {
2784         arc_buf_t *buf;
2785
2786         ASSERT(HDR_HAS_L1HDR(hdr));
2787         ASSERT3U(HDR_GET_LSIZE(hdr), >, 0);
2788         VERIFY(hdr->b_type == ARC_BUFC_DATA ||
2789             hdr->b_type == ARC_BUFC_METADATA);
2790         ASSERT3P(ret, !=, NULL);
2791         ASSERT3P(*ret, ==, NULL);
2792
2793         buf = *ret = kmem_cache_alloc(buf_cache, KM_PUSHPAGE);
2794         buf->b_hdr = hdr;
2795         buf->b_data = NULL;
2796         buf->b_next = hdr->b_l1hdr.b_buf;
2797         buf->b_flags = 0;
2798
2799         add_reference(hdr, tag);
2800
2801         /*
2802          * We're about to change the hdr's b_flags. We must either
2803          * hold the hash_lock or be undiscoverable.
2804          */
2805         ASSERT(MUTEX_HELD(HDR_LOCK(hdr)) || HDR_EMPTY(hdr));
2806
2807         /*
2808          * Only honor requests for compressed bufs if the hdr is actually
2809          * compressed.
2810          */
2811         if (compressed && HDR_GET_COMPRESS(hdr) != ZIO_COMPRESS_OFF)
2812                 buf->b_flags |= ARC_BUF_FLAG_COMPRESSED;
2813
2814         /*
2815          * If the hdr's data can be shared then we share the data buffer and
2816          * set the appropriate bit in the hdr's b_flags to indicate the hdr is
2817          * sharing it's b_pabd with the arc_buf_t. Otherwise, we allocate a new
2818          * buffer to store the buf's data.
2819          *
2820          * There are two additional restrictions here because we're sharing
2821          * hdr -> buf instead of the usual buf -> hdr. First, the hdr can't be
2822          * actively involved in an L2ARC write, because if this buf is used by
2823          * an arc_write() then the hdr's data buffer will be released when the
2824          * write completes, even though the L2ARC write might still be using it.
2825          * Second, the hdr's ABD must be linear so that the buf's user doesn't
2826          * need to be ABD-aware.
2827          */
2828         boolean_t can_share = arc_can_share(hdr, buf) && !HDR_L2_WRITING(hdr) &&
2829             abd_is_linear(hdr->b_l1hdr.b_pabd);
2830
2831         /* Set up b_data and sharing */
2832         if (can_share) {
2833                 buf->b_data = abd_to_buf(hdr->b_l1hdr.b_pabd);
2834                 buf->b_flags |= ARC_BUF_FLAG_SHARED;
2835                 arc_hdr_set_flags(hdr, ARC_FLAG_SHARED_DATA);
2836         } else {
2837                 buf->b_data =
2838                     arc_get_data_buf(hdr, arc_buf_size(buf), buf);
2839                 ARCSTAT_INCR(arcstat_overhead_size, arc_buf_size(buf));
2840         }
2841         VERIFY3P(buf->b_data, !=, NULL);
2842
2843         hdr->b_l1hdr.b_buf = buf;
2844         hdr->b_l1hdr.b_bufcnt += 1;
2845
2846         /*
2847          * If the user wants the data from the hdr, we need to either copy or
2848          * decompress the data.
2849          */
2850         if (fill) {
2851                 return (arc_buf_fill(buf, ARC_BUF_COMPRESSED(buf) != 0));
2852         }
2853
2854         return (0);
2855 }
2856
2857 static char *arc_onloan_tag = "onloan";
2858
2859 static inline void
2860 arc_loaned_bytes_update(int64_t delta)
2861 {
2862         atomic_add_64(&arc_loaned_bytes, delta);
2863
2864         /* assert that it did not wrap around */
2865         ASSERT3S(atomic_add_64_nv(&arc_loaned_bytes, 0), >=, 0);
2866 }
2867
2868 /*
2869  * Loan out an anonymous arc buffer. Loaned buffers are not counted as in
2870  * flight data by arc_tempreserve_space() until they are "returned". Loaned
2871  * buffers must be returned to the arc before they can be used by the DMU or
2872  * freed.
2873  */
2874 arc_buf_t *
2875 arc_loan_buf(spa_t *spa, boolean_t is_metadata, int size)
2876 {
2877         arc_buf_t *buf = arc_alloc_buf(spa, arc_onloan_tag,
2878             is_metadata ? ARC_BUFC_METADATA : ARC_BUFC_DATA, size);
2879
2880         arc_loaned_bytes_update(size);
2881
2882         return (buf);
2883 }
2884
2885 arc_buf_t *
2886 arc_loan_compressed_buf(spa_t *spa, uint64_t psize, uint64_t lsize,
2887     enum zio_compress compression_type)
2888 {
2889         arc_buf_t *buf = arc_alloc_compressed_buf(spa, arc_onloan_tag,
2890             psize, lsize, compression_type);
2891
2892         arc_loaned_bytes_update(psize);
2893
2894         return (buf);
2895 }
2896
2897
2898 /*
2899  * Return a loaned arc buffer to the arc.
2900  */
2901 void
2902 arc_return_buf(arc_buf_t *buf, void *tag)
2903 {
2904         arc_buf_hdr_t *hdr = buf->b_hdr;
2905
2906         ASSERT3P(buf->b_data, !=, NULL);
2907         ASSERT(HDR_HAS_L1HDR(hdr));
2908         (void) refcount_add(&hdr->b_l1hdr.b_refcnt, tag);
2909         (void) refcount_remove(&hdr->b_l1hdr.b_refcnt, arc_onloan_tag);
2910
2911         arc_loaned_bytes_update(-arc_buf_size(buf));
2912 }
2913
2914 /* Detach an arc_buf from a dbuf (tag) */
2915 void
2916 arc_loan_inuse_buf(arc_buf_t *buf, void *tag)
2917 {
2918         arc_buf_hdr_t *hdr = buf->b_hdr;
2919
2920         ASSERT3P(buf->b_data, !=, NULL);
2921         ASSERT(HDR_HAS_L1HDR(hdr));
2922         (void) refcount_add(&hdr->b_l1hdr.b_refcnt, arc_onloan_tag);
2923         (void) refcount_remove(&hdr->b_l1hdr.b_refcnt, tag);
2924
2925         arc_loaned_bytes_update(arc_buf_size(buf));
2926 }
2927
2928 static void
2929 l2arc_free_abd_on_write(abd_t *abd, size_t size, arc_buf_contents_t type)
2930 {
2931         l2arc_data_free_t *df = kmem_alloc(sizeof (*df), KM_SLEEP);
2932
2933         df->l2df_abd = abd;
2934         df->l2df_size = size;
2935         df->l2df_type = type;
2936         mutex_enter(&l2arc_free_on_write_mtx);
2937         list_insert_head(l2arc_free_on_write, df);
2938         mutex_exit(&l2arc_free_on_write_mtx);
2939 }
2940
2941 static void
2942 arc_hdr_free_on_write(arc_buf_hdr_t *hdr)
2943 {
2944         arc_state_t *state = hdr->b_l1hdr.b_state;
2945         arc_buf_contents_t type = arc_buf_type(hdr);
2946         uint64_t size = arc_hdr_size(hdr);
2947
2948         /* protected by hash lock, if in the hash table */
2949         if (multilist_link_active(&hdr->b_l1hdr.b_arc_node)) {
2950                 ASSERT(refcount_is_zero(&hdr->b_l1hdr.b_refcnt));
2951                 ASSERT(state != arc_anon && state != arc_l2c_only);
2952
2953                 (void) refcount_remove_many(&state->arcs_esize[type],
2954                     size, hdr);
2955         }
2956         (void) refcount_remove_many(&state->arcs_size, size, hdr);
2957         if (type == ARC_BUFC_METADATA) {
2958                 arc_space_return(size, ARC_SPACE_META);
2959         } else {
2960                 ASSERT(type == ARC_BUFC_DATA);
2961                 arc_space_return(size, ARC_SPACE_DATA);
2962         }
2963
2964         l2arc_free_abd_on_write(hdr->b_l1hdr.b_pabd, size, type);
2965 }
2966
2967 /*
2968  * Share the arc_buf_t's data with the hdr. Whenever we are sharing the
2969  * data buffer, we transfer the refcount ownership to the hdr and update
2970  * the appropriate kstats.
2971  */
2972 static void
2973 arc_share_buf(arc_buf_hdr_t *hdr, arc_buf_t *buf)
2974 {
2975         arc_state_t *state = hdr->b_l1hdr.b_state;
2976
2977         ASSERT(arc_can_share(hdr, buf));
2978         ASSERT3P(hdr->b_l1hdr.b_pabd, ==, NULL);
2979         ASSERT(MUTEX_HELD(HDR_LOCK(hdr)) || HDR_EMPTY(hdr));
2980
2981         /*
2982          * Start sharing the data buffer. We transfer the
2983          * refcount ownership to the hdr since it always owns
2984          * the refcount whenever an arc_buf_t is shared.
2985          */
2986         refcount_transfer_ownership(&state->arcs_size, buf, hdr);
2987         hdr->b_l1hdr.b_pabd = abd_get_from_buf(buf->b_data, arc_buf_size(buf));
2988         abd_take_ownership_of_buf(hdr->b_l1hdr.b_pabd,
2989             HDR_ISTYPE_METADATA(hdr));
2990         arc_hdr_set_flags(hdr, ARC_FLAG_SHARED_DATA);
2991         buf->b_flags |= ARC_BUF_FLAG_SHARED;
2992
2993         /*
2994          * Since we've transferred ownership to the hdr we need
2995          * to increment its compressed and uncompressed kstats and
2996          * decrement the overhead size.
2997          */
2998         ARCSTAT_INCR(arcstat_compressed_size, arc_hdr_size(hdr));
2999         ARCSTAT_INCR(arcstat_uncompressed_size, HDR_GET_LSIZE(hdr));
3000         ARCSTAT_INCR(arcstat_overhead_size, -arc_buf_size(buf));
3001 }
3002
3003 static void
3004 arc_unshare_buf(arc_buf_hdr_t *hdr, arc_buf_t *buf)
3005 {
3006         arc_state_t *state = hdr->b_l1hdr.b_state;
3007
3008         ASSERT(arc_buf_is_shared(buf));
3009         ASSERT3P(hdr->b_l1hdr.b_pabd, !=, NULL);
3010         ASSERT(MUTEX_HELD(HDR_LOCK(hdr)) || HDR_EMPTY(hdr));
3011
3012         /*
3013          * We are no longer sharing this buffer so we need
3014          * to transfer its ownership to the rightful owner.
3015          */
3016         refcount_transfer_ownership(&state->arcs_size, hdr, buf);
3017         arc_hdr_clear_flags(hdr, ARC_FLAG_SHARED_DATA);
3018         abd_release_ownership_of_buf(hdr->b_l1hdr.b_pabd);
3019         abd_put(hdr->b_l1hdr.b_pabd);
3020         hdr->b_l1hdr.b_pabd = NULL;
3021         buf->b_flags &= ~ARC_BUF_FLAG_SHARED;
3022
3023         /*
3024          * Since the buffer is no longer shared between
3025          * the arc buf and the hdr, count it as overhead.
3026          */
3027         ARCSTAT_INCR(arcstat_compressed_size, -arc_hdr_size(hdr));
3028         ARCSTAT_INCR(arcstat_uncompressed_size, -HDR_GET_LSIZE(hdr));
3029         ARCSTAT_INCR(arcstat_overhead_size, arc_buf_size(buf));
3030 }
3031
3032 /*
3033  * Remove an arc_buf_t from the hdr's buf list and return the last
3034  * arc_buf_t on the list. If no buffers remain on the list then return
3035  * NULL.
3036  */
3037 static arc_buf_t *
3038 arc_buf_remove(arc_buf_hdr_t *hdr, arc_buf_t *buf)
3039 {
3040         ASSERT(HDR_HAS_L1HDR(hdr));
3041         ASSERT(MUTEX_HELD(HDR_LOCK(hdr)) || HDR_EMPTY(hdr));
3042
3043         arc_buf_t **bufp = &hdr->b_l1hdr.b_buf;
3044         arc_buf_t *lastbuf = NULL;
3045
3046         /*
3047          * Remove the buf from the hdr list and locate the last
3048          * remaining buffer on the list.
3049          */
3050         while (*bufp != NULL) {
3051                 if (*bufp == buf)
3052                         *bufp = buf->b_next;
3053
3054                 /*
3055                  * If we've removed a buffer in the middle of
3056                  * the list then update the lastbuf and update
3057                  * bufp.
3058                  */
3059                 if (*bufp != NULL) {
3060                         lastbuf = *bufp;
3061                         bufp = &(*bufp)->b_next;
3062                 }
3063         }
3064         buf->b_next = NULL;
3065         ASSERT3P(lastbuf, !=, buf);
3066         IMPLY(hdr->b_l1hdr.b_bufcnt > 0, lastbuf != NULL);
3067         IMPLY(hdr->b_l1hdr.b_bufcnt > 0, hdr->b_l1hdr.b_buf != NULL);
3068         IMPLY(lastbuf != NULL, ARC_BUF_LAST(lastbuf));
3069
3070         return (lastbuf);
3071 }
3072
3073 /*
3074  * Free up buf->b_data and pull the arc_buf_t off of the the arc_buf_hdr_t's
3075  * list and free it.
3076  */
3077 static void
3078 arc_buf_destroy_impl(arc_buf_t *buf)
3079 {
3080         arc_buf_hdr_t *hdr = buf->b_hdr;
3081
3082         /*
3083          * Free up the data associated with the buf but only if we're not
3084          * sharing this with the hdr. If we are sharing it with the hdr, the
3085          * hdr is responsible for doing the free.
3086          */
3087         if (buf->b_data != NULL) {
3088                 /*
3089                  * We're about to change the hdr's b_flags. We must either
3090                  * hold the hash_lock or be undiscoverable.
3091                  */
3092                 ASSERT(MUTEX_HELD(HDR_LOCK(hdr)) || HDR_EMPTY(hdr));
3093
3094                 arc_cksum_verify(buf);
3095 #ifdef illumos
3096                 arc_buf_unwatch(buf);
3097 #endif
3098
3099                 if (arc_buf_is_shared(buf)) {
3100                         arc_hdr_clear_flags(hdr, ARC_FLAG_SHARED_DATA);
3101                 } else {
3102                         uint64_t size = arc_buf_size(buf);
3103                         arc_free_data_buf(hdr, buf->b_data, size, buf);
3104                         ARCSTAT_INCR(arcstat_overhead_size, -size);
3105                 }
3106                 buf->b_data = NULL;
3107
3108                 ASSERT(hdr->b_l1hdr.b_bufcnt > 0);
3109                 hdr->b_l1hdr.b_bufcnt -= 1;
3110         }
3111
3112         arc_buf_t *lastbuf = arc_buf_remove(hdr, buf);
3113
3114         if (ARC_BUF_SHARED(buf) && !ARC_BUF_COMPRESSED(buf)) {
3115                 /*
3116                  * If the current arc_buf_t is sharing its data buffer with the
3117                  * hdr, then reassign the hdr's b_pabd to share it with the new
3118                  * buffer at the end of the list. The shared buffer is always
3119                  * the last one on the hdr's buffer list.
3120                  *
3121                  * There is an equivalent case for compressed bufs, but since
3122                  * they aren't guaranteed to be the last buf in the list and
3123                  * that is an exceedingly rare case, we just allow that space be
3124                  * wasted temporarily.
3125                  */
3126                 if (lastbuf != NULL) {
3127                         /* Only one buf can be shared at once */
3128                         VERIFY(!arc_buf_is_shared(lastbuf));
3129                         /* hdr is uncompressed so can't have compressed buf */
3130                         VERIFY(!ARC_BUF_COMPRESSED(lastbuf));
3131
3132                         ASSERT3P(hdr->b_l1hdr.b_pabd, !=, NULL);
3133                         arc_hdr_free_pabd(hdr);
3134
3135                         /*
3136                          * We must setup a new shared block between the
3137                          * last buffer and the hdr. The data would have
3138                          * been allocated by the arc buf so we need to transfer
3139                          * ownership to the hdr since it's now being shared.
3140                          */
3141                         arc_share_buf(hdr, lastbuf);
3142                 }
3143         } else if (HDR_SHARED_DATA(hdr)) {
3144                 /*
3145                  * Uncompressed shared buffers are always at the end
3146                  * of the list. Compressed buffers don't have the
3147                  * same requirements. This makes it hard to
3148                  * simply assert that the lastbuf is shared so
3149                  * we rely on the hdr's compression flags to determine
3150                  * if we have a compressed, shared buffer.
3151                  */
3152                 ASSERT3P(lastbuf, !=, NULL);
3153                 ASSERT(arc_buf_is_shared(lastbuf) ||
3154                     HDR_GET_COMPRESS(hdr) != ZIO_COMPRESS_OFF);
3155         }
3156
3157         /*
3158          * Free the checksum if we're removing the last uncompressed buf from
3159          * this hdr.
3160          */
3161         if (!arc_hdr_has_uncompressed_buf(hdr)) {
3162                 arc_cksum_free(hdr);
3163         }
3164
3165         /* clean up the buf */
3166         buf->b_hdr = NULL;
3167         kmem_cache_free(buf_cache, buf);
3168 }
3169
3170 static void
3171 arc_hdr_alloc_pabd(arc_buf_hdr_t *hdr)
3172 {
3173         ASSERT3U(HDR_GET_LSIZE(hdr), >, 0);
3174         ASSERT(HDR_HAS_L1HDR(hdr));
3175         ASSERT(!HDR_SHARED_DATA(hdr));
3176
3177         ASSERT3P(hdr->b_l1hdr.b_pabd, ==, NULL);
3178         hdr->b_l1hdr.b_pabd = arc_get_data_abd(hdr, arc_hdr_size(hdr), hdr);
3179         hdr->b_l1hdr.b_byteswap = DMU_BSWAP_NUMFUNCS;
3180         ASSERT3P(hdr->b_l1hdr.b_pabd, !=, NULL);
3181
3182         ARCSTAT_INCR(arcstat_compressed_size, arc_hdr_size(hdr));
3183         ARCSTAT_INCR(arcstat_uncompressed_size, HDR_GET_LSIZE(hdr));
3184 }
3185
3186 static void
3187 arc_hdr_free_pabd(arc_buf_hdr_t *hdr)
3188 {
3189         ASSERT(HDR_HAS_L1HDR(hdr));
3190         ASSERT3P(hdr->b_l1hdr.b_pabd, !=, NULL);
3191
3192         /*
3193          * If the hdr is currently being written to the l2arc then
3194          * we defer freeing the data by adding it to the l2arc_free_on_write
3195          * list. The l2arc will free the data once it's finished
3196          * writing it to the l2arc device.
3197          */
3198         if (HDR_L2_WRITING(hdr)) {
3199                 arc_hdr_free_on_write(hdr);
3200                 ARCSTAT_BUMP(arcstat_l2_free_on_write);
3201         } else {
3202                 arc_free_data_abd(hdr, hdr->b_l1hdr.b_pabd,
3203                     arc_hdr_size(hdr), hdr);
3204         }
3205         hdr->b_l1hdr.b_pabd = NULL;
3206         hdr->b_l1hdr.b_byteswap = DMU_BSWAP_NUMFUNCS;
3207
3208         ARCSTAT_INCR(arcstat_compressed_size, -arc_hdr_size(hdr));
3209         ARCSTAT_INCR(arcstat_uncompressed_size, -HDR_GET_LSIZE(hdr));
3210 }
3211
3212 static arc_buf_hdr_t *
3213 arc_hdr_alloc(uint64_t spa, int32_t psize, int32_t lsize,
3214     enum zio_compress compression_type, arc_buf_contents_t type)
3215 {
3216         arc_buf_hdr_t *hdr;
3217
3218         VERIFY(type == ARC_BUFC_DATA || type == ARC_BUFC_METADATA);
3219
3220         hdr = kmem_cache_alloc(hdr_full_cache, KM_PUSHPAGE);
3221         ASSERT(HDR_EMPTY(hdr));
3222         ASSERT3P(hdr->b_l1hdr.b_freeze_cksum, ==, NULL);
3223         ASSERT3P(hdr->b_l1hdr.b_thawed, ==, NULL);
3224         HDR_SET_PSIZE(hdr, psize);
3225         HDR_SET_LSIZE(hdr, lsize);
3226         hdr->b_spa = spa;
3227         hdr->b_type = type;
3228         hdr->b_flags = 0;
3229         arc_hdr_set_flags(hdr, arc_bufc_to_flags(type) | ARC_FLAG_HAS_L1HDR);
3230         arc_hdr_set_compress(hdr, compression_type);
3231
3232         hdr->b_l1hdr.b_state = arc_anon;
3233         hdr->b_l1hdr.b_arc_access = 0;
3234         hdr->b_l1hdr.b_bufcnt = 0;
3235         hdr->b_l1hdr.b_buf = NULL;
3236
3237         /*
3238          * Allocate the hdr's buffer. This will contain either
3239          * the compressed or uncompressed data depending on the block
3240          * it references and compressed arc enablement.
3241          */
3242         arc_hdr_alloc_pabd(hdr);
3243         ASSERT(refcount_is_zero(&hdr->b_l1hdr.b_refcnt));
3244
3245         return (hdr);
3246 }
3247
3248 /*
3249  * Transition between the two allocation states for the arc_buf_hdr struct.
3250  * The arc_buf_hdr struct can be allocated with (hdr_full_cache) or without
3251  * (hdr_l2only_cache) the fields necessary for the L1 cache - the smaller
3252  * version is used when a cache buffer is only in the L2ARC in order to reduce
3253  * memory usage.
3254  */
3255 static arc_buf_hdr_t *
3256 arc_hdr_realloc(arc_buf_hdr_t *hdr, kmem_cache_t *old, kmem_cache_t *new)
3257 {
3258         ASSERT(HDR_HAS_L2HDR(hdr));
3259
3260         arc_buf_hdr_t *nhdr;
3261         l2arc_dev_t *dev = hdr->b_l2hdr.b_dev;
3262
3263         ASSERT((old == hdr_full_cache && new == hdr_l2only_cache) ||
3264             (old == hdr_l2only_cache && new == hdr_full_cache));
3265
3266         nhdr = kmem_cache_alloc(new, KM_PUSHPAGE);
3267
3268         ASSERT(MUTEX_HELD(HDR_LOCK(hdr)));
3269         buf_hash_remove(hdr);
3270
3271         bcopy(hdr, nhdr, HDR_L2ONLY_SIZE);
3272
3273         if (new == hdr_full_cache) {
3274                 arc_hdr_set_flags(nhdr, ARC_FLAG_HAS_L1HDR);
3275                 /*
3276                  * arc_access and arc_change_state need to be aware that a
3277                  * header has just come out of L2ARC, so we set its state to
3278                  * l2c_only even though it's about to change.
3279                  */
3280                 nhdr->b_l1hdr.b_state = arc_l2c_only;
3281
3282                 /* Verify previous threads set to NULL before freeing */
3283                 ASSERT3P(nhdr->b_l1hdr.b_pabd, ==, NULL);
3284         } else {
3285                 ASSERT3P(hdr->b_l1hdr.b_buf, ==, NULL);
3286                 ASSERT0(hdr->b_l1hdr.b_bufcnt);
3287                 ASSERT3P(hdr->b_l1hdr.b_freeze_cksum, ==, NULL);
3288
3289                 /*
3290                  * If we've reached here, We must have been called from
3291                  * arc_evict_hdr(), as such we should have already been
3292                  * removed from any ghost list we were previously on
3293                  * (which protects us from racing with arc_evict_state),
3294                  * thus no locking is needed during this check.
3295                  */
3296                 ASSERT(!multilist_link_active(&hdr->b_l1hdr.b_arc_node));
3297
3298                 /*
3299                  * A buffer must not be moved into the arc_l2c_only
3300                  * state if it's not finished being written out to the
3301                  * l2arc device. Otherwise, the b_l1hdr.b_pabd field
3302                  * might try to be accessed, even though it was removed.
3303                  */
3304                 VERIFY(!HDR_L2_WRITING(hdr));
3305                 VERIFY3P(hdr->b_l1hdr.b_pabd, ==, NULL);
3306
3307 #ifdef ZFS_DEBUG
3308                 if (hdr->b_l1hdr.b_thawed != NULL) {
3309                         kmem_free(hdr->b_l1hdr.b_thawed, 1);
3310                         hdr->b_l1hdr.b_thawed = NULL;
3311                 }
3312 #endif
3313
3314                 arc_hdr_clear_flags(nhdr, ARC_FLAG_HAS_L1HDR);
3315         }
3316         /*
3317          * The header has been reallocated so we need to re-insert it into any
3318          * lists it was on.
3319          */
3320         (void) buf_hash_insert(nhdr, NULL);
3321
3322         ASSERT(list_link_active(&hdr->b_l2hdr.b_l2node));
3323
3324         mutex_enter(&dev->l2ad_mtx);
3325
3326         /*
3327          * We must place the realloc'ed header back into the list at
3328          * the same spot. Otherwise, if it's placed earlier in the list,
3329          * l2arc_write_buffers() could find it during the function's
3330          * write phase, and try to write it out to the l2arc.
3331          */
3332         list_insert_after(&dev->l2ad_buflist, hdr, nhdr);
3333         list_remove(&dev->l2ad_buflist, hdr);
3334
3335         mutex_exit(&dev->l2ad_mtx);
3336
3337         /*
3338          * Since we're using the pointer address as the tag when
3339          * incrementing and decrementing the l2ad_alloc refcount, we
3340          * must remove the old pointer (that we're about to destroy) and
3341          * add the new pointer to the refcount. Otherwise we'd remove
3342          * the wrong pointer address when calling arc_hdr_destroy() later.
3343          */
3344
3345         (void) refcount_remove_many(&dev->l2ad_alloc, arc_hdr_size(hdr), hdr);
3346         (void) refcount_add_many(&dev->l2ad_alloc, arc_hdr_size(nhdr), nhdr);
3347
3348         buf_discard_identity(hdr);
3349         kmem_cache_free(old, hdr);
3350
3351         return (nhdr);
3352 }
3353
3354 /*
3355  * Allocate a new arc_buf_hdr_t and arc_buf_t and return the buf to the caller.
3356  * The buf is returned thawed since we expect the consumer to modify it.
3357  */
3358 arc_buf_t *
3359 arc_alloc_buf(spa_t *spa, void *tag, arc_buf_contents_t type, int32_t size)
3360 {
3361         arc_buf_hdr_t *hdr = arc_hdr_alloc(spa_load_guid(spa), size, size,
3362             ZIO_COMPRESS_OFF, type);
3363         ASSERT(!MUTEX_HELD(HDR_LOCK(hdr)));
3364
3365         arc_buf_t *buf = NULL;
3366         VERIFY0(arc_buf_alloc_impl(hdr, tag, B_FALSE, B_FALSE, &buf));
3367         arc_buf_thaw(buf);
3368
3369         return (buf);
3370 }
3371
3372 /*
3373  * Allocate a compressed buf in the same manner as arc_alloc_buf. Don't use this
3374  * for bufs containing metadata.
3375  */
3376 arc_buf_t *
3377 arc_alloc_compressed_buf(spa_t *spa, void *tag, uint64_t psize, uint64_t lsize,
3378     enum zio_compress compression_type)
3379 {
3380         ASSERT3U(lsize, >, 0);
3381         ASSERT3U(lsize, >=, psize);
3382         ASSERT(compression_type > ZIO_COMPRESS_OFF);
3383         ASSERT(compression_type < ZIO_COMPRESS_FUNCTIONS);
3384
3385         arc_buf_hdr_t *hdr = arc_hdr_alloc(spa_load_guid(spa), psize, lsize,
3386             compression_type, ARC_BUFC_DATA);
3387         ASSERT(!MUTEX_HELD(HDR_LOCK(hdr)));
3388
3389         arc_buf_t *buf = NULL;
3390         VERIFY0(arc_buf_alloc_impl(hdr, tag, B_TRUE, B_FALSE, &buf));
3391         arc_buf_thaw(buf);
3392         ASSERT3P(hdr->b_l1hdr.b_freeze_cksum, ==, NULL);
3393
3394         if (!arc_buf_is_shared(buf)) {
3395                 /*
3396                  * To ensure that the hdr has the correct data in it if we call
3397                  * arc_decompress() on this buf before it's been written to
3398                  * disk, it's easiest if we just set up sharing between the
3399                  * buf and the hdr.
3400                  */
3401                 ASSERT(!abd_is_linear(hdr->b_l1hdr.b_pabd));
3402                 arc_hdr_free_pabd(hdr);
3403                 arc_share_buf(hdr, buf);
3404         }
3405
3406         return (buf);
3407 }
3408
3409 static void
3410 arc_hdr_l2hdr_destroy(arc_buf_hdr_t *hdr)
3411 {
3412         l2arc_buf_hdr_t *l2hdr = &hdr->b_l2hdr;
3413         l2arc_dev_t *dev = l2hdr->b_dev;
3414         uint64_t psize = arc_hdr_size(hdr);
3415
3416         ASSERT(MUTEX_HELD(&dev->l2ad_mtx));
3417         ASSERT(HDR_HAS_L2HDR(hdr));
3418
3419         list_remove(&dev->l2ad_buflist, hdr);
3420
3421         ARCSTAT_INCR(arcstat_l2_psize, -psize);
3422         ARCSTAT_INCR(arcstat_l2_lsize, -HDR_GET_LSIZE(hdr));
3423
3424         vdev_space_update(dev->l2ad_vdev, -psize, 0, 0);
3425
3426         (void) refcount_remove_many(&dev->l2ad_alloc, psize, hdr);
3427         arc_hdr_clear_flags(hdr, ARC_FLAG_HAS_L2HDR);
3428 }
3429
3430 static void
3431 arc_hdr_destroy(arc_buf_hdr_t *hdr)
3432 {
3433         if (HDR_HAS_L1HDR(hdr)) {
3434                 ASSERT(hdr->b_l1hdr.b_buf == NULL ||
3435                     hdr->b_l1hdr.b_bufcnt > 0);
3436                 ASSERT(refcount_is_zero(&hdr->b_l1hdr.b_refcnt));
3437                 ASSERT3P(hdr->b_l1hdr.b_state, ==, arc_anon);
3438         }
3439         ASSERT(!HDR_IO_IN_PROGRESS(hdr));
3440         ASSERT(!HDR_IN_HASH_TABLE(hdr));
3441
3442         if (!HDR_EMPTY(hdr))
3443                 buf_discard_identity(hdr);
3444
3445         if (HDR_HAS_L2HDR(hdr)) {
3446                 l2arc_dev_t *dev = hdr->b_l2hdr.b_dev;
3447                 boolean_t buflist_held = MUTEX_HELD(&dev->l2ad_mtx);
3448
3449                 if (!buflist_held)
3450                         mutex_enter(&dev->l2ad_mtx);
3451
3452                 /*
3453                  * Even though we checked this conditional above, we
3454                  * need to check this again now that we have the
3455                  * l2ad_mtx. This is because we could be racing with
3456                  * another thread calling l2arc_evict() which might have
3457                  * destroyed this header's L2 portion as we were waiting
3458                  * to acquire the l2ad_mtx. If that happens, we don't
3459                  * want to re-destroy the header's L2 portion.
3460                  */
3461                 if (HDR_HAS_L2HDR(hdr)) {
3462                         l2arc_trim(hdr);
3463                         arc_hdr_l2hdr_destroy(hdr);
3464                 }
3465
3466                 if (!buflist_held)
3467                         mutex_exit(&dev->l2ad_mtx);
3468         }
3469
3470         if (HDR_HAS_L1HDR(hdr)) {
3471                 arc_cksum_free(hdr);
3472
3473                 while (hdr->b_l1hdr.b_buf != NULL)
3474                         arc_buf_destroy_impl(hdr->b_l1hdr.b_buf);
3475
3476 #ifdef ZFS_DEBUG
3477                 if (hdr->b_l1hdr.b_thawed != NULL) {
3478                         kmem_free(hdr->b_l1hdr.b_thawed, 1);
3479                         hdr->b_l1hdr.b_thawed = NULL;
3480                 }
3481 #endif
3482
3483                 if (hdr->b_l1hdr.b_pabd != NULL) {
3484                         arc_hdr_free_pabd(hdr);
3485                 }
3486         }
3487
3488         ASSERT3P(hdr->b_hash_next, ==, NULL);
3489         if (HDR_HAS_L1HDR(hdr)) {
3490                 ASSERT(!multilist_link_active(&hdr->b_l1hdr.b_arc_node));
3491                 ASSERT3P(hdr->b_l1hdr.b_acb, ==, NULL);
3492                 kmem_cache_free(hdr_full_cache, hdr);
3493         } else {
3494                 kmem_cache_free(hdr_l2only_cache, hdr);
3495         }
3496 }
3497
3498 void
3499 arc_buf_destroy(arc_buf_t *buf, void* tag)
3500 {
3501         arc_buf_hdr_t *hdr = buf->b_hdr;
3502         kmutex_t *hash_lock = HDR_LOCK(hdr);
3503
3504         if (hdr->b_l1hdr.b_state == arc_anon) {
3505                 ASSERT3U(hdr->b_l1hdr.b_bufcnt, ==, 1);
3506                 ASSERT(!HDR_IO_IN_PROGRESS(hdr));
3507                 VERIFY0(remove_reference(hdr, NULL, tag));
3508                 arc_hdr_destroy(hdr);
3509                 return;
3510         }
3511
3512         mutex_enter(hash_lock);
3513         ASSERT3P(hdr, ==, buf->b_hdr);
3514         ASSERT(hdr->b_l1hdr.b_bufcnt > 0);
3515         ASSERT3P(hash_lock, ==, HDR_LOCK(hdr));
3516         ASSERT3P(hdr->b_l1hdr.b_state, !=, arc_anon);
3517         ASSERT3P(buf->b_data, !=, NULL);
3518
3519         (void) remove_reference(hdr, hash_lock, tag);
3520         arc_buf_destroy_impl(buf);
3521         mutex_exit(hash_lock);
3522 }
3523
3524 /*
3525  * Evict the arc_buf_hdr that is provided as a parameter. The resultant
3526  * state of the header is dependent on its state prior to entering this
3527  * function. The following transitions are possible:
3528  *
3529  *    - arc_mru -> arc_mru_ghost
3530  *    - arc_mfu -> arc_mfu_ghost
3531  *    - arc_mru_ghost -> arc_l2c_only
3532  *    - arc_mru_ghost -> deleted
3533  *    - arc_mfu_ghost -> arc_l2c_only
3534  *    - arc_mfu_ghost -> deleted
3535  */
3536 static int64_t
3537 arc_evict_hdr(arc_buf_hdr_t *hdr, kmutex_t *hash_lock)
3538 {
3539         arc_state_t *evicted_state, *state;
3540         int64_t bytes_evicted = 0;
3541
3542         ASSERT(MUTEX_HELD(hash_lock));
3543         ASSERT(HDR_HAS_L1HDR(hdr));
3544
3545         state = hdr->b_l1hdr.b_state;
3546         if (GHOST_STATE(state)) {
3547                 ASSERT(!HDR_IO_IN_PROGRESS(hdr));
3548                 ASSERT3P(hdr->b_l1hdr.b_buf, ==, NULL);
3549
3550                 /*
3551                  * l2arc_write_buffers() relies on a header's L1 portion
3552                  * (i.e. its b_pabd field) during it's write phase.
3553                  * Thus, we cannot push a header onto the arc_l2c_only
3554                  * state (removing it's L1 piece) until the header is
3555                  * done being written to the l2arc.
3556                  */
3557                 if (HDR_HAS_L2HDR(hdr) && HDR_L2_WRITING(hdr)) {
3558                         ARCSTAT_BUMP(arcstat_evict_l2_skip);
3559                         return (bytes_evicted);
3560                 }
3561
3562                 ARCSTAT_BUMP(arcstat_deleted);
3563                 bytes_evicted += HDR_GET_LSIZE(hdr);
3564
3565                 DTRACE_PROBE1(arc__delete, arc_buf_hdr_t *, hdr);
3566
3567                 ASSERT3P(hdr->b_l1hdr.b_pabd, ==, NULL);
3568                 if (HDR_HAS_L2HDR(hdr)) {
3569                         /*
3570                          * This buffer is cached on the 2nd Level ARC;
3571                          * don't destroy the header.
3572                          */
3573                         arc_change_state(arc_l2c_only, hdr, hash_lock);
3574                         /*
3575                          * dropping from L1+L2 cached to L2-only,
3576                          * realloc to remove the L1 header.
3577                          */
3578                         hdr = arc_hdr_realloc(hdr, hdr_full_cache,
3579                             hdr_l2only_cache);
3580                 } else {
3581                         arc_change_state(arc_anon, hdr, hash_lock);
3582                         arc_hdr_destroy(hdr);
3583                 }
3584                 return (bytes_evicted);
3585         }
3586
3587         ASSERT(state == arc_mru || state == arc_mfu);
3588         evicted_state = (state == arc_mru) ? arc_mru_ghost : arc_mfu_ghost;
3589
3590         /* prefetch buffers have a minimum lifespan */
3591         if (HDR_IO_IN_PROGRESS(hdr) ||
3592             ((hdr->b_flags & (ARC_FLAG_PREFETCH | ARC_FLAG_INDIRECT)) &&
3593             ddi_get_lbolt() - hdr->b_l1hdr.b_arc_access <
3594             arc_min_prefetch_lifespan)) {
3595                 ARCSTAT_BUMP(arcstat_evict_skip);
3596                 return (bytes_evicted);
3597         }
3598
3599         ASSERT0(refcount_count(&hdr->b_l1hdr.b_refcnt));
3600         while (hdr->b_l1hdr.b_buf) {
3601                 arc_buf_t *buf = hdr->b_l1hdr.b_buf;
3602                 if (!mutex_tryenter(&buf->b_evict_lock)) {
3603                         ARCSTAT_BUMP(arcstat_mutex_miss);
3604                         break;
3605                 }
3606                 if (buf->b_data != NULL)
3607                         bytes_evicted += HDR_GET_LSIZE(hdr);
3608                 mutex_exit(&buf->b_evict_lock);
3609                 arc_buf_destroy_impl(buf);
3610         }
3611
3612         if (HDR_HAS_L2HDR(hdr)) {
3613                 ARCSTAT_INCR(arcstat_evict_l2_cached, HDR_GET_LSIZE(hdr));
3614         } else {
3615                 if (l2arc_write_eligible(hdr->b_spa, hdr)) {
3616                         ARCSTAT_INCR(arcstat_evict_l2_eligible,
3617                             HDR_GET_LSIZE(hdr));
3618                 } else {
3619                         ARCSTAT_INCR(arcstat_evict_l2_ineligible,
3620                             HDR_GET_LSIZE(hdr));
3621                 }
3622         }
3623
3624         if (hdr->b_l1hdr.b_bufcnt == 0) {
3625                 arc_cksum_free(hdr);
3626
3627                 bytes_evicted += arc_hdr_size(hdr);
3628
3629                 /*
3630                  * If this hdr is being evicted and has a compressed
3631                  * buffer then we discard it here before we change states.
3632                  * This ensures that the accounting is updated correctly
3633                  * in arc_free_data_impl().
3634                  */
3635                 arc_hdr_free_pabd(hdr);
3636
3637                 arc_change_state(evicted_state, hdr, hash_lock);
3638                 ASSERT(HDR_IN_HASH_TABLE(hdr));
3639                 arc_hdr_set_flags(hdr, ARC_FLAG_IN_HASH_TABLE);
3640                 DTRACE_PROBE1(arc__evict, arc_buf_hdr_t *, hdr);
3641         }
3642
3643         return (bytes_evicted);
3644 }
3645
3646 static uint64_t
3647 arc_evict_state_impl(multilist_t *ml, int idx, arc_buf_hdr_t *marker,
3648     uint64_t spa, int64_t bytes)
3649 {
3650         multilist_sublist_t *mls;
3651         uint64_t bytes_evicted = 0;
3652         arc_buf_hdr_t *hdr;
3653         kmutex_t *hash_lock;
3654         int evict_count = 0;
3655
3656         ASSERT3P(marker, !=, NULL);
3657         IMPLY(bytes < 0, bytes == ARC_EVICT_ALL);
3658
3659         mls = multilist_sublist_lock(ml, idx);
3660
3661         for (hdr = multilist_sublist_prev(mls, marker); hdr != NULL;
3662             hdr = multilist_sublist_prev(mls, marker)) {
3663                 if ((bytes != ARC_EVICT_ALL && bytes_evicted >= bytes) ||
3664                     (evict_count >= zfs_arc_evict_batch_limit))
3665                         break;
3666
3667                 /*
3668                  * To keep our iteration location, move the marker
3669                  * forward. Since we're not holding hdr's hash lock, we
3670                  * must be very careful and not remove 'hdr' from the
3671                  * sublist. Otherwise, other consumers might mistake the
3672                  * 'hdr' as not being on a sublist when they call the
3673                  * multilist_link_active() function (they all rely on
3674                  * the hash lock protecting concurrent insertions and
3675                  * removals). multilist_sublist_move_forward() was
3676                  * specifically implemented to ensure this is the case
3677                  * (only 'marker' will be removed and re-inserted).
3678                  */
3679                 multilist_sublist_move_forward(mls, marker);
3680
3681                 /*
3682                  * The only case where the b_spa field should ever be
3683                  * zero, is the marker headers inserted by
3684                  * arc_evict_state(). It's possible for multiple threads
3685                  * to be calling arc_evict_state() concurrently (e.g.
3686                  * dsl_pool_close() and zio_inject_fault()), so we must
3687                  * skip any markers we see from these other threads.
3688                  */
3689                 if (hdr->b_spa == 0)
3690                         continue;
3691
3692                 /* we're only interested in evicting buffers of a certain spa */
3693                 if (spa != 0 && hdr->b_spa != spa) {
3694                         ARCSTAT_BUMP(arcstat_evict_skip);
3695                         continue;
3696                 }
3697
3698                 hash_lock = HDR_LOCK(hdr);
3699
3700                 /*
3701                  * We aren't calling this function from any code path
3702                  * that would already be holding a hash lock, so we're
3703                  * asserting on this assumption to be defensive in case
3704                  * this ever changes. Without this check, it would be
3705                  * possible to incorrectly increment arcstat_mutex_miss
3706                  * below (e.g. if the code changed such that we called
3707                  * this function with a hash lock held).
3708                  */
3709                 ASSERT(!MUTEX_HELD(hash_lock));
3710
3711                 if (mutex_tryenter(hash_lock)) {
3712                         uint64_t evicted = arc_evict_hdr(hdr, hash_lock);
3713                         mutex_exit(hash_lock);
3714
3715                         bytes_evicted += evicted;
3716
3717                         /*
3718                          * If evicted is zero, arc_evict_hdr() must have
3719                          * decided to skip this header, don't increment
3720                          * evict_count in this case.
3721                          */
3722                         if (evicted != 0)
3723                                 evict_count++;
3724
3725                         /*
3726                          * If arc_size isn't overflowing, signal any
3727                          * threads that might happen to be waiting.
3728                          *
3729                          * For each header evicted, we wake up a single
3730                          * thread. If we used cv_broadcast, we could
3731                          * wake up "too many" threads causing arc_size
3732                          * to significantly overflow arc_c; since
3733                          * arc_get_data_impl() doesn't check for overflow
3734                          * when it's woken up (it doesn't because it's
3735                          * possible for the ARC to be overflowing while
3736                          * full of un-evictable buffers, and the
3737                          * function should proceed in this case).
3738                          *
3739                          * If threads are left sleeping, due to not
3740                          * using cv_broadcast, they will be woken up
3741                          * just before arc_reclaim_thread() sleeps.
3742                          */
3743                         mutex_enter(&arc_reclaim_lock);
3744                         if (!arc_is_overflowing())
3745                                 cv_signal(&arc_reclaim_waiters_cv);
3746                         mutex_exit(&arc_reclaim_lock);
3747                 } else {
3748                         ARCSTAT_BUMP(arcstat_mutex_miss);
3749                 }
3750         }
3751
3752         multilist_sublist_unlock(mls);
3753
3754         return (bytes_evicted);
3755 }
3756
3757 /*
3758  * Evict buffers from the given arc state, until we've removed the
3759  * specified number of bytes. Move the removed buffers to the
3760  * appropriate evict state.
3761  *
3762  * This function makes a "best effort". It skips over any buffers
3763  * it can't get a hash_lock on, and so, may not catch all candidates.
3764  * It may also return without evicting as much space as requested.
3765  *
3766  * If bytes is specified using the special value ARC_EVICT_ALL, this
3767  * will evict all available (i.e. unlocked and evictable) buffers from
3768  * the given arc state; which is used by arc_flush().
3769  */
3770 static uint64_t
3771 arc_evict_state(arc_state_t *state, uint64_t spa, int64_t bytes,
3772     arc_buf_contents_t type)
3773 {
3774         uint64_t total_evicted = 0;
3775         multilist_t *ml = state->arcs_list[type];
3776         int num_sublists;
3777         arc_buf_hdr_t **markers;
3778
3779         IMPLY(bytes < 0, bytes == ARC_EVICT_ALL);
3780
3781         num_sublists = multilist_get_num_sublists(ml);
3782
3783         /*
3784          * If we've tried to evict from each sublist, made some
3785          * progress, but still have not hit the target number of bytes
3786          * to evict, we want to keep trying. The markers allow us to
3787          * pick up where we left off for each individual sublist, rather
3788          * than starting from the tail each time.
3789          */
3790         markers = kmem_zalloc(sizeof (*markers) * num_sublists, KM_SLEEP);
3791         for (int i = 0; i < num_sublists; i++) {
3792                 markers[i] = kmem_cache_alloc(hdr_full_cache, KM_SLEEP);
3793
3794                 /*
3795                  * A b_spa of 0 is used to indicate that this header is
3796                  * a marker. This fact is used in arc_adjust_type() and
3797                  * arc_evict_state_impl().
3798                  */
3799                 markers[i]->b_spa = 0;
3800
3801                 multilist_sublist_t *mls = multilist_sublist_lock(ml, i);
3802                 multilist_sublist_insert_tail(mls, markers[i]);
3803                 multilist_sublist_unlock(mls);
3804         }
3805
3806         /*
3807          * While we haven't hit our target number of bytes to evict, or
3808          * we're evicting all available buffers.
3809          */
3810         while (total_evicted < bytes || bytes == ARC_EVICT_ALL) {
3811                 /*
3812                  * Start eviction using a randomly selected sublist,
3813                  * this is to try and evenly balance eviction across all
3814                  * sublists. Always starting at the same sublist
3815                  * (e.g. index 0) would cause evictions to favor certain
3816                  * sublists over others.
3817                  */
3818                 int sublist_idx = multilist_get_random_index(ml);
3819                 uint64_t scan_evicted = 0;
3820
3821                 for (int i = 0; i < num_sublists; i++) {
3822                         uint64_t bytes_remaining;
3823                         uint64_t bytes_evicted;
3824
3825                         if (bytes == ARC_EVICT_ALL)
3826                                 bytes_remaining = ARC_EVICT_ALL;
3827                         else if (total_evicted < bytes)
3828                                 bytes_remaining = bytes - total_evicted;
3829                         else
3830                                 break;
3831
3832                         bytes_evicted = arc_evict_state_impl(ml, sublist_idx,
3833                             markers[sublist_idx], spa, bytes_remaining);
3834
3835                         scan_evicted += bytes_evicted;
3836                         total_evicted += bytes_evicted;
3837
3838                         /* we've reached the end, wrap to the beginning */
3839                         if (++sublist_idx >= num_sublists)
3840                                 sublist_idx = 0;
3841                 }
3842
3843                 /*
3844                  * If we didn't evict anything during this scan, we have
3845                  * no reason to believe we'll evict more during another
3846                  * scan, so break the loop.
3847                  */
3848                 if (scan_evicted == 0) {
3849                         /* This isn't possible, let's make that obvious */
3850                         ASSERT3S(bytes, !=, 0);
3851
3852                         /*
3853                          * When bytes is ARC_EVICT_ALL, the only way to
3854                          * break the loop is when scan_evicted is zero.
3855                          * In that case, we actually have evicted enough,
3856                          * so we don't want to increment the kstat.
3857                          */
3858                         if (bytes != ARC_EVICT_ALL) {
3859                                 ASSERT3S(total_evicted, <, bytes);
3860                                 ARCSTAT_BUMP(arcstat_evict_not_enough);
3861                         }
3862
3863                         break;
3864                 }
3865         }
3866
3867         for (int i = 0; i < num_sublists; i++) {
3868                 multilist_sublist_t *mls = multilist_sublist_lock(ml, i);
3869                 multilist_sublist_remove(mls, markers[i]);
3870                 multilist_sublist_unlock(mls);
3871
3872                 kmem_cache_free(hdr_full_cache, markers[i]);
3873         }
3874         kmem_free(markers, sizeof (*markers) * num_sublists);
3875
3876         return (total_evicted);
3877 }
3878
3879 /*
3880  * Flush all "evictable" data of the given type from the arc state
3881  * specified. This will not evict any "active" buffers (i.e. referenced).
3882  *
3883  * When 'retry' is set to B_FALSE, the function will make a single pass
3884  * over the state and evict any buffers that it can. Since it doesn't
3885  * continually retry the eviction, it might end up leaving some buffers
3886  * in the ARC due to lock misses.
3887  *
3888  * When 'retry' is set to B_TRUE, the function will continually retry the
3889  * eviction until *all* evictable buffers have been removed from the
3890  * state. As a result, if concurrent insertions into the state are
3891  * allowed (e.g. if the ARC isn't shutting down), this function might
3892  * wind up in an infinite loop, continually trying to evict buffers.
3893  */
3894 static uint64_t
3895 arc_flush_state(arc_state_t *state, uint64_t spa, arc_buf_contents_t type,
3896     boolean_t retry)
3897 {
3898         uint64_t evicted = 0;
3899
3900         while (refcount_count(&state->arcs_esize[type]) != 0) {
3901                 evicted += arc_evict_state(state, spa, ARC_EVICT_ALL, type);
3902
3903                 if (!retry)
3904                         break;
3905         }
3906
3907         return (evicted);
3908 }
3909
3910 /*
3911  * Evict the specified number of bytes from the state specified,
3912  * restricting eviction to the spa and type given. This function
3913  * prevents us from trying to evict more from a state's list than
3914  * is "evictable", and to skip evicting altogether when passed a
3915  * negative value for "bytes". In contrast, arc_evict_state() will
3916  * evict everything it can, when passed a negative value for "bytes".
3917  */
3918 static uint64_t
3919 arc_adjust_impl(arc_state_t *state, uint64_t spa, int64_t bytes,
3920     arc_buf_contents_t type)
3921 {
3922         int64_t delta;
3923
3924         if (bytes > 0 && refcount_count(&state->arcs_esize[type]) > 0) {
3925                 delta = MIN(refcount_count(&state->arcs_esize[type]), bytes);
3926                 return (arc_evict_state(state, spa, delta, type));
3927         }
3928
3929         return (0);
3930 }
3931
3932 /*
3933  * Evict metadata buffers from the cache, such that arc_meta_used is
3934  * capped by the arc_meta_limit tunable.
3935  */
3936 static uint64_t
3937 arc_adjust_meta(uint64_t meta_used)
3938 {
3939         uint64_t total_evicted = 0;
3940         int64_t target;
3941
3942         /*
3943          * If we're over the meta limit, we want to evict enough
3944          * metadata to get back under the meta limit. We don't want to
3945          * evict so much that we drop the MRU below arc_p, though. If
3946          * we're over the meta limit more than we're over arc_p, we
3947          * evict some from the MRU here, and some from the MFU below.
3948          */
3949         target = MIN((int64_t)(meta_used - arc_meta_limit),
3950             (int64_t)(refcount_count(&arc_anon->arcs_size) +
3951             refcount_count(&arc_mru->arcs_size) - arc_p));
3952
3953         total_evicted += arc_adjust_impl(arc_mru, 0, target, ARC_BUFC_METADATA);
3954
3955         /*
3956          * Similar to the above, we want to evict enough bytes to get us
3957          * below the meta limit, but not so much as to drop us below the
3958          * space allotted to the MFU (which is defined as arc_c - arc_p).
3959          */
3960         target = MIN((int64_t)(meta_used - arc_meta_limit),
3961             (int64_t)(refcount_count(&arc_mfu->arcs_size) -
3962             (arc_c - arc_p)));
3963
3964         total_evicted += arc_adjust_impl(arc_mfu, 0, target, ARC_BUFC_METADATA);
3965
3966         return (total_evicted);
3967 }
3968
3969 /*
3970  * Return the type of the oldest buffer in the given arc state
3971  *
3972  * This function will select a random sublist of type ARC_BUFC_DATA and
3973  * a random sublist of type ARC_BUFC_METADATA. The tail of each sublist
3974  * is compared, and the type which contains the "older" buffer will be
3975  * returned.
3976  */
3977 static arc_buf_contents_t
3978 arc_adjust_type(arc_state_t *state)
3979 {
3980         multilist_t *data_ml = state->arcs_list[ARC_BUFC_DATA];
3981         multilist_t *meta_ml = state->arcs_list[ARC_BUFC_METADATA];
3982         int data_idx = multilist_get_random_index(data_ml);
3983         int meta_idx = multilist_get_random_index(meta_ml);
3984         multilist_sublist_t *data_mls;
3985         multilist_sublist_t *meta_mls;
3986         arc_buf_contents_t type;
3987         arc_buf_hdr_t *data_hdr;
3988         arc_buf_hdr_t *meta_hdr;
3989
3990         /*
3991          * We keep the sublist lock until we're finished, to prevent
3992          * the headers from being destroyed via arc_evict_state().
3993          */
3994         data_mls = multilist_sublist_lock(data_ml, data_idx);
3995         meta_mls = multilist_sublist_lock(meta_ml, meta_idx);
3996
3997         /*
3998          * These two loops are to ensure we skip any markers that
3999          * might be at the tail of the lists due to arc_evict_state().
4000          */
4001
4002         for (data_hdr = multilist_sublist_tail(data_mls); data_hdr != NULL;
4003             data_hdr = multilist_sublist_prev(data_mls, data_hdr)) {
4004                 if (data_hdr->b_spa != 0)
4005                         break;
4006         }
4007
4008         for (meta_hdr = multilist_sublist_tail(meta_mls); meta_hdr != NULL;
4009             meta_hdr = multilist_sublist_prev(meta_mls, meta_hdr)) {
4010                 if (meta_hdr->b_spa != 0)
4011                         break;
4012         }
4013
4014         if (data_hdr == NULL && meta_hdr == NULL) {
4015                 type = ARC_BUFC_DATA;
4016         } else if (data_hdr == NULL) {
4017                 ASSERT3P(meta_hdr, !=, NULL);
4018                 type = ARC_BUFC_METADATA;
4019         } else if (meta_hdr == NULL) {
4020                 ASSERT3P(data_hdr, !=, NULL);
4021                 type = ARC_BUFC_DATA;
4022         } else {
4023                 ASSERT3P(data_hdr, !=, NULL);
4024                 ASSERT3P(meta_hdr, !=, NULL);
4025
4026                 /* The headers can't be on the sublist without an L1 header */
4027                 ASSERT(HDR_HAS_L1HDR(data_hdr));
4028                 ASSERT(HDR_HAS_L1HDR(meta_hdr));
4029
4030                 if (data_hdr->b_l1hdr.b_arc_access <
4031                     meta_hdr->b_l1hdr.b_arc_access) {
4032                         type = ARC_BUFC_DATA;
4033                 } else {
4034                         type = ARC_BUFC_METADATA;
4035                 }
4036         }
4037
4038         multilist_sublist_unlock(meta_mls);
4039         multilist_sublist_unlock(data_mls);
4040
4041         return (type);
4042 }
4043
4044 /*
4045  * Evict buffers from the cache, such that arc_size is capped by arc_c.
4046  */
4047 static uint64_t
4048 arc_adjust(void)
4049 {
4050         uint64_t total_evicted = 0;
4051         uint64_t bytes;
4052         int64_t target;
4053         uint64_t asize = aggsum_value(&arc_size);
4054         uint64_t ameta = aggsum_value(&arc_meta_used);
4055
4056         /*
4057          * If we're over arc_meta_limit, we want to correct that before
4058          * potentially evicting data buffers below.
4059          */
4060         total_evicted += arc_adjust_meta(ameta);
4061
4062         /*
4063          * Adjust MRU size
4064          *
4065          * If we're over the target cache size, we want to evict enough
4066          * from the list to get back to our target size. We don't want
4067          * to evict too much from the MRU, such that it drops below
4068          * arc_p. So, if we're over our target cache size more than
4069          * the MRU is over arc_p, we'll evict enough to get back to
4070          * arc_p here, and then evict more from the MFU below.
4071          */
4072         target = MIN((int64_t)(asize - arc_c),
4073             (int64_t)(refcount_count(&arc_anon->arcs_size) +
4074             refcount_count(&arc_mru->arcs_size) + ameta - arc_p));
4075
4076         /*
4077          * If we're below arc_meta_min, always prefer to evict data.
4078          * Otherwise, try to satisfy the requested number of bytes to
4079          * evict from the type which contains older buffers; in an
4080          * effort to keep newer buffers in the cache regardless of their
4081          * type. If we cannot satisfy the number of bytes from this
4082          * type, spill over into the next type.
4083          */
4084         if (arc_adjust_type(arc_mru) == ARC_BUFC_METADATA &&
4085             ameta > arc_meta_min) {
4086                 bytes = arc_adjust_impl(arc_mru, 0, target, ARC_BUFC_METADATA);
4087                 total_evicted += bytes;
4088
4089                 /*
4090                  * If we couldn't evict our target number of bytes from
4091                  * metadata, we try to get the rest from data.
4092                  */
4093                 target -= bytes;
4094
4095                 total_evicted +=
4096                     arc_adjust_impl(arc_mru, 0, target, ARC_BUFC_DATA);
4097         } else {
4098                 bytes = arc_adjust_impl(arc_mru, 0, target, ARC_BUFC_DATA);
4099                 total_evicted += bytes;
4100
4101                 /*
4102                  * If we couldn't evict our target number of bytes from
4103                  * data, we try to get the rest from metadata.
4104                  */
4105                 target -= bytes;
4106
4107                 total_evicted +=
4108                     arc_adjust_impl(arc_mru, 0, target, ARC_BUFC_METADATA);
4109         }
4110
4111         /*
4112          * Adjust MFU size
4113          *
4114          * Now that we've tried to evict enough from the MRU to get its
4115          * size back to arc_p, if we're still above the target cache
4116          * size, we evict the rest from the MFU.
4117          */
4118         target = asize - arc_c;
4119
4120         if (arc_adjust_type(arc_mfu) == ARC_BUFC_METADATA &&
4121             ameta > arc_meta_min) {
4122                 bytes = arc_adjust_impl(arc_mfu, 0, target, ARC_BUFC_METADATA);
4123                 total_evicted += bytes;
4124
4125                 /*
4126                  * If we couldn't evict our target number of bytes from
4127                  * metadata, we try to get the rest from data.
4128                  */
4129                 target -= bytes;
4130
4131                 total_evicted +=
4132                     arc_adjust_impl(arc_mfu, 0, target, ARC_BUFC_DATA);
4133         } else {
4134                 bytes = arc_adjust_impl(arc_mfu, 0, target, ARC_BUFC_DATA);
4135                 total_evicted += bytes;
4136
4137                 /*
4138                  * If we couldn't evict our target number of bytes from
4139                  * data, we try to get the rest from data.
4140                  */
4141                 target -= bytes;
4142
4143                 total_evicted +=
4144                     arc_adjust_impl(arc_mfu, 0, target, ARC_BUFC_METADATA);
4145         }
4146
4147         /*
4148          * Adjust ghost lists
4149          *
4150          * In addition to the above, the ARC also defines target values
4151          * for the ghost lists. The sum of the mru list and mru ghost
4152          * list should never exceed the target size of the cache, and
4153          * the sum of the mru list, mfu list, mru ghost list, and mfu
4154          * ghost list should never exceed twice the target size of the
4155          * cache. The following logic enforces these limits on the ghost
4156          * caches, and evicts from them as needed.
4157          */
4158         target = refcount_count(&arc_mru->arcs_size) +
4159             refcount_count(&arc_mru_ghost->arcs_size) - arc_c;
4160
4161         bytes = arc_adjust_impl(arc_mru_ghost, 0, target, ARC_BUFC_DATA);
4162         total_evicted += bytes;
4163
4164         target -= bytes;
4165
4166         total_evicted +=
4167             arc_adjust_impl(arc_mru_ghost, 0, target, ARC_BUFC_METADATA);
4168
4169         /*
4170          * We assume the sum of the mru list and mfu list is less than
4171          * or equal to arc_c (we enforced this above), which means we
4172          * can use the simpler of the two equations below:
4173          *
4174          *      mru + mfu + mru ghost + mfu ghost <= 2 * arc_c
4175          *                  mru ghost + mfu ghost <= arc_c
4176          */
4177         target = refcount_count(&arc_mru_ghost->arcs_size) +
4178             refcount_count(&arc_mfu_ghost->arcs_size) - arc_c;
4179
4180         bytes = arc_adjust_impl(arc_mfu_ghost, 0, target, ARC_BUFC_DATA);
4181         total_evicted += bytes;
4182
4183         target -= bytes;
4184
4185         total_evicted +=
4186             arc_adjust_impl(arc_mfu_ghost, 0, target, ARC_BUFC_METADATA);
4187
4188         return (total_evicted);
4189 }
4190
4191 void
4192 arc_flush(spa_t *spa, boolean_t retry)
4193 {
4194         uint64_t guid = 0;
4195
4196         /*
4197          * If retry is B_TRUE, a spa must not be specified since we have
4198          * no good way to determine if all of a spa's buffers have been
4199          * evicted from an arc state.
4200          */
4201         ASSERT(!retry || spa == 0);
4202
4203         if (spa != NULL)
4204                 guid = spa_load_guid(spa);
4205
4206         (void) arc_flush_state(arc_mru, guid, ARC_BUFC_DATA, retry);
4207         (void) arc_flush_state(arc_mru, guid, ARC_BUFC_METADATA, retry);
4208
4209         (void) arc_flush_state(arc_mfu, guid, ARC_BUFC_DATA, retry);
4210         (void) arc_flush_state(arc_mfu, guid, ARC_BUFC_METADATA, retry);
4211
4212         (void) arc_flush_state(arc_mru_ghost, guid, ARC_BUFC_DATA, retry);
4213         (void) arc_flush_state(arc_mru_ghost, guid, ARC_BUFC_METADATA, retry);
4214
4215         (void) arc_flush_state(arc_mfu_ghost, guid, ARC_BUFC_DATA, retry);
4216         (void) arc_flush_state(arc_mfu_ghost, guid, ARC_BUFC_METADATA, retry);
4217 }
4218
4219 void
4220 arc_shrink(int64_t to_free)
4221 {
4222         uint64_t asize = aggsum_value(&arc_size);
4223         if (arc_c > arc_c_min) {
4224                 DTRACE_PROBE4(arc__shrink, uint64_t, arc_c, uint64_t,
4225                         arc_c_min, uint64_t, arc_p, uint64_t, to_free);
4226                 if (arc_c > arc_c_min + to_free)
4227                         atomic_add_64(&arc_c, -to_free);
4228                 else
4229                         arc_c = arc_c_min;
4230
4231                 atomic_add_64(&arc_p, -(arc_p >> arc_shrink_shift));
4232                 if (asize < arc_c)
4233                         arc_c = MAX(asize, arc_c_min);
4234                 if (arc_p > arc_c)
4235                         arc_p = (arc_c >> 1);
4236
4237                 DTRACE_PROBE2(arc__shrunk, uint64_t, arc_c, uint64_t,
4238                         arc_p);
4239
4240                 ASSERT(arc_c >= arc_c_min);
4241                 ASSERT((int64_t)arc_p >= 0);
4242         }
4243
4244         if (asize > arc_c) {
4245                 DTRACE_PROBE2(arc__shrink_adjust, uint64_t, asize,
4246                         uint64_t, arc_c);
4247                 (void) arc_adjust();
4248         }
4249 }
4250
4251 typedef enum free_memory_reason_t {
4252         FMR_UNKNOWN,
4253         FMR_NEEDFREE,
4254         FMR_LOTSFREE,
4255         FMR_SWAPFS_MINFREE,
4256         FMR_PAGES_PP_MAXIMUM,
4257         FMR_HEAP_ARENA,
4258         FMR_ZIO_ARENA,
4259 } free_memory_reason_t;
4260
4261 int64_t last_free_memory;
4262 free_memory_reason_t last_free_reason;
4263
4264 /*
4265  * Additional reserve of pages for pp_reserve.
4266  */
4267 int64_t arc_pages_pp_reserve = 64;
4268
4269 /*
4270  * Additional reserve of pages for swapfs.
4271  */
4272 int64_t arc_swapfs_reserve = 64;
4273
4274 /*
4275  * Return the amount of memory that can be consumed before reclaim will be
4276  * needed.  Positive if there is sufficient free memory, negative indicates
4277  * the amount of memory that needs to be freed up.
4278  */
4279 static int64_t
4280 arc_available_memory(void)
4281 {
4282         int64_t lowest = INT64_MAX;
4283         int64_t n;
4284         free_memory_reason_t r = FMR_UNKNOWN;
4285
4286 #ifdef _KERNEL
4287 #ifdef __FreeBSD__
4288         /*
4289          * Cooperate with pagedaemon when it's time for it to scan
4290          * and reclaim some pages.
4291          */
4292         n = PAGESIZE * ((int64_t)freemem - zfs_arc_free_target);
4293         if (n < lowest) {
4294                 lowest = n;
4295                 r = FMR_LOTSFREE;
4296         }
4297
4298 #else
4299         if (needfree > 0) {
4300                 n = PAGESIZE * (-needfree);
4301                 if (n < lowest) {
4302                         lowest = n;
4303                         r = FMR_NEEDFREE;
4304                 }
4305         }
4306
4307         /*
4308          * check that we're out of range of the pageout scanner.  It starts to
4309          * schedule paging if freemem is less than lotsfree and needfree.
4310          * lotsfree is the high-water mark for pageout, and needfree is the
4311          * number of needed free pages.  We add extra pages here to make sure
4312          * the scanner doesn't start up while we're freeing memory.
4313          */
4314         n = PAGESIZE * (freemem - lotsfree - needfree - desfree);
4315         if (n < lowest) {
4316                 lowest = n;
4317                 r = FMR_LOTSFREE;
4318         }
4319
4320         /*
4321          * check to make sure that swapfs has enough space so that anon
4322          * reservations can still succeed. anon_resvmem() checks that the
4323          * availrmem is greater than swapfs_minfree, and the number of reserved
4324          * swap pages.  We also add a bit of extra here just to prevent
4325          * circumstances from getting really dire.
4326          */
4327         n = PAGESIZE * (availrmem - swapfs_minfree - swapfs_reserve -
4328             desfree - arc_swapfs_reserve);
4329         if (n < lowest) {
4330                 lowest = n;
4331                 r = FMR_SWAPFS_MINFREE;
4332         }
4333
4334
4335         /*
4336          * Check that we have enough availrmem that memory locking (e.g., via
4337          * mlock(3C) or memcntl(2)) can still succeed.  (pages_pp_maximum
4338          * stores the number of pages that cannot be locked; when availrmem
4339          * drops below pages_pp_maximum, page locking mechanisms such as
4340          * page_pp_lock() will fail.)
4341          */
4342         n = PAGESIZE * (availrmem - pages_pp_maximum -
4343             arc_pages_pp_reserve);
4344         if (n < lowest) {
4345                 lowest = n;
4346                 r = FMR_PAGES_PP_MAXIMUM;
4347         }
4348
4349 #endif  /* __FreeBSD__ */
4350 #if defined(__i386) || !defined(UMA_MD_SMALL_ALLOC)
4351         /*
4352          * If we're on an i386 platform, it's possible that we'll exhaust the
4353          * kernel heap space before we ever run out of available physical
4354          * memory.  Most checks of the size of the heap_area compare against
4355          * tune.t_minarmem, which is the minimum available real memory that we
4356          * can have in the system.  However, this is generally fixed at 25 pages
4357          * which is so low that it's useless.  In this comparison, we seek to
4358          * calculate the total heap-size, and reclaim if more than 3/4ths of the
4359          * heap is allocated.  (Or, in the calculation, if less than 1/4th is
4360          * free)
4361          */
4362         n = uma_avail() - (long)(uma_limit() / 4);
4363         if (n < lowest) {
4364                 lowest = n;
4365                 r = FMR_HEAP_ARENA;
4366         }
4367 #endif
4368
4369         /*
4370          * If zio data pages are being allocated out of a separate heap segment,
4371          * then enforce that the size of available vmem for this arena remains
4372          * above about 1/4th (1/(2^arc_zio_arena_free_shift)) free.
4373          *
4374          * Note that reducing the arc_zio_arena_free_shift keeps more virtual
4375          * memory (in the zio_arena) free, which can avoid memory
4376          * fragmentation issues.
4377          */
4378         if (zio_arena != NULL) {
4379                 n = (int64_t)vmem_size(zio_arena, VMEM_FREE) -
4380                     (vmem_size(zio_arena, VMEM_ALLOC) >>
4381                     arc_zio_arena_free_shift);
4382                 if (n < lowest) {
4383                         lowest = n;
4384                         r = FMR_ZIO_ARENA;
4385                 }
4386         }
4387
4388 #else   /* _KERNEL */
4389         /* Every 100 calls, free a small amount */
4390         if (spa_get_random(100) == 0)
4391                 lowest = -1024;
4392 #endif  /* _KERNEL */
4393
4394         last_free_memory = lowest;
4395         last_free_reason = r;
4396         DTRACE_PROBE2(arc__available_memory, int64_t, lowest, int, r);
4397         return (lowest);
4398 }
4399
4400
4401 /*
4402  * Determine if the system is under memory pressure and is asking
4403  * to reclaim memory. A return value of B_TRUE indicates that the system
4404  * is under memory pressure and that the arc should adjust accordingly.
4405  */
4406 static boolean_t
4407 arc_reclaim_needed(void)
4408 {
4409         return (arc_available_memory() < 0);
4410 }
4411
4412 extern kmem_cache_t     *zio_buf_cache[];
4413 extern kmem_cache_t     *zio_data_buf_cache[];
4414 extern kmem_cache_t     *range_seg_cache;
4415 extern kmem_cache_t     *abd_chunk_cache;
4416
4417 static __noinline void
4418 arc_kmem_reap_now(void)
4419 {
4420         size_t                  i;
4421         kmem_cache_t            *prev_cache = NULL;
4422         kmem_cache_t            *prev_data_cache = NULL;
4423
4424         DTRACE_PROBE(arc__kmem_reap_start);
4425 #ifdef _KERNEL
4426         if (aggsum_compare(&arc_meta_used, arc_meta_limit) >= 0) {
4427                 /*
4428                  * We are exceeding our meta-data cache limit.
4429                  * Purge some DNLC entries to release holds on meta-data.
4430                  */
4431                 dnlc_reduce_cache((void *)(uintptr_t)arc_reduce_dnlc_percent);
4432         }
4433 #if defined(__i386)
4434         /*
4435          * Reclaim unused memory from all kmem caches.
4436          */
4437         kmem_reap();
4438 #endif
4439 #endif
4440
4441         /*
4442          * If a kmem reap is already active, don't schedule more.  We must
4443          * check for this because kmem_cache_reap_soon() won't actually
4444          * block on the cache being reaped (this is to prevent callers from
4445          * becoming implicitly blocked by a system-wide kmem reap -- which,
4446          * on a system with many, many full magazines, can take minutes).
4447          */
4448         if (kmem_cache_reap_active())
4449                 return;
4450
4451         for (i = 0; i < SPA_MAXBLOCKSIZE >> SPA_MINBLOCKSHIFT; i++) {
4452                 if (zio_buf_cache[i] != prev_cache) {
4453                         prev_cache = zio_buf_cache[i];
4454                         kmem_cache_reap_soon(zio_buf_cache[i]);
4455                 }
4456                 if (zio_data_buf_cache[i] != prev_data_cache) {
4457                         prev_data_cache = zio_data_buf_cache[i];
4458                         kmem_cache_reap_soon(zio_data_buf_cache[i]);
4459                 }
4460         }
4461         kmem_cache_reap_soon(abd_chunk_cache);
4462         kmem_cache_reap_soon(buf_cache);
4463         kmem_cache_reap_soon(hdr_full_cache);
4464         kmem_cache_reap_soon(hdr_l2only_cache);
4465         kmem_cache_reap_soon(range_seg_cache);
4466
4467 #ifdef illumos
4468         if (zio_arena != NULL) {
4469                 /*
4470                  * Ask the vmem arena to reclaim unused memory from its
4471                  * quantum caches.
4472                  */
4473                 vmem_qcache_reap(zio_arena);
4474         }
4475 #endif
4476         DTRACE_PROBE(arc__kmem_reap_end);
4477 }
4478
4479 /*
4480  * Threads can block in arc_get_data_impl() waiting for this thread to evict
4481  * enough data and signal them to proceed. When this happens, the threads in
4482  * arc_get_data_impl() are sleeping while holding the hash lock for their
4483  * particular arc header. Thus, we must be careful to never sleep on a
4484  * hash lock in this thread. This is to prevent the following deadlock:
4485  *
4486  *  - Thread A sleeps on CV in arc_get_data_impl() holding hash lock "L",
4487  *    waiting for the reclaim thread to signal it.
4488  *
4489  *  - arc_reclaim_thread() tries to acquire hash lock "L" using mutex_enter,
4490  *    fails, and goes to sleep forever.
4491  *
4492  * This possible deadlock is avoided by always acquiring a hash lock
4493  * using mutex_tryenter() from arc_reclaim_thread().
4494  */
4495 /* ARGSUSED */
4496 static void
4497 arc_reclaim_thread(void *unused __unused)
4498 {
4499         hrtime_t                growtime = 0;
4500         hrtime_t                kmem_reap_time = 0;
4501         callb_cpr_t             cpr;
4502
4503         CALLB_CPR_INIT(&cpr, &arc_reclaim_lock, callb_generic_cpr, FTAG);
4504
4505         mutex_enter(&arc_reclaim_lock);
4506         while (!arc_reclaim_thread_exit) {
4507                 uint64_t evicted = 0;
4508
4509                 /*
4510                  * This is necessary in order for the mdb ::arc dcmd to
4511                  * show up to date information. Since the ::arc command
4512                  * does not call the kstat's update function, without
4513                  * this call, the command may show stale stats for the
4514                  * anon, mru, mru_ghost, mfu, and mfu_ghost lists. Even
4515                  * with this change, the data might be up to 1 second
4516                  * out of date; but that should suffice. The arc_state_t
4517                  * structures can be queried directly if more accurate
4518                  * information is needed.
4519                  */
4520                 if (arc_ksp != NULL)
4521                         arc_ksp->ks_update(arc_ksp, KSTAT_READ);
4522
4523                 mutex_exit(&arc_reclaim_lock);
4524
4525                 /*
4526                  * We call arc_adjust() before (possibly) calling
4527                  * arc_kmem_reap_now(), so that we can wake up
4528                  * arc_get_data_impl() sooner.
4529                  */
4530                 evicted = arc_adjust();
4531
4532                 int64_t free_memory = arc_available_memory();
4533                 if (free_memory < 0) {
4534                         hrtime_t curtime = gethrtime();
4535                         arc_no_grow = B_TRUE;
4536                         arc_warm = B_TRUE;
4537
4538                         /*
4539                          * Wait at least zfs_grow_retry (default 60) seconds
4540                          * before considering growing.
4541                          */
4542                         growtime = curtime + SEC2NSEC(arc_grow_retry);
4543
4544                         /*
4545                          * Wait at least arc_kmem_cache_reap_retry_ms
4546                          * between arc_kmem_reap_now() calls. Without
4547                          * this check it is possible to end up in a
4548                          * situation where we spend lots of time
4549                          * reaping caches, while we're near arc_c_min.
4550                          */
4551                         if (curtime >= kmem_reap_time) {
4552                                 arc_kmem_reap_now();
4553                                 kmem_reap_time = gethrtime() +
4554                                     MSEC2NSEC(arc_kmem_cache_reap_retry_ms);
4555                         }
4556
4557                         /*
4558                          * If we are still low on memory, shrink the ARC
4559                          * so that we have arc_shrink_min free space.
4560                          */
4561                         free_memory = arc_available_memory();
4562
4563                         int64_t to_free =
4564                             (arc_c >> arc_shrink_shift) - free_memory;
4565                         if (to_free > 0) {
4566 #ifdef _KERNEL
4567 #ifdef illumos
4568                                 to_free = MAX(to_free, ptob(needfree));
4569 #endif
4570 #endif
4571                                 arc_shrink(to_free);
4572                         }
4573                 } else if (free_memory < arc_c >> arc_no_grow_shift) {
4574                         arc_no_grow = B_TRUE;
4575                 } else if (gethrtime() >= growtime) {
4576                         arc_no_grow = B_FALSE;
4577                 }
4578
4579                 mutex_enter(&arc_reclaim_lock);
4580
4581                 /*
4582                  * If evicted is zero, we couldn't evict anything via
4583                  * arc_adjust(). This could be due to hash lock
4584                  * collisions, but more likely due to the majority of
4585                  * arc buffers being unevictable. Therefore, even if
4586                  * arc_size is above arc_c, another pass is unlikely to
4587                  * be helpful and could potentially cause us to enter an
4588                  * infinite loop.
4589                  */
4590                 if (aggsum_compare(&arc_size, arc_c) <= 0|| evicted == 0) {
4591                         /*
4592                          * We're either no longer overflowing, or we
4593                          * can't evict anything more, so we should wake
4594                          * up any threads before we go to sleep.
4595                          */
4596                         cv_broadcast(&arc_reclaim_waiters_cv);
4597
4598                         /*
4599                          * Block until signaled, or after one second (we
4600                          * might need to perform arc_kmem_reap_now()
4601                          * even if we aren't being signalled)
4602                          */
4603                         CALLB_CPR_SAFE_BEGIN(&cpr);
4604                         (void) cv_timedwait_hires(&arc_reclaim_thread_cv,
4605                             &arc_reclaim_lock, SEC2NSEC(1), MSEC2NSEC(1), 0);
4606                         CALLB_CPR_SAFE_END(&cpr, &arc_reclaim_lock);
4607                 }
4608         }
4609
4610         arc_reclaim_thread_exit = B_FALSE;
4611         cv_broadcast(&arc_reclaim_thread_cv);
4612         CALLB_CPR_EXIT(&cpr);           /* drops arc_reclaim_lock */
4613         thread_exit();
4614 }
4615
4616 static u_int arc_dnlc_evicts_arg;
4617 extern struct vfsops zfs_vfsops;
4618
4619 static void
4620 arc_dnlc_evicts_thread(void *dummy __unused)
4621 {
4622         callb_cpr_t cpr;
4623         u_int percent;
4624
4625         CALLB_CPR_INIT(&cpr, &arc_dnlc_evicts_lock, callb_generic_cpr, FTAG);
4626
4627         mutex_enter(&arc_dnlc_evicts_lock);
4628         while (!arc_dnlc_evicts_thread_exit) {
4629                 CALLB_CPR_SAFE_BEGIN(&cpr);
4630                 (void) cv_wait(&arc_dnlc_evicts_cv, &arc_dnlc_evicts_lock);
4631                 CALLB_CPR_SAFE_END(&cpr, &arc_dnlc_evicts_lock);
4632                 if (arc_dnlc_evicts_arg != 0) {
4633                         percent = arc_dnlc_evicts_arg;
4634                         mutex_exit(&arc_dnlc_evicts_lock);
4635 #ifdef _KERNEL
4636                         vnlru_free(desiredvnodes * percent / 100, &zfs_vfsops);
4637 #endif
4638                         mutex_enter(&arc_dnlc_evicts_lock);
4639                         /*
4640                          * Clear our token only after vnlru_free()
4641                          * pass is done, to avoid false queueing of
4642                          * the requests.
4643                          */
4644                         arc_dnlc_evicts_arg = 0;
4645                 }
4646         }
4647         arc_dnlc_evicts_thread_exit = FALSE;
4648         cv_broadcast(&arc_dnlc_evicts_cv);
4649         CALLB_CPR_EXIT(&cpr);
4650         thread_exit();
4651 }
4652
4653 void
4654 dnlc_reduce_cache(void *arg)
4655 {
4656         u_int percent;
4657
4658         percent = (u_int)(uintptr_t)arg;
4659         mutex_enter(&arc_dnlc_evicts_lock);
4660         if (arc_dnlc_evicts_arg == 0) {
4661                 arc_dnlc_evicts_arg = percent;
4662                 cv_broadcast(&arc_dnlc_evicts_cv);
4663         }
4664         mutex_exit(&arc_dnlc_evicts_lock);
4665 }
4666
4667 /*
4668  * Adapt arc info given the number of bytes we are trying to add and
4669  * the state that we are comming from.  This function is only called
4670  * when we are adding new content to the cache.
4671  */
4672 static void
4673 arc_adapt(int bytes, arc_state_t *state)
4674 {
4675         int mult;
4676         uint64_t arc_p_min = (arc_c >> arc_p_min_shift);
4677         int64_t mrug_size = refcount_count(&arc_mru_ghost->arcs_size);
4678         int64_t mfug_size = refcount_count(&arc_mfu_ghost->arcs_size);
4679
4680         if (state == arc_l2c_only)
4681                 return;
4682
4683         ASSERT(bytes > 0);
4684         /*
4685          * Adapt the target size of the MRU list:
4686          *      - if we just hit in the MRU ghost list, then increase
4687          *        the target size of the MRU list.
4688          *      - if we just hit in the MFU ghost list, then increase
4689          *        the target size of the MFU list by decreasing the
4690          *        target size of the MRU list.
4691          */
4692         if (state == arc_mru_ghost) {
4693                 mult = (mrug_size >= mfug_size) ? 1 : (mfug_size / mrug_size);
4694                 mult = MIN(mult, 10); /* avoid wild arc_p adjustment */
4695
4696                 arc_p = MIN(arc_c - arc_p_min, arc_p + bytes * mult);
4697         } else if (state == arc_mfu_ghost) {
4698                 uint64_t delta;
4699
4700                 mult = (mfug_size >= mrug_size) ? 1 : (mrug_size / mfug_size);
4701                 mult = MIN(mult, 10);
4702
4703                 delta = MIN(bytes * mult, arc_p);
4704                 arc_p = MAX(arc_p_min, arc_p - delta);
4705         }
4706         ASSERT((int64_t)arc_p >= 0);
4707
4708         if (arc_reclaim_needed()) {
4709                 cv_signal(&arc_reclaim_thread_cv);
4710                 return;
4711         }
4712
4713         if (arc_no_grow)
4714                 return;
4715
4716         if (arc_c >= arc_c_max)
4717                 return;
4718
4719         /*
4720          * If we're within (2 * maxblocksize) bytes of the target
4721          * cache size, increment the target cache size
4722          */
4723         if (aggsum_compare(&arc_size, arc_c - (2ULL << SPA_MAXBLOCKSHIFT)) >
4724             0) {
4725                 DTRACE_PROBE1(arc__inc_adapt, int, bytes);
4726                 atomic_add_64(&arc_c, (int64_t)bytes);
4727                 if (arc_c > arc_c_max)
4728                         arc_c = arc_c_max;
4729                 else if (state == arc_anon)
4730                         atomic_add_64(&arc_p, (int64_t)bytes);
4731                 if (arc_p > arc_c)
4732                         arc_p = arc_c;
4733         }
4734         ASSERT((int64_t)arc_p >= 0);
4735 }
4736
4737 /*
4738  * Check if arc_size has grown past our upper threshold, determined by
4739  * zfs_arc_overflow_shift.
4740  */
4741 static boolean_t
4742 arc_is_overflowing(void)
4743 {
4744         /* Always allow at least one block of overflow */
4745         uint64_t overflow = MAX(SPA_MAXBLOCKSIZE,
4746             arc_c >> zfs_arc_overflow_shift);
4747
4748         /*
4749          * We just compare the lower bound here for performance reasons. Our
4750          * primary goals are to make sure that the arc never grows without
4751          * bound, and that it can reach its maximum size. This check
4752          * accomplishes both goals. The maximum amount we could run over by is
4753          * 2 * aggsum_borrow_multiplier * NUM_CPUS * the average size of a block
4754          * in the ARC. In practice, that's in the tens of MB, which is low
4755          * enough to be safe.
4756          */
4757         return (aggsum_lower_bound(&arc_size) >= arc_c + overflow);
4758 }
4759
4760 static abd_t *
4761 arc_get_data_abd(arc_buf_hdr_t *hdr, uint64_t size, void *tag)
4762 {
4763         arc_buf_contents_t type = arc_buf_type(hdr);
4764
4765         arc_get_data_impl(hdr, size, tag);
4766         if (type == ARC_BUFC_METADATA) {
4767                 return (abd_alloc(size, B_TRUE));
4768         } else {
4769                 ASSERT(type == ARC_BUFC_DATA);
4770                 return (abd_alloc(size, B_FALSE));
4771         }
4772 }
4773
4774 static void *
4775 arc_get_data_buf(arc_buf_hdr_t *hdr, uint64_t size, void *tag)
4776 {
4777         arc_buf_contents_t type = arc_buf_type(hdr);
4778
4779         arc_get_data_impl(hdr, size, tag);
4780         if (type == ARC_BUFC_METADATA) {
4781                 return (zio_buf_alloc(size));
4782         } else {
4783                 ASSERT(type == ARC_BUFC_DATA);
4784                 return (zio_data_buf_alloc(size));
4785         }
4786 }
4787
4788 /*
4789  * Allocate a block and return it to the caller. If we are hitting the
4790  * hard limit for the cache size, we must sleep, waiting for the eviction
4791  * thread to catch up. If we're past the target size but below the hard
4792  * limit, we'll only signal the reclaim thread and continue on.
4793  */
4794 static void
4795 arc_get_data_impl(arc_buf_hdr_t *hdr, uint64_t size, void *tag)
4796 {
4797         arc_state_t *state = hdr->b_l1hdr.b_state;
4798         arc_buf_contents_t type = arc_buf_type(hdr);
4799
4800         arc_adapt(size, state);
4801
4802         /*
4803          * If arc_size is currently overflowing, and has grown past our
4804          * upper limit, we must be adding data faster than the evict
4805          * thread can evict. Thus, to ensure we don't compound the
4806          * problem by adding more data and forcing arc_size to grow even
4807          * further past it's target size, we halt and wait for the
4808          * eviction thread to catch up.
4809          *
4810          * It's also possible that the reclaim thread is unable to evict
4811          * enough buffers to get arc_size below the overflow limit (e.g.
4812          * due to buffers being un-evictable, or hash lock collisions).
4813          * In this case, we want to proceed regardless if we're
4814          * overflowing; thus we don't use a while loop here.
4815          */
4816         if (arc_is_overflowing()) {
4817                 mutex_enter(&arc_reclaim_lock);
4818
4819                 /*
4820                  * Now that we've acquired the lock, we may no longer be
4821                  * over the overflow limit, lets check.
4822                  *
4823                  * We're ignoring the case of spurious wake ups. If that
4824                  * were to happen, it'd let this thread consume an ARC
4825                  * buffer before it should have (i.e. before we're under
4826                  * the overflow limit and were signalled by the reclaim
4827                  * thread). As long as that is a rare occurrence, it
4828                  * shouldn't cause any harm.
4829                  */
4830                 if (arc_is_overflowing()) {
4831                         cv_signal(&arc_reclaim_thread_cv);
4832                         cv_wait(&arc_reclaim_waiters_cv, &arc_reclaim_lock);
4833                 }
4834
4835                 mutex_exit(&arc_reclaim_lock);
4836         }
4837
4838         VERIFY3U(hdr->b_type, ==, type);
4839         if (type == ARC_BUFC_METADATA) {
4840                 arc_space_consume(size, ARC_SPACE_META);
4841         } else {
4842                 arc_space_consume(size, ARC_SPACE_DATA);
4843         }
4844
4845         /*
4846          * Update the state size.  Note that ghost states have a
4847          * "ghost size" and so don't need to be updated.
4848          */
4849         if (!GHOST_STATE(state)) {
4850
4851                 (void) refcount_add_many(&state->arcs_size, size, tag);
4852
4853                 /*
4854                  * If this is reached via arc_read, the link is
4855                  * protected by the hash lock. If reached via
4856                  * arc_buf_alloc, the header should not be accessed by
4857                  * any other thread. And, if reached via arc_read_done,
4858                  * the hash lock will protect it if it's found in the
4859                  * hash table; otherwise no other thread should be
4860                  * trying to [add|remove]_reference it.
4861                  */
4862                 if (multilist_link_active(&hdr->b_l1hdr.b_arc_node)) {
4863                         ASSERT(refcount_is_zero(&hdr->b_l1hdr.b_refcnt));
4864                         (void) refcount_add_many(&state->arcs_esize[type],
4865                             size, tag);
4866                 }
4867
4868                 /*
4869                  * If we are growing the cache, and we are adding anonymous
4870                  * data, and we have outgrown arc_p, update arc_p
4871                  */
4872                 if (aggsum_compare(&arc_size, arc_c) < 0 &&
4873                     hdr->b_l1hdr.b_state == arc_anon &&
4874                     (refcount_count(&arc_anon->arcs_size) +
4875                     refcount_count(&arc_mru->arcs_size) > arc_p))
4876                         arc_p = MIN(arc_c, arc_p + size);
4877         }
4878         ARCSTAT_BUMP(arcstat_allocated);
4879 }
4880
4881 static void
4882 arc_free_data_abd(arc_buf_hdr_t *hdr, abd_t *abd, uint64_t size, void *tag)
4883 {
4884         arc_free_data_impl(hdr, size, tag);
4885         abd_free(abd);
4886 }
4887
4888 static void
4889 arc_free_data_buf(arc_buf_hdr_t *hdr, void *buf, uint64_t size, void *tag)
4890 {
4891         arc_buf_contents_t type = arc_buf_type(hdr);
4892
4893         arc_free_data_impl(hdr, size, tag);
4894         if (type == ARC_BUFC_METADATA) {
4895                 zio_buf_free(buf, size);
4896         } else {
4897                 ASSERT(type == ARC_BUFC_DATA);
4898                 zio_data_buf_free(buf, size);
4899         }
4900 }
4901
4902 /*
4903  * Free the arc data buffer.
4904  */
4905 static void
4906 arc_free_data_impl(arc_buf_hdr_t *hdr, uint64_t size, void *tag)
4907 {
4908         arc_state_t *state = hdr->b_l1hdr.b_state;
4909         arc_buf_contents_t type = arc_buf_type(hdr);
4910
4911         /* protected by hash lock, if in the hash table */
4912         if (multilist_link_active(&hdr->b_l1hdr.b_arc_node)) {
4913                 ASSERT(refcount_is_zero(&hdr->b_l1hdr.b_refcnt));
4914                 ASSERT(state != arc_anon && state != arc_l2c_only);
4915
4916                 (void) refcount_remove_many(&state->arcs_esize[type],
4917                     size, tag);
4918         }
4919         (void) refcount_remove_many(&state->arcs_size, size, tag);
4920
4921         VERIFY3U(hdr->b_type, ==, type);
4922         if (type == ARC_BUFC_METADATA) {
4923                 arc_space_return(size, ARC_SPACE_META);
4924         } else {
4925                 ASSERT(type == ARC_BUFC_DATA);
4926                 arc_space_return(size, ARC_SPACE_DATA);
4927         }
4928 }
4929
4930 /*
4931  * This routine is called whenever a buffer is accessed.
4932  * NOTE: the hash lock is dropped in this function.
4933  */
4934 static void
4935 arc_access(arc_buf_hdr_t *hdr, kmutex_t *hash_lock)
4936 {
4937         clock_t now;
4938
4939         ASSERT(MUTEX_HELD(hash_lock));
4940         ASSERT(HDR_HAS_L1HDR(hdr));
4941
4942         if (hdr->b_l1hdr.b_state == arc_anon) {
4943                 /*
4944                  * This buffer is not in the cache, and does not
4945                  * appear in our "ghost" list.  Add the new buffer
4946                  * to the MRU state.
4947                  */
4948
4949                 ASSERT0(hdr->b_l1hdr.b_arc_access);
4950                 hdr->b_l1hdr.b_arc_access = ddi_get_lbolt();
4951                 DTRACE_PROBE1(new_state__mru, arc_buf_hdr_t *, hdr);
4952                 arc_change_state(arc_mru, hdr, hash_lock);
4953
4954         } else if (hdr->b_l1hdr.b_state == arc_mru) {
4955                 now = ddi_get_lbolt();
4956
4957                 /*
4958                  * If this buffer is here because of a prefetch, then either:
4959                  * - clear the flag if this is a "referencing" read
4960                  *   (any subsequent access will bump this into the MFU state).
4961                  * or
4962                  * - move the buffer to the head of the list if this is
4963                  *   another prefetch (to make it less likely to be evicted).
4964                  */
4965                 if (HDR_PREFETCH(hdr)) {
4966                         if (refcount_count(&hdr->b_l1hdr.b_refcnt) == 0) {
4967                                 /* link protected by hash lock */
4968                                 ASSERT(multilist_link_active(
4969                                     &hdr->b_l1hdr.b_arc_node));
4970                         } else {
4971                                 arc_hdr_clear_flags(hdr, ARC_FLAG_PREFETCH);
4972                                 ARCSTAT_BUMP(arcstat_mru_hits);
4973                         }
4974                         hdr->b_l1hdr.b_arc_access = now;
4975                         return;
4976                 }
4977
4978                 /*
4979                  * This buffer has been "accessed" only once so far,
4980                  * but it is still in the cache. Move it to the MFU
4981                  * state.
4982                  */
4983                 if (now > hdr->b_l1hdr.b_arc_access + ARC_MINTIME) {
4984                         /*
4985                          * More than 125ms have passed since we
4986                          * instantiated this buffer.  Move it to the
4987                          * most frequently used state.
4988                          */
4989                         hdr->b_l1hdr.b_arc_access = now;
4990                         DTRACE_PROBE1(new_state__mfu, arc_buf_hdr_t *, hdr);
4991                         arc_change_state(arc_mfu, hdr, hash_lock);
4992                 }
4993                 ARCSTAT_BUMP(arcstat_mru_hits);
4994         } else if (hdr->b_l1hdr.b_state == arc_mru_ghost) {
4995                 arc_state_t     *new_state;
4996                 /*
4997                  * This buffer has been "accessed" recently, but
4998                  * was evicted from the cache.  Move it to the
4999                  * MFU state.
5000                  */
5001
5002                 if (HDR_PREFETCH(hdr)) {
5003                         new_state = arc_mru;
5004                         if (refcount_count(&hdr->b_l1hdr.b_refcnt) > 0)
5005                                 arc_hdr_clear_flags(hdr, ARC_FLAG_PREFETCH);
5006                         DTRACE_PROBE1(new_state__mru, arc_buf_hdr_t *, hdr);
5007                 } else {
5008                         new_state = arc_mfu;
5009                         DTRACE_PROBE1(new_state__mfu, arc_buf_hdr_t *, hdr);
5010                 }
5011
5012                 hdr->b_l1hdr.b_arc_access = ddi_get_lbolt();
5013                 arc_change_state(new_state, hdr, hash_lock);
5014
5015                 ARCSTAT_BUMP(arcstat_mru_ghost_hits);
5016         } else if (hdr->b_l1hdr.b_state == arc_mfu) {
5017                 /*
5018                  * This buffer has been accessed more than once and is
5019                  * still in the cache.  Keep it in the MFU state.
5020                  *
5021                  * NOTE: an add_reference() that occurred when we did
5022                  * the arc_read() will have kicked this off the list.
5023                  * If it was a prefetch, we will explicitly move it to
5024                  * the head of the list now.
5025                  */
5026                 if ((HDR_PREFETCH(hdr)) != 0) {
5027                         ASSERT(refcount_is_zero(&hdr->b_l1hdr.b_refcnt));
5028                         /* link protected by hash_lock */
5029                         ASSERT(multilist_link_active(&hdr->b_l1hdr.b_arc_node));
5030                 }
5031                 ARCSTAT_BUMP(arcstat_mfu_hits);
5032                 hdr->b_l1hdr.b_arc_access = ddi_get_lbolt();
5033         } else if (hdr->b_l1hdr.b_state == arc_mfu_ghost) {
5034                 arc_state_t     *new_state = arc_mfu;
5035                 /*
5036                  * This buffer has been accessed more than once but has
5037                  * been evicted from the cache.  Move it back to the
5038                  * MFU state.
5039                  */
5040
5041                 if (HDR_PREFETCH(hdr)) {
5042                         /*
5043                          * This is a prefetch access...
5044                          * move this block back to the MRU state.
5045                          */
5046                         ASSERT0(refcount_count(&hdr->b_l1hdr.b_refcnt));
5047                         new_state = arc_mru;
5048                 }
5049
5050                 hdr->b_l1hdr.b_arc_access = ddi_get_lbolt();
5051                 DTRACE_PROBE1(new_state__mfu, arc_buf_hdr_t *, hdr);
5052                 arc_change_state(new_state, hdr, hash_lock);
5053
5054                 ARCSTAT_BUMP(arcstat_mfu_ghost_hits);
5055         } else if (hdr->b_l1hdr.b_state == arc_l2c_only) {
5056                 /*
5057                  * This buffer is on the 2nd Level ARC.
5058                  */
5059
5060                 hdr->b_l1hdr.b_arc_access = ddi_get_lbolt();
5061                 DTRACE_PROBE1(new_state__mfu, arc_buf_hdr_t *, hdr);
5062                 arc_change_state(arc_mfu, hdr, hash_lock);
5063         } else {
5064                 ASSERT(!"invalid arc state");
5065         }
5066 }
5067
5068 /* a generic arc_done_func_t which you can use */
5069 /* ARGSUSED */
5070 void
5071 arc_bcopy_func(zio_t *zio, arc_buf_t *buf, void *arg)
5072 {
5073         if (zio == NULL || zio->io_error == 0)
5074                 bcopy(buf->b_data, arg, arc_buf_size(buf));
5075         arc_buf_destroy(buf, arg);
5076 }
5077
5078 /* a generic arc_done_func_t */
5079 void
5080 arc_getbuf_func(zio_t *zio, arc_buf_t *buf, void *arg)
5081 {
5082         arc_buf_t **bufp = arg;
5083         if (zio && zio->io_error) {
5084                 arc_buf_destroy(buf, arg);
5085                 *bufp = NULL;
5086         } else {
5087                 *bufp = buf;
5088                 ASSERT(buf->b_data);
5089         }
5090 }
5091
5092 static void
5093 arc_hdr_verify(arc_buf_hdr_t *hdr, blkptr_t *bp)
5094 {
5095         if (BP_IS_HOLE(bp) || BP_IS_EMBEDDED(bp)) {
5096                 ASSERT3U(HDR_GET_PSIZE(hdr), ==, 0);
5097                 ASSERT3U(HDR_GET_COMPRESS(hdr), ==, ZIO_COMPRESS_OFF);
5098         } else {
5099                 if (HDR_COMPRESSION_ENABLED(hdr)) {
5100                         ASSERT3U(HDR_GET_COMPRESS(hdr), ==,
5101                             BP_GET_COMPRESS(bp));
5102                 }
5103                 ASSERT3U(HDR_GET_LSIZE(hdr), ==, BP_GET_LSIZE(bp));
5104                 ASSERT3U(HDR_GET_PSIZE(hdr), ==, BP_GET_PSIZE(bp));
5105         }
5106 }
5107
5108 static void
5109 arc_read_done(zio_t *zio)
5110 {
5111         arc_buf_hdr_t   *hdr = zio->io_private;
5112         kmutex_t        *hash_lock = NULL;
5113         arc_callback_t  *callback_list;
5114         arc_callback_t  *acb;
5115         boolean_t       freeable = B_FALSE;
5116         boolean_t       no_zio_error = (zio->io_error == 0);
5117
5118         /*
5119          * The hdr was inserted into hash-table and removed from lists
5120          * prior to starting I/O.  We should find this header, since
5121          * it's in the hash table, and it should be legit since it's
5122          * not possible to evict it during the I/O.  The only possible
5123          * reason for it not to be found is if we were freed during the
5124          * read.
5125          */
5126         if (HDR_IN_HASH_TABLE(hdr)) {
5127                 ASSERT3U(hdr->b_birth, ==, BP_PHYSICAL_BIRTH(zio->io_bp));
5128                 ASSERT3U(hdr->b_dva.dva_word[0], ==,
5129                     BP_IDENTITY(zio->io_bp)->dva_word[0]);
5130                 ASSERT3U(hdr->b_dva.dva_word[1], ==,
5131                     BP_IDENTITY(zio->io_bp)->dva_word[1]);
5132
5133                 arc_buf_hdr_t *found = buf_hash_find(hdr->b_spa, zio->io_bp,
5134                     &hash_lock);
5135
5136                 ASSERT((found == hdr &&
5137                     DVA_EQUAL(&hdr->b_dva, BP_IDENTITY(zio->io_bp))) ||
5138                     (found == hdr && HDR_L2_READING(hdr)));
5139                 ASSERT3P(hash_lock, !=, NULL);
5140         }
5141
5142         if (no_zio_error) {
5143                 /* byteswap if necessary */
5144                 if (BP_SHOULD_BYTESWAP(zio->io_bp)) {
5145                         if (BP_GET_LEVEL(zio->io_bp) > 0) {
5146                                 hdr->b_l1hdr.b_byteswap = DMU_BSWAP_UINT64;
5147                         } else {
5148                                 hdr->b_l1hdr.b_byteswap =
5149                                     DMU_OT_BYTESWAP(BP_GET_TYPE(zio->io_bp));
5150                         }
5151                 } else {
5152                         hdr->b_l1hdr.b_byteswap = DMU_BSWAP_NUMFUNCS;
5153                 }
5154         }
5155
5156         arc_hdr_clear_flags(hdr, ARC_FLAG_L2_EVICTED);
5157         if (l2arc_noprefetch && HDR_PREFETCH(hdr))
5158                 arc_hdr_clear_flags(hdr, ARC_FLAG_L2CACHE);
5159
5160         callback_list = hdr->b_l1hdr.b_acb;
5161         ASSERT3P(callback_list, !=, NULL);
5162
5163         if (hash_lock && no_zio_error && hdr->b_l1hdr.b_state == arc_anon) {
5164                 /*
5165                  * Only call arc_access on anonymous buffers.  This is because
5166                  * if we've issued an I/O for an evicted buffer, we've already
5167                  * called arc_access (to prevent any simultaneous readers from
5168                  * getting confused).
5169                  */
5170                 arc_access(hdr, hash_lock);
5171         }
5172
5173         /*
5174          * If a read request has a callback (i.e. acb_done is not NULL), then we
5175          * make a buf containing the data according to the parameters which were
5176          * passed in. The implementation of arc_buf_alloc_impl() ensures that we
5177          * aren't needlessly decompressing the data multiple times.
5178          */
5179         int callback_cnt = 0;
5180         for (acb = callback_list; acb != NULL; acb = acb->acb_next) {
5181                 if (!acb->acb_done)
5182                         continue;
5183
5184                 /* This is a demand read since prefetches don't use callbacks */
5185                 callback_cnt++;
5186
5187                 int error = arc_buf_alloc_impl(hdr, acb->acb_private,
5188                     acb->acb_compressed, no_zio_error, &acb->acb_buf);
5189                 if (no_zio_error) {
5190                         zio->io_error = error;
5191                 }
5192         }
5193         hdr->b_l1hdr.b_acb = NULL;
5194         arc_hdr_clear_flags(hdr, ARC_FLAG_IO_IN_PROGRESS);
5195         if (callback_cnt == 0) {
5196                 ASSERT(HDR_PREFETCH(hdr));
5197                 ASSERT0(hdr->b_l1hdr.b_bufcnt);
5198                 ASSERT3P(hdr->b_l1hdr.b_pabd, !=, NULL);
5199         }
5200
5201         ASSERT(refcount_is_zero(&hdr->b_l1hdr.b_refcnt) ||
5202             callback_list != NULL);
5203
5204         if (no_zio_error) {
5205                 arc_hdr_verify(hdr, zio->io_bp);
5206         } else {
5207                 arc_hdr_set_flags(hdr, ARC_FLAG_IO_ERROR);
5208                 if (hdr->b_l1hdr.b_state != arc_anon)
5209                         arc_change_state(arc_anon, hdr, hash_lock);
5210                 if (HDR_IN_HASH_TABLE(hdr))
5211                         buf_hash_remove(hdr);
5212                 freeable = refcount_is_zero(&hdr->b_l1hdr.b_refcnt);
5213         }
5214
5215         /*
5216          * Broadcast before we drop the hash_lock to avoid the possibility
5217          * that the hdr (and hence the cv) might be freed before we get to
5218          * the cv_broadcast().
5219          */
5220         cv_broadcast(&hdr->b_l1hdr.b_cv);
5221
5222         if (hash_lock != NULL) {
5223                 mutex_exit(hash_lock);
5224         } else {
5225                 /*
5226                  * This block was freed while we waited for the read to
5227                  * complete.  It has been removed from the hash table and
5228                  * moved to the anonymous state (so that it won't show up
5229                  * in the cache).
5230                  */
5231                 ASSERT3P(hdr->b_l1hdr.b_state, ==, arc_anon);
5232                 freeable = refcount_is_zero(&hdr->b_l1hdr.b_refcnt);
5233         }
5234
5235         /* execute each callback and free its structure */
5236         while ((acb = callback_list) != NULL) {
5237                 if (acb->acb_done)
5238                         acb->acb_done(zio, acb->acb_buf, acb->acb_private);
5239
5240                 if (acb->acb_zio_dummy != NULL) {
5241                         acb->acb_zio_dummy->io_error = zio->io_error;
5242                         zio_nowait(acb->acb_zio_dummy);
5243                 }
5244
5245                 callback_list = acb->acb_next;
5246                 kmem_free(acb, sizeof (arc_callback_t));
5247         }
5248
5249         if (freeable)
5250                 arc_hdr_destroy(hdr);
5251 }
5252
5253 /*
5254  * "Read" the block at the specified DVA (in bp) via the
5255  * cache.  If the block is found in the cache, invoke the provided
5256  * callback immediately and return.  Note that the `zio' parameter
5257  * in the callback will be NULL in this case, since no IO was
5258  * required.  If the block is not in the cache pass the read request
5259  * on to the spa with a substitute callback function, so that the
5260  * requested block will be added to the cache.
5261  *
5262  * If a read request arrives for a block that has a read in-progress,
5263  * either wait for the in-progress read to complete (and return the
5264  * results); or, if this is a read with a "done" func, add a record
5265  * to the read to invoke the "done" func when the read completes,
5266  * and return; or just return.
5267  *
5268  * arc_read_done() will invoke all the requested "done" functions
5269  * for readers of this block.
5270  */
5271 int
5272 arc_read(zio_t *pio, spa_t *spa, const blkptr_t *bp, arc_done_func_t *done,
5273     void *private, zio_priority_t priority, int zio_flags,
5274     arc_flags_t *arc_flags, const zbookmark_phys_t *zb)
5275 {
5276         arc_buf_hdr_t *hdr = NULL;
5277         kmutex_t *hash_lock = NULL;
5278         zio_t *rzio;
5279         uint64_t guid = spa_load_guid(spa);
5280         boolean_t compressed_read = (zio_flags & ZIO_FLAG_RAW) != 0;
5281
5282         ASSERT(!BP_IS_EMBEDDED(bp) ||
5283             BPE_GET_ETYPE(bp) == BP_EMBEDDED_TYPE_DATA);
5284
5285 top:
5286         if (!BP_IS_EMBEDDED(bp)) {
5287                 /*
5288                  * Embedded BP's have no DVA and require no I/O to "read".
5289                  * Create an anonymous arc buf to back it.
5290                  */
5291                 hdr = buf_hash_find(guid, bp, &hash_lock);
5292         }
5293
5294         if (hdr != NULL && HDR_HAS_L1HDR(hdr) && hdr->b_l1hdr.b_pabd != NULL) {
5295                 arc_buf_t *buf = NULL;
5296                 *arc_flags |= ARC_FLAG_CACHED;
5297
5298                 if (HDR_IO_IN_PROGRESS(hdr)) {
5299
5300                         if ((hdr->b_flags & ARC_FLAG_PRIO_ASYNC_READ) &&
5301                             priority == ZIO_PRIORITY_SYNC_READ) {
5302                                 /*
5303                                  * This sync read must wait for an
5304                                  * in-progress async read (e.g. a predictive
5305                                  * prefetch).  Async reads are queued
5306                                  * separately at the vdev_queue layer, so
5307                                  * this is a form of priority inversion.
5308                                  * Ideally, we would "inherit" the demand
5309                                  * i/o's priority by moving the i/o from
5310                                  * the async queue to the synchronous queue,
5311                                  * but there is currently no mechanism to do
5312                                  * so.  Track this so that we can evaluate
5313                                  * the magnitude of this potential performance
5314                                  * problem.
5315                                  *
5316                                  * Note that if the prefetch i/o is already
5317                                  * active (has been issued to the device),
5318                                  * the prefetch improved performance, because
5319                                  * we issued it sooner than we would have
5320                                  * without the prefetch.
5321                                  */
5322                                 DTRACE_PROBE1(arc__sync__wait__for__async,
5323                                     arc_buf_hdr_t *, hdr);
5324                                 ARCSTAT_BUMP(arcstat_sync_wait_for_async);
5325                         }
5326                         if (hdr->b_flags & ARC_FLAG_PREDICTIVE_PREFETCH) {
5327                                 arc_hdr_clear_flags(hdr,
5328                                     ARC_FLAG_PREDICTIVE_PREFETCH);
5329                         }
5330
5331                         if (*arc_flags & ARC_FLAG_WAIT) {
5332                                 cv_wait(&hdr->b_l1hdr.b_cv, hash_lock);
5333                                 mutex_exit(hash_lock);
5334                                 goto top;
5335                         }
5336                         ASSERT(*arc_flags & ARC_FLAG_NOWAIT);
5337
5338                         if (done) {
5339                                 arc_callback_t *acb = NULL;
5340
5341                                 acb = kmem_zalloc(sizeof (arc_callback_t),
5342                                     KM_SLEEP);
5343                                 acb->acb_done = done;
5344                                 acb->acb_private = private;
5345                                 acb->acb_compressed = compressed_read;
5346                                 if (pio != NULL)
5347                                         acb->acb_zio_dummy = zio_null(pio,
5348                                             spa, NULL, NULL, NULL, zio_flags);
5349
5350                                 ASSERT3P(acb->acb_done, !=, NULL);
5351                                 acb->acb_next = hdr->b_l1hdr.b_acb;
5352                                 hdr->b_l1hdr.b_acb = acb;
5353                                 mutex_exit(hash_lock);
5354                                 return (0);
5355                         }
5356                         mutex_exit(hash_lock);
5357                         return (0);
5358                 }
5359
5360                 ASSERT(hdr->b_l1hdr.b_state == arc_mru ||
5361                     hdr->b_l1hdr.b_state == arc_mfu);
5362
5363                 if (done) {
5364                         if (hdr->b_flags & ARC_FLAG_PREDICTIVE_PREFETCH) {
5365                                 /*
5366                                  * This is a demand read which does not have to
5367                                  * wait for i/o because we did a predictive
5368                                  * prefetch i/o for it, which has completed.
5369                                  */
5370                                 DTRACE_PROBE1(
5371                                     arc__demand__hit__predictive__prefetch,
5372                                     arc_buf_hdr_t *, hdr);
5373                                 ARCSTAT_BUMP(
5374                                     arcstat_demand_hit_predictive_prefetch);
5375                                 arc_hdr_clear_flags(hdr,
5376                                     ARC_FLAG_PREDICTIVE_PREFETCH);
5377                         }
5378                         ASSERT(!BP_IS_EMBEDDED(bp) || !BP_IS_HOLE(bp));
5379
5380                         /* Get a buf with the desired data in it. */
5381                         VERIFY0(arc_buf_alloc_impl(hdr, private,
5382                             compressed_read, B_TRUE, &buf));
5383                 } else if (*arc_flags & ARC_FLAG_PREFETCH &&
5384                     refcount_count(&hdr->b_l1hdr.b_refcnt) == 0) {
5385                         arc_hdr_set_flags(hdr, ARC_FLAG_PREFETCH);
5386                 }
5387                 DTRACE_PROBE1(arc__hit, arc_buf_hdr_t *, hdr);
5388                 arc_access(hdr, hash_lock);
5389                 if (*arc_flags & ARC_FLAG_L2CACHE)
5390                         arc_hdr_set_flags(hdr, ARC_FLAG_L2CACHE);
5391                 mutex_exit(hash_lock);
5392                 ARCSTAT_BUMP(arcstat_hits);
5393                 ARCSTAT_CONDSTAT(!HDR_PREFETCH(hdr),
5394                     demand, prefetch, !HDR_ISTYPE_METADATA(hdr),
5395                     data, metadata, hits);
5396
5397                 if (done)
5398                         done(NULL, buf, private);
5399         } else {
5400                 uint64_t lsize = BP_GET_LSIZE(bp);
5401                 uint64_t psize = BP_GET_PSIZE(bp);
5402                 arc_callback_t *acb;
5403                 vdev_t *vd = NULL;
5404                 uint64_t addr = 0;
5405                 boolean_t devw = B_FALSE;
5406                 uint64_t size;
5407
5408                 if (hdr == NULL) {
5409                         /* this block is not in the cache */
5410                         arc_buf_hdr_t *exists = NULL;
5411                         arc_buf_contents_t type = BP_GET_BUFC_TYPE(bp);
5412                         hdr = arc_hdr_alloc(spa_load_guid(spa), psize, lsize,
5413                             BP_GET_COMPRESS(bp), type);
5414
5415                         if (!BP_IS_EMBEDDED(bp)) {
5416                                 hdr->b_dva = *BP_IDENTITY(bp);
5417                                 hdr->b_birth = BP_PHYSICAL_BIRTH(bp);
5418                                 exists = buf_hash_insert(hdr, &hash_lock);
5419                         }
5420                         if (exists != NULL) {
5421                                 /* somebody beat us to the hash insert */
5422                                 mutex_exit(hash_lock);
5423                                 buf_discard_identity(hdr);
5424                                 arc_hdr_destroy(hdr);
5425                                 goto top; /* restart the IO request */
5426                         }
5427                 } else {
5428                         /*
5429                          * This block is in the ghost cache. If it was L2-only
5430                          * (and thus didn't have an L1 hdr), we realloc the
5431                          * header to add an L1 hdr.
5432                          */
5433                         if (!HDR_HAS_L1HDR(hdr)) {
5434                                 hdr = arc_hdr_realloc(hdr, hdr_l2only_cache,
5435                                     hdr_full_cache);
5436                         }
5437                         ASSERT3P(hdr->b_l1hdr.b_pabd, ==, NULL);
5438                         ASSERT(GHOST_STATE(hdr->b_l1hdr.b_state));
5439                         ASSERT(!HDR_IO_IN_PROGRESS(hdr));
5440                         ASSERT(refcount_is_zero(&hdr->b_l1hdr.b_refcnt));
5441                         ASSERT3P(hdr->b_l1hdr.b_buf, ==, NULL);
5442                         ASSERT3P(hdr->b_l1hdr.b_freeze_cksum, ==, NULL);
5443
5444                         /*
5445                          * This is a delicate dance that we play here.
5446                          * This hdr is in the ghost list so we access it
5447                          * to move it out of the ghost list before we
5448                          * initiate the read. If it's a prefetch then
5449                          * it won't have a callback so we'll remove the
5450                          * reference that arc_buf_alloc_impl() created. We
5451                          * do this after we've called arc_access() to
5452                          * avoid hitting an assert in remove_reference().
5453                          */
5454                         arc_access(hdr, hash_lock);
5455                         arc_hdr_alloc_pabd(hdr);
5456                 }
5457                 ASSERT3P(hdr->b_l1hdr.b_pabd, !=, NULL);
5458                 size = arc_hdr_size(hdr);
5459
5460                 /*
5461                  * If compression is enabled on the hdr, then will do
5462                  * RAW I/O and will store the compressed data in the hdr's
5463                  * data block. Otherwise, the hdr's data block will contain
5464                  * the uncompressed data.
5465                  */
5466                 if (HDR_GET_COMPRESS(hdr) != ZIO_COMPRESS_OFF) {
5467                         zio_flags |= ZIO_FLAG_RAW;
5468                 }
5469
5470                 if (*arc_flags & ARC_FLAG_PREFETCH)
5471                         arc_hdr_set_flags(hdr, ARC_FLAG_PREFETCH);
5472                 if (*arc_flags & ARC_FLAG_L2CACHE)
5473                         arc_hdr_set_flags(hdr, ARC_FLAG_L2CACHE);
5474                 if (BP_GET_LEVEL(bp) > 0)
5475                         arc_hdr_set_flags(hdr, ARC_FLAG_INDIRECT);
5476                 if (*arc_flags & ARC_FLAG_PREDICTIVE_PREFETCH)
5477                         arc_hdr_set_flags(hdr, ARC_FLAG_PREDICTIVE_PREFETCH);
5478                 ASSERT(!GHOST_STATE(hdr->b_l1hdr.b_state));
5479
5480                 acb = kmem_zalloc(sizeof (arc_callback_t), KM_SLEEP);
5481                 acb->acb_done = done;
5482                 acb->acb_private = private;
5483                 acb->acb_compressed = compressed_read;
5484
5485                 ASSERT3P(hdr->b_l1hdr.b_acb, ==, NULL);
5486                 hdr->b_l1hdr.b_acb = acb;
5487                 arc_hdr_set_flags(hdr, ARC_FLAG_IO_IN_PROGRESS);
5488
5489                 if (HDR_HAS_L2HDR(hdr) &&
5490                     (vd = hdr->b_l2hdr.b_dev->l2ad_vdev) != NULL) {
5491                         devw = hdr->b_l2hdr.b_dev->l2ad_writing;
5492                         addr = hdr->b_l2hdr.b_daddr;
5493                         /*
5494                          * Lock out L2ARC device removal.
5495                          */
5496                         if (vdev_is_dead(vd) ||
5497                             !spa_config_tryenter(spa, SCL_L2ARC, vd, RW_READER))
5498                                 vd = NULL;
5499                 }
5500
5501                 if (priority == ZIO_PRIORITY_ASYNC_READ)
5502                         arc_hdr_set_flags(hdr, ARC_FLAG_PRIO_ASYNC_READ);
5503                 else
5504                         arc_hdr_clear_flags(hdr, ARC_FLAG_PRIO_ASYNC_READ);
5505
5506                 if (hash_lock != NULL)
5507                         mutex_exit(hash_lock);
5508
5509                 /*
5510                  * At this point, we have a level 1 cache miss.  Try again in
5511                  * L2ARC if possible.
5512                  */
5513                 ASSERT3U(HDR_GET_LSIZE(hdr), ==, lsize);
5514
5515                 DTRACE_PROBE4(arc__miss, arc_buf_hdr_t *, hdr, blkptr_t *, bp,
5516                     uint64_t, lsize, zbookmark_phys_t *, zb);
5517                 ARCSTAT_BUMP(arcstat_misses);
5518                 ARCSTAT_CONDSTAT(!HDR_PREFETCH(hdr),
5519                     demand, prefetch, !HDR_ISTYPE_METADATA(hdr),
5520                     data, metadata, misses);
5521 #ifdef _KERNEL
5522 #ifdef RACCT
5523                 if (racct_enable) {
5524                         PROC_LOCK(curproc);
5525                         racct_add_force(curproc, RACCT_READBPS, size);
5526                         racct_add_force(curproc, RACCT_READIOPS, 1);
5527                         PROC_UNLOCK(curproc);
5528                 }
5529 #endif /* RACCT */
5530                 curthread->td_ru.ru_inblock++;
5531 #endif
5532
5533                 if (vd != NULL && l2arc_ndev != 0 && !(l2arc_norw && devw)) {
5534                         /*
5535                          * Read from the L2ARC if the following are true:
5536                          * 1. The L2ARC vdev was previously cached.
5537                          * 2. This buffer still has L2ARC metadata.
5538                          * 3. This buffer isn't currently writing to the L2ARC.
5539                          * 4. The L2ARC entry wasn't evicted, which may
5540                          *    also have invalidated the vdev.
5541                          * 5. This isn't prefetch and l2arc_noprefetch is set.
5542                          */
5543                         if (HDR_HAS_L2HDR(hdr) &&
5544                             !HDR_L2_WRITING(hdr) && !HDR_L2_EVICTED(hdr) &&
5545                             !(l2arc_noprefetch && HDR_PREFETCH(hdr))) {
5546                                 l2arc_read_callback_t *cb;
5547                                 abd_t *abd;
5548                                 uint64_t asize;
5549
5550                                 DTRACE_PROBE1(l2arc__hit, arc_buf_hdr_t *, hdr);
5551                                 ARCSTAT_BUMP(arcstat_l2_hits);
5552
5553                                 cb = kmem_zalloc(sizeof (l2arc_read_callback_t),
5554                                     KM_SLEEP);
5555                                 cb->l2rcb_hdr = hdr;
5556                                 cb->l2rcb_bp = *bp;
5557                                 cb->l2rcb_zb = *zb;
5558                                 cb->l2rcb_flags = zio_flags;
5559
5560                                 asize = vdev_psize_to_asize(vd, size);
5561                                 if (asize != size) {
5562                                         abd = abd_alloc_for_io(asize,
5563                                             HDR_ISTYPE_METADATA(hdr));
5564                                         cb->l2rcb_abd = abd;
5565                                 } else {
5566                                         abd = hdr->b_l1hdr.b_pabd;
5567                                 }
5568
5569                                 ASSERT(addr >= VDEV_LABEL_START_SIZE &&
5570                                     addr + asize <= vd->vdev_psize -
5571                                     VDEV_LABEL_END_SIZE);
5572
5573                                 /*
5574                                  * l2arc read.  The SCL_L2ARC lock will be
5575                                  * released by l2arc_read_done().
5576                                  * Issue a null zio if the underlying buffer
5577                                  * was squashed to zero size by compression.
5578                                  */
5579                                 ASSERT3U(HDR_GET_COMPRESS(hdr), !=,
5580                                     ZIO_COMPRESS_EMPTY);
5581                                 rzio = zio_read_phys(pio, vd, addr,
5582                                     asize, abd,
5583                                     ZIO_CHECKSUM_OFF,
5584                                     l2arc_read_done, cb, priority,
5585                                     zio_flags | ZIO_FLAG_DONT_CACHE |
5586                                     ZIO_FLAG_CANFAIL |
5587                                     ZIO_FLAG_DONT_PROPAGATE |
5588                                     ZIO_FLAG_DONT_RETRY, B_FALSE);
5589                                 DTRACE_PROBE2(l2arc__read, vdev_t *, vd,
5590                                     zio_t *, rzio);
5591                                 ARCSTAT_INCR(arcstat_l2_read_bytes, size);
5592
5593                                 if (*arc_flags & ARC_FLAG_NOWAIT) {
5594                                         zio_nowait(rzio);
5595                                         return (0);
5596                                 }
5597
5598                                 ASSERT(*arc_flags & ARC_FLAG_WAIT);
5599                                 if (zio_wait(rzio) == 0)
5600                                         return (0);
5601
5602                                 /* l2arc read error; goto zio_read() */
5603                         } else {
5604                                 DTRACE_PROBE1(l2arc__miss,
5605                                     arc_buf_hdr_t *, hdr);
5606                                 ARCSTAT_BUMP(arcstat_l2_misses);
5607                                 if (HDR_L2_WRITING(hdr))
5608                                         ARCSTAT_BUMP(arcstat_l2_rw_clash);
5609                                 spa_config_exit(spa, SCL_L2ARC, vd);
5610                         }
5611                 } else {
5612                         if (vd != NULL)
5613                                 spa_config_exit(spa, SCL_L2ARC, vd);
5614                         if (l2arc_ndev != 0) {
5615                                 DTRACE_PROBE1(l2arc__miss,
5616                                     arc_buf_hdr_t *, hdr);
5617                                 ARCSTAT_BUMP(arcstat_l2_misses);
5618                         }
5619                 }
5620
5621                 rzio = zio_read(pio, spa, bp, hdr->b_l1hdr.b_pabd, size,
5622                     arc_read_done, hdr, priority, zio_flags, zb);
5623
5624                 if (*arc_flags & ARC_FLAG_WAIT)
5625                         return (zio_wait(rzio));
5626
5627                 ASSERT(*arc_flags & ARC_FLAG_NOWAIT);
5628                 zio_nowait(rzio);
5629         }
5630         return (0);
5631 }
5632
5633 /*
5634  * Notify the arc that a block was freed, and thus will never be used again.
5635  */
5636 void
5637 arc_freed(spa_t *spa, const blkptr_t *bp)
5638 {
5639         arc_buf_hdr_t *hdr;
5640         kmutex_t *hash_lock;
5641         uint64_t guid = spa_load_guid(spa);
5642
5643         ASSERT(!BP_IS_EMBEDDED(bp));
5644
5645         hdr = buf_hash_find(guid, bp, &hash_lock);
5646         if (hdr == NULL)
5647                 return;
5648
5649         /*
5650          * We might be trying to free a block that is still doing I/O
5651          * (i.e. prefetch) or has a reference (i.e. a dedup-ed,
5652          * dmu_sync-ed block). If this block is being prefetched, then it
5653          * would still have the ARC_FLAG_IO_IN_PROGRESS flag set on the hdr
5654          * until the I/O completes. A block may also have a reference if it is
5655          * part of a dedup-ed, dmu_synced write. The dmu_sync() function would
5656          * have written the new block to its final resting place on disk but
5657          * without the dedup flag set. This would have left the hdr in the MRU
5658          * state and discoverable. When the txg finally syncs it detects that
5659          * the block was overridden in open context and issues an override I/O.
5660          * Since this is a dedup block, the override I/O will determine if the
5661          * block is already in the DDT. If so, then it will replace the io_bp
5662          * with the bp from the DDT and allow the I/O to finish. When the I/O
5663          * reaches the done callback, dbuf_write_override_done, it will
5664          * check to see if the io_bp and io_bp_override are identical.
5665          * If they are not, then it indicates that the bp was replaced with
5666          * the bp in the DDT and the override bp is freed. This allows
5667          * us to arrive here with a reference on a block that is being
5668          * freed. So if we have an I/O in progress, or a reference to
5669          * this hdr, then we don't destroy the hdr.
5670          */
5671         if (!HDR_HAS_L1HDR(hdr) || (!HDR_IO_IN_PROGRESS(hdr) &&
5672             refcount_is_zero(&hdr->b_l1hdr.b_refcnt))) {
5673                 arc_change_state(arc_anon, hdr, hash_lock);
5674                 arc_hdr_destroy(hdr);
5675                 mutex_exit(hash_lock);
5676         } else {
5677                 mutex_exit(hash_lock);
5678         }
5679
5680 }
5681
5682 /*
5683  * Release this buffer from the cache, making it an anonymous buffer.  This
5684  * must be done after a read and prior to modifying the buffer contents.
5685  * If the buffer has more than one reference, we must make
5686  * a new hdr for the buffer.
5687  */
5688 void
5689 arc_release(arc_buf_t *buf, void *tag)
5690 {
5691         arc_buf_hdr_t *hdr = buf->b_hdr;
5692
5693         /*
5694          * It would be nice to assert that if it's DMU metadata (level >
5695          * 0 || it's the dnode file), then it must be syncing context.
5696          * But we don't know that information at this level.
5697          */
5698
5699         mutex_enter(&buf->b_evict_lock);
5700
5701         ASSERT(HDR_HAS_L1HDR(hdr));
5702
5703         /*
5704          * We don't grab the hash lock prior to this check, because if
5705          * the buffer's header is in the arc_anon state, it won't be
5706          * linked into the hash table.
5707          */
5708         if (hdr->b_l1hdr.b_state == arc_anon) {
5709                 mutex_exit(&buf->b_evict_lock);
5710                 ASSERT(!HDR_IO_IN_PROGRESS(hdr));
5711                 ASSERT(!HDR_IN_HASH_TABLE(hdr));
5712                 ASSERT(!HDR_HAS_L2HDR(hdr));
5713                 ASSERT(HDR_EMPTY(hdr));
5714                 ASSERT3U(hdr->b_l1hdr.b_bufcnt, ==, 1);
5715                 ASSERT3S(refcount_count(&hdr->b_l1hdr.b_refcnt), ==, 1);
5716                 ASSERT(!list_link_active(&hdr->b_l1hdr.b_arc_node));
5717
5718                 hdr->b_l1hdr.b_arc_access = 0;
5719
5720                 /*
5721                  * If the buf is being overridden then it may already
5722                  * have a hdr that is not empty.
5723                  */
5724                 buf_discard_identity(hdr);
5725                 arc_buf_thaw(buf);
5726
5727                 return;
5728         }
5729
5730         kmutex_t *hash_lock = HDR_LOCK(hdr);
5731         mutex_enter(hash_lock);
5732
5733         /*
5734          * This assignment is only valid as long as the hash_lock is
5735          * held, we must be careful not to reference state or the
5736          * b_state field after dropping the lock.
5737          */
5738         arc_state_t *state = hdr->b_l1hdr.b_state;
5739         ASSERT3P(hash_lock, ==, HDR_LOCK(hdr));
5740         ASSERT3P(state, !=, arc_anon);
5741
5742         /* this buffer is not on any list */
5743         ASSERT3S(refcount_count(&hdr->b_l1hdr.b_refcnt), >, 0);
5744
5745         if (HDR_HAS_L2HDR(hdr)) {
5746                 mutex_enter(&hdr->b_l2hdr.b_dev->l2ad_mtx);
5747
5748                 /*
5749                  * We have to recheck this conditional again now that
5750                  * we're holding the l2ad_mtx to prevent a race with
5751                  * another thread which might be concurrently calling
5752                  * l2arc_evict(). In that case, l2arc_evict() might have
5753                  * destroyed the header's L2 portion as we were waiting
5754                  * to acquire the l2ad_mtx.
5755                  */
5756                 if (HDR_HAS_L2HDR(hdr)) {
5757                         l2arc_trim(hdr);
5758                         arc_hdr_l2hdr_destroy(hdr);
5759                 }
5760
5761                 mutex_exit(&hdr->b_l2hdr.b_dev->l2ad_mtx);
5762         }
5763
5764         /*
5765          * Do we have more than one buf?
5766          */
5767         if (hdr->b_l1hdr.b_bufcnt > 1) {
5768                 arc_buf_hdr_t *nhdr;
5769                 uint64_t spa = hdr->b_spa;
5770                 uint64_t psize = HDR_GET_PSIZE(hdr);
5771                 uint64_t lsize = HDR_GET_LSIZE(hdr);
5772                 enum zio_compress compress = HDR_GET_COMPRESS(hdr);
5773                 arc_buf_contents_t type = arc_buf_type(hdr);
5774                 VERIFY3U(hdr->b_type, ==, type);
5775
5776                 ASSERT(hdr->b_l1hdr.b_buf != buf || buf->b_next != NULL);
5777                 (void) remove_reference(hdr, hash_lock, tag);
5778
5779                 if (arc_buf_is_shared(buf) && !ARC_BUF_COMPRESSED(buf)) {
5780                         ASSERT3P(hdr->b_l1hdr.b_buf, !=, buf);
5781                         ASSERT(ARC_BUF_LAST(buf));
5782                 }
5783
5784                 /*
5785                  * Pull the data off of this hdr and attach it to
5786                  * a new anonymous hdr. Also find the last buffer
5787                  * in the hdr's buffer list.
5788                  */
5789                 arc_buf_t *lastbuf = arc_buf_remove(hdr, buf);
5790                 ASSERT3P(lastbuf, !=, NULL);
5791
5792                 /*
5793                  * If the current arc_buf_t and the hdr are sharing their data
5794                  * buffer, then we must stop sharing that block.
5795                  */
5796                 if (arc_buf_is_shared(buf)) {
5797                         VERIFY(!arc_buf_is_shared(lastbuf));
5798
5799                         /*
5800                          * First, sever the block sharing relationship between
5801                          * buf and the arc_buf_hdr_t.
5802                          */
5803                         arc_unshare_buf(hdr, buf);
5804
5805                         /*
5806                          * Now we need to recreate the hdr's b_pabd. Since we
5807                          * have lastbuf handy, we try to share with it, but if
5808                          * we can't then we allocate a new b_pabd and copy the
5809                          * data from buf into it.
5810                          */
5811                         if (arc_can_share(hdr, lastbuf)) {
5812                                 arc_share_buf(hdr, lastbuf);
5813                         } else {
5814                                 arc_hdr_alloc_pabd(hdr);
5815                                 abd_copy_from_buf(hdr->b_l1hdr.b_pabd,
5816                                     buf->b_data, psize);
5817                         }
5818                         VERIFY3P(lastbuf->b_data, !=, NULL);
5819                 } else if (HDR_SHARED_DATA(hdr)) {
5820                         /*
5821                          * Uncompressed shared buffers are always at the end
5822                          * of the list. Compressed buffers don't have the
5823                          * same requirements. This makes it hard to
5824                          * simply assert that the lastbuf is shared so
5825                          * we rely on the hdr's compression flags to determine
5826                          * if we have a compressed, shared buffer.
5827                          */
5828                         ASSERT(arc_buf_is_shared(lastbuf) ||
5829                             HDR_GET_COMPRESS(hdr) != ZIO_COMPRESS_OFF);
5830                         ASSERT(!ARC_BUF_SHARED(buf));
5831                 }
5832                 ASSERT3P(hdr->b_l1hdr.b_pabd, !=, NULL);
5833                 ASSERT3P(state, !=, arc_l2c_only);
5834
5835                 (void) refcount_remove_many(&state->arcs_size,
5836                     arc_buf_size(buf), buf);
5837
5838                 if (refcount_is_zero(&hdr->b_l1hdr.b_refcnt)) {
5839                         ASSERT3P(state, !=, arc_l2c_only);
5840                         (void) refcount_remove_many(&state->arcs_esize[type],
5841                             arc_buf_size(buf), buf);
5842                 }
5843
5844                 hdr->b_l1hdr.b_bufcnt -= 1;
5845                 arc_cksum_verify(buf);
5846 #ifdef illumos
5847                 arc_buf_unwatch(buf);
5848 #endif
5849
5850                 mutex_exit(hash_lock);
5851
5852                 /*
5853                  * Allocate a new hdr. The new hdr will contain a b_pabd
5854                  * buffer which will be freed in arc_write().
5855                  */
5856                 nhdr = arc_hdr_alloc(spa, psize, lsize, compress, type);
5857                 ASSERT3P(nhdr->b_l1hdr.b_buf, ==, NULL);
5858                 ASSERT0(nhdr->b_l1hdr.b_bufcnt);
5859                 ASSERT0(refcount_count(&nhdr->b_l1hdr.b_refcnt));
5860                 VERIFY3U(nhdr->b_type, ==, type);
5861                 ASSERT(!HDR_SHARED_DATA(nhdr));
5862
5863                 nhdr->b_l1hdr.b_buf = buf;
5864                 nhdr->b_l1hdr.b_bufcnt = 1;
5865                 (void) refcount_add(&nhdr->b_l1hdr.b_refcnt, tag);
5866                 buf->b_hdr = nhdr;
5867
5868                 mutex_exit(&buf->b_evict_lock);
5869                 (void) refcount_add_many(&arc_anon->arcs_size,
5870                     arc_buf_size(buf), buf);
5871         } else {
5872                 mutex_exit(&buf->b_evict_lock);
5873                 ASSERT(refcount_count(&hdr->b_l1hdr.b_refcnt) == 1);
5874                 /* protected by hash lock, or hdr is on arc_anon */
5875                 ASSERT(!multilist_link_active(&hdr->b_l1hdr.b_arc_node));
5876                 ASSERT(!HDR_IO_IN_PROGRESS(hdr));
5877                 arc_change_state(arc_anon, hdr, hash_lock);
5878                 hdr->b_l1hdr.b_arc_access = 0;
5879                 mutex_exit(hash_lock);
5880
5881                 buf_discard_identity(hdr);
5882                 arc_buf_thaw(buf);
5883         }
5884 }
5885
5886 int
5887 arc_released(arc_buf_t *buf)
5888 {
5889         int released;
5890
5891         mutex_enter(&buf->b_evict_lock);
5892         released = (buf->b_data != NULL &&
5893             buf->b_hdr->b_l1hdr.b_state == arc_anon);
5894         mutex_exit(&buf->b_evict_lock);
5895         return (released);
5896 }
5897
5898 #ifdef ZFS_DEBUG
5899 int
5900 arc_referenced(arc_buf_t *buf)
5901 {
5902         int referenced;
5903
5904         mutex_enter(&buf->b_evict_lock);
5905         referenced = (refcount_count(&buf->b_hdr->b_l1hdr.b_refcnt));
5906         mutex_exit(&buf->b_evict_lock);
5907         return (referenced);
5908 }
5909 #endif
5910
5911 static void
5912 arc_write_ready(zio_t *zio)
5913 {
5914         arc_write_callback_t *callback = zio->io_private;
5915         arc_buf_t *buf = callback->awcb_buf;
5916         arc_buf_hdr_t *hdr = buf->b_hdr;
5917         uint64_t psize = BP_IS_HOLE(zio->io_bp) ? 0 : BP_GET_PSIZE(zio->io_bp);
5918
5919         ASSERT(HDR_HAS_L1HDR(hdr));
5920         ASSERT(!refcount_is_zero(&buf->b_hdr->b_l1hdr.b_refcnt));
5921         ASSERT(hdr->b_l1hdr.b_bufcnt > 0);
5922
5923         /*
5924          * If we're reexecuting this zio because the pool suspended, then
5925          * cleanup any state that was previously set the first time the
5926          * callback was invoked.
5927          */
5928         if (zio->io_flags & ZIO_FLAG_REEXECUTED) {
5929                 arc_cksum_free(hdr);
5930 #ifdef illumos
5931                 arc_buf_unwatch(buf);
5932 #endif
5933                 if (hdr->b_l1hdr.b_pabd != NULL) {
5934                         if (arc_buf_is_shared(buf)) {
5935                                 arc_unshare_buf(hdr, buf);
5936                         } else {
5937                                 arc_hdr_free_pabd(hdr);
5938                         }
5939                 }
5940         }
5941         ASSERT3P(hdr->b_l1hdr.b_pabd, ==, NULL);
5942         ASSERT(!HDR_SHARED_DATA(hdr));
5943         ASSERT(!arc_buf_is_shared(buf));
5944
5945         callback->awcb_ready(zio, buf, callback->awcb_private);
5946
5947         if (HDR_IO_IN_PROGRESS(hdr))
5948                 ASSERT(zio->io_flags & ZIO_FLAG_REEXECUTED);
5949
5950         arc_cksum_compute(buf);
5951         arc_hdr_set_flags(hdr, ARC_FLAG_IO_IN_PROGRESS);
5952
5953         enum zio_compress compress;
5954         if (BP_IS_HOLE(zio->io_bp) || BP_IS_EMBEDDED(zio->io_bp)) {
5955                 compress = ZIO_COMPRESS_OFF;
5956         } else {
5957                 ASSERT3U(HDR_GET_LSIZE(hdr), ==, BP_GET_LSIZE(zio->io_bp));
5958                 compress = BP_GET_COMPRESS(zio->io_bp);
5959         }
5960         HDR_SET_PSIZE(hdr, psize);
5961         arc_hdr_set_compress(hdr, compress);
5962
5963
5964         /*
5965          * Fill the hdr with data. If the hdr is compressed, the data we want
5966          * is available from the zio, otherwise we can take it from the buf.
5967          *
5968          * We might be able to share the buf's data with the hdr here. However,
5969          * doing so would cause the ARC to be full of linear ABDs if we write a
5970          * lot of shareable data. As a compromise, we check whether scattered
5971          * ABDs are allowed, and assume that if they are then the user wants
5972          * the ARC to be primarily filled with them regardless of the data being
5973          * written. Therefore, if they're allowed then we allocate one and copy
5974          * the data into it; otherwise, we share the data directly if we can.
5975          */
5976         if (zfs_abd_scatter_enabled || !arc_can_share(hdr, buf)) {
5977                 arc_hdr_alloc_pabd(hdr);
5978
5979                 /*
5980                  * Ideally, we would always copy the io_abd into b_pabd, but the
5981                  * user may have disabled compressed ARC, thus we must check the
5982                  * hdr's compression setting rather than the io_bp's.
5983                  */
5984                 if (HDR_GET_COMPRESS(hdr) != ZIO_COMPRESS_OFF) {
5985                         ASSERT3U(BP_GET_COMPRESS(zio->io_bp), !=,
5986                             ZIO_COMPRESS_OFF);
5987                         ASSERT3U(psize, >, 0);
5988
5989                         abd_copy(hdr->b_l1hdr.b_pabd, zio->io_abd, psize);
5990                 } else {
5991                         ASSERT3U(zio->io_orig_size, ==, arc_hdr_size(hdr));
5992
5993                         abd_copy_from_buf(hdr->b_l1hdr.b_pabd, buf->b_data,
5994                             arc_buf_size(buf));
5995                 }
5996         } else {
5997                 ASSERT3P(buf->b_data, ==, abd_to_buf(zio->io_orig_abd));
5998                 ASSERT3U(zio->io_orig_size, ==, arc_buf_size(buf));
5999                 ASSERT3U(hdr->b_l1hdr.b_bufcnt, ==, 1);
6000
6001                 arc_share_buf(hdr, buf);
6002         }
6003
6004         arc_hdr_verify(hdr, zio->io_bp);
6005 }
6006
6007 static void
6008 arc_write_children_ready(zio_t *zio)
6009 {
6010         arc_write_callback_t *callback = zio->io_private;
6011         arc_buf_t *buf = callback->awcb_buf;
6012
6013         callback->awcb_children_ready(zio, buf, callback->awcb_private);
6014 }
6015
6016 /*
6017  * The SPA calls this callback for each physical write that happens on behalf
6018  * of a logical write.  See the comment in dbuf_write_physdone() for details.
6019  */
6020 static void
6021 arc_write_physdone(zio_t *zio)
6022 {
6023         arc_write_callback_t *cb = zio->io_private;
6024         if (cb->awcb_physdone != NULL)
6025                 cb->awcb_physdone(zio, cb->awcb_buf, cb->awcb_private);
6026 }
6027
6028 static void
6029 arc_write_done(zio_t *zio)
6030 {
6031         arc_write_callback_t *callback = zio->io_private;
6032         arc_buf_t *buf = callback->awcb_buf;
6033         arc_buf_hdr_t *hdr = buf->b_hdr;
6034
6035         ASSERT3P(hdr->b_l1hdr.b_acb, ==, NULL);
6036
6037         if (zio->io_error == 0) {
6038                 arc_hdr_verify(hdr, zio->io_bp);
6039
6040                 if (BP_IS_HOLE(zio->io_bp) || BP_IS_EMBEDDED(zio->io_bp)) {
6041                         buf_discard_identity(hdr);
6042                 } else {
6043                         hdr->b_dva = *BP_IDENTITY(zio->io_bp);
6044                         hdr->b_birth = BP_PHYSICAL_BIRTH(zio->io_bp);
6045                 }
6046         } else {
6047                 ASSERT(HDR_EMPTY(hdr));
6048         }
6049
6050         /*
6051          * If the block to be written was all-zero or compressed enough to be
6052          * embedded in the BP, no write was performed so there will be no
6053          * dva/birth/checksum.  The buffer must therefore remain anonymous
6054          * (and uncached).
6055          */
6056         if (!HDR_EMPTY(hdr)) {
6057                 arc_buf_hdr_t *exists;
6058                 kmutex_t *hash_lock;
6059
6060                 ASSERT3U(zio->io_error, ==, 0);
6061
6062                 arc_cksum_verify(buf);
6063
6064                 exists = buf_hash_insert(hdr, &hash_lock);
6065                 if (exists != NULL) {
6066                         /*
6067                          * This can only happen if we overwrite for
6068                          * sync-to-convergence, because we remove
6069                          * buffers from the hash table when we arc_free().
6070                          */
6071                         if (zio->io_flags & ZIO_FLAG_IO_REWRITE) {
6072                                 if (!BP_EQUAL(&zio->io_bp_orig, zio->io_bp))
6073                                         panic("bad overwrite, hdr=%p exists=%p",
6074                                             (void *)hdr, (void *)exists);
6075                                 ASSERT(refcount_is_zero(
6076                                     &exists->b_l1hdr.b_refcnt));
6077                                 arc_change_state(arc_anon, exists, hash_lock);
6078                                 mutex_exit(hash_lock);
6079                                 arc_hdr_destroy(exists);
6080                                 exists = buf_hash_insert(hdr, &hash_lock);
6081                                 ASSERT3P(exists, ==, NULL);
6082                         } else if (zio->io_flags & ZIO_FLAG_NOPWRITE) {
6083                                 /* nopwrite */
6084                                 ASSERT(zio->io_prop.zp_nopwrite);
6085                                 if (!BP_EQUAL(&zio->io_bp_orig, zio->io_bp))
6086                                         panic("bad nopwrite, hdr=%p exists=%p",
6087                                             (void *)hdr, (void *)exists);
6088                         } else {
6089                                 /* Dedup */
6090                                 ASSERT(hdr->b_l1hdr.b_bufcnt == 1);
6091                                 ASSERT(hdr->b_l1hdr.b_state == arc_anon);
6092                                 ASSERT(BP_GET_DEDUP(zio->io_bp));
6093                                 ASSERT(BP_GET_LEVEL(zio->io_bp) == 0);
6094                         }
6095                 }
6096                 arc_hdr_clear_flags(hdr, ARC_FLAG_IO_IN_PROGRESS);
6097                 /* if it's not anon, we are doing a scrub */
6098                 if (exists == NULL && hdr->b_l1hdr.b_state == arc_anon)
6099                         arc_access(hdr, hash_lock);
6100                 mutex_exit(hash_lock);
6101         } else {
6102                 arc_hdr_clear_flags(hdr, ARC_FLAG_IO_IN_PROGRESS);
6103         }
6104
6105         ASSERT(!refcount_is_zero(&hdr->b_l1hdr.b_refcnt));
6106         callback->awcb_done(zio, buf, callback->awcb_private);
6107
6108         abd_put(zio->io_abd);
6109         kmem_free(callback, sizeof (arc_write_callback_t));
6110 }
6111
6112 zio_t *
6113 arc_write(zio_t *pio, spa_t *spa, uint64_t txg, blkptr_t *bp, arc_buf_t *buf,
6114     boolean_t l2arc, const zio_prop_t *zp, arc_done_func_t *ready,
6115     arc_done_func_t *children_ready, arc_done_func_t *physdone,
6116     arc_done_func_t *done, void *private, zio_priority_t priority,
6117     int zio_flags, const zbookmark_phys_t *zb)
6118 {
6119         arc_buf_hdr_t *hdr = buf->b_hdr;
6120         arc_write_callback_t *callback;
6121         zio_t *zio;
6122         zio_prop_t localprop = *zp;
6123
6124         ASSERT3P(ready, !=, NULL);
6125         ASSERT3P(done, !=, NULL);
6126         ASSERT(!HDR_IO_ERROR(hdr));
6127         ASSERT(!HDR_IO_IN_PROGRESS(hdr));
6128         ASSERT3P(hdr->b_l1hdr.b_acb, ==, NULL);
6129         ASSERT3U(hdr->b_l1hdr.b_bufcnt, >, 0);
6130         if (l2arc)
6131                 arc_hdr_set_flags(hdr, ARC_FLAG_L2CACHE);
6132         if (ARC_BUF_COMPRESSED(buf)) {
6133                 /*
6134                  * We're writing a pre-compressed buffer.  Make the
6135                  * compression algorithm requested by the zio_prop_t match
6136                  * the pre-compressed buffer's compression algorithm.
6137                  */
6138                 localprop.zp_compress = HDR_GET_COMPRESS(hdr);
6139
6140                 ASSERT3U(HDR_GET_LSIZE(hdr), !=, arc_buf_size(buf));
6141                 zio_flags |= ZIO_FLAG_RAW;
6142         }
6143         callback = kmem_zalloc(sizeof (arc_write_callback_t), KM_SLEEP);
6144         callback->awcb_ready = ready;
6145         callback->awcb_children_ready = children_ready;
6146         callback->awcb_physdone = physdone;
6147         callback->awcb_done = done;
6148         callback->awcb_private = private;
6149         callback->awcb_buf = buf;
6150
6151         /*
6152          * The hdr's b_pabd is now stale, free it now. A new data block
6153          * will be allocated when the zio pipeline calls arc_write_ready().
6154          */
6155         if (hdr->b_l1hdr.b_pabd != NULL) {
6156                 /*
6157                  * If the buf is currently sharing the data block with
6158                  * the hdr then we need to break that relationship here.
6159                  * The hdr will remain with a NULL data pointer and the
6160                  * buf will take sole ownership of the block.
6161                  */
6162                 if (arc_buf_is_shared(buf)) {
6163                         arc_unshare_buf(hdr, buf);
6164                 } else {
6165                         arc_hdr_free_pabd(hdr);
6166                 }
6167                 VERIFY3P(buf->b_data, !=, NULL);
6168                 arc_hdr_set_compress(hdr, ZIO_COMPRESS_OFF);
6169         }
6170         ASSERT(!arc_buf_is_shared(buf));
6171         ASSERT3P(hdr->b_l1hdr.b_pabd, ==, NULL);
6172
6173         zio = zio_write(pio, spa, txg, bp,
6174             abd_get_from_buf(buf->b_data, HDR_GET_LSIZE(hdr)),
6175             HDR_GET_LSIZE(hdr), arc_buf_size(buf), &localprop, arc_write_ready,
6176             (children_ready != NULL) ? arc_write_children_ready : NULL,
6177             arc_write_physdone, arc_write_done, callback,
6178             priority, zio_flags, zb);
6179
6180         return (zio);
6181 }
6182
6183 static int
6184 arc_memory_throttle(uint64_t reserve, uint64_t txg)
6185 {
6186 #ifdef _KERNEL
6187         uint64_t available_memory = ptob(freemem);
6188         static uint64_t page_load = 0;
6189         static uint64_t last_txg = 0;
6190
6191 #if defined(__i386) || !defined(UMA_MD_SMALL_ALLOC)
6192         available_memory = MIN(available_memory, uma_avail());
6193 #endif
6194
6195         if (freemem > (uint64_t)physmem * arc_lotsfree_percent / 100)
6196                 return (0);
6197
6198         if (txg > last_txg) {
6199                 last_txg = txg;
6200                 page_load = 0;
6201         }
6202         /*
6203          * If we are in pageout, we know that memory is already tight,
6204          * the arc is already going to be evicting, so we just want to
6205          * continue to let page writes occur as quickly as possible.
6206          */
6207         if (curproc == pageproc) {
6208                 if (page_load > MAX(ptob(minfree), available_memory) / 4)
6209                         return (SET_ERROR(ERESTART));
6210                 /* Note: reserve is inflated, so we deflate */
6211                 page_load += reserve / 8;
6212                 return (0);
6213         } else if (page_load > 0 && arc_reclaim_needed()) {
6214                 /* memory is low, delay before restarting */
6215                 ARCSTAT_INCR(arcstat_memory_throttle_count, 1);
6216                 return (SET_ERROR(EAGAIN));
6217         }
6218         page_load = 0;
6219 #endif
6220         return (0);
6221 }
6222
6223 void
6224 arc_tempreserve_clear(uint64_t reserve)
6225 {
6226         atomic_add_64(&arc_tempreserve, -reserve);
6227         ASSERT((int64_t)arc_tempreserve >= 0);
6228 }
6229
6230 int
6231 arc_tempreserve_space(uint64_t reserve, uint64_t txg)
6232 {
6233         int error;
6234         uint64_t anon_size;
6235
6236         if (reserve > arc_c/4 && !arc_no_grow) {
6237                 arc_c = MIN(arc_c_max, reserve * 4);
6238                 DTRACE_PROBE1(arc__set_reserve, uint64_t, arc_c);
6239         }
6240         if (reserve > arc_c)
6241                 return (SET_ERROR(ENOMEM));
6242
6243         /*
6244          * Don't count loaned bufs as in flight dirty data to prevent long
6245          * network delays from blocking transactions that are ready to be
6246          * assigned to a txg.
6247          */
6248
6249         /* assert that it has not wrapped around */
6250         ASSERT3S(atomic_add_64_nv(&arc_loaned_bytes, 0), >=, 0);
6251
6252         anon_size = MAX((int64_t)(refcount_count(&arc_anon->arcs_size) -
6253             arc_loaned_bytes), 0);
6254
6255         /*
6256          * Writes will, almost always, require additional memory allocations
6257          * in order to compress/encrypt/etc the data.  We therefore need to
6258          * make sure that there is sufficient available memory for this.
6259          */
6260         error = arc_memory_throttle(reserve, txg);
6261         if (error != 0)
6262                 return (error);
6263
6264         /*
6265          * Throttle writes when the amount of dirty data in the cache
6266          * gets too large.  We try to keep the cache less than half full
6267          * of dirty blocks so that our sync times don't grow too large.
6268          * Note: if two requests come in concurrently, we might let them
6269          * both succeed, when one of them should fail.  Not a huge deal.
6270          */
6271
6272         if (reserve + arc_tempreserve + anon_size > arc_c / 2 &&
6273             anon_size > arc_c / 4) {
6274                 uint64_t meta_esize =
6275                     refcount_count(&arc_anon->arcs_esize[ARC_BUFC_METADATA]);
6276                 uint64_t data_esize =
6277                     refcount_count(&arc_anon->arcs_esize[ARC_BUFC_DATA]);
6278                 dprintf("failing, arc_tempreserve=%lluK anon_meta=%lluK "
6279                     "anon_data=%lluK tempreserve=%lluK arc_c=%lluK\n",
6280                     arc_tempreserve >> 10, meta_esize >> 10,
6281                     data_esize >> 10, reserve >> 10, arc_c >> 10);
6282                 return (SET_ERROR(ERESTART));
6283         }
6284         atomic_add_64(&arc_tempreserve, reserve);
6285         return (0);
6286 }
6287
6288 static void
6289 arc_kstat_update_state(arc_state_t *state, kstat_named_t *size,
6290     kstat_named_t *evict_data, kstat_named_t *evict_metadata)
6291 {
6292         size->value.ui64 = refcount_count(&state->arcs_size);
6293         evict_data->value.ui64 =
6294             refcount_count(&state->arcs_esize[ARC_BUFC_DATA]);
6295         evict_metadata->value.ui64 =
6296             refcount_count(&state->arcs_esize[ARC_BUFC_METADATA]);
6297 }
6298
6299 static int
6300 arc_kstat_update(kstat_t *ksp, int rw)
6301 {
6302         arc_stats_t *as = ksp->ks_data;
6303
6304         if (rw == KSTAT_WRITE) {
6305                 return (EACCES);
6306         } else {
6307                 arc_kstat_update_state(arc_anon,
6308                     &as->arcstat_anon_size,
6309                     &as->arcstat_anon_evictable_data,
6310                     &as->arcstat_anon_evictable_metadata);
6311                 arc_kstat_update_state(arc_mru,
6312                     &as->arcstat_mru_size,
6313                     &as->arcstat_mru_evictable_data,
6314                     &as->arcstat_mru_evictable_metadata);
6315                 arc_kstat_update_state(arc_mru_ghost,
6316                     &as->arcstat_mru_ghost_size,
6317                     &as->arcstat_mru_ghost_evictable_data,
6318                     &as->arcstat_mru_ghost_evictable_metadata);
6319                 arc_kstat_update_state(arc_mfu,
6320                     &as->arcstat_mfu_size,
6321                     &as->arcstat_mfu_evictable_data,
6322                     &as->arcstat_mfu_evictable_metadata);
6323                 arc_kstat_update_state(arc_mfu_ghost,
6324                     &as->arcstat_mfu_ghost_size,
6325                     &as->arcstat_mfu_ghost_evictable_data,
6326                     &as->arcstat_mfu_ghost_evictable_metadata);
6327
6328                 ARCSTAT(arcstat_size) = aggsum_value(&arc_size);
6329                 ARCSTAT(arcstat_meta_used) = aggsum_value(&arc_meta_used);
6330                 ARCSTAT(arcstat_data_size) = aggsum_value(&astat_data_size);
6331                 ARCSTAT(arcstat_metadata_size) =
6332                     aggsum_value(&astat_metadata_size);
6333                 ARCSTAT(arcstat_hdr_size) = aggsum_value(&astat_hdr_size);
6334                 ARCSTAT(arcstat_other_size) = aggsum_value(&astat_other_size);
6335                 ARCSTAT(arcstat_l2_hdr_size) = aggsum_value(&astat_l2_hdr_size);
6336         }
6337
6338         return (0);
6339 }
6340
6341 /*
6342  * This function *must* return indices evenly distributed between all
6343  * sublists of the multilist. This is needed due to how the ARC eviction
6344  * code is laid out; arc_evict_state() assumes ARC buffers are evenly
6345  * distributed between all sublists and uses this assumption when
6346  * deciding which sublist to evict from and how much to evict from it.
6347  */
6348 unsigned int
6349 arc_state_multilist_index_func(multilist_t *ml, void *obj)
6350 {
6351         arc_buf_hdr_t *hdr = obj;
6352
6353         /*
6354          * We rely on b_dva to generate evenly distributed index
6355          * numbers using buf_hash below. So, as an added precaution,
6356          * let's make sure we never add empty buffers to the arc lists.
6357          */
6358         ASSERT(!HDR_EMPTY(hdr));
6359
6360         /*
6361          * The assumption here, is the hash value for a given
6362          * arc_buf_hdr_t will remain constant throughout it's lifetime
6363          * (i.e. it's b_spa, b_dva, and b_birth fields don't change).
6364          * Thus, we don't need to store the header's sublist index
6365          * on insertion, as this index can be recalculated on removal.
6366          *
6367          * Also, the low order bits of the hash value are thought to be
6368          * distributed evenly. Otherwise, in the case that the multilist
6369          * has a power of two number of sublists, each sublists' usage
6370          * would not be evenly distributed.
6371          */
6372         return (buf_hash(hdr->b_spa, &hdr->b_dva, hdr->b_birth) %
6373             multilist_get_num_sublists(ml));
6374 }
6375
6376 #ifdef _KERNEL
6377 static eventhandler_tag arc_event_lowmem = NULL;
6378
6379 static void
6380 arc_lowmem(void *arg __unused, int howto __unused)
6381 {
6382
6383         mutex_enter(&arc_reclaim_lock);
6384         DTRACE_PROBE1(arc__needfree, int64_t, ((int64_t)freemem - zfs_arc_free_target) * PAGESIZE);
6385         cv_signal(&arc_reclaim_thread_cv);
6386
6387         /*
6388          * It is unsafe to block here in arbitrary threads, because we can come
6389          * here from ARC itself and may hold ARC locks and thus risk a deadlock
6390          * with ARC reclaim thread.
6391          */
6392         if (curproc == pageproc)
6393                 (void) cv_wait(&arc_reclaim_waiters_cv, &arc_reclaim_lock);
6394         mutex_exit(&arc_reclaim_lock);
6395 }
6396 #endif
6397
6398 static void
6399 arc_state_init(void)
6400 {
6401         arc_anon = &ARC_anon;
6402         arc_mru = &ARC_mru;
6403         arc_mru_ghost = &ARC_mru_ghost;
6404         arc_mfu = &ARC_mfu;
6405         arc_mfu_ghost = &ARC_mfu_ghost;
6406         arc_l2c_only = &ARC_l2c_only;
6407
6408         arc_mru->arcs_list[ARC_BUFC_METADATA] =
6409             multilist_create(sizeof (arc_buf_hdr_t),
6410             offsetof(arc_buf_hdr_t, b_l1hdr.b_arc_node),
6411             arc_state_multilist_index_func);
6412         arc_mru->arcs_list[ARC_BUFC_DATA] =
6413             multilist_create(sizeof (arc_buf_hdr_t),
6414             offsetof(arc_buf_hdr_t, b_l1hdr.b_arc_node),
6415             arc_state_multilist_index_func);
6416         arc_mru_ghost->arcs_list[ARC_BUFC_METADATA] =
6417             multilist_create(sizeof (arc_buf_hdr_t),
6418             offsetof(arc_buf_hdr_t, b_l1hdr.b_arc_node),
6419             arc_state_multilist_index_func);
6420         arc_mru_ghost->arcs_list[ARC_BUFC_DATA] =
6421             multilist_create(sizeof (arc_buf_hdr_t),
6422             offsetof(arc_buf_hdr_t, b_l1hdr.b_arc_node),
6423             arc_state_multilist_index_func);
6424         arc_mfu->arcs_list[ARC_BUFC_METADATA] =
6425             multilist_create(sizeof (arc_buf_hdr_t),
6426             offsetof(arc_buf_hdr_t, b_l1hdr.b_arc_node),
6427             arc_state_multilist_index_func);
6428         arc_mfu->arcs_list[ARC_BUFC_DATA] =
6429             multilist_create(sizeof (arc_buf_hdr_t),
6430             offsetof(arc_buf_hdr_t, b_l1hdr.b_arc_node),
6431             arc_state_multilist_index_func);
6432         arc_mfu_ghost->arcs_list[ARC_BUFC_METADATA] =
6433             multilist_create(sizeof (arc_buf_hdr_t),
6434             offsetof(arc_buf_hdr_t, b_l1hdr.b_arc_node),
6435             arc_state_multilist_index_func);
6436         arc_mfu_ghost->arcs_list[ARC_BUFC_DATA] =
6437             multilist_create(sizeof (arc_buf_hdr_t),
6438             offsetof(arc_buf_hdr_t, b_l1hdr.b_arc_node),
6439             arc_state_multilist_index_func);
6440         arc_l2c_only->arcs_list[ARC_BUFC_METADATA] =
6441             multilist_create(sizeof (arc_buf_hdr_t),
6442             offsetof(arc_buf_hdr_t, b_l1hdr.b_arc_node),
6443             arc_state_multilist_index_func);
6444         arc_l2c_only->arcs_list[ARC_BUFC_DATA] =
6445             multilist_create(sizeof (arc_buf_hdr_t),
6446             offsetof(arc_buf_hdr_t, b_l1hdr.b_arc_node),
6447             arc_state_multilist_index_func);
6448
6449         refcount_create(&arc_anon->arcs_esize[ARC_BUFC_METADATA]);
6450         refcount_create(&arc_anon->arcs_esize[ARC_BUFC_DATA]);
6451         refcount_create(&arc_mru->arcs_esize[ARC_BUFC_METADATA]);
6452         refcount_create(&arc_mru->arcs_esize[ARC_BUFC_DATA]);
6453         refcount_create(&arc_mru_ghost->arcs_esize[ARC_BUFC_METADATA]);
6454         refcount_create(&arc_mru_ghost->arcs_esize[ARC_BUFC_DATA]);
6455         refcount_create(&arc_mfu->arcs_esize[ARC_BUFC_METADATA]);
6456         refcount_create(&arc_mfu->arcs_esize[ARC_BUFC_DATA]);
6457         refcount_create(&arc_mfu_ghost->arcs_esize[ARC_BUFC_METADATA]);
6458         refcount_create(&arc_mfu_ghost->arcs_esize[ARC_BUFC_DATA]);
6459         refcount_create(&arc_l2c_only->arcs_esize[ARC_BUFC_METADATA]);
6460         refcount_create(&arc_l2c_only->arcs_esize[ARC_BUFC_DATA]);
6461
6462         refcount_create(&arc_anon->arcs_size);
6463         refcount_create(&arc_mru->arcs_size);
6464         refcount_create(&arc_mru_ghost->arcs_size);
6465         refcount_create(&arc_mfu->arcs_size);
6466         refcount_create(&arc_mfu_ghost->arcs_size);
6467         refcount_create(&arc_l2c_only->arcs_size);
6468
6469         aggsum_init(&arc_meta_used, 0);
6470         aggsum_init(&arc_size, 0);
6471         aggsum_init(&astat_data_size, 0);
6472         aggsum_init(&astat_metadata_size, 0);
6473         aggsum_init(&astat_hdr_size, 0);
6474         aggsum_init(&astat_other_size, 0);
6475         aggsum_init(&astat_l2_hdr_size, 0);
6476 }
6477
6478 static void
6479 arc_state_fini(void)
6480 {
6481         refcount_destroy(&arc_anon->arcs_esize[ARC_BUFC_METADATA]);
6482         refcount_destroy(&arc_anon->arcs_esize[ARC_BUFC_DATA]);
6483         refcount_destroy(&arc_mru->arcs_esize[ARC_BUFC_METADATA]);
6484         refcount_destroy(&arc_mru->arcs_esize[ARC_BUFC_DATA]);
6485         refcount_destroy(&arc_mru_ghost->arcs_esize[ARC_BUFC_METADATA]);
6486         refcount_destroy(&arc_mru_ghost->arcs_esize[ARC_BUFC_DATA]);
6487         refcount_destroy(&arc_mfu->arcs_esize[ARC_BUFC_METADATA]);
6488         refcount_destroy(&arc_mfu->arcs_esize[ARC_BUFC_DATA]);
6489         refcount_destroy(&arc_mfu_ghost->arcs_esize[ARC_BUFC_METADATA]);
6490         refcount_destroy(&arc_mfu_ghost->arcs_esize[ARC_BUFC_DATA]);
6491         refcount_destroy(&arc_l2c_only->arcs_esize[ARC_BUFC_METADATA]);
6492         refcount_destroy(&arc_l2c_only->arcs_esize[ARC_BUFC_DATA]);
6493
6494         refcount_destroy(&arc_anon->arcs_size);
6495         refcount_destroy(&arc_mru->arcs_size);
6496         refcount_destroy(&arc_mru_ghost->arcs_size);
6497         refcount_destroy(&arc_mfu->arcs_size);
6498         refcount_destroy(&arc_mfu_ghost->arcs_size);
6499         refcount_destroy(&arc_l2c_only->arcs_size);
6500
6501         multilist_destroy(arc_mru->arcs_list[ARC_BUFC_METADATA]);
6502         multilist_destroy(arc_mru_ghost->arcs_list[ARC_BUFC_METADATA]);
6503         multilist_destroy(arc_mfu->arcs_list[ARC_BUFC_METADATA]);
6504         multilist_destroy(arc_mfu_ghost->arcs_list[ARC_BUFC_METADATA]);
6505         multilist_destroy(arc_mru->arcs_list[ARC_BUFC_DATA]);
6506         multilist_destroy(arc_mru_ghost->arcs_list[ARC_BUFC_DATA]);
6507         multilist_destroy(arc_mfu->arcs_list[ARC_BUFC_DATA]);
6508         multilist_destroy(arc_mfu_ghost->arcs_list[ARC_BUFC_DATA]);
6509 }
6510
6511 uint64_t
6512 arc_max_bytes(void)
6513 {
6514         return (arc_c_max);
6515 }
6516
6517 void
6518 arc_init(void)
6519 {
6520         int i, prefetch_tunable_set = 0;
6521
6522         /*
6523          * allmem is "all memory that we could possibly use".
6524          */
6525 #ifdef illumos
6526 #ifdef _KERNEL
6527         uint64_t allmem = ptob(physmem - swapfs_minfree);
6528 #else
6529         uint64_t allmem = (physmem * PAGESIZE) / 2;
6530 #endif
6531 #else
6532         uint64_t allmem = kmem_size();
6533 #endif
6534
6535
6536         mutex_init(&arc_reclaim_lock, NULL, MUTEX_DEFAULT, NULL);
6537         cv_init(&arc_reclaim_thread_cv, NULL, CV_DEFAULT, NULL);
6538         cv_init(&arc_reclaim_waiters_cv, NULL, CV_DEFAULT, NULL);
6539
6540         mutex_init(&arc_dnlc_evicts_lock, NULL, MUTEX_DEFAULT, NULL);
6541         cv_init(&arc_dnlc_evicts_cv, NULL, CV_DEFAULT, NULL);
6542
6543         /* Convert seconds to clock ticks */
6544         arc_min_prefetch_lifespan = 1 * hz;
6545
6546         /* set min cache to 1/32 of all memory, or arc_abs_min, whichever is more */
6547         arc_c_min = MAX(allmem / 32, arc_abs_min);
6548         /* set max to 5/8 of all memory, or all but 1GB, whichever is more */
6549         if (allmem >= 1 << 30)
6550                 arc_c_max = allmem - (1 << 30);
6551         else
6552                 arc_c_max = arc_c_min;
6553         arc_c_max = MAX(allmem * 5 / 8, arc_c_max);
6554
6555         /*
6556          * In userland, there's only the memory pressure that we artificially
6557          * create (see arc_available_memory()).  Don't let arc_c get too
6558          * small, because it can cause transactions to be larger than
6559          * arc_c, causing arc_tempreserve_space() to fail.
6560          */
6561 #ifndef _KERNEL
6562         arc_c_min = arc_c_max / 2;
6563 #endif
6564
6565 #ifdef _KERNEL
6566         /*
6567          * Allow the tunables to override our calculations if they are
6568          * reasonable.
6569          */
6570         if (zfs_arc_max > arc_abs_min && zfs_arc_max < allmem) {
6571                 arc_c_max = zfs_arc_max;
6572                 arc_c_min = MIN(arc_c_min, arc_c_max);
6573         }
6574         if (zfs_arc_min > arc_abs_min && zfs_arc_min <= arc_c_max)
6575                 arc_c_min = zfs_arc_min;
6576 #endif
6577
6578         arc_c = arc_c_max;
6579         arc_p = (arc_c >> 1);
6580
6581         /* limit meta-data to 1/4 of the arc capacity */
6582         arc_meta_limit = arc_c_max / 4;
6583
6584 #ifdef _KERNEL
6585         /*
6586          * Metadata is stored in the kernel's heap.  Don't let us
6587          * use more than half the heap for the ARC.
6588          */
6589 #ifdef __FreeBSD__
6590         arc_meta_limit = MIN(arc_meta_limit, uma_limit() / 2);
6591 #else
6592         arc_meta_limit = MIN(arc_meta_limit,
6593             vmem_size(heap_arena, VMEM_ALLOC | VMEM_FREE) / 2);
6594 #endif
6595 #endif
6596
6597         /* Allow the tunable to override if it is reasonable */
6598         if (zfs_arc_meta_limit > 0 && zfs_arc_meta_limit <= arc_c_max)
6599                 arc_meta_limit = zfs_arc_meta_limit;
6600
6601         if (arc_c_min < arc_meta_limit / 2 && zfs_arc_min == 0)
6602                 arc_c_min = arc_meta_limit / 2;
6603
6604         if (zfs_arc_meta_min > 0) {
6605                 arc_meta_min = zfs_arc_meta_min;
6606         } else {
6607                 arc_meta_min = arc_c_min / 2;
6608         }
6609
6610         if (zfs_arc_grow_retry > 0)
6611                 arc_grow_retry = zfs_arc_grow_retry;
6612
6613         if (zfs_arc_shrink_shift > 0)
6614                 arc_shrink_shift = zfs_arc_shrink_shift;
6615
6616         if (zfs_arc_no_grow_shift > 0)
6617                 arc_no_grow_shift = zfs_arc_no_grow_shift;
6618         /*
6619          * Ensure that arc_no_grow_shift is less than arc_shrink_shift.
6620          */
6621         if (arc_no_grow_shift >= arc_shrink_shift)
6622                 arc_no_grow_shift = arc_shrink_shift - 1;
6623
6624         if (zfs_arc_p_min_shift > 0)
6625                 arc_p_min_shift = zfs_arc_p_min_shift;
6626
6627         /* if kmem_flags are set, lets try to use less memory */
6628         if (kmem_debugging())
6629                 arc_c = arc_c / 2;
6630         if (arc_c < arc_c_min)
6631                 arc_c = arc_c_min;
6632
6633         zfs_arc_min = arc_c_min;
6634         zfs_arc_max = arc_c_max;
6635
6636         arc_state_init();
6637         buf_init();
6638
6639         arc_reclaim_thread_exit = B_FALSE;
6640         arc_dnlc_evicts_thread_exit = FALSE;
6641
6642         arc_ksp = kstat_create("zfs", 0, "arcstats", "misc", KSTAT_TYPE_NAMED,
6643             sizeof (arc_stats) / sizeof (kstat_named_t), KSTAT_FLAG_VIRTUAL);
6644
6645         if (arc_ksp != NULL) {
6646                 arc_ksp->ks_data = &arc_stats;
6647                 arc_ksp->ks_update = arc_kstat_update;
6648                 kstat_install(arc_ksp);
6649         }
6650
6651         (void) thread_create(NULL, 0, arc_reclaim_thread, NULL, 0, &p0,
6652             TS_RUN, minclsyspri);
6653
6654 #ifdef _KERNEL
6655         arc_event_lowmem = EVENTHANDLER_REGISTER(vm_lowmem, arc_lowmem, NULL,
6656             EVENTHANDLER_PRI_FIRST);
6657 #endif
6658
6659         (void) thread_create(NULL, 0, arc_dnlc_evicts_thread, NULL, 0, &p0,
6660             TS_RUN, minclsyspri);
6661
6662         arc_dead = B_FALSE;
6663         arc_warm = B_FALSE;
6664
6665         /*
6666          * Calculate maximum amount of dirty data per pool.
6667          *
6668          * If it has been set by /etc/system, take that.
6669          * Otherwise, use a percentage of physical memory defined by
6670          * zfs_dirty_data_max_percent (default 10%) with a cap at
6671          * zfs_dirty_data_max_max (default 4GB).
6672          */
6673         if (zfs_dirty_data_max == 0) {
6674                 zfs_dirty_data_max = ptob(physmem) *
6675                     zfs_dirty_data_max_percent / 100;
6676                 zfs_dirty_data_max = MIN(zfs_dirty_data_max,
6677                     zfs_dirty_data_max_max);
6678         }
6679
6680 #ifdef _KERNEL
6681         if (TUNABLE_INT_FETCH("vfs.zfs.prefetch_disable", &zfs_prefetch_disable))
6682                 prefetch_tunable_set = 1;
6683
6684 #ifdef __i386__
6685         if (prefetch_tunable_set == 0) {
6686                 printf("ZFS NOTICE: Prefetch is disabled by default on i386 "
6687                     "-- to enable,\n");
6688                 printf("            add \"vfs.zfs.prefetch_disable=0\" "
6689                     "to /boot/loader.conf.\n");
6690                 zfs_prefetch_disable = 1;
6691         }
6692 #else
6693         if ((((uint64_t)physmem * PAGESIZE) < (1ULL << 32)) &&
6694             prefetch_tunable_set == 0) {
6695                 printf("ZFS NOTICE: Prefetch is disabled by default if less "
6696                     "than 4GB of RAM is present;\n"
6697                     "            to enable, add \"vfs.zfs.prefetch_disable=0\" "
6698                     "to /boot/loader.conf.\n");
6699                 zfs_prefetch_disable = 1;
6700         }
6701 #endif
6702         /* Warn about ZFS memory and address space requirements. */
6703         if (((uint64_t)physmem * PAGESIZE) < (256 + 128 + 64) * (1 << 20)) {
6704                 printf("ZFS WARNING: Recommended minimum RAM size is 512MB; "
6705                     "expect unstable behavior.\n");
6706         }
6707         if (allmem < 512 * (1 << 20)) {
6708                 printf("ZFS WARNING: Recommended minimum kmem_size is 512MB; "
6709                     "expect unstable behavior.\n");
6710                 printf("             Consider tuning vm.kmem_size and "
6711                     "vm.kmem_size_max\n");
6712                 printf("             in /boot/loader.conf.\n");
6713         }
6714 #endif
6715 }
6716
6717 void
6718 arc_fini(void)
6719 {
6720 #ifdef _KERNEL
6721         if (arc_event_lowmem != NULL)
6722                 EVENTHANDLER_DEREGISTER(vm_lowmem, arc_event_lowmem);
6723 #endif
6724
6725         mutex_enter(&arc_reclaim_lock);
6726         arc_reclaim_thread_exit = B_TRUE;
6727         /*
6728          * The reclaim thread will set arc_reclaim_thread_exit back to
6729          * B_FALSE when it is finished exiting; we're waiting for that.
6730          */
6731         while (arc_reclaim_thread_exit) {
6732                 cv_signal(&arc_reclaim_thread_cv);
6733                 cv_wait(&arc_reclaim_thread_cv, &arc_reclaim_lock);
6734         }
6735         mutex_exit(&arc_reclaim_lock);
6736
6737         /* Use B_TRUE to ensure *all* buffers are evicted */
6738         arc_flush(NULL, B_TRUE);
6739
6740         mutex_enter(&arc_dnlc_evicts_lock);
6741         arc_dnlc_evicts_thread_exit = TRUE;
6742         /*
6743          * The user evicts thread will set arc_user_evicts_thread_exit
6744          * to FALSE when it is finished exiting; we're waiting for that.
6745          */
6746         while (arc_dnlc_evicts_thread_exit) {
6747                 cv_signal(&arc_dnlc_evicts_cv);
6748                 cv_wait(&arc_dnlc_evicts_cv, &arc_dnlc_evicts_lock);
6749         }
6750         mutex_exit(&arc_dnlc_evicts_lock);
6751
6752         arc_dead = B_TRUE;
6753
6754         if (arc_ksp != NULL) {
6755                 kstat_delete(arc_ksp);
6756                 arc_ksp = NULL;
6757         }
6758
6759         mutex_destroy(&arc_reclaim_lock);
6760         cv_destroy(&arc_reclaim_thread_cv);
6761         cv_destroy(&arc_reclaim_waiters_cv);
6762
6763         mutex_destroy(&arc_dnlc_evicts_lock);
6764         cv_destroy(&arc_dnlc_evicts_cv);
6765
6766         arc_state_fini();
6767         buf_fini();
6768
6769         ASSERT0(arc_loaned_bytes);
6770 }
6771
6772 /*
6773  * Level 2 ARC
6774  *
6775  * The level 2 ARC (L2ARC) is a cache layer in-between main memory and disk.
6776  * It uses dedicated storage devices to hold cached data, which are populated
6777  * using large infrequent writes.  The main role of this cache is to boost
6778  * the performance of random read workloads.  The intended L2ARC devices
6779  * include short-stroked disks, solid state disks, and other media with
6780  * substantially faster read latency than disk.
6781  *
6782  *                 +-----------------------+
6783  *                 |         ARC           |
6784  *                 +-----------------------+
6785  *                    |         ^     ^
6786  *                    |         |     |
6787  *      l2arc_feed_thread()    arc_read()
6788  *                    |         |     |
6789  *                    |  l2arc read   |
6790  *                    V         |     |
6791  *               +---------------+    |
6792  *               |     L2ARC     |    |
6793  *               +---------------+    |
6794  *                   |    ^           |
6795  *          l2arc_write() |           |
6796  *                   |    |           |
6797  *                   V    |           |
6798  *                 +-------+      +-------+
6799  *                 | vdev  |      | vdev  |
6800  *                 | cache |      | cache |
6801  *                 +-------+      +-------+
6802  *                 +=========+     .-----.
6803  *                 :  L2ARC  :    |-_____-|
6804  *                 : devices :    | Disks |
6805  *                 +=========+    `-_____-'
6806  *
6807  * Read requests are satisfied from the following sources, in order:
6808  *
6809  *      1) ARC
6810  *      2) vdev cache of L2ARC devices
6811  *      3) L2ARC devices
6812  *      4) vdev cache of disks
6813  *      5) disks
6814  *
6815  * Some L2ARC device types exhibit extremely slow write performance.
6816  * To accommodate for this there are some significant differences between
6817  * the L2ARC and traditional cache design:
6818  *
6819  * 1. There is no eviction path from the ARC to the L2ARC.  Evictions from
6820  * the ARC behave as usual, freeing buffers and placing headers on ghost
6821  * lists.  The ARC does not send buffers to the L2ARC during eviction as
6822  * this would add inflated write latencies for all ARC memory pressure.
6823  *
6824  * 2. The L2ARC attempts to cache data from the ARC before it is evicted.
6825  * It does this by periodically scanning buffers from the eviction-end of
6826  * the MFU and MRU ARC lists, copying them to the L2ARC devices if they are
6827  * not already there. It scans until a headroom of buffers is satisfied,
6828  * which itself is a buffer for ARC eviction. If a compressible buffer is
6829  * found during scanning and selected for writing to an L2ARC device, we
6830  * temporarily boost scanning headroom during the next scan cycle to make
6831  * sure we adapt to compression effects (which might significantly reduce
6832  * the data volume we write to L2ARC). The thread that does this is
6833  * l2arc_feed_thread(), illustrated below; example sizes are included to
6834  * provide a better sense of ratio than this diagram:
6835  *
6836  *             head -->                        tail
6837  *              +---------------------+----------+
6838  *      ARC_mfu |:::::#:::::::::::::::|o#o###o###|-->.   # already on L2ARC
6839  *              +---------------------+----------+   |   o L2ARC eligible
6840  *      ARC_mru |:#:::::::::::::::::::|#o#ooo####|-->|   : ARC buffer
6841  *              +---------------------+----------+   |
6842  *                   15.9 Gbytes      ^ 32 Mbytes    |
6843  *                                 headroom          |
6844  *                                            l2arc_feed_thread()
6845  *                                                   |
6846  *                       l2arc write hand <--[oooo]--'
6847  *                               |           8 Mbyte
6848  *                               |          write max
6849  *                               V
6850  *                +==============================+
6851  *      L2ARC dev |####|#|###|###|    |####| ... |
6852  *                +==============================+
6853  *                           32 Gbytes
6854  *
6855  * 3. If an ARC buffer is copied to the L2ARC but then hit instead of
6856  * evicted, then the L2ARC has cached a buffer much sooner than it probably
6857  * needed to, potentially wasting L2ARC device bandwidth and storage.  It is
6858  * safe to say that this is an uncommon case, since buffers at the end of
6859  * the ARC lists have moved there due to inactivity.
6860  *
6861  * 4. If the ARC evicts faster than the L2ARC can maintain a headroom,
6862  * then the L2ARC simply misses copying some buffers.  This serves as a
6863  * pressure valve to prevent heavy read workloads from both stalling the ARC
6864  * with waits and clogging the L2ARC with writes.  This also helps prevent
6865  * the potential for the L2ARC to churn if it attempts to cache content too
6866  * quickly, such as during backups of the entire pool.
6867  *
6868  * 5. After system boot and before the ARC has filled main memory, there are
6869  * no evictions from the ARC and so the tails of the ARC_mfu and ARC_mru
6870  * lists can remain mostly static.  Instead of searching from tail of these
6871  * lists as pictured, the l2arc_feed_thread() will search from the list heads
6872  * for eligible buffers, greatly increasing its chance of finding them.
6873  *
6874  * The L2ARC device write speed is also boosted during this time so that
6875  * the L2ARC warms up faster.  Since there have been no ARC evictions yet,
6876  * there are no L2ARC reads, and no fear of degrading read performance
6877  * through increased writes.
6878  *
6879  * 6. Writes to the L2ARC devices are grouped and sent in-sequence, so that
6880  * the vdev queue can aggregate them into larger and fewer writes.  Each
6881  * device is written to in a rotor fashion, sweeping writes through
6882  * available space then repeating.
6883  *
6884  * 7. The L2ARC does not store dirty content.  It never needs to flush
6885  * write buffers back to disk based storage.
6886  *
6887  * 8. If an ARC buffer is written (and dirtied) which also exists in the
6888  * L2ARC, the now stale L2ARC buffer is immediately dropped.
6889  *
6890  * The performance of the L2ARC can be tweaked by a number of tunables, which
6891  * may be necessary for different workloads:
6892  *
6893  *      l2arc_write_max         max write bytes per interval
6894  *      l2arc_write_boost       extra write bytes during device warmup
6895  *      l2arc_noprefetch        skip caching prefetched buffers
6896  *      l2arc_headroom          number of max device writes to precache
6897  *      l2arc_headroom_boost    when we find compressed buffers during ARC
6898  *                              scanning, we multiply headroom by this
6899  *                              percentage factor for the next scan cycle,
6900  *                              since more compressed buffers are likely to
6901  *                              be present
6902  *      l2arc_feed_secs         seconds between L2ARC writing
6903  *
6904  * Tunables may be removed or added as future performance improvements are
6905  * integrated, and also may become zpool properties.
6906  *
6907  * There are three key functions that control how the L2ARC warms up:
6908  *
6909  *      l2arc_write_eligible()  check if a buffer is eligible to cache
6910  *      l2arc_write_size()      calculate how much to write
6911  *      l2arc_write_interval()  calculate sleep delay between writes
6912  *
6913  * These three functions determine what to write, how much, and how quickly
6914  * to send writes.
6915  */
6916
6917 static boolean_t
6918 l2arc_write_eligible(uint64_t spa_guid, arc_buf_hdr_t *hdr)
6919 {
6920         /*
6921          * A buffer is *not* eligible for the L2ARC if it:
6922          * 1. belongs to a different spa.
6923          * 2. is already cached on the L2ARC.
6924          * 3. has an I/O in progress (it may be an incomplete read).
6925          * 4. is flagged not eligible (zfs property).
6926          */
6927         if (hdr->b_spa != spa_guid) {
6928                 ARCSTAT_BUMP(arcstat_l2_write_spa_mismatch);
6929                 return (B_FALSE);
6930         }
6931         if (HDR_HAS_L2HDR(hdr)) {
6932                 ARCSTAT_BUMP(arcstat_l2_write_in_l2);
6933                 return (B_FALSE);
6934         }
6935         if (HDR_IO_IN_PROGRESS(hdr)) {
6936                 ARCSTAT_BUMP(arcstat_l2_write_hdr_io_in_progress);
6937                 return (B_FALSE);
6938         }
6939         if (!HDR_L2CACHE(hdr)) {
6940                 ARCSTAT_BUMP(arcstat_l2_write_not_cacheable);
6941                 return (B_FALSE);
6942         }
6943
6944         return (B_TRUE);
6945 }
6946
6947 static uint64_t
6948 l2arc_write_size(void)
6949 {
6950         uint64_t size;
6951
6952         /*
6953          * Make sure our globals have meaningful values in case the user
6954          * altered them.
6955          */
6956         size = l2arc_write_max;
6957         if (size == 0) {
6958                 cmn_err(CE_NOTE, "Bad value for l2arc_write_max, value must "
6959                     "be greater than zero, resetting it to the default (%d)",
6960                     L2ARC_WRITE_SIZE);
6961                 size = l2arc_write_max = L2ARC_WRITE_SIZE;
6962         }
6963
6964         if (arc_warm == B_FALSE)
6965                 size += l2arc_write_boost;
6966
6967         return (size);
6968
6969 }
6970
6971 static clock_t
6972 l2arc_write_interval(clock_t began, uint64_t wanted, uint64_t wrote)
6973 {
6974         clock_t interval, next, now;
6975
6976         /*
6977          * If the ARC lists are busy, increase our write rate; if the
6978          * lists are stale, idle back.  This is achieved by checking
6979          * how much we previously wrote - if it was more than half of
6980          * what we wanted, schedule the next write much sooner.
6981          */
6982         if (l2arc_feed_again && wrote > (wanted / 2))
6983                 interval = (hz * l2arc_feed_min_ms) / 1000;
6984         else
6985                 interval = hz * l2arc_feed_secs;
6986
6987         now = ddi_get_lbolt();
6988         next = MAX(now, MIN(now + interval, began + interval));
6989
6990         return (next);
6991 }
6992
6993 /*
6994  * Cycle through L2ARC devices.  This is how L2ARC load balances.
6995  * If a device is returned, this also returns holding the spa config lock.
6996  */
6997 static l2arc_dev_t *
6998 l2arc_dev_get_next(void)
6999 {
7000         l2arc_dev_t *first, *next = NULL;
7001
7002         /*
7003          * Lock out the removal of spas (spa_namespace_lock), then removal
7004          * of cache devices (l2arc_dev_mtx).  Once a device has been selected,
7005          * both locks will be dropped and a spa config lock held instead.
7006          */
7007         mutex_enter(&spa_namespace_lock);
7008         mutex_enter(&l2arc_dev_mtx);
7009
7010         /* if there are no vdevs, there is nothing to do */
7011         if (l2arc_ndev == 0)
7012                 goto out;
7013
7014         first = NULL;
7015         next = l2arc_dev_last;
7016         do {
7017                 /* loop around the list looking for a non-faulted vdev */
7018                 if (next == NULL) {
7019                         next = list_head(l2arc_dev_list);
7020                 } else {
7021                         next = list_next(l2arc_dev_list, next);
7022                         if (next == NULL)
7023                                 next = list_head(l2arc_dev_list);
7024                 }
7025
7026                 /* if we have come back to the start, bail out */
7027                 if (first == NULL)
7028                         first = next;
7029                 else if (next == first)
7030                         break;
7031
7032         } while (vdev_is_dead(next->l2ad_vdev));
7033
7034         /* if we were unable to find any usable vdevs, return NULL */
7035         if (vdev_is_dead(next->l2ad_vdev))
7036                 next = NULL;
7037
7038         l2arc_dev_last = next;
7039
7040 out:
7041         mutex_exit(&l2arc_dev_mtx);
7042
7043         /*
7044          * Grab the config lock to prevent the 'next' device from being
7045          * removed while we are writing to it.
7046          */
7047         if (next != NULL)
7048                 spa_config_enter(next->l2ad_spa, SCL_L2ARC, next, RW_READER);
7049         mutex_exit(&spa_namespace_lock);
7050
7051         return (next);
7052 }
7053
7054 /*
7055  * Free buffers that were tagged for destruction.
7056  */
7057 static void
7058 l2arc_do_free_on_write()
7059 {
7060         list_t *buflist;
7061         l2arc_data_free_t *df, *df_prev;
7062
7063         mutex_enter(&l2arc_free_on_write_mtx);
7064         buflist = l2arc_free_on_write;
7065
7066         for (df = list_tail(buflist); df; df = df_prev) {
7067                 df_prev = list_prev(buflist, df);
7068                 ASSERT3P(df->l2df_abd, !=, NULL);
7069                 abd_free(df->l2df_abd);
7070                 list_remove(buflist, df);
7071                 kmem_free(df, sizeof (l2arc_data_free_t));
7072         }
7073
7074         mutex_exit(&l2arc_free_on_write_mtx);
7075 }
7076
7077 /*
7078  * A write to a cache device has completed.  Update all headers to allow
7079  * reads from these buffers to begin.
7080  */
7081 static void
7082 l2arc_write_done(zio_t *zio)
7083 {
7084         l2arc_write_callback_t *cb;
7085         l2arc_dev_t *dev;
7086         list_t *buflist;
7087         arc_buf_hdr_t *head, *hdr, *hdr_prev;
7088         kmutex_t *hash_lock;
7089         int64_t bytes_dropped = 0;
7090
7091         cb = zio->io_private;
7092         ASSERT3P(cb, !=, NULL);
7093         dev = cb->l2wcb_dev;
7094         ASSERT3P(dev, !=, NULL);
7095         head = cb->l2wcb_head;
7096         ASSERT3P(head, !=, NULL);
7097         buflist = &dev->l2ad_buflist;
7098         ASSERT3P(buflist, !=, NULL);
7099         DTRACE_PROBE2(l2arc__iodone, zio_t *, zio,
7100             l2arc_write_callback_t *, cb);
7101
7102         if (zio->io_error != 0)
7103                 ARCSTAT_BUMP(arcstat_l2_writes_error);
7104
7105         /*
7106          * All writes completed, or an error was hit.
7107          */
7108 top:
7109         mutex_enter(&dev->l2ad_mtx);
7110         for (hdr = list_prev(buflist, head); hdr; hdr = hdr_prev) {
7111                 hdr_prev = list_prev(buflist, hdr);
7112
7113                 hash_lock = HDR_LOCK(hdr);
7114
7115                 /*
7116                  * We cannot use mutex_enter or else we can deadlock
7117                  * with l2arc_write_buffers (due to swapping the order
7118                  * the hash lock and l2ad_mtx are taken).
7119                  */
7120                 if (!mutex_tryenter(hash_lock)) {
7121                         /*
7122                          * Missed the hash lock. We must retry so we
7123                          * don't leave the ARC_FLAG_L2_WRITING bit set.
7124                          */
7125                         ARCSTAT_BUMP(arcstat_l2_writes_lock_retry);
7126
7127                         /*
7128                          * We don't want to rescan the headers we've
7129                          * already marked as having been written out, so
7130                          * we reinsert the head node so we can pick up
7131                          * where we left off.
7132                          */
7133                         list_remove(buflist, head);
7134                         list_insert_after(buflist, hdr, head);
7135
7136                         mutex_exit(&dev->l2ad_mtx);
7137
7138                         /*
7139                          * We wait for the hash lock to become available
7140                          * to try and prevent busy waiting, and increase
7141                          * the chance we'll be able to acquire the lock
7142                          * the next time around.
7143                          */
7144                         mutex_enter(hash_lock);
7145                         mutex_exit(hash_lock);
7146                         goto top;
7147                 }
7148
7149                 /*
7150                  * We could not have been moved into the arc_l2c_only
7151                  * state while in-flight due to our ARC_FLAG_L2_WRITING
7152                  * bit being set. Let's just ensure that's being enforced.
7153                  */
7154                 ASSERT(HDR_HAS_L1HDR(hdr));
7155
7156                 if (zio->io_error != 0) {
7157                         /*
7158                          * Error - drop L2ARC entry.
7159                          */
7160                         list_remove(buflist, hdr);
7161                         l2arc_trim(hdr);
7162                         arc_hdr_clear_flags(hdr, ARC_FLAG_HAS_L2HDR);
7163
7164                         ARCSTAT_INCR(arcstat_l2_psize, -arc_hdr_size(hdr));
7165                         ARCSTAT_INCR(arcstat_l2_lsize, -HDR_GET_LSIZE(hdr));
7166
7167                         bytes_dropped += arc_hdr_size(hdr);
7168                         (void) refcount_remove_many(&dev->l2ad_alloc,
7169                             arc_hdr_size(hdr), hdr);
7170                 }
7171
7172                 /*
7173                  * Allow ARC to begin reads and ghost list evictions to
7174                  * this L2ARC entry.
7175                  */
7176                 arc_hdr_clear_flags(hdr, ARC_FLAG_L2_WRITING);
7177
7178                 mutex_exit(hash_lock);
7179         }
7180
7181         atomic_inc_64(&l2arc_writes_done);
7182         list_remove(buflist, head);
7183         ASSERT(!HDR_HAS_L1HDR(head));
7184         kmem_cache_free(hdr_l2only_cache, head);
7185         mutex_exit(&dev->l2ad_mtx);
7186
7187         vdev_space_update(dev->l2ad_vdev, -bytes_dropped, 0, 0);
7188
7189         l2arc_do_free_on_write();
7190
7191         kmem_free(cb, sizeof (l2arc_write_callback_t));
7192 }
7193
7194 /*
7195  * A read to a cache device completed.  Validate buffer contents before
7196  * handing over to the regular ARC routines.
7197  */
7198 static void
7199 l2arc_read_done(zio_t *zio)
7200 {
7201         l2arc_read_callback_t *cb;
7202         arc_buf_hdr_t *hdr;
7203         kmutex_t *hash_lock;
7204         boolean_t valid_cksum;
7205
7206         ASSERT3P(zio->io_vd, !=, NULL);
7207         ASSERT(zio->io_flags & ZIO_FLAG_DONT_PROPAGATE);
7208
7209         spa_config_exit(zio->io_spa, SCL_L2ARC, zio->io_vd);
7210
7211         cb = zio->io_private;
7212         ASSERT3P(cb, !=, NULL);
7213         hdr = cb->l2rcb_hdr;
7214         ASSERT3P(hdr, !=, NULL);
7215
7216         hash_lock = HDR_LOCK(hdr);
7217         mutex_enter(hash_lock);
7218         ASSERT3P(hash_lock, ==, HDR_LOCK(hdr));
7219
7220         /*
7221          * If the data was read into a temporary buffer,
7222          * move it and free the buffer.
7223          */
7224         if (cb->l2rcb_abd != NULL) {
7225                 ASSERT3U(arc_hdr_size(hdr), <, zio->io_size);
7226                 if (zio->io_error == 0) {
7227                         abd_copy(hdr->b_l1hdr.b_pabd, cb->l2rcb_abd,
7228                             arc_hdr_size(hdr));
7229                 }
7230
7231                 /*
7232                  * The following must be done regardless of whether
7233                  * there was an error:
7234                  * - free the temporary buffer
7235                  * - point zio to the real ARC buffer
7236                  * - set zio size accordingly
7237                  * These are required because zio is either re-used for
7238                  * an I/O of the block in the case of the error
7239                  * or the zio is passed to arc_read_done() and it
7240                  * needs real data.
7241                  */
7242                 abd_free(cb->l2rcb_abd);
7243                 zio->io_size = zio->io_orig_size = arc_hdr_size(hdr);
7244                 zio->io_abd = zio->io_orig_abd = hdr->b_l1hdr.b_pabd;
7245         }
7246
7247         ASSERT3P(zio->io_abd, !=, NULL);
7248
7249         /*
7250          * Check this survived the L2ARC journey.
7251          */
7252         ASSERT3P(zio->io_abd, ==, hdr->b_l1hdr.b_pabd);
7253         zio->io_bp_copy = cb->l2rcb_bp; /* XXX fix in L2ARC 2.0 */
7254         zio->io_bp = &zio->io_bp_copy;  /* XXX fix in L2ARC 2.0 */
7255
7256         valid_cksum = arc_cksum_is_equal(hdr, zio);
7257         if (valid_cksum && zio->io_error == 0 && !HDR_L2_EVICTED(hdr)) {
7258                 mutex_exit(hash_lock);
7259                 zio->io_private = hdr;
7260                 arc_read_done(zio);
7261         } else {
7262                 mutex_exit(hash_lock);
7263                 /*
7264                  * Buffer didn't survive caching.  Increment stats and
7265                  * reissue to the original storage device.
7266                  */
7267                 if (zio->io_error != 0) {
7268                         ARCSTAT_BUMP(arcstat_l2_io_error);
7269                 } else {
7270                         zio->io_error = SET_ERROR(EIO);
7271                 }
7272                 if (!valid_cksum)
7273                         ARCSTAT_BUMP(arcstat_l2_cksum_bad);
7274
7275                 /*
7276                  * If there's no waiter, issue an async i/o to the primary
7277                  * storage now.  If there *is* a waiter, the caller must
7278                  * issue the i/o in a context where it's OK to block.
7279                  */
7280                 if (zio->io_waiter == NULL) {
7281                         zio_t *pio = zio_unique_parent(zio);
7282
7283                         ASSERT(!pio || pio->io_child_type == ZIO_CHILD_LOGICAL);
7284
7285                         zio_nowait(zio_read(pio, zio->io_spa, zio->io_bp,
7286                             hdr->b_l1hdr.b_pabd, zio->io_size, arc_read_done,
7287                             hdr, zio->io_priority, cb->l2rcb_flags,
7288                             &cb->l2rcb_zb));
7289                 }
7290         }
7291
7292         kmem_free(cb, sizeof (l2arc_read_callback_t));
7293 }
7294
7295 /*
7296  * This is the list priority from which the L2ARC will search for pages to
7297  * cache.  This is used within loops (0..3) to cycle through lists in the
7298  * desired order.  This order can have a significant effect on cache
7299  * performance.
7300  *
7301  * Currently the metadata lists are hit first, MFU then MRU, followed by
7302  * the data lists.  This function returns a locked list, and also returns
7303  * the lock pointer.
7304  */
7305 static multilist_sublist_t *
7306 l2arc_sublist_lock(int list_num)
7307 {
7308         multilist_t *ml = NULL;
7309         unsigned int idx;
7310
7311         ASSERT(list_num >= 0 && list_num <= 3);
7312
7313         switch (list_num) {
7314         case 0:
7315                 ml = arc_mfu->arcs_list[ARC_BUFC_METADATA];
7316                 break;
7317         case 1:
7318                 ml = arc_mru->arcs_list[ARC_BUFC_METADATA];
7319                 break;
7320         case 2:
7321                 ml = arc_mfu->arcs_list[ARC_BUFC_DATA];
7322                 break;
7323         case 3:
7324                 ml = arc_mru->arcs_list[ARC_BUFC_DATA];
7325                 break;
7326         }
7327
7328         /*
7329          * Return a randomly-selected sublist. This is acceptable
7330          * because the caller feeds only a little bit of data for each
7331          * call (8MB). Subsequent calls will result in different
7332          * sublists being selected.
7333          */
7334         idx = multilist_get_random_index(ml);
7335         return (multilist_sublist_lock(ml, idx));
7336 }
7337
7338 /*
7339  * Evict buffers from the device write hand to the distance specified in
7340  * bytes.  This distance may span populated buffers, it may span nothing.
7341  * This is clearing a region on the L2ARC device ready for writing.
7342  * If the 'all' boolean is set, every buffer is evicted.
7343  */
7344 static void
7345 l2arc_evict(l2arc_dev_t *dev, uint64_t distance, boolean_t all)
7346 {
7347         list_t *buflist;
7348         arc_buf_hdr_t *hdr, *hdr_prev;
7349         kmutex_t *hash_lock;
7350         uint64_t taddr;
7351
7352         buflist = &dev->l2ad_buflist;
7353
7354         if (!all && dev->l2ad_first) {
7355                 /*
7356                  * This is the first sweep through the device.  There is
7357                  * nothing to evict.
7358                  */
7359                 return;
7360         }
7361
7362         if (dev->l2ad_hand >= (dev->l2ad_end - (2 * distance))) {
7363                 /*
7364                  * When nearing the end of the device, evict to the end
7365                  * before the device write hand jumps to the start.
7366                  */
7367                 taddr = dev->l2ad_end;
7368         } else {
7369                 taddr = dev->l2ad_hand + distance;
7370         }
7371         DTRACE_PROBE4(l2arc__evict, l2arc_dev_t *, dev, list_t *, buflist,
7372             uint64_t, taddr, boolean_t, all);
7373
7374 top:
7375         mutex_enter(&dev->l2ad_mtx);
7376         for (hdr = list_tail(buflist); hdr; hdr = hdr_prev) {
7377                 hdr_prev = list_prev(buflist, hdr);
7378
7379                 hash_lock = HDR_LOCK(hdr);
7380
7381                 /*
7382                  * We cannot use mutex_enter or else we can deadlock
7383                  * with l2arc_write_buffers (due to swapping the order
7384                  * the hash lock and l2ad_mtx are taken).
7385                  */
7386                 if (!mutex_tryenter(hash_lock)) {
7387                         /*
7388                          * Missed the hash lock.  Retry.
7389                          */
7390                         ARCSTAT_BUMP(arcstat_l2_evict_lock_retry);
7391                         mutex_exit(&dev->l2ad_mtx);
7392                         mutex_enter(hash_lock);
7393                         mutex_exit(hash_lock);
7394                         goto top;
7395                 }
7396
7397                 /*
7398                  * A header can't be on this list if it doesn't have L2 header.
7399                  */
7400                 ASSERT(HDR_HAS_L2HDR(hdr));
7401
7402                 /* Ensure this header has finished being written. */
7403                 ASSERT(!HDR_L2_WRITING(hdr));
7404                 ASSERT(!HDR_L2_WRITE_HEAD(hdr));
7405
7406                 if (!all && (hdr->b_l2hdr.b_daddr >= taddr ||
7407                     hdr->b_l2hdr.b_daddr < dev->l2ad_hand)) {
7408                         /*
7409                          * We've evicted to the target address,
7410                          * or the end of the device.
7411                          */
7412                         mutex_exit(hash_lock);
7413                         break;
7414                 }
7415
7416                 if (!HDR_HAS_L1HDR(hdr)) {
7417                         ASSERT(!HDR_L2_READING(hdr));
7418                         /*
7419                          * This doesn't exist in the ARC.  Destroy.
7420                          * arc_hdr_destroy() will call list_remove()
7421                          * and decrement arcstat_l2_lsize.
7422                          */
7423                         arc_change_state(arc_anon, hdr, hash_lock);
7424                         arc_hdr_destroy(hdr);
7425                 } else {
7426                         ASSERT(hdr->b_l1hdr.b_state != arc_l2c_only);
7427                         ARCSTAT_BUMP(arcstat_l2_evict_l1cached);
7428                         /*
7429                          * Invalidate issued or about to be issued
7430                          * reads, since we may be about to write
7431                          * over this location.
7432                          */
7433                         if (HDR_L2_READING(hdr)) {
7434                                 ARCSTAT_BUMP(arcstat_l2_evict_reading);
7435                                 arc_hdr_set_flags(hdr, ARC_FLAG_L2_EVICTED);
7436                         }
7437
7438                         arc_hdr_l2hdr_destroy(hdr);
7439                 }
7440                 mutex_exit(hash_lock);
7441         }
7442         mutex_exit(&dev->l2ad_mtx);
7443 }
7444
7445 /*
7446  * Find and write ARC buffers to the L2ARC device.
7447  *
7448  * An ARC_FLAG_L2_WRITING flag is set so that the L2ARC buffers are not valid
7449  * for reading until they have completed writing.
7450  * The headroom_boost is an in-out parameter used to maintain headroom boost
7451  * state between calls to this function.
7452  *
7453  * Returns the number of bytes actually written (which may be smaller than
7454  * the delta by which the device hand has changed due to alignment).
7455  */
7456 static uint64_t
7457 l2arc_write_buffers(spa_t *spa, l2arc_dev_t *dev, uint64_t target_sz)
7458 {
7459         arc_buf_hdr_t *hdr, *hdr_prev, *head;
7460         uint64_t write_asize, write_psize, write_lsize, headroom;
7461         boolean_t full;
7462         l2arc_write_callback_t *cb;
7463         zio_t *pio, *wzio;
7464         uint64_t guid = spa_load_guid(spa);
7465         int try;
7466
7467         ASSERT3P(dev->l2ad_vdev, !=, NULL);
7468
7469         pio = NULL;
7470         write_lsize = write_asize = write_psize = 0;
7471         full = B_FALSE;
7472         head = kmem_cache_alloc(hdr_l2only_cache, KM_PUSHPAGE);
7473         arc_hdr_set_flags(head, ARC_FLAG_L2_WRITE_HEAD | ARC_FLAG_HAS_L2HDR);
7474
7475         ARCSTAT_BUMP(arcstat_l2_write_buffer_iter);
7476         /*
7477          * Copy buffers for L2ARC writing.
7478          */
7479         for (try = 0; try <= 3; try++) {
7480                 multilist_sublist_t *mls = l2arc_sublist_lock(try);
7481                 uint64_t passed_sz = 0;
7482
7483                 ARCSTAT_BUMP(arcstat_l2_write_buffer_list_iter);
7484
7485                 /*
7486                  * L2ARC fast warmup.
7487                  *
7488                  * Until the ARC is warm and starts to evict, read from the
7489                  * head of the ARC lists rather than the tail.
7490                  */
7491                 if (arc_warm == B_FALSE)
7492                         hdr = multilist_sublist_head(mls);
7493                 else
7494                         hdr = multilist_sublist_tail(mls);
7495                 if (hdr == NULL)
7496                         ARCSTAT_BUMP(arcstat_l2_write_buffer_list_null_iter);
7497
7498                 headroom = target_sz * l2arc_headroom;
7499                 if (zfs_compressed_arc_enabled)
7500                         headroom = (headroom * l2arc_headroom_boost) / 100;
7501
7502                 for (; hdr; hdr = hdr_prev) {
7503                         kmutex_t *hash_lock;
7504
7505                         if (arc_warm == B_FALSE)
7506                                 hdr_prev = multilist_sublist_next(mls, hdr);
7507                         else
7508                                 hdr_prev = multilist_sublist_prev(mls, hdr);
7509                         ARCSTAT_INCR(arcstat_l2_write_buffer_bytes_scanned,
7510                             HDR_GET_LSIZE(hdr));
7511
7512                         hash_lock = HDR_LOCK(hdr);
7513                         if (!mutex_tryenter(hash_lock)) {
7514                                 ARCSTAT_BUMP(arcstat_l2_write_trylock_fail);
7515                                 /*
7516                                  * Skip this buffer rather than waiting.
7517                                  */
7518                                 continue;
7519                         }
7520
7521                         passed_sz += HDR_GET_LSIZE(hdr);
7522                         if (passed_sz > headroom) {
7523                                 /*
7524                                  * Searched too far.
7525                                  */
7526                                 mutex_exit(hash_lock);
7527                                 ARCSTAT_BUMP(arcstat_l2_write_passed_headroom);
7528                                 break;
7529                         }
7530
7531                         if (!l2arc_write_eligible(guid, hdr)) {
7532                                 mutex_exit(hash_lock);
7533                                 continue;
7534                         }
7535
7536                         /*
7537                          * We rely on the L1 portion of the header below, so
7538                          * it's invalid for this header to have been evicted out
7539                          * of the ghost cache, prior to being written out. The
7540                          * ARC_FLAG_L2_WRITING bit ensures this won't happen.
7541                          */
7542                         ASSERT(HDR_HAS_L1HDR(hdr));
7543
7544                         ASSERT3U(HDR_GET_PSIZE(hdr), >, 0);
7545                         ASSERT3P(hdr->b_l1hdr.b_pabd, !=, NULL);
7546                         ASSERT3U(arc_hdr_size(hdr), >, 0);
7547                         uint64_t psize = arc_hdr_size(hdr);
7548                         uint64_t asize = vdev_psize_to_asize(dev->l2ad_vdev,
7549                             psize);
7550
7551                         if ((write_asize + asize) > target_sz) {
7552                                 full = B_TRUE;
7553                                 mutex_exit(hash_lock);
7554                                 ARCSTAT_BUMP(arcstat_l2_write_full);
7555                                 break;
7556                         }
7557
7558                         if (pio == NULL) {
7559                                 /*
7560                                  * Insert a dummy header on the buflist so
7561                                  * l2arc_write_done() can find where the
7562                                  * write buffers begin without searching.
7563                                  */
7564                                 mutex_enter(&dev->l2ad_mtx);
7565                                 list_insert_head(&dev->l2ad_buflist, head);
7566                                 mutex_exit(&dev->l2ad_mtx);
7567
7568                                 cb = kmem_alloc(
7569                                     sizeof (l2arc_write_callback_t), KM_SLEEP);
7570                                 cb->l2wcb_dev = dev;
7571                                 cb->l2wcb_head = head;
7572                                 pio = zio_root(spa, l2arc_write_done, cb,
7573                                     ZIO_FLAG_CANFAIL);
7574                                 ARCSTAT_BUMP(arcstat_l2_write_pios);
7575                         }
7576
7577                         hdr->b_l2hdr.b_dev = dev;
7578                         hdr->b_l2hdr.b_daddr = dev->l2ad_hand;
7579                         arc_hdr_set_flags(hdr,
7580                             ARC_FLAG_L2_WRITING | ARC_FLAG_HAS_L2HDR);
7581
7582                         mutex_enter(&dev->l2ad_mtx);
7583                         list_insert_head(&dev->l2ad_buflist, hdr);
7584                         mutex_exit(&dev->l2ad_mtx);
7585
7586                         (void) refcount_add_many(&dev->l2ad_alloc, psize, hdr);
7587
7588                         /*
7589                          * Normally the L2ARC can use the hdr's data, but if
7590                          * we're sharing data between the hdr and one of its
7591                          * bufs, L2ARC needs its own copy of the data so that
7592                          * the ZIO below can't race with the buf consumer.
7593                          * Another case where we need to create a copy of the
7594                          * data is when the buffer size is not device-aligned
7595                          * and we need to pad the block to make it such.
7596                          * That also keeps the clock hand suitably aligned.
7597                          *
7598                          * To ensure that the copy will be available for the
7599                          * lifetime of the ZIO and be cleaned up afterwards, we
7600                          * add it to the l2arc_free_on_write queue.
7601                          */
7602                         abd_t *to_write;
7603                         if (!HDR_SHARED_DATA(hdr) && psize == asize) {
7604                                 to_write = hdr->b_l1hdr.b_pabd;
7605                         } else {
7606                                 to_write = abd_alloc_for_io(asize,
7607                                     HDR_ISTYPE_METADATA(hdr));
7608                                 abd_copy(to_write, hdr->b_l1hdr.b_pabd, psize);
7609                                 if (asize != psize) {
7610                                         abd_zero_off(to_write, psize,
7611                                             asize - psize);
7612                                 }
7613                                 l2arc_free_abd_on_write(to_write, asize,
7614                                     arc_buf_type(hdr));
7615                         }
7616                         wzio = zio_write_phys(pio, dev->l2ad_vdev,
7617                             hdr->b_l2hdr.b_daddr, asize, to_write,
7618                             ZIO_CHECKSUM_OFF, NULL, hdr,
7619                             ZIO_PRIORITY_ASYNC_WRITE,
7620                             ZIO_FLAG_CANFAIL, B_FALSE);
7621
7622                         write_lsize += HDR_GET_LSIZE(hdr);
7623                         DTRACE_PROBE2(l2arc__write, vdev_t *, dev->l2ad_vdev,
7624                             zio_t *, wzio);
7625
7626                         write_psize += psize;
7627                         write_asize += asize;
7628                         dev->l2ad_hand += asize;
7629
7630                         mutex_exit(hash_lock);
7631
7632                         (void) zio_nowait(wzio);
7633                 }
7634
7635                 multilist_sublist_unlock(mls);
7636
7637                 if (full == B_TRUE)
7638                         break;
7639         }
7640
7641         /* No buffers selected for writing? */
7642         if (pio == NULL) {
7643                 ASSERT0(write_lsize);
7644                 ASSERT(!HDR_HAS_L1HDR(head));
7645                 kmem_cache_free(hdr_l2only_cache, head);
7646                 return (0);
7647         }
7648
7649         ASSERT3U(write_psize, <=, target_sz);
7650         ARCSTAT_BUMP(arcstat_l2_writes_sent);
7651         ARCSTAT_INCR(arcstat_l2_write_bytes, write_psize);
7652         ARCSTAT_INCR(arcstat_l2_lsize, write_lsize);
7653         ARCSTAT_INCR(arcstat_l2_psize, write_psize);
7654         vdev_space_update(dev->l2ad_vdev, write_psize, 0, 0);
7655
7656         /*
7657          * Bump device hand to the device start if it is approaching the end.
7658          * l2arc_evict() will already have evicted ahead for this case.
7659          */
7660         if (dev->l2ad_hand >= (dev->l2ad_end - target_sz)) {
7661                 dev->l2ad_hand = dev->l2ad_start;
7662                 dev->l2ad_first = B_FALSE;
7663         }
7664
7665         dev->l2ad_writing = B_TRUE;
7666         (void) zio_wait(pio);
7667         dev->l2ad_writing = B_FALSE;
7668
7669         return (write_asize);
7670 }
7671
7672 /*
7673  * This thread feeds the L2ARC at regular intervals.  This is the beating
7674  * heart of the L2ARC.
7675  */
7676 /* ARGSUSED */
7677 static void
7678 l2arc_feed_thread(void *unused __unused)
7679 {
7680         callb_cpr_t cpr;
7681         l2arc_dev_t *dev;
7682         spa_t *spa;
7683         uint64_t size, wrote;
7684         clock_t begin, next = ddi_get_lbolt();
7685
7686         CALLB_CPR_INIT(&cpr, &l2arc_feed_thr_lock, callb_generic_cpr, FTAG);
7687
7688         mutex_enter(&l2arc_feed_thr_lock);
7689
7690         while (l2arc_thread_exit == 0) {
7691                 CALLB_CPR_SAFE_BEGIN(&cpr);
7692                 (void) cv_timedwait(&l2arc_feed_thr_cv, &l2arc_feed_thr_lock,
7693                     next - ddi_get_lbolt());
7694                 CALLB_CPR_SAFE_END(&cpr, &l2arc_feed_thr_lock);
7695                 next = ddi_get_lbolt() + hz;
7696
7697                 /*
7698                  * Quick check for L2ARC devices.
7699                  */
7700                 mutex_enter(&l2arc_dev_mtx);
7701                 if (l2arc_ndev == 0) {
7702                         mutex_exit(&l2arc_dev_mtx);
7703                         continue;
7704                 }
7705                 mutex_exit(&l2arc_dev_mtx);
7706                 begin = ddi_get_lbolt();
7707
7708                 /*
7709                  * This selects the next l2arc device to write to, and in
7710                  * doing so the next spa to feed from: dev->l2ad_spa.   This
7711                  * will return NULL if there are now no l2arc devices or if
7712                  * they are all faulted.
7713                  *
7714                  * If a device is returned, its spa's config lock is also
7715                  * held to prevent device removal.  l2arc_dev_get_next()
7716                  * will grab and release l2arc_dev_mtx.
7717                  */
7718                 if ((dev = l2arc_dev_get_next()) == NULL)
7719                         continue;
7720
7721                 spa = dev->l2ad_spa;
7722                 ASSERT3P(spa, !=, NULL);
7723
7724                 /*
7725                  * If the pool is read-only then force the feed thread to
7726                  * sleep a little longer.
7727                  */
7728                 if (!spa_writeable(spa)) {
7729                         next = ddi_get_lbolt() + 5 * l2arc_feed_secs * hz;
7730                         spa_config_exit(spa, SCL_L2ARC, dev);
7731                         continue;
7732                 }
7733
7734                 /*
7735                  * Avoid contributing to memory pressure.
7736                  */
7737                 if (arc_reclaim_needed()) {
7738                         ARCSTAT_BUMP(arcstat_l2_abort_lowmem);
7739                         spa_config_exit(spa, SCL_L2ARC, dev);
7740                         continue;
7741                 }
7742
7743                 ARCSTAT_BUMP(arcstat_l2_feeds);
7744
7745                 size = l2arc_write_size();
7746
7747                 /*
7748                  * Evict L2ARC buffers that will be overwritten.
7749                  */
7750                 l2arc_evict(dev, size, B_FALSE);
7751
7752                 /*
7753                  * Write ARC buffers.
7754                  */
7755                 wrote = l2arc_write_buffers(spa, dev, size);
7756
7757                 /*
7758                  * Calculate interval between writes.
7759                  */
7760                 next = l2arc_write_interval(begin, size, wrote);
7761                 spa_config_exit(spa, SCL_L2ARC, dev);
7762         }
7763
7764         l2arc_thread_exit = 0;
7765         cv_broadcast(&l2arc_feed_thr_cv);
7766         CALLB_CPR_EXIT(&cpr);           /* drops l2arc_feed_thr_lock */
7767         thread_exit();
7768 }
7769
7770 boolean_t
7771 l2arc_vdev_present(vdev_t *vd)
7772 {
7773         l2arc_dev_t *dev;
7774
7775         mutex_enter(&l2arc_dev_mtx);
7776         for (dev = list_head(l2arc_dev_list); dev != NULL;
7777             dev = list_next(l2arc_dev_list, dev)) {
7778                 if (dev->l2ad_vdev == vd)
7779                         break;
7780         }
7781         mutex_exit(&l2arc_dev_mtx);
7782
7783         return (dev != NULL);
7784 }
7785
7786 /*
7787  * Add a vdev for use by the L2ARC.  By this point the spa has already
7788  * validated the vdev and opened it.
7789  */
7790 void
7791 l2arc_add_vdev(spa_t *spa, vdev_t *vd)
7792 {
7793         l2arc_dev_t *adddev;
7794
7795         ASSERT(!l2arc_vdev_present(vd));
7796
7797         vdev_ashift_optimize(vd);
7798
7799         /*
7800          * Create a new l2arc device entry.
7801          */
7802         adddev = kmem_zalloc(sizeof (l2arc_dev_t), KM_SLEEP);
7803         adddev->l2ad_spa = spa;
7804         adddev->l2ad_vdev = vd;
7805         adddev->l2ad_start = VDEV_LABEL_START_SIZE;
7806         adddev->l2ad_end = VDEV_LABEL_START_SIZE + vdev_get_min_asize(vd);
7807         adddev->l2ad_hand = adddev->l2ad_start;
7808         adddev->l2ad_first = B_TRUE;
7809         adddev->l2ad_writing = B_FALSE;
7810
7811         mutex_init(&adddev->l2ad_mtx, NULL, MUTEX_DEFAULT, NULL);
7812         /*
7813          * This is a list of all ARC buffers that are still valid on the
7814          * device.
7815          */
7816         list_create(&adddev->l2ad_buflist, sizeof (arc_buf_hdr_t),
7817             offsetof(arc_buf_hdr_t, b_l2hdr.b_l2node));
7818
7819         vdev_space_update(vd, 0, 0, adddev->l2ad_end - adddev->l2ad_hand);
7820         refcount_create(&adddev->l2ad_alloc);
7821
7822         /*
7823          * Add device to global list
7824          */
7825         mutex_enter(&l2arc_dev_mtx);
7826         list_insert_head(l2arc_dev_list, adddev);
7827         atomic_inc_64(&l2arc_ndev);
7828         mutex_exit(&l2arc_dev_mtx);
7829 }
7830
7831 /*
7832  * Remove a vdev from the L2ARC.
7833  */
7834 void
7835 l2arc_remove_vdev(vdev_t *vd)
7836 {
7837         l2arc_dev_t *dev, *nextdev, *remdev = NULL;
7838
7839         /*
7840          * Find the device by vdev
7841          */
7842         mutex_enter(&l2arc_dev_mtx);
7843         for (dev = list_head(l2arc_dev_list); dev; dev = nextdev) {
7844                 nextdev = list_next(l2arc_dev_list, dev);
7845                 if (vd == dev->l2ad_vdev) {
7846                         remdev = dev;
7847                         break;
7848                 }
7849         }
7850         ASSERT3P(remdev, !=, NULL);
7851
7852         /*
7853          * Remove device from global list
7854          */
7855         list_remove(l2arc_dev_list, remdev);
7856         l2arc_dev_last = NULL;          /* may have been invalidated */
7857         atomic_dec_64(&l2arc_ndev);
7858         mutex_exit(&l2arc_dev_mtx);
7859
7860         /*
7861          * Clear all buflists and ARC references.  L2ARC device flush.
7862          */
7863         l2arc_evict(remdev, 0, B_TRUE);
7864         list_destroy(&remdev->l2ad_buflist);
7865         mutex_destroy(&remdev->l2ad_mtx);
7866         refcount_destroy(&remdev->l2ad_alloc);
7867         kmem_free(remdev, sizeof (l2arc_dev_t));
7868 }
7869
7870 void
7871 l2arc_init(void)
7872 {
7873         l2arc_thread_exit = 0;
7874         l2arc_ndev = 0;
7875         l2arc_writes_sent = 0;
7876         l2arc_writes_done = 0;
7877
7878         mutex_init(&l2arc_feed_thr_lock, NULL, MUTEX_DEFAULT, NULL);
7879         cv_init(&l2arc_feed_thr_cv, NULL, CV_DEFAULT, NULL);
7880         mutex_init(&l2arc_dev_mtx, NULL, MUTEX_DEFAULT, NULL);
7881         mutex_init(&l2arc_free_on_write_mtx, NULL, MUTEX_DEFAULT, NULL);
7882
7883         l2arc_dev_list = &L2ARC_dev_list;
7884         l2arc_free_on_write = &L2ARC_free_on_write;
7885         list_create(l2arc_dev_list, sizeof (l2arc_dev_t),
7886             offsetof(l2arc_dev_t, l2ad_node));
7887         list_create(l2arc_free_on_write, sizeof (l2arc_data_free_t),
7888             offsetof(l2arc_data_free_t, l2df_list_node));
7889 }
7890
7891 void
7892 l2arc_fini(void)
7893 {
7894         /*
7895          * This is called from dmu_fini(), which is called from spa_fini();
7896          * Because of this, we can assume that all l2arc devices have
7897          * already been removed when the pools themselves were removed.
7898          */
7899
7900         l2arc_do_free_on_write();
7901
7902         mutex_destroy(&l2arc_feed_thr_lock);
7903         cv_destroy(&l2arc_feed_thr_cv);
7904         mutex_destroy(&l2arc_dev_mtx);
7905         mutex_destroy(&l2arc_free_on_write_mtx);
7906
7907         list_destroy(l2arc_dev_list);
7908         list_destroy(l2arc_free_on_write);
7909 }
7910
7911 void
7912 l2arc_start(void)
7913 {
7914         if (!(spa_mode_global & FWRITE))
7915                 return;
7916
7917         (void) thread_create(NULL, 0, l2arc_feed_thread, NULL, 0, &p0,
7918             TS_RUN, minclsyspri);
7919 }
7920
7921 void
7922 l2arc_stop(void)
7923 {
7924         if (!(spa_mode_global & FWRITE))
7925                 return;
7926
7927         mutex_enter(&l2arc_feed_thr_lock);
7928         cv_signal(&l2arc_feed_thr_cv);  /* kick thread out of startup */
7929         l2arc_thread_exit = 1;
7930         while (l2arc_thread_exit != 0)
7931                 cv_wait(&l2arc_feed_thr_cv, &l2arc_feed_thr_lock);
7932         mutex_exit(&l2arc_feed_thr_lock);
7933 }