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_defer.h"
28 #include "xfs_da_format.h"
29 #include "xfs_da_btree.h"
30 #include "xfs_inode.h"
31 #include "xfs_alloc.h"
32 #include "xfs_trans.h"
33 #include "xfs_inode_item.h"
35 #include "xfs_bmap_util.h"
37 #include "xfs_attr_leaf.h"
38 #include "xfs_attr_remote.h"
39 #include "xfs_trans_space.h"
40 #include "xfs_trace.h"
41 #include "xfs_cksum.h"
42 #include "xfs_buf_item.h"
43 #include "xfs_error.h"
45 #define ATTR_RMTVALUE_MAPSIZE 1 /* # of map entries at once */
48 * Each contiguous block has a header, so it is not just a simple attribute
49 * length to FSB conversion.
56 if (xfs_sb_version_hascrc(&mp->m_sb)) {
57 int buflen = XFS_ATTR3_RMT_BUF_SPACE(mp, mp->m_sb.sb_blocksize);
58 return (attrlen + buflen - 1) / buflen;
60 return XFS_B_TO_FSB(mp, attrlen);
64 * Checking of the remote attribute header is split into two parts. The verifier
65 * does CRC, location and bounds checking, the unpacking function checks the
66 * attribute parameters and owner.
76 struct xfs_attr3_rmt_hdr *rmt = ptr;
78 if (bno != be64_to_cpu(rmt->rm_blkno))
80 if (offset != be32_to_cpu(rmt->rm_offset))
82 if (size != be32_to_cpu(rmt->rm_bytes))
84 if (ino != be64_to_cpu(rmt->rm_owner))
98 struct xfs_attr3_rmt_hdr *rmt = ptr;
100 if (!xfs_sb_version_hascrc(&mp->m_sb))
102 if (rmt->rm_magic != cpu_to_be32(XFS_ATTR3_RMT_MAGIC))
104 if (!uuid_equal(&rmt->rm_uuid, &mp->m_sb.sb_meta_uuid))
106 if (be64_to_cpu(rmt->rm_blkno) != bno)
108 if (be32_to_cpu(rmt->rm_bytes) > fsbsize - sizeof(*rmt))
110 if (be32_to_cpu(rmt->rm_offset) +
111 be32_to_cpu(rmt->rm_bytes) > XFS_XATTR_SIZE_MAX)
113 if (rmt->rm_owner == 0)
120 xfs_attr3_rmt_read_verify(
123 struct xfs_mount *mp = bp->b_target->bt_mount;
127 int blksize = mp->m_attr_geo->blksize;
129 /* no verification of non-crc buffers */
130 if (!xfs_sb_version_hascrc(&mp->m_sb))
135 len = BBTOB(bp->b_length);
136 ASSERT(len >= blksize);
139 if (!xfs_verify_cksum(ptr, blksize, XFS_ATTR3_RMT_CRC_OFF)) {
140 xfs_buf_ioerror(bp, -EFSBADCRC);
143 if (!xfs_attr3_rmt_verify(mp, ptr, blksize, bno)) {
144 xfs_buf_ioerror(bp, -EFSCORRUPTED);
149 bno += BTOBB(blksize);
153 xfs_verifier_error(bp);
159 xfs_attr3_rmt_write_verify(
162 struct xfs_mount *mp = bp->b_target->bt_mount;
163 int blksize = mp->m_attr_geo->blksize;
168 /* no verification of non-crc buffers */
169 if (!xfs_sb_version_hascrc(&mp->m_sb))
174 len = BBTOB(bp->b_length);
175 ASSERT(len >= blksize);
178 struct xfs_attr3_rmt_hdr *rmt = (struct xfs_attr3_rmt_hdr *)ptr;
180 if (!xfs_attr3_rmt_verify(mp, ptr, blksize, bno)) {
181 xfs_buf_ioerror(bp, -EFSCORRUPTED);
182 xfs_verifier_error(bp);
187 * Ensure we aren't writing bogus LSNs to disk. See
188 * xfs_attr3_rmt_hdr_set() for the explanation.
190 if (rmt->rm_lsn != cpu_to_be64(NULLCOMMITLSN)) {
191 xfs_buf_ioerror(bp, -EFSCORRUPTED);
192 xfs_verifier_error(bp);
195 xfs_update_cksum(ptr, blksize, XFS_ATTR3_RMT_CRC_OFF);
199 bno += BTOBB(blksize);
204 const struct xfs_buf_ops xfs_attr3_rmt_buf_ops = {
205 .name = "xfs_attr3_rmt",
206 .verify_read = xfs_attr3_rmt_read_verify,
207 .verify_write = xfs_attr3_rmt_write_verify,
211 xfs_attr3_rmt_hdr_set(
212 struct xfs_mount *mp,
219 struct xfs_attr3_rmt_hdr *rmt = ptr;
221 if (!xfs_sb_version_hascrc(&mp->m_sb))
224 rmt->rm_magic = cpu_to_be32(XFS_ATTR3_RMT_MAGIC);
225 rmt->rm_offset = cpu_to_be32(offset);
226 rmt->rm_bytes = cpu_to_be32(size);
227 uuid_copy(&rmt->rm_uuid, &mp->m_sb.sb_meta_uuid);
228 rmt->rm_owner = cpu_to_be64(ino);
229 rmt->rm_blkno = cpu_to_be64(bno);
232 * Remote attribute blocks are written synchronously, so we don't
233 * have an LSN that we can stamp in them that makes any sense to log
234 * recovery. To ensure that log recovery handles overwrites of these
235 * blocks sanely (i.e. once they've been freed and reallocated as some
236 * other type of metadata) we need to ensure that the LSN has a value
237 * that tells log recovery to ignore the LSN and overwrite the buffer
238 * with whatever is in it's log. To do this, we use the magic
239 * NULLCOMMITLSN to indicate that the LSN is invalid.
241 rmt->rm_lsn = cpu_to_be64(NULLCOMMITLSN);
243 return sizeof(struct xfs_attr3_rmt_hdr);
247 * Helper functions to copy attribute data in and out of the one disk extents
250 xfs_attr_rmtval_copyout(
251 struct xfs_mount *mp,
258 char *src = bp->b_addr;
259 xfs_daddr_t bno = bp->b_bn;
260 int len = BBTOB(bp->b_length);
261 int blksize = mp->m_attr_geo->blksize;
263 ASSERT(len >= blksize);
265 while (len > 0 && *valuelen > 0) {
267 int byte_cnt = XFS_ATTR3_RMT_BUF_SPACE(mp, blksize);
269 byte_cnt = min(*valuelen, byte_cnt);
271 if (xfs_sb_version_hascrc(&mp->m_sb)) {
272 if (!xfs_attr3_rmt_hdr_ok(src, ino, *offset,
275 "remote attribute header mismatch bno/off/len/owner (0x%llx/0x%x/Ox%x/0x%llx)",
276 bno, *offset, byte_cnt, ino);
277 return -EFSCORRUPTED;
279 hdr_size = sizeof(struct xfs_attr3_rmt_hdr);
282 memcpy(*dst, src + hdr_size, byte_cnt);
284 /* roll buffer forwards */
287 bno += BTOBB(blksize);
289 /* roll attribute data forwards */
290 *valuelen -= byte_cnt;
298 xfs_attr_rmtval_copyin(
299 struct xfs_mount *mp,
306 char *dst = bp->b_addr;
307 xfs_daddr_t bno = bp->b_bn;
308 int len = BBTOB(bp->b_length);
309 int blksize = mp->m_attr_geo->blksize;
311 ASSERT(len >= blksize);
313 while (len > 0 && *valuelen > 0) {
315 int byte_cnt = XFS_ATTR3_RMT_BUF_SPACE(mp, blksize);
317 byte_cnt = min(*valuelen, byte_cnt);
318 hdr_size = xfs_attr3_rmt_hdr_set(mp, dst, ino, *offset,
321 memcpy(dst + hdr_size, *src, byte_cnt);
324 * If this is the last block, zero the remainder of it.
325 * Check that we are actually the last block, too.
327 if (byte_cnt + hdr_size < blksize) {
328 ASSERT(*valuelen - byte_cnt == 0);
329 ASSERT(len == blksize);
330 memset(dst + hdr_size + byte_cnt, 0,
331 blksize - hdr_size - byte_cnt);
334 /* roll buffer forwards */
337 bno += BTOBB(blksize);
339 /* roll attribute data forwards */
340 *valuelen -= byte_cnt;
347 * Read the value associated with an attribute from the out-of-line buffer
348 * that we stored it in.
352 struct xfs_da_args *args)
354 struct xfs_bmbt_irec map[ATTR_RMTVALUE_MAPSIZE];
355 struct xfs_mount *mp = args->dp->i_mount;
357 xfs_dablk_t lblkno = args->rmtblkno;
358 uint8_t *dst = args->value;
362 int blkcnt = args->rmtblkcnt;
366 trace_xfs_attr_rmtval_get(args);
368 ASSERT(!(args->flags & ATTR_KERNOVAL));
369 ASSERT(args->rmtvaluelen == args->valuelen);
371 valuelen = args->rmtvaluelen;
372 while (valuelen > 0) {
373 nmap = ATTR_RMTVALUE_MAPSIZE;
374 error = xfs_bmapi_read(args->dp, (xfs_fileoff_t)lblkno,
381 for (i = 0; (i < nmap) && (valuelen > 0); i++) {
385 ASSERT((map[i].br_startblock != DELAYSTARTBLOCK) &&
386 (map[i].br_startblock != HOLESTARTBLOCK));
387 dblkno = XFS_FSB_TO_DADDR(mp, map[i].br_startblock);
388 dblkcnt = XFS_FSB_TO_BB(mp, map[i].br_blockcount);
389 error = xfs_trans_read_buf(mp, args->trans,
391 dblkno, dblkcnt, 0, &bp,
392 &xfs_attr3_rmt_buf_ops);
396 error = xfs_attr_rmtval_copyout(mp, bp, args->dp->i_ino,
399 xfs_trans_brelse(args->trans, bp);
403 /* roll attribute extent map forwards */
404 lblkno += map[i].br_blockcount;
405 blkcnt -= map[i].br_blockcount;
408 ASSERT(valuelen == 0);
413 * Write the value associated with an attribute into the out-of-line buffer
414 * that we have defined for it.
418 struct xfs_da_args *args)
420 struct xfs_inode *dp = args->dp;
421 struct xfs_mount *mp = dp->i_mount;
422 struct xfs_bmbt_irec map;
424 xfs_fileoff_t lfileoff = 0;
425 uint8_t *src = args->value;
432 trace_xfs_attr_rmtval_set(args);
435 * Find a "hole" in the attribute address space large enough for
436 * us to drop the new attribute's value into. Because CRC enable
437 * attributes have headers, we can't just do a straight byte to FSB
438 * conversion and have to take the header space into account.
440 blkcnt = xfs_attr3_rmt_blocks(mp, args->rmtvaluelen);
441 error = xfs_bmap_first_unused(args->trans, args->dp, blkcnt, &lfileoff,
446 args->rmtblkno = lblkno = (xfs_dablk_t)lfileoff;
447 args->rmtblkcnt = blkcnt;
450 * 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_defer_init(args->dfops, 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->dfops);
471 error = xfs_defer_finish(&args->trans, args->dfops, dp);
474 xfs_defer_cancel(args->dfops);
479 ASSERT((map.br_startblock != DELAYSTARTBLOCK) &&
480 (map.br_startblock != HOLESTARTBLOCK));
481 lblkno += map.br_blockcount;
482 blkcnt -= map.br_blockcount;
485 * Start the next trans in the chain.
487 error = xfs_trans_roll(&args->trans, dp);
493 * Roll through the "value", copying the attribute value to the
494 * already-allocated blocks. Blocks are written synchronously
495 * so that we can know they are all on disk before we turn off
496 * the INCOMPLETE flag.
498 lblkno = args->rmtblkno;
499 blkcnt = args->rmtblkcnt;
500 valuelen = args->rmtvaluelen;
501 while (valuelen > 0) {
508 xfs_defer_init(args->dfops, args->firstblock);
510 error = xfs_bmapi_read(dp, (xfs_fileoff_t)lblkno,
516 ASSERT((map.br_startblock != DELAYSTARTBLOCK) &&
517 (map.br_startblock != HOLESTARTBLOCK));
519 dblkno = XFS_FSB_TO_DADDR(mp, map.br_startblock),
520 dblkcnt = XFS_FSB_TO_BB(mp, map.br_blockcount);
522 bp = xfs_buf_get(mp->m_ddev_targp, dblkno, dblkcnt, 0);
525 bp->b_ops = &xfs_attr3_rmt_buf_ops;
527 xfs_attr_rmtval_copyin(mp, bp, args->dp->i_ino, &offset,
530 error = xfs_bwrite(bp); /* GROT: NOTE: synchronous write */
536 /* roll attribute extent map forwards */
537 lblkno += map.br_blockcount;
538 blkcnt -= map.br_blockcount;
540 ASSERT(valuelen == 0);
545 * Remove the value associated with an attribute by deleting the
546 * out-of-line buffer that it is stored on.
549 xfs_attr_rmtval_remove(
550 struct xfs_da_args *args)
552 struct xfs_mount *mp = args->dp->i_mount;
558 trace_xfs_attr_rmtval_remove(args);
561 * Roll through the "value", invalidating the attribute value's blocks.
563 lblkno = args->rmtblkno;
564 blkcnt = args->rmtblkcnt;
566 struct xfs_bmbt_irec map;
573 * Try to remember where we decided to put the value.
576 error = xfs_bmapi_read(args->dp, (xfs_fileoff_t)lblkno,
577 blkcnt, &map, &nmap, XFS_BMAPI_ATTRFORK);
581 ASSERT((map.br_startblock != DELAYSTARTBLOCK) &&
582 (map.br_startblock != HOLESTARTBLOCK));
584 dblkno = XFS_FSB_TO_DADDR(mp, map.br_startblock),
585 dblkcnt = XFS_FSB_TO_BB(mp, map.br_blockcount);
588 * If the "remote" value is in the cache, remove it.
590 bp = xfs_incore(mp->m_ddev_targp, dblkno, dblkcnt, XBF_TRYLOCK);
597 lblkno += map.br_blockcount;
598 blkcnt -= map.br_blockcount;
602 * Keep de-allocating extents until the remote-value region is gone.
604 lblkno = args->rmtblkno;
605 blkcnt = args->rmtblkcnt;
608 xfs_defer_init(args->dfops, args->firstblock);
609 error = xfs_bunmapi(args->trans, args->dp, lblkno, blkcnt,
610 XFS_BMAPI_ATTRFORK, 1, args->firstblock,
613 error = xfs_defer_finish(&args->trans, args->dfops,
617 xfs_defer_cancel(args->dfops);
622 * Close out trans and start the next one in the chain.
624 error = xfs_trans_roll(&args->trans, args->dp);