xref: /linux/fs/xfs/xfs_symlink.c (revision 9cb5f15d88d4cbda3bac22769d9e4808bd6cf248)
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  * Copyright (c) 2000-2006 Silicon Graphics, Inc.
4  * Copyright (c) 2012-2013 Red Hat, Inc.
5  * All rights reserved.
6  */
7 #include "xfs.h"
8 #include "xfs_shared.h"
9 #include "xfs_fs.h"
10 #include "xfs_format.h"
11 #include "xfs_log_format.h"
12 #include "xfs_trans_resv.h"
13 #include "xfs_bit.h"
14 #include "xfs_mount.h"
15 #include "xfs_dir2.h"
16 #include "xfs_inode.h"
17 #include "xfs_bmap.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"
24 #include "xfs_ialloc.h"
25 #include "xfs_error.h"
26 #include "xfs_health.h"
27 #include "xfs_symlink_remote.h"
28 
29 int
30 xfs_readlink(
31 	struct xfs_inode	*ip,
32 	char			*link)
33 {
34 	struct xfs_mount	*mp = ip->i_mount;
35 	xfs_fsize_t		pathlen;
36 	int			error;
37 
38 	trace_xfs_readlink(ip);
39 
40 	if (xfs_is_shutdown(mp))
41 		return -EIO;
42 	if (xfs_ifork_zapped(ip, XFS_DATA_FORK))
43 		return -EIO;
44 
45 	xfs_ilock(ip, XFS_ILOCK_SHARED);
46 
47 	pathlen = ip->i_disk_size;
48 	if (!pathlen)
49 		goto out_corrupt;
50 
51 	if (pathlen < 0 || pathlen > XFS_SYMLINK_MAXLEN) {
52 		xfs_alert(mp, "%s: inode (%llu) bad symlink length (%lld)",
53 			 __func__, (unsigned long long) ip->i_ino,
54 			 (long long) pathlen);
55 		ASSERT(0);
56 		goto out_corrupt;
57 	}
58 
59 	if (ip->i_df.if_format == XFS_DINODE_FMT_LOCAL) {
60 		/*
61 		 * The VFS crashes on a NULL pointer, so return -EFSCORRUPTED
62 		 * if if_data is junk.
63 		 */
64 		if (XFS_IS_CORRUPT(ip->i_mount, !ip->i_df.if_data))
65 			goto out_corrupt;
66 
67 		memcpy(link, ip->i_df.if_data, pathlen + 1);
68 		error = 0;
69 	} else {
70 		error = xfs_symlink_remote_read(ip, link);
71 	}
72 
73 	xfs_iunlock(ip, XFS_ILOCK_SHARED);
74 	return error;
75  out_corrupt:
76 	xfs_iunlock(ip, XFS_ILOCK_SHARED);
77 	xfs_inode_mark_sick(ip, XFS_SICK_INO_SYMLINK);
78 	return -EFSCORRUPTED;
79 }
80 
81 int
82 xfs_symlink(
83 	struct mnt_idmap	*idmap,
84 	struct xfs_inode	*dp,
85 	struct xfs_name		*link_name,
86 	const char		*target_path,
87 	umode_t			mode,
88 	struct xfs_inode	**ipp)
89 {
90 	struct xfs_mount	*mp = dp->i_mount;
91 	struct xfs_trans	*tp = NULL;
92 	struct xfs_inode	*ip = NULL;
93 	int			error = 0;
94 	int			pathlen;
95 	bool                    unlock_dp_on_error = false;
96 	xfs_filblks_t		fs_blocks;
97 	prid_t			prid;
98 	struct xfs_dquot	*udqp = NULL;
99 	struct xfs_dquot	*gdqp = NULL;
100 	struct xfs_dquot	*pdqp = NULL;
101 	uint			resblks;
102 	xfs_ino_t		ino;
103 
104 	*ipp = NULL;
105 
106 	trace_xfs_symlink(dp, link_name);
107 
108 	if (xfs_is_shutdown(mp))
109 		return -EIO;
110 
111 	/*
112 	 * Check component lengths of the target path name.
113 	 */
114 	pathlen = strlen(target_path);
115 	if (pathlen >= XFS_SYMLINK_MAXLEN)      /* total string too long */
116 		return -ENAMETOOLONG;
117 	ASSERT(pathlen > 0);
118 
119 	prid = xfs_get_initial_prid(dp);
120 
121 	/*
122 	 * Make sure that we have allocated dquot(s) on disk.
123 	 */
124 	error = xfs_qm_vop_dqalloc(dp, mapped_fsuid(idmap, &init_user_ns),
125 			mapped_fsgid(idmap, &init_user_ns), prid,
126 			XFS_QMOPT_QUOTALL | XFS_QMOPT_INHERIT,
127 			&udqp, &gdqp, &pdqp);
128 	if (error)
129 		return error;
130 
131 	/*
132 	 * The symlink will fit into the inode data fork?
133 	 * There can't be any attributes so we get the whole variable part.
134 	 */
135 	if (pathlen <= XFS_LITINO(mp))
136 		fs_blocks = 0;
137 	else
138 		fs_blocks = xfs_symlink_blocks(mp, pathlen);
139 	resblks = XFS_SYMLINK_SPACE_RES(mp, link_name->len, fs_blocks);
140 
141 	error = xfs_trans_alloc_icreate(mp, &M_RES(mp)->tr_symlink, udqp, gdqp,
142 			pdqp, resblks, &tp);
143 	if (error)
144 		goto out_release_dquots;
145 
146 	xfs_ilock(dp, XFS_ILOCK_EXCL | XFS_ILOCK_PARENT);
147 	unlock_dp_on_error = true;
148 
149 	/*
150 	 * Check whether the directory allows new symlinks or not.
151 	 */
152 	if (dp->i_diflags & XFS_DIFLAG_NOSYMLINKS) {
153 		error = -EPERM;
154 		goto out_trans_cancel;
155 	}
156 
157 	/*
158 	 * Allocate an inode for the symlink.
159 	 */
160 	error = xfs_dialloc(&tp, dp->i_ino, S_IFLNK, &ino);
161 	if (!error)
162 		error = xfs_init_new_inode(idmap, tp, dp, ino,
163 				S_IFLNK | (mode & ~S_IFMT), 1, 0, prid,
164 				false, &ip);
165 	if (error)
166 		goto out_trans_cancel;
167 
168 	/*
169 	 * Now we join the directory inode to the transaction.  We do not do it
170 	 * earlier because xfs_dir_ialloc might commit the previous transaction
171 	 * (and release all the locks).  An error from here on will result in
172 	 * the transaction cancel unlocking dp so don't do it explicitly in the
173 	 * error path.
174 	 */
175 	xfs_trans_ijoin(tp, dp, 0);
176 
177 	/*
178 	 * Also attach the dquot(s) to it, if applicable.
179 	 */
180 	xfs_qm_vop_create_dqattach(tp, ip, udqp, gdqp, pdqp);
181 
182 	resblks -= XFS_IALLOC_SPACE_RES(mp);
183 	error = xfs_symlink_write_target(tp, ip, ip->i_ino, target_path,
184 			pathlen, fs_blocks, resblks);
185 	if (error)
186 		goto out_trans_cancel;
187 	resblks -= fs_blocks;
188 	i_size_write(VFS_I(ip), ip->i_disk_size);
189 
190 	/*
191 	 * Create the directory entry for the symlink.
192 	 */
193 	error = xfs_dir_createname(tp, dp, link_name, ip->i_ino, resblks);
194 	if (error)
195 		goto out_trans_cancel;
196 	xfs_trans_ichgtime(tp, dp, XFS_ICHGTIME_MOD | XFS_ICHGTIME_CHG);
197 	xfs_trans_log_inode(tp, dp, XFS_ILOG_CORE);
198 	xfs_dir_update_hook(dp, ip, 1, link_name);
199 
200 	/*
201 	 * If this is a synchronous mount, make sure that the
202 	 * symlink transaction goes to disk before returning to
203 	 * the user.
204 	 */
205 	if (xfs_has_wsync(mp) || xfs_has_dirsync(mp))
206 		xfs_trans_set_sync(tp);
207 
208 	error = xfs_trans_commit(tp);
209 	if (error)
210 		goto out_release_inode;
211 
212 	xfs_qm_dqrele(udqp);
213 	xfs_qm_dqrele(gdqp);
214 	xfs_qm_dqrele(pdqp);
215 
216 	*ipp = ip;
217 	xfs_iunlock(ip, XFS_ILOCK_EXCL);
218 	xfs_iunlock(dp, XFS_ILOCK_EXCL);
219 	return 0;
220 
221 out_trans_cancel:
222 	xfs_trans_cancel(tp);
223 out_release_inode:
224 	/*
225 	 * Wait until after the current transaction is aborted to finish the
226 	 * setup of the inode and release the inode.  This prevents recursive
227 	 * transactions and deadlocks from xfs_inactive.
228 	 */
229 	if (ip) {
230 		xfs_iunlock(ip, XFS_ILOCK_EXCL);
231 		xfs_finish_inode_setup(ip);
232 		xfs_irele(ip);
233 	}
234 out_release_dquots:
235 	xfs_qm_dqrele(udqp);
236 	xfs_qm_dqrele(gdqp);
237 	xfs_qm_dqrele(pdqp);
238 
239 	if (unlock_dp_on_error)
240 		xfs_iunlock(dp, XFS_ILOCK_EXCL);
241 	return error;
242 }
243 
244 /*
245  * Free a symlink that has blocks associated with it.
246  *
247  * Note: zero length symlinks are not allowed to exist. When we set the size to
248  * zero, also change it to a regular file so that it does not get written to
249  * disk as a zero length symlink. The inode is on the unlinked list already, so
250  * userspace cannot find this inode anymore, so this change is not user visible
251  * but allows us to catch corrupt zero-length symlinks in the verifiers.
252  */
253 STATIC int
254 xfs_inactive_symlink_rmt(
255 	struct xfs_inode	*ip)
256 {
257 	struct xfs_mount	*mp = ip->i_mount;
258 	struct xfs_trans	*tp;
259 	int			error;
260 
261 	ASSERT(!xfs_need_iread_extents(&ip->i_df));
262 	/*
263 	 * We're freeing a symlink that has some
264 	 * blocks allocated to it.  Free the
265 	 * blocks here.  We know that we've got
266 	 * either 1 or 2 extents and that we can
267 	 * free them all in one bunmapi call.
268 	 */
269 	ASSERT(ip->i_df.if_nextents > 0 && ip->i_df.if_nextents <= 2);
270 
271 	error = xfs_trans_alloc(mp, &M_RES(mp)->tr_itruncate, 0, 0, 0, &tp);
272 	if (error)
273 		return error;
274 
275 	xfs_ilock(ip, XFS_ILOCK_EXCL);
276 	xfs_trans_ijoin(tp, ip, 0);
277 
278 	/*
279 	 * Lock the inode, fix the size, turn it into a regular file and join it
280 	 * to the transaction.  Hold it so in the normal path, we still have it
281 	 * locked for the second transaction.  In the error paths we need it
282 	 * held so the cancel won't rele it, see below.
283 	 */
284 	ip->i_disk_size = 0;
285 	VFS_I(ip)->i_mode = (VFS_I(ip)->i_mode & ~S_IFMT) | S_IFREG;
286 	xfs_trans_log_inode(tp, ip, XFS_ILOG_CORE);
287 
288 	error = xfs_symlink_remote_truncate(tp, ip);
289 	if (error)
290 		goto error_trans_cancel;
291 
292 	error = xfs_trans_commit(tp);
293 	if (error) {
294 		ASSERT(xfs_is_shutdown(mp));
295 		goto error_unlock;
296 	}
297 
298 	/*
299 	 * Remove the memory for extent descriptions (just bookkeeping).
300 	 */
301 	if (ip->i_df.if_bytes)
302 		xfs_idata_realloc(ip, -ip->i_df.if_bytes, XFS_DATA_FORK);
303 	ASSERT(ip->i_df.if_bytes == 0);
304 
305 	xfs_iunlock(ip, XFS_ILOCK_EXCL);
306 	return 0;
307 
308 error_trans_cancel:
309 	xfs_trans_cancel(tp);
310 error_unlock:
311 	xfs_iunlock(ip, XFS_ILOCK_EXCL);
312 	return error;
313 }
314 
315 /*
316  * xfs_inactive_symlink - free a symlink
317  */
318 int
319 xfs_inactive_symlink(
320 	struct xfs_inode	*ip)
321 {
322 	struct xfs_mount	*mp = ip->i_mount;
323 	int			pathlen;
324 
325 	trace_xfs_inactive_symlink(ip);
326 
327 	if (xfs_is_shutdown(mp))
328 		return -EIO;
329 
330 	xfs_ilock(ip, XFS_ILOCK_EXCL);
331 	pathlen = (int)ip->i_disk_size;
332 	ASSERT(pathlen);
333 
334 	if (pathlen <= 0 || pathlen > XFS_SYMLINK_MAXLEN) {
335 		xfs_alert(mp, "%s: inode (0x%llx) bad symlink length (%d)",
336 			 __func__, (unsigned long long)ip->i_ino, pathlen);
337 		xfs_iunlock(ip, XFS_ILOCK_EXCL);
338 		ASSERT(0);
339 		xfs_inode_mark_sick(ip, XFS_SICK_INO_SYMLINK);
340 		return -EFSCORRUPTED;
341 	}
342 
343 	/*
344 	 * Inline fork state gets removed by xfs_difree() so we have nothing to
345 	 * do here in that case.
346 	 */
347 	if (ip->i_df.if_format == XFS_DINODE_FMT_LOCAL) {
348 		xfs_iunlock(ip, XFS_ILOCK_EXCL);
349 		return 0;
350 	}
351 
352 	xfs_iunlock(ip, XFS_ILOCK_EXCL);
353 
354 	/* remove the remote symlink */
355 	return xfs_inactive_symlink_rmt(ip);
356 }
357