fs/xfs/xfs_symlink.c

   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
  25 /* ----- Kernel only functions below ----- */
  26 int
  27 xfs_readlink_bmap_ilocked(
  28         struct xfs_inode        *ip,
  29         char                    *link)
  30 {
  31         struct xfs_mount        *mp = ip->i_mount;
  32         struct xfs_bmbt_irec    mval[XFS_SYMLINK_MAPS];
  33         struct xfs_buf          *bp;
  34         xfs_daddr_t             d;
  35         char                    *cur_chunk;
  36         int                     pathlen = ip->i_d.di_size;
  37         int                     nmaps = XFS_SYMLINK_MAPS;
  38         int                     byte_cnt;
  39         int                     n;
  40         int                     error = 0;
  41         int                     fsblocks = 0;
  42         int                     offset;
  43
  44         ASSERT(xfs_isilocked(ip, XFS_ILOCK_SHARED | XFS_ILOCK_EXCL));
  45
  46         fsblocks = xfs_symlink_blocks(mp, pathlen);
  47         error = xfs_bmapi_read(ip, 0, fsblocks, mval, &nmaps, 0);
  48         if (error)
  49                 goto out;
  50
  51         offset = 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);
  55
  56                 error = xfs_buf_read(mp->m_ddev_targp, d, BTOBB(byte_cnt), 0,
  57                                 &bp, &xfs_symlink_buf_ops);
  58                 if (error)
  59                         return error;
  60                 byte_cnt = XFS_SYMLINK_BUF_SPACE(mp, byte_cnt);
  61                 if (pathlen < byte_cnt)
  62                         byte_cnt = pathlen;
  63
  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,
  67                                                         byte_cnt, bp)) {
  68                                 error = -EFSCORRUPTED;
  69                                 xfs_alert(mp,
  70 "symlink header does not match required off/len/owner (0x%x/Ox%x,0x%llx)",
  71                                         offset, byte_cnt, ip->i_ino);
  72                                 xfs_buf_relse(bp);
  73                                 goto out;
  74
  75                         }
  76
  77                         cur_chunk += sizeof(struct xfs_dsymlink_hdr);
  78                 }
  79
  80                 memcpy(link + offset, cur_chunk, byte_cnt);
  81
  82                 pathlen -= byte_cnt;
  83                 offset += byte_cnt;
  84
  85                 xfs_buf_relse(bp);
  86         }
  87         ASSERT(pathlen == 0);
  88
  89         link[ip->i_d.di_size] = '\0';
  90         error = 0;
  91
  92  out:
  93         return error;
  94 }
  95
  96 int
  97 xfs_readlink(
  98         struct xfs_inode *ip,
  99         char            *link)
 100 {
 101         struct xfs_mount *mp = ip->i_mount;
 102         xfs_fsize_t     pathlen;
 103         int             error = 0;
 104
 105         trace_xfs_readlink(ip);
 106
 107         ASSERT(!(ip->i_df.if_flags & XFS_IFINLINE));
 108
 109         if (XFS_FORCED_SHUTDOWN(mp))
 110                 return -EIO;
 111
 112         xfs_ilock(ip, XFS_ILOCK_SHARED);
 113
 114         pathlen = ip->i_d.di_size;
 115         if (!pathlen)
 116                 goto out;
 117
 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);
 122                 ASSERT(0);
 123                 error = -EFSCORRUPTED;
 124                 goto out;
 125         }
 126
 127
 128         error = xfs_readlink_bmap_ilocked(ip, link);
 129
 130  out:
 131         xfs_iunlock(ip, XFS_ILOCK_SHARED);
 132         return error;
 133 }
 134
 135 int
 136 xfs_symlink(
 137         struct xfs_inode        *dp,
 138         struct xfs_name         *link_name,
 139         const char              *target_path,
 140         umode_t                 mode,
 141         struct xfs_inode        **ipp)
 142 {
 143         struct xfs_mount        *mp = dp->i_mount;
 144         struct xfs_trans        *tp = NULL;
 145         struct xfs_inode        *ip = NULL;
 146         int                     error = 0;
 147         int                     pathlen;
 148         bool                    unlock_dp_on_error = false;
 149         xfs_fileoff_t           first_fsb;
 150         xfs_filblks_t           fs_blocks;
 151         int                     nmaps;
 152         struct xfs_bmbt_irec    mval[XFS_SYMLINK_MAPS];
 153         xfs_daddr_t             d;
 154         const char              *cur_chunk;
 155         int                     byte_cnt;
 156         int                     n;
 157         xfs_buf_t               *bp;
 158         prid_t                  prid;
 159         struct xfs_dquot        *udqp = NULL;
 160         struct xfs_dquot        *gdqp = NULL;
 161         struct xfs_dquot        *pdqp = NULL;
 162         uint                    resblks;
 163
 164         *ipp = NULL;
 165
 166         trace_xfs_symlink(dp, link_name);
 167
 168         if (XFS_FORCED_SHUTDOWN(mp))
 169                 return -EIO;
 170
 171         /*
 172          * Check component lengths of the target path name.
 173          */
 174         pathlen = strlen(target_path);
 175         if (pathlen >= XFS_SYMLINK_MAXLEN)      /* total string too long */
 176                 return -ENAMETOOLONG;
 177         ASSERT(pathlen > 0);
 178
 179         udqp = gdqp = NULL;
 180         prid = xfs_get_initial_prid(dp);
 181
 182         /*
 183          * Make sure that we have allocated dquot(s) on disk.
 184          */
 185         error = xfs_qm_vop_dqalloc(dp,
 186                         xfs_kuid_to_uid(current_fsuid()),
 187                         xfs_kgid_to_gid(current_fsgid()), prid,
 188                         XFS_QMOPT_QUOTALL | XFS_QMOPT_INHERIT,
 189                         &udqp, &gdqp, &pdqp);
 190         if (error)
 191                 return error;
 192
 193         /*
 194          * The symlink will fit into the inode data fork?
 195          * There can't be any attributes so we get the whole variable part.
 196          */
 197         if (pathlen <= XFS_LITINO(mp, dp->i_d.di_version))
 198                 fs_blocks = 0;
 199         else
 200                 fs_blocks = xfs_symlink_blocks(mp, pathlen);
 201         resblks = XFS_SYMLINK_SPACE_RES(mp, link_name->len, fs_blocks);
 202
 203         error = xfs_trans_alloc(mp, &M_RES(mp)->tr_symlink, resblks, 0, 0, &tp);
 204         if (error)
 205                 goto out_release_inode;
 206
 207         xfs_ilock(dp, XFS_ILOCK_EXCL | XFS_ILOCK_PARENT);
 208         unlock_dp_on_error = true;
 209
 210         /*
 211          * Check whether the directory allows new symlinks or not.
 212          */
 213         if (dp->i_d.di_flags & XFS_DIFLAG_NOSYMLINKS) {
 214                 error = -EPERM;
 215                 goto out_trans_cancel;
 216         }
 217
 218         /*
 219          * Reserve disk quota : blocks and inode.
 220          */
 221         error = xfs_trans_reserve_quota(tp, mp, udqp, gdqp,
 222                                                 pdqp, resblks, 1, 0);
 223         if (error)
 224                 goto out_trans_cancel;
 225
 226         /*
 227          * Allocate an inode for the symlink.
 228          */
 229         error = xfs_dir_ialloc(&tp, dp, S_IFLNK | (mode & ~S_IFMT), 1, 0,
 230                                prid, &ip);
 231         if (error)
 232                 goto out_trans_cancel;
 233
 234         /*
 235          * Now we join the directory inode to the transaction.  We do not do it
 236          * earlier because xfs_dir_ialloc might commit the previous transaction
 237          * (and release all the locks).  An error from here on will result in
 238          * the transaction cancel unlocking dp so don't do it explicitly in the
 239          * error path.
 240          */
 241         xfs_trans_ijoin(tp, dp, XFS_ILOCK_EXCL);
 242         unlock_dp_on_error = false;
 243
 244         /*
 245          * Also attach the dquot(s) to it, if applicable.
 246          */
 247         xfs_qm_vop_create_dqattach(tp, ip, udqp, gdqp, pdqp);
 248
 249         if (resblks)
 250                 resblks -= XFS_IALLOC_SPACE_RES(mp);
 251         /*
 252          * If the symlink will fit into the inode, write it inline.
 253          */
 254         if (pathlen <= XFS_IFORK_DSIZE(ip)) {
 255                 xfs_init_local_fork(ip, XFS_DATA_FORK, target_path, pathlen);
 256
 257                 ip->i_d.di_size = pathlen;
 258                 ip->i_d.di_format = XFS_DINODE_FMT_LOCAL;
 259                 xfs_trans_log_inode(tp, ip, XFS_ILOG_DDATA | XFS_ILOG_CORE);
 260         } else {
 261                 int     offset;
 262
 263                 first_fsb = 0;
 264                 nmaps = XFS_SYMLINK_MAPS;
 265
 266                 error = xfs_bmapi_write(tp, ip, first_fsb, fs_blocks,
 267                                   XFS_BMAPI_METADATA, resblks, mval, &nmaps);
 268                 if (error)
 269                         goto out_trans_cancel;
 270
 271                 if (resblks)
 272                         resblks -= fs_blocks;
 273                 ip->i_d.di_size = pathlen;
 274                 xfs_trans_log_inode(tp, ip, XFS_ILOG_CORE);
 275
 276                 cur_chunk = target_path;
 277                 offset = 0;
 278                 for (n = 0; n < nmaps; n++) {
 279                         char    *buf;
 280
 281                         d = XFS_FSB_TO_DADDR(mp, mval[n].br_startblock);
 282                         byte_cnt = XFS_FSB_TO_B(mp, mval[n].br_blockcount);
 283                         error = xfs_trans_get_buf(tp, mp->m_ddev_targp, d,
 284                                                BTOBB(byte_cnt), 0, &bp);
 285                         if (error)
 286                                 goto out_trans_cancel;
 287                         bp->b_ops = &xfs_symlink_buf_ops;
 288
 289                         byte_cnt = XFS_SYMLINK_BUF_SPACE(mp, byte_cnt);
 290                         byte_cnt = min(byte_cnt, pathlen);
 291
 292                         buf = bp->b_addr;
 293                         buf += xfs_symlink_hdr_set(mp, ip->i_ino, offset,
 294                                                    byte_cnt, bp);
 295
 296                         memcpy(buf, cur_chunk, byte_cnt);
 297
 298                         cur_chunk += byte_cnt;
 299                         pathlen -= byte_cnt;
 300                         offset += byte_cnt;
 301
 302                         xfs_trans_buf_set_type(tp, bp, XFS_BLFT_SYMLINK_BUF);
 303                         xfs_trans_log_buf(tp, bp, 0, (buf + byte_cnt - 1) -
 304                                                         (char *)bp->b_addr);
 305                 }
 306                 ASSERT(pathlen == 0);
 307         }
 308
 309         /*
 310          * Create the directory entry for the symlink.
 311          */
 312         error = xfs_dir_createname(tp, dp, link_name, ip->i_ino, resblks);
 313         if (error)
 314                 goto out_trans_cancel;
 315         xfs_trans_ichgtime(tp, dp, XFS_ICHGTIME_MOD | XFS_ICHGTIME_CHG);
 316         xfs_trans_log_inode(tp, dp, XFS_ILOG_CORE);
 317
 318         /*
 319          * If this is a synchronous mount, make sure that the
 320          * symlink transaction goes to disk before returning to
 321          * the user.
 322          */
 323         if (mp->m_flags & (XFS_MOUNT_WSYNC|XFS_MOUNT_DIRSYNC)) {
 324                 xfs_trans_set_sync(tp);
 325         }
 326
 327         error = xfs_trans_commit(tp);
 328         if (error)
 329                 goto out_release_inode;
 330
 331         xfs_qm_dqrele(udqp);
 332         xfs_qm_dqrele(gdqp);
 333         xfs_qm_dqrele(pdqp);
 334
 335         *ipp = ip;
 336         return 0;
 337
 338 out_trans_cancel:
 339         xfs_trans_cancel(tp);
 340 out_release_inode:
 341         /*
 342          * Wait until after the current transaction is aborted to finish the
 343          * setup of the inode and release the inode.  This prevents recursive
 344          * transactions and deadlocks from xfs_inactive.
 345          */
 346         if (ip) {
 347                 xfs_finish_inode_setup(ip);
 348                 xfs_irele(ip);
 349         }
 350
 351         xfs_qm_dqrele(udqp);
 352         xfs_qm_dqrele(gdqp);
 353         xfs_qm_dqrele(pdqp);
 354
 355         if (unlock_dp_on_error)
 356                 xfs_iunlock(dp, XFS_ILOCK_EXCL);
 357         return error;
 358 }
 359
 360 /*
 361  * Free a symlink that has blocks associated with it.
 362  *
 363  * Note: zero length symlinks are not allowed to exist. When we set the size to
 364  * zero, also change it to a regular file so that it does not get written to
 365  * disk as a zero length symlink. The inode is on the unlinked list already, so
 366  * userspace cannot find this inode anymore, so this change is not user visible
 367  * but allows us to catch corrupt zero-length symlinks in the verifiers.
 368  */
 369 STATIC int
 370 xfs_inactive_symlink_rmt(
 371         struct xfs_inode *ip)
 372 {
 373         xfs_buf_t       *bp;
 374         int             done;
 375         int             error;
 376         int             i;
 377         xfs_mount_t     *mp;
 378         xfs_bmbt_irec_t mval[XFS_SYMLINK_MAPS];
 379         int             nmaps;
 380         int             size;
 381         xfs_trans_t     *tp;
 382
 383         mp = ip->i_mount;
 384         ASSERT(ip->i_df.if_flags & XFS_IFEXTENTS);
 385         /*
 386          * We're freeing a symlink that has some
 387          * blocks allocated to it.  Free the
 388          * blocks here.  We know that we've got
 389          * either 1 or 2 extents and that we can
 390          * free them all in one bunmapi call.
 391          */
 392         ASSERT(ip->i_d.di_nextents > 0 && ip->i_d.di_nextents <= 2);
 393
 394         error = xfs_trans_alloc(mp, &M_RES(mp)->tr_itruncate, 0, 0, 0, &tp);
 395         if (error)
 396                 return error;
 397
 398         xfs_ilock(ip, XFS_ILOCK_EXCL);
 399         xfs_trans_ijoin(tp, ip, 0);
 400
 401         /*
 402          * Lock the inode, fix the size, turn it into a regular file and join it
 403          * to the transaction.  Hold it so in the normal path, we still have it
 404          * locked for the second transaction.  In the error paths we need it
 405          * held so the cancel won't rele it, see below.
 406          */
 407         size = (int)ip->i_d.di_size;
 408         ip->i_d.di_size = 0;
 409         VFS_I(ip)->i_mode = (VFS_I(ip)->i_mode & ~S_IFMT) | S_IFREG;
 410         xfs_trans_log_inode(tp, ip, XFS_ILOG_CORE);
 411         /*
 412          * Find the block(s) so we can inval and unmap them.
 413          */
 414         done = 0;
 415         nmaps = ARRAY_SIZE(mval);
 416         error = xfs_bmapi_read(ip, 0, xfs_symlink_blocks(mp, size),
 417                                 mval, &nmaps, 0);
 418         if (error)
 419                 goto error_trans_cancel;
 420         /*
 421          * Invalidate the block(s). No validation is done.
 422          */
 423         for (i = 0; i < nmaps; i++) {
 424                 error = xfs_trans_get_buf(tp, mp->m_ddev_targp,
 425                                 XFS_FSB_TO_DADDR(mp, mval[i].br_startblock),
 426                                 XFS_FSB_TO_BB(mp, mval[i].br_blockcount), 0,
 427                                 &bp);
 428                 if (error)
 429                         goto error_trans_cancel;
 430                 xfs_trans_binval(tp, bp);
 431         }
 432         /*
 433          * Unmap the dead block(s) to the dfops.
 434          */
 435         error = xfs_bunmapi(tp, ip, 0, size, 0, nmaps, &done);
 436         if (error)
 437                 goto error_trans_cancel;
 438         ASSERT(done);
 439
 440         /*
 441          * Commit the transaction. This first logs the EFI and the inode, then
 442          * rolls and commits the transaction that frees the extents.
 443          */
 444         xfs_trans_log_inode(tp, ip, XFS_ILOG_CORE);
 445         error = xfs_trans_commit(tp);
 446         if (error) {
 447                 ASSERT(XFS_FORCED_SHUTDOWN(mp));
 448                 goto error_unlock;
 449         }
 450
 451         /*
 452          * Remove the memory for extent descriptions (just bookkeeping).
 453          */
 454         if (ip->i_df.if_bytes)
 455                 xfs_idata_realloc(ip, -ip->i_df.if_bytes, XFS_DATA_FORK);
 456         ASSERT(ip->i_df.if_bytes == 0);
 457
 458         xfs_iunlock(ip, XFS_ILOCK_EXCL);
 459         return 0;
 460
 461 error_trans_cancel:
 462         xfs_trans_cancel(tp);
 463 error_unlock:
 464         xfs_iunlock(ip, XFS_ILOCK_EXCL);
 465         return error;
 466 }
 467
 468 /*
 469  * xfs_inactive_symlink - free a symlink
 470  */
 471 int
 472 xfs_inactive_symlink(
 473         struct xfs_inode        *ip)
 474 {
 475         struct xfs_mount        *mp = ip->i_mount;
 476         int                     pathlen;
 477
 478         trace_xfs_inactive_symlink(ip);
 479
 480         if (XFS_FORCED_SHUTDOWN(mp))
 481                 return -EIO;
 482
 483         xfs_ilock(ip, XFS_ILOCK_EXCL);
 484         pathlen = (int)ip->i_d.di_size;
 485         ASSERT(pathlen);
 486
 487         if (pathlen <= 0 || pathlen > XFS_SYMLINK_MAXLEN) {
 488                 xfs_alert(mp, "%s: inode (0x%llx) bad symlink length (%d)",
 489                          __func__, (unsigned long long)ip->i_ino, pathlen);
 490                 xfs_iunlock(ip, XFS_ILOCK_EXCL);
 491                 ASSERT(0);
 492                 return -EFSCORRUPTED;
 493         }
 494
 495         /*
 496          * Inline fork state gets removed by xfs_difree() so we have nothing to
 497          * do here in that case.
 498          */
 499         if (ip->i_df.if_flags & XFS_IFINLINE) {
 500                 xfs_iunlock(ip, XFS_ILOCK_EXCL);
 501                 return 0;
 502         }
 503
 504         xfs_iunlock(ip, XFS_ILOCK_EXCL);
 505
 506         /* remove the remote symlink */
 507         return xfs_inactive_symlink_rmt(ip);
 508 }