1 // SPDX-License-Identifier: GPL-2.0
3 * Copyright (c) 2000-2006 Silicon Graphics, Inc.
4 * Copyright (c) 2012-2013 Red Hat, Inc.
8 #include "xfs_shared.h"
10 #include "xfs_format.h"
11 #include "xfs_log_format.h"
12 #include "xfs_trans_resv.h"
14 #include "xfs_mount.h"
16 #include "xfs_inode.h"
18 #include "xfs_bmap_btree.h"
19 #include "xfs_quota.h"
20 #include "xfs_symlink.h"
21 #include "xfs_trans_space.h"
22 #include "xfs_trace.h"
23 #include "xfs_trans.h"
25 /* ----- Kernel only functions below ----- */
27 xfs_readlink_bmap_ilocked(
31 struct xfs_mount
*mp
= ip
->i_mount
;
32 struct xfs_bmbt_irec mval
[XFS_SYMLINK_MAPS
];
36 int pathlen
= ip
->i_d
.di_size
;
37 int nmaps
= XFS_SYMLINK_MAPS
;
44 ASSERT(xfs_isilocked(ip
, XFS_ILOCK_SHARED
| XFS_ILOCK_EXCL
));
46 fsblocks
= xfs_symlink_blocks(mp
, pathlen
);
47 error
= xfs_bmapi_read(ip
, 0, fsblocks
, mval
, &nmaps
, 0);
52 for (n
= 0; n
< nmaps
; n
++) {
53 d
= XFS_FSB_TO_DADDR(mp
, mval
[n
].br_startblock
);
54 byte_cnt
= XFS_FSB_TO_B(mp
, mval
[n
].br_blockcount
);
56 error
= xfs_buf_read(mp
->m_ddev_targp
, d
, BTOBB(byte_cnt
), 0,
57 &bp
, &xfs_symlink_buf_ops
);
60 byte_cnt
= XFS_SYMLINK_BUF_SPACE(mp
, byte_cnt
);
61 if (pathlen
< byte_cnt
)
64 cur_chunk
= bp
->b_addr
;
65 if (xfs_sb_version_hascrc(&mp
->m_sb
)) {
66 if (!xfs_symlink_hdr_ok(ip
->i_ino
, offset
,
68 error
= -EFSCORRUPTED
;
70 "symlink header does not match required off/len/owner (0x%x/Ox%x,0x%llx)",
71 offset
, byte_cnt
, ip
->i_ino
);
77 cur_chunk
+= sizeof(struct xfs_dsymlink_hdr
);
80 memcpy(link
+ offset
, cur_chunk
, byte_cnt
);
89 link
[ip
->i_d
.di_size
] = '\0';
101 struct xfs_mount
*mp
= ip
->i_mount
;
105 trace_xfs_readlink(ip
);
107 ASSERT(!(ip
->i_df
.if_flags
& XFS_IFINLINE
));
109 if (XFS_FORCED_SHUTDOWN(mp
))
112 xfs_ilock(ip
, XFS_ILOCK_SHARED
);
114 pathlen
= ip
->i_d
.di_size
;
118 if (pathlen
< 0 || pathlen
> XFS_SYMLINK_MAXLEN
) {
119 xfs_alert(mp
, "%s: inode (%llu) bad symlink length (%lld)",
120 __func__
, (unsigned long long) ip
->i_ino
,
121 (long long) pathlen
);
123 error
= -EFSCORRUPTED
;
128 error
= xfs_readlink_bmap_ilocked(ip
, link
);
131 xfs_iunlock(ip
, XFS_ILOCK_SHARED
);
137 struct xfs_inode
*dp
,
138 struct xfs_name
*link_name
,
139 const char *target_path
,
141 struct xfs_inode
**ipp
)
143 struct xfs_mount
*mp
= dp
->i_mount
;
144 struct xfs_trans
*tp
= NULL
;
145 struct xfs_inode
*ip
= NULL
;
148 bool unlock_dp_on_error
= false;
149 xfs_fileoff_t first_fsb
;
150 xfs_filblks_t fs_blocks
;
152 struct xfs_bmbt_irec mval
[XFS_SYMLINK_MAPS
];
154 const char *cur_chunk
;
159 struct xfs_dquot
*udqp
= NULL
;
160 struct xfs_dquot
*gdqp
= NULL
;
161 struct xfs_dquot
*pdqp
= NULL
;
166 trace_xfs_symlink(dp
, link_name
);
168 if (XFS_FORCED_SHUTDOWN(mp
))
172 * Check component lengths of the target path name.
174 pathlen
= strlen(target_path
);
175 if (pathlen
>= XFS_SYMLINK_MAXLEN
) /* total string too long */
176 return -ENAMETOOLONG
;
179 prid
= xfs_get_initial_prid(dp
);
182 * Make sure that we have allocated dquot(s) on disk.
184 error
= xfs_qm_vop_dqalloc(dp
, current_fsuid(), current_fsgid(), prid
,
185 XFS_QMOPT_QUOTALL
| XFS_QMOPT_INHERIT
,
186 &udqp
, &gdqp
, &pdqp
);
191 * The symlink will fit into the inode data fork?
192 * There can't be any attributes so we get the whole variable part.
194 if (pathlen
<= XFS_LITINO(mp
))
197 fs_blocks
= xfs_symlink_blocks(mp
, pathlen
);
198 resblks
= XFS_SYMLINK_SPACE_RES(mp
, link_name
->len
, fs_blocks
);
200 error
= xfs_trans_alloc(mp
, &M_RES(mp
)->tr_symlink
, resblks
, 0, 0, &tp
);
202 goto out_release_inode
;
204 xfs_ilock(dp
, XFS_ILOCK_EXCL
| XFS_ILOCK_PARENT
);
205 unlock_dp_on_error
= true;
208 * Check whether the directory allows new symlinks or not.
210 if (dp
->i_d
.di_flags
& XFS_DIFLAG_NOSYMLINKS
) {
212 goto out_trans_cancel
;
216 * Reserve disk quota : blocks and inode.
218 error
= xfs_trans_reserve_quota(tp
, mp
, udqp
, gdqp
,
219 pdqp
, resblks
, 1, 0);
221 goto out_trans_cancel
;
224 * Allocate an inode for the symlink.
226 error
= xfs_dir_ialloc(&tp
, dp
, S_IFLNK
| (mode
& ~S_IFMT
), 1, 0,
229 goto out_trans_cancel
;
232 * Now we join the directory inode to the transaction. We do not do it
233 * earlier because xfs_dir_ialloc might commit the previous transaction
234 * (and release all the locks). An error from here on will result in
235 * the transaction cancel unlocking dp so don't do it explicitly in the
238 xfs_trans_ijoin(tp
, dp
, XFS_ILOCK_EXCL
);
239 unlock_dp_on_error
= false;
242 * Also attach the dquot(s) to it, if applicable.
244 xfs_qm_vop_create_dqattach(tp
, ip
, udqp
, gdqp
, pdqp
);
246 resblks
-= XFS_IALLOC_SPACE_RES(mp
);
248 * If the symlink will fit into the inode, write it inline.
250 if (pathlen
<= XFS_IFORK_DSIZE(ip
)) {
251 xfs_init_local_fork(ip
, XFS_DATA_FORK
, target_path
, pathlen
);
253 ip
->i_d
.di_size
= pathlen
;
254 ip
->i_df
.if_format
= XFS_DINODE_FMT_LOCAL
;
255 xfs_trans_log_inode(tp
, ip
, XFS_ILOG_DDATA
| XFS_ILOG_CORE
);
260 nmaps
= XFS_SYMLINK_MAPS
;
262 error
= xfs_bmapi_write(tp
, ip
, first_fsb
, fs_blocks
,
263 XFS_BMAPI_METADATA
, resblks
, mval
, &nmaps
);
265 goto out_trans_cancel
;
267 resblks
-= fs_blocks
;
268 ip
->i_d
.di_size
= pathlen
;
269 xfs_trans_log_inode(tp
, ip
, XFS_ILOG_CORE
);
271 cur_chunk
= target_path
;
273 for (n
= 0; n
< nmaps
; n
++) {
276 d
= XFS_FSB_TO_DADDR(mp
, mval
[n
].br_startblock
);
277 byte_cnt
= XFS_FSB_TO_B(mp
, mval
[n
].br_blockcount
);
278 error
= xfs_trans_get_buf(tp
, mp
->m_ddev_targp
, d
,
279 BTOBB(byte_cnt
), 0, &bp
);
281 goto out_trans_cancel
;
282 bp
->b_ops
= &xfs_symlink_buf_ops
;
284 byte_cnt
= XFS_SYMLINK_BUF_SPACE(mp
, byte_cnt
);
285 byte_cnt
= min(byte_cnt
, pathlen
);
288 buf
+= xfs_symlink_hdr_set(mp
, ip
->i_ino
, offset
,
291 memcpy(buf
, cur_chunk
, byte_cnt
);
293 cur_chunk
+= byte_cnt
;
297 xfs_trans_buf_set_type(tp
, bp
, XFS_BLFT_SYMLINK_BUF
);
298 xfs_trans_log_buf(tp
, bp
, 0, (buf
+ byte_cnt
- 1) -
301 ASSERT(pathlen
== 0);
305 * Create the directory entry for the symlink.
307 error
= xfs_dir_createname(tp
, dp
, link_name
, ip
->i_ino
, resblks
);
309 goto out_trans_cancel
;
310 xfs_trans_ichgtime(tp
, dp
, XFS_ICHGTIME_MOD
| XFS_ICHGTIME_CHG
);
311 xfs_trans_log_inode(tp
, dp
, XFS_ILOG_CORE
);
314 * If this is a synchronous mount, make sure that the
315 * symlink transaction goes to disk before returning to
318 if (mp
->m_flags
& (XFS_MOUNT_WSYNC
|XFS_MOUNT_DIRSYNC
)) {
319 xfs_trans_set_sync(tp
);
322 error
= xfs_trans_commit(tp
);
324 goto out_release_inode
;
334 xfs_trans_cancel(tp
);
337 * Wait until after the current transaction is aborted to finish the
338 * setup of the inode and release the inode. This prevents recursive
339 * transactions and deadlocks from xfs_inactive.
342 xfs_finish_inode_setup(ip
);
350 if (unlock_dp_on_error
)
351 xfs_iunlock(dp
, XFS_ILOCK_EXCL
);
356 * Free a symlink that has blocks associated with it.
358 * Note: zero length symlinks are not allowed to exist. When we set the size to
359 * zero, also change it to a regular file so that it does not get written to
360 * disk as a zero length symlink. The inode is on the unlinked list already, so
361 * userspace cannot find this inode anymore, so this change is not user visible
362 * but allows us to catch corrupt zero-length symlinks in the verifiers.
365 xfs_inactive_symlink_rmt(
366 struct xfs_inode
*ip
)
373 xfs_bmbt_irec_t mval
[XFS_SYMLINK_MAPS
];
379 ASSERT(ip
->i_df
.if_flags
& XFS_IFEXTENTS
);
381 * We're freeing a symlink that has some
382 * blocks allocated to it. Free the
383 * blocks here. We know that we've got
384 * either 1 or 2 extents and that we can
385 * free them all in one bunmapi call.
387 ASSERT(ip
->i_df
.if_nextents
> 0 && ip
->i_df
.if_nextents
<= 2);
389 error
= xfs_trans_alloc(mp
, &M_RES(mp
)->tr_itruncate
, 0, 0, 0, &tp
);
393 xfs_ilock(ip
, XFS_ILOCK_EXCL
);
394 xfs_trans_ijoin(tp
, ip
, 0);
397 * Lock the inode, fix the size, turn it into a regular file and join it
398 * to the transaction. Hold it so in the normal path, we still have it
399 * locked for the second transaction. In the error paths we need it
400 * held so the cancel won't rele it, see below.
402 size
= (int)ip
->i_d
.di_size
;
404 VFS_I(ip
)->i_mode
= (VFS_I(ip
)->i_mode
& ~S_IFMT
) | S_IFREG
;
405 xfs_trans_log_inode(tp
, ip
, XFS_ILOG_CORE
);
407 * Find the block(s) so we can inval and unmap them.
410 nmaps
= ARRAY_SIZE(mval
);
411 error
= xfs_bmapi_read(ip
, 0, xfs_symlink_blocks(mp
, size
),
414 goto error_trans_cancel
;
416 * Invalidate the block(s). No validation is done.
418 for (i
= 0; i
< nmaps
; i
++) {
419 error
= xfs_trans_get_buf(tp
, mp
->m_ddev_targp
,
420 XFS_FSB_TO_DADDR(mp
, mval
[i
].br_startblock
),
421 XFS_FSB_TO_BB(mp
, mval
[i
].br_blockcount
), 0,
424 goto error_trans_cancel
;
425 xfs_trans_binval(tp
, bp
);
428 * Unmap the dead block(s) to the dfops.
430 error
= xfs_bunmapi(tp
, ip
, 0, size
, 0, nmaps
, &done
);
432 goto error_trans_cancel
;
436 * Commit the transaction. This first logs the EFI and the inode, then
437 * rolls and commits the transaction that frees the extents.
439 xfs_trans_log_inode(tp
, ip
, XFS_ILOG_CORE
);
440 error
= xfs_trans_commit(tp
);
442 ASSERT(XFS_FORCED_SHUTDOWN(mp
));
447 * Remove the memory for extent descriptions (just bookkeeping).
449 if (ip
->i_df
.if_bytes
)
450 xfs_idata_realloc(ip
, -ip
->i_df
.if_bytes
, XFS_DATA_FORK
);
451 ASSERT(ip
->i_df
.if_bytes
== 0);
453 xfs_iunlock(ip
, XFS_ILOCK_EXCL
);
457 xfs_trans_cancel(tp
);
459 xfs_iunlock(ip
, XFS_ILOCK_EXCL
);
464 * xfs_inactive_symlink - free a symlink
467 xfs_inactive_symlink(
468 struct xfs_inode
*ip
)
470 struct xfs_mount
*mp
= ip
->i_mount
;
473 trace_xfs_inactive_symlink(ip
);
475 if (XFS_FORCED_SHUTDOWN(mp
))
478 xfs_ilock(ip
, XFS_ILOCK_EXCL
);
479 pathlen
= (int)ip
->i_d
.di_size
;
482 if (pathlen
<= 0 || pathlen
> XFS_SYMLINK_MAXLEN
) {
483 xfs_alert(mp
, "%s: inode (0x%llx) bad symlink length (%d)",
484 __func__
, (unsigned long long)ip
->i_ino
, pathlen
);
485 xfs_iunlock(ip
, XFS_ILOCK_EXCL
);
487 return -EFSCORRUPTED
;
491 * Inline fork state gets removed by xfs_difree() so we have nothing to
492 * do here in that case.
494 if (ip
->i_df
.if_flags
& XFS_IFINLINE
) {
495 xfs_iunlock(ip
, XFS_ILOCK_EXCL
);
499 xfs_iunlock(ip
, XFS_ILOCK_EXCL
);
501 /* remove the remote symlink */
502 return xfs_inactive_symlink_rmt(ip
);