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