2 * Copyright (c) 2000-2005 Silicon Graphics, Inc.
3 * Copyright (c) 2013 Red Hat, Inc.
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License as
8 * published by the Free Software Foundation.
10 * This program is distributed in the hope that it would be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write the Free Software Foundation,
17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
21 #include "xfs_shared.h"
22 #include "xfs_format.h"
23 #include "xfs_log_format.h"
24 #include "xfs_trans_resv.h"
26 #include "xfs_mount.h"
27 #include "xfs_da_format.h"
28 #include "xfs_da_btree.h"
29 #include "xfs_inode.h"
30 #include "xfs_alloc.h"
31 #include "xfs_trans.h"
32 #include "xfs_inode_item.h"
34 #include "xfs_bmap_util.h"
36 #include "xfs_attr_leaf.h"
37 #include "xfs_attr_remote.h"
38 #include "xfs_trans_space.h"
39 #include "xfs_trace.h"
40 #include "xfs_cksum.h"
41 #include "xfs_buf_item.h"
42 #include "xfs_error.h"
44 #define ATTR_RMTVALUE_MAPSIZE 1 /* # of map entries at once */
47 * Each contiguous block has a header, so it is not just a simple attribute
48 * length to FSB conversion.
55 if (xfs_sb_version_hascrc(&mp->m_sb)) {
56 int buflen = XFS_ATTR3_RMT_BUF_SPACE(mp, mp->m_sb.sb_blocksize);
57 return (attrlen + buflen - 1) / buflen;
59 return XFS_B_TO_FSB(mp, attrlen);
63 * Checking of the remote attribute header is split into two parts. The verifier
64 * does CRC, location and bounds checking, the unpacking function checks the
65 * attribute parameters and owner.
75 struct xfs_attr3_rmt_hdr *rmt = ptr;
77 if (bno != be64_to_cpu(rmt->rm_blkno))
79 if (offset != be32_to_cpu(rmt->rm_offset))
81 if (size != be32_to_cpu(rmt->rm_bytes))
83 if (ino != be64_to_cpu(rmt->rm_owner))
97 struct xfs_attr3_rmt_hdr *rmt = ptr;
99 if (!xfs_sb_version_hascrc(&mp->m_sb))
101 if (rmt->rm_magic != cpu_to_be32(XFS_ATTR3_RMT_MAGIC))
103 if (!uuid_equal(&rmt->rm_uuid, &mp->m_sb.sb_meta_uuid))
105 if (be64_to_cpu(rmt->rm_blkno) != bno)
107 if (be32_to_cpu(rmt->rm_bytes) > fsbsize - sizeof(*rmt))
109 if (be32_to_cpu(rmt->rm_offset) +
110 be32_to_cpu(rmt->rm_bytes) > XFS_XATTR_SIZE_MAX)
112 if (rmt->rm_owner == 0)
119 xfs_attr3_rmt_read_verify(
122 struct xfs_mount *mp = bp->b_target->bt_mount;
126 int blksize = mp->m_attr_geo->blksize;
128 /* no verification of non-crc buffers */
129 if (!xfs_sb_version_hascrc(&mp->m_sb))
134 len = BBTOB(bp->b_length);
135 ASSERT(len >= blksize);
138 if (!xfs_verify_cksum(ptr, blksize, XFS_ATTR3_RMT_CRC_OFF)) {
139 xfs_buf_ioerror(bp, -EFSBADCRC);
142 if (!xfs_attr3_rmt_verify(mp, ptr, blksize, bno)) {
143 xfs_buf_ioerror(bp, -EFSCORRUPTED);
148 bno += BTOBB(blksize);
152 xfs_verifier_error(bp);
158 xfs_attr3_rmt_write_verify(
161 struct xfs_mount *mp = bp->b_target->bt_mount;
162 int blksize = mp->m_attr_geo->blksize;
167 /* no verification of non-crc buffers */
168 if (!xfs_sb_version_hascrc(&mp->m_sb))
173 len = BBTOB(bp->b_length);
174 ASSERT(len >= blksize);
177 struct xfs_attr3_rmt_hdr *rmt = (struct xfs_attr3_rmt_hdr *)ptr;
179 if (!xfs_attr3_rmt_verify(mp, ptr, blksize, bno)) {
180 xfs_buf_ioerror(bp, -EFSCORRUPTED);
181 xfs_verifier_error(bp);
186 * Ensure we aren't writing bogus LSNs to disk. See
187 * xfs_attr3_rmt_hdr_set() for the explanation.
189 if (rmt->rm_lsn != cpu_to_be64(NULLCOMMITLSN)) {
190 xfs_buf_ioerror(bp, -EFSCORRUPTED);
191 xfs_verifier_error(bp);
194 xfs_update_cksum(ptr, blksize, XFS_ATTR3_RMT_CRC_OFF);
198 bno += BTOBB(blksize);
203 const struct xfs_buf_ops xfs_attr3_rmt_buf_ops = {
204 .name = "xfs_attr3_rmt",
205 .verify_read = xfs_attr3_rmt_read_verify,
206 .verify_write = xfs_attr3_rmt_write_verify,
210 xfs_attr3_rmt_hdr_set(
211 struct xfs_mount *mp,
218 struct xfs_attr3_rmt_hdr *rmt = ptr;
220 if (!xfs_sb_version_hascrc(&mp->m_sb))
223 rmt->rm_magic = cpu_to_be32(XFS_ATTR3_RMT_MAGIC);
224 rmt->rm_offset = cpu_to_be32(offset);
225 rmt->rm_bytes = cpu_to_be32(size);
226 uuid_copy(&rmt->rm_uuid, &mp->m_sb.sb_meta_uuid);
227 rmt->rm_owner = cpu_to_be64(ino);
228 rmt->rm_blkno = cpu_to_be64(bno);
231 * Remote attribute blocks are written synchronously, so we don't
232 * have an LSN that we can stamp in them that makes any sense to log
233 * recovery. To ensure that log recovery handles overwrites of these
234 * blocks sanely (i.e. once they've been freed and reallocated as some
235 * other type of metadata) we need to ensure that the LSN has a value
236 * that tells log recovery to ignore the LSN and overwrite the buffer
237 * with whatever is in it's log. To do this, we use the magic
238 * NULLCOMMITLSN to indicate that the LSN is invalid.
240 rmt->rm_lsn = cpu_to_be64(NULLCOMMITLSN);
242 return sizeof(struct xfs_attr3_rmt_hdr);
246 * Helper functions to copy attribute data in and out of the one disk extents
249 xfs_attr_rmtval_copyout(
250 struct xfs_mount *mp,
257 char *src = bp->b_addr;
258 xfs_daddr_t bno = bp->b_bn;
259 int len = BBTOB(bp->b_length);
260 int blksize = mp->m_attr_geo->blksize;
262 ASSERT(len >= blksize);
264 while (len > 0 && *valuelen > 0) {
266 int byte_cnt = XFS_ATTR3_RMT_BUF_SPACE(mp, blksize);
268 byte_cnt = min(*valuelen, byte_cnt);
270 if (xfs_sb_version_hascrc(&mp->m_sb)) {
271 if (!xfs_attr3_rmt_hdr_ok(src, ino, *offset,
274 "remote attribute header mismatch bno/off/len/owner (0x%llx/0x%x/Ox%x/0x%llx)",
275 bno, *offset, byte_cnt, ino);
276 return -EFSCORRUPTED;
278 hdr_size = sizeof(struct xfs_attr3_rmt_hdr);
281 memcpy(*dst, src + hdr_size, byte_cnt);
283 /* roll buffer forwards */
286 bno += BTOBB(blksize);
288 /* roll attribute data forwards */
289 *valuelen -= byte_cnt;
297 xfs_attr_rmtval_copyin(
298 struct xfs_mount *mp,
305 char *dst = bp->b_addr;
306 xfs_daddr_t bno = bp->b_bn;
307 int len = BBTOB(bp->b_length);
308 int blksize = mp->m_attr_geo->blksize;
310 ASSERT(len >= blksize);
312 while (len > 0 && *valuelen > 0) {
314 int byte_cnt = XFS_ATTR3_RMT_BUF_SPACE(mp, blksize);
316 byte_cnt = min(*valuelen, byte_cnt);
317 hdr_size = xfs_attr3_rmt_hdr_set(mp, dst, ino, *offset,
320 memcpy(dst + hdr_size, *src, byte_cnt);
323 * If this is the last block, zero the remainder of it.
324 * Check that we are actually the last block, too.
326 if (byte_cnt + hdr_size < blksize) {
327 ASSERT(*valuelen - byte_cnt == 0);
328 ASSERT(len == blksize);
329 memset(dst + hdr_size + byte_cnt, 0,
330 blksize - hdr_size - byte_cnt);
333 /* roll buffer forwards */
336 bno += BTOBB(blksize);
338 /* roll attribute data forwards */
339 *valuelen -= byte_cnt;
346 * Read the value associated with an attribute from the out-of-line buffer
347 * that we stored it in.
351 struct xfs_da_args *args)
353 struct xfs_bmbt_irec map[ATTR_RMTVALUE_MAPSIZE];
354 struct xfs_mount *mp = args->dp->i_mount;
356 xfs_dablk_t lblkno = args->rmtblkno;
357 __uint8_t *dst = args->value;
361 int blkcnt = args->rmtblkcnt;
365 trace_xfs_attr_rmtval_get(args);
367 ASSERT(!(args->flags & ATTR_KERNOVAL));
368 ASSERT(args->rmtvaluelen == args->valuelen);
370 valuelen = args->rmtvaluelen;
371 while (valuelen > 0) {
372 nmap = ATTR_RMTVALUE_MAPSIZE;
373 error = xfs_bmapi_read(args->dp, (xfs_fileoff_t)lblkno,
380 for (i = 0; (i < nmap) && (valuelen > 0); i++) {
384 ASSERT((map[i].br_startblock != DELAYSTARTBLOCK) &&
385 (map[i].br_startblock != HOLESTARTBLOCK));
386 dblkno = XFS_FSB_TO_DADDR(mp, map[i].br_startblock);
387 dblkcnt = XFS_FSB_TO_BB(mp, map[i].br_blockcount);
388 error = xfs_trans_read_buf(mp, NULL, mp->m_ddev_targp,
389 dblkno, dblkcnt, 0, &bp,
390 &xfs_attr3_rmt_buf_ops);
394 error = xfs_attr_rmtval_copyout(mp, bp, args->dp->i_ino,
401 /* roll attribute extent map forwards */
402 lblkno += map[i].br_blockcount;
403 blkcnt -= map[i].br_blockcount;
406 ASSERT(valuelen == 0);
411 * Write the value associated with an attribute into the out-of-line buffer
412 * that we have defined for it.
416 struct xfs_da_args *args)
418 struct xfs_inode *dp = args->dp;
419 struct xfs_mount *mp = dp->i_mount;
420 struct xfs_bmbt_irec map;
422 xfs_fileoff_t lfileoff = 0;
423 __uint8_t *src = args->value;
430 trace_xfs_attr_rmtval_set(args);
433 * Find a "hole" in the attribute address space large enough for
434 * us to drop the new attribute's value into. Because CRC enable
435 * attributes have headers, we can't just do a straight byte to FSB
436 * conversion and have to take the header space into account.
438 blkcnt = xfs_attr3_rmt_blocks(mp, args->rmtvaluelen);
439 error = xfs_bmap_first_unused(args->trans, args->dp, blkcnt, &lfileoff,
444 args->rmtblkno = lblkno = (xfs_dablk_t)lfileoff;
445 args->rmtblkcnt = blkcnt;
448 * Roll through the "value", allocating blocks on disk as required.
454 * Allocate a single extent, up to the size of the value.
456 * Note that we have to consider this a data allocation as we
457 * write the remote attribute without logging the contents.
458 * Hence we must ensure that we aren't using blocks that are on
459 * the busy list so that we don't overwrite blocks which have
460 * recently been freed but their transactions are not yet
461 * committed to disk. If we overwrite the contents of a busy
462 * extent and then crash then the block may not contain the
463 * correct metadata after log recovery occurs.
465 xfs_bmap_init(args->flist, args->firstblock);
467 error = xfs_bmapi_write(args->trans, dp, (xfs_fileoff_t)lblkno,
468 blkcnt, XFS_BMAPI_ATTRFORK, args->firstblock,
469 args->total, &map, &nmap, args->flist);
471 error = xfs_bmap_finish(&args->trans, args->flist,
477 xfs_bmap_cancel(args->flist);
482 * bmap_finish() may have committed the last trans and started
483 * a new one. We need the inode to be in all transactions.
486 xfs_trans_ijoin(args->trans, dp, 0);
489 ASSERT((map.br_startblock != DELAYSTARTBLOCK) &&
490 (map.br_startblock != HOLESTARTBLOCK));
491 lblkno += map.br_blockcount;
492 blkcnt -= map.br_blockcount;
495 * Start the next trans in the chain.
497 error = xfs_trans_roll(&args->trans, dp);
503 * Roll through the "value", copying the attribute value to the
504 * already-allocated blocks. Blocks are written synchronously
505 * so that we can know they are all on disk before we turn off
506 * the INCOMPLETE flag.
508 lblkno = args->rmtblkno;
509 blkcnt = args->rmtblkcnt;
510 valuelen = args->rmtvaluelen;
511 while (valuelen > 0) {
518 xfs_bmap_init(args->flist, args->firstblock);
520 error = xfs_bmapi_read(dp, (xfs_fileoff_t)lblkno,
526 ASSERT((map.br_startblock != DELAYSTARTBLOCK) &&
527 (map.br_startblock != HOLESTARTBLOCK));
529 dblkno = XFS_FSB_TO_DADDR(mp, map.br_startblock),
530 dblkcnt = XFS_FSB_TO_BB(mp, map.br_blockcount);
532 bp = xfs_buf_get(mp->m_ddev_targp, dblkno, dblkcnt, 0);
535 bp->b_ops = &xfs_attr3_rmt_buf_ops;
537 xfs_attr_rmtval_copyin(mp, bp, args->dp->i_ino, &offset,
540 error = xfs_bwrite(bp); /* GROT: NOTE: synchronous write */
546 /* roll attribute extent map forwards */
547 lblkno += map.br_blockcount;
548 blkcnt -= map.br_blockcount;
550 ASSERT(valuelen == 0);
555 * Remove the value associated with an attribute by deleting the
556 * out-of-line buffer that it is stored on.
559 xfs_attr_rmtval_remove(
560 struct xfs_da_args *args)
562 struct xfs_mount *mp = args->dp->i_mount;
568 trace_xfs_attr_rmtval_remove(args);
571 * Roll through the "value", invalidating the attribute value's blocks.
573 lblkno = args->rmtblkno;
574 blkcnt = args->rmtblkcnt;
576 struct xfs_bmbt_irec map;
583 * Try to remember where we decided to put the value.
586 error = xfs_bmapi_read(args->dp, (xfs_fileoff_t)lblkno,
587 blkcnt, &map, &nmap, XFS_BMAPI_ATTRFORK);
591 ASSERT((map.br_startblock != DELAYSTARTBLOCK) &&
592 (map.br_startblock != HOLESTARTBLOCK));
594 dblkno = XFS_FSB_TO_DADDR(mp, map.br_startblock),
595 dblkcnt = XFS_FSB_TO_BB(mp, map.br_blockcount);
598 * If the "remote" value is in the cache, remove it.
600 bp = xfs_incore(mp->m_ddev_targp, dblkno, dblkcnt, XBF_TRYLOCK);
607 lblkno += map.br_blockcount;
608 blkcnt -= map.br_blockcount;
612 * Keep de-allocating extents until the remote-value region is gone.
614 lblkno = args->rmtblkno;
615 blkcnt = args->rmtblkcnt;
620 xfs_bmap_init(args->flist, args->firstblock);
621 error = xfs_bunmapi(args->trans, args->dp, lblkno, blkcnt,
622 XFS_BMAPI_ATTRFORK, 1, args->firstblock,
625 error = xfs_bmap_finish(&args->trans, args->flist,
631 xfs_bmap_cancel(args->flist);
636 * bmap_finish() may have committed the last trans and started
637 * a new one. We need the inode to be in all transactions.
640 xfs_trans_ijoin(args->trans, args->dp, 0);
643 * Close out trans and start the next one in the chain.
645 error = xfs_trans_roll(&args->trans, args->dp);