Add zfs_disable_dup_eviction module option
[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_disable_dup_eviction = 0;
193 int zfs_arc_meta_prune = 0;
194
195 /*
196  * Note that buffers can be in one of 6 states:
197  *      ARC_anon        - anonymous (discussed below)
198  *      ARC_mru         - recently used, currently cached
199  *      ARC_mru_ghost   - recentely used, no longer in cache
200  *      ARC_mfu         - frequently used, currently cached
201  *      ARC_mfu_ghost   - frequently used, no longer in cache
202  *      ARC_l2c_only    - exists in L2ARC but not other states
203  * When there are no active references to the buffer, they are
204  * are linked onto a list in one of these arc states.  These are
205  * the only buffers that can be evicted or deleted.  Within each
206  * state there are multiple lists, one for meta-data and one for
207  * non-meta-data.  Meta-data (indirect blocks, blocks of dnodes,
208  * etc.) is tracked separately so that it can be managed more
209  * explicitly: favored over data, limited explicitly.
210  *
211  * Anonymous buffers are buffers that are not associated with
212  * a DVA.  These are buffers that hold dirty block copies
213  * before they are written to stable storage.  By definition,
214  * they are "ref'd" and are considered part of arc_mru
215  * that cannot be freed.  Generally, they will aquire a DVA
216  * as they are written and migrate onto the arc_mru list.
217  *
218  * The ARC_l2c_only state is for buffers that are in the second
219  * level ARC but no longer in any of the ARC_m* lists.  The second
220  * level ARC itself may also contain buffers that are in any of
221  * the ARC_m* states - meaning that a buffer can exist in two
222  * places.  The reason for the ARC_l2c_only state is to keep the
223  * buffer header in the hash table, so that reads that hit the
224  * second level ARC benefit from these fast lookups.
225  */
226
227 typedef struct arc_state {
228         list_t  arcs_list[ARC_BUFC_NUMTYPES];   /* list of evictable buffers */
229         uint64_t arcs_lsize[ARC_BUFC_NUMTYPES]; /* amount of evictable data */
230         uint64_t arcs_size;     /* total amount of data in this state */
231         kmutex_t arcs_mtx;
232 } arc_state_t;
233
234 /* The 6 states: */
235 static arc_state_t ARC_anon;
236 static arc_state_t ARC_mru;
237 static arc_state_t ARC_mru_ghost;
238 static arc_state_t ARC_mfu;
239 static arc_state_t ARC_mfu_ghost;
240 static arc_state_t ARC_l2c_only;
241
242 typedef struct arc_stats {
243         kstat_named_t arcstat_hits;
244         kstat_named_t arcstat_misses;
245         kstat_named_t arcstat_demand_data_hits;
246         kstat_named_t arcstat_demand_data_misses;
247         kstat_named_t arcstat_demand_metadata_hits;
248         kstat_named_t arcstat_demand_metadata_misses;
249         kstat_named_t arcstat_prefetch_data_hits;
250         kstat_named_t arcstat_prefetch_data_misses;
251         kstat_named_t arcstat_prefetch_metadata_hits;
252         kstat_named_t arcstat_prefetch_metadata_misses;
253         kstat_named_t arcstat_mru_hits;
254         kstat_named_t arcstat_mru_ghost_hits;
255         kstat_named_t arcstat_mfu_hits;
256         kstat_named_t arcstat_mfu_ghost_hits;
257         kstat_named_t arcstat_deleted;
258         kstat_named_t arcstat_recycle_miss;
259         kstat_named_t arcstat_mutex_miss;
260         kstat_named_t arcstat_evict_skip;
261         kstat_named_t arcstat_evict_l2_cached;
262         kstat_named_t arcstat_evict_l2_eligible;
263         kstat_named_t arcstat_evict_l2_ineligible;
264         kstat_named_t arcstat_hash_elements;
265         kstat_named_t arcstat_hash_elements_max;
266         kstat_named_t arcstat_hash_collisions;
267         kstat_named_t arcstat_hash_chains;
268         kstat_named_t arcstat_hash_chain_max;
269         kstat_named_t arcstat_p;
270         kstat_named_t arcstat_c;
271         kstat_named_t arcstat_c_min;
272         kstat_named_t arcstat_c_max;
273         kstat_named_t arcstat_size;
274         kstat_named_t arcstat_hdr_size;
275         kstat_named_t arcstat_data_size;
276         kstat_named_t arcstat_other_size;
277         kstat_named_t arcstat_anon_size;
278         kstat_named_t arcstat_anon_evict_data;
279         kstat_named_t arcstat_anon_evict_metadata;
280         kstat_named_t arcstat_mru_size;
281         kstat_named_t arcstat_mru_evict_data;
282         kstat_named_t arcstat_mru_evict_metadata;
283         kstat_named_t arcstat_mru_ghost_size;
284         kstat_named_t arcstat_mru_ghost_evict_data;
285         kstat_named_t arcstat_mru_ghost_evict_metadata;
286         kstat_named_t arcstat_mfu_size;
287         kstat_named_t arcstat_mfu_evict_data;
288         kstat_named_t arcstat_mfu_evict_metadata;
289         kstat_named_t arcstat_mfu_ghost_size;
290         kstat_named_t arcstat_mfu_ghost_evict_data;
291         kstat_named_t arcstat_mfu_ghost_evict_metadata;
292         kstat_named_t arcstat_l2_hits;
293         kstat_named_t arcstat_l2_misses;
294         kstat_named_t arcstat_l2_feeds;
295         kstat_named_t arcstat_l2_rw_clash;
296         kstat_named_t arcstat_l2_read_bytes;
297         kstat_named_t arcstat_l2_write_bytes;
298         kstat_named_t arcstat_l2_writes_sent;
299         kstat_named_t arcstat_l2_writes_done;
300         kstat_named_t arcstat_l2_writes_error;
301         kstat_named_t arcstat_l2_writes_hdr_miss;
302         kstat_named_t arcstat_l2_evict_lock_retry;
303         kstat_named_t arcstat_l2_evict_reading;
304         kstat_named_t arcstat_l2_free_on_write;
305         kstat_named_t arcstat_l2_abort_lowmem;
306         kstat_named_t arcstat_l2_cksum_bad;
307         kstat_named_t arcstat_l2_io_error;
308         kstat_named_t arcstat_l2_size;
309         kstat_named_t arcstat_l2_hdr_size;
310         kstat_named_t arcstat_memory_throttle_count;
311         kstat_named_t arcstat_duplicate_buffers;
312         kstat_named_t arcstat_duplicate_buffers_size;
313         kstat_named_t arcstat_duplicate_reads;
314         kstat_named_t arcstat_memory_direct_count;
315         kstat_named_t arcstat_memory_indirect_count;
316         kstat_named_t arcstat_no_grow;
317         kstat_named_t arcstat_tempreserve;
318         kstat_named_t arcstat_loaned_bytes;
319         kstat_named_t arcstat_prune;
320         kstat_named_t arcstat_meta_used;
321         kstat_named_t arcstat_meta_limit;
322         kstat_named_t arcstat_meta_max;
323 } arc_stats_t;
324
325 static arc_stats_t arc_stats = {
326         { "hits",                       KSTAT_DATA_UINT64 },
327         { "misses",                     KSTAT_DATA_UINT64 },
328         { "demand_data_hits",           KSTAT_DATA_UINT64 },
329         { "demand_data_misses",         KSTAT_DATA_UINT64 },
330         { "demand_metadata_hits",       KSTAT_DATA_UINT64 },
331         { "demand_metadata_misses",     KSTAT_DATA_UINT64 },
332         { "prefetch_data_hits",         KSTAT_DATA_UINT64 },
333         { "prefetch_data_misses",       KSTAT_DATA_UINT64 },
334         { "prefetch_metadata_hits",     KSTAT_DATA_UINT64 },
335         { "prefetch_metadata_misses",   KSTAT_DATA_UINT64 },
336         { "mru_hits",                   KSTAT_DATA_UINT64 },
337         { "mru_ghost_hits",             KSTAT_DATA_UINT64 },
338         { "mfu_hits",                   KSTAT_DATA_UINT64 },
339         { "mfu_ghost_hits",             KSTAT_DATA_UINT64 },
340         { "deleted",                    KSTAT_DATA_UINT64 },
341         { "recycle_miss",               KSTAT_DATA_UINT64 },
342         { "mutex_miss",                 KSTAT_DATA_UINT64 },
343         { "evict_skip",                 KSTAT_DATA_UINT64 },
344         { "evict_l2_cached",            KSTAT_DATA_UINT64 },
345         { "evict_l2_eligible",          KSTAT_DATA_UINT64 },
346         { "evict_l2_ineligible",        KSTAT_DATA_UINT64 },
347         { "hash_elements",              KSTAT_DATA_UINT64 },
348         { "hash_elements_max",          KSTAT_DATA_UINT64 },
349         { "hash_collisions",            KSTAT_DATA_UINT64 },
350         { "hash_chains",                KSTAT_DATA_UINT64 },
351         { "hash_chain_max",             KSTAT_DATA_UINT64 },
352         { "p",                          KSTAT_DATA_UINT64 },
353         { "c",                          KSTAT_DATA_UINT64 },
354         { "c_min",                      KSTAT_DATA_UINT64 },
355         { "c_max",                      KSTAT_DATA_UINT64 },
356         { "size",                       KSTAT_DATA_UINT64 },
357         { "hdr_size",                   KSTAT_DATA_UINT64 },
358         { "data_size",                  KSTAT_DATA_UINT64 },
359         { "other_size",                 KSTAT_DATA_UINT64 },
360         { "anon_size",                  KSTAT_DATA_UINT64 },
361         { "anon_evict_data",            KSTAT_DATA_UINT64 },
362         { "anon_evict_metadata",        KSTAT_DATA_UINT64 },
363         { "mru_size",                   KSTAT_DATA_UINT64 },
364         { "mru_evict_data",             KSTAT_DATA_UINT64 },
365         { "mru_evict_metadata",         KSTAT_DATA_UINT64 },
366         { "mru_ghost_size",             KSTAT_DATA_UINT64 },
367         { "mru_ghost_evict_data",       KSTAT_DATA_UINT64 },
368         { "mru_ghost_evict_metadata",   KSTAT_DATA_UINT64 },
369         { "mfu_size",                   KSTAT_DATA_UINT64 },
370         { "mfu_evict_data",             KSTAT_DATA_UINT64 },
371         { "mfu_evict_metadata",         KSTAT_DATA_UINT64 },
372         { "mfu_ghost_size",             KSTAT_DATA_UINT64 },
373         { "mfu_ghost_evict_data",       KSTAT_DATA_UINT64 },
374         { "mfu_ghost_evict_metadata",   KSTAT_DATA_UINT64 },
375         { "l2_hits",                    KSTAT_DATA_UINT64 },
376         { "l2_misses",                  KSTAT_DATA_UINT64 },
377         { "l2_feeds",                   KSTAT_DATA_UINT64 },
378         { "l2_rw_clash",                KSTAT_DATA_UINT64 },
379         { "l2_read_bytes",              KSTAT_DATA_UINT64 },
380         { "l2_write_bytes",             KSTAT_DATA_UINT64 },
381         { "l2_writes_sent",             KSTAT_DATA_UINT64 },
382         { "l2_writes_done",             KSTAT_DATA_UINT64 },
383         { "l2_writes_error",            KSTAT_DATA_UINT64 },
384         { "l2_writes_hdr_miss",         KSTAT_DATA_UINT64 },
385         { "l2_evict_lock_retry",        KSTAT_DATA_UINT64 },
386         { "l2_evict_reading",           KSTAT_DATA_UINT64 },
387         { "l2_free_on_write",           KSTAT_DATA_UINT64 },
388         { "l2_abort_lowmem",            KSTAT_DATA_UINT64 },
389         { "l2_cksum_bad",               KSTAT_DATA_UINT64 },
390         { "l2_io_error",                KSTAT_DATA_UINT64 },
391         { "l2_size",                    KSTAT_DATA_UINT64 },
392         { "l2_hdr_size",                KSTAT_DATA_UINT64 },
393         { "memory_throttle_count",      KSTAT_DATA_UINT64 },
394         { "duplicate_buffers",          KSTAT_DATA_UINT64 },
395         { "duplicate_buffers_size",     KSTAT_DATA_UINT64 },
396         { "duplicate_reads",            KSTAT_DATA_UINT64 },
397         { "memory_direct_count",        KSTAT_DATA_UINT64 },
398         { "memory_indirect_count",      KSTAT_DATA_UINT64 },
399         { "arc_no_grow",                KSTAT_DATA_UINT64 },
400         { "arc_tempreserve",            KSTAT_DATA_UINT64 },
401         { "arc_loaned_bytes",           KSTAT_DATA_UINT64 },
402         { "arc_prune",                  KSTAT_DATA_UINT64 },
403         { "arc_meta_used",              KSTAT_DATA_UINT64 },
404         { "arc_meta_limit",             KSTAT_DATA_UINT64 },
405         { "arc_meta_max",               KSTAT_DATA_UINT64 },
406 };
407
408 #define ARCSTAT(stat)   (arc_stats.stat.value.ui64)
409
410 #define ARCSTAT_INCR(stat, val) \
411         atomic_add_64(&arc_stats.stat.value.ui64, (val));
412
413 #define ARCSTAT_BUMP(stat)      ARCSTAT_INCR(stat, 1)
414 #define ARCSTAT_BUMPDOWN(stat)  ARCSTAT_INCR(stat, -1)
415
416 #define ARCSTAT_MAX(stat, val) {                                        \
417         uint64_t m;                                                     \
418         while ((val) > (m = arc_stats.stat.value.ui64) &&               \
419             (m != atomic_cas_64(&arc_stats.stat.value.ui64, m, (val)))) \
420                 continue;                                               \
421 }
422
423 #define ARCSTAT_MAXSTAT(stat) \
424         ARCSTAT_MAX(stat##_max, arc_stats.stat.value.ui64)
425
426 /*
427  * We define a macro to allow ARC hits/misses to be easily broken down by
428  * two separate conditions, giving a total of four different subtypes for
429  * each of hits and misses (so eight statistics total).
430  */
431 #define ARCSTAT_CONDSTAT(cond1, stat1, notstat1, cond2, stat2, notstat2, stat) \
432         if (cond1) {                                                    \
433                 if (cond2) {                                            \
434                         ARCSTAT_BUMP(arcstat_##stat1##_##stat2##_##stat); \
435                 } else {                                                \
436                         ARCSTAT_BUMP(arcstat_##stat1##_##notstat2##_##stat); \
437                 }                                                       \
438         } else {                                                        \
439                 if (cond2) {                                            \
440                         ARCSTAT_BUMP(arcstat_##notstat1##_##stat2##_##stat); \
441                 } else {                                                \
442                         ARCSTAT_BUMP(arcstat_##notstat1##_##notstat2##_##stat);\
443                 }                                                       \
444         }
445
446 kstat_t                 *arc_ksp;
447 static arc_state_t      *arc_anon;
448 static arc_state_t      *arc_mru;
449 static arc_state_t      *arc_mru_ghost;
450 static arc_state_t      *arc_mfu;
451 static arc_state_t      *arc_mfu_ghost;
452 static arc_state_t      *arc_l2c_only;
453
454 /*
455  * There are several ARC variables that are critical to export as kstats --
456  * but we don't want to have to grovel around in the kstat whenever we wish to
457  * manipulate them.  For these variables, we therefore define them to be in
458  * terms of the statistic variable.  This assures that we are not introducing
459  * the possibility of inconsistency by having shadow copies of the variables,
460  * while still allowing the code to be readable.
461  */
462 #define arc_size        ARCSTAT(arcstat_size)   /* actual total arc size */
463 #define arc_p           ARCSTAT(arcstat_p)      /* target size of MRU */
464 #define arc_c           ARCSTAT(arcstat_c)      /* target size of cache */
465 #define arc_c_min       ARCSTAT(arcstat_c_min)  /* min target cache size */
466 #define arc_c_max       ARCSTAT(arcstat_c_max)  /* max target cache size */
467 #define arc_no_grow     ARCSTAT(arcstat_no_grow)
468 #define arc_tempreserve ARCSTAT(arcstat_tempreserve)
469 #define arc_loaned_bytes        ARCSTAT(arcstat_loaned_bytes)
470 #define arc_meta_used   ARCSTAT(arcstat_meta_used)
471 #define arc_meta_limit  ARCSTAT(arcstat_meta_limit)
472 #define arc_meta_max    ARCSTAT(arcstat_meta_max)
473
474 typedef struct l2arc_buf_hdr l2arc_buf_hdr_t;
475
476 typedef struct arc_callback arc_callback_t;
477
478 struct arc_callback {
479         void                    *acb_private;
480         arc_done_func_t         *acb_done;
481         arc_buf_t               *acb_buf;
482         zio_t                   *acb_zio_dummy;
483         arc_callback_t          *acb_next;
484 };
485
486 typedef struct arc_write_callback arc_write_callback_t;
487
488 struct arc_write_callback {
489         void            *awcb_private;
490         arc_done_func_t *awcb_ready;
491         arc_done_func_t *awcb_done;
492         arc_buf_t       *awcb_buf;
493 };
494
495 struct arc_buf_hdr {
496         /* protected by hash lock */
497         dva_t                   b_dva;
498         uint64_t                b_birth;
499         uint64_t                b_cksum0;
500
501         kmutex_t                b_freeze_lock;
502         zio_cksum_t             *b_freeze_cksum;
503         void                    *b_thawed;
504
505         arc_buf_hdr_t           *b_hash_next;
506         arc_buf_t               *b_buf;
507         uint32_t                b_flags;
508         uint32_t                b_datacnt;
509
510         arc_callback_t          *b_acb;
511         kcondvar_t              b_cv;
512
513         /* immutable */
514         arc_buf_contents_t      b_type;
515         uint64_t                b_size;
516         uint64_t                b_spa;
517
518         /* protected by arc state mutex */
519         arc_state_t             *b_state;
520         list_node_t             b_arc_node;
521
522         /* updated atomically */
523         clock_t                 b_arc_access;
524
525         /* self protecting */
526         refcount_t              b_refcnt;
527
528         l2arc_buf_hdr_t         *b_l2hdr;
529         list_node_t             b_l2node;
530 };
531
532 static list_t arc_prune_list;
533 static kmutex_t arc_prune_mtx;
534 static arc_buf_t *arc_eviction_list;
535 static kmutex_t arc_eviction_mtx;
536 static arc_buf_hdr_t arc_eviction_hdr;
537 static void arc_get_data_buf(arc_buf_t *buf);
538 static void arc_access(arc_buf_hdr_t *buf, kmutex_t *hash_lock);
539 static int arc_evict_needed(arc_buf_contents_t type);
540 static void arc_evict_ghost(arc_state_t *state, uint64_t spa, int64_t bytes);
541
542 static boolean_t l2arc_write_eligible(uint64_t spa_guid, arc_buf_hdr_t *ab);
543
544 #define GHOST_STATE(state)      \
545         ((state) == arc_mru_ghost || (state) == arc_mfu_ghost ||        \
546         (state) == arc_l2c_only)
547
548 /*
549  * Private ARC flags.  These flags are private ARC only flags that will show up
550  * in b_flags in the arc_hdr_buf_t.  Some flags are publicly declared, and can
551  * be passed in as arc_flags in things like arc_read.  However, these flags
552  * should never be passed and should only be set by ARC code.  When adding new
553  * public flags, make sure not to smash the private ones.
554  */
555
556 #define ARC_IN_HASH_TABLE       (1 << 9)        /* this buffer is hashed */
557 #define ARC_IO_IN_PROGRESS      (1 << 10)       /* I/O in progress for buf */
558 #define ARC_IO_ERROR            (1 << 11)       /* I/O failed for buf */
559 #define ARC_FREED_IN_READ       (1 << 12)       /* buf freed while in read */
560 #define ARC_BUF_AVAILABLE       (1 << 13)       /* block not in active use */
561 #define ARC_INDIRECT            (1 << 14)       /* this is an indirect block */
562 #define ARC_FREE_IN_PROGRESS    (1 << 15)       /* hdr about to be freed */
563 #define ARC_L2_WRITING          (1 << 16)       /* L2ARC write in progress */
564 #define ARC_L2_EVICTED          (1 << 17)       /* evicted during I/O */
565 #define ARC_L2_WRITE_HEAD       (1 << 18)       /* head of write list */
566
567 #define HDR_IN_HASH_TABLE(hdr)  ((hdr)->b_flags & ARC_IN_HASH_TABLE)
568 #define HDR_IO_IN_PROGRESS(hdr) ((hdr)->b_flags & ARC_IO_IN_PROGRESS)
569 #define HDR_IO_ERROR(hdr)       ((hdr)->b_flags & ARC_IO_ERROR)
570 #define HDR_PREFETCH(hdr)       ((hdr)->b_flags & ARC_PREFETCH)
571 #define HDR_FREED_IN_READ(hdr)  ((hdr)->b_flags & ARC_FREED_IN_READ)
572 #define HDR_BUF_AVAILABLE(hdr)  ((hdr)->b_flags & ARC_BUF_AVAILABLE)
573 #define HDR_FREE_IN_PROGRESS(hdr)       ((hdr)->b_flags & ARC_FREE_IN_PROGRESS)
574 #define HDR_L2CACHE(hdr)        ((hdr)->b_flags & ARC_L2CACHE)
575 #define HDR_L2_READING(hdr)     ((hdr)->b_flags & ARC_IO_IN_PROGRESS && \
576                                     (hdr)->b_l2hdr != NULL)
577 #define HDR_L2_WRITING(hdr)     ((hdr)->b_flags & ARC_L2_WRITING)
578 #define HDR_L2_EVICTED(hdr)     ((hdr)->b_flags & ARC_L2_EVICTED)
579 #define HDR_L2_WRITE_HEAD(hdr)  ((hdr)->b_flags & ARC_L2_WRITE_HEAD)
580
581 /*
582  * Other sizes
583  */
584
585 #define HDR_SIZE ((int64_t)sizeof (arc_buf_hdr_t))
586 #define L2HDR_SIZE ((int64_t)sizeof (l2arc_buf_hdr_t))
587
588 /*
589  * Hash table routines
590  */
591
592 #define HT_LOCK_ALIGN   64
593 #define HT_LOCK_PAD     (P2NPHASE(sizeof (kmutex_t), (HT_LOCK_ALIGN)))
594
595 struct ht_lock {
596         kmutex_t        ht_lock;
597 #ifdef _KERNEL
598         unsigned char   pad[HT_LOCK_PAD];
599 #endif
600 };
601
602 #define BUF_LOCKS 256
603 typedef struct buf_hash_table {
604         uint64_t ht_mask;
605         arc_buf_hdr_t **ht_table;
606         struct ht_lock ht_locks[BUF_LOCKS];
607 } buf_hash_table_t;
608
609 static buf_hash_table_t buf_hash_table;
610
611 #define BUF_HASH_INDEX(spa, dva, birth) \
612         (buf_hash(spa, dva, birth) & buf_hash_table.ht_mask)
613 #define BUF_HASH_LOCK_NTRY(idx) (buf_hash_table.ht_locks[idx & (BUF_LOCKS-1)])
614 #define BUF_HASH_LOCK(idx)      (&(BUF_HASH_LOCK_NTRY(idx).ht_lock))
615 #define HDR_LOCK(hdr) \
616         (BUF_HASH_LOCK(BUF_HASH_INDEX(hdr->b_spa, &hdr->b_dva, hdr->b_birth)))
617
618 uint64_t zfs_crc64_table[256];
619
620 /*
621  * Level 2 ARC
622  */
623
624 #define L2ARC_WRITE_SIZE        (8 * 1024 * 1024)       /* initial write max */
625 #define L2ARC_HEADROOM          2               /* num of writes */
626 #define L2ARC_FEED_SECS         1               /* caching interval secs */
627 #define L2ARC_FEED_MIN_MS       200             /* min caching interval ms */
628
629 #define l2arc_writes_sent       ARCSTAT(arcstat_l2_writes_sent)
630 #define l2arc_writes_done       ARCSTAT(arcstat_l2_writes_done)
631
632 /*
633  * L2ARC Performance Tunables
634  */
635 unsigned long l2arc_write_max = L2ARC_WRITE_SIZE;       /* def max write size */
636 unsigned long l2arc_write_boost = L2ARC_WRITE_SIZE;     /* extra warmup write */
637 unsigned long l2arc_headroom = L2ARC_HEADROOM;          /* # of dev writes */
638 unsigned long l2arc_feed_secs = L2ARC_FEED_SECS;        /* interval seconds */
639 unsigned long l2arc_feed_min_ms = L2ARC_FEED_MIN_MS;    /* min interval msecs */
640 int l2arc_noprefetch = B_TRUE;                  /* don't cache prefetch bufs */
641 int l2arc_feed_again = B_TRUE;                  /* turbo warmup */
642 int l2arc_norw = B_TRUE;                        /* no reads during writes */
643
644 /*
645  * L2ARC Internals
646  */
647 typedef struct l2arc_dev {
648         vdev_t                  *l2ad_vdev;     /* vdev */
649         spa_t                   *l2ad_spa;      /* spa */
650         uint64_t                l2ad_hand;      /* next write location */
651         uint64_t                l2ad_write;     /* desired write size, bytes */
652         uint64_t                l2ad_boost;     /* warmup write boost, bytes */
653         uint64_t                l2ad_start;     /* first addr on device */
654         uint64_t                l2ad_end;       /* last addr on device */
655         uint64_t                l2ad_evict;     /* last addr eviction reached */
656         boolean_t               l2ad_first;     /* first sweep through */
657         boolean_t               l2ad_writing;   /* currently writing */
658         list_t                  *l2ad_buflist;  /* buffer list */
659         list_node_t             l2ad_node;      /* device list node */
660 } l2arc_dev_t;
661
662 static list_t L2ARC_dev_list;                   /* device list */
663 static list_t *l2arc_dev_list;                  /* device list pointer */
664 static kmutex_t l2arc_dev_mtx;                  /* device list mutex */
665 static l2arc_dev_t *l2arc_dev_last;             /* last device used */
666 static kmutex_t l2arc_buflist_mtx;              /* mutex for all buflists */
667 static list_t L2ARC_free_on_write;              /* free after write buf list */
668 static list_t *l2arc_free_on_write;             /* free after write list ptr */
669 static kmutex_t l2arc_free_on_write_mtx;        /* mutex for list */
670 static uint64_t l2arc_ndev;                     /* number of devices */
671
672 typedef struct l2arc_read_callback {
673         arc_buf_t       *l2rcb_buf;             /* read buffer */
674         spa_t           *l2rcb_spa;             /* spa */
675         blkptr_t        l2rcb_bp;               /* original blkptr */
676         zbookmark_t     l2rcb_zb;               /* original bookmark */
677         int             l2rcb_flags;            /* original flags */
678 } l2arc_read_callback_t;
679
680 typedef struct l2arc_write_callback {
681         l2arc_dev_t     *l2wcb_dev;             /* device info */
682         arc_buf_hdr_t   *l2wcb_head;            /* head of write buflist */
683 } l2arc_write_callback_t;
684
685 struct l2arc_buf_hdr {
686         /* protected by arc_buf_hdr  mutex */
687         l2arc_dev_t     *b_dev;                 /* L2ARC device */
688         uint64_t        b_daddr;                /* disk address, offset byte */
689 };
690
691 typedef struct l2arc_data_free {
692         /* protected by l2arc_free_on_write_mtx */
693         void            *l2df_data;
694         size_t          l2df_size;
695         void            (*l2df_func)(void *, size_t);
696         list_node_t     l2df_list_node;
697 } l2arc_data_free_t;
698
699 static kmutex_t l2arc_feed_thr_lock;
700 static kcondvar_t l2arc_feed_thr_cv;
701 static uint8_t l2arc_thread_exit;
702
703 static void l2arc_read_done(zio_t *zio);
704 static void l2arc_hdr_stat_add(void);
705 static void l2arc_hdr_stat_remove(void);
706
707 static uint64_t
708 buf_hash(uint64_t spa, const dva_t *dva, uint64_t birth)
709 {
710         uint8_t *vdva = (uint8_t *)dva;
711         uint64_t crc = -1ULL;
712         int i;
713
714         ASSERT(zfs_crc64_table[128] == ZFS_CRC64_POLY);
715
716         for (i = 0; i < sizeof (dva_t); i++)
717                 crc = (crc >> 8) ^ zfs_crc64_table[(crc ^ vdva[i]) & 0xFF];
718
719         crc ^= (spa>>8) ^ birth;
720
721         return (crc);
722 }
723
724 #define BUF_EMPTY(buf)                                          \
725         ((buf)->b_dva.dva_word[0] == 0 &&                       \
726         (buf)->b_dva.dva_word[1] == 0 &&                        \
727         (buf)->b_birth == 0)
728
729 #define BUF_EQUAL(spa, dva, birth, buf)                         \
730         ((buf)->b_dva.dva_word[0] == (dva)->dva_word[0]) &&     \
731         ((buf)->b_dva.dva_word[1] == (dva)->dva_word[1]) &&     \
732         ((buf)->b_birth == birth) && ((buf)->b_spa == spa)
733
734 static void
735 buf_discard_identity(arc_buf_hdr_t *hdr)
736 {
737         hdr->b_dva.dva_word[0] = 0;
738         hdr->b_dva.dva_word[1] = 0;
739         hdr->b_birth = 0;
740         hdr->b_cksum0 = 0;
741 }
742
743 static arc_buf_hdr_t *
744 buf_hash_find(uint64_t spa, const dva_t *dva, uint64_t birth, kmutex_t **lockp)
745 {
746         uint64_t idx = BUF_HASH_INDEX(spa, dva, birth);
747         kmutex_t *hash_lock = BUF_HASH_LOCK(idx);
748         arc_buf_hdr_t *buf;
749
750         mutex_enter(hash_lock);
751         for (buf = buf_hash_table.ht_table[idx]; buf != NULL;
752             buf = buf->b_hash_next) {
753                 if (BUF_EQUAL(spa, dva, birth, buf)) {
754                         *lockp = hash_lock;
755                         return (buf);
756                 }
757         }
758         mutex_exit(hash_lock);
759         *lockp = NULL;
760         return (NULL);
761 }
762
763 /*
764  * Insert an entry into the hash table.  If there is already an element
765  * equal to elem in the hash table, then the already existing element
766  * will be returned and the new element will not be inserted.
767  * Otherwise returns NULL.
768  */
769 static arc_buf_hdr_t *
770 buf_hash_insert(arc_buf_hdr_t *buf, kmutex_t **lockp)
771 {
772         uint64_t idx = BUF_HASH_INDEX(buf->b_spa, &buf->b_dva, buf->b_birth);
773         kmutex_t *hash_lock = BUF_HASH_LOCK(idx);
774         arc_buf_hdr_t *fbuf;
775         uint32_t i;
776
777         ASSERT(!HDR_IN_HASH_TABLE(buf));
778         *lockp = hash_lock;
779         mutex_enter(hash_lock);
780         for (fbuf = buf_hash_table.ht_table[idx], i = 0; fbuf != NULL;
781             fbuf = fbuf->b_hash_next, i++) {
782                 if (BUF_EQUAL(buf->b_spa, &buf->b_dva, buf->b_birth, fbuf))
783                         return (fbuf);
784         }
785
786         buf->b_hash_next = buf_hash_table.ht_table[idx];
787         buf_hash_table.ht_table[idx] = buf;
788         buf->b_flags |= ARC_IN_HASH_TABLE;
789
790         /* collect some hash table performance data */
791         if (i > 0) {
792                 ARCSTAT_BUMP(arcstat_hash_collisions);
793                 if (i == 1)
794                         ARCSTAT_BUMP(arcstat_hash_chains);
795
796                 ARCSTAT_MAX(arcstat_hash_chain_max, i);
797         }
798
799         ARCSTAT_BUMP(arcstat_hash_elements);
800         ARCSTAT_MAXSTAT(arcstat_hash_elements);
801
802         return (NULL);
803 }
804
805 static void
806 buf_hash_remove(arc_buf_hdr_t *buf)
807 {
808         arc_buf_hdr_t *fbuf, **bufp;
809         uint64_t idx = BUF_HASH_INDEX(buf->b_spa, &buf->b_dva, buf->b_birth);
810
811         ASSERT(MUTEX_HELD(BUF_HASH_LOCK(idx)));
812         ASSERT(HDR_IN_HASH_TABLE(buf));
813
814         bufp = &buf_hash_table.ht_table[idx];
815         while ((fbuf = *bufp) != buf) {
816                 ASSERT(fbuf != NULL);
817                 bufp = &fbuf->b_hash_next;
818         }
819         *bufp = buf->b_hash_next;
820         buf->b_hash_next = NULL;
821         buf->b_flags &= ~ARC_IN_HASH_TABLE;
822
823         /* collect some hash table performance data */
824         ARCSTAT_BUMPDOWN(arcstat_hash_elements);
825
826         if (buf_hash_table.ht_table[idx] &&
827             buf_hash_table.ht_table[idx]->b_hash_next == NULL)
828                 ARCSTAT_BUMPDOWN(arcstat_hash_chains);
829 }
830
831 /*
832  * Global data structures and functions for the buf kmem cache.
833  */
834 static kmem_cache_t *hdr_cache;
835 static kmem_cache_t *buf_cache;
836
837 static void
838 buf_fini(void)
839 {
840         int i;
841
842 #if defined(_KERNEL) && defined(HAVE_SPL)
843         /* Large allocations which do not require contiguous pages
844          * should be using vmem_free() in the linux kernel */
845         vmem_free(buf_hash_table.ht_table,
846             (buf_hash_table.ht_mask + 1) * sizeof (void *));
847 #else
848         kmem_free(buf_hash_table.ht_table,
849             (buf_hash_table.ht_mask + 1) * sizeof (void *));
850 #endif
851         for (i = 0; i < BUF_LOCKS; i++)
852                 mutex_destroy(&buf_hash_table.ht_locks[i].ht_lock);
853         kmem_cache_destroy(hdr_cache);
854         kmem_cache_destroy(buf_cache);
855 }
856
857 /*
858  * Constructor callback - called when the cache is empty
859  * and a new buf is requested.
860  */
861 /* ARGSUSED */
862 static int
863 hdr_cons(void *vbuf, void *unused, int kmflag)
864 {
865         arc_buf_hdr_t *buf = vbuf;
866
867         bzero(buf, sizeof (arc_buf_hdr_t));
868         refcount_create(&buf->b_refcnt);
869         cv_init(&buf->b_cv, NULL, CV_DEFAULT, NULL);
870         mutex_init(&buf->b_freeze_lock, NULL, MUTEX_DEFAULT, NULL);
871         list_link_init(&buf->b_arc_node);
872         list_link_init(&buf->b_l2node);
873         arc_space_consume(sizeof (arc_buf_hdr_t), ARC_SPACE_HDRS);
874
875         return (0);
876 }
877
878 /* ARGSUSED */
879 static int
880 buf_cons(void *vbuf, void *unused, int kmflag)
881 {
882         arc_buf_t *buf = vbuf;
883
884         bzero(buf, sizeof (arc_buf_t));
885         mutex_init(&buf->b_evict_lock, NULL, MUTEX_DEFAULT, NULL);
886         rw_init(&buf->b_data_lock, NULL, RW_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         rw_destroy(&buf->b_data_lock);
917         arc_space_return(sizeof (arc_buf_t), ARC_SPACE_HDRS);
918 }
919
920 static void
921 buf_init(void)
922 {
923         uint64_t *ct;
924         uint64_t hsize = 1ULL << 12;
925         int i, j;
926
927         /*
928          * The hash table is big enough to fill all of physical memory
929          * with an average 64K block size.  The table will take up
930          * totalmem*sizeof(void*)/64K (eg. 128KB/GB with 8-byte pointers).
931          */
932         while (hsize * 65536 < physmem * PAGESIZE)
933                 hsize <<= 1;
934 retry:
935         buf_hash_table.ht_mask = hsize - 1;
936 #if defined(_KERNEL) && defined(HAVE_SPL)
937         /* Large allocations which do not require contiguous pages
938          * should be using vmem_alloc() in the linux kernel */
939         buf_hash_table.ht_table =
940             vmem_zalloc(hsize * sizeof (void*), KM_SLEEP);
941 #else
942         buf_hash_table.ht_table =
943             kmem_zalloc(hsize * sizeof (void*), KM_NOSLEEP);
944 #endif
945         if (buf_hash_table.ht_table == NULL) {
946                 ASSERT(hsize > (1ULL << 8));
947                 hsize >>= 1;
948                 goto retry;
949         }
950
951         hdr_cache = kmem_cache_create("arc_buf_hdr_t", sizeof (arc_buf_hdr_t),
952             0, hdr_cons, hdr_dest, NULL, NULL, NULL, 0);
953         buf_cache = kmem_cache_create("arc_buf_t", sizeof (arc_buf_t),
954             0, buf_cons, buf_dest, NULL, NULL, NULL, 0);
955
956         for (i = 0; i < 256; i++)
957                 for (ct = zfs_crc64_table + i, *ct = i, j = 8; j > 0; j--)
958                         *ct = (*ct >> 1) ^ (-(*ct & 1) & ZFS_CRC64_POLY);
959
960         for (i = 0; i < BUF_LOCKS; i++) {
961                 mutex_init(&buf_hash_table.ht_locks[i].ht_lock,
962                     NULL, MUTEX_DEFAULT, NULL);
963         }
964 }
965
966 #define ARC_MINTIME     (hz>>4) /* 62 ms */
967
968 static void
969 arc_cksum_verify(arc_buf_t *buf)
970 {
971         zio_cksum_t zc;
972
973         if (!(zfs_flags & ZFS_DEBUG_MODIFY))
974                 return;
975
976         mutex_enter(&buf->b_hdr->b_freeze_lock);
977         if (buf->b_hdr->b_freeze_cksum == NULL ||
978             (buf->b_hdr->b_flags & ARC_IO_ERROR)) {
979                 mutex_exit(&buf->b_hdr->b_freeze_lock);
980                 return;
981         }
982         fletcher_2_native(buf->b_data, buf->b_hdr->b_size, &zc);
983         if (!ZIO_CHECKSUM_EQUAL(*buf->b_hdr->b_freeze_cksum, zc))
984                 panic("buffer modified while frozen!");
985         mutex_exit(&buf->b_hdr->b_freeze_lock);
986 }
987
988 static int
989 arc_cksum_equal(arc_buf_t *buf)
990 {
991         zio_cksum_t zc;
992         int equal;
993
994         mutex_enter(&buf->b_hdr->b_freeze_lock);
995         fletcher_2_native(buf->b_data, buf->b_hdr->b_size, &zc);
996         equal = ZIO_CHECKSUM_EQUAL(*buf->b_hdr->b_freeze_cksum, zc);
997         mutex_exit(&buf->b_hdr->b_freeze_lock);
998
999         return (equal);
1000 }
1001
1002 static void
1003 arc_cksum_compute(arc_buf_t *buf, boolean_t force)
1004 {
1005         if (!force && !(zfs_flags & ZFS_DEBUG_MODIFY))
1006                 return;
1007
1008         mutex_enter(&buf->b_hdr->b_freeze_lock);
1009         if (buf->b_hdr->b_freeze_cksum != NULL) {
1010                 mutex_exit(&buf->b_hdr->b_freeze_lock);
1011                 return;
1012         }
1013         buf->b_hdr->b_freeze_cksum = kmem_alloc(sizeof (zio_cksum_t),
1014                                                 KM_PUSHPAGE);
1015         fletcher_2_native(buf->b_data, buf->b_hdr->b_size,
1016             buf->b_hdr->b_freeze_cksum);
1017         mutex_exit(&buf->b_hdr->b_freeze_lock);
1018 }
1019
1020 void
1021 arc_buf_thaw(arc_buf_t *buf)
1022 {
1023         if (zfs_flags & ZFS_DEBUG_MODIFY) {
1024                 if (buf->b_hdr->b_state != arc_anon)
1025                         panic("modifying non-anon buffer!");
1026                 if (buf->b_hdr->b_flags & ARC_IO_IN_PROGRESS)
1027                         panic("modifying buffer while i/o in progress!");
1028                 arc_cksum_verify(buf);
1029         }
1030
1031         mutex_enter(&buf->b_hdr->b_freeze_lock);
1032         if (buf->b_hdr->b_freeze_cksum != NULL) {
1033                 kmem_free(buf->b_hdr->b_freeze_cksum, sizeof (zio_cksum_t));
1034                 buf->b_hdr->b_freeze_cksum = NULL;
1035         }
1036
1037         if (zfs_flags & ZFS_DEBUG_MODIFY) {
1038                 if (buf->b_hdr->b_thawed)
1039                         kmem_free(buf->b_hdr->b_thawed, 1);
1040                 buf->b_hdr->b_thawed = kmem_alloc(1, KM_SLEEP);
1041         }
1042
1043         mutex_exit(&buf->b_hdr->b_freeze_lock);
1044 }
1045
1046 void
1047 arc_buf_freeze(arc_buf_t *buf)
1048 {
1049         kmutex_t *hash_lock;
1050
1051         if (!(zfs_flags & ZFS_DEBUG_MODIFY))
1052                 return;
1053
1054         hash_lock = HDR_LOCK(buf->b_hdr);
1055         mutex_enter(hash_lock);
1056
1057         ASSERT(buf->b_hdr->b_freeze_cksum != NULL ||
1058             buf->b_hdr->b_state == arc_anon);
1059         arc_cksum_compute(buf, B_FALSE);
1060         mutex_exit(hash_lock);
1061 }
1062
1063 static void
1064 add_reference(arc_buf_hdr_t *ab, kmutex_t *hash_lock, void *tag)
1065 {
1066         ASSERT(MUTEX_HELD(hash_lock));
1067
1068         if ((refcount_add(&ab->b_refcnt, tag) == 1) &&
1069             (ab->b_state != arc_anon)) {
1070                 uint64_t delta = ab->b_size * ab->b_datacnt;
1071                 list_t *list = &ab->b_state->arcs_list[ab->b_type];
1072                 uint64_t *size = &ab->b_state->arcs_lsize[ab->b_type];
1073
1074                 ASSERT(!MUTEX_HELD(&ab->b_state->arcs_mtx));
1075                 mutex_enter(&ab->b_state->arcs_mtx);
1076                 ASSERT(list_link_active(&ab->b_arc_node));
1077                 list_remove(list, ab);
1078                 if (GHOST_STATE(ab->b_state)) {
1079                         ASSERT3U(ab->b_datacnt, ==, 0);
1080                         ASSERT3P(ab->b_buf, ==, NULL);
1081                         delta = ab->b_size;
1082                 }
1083                 ASSERT(delta > 0);
1084                 ASSERT3U(*size, >=, delta);
1085                 atomic_add_64(size, -delta);
1086                 mutex_exit(&ab->b_state->arcs_mtx);
1087                 /* remove the prefetch flag if we get a reference */
1088                 if (ab->b_flags & ARC_PREFETCH)
1089                         ab->b_flags &= ~ARC_PREFETCH;
1090         }
1091 }
1092
1093 static int
1094 remove_reference(arc_buf_hdr_t *ab, kmutex_t *hash_lock, void *tag)
1095 {
1096         int cnt;
1097         arc_state_t *state = ab->b_state;
1098
1099         ASSERT(state == arc_anon || MUTEX_HELD(hash_lock));
1100         ASSERT(!GHOST_STATE(state));
1101
1102         if (((cnt = refcount_remove(&ab->b_refcnt, tag)) == 0) &&
1103             (state != arc_anon)) {
1104                 uint64_t *size = &state->arcs_lsize[ab->b_type];
1105
1106                 ASSERT(!MUTEX_HELD(&state->arcs_mtx));
1107                 mutex_enter(&state->arcs_mtx);
1108                 ASSERT(!list_link_active(&ab->b_arc_node));
1109                 list_insert_head(&state->arcs_list[ab->b_type], ab);
1110                 ASSERT(ab->b_datacnt > 0);
1111                 atomic_add_64(size, ab->b_size * ab->b_datacnt);
1112                 mutex_exit(&state->arcs_mtx);
1113         }
1114         return (cnt);
1115 }
1116
1117 /*
1118  * Move the supplied buffer to the indicated state.  The mutex
1119  * for the buffer must be held by the caller.
1120  */
1121 static void
1122 arc_change_state(arc_state_t *new_state, arc_buf_hdr_t *ab, kmutex_t *hash_lock)
1123 {
1124         arc_state_t *old_state = ab->b_state;
1125         int64_t refcnt = refcount_count(&ab->b_refcnt);
1126         uint64_t from_delta, to_delta;
1127
1128         ASSERT(MUTEX_HELD(hash_lock));
1129         ASSERT(new_state != old_state);
1130         ASSERT(refcnt == 0 || ab->b_datacnt > 0);
1131         ASSERT(ab->b_datacnt == 0 || !GHOST_STATE(new_state));
1132         ASSERT(ab->b_datacnt <= 1 || old_state != arc_anon);
1133
1134         from_delta = to_delta = ab->b_datacnt * ab->b_size;
1135
1136         /*
1137          * If this buffer is evictable, transfer it from the
1138          * old state list to the new state list.
1139          */
1140         if (refcnt == 0) {
1141                 if (old_state != arc_anon) {
1142                         int use_mutex = !MUTEX_HELD(&old_state->arcs_mtx);
1143                         uint64_t *size = &old_state->arcs_lsize[ab->b_type];
1144
1145                         if (use_mutex)
1146                                 mutex_enter(&old_state->arcs_mtx);
1147
1148                         ASSERT(list_link_active(&ab->b_arc_node));
1149                         list_remove(&old_state->arcs_list[ab->b_type], ab);
1150
1151                         /*
1152                          * If prefetching out of the ghost cache,
1153                          * we will have a non-zero datacnt.
1154                          */
1155                         if (GHOST_STATE(old_state) && ab->b_datacnt == 0) {
1156                                 /* ghost elements have a ghost size */
1157                                 ASSERT(ab->b_buf == NULL);
1158                                 from_delta = ab->b_size;
1159                         }
1160                         ASSERT3U(*size, >=, from_delta);
1161                         atomic_add_64(size, -from_delta);
1162
1163                         if (use_mutex)
1164                                 mutex_exit(&old_state->arcs_mtx);
1165                 }
1166                 if (new_state != arc_anon) {
1167                         int use_mutex = !MUTEX_HELD(&new_state->arcs_mtx);
1168                         uint64_t *size = &new_state->arcs_lsize[ab->b_type];
1169
1170                         if (use_mutex)
1171                                 mutex_enter(&new_state->arcs_mtx);
1172
1173                         list_insert_head(&new_state->arcs_list[ab->b_type], ab);
1174
1175                         /* ghost elements have a ghost size */
1176                         if (GHOST_STATE(new_state)) {
1177                                 ASSERT(ab->b_datacnt == 0);
1178                                 ASSERT(ab->b_buf == NULL);
1179                                 to_delta = ab->b_size;
1180                         }
1181                         atomic_add_64(size, to_delta);
1182
1183                         if (use_mutex)
1184                                 mutex_exit(&new_state->arcs_mtx);
1185                 }
1186         }
1187
1188         ASSERT(!BUF_EMPTY(ab));
1189         if (new_state == arc_anon && HDR_IN_HASH_TABLE(ab))
1190                 buf_hash_remove(ab);
1191
1192         /* adjust state sizes */
1193         if (to_delta)
1194                 atomic_add_64(&new_state->arcs_size, to_delta);
1195         if (from_delta) {
1196                 ASSERT3U(old_state->arcs_size, >=, from_delta);
1197                 atomic_add_64(&old_state->arcs_size, -from_delta);
1198         }
1199         ab->b_state = new_state;
1200
1201         /* adjust l2arc hdr stats */
1202         if (new_state == arc_l2c_only)
1203                 l2arc_hdr_stat_add();
1204         else if (old_state == arc_l2c_only)
1205                 l2arc_hdr_stat_remove();
1206 }
1207
1208 void
1209 arc_space_consume(uint64_t space, arc_space_type_t type)
1210 {
1211         ASSERT(type >= 0 && type < ARC_SPACE_NUMTYPES);
1212
1213         switch (type) {
1214         default:
1215                 break;
1216         case ARC_SPACE_DATA:
1217                 ARCSTAT_INCR(arcstat_data_size, space);
1218                 break;
1219         case ARC_SPACE_OTHER:
1220                 ARCSTAT_INCR(arcstat_other_size, space);
1221                 break;
1222         case ARC_SPACE_HDRS:
1223                 ARCSTAT_INCR(arcstat_hdr_size, space);
1224                 break;
1225         case ARC_SPACE_L2HDRS:
1226                 ARCSTAT_INCR(arcstat_l2_hdr_size, space);
1227                 break;
1228         }
1229
1230         atomic_add_64(&arc_meta_used, space);
1231         atomic_add_64(&arc_size, space);
1232 }
1233
1234 void
1235 arc_space_return(uint64_t space, arc_space_type_t type)
1236 {
1237         ASSERT(type >= 0 && type < ARC_SPACE_NUMTYPES);
1238
1239         switch (type) {
1240         default:
1241                 break;
1242         case ARC_SPACE_DATA:
1243                 ARCSTAT_INCR(arcstat_data_size, -space);
1244                 break;
1245         case ARC_SPACE_OTHER:
1246                 ARCSTAT_INCR(arcstat_other_size, -space);
1247                 break;
1248         case ARC_SPACE_HDRS:
1249                 ARCSTAT_INCR(arcstat_hdr_size, -space);
1250                 break;
1251         case ARC_SPACE_L2HDRS:
1252                 ARCSTAT_INCR(arcstat_l2_hdr_size, -space);
1253                 break;
1254         }
1255
1256         ASSERT(arc_meta_used >= space);
1257         if (arc_meta_max < arc_meta_used)
1258                 arc_meta_max = arc_meta_used;
1259         atomic_add_64(&arc_meta_used, -space);
1260         ASSERT(arc_size >= space);
1261         atomic_add_64(&arc_size, -space);
1262 }
1263
1264 void *
1265 arc_data_buf_alloc(uint64_t size)
1266 {
1267         if (arc_evict_needed(ARC_BUFC_DATA))
1268                 cv_signal(&arc_reclaim_thr_cv);
1269         atomic_add_64(&arc_size, size);
1270         return (zio_data_buf_alloc(size));
1271 }
1272
1273 void
1274 arc_data_buf_free(void *buf, uint64_t size)
1275 {
1276         zio_data_buf_free(buf, size);
1277         ASSERT(arc_size >= size);
1278         atomic_add_64(&arc_size, -size);
1279 }
1280
1281 arc_buf_t *
1282 arc_buf_alloc(spa_t *spa, int size, void *tag, arc_buf_contents_t type)
1283 {
1284         arc_buf_hdr_t *hdr;
1285         arc_buf_t *buf;
1286
1287         ASSERT3U(size, >, 0);
1288         hdr = kmem_cache_alloc(hdr_cache, KM_PUSHPAGE);
1289         ASSERT(BUF_EMPTY(hdr));
1290         hdr->b_size = size;
1291         hdr->b_type = type;
1292         hdr->b_spa = spa_load_guid(spa);
1293         hdr->b_state = arc_anon;
1294         hdr->b_arc_access = 0;
1295         buf = kmem_cache_alloc(buf_cache, KM_PUSHPAGE);
1296         buf->b_hdr = hdr;
1297         buf->b_data = NULL;
1298         buf->b_efunc = NULL;
1299         buf->b_private = NULL;
1300         buf->b_next = NULL;
1301         hdr->b_buf = buf;
1302         arc_get_data_buf(buf);
1303         hdr->b_datacnt = 1;
1304         hdr->b_flags = 0;
1305         ASSERT(refcount_is_zero(&hdr->b_refcnt));
1306         (void) refcount_add(&hdr->b_refcnt, tag);
1307
1308         return (buf);
1309 }
1310
1311 static char *arc_onloan_tag = "onloan";
1312
1313 /*
1314  * Loan out an anonymous arc buffer. Loaned buffers are not counted as in
1315  * flight data by arc_tempreserve_space() until they are "returned". Loaned
1316  * buffers must be returned to the arc before they can be used by the DMU or
1317  * freed.
1318  */
1319 arc_buf_t *
1320 arc_loan_buf(spa_t *spa, int size)
1321 {
1322         arc_buf_t *buf;
1323
1324         buf = arc_buf_alloc(spa, size, arc_onloan_tag, ARC_BUFC_DATA);
1325
1326         atomic_add_64(&arc_loaned_bytes, size);
1327         return (buf);
1328 }
1329
1330 /*
1331  * Return a loaned arc buffer to the arc.
1332  */
1333 void
1334 arc_return_buf(arc_buf_t *buf, void *tag)
1335 {
1336         arc_buf_hdr_t *hdr = buf->b_hdr;
1337
1338         ASSERT(buf->b_data != NULL);
1339         (void) refcount_add(&hdr->b_refcnt, tag);
1340         (void) refcount_remove(&hdr->b_refcnt, arc_onloan_tag);
1341
1342         atomic_add_64(&arc_loaned_bytes, -hdr->b_size);
1343 }
1344
1345 /* Detach an arc_buf from a dbuf (tag) */
1346 void
1347 arc_loan_inuse_buf(arc_buf_t *buf, void *tag)
1348 {
1349         arc_buf_hdr_t *hdr;
1350
1351         ASSERT(buf->b_data != NULL);
1352         hdr = buf->b_hdr;
1353         (void) refcount_add(&hdr->b_refcnt, arc_onloan_tag);
1354         (void) refcount_remove(&hdr->b_refcnt, tag);
1355         buf->b_efunc = NULL;
1356         buf->b_private = NULL;
1357
1358         atomic_add_64(&arc_loaned_bytes, hdr->b_size);
1359 }
1360
1361 static arc_buf_t *
1362 arc_buf_clone(arc_buf_t *from)
1363 {
1364         arc_buf_t *buf;
1365         arc_buf_hdr_t *hdr = from->b_hdr;
1366         uint64_t size = hdr->b_size;
1367
1368         ASSERT(hdr->b_state != arc_anon);
1369
1370         buf = kmem_cache_alloc(buf_cache, KM_PUSHPAGE);
1371         buf->b_hdr = hdr;
1372         buf->b_data = NULL;
1373         buf->b_efunc = NULL;
1374         buf->b_private = NULL;
1375         buf->b_next = hdr->b_buf;
1376         hdr->b_buf = buf;
1377         arc_get_data_buf(buf);
1378         bcopy(from->b_data, buf->b_data, size);
1379
1380         /*
1381          * This buffer already exists in the arc so create a duplicate
1382          * copy for the caller.  If the buffer is associated with user data
1383          * then track the size and number of duplicates.  These stats will be
1384          * updated as duplicate buffers are created and destroyed.
1385          */
1386         if (hdr->b_type == ARC_BUFC_DATA) {
1387                 ARCSTAT_BUMP(arcstat_duplicate_buffers);
1388                 ARCSTAT_INCR(arcstat_duplicate_buffers_size, size);
1389         }
1390         hdr->b_datacnt += 1;
1391         return (buf);
1392 }
1393
1394 void
1395 arc_buf_add_ref(arc_buf_t *buf, void* tag)
1396 {
1397         arc_buf_hdr_t *hdr;
1398         kmutex_t *hash_lock;
1399
1400         /*
1401          * Check to see if this buffer is evicted.  Callers
1402          * must verify b_data != NULL to know if the add_ref
1403          * was successful.
1404          */
1405         mutex_enter(&buf->b_evict_lock);
1406         if (buf->b_data == NULL) {
1407                 mutex_exit(&buf->b_evict_lock);
1408                 return;
1409         }
1410         hash_lock = HDR_LOCK(buf->b_hdr);
1411         mutex_enter(hash_lock);
1412         hdr = buf->b_hdr;
1413         ASSERT3P(hash_lock, ==, HDR_LOCK(hdr));
1414         mutex_exit(&buf->b_evict_lock);
1415
1416         ASSERT(hdr->b_state == arc_mru || hdr->b_state == arc_mfu);
1417         add_reference(hdr, hash_lock, tag);
1418         DTRACE_PROBE1(arc__hit, arc_buf_hdr_t *, hdr);
1419         arc_access(hdr, hash_lock);
1420         mutex_exit(hash_lock);
1421         ARCSTAT_BUMP(arcstat_hits);
1422         ARCSTAT_CONDSTAT(!(hdr->b_flags & ARC_PREFETCH),
1423             demand, prefetch, hdr->b_type != ARC_BUFC_METADATA,
1424             data, metadata, hits);
1425 }
1426
1427 /*
1428  * Free the arc data buffer.  If it is an l2arc write in progress,
1429  * the buffer is placed on l2arc_free_on_write to be freed later.
1430  */
1431 static void
1432 arc_buf_data_free(arc_buf_hdr_t *hdr, void (*free_func)(void *, size_t),
1433     void *data, size_t size)
1434 {
1435         if (HDR_L2_WRITING(hdr)) {
1436                 l2arc_data_free_t *df;
1437                 df = kmem_alloc(sizeof (l2arc_data_free_t), KM_PUSHPAGE);
1438                 df->l2df_data = data;
1439                 df->l2df_size = size;
1440                 df->l2df_func = free_func;
1441                 mutex_enter(&l2arc_free_on_write_mtx);
1442                 list_insert_head(l2arc_free_on_write, df);
1443                 mutex_exit(&l2arc_free_on_write_mtx);
1444                 ARCSTAT_BUMP(arcstat_l2_free_on_write);
1445         } else {
1446                 free_func(data, size);
1447         }
1448 }
1449
1450 static void
1451 arc_buf_destroy(arc_buf_t *buf, boolean_t recycle, boolean_t all)
1452 {
1453         arc_buf_t **bufp;
1454
1455         /* free up data associated with the buf */
1456         if (buf->b_data) {
1457                 arc_state_t *state = buf->b_hdr->b_state;
1458                 uint64_t size = buf->b_hdr->b_size;
1459                 arc_buf_contents_t type = buf->b_hdr->b_type;
1460
1461                 arc_cksum_verify(buf);
1462
1463                 if (!recycle) {
1464                         if (type == ARC_BUFC_METADATA) {
1465                                 arc_buf_data_free(buf->b_hdr, zio_buf_free,
1466                                     buf->b_data, size);
1467                                 arc_space_return(size, ARC_SPACE_DATA);
1468                         } else {
1469                                 ASSERT(type == ARC_BUFC_DATA);
1470                                 arc_buf_data_free(buf->b_hdr,
1471                                     zio_data_buf_free, buf->b_data, size);
1472                                 ARCSTAT_INCR(arcstat_data_size, -size);
1473                                 atomic_add_64(&arc_size, -size);
1474                         }
1475                 }
1476                 if (list_link_active(&buf->b_hdr->b_arc_node)) {
1477                         uint64_t *cnt = &state->arcs_lsize[type];
1478
1479                         ASSERT(refcount_is_zero(&buf->b_hdr->b_refcnt));
1480                         ASSERT(state != arc_anon);
1481
1482                         ASSERT3U(*cnt, >=, size);
1483                         atomic_add_64(cnt, -size);
1484                 }
1485                 ASSERT3U(state->arcs_size, >=, size);
1486                 atomic_add_64(&state->arcs_size, -size);
1487                 buf->b_data = NULL;
1488
1489                 /*
1490                  * If we're destroying a duplicate buffer make sure
1491                  * that the appropriate statistics are updated.
1492                  */
1493                 if (buf->b_hdr->b_datacnt > 1 &&
1494                     buf->b_hdr->b_type == ARC_BUFC_DATA) {
1495                         ARCSTAT_BUMPDOWN(arcstat_duplicate_buffers);
1496                         ARCSTAT_INCR(arcstat_duplicate_buffers_size, -size);
1497                 }
1498                 ASSERT(buf->b_hdr->b_datacnt > 0);
1499                 buf->b_hdr->b_datacnt -= 1;
1500         }
1501
1502         /* only remove the buf if requested */
1503         if (!all)
1504                 return;
1505
1506         /* remove the buf from the hdr list */
1507         for (bufp = &buf->b_hdr->b_buf; *bufp != buf; bufp = &(*bufp)->b_next)
1508                 continue;
1509         *bufp = buf->b_next;
1510         buf->b_next = NULL;
1511
1512         ASSERT(buf->b_efunc == NULL);
1513
1514         /* clean up the buf */
1515         buf->b_hdr = NULL;
1516         kmem_cache_free(buf_cache, buf);
1517 }
1518
1519 static void
1520 arc_hdr_destroy(arc_buf_hdr_t *hdr)
1521 {
1522         l2arc_buf_hdr_t *l2hdr = hdr->b_l2hdr;
1523
1524         ASSERT(refcount_is_zero(&hdr->b_refcnt));
1525         ASSERT3P(hdr->b_state, ==, arc_anon);
1526         ASSERT(!HDR_IO_IN_PROGRESS(hdr));
1527
1528         if (l2hdr != NULL) {
1529                 boolean_t buflist_held = MUTEX_HELD(&l2arc_buflist_mtx);
1530                 /*
1531                  * To prevent arc_free() and l2arc_evict() from
1532                  * attempting to free the same buffer at the same time,
1533                  * a FREE_IN_PROGRESS flag is given to arc_free() to
1534                  * give it priority.  l2arc_evict() can't destroy this
1535                  * header while we are waiting on l2arc_buflist_mtx.
1536                  *
1537                  * The hdr may be removed from l2ad_buflist before we
1538                  * grab l2arc_buflist_mtx, so b_l2hdr is rechecked.
1539                  */
1540                 if (!buflist_held) {
1541                         mutex_enter(&l2arc_buflist_mtx);
1542                         l2hdr = hdr->b_l2hdr;
1543                 }
1544
1545                 if (l2hdr != NULL) {
1546                         list_remove(l2hdr->b_dev->l2ad_buflist, hdr);
1547                         ARCSTAT_INCR(arcstat_l2_size, -hdr->b_size);
1548                         kmem_free(l2hdr, sizeof (l2arc_buf_hdr_t));
1549                         if (hdr->b_state == arc_l2c_only)
1550                                 l2arc_hdr_stat_remove();
1551                         hdr->b_l2hdr = NULL;
1552                 }
1553
1554                 if (!buflist_held)
1555                         mutex_exit(&l2arc_buflist_mtx);
1556         }
1557
1558         if (!BUF_EMPTY(hdr)) {
1559                 ASSERT(!HDR_IN_HASH_TABLE(hdr));
1560                 buf_discard_identity(hdr);
1561         }
1562         while (hdr->b_buf) {
1563                 arc_buf_t *buf = hdr->b_buf;
1564
1565                 if (buf->b_efunc) {
1566                         mutex_enter(&arc_eviction_mtx);
1567                         mutex_enter(&buf->b_evict_lock);
1568                         ASSERT(buf->b_hdr != NULL);
1569                         arc_buf_destroy(hdr->b_buf, FALSE, FALSE);
1570                         hdr->b_buf = buf->b_next;
1571                         buf->b_hdr = &arc_eviction_hdr;
1572                         buf->b_next = arc_eviction_list;
1573                         arc_eviction_list = buf;
1574                         mutex_exit(&buf->b_evict_lock);
1575                         mutex_exit(&arc_eviction_mtx);
1576                 } else {
1577                         arc_buf_destroy(hdr->b_buf, FALSE, TRUE);
1578                 }
1579         }
1580         if (hdr->b_freeze_cksum != NULL) {
1581                 kmem_free(hdr->b_freeze_cksum, sizeof (zio_cksum_t));
1582                 hdr->b_freeze_cksum = NULL;
1583         }
1584         if (hdr->b_thawed) {
1585                 kmem_free(hdr->b_thawed, 1);
1586                 hdr->b_thawed = NULL;
1587         }
1588
1589         ASSERT(!list_link_active(&hdr->b_arc_node));
1590         ASSERT3P(hdr->b_hash_next, ==, NULL);
1591         ASSERT3P(hdr->b_acb, ==, NULL);
1592         kmem_cache_free(hdr_cache, hdr);
1593 }
1594
1595 void
1596 arc_buf_free(arc_buf_t *buf, void *tag)
1597 {
1598         arc_buf_hdr_t *hdr = buf->b_hdr;
1599         int hashed = hdr->b_state != arc_anon;
1600
1601         ASSERT(buf->b_efunc == NULL);
1602         ASSERT(buf->b_data != NULL);
1603
1604         if (hashed) {
1605                 kmutex_t *hash_lock = HDR_LOCK(hdr);
1606
1607                 mutex_enter(hash_lock);
1608                 hdr = buf->b_hdr;
1609                 ASSERT3P(hash_lock, ==, HDR_LOCK(hdr));
1610
1611                 (void) remove_reference(hdr, hash_lock, tag);
1612                 if (hdr->b_datacnt > 1) {
1613                         arc_buf_destroy(buf, FALSE, TRUE);
1614                 } else {
1615                         ASSERT(buf == hdr->b_buf);
1616                         ASSERT(buf->b_efunc == NULL);
1617                         hdr->b_flags |= ARC_BUF_AVAILABLE;
1618                 }
1619                 mutex_exit(hash_lock);
1620         } else if (HDR_IO_IN_PROGRESS(hdr)) {
1621                 int destroy_hdr;
1622                 /*
1623                  * We are in the middle of an async write.  Don't destroy
1624                  * this buffer unless the write completes before we finish
1625                  * decrementing the reference count.
1626                  */
1627                 mutex_enter(&arc_eviction_mtx);
1628                 (void) remove_reference(hdr, NULL, tag);
1629                 ASSERT(refcount_is_zero(&hdr->b_refcnt));
1630                 destroy_hdr = !HDR_IO_IN_PROGRESS(hdr);
1631                 mutex_exit(&arc_eviction_mtx);
1632                 if (destroy_hdr)
1633                         arc_hdr_destroy(hdr);
1634         } else {
1635                 if (remove_reference(hdr, NULL, tag) > 0)
1636                         arc_buf_destroy(buf, FALSE, TRUE);
1637                 else
1638                         arc_hdr_destroy(hdr);
1639         }
1640 }
1641
1642 int
1643 arc_buf_remove_ref(arc_buf_t *buf, void* tag)
1644 {
1645         arc_buf_hdr_t *hdr = buf->b_hdr;
1646         kmutex_t *hash_lock = HDR_LOCK(hdr);
1647         int no_callback = (buf->b_efunc == NULL);
1648
1649         if (hdr->b_state == arc_anon) {
1650                 ASSERT(hdr->b_datacnt == 1);
1651                 arc_buf_free(buf, tag);
1652                 return (no_callback);
1653         }
1654
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                         ASSERT3U(refcount_count(&ab->b_refcnt), ==, 0);
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                         ASSERT3U(refcount_count(&buf->b_refcnt), ==, 0);
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                 arc_byteswap_func_t *func = BP_GET_LEVEL(zio->io_bp) > 0 ?
2805                     byteswap_uint64_array :
2806                     dmu_ot_byteswap[bswap].ob_func;
2807                 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  * Normal callers should use arc_read and pass the arc buffer and offset
2911  * for the bp.  But if you know you don't need locking, you can use
2912  * arc_read_bp.
2913  */
2914 int
2915 arc_read(zio_t *pio, spa_t *spa, const blkptr_t *bp, arc_buf_t *pbuf,
2916     arc_done_func_t *done, void *private, int priority, int zio_flags,
2917     uint32_t *arc_flags, const zbookmark_t *zb)
2918 {
2919         int err;
2920
2921         if (pbuf == NULL) {
2922                 /*
2923                  * XXX This happens from traverse callback funcs, for
2924                  * the objset_phys_t block.
2925                  */
2926                 return (arc_read_nolock(pio, spa, bp, done, private, priority,
2927                     zio_flags, arc_flags, zb));
2928         }
2929
2930         ASSERT(!refcount_is_zero(&pbuf->b_hdr->b_refcnt));
2931         ASSERT3U((char *)bp - (char *)pbuf->b_data, <, pbuf->b_hdr->b_size);
2932         rw_enter(&pbuf->b_data_lock, RW_READER);
2933
2934         err = arc_read_nolock(pio, spa, bp, done, private, priority,
2935             zio_flags, arc_flags, zb);
2936         rw_exit(&pbuf->b_data_lock);
2937
2938         return (err);
2939 }
2940
2941 int
2942 arc_read_nolock(zio_t *pio, spa_t *spa, const blkptr_t *bp,
2943     arc_done_func_t *done, void *private, int priority, int zio_flags,
2944     uint32_t *arc_flags, const zbookmark_t *zb)
2945 {
2946         arc_buf_hdr_t *hdr;
2947         arc_buf_t *buf = NULL;
2948         kmutex_t *hash_lock;
2949         zio_t *rzio;
2950         uint64_t guid = spa_load_guid(spa);
2951
2952 top:
2953         hdr = buf_hash_find(guid, BP_IDENTITY(bp), BP_PHYSICAL_BIRTH(bp),
2954             &hash_lock);
2955         if (hdr && hdr->b_datacnt > 0) {
2956
2957                 *arc_flags |= ARC_CACHED;
2958
2959                 if (HDR_IO_IN_PROGRESS(hdr)) {
2960
2961                         if (*arc_flags & ARC_WAIT) {
2962                                 cv_wait(&hdr->b_cv, hash_lock);
2963                                 mutex_exit(hash_lock);
2964                                 goto top;
2965                         }
2966                         ASSERT(*arc_flags & ARC_NOWAIT);
2967
2968                         if (done) {
2969                                 arc_callback_t  *acb = NULL;
2970
2971                                 acb = kmem_zalloc(sizeof (arc_callback_t),
2972                                     KM_PUSHPAGE);
2973                                 acb->acb_done = done;
2974                                 acb->acb_private = private;
2975                                 if (pio != NULL)
2976                                         acb->acb_zio_dummy = zio_null(pio,
2977                                             spa, NULL, NULL, NULL, zio_flags);
2978
2979                                 ASSERT(acb->acb_done != NULL);
2980                                 acb->acb_next = hdr->b_acb;
2981                                 hdr->b_acb = acb;
2982                                 add_reference(hdr, hash_lock, private);
2983                                 mutex_exit(hash_lock);
2984                                 return (0);
2985                         }
2986                         mutex_exit(hash_lock);
2987                         return (0);
2988                 }
2989
2990                 ASSERT(hdr->b_state == arc_mru || hdr->b_state == arc_mfu);
2991
2992                 if (done) {
2993                         add_reference(hdr, hash_lock, private);
2994                         /*
2995                          * If this block is already in use, create a new
2996                          * copy of the data so that we will be guaranteed
2997                          * that arc_release() will always succeed.
2998                          */
2999                         buf = hdr->b_buf;
3000                         ASSERT(buf);
3001                         ASSERT(buf->b_data);
3002                         if (HDR_BUF_AVAILABLE(hdr)) {
3003                                 ASSERT(buf->b_efunc == NULL);
3004                                 hdr->b_flags &= ~ARC_BUF_AVAILABLE;
3005                         } else {
3006                                 buf = arc_buf_clone(buf);
3007                         }
3008
3009                 } else if (*arc_flags & ARC_PREFETCH &&
3010                     refcount_count(&hdr->b_refcnt) == 0) {
3011                         hdr->b_flags |= ARC_PREFETCH;
3012                 }
3013                 DTRACE_PROBE1(arc__hit, arc_buf_hdr_t *, hdr);
3014                 arc_access(hdr, hash_lock);
3015                 if (*arc_flags & ARC_L2CACHE)
3016                         hdr->b_flags |= ARC_L2CACHE;
3017                 mutex_exit(hash_lock);
3018                 ARCSTAT_BUMP(arcstat_hits);
3019                 ARCSTAT_CONDSTAT(!(hdr->b_flags & ARC_PREFETCH),
3020                     demand, prefetch, hdr->b_type != ARC_BUFC_METADATA,
3021                     data, metadata, hits);
3022
3023                 if (done)
3024                         done(NULL, buf, private);
3025         } else {
3026                 uint64_t size = BP_GET_LSIZE(bp);
3027                 arc_callback_t  *acb;
3028                 vdev_t *vd = NULL;
3029                 uint64_t addr = -1;
3030                 boolean_t devw = B_FALSE;
3031
3032                 if (hdr == NULL) {
3033                         /* this block is not in the cache */
3034                         arc_buf_hdr_t   *exists;
3035                         arc_buf_contents_t type = BP_GET_BUFC_TYPE(bp);
3036                         buf = arc_buf_alloc(spa, size, private, type);
3037                         hdr = buf->b_hdr;
3038                         hdr->b_dva = *BP_IDENTITY(bp);
3039                         hdr->b_birth = BP_PHYSICAL_BIRTH(bp);
3040                         hdr->b_cksum0 = bp->blk_cksum.zc_word[0];
3041                         exists = buf_hash_insert(hdr, &hash_lock);
3042                         if (exists) {
3043                                 /* somebody beat us to the hash insert */
3044                                 mutex_exit(hash_lock);
3045                                 buf_discard_identity(hdr);
3046                                 (void) arc_buf_remove_ref(buf, private);
3047                                 goto top; /* restart the IO request */
3048                         }
3049                         /* if this is a prefetch, we don't have a reference */
3050                         if (*arc_flags & ARC_PREFETCH) {
3051                                 (void) remove_reference(hdr, hash_lock,
3052                                     private);
3053                                 hdr->b_flags |= ARC_PREFETCH;
3054                         }
3055                         if (*arc_flags & ARC_L2CACHE)
3056                                 hdr->b_flags |= ARC_L2CACHE;
3057                         if (BP_GET_LEVEL(bp) > 0)
3058                                 hdr->b_flags |= ARC_INDIRECT;
3059                 } else {
3060                         /* this block is in the ghost cache */
3061                         ASSERT(GHOST_STATE(hdr->b_state));
3062                         ASSERT(!HDR_IO_IN_PROGRESS(hdr));
3063                         ASSERT3U(refcount_count(&hdr->b_refcnt), ==, 0);
3064                         ASSERT(hdr->b_buf == NULL);
3065
3066                         /* if this is a prefetch, we don't have a reference */
3067                         if (*arc_flags & ARC_PREFETCH)
3068                                 hdr->b_flags |= ARC_PREFETCH;
3069                         else
3070                                 add_reference(hdr, hash_lock, private);
3071                         if (*arc_flags & ARC_L2CACHE)
3072                                 hdr->b_flags |= ARC_L2CACHE;
3073                         buf = kmem_cache_alloc(buf_cache, KM_PUSHPAGE);
3074                         buf->b_hdr = hdr;
3075                         buf->b_data = NULL;
3076                         buf->b_efunc = NULL;
3077                         buf->b_private = NULL;
3078                         buf->b_next = NULL;
3079                         hdr->b_buf = buf;
3080                         ASSERT(hdr->b_datacnt == 0);
3081                         hdr->b_datacnt = 1;
3082                         arc_get_data_buf(buf);
3083                         arc_access(hdr, hash_lock);
3084                 }
3085
3086                 ASSERT(!GHOST_STATE(hdr->b_state));
3087
3088                 acb = kmem_zalloc(sizeof (arc_callback_t), KM_PUSHPAGE);
3089                 acb->acb_done = done;
3090                 acb->acb_private = private;
3091
3092                 ASSERT(hdr->b_acb == NULL);
3093                 hdr->b_acb = acb;
3094                 hdr->b_flags |= ARC_IO_IN_PROGRESS;
3095
3096                 if (HDR_L2CACHE(hdr) && hdr->b_l2hdr != NULL &&
3097                     (vd = hdr->b_l2hdr->b_dev->l2ad_vdev) != NULL) {
3098                         devw = hdr->b_l2hdr->b_dev->l2ad_writing;
3099                         addr = hdr->b_l2hdr->b_daddr;
3100                         /*
3101                          * Lock out device removal.
3102                          */
3103                         if (vdev_is_dead(vd) ||
3104                             !spa_config_tryenter(spa, SCL_L2ARC, vd, RW_READER))
3105                                 vd = NULL;
3106                 }
3107
3108                 mutex_exit(hash_lock);
3109
3110                 ASSERT3U(hdr->b_size, ==, size);
3111                 DTRACE_PROBE4(arc__miss, arc_buf_hdr_t *, hdr, blkptr_t *, bp,
3112                     uint64_t, size, zbookmark_t *, zb);
3113                 ARCSTAT_BUMP(arcstat_misses);
3114                 ARCSTAT_CONDSTAT(!(hdr->b_flags & ARC_PREFETCH),
3115                     demand, prefetch, hdr->b_type != ARC_BUFC_METADATA,
3116                     data, metadata, misses);
3117
3118                 if (vd != NULL && l2arc_ndev != 0 && !(l2arc_norw && devw)) {
3119                         /*
3120                          * Read from the L2ARC if the following are true:
3121                          * 1. The L2ARC vdev was previously cached.
3122                          * 2. This buffer still has L2ARC metadata.
3123                          * 3. This buffer isn't currently writing to the L2ARC.
3124                          * 4. The L2ARC entry wasn't evicted, which may
3125                          *    also have invalidated the vdev.
3126                          * 5. This isn't prefetch and l2arc_noprefetch is set.
3127                          */
3128                         if (hdr->b_l2hdr != NULL &&
3129                             !HDR_L2_WRITING(hdr) && !HDR_L2_EVICTED(hdr) &&
3130                             !(l2arc_noprefetch && HDR_PREFETCH(hdr))) {
3131                                 l2arc_read_callback_t *cb;
3132
3133                                 DTRACE_PROBE1(l2arc__hit, arc_buf_hdr_t *, hdr);
3134                                 ARCSTAT_BUMP(arcstat_l2_hits);
3135
3136                                 cb = kmem_zalloc(sizeof (l2arc_read_callback_t),
3137                                     KM_PUSHPAGE);
3138                                 cb->l2rcb_buf = buf;
3139                                 cb->l2rcb_spa = spa;
3140                                 cb->l2rcb_bp = *bp;
3141                                 cb->l2rcb_zb = *zb;
3142                                 cb->l2rcb_flags = zio_flags;
3143
3144                                 /*
3145                                  * l2arc read.  The SCL_L2ARC lock will be
3146                                  * released by l2arc_read_done().
3147                                  */
3148                                 rzio = zio_read_phys(pio, vd, addr, size,
3149                                     buf->b_data, ZIO_CHECKSUM_OFF,
3150                                     l2arc_read_done, cb, priority, zio_flags |
3151                                     ZIO_FLAG_DONT_CACHE | ZIO_FLAG_CANFAIL |
3152                                     ZIO_FLAG_DONT_PROPAGATE |
3153                                     ZIO_FLAG_DONT_RETRY, B_FALSE);
3154                                 DTRACE_PROBE2(l2arc__read, vdev_t *, vd,
3155                                     zio_t *, rzio);
3156                                 ARCSTAT_INCR(arcstat_l2_read_bytes, size);
3157
3158                                 if (*arc_flags & ARC_NOWAIT) {
3159                                         zio_nowait(rzio);
3160                                         return (0);
3161                                 }
3162
3163                                 ASSERT(*arc_flags & ARC_WAIT);
3164                                 if (zio_wait(rzio) == 0)
3165                                         return (0);
3166
3167                                 /* l2arc read error; goto zio_read() */
3168                         } else {
3169                                 DTRACE_PROBE1(l2arc__miss,
3170                                     arc_buf_hdr_t *, hdr);
3171                                 ARCSTAT_BUMP(arcstat_l2_misses);
3172                                 if (HDR_L2_WRITING(hdr))
3173                                         ARCSTAT_BUMP(arcstat_l2_rw_clash);
3174                                 spa_config_exit(spa, SCL_L2ARC, vd);
3175                         }
3176                 } else {
3177                         if (vd != NULL)
3178                                 spa_config_exit(spa, SCL_L2ARC, vd);
3179                         if (l2arc_ndev != 0) {
3180                                 DTRACE_PROBE1(l2arc__miss,
3181                                     arc_buf_hdr_t *, hdr);
3182                                 ARCSTAT_BUMP(arcstat_l2_misses);
3183                         }
3184                 }
3185
3186                 rzio = zio_read(pio, spa, bp, buf->b_data, size,
3187                     arc_read_done, buf, priority, zio_flags, zb);
3188
3189                 if (*arc_flags & ARC_WAIT)
3190                         return (zio_wait(rzio));
3191
3192                 ASSERT(*arc_flags & ARC_NOWAIT);
3193                 zio_nowait(rzio);
3194         }
3195         return (0);
3196 }
3197
3198 arc_prune_t *
3199 arc_add_prune_callback(arc_prune_func_t *func, void *private)
3200 {
3201         arc_prune_t *p;
3202
3203         p = kmem_alloc(sizeof(*p), KM_SLEEP);
3204         p->p_pfunc = func;
3205         p->p_private = private;
3206         list_link_init(&p->p_node);
3207         refcount_create(&p->p_refcnt);
3208
3209         mutex_enter(&arc_prune_mtx);
3210         refcount_add(&p->p_refcnt, &arc_prune_list);
3211         list_insert_head(&arc_prune_list, p);
3212         mutex_exit(&arc_prune_mtx);
3213
3214         return (p);
3215 }
3216
3217 void
3218 arc_remove_prune_callback(arc_prune_t *p)
3219 {
3220         mutex_enter(&arc_prune_mtx);
3221         list_remove(&arc_prune_list, p);
3222         if (refcount_remove(&p->p_refcnt, &arc_prune_list) == 0) {
3223                 refcount_destroy(&p->p_refcnt);
3224                 kmem_free(p, sizeof (*p));
3225         }
3226         mutex_exit(&arc_prune_mtx);
3227 }
3228
3229 void
3230 arc_set_callback(arc_buf_t *buf, arc_evict_func_t *func, void *private)
3231 {
3232         ASSERT(buf->b_hdr != NULL);
3233         ASSERT(buf->b_hdr->b_state != arc_anon);
3234         ASSERT(!refcount_is_zero(&buf->b_hdr->b_refcnt) || func == NULL);
3235         ASSERT(buf->b_efunc == NULL);
3236         ASSERT(!HDR_BUF_AVAILABLE(buf->b_hdr));
3237
3238         buf->b_efunc = func;
3239         buf->b_private = private;
3240 }
3241
3242 /*
3243  * This is used by the DMU to let the ARC know that a buffer is
3244  * being evicted, so the ARC should clean up.  If this arc buf
3245  * is not yet in the evicted state, it will be put there.
3246  */
3247 int
3248 arc_buf_evict(arc_buf_t *buf)
3249 {
3250         arc_buf_hdr_t *hdr;
3251         kmutex_t *hash_lock;
3252         arc_buf_t **bufp;
3253
3254         mutex_enter(&buf->b_evict_lock);
3255         hdr = buf->b_hdr;
3256         if (hdr == NULL) {
3257                 /*
3258                  * We are in arc_do_user_evicts().
3259                  */
3260                 ASSERT(buf->b_data == NULL);
3261                 mutex_exit(&buf->b_evict_lock);
3262                 return (0);
3263         } else if (buf->b_data == NULL) {
3264                 arc_buf_t copy = *buf; /* structure assignment */
3265                 /*
3266                  * We are on the eviction list; process this buffer now
3267                  * but let arc_do_user_evicts() do the reaping.
3268                  */
3269                 buf->b_efunc = NULL;
3270                 mutex_exit(&buf->b_evict_lock);
3271                 VERIFY(copy.b_efunc(&copy) == 0);
3272                 return (1);
3273         }
3274         hash_lock = HDR_LOCK(hdr);
3275         mutex_enter(hash_lock);
3276         hdr = buf->b_hdr;
3277         ASSERT3P(hash_lock, ==, HDR_LOCK(hdr));
3278
3279         ASSERT3U(refcount_count(&hdr->b_refcnt), <, hdr->b_datacnt);
3280         ASSERT(hdr->b_state == arc_mru || hdr->b_state == arc_mfu);
3281
3282         /*
3283          * Pull this buffer off of the hdr
3284          */
3285         bufp = &hdr->b_buf;
3286         while (*bufp != buf)
3287                 bufp = &(*bufp)->b_next;
3288         *bufp = buf->b_next;
3289
3290         ASSERT(buf->b_data != NULL);
3291         arc_buf_destroy(buf, FALSE, FALSE);
3292
3293         if (hdr->b_datacnt == 0) {
3294                 arc_state_t *old_state = hdr->b_state;
3295                 arc_state_t *evicted_state;
3296
3297                 ASSERT(hdr->b_buf == NULL);
3298                 ASSERT(refcount_is_zero(&hdr->b_refcnt));
3299
3300                 evicted_state =
3301                     (old_state == arc_mru) ? arc_mru_ghost : arc_mfu_ghost;
3302
3303                 mutex_enter(&old_state->arcs_mtx);
3304                 mutex_enter(&evicted_state->arcs_mtx);
3305
3306                 arc_change_state(evicted_state, hdr, hash_lock);
3307                 ASSERT(HDR_IN_HASH_TABLE(hdr));
3308                 hdr->b_flags |= ARC_IN_HASH_TABLE;
3309                 hdr->b_flags &= ~ARC_BUF_AVAILABLE;
3310
3311                 mutex_exit(&evicted_state->arcs_mtx);
3312                 mutex_exit(&old_state->arcs_mtx);
3313         }
3314         mutex_exit(hash_lock);
3315         mutex_exit(&buf->b_evict_lock);
3316
3317         VERIFY(buf->b_efunc(buf) == 0);
3318         buf->b_efunc = NULL;
3319         buf->b_private = NULL;
3320         buf->b_hdr = NULL;
3321         buf->b_next = NULL;
3322         kmem_cache_free(buf_cache, buf);
3323         return (1);
3324 }
3325
3326 /*
3327  * Release this buffer from the cache.  This must be done
3328  * after a read and prior to modifying the buffer contents.
3329  * If the buffer has more than one reference, we must make
3330  * a new hdr for the buffer.
3331  */
3332 void
3333 arc_release(arc_buf_t *buf, void *tag)
3334 {
3335         arc_buf_hdr_t *hdr;
3336         kmutex_t *hash_lock = NULL;
3337         l2arc_buf_hdr_t *l2hdr;
3338         uint64_t buf_size = 0;
3339
3340         /*
3341          * It would be nice to assert that if it's DMU metadata (level >
3342          * 0 || it's the dnode file), then it must be syncing context.
3343          * But we don't know that information at this level.
3344          */
3345
3346         mutex_enter(&buf->b_evict_lock);
3347         hdr = buf->b_hdr;
3348
3349         /* this buffer is not on any list */
3350         ASSERT(refcount_count(&hdr->b_refcnt) > 0);
3351
3352         if (hdr->b_state == arc_anon) {
3353                 /* this buffer is already released */
3354                 ASSERT(buf->b_efunc == NULL);
3355         } else {
3356                 hash_lock = HDR_LOCK(hdr);
3357                 mutex_enter(hash_lock);
3358                 hdr = buf->b_hdr;
3359                 ASSERT3P(hash_lock, ==, HDR_LOCK(hdr));
3360         }
3361
3362         l2hdr = hdr->b_l2hdr;
3363         if (l2hdr) {
3364                 mutex_enter(&l2arc_buflist_mtx);
3365                 hdr->b_l2hdr = NULL;
3366                 buf_size = hdr->b_size;
3367         }
3368
3369         /*
3370          * Do we have more than one buf?
3371          */
3372         if (hdr->b_datacnt > 1) {
3373                 arc_buf_hdr_t *nhdr;
3374                 arc_buf_t **bufp;
3375                 uint64_t blksz = hdr->b_size;
3376                 uint64_t spa = hdr->b_spa;
3377                 arc_buf_contents_t type = hdr->b_type;
3378                 uint32_t flags = hdr->b_flags;
3379
3380                 ASSERT(hdr->b_buf != buf || buf->b_next != NULL);
3381                 /*
3382                  * Pull the data off of this hdr and attach it to
3383                  * a new anonymous hdr.
3384                  */
3385                 (void) remove_reference(hdr, hash_lock, tag);
3386                 bufp = &hdr->b_buf;
3387                 while (*bufp != buf)
3388                         bufp = &(*bufp)->b_next;
3389                 *bufp = buf->b_next;
3390                 buf->b_next = NULL;
3391
3392                 ASSERT3U(hdr->b_state->arcs_size, >=, hdr->b_size);
3393                 atomic_add_64(&hdr->b_state->arcs_size, -hdr->b_size);
3394                 if (refcount_is_zero(&hdr->b_refcnt)) {
3395                         uint64_t *size = &hdr->b_state->arcs_lsize[hdr->b_type];
3396                         ASSERT3U(*size, >=, hdr->b_size);
3397                         atomic_add_64(size, -hdr->b_size);
3398                 }
3399
3400                 /*
3401                  * We're releasing a duplicate user data buffer, update
3402                  * our statistics accordingly.
3403                  */
3404                 if (hdr->b_type == ARC_BUFC_DATA) {
3405                         ARCSTAT_BUMPDOWN(arcstat_duplicate_buffers);
3406                         ARCSTAT_INCR(arcstat_duplicate_buffers_size,
3407                             -hdr->b_size);
3408                 }
3409                 hdr->b_datacnt -= 1;
3410                 arc_cksum_verify(buf);
3411
3412                 mutex_exit(hash_lock);
3413
3414                 nhdr = kmem_cache_alloc(hdr_cache, KM_PUSHPAGE);
3415                 nhdr->b_size = blksz;
3416                 nhdr->b_spa = spa;
3417                 nhdr->b_type = type;
3418                 nhdr->b_buf = buf;
3419                 nhdr->b_state = arc_anon;
3420                 nhdr->b_arc_access = 0;
3421                 nhdr->b_flags = flags & ARC_L2_WRITING;
3422                 nhdr->b_l2hdr = NULL;
3423                 nhdr->b_datacnt = 1;
3424                 nhdr->b_freeze_cksum = NULL;
3425                 (void) refcount_add(&nhdr->b_refcnt, tag);
3426                 buf->b_hdr = nhdr;
3427                 mutex_exit(&buf->b_evict_lock);
3428                 atomic_add_64(&arc_anon->arcs_size, blksz);
3429         } else {
3430                 mutex_exit(&buf->b_evict_lock);
3431                 ASSERT(refcount_count(&hdr->b_refcnt) == 1);
3432                 ASSERT(!list_link_active(&hdr->b_arc_node));
3433                 ASSERT(!HDR_IO_IN_PROGRESS(hdr));
3434                 if (hdr->b_state != arc_anon)
3435                         arc_change_state(arc_anon, hdr, hash_lock);
3436                 hdr->b_arc_access = 0;
3437                 if (hash_lock)
3438                         mutex_exit(hash_lock);
3439
3440                 buf_discard_identity(hdr);
3441                 arc_buf_thaw(buf);
3442         }
3443         buf->b_efunc = NULL;
3444         buf->b_private = NULL;
3445
3446         if (l2hdr) {
3447                 list_remove(l2hdr->b_dev->l2ad_buflist, hdr);
3448                 kmem_free(l2hdr, sizeof (l2arc_buf_hdr_t));
3449                 ARCSTAT_INCR(arcstat_l2_size, -buf_size);
3450                 mutex_exit(&l2arc_buflist_mtx);
3451         }
3452 }
3453
3454 /*
3455  * Release this buffer.  If it does not match the provided BP, fill it
3456  * with that block's contents.
3457  */
3458 /* ARGSUSED */
3459 int
3460 arc_release_bp(arc_buf_t *buf, void *tag, blkptr_t *bp, spa_t *spa,
3461     zbookmark_t *zb)
3462 {
3463         arc_release(buf, tag);
3464         return (0);
3465 }
3466
3467 int
3468 arc_released(arc_buf_t *buf)
3469 {
3470         int released;
3471
3472         mutex_enter(&buf->b_evict_lock);
3473         released = (buf->b_data != NULL && buf->b_hdr->b_state == arc_anon);
3474         mutex_exit(&buf->b_evict_lock);
3475         return (released);
3476 }
3477
3478 int
3479 arc_has_callback(arc_buf_t *buf)
3480 {
3481         int callback;
3482
3483         mutex_enter(&buf->b_evict_lock);
3484         callback = (buf->b_efunc != NULL);
3485         mutex_exit(&buf->b_evict_lock);
3486         return (callback);
3487 }
3488
3489 #ifdef ZFS_DEBUG
3490 int
3491 arc_referenced(arc_buf_t *buf)
3492 {
3493         int referenced;
3494
3495         mutex_enter(&buf->b_evict_lock);
3496         referenced = (refcount_count(&buf->b_hdr->b_refcnt));
3497         mutex_exit(&buf->b_evict_lock);
3498         return (referenced);
3499 }
3500 #endif
3501
3502 static void
3503 arc_write_ready(zio_t *zio)
3504 {
3505         arc_write_callback_t *callback = zio->io_private;
3506         arc_buf_t *buf = callback->awcb_buf;
3507         arc_buf_hdr_t *hdr = buf->b_hdr;
3508
3509         ASSERT(!refcount_is_zero(&buf->b_hdr->b_refcnt));
3510         callback->awcb_ready(zio, buf, callback->awcb_private);
3511
3512         /*
3513          * If the IO is already in progress, then this is a re-write
3514          * attempt, so we need to thaw and re-compute the cksum.
3515          * It is the responsibility of the callback to handle the
3516          * accounting for any re-write attempt.
3517          */
3518         if (HDR_IO_IN_PROGRESS(hdr)) {
3519                 mutex_enter(&hdr->b_freeze_lock);
3520                 if (hdr->b_freeze_cksum != NULL) {
3521                         kmem_free(hdr->b_freeze_cksum, sizeof (zio_cksum_t));
3522                         hdr->b_freeze_cksum = NULL;
3523                 }
3524                 mutex_exit(&hdr->b_freeze_lock);
3525         }
3526         arc_cksum_compute(buf, B_FALSE);
3527         hdr->b_flags |= ARC_IO_IN_PROGRESS;
3528 }
3529
3530 static void
3531 arc_write_done(zio_t *zio)
3532 {
3533         arc_write_callback_t *callback = zio->io_private;
3534         arc_buf_t *buf = callback->awcb_buf;
3535         arc_buf_hdr_t *hdr = buf->b_hdr;
3536
3537         ASSERT(hdr->b_acb == NULL);
3538
3539         if (zio->io_error == 0) {
3540                 hdr->b_dva = *BP_IDENTITY(zio->io_bp);
3541                 hdr->b_birth = BP_PHYSICAL_BIRTH(zio->io_bp);
3542                 hdr->b_cksum0 = zio->io_bp->blk_cksum.zc_word[0];
3543         } else {
3544                 ASSERT(BUF_EMPTY(hdr));
3545         }
3546
3547         /*
3548          * If the block to be written was all-zero, we may have
3549          * compressed it away.  In this case no write was performed
3550          * so there will be no dva/birth/checksum.  The buffer must
3551          * therefore remain anonymous (and uncached).
3552          */
3553         if (!BUF_EMPTY(hdr)) {
3554                 arc_buf_hdr_t *exists;
3555                 kmutex_t *hash_lock;
3556
3557                 ASSERT(zio->io_error == 0);
3558
3559                 arc_cksum_verify(buf);
3560
3561                 exists = buf_hash_insert(hdr, &hash_lock);
3562                 if (exists) {
3563                         /*
3564                          * This can only happen if we overwrite for
3565                          * sync-to-convergence, because we remove
3566                          * buffers from the hash table when we arc_free().
3567                          */
3568                         if (zio->io_flags & ZIO_FLAG_IO_REWRITE) {
3569                                 if (!BP_EQUAL(&zio->io_bp_orig, zio->io_bp))
3570                                         panic("bad overwrite, hdr=%p exists=%p",
3571                                             (void *)hdr, (void *)exists);
3572                                 ASSERT(refcount_is_zero(&exists->b_refcnt));
3573                                 arc_change_state(arc_anon, exists, hash_lock);
3574                                 mutex_exit(hash_lock);
3575                                 arc_hdr_destroy(exists);
3576                                 exists = buf_hash_insert(hdr, &hash_lock);
3577                                 ASSERT3P(exists, ==, NULL);
3578                         } else {
3579                                 /* Dedup */
3580                                 ASSERT(hdr->b_datacnt == 1);
3581                                 ASSERT(hdr->b_state == arc_anon);
3582                                 ASSERT(BP_GET_DEDUP(zio->io_bp));
3583                                 ASSERT(BP_GET_LEVEL(zio->io_bp) == 0);
3584                         }
3585                 }
3586                 hdr->b_flags &= ~ARC_IO_IN_PROGRESS;
3587                 /* if it's not anon, we are doing a scrub */
3588                 if (!exists && hdr->b_state == arc_anon)
3589                         arc_access(hdr, hash_lock);
3590                 mutex_exit(hash_lock);
3591         } else {
3592                 hdr->b_flags &= ~ARC_IO_IN_PROGRESS;
3593         }
3594
3595         ASSERT(!refcount_is_zero(&hdr->b_refcnt));
3596         callback->awcb_done(zio, buf, callback->awcb_private);
3597
3598         kmem_free(callback, sizeof (arc_write_callback_t));
3599 }
3600
3601 zio_t *
3602 arc_write(zio_t *pio, spa_t *spa, uint64_t txg,
3603     blkptr_t *bp, arc_buf_t *buf, boolean_t l2arc, const zio_prop_t *zp,
3604     arc_done_func_t *ready, arc_done_func_t *done, void *private,
3605     int priority, int zio_flags, const zbookmark_t *zb)
3606 {
3607         arc_buf_hdr_t *hdr = buf->b_hdr;
3608         arc_write_callback_t *callback;
3609         zio_t *zio;
3610
3611         ASSERT(ready != NULL);
3612         ASSERT(done != NULL);
3613         ASSERT(!HDR_IO_ERROR(hdr));
3614         ASSERT((hdr->b_flags & ARC_IO_IN_PROGRESS) == 0);
3615         ASSERT(hdr->b_acb == NULL);
3616         if (l2arc)
3617                 hdr->b_flags |= ARC_L2CACHE;
3618         callback = kmem_zalloc(sizeof (arc_write_callback_t), KM_PUSHPAGE);
3619         callback->awcb_ready = ready;
3620         callback->awcb_done = done;
3621         callback->awcb_private = private;
3622         callback->awcb_buf = buf;
3623
3624         zio = zio_write(pio, spa, txg, bp, buf->b_data, hdr->b_size, zp,
3625             arc_write_ready, arc_write_done, callback, priority, zio_flags, zb);
3626
3627         return (zio);
3628 }
3629
3630 static int
3631 arc_memory_throttle(uint64_t reserve, uint64_t inflight_data, uint64_t txg)
3632 {
3633 #ifdef _KERNEL
3634         uint64_t available_memory;
3635
3636         /* Easily reclaimable memory (free + inactive + arc-evictable) */
3637         available_memory = ptob(spl_kmem_availrmem()) + arc_evictable_memory();
3638
3639         if (available_memory <= zfs_write_limit_max) {
3640                 ARCSTAT_INCR(arcstat_memory_throttle_count, 1);
3641                 DMU_TX_STAT_BUMP(dmu_tx_memory_reclaim);
3642                 return (EAGAIN);
3643         }
3644
3645         if (inflight_data > available_memory / 4) {
3646                 ARCSTAT_INCR(arcstat_memory_throttle_count, 1);
3647                 DMU_TX_STAT_BUMP(dmu_tx_memory_inflight);
3648                 return (ERESTART);
3649         }
3650 #endif
3651         return (0);
3652 }
3653
3654 void
3655 arc_tempreserve_clear(uint64_t reserve)
3656 {
3657         atomic_add_64(&arc_tempreserve, -reserve);
3658         ASSERT((int64_t)arc_tempreserve >= 0);
3659 }
3660
3661 int
3662 arc_tempreserve_space(uint64_t reserve, uint64_t txg)
3663 {
3664         int error;
3665         uint64_t anon_size;
3666
3667 #ifdef ZFS_DEBUG
3668         /*
3669          * Once in a while, fail for no reason.  Everything should cope.
3670          */
3671         if (spa_get_random(10000) == 0) {
3672                 dprintf("forcing random failure\n");
3673                 return (ERESTART);
3674         }
3675 #endif
3676         if (reserve > arc_c/4 && !arc_no_grow)
3677                 arc_c = MIN(arc_c_max, reserve * 4);
3678         if (reserve > arc_c) {
3679                 DMU_TX_STAT_BUMP(dmu_tx_memory_reserve);
3680                 return (ENOMEM);
3681         }
3682
3683         /*
3684          * Don't count loaned bufs as in flight dirty data to prevent long
3685          * network delays from blocking transactions that are ready to be
3686          * assigned to a txg.
3687          */
3688         anon_size = MAX((int64_t)(arc_anon->arcs_size - arc_loaned_bytes), 0);
3689
3690         /*
3691          * Writes will, almost always, require additional memory allocations
3692          * in order to compress/encrypt/etc the data.  We therefor need to
3693          * make sure that there is sufficient available memory for this.
3694          */
3695         if ((error = arc_memory_throttle(reserve, anon_size, txg)))
3696                 return (error);
3697
3698         /*
3699          * Throttle writes when the amount of dirty data in the cache
3700          * gets too large.  We try to keep the cache less than half full
3701          * of dirty blocks so that our sync times don't grow too large.
3702          * Note: if two requests come in concurrently, we might let them
3703          * both succeed, when one of them should fail.  Not a huge deal.
3704          */
3705
3706         if (reserve + arc_tempreserve + anon_size > arc_c / 2 &&
3707             anon_size > arc_c / 4) {
3708                 dprintf("failing, arc_tempreserve=%lluK anon_meta=%lluK "
3709                     "anon_data=%lluK tempreserve=%lluK arc_c=%lluK\n",
3710                     arc_tempreserve>>10,
3711                     arc_anon->arcs_lsize[ARC_BUFC_METADATA]>>10,
3712                     arc_anon->arcs_lsize[ARC_BUFC_DATA]>>10,
3713                     reserve>>10, arc_c>>10);
3714                 DMU_TX_STAT_BUMP(dmu_tx_dirty_throttle);
3715                 return (ERESTART);
3716         }
3717         atomic_add_64(&arc_tempreserve, reserve);
3718         return (0);
3719 }
3720
3721 static void
3722 arc_kstat_update_state(arc_state_t *state, kstat_named_t *size,
3723     kstat_named_t *evict_data, kstat_named_t *evict_metadata)
3724 {
3725         size->value.ui64 = state->arcs_size;
3726         evict_data->value.ui64 = state->arcs_lsize[ARC_BUFC_DATA];
3727         evict_metadata->value.ui64 = state->arcs_lsize[ARC_BUFC_METADATA];
3728 }
3729
3730 static int
3731 arc_kstat_update(kstat_t *ksp, int rw)
3732 {
3733         arc_stats_t *as = ksp->ks_data;
3734
3735         if (rw == KSTAT_WRITE) {
3736                 return (EACCES);
3737         } else {
3738                 arc_kstat_update_state(arc_anon,
3739                     &as->arcstat_anon_size,
3740                     &as->arcstat_anon_evict_data,
3741                     &as->arcstat_anon_evict_metadata);
3742                 arc_kstat_update_state(arc_mru,
3743                     &as->arcstat_mru_size,
3744                     &as->arcstat_mru_evict_data,
3745                     &as->arcstat_mru_evict_metadata);
3746                 arc_kstat_update_state(arc_mru_ghost,
3747                     &as->arcstat_mru_ghost_size,
3748                     &as->arcstat_mru_ghost_evict_data,
3749                     &as->arcstat_mru_ghost_evict_metadata);
3750                 arc_kstat_update_state(arc_mfu,
3751                     &as->arcstat_mfu_size,
3752                     &as->arcstat_mfu_evict_data,
3753                     &as->arcstat_mfu_evict_metadata);
3754                 arc_kstat_update_state(arc_mfu_ghost,
3755                     &as->arcstat_mfu_ghost_size,
3756                     &as->arcstat_mfu_ghost_evict_data,
3757                     &as->arcstat_mfu_ghost_evict_metadata);
3758         }
3759
3760         return (0);
3761 }
3762
3763 void
3764 arc_init(void)
3765 {
3766         mutex_init(&arc_reclaim_thr_lock, NULL, MUTEX_DEFAULT, NULL);
3767         cv_init(&arc_reclaim_thr_cv, NULL, CV_DEFAULT, NULL);
3768
3769         /* Convert seconds to clock ticks */
3770         arc_min_prefetch_lifespan = 1 * hz;
3771
3772         /* Start out with 1/8 of all memory */
3773         arc_c = physmem * PAGESIZE / 8;
3774
3775 #ifdef _KERNEL
3776         /*
3777          * On architectures where the physical memory can be larger
3778          * than the addressable space (intel in 32-bit mode), we may
3779          * need to limit the cache to 1/8 of VM size.
3780          */
3781         arc_c = MIN(arc_c, vmem_size(heap_arena, VMEM_ALLOC | VMEM_FREE) / 8);
3782         /*
3783          * Register a shrinker to support synchronous (direct) memory
3784          * reclaim from the arc.  This is done to prevent kswapd from
3785          * swapping out pages when it is preferable to shrink the arc.
3786          */
3787         spl_register_shrinker(&arc_shrinker);
3788 #endif
3789
3790         /* set min cache to 1/32 of all memory, or 64MB, whichever is more */
3791         arc_c_min = MAX(arc_c / 4, 64<<20);
3792         /* set max to 1/2 of all memory */
3793         arc_c_max = MAX(arc_c * 4, arc_c_max);
3794
3795         /*
3796          * Allow the tunables to override our calculations if they are
3797          * reasonable (ie. over 64MB)
3798          */
3799         if (zfs_arc_max > 64<<20 && zfs_arc_max < physmem * PAGESIZE)
3800                 arc_c_max = zfs_arc_max;
3801         if (zfs_arc_min > 64<<20 && zfs_arc_min <= arc_c_max)
3802                 arc_c_min = zfs_arc_min;
3803
3804         arc_c = arc_c_max;
3805         arc_p = (arc_c >> 1);
3806
3807         /* limit meta-data to 1/4 of the arc capacity */
3808         arc_meta_limit = arc_c_max / 4;
3809         arc_meta_max = 0;
3810
3811         /* Allow the tunable to override if it is reasonable */
3812         if (zfs_arc_meta_limit > 0 && zfs_arc_meta_limit <= arc_c_max)
3813                 arc_meta_limit = zfs_arc_meta_limit;
3814
3815         if (arc_c_min < arc_meta_limit / 2 && zfs_arc_min == 0)
3816                 arc_c_min = arc_meta_limit / 2;
3817
3818         if (zfs_arc_grow_retry > 0)
3819                 arc_grow_retry = zfs_arc_grow_retry;
3820
3821         if (zfs_arc_shrink_shift > 0)
3822                 arc_shrink_shift = zfs_arc_shrink_shift;
3823
3824         if (zfs_arc_p_min_shift > 0)
3825                 arc_p_min_shift = zfs_arc_p_min_shift;
3826
3827         if (zfs_arc_meta_prune > 0)
3828                 arc_meta_prune = zfs_arc_meta_prune;
3829
3830         /* if kmem_flags are set, lets try to use less memory */
3831         if (kmem_debugging())
3832                 arc_c = arc_c / 2;
3833         if (arc_c < arc_c_min)
3834                 arc_c = arc_c_min;
3835
3836         arc_anon = &ARC_anon;
3837         arc_mru = &ARC_mru;
3838         arc_mru_ghost = &ARC_mru_ghost;
3839         arc_mfu = &ARC_mfu;
3840         arc_mfu_ghost = &ARC_mfu_ghost;
3841         arc_l2c_only = &ARC_l2c_only;
3842         arc_size = 0;
3843
3844         mutex_init(&arc_anon->arcs_mtx, NULL, MUTEX_DEFAULT, NULL);
3845         mutex_init(&arc_mru->arcs_mtx, NULL, MUTEX_DEFAULT, NULL);
3846         mutex_init(&arc_mru_ghost->arcs_mtx, NULL, MUTEX_DEFAULT, NULL);
3847         mutex_init(&arc_mfu->arcs_mtx, NULL, MUTEX_DEFAULT, NULL);
3848         mutex_init(&arc_mfu_ghost->arcs_mtx, NULL, MUTEX_DEFAULT, NULL);
3849         mutex_init(&arc_l2c_only->arcs_mtx, NULL, MUTEX_DEFAULT, NULL);
3850
3851         list_create(&arc_mru->arcs_list[ARC_BUFC_METADATA],
3852             sizeof (arc_buf_hdr_t), offsetof(arc_buf_hdr_t, b_arc_node));
3853         list_create(&arc_mru->arcs_list[ARC_BUFC_DATA],
3854             sizeof (arc_buf_hdr_t), offsetof(arc_buf_hdr_t, b_arc_node));
3855         list_create(&arc_mru_ghost->arcs_list[ARC_BUFC_METADATA],
3856             sizeof (arc_buf_hdr_t), offsetof(arc_buf_hdr_t, b_arc_node));
3857         list_create(&arc_mru_ghost->arcs_list[ARC_BUFC_DATA],
3858             sizeof (arc_buf_hdr_t), offsetof(arc_buf_hdr_t, b_arc_node));
3859         list_create(&arc_mfu->arcs_list[ARC_BUFC_METADATA],
3860             sizeof (arc_buf_hdr_t), offsetof(arc_buf_hdr_t, b_arc_node));
3861         list_create(&arc_mfu->arcs_list[ARC_BUFC_DATA],
3862             sizeof (arc_buf_hdr_t), offsetof(arc_buf_hdr_t, b_arc_node));
3863         list_create(&arc_mfu_ghost->arcs_list[ARC_BUFC_METADATA],
3864             sizeof (arc_buf_hdr_t), offsetof(arc_buf_hdr_t, b_arc_node));
3865         list_create(&arc_mfu_ghost->arcs_list[ARC_BUFC_DATA],
3866             sizeof (arc_buf_hdr_t), offsetof(arc_buf_hdr_t, b_arc_node));
3867         list_create(&arc_l2c_only->arcs_list[ARC_BUFC_METADATA],
3868             sizeof (arc_buf_hdr_t), offsetof(arc_buf_hdr_t, b_arc_node));
3869         list_create(&arc_l2c_only->arcs_list[ARC_BUFC_DATA],
3870             sizeof (arc_buf_hdr_t), offsetof(arc_buf_hdr_t, b_arc_node));
3871
3872         buf_init();
3873
3874         arc_thread_exit = 0;
3875         list_create(&arc_prune_list, sizeof (arc_prune_t),
3876             offsetof(arc_prune_t, p_node));
3877         arc_eviction_list = NULL;
3878         mutex_init(&arc_prune_mtx, NULL, MUTEX_DEFAULT, NULL);
3879         mutex_init(&arc_eviction_mtx, NULL, MUTEX_DEFAULT, NULL);
3880         bzero(&arc_eviction_hdr, sizeof (arc_buf_hdr_t));
3881
3882         arc_ksp = kstat_create("zfs", 0, "arcstats", "misc", KSTAT_TYPE_NAMED,
3883             sizeof (arc_stats) / sizeof (kstat_named_t), KSTAT_FLAG_VIRTUAL);
3884
3885         if (arc_ksp != NULL) {
3886                 arc_ksp->ks_data = &arc_stats;
3887                 arc_ksp->ks_update = arc_kstat_update;
3888                 kstat_install(arc_ksp);
3889         }
3890
3891         (void) thread_create(NULL, 0, arc_adapt_thread, NULL, 0, &p0,
3892             TS_RUN, minclsyspri);
3893
3894         arc_dead = FALSE;
3895         arc_warm = B_FALSE;
3896
3897         if (zfs_write_limit_max == 0)
3898                 zfs_write_limit_max = ptob(physmem) >> zfs_write_limit_shift;
3899         else
3900                 zfs_write_limit_shift = 0;
3901         mutex_init(&zfs_write_limit_lock, NULL, MUTEX_DEFAULT, NULL);
3902 }
3903
3904 void
3905 arc_fini(void)
3906 {
3907         arc_prune_t *p;
3908
3909         mutex_enter(&arc_reclaim_thr_lock);
3910 #ifdef _KERNEL
3911         spl_unregister_shrinker(&arc_shrinker);
3912 #endif /* _KERNEL */
3913
3914         arc_thread_exit = 1;
3915         while (arc_thread_exit != 0)
3916                 cv_wait(&arc_reclaim_thr_cv, &arc_reclaim_thr_lock);
3917         mutex_exit(&arc_reclaim_thr_lock);
3918
3919         arc_flush(NULL);
3920
3921         arc_dead = TRUE;
3922
3923         if (arc_ksp != NULL) {
3924                 kstat_delete(arc_ksp);
3925                 arc_ksp = NULL;
3926         }
3927
3928         mutex_enter(&arc_prune_mtx);
3929         while ((p = list_head(&arc_prune_list)) != NULL) {
3930                 list_remove(&arc_prune_list, p);
3931                 refcount_remove(&p->p_refcnt, &arc_prune_list);
3932                 refcount_destroy(&p->p_refcnt);
3933                 kmem_free(p, sizeof (*p));
3934         }
3935         mutex_exit(&arc_prune_mtx);
3936
3937         list_destroy(&arc_prune_list);
3938         mutex_destroy(&arc_prune_mtx);
3939         mutex_destroy(&arc_eviction_mtx);
3940         mutex_destroy(&arc_reclaim_thr_lock);
3941         cv_destroy(&arc_reclaim_thr_cv);
3942
3943         list_destroy(&arc_mru->arcs_list[ARC_BUFC_METADATA]);
3944         list_destroy(&arc_mru_ghost->arcs_list[ARC_BUFC_METADATA]);
3945         list_destroy(&arc_mfu->arcs_list[ARC_BUFC_METADATA]);
3946         list_destroy(&arc_mfu_ghost->arcs_list[ARC_BUFC_METADATA]);
3947         list_destroy(&arc_mru->arcs_list[ARC_BUFC_DATA]);
3948         list_destroy(&arc_mru_ghost->arcs_list[ARC_BUFC_DATA]);
3949         list_destroy(&arc_mfu->arcs_list[ARC_BUFC_DATA]);
3950         list_destroy(&arc_mfu_ghost->arcs_list[ARC_BUFC_DATA]);
3951
3952         mutex_destroy(&arc_anon->arcs_mtx);
3953         mutex_destroy(&arc_mru->arcs_mtx);
3954         mutex_destroy(&arc_mru_ghost->arcs_mtx);
3955         mutex_destroy(&arc_mfu->arcs_mtx);
3956         mutex_destroy(&arc_mfu_ghost->arcs_mtx);
3957         mutex_destroy(&arc_l2c_only->arcs_mtx);
3958
3959         mutex_destroy(&zfs_write_limit_lock);
3960
3961         buf_fini();
3962
3963         ASSERT(arc_loaned_bytes == 0);
3964 }
3965
3966 /*
3967  * Level 2 ARC
3968  *
3969  * The level 2 ARC (L2ARC) is a cache layer in-between main memory and disk.
3970  * It uses dedicated storage devices to hold cached data, which are populated
3971  * using large infrequent writes.  The main role of this cache is to boost
3972  * the performance of random read workloads.  The intended L2ARC devices
3973  * include short-stroked disks, solid state disks, and other media with
3974  * substantially faster read latency than disk.
3975  *
3976  *                 +-----------------------+
3977  *                 |         ARC           |
3978  *                 +-----------------------+
3979  *                    |         ^     ^
3980  *                    |         |     |
3981  *      l2arc_feed_thread()    arc_read()
3982  *                    |         |     |
3983  *                    |  l2arc read   |
3984  *                    V         |     |
3985  *               +---------------+    |
3986  *               |     L2ARC     |    |
3987  *               +---------------+    |
3988  *                   |    ^           |
3989  *          l2arc_write() |           |
3990  *                   |    |           |
3991  *                   V    |           |
3992  *                 +-------+      +-------+
3993  *                 | vdev  |      | vdev  |
3994  *                 | cache |      | cache |
3995  *                 +-------+      +-------+
3996  *                 +=========+     .-----.
3997  *                 :  L2ARC  :    |-_____-|
3998  *                 : devices :    | Disks |
3999  *                 +=========+    `-_____-'
4000  *
4001  * Read requests are satisfied from the following sources, in order:
4002  *
4003  *      1) ARC
4004  *      2) vdev cache of L2ARC devices
4005  *      3) L2ARC devices
4006  *      4) vdev cache of disks
4007  *      5) disks
4008  *
4009  * Some L2ARC device types exhibit extremely slow write performance.
4010  * To accommodate for this there are some significant differences between
4011  * the L2ARC and traditional cache design:
4012  *
4013  * 1. There is no eviction path from the ARC to the L2ARC.  Evictions from
4014  * the ARC behave as usual, freeing buffers and placing headers on ghost
4015  * lists.  The ARC does not send buffers to the L2ARC during eviction as
4016  * this would add inflated write latencies for all ARC memory pressure.
4017  *
4018  * 2. The L2ARC attempts to cache data from the ARC before it is evicted.
4019  * It does this by periodically scanning buffers from the eviction-end of
4020  * the MFU and MRU ARC lists, copying them to the L2ARC devices if they are
4021  * not already there.  It scans until a headroom of buffers is satisfied,
4022  * which itself is a buffer for ARC eviction.  The thread that does this is
4023  * l2arc_feed_thread(), illustrated below; example sizes are included to
4024  * provide a better sense of ratio than this diagram:
4025  *
4026  *             head -->                        tail
4027  *              +---------------------+----------+
4028  *      ARC_mfu |:::::#:::::::::::::::|o#o###o###|-->.   # already on L2ARC
4029  *              +---------------------+----------+   |   o L2ARC eligible
4030  *      ARC_mru |:#:::::::::::::::::::|#o#ooo####|-->|   : ARC buffer
4031  *              +---------------------+----------+   |
4032  *                   15.9 Gbytes      ^ 32 Mbytes    |
4033  *                                 headroom          |
4034  *                                            l2arc_feed_thread()
4035  *                                                   |
4036  *                       l2arc write hand <--[oooo]--'
4037  *                               |           8 Mbyte
4038  *                               |          write max
4039  *                               V
4040  *                +==============================+
4041  *      L2ARC dev |####|#|###|###|    |####| ... |
4042  *                +==============================+
4043  *                           32 Gbytes
4044  *
4045  * 3. If an ARC buffer is copied to the L2ARC but then hit instead of
4046  * evicted, then the L2ARC has cached a buffer much sooner than it probably
4047  * needed to, potentially wasting L2ARC device bandwidth and storage.  It is
4048  * safe to say that this is an uncommon case, since buffers at the end of
4049  * the ARC lists have moved there due to inactivity.
4050  *
4051  * 4. If the ARC evicts faster than the L2ARC can maintain a headroom,
4052  * then the L2ARC simply misses copying some buffers.  This serves as a
4053  * pressure valve to prevent heavy read workloads from both stalling the ARC
4054  * with waits and clogging the L2ARC with writes.  This also helps prevent
4055  * the potential for the L2ARC to churn if it attempts to cache content too
4056  * quickly, such as during backups of the entire pool.
4057  *
4058  * 5. After system boot and before the ARC has filled main memory, there are
4059  * no evictions from the ARC and so the tails of the ARC_mfu and ARC_mru
4060  * lists can remain mostly static.  Instead of searching from tail of these
4061  * lists as pictured, the l2arc_feed_thread() will search from the list heads
4062  * for eligible buffers, greatly increasing its chance of finding them.
4063  *
4064  * The L2ARC device write speed is also boosted during this time so that
4065  * the L2ARC warms up faster.  Since there have been no ARC evictions yet,
4066  * there are no L2ARC reads, and no fear of degrading read performance
4067  * through increased writes.
4068  *
4069  * 6. Writes to the L2ARC devices are grouped and sent in-sequence, so that
4070  * the vdev queue can aggregate them into larger and fewer writes.  Each
4071  * device is written to in a rotor fashion, sweeping writes through
4072  * available space then repeating.
4073  *
4074  * 7. The L2ARC does not store dirty content.  It never needs to flush
4075  * write buffers back to disk based storage.
4076  *
4077  * 8. If an ARC buffer is written (and dirtied) which also exists in the
4078  * L2ARC, the now stale L2ARC buffer is immediately dropped.
4079  *
4080  * The performance of the L2ARC can be tweaked by a number of tunables, which
4081  * may be necessary for different workloads:
4082  *
4083  *      l2arc_write_max         max write bytes per interval
4084  *      l2arc_write_boost       extra write bytes during device warmup
4085  *      l2arc_noprefetch        skip caching prefetched buffers
4086  *      l2arc_headroom          number of max device writes to precache
4087  *      l2arc_feed_secs         seconds between L2ARC writing
4088  *
4089  * Tunables may be removed or added as future performance improvements are
4090  * integrated, and also may become zpool properties.
4091  *
4092  * There are three key functions that control how the L2ARC warms up:
4093  *
4094  *      l2arc_write_eligible()  check if a buffer is eligible to cache
4095  *      l2arc_write_size()      calculate how much to write
4096  *      l2arc_write_interval()  calculate sleep delay between writes
4097  *
4098  * These three functions determine what to write, how much, and how quickly
4099  * to send writes.
4100  */
4101
4102 static boolean_t
4103 l2arc_write_eligible(uint64_t spa_guid, arc_buf_hdr_t *ab)
4104 {
4105         /*
4106          * A buffer is *not* eligible for the L2ARC if it:
4107          * 1. belongs to a different spa.
4108          * 2. is already cached on the L2ARC.
4109          * 3. has an I/O in progress (it may be an incomplete read).
4110          * 4. is flagged not eligible (zfs property).
4111          */
4112         if (ab->b_spa != spa_guid || ab->b_l2hdr != NULL ||
4113             HDR_IO_IN_PROGRESS(ab) || !HDR_L2CACHE(ab))
4114                 return (B_FALSE);
4115
4116         return (B_TRUE);
4117 }
4118
4119 static uint64_t
4120 l2arc_write_size(l2arc_dev_t *dev)
4121 {
4122         uint64_t size;
4123
4124         size = dev->l2ad_write;
4125
4126         if (arc_warm == B_FALSE)
4127                 size += dev->l2ad_boost;
4128
4129         return (size);
4130
4131 }
4132
4133 static clock_t
4134 l2arc_write_interval(clock_t began, uint64_t wanted, uint64_t wrote)
4135 {
4136         clock_t interval, next, now;
4137
4138         /*
4139          * If the ARC lists are busy, increase our write rate; if the
4140          * lists are stale, idle back.  This is achieved by checking
4141          * how much we previously wrote - if it was more than half of
4142          * what we wanted, schedule the next write much sooner.
4143          */
4144         if (l2arc_feed_again && wrote > (wanted / 2))
4145                 interval = (hz * l2arc_feed_min_ms) / 1000;
4146         else
4147                 interval = hz * l2arc_feed_secs;
4148
4149         now = ddi_get_lbolt();
4150         next = MAX(now, MIN(now + interval, began + interval));
4151
4152         return (next);
4153 }
4154
4155 static void
4156 l2arc_hdr_stat_add(void)
4157 {
4158         ARCSTAT_INCR(arcstat_l2_hdr_size, HDR_SIZE + L2HDR_SIZE);
4159         ARCSTAT_INCR(arcstat_hdr_size, -HDR_SIZE);
4160 }
4161
4162 static void
4163 l2arc_hdr_stat_remove(void)
4164 {
4165         ARCSTAT_INCR(arcstat_l2_hdr_size, -(HDR_SIZE + L2HDR_SIZE));
4166         ARCSTAT_INCR(arcstat_hdr_size, HDR_SIZE);
4167 }
4168
4169 /*
4170  * Cycle through L2ARC devices.  This is how L2ARC load balances.
4171  * If a device is returned, this also returns holding the spa config lock.
4172  */
4173 static l2arc_dev_t *
4174 l2arc_dev_get_next(void)
4175 {
4176         l2arc_dev_t *first, *next = NULL;
4177
4178         /*
4179          * Lock out the removal of spas (spa_namespace_lock), then removal
4180          * of cache devices (l2arc_dev_mtx).  Once a device has been selected,
4181          * both locks will be dropped and a spa config lock held instead.
4182          */
4183         mutex_enter(&spa_namespace_lock);
4184         mutex_enter(&l2arc_dev_mtx);
4185
4186         /* if there are no vdevs, there is nothing to do */
4187         if (l2arc_ndev == 0)
4188                 goto out;
4189
4190         first = NULL;
4191         next = l2arc_dev_last;
4192         do {
4193                 /* loop around the list looking for a non-faulted vdev */
4194                 if (next == NULL) {
4195                         next = list_head(l2arc_dev_list);
4196                 } else {
4197                         next = list_next(l2arc_dev_list, next);
4198                         if (next == NULL)
4199                                 next = list_head(l2arc_dev_list);
4200                 }
4201
4202                 /* if we have come back to the start, bail out */
4203                 if (first == NULL)
4204                         first = next;
4205                 else if (next == first)
4206                         break;
4207
4208         } while (vdev_is_dead(next->l2ad_vdev));
4209
4210         /* if we were unable to find any usable vdevs, return NULL */
4211         if (vdev_is_dead(next->l2ad_vdev))
4212                 next = NULL;
4213
4214         l2arc_dev_last = next;
4215
4216 out:
4217         mutex_exit(&l2arc_dev_mtx);
4218
4219         /*
4220          * Grab the config lock to prevent the 'next' device from being
4221          * removed while we are writing to it.
4222          */
4223         if (next != NULL)
4224                 spa_config_enter(next->l2ad_spa, SCL_L2ARC, next, RW_READER);
4225         mutex_exit(&spa_namespace_lock);
4226
4227         return (next);
4228 }
4229
4230 /*
4231  * Free buffers that were tagged for destruction.
4232  */
4233 static void
4234 l2arc_do_free_on_write(void)
4235 {
4236         list_t *buflist;
4237         l2arc_data_free_t *df, *df_prev;
4238
4239         mutex_enter(&l2arc_free_on_write_mtx);
4240         buflist = l2arc_free_on_write;
4241
4242         for (df = list_tail(buflist); df; df = df_prev) {
4243                 df_prev = list_prev(buflist, df);
4244                 ASSERT(df->l2df_data != NULL);
4245                 ASSERT(df->l2df_func != NULL);
4246                 df->l2df_func(df->l2df_data, df->l2df_size);
4247                 list_remove(buflist, df);
4248                 kmem_free(df, sizeof (l2arc_data_free_t));
4249         }
4250
4251         mutex_exit(&l2arc_free_on_write_mtx);
4252 }
4253
4254 /*
4255  * A write to a cache device has completed.  Update all headers to allow
4256  * reads from these buffers to begin.
4257  */
4258 static void
4259 l2arc_write_done(zio_t *zio)
4260 {
4261         l2arc_write_callback_t *cb;
4262         l2arc_dev_t *dev;
4263         list_t *buflist;
4264         arc_buf_hdr_t *head, *ab, *ab_prev;
4265         l2arc_buf_hdr_t *abl2;
4266         kmutex_t *hash_lock;
4267
4268         cb = zio->io_private;
4269         ASSERT(cb != NULL);
4270         dev = cb->l2wcb_dev;
4271         ASSERT(dev != NULL);
4272         head = cb->l2wcb_head;
4273         ASSERT(head != NULL);
4274         buflist = dev->l2ad_buflist;
4275         ASSERT(buflist != NULL);
4276         DTRACE_PROBE2(l2arc__iodone, zio_t *, zio,
4277             l2arc_write_callback_t *, cb);
4278
4279         if (zio->io_error != 0)
4280                 ARCSTAT_BUMP(arcstat_l2_writes_error);
4281
4282         mutex_enter(&l2arc_buflist_mtx);
4283
4284         /*
4285          * All writes completed, or an error was hit.
4286          */
4287         for (ab = list_prev(buflist, head); ab; ab = ab_prev) {
4288                 ab_prev = list_prev(buflist, ab);
4289
4290                 hash_lock = HDR_LOCK(ab);
4291                 if (!mutex_tryenter(hash_lock)) {
4292                         /*
4293                          * This buffer misses out.  It may be in a stage
4294                          * of eviction.  Its ARC_L2_WRITING flag will be
4295                          * left set, denying reads to this buffer.
4296                          */
4297                         ARCSTAT_BUMP(arcstat_l2_writes_hdr_miss);
4298                         continue;
4299                 }
4300
4301                 if (zio->io_error != 0) {
4302                         /*
4303                          * Error - drop L2ARC entry.
4304                          */
4305                         list_remove(buflist, ab);
4306                         abl2 = ab->b_l2hdr;
4307                         ab->b_l2hdr = NULL;
4308                         kmem_free(abl2, sizeof (l2arc_buf_hdr_t));
4309                         ARCSTAT_INCR(arcstat_l2_size, -ab->b_size);
4310                 }
4311
4312                 /*
4313                  * Allow ARC to begin reads to this L2ARC entry.
4314                  */
4315                 ab->b_flags &= ~ARC_L2_WRITING;
4316
4317                 mutex_exit(hash_lock);
4318         }
4319
4320         atomic_inc_64(&l2arc_writes_done);
4321         list_remove(buflist, head);
4322         kmem_cache_free(hdr_cache, head);
4323         mutex_exit(&l2arc_buflist_mtx);
4324
4325         l2arc_do_free_on_write();
4326
4327         kmem_free(cb, sizeof (l2arc_write_callback_t));
4328 }
4329
4330 /*
4331  * A read to a cache device completed.  Validate buffer contents before
4332  * handing over to the regular ARC routines.
4333  */
4334 static void
4335 l2arc_read_done(zio_t *zio)
4336 {
4337         l2arc_read_callback_t *cb;
4338         arc_buf_hdr_t *hdr;
4339         arc_buf_t *buf;
4340         kmutex_t *hash_lock;
4341         int equal;
4342
4343         ASSERT(zio->io_vd != NULL);
4344         ASSERT(zio->io_flags & ZIO_FLAG_DONT_PROPAGATE);
4345
4346         spa_config_exit(zio->io_spa, SCL_L2ARC, zio->io_vd);
4347
4348         cb = zio->io_private;
4349         ASSERT(cb != NULL);
4350         buf = cb->l2rcb_buf;
4351         ASSERT(buf != NULL);
4352
4353         hash_lock = HDR_LOCK(buf->b_hdr);
4354         mutex_enter(hash_lock);
4355         hdr = buf->b_hdr;
4356         ASSERT3P(hash_lock, ==, HDR_LOCK(hdr));
4357
4358         /*
4359          * Check this survived the L2ARC journey.
4360          */
4361         equal = arc_cksum_equal(buf);
4362         if (equal && zio->io_error == 0 && !HDR_L2_EVICTED(hdr)) {
4363                 mutex_exit(hash_lock);
4364                 zio->io_private = buf;
4365                 zio->io_bp_copy = cb->l2rcb_bp; /* XXX fix in L2ARC 2.0 */
4366                 zio->io_bp = &zio->io_bp_copy;  /* XXX fix in L2ARC 2.0 */
4367                 arc_read_done(zio);
4368         } else {
4369                 mutex_exit(hash_lock);
4370                 /*
4371                  * Buffer didn't survive caching.  Increment stats and
4372                  * reissue to the original storage device.
4373                  */
4374                 if (zio->io_error != 0) {
4375                         ARCSTAT_BUMP(arcstat_l2_io_error);
4376                 } else {
4377                         zio->io_error = EIO;
4378                 }
4379                 if (!equal)
4380                         ARCSTAT_BUMP(arcstat_l2_cksum_bad);
4381
4382                 /*
4383                  * If there's no waiter, issue an async i/o to the primary
4384                  * storage now.  If there *is* a waiter, the caller must
4385                  * issue the i/o in a context where it's OK to block.
4386                  */
4387                 if (zio->io_waiter == NULL) {
4388                         zio_t *pio = zio_unique_parent(zio);
4389
4390                         ASSERT(!pio || pio->io_child_type == ZIO_CHILD_LOGICAL);
4391
4392                         zio_nowait(zio_read(pio, cb->l2rcb_spa, &cb->l2rcb_bp,
4393                             buf->b_data, zio->io_size, arc_read_done, buf,
4394                             zio->io_priority, cb->l2rcb_flags, &cb->l2rcb_zb));
4395                 }
4396         }
4397
4398         kmem_free(cb, sizeof (l2arc_read_callback_t));
4399 }
4400
4401 /*
4402  * This is the list priority from which the L2ARC will search for pages to
4403  * cache.  This is used within loops (0..3) to cycle through lists in the
4404  * desired order.  This order can have a significant effect on cache
4405  * performance.
4406  *
4407  * Currently the metadata lists are hit first, MFU then MRU, followed by
4408  * the data lists.  This function returns a locked list, and also returns
4409  * the lock pointer.
4410  */
4411 static list_t *
4412 l2arc_list_locked(int list_num, kmutex_t **lock)
4413 {
4414         list_t *list = NULL;
4415
4416         ASSERT(list_num >= 0 && list_num <= 3);
4417
4418         switch (list_num) {
4419         case 0:
4420                 list = &arc_mfu->arcs_list[ARC_BUFC_METADATA];
4421                 *lock = &arc_mfu->arcs_mtx;
4422                 break;
4423         case 1:
4424                 list = &arc_mru->arcs_list[ARC_BUFC_METADATA];
4425                 *lock = &arc_mru->arcs_mtx;
4426                 break;
4427         case 2:
4428                 list = &arc_mfu->arcs_list[ARC_BUFC_DATA];
4429                 *lock = &arc_mfu->arcs_mtx;
4430                 break;
4431         case 3:
4432                 list = &arc_mru->arcs_list[ARC_BUFC_DATA];
4433                 *lock = &arc_mru->arcs_mtx;
4434                 break;
4435         }
4436
4437         ASSERT(!(MUTEX_HELD(*lock)));
4438         mutex_enter(*lock);
4439         return (list);
4440 }
4441
4442 /*
4443  * Evict buffers from the device write hand to the distance specified in
4444  * bytes.  This distance may span populated buffers, it may span nothing.
4445  * This is clearing a region on the L2ARC device ready for writing.
4446  * If the 'all' boolean is set, every buffer is evicted.
4447  */
4448 static void
4449 l2arc_evict(l2arc_dev_t *dev, uint64_t distance, boolean_t all)
4450 {
4451         list_t *buflist;
4452         l2arc_buf_hdr_t *abl2;
4453         arc_buf_hdr_t *ab, *ab_prev;
4454         kmutex_t *hash_lock;
4455         uint64_t taddr;
4456
4457         buflist = dev->l2ad_buflist;
4458
4459         if (buflist == NULL)
4460                 return;
4461
4462         if (!all && dev->l2ad_first) {
4463                 /*
4464                  * This is the first sweep through the device.  There is
4465                  * nothing to evict.
4466                  */
4467                 return;
4468         }
4469
4470         if (dev->l2ad_hand >= (dev->l2ad_end - (2 * distance))) {
4471                 /*
4472                  * When nearing the end of the device, evict to the end
4473                  * before the device write hand jumps to the start.
4474                  */
4475                 taddr = dev->l2ad_end;
4476         } else {
4477                 taddr = dev->l2ad_hand + distance;
4478         }
4479         DTRACE_PROBE4(l2arc__evict, l2arc_dev_t *, dev, list_t *, buflist,
4480             uint64_t, taddr, boolean_t, all);
4481
4482 top:
4483         mutex_enter(&l2arc_buflist_mtx);
4484         for (ab = list_tail(buflist); ab; ab = ab_prev) {
4485                 ab_prev = list_prev(buflist, ab);
4486
4487                 hash_lock = HDR_LOCK(ab);
4488                 if (!mutex_tryenter(hash_lock)) {
4489                         /*
4490                          * Missed the hash lock.  Retry.
4491                          */
4492                         ARCSTAT_BUMP(arcstat_l2_evict_lock_retry);
4493                         mutex_exit(&l2arc_buflist_mtx);
4494                         mutex_enter(hash_lock);
4495                         mutex_exit(hash_lock);
4496                         goto top;
4497                 }
4498
4499                 if (HDR_L2_WRITE_HEAD(ab)) {
4500                         /*
4501                          * We hit a write head node.  Leave it for
4502                          * l2arc_write_done().
4503                          */
4504                         list_remove(buflist, ab);
4505                         mutex_exit(hash_lock);
4506                         continue;
4507                 }
4508
4509                 if (!all && ab->b_l2hdr != NULL &&
4510                     (ab->b_l2hdr->b_daddr > taddr ||
4511                     ab->b_l2hdr->b_daddr < dev->l2ad_hand)) {
4512                         /*
4513                          * We've evicted to the target address,
4514                          * or the end of the device.
4515                          */
4516                         mutex_exit(hash_lock);
4517                         break;
4518                 }
4519
4520                 if (HDR_FREE_IN_PROGRESS(ab)) {
4521                         /*
4522                          * Already on the path to destruction.
4523                          */
4524                         mutex_exit(hash_lock);
4525                         continue;
4526                 }
4527
4528                 if (ab->b_state == arc_l2c_only) {
4529                         ASSERT(!HDR_L2_READING(ab));
4530                         /*
4531                          * This doesn't exist in the ARC.  Destroy.
4532                          * arc_hdr_destroy() will call list_remove()
4533                          * and decrement arcstat_l2_size.
4534                          */
4535                         arc_change_state(arc_anon, ab, hash_lock);
4536                         arc_hdr_destroy(ab);
4537                 } else {
4538                         /*
4539                          * Invalidate issued or about to be issued
4540                          * reads, since we may be about to write
4541                          * over this location.
4542                          */
4543                         if (HDR_L2_READING(ab)) {
4544                                 ARCSTAT_BUMP(arcstat_l2_evict_reading);
4545                                 ab->b_flags |= ARC_L2_EVICTED;
4546                         }
4547
4548                         /*
4549                          * Tell ARC this no longer exists in L2ARC.
4550                          */
4551                         if (ab->b_l2hdr != NULL) {
4552                                 abl2 = ab->b_l2hdr;
4553                                 ab->b_l2hdr = NULL;
4554                                 kmem_free(abl2, sizeof (l2arc_buf_hdr_t));
4555                                 ARCSTAT_INCR(arcstat_l2_size, -ab->b_size);
4556                         }
4557                         list_remove(buflist, ab);
4558
4559                         /*
4560                          * This may have been leftover after a
4561                          * failed write.
4562                          */
4563                         ab->b_flags &= ~ARC_L2_WRITING;
4564                 }
4565                 mutex_exit(hash_lock);
4566         }
4567         mutex_exit(&l2arc_buflist_mtx);
4568
4569         vdev_space_update(dev->l2ad_vdev, -(taddr - dev->l2ad_evict), 0, 0);
4570         dev->l2ad_evict = taddr;
4571 }
4572
4573 /*
4574  * Find and write ARC buffers to the L2ARC device.
4575  *
4576  * An ARC_L2_WRITING flag is set so that the L2ARC buffers are not valid
4577  * for reading until they have completed writing.
4578  */
4579 static uint64_t
4580 l2arc_write_buffers(spa_t *spa, l2arc_dev_t *dev, uint64_t target_sz)
4581 {
4582         arc_buf_hdr_t *ab, *ab_prev, *head;
4583         l2arc_buf_hdr_t *hdrl2;
4584         list_t *list;
4585         uint64_t passed_sz, write_sz, buf_sz, headroom;
4586         void *buf_data;
4587         kmutex_t *hash_lock, *list_lock = NULL;
4588         boolean_t have_lock, full;
4589         l2arc_write_callback_t *cb;
4590         zio_t *pio, *wzio;
4591         uint64_t guid = spa_load_guid(spa);
4592         int try;
4593
4594         ASSERT(dev->l2ad_vdev != NULL);
4595
4596         pio = NULL;
4597         write_sz = 0;
4598         full = B_FALSE;
4599         head = kmem_cache_alloc(hdr_cache, KM_PUSHPAGE);
4600         head->b_flags |= ARC_L2_WRITE_HEAD;
4601
4602         /*
4603          * Copy buffers for L2ARC writing.
4604          */
4605         mutex_enter(&l2arc_buflist_mtx);
4606         for (try = 0; try <= 3; try++) {
4607                 list = l2arc_list_locked(try, &list_lock);
4608                 passed_sz = 0;
4609
4610                 /*
4611                  * L2ARC fast warmup.
4612                  *
4613                  * Until the ARC is warm and starts to evict, read from the
4614                  * head of the ARC lists rather than the tail.
4615                  */
4616                 headroom = target_sz * l2arc_headroom;
4617                 if (arc_warm == B_FALSE)
4618                         ab = list_head(list);
4619                 else
4620                         ab = list_tail(list);
4621
4622                 for (; ab; ab = ab_prev) {
4623                         if (arc_warm == B_FALSE)
4624                                 ab_prev = list_next(list, ab);
4625                         else
4626                                 ab_prev = list_prev(list, ab);
4627
4628                         hash_lock = HDR_LOCK(ab);
4629                         have_lock = MUTEX_HELD(hash_lock);
4630                         if (!have_lock && !mutex_tryenter(hash_lock)) {
4631                                 /*
4632                                  * Skip this buffer rather than waiting.
4633                                  */
4634                                 continue;
4635                         }
4636
4637                         passed_sz += ab->b_size;
4638                         if (passed_sz > headroom) {
4639                                 /*
4640                                  * Searched too far.
4641                                  */
4642                                 mutex_exit(hash_lock);
4643                                 break;
4644                         }
4645
4646                         if (!l2arc_write_eligible(guid, ab)) {
4647                                 mutex_exit(hash_lock);
4648                                 continue;
4649                         }
4650
4651                         if ((write_sz + ab->b_size) > target_sz) {
4652                                 full = B_TRUE;
4653                                 mutex_exit(hash_lock);
4654                                 break;
4655                         }
4656
4657                         if (pio == NULL) {
4658                                 /*
4659                                  * Insert a dummy header on the buflist so
4660                                  * l2arc_write_done() can find where the
4661                                  * write buffers begin without searching.
4662                                  */
4663                                 list_insert_head(dev->l2ad_buflist, head);
4664
4665                                 cb = kmem_alloc(sizeof (l2arc_write_callback_t),
4666                                                 KM_PUSHPAGE);
4667                                 cb->l2wcb_dev = dev;
4668                                 cb->l2wcb_head = head;
4669                                 pio = zio_root(spa, l2arc_write_done, cb,
4670                                     ZIO_FLAG_CANFAIL);
4671                         }
4672
4673                         /*
4674                          * Create and add a new L2ARC header.
4675                          */
4676                         hdrl2 = kmem_zalloc(sizeof (l2arc_buf_hdr_t),
4677                                             KM_PUSHPAGE);
4678                         hdrl2->b_dev = dev;
4679                         hdrl2->b_daddr = dev->l2ad_hand;
4680
4681                         ab->b_flags |= ARC_L2_WRITING;
4682                         ab->b_l2hdr = hdrl2;
4683                         list_insert_head(dev->l2ad_buflist, ab);
4684                         buf_data = ab->b_buf->b_data;
4685                         buf_sz = ab->b_size;
4686
4687                         /*
4688                          * Compute and store the buffer cksum before
4689                          * writing.  On debug the cksum is verified first.
4690                          */
4691                         arc_cksum_verify(ab->b_buf);
4692                         arc_cksum_compute(ab->b_buf, B_TRUE);
4693
4694                         mutex_exit(hash_lock);
4695
4696                         wzio = zio_write_phys(pio, dev->l2ad_vdev,
4697                             dev->l2ad_hand, buf_sz, buf_data, ZIO_CHECKSUM_OFF,
4698                             NULL, NULL, ZIO_PRIORITY_ASYNC_WRITE,
4699                             ZIO_FLAG_CANFAIL, B_FALSE);
4700
4701                         DTRACE_PROBE2(l2arc__write, vdev_t *, dev->l2ad_vdev,
4702                             zio_t *, wzio);
4703                         (void) zio_nowait(wzio);
4704
4705                         /*
4706                          * Keep the clock hand suitably device-aligned.
4707                          */
4708                         buf_sz = vdev_psize_to_asize(dev->l2ad_vdev, buf_sz);
4709
4710                         write_sz += buf_sz;
4711                         dev->l2ad_hand += buf_sz;
4712                 }
4713
4714                 mutex_exit(list_lock);
4715
4716                 if (full == B_TRUE)
4717                         break;
4718         }
4719         mutex_exit(&l2arc_buflist_mtx);
4720
4721         if (pio == NULL) {
4722                 ASSERT3U(write_sz, ==, 0);
4723                 kmem_cache_free(hdr_cache, head);
4724                 return (0);
4725         }
4726
4727         ASSERT3U(write_sz, <=, target_sz);
4728         ARCSTAT_BUMP(arcstat_l2_writes_sent);
4729         ARCSTAT_INCR(arcstat_l2_write_bytes, write_sz);
4730         ARCSTAT_INCR(arcstat_l2_size, write_sz);
4731         vdev_space_update(dev->l2ad_vdev, write_sz, 0, 0);
4732
4733         /*
4734          * Bump device hand to the device start if it is approaching the end.
4735          * l2arc_evict() will already have evicted ahead for this case.
4736          */
4737         if (dev->l2ad_hand >= (dev->l2ad_end - target_sz)) {
4738                 vdev_space_update(dev->l2ad_vdev,
4739                     dev->l2ad_end - dev->l2ad_hand, 0, 0);
4740                 dev->l2ad_hand = dev->l2ad_start;
4741                 dev->l2ad_evict = dev->l2ad_start;
4742                 dev->l2ad_first = B_FALSE;
4743         }
4744
4745         dev->l2ad_writing = B_TRUE;
4746         (void) zio_wait(pio);
4747         dev->l2ad_writing = B_FALSE;
4748
4749         return (write_sz);
4750 }
4751
4752 /*
4753  * This thread feeds the L2ARC at regular intervals.  This is the beating
4754  * heart of the L2ARC.
4755  */
4756 static void
4757 l2arc_feed_thread(void)
4758 {
4759         callb_cpr_t cpr;
4760         l2arc_dev_t *dev;
4761         spa_t *spa;
4762         uint64_t size, wrote;
4763         clock_t begin, next = ddi_get_lbolt();
4764
4765         CALLB_CPR_INIT(&cpr, &l2arc_feed_thr_lock, callb_generic_cpr, FTAG);
4766
4767         mutex_enter(&l2arc_feed_thr_lock);
4768
4769         while (l2arc_thread_exit == 0) {
4770                 CALLB_CPR_SAFE_BEGIN(&cpr);
4771                 (void) cv_timedwait_interruptible(&l2arc_feed_thr_cv,
4772                     &l2arc_feed_thr_lock, next);
4773                 CALLB_CPR_SAFE_END(&cpr, &l2arc_feed_thr_lock);
4774                 next = ddi_get_lbolt() + hz;
4775
4776                 /*
4777                  * Quick check for L2ARC devices.
4778                  */
4779                 mutex_enter(&l2arc_dev_mtx);
4780                 if (l2arc_ndev == 0) {
4781                         mutex_exit(&l2arc_dev_mtx);
4782                         continue;
4783                 }
4784                 mutex_exit(&l2arc_dev_mtx);
4785                 begin = ddi_get_lbolt();
4786
4787                 /*
4788                  * This selects the next l2arc device to write to, and in
4789                  * doing so the next spa to feed from: dev->l2ad_spa.   This
4790                  * will return NULL if there are now no l2arc devices or if
4791                  * they are all faulted.
4792                  *
4793                  * If a device is returned, its spa's config lock is also
4794                  * held to prevent device removal.  l2arc_dev_get_next()
4795                  * will grab and release l2arc_dev_mtx.
4796                  */
4797                 if ((dev = l2arc_dev_get_next()) == NULL)
4798                         continue;
4799
4800                 spa = dev->l2ad_spa;
4801                 ASSERT(spa != NULL);
4802
4803                 /*
4804                  * If the pool is read-only then force the feed thread to
4805                  * sleep a little longer.
4806                  */
4807                 if (!spa_writeable(spa)) {
4808                         next = ddi_get_lbolt() + 5 * l2arc_feed_secs * hz;
4809                         spa_config_exit(spa, SCL_L2ARC, dev);
4810                         continue;
4811                 }
4812
4813                 /*
4814                  * Avoid contributing to memory pressure.
4815                  */
4816                 if (arc_no_grow) {
4817                         ARCSTAT_BUMP(arcstat_l2_abort_lowmem);
4818                         spa_config_exit(spa, SCL_L2ARC, dev);
4819                         continue;
4820                 }
4821
4822                 ARCSTAT_BUMP(arcstat_l2_feeds);
4823
4824                 size = l2arc_write_size(dev);
4825
4826                 /*
4827                  * Evict L2ARC buffers that will be overwritten.
4828                  */
4829                 l2arc_evict(dev, size, B_FALSE);
4830
4831                 /*
4832                  * Write ARC buffers.
4833                  */
4834                 wrote = l2arc_write_buffers(spa, dev, size);
4835
4836                 /*
4837                  * Calculate interval between writes.
4838                  */
4839                 next = l2arc_write_interval(begin, size, wrote);
4840                 spa_config_exit(spa, SCL_L2ARC, dev);
4841         }
4842
4843         l2arc_thread_exit = 0;
4844         cv_broadcast(&l2arc_feed_thr_cv);
4845         CALLB_CPR_EXIT(&cpr);           /* drops l2arc_feed_thr_lock */
4846         thread_exit();
4847 }
4848
4849 boolean_t
4850 l2arc_vdev_present(vdev_t *vd)
4851 {
4852         l2arc_dev_t *dev;
4853
4854         mutex_enter(&l2arc_dev_mtx);
4855         for (dev = list_head(l2arc_dev_list); dev != NULL;
4856             dev = list_next(l2arc_dev_list, dev)) {
4857                 if (dev->l2ad_vdev == vd)
4858                         break;
4859         }
4860         mutex_exit(&l2arc_dev_mtx);
4861
4862         return (dev != NULL);
4863 }
4864
4865 /*
4866  * Add a vdev for use by the L2ARC.  By this point the spa has already
4867  * validated the vdev and opened it.
4868  */
4869 void
4870 l2arc_add_vdev(spa_t *spa, vdev_t *vd)
4871 {
4872         l2arc_dev_t *adddev;
4873
4874         ASSERT(!l2arc_vdev_present(vd));
4875
4876         /*
4877          * Create a new l2arc device entry.
4878          */
4879         adddev = kmem_zalloc(sizeof (l2arc_dev_t), KM_SLEEP);
4880         adddev->l2ad_spa = spa;
4881         adddev->l2ad_vdev = vd;
4882         adddev->l2ad_write = l2arc_write_max;
4883         adddev->l2ad_boost = l2arc_write_boost;
4884         adddev->l2ad_start = VDEV_LABEL_START_SIZE;
4885         adddev->l2ad_end = VDEV_LABEL_START_SIZE + vdev_get_min_asize(vd);
4886         adddev->l2ad_hand = adddev->l2ad_start;
4887         adddev->l2ad_evict = adddev->l2ad_start;
4888         adddev->l2ad_first = B_TRUE;
4889         adddev->l2ad_writing = B_FALSE;
4890         list_link_init(&adddev->l2ad_node);
4891         ASSERT3U(adddev->l2ad_write, >, 0);
4892
4893         /*
4894          * This is a list of all ARC buffers that are still valid on the
4895          * device.
4896          */
4897         adddev->l2ad_buflist = kmem_zalloc(sizeof (list_t), KM_SLEEP);
4898         list_create(adddev->l2ad_buflist, sizeof (arc_buf_hdr_t),
4899             offsetof(arc_buf_hdr_t, b_l2node));
4900
4901         vdev_space_update(vd, 0, 0, adddev->l2ad_end - adddev->l2ad_hand);
4902
4903         /*
4904          * Add device to global list
4905          */
4906         mutex_enter(&l2arc_dev_mtx);
4907         list_insert_head(l2arc_dev_list, adddev);
4908         atomic_inc_64(&l2arc_ndev);
4909         mutex_exit(&l2arc_dev_mtx);
4910 }
4911
4912 /*
4913  * Remove a vdev from the L2ARC.
4914  */
4915 void
4916 l2arc_remove_vdev(vdev_t *vd)
4917 {
4918         l2arc_dev_t *dev, *nextdev, *remdev = NULL;
4919
4920         /*
4921          * Find the device by vdev
4922          */
4923         mutex_enter(&l2arc_dev_mtx);
4924         for (dev = list_head(l2arc_dev_list); dev; dev = nextdev) {
4925                 nextdev = list_next(l2arc_dev_list, dev);
4926                 if (vd == dev->l2ad_vdev) {
4927                         remdev = dev;
4928                         break;
4929                 }
4930         }
4931         ASSERT(remdev != NULL);
4932
4933         /*
4934          * Remove device from global list
4935          */
4936         list_remove(l2arc_dev_list, remdev);
4937         l2arc_dev_last = NULL;          /* may have been invalidated */
4938         atomic_dec_64(&l2arc_ndev);
4939         mutex_exit(&l2arc_dev_mtx);
4940
4941         /*
4942          * Clear all buflists and ARC references.  L2ARC device flush.
4943          */
4944         l2arc_evict(remdev, 0, B_TRUE);
4945         list_destroy(remdev->l2ad_buflist);
4946         kmem_free(remdev->l2ad_buflist, sizeof (list_t));
4947         kmem_free(remdev, sizeof (l2arc_dev_t));
4948 }
4949
4950 void
4951 l2arc_init(void)
4952 {
4953         l2arc_thread_exit = 0;
4954         l2arc_ndev = 0;
4955         l2arc_writes_sent = 0;
4956         l2arc_writes_done = 0;
4957
4958         mutex_init(&l2arc_feed_thr_lock, NULL, MUTEX_DEFAULT, NULL);
4959         cv_init(&l2arc_feed_thr_cv, NULL, CV_DEFAULT, NULL);
4960         mutex_init(&l2arc_dev_mtx, NULL, MUTEX_DEFAULT, NULL);
4961         mutex_init(&l2arc_buflist_mtx, NULL, MUTEX_DEFAULT, NULL);
4962         mutex_init(&l2arc_free_on_write_mtx, NULL, MUTEX_DEFAULT, NULL);
4963
4964         l2arc_dev_list = &L2ARC_dev_list;
4965         l2arc_free_on_write = &L2ARC_free_on_write;
4966         list_create(l2arc_dev_list, sizeof (l2arc_dev_t),
4967             offsetof(l2arc_dev_t, l2ad_node));
4968         list_create(l2arc_free_on_write, sizeof (l2arc_data_free_t),
4969             offsetof(l2arc_data_free_t, l2df_list_node));
4970 }
4971
4972 void
4973 l2arc_fini(void)
4974 {
4975         /*
4976          * This is called from dmu_fini(), which is called from spa_fini();
4977          * Because of this, we can assume that all l2arc devices have
4978          * already been removed when the pools themselves were removed.
4979          */
4980
4981         l2arc_do_free_on_write();
4982
4983         mutex_destroy(&l2arc_feed_thr_lock);
4984         cv_destroy(&l2arc_feed_thr_cv);
4985         mutex_destroy(&l2arc_dev_mtx);
4986         mutex_destroy(&l2arc_buflist_mtx);
4987         mutex_destroy(&l2arc_free_on_write_mtx);
4988
4989         list_destroy(l2arc_dev_list);
4990         list_destroy(l2arc_free_on_write);
4991 }
4992
4993 void
4994 l2arc_start(void)
4995 {
4996         if (!(spa_mode_global & FWRITE))
4997                 return;
4998
4999         (void) thread_create(NULL, 0, l2arc_feed_thread, NULL, 0, &p0,
5000             TS_RUN, minclsyspri);
5001 }
5002
5003 void
5004 l2arc_stop(void)
5005 {
5006         if (!(spa_mode_global & FWRITE))
5007                 return;
5008
5009         mutex_enter(&l2arc_feed_thr_lock);
5010         cv_signal(&l2arc_feed_thr_cv);  /* kick thread out of startup */
5011         l2arc_thread_exit = 1;
5012         while (l2arc_thread_exit != 0)
5013                 cv_wait(&l2arc_feed_thr_cv, &l2arc_feed_thr_lock);
5014         mutex_exit(&l2arc_feed_thr_lock);
5015 }
5016
5017 #if defined(_KERNEL) && defined(HAVE_SPL)
5018 EXPORT_SYMBOL(arc_read);
5019 EXPORT_SYMBOL(arc_buf_remove_ref);
5020 EXPORT_SYMBOL(arc_getbuf_func);
5021 EXPORT_SYMBOL(arc_add_prune_callback);
5022 EXPORT_SYMBOL(arc_remove_prune_callback);
5023
5024 module_param(zfs_arc_min, ulong, 0444);
5025 MODULE_PARM_DESC(zfs_arc_min, "Min arc size");
5026
5027 module_param(zfs_arc_max, ulong, 0444);
5028 MODULE_PARM_DESC(zfs_arc_max, "Max arc size");
5029
5030 module_param(zfs_arc_meta_limit, ulong, 0444);
5031 MODULE_PARM_DESC(zfs_arc_meta_limit, "Meta limit for arc size");
5032
5033 module_param(zfs_arc_meta_prune, int, 0444);
5034 MODULE_PARM_DESC(zfs_arc_meta_prune, "Bytes of meta data to prune");
5035
5036 module_param(zfs_arc_grow_retry, int, 0444);
5037 MODULE_PARM_DESC(zfs_arc_grow_retry, "Seconds before growing arc size");
5038
5039 module_param(zfs_arc_shrink_shift, int, 0444);
5040 MODULE_PARM_DESC(zfs_arc_shrink_shift, "log2(fraction of arc to reclaim)");
5041
5042 module_param(zfs_arc_p_min_shift, int, 0444);
5043 MODULE_PARM_DESC(zfs_arc_p_min_shift, "arc_c shift to calc min/max arc_p");
5044
5045 module_param(zfs_disable_dup_eviction, int, 0644);
5046 MODULE_PARM_DESC(zfs_disable_dup_eviction, "disable duplicate buffer eviction");
5047
5048 module_param(l2arc_write_max, ulong, 0444);
5049 MODULE_PARM_DESC(l2arc_write_max, "Max write bytes per interval");
5050
5051 module_param(l2arc_write_boost, ulong, 0444);
5052 MODULE_PARM_DESC(l2arc_write_boost, "Extra write bytes during device warmup");
5053
5054 module_param(l2arc_headroom, ulong, 0444);
5055 MODULE_PARM_DESC(l2arc_headroom, "Number of max device writes to precache");
5056
5057 module_param(l2arc_feed_secs, ulong, 0444);
5058 MODULE_PARM_DESC(l2arc_feed_secs, "Seconds between L2ARC writing");
5059
5060 module_param(l2arc_feed_min_ms, ulong, 0444);
5061 MODULE_PARM_DESC(l2arc_feed_min_ms, "Min feed interval in milliseconds");
5062
5063 module_param(l2arc_noprefetch, int, 0444);
5064 MODULE_PARM_DESC(l2arc_noprefetch, "Skip caching prefetched buffers");
5065
5066 module_param(l2arc_feed_again, int, 0444);
5067 MODULE_PARM_DESC(l2arc_feed_again, "Turbo L2ARC warmup");
5068
5069 module_param(l2arc_norw, int, 0444);
5070 MODULE_PARM_DESC(l2arc_norw, "No reads during writes");
5071
5072 #endif