linux_getcwd.c revision 281829
182518Sgallatin/* $OpenBSD: linux_getcwd.c,v 1.2 2001/05/16 12:50:21 ho Exp $ */ 282518Sgallatin/* $NetBSD: vfs_getcwd.c,v 1.3.2.3 1999/07/11 10:24:09 sommerfeld Exp $ */ 382518Sgallatin/*- 482518Sgallatin * Copyright (c) 1999 The NetBSD Foundation, Inc. 582518Sgallatin * All rights reserved. 682518Sgallatin * 782518Sgallatin * This code is derived from software contributed to The NetBSD Foundation 882518Sgallatin * by Bill Sommerfeld. 982518Sgallatin * 1082518Sgallatin * Redistribution and use in source and binary forms, with or without 1182518Sgallatin * modification, are permitted provided that the following conditions 1282518Sgallatin * are met: 1382518Sgallatin * 1. Redistributions of source code must retain the above copyright 1482518Sgallatin * notice, this list of conditions and the following disclaimer. 1582518Sgallatin * 2. Redistributions in binary form must reproduce the above copyright 1682518Sgallatin * notice, this list of conditions and the following disclaimer in the 1782518Sgallatin * documentation and/or other materials provided with the distribution. 1882518Sgallatin * 1982518Sgallatin * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 2082518Sgallatin * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 2182518Sgallatin * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 2282518Sgallatin * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 2382518Sgallatin * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 2482518Sgallatin * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 2582518Sgallatin * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 2682518Sgallatin * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 2782518Sgallatin * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 2882518Sgallatin * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 2982518Sgallatin * POSSIBILITY OF SUCH DAMAGE. 3082518Sgallatin */ 31116173Sobrien 32116173Sobrien#include <sys/cdefs.h> 33116173Sobrien__FBSDID("$FreeBSD: head/sys/compat/linux/linux_getcwd.c 281829 2015-04-21 13:55:24Z trasz $"); 34116173Sobrien 35156874Sru#include "opt_compat.h" 3682518Sgallatin 3782518Sgallatin#include <sys/param.h> 3882518Sgallatin#include <sys/systm.h> 39112430Sphk#include <sys/namei.h> 40112430Sphk#include <sys/filedesc.h> 41112430Sphk#include <sys/kernel.h> 42112430Sphk#include <sys/file.h> 43112430Sphk#include <sys/stat.h> 44102872Siedowse#include <sys/syscallsubr.h> 45112430Sphk#include <sys/vnode.h> 46112430Sphk#include <sys/mount.h> 4782518Sgallatin#include <sys/proc.h> 48112430Sphk#include <sys/uio.h> 49112430Sphk#include <sys/malloc.h> 50112430Sphk#include <sys/dirent.h> 51112430Sphk#include <ufs/ufs/dir.h> /* XXX only for DIRBLKSIZ */ 5282518Sgallatin 53140214Sobrien#ifdef COMPAT_LINUX32 54140214Sobrien#include <machine/../linux32/linux.h> 55140214Sobrien#include <machine/../linux32/linux32_proto.h> 56140214Sobrien#else 5782518Sgallatin#include <machine/../linux/linux.h> 5882518Sgallatin#include <machine/../linux/linux_proto.h> 59133816Stjr#endif 60281829Strasz#include <compat/linux/linux_misc.h> 61112430Sphk#include <compat/linux/linux_util.h> 6282518Sgallatin 63163606Srwatson#include <security/mac/mac_framework.h> 64163606Srwatson 65112430Sphkstatic int 66112430Sphklinux_getcwd_scandir(struct vnode **, struct vnode **, 67112430Sphk char **, char *, struct thread *); 68112430Sphkstatic int 69112430Sphklinux_getcwd_common(struct vnode *, struct vnode *, 70112430Sphk char **, char *, int, int, struct thread *); 71112430Sphk 72112430Sphk#define DIRENT_MINSIZE (sizeof(struct dirent) - (MAXNAMLEN+1) + 4) 73112430Sphk 7482518Sgallatin/* 75112430Sphk * Vnode variable naming conventions in this file: 76112430Sphk * 77112430Sphk * rvp: the current root we're aiming towards. 78112430Sphk * lvp, *lvpp: the "lower" vnode 79112430Sphk * uvp, *uvpp: the "upper" vnode. 80112430Sphk * 81112430Sphk * Since all the vnodes we're dealing with are directories, and the 82112430Sphk * lookups are going *up* in the filesystem rather than *down*, the 83112430Sphk * usual "pvp" (parent) or "dvp" (directory) naming conventions are 84112430Sphk * too confusing. 85112430Sphk */ 86112430Sphk 87112430Sphk/* 88112430Sphk * XXX Will infinite loop in certain cases if a directory read reliably 89112430Sphk * returns EINVAL on last block. 90112430Sphk * XXX is EINVAL the right thing to return if a directory is malformed? 91112430Sphk */ 92112430Sphk 93112430Sphk/* 94112430Sphk * XXX Untested vs. mount -o union; probably does the wrong thing. 95112430Sphk */ 96112430Sphk 97112430Sphk/* 98112430Sphk * Find parent vnode of *lvpp, return in *uvpp 99112430Sphk * 100112430Sphk * If we care about the name, scan it looking for name of directory 101112430Sphk * entry pointing at lvp. 102112430Sphk * 103112430Sphk * Place the name in the buffer which starts at bufp, immediately 104112430Sphk * before *bpp, and move bpp backwards to point at the start of it. 105112430Sphk * 106112430Sphk * On entry, *lvpp is a locked vnode reference; on exit, it is vput and NULL'ed 107112430Sphk * On exit, *uvpp is either NULL or is a locked vnode reference. 108112430Sphk */ 109112430Sphkstatic int 110112430Sphklinux_getcwd_scandir(lvpp, uvpp, bpp, bufp, td) 111112430Sphk struct vnode **lvpp; 112112430Sphk struct vnode **uvpp; 113112430Sphk char **bpp; 114112430Sphk char *bufp; 115112430Sphk struct thread *td; 116112430Sphk{ 117112430Sphk int error = 0; 118112430Sphk int eofflag; 119112430Sphk off_t off; 120112430Sphk int tries; 121112430Sphk struct uio uio; 122112430Sphk struct iovec iov; 123112430Sphk char *dirbuf = NULL; 124112430Sphk int dirbuflen; 125112430Sphk ino_t fileno; 126112430Sphk struct vattr va; 127112430Sphk struct vnode *uvp = NULL; 128112430Sphk struct vnode *lvp = *lvpp; 129112430Sphk struct componentname cn; 130112430Sphk int len, reclen; 131112430Sphk tries = 0; 132112430Sphk 133112430Sphk /* 134112430Sphk * If we want the filename, get some info we need while the 135112430Sphk * current directory is still locked. 136112430Sphk */ 137112430Sphk if (bufp != NULL) { 138182371Sattilio error = VOP_GETATTR(lvp, &va, td->td_ucred); 139112430Sphk if (error) { 140112430Sphk vput(lvp); 141112430Sphk *lvpp = NULL; 142112430Sphk *uvpp = NULL; 143112430Sphk return error; 144112430Sphk } 145112430Sphk } 146112430Sphk 147112430Sphk /* 148112430Sphk * Ok, we have to do it the hard way.. 149112430Sphk * Next, get parent vnode using lookup of .. 150112430Sphk */ 151112430Sphk cn.cn_nameiop = LOOKUP; 152112430Sphk cn.cn_flags = ISLASTCN | ISDOTDOT | RDONLY; 153112430Sphk cn.cn_thread = td; 154112430Sphk cn.cn_cred = td->td_ucred; 155112430Sphk cn.cn_pnbuf = NULL; 156112430Sphk cn.cn_nameptr = ".."; 157112430Sphk cn.cn_namelen = 2; 158112430Sphk cn.cn_consume = 0; 159188588Sjhb cn.cn_lkflags = LK_SHARED; 160112430Sphk 161112430Sphk /* 162112430Sphk * At this point, lvp is locked and will be unlocked by the lookup. 163112430Sphk * On successful return, *uvpp will be locked 164112430Sphk */ 165122861Srwatson#ifdef MAC 166172930Srwatson error = mac_vnode_check_lookup(td->td_ucred, lvp, &cn); 167122861Srwatson if (error == 0) 168122861Srwatson#endif 169122861Srwatson error = VOP_LOOKUP(lvp, uvpp, &cn); 170112430Sphk if (error) { 171112430Sphk vput(lvp); 172112430Sphk *lvpp = NULL; 173112430Sphk *uvpp = NULL; 174112430Sphk return error; 175112430Sphk } 176112430Sphk uvp = *uvpp; 177112430Sphk 178112430Sphk /* If we don't care about the pathname, we're done */ 179112430Sphk if (bufp == NULL) { 180145006Sjeff vput(lvp); 181112430Sphk *lvpp = NULL; 182112430Sphk return 0; 183112430Sphk } 184112430Sphk 185112430Sphk fileno = va.va_fileid; 186112430Sphk 187112430Sphk dirbuflen = DIRBLKSIZ; 188112430Sphk if (dirbuflen < va.va_blocksize) 189112430Sphk dirbuflen = va.va_blocksize; 190276654Sdchagin dirbuf = malloc(dirbuflen, M_TEMP, M_WAITOK); 191112430Sphk 192112430Sphk#if 0 193112430Sphkunionread: 194112430Sphk#endif 195112430Sphk off = 0; 196112430Sphk do { 197112430Sphk /* call VOP_READDIR of parent */ 198112430Sphk iov.iov_base = dirbuf; 199112430Sphk iov.iov_len = dirbuflen; 200112430Sphk 201112430Sphk uio.uio_iov = &iov; 202112430Sphk uio.uio_iovcnt = 1; 203112430Sphk uio.uio_offset = off; 204112430Sphk uio.uio_resid = dirbuflen; 205112430Sphk uio.uio_segflg = UIO_SYSSPACE; 206112430Sphk uio.uio_rw = UIO_READ; 207112430Sphk uio.uio_td = td; 208112430Sphk 209112430Sphk eofflag = 0; 210112430Sphk 211112430Sphk#ifdef MAC 212172930Srwatson error = mac_vnode_check_readdir(td->td_ucred, uvp); 213112430Sphk if (error == 0) 214112430Sphk#endif /* MAC */ 215112430Sphk error = VOP_READDIR(uvp, &uio, td->td_ucred, &eofflag, 216112430Sphk 0, 0); 217112430Sphk 218112430Sphk off = uio.uio_offset; 219112430Sphk 220112430Sphk /* 221112430Sphk * Try again if NFS tosses its cookies. 222112430Sphk * XXX this can still loop forever if the directory is busted 223112430Sphk * such that the second or subsequent page of it always 224112430Sphk * returns EINVAL 225112430Sphk */ 226112430Sphk if ((error == EINVAL) && (tries < 3)) { 227112430Sphk off = 0; 228112430Sphk tries++; 229112430Sphk continue; /* once more, with feeling */ 230112430Sphk } 231112430Sphk 232112430Sphk if (!error) { 233112430Sphk char *cpos; 234112430Sphk struct dirent *dp; 235112430Sphk 236112430Sphk cpos = dirbuf; 237112430Sphk tries = 0; 238112430Sphk 239112430Sphk /* scan directory page looking for matching vnode */ 240112430Sphk for (len = (dirbuflen - uio.uio_resid); len > 0; len -= reclen) { 241112430Sphk dp = (struct dirent *) cpos; 242112430Sphk reclen = dp->d_reclen; 243112430Sphk 244112430Sphk /* check for malformed directory.. */ 245112430Sphk if (reclen < DIRENT_MINSIZE) { 246112430Sphk error = EINVAL; 247112430Sphk goto out; 248112430Sphk } 249112430Sphk /* 250112430Sphk * XXX should perhaps do VOP_LOOKUP to 251112430Sphk * check that we got back to the right place, 252112430Sphk * but getting the locking games for that 253112430Sphk * right would be heinous. 254112430Sphk */ 255112430Sphk if ((dp->d_type != DT_WHT) && 256112430Sphk (dp->d_fileno == fileno)) { 257112430Sphk char *bp = *bpp; 258112430Sphk bp -= dp->d_namlen; 259112430Sphk 260112430Sphk if (bp <= bufp) { 261112430Sphk error = ERANGE; 262112430Sphk goto out; 263112430Sphk } 264112430Sphk bcopy(dp->d_name, bp, dp->d_namlen); 265112430Sphk error = 0; 266112430Sphk *bpp = bp; 267112430Sphk goto out; 268112430Sphk } 269112430Sphk cpos += reclen; 270112430Sphk } 271112430Sphk } 272112430Sphk } while (!eofflag); 273112430Sphk error = ENOENT; 274112430Sphk 275112430Sphkout: 276145006Sjeff vput(lvp); 277112430Sphk *lvpp = NULL; 278112430Sphk free(dirbuf, M_TEMP); 279112430Sphk return error; 280112430Sphk} 281112430Sphk 282112430Sphk 283112430Sphk/* 284112430Sphk * common routine shared by sys___getcwd() and linux_vn_isunder() 285112430Sphk */ 286112430Sphk 287112430Sphk#define GETCWD_CHECK_ACCESS 0x0001 288112430Sphk 289112430Sphkstatic int 290112430Sphklinux_getcwd_common (lvp, rvp, bpp, bufp, limit, flags, td) 291112430Sphk struct vnode *lvp; 292112430Sphk struct vnode *rvp; 293112430Sphk char **bpp; 294112430Sphk char *bufp; 295112430Sphk int limit; 296112430Sphk int flags; 297112430Sphk struct thread *td; 298112430Sphk{ 299112430Sphk struct filedesc *fdp = td->td_proc->p_fd; 300112430Sphk struct vnode *uvp = NULL; 301112430Sphk char *bp = NULL; 302112430Sphk int error; 303184413Strasz accmode_t accmode = VEXEC; 304112430Sphk 305112430Sphk if (rvp == NULL) { 306112430Sphk rvp = fdp->fd_rdir; 307112430Sphk if (rvp == NULL) 308112430Sphk rvp = rootvnode; 309112430Sphk } 310112430Sphk 311112430Sphk VREF(rvp); 312112430Sphk VREF(lvp); 313112430Sphk 314112430Sphk /* 315112430Sphk * Error handling invariant: 316112430Sphk * Before a `goto out': 317112430Sphk * lvp is either NULL, or locked and held. 318112430Sphk * uvp is either NULL, or locked and held. 319112430Sphk */ 320112430Sphk 321175202Sattilio error = vn_lock(lvp, LK_EXCLUSIVE | LK_RETRY); 322155033Sjeff if (error != 0) 323155033Sjeff panic("vn_lock LK_RETRY returned error %d", error); 324112430Sphk if (bufp) 325112430Sphk bp = *bpp; 326112430Sphk /* 327112430Sphk * this loop will terminate when one of the following happens: 328112430Sphk * - we hit the root 329112430Sphk * - getdirentries or lookup fails 330112430Sphk * - we run out of space in the buffer. 331112430Sphk */ 332112430Sphk if (lvp == rvp) { 333112430Sphk if (bp) 334112430Sphk *(--bp) = '/'; 335112430Sphk goto out; 336112430Sphk } 337112430Sphk do { 338112430Sphk if (lvp->v_type != VDIR) { 339112430Sphk error = ENOTDIR; 340112430Sphk goto out; 341112430Sphk } 342112430Sphk 343112430Sphk /* 344112430Sphk * access check here is optional, depending on 345112430Sphk * whether or not caller cares. 346112430Sphk */ 347112430Sphk if (flags & GETCWD_CHECK_ACCESS) { 348184413Strasz error = VOP_ACCESS(lvp, accmode, td->td_ucred, td); 349112430Sphk if (error) 350112430Sphk goto out; 351184413Strasz accmode = VEXEC|VREAD; 352112430Sphk } 353112430Sphk 354112430Sphk /* 355112430Sphk * step up if we're a covered vnode.. 356112430Sphk */ 357112430Sphk while (lvp->v_vflag & VV_ROOT) { 358112430Sphk struct vnode *tvp; 359112430Sphk 360112430Sphk if (lvp == rvp) 361112430Sphk goto out; 362112430Sphk 363112430Sphk tvp = lvp; 364112430Sphk lvp = lvp->v_mount->mnt_vnodecovered; 365112430Sphk vput(tvp); 366112430Sphk /* 367112430Sphk * hodie natus est radici frater 368112430Sphk */ 369112430Sphk if (lvp == NULL) { 370112430Sphk error = ENOENT; 371112430Sphk goto out; 372112430Sphk } 373112430Sphk VREF(lvp); 374175202Sattilio error = vn_lock(lvp, LK_EXCLUSIVE | LK_RETRY); 375155033Sjeff if (error != 0) 376155033Sjeff panic("vn_lock LK_RETRY returned %d", error); 377112430Sphk } 378112430Sphk error = linux_getcwd_scandir(&lvp, &uvp, &bp, bufp, td); 379112430Sphk if (error) 380112430Sphk goto out; 381153072Sru#ifdef DIAGNOSTIC 382112430Sphk if (lvp != NULL) 383112430Sphk panic("getcwd: oops, forgot to null lvp"); 384112430Sphk if (bufp && (bp <= bufp)) { 385112430Sphk panic("getcwd: oops, went back too far"); 386112430Sphk } 387112430Sphk#endif 388112430Sphk if (bp) 389112430Sphk *(--bp) = '/'; 390112430Sphk lvp = uvp; 391112430Sphk uvp = NULL; 392112430Sphk limit--; 393112430Sphk } while ((lvp != rvp) && (limit > 0)); 394112430Sphk 395112430Sphkout: 396112430Sphk if (bpp) 397112430Sphk *bpp = bp; 398112430Sphk if (uvp) 399112430Sphk vput(uvp); 400112430Sphk if (lvp) 401112430Sphk vput(lvp); 402112430Sphk vrele(rvp); 403112430Sphk return error; 404112430Sphk} 405112430Sphk 406112430Sphk 407112430Sphk/* 40882518Sgallatin * Find pathname of process's current directory. 40982518Sgallatin * 41082518Sgallatin * Use vfs vnode-to-name reverse cache; if that fails, fall back 411112430Sphk * to reading directory contents. 41282518Sgallatin */ 41382518Sgallatin 41482518Sgallatinint 41583366Sjulianlinux_getcwd(struct thread *td, struct linux_getcwd_args *args) 41682518Sgallatin{ 417276654Sdchagin char *bp, *bend, *path; 418112430Sphk int error, len, lenused; 419112430Sphk 420112430Sphk#ifdef DEBUG 421164379Skib if (ldebug(getcwd)) 422164383Skib printf(ARGS(getcwd, "%p, %ld"), args->buf, (long)args->bufsize); 423112430Sphk#endif 424112430Sphk 425112430Sphk len = args->bufsize; 426112430Sphk 427281829Strasz if (len > LINUX_PATH_MAX) 428281829Strasz len = LINUX_PATH_MAX; 429112430Sphk else if (len < 2) 430112430Sphk return ERANGE; 431112430Sphk 432276654Sdchagin path = malloc(len, M_TEMP, M_WAITOK); 433112430Sphk 434281829Strasz error = kern___getcwd(td, path, UIO_SYSSPACE, len, LINUX_PATH_MAX); 435112430Sphk if (!error) { 436112430Sphk lenused = strlen(path) + 1; 437112430Sphk if (lenused <= args->bufsize) { 438112430Sphk td->td_retval[0] = lenused; 439112430Sphk error = copyout(path, args->buf, lenused); 440112430Sphk } 441112430Sphk else 442112430Sphk error = ERANGE; 443112430Sphk } else { 444112430Sphk bp = &path[len]; 445112430Sphk bend = bp; 446112430Sphk *(--bp) = '\0'; 447112430Sphk 448112430Sphk /* 449112430Sphk * 5th argument here is "max number of vnodes to traverse". 450112430Sphk * Since each entry takes up at least 2 bytes in the output buffer, 451112430Sphk * limit it to N/2 vnodes for an N byte buffer. 452112430Sphk */ 453112430Sphk 454112430Sphk error = linux_getcwd_common (td->td_proc->p_fd->fd_cdir, NULL, 455112430Sphk &bp, path, len/2, GETCWD_CHECK_ACCESS, td); 456112430Sphk if (error) 457112430Sphk goto out; 458112430Sphk lenused = bend - bp; 459112430Sphk td->td_retval[0] = lenused; 460112430Sphk /* put the result into user buffer */ 461112430Sphk error = copyout(bp, args->buf, lenused); 462112430Sphk } 463112430Sphkout: 464112430Sphk free(path, M_TEMP); 465112430Sphk return (error); 46682518Sgallatin} 46782518Sgallatin 468