shim_namei.c 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835
  1. /* Copyright (C) 2017, University of North Carolina at Chapel Hill
  2. and Fortanix, Inc.
  3. This file is part of Graphene Library OS.
  4. Graphene Library OS is free software: you can redistribute it and/or
  5. modify it under the terms of the GNU Lesser General Public License
  6. as published by the Free Software Foundation, either version 3 of the
  7. License, or (at your option) any later version.
  8. Graphene Library OS is distributed in the hope that it will be useful,
  9. but WITHOUT ANY WARRANTY; without even the implied warranty of
  10. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  11. GNU Lesser General Public License for more details.
  12. You should have received a copy of the GNU Lesser General Public License
  13. along with this program. If not, see <http://www.gnu.org/licenses/>. */
  14. /*
  15. * shim_namei.c
  16. *
  17. * This file contains codes for parsing a FS path and looking up in the
  18. * directory cache.
  19. */
  20. #include <stdbool.h>
  21. #include <shim_internal.h>
  22. #include <shim_utils.h>
  23. #include <shim_thread.h>
  24. #include <shim_handle.h>
  25. #include <shim_fs.h>
  26. #include <shim_profile.h>
  27. #include <pal.h>
  28. #include <linux/stat.h>
  29. #include <linux/fcntl.h>
  30. #include <asm/fcntl.h>
  31. /* Advances a char pointer (string) past any repeated slashes and returns the result.
  32. * Must be a null-terminated string. */
  33. static inline const char * eat_slashes (const char * string)
  34. {
  35. while (*string == '/' && *string != '\0') string++;
  36. return string;
  37. }
  38. static inline int __lookup_flags (int flags)
  39. {
  40. int retval = LOOKUP_FOLLOW;
  41. if (flags & O_NOFOLLOW)
  42. retval &= ~LOOKUP_FOLLOW;
  43. if ((flags & (O_CREAT|O_EXCL)) == (O_CREAT|O_EXCL))
  44. retval &= ~LOOKUP_FOLLOW;
  45. if (flags & O_DIRECTORY)
  46. retval |= LOOKUP_DIRECTORY;
  47. return retval;
  48. }
  49. /* check permission (specified by mask) of a dentry. If force is not set,
  50. * permission is considered granted on invalid dentries
  51. *
  52. * mask is the same as mode in the manual for access(2): F_OK, R_OK, W_OK,
  53. * X_OK
  54. *
  55. * Returns 0 on success, negative on failure.
  56. */
  57. /* Assume caller has acquired dcache_lock */
  58. int permission (struct shim_dentry * dent, mode_t mask) {
  59. mode_t mode = 0;
  60. /* Pseudo dentries don't really have permssions. I wonder if
  61. * we could tighten up the range of allowed calls.
  62. */
  63. if (dent->state & DENTRY_ANCESTOR)
  64. return 0;
  65. if (dent->state & DENTRY_NEGATIVE)
  66. return -ENOENT;
  67. /* At this point, we can just return zero if we are only
  68. * checking F_OK (the dentry isn't negative). */
  69. if (mask == F_OK)
  70. return 0;
  71. /* A dentry may not have the mode stored. The original code
  72. * used both NO_MODE and !DENTRY_VALID; let's try to consolidate to
  73. * just NO_MODE.
  74. */
  75. if (dent->mode == NO_MODE) {
  76. /* DEP 6/16/17: I don't think we should be defaulting to 0 if
  77. * there isn't a mode function. */
  78. assert(dent->fs);
  79. assert(dent->fs->d_ops);
  80. assert(dent->fs->d_ops->mode);
  81. /* Fall back to the low-level file system */
  82. int err = dent->fs->d_ops->mode(dent, &mode);
  83. /*
  84. * DEP 6/16/17: I think the low-level file system should be
  85. * setting modes, rather than defaulting to open here.
  86. * I'm ok with a file system that doesn't care setting the
  87. * permission to all.
  88. *
  89. * Set an assertion here to catch these cases in debugging.
  90. */
  91. assert(err != -ESKIPPED);
  92. if (err < 0)
  93. return err;
  94. dent->mode = mode;
  95. }
  96. mode = dent->mode;
  97. if (((mode >> 6) & mask) == mask)
  98. return 0;
  99. return -EACCES;
  100. }
  101. /*
  102. * This function looks up a single dentry based on its parent dentry pointer
  103. * and the name. Namelen is the length of char * name.
  104. * The dentry is returned in pointer *new. The refcount of new is incremented
  105. * by one.
  106. *
  107. * Parent can be null when mounting the root file system. In this case, the
  108. * function creates a new, negative dentry, which will then be initialized by
  109. * the mount code and made non-negative.
  110. *
  111. * The fs argument specifies the file system type to use on a miss; typically,
  112. * this will be parent->fs.
  113. *
  114. * This function checks the dcache first, and then, on a miss, falls back
  115. * to the low-level file system.
  116. *
  117. * XXX: The original code returned whether the process can exec the task?
  118. * Not clear this is needed; try not doing this.
  119. *
  120. * Returns zero if the file is found; -ENOENT if it doesn't exist,
  121. * possibly other errors.
  122. *
  123. * The caller should hold the dcache_lock.
  124. */
  125. int lookup_dentry (struct shim_dentry * parent, const char * name, int namelen, struct shim_dentry ** new, struct shim_mount * fs)
  126. {
  127. struct shim_dentry * dent = NULL;
  128. int do_fs_lookup = 0;
  129. int err = 0;
  130. /* Look up the name in the dcache first, one atom at a time. */
  131. dent = __lookup_dcache(parent, name, namelen, NULL);
  132. if (!dent) {
  133. if (parent) {
  134. /* Newly created dentry's relative path will be a concatenation of parent
  135. * + name strings (see get_new_dentry), make sure it fits into qstr */
  136. if (parent->rel_path.len + 1 + namelen >= STR_SIZE) { /* +1 for '/' */
  137. debug("Relative path exceeds the limit %d\n", STR_SIZE);
  138. return -ENAMETOOLONG;
  139. }
  140. }
  141. dent = get_new_dentry(fs, parent, name, namelen, NULL);
  142. if (!dent)
  143. return -ENOMEM;
  144. do_fs_lookup = 1;
  145. // In the case we make a new dentry, go ahead and increment the
  146. // ref count; in other cases, __lookup_dcache does this
  147. get_dentry(dent);
  148. } else {
  149. if (!(dent->state & DENTRY_VALID))
  150. do_fs_lookup = 1;
  151. }
  152. if (do_fs_lookup) {
  153. // This doesn't make any sense if there isn't a low-level
  154. // lookup function.
  155. assert (dent->fs);
  156. assert (dent->fs->d_ops);
  157. assert (dent->fs->d_ops->lookup);
  158. err = dent->fs->d_ops->lookup(dent);
  159. /* XXX: On an error, it seems like we should probably destroy
  160. * the dentry, rather than keep some malformed dentry lying around.
  161. * Not done in original code, so leaving for now.
  162. */
  163. if (err) {
  164. if (err == -ENOENT) {
  165. // Let ENOENT fall through so we can get negative dentries in
  166. // the cache
  167. dent->state |= DENTRY_NEGATIVE;
  168. } else {
  169. /* Trying to weed out ESKIPPED */
  170. assert(err != -ESKIPPED);
  171. return err;
  172. }
  173. }
  174. dent->state |= DENTRY_VALID;
  175. }
  176. /* I think we can assume we have a valid dent at this point */
  177. assert(dent);
  178. assert(dent->state & DENTRY_VALID);
  179. // Set the err is ENOENT if negative
  180. if (dent->state & DENTRY_NEGATIVE)
  181. err = -ENOENT;
  182. if (new)
  183. *new = dent;
  184. return err;
  185. }
  186. /*
  187. * Looks up path under start dentry. Saves in dent (if specified; dent may be
  188. * NULL). Start is a hint, and may be null; in this case, we use the first
  189. * char of the path to infer whether the path is relative or absolute.
  190. *
  191. * Primarily to support bootstrapping, this function takes a fs parameter,
  192. * that specifies a mount point. Typically, this would be start->fs, but there
  193. * are cases where start may be absent (e.g., in bootstrapping). Fs can be
  194. * null only if the current thread is defined.
  195. *
  196. * Assumes dcache_lock is held; main difference from path_lookupat is that
  197. * dcache_lock is acquired/released.
  198. *
  199. * We assume the caller has incremented the reference count on start and its
  200. * associated file system mount by one
  201. *
  202. * The refcount is raised by one on the returned dentry and associated mount.
  203. *
  204. * The make_ancestor flag creates pseudo-dentries for any parent paths that
  205. * are not in cache and do not exist on the underlying file system. This is
  206. * intended for use only in setting up the file system view specified in the
  207. * manifest.
  208. *
  209. * If the file isn't found, returns -ENOENT.
  210. *
  211. * If the LOOKUP_DIRECTORY flag is set, and the found file isn't a directory,
  212. * returns -ENOTDIR.
  213. */
  214. int __path_lookupat (struct shim_dentry * start, const char * path, int flags,
  215. struct shim_dentry ** dent, int link_depth,
  216. struct shim_mount * fs, bool make_ancestor)
  217. {
  218. // Basic idea: recursively iterate over path, peeling off one atom at a
  219. // time.
  220. /* Chia-Che 12/5/2014:
  221. * XXX I am not a big fan of recursion. I am giving a pass to this code
  222. * for now, but eventually someone (probably me) should rewrite it. */
  223. const char * my_path;
  224. int my_pathlen = 0;
  225. int err = 0;
  226. struct shim_dentry *my_dent = NULL;
  227. struct shim_qstr this = QSTR_INIT;
  228. bool leaf_case = false; // Leaf call in case of recursion
  229. bool no_start = false; // start not passed
  230. bool no_fs = false; // fs not passed
  231. struct shim_thread * cur_thread = get_cur_thread();
  232. if (!start) {
  233. if (cur_thread) {
  234. start = *path == '/' ? cur_thread->root : cur_thread->cwd;
  235. } else {
  236. /* Start at the global root if we have no fs and no start dentry.
  237. * This shoud only happen as part of initialization.
  238. */
  239. start = dentry_root;
  240. assert(start);
  241. }
  242. no_start = true;
  243. // refcount should only be incremented if the caller didn't do it
  244. get_dentry(start);
  245. }
  246. assert(start);
  247. if (!fs) {
  248. no_fs = true;
  249. fs = start->fs;
  250. // refcount should only be incremented if the caller didn't do it
  251. get_mount(fs);
  252. }
  253. assert(fs);
  254. assert(start->state & DENTRY_ISDIRECTORY);
  255. // Peel off any preceeding slashes
  256. path = eat_slashes(path);
  257. // Check that we didn't hit the leaf case
  258. if (*path == '\0') {
  259. // We'll return start since this is the last path element
  260. my_dent = start;
  261. // Increment refcount of the found entry
  262. get_dentry(my_dent);
  263. leaf_case = true;
  264. } else {
  265. my_path = path;
  266. // Find the length of the path
  267. while (*my_path != '/' && *my_path != '\0') {
  268. my_path++;
  269. my_pathlen++;
  270. }
  271. if (my_pathlen > MAX_FILENAME) {
  272. err = -ENAMETOOLONG;
  273. goto out;
  274. }
  275. /* Handle . */
  276. if (my_pathlen == 1 && *path == '.') {
  277. /* For the recursion to work, we need to do the following:
  278. * Bump the ref count, set my_dent to start
  279. */
  280. my_dent = start;
  281. get_dentry(my_dent);
  282. } else if (my_pathlen == 2 && path[0] == '.' && path[1] == '.') {
  283. if (start->parent) {
  284. my_dent = start->parent;
  285. } else {
  286. // Root
  287. my_dent = start;
  288. }
  289. get_dentry(my_dent);
  290. } else {
  291. // Once we have an atom, look it up and update start
  292. err = lookup_dentry(start, path, my_pathlen, &my_dent, fs);
  293. // my_dent's refcount is incremented after this, consistent with cases above
  294. // Allow a negative dentry to move forward
  295. if (err < 0 && err != -ENOENT)
  296. goto out;
  297. // Drop any trailing slashes from the path
  298. my_path = eat_slashes(my_path);
  299. // If the LOOKUP_FOLLOW flag is set, check if we hit a symlink
  300. if ((flags & LOOKUP_FOLLOW) && (my_dent->state & DENTRY_ISLINK)) {
  301. // Keep from following too many links
  302. if (link_depth > 80) {
  303. err = -ELOOP;
  304. goto out;
  305. }
  306. link_depth++;
  307. assert(my_dent->fs->d_ops && my_dent->fs->d_ops->follow_link);
  308. if ((err = my_dent->fs->d_ops->follow_link(my_dent, &this)) < 0)
  309. goto out;
  310. path = qstrgetstr(&this);
  311. if (path) {
  312. /* symlink name starts with a slash, restart lookup at root */
  313. if (*path == '/') {
  314. struct shim_dentry * root;
  315. // not sure how to deal with this case if cur_thread isn't defined
  316. assert(cur_thread);
  317. root = cur_thread->root;
  318. /*XXX: Check out path_reacquire here? */
  319. // my_dent's refcount was incremented by lookup_dentry above,
  320. // we need to not leak it here
  321. put_dentry(my_dent);
  322. my_dent = root;
  323. get_dentry(my_dent);
  324. } else {
  325. // Relative path, stay in this dir
  326. put_dentry(my_dent);
  327. my_dent = start;
  328. get_dentry(my_dent);
  329. }
  330. }
  331. }
  332. }
  333. // Drop any trailing slashes from the path
  334. my_path = eat_slashes(my_path);
  335. // If we found something, and there is more, recur
  336. if (*my_path != '\0') {
  337. /* If we have more to look up, but got a negative DENTRY,
  338. * we need to fail or (unlikely) create an ancestor dentry.*/
  339. if (my_dent->state & DENTRY_NEGATIVE) {
  340. if (make_ancestor) {
  341. my_dent->state |= DENTRY_ANCESTOR;
  342. my_dent->state |= DENTRY_ISDIRECTORY;
  343. my_dent->state &= ~DENTRY_NEGATIVE;
  344. } else {
  345. err = -ENOENT;
  346. goto out;
  347. }
  348. }
  349. /* Although this is slight over-kill, let's just always increment the
  350. * mount ref count on a recursion, for easier bookkeeping */
  351. get_mount(my_dent->fs);
  352. err = __path_lookupat (my_dent, my_path, flags, dent, link_depth,
  353. my_dent->fs, make_ancestor);
  354. if (err < 0)
  355. goto out;
  356. /* If we aren't returning a live reference to the target dentry, go
  357. * ahead and release the ref count when we unwind the recursion.
  358. */
  359. put_mount(my_dent->fs);
  360. put_dentry(my_dent);
  361. } else {
  362. /* If make_ancestor is set, we also need to handle the case here */
  363. if (make_ancestor && (my_dent->state & DENTRY_NEGATIVE)) {
  364. my_dent->state |= DENTRY_ANCESTOR;
  365. my_dent->state |= DENTRY_ISDIRECTORY;
  366. my_dent->state &= ~DENTRY_NEGATIVE;
  367. if (err == -ENOENT)
  368. err = 0;
  369. }
  370. leaf_case = true;
  371. }
  372. }
  373. /* Base case. Set dent and return. */
  374. if (leaf_case) {
  375. if (dent)
  376. *dent = my_dent;
  377. // Enforce LOOKUP_CREATE flag at a higher level
  378. if (my_dent->state & DENTRY_NEGATIVE)
  379. err = -ENOENT;
  380. // Enforce the LOOKUP_DIRECTORY flag
  381. if ((flags & LOOKUP_DIRECTORY) & !(my_dent->state & DENTRY_ISDIRECTORY))
  382. err = -ENOTDIR;
  383. }
  384. out:
  385. /* If we didn't have a start dentry, decrement the ref count here */
  386. if (no_start)
  387. put_dentry(start);
  388. if (no_fs)
  389. put_mount(fs);
  390. qstrfree(&this);
  391. return err;
  392. }
  393. /* Just wraps __path_lookupat, but also acquires and releases the dcache_lock.
  394. */
  395. int path_lookupat (struct shim_dentry * start, const char * name, int flags,
  396. struct shim_dentry ** dent, struct shim_mount * fs)
  397. {
  398. int ret = 0;
  399. lock(&dcache_lock);
  400. ret = __path_lookupat (start, name, flags, dent, 0, fs, 0);
  401. unlock(&dcache_lock);
  402. return ret;
  403. }
  404. /* Open path with given flags, in mode, similar to Unix open.
  405. *
  406. * The start dentry specifies where to begin the search, and can be null. If
  407. * specified, we assume the caller has incremented the ref count on the start,
  408. * but not the associated mount (probably using path_startat)
  409. *
  410. * hdl is an optional argument; if passed in, it is initialized to
  411. * refer to the opened path.
  412. *
  413. * We assume the caller has not increased
  414. *
  415. * The result is stored in dent.
  416. */
  417. int open_namei (struct shim_handle * hdl, struct shim_dentry * start,
  418. const char * path, int flags, int mode,
  419. struct shim_dentry ** dent)
  420. {
  421. int lookup_flags = __lookup_flags(flags);
  422. mode_t acc_mode = ACC_MODE(flags & O_ACCMODE);
  423. int err = 0, newly_created = 0;
  424. struct shim_dentry *mydent = NULL;
  425. lock(&dcache_lock);
  426. // lookup the path from start, passing flags
  427. err = __path_lookupat(start, path, lookup_flags, &mydent, 0, NULL, 0);
  428. // Deal with O_CREAT, O_EXCL, but only if we actually got a valid prefix
  429. // of directories.
  430. if (mydent && err == -ENOENT && (flags & O_CREAT)) {
  431. // Create the file
  432. struct shim_dentry * dir = mydent->parent;
  433. if (!dir) {
  434. err = -ENOENT;
  435. goto out;
  436. }
  437. // Check the parent permission first
  438. err = permission(dir, MAY_WRITE | MAY_EXEC);
  439. if (err) goto out;
  440. // Try EINVAL when creat isn't an option
  441. if (!dir->fs->d_ops || !dir->fs->d_ops->creat) {
  442. err = -EINVAL;
  443. goto out;
  444. }
  445. // Differentiate directory and file creation;
  446. // Seems like overloading functionality that could probably be more
  447. // cleanly pushed into shim_do_mkdir
  448. if (flags & O_DIRECTORY) {
  449. err = dir->fs->d_ops->mkdir(dir, mydent, mode);
  450. } else {
  451. err = dir->fs->d_ops->creat(hdl, dir, mydent, flags, mode);
  452. }
  453. if (err)
  454. goto out;
  455. newly_created = 1;
  456. // If we didn't get an error and made a directory, set the dcache dir flag
  457. if (flags & O_DIRECTORY) {
  458. mydent->state |= DENTRY_ISDIRECTORY;
  459. mydent->type = S_IFDIR;
  460. }
  461. // Once the dentry is creat-ed, drop the negative flag
  462. mydent->state &= ~DENTRY_NEGATIVE;
  463. // Set err back to zero and fall through
  464. err = 0;
  465. } else if (err == 0 && (flags & (O_CREAT|O_EXCL))) {
  466. err = -EEXIST;
  467. } else if (err < 0)
  468. goto out;
  469. // Check permission, but only if we didn't create the file.
  470. // creat/O_CREAT have idiosyncratic semantics about opening a
  471. // newly-created, read-only file for writing, but only the first time.
  472. if (!newly_created) {
  473. if ((err = permission(mydent, acc_mode)) < 0)
  474. goto out;
  475. }
  476. // Set up the file handle, if provided
  477. if (hdl)
  478. err = dentry_open(hdl, mydent, flags);
  479. out:
  480. if (dent && !err)
  481. *dent = mydent;
  482. unlock(&dcache_lock);
  483. return err;
  484. }
  485. /* This function calls the low-level file system to do the work
  486. * of opening file indicated by dent, and initializing it in hdl.
  487. * Flags are standard open flags.
  488. *
  489. * If O_TRUNC is specified, this function is responsible for calling
  490. * the underlying truncate function.
  491. */
  492. int dentry_open (struct shim_handle * hdl, struct shim_dentry * dent,
  493. int flags)
  494. {
  495. int ret = 0;
  496. size_t size;
  497. char *path;
  498. struct shim_mount * fs = dent->fs;
  499. /* I think missing functionality shoudl be treated as EINVAL, or maybe
  500. * ENOSYS?*/
  501. if (!fs->d_ops || !fs->d_ops->open) {
  502. ret = -EINVAL;
  503. goto out;
  504. }
  505. if ((ret = fs->d_ops->open(hdl, dent, flags)) < 0)
  506. goto out;
  507. set_handle_fs(hdl, fs);
  508. get_dentry(dent);
  509. hdl->dentry = dent;
  510. hdl->flags = flags;
  511. // Set the type of the handle if we have a directory. The original code
  512. // had a special case for this.
  513. // XXX: Having a type on the handle seems a little redundant if we have a
  514. // dentry too.
  515. if (dent->state & DENTRY_ISDIRECTORY) {
  516. hdl->type = TYPE_DIR;
  517. memcpy(hdl->fs_type, fs->type, sizeof(fs->type));
  518. // Set dot and dot dot for some reason
  519. get_dentry(dent);
  520. hdl->info.dir.dot = dent;
  521. if (dent->parent) {
  522. get_dentry(dent->parent);
  523. hdl->info.dir.dotdot = dent->parent;
  524. } else
  525. hdl->info.dir.dotdot = NULL;
  526. // Let's defer setting the DENTRY_LISTED flag until we need it
  527. // Use -1 to indicate that the buf/ptr isn't initialized
  528. hdl->info.dir.buf = (void *)-1;
  529. hdl->info.dir.ptr = (void *)-1;
  530. }
  531. path = dentry_get_path(dent, true, &size);
  532. if (!path) {
  533. ret = -ENOMEM;
  534. goto out;
  535. }
  536. qstrsetstr(&hdl->path, path, size);
  537. /* truncate the file if O_TRUNC is given */
  538. if (flags & O_TRUNC) {
  539. if (!fs->fs_ops->truncate) {
  540. ret = -EINVAL;
  541. goto out;
  542. }
  543. ret = fs->fs_ops->truncate(hdl, 0);
  544. }
  545. out:
  546. return ret;
  547. }
  548. static inline void set_dirent_type (mode_t * type, int d_type)
  549. {
  550. switch (d_type) {
  551. case LINUX_DT_DIR:
  552. *type = S_IFDIR;
  553. return;
  554. case LINUX_DT_FIFO:
  555. *type = S_IFIFO;
  556. return;
  557. case LINUX_DT_CHR:
  558. *type = S_IFCHR;
  559. return;
  560. case LINUX_DT_BLK:
  561. *type = S_IFBLK;
  562. return;
  563. case LINUX_DT_REG:
  564. *type = S_IFREG;
  565. return;
  566. case LINUX_DT_LNK:
  567. *type = S_IFLNK;
  568. return;
  569. case LINUX_DT_SOCK:
  570. *type = S_IFSOCK;
  571. return;
  572. default:
  573. *type = 0;
  574. return;
  575. }
  576. }
  577. /* This function enumerates a directory and caches the results in the cache.
  578. *
  579. * Input: A dentry for a directory in the DENTRY_ISDIRECTORY and not in the
  580. * DENTRY_LISTED state. The dentry DENTRY_LISTED flag is set upon success.
  581. *
  582. * Return value: 0 on success, <0 on error
  583. *
  584. * DEP 7/9/17: This work was once done as part of open, but, since getdents*
  585. * have no consistency semantics, we can apply the principle of laziness and
  586. * not do the work until we are sure we really need to.
  587. */
  588. int list_directory_dentry (struct shim_dentry *dent) {
  589. int ret = 0;
  590. struct shim_mount * fs = dent->fs;
  591. lock(&dcache_lock);
  592. /* DEP 8/4/17: Another process could list this directory
  593. * while we are waiting on the dcache lock. This is ok,
  594. * no need to blow an assert.
  595. */
  596. if (dent->state & DENTRY_LISTED){
  597. unlock(&dcache_lock);
  598. return 0;
  599. }
  600. // DEP 7/9/17: In yet another strange turn of events in POSIX-land,
  601. // you can do a readdir on a rmdir-ed directory handle. What you
  602. // expect to learn is beyond me, but be careful with blowing assert
  603. // and tell the program something to keep it moving.
  604. if (dent->state & DENTRY_NEGATIVE) {
  605. unlock(&dcache_lock);
  606. return 0;
  607. }
  608. assert (dent->state & DENTRY_ISDIRECTORY);
  609. struct shim_dirent * dirent = NULL;
  610. if ((ret = fs->d_ops->readdir(dent, &dirent)) < 0 || !dirent) {
  611. dirent = NULL;
  612. goto done_read;
  613. }
  614. struct shim_dirent * d = dirent;
  615. for ( ; d ; d = d->next) {
  616. struct shim_dentry * child;
  617. if ((ret = lookup_dentry(dent, d->name, strlen(d->name),
  618. &child, fs)) < 0)
  619. goto done_read;
  620. if (child->state & DENTRY_NEGATIVE)
  621. continue;
  622. if (!(child->state & DENTRY_VALID)) {
  623. set_dirent_type(&child->type, d->type);
  624. child->state |= DENTRY_VALID|DENTRY_RECENTLY;
  625. }
  626. child->ino = d->ino;
  627. }
  628. dent->state |= DENTRY_LISTED;
  629. done_read:
  630. unlock(&dcache_lock);
  631. free(dirent);
  632. return ret;
  633. }
  634. /* This function caches the contents of a directory (dent), already
  635. * in the listed state, in a buffer associated with a handle (hdl).
  636. *
  637. * This function should only be called once on a handle.
  638. *
  639. * Returns 0 on success, <0 on failure.
  640. */
  641. int list_directory_handle (struct shim_dentry * dent, struct shim_handle * hdl)
  642. {
  643. struct shim_dentry ** children = NULL;
  644. int nchildren = dent->nchildren, count = 0;
  645. struct shim_dentry * child;
  646. assert(hdl->info.dir.buf == (void *)-1);
  647. assert(hdl->info.dir.ptr == (void *)-1);
  648. // Handle the case where the handle is on a rmdir-ed directory
  649. // Handle is already locked by caller, so these values shouldn't change
  650. // after dcache lock is acquired
  651. if (dent->state & DENTRY_NEGATIVE) {
  652. hdl->info.dir.buf = NULL;
  653. hdl->info.dir.ptr = NULL;
  654. return 0;
  655. }
  656. children = malloc(sizeof(struct shim_dentry *) * (nchildren + 1));
  657. if (!children)
  658. return -ENOMEM;
  659. lock(&dcache_lock);
  660. LISTP_FOR_EACH_ENTRY(child, &dent->children, siblings) {
  661. if (count >= nchildren)
  662. break;
  663. struct shim_dentry * c = child;
  664. while (c->state & DENTRY_MOUNTPOINT)
  665. c = c->mounted->root;
  666. if (c->state & DENTRY_VALID) {
  667. get_dentry(c);
  668. children[count++] = c;
  669. }
  670. }
  671. children[count] = NULL;
  672. hdl->info.dir.buf = children;
  673. hdl->info.dir.ptr = children;
  674. unlock(&dcache_lock);
  675. return 0;
  676. }
  677. /* This function initializes dir to before a search, to either point
  678. * to the current working directory (if dfd == AT_FDCWD), or to the handle
  679. * pointed to by dfd, depending on the argument.
  680. *
  681. * Increments dentry ref count by one.
  682. *
  683. * Returns -EBADF if dfd is <0 or not a valid handle.
  684. * Returns -ENOTDIR if dfd is not a directory.
  685. */
  686. int path_startat (int dfd, struct shim_dentry ** dir)
  687. {
  688. if (dfd == AT_FDCWD) {
  689. struct shim_thread * cur = get_cur_thread();
  690. get_dentry(cur->cwd);
  691. *dir = cur->cwd;
  692. return 0;
  693. } else if (dfd < 0) {
  694. return -EBADF;
  695. } else {
  696. struct shim_handle * hdl = get_fd_handle(dfd, NULL, NULL);
  697. if (!hdl)
  698. return -EBADF;
  699. if (hdl->type != TYPE_DIR) {
  700. put_handle(hdl);
  701. return -ENOTDIR;
  702. }
  703. get_dentry(hdl->dentry);
  704. put_handle(hdl);
  705. *dir = hdl->dentry;
  706. return 0;
  707. }
  708. }