Improve code in arc_buf_remove_ref
[zfs.git] / module / 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 2011 Nexenta Systems, Inc.  All rights reserved.
24  * Copyright (c) 2011 by Delphix. All rights reserved.
25  */
26
27 /*
28  * DVA-based Adjustable Replacement Cache
29  *
30  * While much of the theory of operation used here is
31  * based on the self-tuning, low overhead replacement cache
32  * presented by Megiddo and Modha at FAST 2003, there are some
33  * significant differences:
34  *
35  * 1. The Megiddo and Modha model assumes any page is evictable.
36  * Pages in its cache cannot be "locked" into memory.  This makes
37  * the eviction algorithm simple: evict the last page in the list.
38  * This also make the performance characteristics easy to reason
39  * about.  Our cache is not so simple.  At any given moment, some
40  * subset of the blocks in the cache are un-evictable because we
41  * have handed out a reference to them.  Blocks are only evictable
42  * when there are no external references active.  This makes
43  * eviction far more problematic:  we choose to evict the evictable
44  * blocks that are the "lowest" in the list.
45  *
46  * There are times when it is not possible to evict the requested
47  * space.  In these circumstances we are unable to adjust the cache
48  * size.  To prevent the cache growing unbounded at these times we
49  * implement a "cache throttle" that slows the flow of new data
50  * into the cache until we can make space available.
51  *
52  * 2. The Megiddo and Modha model assumes a fixed cache size.
53  * Pages are evicted when the cache is full and there is a cache
54  * miss.  Our model has a variable sized cache.  It grows with
55  * high use, but also tries to react to memory pressure from the
56  * operating system: decreasing its size when system memory is
57  * tight.
58  *
59  * 3. The Megiddo and Modha model assumes a fixed page size. All
60  * elements of the cache are therefor exactly the same size.  So
61  * when adjusting the cache size following a cache miss, its simply
62  * a matter of choosing a single page to evict.  In our model, we
63  * have variable sized cache blocks (rangeing from 512 bytes to
64  * 128K bytes).  We therefor choose a set of blocks to evict to make
65  * space for a cache miss that approximates as closely as possible
66  * the space used by the new block.
67  *
68  * See also:  "ARC: A Self-Tuning, Low Overhead Replacement Cache"
69  * by N. Megiddo & D. Modha, FAST 2003
70  */
71
72 /*
73  * The locking model:
74  *
75  * A new reference to a cache buffer can be obtained in two
76  * ways: 1) via a hash table lookup using the DVA as a key,
77  * or 2) via one of the ARC lists.  The arc_read() interface
78  * uses method 1, while the internal arc algorithms for
79  * adjusting the cache use method 2.  We therefor provide two
80  * types of locks: 1) the hash table lock array, and 2) the
81  * arc list locks.
82  *
83  * Buffers do not have their own mutexes, rather they rely on the
84  * hash table mutexes for the bulk of their protection (i.e. most
85  * fields in the arc_buf_hdr_t are protected by these mutexes).
86  *
87  * buf_hash_find() returns the appropriate mutex (held) when it
88  * locates the requested buffer in the hash table.  It returns
89  * NULL for the mutex if the buffer was not in the table.
90  *
91  * buf_hash_remove() expects the appropriate hash mutex to be
92  * already held before it is invoked.
93  *
94  * Each arc state also has a mutex which is used to protect the
95  * buffer list associated with the state.  When attempting to
96  * obtain a hash table lock while holding an arc list lock you
97  * must use: mutex_tryenter() to avoid deadlock.  Also note that
98  * the active state mutex must be held before the ghost state mutex.
99  *
100  * Arc buffers may have an associated eviction callback function.
101  * This function will be invoked prior to removing the buffer (e.g.
102  * in arc_do_user_evicts()).  Note however that the data associated
103  * with the buffer may be evicted prior to the callback.  The callback
104  * must be made with *no locks held* (to prevent deadlock).  Additionally,
105  * the users of callbacks must ensure that their private data is
106  * protected from simultaneous callbacks from arc_buf_evict()
107  * and arc_do_user_evicts().
108  *
109  * It as also possible to register a callback which is run when the
110  * arc_meta_limit is reached and no buffers can be safely evicted.  In
111  * this case the arc user should drop a reference on some arc buffers so
112  * they can be reclaimed and the arc_meta_limit honored.  For example,
113  * when using the ZPL each dentry holds a references on a znode.  These
114  * dentries must be pruned before the arc buffer holding the znode can
115  * be safely evicted.
116  *
117  * Note that the majority of the performance stats are manipulated
118  * with atomic operations.
119  *
120  * The L2ARC uses the l2arc_buflist_mtx global mutex for the following:
121  *
122  *      - L2ARC buflist creation
123  *      - L2ARC buflist eviction
124  *      - L2ARC write completion, which walks L2ARC buflists
125  *      - ARC header destruction, as it removes from L2ARC buflists
126  *      - ARC header release, as it removes from L2ARC buflists
127  */
128
129 #include <sys/spa.h>
130 #include <sys/zio.h>
131 #include <sys/zfs_context.h>
132 #include <sys/arc.h>
133 #include <sys/vdev.h>
134 #include <sys/vdev_impl.h>
135 #ifdef _KERNEL
136 #include <sys/vmsystm.h>
137 #include <vm/anon.h>
138 #include <sys/fs/swapnode.h>
139 #include <sys/zpl.h>
140 #endif
141 #include <sys/callb.h>
142 #include <sys/kstat.h>
143 #include <sys/dmu_tx.h>
144 #include <zfs_fletcher.h>
145
146 static kmutex_t         arc_reclaim_thr_lock;
147 static kcondvar_t       arc_reclaim_thr_cv;     /* used to signal reclaim thr */
148 static uint8_t          arc_thread_exit;
149
150 /* number of bytes to prune from caches when at arc_meta_limit is reached */
151 uint_t arc_meta_prune = 1048576;
152
153 typedef enum arc_reclaim_strategy {
154         ARC_RECLAIM_AGGR,               /* Aggressive reclaim strategy */
155         ARC_RECLAIM_CONS                /* Conservative reclaim strategy */
156 } arc_reclaim_strategy_t;
157
158 /* number of seconds before growing cache again */
159 static int              arc_grow_retry = 5;
160
161 /* expiration time for arc_no_grow */
162 static clock_t          arc_grow_time = 0;
163
164 /* shift of arc_c for calculating both min and max arc_p */
165 static int              arc_p_min_shift = 4;
166
167 /* log2(fraction of arc to reclaim) */
168 static int              arc_shrink_shift = 5;
169
170 /*
171  * minimum lifespan of a prefetch block in clock ticks
172  * (initialized in arc_init())
173  */
174 static int              arc_min_prefetch_lifespan;
175
176 static int arc_dead;
177
178 /*
179  * The arc has filled available memory and has now warmed up.
180  */
181 static boolean_t arc_warm;
182
183 /*
184  * These tunables are for performance analysis.
185  */
186 unsigned long zfs_arc_max = 0;
187 unsigned long zfs_arc_min = 0;
188 unsigned long zfs_arc_meta_limit = 0;
189 int zfs_arc_grow_retry = 0;
190 int zfs_arc_shrink_shift = 0;
191 int zfs_arc_p_min_shift = 0;
192 int zfs_arc_memory_throttle_disable = 1;
193 int zfs_disable_dup_eviction = 0;
194 int zfs_arc_meta_prune = 0;
195
196 /*
197  * Note that buffers can be in one of 6 states:
198  *      ARC_anon        - anonymous (discussed below)
199  *      ARC_mru         - recently used, currently cached
200  *      ARC_mru_ghost   - recentely used, no longer in cache
201  *      ARC_mfu         - frequently used, currently cached
202  *      ARC_mfu_ghost   - frequently used, no longer in cache
203  *      ARC_l2c_only    - exists in L2ARC but not other states
204  * When there are no active references to the buffer, they are
205  * are linked onto a list in one of these arc states.  These are
206  * the only buffers that can be evicted or deleted.  Within each
207  * state there are multiple lists, one for meta-data and one for
208  * non-meta-data.  Meta-data (indirect blocks, blocks of dnodes,
209  * etc.) is tracked separately so that it can be managed more
210  * explicitly: favored over data, limited explicitly.
211  *
212  * Anonymous buffers are buffers that are not associated with
213  * a DVA.  These are buffers that hold dirty block copies
214  * before they are written to stable storage.  By definition,
215  * they are "ref'd" and are considered part of arc_mru
216  * that cannot be freed.  Generally, they will aquire a DVA
217  * as they are written and migrate onto the arc_mru list.
218  *
219  * The ARC_l2c_only state is for buffers that are in the second
220  * level ARC but no longer in any of the ARC_m* lists.  The second
221  * level ARC itself may also contain buffers that are in any of
222  * the ARC_m* states - meaning that a buffer can exist in two
223  * places.  The reason for the ARC_l2c_only state is to keep the
224  * buffer header in the hash table, so that reads that hit the
225  * second level ARC benefit from these fast lookups.
226  */
227
228 typedef struct arc_state {
229         list_t  arcs_list[ARC_BUFC_NUMTYPES];   /* list of evictable buffers */
230         uint64_t arcs_lsize[ARC_BUFC_NUMTYPES]; /* amount of evictable data */
231         uint64_t arcs_size;     /* total amount of data in this state */
232         kmutex_t arcs_mtx;
233 } arc_state_t;
234
235 /* The 6 states: */
236 static arc_state_t ARC_anon;
237 static arc_state_t ARC_mru;
238 static arc_state_t ARC_mru_ghost;
239 static arc_state_t ARC_mfu;
240 static arc_state_t ARC_mfu_ghost;
241 static arc_state_t ARC_l2c_only;
242
243 typedef struct arc_stats {
244         kstat_named_t arcstat_hits;
245         kstat_named_t arcstat_misses;
246         kstat_named_t arcstat_demand_data_hits;
247         kstat_named_t arcstat_demand_data_misses;
248         kstat_named_t arcstat_demand_metadata_hits;
249         kstat_named_t arcstat_demand_metadata_misses;
250         kstat_named_t arcstat_prefetch_data_hits;
251         kstat_named_t arcstat_prefetch_data_misses;
252         kstat_named_t arcstat_prefetch_metadata_hits;
253         kstat_named_t arcstat_prefetch_metadata_misses;
254         kstat_named_t arcstat_mru_hits;
255         kstat_named_t arcstat_mru_ghost_hits;
256         kstat_named_t arcstat_mfu_hits;
257         kstat_named_t arcstat_mfu_ghost_hits;
258         kstat_named_t arcstat_deleted;
259         kstat_named_t arcstat_recycle_miss;
260         kstat_named_t arcstat_mutex_miss;
261         kstat_named_t arcstat_evict_skip;
262         kstat_named_t arcstat_evict_l2_cached;
263         kstat_named_t arcstat_evict_l2_eligible;
264         kstat_named_t arcstat_evict_l2_ineligible;
265         kstat_named_t arcstat_hash_elements;
266         kstat_named_t arcstat_hash_elements_max;
267         kstat_named_t arcstat_hash_collisions;
268         kstat_named_t arcstat_hash_chains;
269         kstat_named_t arcstat_hash_chain_max;
270         kstat_named_t arcstat_p;
271         kstat_named_t arcstat_c;
272         kstat_named_t arcstat_c_min;
273         kstat_named_t arcstat_c_max;
274         kstat_named_t arcstat_size;
275         kstat_named_t arcstat_hdr_size;
276         kstat_named_t arcstat_data_size;
277         kstat_named_t arcstat_other_size;
278         kstat_named_t arcstat_anon_size;
279         kstat_named_t arcstat_anon_evict_data;
280         kstat_named_t arcstat_anon_evict_metadata;
281         kstat_named_t arcstat_mru_size;
282         kstat_named_t arcstat_mru_evict_data;
283         kstat_named_t arcstat_mru_evict_metadata;
284         kstat_named_t arcstat_mru_ghost_size;
285         kstat_named_t arcstat_mru_ghost_evict_data;
286         kstat_named_t arcstat_mru_ghost_evict_metadata;
287         kstat_named_t arcstat_mfu_size;
288         kstat_named_t arcstat_mfu_evict_data;
289         kstat_named_t arcstat_mfu_evict_metadata;
290         kstat_named_t arcstat_mfu_ghost_size;
291         kstat_named_t arcstat_mfu_ghost_evict_data;
292         kstat_named_t arcstat_mfu_ghost_evict_metadata;
293         kstat_named_t arcstat_l2_hits;
294         kstat_named_t arcstat_l2_misses;
295         kstat_named_t arcstat_l2_feeds;
296         kstat_named_t arcstat_l2_rw_clash;
297         kstat_named_t arcstat_l2_read_bytes;
298         kstat_named_t arcstat_l2_write_bytes;
299         kstat_named_t arcstat_l2_writes_sent;
300         kstat_named_t arcstat_l2_writes_done;
301         kstat_named_t arcstat_l2_writes_error;
302         kstat_named_t arcstat_l2_writes_hdr_miss;
303         kstat_named_t arcstat_l2_evict_lock_retry;
304         kstat_named_t arcstat_l2_evict_reading;
305         kstat_named_t arcstat_l2_free_on_write;
306         kstat_named_t arcstat_l2_abort_lowmem;
307         kstat_named_t arcstat_l2_cksum_bad;
308         kstat_named_t arcstat_l2_io_error;
309         kstat_named_t arcstat_l2_size;
310         kstat_named_t arcstat_l2_hdr_size;
311         kstat_named_t arcstat_memory_throttle_count;
312         kstat_named_t arcstat_duplicate_buffers;
313         kstat_named_t arcstat_duplicate_buffers_size;
314         kstat_named_t arcstat_duplicate_reads;
315         kstat_named_t arcstat_memory_direct_count;
316         kstat_named_t arcstat_memory_indirect_count;
317         kstat_named_t arcstat_no_grow;
318         kstat_named_t arcstat_tempreserve;
319         kstat_named_t arcstat_loaned_bytes;
320         kstat_named_t arcstat_prune;
321         kstat_named_t arcstat_meta_used;
322         kstat_named_t arcstat_meta_limit;
323         kstat_named_t arcstat_meta_max;
324 } arc_stats_t;
325
326 static arc_stats_t arc_stats = {
327         { "hits",                       KSTAT_DATA_UINT64 },
328         { "misses",                     KSTAT_DATA_UINT64 },
329         { "demand_data_hits",           KSTAT_DATA_UINT64 },
330         { "demand_data_misses",         KSTAT_DATA_UINT64 },
331         { "demand_metadata_hits",       KSTAT_DATA_UINT64 },
332         { "demand_metadata_misses",     KSTAT_DATA_UINT64 },
333         { "prefetch_data_hits",         KSTAT_DATA_UINT64 },
334         { "prefetch_data_misses",       KSTAT_DATA_UINT64 },
335         { "prefetch_metadata_hits",     KSTAT_DATA_UINT64 },
336         { "prefetch_metadata_misses",   KSTAT_DATA_UINT64 },
337         { "mru_hits",                   KSTAT_DATA_UINT64 },
338         { "mru_ghost_hits",             KSTAT_DATA_UINT64 },
339         { "mfu_hits",                   KSTAT_DATA_UINT64 },
340         { "mfu_ghost_hits",             KSTAT_DATA_UINT64 },
341         { "deleted",                    KSTAT_DATA_UINT64 },
342         { "recycle_miss",               KSTAT_DATA_UINT64 },
343         { "mutex_miss",                 KSTAT_DATA_UINT64 },
344         { "evict_skip",                 KSTAT_DATA_UINT64 },
345         { "evict_l2_cached",            KSTAT_DATA_UINT64 },
346         { "evict_l2_eligible",          KSTAT_DATA_UINT64 },
347         { "evict_l2_ineligible",        KSTAT_DATA_UINT64 },
348         { "hash_elements",              KSTAT_DATA_UINT64 },
349         { "hash_elements_max",          KSTAT_DATA_UINT64 },
350         { "hash_collisions",            KSTAT_DATA_UINT64 },
351         { "hash_chains",                KSTAT_DATA_UINT64 },
352         { "hash_chain_max",             KSTAT_DATA_UINT64 },
353         { "p",                          KSTAT_DATA_UINT64 },
354         { "c",                          KSTAT_DATA_UINT64 },
355         { "c_min",                      KSTAT_DATA_UINT64 },
356         { "c_max",                      KSTAT_DATA_UINT64 },
357         { "size",                       KSTAT_DATA_UINT64 },
358         { "hdr_size",                   KSTAT_DATA_UINT64 },
359         { "data_size",                  KSTAT_DATA_UINT64 },
360         { "other_size",                 KSTAT_DATA_UINT64 },
361         { "anon_size",                  KSTAT_DATA_UINT64 },
362         { "anon_evict_data",            KSTAT_DATA_UINT64 },
363         { "anon_evict_metadata",        KSTAT_DATA_UINT64 },
364         { "mru_size",                   KSTAT_DATA_UINT64 },
365         { "mru_evict_data",             KSTAT_DATA_UINT64 },
366         { "mru_evict_metadata",         KSTAT_DATA_UINT64 },
367         { "mru_ghost_size",             KSTAT_DATA_UINT64 },
368         { "mru_ghost_evict_data",       KSTAT_DATA_UINT64 },
369         { "mru_ghost_evict_metadata",   KSTAT_DATA_UINT64 },
370         { "mfu_size",                   KSTAT_DATA_UINT64 },
371         { "mfu_evict_data",             KSTAT_DATA_UINT64 },
372         { "mfu_evict_metadata",         KSTAT_DATA_UINT64 },
373         { "mfu_ghost_size",             KSTAT_DATA_UINT64 },
374         { "mfu_ghost_evict_data",       KSTAT_DATA_UINT64 },
375         { "mfu_ghost_evict_metadata",   KSTAT_DATA_UINT64 },
376         { "l2_hits",                    KSTAT_DATA_UINT64 },
377         { "l2_misses",                  KSTAT_DATA_UINT64 },
378         { "l2_feeds",                   KSTAT_DATA_UINT64 },
379         { "l2_rw_clash",                KSTAT_DATA_UINT64 },
380         { "l2_read_bytes",              KSTAT_DATA_UINT64 },
381         { "l2_write_bytes",             KSTAT_DATA_UINT64 },
382         { "l2_writes_sent",             KSTAT_DATA_UINT64 },
383         { "l2_writes_done",             KSTAT_DATA_UINT64 },
384         { "l2_writes_error",            KSTAT_DATA_UINT64 },
385         { "l2_writes_hdr_miss",         KSTAT_DATA_UINT64 },
386         { "l2_evict_lock_retry",        KSTAT_DATA_UINT64 },
387         { "l2_evict_reading",           KSTAT_DATA_UINT64 },
388         { "l2_free_on_write",           KSTAT_DATA_UINT64 },
389         { "l2_abort_lowmem",            KSTAT_DATA_UINT64 },
390         { "l2_cksum_bad",               KSTAT_DATA_UINT64 },
391         { "l2_io_error",                KSTAT_DATA_UINT64 },
392         { "l2_size",                    KSTAT_DATA_UINT64 },
393         { "l2_hdr_size",                KSTAT_DATA_UINT64 },
394         { "memory_throttle_count",      KSTAT_DATA_UINT64 },
395         { "duplicate_buffers",          KSTAT_DATA_UINT64 },
396         { "duplicate_buffers_size",     KSTAT_DATA_UINT64 },
397         { "duplicate_reads",            KSTAT_DATA_UINT64 },
398         { "memory_direct_count",        KSTAT_DATA_UINT64 },
399         { "memory_indirect_count",      KSTAT_DATA_UINT64 },
400         { "arc_no_grow",                KSTAT_DATA_UINT64 },
401         { "arc_tempreserve",            KSTAT_DATA_UINT64 },
402         { "arc_loaned_bytes",           KSTAT_DATA_UINT64 },
403         { "arc_prune",                  KSTAT_DATA_UINT64 },
404         { "arc_meta_used",              KSTAT_DATA_UINT64 },
405         { "arc_meta_limit",             KSTAT_DATA_UINT64 },
406         { "arc_meta_max",               KSTAT_DATA_UINT64 },
407 };
408
409 #define ARCSTAT(stat)   (arc_stats.stat.value.ui64)
410
411 #define ARCSTAT_INCR(stat, val) \
412         atomic_add_64(&arc_stats.stat.value.ui64, (val));
413
414 #define ARCSTAT_BUMP(stat)      ARCSTAT_INCR(stat, 1)
415 #define ARCSTAT_BUMPDOWN(stat)  ARCSTAT_INCR(stat, -1)
416
417 #define ARCSTAT_MAX(stat, val) {                                        \
418         uint64_t m;                                                     \
419         while ((val) > (m = arc_stats.stat.value.ui64) &&               \
420             (m != atomic_cas_64(&arc_stats.stat.value.ui64, m, (val)))) \
421                 continue;                                               \
422 }
423
424 #define ARCSTAT_MAXSTAT(stat) \
425         ARCSTAT_MAX(stat##_max, arc_stats.stat.value.ui64)
426
427 /*
428  * We define a macro to allow ARC hits/misses to be easily broken down by
429  * two separate conditions, giving a total of four different subtypes for
430  * each of hits and misses (so eight statistics total).
431  */
432 #define ARCSTAT_CONDSTAT(cond1, stat1, notstat1, cond2, stat2, notstat2, stat) \
433         if (cond1) {                                                    \
434                 if (cond2) {                                            \
435                         ARCSTAT_BUMP(arcstat_##stat1##_##stat2##_##stat); \
436                 } else {                                                \
437                         ARCSTAT_BUMP(arcstat_##stat1##_##notstat2##_##stat); \
438                 }                                                       \
439         } else {                                                        \
440                 if (cond2) {                                            \
441                         ARCSTAT_BUMP(arcstat_##notstat1##_##stat2##_##stat); \
442                 } else {                                                \
443                         ARCSTAT_BUMP(arcstat_##notstat1##_##notstat2##_##stat);\
444                 }                                                       \
445         }
446
447 kstat_t                 *arc_ksp;
448 static arc_state_t      *arc_anon;
449 static arc_state_t      *arc_mru;
450 static arc_state_t      *arc_mru_ghost;
451 static arc_state_t      *arc_mfu;
452 static arc_state_t      *arc_mfu_ghost;
453 static arc_state_t      *arc_l2c_only;
454
455 /*
456  * There are several ARC variables that are critical to export as kstats --
457  * but we don't want to have to grovel around in the kstat whenever we wish to
458  * manipulate them.  For these variables, we therefore define them to be in
459  * terms of the statistic variable.  This assures that we are not introducing
460  * the possibility of inconsistency by having shadow copies of the variables,
461  * while still allowing the code to be readable.
462  */
463 #define arc_size        ARCSTAT(arcstat_size)   /* actual total arc size */
464 #define arc_p           ARCSTAT(arcstat_p)      /* target size of MRU */
465 #define arc_c           ARCSTAT(arcstat_c)      /* target size of cache */
466 #define arc_c_min       ARCSTAT(arcstat_c_min)  /* min target cache size */
467 #define arc_c_max       ARCSTAT(arcstat_c_max)  /* max target cache size */
468 #define arc_no_grow     ARCSTAT(arcstat_no_grow)
469 #define arc_tempreserve ARCSTAT(arcstat_tempreserve)
470 #define arc_loaned_bytes        ARCSTAT(arcstat_loaned_bytes)
471 #define arc_meta_used   ARCSTAT(arcstat_meta_used)
472 #define arc_meta_limit  ARCSTAT(arcstat_meta_limit)
473 #define arc_meta_max    ARCSTAT(arcstat_meta_max)
474
475 typedef struct l2arc_buf_hdr l2arc_buf_hdr_t;
476
477 typedef struct arc_callback arc_callback_t;
478
479 struct arc_callback {
480         void                    *acb_private;
481         arc_done_func_t         *acb_done;
482         arc_buf_t               *acb_buf;
483         zio_t                   *acb_zio_dummy;
484         arc_callback_t          *acb_next;
485 };
486
487 typedef struct arc_write_callback arc_write_callback_t;
488
489 struct arc_write_callback {
490         void            *awcb_private;
491         arc_done_func_t *awcb_ready;
492         arc_done_func_t *awcb_done;
493         arc_buf_t       *awcb_buf;
494 };
495
496 struct arc_buf_hdr {
497         /* protected by hash lock */
498         dva_t                   b_dva;
499         uint64_t                b_birth;
500         uint64_t                b_cksum0;
501
502         kmutex_t                b_freeze_lock;
503         zio_cksum_t             *b_freeze_cksum;
504         void                    *b_thawed;
505
506         arc_buf_hdr_t           *b_hash_next;
507         arc_buf_t               *b_buf;
508         uint32_t                b_flags;
509         uint32_t                b_datacnt;
510
511         arc_callback_t          *b_acb;
512         kcondvar_t              b_cv;
513
514         /* immutable */
515         arc_buf_contents_t      b_type;
516         uint64_t                b_size;
517         uint64_t                b_spa;
518
519         /* protected by arc state mutex */
520         arc_state_t             *b_state;
521         list_node_t             b_arc_node;
522
523         /* updated atomically */
524         clock_t                 b_arc_access;
525
526         /* self protecting */
527         refcount_t              b_refcnt;
528
529         l2arc_buf_hdr_t         *b_l2hdr;
530         list_node_t             b_l2node;
531 };
532
533 static list_t arc_prune_list;
534 static kmutex_t arc_prune_mtx;
535 static arc_buf_t *arc_eviction_list;
536 static kmutex_t arc_eviction_mtx;
537 static arc_buf_hdr_t arc_eviction_hdr;
538 static void arc_get_data_buf(arc_buf_t *buf);
539 static void arc_access(arc_buf_hdr_t *buf, kmutex_t *hash_lock);
540 static int arc_evict_needed(arc_buf_contents_t type);
541 static void arc_evict_ghost(arc_state_t *state, uint64_t spa, int64_t bytes);
542
543 static boolean_t l2arc_write_eligible(uint64_t spa_guid, arc_buf_hdr_t *ab);
544
545 #define GHOST_STATE(state)      \
546         ((state) == arc_mru_ghost || (state) == arc_mfu_ghost ||        \
547         (state) == arc_l2c_only)
548
549 /*
550  * Private ARC flags.  These flags are private ARC only flags that will show up
551  * in b_flags in the arc_hdr_buf_t.  Some flags are publicly declared, and can
552  * be passed in as arc_flags in things like arc_read.  However, these flags
553  * should never be passed and should only be set by ARC code.  When adding new
554  * public flags, make sure not to smash the private ones.
555  */
556
557 #define ARC_IN_HASH_TABLE       (1 << 9)        /* this buffer is hashed */
558 #define ARC_IO_IN_PROGRESS      (1 << 10)       /* I/O in progress for buf */
559 #define ARC_IO_ERROR            (1 << 11)       /* I/O failed for buf */
560 #define ARC_FREED_IN_READ       (1 << 12)       /* buf freed while in read */
561 #define ARC_BUF_AVAILABLE       (1 << 13)       /* block not in active use */
562 #define ARC_INDIRECT            (1 << 14)       /* this is an indirect block */
563 #define ARC_FREE_IN_PROGRESS    (1 << 15)       /* hdr about to be freed */
564 #define ARC_L2_WRITING          (1 << 16)       /* L2ARC write in progress */
565 #define ARC_L2_EVICTED          (1 << 17)       /* evicted during I/O */
566 #define ARC_L2_WRITE_HEAD       (1 << 18)       /* head of write list */
567
568 #define HDR_IN_HASH_TABLE(hdr)  ((hdr)->b_flags & ARC_IN_HASH_TABLE)
569 #define HDR_IO_IN_PROGRESS(hdr) ((hdr)->b_flags & ARC_IO_IN_PROGRESS)
570 #define HDR_IO_ERROR(hdr)       ((hdr)->b_flags & ARC_IO_ERROR)
571 #define HDR_PREFETCH(hdr)       ((hdr)->b_flags & ARC_PREFETCH)
572 #define HDR_FREED_IN_READ(hdr)  ((hdr)->b_flags & ARC_FREED_IN_READ)
573 #define HDR_BUF_AVAILABLE(hdr)  ((hdr)->b_flags & ARC_BUF_AVAILABLE)
574 #define HDR_FREE_IN_PROGRESS(hdr)       ((hdr)->b_flags & ARC_FREE_IN_PROGRESS)
575 #define HDR_L2CACHE(hdr)        ((hdr)->b_flags & ARC_L2CACHE)
576 #define HDR_L2_READING(hdr)     ((hdr)->b_flags & ARC_IO_IN_PROGRESS && \
577                                     (hdr)->b_l2hdr != NULL)
578 #define HDR_L2_WRITING(hdr)     ((hdr)->b_flags & ARC_L2_WRITING)
579 #define HDR_L2_EVICTED(hdr)     ((hdr)->b_flags & ARC_L2_EVICTED)
580 #define HDR_L2_WRITE_HEAD(hdr)  ((hdr)->b_flags & ARC_L2_WRITE_HEAD)
581
582 /*
583  * Other sizes
584  */
585
586 #define HDR_SIZE ((int64_t)sizeof (arc_buf_hdr_t))
587 #define L2HDR_SIZE ((int64_t)sizeof (l2arc_buf_hdr_t))
588
589 /*
590  * Hash table routines
591  */
592
593 #define HT_LOCK_ALIGN   64
594 #define HT_LOCK_PAD     (P2NPHASE(sizeof (kmutex_t), (HT_LOCK_ALIGN)))
595
596 struct ht_lock {
597         kmutex_t        ht_lock;
598 #ifdef _KERNEL
599         unsigned char   pad[HT_LOCK_PAD];
600 #endif
601 };
602
603 #define BUF_LOCKS 256
604 typedef struct buf_hash_table {
605         uint64_t ht_mask;
606         arc_buf_hdr_t **ht_table;
607         struct ht_lock ht_locks[BUF_LOCKS];
608 } buf_hash_table_t;
609
610 static buf_hash_table_t buf_hash_table;
611
612 #define BUF_HASH_INDEX(spa, dva, birth) \
613         (buf_hash(spa, dva, birth) & buf_hash_table.ht_mask)
614 #define BUF_HASH_LOCK_NTRY(idx) (buf_hash_table.ht_locks[idx & (BUF_LOCKS-1)])
615 #define BUF_HASH_LOCK(idx)      (&(BUF_HASH_LOCK_NTRY(idx).ht_lock))
616 #define HDR_LOCK(hdr) \
617         (BUF_HASH_LOCK(BUF_HASH_INDEX(hdr->b_spa, &hdr->b_dva, hdr->b_birth)))
618
619 uint64_t zfs_crc64_table[256];
620
621 /*
622  * Level 2 ARC
623  */
624
625 #define L2ARC_WRITE_SIZE        (8 * 1024 * 1024)       /* initial write max */
626 #define L2ARC_HEADROOM          2               /* num of writes */
627 #define L2ARC_FEED_SECS         1               /* caching interval secs */
628 #define L2ARC_FEED_MIN_MS       200             /* min caching interval ms */
629
630 #define l2arc_writes_sent       ARCSTAT(arcstat_l2_writes_sent)
631 #define l2arc_writes_done       ARCSTAT(arcstat_l2_writes_done)
632
633 /*
634  * L2ARC Performance Tunables
635  */
636 unsigned long l2arc_write_max = L2ARC_WRITE_SIZE;       /* def max write size */
637 unsigned long l2arc_write_boost = L2ARC_WRITE_SIZE;     /* extra warmup write */
638 unsigned long l2arc_headroom = L2ARC_HEADROOM;          /* # of dev writes */
639 unsigned long l2arc_feed_secs = L2ARC_FEED_SECS;        /* interval seconds */
640 unsigned long l2arc_feed_min_ms = L2ARC_FEED_MIN_MS;    /* min interval msecs */
641 int l2arc_noprefetch = B_TRUE;                  /* don't cache prefetch bufs */
642 int l2arc_feed_again = B_TRUE;                  /* turbo warmup */
643 int l2arc_norw = B_TRUE;                        /* no reads during writes */
644
645 /*
646  * L2ARC Internals
647  */
648 typedef struct l2arc_dev {
649         vdev_t                  *l2ad_vdev;     /* vdev */
650         spa_t                   *l2ad_spa;      /* spa */
651         uint64_t                l2ad_hand;      /* next write location */
652         uint64_t                l2ad_write;     /* desired write size, bytes */
653         uint64_t                l2ad_boost;     /* warmup write boost, bytes */
654         uint64_t                l2ad_start;     /* first addr on device */
655         uint64_t                l2ad_end;       /* last addr on device */
656         uint64_t                l2ad_evict;     /* last addr eviction reached */
657         boolean_t               l2ad_first;     /* first sweep through */
658         boolean_t               l2ad_writing;   /* currently writing */
659         list_t                  *l2ad_buflist;  /* buffer list */
660         list_node_t             l2ad_node;      /* device list node */
661 } l2arc_dev_t;
662
663 static list_t L2ARC_dev_list;                   /* device list */
664 static list_t *l2arc_dev_list;                  /* device list pointer */
665 static kmutex_t l2arc_dev_mtx;                  /* device list mutex */
666 static l2arc_dev_t *l2arc_dev_last;             /* last device used */
667 static kmutex_t l2arc_buflist_mtx;              /* mutex for all buflists */
668 static list_t L2ARC_free_on_write;              /* free after write buf list */
669 static list_t *l2arc_free_on_write;             /* free after write list ptr */
670 static kmutex_t l2arc_free_on_write_mtx;        /* mutex for list */
671 static uint64_t l2arc_ndev;                     /* number of devices */
672
673 typedef struct l2arc_read_callback {
674         arc_buf_t       *l2rcb_buf;             /* read buffer */
675         spa_t           *l2rcb_spa;             /* spa */
676         blkptr_t        l2rcb_bp;               /* original blkptr */
677         zbookmark_t     l2rcb_zb;               /* original bookmark */
678         int             l2rcb_flags;            /* original flags */
679 } l2arc_read_callback_t;
680
681 typedef struct l2arc_write_callback {
682         l2arc_dev_t     *l2wcb_dev;             /* device info */
683         arc_buf_hdr_t   *l2wcb_head;            /* head of write buflist */
684 } l2arc_write_callback_t;
685
686 struct l2arc_buf_hdr {
687         /* protected by arc_buf_hdr  mutex */
688         l2arc_dev_t     *b_dev;                 /* L2ARC device */
689         uint64_t        b_daddr;                /* disk address, offset byte */
690 };
691
692 typedef struct l2arc_data_free {
693         /* protected by l2arc_free_on_write_mtx */
694         void            *l2df_data;
695         size_t          l2df_size;
696         void            (*l2df_func)(void *, size_t);
697         list_node_t     l2df_list_node;
698 } l2arc_data_free_t;
699
700 static kmutex_t l2arc_feed_thr_lock;
701 static kcondvar_t l2arc_feed_thr_cv;
702 static uint8_t l2arc_thread_exit;
703
704 static void l2arc_read_done(zio_t *zio);
705 static void l2arc_hdr_stat_add(void);
706 static void l2arc_hdr_stat_remove(void);
707
708 static uint64_t
709 buf_hash(uint64_t spa, const dva_t *dva, uint64_t birth)
710 {
711         uint8_t *vdva = (uint8_t *)dva;
712         uint64_t crc = -1ULL;
713         int i;
714
715         ASSERT(zfs_crc64_table[128] == ZFS_CRC64_POLY);
716
717         for (i = 0; i < sizeof (dva_t); i++)
718                 crc = (crc >> 8) ^ zfs_crc64_table[(crc ^ vdva[i]) & 0xFF];
719
720         crc ^= (spa>>8) ^ birth;
721
722         return (crc);
723 }
724
725 #define BUF_EMPTY(buf)                                          \
726         ((buf)->b_dva.dva_word[0] == 0 &&                       \
727         (buf)->b_dva.dva_word[1] == 0 &&                        \
728         (buf)->b_birth == 0)
729
730 #define BUF_EQUAL(spa, dva, birth, buf)                         \
731         ((buf)->b_dva.dva_word[0] == (dva)->dva_word[0]) &&     \
732         ((buf)->b_dva.dva_word[1] == (dva)->dva_word[1]) &&     \
733         ((buf)->b_birth == birth) && ((buf)->b_spa == spa)
734
735 static void
736 buf_discard_identity(arc_buf_hdr_t *hdr)
737 {
738         hdr->b_dva.dva_word[0] = 0;
739         hdr->b_dva.dva_word[1] = 0;
740         hdr->b_birth = 0;
741         hdr->b_cksum0 = 0;
742 }
743
744 static arc_buf_hdr_t *
745 buf_hash_find(uint64_t spa, const dva_t *dva, uint64_t birth, kmutex_t **lockp)
746 {
747         uint64_t idx = BUF_HASH_INDEX(spa, dva, birth);
748         kmutex_t *hash_lock = BUF_HASH_LOCK(idx);
749         arc_buf_hdr_t *buf;
750
751         mutex_enter(hash_lock);
752         for (buf = buf_hash_table.ht_table[idx]; buf != NULL;
753             buf = buf->b_hash_next) {
754                 if (BUF_EQUAL(spa, dva, birth, buf)) {
755                         *lockp = hash_lock;
756                         return (buf);
757                 }
758         }
759         mutex_exit(hash_lock);
760         *lockp = NULL;
761         return (NULL);
762 }
763
764 /*
765  * Insert an entry into the hash table.  If there is already an element
766  * equal to elem in the hash table, then the already existing element
767  * will be returned and the new element will not be inserted.
768  * Otherwise returns NULL.
769  */
770 static arc_buf_hdr_t *
771 buf_hash_insert(arc_buf_hdr_t *buf, kmutex_t **lockp)
772 {
773         uint64_t idx = BUF_HASH_INDEX(buf->b_spa, &buf->b_dva, buf->b_birth);
774         kmutex_t *hash_lock = BUF_HASH_LOCK(idx);
775         arc_buf_hdr_t *fbuf;
776         uint32_t i;
777
778         ASSERT(!HDR_IN_HASH_TABLE(buf));
779         *lockp = hash_lock;
780         mutex_enter(hash_lock);
781         for (fbuf = buf_hash_table.ht_table[idx], i = 0; fbuf != NULL;
782             fbuf = fbuf->b_hash_next, i++) {
783                 if (BUF_EQUAL(buf->b_spa, &buf->b_dva, buf->b_birth, fbuf))
784                         return (fbuf);
785         }
786
787         buf->b_hash_next = buf_hash_table.ht_table[idx];
788         buf_hash_table.ht_table[idx] = buf;
789         buf->b_flags |= ARC_IN_HASH_TABLE;
790
791         /* collect some hash table performance data */
792         if (i > 0) {
793                 ARCSTAT_BUMP(arcstat_hash_collisions);
794                 if (i == 1)
795                         ARCSTAT_BUMP(arcstat_hash_chains);
796
797                 ARCSTAT_MAX(arcstat_hash_chain_max, i);
798         }
799
800         ARCSTAT_BUMP(arcstat_hash_elements);
801         ARCSTAT_MAXSTAT(arcstat_hash_elements);
802
803         return (NULL);
804 }
805
806 static void
807 buf_hash_remove(arc_buf_hdr_t *buf)
808 {
809         arc_buf_hdr_t *fbuf, **bufp;
810         uint64_t idx = BUF_HASH_INDEX(buf->b_spa, &buf->b_dva, buf->b_birth);
811
812         ASSERT(MUTEX_HELD(BUF_HASH_LOCK(idx)));
813         ASSERT(HDR_IN_HASH_TABLE(buf));
814
815         bufp = &buf_hash_table.ht_table[idx];
816         while ((fbuf = *bufp) != buf) {
817                 ASSERT(fbuf != NULL);
818                 bufp = &fbuf->b_hash_next;
819         }
820         *bufp = buf->b_hash_next;
821         buf->b_hash_next = NULL;
822         buf->b_flags &= ~ARC_IN_HASH_TABLE;
823
824         /* collect some hash table performance data */
825         ARCSTAT_BUMPDOWN(arcstat_hash_elements);
826
827         if (buf_hash_table.ht_table[idx] &&
828             buf_hash_table.ht_table[idx]->b_hash_next == NULL)
829                 ARCSTAT_BUMPDOWN(arcstat_hash_chains);
830 }
831
832 /*
833  * Global data structures and functions for the buf kmem cache.
834  */
835 static kmem_cache_t *hdr_cache;
836 static kmem_cache_t *buf_cache;
837
838 static void
839 buf_fini(void)
840 {
841         int i;
842
843 #if defined(_KERNEL) && defined(HAVE_SPL)
844         /* Large allocations which do not require contiguous pages
845          * should be using vmem_free() in the linux kernel */
846         vmem_free(buf_hash_table.ht_table,
847             (buf_hash_table.ht_mask + 1) * sizeof (void *));
848 #else
849         kmem_free(buf_hash_table.ht_table,
850             (buf_hash_table.ht_mask + 1) * sizeof (void *));
851 #endif
852         for (i = 0; i < BUF_LOCKS; i++)
853                 mutex_destroy(&buf_hash_table.ht_locks[i].ht_lock);
854         kmem_cache_destroy(hdr_cache);
855         kmem_cache_destroy(buf_cache);
856 }
857
858 /*
859  * Constructor callback - called when the cache is empty
860  * and a new buf is requested.
861  */
862 /* ARGSUSED */
863 static int
864 hdr_cons(void *vbuf, void *unused, int kmflag)
865 {
866         arc_buf_hdr_t *buf = vbuf;
867
868         bzero(buf, sizeof (arc_buf_hdr_t));
869         refcount_create(&buf->b_refcnt);
870         cv_init(&buf->b_cv, NULL, CV_DEFAULT, NULL);
871         mutex_init(&buf->b_freeze_lock, NULL, MUTEX_DEFAULT, NULL);
872         list_link_init(&buf->b_arc_node);
873         list_link_init(&buf->b_l2node);
874         arc_space_consume(sizeof (arc_buf_hdr_t), ARC_SPACE_HDRS);
875
876         return (0);
877 }
878
879 /* ARGSUSED */
880 static int
881 buf_cons(void *vbuf, void *unused, int kmflag)
882 {
883         arc_buf_t *buf = vbuf;
884
885         bzero(buf, sizeof (arc_buf_t));
886         mutex_init(&buf->b_evict_lock, NULL, MUTEX_DEFAULT, NULL);
887         arc_space_consume(sizeof (arc_buf_t), ARC_SPACE_HDRS);
888
889         return (0);
890 }
891
892 /*
893  * Destructor callback - called when a cached buf is
894  * no longer required.
895  */
896 /* ARGSUSED */
897 static void
898 hdr_dest(void *vbuf, void *unused)
899 {
900         arc_buf_hdr_t *buf = vbuf;
901
902         ASSERT(BUF_EMPTY(buf));
903         refcount_destroy(&buf->b_refcnt);
904         cv_destroy(&buf->b_cv);
905         mutex_destroy(&buf->b_freeze_lock);
906         arc_space_return(sizeof (arc_buf_hdr_t), ARC_SPACE_HDRS);
907 }
908
909 /* ARGSUSED */
910 static void
911 buf_dest(void *vbuf, void *unused)
912 {
913         arc_buf_t *buf = vbuf;
914
915         mutex_destroy(&buf->b_evict_lock);
916         arc_space_return(sizeof (arc_buf_t), ARC_SPACE_HDRS);
917 }
918
919 static void
920 buf_init(void)
921 {
922         uint64_t *ct;
923         uint64_t hsize = 1ULL << 12;
924         int i, j;
925
926         /*
927          * The hash table is big enough to fill all of physical memory
928          * with an average 64K block size.  The table will take up
929          * totalmem*sizeof(void*)/64K (eg. 128KB/GB with 8-byte pointers).
930          */
931         while (hsize * 65536 < physmem * PAGESIZE)
932                 hsize <<= 1;
933 retry:
934         buf_hash_table.ht_mask = hsize - 1;
935 #if defined(_KERNEL) && defined(HAVE_SPL)
936         /* Large allocations which do not require contiguous pages
937          * should be using vmem_alloc() in the linux kernel */
938         buf_hash_table.ht_table =
939             vmem_zalloc(hsize * sizeof (void*), KM_SLEEP);
940 #else
941         buf_hash_table.ht_table =
942             kmem_zalloc(hsize * sizeof (void*), KM_NOSLEEP);
943 #endif
944         if (buf_hash_table.ht_table == NULL) {
945                 ASSERT(hsize > (1ULL << 8));
946                 hsize >>= 1;
947                 goto retry;
948         }
949
950         hdr_cache = kmem_cache_create("arc_buf_hdr_t", sizeof (arc_buf_hdr_t),
951             0, hdr_cons, hdr_dest, NULL, NULL, NULL, 0);
952         buf_cache = kmem_cache_create("arc_buf_t", sizeof (arc_buf_t),
953             0, buf_cons, buf_dest, NULL, NULL, NULL, 0);
954
955         for (i = 0; i < 256; i++)
956                 for (ct = zfs_crc64_table + i, *ct = i, j = 8; j > 0; j--)
957                         *ct = (*ct >> 1) ^ (-(*ct & 1) & ZFS_CRC64_POLY);
958
959         for (i = 0; i < BUF_LOCKS; i++) {
960                 mutex_init(&buf_hash_table.ht_locks[i].ht_lock,
961                     NULL, MUTEX_DEFAULT, NULL);
962         }
963 }
964
965 #define ARC_MINTIME     (hz>>4) /* 62 ms */
966
967 static void
968 arc_cksum_verify(arc_buf_t *buf)
969 {
970         zio_cksum_t zc;
971
972         if (!(zfs_flags & ZFS_DEBUG_MODIFY))
973                 return;
974
975         mutex_enter(&buf->b_hdr->b_freeze_lock);
976         if (buf->b_hdr->b_freeze_cksum == NULL ||
977             (buf->b_hdr->b_flags & ARC_IO_ERROR)) {
978                 mutex_exit(&buf->b_hdr->b_freeze_lock);
979                 return;
980         }
981         fletcher_2_native(buf->b_data, buf->b_hdr->b_size, &zc);
982         if (!ZIO_CHECKSUM_EQUAL(*buf->b_hdr->b_freeze_cksum, zc))
983                 panic("buffer modified while frozen!");
984         mutex_exit(&buf->b_hdr->b_freeze_lock);
985 }
986
987 static int
988 arc_cksum_equal(arc_buf_t *buf)
989 {
990         zio_cksum_t zc;
991         int equal;
992
993         mutex_enter(&buf->b_hdr->b_freeze_lock);
994         fletcher_2_native(buf->b_data, buf->b_hdr->b_size, &zc);
995         equal = ZIO_CHECKSUM_EQUAL(*buf->b_hdr->b_freeze_cksum, zc);
996         mutex_exit(&buf->b_hdr->b_freeze_lock);
997
998         return (equal);
999 }
1000
1001 static void
1002 arc_cksum_compute(arc_buf_t *buf, boolean_t force)
1003 {
1004         if (!force && !(zfs_flags & ZFS_DEBUG_MODIFY))
1005                 return;
1006
1007         mutex_enter(&buf->b_hdr->b_freeze_lock);
1008         if (buf->b_hdr->b_freeze_cksum != NULL) {
1009                 mutex_exit(&buf->b_hdr->b_freeze_lock);
1010                 return;
1011         }
1012         buf->b_hdr->b_freeze_cksum = kmem_alloc(sizeof (zio_cksum_t),
1013                                                 KM_PUSHPAGE);
1014         fletcher_2_native(buf->b_data, buf->b_hdr->b_size,
1015             buf->b_hdr->b_freeze_cksum);
1016         mutex_exit(&buf->b_hdr->b_freeze_lock);
1017 }
1018
1019 void
1020 arc_buf_thaw(arc_buf_t *buf)
1021 {
1022         if (zfs_flags & ZFS_DEBUG_MODIFY) {
1023                 if (buf->b_hdr->b_state != arc_anon)
1024                         panic("modifying non-anon buffer!");
1025                 if (buf->b_hdr->b_flags & ARC_IO_IN_PROGRESS)
1026                         panic("modifying buffer while i/o in progress!");
1027                 arc_cksum_verify(buf);
1028         }
1029
1030         mutex_enter(&buf->b_hdr->b_freeze_lock);
1031         if (buf->b_hdr->b_freeze_cksum != NULL) {
1032                 kmem_free(buf->b_hdr->b_freeze_cksum, sizeof (zio_cksum_t));
1033                 buf->b_hdr->b_freeze_cksum = NULL;
1034         }
1035
1036         if (zfs_flags & ZFS_DEBUG_MODIFY) {
1037                 if (buf->b_hdr->b_thawed)
1038                         kmem_free(buf->b_hdr->b_thawed, 1);
1039                 buf->b_hdr->b_thawed = kmem_alloc(1, KM_SLEEP);
1040         }
1041
1042         mutex_exit(&buf->b_hdr->b_freeze_lock);
1043 }
1044
1045 void
1046 arc_buf_freeze(arc_buf_t *buf)
1047 {
1048         kmutex_t *hash_lock;
1049
1050         if (!(zfs_flags & ZFS_DEBUG_MODIFY))
1051                 return;
1052
1053         hash_lock = HDR_LOCK(buf->b_hdr);
1054         mutex_enter(hash_lock);
1055
1056         ASSERT(buf->b_hdr->b_freeze_cksum != NULL ||
1057             buf->b_hdr->b_state == arc_anon);
1058         arc_cksum_compute(buf, B_FALSE);
1059         mutex_exit(hash_lock);
1060 }
1061
1062 static void
1063 add_reference(arc_buf_hdr_t *ab, kmutex_t *hash_lock, void *tag)
1064 {
1065         ASSERT(MUTEX_HELD(hash_lock));
1066
1067         if ((refcount_add(&ab->b_refcnt, tag) == 1) &&
1068             (ab->b_state != arc_anon)) {
1069                 uint64_t delta = ab->b_size * ab->b_datacnt;
1070                 list_t *list = &ab->b_state->arcs_list[ab->b_type];
1071                 uint64_t *size = &ab->b_state->arcs_lsize[ab->b_type];
1072
1073                 ASSERT(!MUTEX_HELD(&ab->b_state->arcs_mtx));
1074                 mutex_enter(&ab->b_state->arcs_mtx);
1075                 ASSERT(list_link_active(&ab->b_arc_node));
1076                 list_remove(list, ab);
1077                 if (GHOST_STATE(ab->b_state)) {
1078                         ASSERT0(ab->b_datacnt);
1079                         ASSERT3P(ab->b_buf, ==, NULL);
1080                         delta = ab->b_size;
1081                 }
1082                 ASSERT(delta > 0);
1083                 ASSERT3U(*size, >=, delta);
1084                 atomic_add_64(size, -delta);
1085                 mutex_exit(&ab->b_state->arcs_mtx);
1086                 /* remove the prefetch flag if we get a reference */
1087                 if (ab->b_flags & ARC_PREFETCH)
1088                         ab->b_flags &= ~ARC_PREFETCH;
1089         }
1090 }
1091
1092 static int
1093 remove_reference(arc_buf_hdr_t *ab, kmutex_t *hash_lock, void *tag)
1094 {
1095         int cnt;
1096         arc_state_t *state = ab->b_state;
1097
1098         ASSERT(state == arc_anon || MUTEX_HELD(hash_lock));
1099         ASSERT(!GHOST_STATE(state));
1100
1101         if (((cnt = refcount_remove(&ab->b_refcnt, tag)) == 0) &&
1102             (state != arc_anon)) {
1103                 uint64_t *size = &state->arcs_lsize[ab->b_type];
1104
1105                 ASSERT(!MUTEX_HELD(&state->arcs_mtx));
1106                 mutex_enter(&state->arcs_mtx);
1107                 ASSERT(!list_link_active(&ab->b_arc_node));
1108                 list_insert_head(&state->arcs_list[ab->b_type], ab);
1109                 ASSERT(ab->b_datacnt > 0);
1110                 atomic_add_64(size, ab->b_size * ab->b_datacnt);
1111                 mutex_exit(&state->arcs_mtx);
1112         }
1113         return (cnt);
1114 }
1115
1116 /*
1117  * Move the supplied buffer to the indicated state.  The mutex
1118  * for the buffer must be held by the caller.
1119  */
1120 static void
1121 arc_change_state(arc_state_t *new_state, arc_buf_hdr_t *ab, kmutex_t *hash_lock)
1122 {
1123         arc_state_t *old_state = ab->b_state;
1124         int64_t refcnt = refcount_count(&ab->b_refcnt);
1125         uint64_t from_delta, to_delta;
1126
1127         ASSERT(MUTEX_HELD(hash_lock));
1128         ASSERT(new_state != old_state);
1129         ASSERT(refcnt == 0 || ab->b_datacnt > 0);
1130         ASSERT(ab->b_datacnt == 0 || !GHOST_STATE(new_state));
1131         ASSERT(ab->b_datacnt <= 1 || old_state != arc_anon);
1132
1133         from_delta = to_delta = ab->b_datacnt * ab->b_size;
1134
1135         /*
1136          * If this buffer is evictable, transfer it from the
1137          * old state list to the new state list.
1138          */
1139         if (refcnt == 0) {
1140                 if (old_state != arc_anon) {
1141                         int use_mutex = !MUTEX_HELD(&old_state->arcs_mtx);
1142                         uint64_t *size = &old_state->arcs_lsize[ab->b_type];
1143
1144                         if (use_mutex)
1145                                 mutex_enter(&old_state->arcs_mtx);
1146
1147                         ASSERT(list_link_active(&ab->b_arc_node));
1148                         list_remove(&old_state->arcs_list[ab->b_type], ab);
1149
1150                         /*
1151                          * If prefetching out of the ghost cache,
1152                          * we will have a non-zero datacnt.
1153                          */
1154                         if (GHOST_STATE(old_state) && ab->b_datacnt == 0) {
1155                                 /* ghost elements have a ghost size */
1156                                 ASSERT(ab->b_buf == NULL);
1157                                 from_delta = ab->b_size;
1158                         }
1159                         ASSERT3U(*size, >=, from_delta);
1160                         atomic_add_64(size, -from_delta);
1161
1162                         if (use_mutex)
1163                                 mutex_exit(&old_state->arcs_mtx);
1164                 }
1165                 if (new_state != arc_anon) {
1166                         int use_mutex = !MUTEX_HELD(&new_state->arcs_mtx);
1167                         uint64_t *size = &new_state->arcs_lsize[ab->b_type];
1168
1169                         if (use_mutex)
1170                                 mutex_enter(&new_state->arcs_mtx);
1171
1172                         list_insert_head(&new_state->arcs_list[ab->b_type], ab);
1173
1174                         /* ghost elements have a ghost size */
1175                         if (GHOST_STATE(new_state)) {
1176                                 ASSERT(ab->b_datacnt == 0);
1177                                 ASSERT(ab->b_buf == NULL);
1178                                 to_delta = ab->b_size;
1179                         }
1180                         atomic_add_64(size, to_delta);
1181
1182                         if (use_mutex)
1183                                 mutex_exit(&new_state->arcs_mtx);
1184                 }
1185         }
1186
1187         ASSERT(!BUF_EMPTY(ab));
1188         if (new_state == arc_anon && HDR_IN_HASH_TABLE(ab))
1189                 buf_hash_remove(ab);
1190
1191         /* adjust state sizes */
1192         if (to_delta)
1193                 atomic_add_64(&new_state->arcs_size, to_delta);
1194         if (from_delta) {
1195                 ASSERT3U(old_state->arcs_size, >=, from_delta);
1196                 atomic_add_64(&old_state->arcs_size, -from_delta);
1197         }
1198         ab->b_state = new_state;
1199
1200         /* adjust l2arc hdr stats */
1201         if (new_state == arc_l2c_only)
1202                 l2arc_hdr_stat_add();
1203         else if (old_state == arc_l2c_only)
1204                 l2arc_hdr_stat_remove();
1205 }
1206
1207 void
1208 arc_space_consume(uint64_t space, arc_space_type_t type)
1209 {
1210         ASSERT(type >= 0 && type < ARC_SPACE_NUMTYPES);
1211
1212         switch (type) {
1213         default:
1214                 break;
1215         case ARC_SPACE_DATA:
1216                 ARCSTAT_INCR(arcstat_data_size, space);
1217                 break;
1218         case ARC_SPACE_OTHER:
1219                 ARCSTAT_INCR(arcstat_other_size, space);
1220                 break;
1221         case ARC_SPACE_HDRS:
1222                 ARCSTAT_INCR(arcstat_hdr_size, space);
1223                 break;
1224         case ARC_SPACE_L2HDRS:
1225                 ARCSTAT_INCR(arcstat_l2_hdr_size, space);
1226                 break;
1227         }
1228
1229         atomic_add_64(&arc_meta_used, space);
1230         atomic_add_64(&arc_size, space);
1231 }
1232
1233 void
1234 arc_space_return(uint64_t space, arc_space_type_t type)
1235 {
1236         ASSERT(type >= 0 && type < ARC_SPACE_NUMTYPES);
1237
1238         switch (type) {
1239         default:
1240                 break;
1241         case ARC_SPACE_DATA:
1242                 ARCSTAT_INCR(arcstat_data_size, -space);
1243                 break;
1244         case ARC_SPACE_OTHER:
1245                 ARCSTAT_INCR(arcstat_other_size, -space);
1246                 break;
1247         case ARC_SPACE_HDRS:
1248                 ARCSTAT_INCR(arcstat_hdr_size, -space);
1249                 break;
1250         case ARC_SPACE_L2HDRS:
1251                 ARCSTAT_INCR(arcstat_l2_hdr_size, -space);
1252                 break;
1253         }
1254
1255         ASSERT(arc_meta_used >= space);
1256         if (arc_meta_max < arc_meta_used)
1257                 arc_meta_max = arc_meta_used;
1258         atomic_add_64(&arc_meta_used, -space);
1259         ASSERT(arc_size >= space);
1260         atomic_add_64(&arc_size, -space);
1261 }
1262
1263 void *
1264 arc_data_buf_alloc(uint64_t size)
1265 {
1266         if (arc_evict_needed(ARC_BUFC_DATA))
1267                 cv_signal(&arc_reclaim_thr_cv);
1268         atomic_add_64(&arc_size, size);
1269         return (zio_data_buf_alloc(size));
1270 }
1271
1272 void
1273 arc_data_buf_free(void *buf, uint64_t size)
1274 {
1275         zio_data_buf_free(buf, size);
1276         ASSERT(arc_size >= size);
1277         atomic_add_64(&arc_size, -size);
1278 }
1279
1280 arc_buf_t *
1281 arc_buf_alloc(spa_t *spa, int size, void *tag, arc_buf_contents_t type)
1282 {
1283         arc_buf_hdr_t *hdr;
1284         arc_buf_t *buf;
1285
1286         ASSERT3U(size, >, 0);
1287         hdr = kmem_cache_alloc(hdr_cache, KM_PUSHPAGE);
1288         ASSERT(BUF_EMPTY(hdr));
1289         hdr->b_size = size;
1290         hdr->b_type = type;
1291         hdr->b_spa = spa_load_guid(spa);
1292         hdr->b_state = arc_anon;
1293         hdr->b_arc_access = 0;
1294         buf = kmem_cache_alloc(buf_cache, KM_PUSHPAGE);
1295         buf->b_hdr = hdr;
1296         buf->b_data = NULL;
1297         buf->b_efunc = NULL;
1298         buf->b_private = NULL;
1299         buf->b_next = NULL;
1300         hdr->b_buf = buf;
1301         arc_get_data_buf(buf);
1302         hdr->b_datacnt = 1;
1303         hdr->b_flags = 0;
1304         ASSERT(refcount_is_zero(&hdr->b_refcnt));
1305         (void) refcount_add(&hdr->b_refcnt, tag);
1306
1307         return (buf);
1308 }
1309
1310 static char *arc_onloan_tag = "onloan";
1311
1312 /*
1313  * Loan out an anonymous arc buffer. Loaned buffers are not counted as in
1314  * flight data by arc_tempreserve_space() until they are "returned". Loaned
1315  * buffers must be returned to the arc before they can be used by the DMU or
1316  * freed.
1317  */
1318 arc_buf_t *
1319 arc_loan_buf(spa_t *spa, int size)
1320 {
1321         arc_buf_t *buf;
1322
1323         buf = arc_buf_alloc(spa, size, arc_onloan_tag, ARC_BUFC_DATA);
1324
1325         atomic_add_64(&arc_loaned_bytes, size);
1326         return (buf);
1327 }
1328
1329 /*
1330  * Return a loaned arc buffer to the arc.
1331  */
1332 void
1333 arc_return_buf(arc_buf_t *buf, void *tag)
1334 {
1335         arc_buf_hdr_t *hdr = buf->b_hdr;
1336
1337         ASSERT(buf->b_data != NULL);
1338         (void) refcount_add(&hdr->b_refcnt, tag);
1339         (void) refcount_remove(&hdr->b_refcnt, arc_onloan_tag);
1340
1341         atomic_add_64(&arc_loaned_bytes, -hdr->b_size);
1342 }
1343
1344 /* Detach an arc_buf from a dbuf (tag) */
1345 void
1346 arc_loan_inuse_buf(arc_buf_t *buf, void *tag)
1347 {
1348         arc_buf_hdr_t *hdr;
1349
1350         ASSERT(buf->b_data != NULL);
1351         hdr = buf->b_hdr;
1352         (void) refcount_add(&hdr->b_refcnt, arc_onloan_tag);
1353         (void) refcount_remove(&hdr->b_refcnt, tag);
1354         buf->b_efunc = NULL;
1355         buf->b_private = NULL;
1356
1357         atomic_add_64(&arc_loaned_bytes, hdr->b_size);
1358 }
1359
1360 static arc_buf_t *
1361 arc_buf_clone(arc_buf_t *from)
1362 {
1363         arc_buf_t *buf;
1364         arc_buf_hdr_t *hdr = from->b_hdr;
1365         uint64_t size = hdr->b_size;
1366
1367         ASSERT(hdr->b_state != arc_anon);
1368
1369         buf = kmem_cache_alloc(buf_cache, KM_PUSHPAGE);
1370         buf->b_hdr = hdr;
1371         buf->b_data = NULL;
1372         buf->b_efunc = NULL;
1373         buf->b_private = NULL;
1374         buf->b_next = hdr->b_buf;
1375         hdr->b_buf = buf;
1376         arc_get_data_buf(buf);
1377         bcopy(from->b_data, buf->b_data, size);
1378
1379         /*
1380          * This buffer already exists in the arc so create a duplicate
1381          * copy for the caller.  If the buffer is associated with user data
1382          * then track the size and number of duplicates.  These stats will be
1383          * updated as duplicate buffers are created and destroyed.
1384          */
1385         if (hdr->b_type == ARC_BUFC_DATA) {
1386                 ARCSTAT_BUMP(arcstat_duplicate_buffers);
1387                 ARCSTAT_INCR(arcstat_duplicate_buffers_size, size);
1388         }
1389         hdr->b_datacnt += 1;
1390         return (buf);
1391 }
1392
1393 void
1394 arc_buf_add_ref(arc_buf_t *buf, void* tag)
1395 {
1396         arc_buf_hdr_t *hdr;
1397         kmutex_t *hash_lock;
1398
1399         /*
1400          * Check to see if this buffer is evicted.  Callers
1401          * must verify b_data != NULL to know if the add_ref
1402          * was successful.
1403          */
1404         mutex_enter(&buf->b_evict_lock);
1405         if (buf->b_data == NULL) {
1406                 mutex_exit(&buf->b_evict_lock);
1407                 return;
1408         }
1409         hash_lock = HDR_LOCK(buf->b_hdr);
1410         mutex_enter(hash_lock);
1411         hdr = buf->b_hdr;
1412         ASSERT3P(hash_lock, ==, HDR_LOCK(hdr));
1413         mutex_exit(&buf->b_evict_lock);
1414
1415         ASSERT(hdr->b_state == arc_mru || hdr->b_state == arc_mfu);
1416         add_reference(hdr, hash_lock, tag);
1417         DTRACE_PROBE1(arc__hit, arc_buf_hdr_t *, hdr);
1418         arc_access(hdr, hash_lock);
1419         mutex_exit(hash_lock);
1420         ARCSTAT_BUMP(arcstat_hits);
1421         ARCSTAT_CONDSTAT(!(hdr->b_flags & ARC_PREFETCH),
1422             demand, prefetch, hdr->b_type != ARC_BUFC_METADATA,
1423             data, metadata, hits);
1424 }
1425
1426 /*
1427  * Free the arc data buffer.  If it is an l2arc write in progress,
1428  * the buffer is placed on l2arc_free_on_write to be freed later.
1429  */
1430 static void
1431 arc_buf_data_free(arc_buf_hdr_t *hdr, void (*free_func)(void *, size_t),
1432     void *data, size_t size)
1433 {
1434         if (HDR_L2_WRITING(hdr)) {
1435                 l2arc_data_free_t *df;
1436                 df = kmem_alloc(sizeof (l2arc_data_free_t), KM_PUSHPAGE);
1437                 df->l2df_data = data;
1438                 df->l2df_size = size;
1439                 df->l2df_func = free_func;
1440                 mutex_enter(&l2arc_free_on_write_mtx);
1441                 list_insert_head(l2arc_free_on_write, df);
1442                 mutex_exit(&l2arc_free_on_write_mtx);
1443                 ARCSTAT_BUMP(arcstat_l2_free_on_write);
1444         } else {
1445                 free_func(data, size);
1446         }
1447 }
1448
1449 static void
1450 arc_buf_destroy(arc_buf_t *buf, boolean_t recycle, boolean_t all)
1451 {
1452         arc_buf_t **bufp;
1453
1454         /* free up data associated with the buf */
1455         if (buf->b_data) {
1456                 arc_state_t *state = buf->b_hdr->b_state;
1457                 uint64_t size = buf->b_hdr->b_size;
1458                 arc_buf_contents_t type = buf->b_hdr->b_type;
1459
1460                 arc_cksum_verify(buf);
1461
1462                 if (!recycle) {
1463                         if (type == ARC_BUFC_METADATA) {
1464                                 arc_buf_data_free(buf->b_hdr, zio_buf_free,
1465                                     buf->b_data, size);
1466                                 arc_space_return(size, ARC_SPACE_DATA);
1467                         } else {
1468                                 ASSERT(type == ARC_BUFC_DATA);
1469                                 arc_buf_data_free(buf->b_hdr,
1470                                     zio_data_buf_free, buf->b_data, size);
1471                                 ARCSTAT_INCR(arcstat_data_size, -size);
1472                                 atomic_add_64(&arc_size, -size);
1473                         }
1474                 }
1475                 if (list_link_active(&buf->b_hdr->b_arc_node)) {
1476                         uint64_t *cnt = &state->arcs_lsize[type];
1477
1478                         ASSERT(refcount_is_zero(&buf->b_hdr->b_refcnt));
1479                         ASSERT(state != arc_anon);
1480
1481                         ASSERT3U(*cnt, >=, size);
1482                         atomic_add_64(cnt, -size);
1483                 }
1484                 ASSERT3U(state->arcs_size, >=, size);
1485                 atomic_add_64(&state->arcs_size, -size);
1486                 buf->b_data = NULL;
1487
1488                 /*
1489                  * If we're destroying a duplicate buffer make sure
1490                  * that the appropriate statistics are updated.
1491                  */
1492                 if (buf->b_hdr->b_datacnt > 1 &&
1493                     buf->b_hdr->b_type == ARC_BUFC_DATA) {
1494                         ARCSTAT_BUMPDOWN(arcstat_duplicate_buffers);
1495                         ARCSTAT_INCR(arcstat_duplicate_buffers_size, -size);
1496                 }
1497                 ASSERT(buf->b_hdr->b_datacnt > 0);
1498                 buf->b_hdr->b_datacnt -= 1;
1499         }
1500
1501         /* only remove the buf if requested */
1502         if (!all)
1503                 return;
1504
1505         /* remove the buf from the hdr list */
1506         for (bufp = &buf->b_hdr->b_buf; *bufp != buf; bufp = &(*bufp)->b_next)
1507                 continue;
1508         *bufp = buf->b_next;
1509         buf->b_next = NULL;
1510
1511         ASSERT(buf->b_efunc == NULL);
1512
1513         /* clean up the buf */
1514         buf->b_hdr = NULL;
1515         kmem_cache_free(buf_cache, buf);
1516 }
1517
1518 static void
1519 arc_hdr_destroy(arc_buf_hdr_t *hdr)
1520 {
1521         l2arc_buf_hdr_t *l2hdr = hdr->b_l2hdr;
1522
1523         ASSERT(refcount_is_zero(&hdr->b_refcnt));
1524         ASSERT3P(hdr->b_state, ==, arc_anon);
1525         ASSERT(!HDR_IO_IN_PROGRESS(hdr));
1526
1527         if (l2hdr != NULL) {
1528                 boolean_t buflist_held = MUTEX_HELD(&l2arc_buflist_mtx);
1529                 /*
1530                  * To prevent arc_free() and l2arc_evict() from
1531                  * attempting to free the same buffer at the same time,
1532                  * a FREE_IN_PROGRESS flag is given to arc_free() to
1533                  * give it priority.  l2arc_evict() can't destroy this
1534                  * header while we are waiting on l2arc_buflist_mtx.
1535                  *
1536                  * The hdr may be removed from l2ad_buflist before we
1537                  * grab l2arc_buflist_mtx, so b_l2hdr is rechecked.
1538                  */
1539                 if (!buflist_held) {
1540                         mutex_enter(&l2arc_buflist_mtx);
1541                         l2hdr = hdr->b_l2hdr;
1542                 }
1543
1544                 if (l2hdr != NULL) {
1545                         list_remove(l2hdr->b_dev->l2ad_buflist, hdr);
1546                         ARCSTAT_INCR(arcstat_l2_size, -hdr->b_size);
1547                         kmem_free(l2hdr, sizeof (l2arc_buf_hdr_t));
1548                         if (hdr->b_state == arc_l2c_only)
1549                                 l2arc_hdr_stat_remove();
1550                         hdr->b_l2hdr = NULL;
1551                 }
1552
1553                 if (!buflist_held)
1554                         mutex_exit(&l2arc_buflist_mtx);
1555         }
1556
1557         if (!BUF_EMPTY(hdr)) {
1558                 ASSERT(!HDR_IN_HASH_TABLE(hdr));
1559                 buf_discard_identity(hdr);
1560         }
1561         while (hdr->b_buf) {
1562                 arc_buf_t *buf = hdr->b_buf;
1563
1564                 if (buf->b_efunc) {
1565                         mutex_enter(&arc_eviction_mtx);
1566                         mutex_enter(&buf->b_evict_lock);
1567                         ASSERT(buf->b_hdr != NULL);
1568                         arc_buf_destroy(hdr->b_buf, FALSE, FALSE);
1569                         hdr->b_buf = buf->b_next;
1570                         buf->b_hdr = &arc_eviction_hdr;
1571                         buf->b_next = arc_eviction_list;
1572                         arc_eviction_list = buf;
1573                         mutex_exit(&buf->b_evict_lock);
1574                         mutex_exit(&arc_eviction_mtx);
1575                 } else {
1576                         arc_buf_destroy(hdr->b_buf, FALSE, TRUE);
1577                 }
1578         }
1579         if (hdr->b_freeze_cksum != NULL) {
1580                 kmem_free(hdr->b_freeze_cksum, sizeof (zio_cksum_t));
1581                 hdr->b_freeze_cksum = NULL;
1582         }
1583         if (hdr->b_thawed) {
1584                 kmem_free(hdr->b_thawed, 1);
1585                 hdr->b_thawed = NULL;
1586         }
1587
1588         ASSERT(!list_link_active(&hdr->b_arc_node));
1589         ASSERT3P(hdr->b_hash_next, ==, NULL);
1590         ASSERT3P(hdr->b_acb, ==, NULL);
1591         kmem_cache_free(hdr_cache, hdr);
1592 }
1593
1594 void
1595 arc_buf_free(arc_buf_t *buf, void *tag)
1596 {
1597         arc_buf_hdr_t *hdr = buf->b_hdr;
1598         int hashed = hdr->b_state != arc_anon;
1599
1600         ASSERT(buf->b_efunc == NULL);
1601         ASSERT(buf->b_data != NULL);
1602
1603         if (hashed) {
1604                 kmutex_t *hash_lock = HDR_LOCK(hdr);
1605
1606                 mutex_enter(hash_lock);
1607                 hdr = buf->b_hdr;
1608                 ASSERT3P(hash_lock, ==, HDR_LOCK(hdr));
1609
1610                 (void) remove_reference(hdr, hash_lock, tag);
1611                 if (hdr->b_datacnt > 1) {
1612                         arc_buf_destroy(buf, FALSE, TRUE);
1613                 } else {
1614                         ASSERT(buf == hdr->b_buf);
1615                         ASSERT(buf->b_efunc == NULL);
1616                         hdr->b_flags |= ARC_BUF_AVAILABLE;
1617                 }
1618                 mutex_exit(hash_lock);
1619         } else if (HDR_IO_IN_PROGRESS(hdr)) {
1620                 int destroy_hdr;
1621                 /*
1622                  * We are in the middle of an async write.  Don't destroy
1623                  * this buffer unless the write completes before we finish
1624                  * decrementing the reference count.
1625                  */
1626                 mutex_enter(&arc_eviction_mtx);
1627                 (void) remove_reference(hdr, NULL, tag);
1628                 ASSERT(refcount_is_zero(&hdr->b_refcnt));
1629                 destroy_hdr = !HDR_IO_IN_PROGRESS(hdr);
1630                 mutex_exit(&arc_eviction_mtx);
1631                 if (destroy_hdr)
1632                         arc_hdr_destroy(hdr);
1633         } else {
1634                 if (remove_reference(hdr, NULL, tag) > 0)
1635                         arc_buf_destroy(buf, FALSE, TRUE);
1636                 else
1637                         arc_hdr_destroy(hdr);
1638         }
1639 }
1640
1641 int
1642 arc_buf_remove_ref(arc_buf_t *buf, void* tag)
1643 {
1644         arc_buf_hdr_t *hdr = buf->b_hdr;
1645         kmutex_t *hash_lock = NULL;
1646         int no_callback = (buf->b_efunc == NULL);
1647
1648         if (hdr->b_state == arc_anon) {
1649                 ASSERT(hdr->b_datacnt == 1);
1650                 arc_buf_free(buf, tag);
1651                 return (no_callback);
1652         }
1653
1654         hash_lock = HDR_LOCK(hdr);
1655         mutex_enter(hash_lock);
1656         hdr = buf->b_hdr;
1657         ASSERT3P(hash_lock, ==, HDR_LOCK(hdr));
1658         ASSERT(hdr->b_state != arc_anon);
1659         ASSERT(buf->b_data != NULL);
1660
1661         (void) remove_reference(hdr, hash_lock, tag);
1662         if (hdr->b_datacnt > 1) {
1663                 if (no_callback)
1664                         arc_buf_destroy(buf, FALSE, TRUE);
1665         } else if (no_callback) {
1666                 ASSERT(hdr->b_buf == buf && buf->b_next == NULL);
1667                 ASSERT(buf->b_efunc == NULL);
1668                 hdr->b_flags |= ARC_BUF_AVAILABLE;
1669         }
1670         ASSERT(no_callback || hdr->b_datacnt > 1 ||
1671             refcount_is_zero(&hdr->b_refcnt));
1672         mutex_exit(hash_lock);
1673         return (no_callback);
1674 }
1675
1676 int
1677 arc_buf_size(arc_buf_t *buf)
1678 {
1679         return (buf->b_hdr->b_size);
1680 }
1681
1682 /*
1683  * Called from the DMU to determine if the current buffer should be
1684  * evicted. In order to ensure proper locking, the eviction must be initiated
1685  * from the DMU. Return true if the buffer is associated with user data and
1686  * duplicate buffers still exist.
1687  */
1688 boolean_t
1689 arc_buf_eviction_needed(arc_buf_t *buf)
1690 {
1691         arc_buf_hdr_t *hdr;
1692         boolean_t evict_needed = B_FALSE;
1693
1694         if (zfs_disable_dup_eviction)
1695                 return (B_FALSE);
1696
1697         mutex_enter(&buf->b_evict_lock);
1698         hdr = buf->b_hdr;
1699         if (hdr == NULL) {
1700                 /*
1701                  * We are in arc_do_user_evicts(); let that function
1702                  * perform the eviction.
1703                  */
1704                 ASSERT(buf->b_data == NULL);
1705                 mutex_exit(&buf->b_evict_lock);
1706                 return (B_FALSE);
1707         } else if (buf->b_data == NULL) {
1708                 /*
1709                  * We have already been added to the arc eviction list;
1710                  * recommend eviction.
1711                  */
1712                 ASSERT3P(hdr, ==, &arc_eviction_hdr);
1713                 mutex_exit(&buf->b_evict_lock);
1714                 return (B_TRUE);
1715         }
1716
1717         if (hdr->b_datacnt > 1 && hdr->b_type == ARC_BUFC_DATA)
1718                 evict_needed = B_TRUE;
1719
1720         mutex_exit(&buf->b_evict_lock);
1721         return (evict_needed);
1722 }
1723
1724 /*
1725  * Evict buffers from list until we've removed the specified number of
1726  * bytes.  Move the removed buffers to the appropriate evict state.
1727  * If the recycle flag is set, then attempt to "recycle" a buffer:
1728  * - look for a buffer to evict that is `bytes' long.
1729  * - return the data block from this buffer rather than freeing it.
1730  * This flag is used by callers that are trying to make space for a
1731  * new buffer in a full arc cache.
1732  *
1733  * This function makes a "best effort".  It skips over any buffers
1734  * it can't get a hash_lock on, and so may not catch all candidates.
1735  * It may also return without evicting as much space as requested.
1736  */
1737 static void *
1738 arc_evict(arc_state_t *state, uint64_t spa, int64_t bytes, boolean_t recycle,
1739     arc_buf_contents_t type)
1740 {
1741         arc_state_t *evicted_state;
1742         uint64_t bytes_evicted = 0, skipped = 0, missed = 0;
1743         arc_buf_hdr_t *ab, *ab_prev = NULL;
1744         list_t *list = &state->arcs_list[type];
1745         kmutex_t *hash_lock;
1746         boolean_t have_lock;
1747         void *stolen = NULL;
1748
1749         ASSERT(state == arc_mru || state == arc_mfu);
1750
1751         evicted_state = (state == arc_mru) ? arc_mru_ghost : arc_mfu_ghost;
1752
1753         mutex_enter(&state->arcs_mtx);
1754         mutex_enter(&evicted_state->arcs_mtx);
1755
1756         for (ab = list_tail(list); ab; ab = ab_prev) {
1757                 ab_prev = list_prev(list, ab);
1758                 /* prefetch buffers have a minimum lifespan */
1759                 if (HDR_IO_IN_PROGRESS(ab) ||
1760                     (spa && ab->b_spa != spa) ||
1761                     (ab->b_flags & (ARC_PREFETCH|ARC_INDIRECT) &&
1762                     ddi_get_lbolt() - ab->b_arc_access <
1763                     arc_min_prefetch_lifespan)) {
1764                         skipped++;
1765                         continue;
1766                 }
1767                 /* "lookahead" for better eviction candidate */
1768                 if (recycle && ab->b_size != bytes &&
1769                     ab_prev && ab_prev->b_size == bytes)
1770                         continue;
1771                 hash_lock = HDR_LOCK(ab);
1772                 have_lock = MUTEX_HELD(hash_lock);
1773                 if (have_lock || mutex_tryenter(hash_lock)) {
1774                         ASSERT0(refcount_count(&ab->b_refcnt));
1775                         ASSERT(ab->b_datacnt > 0);
1776                         while (ab->b_buf) {
1777                                 arc_buf_t *buf = ab->b_buf;
1778                                 if (!mutex_tryenter(&buf->b_evict_lock)) {
1779                                         missed += 1;
1780                                         break;
1781                                 }
1782                                 if (buf->b_data) {
1783                                         bytes_evicted += ab->b_size;
1784                                         if (recycle && ab->b_type == type &&
1785                                             ab->b_size == bytes &&
1786                                             !HDR_L2_WRITING(ab)) {
1787                                                 stolen = buf->b_data;
1788                                                 recycle = FALSE;
1789                                         }
1790                                 }
1791                                 if (buf->b_efunc) {
1792                                         mutex_enter(&arc_eviction_mtx);
1793                                         arc_buf_destroy(buf,
1794                                             buf->b_data == stolen, FALSE);
1795                                         ab->b_buf = buf->b_next;
1796                                         buf->b_hdr = &arc_eviction_hdr;
1797                                         buf->b_next = arc_eviction_list;
1798                                         arc_eviction_list = buf;
1799                                         mutex_exit(&arc_eviction_mtx);
1800                                         mutex_exit(&buf->b_evict_lock);
1801                                 } else {
1802                                         mutex_exit(&buf->b_evict_lock);
1803                                         arc_buf_destroy(buf,
1804                                             buf->b_data == stolen, TRUE);
1805                                 }
1806                         }
1807
1808                         if (ab->b_l2hdr) {
1809                                 ARCSTAT_INCR(arcstat_evict_l2_cached,
1810                                     ab->b_size);
1811                         } else {
1812                                 if (l2arc_write_eligible(ab->b_spa, ab)) {
1813                                         ARCSTAT_INCR(arcstat_evict_l2_eligible,
1814                                             ab->b_size);
1815                                 } else {
1816                                         ARCSTAT_INCR(
1817                                             arcstat_evict_l2_ineligible,
1818                                             ab->b_size);
1819                                 }
1820                         }
1821
1822                         if (ab->b_datacnt == 0) {
1823                                 arc_change_state(evicted_state, ab, hash_lock);
1824                                 ASSERT(HDR_IN_HASH_TABLE(ab));
1825                                 ab->b_flags |= ARC_IN_HASH_TABLE;
1826                                 ab->b_flags &= ~ARC_BUF_AVAILABLE;
1827                                 DTRACE_PROBE1(arc__evict, arc_buf_hdr_t *, ab);
1828                         }
1829                         if (!have_lock)
1830                                 mutex_exit(hash_lock);
1831                         if (bytes >= 0 && bytes_evicted >= bytes)
1832                                 break;
1833                 } else {
1834                         missed += 1;
1835                 }
1836         }
1837
1838         mutex_exit(&evicted_state->arcs_mtx);
1839         mutex_exit(&state->arcs_mtx);
1840
1841         if (bytes_evicted < bytes)
1842                 dprintf("only evicted %lld bytes from %x\n",
1843                     (longlong_t)bytes_evicted, state);
1844
1845         if (skipped)
1846                 ARCSTAT_INCR(arcstat_evict_skip, skipped);
1847
1848         if (missed)
1849                 ARCSTAT_INCR(arcstat_mutex_miss, missed);
1850
1851         /*
1852          * We have just evicted some date into the ghost state, make
1853          * sure we also adjust the ghost state size if necessary.
1854          */
1855         if (arc_no_grow &&
1856             arc_mru_ghost->arcs_size + arc_mfu_ghost->arcs_size > arc_c) {
1857                 int64_t mru_over = arc_anon->arcs_size + arc_mru->arcs_size +
1858                     arc_mru_ghost->arcs_size - arc_c;
1859
1860                 if (mru_over > 0 && arc_mru_ghost->arcs_lsize[type] > 0) {
1861                         int64_t todelete =
1862                             MIN(arc_mru_ghost->arcs_lsize[type], mru_over);
1863                         arc_evict_ghost(arc_mru_ghost, 0, todelete);
1864                 } else if (arc_mfu_ghost->arcs_lsize[type] > 0) {
1865                         int64_t todelete = MIN(arc_mfu_ghost->arcs_lsize[type],
1866                             arc_mru_ghost->arcs_size +
1867                             arc_mfu_ghost->arcs_size - arc_c);
1868                         arc_evict_ghost(arc_mfu_ghost, 0, todelete);
1869                 }
1870         }
1871
1872         return (stolen);
1873 }
1874
1875 /*
1876  * Remove buffers from list until we've removed the specified number of
1877  * bytes.  Destroy the buffers that are removed.
1878  */
1879 static void
1880 arc_evict_ghost(arc_state_t *state, uint64_t spa, int64_t bytes)
1881 {
1882         arc_buf_hdr_t *ab, *ab_prev;
1883         arc_buf_hdr_t marker;
1884         list_t *list = &state->arcs_list[ARC_BUFC_DATA];
1885         kmutex_t *hash_lock;
1886         uint64_t bytes_deleted = 0;
1887         uint64_t bufs_skipped = 0;
1888
1889         ASSERT(GHOST_STATE(state));
1890         bzero(&marker, sizeof(marker));
1891 top:
1892         mutex_enter(&state->arcs_mtx);
1893         for (ab = list_tail(list); ab; ab = ab_prev) {
1894                 ab_prev = list_prev(list, ab);
1895                 if (spa && ab->b_spa != spa)
1896                         continue;
1897
1898                 /* ignore markers */
1899                 if (ab->b_spa == 0)
1900                         continue;
1901
1902                 hash_lock = HDR_LOCK(ab);
1903                 /* caller may be trying to modify this buffer, skip it */
1904                 if (MUTEX_HELD(hash_lock))
1905                         continue;
1906                 if (mutex_tryenter(hash_lock)) {
1907                         ASSERT(!HDR_IO_IN_PROGRESS(ab));
1908                         ASSERT(ab->b_buf == NULL);
1909                         ARCSTAT_BUMP(arcstat_deleted);
1910                         bytes_deleted += ab->b_size;
1911
1912                         if (ab->b_l2hdr != NULL) {
1913                                 /*
1914                                  * This buffer is cached on the 2nd Level ARC;
1915                                  * don't destroy the header.
1916                                  */
1917                                 arc_change_state(arc_l2c_only, ab, hash_lock);
1918                                 mutex_exit(hash_lock);
1919                         } else {
1920                                 arc_change_state(arc_anon, ab, hash_lock);
1921                                 mutex_exit(hash_lock);
1922                                 arc_hdr_destroy(ab);
1923                         }
1924
1925                         DTRACE_PROBE1(arc__delete, arc_buf_hdr_t *, ab);
1926                         if (bytes >= 0 && bytes_deleted >= bytes)
1927                                 break;
1928                 } else if (bytes < 0) {
1929                         /*
1930                          * Insert a list marker and then wait for the
1931                          * hash lock to become available. Once its
1932                          * available, restart from where we left off.
1933                          */
1934                         list_insert_after(list, ab, &marker);
1935                         mutex_exit(&state->arcs_mtx);
1936                         mutex_enter(hash_lock);
1937                         mutex_exit(hash_lock);
1938                         mutex_enter(&state->arcs_mtx);
1939                         ab_prev = list_prev(list, &marker);
1940                         list_remove(list, &marker);
1941                 } else
1942                         bufs_skipped += 1;
1943         }
1944         mutex_exit(&state->arcs_mtx);
1945
1946         if (list == &state->arcs_list[ARC_BUFC_DATA] &&
1947             (bytes < 0 || bytes_deleted < bytes)) {
1948                 list = &state->arcs_list[ARC_BUFC_METADATA];
1949                 goto top;
1950         }
1951
1952         if (bufs_skipped) {
1953                 ARCSTAT_INCR(arcstat_mutex_miss, bufs_skipped);
1954                 ASSERT(bytes >= 0);
1955         }
1956
1957         if (bytes_deleted < bytes)
1958                 dprintf("only deleted %lld bytes from %p\n",
1959                     (longlong_t)bytes_deleted, state);
1960 }
1961
1962 static void
1963 arc_adjust(void)
1964 {
1965         int64_t adjustment, delta;
1966
1967         /*
1968          * Adjust MRU size
1969          */
1970
1971         adjustment = MIN((int64_t)(arc_size - arc_c),
1972             (int64_t)(arc_anon->arcs_size + arc_mru->arcs_size + arc_meta_used -
1973             arc_p));
1974
1975         if (adjustment > 0 && arc_mru->arcs_lsize[ARC_BUFC_DATA] > 0) {
1976                 delta = MIN(arc_mru->arcs_lsize[ARC_BUFC_DATA], adjustment);
1977                 (void) arc_evict(arc_mru, 0, delta, FALSE, ARC_BUFC_DATA);
1978                 adjustment -= delta;
1979         }
1980
1981         if (adjustment > 0 && arc_mru->arcs_lsize[ARC_BUFC_METADATA] > 0) {
1982                 delta = MIN(arc_mru->arcs_lsize[ARC_BUFC_METADATA], adjustment);
1983                 (void) arc_evict(arc_mru, 0, delta, FALSE,
1984                     ARC_BUFC_METADATA);
1985         }
1986
1987         /*
1988          * Adjust MFU size
1989          */
1990
1991         adjustment = arc_size - arc_c;
1992
1993         if (adjustment > 0 && arc_mfu->arcs_lsize[ARC_BUFC_DATA] > 0) {
1994                 delta = MIN(adjustment, arc_mfu->arcs_lsize[ARC_BUFC_DATA]);
1995                 (void) arc_evict(arc_mfu, 0, delta, FALSE, ARC_BUFC_DATA);
1996                 adjustment -= delta;
1997         }
1998
1999         if (adjustment > 0 && arc_mfu->arcs_lsize[ARC_BUFC_METADATA] > 0) {
2000                 int64_t delta = MIN(adjustment,
2001                     arc_mfu->arcs_lsize[ARC_BUFC_METADATA]);
2002                 (void) arc_evict(arc_mfu, 0, delta, FALSE,
2003                     ARC_BUFC_METADATA);
2004         }
2005
2006         /*
2007          * Adjust ghost lists
2008          */
2009
2010         adjustment = arc_mru->arcs_size + arc_mru_ghost->arcs_size - arc_c;
2011
2012         if (adjustment > 0 && arc_mru_ghost->arcs_size > 0) {
2013                 delta = MIN(arc_mru_ghost->arcs_size, adjustment);
2014                 arc_evict_ghost(arc_mru_ghost, 0, delta);
2015         }
2016
2017         adjustment =
2018             arc_mru_ghost->arcs_size + arc_mfu_ghost->arcs_size - arc_c;
2019
2020         if (adjustment > 0 && arc_mfu_ghost->arcs_size > 0) {
2021                 delta = MIN(arc_mfu_ghost->arcs_size, adjustment);
2022                 arc_evict_ghost(arc_mfu_ghost, 0, delta);
2023         }
2024 }
2025
2026 /*
2027  * Request that arc user drop references so that N bytes can be released
2028  * from the cache.  This provides a mechanism to ensure the arc can honor
2029  * the arc_meta_limit and reclaim buffers which are pinned in the cache
2030  * by higher layers.  (i.e. the zpl)
2031  */
2032 static void
2033 arc_do_user_prune(int64_t adjustment)
2034 {
2035         arc_prune_func_t *func;
2036         void *private;
2037         arc_prune_t *cp, *np;
2038
2039         mutex_enter(&arc_prune_mtx);
2040
2041         cp = list_head(&arc_prune_list);
2042         while (cp != NULL) {
2043                 func = cp->p_pfunc;
2044                 private = cp->p_private;
2045                 np = list_next(&arc_prune_list, cp);
2046                 refcount_add(&cp->p_refcnt, func);
2047                 mutex_exit(&arc_prune_mtx);
2048
2049                 if (func != NULL)
2050                         func(adjustment, private);
2051
2052                 mutex_enter(&arc_prune_mtx);
2053
2054                 /* User removed prune callback concurrently with execution */
2055                 if (refcount_remove(&cp->p_refcnt, func) == 0) {
2056                         ASSERT(!list_link_active(&cp->p_node));
2057                         refcount_destroy(&cp->p_refcnt);
2058                         kmem_free(cp, sizeof (*cp));
2059                 }
2060
2061                 cp = np;
2062         }
2063
2064         ARCSTAT_BUMP(arcstat_prune);
2065         mutex_exit(&arc_prune_mtx);
2066 }
2067
2068 static void
2069 arc_do_user_evicts(void)
2070 {
2071         mutex_enter(&arc_eviction_mtx);
2072         while (arc_eviction_list != NULL) {
2073                 arc_buf_t *buf = arc_eviction_list;
2074                 arc_eviction_list = buf->b_next;
2075                 mutex_enter(&buf->b_evict_lock);
2076                 buf->b_hdr = NULL;
2077                 mutex_exit(&buf->b_evict_lock);
2078                 mutex_exit(&arc_eviction_mtx);
2079
2080                 if (buf->b_efunc != NULL)
2081                         VERIFY(buf->b_efunc(buf) == 0);
2082
2083                 buf->b_efunc = NULL;
2084                 buf->b_private = NULL;
2085                 kmem_cache_free(buf_cache, buf);
2086                 mutex_enter(&arc_eviction_mtx);
2087         }
2088         mutex_exit(&arc_eviction_mtx);
2089 }
2090
2091 /*
2092  * Evict only meta data objects from the cache leaving the data objects.
2093  * This is only used to enforce the tunable arc_meta_limit, if we are
2094  * unable to evict enough buffers notify the user via the prune callback.
2095  */
2096 void
2097 arc_adjust_meta(int64_t adjustment, boolean_t may_prune)
2098 {
2099         int64_t delta;
2100
2101         if (adjustment > 0 && arc_mru->arcs_lsize[ARC_BUFC_METADATA] > 0) {
2102                 delta = MIN(arc_mru->arcs_lsize[ARC_BUFC_METADATA], adjustment);
2103                 arc_evict(arc_mru, 0, delta, FALSE, ARC_BUFC_METADATA);
2104                 adjustment -= delta;
2105         }
2106
2107         if (adjustment > 0 && arc_mfu->arcs_lsize[ARC_BUFC_METADATA] > 0) {
2108                 delta = MIN(arc_mfu->arcs_lsize[ARC_BUFC_METADATA], adjustment);
2109                 arc_evict(arc_mfu, 0, delta, FALSE, ARC_BUFC_METADATA);
2110                 adjustment -= delta;
2111         }
2112
2113         if (may_prune && (adjustment > 0) && (arc_meta_used > arc_meta_limit))
2114                 arc_do_user_prune(arc_meta_prune);
2115 }
2116
2117 /*
2118  * Flush all *evictable* data from the cache for the given spa.
2119  * NOTE: this will not touch "active" (i.e. referenced) data.
2120  */
2121 void
2122 arc_flush(spa_t *spa)
2123 {
2124         uint64_t guid = 0;
2125
2126         if (spa)
2127                 guid = spa_load_guid(spa);
2128
2129         while (list_head(&arc_mru->arcs_list[ARC_BUFC_DATA])) {
2130                 (void) arc_evict(arc_mru, guid, -1, FALSE, ARC_BUFC_DATA);
2131                 if (spa)
2132                         break;
2133         }
2134         while (list_head(&arc_mru->arcs_list[ARC_BUFC_METADATA])) {
2135                 (void) arc_evict(arc_mru, guid, -1, FALSE, ARC_BUFC_METADATA);
2136                 if (spa)
2137                         break;
2138         }
2139         while (list_head(&arc_mfu->arcs_list[ARC_BUFC_DATA])) {
2140                 (void) arc_evict(arc_mfu, guid, -1, FALSE, ARC_BUFC_DATA);
2141                 if (spa)
2142                         break;
2143         }
2144         while (list_head(&arc_mfu->arcs_list[ARC_BUFC_METADATA])) {
2145                 (void) arc_evict(arc_mfu, guid, -1, FALSE, ARC_BUFC_METADATA);
2146                 if (spa)
2147                         break;
2148         }
2149
2150         arc_evict_ghost(arc_mru_ghost, guid, -1);
2151         arc_evict_ghost(arc_mfu_ghost, guid, -1);
2152
2153         mutex_enter(&arc_reclaim_thr_lock);
2154         arc_do_user_evicts();
2155         mutex_exit(&arc_reclaim_thr_lock);
2156         ASSERT(spa || arc_eviction_list == NULL);
2157 }
2158
2159 void
2160 arc_shrink(uint64_t bytes)
2161 {
2162         if (arc_c > arc_c_min) {
2163                 uint64_t to_free;
2164
2165                 to_free = bytes ? bytes : arc_c >> arc_shrink_shift;
2166
2167                 if (arc_c > arc_c_min + to_free)
2168                         atomic_add_64(&arc_c, -to_free);
2169                 else
2170                         arc_c = arc_c_min;
2171
2172                 atomic_add_64(&arc_p, -(arc_p >> arc_shrink_shift));
2173                 if (arc_c > arc_size)
2174                         arc_c = MAX(arc_size, arc_c_min);
2175                 if (arc_p > arc_c)
2176                         arc_p = (arc_c >> 1);
2177                 ASSERT(arc_c >= arc_c_min);
2178                 ASSERT((int64_t)arc_p >= 0);
2179         }
2180
2181         if (arc_size > arc_c)
2182                 arc_adjust();
2183 }
2184
2185 static void
2186 arc_kmem_reap_now(arc_reclaim_strategy_t strat, uint64_t bytes)
2187 {
2188         size_t                  i;
2189         kmem_cache_t            *prev_cache = NULL;
2190         kmem_cache_t            *prev_data_cache = NULL;
2191         extern kmem_cache_t     *zio_buf_cache[];
2192         extern kmem_cache_t     *zio_data_buf_cache[];
2193
2194         /*
2195          * An aggressive reclamation will shrink the cache size as well as
2196          * reap free buffers from the arc kmem caches.
2197          */
2198         if (strat == ARC_RECLAIM_AGGR)
2199                 arc_shrink(bytes);
2200
2201         for (i = 0; i < SPA_MAXBLOCKSIZE >> SPA_MINBLOCKSHIFT; i++) {
2202                 if (zio_buf_cache[i] != prev_cache) {
2203                         prev_cache = zio_buf_cache[i];
2204                         kmem_cache_reap_now(zio_buf_cache[i]);
2205                 }
2206                 if (zio_data_buf_cache[i] != prev_data_cache) {
2207                         prev_data_cache = zio_data_buf_cache[i];
2208                         kmem_cache_reap_now(zio_data_buf_cache[i]);
2209                 }
2210         }
2211
2212         kmem_cache_reap_now(buf_cache);
2213         kmem_cache_reap_now(hdr_cache);
2214 }
2215
2216 /*
2217  * Unlike other ZFS implementations this thread is only responsible for
2218  * adapting the target ARC size on Linux.  The responsibility for memory
2219  * reclamation has been entirely delegated to the arc_shrinker_func()
2220  * which is registered with the VM.  To reflect this change in behavior
2221  * the arc_reclaim thread has been renamed to arc_adapt.
2222  */
2223 static void
2224 arc_adapt_thread(void)
2225 {
2226         callb_cpr_t             cpr;
2227         int64_t                 prune;
2228
2229         CALLB_CPR_INIT(&cpr, &arc_reclaim_thr_lock, callb_generic_cpr, FTAG);
2230
2231         mutex_enter(&arc_reclaim_thr_lock);
2232         while (arc_thread_exit == 0) {
2233 #ifndef _KERNEL
2234                 arc_reclaim_strategy_t  last_reclaim = ARC_RECLAIM_CONS;
2235
2236                 if (spa_get_random(100) == 0) {
2237
2238                         if (arc_no_grow) {
2239                                 if (last_reclaim == ARC_RECLAIM_CONS) {
2240                                         last_reclaim = ARC_RECLAIM_AGGR;
2241                                 } else {
2242                                         last_reclaim = ARC_RECLAIM_CONS;
2243                                 }
2244                         } else {
2245                                 arc_no_grow = TRUE;
2246                                 last_reclaim = ARC_RECLAIM_AGGR;
2247                                 membar_producer();
2248                         }
2249
2250                         /* reset the growth delay for every reclaim */
2251                         arc_grow_time = ddi_get_lbolt()+(arc_grow_retry * hz);
2252
2253                         arc_kmem_reap_now(last_reclaim, 0);
2254                         arc_warm = B_TRUE;
2255                 }
2256 #endif /* !_KERNEL */
2257
2258                 /* No recent memory pressure allow the ARC to grow. */
2259                 if (arc_no_grow && ddi_get_lbolt() >= arc_grow_time)
2260                         arc_no_grow = FALSE;
2261
2262                 /*
2263                  * Keep meta data usage within limits, arc_shrink() is not
2264                  * used to avoid collapsing the arc_c value when only the
2265                  * arc_meta_limit is being exceeded.
2266                  */
2267                 prune = (int64_t)arc_meta_used - (int64_t)arc_meta_limit;
2268                 if (prune > 0)
2269                         arc_adjust_meta(prune, B_TRUE);
2270
2271                 arc_adjust();
2272
2273                 if (arc_eviction_list != NULL)
2274                         arc_do_user_evicts();
2275
2276                 /* block until needed, or one second, whichever is shorter */
2277                 CALLB_CPR_SAFE_BEGIN(&cpr);
2278                 (void) cv_timedwait_interruptible(&arc_reclaim_thr_cv,
2279                     &arc_reclaim_thr_lock, (ddi_get_lbolt() + hz));
2280                 CALLB_CPR_SAFE_END(&cpr, &arc_reclaim_thr_lock);
2281         }
2282
2283         arc_thread_exit = 0;
2284         cv_broadcast(&arc_reclaim_thr_cv);
2285         CALLB_CPR_EXIT(&cpr);           /* drops arc_reclaim_thr_lock */
2286         thread_exit();
2287 }
2288
2289 #ifdef _KERNEL
2290 /*
2291  * Determine the amount of memory eligible for eviction contained in the
2292  * ARC. All clean data reported by the ghost lists can always be safely
2293  * evicted. Due to arc_c_min, the same does not hold for all clean data
2294  * contained by the regular mru and mfu lists.
2295  *
2296  * In the case of the regular mru and mfu lists, we need to report as
2297  * much clean data as possible, such that evicting that same reported
2298  * data will not bring arc_size below arc_c_min. Thus, in certain
2299  * circumstances, the total amount of clean data in the mru and mfu
2300  * lists might not actually be evictable.
2301  *
2302  * The following two distinct cases are accounted for:
2303  *
2304  * 1. The sum of the amount of dirty data contained by both the mru and
2305  *    mfu lists, plus the ARC's other accounting (e.g. the anon list),
2306  *    is greater than or equal to arc_c_min.
2307  *    (i.e. amount of dirty data >= arc_c_min)
2308  *
2309  *    This is the easy case; all clean data contained by the mru and mfu
2310  *    lists is evictable. Evicting all clean data can only drop arc_size
2311  *    to the amount of dirty data, which is greater than arc_c_min.
2312  *
2313  * 2. The sum of the amount of dirty data contained by both the mru and
2314  *    mfu lists, plus the ARC's other accounting (e.g. the anon list),
2315  *    is less than arc_c_min.
2316  *    (i.e. arc_c_min > amount of dirty data)
2317  *
2318  *    2.1. arc_size is greater than or equal arc_c_min.
2319  *         (i.e. arc_size >= arc_c_min > amount of dirty data)
2320  *
2321  *         In this case, not all clean data from the regular mru and mfu
2322  *         lists is actually evictable; we must leave enough clean data
2323  *         to keep arc_size above arc_c_min. Thus, the maximum amount of
2324  *         evictable data from the two lists combined, is exactly the
2325  *         difference between arc_size and arc_c_min.
2326  *
2327  *    2.2. arc_size is less than arc_c_min
2328  *         (i.e. arc_c_min > arc_size > amount of dirty data)
2329  *
2330  *         In this case, none of the data contained in the mru and mfu
2331  *         lists is evictable, even if it's clean. Since arc_size is
2332  *         already below arc_c_min, evicting any more would only
2333  *         increase this negative difference.
2334  */
2335 static uint64_t
2336 arc_evictable_memory(void) {
2337         uint64_t arc_clean =
2338             arc_mru->arcs_lsize[ARC_BUFC_DATA] +
2339             arc_mru->arcs_lsize[ARC_BUFC_METADATA] +
2340             arc_mfu->arcs_lsize[ARC_BUFC_DATA] +
2341             arc_mfu->arcs_lsize[ARC_BUFC_METADATA];
2342         uint64_t ghost_clean =
2343             arc_mru_ghost->arcs_lsize[ARC_BUFC_DATA] +
2344             arc_mru_ghost->arcs_lsize[ARC_BUFC_METADATA] +
2345             arc_mfu_ghost->arcs_lsize[ARC_BUFC_DATA] +
2346             arc_mfu_ghost->arcs_lsize[ARC_BUFC_METADATA];
2347         uint64_t arc_dirty = MAX((int64_t)arc_size - (int64_t)arc_clean, 0);
2348
2349         if (arc_dirty >= arc_c_min)
2350                 return (ghost_clean + arc_clean);
2351
2352         return (ghost_clean + MAX((int64_t)arc_size - (int64_t)arc_c_min, 0));
2353 }
2354
2355 static int
2356 __arc_shrinker_func(struct shrinker *shrink, struct shrink_control *sc)
2357 {
2358         uint64_t pages;
2359
2360         /* The arc is considered warm once reclaim has occurred */
2361         if (unlikely(arc_warm == B_FALSE))
2362                 arc_warm = B_TRUE;
2363
2364         /* Return the potential number of reclaimable pages */
2365         pages = btop(arc_evictable_memory());
2366         if (sc->nr_to_scan == 0)
2367                 return (pages);
2368
2369         /* Not allowed to perform filesystem reclaim */
2370         if (!(sc->gfp_mask & __GFP_FS))
2371                 return (-1);
2372
2373         /* Reclaim in progress */
2374         if (mutex_tryenter(&arc_reclaim_thr_lock) == 0)
2375                 return (-1);
2376
2377         /*
2378          * Evict the requested number of pages by shrinking arc_c the
2379          * requested amount.  If there is nothing left to evict just
2380          * reap whatever we can from the various arc slabs.
2381          */
2382         if (pages > 0) {
2383                 arc_kmem_reap_now(ARC_RECLAIM_AGGR, ptob(sc->nr_to_scan));
2384                 pages = btop(arc_evictable_memory());
2385         } else {
2386                 arc_kmem_reap_now(ARC_RECLAIM_CONS, ptob(sc->nr_to_scan));
2387                 pages = -1;
2388         }
2389
2390         /*
2391          * When direct reclaim is observed it usually indicates a rapid
2392          * increase in memory pressure.  This occurs because the kswapd
2393          * threads were unable to asynchronously keep enough free memory
2394          * available.  In this case set arc_no_grow to briefly pause arc
2395          * growth to avoid compounding the memory pressure.
2396          */
2397         if (current_is_kswapd()) {
2398                 ARCSTAT_BUMP(arcstat_memory_indirect_count);
2399         } else {
2400                 arc_no_grow = B_TRUE;
2401                 arc_grow_time = ddi_get_lbolt() + (arc_grow_retry * hz);
2402                 ARCSTAT_BUMP(arcstat_memory_direct_count);
2403         }
2404
2405         mutex_exit(&arc_reclaim_thr_lock);
2406
2407         return (pages);
2408 }
2409 SPL_SHRINKER_CALLBACK_WRAPPER(arc_shrinker_func);
2410
2411 SPL_SHRINKER_DECLARE(arc_shrinker, arc_shrinker_func, DEFAULT_SEEKS);
2412 #endif /* _KERNEL */
2413
2414 /*
2415  * Adapt arc info given the number of bytes we are trying to add and
2416  * the state that we are comming from.  This function is only called
2417  * when we are adding new content to the cache.
2418  */
2419 static void
2420 arc_adapt(int bytes, arc_state_t *state)
2421 {
2422         int mult;
2423         uint64_t arc_p_min = (arc_c >> arc_p_min_shift);
2424
2425         if (state == arc_l2c_only)
2426                 return;
2427
2428         ASSERT(bytes > 0);
2429         /*
2430          * Adapt the target size of the MRU list:
2431          *      - if we just hit in the MRU ghost list, then increase
2432          *        the target size of the MRU list.
2433          *      - if we just hit in the MFU ghost list, then increase
2434          *        the target size of the MFU list by decreasing the
2435          *        target size of the MRU list.
2436          */
2437         if (state == arc_mru_ghost) {
2438                 mult = ((arc_mru_ghost->arcs_size >= arc_mfu_ghost->arcs_size) ?
2439                     1 : (arc_mfu_ghost->arcs_size/arc_mru_ghost->arcs_size));
2440                 mult = MIN(mult, 10); /* avoid wild arc_p adjustment */
2441
2442                 arc_p = MIN(arc_c - arc_p_min, arc_p + bytes * mult);
2443         } else if (state == arc_mfu_ghost) {
2444                 uint64_t delta;
2445
2446                 mult = ((arc_mfu_ghost->arcs_size >= arc_mru_ghost->arcs_size) ?
2447                     1 : (arc_mru_ghost->arcs_size/arc_mfu_ghost->arcs_size));
2448                 mult = MIN(mult, 10);
2449
2450                 delta = MIN(bytes * mult, arc_p);
2451                 arc_p = MAX(arc_p_min, arc_p - delta);
2452         }
2453         ASSERT((int64_t)arc_p >= 0);
2454
2455         if (arc_no_grow)
2456                 return;
2457
2458         if (arc_c >= arc_c_max)
2459                 return;
2460
2461         /*
2462          * If we're within (2 * maxblocksize) bytes of the target
2463          * cache size, increment the target cache size
2464          */
2465         if (arc_size > arc_c - (2ULL << SPA_MAXBLOCKSHIFT)) {
2466                 atomic_add_64(&arc_c, (int64_t)bytes);
2467                 if (arc_c > arc_c_max)
2468                         arc_c = arc_c_max;
2469                 else if (state == arc_anon)
2470                         atomic_add_64(&arc_p, (int64_t)bytes);
2471                 if (arc_p > arc_c)
2472                         arc_p = arc_c;
2473         }
2474         ASSERT((int64_t)arc_p >= 0);
2475 }
2476
2477 /*
2478  * Check if the cache has reached its limits and eviction is required
2479  * prior to insert.
2480  */
2481 static int
2482 arc_evict_needed(arc_buf_contents_t type)
2483 {
2484         if (type == ARC_BUFC_METADATA && arc_meta_used >= arc_meta_limit)
2485                 return (1);
2486
2487         if (arc_no_grow)
2488                 return (1);
2489
2490         return (arc_size > arc_c);
2491 }
2492
2493 /*
2494  * The buffer, supplied as the first argument, needs a data block.
2495  * So, if we are at cache max, determine which cache should be victimized.
2496  * We have the following cases:
2497  *
2498  * 1. Insert for MRU, p > sizeof(arc_anon + arc_mru) ->
2499  * In this situation if we're out of space, but the resident size of the MFU is
2500  * under the limit, victimize the MFU cache to satisfy this insertion request.
2501  *
2502  * 2. Insert for MRU, p <= sizeof(arc_anon + arc_mru) ->
2503  * Here, we've used up all of the available space for the MRU, so we need to
2504  * evict from our own cache instead.  Evict from the set of resident MRU
2505  * entries.
2506  *
2507  * 3. Insert for MFU (c - p) > sizeof(arc_mfu) ->
2508  * c minus p represents the MFU space in the cache, since p is the size of the
2509  * cache that is dedicated to the MRU.  In this situation there's still space on
2510  * the MFU side, so the MRU side needs to be victimized.
2511  *
2512  * 4. Insert for MFU (c - p) < sizeof(arc_mfu) ->
2513  * MFU's resident set is consuming more space than it has been allotted.  In
2514  * this situation, we must victimize our own cache, the MFU, for this insertion.
2515  */
2516 static void
2517 arc_get_data_buf(arc_buf_t *buf)
2518 {
2519         arc_state_t             *state = buf->b_hdr->b_state;
2520         uint64_t                size = buf->b_hdr->b_size;
2521         arc_buf_contents_t      type = buf->b_hdr->b_type;
2522
2523         arc_adapt(size, state);
2524
2525         /*
2526          * We have not yet reached cache maximum size,
2527          * just allocate a new buffer.
2528          */
2529         if (!arc_evict_needed(type)) {
2530                 if (type == ARC_BUFC_METADATA) {
2531                         buf->b_data = zio_buf_alloc(size);
2532                         arc_space_consume(size, ARC_SPACE_DATA);
2533                 } else {
2534                         ASSERT(type == ARC_BUFC_DATA);
2535                         buf->b_data = zio_data_buf_alloc(size);
2536                         ARCSTAT_INCR(arcstat_data_size, size);
2537                         atomic_add_64(&arc_size, size);
2538                 }
2539                 goto out;
2540         }
2541
2542         /*
2543          * If we are prefetching from the mfu ghost list, this buffer
2544          * will end up on the mru list; so steal space from there.
2545          */
2546         if (state == arc_mfu_ghost)
2547                 state = buf->b_hdr->b_flags & ARC_PREFETCH ? arc_mru : arc_mfu;
2548         else if (state == arc_mru_ghost)
2549                 state = arc_mru;
2550
2551         if (state == arc_mru || state == arc_anon) {
2552                 uint64_t mru_used = arc_anon->arcs_size + arc_mru->arcs_size;
2553                 state = (arc_mfu->arcs_lsize[type] >= size &&
2554                     arc_p > mru_used) ? arc_mfu : arc_mru;
2555         } else {
2556                 /* MFU cases */
2557                 uint64_t mfu_space = arc_c - arc_p;
2558                 state =  (arc_mru->arcs_lsize[type] >= size &&
2559                     mfu_space > arc_mfu->arcs_size) ? arc_mru : arc_mfu;
2560         }
2561
2562         if ((buf->b_data = arc_evict(state, 0, size, TRUE, type)) == NULL) {
2563                 if (type == ARC_BUFC_METADATA) {
2564                         buf->b_data = zio_buf_alloc(size);
2565                         arc_space_consume(size, ARC_SPACE_DATA);
2566
2567                         /*
2568                          * If we are unable to recycle an existing meta buffer
2569                          * signal the reclaim thread.  It will notify users
2570                          * via the prune callback to drop references.  The
2571                          * prune callback in run in the context of the reclaim
2572                          * thread to avoid deadlocking on the hash_lock.
2573                          */
2574                         cv_signal(&arc_reclaim_thr_cv);
2575                 } else {
2576                         ASSERT(type == ARC_BUFC_DATA);
2577                         buf->b_data = zio_data_buf_alloc(size);
2578                         ARCSTAT_INCR(arcstat_data_size, size);
2579                         atomic_add_64(&arc_size, size);
2580                 }
2581
2582                 ARCSTAT_BUMP(arcstat_recycle_miss);
2583         }
2584         ASSERT(buf->b_data != NULL);
2585 out:
2586         /*
2587          * Update the state size.  Note that ghost states have a
2588          * "ghost size" and so don't need to be updated.
2589          */
2590         if (!GHOST_STATE(buf->b_hdr->b_state)) {
2591                 arc_buf_hdr_t *hdr = buf->b_hdr;
2592
2593                 atomic_add_64(&hdr->b_state->arcs_size, size);
2594                 if (list_link_active(&hdr->b_arc_node)) {
2595                         ASSERT(refcount_is_zero(&hdr->b_refcnt));
2596                         atomic_add_64(&hdr->b_state->arcs_lsize[type], size);
2597                 }
2598                 /*
2599                  * If we are growing the cache, and we are adding anonymous
2600                  * data, and we have outgrown arc_p, update arc_p
2601                  */
2602                 if (arc_size < arc_c && hdr->b_state == arc_anon &&
2603                     arc_anon->arcs_size + arc_mru->arcs_size > arc_p)
2604                         arc_p = MIN(arc_c, arc_p + size);
2605         }
2606 }
2607
2608 /*
2609  * This routine is called whenever a buffer is accessed.
2610  * NOTE: the hash lock is dropped in this function.
2611  */
2612 static void
2613 arc_access(arc_buf_hdr_t *buf, kmutex_t *hash_lock)
2614 {
2615         clock_t now;
2616
2617         ASSERT(MUTEX_HELD(hash_lock));
2618
2619         if (buf->b_state == arc_anon) {
2620                 /*
2621                  * This buffer is not in the cache, and does not
2622                  * appear in our "ghost" list.  Add the new buffer
2623                  * to the MRU state.
2624                  */
2625
2626                 ASSERT(buf->b_arc_access == 0);
2627                 buf->b_arc_access = ddi_get_lbolt();
2628                 DTRACE_PROBE1(new_state__mru, arc_buf_hdr_t *, buf);
2629                 arc_change_state(arc_mru, buf, hash_lock);
2630
2631         } else if (buf->b_state == arc_mru) {
2632                 now = ddi_get_lbolt();
2633
2634                 /*
2635                  * If this buffer is here because of a prefetch, then either:
2636                  * - clear the flag if this is a "referencing" read
2637                  *   (any subsequent access will bump this into the MFU state).
2638                  * or
2639                  * - move the buffer to the head of the list if this is
2640                  *   another prefetch (to make it less likely to be evicted).
2641                  */
2642                 if ((buf->b_flags & ARC_PREFETCH) != 0) {
2643                         if (refcount_count(&buf->b_refcnt) == 0) {
2644                                 ASSERT(list_link_active(&buf->b_arc_node));
2645                         } else {
2646                                 buf->b_flags &= ~ARC_PREFETCH;
2647                                 ARCSTAT_BUMP(arcstat_mru_hits);
2648                         }
2649                         buf->b_arc_access = now;
2650                         return;
2651                 }
2652
2653                 /*
2654                  * This buffer has been "accessed" only once so far,
2655                  * but it is still in the cache. Move it to the MFU
2656                  * state.
2657                  */
2658                 if (now > buf->b_arc_access + ARC_MINTIME) {
2659                         /*
2660                          * More than 125ms have passed since we
2661                          * instantiated this buffer.  Move it to the
2662                          * most frequently used state.
2663                          */
2664                         buf->b_arc_access = now;
2665                         DTRACE_PROBE1(new_state__mfu, arc_buf_hdr_t *, buf);
2666                         arc_change_state(arc_mfu, buf, hash_lock);
2667                 }
2668                 ARCSTAT_BUMP(arcstat_mru_hits);
2669         } else if (buf->b_state == arc_mru_ghost) {
2670                 arc_state_t     *new_state;
2671                 /*
2672                  * This buffer has been "accessed" recently, but
2673                  * was evicted from the cache.  Move it to the
2674                  * MFU state.
2675                  */
2676
2677                 if (buf->b_flags & ARC_PREFETCH) {
2678                         new_state = arc_mru;
2679                         if (refcount_count(&buf->b_refcnt) > 0)
2680                                 buf->b_flags &= ~ARC_PREFETCH;
2681                         DTRACE_PROBE1(new_state__mru, arc_buf_hdr_t *, buf);
2682                 } else {
2683                         new_state = arc_mfu;
2684                         DTRACE_PROBE1(new_state__mfu, arc_buf_hdr_t *, buf);
2685                 }
2686
2687                 buf->b_arc_access = ddi_get_lbolt();
2688                 arc_change_state(new_state, buf, hash_lock);
2689
2690                 ARCSTAT_BUMP(arcstat_mru_ghost_hits);
2691         } else if (buf->b_state == arc_mfu) {
2692                 /*
2693                  * This buffer has been accessed more than once and is
2694                  * still in the cache.  Keep it in the MFU state.
2695                  *
2696                  * NOTE: an add_reference() that occurred when we did
2697                  * the arc_read() will have kicked this off the list.
2698                  * If it was a prefetch, we will explicitly move it to
2699                  * the head of the list now.
2700                  */
2701                 if ((buf->b_flags & ARC_PREFETCH) != 0) {
2702                         ASSERT(refcount_count(&buf->b_refcnt) == 0);
2703                         ASSERT(list_link_active(&buf->b_arc_node));
2704                 }
2705                 ARCSTAT_BUMP(arcstat_mfu_hits);
2706                 buf->b_arc_access = ddi_get_lbolt();
2707         } else if (buf->b_state == arc_mfu_ghost) {
2708                 arc_state_t     *new_state = arc_mfu;
2709                 /*
2710                  * This buffer has been accessed more than once but has
2711                  * been evicted from the cache.  Move it back to the
2712                  * MFU state.
2713                  */
2714
2715                 if (buf->b_flags & ARC_PREFETCH) {
2716                         /*
2717                          * This is a prefetch access...
2718                          * move this block back to the MRU state.
2719                          */
2720                         ASSERT0(refcount_count(&buf->b_refcnt));
2721                         new_state = arc_mru;
2722                 }
2723
2724                 buf->b_arc_access = ddi_get_lbolt();
2725                 DTRACE_PROBE1(new_state__mfu, arc_buf_hdr_t *, buf);
2726                 arc_change_state(new_state, buf, hash_lock);
2727
2728                 ARCSTAT_BUMP(arcstat_mfu_ghost_hits);
2729         } else if (buf->b_state == arc_l2c_only) {
2730                 /*
2731                  * This buffer is on the 2nd Level ARC.
2732                  */
2733
2734                 buf->b_arc_access = ddi_get_lbolt();
2735                 DTRACE_PROBE1(new_state__mfu, arc_buf_hdr_t *, buf);
2736                 arc_change_state(arc_mfu, buf, hash_lock);
2737         } else {
2738                 ASSERT(!"invalid arc state");
2739         }
2740 }
2741
2742 /* a generic arc_done_func_t which you can use */
2743 /* ARGSUSED */
2744 void
2745 arc_bcopy_func(zio_t *zio, arc_buf_t *buf, void *arg)
2746 {
2747         if (zio == NULL || zio->io_error == 0)
2748                 bcopy(buf->b_data, arg, buf->b_hdr->b_size);
2749         VERIFY(arc_buf_remove_ref(buf, arg) == 1);
2750 }
2751
2752 /* a generic arc_done_func_t */
2753 void
2754 arc_getbuf_func(zio_t *zio, arc_buf_t *buf, void *arg)
2755 {
2756         arc_buf_t **bufp = arg;
2757         if (zio && zio->io_error) {
2758                 VERIFY(arc_buf_remove_ref(buf, arg) == 1);
2759                 *bufp = NULL;
2760         } else {
2761                 *bufp = buf;
2762                 ASSERT(buf->b_data);
2763         }
2764 }
2765
2766 static void
2767 arc_read_done(zio_t *zio)
2768 {
2769         arc_buf_hdr_t   *hdr, *found;
2770         arc_buf_t       *buf;
2771         arc_buf_t       *abuf;  /* buffer we're assigning to callback */
2772         kmutex_t        *hash_lock;
2773         arc_callback_t  *callback_list, *acb;
2774         int             freeable = FALSE;
2775
2776         buf = zio->io_private;
2777         hdr = buf->b_hdr;
2778
2779         /*
2780          * The hdr was inserted into hash-table and removed from lists
2781          * prior to starting I/O.  We should find this header, since
2782          * it's in the hash table, and it should be legit since it's
2783          * not possible to evict it during the I/O.  The only possible
2784          * reason for it not to be found is if we were freed during the
2785          * read.
2786          */
2787         found = buf_hash_find(hdr->b_spa, &hdr->b_dva, hdr->b_birth,
2788             &hash_lock);
2789
2790         ASSERT((found == NULL && HDR_FREED_IN_READ(hdr) && hash_lock == NULL) ||
2791             (found == hdr && DVA_EQUAL(&hdr->b_dva, BP_IDENTITY(zio->io_bp))) ||
2792             (found == hdr && HDR_L2_READING(hdr)));
2793
2794         hdr->b_flags &= ~ARC_L2_EVICTED;
2795         if (l2arc_noprefetch && (hdr->b_flags & ARC_PREFETCH))
2796                 hdr->b_flags &= ~ARC_L2CACHE;
2797
2798         /* byteswap if necessary */
2799         callback_list = hdr->b_acb;
2800         ASSERT(callback_list != NULL);
2801         if (BP_SHOULD_BYTESWAP(zio->io_bp) && zio->io_error == 0) {
2802                 dmu_object_byteswap_t bswap =
2803                     DMU_OT_BYTESWAP(BP_GET_TYPE(zio->io_bp));
2804                 if (BP_GET_LEVEL(zio->io_bp) > 0)
2805                     byteswap_uint64_array(buf->b_data, hdr->b_size);
2806                 else
2807                     dmu_ot_byteswap[bswap].ob_func(buf->b_data, hdr->b_size);
2808         }
2809
2810         arc_cksum_compute(buf, B_FALSE);
2811
2812         if (hash_lock && zio->io_error == 0 && hdr->b_state == arc_anon) {
2813                 /*
2814                  * Only call arc_access on anonymous buffers.  This is because
2815                  * if we've issued an I/O for an evicted buffer, we've already
2816                  * called arc_access (to prevent any simultaneous readers from
2817                  * getting confused).
2818                  */
2819                 arc_access(hdr, hash_lock);
2820         }
2821
2822         /* create copies of the data buffer for the callers */
2823         abuf = buf;
2824         for (acb = callback_list; acb; acb = acb->acb_next) {
2825                 if (acb->acb_done) {
2826                         if (abuf == NULL) {
2827                                 ARCSTAT_BUMP(arcstat_duplicate_reads);
2828                                 abuf = arc_buf_clone(buf);
2829                         }
2830                         acb->acb_buf = abuf;
2831                         abuf = NULL;
2832                 }
2833         }
2834         hdr->b_acb = NULL;
2835         hdr->b_flags &= ~ARC_IO_IN_PROGRESS;
2836         ASSERT(!HDR_BUF_AVAILABLE(hdr));
2837         if (abuf == buf) {
2838                 ASSERT(buf->b_efunc == NULL);
2839                 ASSERT(hdr->b_datacnt == 1);
2840                 hdr->b_flags |= ARC_BUF_AVAILABLE;
2841         }
2842
2843         ASSERT(refcount_is_zero(&hdr->b_refcnt) || callback_list != NULL);
2844
2845         if (zio->io_error != 0) {
2846                 hdr->b_flags |= ARC_IO_ERROR;
2847                 if (hdr->b_state != arc_anon)
2848                         arc_change_state(arc_anon, hdr, hash_lock);
2849                 if (HDR_IN_HASH_TABLE(hdr))
2850                         buf_hash_remove(hdr);
2851                 freeable = refcount_is_zero(&hdr->b_refcnt);
2852         }
2853
2854         /*
2855          * Broadcast before we drop the hash_lock to avoid the possibility
2856          * that the hdr (and hence the cv) might be freed before we get to
2857          * the cv_broadcast().
2858          */
2859         cv_broadcast(&hdr->b_cv);
2860
2861         if (hash_lock) {
2862                 mutex_exit(hash_lock);
2863         } else {
2864                 /*
2865                  * This block was freed while we waited for the read to
2866                  * complete.  It has been removed from the hash table and
2867                  * moved to the anonymous state (so that it won't show up
2868                  * in the cache).
2869                  */
2870                 ASSERT3P(hdr->b_state, ==, arc_anon);
2871                 freeable = refcount_is_zero(&hdr->b_refcnt);
2872         }
2873
2874         /* execute each callback and free its structure */
2875         while ((acb = callback_list) != NULL) {
2876                 if (acb->acb_done)
2877                         acb->acb_done(zio, acb->acb_buf, acb->acb_private);
2878
2879                 if (acb->acb_zio_dummy != NULL) {
2880                         acb->acb_zio_dummy->io_error = zio->io_error;
2881                         zio_nowait(acb->acb_zio_dummy);
2882                 }
2883
2884                 callback_list = acb->acb_next;
2885                 kmem_free(acb, sizeof (arc_callback_t));
2886         }
2887
2888         if (freeable)
2889                 arc_hdr_destroy(hdr);
2890 }
2891
2892 /*
2893  * "Read" the block at the specified DVA (in bp) via the
2894  * cache.  If the block is found in the cache, invoke the provided
2895  * callback immediately and return.  Note that the `zio' parameter
2896  * in the callback will be NULL in this case, since no IO was
2897  * required.  If the block is not in the cache pass the read request
2898  * on to the spa with a substitute callback function, so that the
2899  * requested block will be added to the cache.
2900  *
2901  * If a read request arrives for a block that has a read in-progress,
2902  * either wait for the in-progress read to complete (and return the
2903  * results); or, if this is a read with a "done" func, add a record
2904  * to the read to invoke the "done" func when the read completes,
2905  * and return; or just return.
2906  *
2907  * arc_read_done() will invoke all the requested "done" functions
2908  * for readers of this block.
2909  */
2910 int
2911 arc_read(zio_t *pio, spa_t *spa, const blkptr_t *bp, arc_done_func_t *done,
2912     void *private, int priority, int zio_flags, uint32_t *arc_flags,
2913     const zbookmark_t *zb)
2914 {
2915         arc_buf_hdr_t *hdr;
2916         arc_buf_t *buf = NULL;
2917         kmutex_t *hash_lock;
2918         zio_t *rzio;
2919         uint64_t guid = spa_load_guid(spa);
2920
2921 top:
2922         hdr = buf_hash_find(guid, BP_IDENTITY(bp), BP_PHYSICAL_BIRTH(bp),
2923             &hash_lock);
2924         if (hdr && hdr->b_datacnt > 0) {
2925
2926                 *arc_flags |= ARC_CACHED;
2927
2928                 if (HDR_IO_IN_PROGRESS(hdr)) {
2929
2930                         if (*arc_flags & ARC_WAIT) {
2931                                 cv_wait(&hdr->b_cv, hash_lock);
2932                                 mutex_exit(hash_lock);
2933                                 goto top;
2934                         }
2935                         ASSERT(*arc_flags & ARC_NOWAIT);
2936
2937                         if (done) {
2938                                 arc_callback_t  *acb = NULL;
2939
2940                                 acb = kmem_zalloc(sizeof (arc_callback_t),
2941                                     KM_PUSHPAGE);
2942                                 acb->acb_done = done;
2943                                 acb->acb_private = private;
2944                                 if (pio != NULL)
2945                                         acb->acb_zio_dummy = zio_null(pio,
2946                                             spa, NULL, NULL, NULL, zio_flags);
2947
2948                                 ASSERT(acb->acb_done != NULL);
2949                                 acb->acb_next = hdr->b_acb;
2950                                 hdr->b_acb = acb;
2951                                 add_reference(hdr, hash_lock, private);
2952                                 mutex_exit(hash_lock);
2953                                 return (0);
2954                         }
2955                         mutex_exit(hash_lock);
2956                         return (0);
2957                 }
2958
2959                 ASSERT(hdr->b_state == arc_mru || hdr->b_state == arc_mfu);
2960
2961                 if (done) {
2962                         add_reference(hdr, hash_lock, private);
2963                         /*
2964                          * If this block is already in use, create a new
2965                          * copy of the data so that we will be guaranteed
2966                          * that arc_release() will always succeed.
2967                          */
2968                         buf = hdr->b_buf;
2969                         ASSERT(buf);
2970                         ASSERT(buf->b_data);
2971                         if (HDR_BUF_AVAILABLE(hdr)) {
2972                                 ASSERT(buf->b_efunc == NULL);
2973                                 hdr->b_flags &= ~ARC_BUF_AVAILABLE;
2974                         } else {
2975                                 buf = arc_buf_clone(buf);
2976                         }
2977
2978                 } else if (*arc_flags & ARC_PREFETCH &&
2979                     refcount_count(&hdr->b_refcnt) == 0) {
2980                         hdr->b_flags |= ARC_PREFETCH;
2981                 }
2982                 DTRACE_PROBE1(arc__hit, arc_buf_hdr_t *, hdr);
2983                 arc_access(hdr, hash_lock);
2984                 if (*arc_flags & ARC_L2CACHE)
2985                         hdr->b_flags |= ARC_L2CACHE;
2986                 mutex_exit(hash_lock);
2987                 ARCSTAT_BUMP(arcstat_hits);
2988                 ARCSTAT_CONDSTAT(!(hdr->b_flags & ARC_PREFETCH),
2989                     demand, prefetch, hdr->b_type != ARC_BUFC_METADATA,
2990                     data, metadata, hits);
2991
2992                 if (done)
2993                         done(NULL, buf, private);
2994         } else {
2995                 uint64_t size = BP_GET_LSIZE(bp);
2996                 arc_callback_t  *acb;
2997                 vdev_t *vd = NULL;
2998                 uint64_t addr = -1;
2999                 boolean_t devw = B_FALSE;
3000
3001                 if (hdr == NULL) {
3002                         /* this block is not in the cache */
3003                         arc_buf_hdr_t   *exists;
3004                         arc_buf_contents_t type = BP_GET_BUFC_TYPE(bp);
3005                         buf = arc_buf_alloc(spa, size, private, type);
3006                         hdr = buf->b_hdr;
3007                         hdr->b_dva = *BP_IDENTITY(bp);
3008                         hdr->b_birth = BP_PHYSICAL_BIRTH(bp);
3009                         hdr->b_cksum0 = bp->blk_cksum.zc_word[0];
3010                         exists = buf_hash_insert(hdr, &hash_lock);
3011                         if (exists) {
3012                                 /* somebody beat us to the hash insert */
3013                                 mutex_exit(hash_lock);
3014                                 buf_discard_identity(hdr);
3015                                 (void) arc_buf_remove_ref(buf, private);
3016                                 goto top; /* restart the IO request */
3017                         }
3018                         /* if this is a prefetch, we don't have a reference */
3019                         if (*arc_flags & ARC_PREFETCH) {
3020                                 (void) remove_reference(hdr, hash_lock,
3021                                     private);
3022                                 hdr->b_flags |= ARC_PREFETCH;
3023                         }
3024                         if (*arc_flags & ARC_L2CACHE)
3025                                 hdr->b_flags |= ARC_L2CACHE;
3026                         if (BP_GET_LEVEL(bp) > 0)
3027                                 hdr->b_flags |= ARC_INDIRECT;
3028                 } else {
3029                         /* this block is in the ghost cache */
3030                         ASSERT(GHOST_STATE(hdr->b_state));
3031                         ASSERT(!HDR_IO_IN_PROGRESS(hdr));
3032                         ASSERT0(refcount_count(&hdr->b_refcnt));
3033                         ASSERT(hdr->b_buf == NULL);
3034
3035                         /* if this is a prefetch, we don't have a reference */
3036                         if (*arc_flags & ARC_PREFETCH)
3037                                 hdr->b_flags |= ARC_PREFETCH;
3038                         else
3039                                 add_reference(hdr, hash_lock, private);
3040                         if (*arc_flags & ARC_L2CACHE)
3041                                 hdr->b_flags |= ARC_L2CACHE;
3042                         buf = kmem_cache_alloc(buf_cache, KM_PUSHPAGE);
3043                         buf->b_hdr = hdr;
3044                         buf->b_data = NULL;
3045                         buf->b_efunc = NULL;
3046                         buf->b_private = NULL;
3047                         buf->b_next = NULL;
3048                         hdr->b_buf = buf;
3049                         ASSERT(hdr->b_datacnt == 0);
3050                         hdr->b_datacnt = 1;
3051                         arc_get_data_buf(buf);
3052                         arc_access(hdr, hash_lock);
3053                 }
3054
3055                 ASSERT(!GHOST_STATE(hdr->b_state));
3056
3057                 acb = kmem_zalloc(sizeof (arc_callback_t), KM_PUSHPAGE);
3058                 acb->acb_done = done;
3059                 acb->acb_private = private;
3060
3061                 ASSERT(hdr->b_acb == NULL);
3062                 hdr->b_acb = acb;
3063                 hdr->b_flags |= ARC_IO_IN_PROGRESS;
3064
3065                 if (HDR_L2CACHE(hdr) && hdr->b_l2hdr != NULL &&
3066                     (vd = hdr->b_l2hdr->b_dev->l2ad_vdev) != NULL) {
3067                         devw = hdr->b_l2hdr->b_dev->l2ad_writing;
3068                         addr = hdr->b_l2hdr->b_daddr;
3069                         /*
3070                          * Lock out device removal.
3071                          */
3072                         if (vdev_is_dead(vd) ||
3073                             !spa_config_tryenter(spa, SCL_L2ARC, vd, RW_READER))
3074                                 vd = NULL;
3075                 }
3076
3077                 mutex_exit(hash_lock);
3078
3079                 ASSERT3U(hdr->b_size, ==, size);
3080                 DTRACE_PROBE4(arc__miss, arc_buf_hdr_t *, hdr, blkptr_t *, bp,
3081                     uint64_t, size, zbookmark_t *, zb);
3082                 ARCSTAT_BUMP(arcstat_misses);
3083                 ARCSTAT_CONDSTAT(!(hdr->b_flags & ARC_PREFETCH),
3084                     demand, prefetch, hdr->b_type != ARC_BUFC_METADATA,
3085                     data, metadata, misses);
3086
3087                 if (vd != NULL && l2arc_ndev != 0 && !(l2arc_norw && devw)) {
3088                         /*
3089                          * Read from the L2ARC if the following are true:
3090                          * 1. The L2ARC vdev was previously cached.
3091                          * 2. This buffer still has L2ARC metadata.
3092                          * 3. This buffer isn't currently writing to the L2ARC.
3093                          * 4. The L2ARC entry wasn't evicted, which may
3094                          *    also have invalidated the vdev.
3095                          * 5. This isn't prefetch and l2arc_noprefetch is set.
3096                          */
3097                         if (hdr->b_l2hdr != NULL &&
3098                             !HDR_L2_WRITING(hdr) && !HDR_L2_EVICTED(hdr) &&
3099                             !(l2arc_noprefetch && HDR_PREFETCH(hdr))) {
3100                                 l2arc_read_callback_t *cb;
3101
3102                                 DTRACE_PROBE1(l2arc__hit, arc_buf_hdr_t *, hdr);
3103                                 ARCSTAT_BUMP(arcstat_l2_hits);
3104
3105                                 cb = kmem_zalloc(sizeof (l2arc_read_callback_t),
3106                                     KM_PUSHPAGE);
3107                                 cb->l2rcb_buf = buf;
3108                                 cb->l2rcb_spa = spa;
3109                                 cb->l2rcb_bp = *bp;
3110                                 cb->l2rcb_zb = *zb;
3111                                 cb->l2rcb_flags = zio_flags;
3112
3113                                 /*
3114                                  * l2arc read.  The SCL_L2ARC lock will be
3115                                  * released by l2arc_read_done().
3116                                  */
3117                                 rzio = zio_read_phys(pio, vd, addr, size,
3118                                     buf->b_data, ZIO_CHECKSUM_OFF,
3119                                     l2arc_read_done, cb, priority, zio_flags |
3120                                     ZIO_FLAG_DONT_CACHE | ZIO_FLAG_CANFAIL |
3121                                     ZIO_FLAG_DONT_PROPAGATE |
3122                                     ZIO_FLAG_DONT_RETRY, B_FALSE);
3123                                 DTRACE_PROBE2(l2arc__read, vdev_t *, vd,
3124                                     zio_t *, rzio);
3125                                 ARCSTAT_INCR(arcstat_l2_read_bytes, size);
3126
3127                                 if (*arc_flags & ARC_NOWAIT) {
3128                                         zio_nowait(rzio);
3129                                         return (0);
3130                                 }
3131
3132                                 ASSERT(*arc_flags & ARC_WAIT);
3133                                 if (zio_wait(rzio) == 0)
3134                                         return (0);
3135
3136                                 /* l2arc read error; goto zio_read() */
3137                         } else {
3138                                 DTRACE_PROBE1(l2arc__miss,
3139                                     arc_buf_hdr_t *, hdr);
3140                                 ARCSTAT_BUMP(arcstat_l2_misses);
3141                                 if (HDR_L2_WRITING(hdr))
3142                                         ARCSTAT_BUMP(arcstat_l2_rw_clash);
3143                                 spa_config_exit(spa, SCL_L2ARC, vd);
3144                         }
3145                 } else {
3146                         if (vd != NULL)
3147                                 spa_config_exit(spa, SCL_L2ARC, vd);
3148                         if (l2arc_ndev != 0) {
3149                                 DTRACE_PROBE1(l2arc__miss,
3150                                     arc_buf_hdr_t *, hdr);
3151                                 ARCSTAT_BUMP(arcstat_l2_misses);
3152                         }
3153                 }
3154
3155                 rzio = zio_read(pio, spa, bp, buf->b_data, size,
3156                     arc_read_done, buf, priority, zio_flags, zb);
3157
3158                 if (*arc_flags & ARC_WAIT)
3159                         return (zio_wait(rzio));
3160
3161                 ASSERT(*arc_flags & ARC_NOWAIT);
3162                 zio_nowait(rzio);
3163         }
3164         return (0);
3165 }
3166
3167 arc_prune_t *
3168 arc_add_prune_callback(arc_prune_func_t *func, void *private)
3169 {
3170         arc_prune_t *p;
3171
3172         p = kmem_alloc(sizeof(*p), KM_SLEEP);
3173         p->p_pfunc = func;
3174         p->p_private = private;
3175         list_link_init(&p->p_node);
3176         refcount_create(&p->p_refcnt);
3177
3178         mutex_enter(&arc_prune_mtx);
3179         refcount_add(&p->p_refcnt, &arc_prune_list);
3180         list_insert_head(&arc_prune_list, p);
3181         mutex_exit(&arc_prune_mtx);
3182
3183         return (p);
3184 }
3185
3186 void
3187 arc_remove_prune_callback(arc_prune_t *p)
3188 {
3189         mutex_enter(&arc_prune_mtx);
3190         list_remove(&arc_prune_list, p);
3191         if (refcount_remove(&p->p_refcnt, &arc_prune_list) == 0) {
3192                 refcount_destroy(&p->p_refcnt);
3193                 kmem_free(p, sizeof (*p));
3194         }
3195         mutex_exit(&arc_prune_mtx);
3196 }
3197
3198 void
3199 arc_set_callback(arc_buf_t *buf, arc_evict_func_t *func, void *private)
3200 {
3201         ASSERT(buf->b_hdr != NULL);
3202         ASSERT(buf->b_hdr->b_state != arc_anon);
3203         ASSERT(!refcount_is_zero(&buf->b_hdr->b_refcnt) || func == NULL);
3204         ASSERT(buf->b_efunc == NULL);
3205         ASSERT(!HDR_BUF_AVAILABLE(buf->b_hdr));
3206
3207         buf->b_efunc = func;
3208         buf->b_private = private;
3209 }
3210
3211 /*
3212  * Notify the arc that a block was freed, and thus will never be used again.
3213  */
3214 void
3215 arc_freed(spa_t *spa, const blkptr_t *bp)
3216 {
3217         arc_buf_hdr_t *hdr;
3218         kmutex_t *hash_lock;
3219         uint64_t guid = spa_load_guid(spa);
3220
3221         hdr = buf_hash_find(guid, BP_IDENTITY(bp), BP_PHYSICAL_BIRTH(bp),
3222             &hash_lock);
3223         if (hdr == NULL)
3224                 return;
3225         if (HDR_BUF_AVAILABLE(hdr)) {
3226                 arc_buf_t *buf = hdr->b_buf;
3227                 add_reference(hdr, hash_lock, FTAG);
3228                 hdr->b_flags &= ~ARC_BUF_AVAILABLE;
3229                 mutex_exit(hash_lock);
3230
3231                 arc_release(buf, FTAG);
3232                 (void) arc_buf_remove_ref(buf, FTAG);
3233         } else {
3234                 mutex_exit(hash_lock);
3235         }
3236
3237 }
3238
3239 /*
3240  * This is used by the DMU to let the ARC know that a buffer is
3241  * being evicted, so the ARC should clean up.  If this arc buf
3242  * is not yet in the evicted state, it will be put there.
3243  */
3244 int
3245 arc_buf_evict(arc_buf_t *buf)
3246 {
3247         arc_buf_hdr_t *hdr;
3248         kmutex_t *hash_lock;
3249         arc_buf_t **bufp;
3250
3251         mutex_enter(&buf->b_evict_lock);
3252         hdr = buf->b_hdr;
3253         if (hdr == NULL) {
3254                 /*
3255                  * We are in arc_do_user_evicts().
3256                  */
3257                 ASSERT(buf->b_data == NULL);
3258                 mutex_exit(&buf->b_evict_lock);
3259                 return (0);
3260         } else if (buf->b_data == NULL) {
3261                 arc_buf_t copy = *buf; /* structure assignment */
3262                 /*
3263                  * We are on the eviction list; process this buffer now
3264                  * but let arc_do_user_evicts() do the reaping.
3265                  */
3266                 buf->b_efunc = NULL;
3267                 mutex_exit(&buf->b_evict_lock);
3268                 VERIFY(copy.b_efunc(&copy) == 0);
3269                 return (1);
3270         }
3271         hash_lock = HDR_LOCK(hdr);
3272         mutex_enter(hash_lock);
3273         hdr = buf->b_hdr;
3274         ASSERT3P(hash_lock, ==, HDR_LOCK(hdr));
3275
3276         ASSERT3U(refcount_count(&hdr->b_refcnt), <, hdr->b_datacnt);
3277         ASSERT(hdr->b_state == arc_mru || hdr->b_state == arc_mfu);
3278
3279         /*
3280          * Pull this buffer off of the hdr
3281          */
3282         bufp = &hdr->b_buf;
3283         while (*bufp != buf)
3284                 bufp = &(*bufp)->b_next;
3285         *bufp = buf->b_next;
3286
3287         ASSERT(buf->b_data != NULL);
3288         arc_buf_destroy(buf, FALSE, FALSE);
3289
3290         if (hdr->b_datacnt == 0) {
3291                 arc_state_t *old_state = hdr->b_state;
3292                 arc_state_t *evicted_state;
3293
3294                 ASSERT(hdr->b_buf == NULL);
3295                 ASSERT(refcount_is_zero(&hdr->b_refcnt));
3296
3297                 evicted_state =
3298                     (old_state == arc_mru) ? arc_mru_ghost : arc_mfu_ghost;
3299
3300                 mutex_enter(&old_state->arcs_mtx);
3301                 mutex_enter(&evicted_state->arcs_mtx);
3302
3303                 arc_change_state(evicted_state, hdr, hash_lock);
3304                 ASSERT(HDR_IN_HASH_TABLE(hdr));
3305                 hdr->b_flags |= ARC_IN_HASH_TABLE;
3306                 hdr->b_flags &= ~ARC_BUF_AVAILABLE;
3307
3308                 mutex_exit(&evicted_state->arcs_mtx);
3309                 mutex_exit(&old_state->arcs_mtx);
3310         }
3311         mutex_exit(hash_lock);
3312         mutex_exit(&buf->b_evict_lock);
3313
3314         VERIFY(buf->b_efunc(buf) == 0);
3315         buf->b_efunc = NULL;
3316         buf->b_private = NULL;
3317         buf->b_hdr = NULL;
3318         buf->b_next = NULL;
3319         kmem_cache_free(buf_cache, buf);
3320         return (1);
3321 }
3322
3323 /*
3324  * Release this buffer from the cache.  This must be done
3325  * after a read and prior to modifying the buffer contents.
3326  * If the buffer has more than one reference, we must make
3327  * a new hdr for the buffer.
3328  */
3329 void
3330 arc_release(arc_buf_t *buf, void *tag)
3331 {
3332         arc_buf_hdr_t *hdr;
3333         kmutex_t *hash_lock = NULL;
3334         l2arc_buf_hdr_t *l2hdr;
3335         uint64_t buf_size = 0;
3336
3337         /*
3338          * It would be nice to assert that if it's DMU metadata (level >
3339          * 0 || it's the dnode file), then it must be syncing context.
3340          * But we don't know that information at this level.
3341          */
3342
3343         mutex_enter(&buf->b_evict_lock);
3344         hdr = buf->b_hdr;
3345
3346         /* this buffer is not on any list */
3347         ASSERT(refcount_count(&hdr->b_refcnt) > 0);
3348
3349         if (hdr->b_state == arc_anon) {
3350                 /* this buffer is already released */
3351                 ASSERT(buf->b_efunc == NULL);
3352         } else {
3353                 hash_lock = HDR_LOCK(hdr);
3354                 mutex_enter(hash_lock);
3355                 hdr = buf->b_hdr;
3356                 ASSERT3P(hash_lock, ==, HDR_LOCK(hdr));
3357         }
3358
3359         l2hdr = hdr->b_l2hdr;
3360         if (l2hdr) {
3361                 mutex_enter(&l2arc_buflist_mtx);
3362                 hdr->b_l2hdr = NULL;
3363                 buf_size = hdr->b_size;
3364         }
3365
3366         /*
3367          * Do we have more than one buf?
3368          */
3369         if (hdr->b_datacnt > 1) {
3370                 arc_buf_hdr_t *nhdr;
3371                 arc_buf_t **bufp;
3372                 uint64_t blksz = hdr->b_size;
3373                 uint64_t spa = hdr->b_spa;
3374                 arc_buf_contents_t type = hdr->b_type;
3375                 uint32_t flags = hdr->b_flags;
3376
3377                 ASSERT(hdr->b_buf != buf || buf->b_next != NULL);
3378                 /*
3379                  * Pull the data off of this hdr and attach it to
3380                  * a new anonymous hdr.
3381                  */
3382                 (void) remove_reference(hdr, hash_lock, tag);
3383                 bufp = &hdr->b_buf;
3384                 while (*bufp != buf)
3385                         bufp = &(*bufp)->b_next;
3386                 *bufp = buf->b_next;
3387                 buf->b_next = NULL;
3388
3389                 ASSERT3U(hdr->b_state->arcs_size, >=, hdr->b_size);
3390                 atomic_add_64(&hdr->b_state->arcs_size, -hdr->b_size);
3391                 if (refcount_is_zero(&hdr->b_refcnt)) {
3392                         uint64_t *size = &hdr->b_state->arcs_lsize[hdr->b_type];
3393                         ASSERT3U(*size, >=, hdr->b_size);
3394                         atomic_add_64(size, -hdr->b_size);
3395                 }
3396
3397                 /*
3398                  * We're releasing a duplicate user data buffer, update
3399                  * our statistics accordingly.
3400                  */
3401                 if (hdr->b_type == ARC_BUFC_DATA) {
3402                         ARCSTAT_BUMPDOWN(arcstat_duplicate_buffers);
3403                         ARCSTAT_INCR(arcstat_duplicate_buffers_size,
3404                             -hdr->b_size);
3405                 }
3406                 hdr->b_datacnt -= 1;
3407                 arc_cksum_verify(buf);
3408
3409                 mutex_exit(hash_lock);
3410
3411                 nhdr = kmem_cache_alloc(hdr_cache, KM_PUSHPAGE);
3412                 nhdr->b_size = blksz;
3413                 nhdr->b_spa = spa;
3414                 nhdr->b_type = type;
3415                 nhdr->b_buf = buf;
3416                 nhdr->b_state = arc_anon;
3417                 nhdr->b_arc_access = 0;
3418                 nhdr->b_flags = flags & ARC_L2_WRITING;
3419                 nhdr->b_l2hdr = NULL;
3420                 nhdr->b_datacnt = 1;
3421                 nhdr->b_freeze_cksum = NULL;
3422                 (void) refcount_add(&nhdr->b_refcnt, tag);
3423                 buf->b_hdr = nhdr;
3424                 mutex_exit(&buf->b_evict_lock);
3425                 atomic_add_64(&arc_anon->arcs_size, blksz);
3426         } else {
3427                 mutex_exit(&buf->b_evict_lock);
3428                 ASSERT(refcount_count(&hdr->b_refcnt) == 1);
3429                 ASSERT(!list_link_active(&hdr->b_arc_node));
3430                 ASSERT(!HDR_IO_IN_PROGRESS(hdr));
3431                 if (hdr->b_state != arc_anon)
3432                         arc_change_state(arc_anon, hdr, hash_lock);
3433                 hdr->b_arc_access = 0;
3434                 if (hash_lock)
3435                         mutex_exit(hash_lock);
3436
3437                 buf_discard_identity(hdr);
3438                 arc_buf_thaw(buf);
3439         }
3440         buf->b_efunc = NULL;
3441         buf->b_private = NULL;
3442
3443         if (l2hdr) {
3444                 list_remove(l2hdr->b_dev->l2ad_buflist, hdr);
3445                 kmem_free(l2hdr, sizeof (l2arc_buf_hdr_t));
3446                 ARCSTAT_INCR(arcstat_l2_size, -buf_size);
3447                 mutex_exit(&l2arc_buflist_mtx);
3448         }
3449 }
3450
3451 int
3452 arc_released(arc_buf_t *buf)
3453 {
3454         int released;
3455
3456         mutex_enter(&buf->b_evict_lock);
3457         released = (buf->b_data != NULL && buf->b_hdr->b_state == arc_anon);
3458         mutex_exit(&buf->b_evict_lock);
3459         return (released);
3460 }
3461
3462 int
3463 arc_has_callback(arc_buf_t *buf)
3464 {
3465         int callback;
3466
3467         mutex_enter(&buf->b_evict_lock);
3468         callback = (buf->b_efunc != NULL);
3469         mutex_exit(&buf->b_evict_lock);
3470         return (callback);
3471 }
3472
3473 #ifdef ZFS_DEBUG
3474 int
3475 arc_referenced(arc_buf_t *buf)
3476 {
3477         int referenced;
3478
3479         mutex_enter(&buf->b_evict_lock);
3480         referenced = (refcount_count(&buf->b_hdr->b_refcnt));
3481         mutex_exit(&buf->b_evict_lock);
3482         return (referenced);
3483 }
3484 #endif
3485
3486 static void
3487 arc_write_ready(zio_t *zio)
3488 {
3489         arc_write_callback_t *callback = zio->io_private;
3490         arc_buf_t *buf = callback->awcb_buf;
3491         arc_buf_hdr_t *hdr = buf->b_hdr;
3492
3493         ASSERT(!refcount_is_zero(&buf->b_hdr->b_refcnt));
3494         callback->awcb_ready(zio, buf, callback->awcb_private);
3495
3496         /*
3497          * If the IO is already in progress, then this is a re-write
3498          * attempt, so we need to thaw and re-compute the cksum.
3499          * It is the responsibility of the callback to handle the
3500          * accounting for any re-write attempt.
3501          */
3502         if (HDR_IO_IN_PROGRESS(hdr)) {
3503                 mutex_enter(&hdr->b_freeze_lock);
3504                 if (hdr->b_freeze_cksum != NULL) {
3505                         kmem_free(hdr->b_freeze_cksum, sizeof (zio_cksum_t));
3506                         hdr->b_freeze_cksum = NULL;
3507                 }
3508                 mutex_exit(&hdr->b_freeze_lock);
3509         }
3510         arc_cksum_compute(buf, B_FALSE);
3511         hdr->b_flags |= ARC_IO_IN_PROGRESS;
3512 }
3513
3514 static void
3515 arc_write_done(zio_t *zio)
3516 {
3517         arc_write_callback_t *callback = zio->io_private;
3518         arc_buf_t *buf = callback->awcb_buf;
3519         arc_buf_hdr_t *hdr = buf->b_hdr;
3520
3521         ASSERT(hdr->b_acb == NULL);
3522
3523         if (zio->io_error == 0) {
3524                 hdr->b_dva = *BP_IDENTITY(zio->io_bp);
3525                 hdr->b_birth = BP_PHYSICAL_BIRTH(zio->io_bp);
3526                 hdr->b_cksum0 = zio->io_bp->blk_cksum.zc_word[0];
3527         } else {
3528                 ASSERT(BUF_EMPTY(hdr));
3529         }
3530
3531         /*
3532          * If the block to be written was all-zero, we may have
3533          * compressed it away.  In this case no write was performed
3534          * so there will be no dva/birth/checksum.  The buffer must
3535          * therefore remain anonymous (and uncached).
3536          */
3537         if (!BUF_EMPTY(hdr)) {
3538                 arc_buf_hdr_t *exists;
3539                 kmutex_t *hash_lock;
3540
3541                 ASSERT(zio->io_error == 0);
3542
3543                 arc_cksum_verify(buf);
3544
3545                 exists = buf_hash_insert(hdr, &hash_lock);
3546                 if (exists) {
3547                         /*
3548                          * This can only happen if we overwrite for
3549                          * sync-to-convergence, because we remove
3550                          * buffers from the hash table when we arc_free().
3551                          */
3552                         if (zio->io_flags & ZIO_FLAG_IO_REWRITE) {
3553                                 if (!BP_EQUAL(&zio->io_bp_orig, zio->io_bp))
3554                                         panic("bad overwrite, hdr=%p exists=%p",
3555                                             (void *)hdr, (void *)exists);
3556                                 ASSERT(refcount_is_zero(&exists->b_refcnt));
3557                                 arc_change_state(arc_anon, exists, hash_lock);
3558                                 mutex_exit(hash_lock);
3559                                 arc_hdr_destroy(exists);
3560                                 exists = buf_hash_insert(hdr, &hash_lock);
3561                                 ASSERT3P(exists, ==, NULL);
3562                         } else {
3563                                 /* Dedup */
3564                                 ASSERT(hdr->b_datacnt == 1);
3565                                 ASSERT(hdr->b_state == arc_anon);
3566                                 ASSERT(BP_GET_DEDUP(zio->io_bp));
3567                                 ASSERT(BP_GET_LEVEL(zio->io_bp) == 0);
3568                         }
3569                 }
3570                 hdr->b_flags &= ~ARC_IO_IN_PROGRESS;
3571                 /* if it's not anon, we are doing a scrub */
3572                 if (!exists && hdr->b_state == arc_anon)
3573                         arc_access(hdr, hash_lock);
3574                 mutex_exit(hash_lock);
3575         } else {
3576                 hdr->b_flags &= ~ARC_IO_IN_PROGRESS;
3577         }
3578
3579         ASSERT(!refcount_is_zero(&hdr->b_refcnt));
3580         callback->awcb_done(zio, buf, callback->awcb_private);
3581
3582         kmem_free(callback, sizeof (arc_write_callback_t));
3583 }
3584
3585 zio_t *
3586 arc_write(zio_t *pio, spa_t *spa, uint64_t txg,
3587     blkptr_t *bp, arc_buf_t *buf, boolean_t l2arc, const zio_prop_t *zp,
3588     arc_done_func_t *ready, arc_done_func_t *done, void *private,
3589     int priority, int zio_flags, const zbookmark_t *zb)
3590 {
3591         arc_buf_hdr_t *hdr = buf->b_hdr;
3592         arc_write_callback_t *callback;
3593         zio_t *zio;
3594
3595         ASSERT(ready != NULL);
3596         ASSERT(done != NULL);
3597         ASSERT(!HDR_IO_ERROR(hdr));
3598         ASSERT((hdr->b_flags & ARC_IO_IN_PROGRESS) == 0);
3599         ASSERT(hdr->b_acb == NULL);
3600         if (l2arc)
3601                 hdr->b_flags |= ARC_L2CACHE;
3602         callback = kmem_zalloc(sizeof (arc_write_callback_t), KM_PUSHPAGE);
3603         callback->awcb_ready = ready;
3604         callback->awcb_done = done;
3605         callback->awcb_private = private;
3606         callback->awcb_buf = buf;
3607
3608         zio = zio_write(pio, spa, txg, bp, buf->b_data, hdr->b_size, zp,
3609             arc_write_ready, arc_write_done, callback, priority, zio_flags, zb);
3610
3611         return (zio);
3612 }
3613
3614 static int
3615 arc_memory_throttle(uint64_t reserve, uint64_t inflight_data, uint64_t txg)
3616 {
3617 #ifdef _KERNEL
3618         uint64_t available_memory;
3619
3620         if (zfs_arc_memory_throttle_disable)
3621                 return (0);
3622
3623         /* Easily reclaimable memory (free + inactive + arc-evictable) */
3624         available_memory = ptob(spl_kmem_availrmem()) + arc_evictable_memory();
3625
3626         if (available_memory <= zfs_write_limit_max) {
3627                 ARCSTAT_INCR(arcstat_memory_throttle_count, 1);
3628                 DMU_TX_STAT_BUMP(dmu_tx_memory_reclaim);
3629                 return (EAGAIN);
3630         }
3631
3632         if (inflight_data > available_memory / 4) {
3633                 ARCSTAT_INCR(arcstat_memory_throttle_count, 1);
3634                 DMU_TX_STAT_BUMP(dmu_tx_memory_inflight);
3635                 return (ERESTART);
3636         }
3637 #endif
3638         return (0);
3639 }
3640
3641 void
3642 arc_tempreserve_clear(uint64_t reserve)
3643 {
3644         atomic_add_64(&arc_tempreserve, -reserve);
3645         ASSERT((int64_t)arc_tempreserve >= 0);
3646 }
3647
3648 int
3649 arc_tempreserve_space(uint64_t reserve, uint64_t txg)
3650 {
3651         int error;
3652         uint64_t anon_size;
3653
3654 #ifdef ZFS_DEBUG
3655         /*
3656          * Once in a while, fail for no reason.  Everything should cope.
3657          */
3658         if (spa_get_random(10000) == 0) {
3659                 dprintf("forcing random failure\n");
3660                 return (ERESTART);
3661         }
3662 #endif
3663         if (reserve > arc_c/4 && !arc_no_grow)
3664                 arc_c = MIN(arc_c_max, reserve * 4);
3665         if (reserve > arc_c) {
3666                 DMU_TX_STAT_BUMP(dmu_tx_memory_reserve);
3667                 return (ENOMEM);
3668         }
3669
3670         /*
3671          * Don't count loaned bufs as in flight dirty data to prevent long
3672          * network delays from blocking transactions that are ready to be
3673          * assigned to a txg.
3674          */
3675         anon_size = MAX((int64_t)(arc_anon->arcs_size - arc_loaned_bytes), 0);
3676
3677         /*
3678          * Writes will, almost always, require additional memory allocations
3679          * in order to compress/encrypt/etc the data.  We therefor need to
3680          * make sure that there is sufficient available memory for this.
3681          */
3682         if ((error = arc_memory_throttle(reserve, anon_size, txg)))
3683                 return (error);
3684
3685         /*
3686          * Throttle writes when the amount of dirty data in the cache
3687          * gets too large.  We try to keep the cache less than half full
3688          * of dirty blocks so that our sync times don't grow too large.
3689          * Note: if two requests come in concurrently, we might let them
3690          * both succeed, when one of them should fail.  Not a huge deal.
3691          */
3692
3693         if (reserve + arc_tempreserve + anon_size > arc_c / 2 &&
3694             anon_size > arc_c / 4) {
3695                 dprintf("failing, arc_tempreserve=%lluK anon_meta=%lluK "
3696                     "anon_data=%lluK tempreserve=%lluK arc_c=%lluK\n",
3697                     arc_tempreserve>>10,
3698                     arc_anon->arcs_lsize[ARC_BUFC_METADATA]>>10,
3699                     arc_anon->arcs_lsize[ARC_BUFC_DATA]>>10,
3700                     reserve>>10, arc_c>>10);
3701                 DMU_TX_STAT_BUMP(dmu_tx_dirty_throttle);
3702                 return (ERESTART);
3703         }
3704         atomic_add_64(&arc_tempreserve, reserve);
3705         return (0);
3706 }
3707
3708 static void
3709 arc_kstat_update_state(arc_state_t *state, kstat_named_t *size,
3710     kstat_named_t *evict_data, kstat_named_t *evict_metadata)
3711 {
3712         size->value.ui64 = state->arcs_size;
3713         evict_data->value.ui64 = state->arcs_lsize[ARC_BUFC_DATA];
3714         evict_metadata->value.ui64 = state->arcs_lsize[ARC_BUFC_METADATA];
3715 }
3716
3717 static int
3718 arc_kstat_update(kstat_t *ksp, int rw)
3719 {
3720         arc_stats_t *as = ksp->ks_data;
3721
3722         if (rw == KSTAT_WRITE) {
3723                 return (EACCES);
3724         } else {
3725                 arc_kstat_update_state(arc_anon,
3726                     &as->arcstat_anon_size,
3727                     &as->arcstat_anon_evict_data,
3728                     &as->arcstat_anon_evict_metadata);
3729                 arc_kstat_update_state(arc_mru,
3730                     &as->arcstat_mru_size,
3731                     &as->arcstat_mru_evict_data,
3732                     &as->arcstat_mru_evict_metadata);
3733                 arc_kstat_update_state(arc_mru_ghost,
3734                     &as->arcstat_mru_ghost_size,
3735                     &as->arcstat_mru_ghost_evict_data,
3736                     &as->arcstat_mru_ghost_evict_metadata);
3737                 arc_kstat_update_state(arc_mfu,
3738                     &as->arcstat_mfu_size,
3739                     &as->arcstat_mfu_evict_data,
3740                     &as->arcstat_mfu_evict_metadata);
3741                 arc_kstat_update_state(arc_mfu_ghost,
3742                     &as->arcstat_mfu_ghost_size,
3743                     &as->arcstat_mfu_ghost_evict_data,
3744                     &as->arcstat_mfu_ghost_evict_metadata);
3745         }
3746
3747         return (0);
3748 }
3749
3750 void
3751 arc_init(void)
3752 {
3753         mutex_init(&arc_reclaim_thr_lock, NULL, MUTEX_DEFAULT, NULL);
3754         cv_init(&arc_reclaim_thr_cv, NULL, CV_DEFAULT, NULL);
3755
3756         /* Convert seconds to clock ticks */
3757         arc_min_prefetch_lifespan = 1 * hz;
3758
3759         /* Start out with 1/8 of all memory */
3760         arc_c = physmem * PAGESIZE / 8;
3761
3762 #ifdef _KERNEL
3763         /*
3764          * On architectures where the physical memory can be larger
3765          * than the addressable space (intel in 32-bit mode), we may
3766          * need to limit the cache to 1/8 of VM size.
3767          */
3768         arc_c = MIN(arc_c, vmem_size(heap_arena, VMEM_ALLOC | VMEM_FREE) / 8);
3769         /*
3770          * Register a shrinker to support synchronous (direct) memory
3771          * reclaim from the arc.  This is done to prevent kswapd from
3772          * swapping out pages when it is preferable to shrink the arc.
3773          */
3774         spl_register_shrinker(&arc_shrinker);
3775 #endif
3776
3777         /* set min cache to 1/32 of all memory, or 64MB, whichever is more */
3778         arc_c_min = MAX(arc_c / 4, 64<<20);
3779         /* set max to 1/2 of all memory */
3780         arc_c_max = MAX(arc_c * 4, arc_c_max);
3781
3782         /*
3783          * Allow the tunables to override our calculations if they are
3784          * reasonable (ie. over 64MB)
3785          */
3786         if (zfs_arc_max > 64<<20 && zfs_arc_max < physmem * PAGESIZE)
3787                 arc_c_max = zfs_arc_max;
3788         if (zfs_arc_min > 64<<20 && zfs_arc_min <= arc_c_max)
3789                 arc_c_min = zfs_arc_min;
3790
3791         arc_c = arc_c_max;
3792         arc_p = (arc_c >> 1);
3793
3794         /* limit meta-data to 1/4 of the arc capacity */
3795         arc_meta_limit = arc_c_max / 4;
3796         arc_meta_max = 0;
3797
3798         /* Allow the tunable to override if it is reasonable */
3799         if (zfs_arc_meta_limit > 0 && zfs_arc_meta_limit <= arc_c_max)
3800                 arc_meta_limit = zfs_arc_meta_limit;
3801
3802         if (arc_c_min < arc_meta_limit / 2 && zfs_arc_min == 0)
3803                 arc_c_min = arc_meta_limit / 2;
3804
3805         if (zfs_arc_grow_retry > 0)
3806                 arc_grow_retry = zfs_arc_grow_retry;
3807
3808         if (zfs_arc_shrink_shift > 0)
3809                 arc_shrink_shift = zfs_arc_shrink_shift;
3810
3811         if (zfs_arc_p_min_shift > 0)
3812                 arc_p_min_shift = zfs_arc_p_min_shift;
3813
3814         if (zfs_arc_meta_prune > 0)
3815                 arc_meta_prune = zfs_arc_meta_prune;
3816
3817         /* if kmem_flags are set, lets try to use less memory */
3818         if (kmem_debugging())
3819                 arc_c = arc_c / 2;
3820         if (arc_c < arc_c_min)
3821                 arc_c = arc_c_min;
3822
3823         arc_anon = &ARC_anon;
3824         arc_mru = &ARC_mru;
3825         arc_mru_ghost = &ARC_mru_ghost;
3826         arc_mfu = &ARC_mfu;
3827         arc_mfu_ghost = &ARC_mfu_ghost;
3828         arc_l2c_only = &ARC_l2c_only;
3829         arc_size = 0;
3830
3831         mutex_init(&arc_anon->arcs_mtx, NULL, MUTEX_DEFAULT, NULL);
3832         mutex_init(&arc_mru->arcs_mtx, NULL, MUTEX_DEFAULT, NULL);
3833         mutex_init(&arc_mru_ghost->arcs_mtx, NULL, MUTEX_DEFAULT, NULL);
3834         mutex_init(&arc_mfu->arcs_mtx, NULL, MUTEX_DEFAULT, NULL);
3835         mutex_init(&arc_mfu_ghost->arcs_mtx, NULL, MUTEX_DEFAULT, NULL);
3836         mutex_init(&arc_l2c_only->arcs_mtx, NULL, MUTEX_DEFAULT, NULL);
3837
3838         list_create(&arc_mru->arcs_list[ARC_BUFC_METADATA],
3839             sizeof (arc_buf_hdr_t), offsetof(arc_buf_hdr_t, b_arc_node));
3840         list_create(&arc_mru->arcs_list[ARC_BUFC_DATA],
3841             sizeof (arc_buf_hdr_t), offsetof(arc_buf_hdr_t, b_arc_node));
3842         list_create(&arc_mru_ghost->arcs_list[ARC_BUFC_METADATA],
3843             sizeof (arc_buf_hdr_t), offsetof(arc_buf_hdr_t, b_arc_node));
3844         list_create(&arc_mru_ghost->arcs_list[ARC_BUFC_DATA],
3845             sizeof (arc_buf_hdr_t), offsetof(arc_buf_hdr_t, b_arc_node));
3846         list_create(&arc_mfu->arcs_list[ARC_BUFC_METADATA],
3847             sizeof (arc_buf_hdr_t), offsetof(arc_buf_hdr_t, b_arc_node));
3848         list_create(&arc_mfu->arcs_list[ARC_BUFC_DATA],
3849             sizeof (arc_buf_hdr_t), offsetof(arc_buf_hdr_t, b_arc_node));
3850         list_create(&arc_mfu_ghost->arcs_list[ARC_BUFC_METADATA],
3851             sizeof (arc_buf_hdr_t), offsetof(arc_buf_hdr_t, b_arc_node));
3852         list_create(&arc_mfu_ghost->arcs_list[ARC_BUFC_DATA],
3853             sizeof (arc_buf_hdr_t), offsetof(arc_buf_hdr_t, b_arc_node));
3854         list_create(&arc_l2c_only->arcs_list[ARC_BUFC_METADATA],
3855             sizeof (arc_buf_hdr_t), offsetof(arc_buf_hdr_t, b_arc_node));
3856         list_create(&arc_l2c_only->arcs_list[ARC_BUFC_DATA],
3857             sizeof (arc_buf_hdr_t), offsetof(arc_buf_hdr_t, b_arc_node));
3858
3859         buf_init();
3860
3861         arc_thread_exit = 0;
3862         list_create(&arc_prune_list, sizeof (arc_prune_t),
3863             offsetof(arc_prune_t, p_node));
3864         arc_eviction_list = NULL;
3865         mutex_init(&arc_prune_mtx, NULL, MUTEX_DEFAULT, NULL);
3866         mutex_init(&arc_eviction_mtx, NULL, MUTEX_DEFAULT, NULL);
3867         bzero(&arc_eviction_hdr, sizeof (arc_buf_hdr_t));
3868
3869         arc_ksp = kstat_create("zfs", 0, "arcstats", "misc", KSTAT_TYPE_NAMED,
3870             sizeof (arc_stats) / sizeof (kstat_named_t), KSTAT_FLAG_VIRTUAL);
3871
3872         if (arc_ksp != NULL) {
3873                 arc_ksp->ks_data = &arc_stats;
3874                 arc_ksp->ks_update = arc_kstat_update;
3875                 kstat_install(arc_ksp);
3876         }
3877
3878         (void) thread_create(NULL, 0, arc_adapt_thread, NULL, 0, &p0,
3879             TS_RUN, minclsyspri);
3880
3881         arc_dead = FALSE;
3882         arc_warm = B_FALSE;
3883
3884         if (zfs_write_limit_max == 0)
3885                 zfs_write_limit_max = ptob(physmem) >> zfs_write_limit_shift;
3886         else
3887                 zfs_write_limit_shift = 0;
3888         mutex_init(&zfs_write_limit_lock, NULL, MUTEX_DEFAULT, NULL);
3889 }
3890
3891 void
3892 arc_fini(void)
3893 {
3894         arc_prune_t *p;
3895
3896         mutex_enter(&arc_reclaim_thr_lock);
3897 #ifdef _KERNEL
3898         spl_unregister_shrinker(&arc_shrinker);
3899 #endif /* _KERNEL */
3900
3901         arc_thread_exit = 1;
3902         while (arc_thread_exit != 0)
3903                 cv_wait(&arc_reclaim_thr_cv, &arc_reclaim_thr_lock);
3904         mutex_exit(&arc_reclaim_thr_lock);
3905
3906         arc_flush(NULL);
3907
3908         arc_dead = TRUE;
3909
3910         if (arc_ksp != NULL) {
3911                 kstat_delete(arc_ksp);
3912                 arc_ksp = NULL;
3913         }
3914
3915         mutex_enter(&arc_prune_mtx);
3916         while ((p = list_head(&arc_prune_list)) != NULL) {
3917                 list_remove(&arc_prune_list, p);
3918                 refcount_remove(&p->p_refcnt, &arc_prune_list);
3919                 refcount_destroy(&p->p_refcnt);
3920                 kmem_free(p, sizeof (*p));
3921         }
3922         mutex_exit(&arc_prune_mtx);
3923
3924         list_destroy(&arc_prune_list);
3925         mutex_destroy(&arc_prune_mtx);
3926         mutex_destroy(&arc_eviction_mtx);
3927         mutex_destroy(&arc_reclaim_thr_lock);
3928         cv_destroy(&arc_reclaim_thr_cv);
3929
3930         list_destroy(&arc_mru->arcs_list[ARC_BUFC_METADATA]);
3931         list_destroy(&arc_mru_ghost->arcs_list[ARC_BUFC_METADATA]);
3932         list_destroy(&arc_mfu->arcs_list[ARC_BUFC_METADATA]);
3933         list_destroy(&arc_mfu_ghost->arcs_list[ARC_BUFC_METADATA]);
3934         list_destroy(&arc_mru->arcs_list[ARC_BUFC_DATA]);
3935         list_destroy(&arc_mru_ghost->arcs_list[ARC_BUFC_DATA]);
3936         list_destroy(&arc_mfu->arcs_list[ARC_BUFC_DATA]);
3937         list_destroy(&arc_mfu_ghost->arcs_list[ARC_BUFC_DATA]);
3938
3939         mutex_destroy(&arc_anon->arcs_mtx);
3940         mutex_destroy(&arc_mru->arcs_mtx);
3941         mutex_destroy(&arc_mru_ghost->arcs_mtx);
3942         mutex_destroy(&arc_mfu->arcs_mtx);
3943         mutex_destroy(&arc_mfu_ghost->arcs_mtx);
3944         mutex_destroy(&arc_l2c_only->arcs_mtx);
3945
3946         mutex_destroy(&zfs_write_limit_lock);
3947
3948         buf_fini();
3949
3950         ASSERT(arc_loaned_bytes == 0);
3951 }
3952
3953 /*
3954  * Level 2 ARC
3955  *
3956  * The level 2 ARC (L2ARC) is a cache layer in-between main memory and disk.
3957  * It uses dedicated storage devices to hold cached data, which are populated
3958  * using large infrequent writes.  The main role of this cache is to boost
3959  * the performance of random read workloads.  The intended L2ARC devices
3960  * include short-stroked disks, solid state disks, and other media with
3961  * substantially faster read latency than disk.
3962  *
3963  *                 +-----------------------+
3964  *                 |         ARC           |
3965  *                 +-----------------------+
3966  *                    |         ^     ^
3967  *                    |         |     |
3968  *      l2arc_feed_thread()    arc_read()
3969  *                    |         |     |
3970  *                    |  l2arc read   |
3971  *                    V         |     |
3972  *               +---------------+    |
3973  *               |     L2ARC     |    |
3974  *               +---------------+    |
3975  *                   |    ^           |
3976  *          l2arc_write() |           |
3977  *                   |    |           |
3978  *                   V    |           |
3979  *                 +-------+      +-------+
3980  *                 | vdev  |      | vdev  |
3981  *                 | cache |      | cache |
3982  *                 +-------+      +-------+
3983  *                 +=========+     .-----.
3984  *                 :  L2ARC  :    |-_____-|
3985  *                 : devices :    | Disks |
3986  *                 +=========+    `-_____-'
3987  *
3988  * Read requests are satisfied from the following sources, in order:
3989  *
3990  *      1) ARC
3991  *      2) vdev cache of L2ARC devices
3992  *      3) L2ARC devices
3993  *      4) vdev cache of disks
3994  *      5) disks
3995  *
3996  * Some L2ARC device types exhibit extremely slow write performance.
3997  * To accommodate for this there are some significant differences between
3998  * the L2ARC and traditional cache design:
3999  *
4000  * 1. There is no eviction path from the ARC to the L2ARC.  Evictions from
4001  * the ARC behave as usual, freeing buffers and placing headers on ghost
4002  * lists.  The ARC does not send buffers to the L2ARC during eviction as
4003  * this would add inflated write latencies for all ARC memory pressure.
4004  *
4005  * 2. The L2ARC attempts to cache data from the ARC before it is evicted.
4006  * It does this by periodically scanning buffers from the eviction-end of
4007  * the MFU and MRU ARC lists, copying them to the L2ARC devices if they are
4008  * not already there.  It scans until a headroom of buffers is satisfied,
4009  * which itself is a buffer for ARC eviction.  The thread that does this is
4010  * l2arc_feed_thread(), illustrated below; example sizes are included to
4011  * provide a better sense of ratio than this diagram:
4012  *
4013  *             head -->                        tail
4014  *              +---------------------+----------+
4015  *      ARC_mfu |:::::#:::::::::::::::|o#o###o###|-->.   # already on L2ARC
4016  *              +---------------------+----------+   |   o L2ARC eligible
4017  *      ARC_mru |:#:::::::::::::::::::|#o#ooo####|-->|   : ARC buffer
4018  *              +---------------------+----------+   |
4019  *                   15.9 Gbytes      ^ 32 Mbytes    |
4020  *                                 headroom          |
4021  *                                            l2arc_feed_thread()
4022  *                                                   |
4023  *                       l2arc write hand <--[oooo]--'
4024  *                               |           8 Mbyte
4025  *                               |          write max
4026  *                               V
4027  *                +==============================+
4028  *      L2ARC dev |####|#|###|###|    |####| ... |
4029  *                +==============================+
4030  *                           32 Gbytes
4031  *
4032  * 3. If an ARC buffer is copied to the L2ARC but then hit instead of
4033  * evicted, then the L2ARC has cached a buffer much sooner than it probably
4034  * needed to, potentially wasting L2ARC device bandwidth and storage.  It is
4035  * safe to say that this is an uncommon case, since buffers at the end of
4036  * the ARC lists have moved there due to inactivity.
4037  *
4038  * 4. If the ARC evicts faster than the L2ARC can maintain a headroom,
4039  * then the L2ARC simply misses copying some buffers.  This serves as a
4040  * pressure valve to prevent heavy read workloads from both stalling the ARC
4041  * with waits and clogging the L2ARC with writes.  This also helps prevent
4042  * the potential for the L2ARC to churn if it attempts to cache content too
4043  * quickly, such as during backups of the entire pool.
4044  *
4045  * 5. After system boot and before the ARC has filled main memory, there are
4046  * no evictions from the ARC and so the tails of the ARC_mfu and ARC_mru
4047  * lists can remain mostly static.  Instead of searching from tail of these
4048  * lists as pictured, the l2arc_feed_thread() will search from the list heads
4049  * for eligible buffers, greatly increasing its chance of finding them.
4050  *
4051  * The L2ARC device write speed is also boosted during this time so that
4052  * the L2ARC warms up faster.  Since there have been no ARC evictions yet,
4053  * there are no L2ARC reads, and no fear of degrading read performance
4054  * through increased writes.
4055  *
4056  * 6. Writes to the L2ARC devices are grouped and sent in-sequence, so that
4057  * the vdev queue can aggregate them into larger and fewer writes.  Each
4058  * device is written to in a rotor fashion, sweeping writes through
4059  * available space then repeating.
4060  *
4061  * 7. The L2ARC does not store dirty content.  It never needs to flush
4062  * write buffers back to disk based storage.
4063  *
4064  * 8. If an ARC buffer is written (and dirtied) which also exists in the
4065  * L2ARC, the now stale L2ARC buffer is immediately dropped.
4066  *
4067  * The performance of the L2ARC can be tweaked by a number of tunables, which
4068  * may be necessary for different workloads:
4069  *
4070  *      l2arc_write_max         max write bytes per interval
4071  *      l2arc_write_boost       extra write bytes during device warmup
4072  *      l2arc_noprefetch        skip caching prefetched buffers
4073  *      l2arc_headroom          number of max device writes to precache
4074  *      l2arc_feed_secs         seconds between L2ARC writing
4075  *
4076  * Tunables may be removed or added as future performance improvements are
4077  * integrated, and also may become zpool properties.
4078  *
4079  * There are three key functions that control how the L2ARC warms up:
4080  *
4081  *      l2arc_write_eligible()  check if a buffer is eligible to cache
4082  *      l2arc_write_size()      calculate how much to write
4083  *      l2arc_write_interval()  calculate sleep delay between writes
4084  *
4085  * These three functions determine what to write, how much, and how quickly
4086  * to send writes.
4087  */
4088
4089 static boolean_t
4090 l2arc_write_eligible(uint64_t spa_guid, arc_buf_hdr_t *ab)
4091 {
4092         /*
4093          * A buffer is *not* eligible for the L2ARC if it:
4094          * 1. belongs to a different spa.
4095          * 2. is already cached on the L2ARC.
4096          * 3. has an I/O in progress (it may be an incomplete read).
4097          * 4. is flagged not eligible (zfs property).
4098          */
4099         if (ab->b_spa != spa_guid || ab->b_l2hdr != NULL ||
4100             HDR_IO_IN_PROGRESS(ab) || !HDR_L2CACHE(ab))
4101                 return (B_FALSE);
4102
4103         return (B_TRUE);
4104 }
4105
4106 static uint64_t
4107 l2arc_write_size(l2arc_dev_t *dev)
4108 {
4109         uint64_t size;
4110
4111         size = dev->l2ad_write;
4112
4113         if (arc_warm == B_FALSE)
4114                 size += dev->l2ad_boost;
4115
4116         return (size);
4117
4118 }
4119
4120 static clock_t
4121 l2arc_write_interval(clock_t began, uint64_t wanted, uint64_t wrote)
4122 {
4123         clock_t interval, next, now;
4124
4125         /*
4126          * If the ARC lists are busy, increase our write rate; if the
4127          * lists are stale, idle back.  This is achieved by checking
4128          * how much we previously wrote - if it was more than half of
4129          * what we wanted, schedule the next write much sooner.
4130          */
4131         if (l2arc_feed_again && wrote > (wanted / 2))
4132                 interval = (hz * l2arc_feed_min_ms) / 1000;
4133         else
4134                 interval = hz * l2arc_feed_secs;
4135
4136         now = ddi_get_lbolt();
4137         next = MAX(now, MIN(now + interval, began + interval));
4138
4139         return (next);
4140 }
4141
4142 static void
4143 l2arc_hdr_stat_add(void)
4144 {
4145         ARCSTAT_INCR(arcstat_l2_hdr_size, HDR_SIZE + L2HDR_SIZE);
4146         ARCSTAT_INCR(arcstat_hdr_size, -HDR_SIZE);
4147 }
4148
4149 static void
4150 l2arc_hdr_stat_remove(void)
4151 {
4152         ARCSTAT_INCR(arcstat_l2_hdr_size, -(HDR_SIZE + L2HDR_SIZE));
4153         ARCSTAT_INCR(arcstat_hdr_size, HDR_SIZE);
4154 }
4155
4156 /*
4157  * Cycle through L2ARC devices.  This is how L2ARC load balances.
4158  * If a device is returned, this also returns holding the spa config lock.
4159  */
4160 static l2arc_dev_t *
4161 l2arc_dev_get_next(void)
4162 {
4163         l2arc_dev_t *first, *next = NULL;
4164
4165         /*
4166          * Lock out the removal of spas (spa_namespace_lock), then removal
4167          * of cache devices (l2arc_dev_mtx).  Once a device has been selected,
4168          * both locks will be dropped and a spa config lock held instead.
4169          */
4170         mutex_enter(&spa_namespace_lock);
4171         mutex_enter(&l2arc_dev_mtx);
4172
4173         /* if there are no vdevs, there is nothing to do */
4174         if (l2arc_ndev == 0)
4175                 goto out;
4176
4177         first = NULL;
4178         next = l2arc_dev_last;
4179         do {
4180                 /* loop around the list looking for a non-faulted vdev */
4181                 if (next == NULL) {
4182                         next = list_head(l2arc_dev_list);
4183                 } else {
4184                         next = list_next(l2arc_dev_list, next);
4185                         if (next == NULL)
4186                                 next = list_head(l2arc_dev_list);
4187                 }
4188
4189                 /* if we have come back to the start, bail out */
4190                 if (first == NULL)
4191                         first = next;
4192                 else if (next == first)
4193                         break;
4194
4195         } while (vdev_is_dead(next->l2ad_vdev));
4196
4197         /* if we were unable to find any usable vdevs, return NULL */
4198         if (vdev_is_dead(next->l2ad_vdev))
4199                 next = NULL;
4200
4201         l2arc_dev_last = next;
4202
4203 out:
4204         mutex_exit(&l2arc_dev_mtx);
4205
4206         /*
4207          * Grab the config lock to prevent the 'next' device from being
4208          * removed while we are writing to it.
4209          */
4210         if (next != NULL)
4211                 spa_config_enter(next->l2ad_spa, SCL_L2ARC, next, RW_READER);
4212         mutex_exit(&spa_namespace_lock);
4213
4214         return (next);
4215 }
4216
4217 /*
4218  * Free buffers that were tagged for destruction.
4219  */
4220 static void
4221 l2arc_do_free_on_write(void)
4222 {
4223         list_t *buflist;
4224         l2arc_data_free_t *df, *df_prev;
4225
4226         mutex_enter(&l2arc_free_on_write_mtx);
4227         buflist = l2arc_free_on_write;
4228
4229         for (df = list_tail(buflist); df; df = df_prev) {
4230                 df_prev = list_prev(buflist, df);
4231                 ASSERT(df->l2df_data != NULL);
4232                 ASSERT(df->l2df_func != NULL);
4233                 df->l2df_func(df->l2df_data, df->l2df_size);
4234                 list_remove(buflist, df);
4235                 kmem_free(df, sizeof (l2arc_data_free_t));
4236         }
4237
4238         mutex_exit(&l2arc_free_on_write_mtx);
4239 }
4240
4241 /*
4242  * A write to a cache device has completed.  Update all headers to allow
4243  * reads from these buffers to begin.
4244  */
4245 static void
4246 l2arc_write_done(zio_t *zio)
4247 {
4248         l2arc_write_callback_t *cb;
4249         l2arc_dev_t *dev;
4250         list_t *buflist;
4251         arc_buf_hdr_t *head, *ab, *ab_prev;
4252         l2arc_buf_hdr_t *abl2;
4253         kmutex_t *hash_lock;
4254
4255         cb = zio->io_private;
4256         ASSERT(cb != NULL);
4257         dev = cb->l2wcb_dev;
4258         ASSERT(dev != NULL);
4259         head = cb->l2wcb_head;
4260         ASSERT(head != NULL);
4261         buflist = dev->l2ad_buflist;
4262         ASSERT(buflist != NULL);
4263         DTRACE_PROBE2(l2arc__iodone, zio_t *, zio,
4264             l2arc_write_callback_t *, cb);
4265
4266         if (zio->io_error != 0)
4267                 ARCSTAT_BUMP(arcstat_l2_writes_error);
4268
4269         mutex_enter(&l2arc_buflist_mtx);
4270
4271         /*
4272          * All writes completed, or an error was hit.
4273          */
4274         for (ab = list_prev(buflist, head); ab; ab = ab_prev) {
4275                 ab_prev = list_prev(buflist, ab);
4276
4277                 hash_lock = HDR_LOCK(ab);
4278                 if (!mutex_tryenter(hash_lock)) {
4279                         /*
4280                          * This buffer misses out.  It may be in a stage
4281                          * of eviction.  Its ARC_L2_WRITING flag will be
4282                          * left set, denying reads to this buffer.
4283                          */
4284                         ARCSTAT_BUMP(arcstat_l2_writes_hdr_miss);
4285                         continue;
4286                 }
4287
4288                 if (zio->io_error != 0) {
4289                         /*
4290                          * Error - drop L2ARC entry.
4291                          */
4292                         list_remove(buflist, ab);
4293                         abl2 = ab->b_l2hdr;
4294                         ab->b_l2hdr = NULL;
4295                         kmem_free(abl2, sizeof (l2arc_buf_hdr_t));
4296                         ARCSTAT_INCR(arcstat_l2_size, -ab->b_size);
4297                 }
4298
4299                 /*
4300                  * Allow ARC to begin reads to this L2ARC entry.
4301                  */
4302                 ab->b_flags &= ~ARC_L2_WRITING;
4303
4304                 mutex_exit(hash_lock);
4305         }
4306
4307         atomic_inc_64(&l2arc_writes_done);
4308         list_remove(buflist, head);
4309         kmem_cache_free(hdr_cache, head);
4310         mutex_exit(&l2arc_buflist_mtx);
4311
4312         l2arc_do_free_on_write();
4313
4314         kmem_free(cb, sizeof (l2arc_write_callback_t));
4315 }
4316
4317 /*
4318  * A read to a cache device completed.  Validate buffer contents before
4319  * handing over to the regular ARC routines.
4320  */
4321 static void
4322 l2arc_read_done(zio_t *zio)
4323 {
4324         l2arc_read_callback_t *cb;
4325         arc_buf_hdr_t *hdr;
4326         arc_buf_t *buf;
4327         kmutex_t *hash_lock;
4328         int equal;
4329
4330         ASSERT(zio->io_vd != NULL);
4331         ASSERT(zio->io_flags & ZIO_FLAG_DONT_PROPAGATE);
4332
4333         spa_config_exit(zio->io_spa, SCL_L2ARC, zio->io_vd);
4334
4335         cb = zio->io_private;
4336         ASSERT(cb != NULL);
4337         buf = cb->l2rcb_buf;
4338         ASSERT(buf != NULL);
4339
4340         hash_lock = HDR_LOCK(buf->b_hdr);
4341         mutex_enter(hash_lock);
4342         hdr = buf->b_hdr;
4343         ASSERT3P(hash_lock, ==, HDR_LOCK(hdr));
4344
4345         /*
4346          * Check this survived the L2ARC journey.
4347          */
4348         equal = arc_cksum_equal(buf);
4349         if (equal && zio->io_error == 0 && !HDR_L2_EVICTED(hdr)) {
4350                 mutex_exit(hash_lock);
4351                 zio->io_private = buf;
4352                 zio->io_bp_copy = cb->l2rcb_bp; /* XXX fix in L2ARC 2.0 */
4353                 zio->io_bp = &zio->io_bp_copy;  /* XXX fix in L2ARC 2.0 */
4354                 arc_read_done(zio);
4355         } else {
4356                 mutex_exit(hash_lock);
4357                 /*
4358                  * Buffer didn't survive caching.  Increment stats and
4359                  * reissue to the original storage device.
4360                  */
4361                 if (zio->io_error != 0) {
4362                         ARCSTAT_BUMP(arcstat_l2_io_error);
4363                 } else {
4364                         zio->io_error = EIO;
4365                 }
4366                 if (!equal)
4367                         ARCSTAT_BUMP(arcstat_l2_cksum_bad);
4368
4369                 /*
4370                  * If there's no waiter, issue an async i/o to the primary
4371                  * storage now.  If there *is* a waiter, the caller must
4372                  * issue the i/o in a context where it's OK to block.
4373                  */
4374                 if (zio->io_waiter == NULL) {
4375                         zio_t *pio = zio_unique_parent(zio);
4376
4377                         ASSERT(!pio || pio->io_child_type == ZIO_CHILD_LOGICAL);
4378
4379                         zio_nowait(zio_read(pio, cb->l2rcb_spa, &cb->l2rcb_bp,
4380                             buf->b_data, zio->io_size, arc_read_done, buf,
4381                             zio->io_priority, cb->l2rcb_flags, &cb->l2rcb_zb));
4382                 }
4383         }
4384
4385         kmem_free(cb, sizeof (l2arc_read_callback_t));
4386 }
4387
4388 /*
4389  * This is the list priority from which the L2ARC will search for pages to
4390  * cache.  This is used within loops (0..3) to cycle through lists in the
4391  * desired order.  This order can have a significant effect on cache
4392  * performance.
4393  *
4394  * Currently the metadata lists are hit first, MFU then MRU, followed by
4395  * the data lists.  This function returns a locked list, and also returns
4396  * the lock pointer.
4397  */
4398 static list_t *
4399 l2arc_list_locked(int list_num, kmutex_t **lock)
4400 {
4401         list_t *list = NULL;
4402
4403         ASSERT(list_num >= 0 && list_num <= 3);
4404
4405         switch (list_num) {
4406         case 0:
4407                 list = &arc_mfu->arcs_list[ARC_BUFC_METADATA];
4408                 *lock = &arc_mfu->arcs_mtx;
4409                 break;
4410         case 1:
4411                 list = &arc_mru->arcs_list[ARC_BUFC_METADATA];
4412                 *lock = &arc_mru->arcs_mtx;
4413                 break;
4414         case 2:
4415                 list = &arc_mfu->arcs_list[ARC_BUFC_DATA];
4416                 *lock = &arc_mfu->arcs_mtx;
4417                 break;
4418         case 3:
4419                 list = &arc_mru->arcs_list[ARC_BUFC_DATA];
4420                 *lock = &arc_mru->arcs_mtx;
4421                 break;
4422         }
4423
4424         ASSERT(!(MUTEX_HELD(*lock)));
4425         mutex_enter(*lock);
4426         return (list);
4427 }
4428
4429 /*
4430  * Evict buffers from the device write hand to the distance specified in
4431  * bytes.  This distance may span populated buffers, it may span nothing.
4432  * This is clearing a region on the L2ARC device ready for writing.
4433  * If the 'all' boolean is set, every buffer is evicted.
4434  */
4435 static void
4436 l2arc_evict(l2arc_dev_t *dev, uint64_t distance, boolean_t all)
4437 {
4438         list_t *buflist;
4439         l2arc_buf_hdr_t *abl2;
4440         arc_buf_hdr_t *ab, *ab_prev;
4441         kmutex_t *hash_lock;
4442         uint64_t taddr;
4443
4444         buflist = dev->l2ad_buflist;
4445
4446         if (buflist == NULL)
4447                 return;
4448
4449         if (!all && dev->l2ad_first) {
4450                 /*
4451                  * This is the first sweep through the device.  There is
4452                  * nothing to evict.
4453                  */
4454                 return;
4455         }
4456
4457         if (dev->l2ad_hand >= (dev->l2ad_end - (2 * distance))) {
4458                 /*
4459                  * When nearing the end of the device, evict to the end
4460                  * before the device write hand jumps to the start.
4461                  */
4462                 taddr = dev->l2ad_end;
4463         } else {
4464                 taddr = dev->l2ad_hand + distance;
4465         }
4466         DTRACE_PROBE4(l2arc__evict, l2arc_dev_t *, dev, list_t *, buflist,
4467             uint64_t, taddr, boolean_t, all);
4468
4469 top:
4470         mutex_enter(&l2arc_buflist_mtx);
4471         for (ab = list_tail(buflist); ab; ab = ab_prev) {
4472                 ab_prev = list_prev(buflist, ab);
4473
4474                 hash_lock = HDR_LOCK(ab);
4475                 if (!mutex_tryenter(hash_lock)) {
4476                         /*
4477                          * Missed the hash lock.  Retry.
4478                          */
4479                         ARCSTAT_BUMP(arcstat_l2_evict_lock_retry);
4480                         mutex_exit(&l2arc_buflist_mtx);
4481                         mutex_enter(hash_lock);
4482                         mutex_exit(hash_lock);
4483                         goto top;
4484                 }
4485
4486                 if (HDR_L2_WRITE_HEAD(ab)) {
4487                         /*
4488                          * We hit a write head node.  Leave it for
4489                          * l2arc_write_done().
4490                          */
4491                         list_remove(buflist, ab);
4492                         mutex_exit(hash_lock);
4493                         continue;
4494                 }
4495
4496                 if (!all && ab->b_l2hdr != NULL &&
4497                     (ab->b_l2hdr->b_daddr > taddr ||
4498                     ab->b_l2hdr->b_daddr < dev->l2ad_hand)) {
4499                         /*
4500                          * We've evicted to the target address,
4501                          * or the end of the device.
4502                          */
4503                         mutex_exit(hash_lock);
4504                         break;
4505                 }
4506
4507                 if (HDR_FREE_IN_PROGRESS(ab)) {
4508                         /*
4509                          * Already on the path to destruction.
4510                          */
4511                         mutex_exit(hash_lock);
4512                         continue;
4513                 }
4514
4515                 if (ab->b_state == arc_l2c_only) {
4516                         ASSERT(!HDR_L2_READING(ab));
4517                         /*
4518                          * This doesn't exist in the ARC.  Destroy.
4519                          * arc_hdr_destroy() will call list_remove()
4520                          * and decrement arcstat_l2_size.
4521                          */
4522                         arc_change_state(arc_anon, ab, hash_lock);
4523                         arc_hdr_destroy(ab);
4524                 } else {
4525                         /*
4526                          * Invalidate issued or about to be issued
4527                          * reads, since we may be about to write
4528                          * over this location.
4529                          */
4530                         if (HDR_L2_READING(ab)) {
4531                                 ARCSTAT_BUMP(arcstat_l2_evict_reading);
4532                                 ab->b_flags |= ARC_L2_EVICTED;
4533                         }
4534
4535                         /*
4536                          * Tell ARC this no longer exists in L2ARC.
4537                          */
4538                         if (ab->b_l2hdr != NULL) {
4539                                 abl2 = ab->b_l2hdr;
4540                                 ab->b_l2hdr = NULL;
4541                                 kmem_free(abl2, sizeof (l2arc_buf_hdr_t));
4542                                 ARCSTAT_INCR(arcstat_l2_size, -ab->b_size);
4543                         }
4544                         list_remove(buflist, ab);
4545
4546                         /*
4547                          * This may have been leftover after a
4548                          * failed write.
4549                          */
4550                         ab->b_flags &= ~ARC_L2_WRITING;
4551                 }
4552                 mutex_exit(hash_lock);
4553         }
4554         mutex_exit(&l2arc_buflist_mtx);
4555
4556         vdev_space_update(dev->l2ad_vdev, -(taddr - dev->l2ad_evict), 0, 0);
4557         dev->l2ad_evict = taddr;
4558 }
4559
4560 /*
4561  * Find and write ARC buffers to the L2ARC device.
4562  *
4563  * An ARC_L2_WRITING flag is set so that the L2ARC buffers are not valid
4564  * for reading until they have completed writing.
4565  */
4566 static uint64_t
4567 l2arc_write_buffers(spa_t *spa, l2arc_dev_t *dev, uint64_t target_sz)
4568 {
4569         arc_buf_hdr_t *ab, *ab_prev, *head;
4570         l2arc_buf_hdr_t *hdrl2;
4571         list_t *list;
4572         uint64_t passed_sz, write_sz, buf_sz, headroom;
4573         void *buf_data;
4574         kmutex_t *hash_lock, *list_lock = NULL;
4575         boolean_t have_lock, full;
4576         l2arc_write_callback_t *cb;
4577         zio_t *pio, *wzio;
4578         uint64_t guid = spa_load_guid(spa);
4579         int try;
4580
4581         ASSERT(dev->l2ad_vdev != NULL);
4582
4583         pio = NULL;
4584         write_sz = 0;
4585         full = B_FALSE;
4586         head = kmem_cache_alloc(hdr_cache, KM_PUSHPAGE);
4587         head->b_flags |= ARC_L2_WRITE_HEAD;
4588
4589         /*
4590          * Copy buffers for L2ARC writing.
4591          */
4592         mutex_enter(&l2arc_buflist_mtx);
4593         for (try = 0; try <= 3; try++) {
4594                 list = l2arc_list_locked(try, &list_lock);
4595                 passed_sz = 0;
4596
4597                 /*
4598                  * L2ARC fast warmup.
4599                  *
4600                  * Until the ARC is warm and starts to evict, read from the
4601                  * head of the ARC lists rather than the tail.
4602                  */
4603                 headroom = target_sz * l2arc_headroom;
4604                 if (arc_warm == B_FALSE)
4605                         ab = list_head(list);
4606                 else
4607                         ab = list_tail(list);
4608
4609                 for (; ab; ab = ab_prev) {
4610                         if (arc_warm == B_FALSE)
4611                                 ab_prev = list_next(list, ab);
4612                         else
4613                                 ab_prev = list_prev(list, ab);
4614
4615                         hash_lock = HDR_LOCK(ab);
4616                         have_lock = MUTEX_HELD(hash_lock);
4617                         if (!have_lock && !mutex_tryenter(hash_lock)) {
4618                                 /*
4619                                  * Skip this buffer rather than waiting.
4620                                  */
4621                                 continue;
4622                         }
4623
4624                         passed_sz += ab->b_size;
4625                         if (passed_sz > headroom) {
4626                                 /*
4627                                  * Searched too far.
4628                                  */
4629                                 mutex_exit(hash_lock);
4630                                 break;
4631                         }
4632
4633                         if (!l2arc_write_eligible(guid, ab)) {
4634                                 mutex_exit(hash_lock);
4635                                 continue;
4636                         }
4637
4638                         if ((write_sz + ab->b_size) > target_sz) {
4639                                 full = B_TRUE;
4640                                 mutex_exit(hash_lock);
4641                                 break;
4642                         }
4643
4644                         if (pio == NULL) {
4645                                 /*
4646                                  * Insert a dummy header on the buflist so
4647                                  * l2arc_write_done() can find where the
4648                                  * write buffers begin without searching.
4649                                  */
4650                                 list_insert_head(dev->l2ad_buflist, head);
4651
4652                                 cb = kmem_alloc(sizeof (l2arc_write_callback_t),
4653                                                 KM_PUSHPAGE);
4654                                 cb->l2wcb_dev = dev;
4655                                 cb->l2wcb_head = head;
4656                                 pio = zio_root(spa, l2arc_write_done, cb,
4657                                     ZIO_FLAG_CANFAIL);
4658                         }
4659
4660                         /*
4661                          * Create and add a new L2ARC header.
4662                          */
4663                         hdrl2 = kmem_zalloc(sizeof (l2arc_buf_hdr_t),
4664                                             KM_PUSHPAGE);
4665                         hdrl2->b_dev = dev;
4666                         hdrl2->b_daddr = dev->l2ad_hand;
4667
4668                         ab->b_flags |= ARC_L2_WRITING;
4669                         ab->b_l2hdr = hdrl2;
4670                         list_insert_head(dev->l2ad_buflist, ab);
4671                         buf_data = ab->b_buf->b_data;
4672                         buf_sz = ab->b_size;
4673
4674                         /*
4675                          * Compute and store the buffer cksum before
4676                          * writing.  On debug the cksum is verified first.
4677                          */
4678                         arc_cksum_verify(ab->b_buf);
4679                         arc_cksum_compute(ab->b_buf, B_TRUE);
4680
4681                         mutex_exit(hash_lock);
4682
4683                         wzio = zio_write_phys(pio, dev->l2ad_vdev,
4684                             dev->l2ad_hand, buf_sz, buf_data, ZIO_CHECKSUM_OFF,
4685                             NULL, NULL, ZIO_PRIORITY_ASYNC_WRITE,
4686                             ZIO_FLAG_CANFAIL, B_FALSE);
4687
4688                         DTRACE_PROBE2(l2arc__write, vdev_t *, dev->l2ad_vdev,
4689                             zio_t *, wzio);
4690                         (void) zio_nowait(wzio);
4691
4692                         /*
4693                          * Keep the clock hand suitably device-aligned.
4694                          */
4695                         buf_sz = vdev_psize_to_asize(dev->l2ad_vdev, buf_sz);
4696
4697                         write_sz += buf_sz;
4698                         dev->l2ad_hand += buf_sz;
4699                 }
4700
4701                 mutex_exit(list_lock);
4702
4703                 if (full == B_TRUE)
4704                         break;
4705         }
4706         mutex_exit(&l2arc_buflist_mtx);
4707
4708         if (pio == NULL) {
4709                 ASSERT0(write_sz);
4710                 kmem_cache_free(hdr_cache, head);
4711                 return (0);
4712         }
4713
4714         ASSERT3U(write_sz, <=, target_sz);
4715         ARCSTAT_BUMP(arcstat_l2_writes_sent);
4716         ARCSTAT_INCR(arcstat_l2_write_bytes, write_sz);
4717         ARCSTAT_INCR(arcstat_l2_size, write_sz);
4718         vdev_space_update(dev->l2ad_vdev, write_sz, 0, 0);
4719
4720         /*
4721          * Bump device hand to the device start if it is approaching the end.
4722          * l2arc_evict() will already have evicted ahead for this case.
4723          */
4724         if (dev->l2ad_hand >= (dev->l2ad_end - target_sz)) {
4725                 vdev_space_update(dev->l2ad_vdev,
4726                     dev->l2ad_end - dev->l2ad_hand, 0, 0);
4727                 dev->l2ad_hand = dev->l2ad_start;
4728                 dev->l2ad_evict = dev->l2ad_start;
4729                 dev->l2ad_first = B_FALSE;
4730         }
4731
4732         dev->l2ad_writing = B_TRUE;
4733         (void) zio_wait(pio);
4734         dev->l2ad_writing = B_FALSE;
4735
4736         return (write_sz);
4737 }
4738
4739 /*
4740  * This thread feeds the L2ARC at regular intervals.  This is the beating
4741  * heart of the L2ARC.
4742  */
4743 static void
4744 l2arc_feed_thread(void)
4745 {
4746         callb_cpr_t cpr;
4747         l2arc_dev_t *dev;
4748         spa_t *spa;
4749         uint64_t size, wrote;
4750         clock_t begin, next = ddi_get_lbolt();
4751
4752         CALLB_CPR_INIT(&cpr, &l2arc_feed_thr_lock, callb_generic_cpr, FTAG);
4753
4754         mutex_enter(&l2arc_feed_thr_lock);
4755
4756         while (l2arc_thread_exit == 0) {
4757                 CALLB_CPR_SAFE_BEGIN(&cpr);
4758                 (void) cv_timedwait_interruptible(&l2arc_feed_thr_cv,
4759                     &l2arc_feed_thr_lock, next);
4760                 CALLB_CPR_SAFE_END(&cpr, &l2arc_feed_thr_lock);
4761                 next = ddi_get_lbolt() + hz;
4762
4763                 /*
4764                  * Quick check for L2ARC devices.
4765                  */
4766                 mutex_enter(&l2arc_dev_mtx);
4767                 if (l2arc_ndev == 0) {
4768                         mutex_exit(&l2arc_dev_mtx);
4769                         continue;
4770                 }
4771                 mutex_exit(&l2arc_dev_mtx);
4772                 begin = ddi_get_lbolt();
4773
4774                 /*
4775                  * This selects the next l2arc device to write to, and in
4776                  * doing so the next spa to feed from: dev->l2ad_spa.   This
4777                  * will return NULL if there are now no l2arc devices or if
4778                  * they are all faulted.
4779                  *
4780                  * If a device is returned, its spa's config lock is also
4781                  * held to prevent device removal.  l2arc_dev_get_next()
4782                  * will grab and release l2arc_dev_mtx.
4783                  */
4784                 if ((dev = l2arc_dev_get_next()) == NULL)
4785                         continue;
4786
4787                 spa = dev->l2ad_spa;
4788                 ASSERT(spa != NULL);
4789
4790                 /*
4791                  * If the pool is read-only then force the feed thread to
4792                  * sleep a little longer.
4793                  */
4794                 if (!spa_writeable(spa)) {
4795                         next = ddi_get_lbolt() + 5 * l2arc_feed_secs * hz;
4796                         spa_config_exit(spa, SCL_L2ARC, dev);
4797                         continue;
4798                 }
4799
4800                 /*
4801                  * Avoid contributing to memory pressure.
4802                  */
4803                 if (arc_no_grow) {
4804                         ARCSTAT_BUMP(arcstat_l2_abort_lowmem);
4805                         spa_config_exit(spa, SCL_L2ARC, dev);
4806                         continue;
4807                 }
4808
4809                 ARCSTAT_BUMP(arcstat_l2_feeds);
4810
4811                 size = l2arc_write_size(dev);
4812
4813                 /*
4814                  * Evict L2ARC buffers that will be overwritten.
4815                  */
4816                 l2arc_evict(dev, size, B_FALSE);
4817
4818                 /*
4819                  * Write ARC buffers.
4820                  */
4821                 wrote = l2arc_write_buffers(spa, dev, size);
4822
4823                 /*
4824                  * Calculate interval between writes.
4825                  */
4826                 next = l2arc_write_interval(begin, size, wrote);
4827                 spa_config_exit(spa, SCL_L2ARC, dev);
4828         }
4829
4830         l2arc_thread_exit = 0;
4831         cv_broadcast(&l2arc_feed_thr_cv);
4832         CALLB_CPR_EXIT(&cpr);           /* drops l2arc_feed_thr_lock */
4833         thread_exit();
4834 }
4835
4836 boolean_t
4837 l2arc_vdev_present(vdev_t *vd)
4838 {
4839         l2arc_dev_t *dev;
4840
4841         mutex_enter(&l2arc_dev_mtx);
4842         for (dev = list_head(l2arc_dev_list); dev != NULL;
4843             dev = list_next(l2arc_dev_list, dev)) {
4844                 if (dev->l2ad_vdev == vd)
4845                         break;
4846         }
4847         mutex_exit(&l2arc_dev_mtx);
4848
4849         return (dev != NULL);
4850 }
4851
4852 /*
4853  * Add a vdev for use by the L2ARC.  By this point the spa has already
4854  * validated the vdev and opened it.
4855  */
4856 void
4857 l2arc_add_vdev(spa_t *spa, vdev_t *vd)
4858 {
4859         l2arc_dev_t *adddev;
4860
4861         ASSERT(!l2arc_vdev_present(vd));
4862
4863         /*
4864          * Create a new l2arc device entry.
4865          */
4866         adddev = kmem_zalloc(sizeof (l2arc_dev_t), KM_SLEEP);
4867         adddev->l2ad_spa = spa;
4868         adddev->l2ad_vdev = vd;
4869         adddev->l2ad_write = l2arc_write_max;
4870         adddev->l2ad_boost = l2arc_write_boost;
4871         adddev->l2ad_start = VDEV_LABEL_START_SIZE;
4872         adddev->l2ad_end = VDEV_LABEL_START_SIZE + vdev_get_min_asize(vd);
4873         adddev->l2ad_hand = adddev->l2ad_start;
4874         adddev->l2ad_evict = adddev->l2ad_start;
4875         adddev->l2ad_first = B_TRUE;
4876         adddev->l2ad_writing = B_FALSE;
4877         list_link_init(&adddev->l2ad_node);
4878         ASSERT3U(adddev->l2ad_write, >, 0);
4879
4880         /*
4881          * This is a list of all ARC buffers that are still valid on the
4882          * device.
4883          */
4884         adddev->l2ad_buflist = kmem_zalloc(sizeof (list_t), KM_SLEEP);
4885         list_create(adddev->l2ad_buflist, sizeof (arc_buf_hdr_t),
4886             offsetof(arc_buf_hdr_t, b_l2node));
4887
4888         vdev_space_update(vd, 0, 0, adddev->l2ad_end - adddev->l2ad_hand);
4889
4890         /*
4891          * Add device to global list
4892          */
4893         mutex_enter(&l2arc_dev_mtx);
4894         list_insert_head(l2arc_dev_list, adddev);
4895         atomic_inc_64(&l2arc_ndev);
4896         mutex_exit(&l2arc_dev_mtx);
4897 }
4898
4899 /*
4900  * Remove a vdev from the L2ARC.
4901  */
4902 void
4903 l2arc_remove_vdev(vdev_t *vd)
4904 {
4905         l2arc_dev_t *dev, *nextdev, *remdev = NULL;
4906
4907         /*
4908          * Find the device by vdev
4909          */
4910         mutex_enter(&l2arc_dev_mtx);
4911         for (dev = list_head(l2arc_dev_list); dev; dev = nextdev) {
4912                 nextdev = list_next(l2arc_dev_list, dev);
4913                 if (vd == dev->l2ad_vdev) {
4914                         remdev = dev;
4915                         break;
4916                 }
4917         }
4918         ASSERT(remdev != NULL);
4919
4920         /*
4921          * Remove device from global list
4922          */
4923         list_remove(l2arc_dev_list, remdev);
4924         l2arc_dev_last = NULL;          /* may have been invalidated */
4925         atomic_dec_64(&l2arc_ndev);
4926         mutex_exit(&l2arc_dev_mtx);
4927
4928         /*
4929          * Clear all buflists and ARC references.  L2ARC device flush.
4930          */
4931         l2arc_evict(remdev, 0, B_TRUE);
4932         list_destroy(remdev->l2ad_buflist);
4933         kmem_free(remdev->l2ad_buflist, sizeof (list_t));
4934         kmem_free(remdev, sizeof (l2arc_dev_t));
4935 }
4936
4937 void
4938 l2arc_init(void)
4939 {
4940         l2arc_thread_exit = 0;
4941         l2arc_ndev = 0;
4942         l2arc_writes_sent = 0;
4943         l2arc_writes_done = 0;
4944
4945         mutex_init(&l2arc_feed_thr_lock, NULL, MUTEX_DEFAULT, NULL);
4946         cv_init(&l2arc_feed_thr_cv, NULL, CV_DEFAULT, NULL);
4947         mutex_init(&l2arc_dev_mtx, NULL, MUTEX_DEFAULT, NULL);
4948         mutex_init(&l2arc_buflist_mtx, NULL, MUTEX_DEFAULT, NULL);
4949         mutex_init(&l2arc_free_on_write_mtx, NULL, MUTEX_DEFAULT, NULL);
4950
4951         l2arc_dev_list = &L2ARC_dev_list;
4952         l2arc_free_on_write = &L2ARC_free_on_write;
4953         list_create(l2arc_dev_list, sizeof (l2arc_dev_t),
4954             offsetof(l2arc_dev_t, l2ad_node));
4955         list_create(l2arc_free_on_write, sizeof (l2arc_data_free_t),
4956             offsetof(l2arc_data_free_t, l2df_list_node));
4957 }
4958
4959 void
4960 l2arc_fini(void)
4961 {
4962         /*
4963          * This is called from dmu_fini(), which is called from spa_fini();
4964          * Because of this, we can assume that all l2arc devices have
4965          * already been removed when the pools themselves were removed.
4966          */
4967
4968         l2arc_do_free_on_write();
4969
4970         mutex_destroy(&l2arc_feed_thr_lock);
4971         cv_destroy(&l2arc_feed_thr_cv);
4972         mutex_destroy(&l2arc_dev_mtx);
4973         mutex_destroy(&l2arc_buflist_mtx);
4974         mutex_destroy(&l2arc_free_on_write_mtx);
4975
4976         list_destroy(l2arc_dev_list);
4977         list_destroy(l2arc_free_on_write);
4978 }
4979
4980 void
4981 l2arc_start(void)
4982 {
4983         if (!(spa_mode_global & FWRITE))
4984                 return;
4985
4986         (void) thread_create(NULL, 0, l2arc_feed_thread, NULL, 0, &p0,
4987             TS_RUN, minclsyspri);
4988 }
4989
4990 void
4991 l2arc_stop(void)
4992 {
4993         if (!(spa_mode_global & FWRITE))
4994                 return;
4995
4996         mutex_enter(&l2arc_feed_thr_lock);
4997         cv_signal(&l2arc_feed_thr_cv);  /* kick thread out of startup */
4998         l2arc_thread_exit = 1;
4999         while (l2arc_thread_exit != 0)
5000                 cv_wait(&l2arc_feed_thr_cv, &l2arc_feed_thr_lock);
5001         mutex_exit(&l2arc_feed_thr_lock);
5002 }
5003
5004 #if defined(_KERNEL) && defined(HAVE_SPL)
5005 EXPORT_SYMBOL(arc_read);
5006 EXPORT_SYMBOL(arc_buf_remove_ref);
5007 EXPORT_SYMBOL(arc_getbuf_func);
5008 EXPORT_SYMBOL(arc_add_prune_callback);
5009 EXPORT_SYMBOL(arc_remove_prune_callback);
5010
5011 module_param(zfs_arc_min, ulong, 0444);
5012 MODULE_PARM_DESC(zfs_arc_min, "Min arc size");
5013
5014 module_param(zfs_arc_max, ulong, 0444);
5015 MODULE_PARM_DESC(zfs_arc_max, "Max arc size");
5016
5017 module_param(zfs_arc_meta_limit, ulong, 0444);
5018 MODULE_PARM_DESC(zfs_arc_meta_limit, "Meta limit for arc size");
5019
5020 module_param(zfs_arc_meta_prune, int, 0444);
5021 MODULE_PARM_DESC(zfs_arc_meta_prune, "Bytes of meta data to prune");
5022
5023 module_param(zfs_arc_grow_retry, int, 0444);
5024 MODULE_PARM_DESC(zfs_arc_grow_retry, "Seconds before growing arc size");
5025
5026 module_param(zfs_arc_shrink_shift, int, 0444);
5027 MODULE_PARM_DESC(zfs_arc_shrink_shift, "log2(fraction of arc to reclaim)");
5028
5029 module_param(zfs_arc_p_min_shift, int, 0444);
5030 MODULE_PARM_DESC(zfs_arc_p_min_shift, "arc_c shift to calc min/max arc_p");
5031
5032 module_param(zfs_disable_dup_eviction, int, 0644);
5033 MODULE_PARM_DESC(zfs_disable_dup_eviction, "disable duplicate buffer eviction");
5034
5035 module_param(zfs_arc_memory_throttle_disable, int, 0644);
5036 MODULE_PARM_DESC(zfs_arc_memory_throttle_disable, "disable memory throttle");
5037
5038 module_param(l2arc_write_max, ulong, 0444);
5039 MODULE_PARM_DESC(l2arc_write_max, "Max write bytes per interval");
5040
5041 module_param(l2arc_write_boost, ulong, 0444);
5042 MODULE_PARM_DESC(l2arc_write_boost, "Extra write bytes during device warmup");
5043
5044 module_param(l2arc_headroom, ulong, 0444);
5045 MODULE_PARM_DESC(l2arc_headroom, "Number of max device writes to precache");
5046
5047 module_param(l2arc_feed_secs, ulong, 0444);
5048 MODULE_PARM_DESC(l2arc_feed_secs, "Seconds between L2ARC writing");
5049
5050 module_param(l2arc_feed_min_ms, ulong, 0444);
5051 MODULE_PARM_DESC(l2arc_feed_min_ms, "Min feed interval in milliseconds");
5052
5053 module_param(l2arc_noprefetch, int, 0444);
5054 MODULE_PARM_DESC(l2arc_noprefetch, "Skip caching prefetched buffers");
5055
5056 module_param(l2arc_feed_again, int, 0444);
5057 MODULE_PARM_DESC(l2arc_feed_again, "Turbo L2ARC warmup");
5058
5059 module_param(l2arc_norw, int, 0444);
5060 MODULE_PARM_DESC(l2arc_norw, "No reads during writes");
5061
5062 #endif