Subversion Repositories HelenOS

Rev

Rev 4357 | Rev 4359 | Go to most recent revision | Blame | Compare with Previous | Last modification | View Log | Download | RSS feed

  1. /*
  2.  * Copyright (c) 2008 Jakub Jermar
  3.  * All rights reserved.
  4.  *
  5.  * Redistribution and use in source and binary forms, with or without
  6.  * modification, are permitted provided that the following conditions
  7.  * are met:
  8.  *
  9.  * - Redistributions of source code must retain the above copyright
  10.  *   notice, this list of conditions and the following disclaimer.
  11.  * - Redistributions in binary form must reproduce the above copyright
  12.  *   notice, this list of conditions and the following disclaimer in the
  13.  *   documentation and/or other materials provided with the distribution.
  14.  * - The name of the author may not be used to endorse or promote products
  15.  *   derived from this software without specific prior written permission.
  16.  *
  17.  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  18.  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  19.  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  20.  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  21.  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  22.  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23.  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24.  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25.  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26.  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27.  */
  28.  
  29. /** @addtogroup fs
  30.  * @{
  31.  */
  32.  
  33. /**
  34.  * @file    fat_ops.c
  35.  * @brief   Implementation of VFS operations for the FAT file system server.
  36.  */
  37.  
  38. #include "fat.h"
  39. #include "fat_dentry.h"
  40. #include "fat_fat.h"
  41. #include "../../vfs/vfs.h"
  42. #include <libfs.h>
  43. #include <libblock.h>
  44. #include <ipc/ipc.h>
  45. #include <ipc/services.h>
  46. #include <ipc/devmap.h>
  47. #include <async.h>
  48. #include <errno.h>
  49. #include <string.h>
  50. #include <byteorder.h>
  51. #include <libadt/hash_table.h>
  52. #include <libadt/list.h>
  53. #include <assert.h>
  54. #include <futex.h>
  55. #include <sys/mman.h>
  56. #include <align.h>
  57.  
  58. #define FAT_NODE(node)  ((node) ? (fat_node_t *) (node)->data : NULL)
  59. #define FS_NODE(node)   ((node) ? (node)->bp : NULL)
  60.  
  61. /** Futex protecting the list of cached free FAT nodes. */
  62. static futex_t ffn_futex = FUTEX_INITIALIZER;
  63.  
  64. /** List of cached free FAT nodes. */
  65. static LIST_INITIALIZE(ffn_head);
  66.  
  67. static void fat_node_initialize(fat_node_t *node)
  68. {
  69.     futex_initialize(&node->lock, 1);
  70.     node->bp = NULL;
  71.     node->idx = NULL;
  72.     node->type = 0;
  73.     link_initialize(&node->ffn_link);
  74.     node->size = 0;
  75.     node->lnkcnt = 0;
  76.     node->refcnt = 0;
  77.     node->dirty = false;
  78. }
  79.  
  80. static void fat_node_sync(fat_node_t *node)
  81. {
  82.     block_t *b;
  83.     fat_bs_t *bs;
  84.     fat_dentry_t *d;
  85.     uint16_t bps;
  86.     unsigned dps;
  87.    
  88.     assert(node->dirty);
  89.  
  90.     bs = block_bb_get(node->idx->dev_handle);
  91.     bps = uint16_t_le2host(bs->bps);
  92.     dps = bps / sizeof(fat_dentry_t);
  93.    
  94.     /* Read the block that contains the dentry of interest. */
  95.     b = _fat_block_get(bs, node->idx->dev_handle, node->idx->pfc,
  96.         (node->idx->pdi * sizeof(fat_dentry_t)) / bps, BLOCK_FLAGS_NONE);
  97.  
  98.     d = ((fat_dentry_t *)b->data) + (node->idx->pdi % dps);
  99.  
  100.     d->firstc = host2uint16_t_le(node->firstc);
  101.     if (node->type == FAT_FILE) {
  102.         d->size = host2uint32_t_le(node->size);
  103.     } else if (node->type == FAT_DIRECTORY) {
  104.         d->attr = FAT_ATTR_SUBDIR;
  105.     }
  106.    
  107.     /* TODO: update other fields? (e.g time fields) */
  108.    
  109.     b->dirty = true;        /* need to sync block */
  110.     block_put(b);
  111. }
  112.  
  113. static fat_node_t *fat_node_get_new(void)
  114. {
  115.     fs_node_t *fn;
  116.     fat_node_t *nodep;
  117.  
  118.     futex_down(&ffn_futex);
  119.     if (!list_empty(&ffn_head)) {
  120.         /* Try to use a cached free node structure. */
  121.         fat_idx_t *idxp_tmp;
  122.         nodep = list_get_instance(ffn_head.next, fat_node_t, ffn_link);
  123.         if (futex_trydown(&nodep->lock) == ESYNCH_WOULD_BLOCK)
  124.             goto skip_cache;
  125.         idxp_tmp = nodep->idx;
  126.         if (futex_trydown(&idxp_tmp->lock) == ESYNCH_WOULD_BLOCK) {
  127.             futex_up(&nodep->lock);
  128.             goto skip_cache;
  129.         }
  130.         list_remove(&nodep->ffn_link);
  131.         futex_up(&ffn_futex);
  132.         if (nodep->dirty)
  133.             fat_node_sync(nodep);
  134.         idxp_tmp->nodep = NULL;
  135.         futex_up(&nodep->lock);
  136.         futex_up(&idxp_tmp->lock);
  137.         fn = FS_NODE(nodep);
  138.     } else {
  139. skip_cache:
  140.         /* Try to allocate a new node structure. */
  141.         futex_up(&ffn_futex);
  142.         fn = (fs_node_t *)malloc(sizeof(fs_node_t));
  143.         if (!fn)
  144.             return NULL;
  145.         nodep = (fat_node_t *)malloc(sizeof(fat_node_t));
  146.         if (!nodep) {
  147.             free(fn);
  148.             return NULL;
  149.         }
  150.     }
  151.     fat_node_initialize(nodep);
  152.     fn->data = nodep;
  153.     nodep->bp = fn;
  154.    
  155.     return nodep;
  156. }
  157.  
  158. /** Internal version of fat_node_get().
  159.  *
  160.  * @param idxp      Locked index structure.
  161.  */
  162. static fat_node_t *fat_node_get_core(fat_idx_t *idxp)
  163. {
  164.     block_t *b;
  165.     fat_bs_t *bs;
  166.     fat_dentry_t *d;
  167.     fat_node_t *nodep = NULL;
  168.     unsigned bps;
  169.     unsigned spc;
  170.     unsigned dps;
  171.  
  172.     if (idxp->nodep) {
  173.         /*
  174.          * We are lucky.
  175.          * The node is already instantiated in memory.
  176.          */
  177.         futex_down(&idxp->nodep->lock);
  178.         if (!idxp->nodep->refcnt++)
  179.             list_remove(&idxp->nodep->ffn_link);
  180.         futex_up(&idxp->nodep->lock);
  181.         return idxp->nodep;
  182.     }
  183.  
  184.     /*
  185.      * We must instantiate the node from the file system.
  186.      */
  187.    
  188.     assert(idxp->pfc);
  189.  
  190.     nodep = fat_node_get_new();
  191.     if (!nodep)
  192.         return NULL;
  193.  
  194.     bs = block_bb_get(idxp->dev_handle);
  195.     bps = uint16_t_le2host(bs->bps);
  196.     spc = bs->spc;
  197.     dps = bps / sizeof(fat_dentry_t);
  198.  
  199.     /* Read the block that contains the dentry of interest. */
  200.     b = _fat_block_get(bs, idxp->dev_handle, idxp->pfc,
  201.         (idxp->pdi * sizeof(fat_dentry_t)) / bps, BLOCK_FLAGS_NONE);
  202.     assert(b);
  203.  
  204.     d = ((fat_dentry_t *)b->data) + (idxp->pdi % dps);
  205.     if (d->attr & FAT_ATTR_SUBDIR) {
  206.         /*
  207.          * The only directory which does not have this bit set is the
  208.          * root directory itself. The root directory node is handled
  209.          * and initialized elsewhere.
  210.          */
  211.         nodep->type = FAT_DIRECTORY;
  212.         /*
  213.          * Unfortunately, the 'size' field of the FAT dentry is not
  214.          * defined for the directory entry type. We must determine the
  215.          * size of the directory by walking the FAT.
  216.          */
  217.         nodep->size = bps * spc * fat_clusters_get(bs, idxp->dev_handle,
  218.             uint16_t_le2host(d->firstc));
  219.     } else {
  220.         nodep->type = FAT_FILE;
  221.         nodep->size = uint32_t_le2host(d->size);
  222.     }
  223.     nodep->firstc = uint16_t_le2host(d->firstc);
  224.     nodep->lnkcnt = 1;
  225.     nodep->refcnt = 1;
  226.  
  227.     block_put(b);
  228.  
  229.     /* Link the idx structure with the node structure. */
  230.     nodep->idx = idxp;
  231.     idxp->nodep = nodep;
  232.  
  233.     return nodep;
  234. }
  235.  
  236. /*
  237.  * Forward declarations of FAT libfs operations.
  238.  */
  239. static fs_node_t *fat_node_get(dev_handle_t, fs_index_t);
  240. static void fat_node_put(fs_node_t *);
  241. static fs_node_t *fat_create_node(dev_handle_t, int);
  242. static int fat_destroy_node(fs_node_t *);
  243. static int fat_link(fs_node_t *, fs_node_t *, const char *);
  244. static int fat_unlink(fs_node_t *, fs_node_t *);
  245. static fs_node_t *fat_match(fs_node_t *, const char *);
  246. static fs_index_t fat_index_get(fs_node_t *);
  247. static size_t fat_size_get(fs_node_t *);
  248. static unsigned fat_lnkcnt_get(fs_node_t *);
  249. static bool fat_has_children(fs_node_t *);
  250. static fs_node_t *fat_root_get(dev_handle_t);
  251. static char fat_plb_get_char(unsigned);
  252. static bool fat_is_directory(fs_node_t *);
  253. static bool fat_is_file(fs_node_t *node);
  254.  
  255. /*
  256.  * FAT libfs operations.
  257.  */
  258.  
  259. /** Instantiate a FAT in-core node. */
  260. fs_node_t *fat_node_get(dev_handle_t dev_handle, fs_index_t index)
  261. {
  262.     fat_node_t *nodep;
  263.     fat_idx_t *idxp;
  264.  
  265.     idxp = fat_idx_get_by_index(dev_handle, index);
  266.     if (!idxp)
  267.         return NULL;
  268.     /* idxp->lock held */
  269.     nodep = fat_node_get_core(idxp);
  270.     futex_up(&idxp->lock);
  271.     return FS_NODE(nodep);
  272. }
  273.  
  274. void fat_node_put(fs_node_t *fn)
  275. {
  276.     fat_node_t *nodep = FAT_NODE(fn);
  277.     bool destroy = false;
  278.  
  279.     futex_down(&nodep->lock);
  280.     if (!--nodep->refcnt) {
  281.         if (nodep->idx) {
  282.             futex_down(&ffn_futex);
  283.             list_append(&nodep->ffn_link, &ffn_head);
  284.             futex_up(&ffn_futex);
  285.         } else {
  286.             /*
  287.              * The node does not have any index structure associated
  288.              * with itself. This can only mean that we are releasing
  289.              * the node after a failed attempt to allocate the index
  290.              * structure for it.
  291.              */
  292.             destroy = true;
  293.         }
  294.     }
  295.     futex_up(&nodep->lock);
  296.     if (destroy) {
  297.         free(nodep->bp);
  298.         free(nodep);
  299.     }
  300. }
  301.  
  302. fs_node_t *fat_create_node(dev_handle_t dev_handle, int flags)
  303. {
  304.     fat_idx_t *idxp;
  305.     fat_node_t *nodep;
  306.     fat_bs_t *bs;
  307.     fat_cluster_t mcl, lcl;
  308.     uint16_t bps;
  309.     int rc;
  310.  
  311.     bs = block_bb_get(dev_handle);
  312.     bps = uint16_t_le2host(bs->bps);
  313.     if (flags & L_DIRECTORY) {
  314.         /* allocate a cluster */
  315.         rc = fat_alloc_clusters(bs, dev_handle, 1, &mcl, &lcl);
  316.         if (rc != EOK)
  317.             return NULL;
  318.     }
  319.  
  320.     nodep = fat_node_get_new();
  321.     if (!nodep) {
  322.         fat_free_clusters(bs, dev_handle, mcl);
  323.         return NULL;
  324.     }
  325.     idxp = fat_idx_get_new(dev_handle);
  326.     if (!idxp) {
  327.         fat_free_clusters(bs, dev_handle, mcl);
  328.         fat_node_put(FS_NODE(nodep));
  329.         return NULL;
  330.     }
  331.     /* idxp->lock held */
  332.     if (flags & L_DIRECTORY) {
  333.         int i;
  334.         block_t *b;
  335.  
  336.         /*
  337.          * Populate the new cluster with unused dentries.
  338.          */
  339.         for (i = 0; i < bs->spc; i++) {
  340.             b = _fat_block_get(bs, dev_handle, mcl, i,
  341.                 BLOCK_FLAGS_NOREAD);
  342.             /* mark all dentries as never-used */
  343.             memset(b->data, 0, bps);
  344.             b->dirty = false;
  345.             block_put(b);
  346.         }
  347.         nodep->type = FAT_DIRECTORY;
  348.         nodep->firstc = mcl;
  349.         nodep->size = bps * bs->spc;
  350.     } else {
  351.         nodep->type = FAT_FILE;
  352.         nodep->firstc = FAT_CLST_RES0;
  353.         nodep->size = 0;
  354.     }
  355.     nodep->lnkcnt = 0;  /* not linked anywhere */
  356.     nodep->refcnt = 1;
  357.     nodep->dirty = true;
  358.  
  359.     nodep->idx = idxp;
  360.     idxp->nodep = nodep;
  361.  
  362.     futex_up(&idxp->lock);
  363.     return FS_NODE(nodep);
  364. }
  365.  
  366. int fat_destroy_node(fs_node_t *fn)
  367. {
  368.     fat_node_t *nodep = FAT_NODE(fn);
  369.     fat_bs_t *bs;
  370.  
  371.     /*
  372.      * The node is not reachable from the file system. This means that the
  373.      * link count should be zero and that the index structure cannot be
  374.      * found in the position hash. Obviously, we don't need to lock the node
  375.      * nor its index structure.
  376.      */
  377.     assert(nodep->lnkcnt == 0);
  378.  
  379.     /*
  380.      * The node may not have any children.
  381.      */
  382.     assert(fat_has_children(fn) == false);
  383.  
  384.     bs = block_bb_get(nodep->idx->dev_handle);
  385.     if (nodep->firstc != FAT_CLST_RES0) {
  386.         assert(nodep->size);
  387.         /* Free all clusters allocated to the node. */
  388.         fat_free_clusters(bs, nodep->idx->dev_handle, nodep->firstc);
  389.     }
  390.  
  391.     fat_idx_destroy(nodep->idx);
  392.     free(nodep->bp);
  393.     free(nodep);
  394.     return EOK;
  395. }
  396.  
  397. int fat_link(fs_node_t *pfn, fs_node_t *cfn, const char *name)
  398. {
  399.     fat_node_t *parentp = FAT_NODE(pfn);
  400.     fat_node_t *childp = FAT_NODE(cfn);
  401.     fat_dentry_t *d;
  402.     fat_bs_t *bs;
  403.     block_t *b;
  404.     int i, j;
  405.     uint16_t bps;
  406.     unsigned dps;
  407.     unsigned blocks;
  408.     fat_cluster_t mcl, lcl;
  409.     int rc;
  410.  
  411.     futex_down(&childp->lock);
  412.     if (childp->lnkcnt == 1) {
  413.         /*
  414.          * On FAT, we don't support multiple hard links.
  415.          */
  416.         futex_up(&childp->lock);
  417.         return EMLINK;
  418.     }
  419.     assert(childp->lnkcnt == 0);
  420.     futex_up(&childp->lock);
  421.  
  422.     if (!fat_dentry_name_verify(name)) {
  423.         /*
  424.          * Attempt to create unsupported name.
  425.          */
  426.         return ENOTSUP;
  427.     }
  428.  
  429.     /*
  430.      * Get us an unused parent node's dentry or grow the parent and allocate
  431.      * a new one.
  432.      */
  433.    
  434.     futex_down(&parentp->idx->lock);
  435.     bs = block_bb_get(parentp->idx->dev_handle);
  436.     bps = uint16_t_le2host(bs->bps);
  437.     dps = bps / sizeof(fat_dentry_t);
  438.  
  439.     blocks = parentp->size / bps;
  440.  
  441.     for (i = 0; i < blocks; i++) {
  442.         b = fat_block_get(bs, parentp, i, BLOCK_FLAGS_NONE);
  443.         for (j = 0; j < dps; j++) {
  444.             d = ((fat_dentry_t *)b->data) + j;
  445.             switch (fat_classify_dentry(d)) {
  446.             case FAT_DENTRY_SKIP:
  447.             case FAT_DENTRY_VALID:
  448.                 /* skipping used and meta entries */
  449.                 continue;
  450.             case FAT_DENTRY_FREE:
  451.             case FAT_DENTRY_LAST:
  452.                 /* found an empty slot */
  453.                 goto hit;
  454.             }
  455.         }
  456.         block_put(b);
  457.     }
  458.     j = 0;
  459.    
  460.     /*
  461.      * We need to grow the parent in order to create a new unused dentry.
  462.      */
  463.     if (parentp->idx->pfc == FAT_CLST_ROOT) {
  464.         /* Can't grow the root directory. */
  465.         futex_up(&parentp->idx->lock);
  466.         return ENOSPC;
  467.     }
  468.     rc = fat_alloc_clusters(bs, parentp->idx->dev_handle, 1, &mcl, &lcl);
  469.     if (rc != EOK) {
  470.         futex_up(&parentp->idx->lock);
  471.         return rc;
  472.     }
  473.     fat_append_clusters(bs, parentp, mcl);
  474.     b = fat_block_get(bs, parentp, i, BLOCK_FLAGS_NOREAD);
  475.     d = (fat_dentry_t *)b->data;
  476.     /*
  477.      * Clear all dentries in the block except for the first one (the first
  478.      * dentry will be cleared in the next step).
  479.      */
  480.     memset(d + 1, 0, bps - sizeof(fat_dentry_t));
  481.  
  482. hit:
  483.     /*
  484.      * At this point we only establish the link between the parent and the
  485.      * child.  The dentry, except of the name and the extension, will remain
  486.      * uninitialized until the corresponding node is synced. Thus the valid
  487.      * dentry data is kept in the child node structure.
  488.      */
  489.     memset(d, 0, sizeof(fat_dentry_t));
  490.     fat_dentry_name_set(d, name);
  491.     b->dirty = true;        /* need to sync block */
  492.     block_put(b);
  493.     futex_up(&parentp->idx->lock);
  494.  
  495.     futex_down(&childp->idx->lock);
  496.    
  497.     /*
  498.      * If possible, create the Sub-directory Identifier Entry and the
  499.      * Sub-directory Parent Pointer Entry (i.e. "." and ".."). These entries
  500.      * are not mandatory according to Standard ECMA-107 and HelenOS VFS does
  501.      * not use them anyway, so this is rather a sign of our good will.
  502.      */
  503.     b = fat_block_get(bs, childp, 0, BLOCK_FLAGS_NONE);
  504.     d = (fat_dentry_t *)b->data;
  505.     if (fat_classify_dentry(d) == FAT_DENTRY_LAST ||
  506.         str_cmp(d->name, FAT_NAME_DOT) == 0) {
  507.         memset(d, 0, sizeof(fat_dentry_t));
  508.         str_cpy(d->name, 8, FAT_NAME_DOT);
  509.         str_cpy(d->ext, 3, FAT_EXT_PAD);
  510.         d->attr = FAT_ATTR_SUBDIR;
  511.         d->firstc = host2uint16_t_le(childp->firstc);
  512.         /* TODO: initialize also the date/time members. */
  513.     }
  514.     d++;
  515.     if (fat_classify_dentry(d) == FAT_DENTRY_LAST ||
  516.         str_cmp(d->name, FAT_NAME_DOT_DOT) == 0) {
  517.         memset(d, 0, sizeof(fat_dentry_t));
  518.         str_cpy(d->name, 8, FAT_NAME_DOT_DOT);
  519.         str_cpy(d->ext, 3, FAT_EXT_PAD);
  520.         d->attr = FAT_ATTR_SUBDIR;
  521.         d->firstc = (parentp->firstc == FAT_CLST_ROOT) ?
  522.             host2uint16_t_le(FAT_CLST_RES0) :
  523.             host2uint16_t_le(parentp->firstc);
  524.         /* TODO: initialize also the date/time members. */
  525.     }
  526.     b->dirty = true;        /* need to sync block */
  527.     block_put(b);
  528.  
  529.     childp->idx->pfc = parentp->firstc;
  530.     childp->idx->pdi = i * dps + j;
  531.     futex_up(&childp->idx->lock);
  532.  
  533.     futex_down(&childp->lock);
  534.     childp->lnkcnt = 1;
  535.     childp->dirty = true;       /* need to sync node */
  536.     futex_up(&childp->lock);
  537.  
  538.     /*
  539.      * Hash in the index structure into the position hash.
  540.      */
  541.     fat_idx_hashin(childp->idx);
  542.  
  543.     return EOK;
  544. }
  545.  
  546. int fat_unlink(fs_node_t *pfn, fs_node_t *cfn)
  547. {
  548.     fat_node_t *parentp = FAT_NODE(pfn);
  549.     fat_node_t *childp = FAT_NODE(cfn);
  550.     fat_bs_t *bs;
  551.     fat_dentry_t *d;
  552.     uint16_t bps;
  553.     block_t *b;
  554.  
  555.     if (!parentp)
  556.         return EBUSY;
  557.  
  558.     futex_down(&parentp->lock);
  559.     futex_down(&childp->lock);
  560.     assert(childp->lnkcnt == 1);
  561.     futex_down(&childp->idx->lock);
  562.     bs = block_bb_get(childp->idx->dev_handle);
  563.     bps = uint16_t_le2host(bs->bps);
  564.  
  565.     b = _fat_block_get(bs, childp->idx->dev_handle, childp->idx->pfc,
  566.         (childp->idx->pdi * sizeof(fat_dentry_t)) / bps,
  567.         BLOCK_FLAGS_NONE);
  568.     d = (fat_dentry_t *)b->data +
  569.         (childp->idx->pdi % (bps / sizeof(fat_dentry_t)));
  570.     /* mark the dentry as not-currently-used */
  571.     d->name[0] = FAT_DENTRY_ERASED;
  572.     b->dirty = true;        /* need to sync block */
  573.     block_put(b);
  574.  
  575.     /* remove the index structure from the position hash */
  576.     fat_idx_hashout(childp->idx);
  577.     /* clear position information */
  578.     childp->idx->pfc = FAT_CLST_RES0;
  579.     childp->idx->pdi = 0;
  580.     futex_up(&childp->idx->lock);
  581.     childp->lnkcnt = 0;
  582.     childp->dirty = true;
  583.     futex_up(&childp->lock);
  584.     futex_up(&parentp->lock);
  585.  
  586.     return EOK;
  587. }
  588.  
  589. fs_node_t *fat_match(fs_node_t *pfn, const char *component)
  590. {
  591.     fat_bs_t *bs;
  592.     fat_node_t *parentp = FAT_NODE(pfn);
  593.     char name[FAT_NAME_LEN + 1 + FAT_EXT_LEN + 1];
  594.     unsigned i, j;
  595.     unsigned bps;       /* bytes per sector */
  596.     unsigned dps;       /* dentries per sector */
  597.     unsigned blocks;
  598.     fat_dentry_t *d;
  599.     block_t *b;
  600.  
  601.     futex_down(&parentp->idx->lock);
  602.     bs = block_bb_get(parentp->idx->dev_handle);
  603.     bps = uint16_t_le2host(bs->bps);
  604.     dps = bps / sizeof(fat_dentry_t);
  605.     blocks = parentp->size / bps;
  606.     for (i = 0; i < blocks; i++) {
  607.         b = fat_block_get(bs, parentp, i, BLOCK_FLAGS_NONE);
  608.         for (j = 0; j < dps; j++) {
  609.             d = ((fat_dentry_t *)b->data) + j;
  610.             switch (fat_classify_dentry(d)) {
  611.             case FAT_DENTRY_SKIP:
  612.             case FAT_DENTRY_FREE:
  613.                 continue;
  614.             case FAT_DENTRY_LAST:
  615.                 block_put(b);
  616.                 futex_up(&parentp->idx->lock);
  617.                 return NULL;
  618.             default:
  619.             case FAT_DENTRY_VALID:
  620.                 fat_dentry_name_get(d, name);
  621.                 break;
  622.             }
  623.             if (fat_dentry_namecmp(name, component) == 0) {
  624.                 /* hit */
  625.                 fat_node_t *nodep;
  626.                 /*
  627.                  * Assume tree hierarchy for locking.  We
  628.                  * already have the parent and now we are going
  629.                  * to lock the child.  Never lock in the oposite
  630.                  * order.
  631.                  */
  632.                 fat_idx_t *idx = fat_idx_get_by_pos(
  633.                     parentp->idx->dev_handle, parentp->firstc,
  634.                     i * dps + j);
  635.                 futex_up(&parentp->idx->lock);
  636.                 if (!idx) {
  637.                     /*
  638.                      * Can happen if memory is low or if we
  639.                      * run out of 32-bit indices.
  640.                      */
  641.                     block_put(b);
  642.                     return NULL;
  643.                 }
  644.                 nodep = fat_node_get_core(idx);
  645.                 futex_up(&idx->lock);
  646.                 block_put(b);
  647.                 return FS_NODE(nodep);
  648.             }
  649.         }
  650.         block_put(b);
  651.     }
  652.  
  653.     futex_up(&parentp->idx->lock);
  654.     return NULL;
  655. }
  656.  
  657. fs_index_t fat_index_get(fs_node_t *fn)
  658. {
  659.     return FAT_NODE(fn)->idx->index;
  660. }
  661.  
  662. size_t fat_size_get(fs_node_t *fn)
  663. {
  664.     return FAT_NODE(fn)->size;
  665. }
  666.  
  667. unsigned fat_lnkcnt_get(fs_node_t *fn)
  668. {
  669.     return FAT_NODE(fn)->lnkcnt;
  670. }
  671.  
  672. bool fat_has_children(fs_node_t *fn)
  673. {
  674.     fat_bs_t *bs;
  675.     fat_node_t *nodep = FAT_NODE(fn);
  676.     unsigned bps;
  677.     unsigned dps;
  678.     unsigned blocks;
  679.     block_t *b;
  680.     unsigned i, j;
  681.  
  682.     if (nodep->type != FAT_DIRECTORY)
  683.         return false;
  684.    
  685.     futex_down(&nodep->idx->lock);
  686.     bs = block_bb_get(nodep->idx->dev_handle);
  687.     bps = uint16_t_le2host(bs->bps);
  688.     dps = bps / sizeof(fat_dentry_t);
  689.  
  690.     blocks = nodep->size / bps;
  691.  
  692.     for (i = 0; i < blocks; i++) {
  693.         fat_dentry_t *d;
  694.    
  695.         b = fat_block_get(bs, nodep, i, BLOCK_FLAGS_NONE);
  696.         for (j = 0; j < dps; j++) {
  697.             d = ((fat_dentry_t *)b->data) + j;
  698.             switch (fat_classify_dentry(d)) {
  699.             case FAT_DENTRY_SKIP:
  700.             case FAT_DENTRY_FREE:
  701.                 continue;
  702.             case FAT_DENTRY_LAST:
  703.                 block_put(b);
  704.                 futex_up(&nodep->idx->lock);
  705.                 return false;
  706.             default:
  707.             case FAT_DENTRY_VALID:
  708.                 block_put(b);
  709.                 futex_up(&nodep->idx->lock);
  710.                 return true;
  711.             }
  712.             block_put(b);
  713.             futex_up(&nodep->idx->lock);
  714.             return true;
  715.         }
  716.         block_put(b);
  717.     }
  718.  
  719.     futex_up(&nodep->idx->lock);
  720.     return false;
  721. }
  722.  
  723. fs_node_t *fat_root_get(dev_handle_t dev_handle)
  724. {
  725.     return fat_node_get(dev_handle, 0);
  726. }
  727.  
  728. char fat_plb_get_char(unsigned pos)
  729. {
  730.     return fat_reg.plb_ro[pos % PLB_SIZE];
  731. }
  732.  
  733. bool fat_is_directory(fs_node_t *fn)
  734. {
  735.     return FAT_NODE(fn)->type == FAT_DIRECTORY;
  736. }
  737.  
  738. bool fat_is_file(fs_node_t *fn)
  739. {
  740.     return FAT_NODE(fn)->type == FAT_FILE;
  741. }
  742.  
  743. /** libfs operations */
  744. libfs_ops_t fat_libfs_ops = {
  745.     .match = fat_match,
  746.     .node_get = fat_node_get,
  747.     .node_put = fat_node_put,
  748.     .create = fat_create_node,
  749.     .destroy = fat_destroy_node,
  750.     .link = fat_link,
  751.     .unlink = fat_unlink,
  752.     .index_get = fat_index_get,
  753.     .size_get = fat_size_get,
  754.     .lnkcnt_get = fat_lnkcnt_get,
  755.     .has_children = fat_has_children,
  756.     .root_get = fat_root_get,
  757.     .plb_get_char = fat_plb_get_char,
  758.     .is_directory = fat_is_directory,
  759.     .is_file = fat_is_file
  760. };
  761.  
  762. /*
  763.  * VFS operations.
  764.  */
  765.  
  766. void fat_mounted(ipc_callid_t rid, ipc_call_t *request)
  767. {
  768.     dev_handle_t dev_handle = (dev_handle_t) IPC_GET_ARG1(*request);
  769.     fat_bs_t *bs;
  770.     uint16_t bps;
  771.     uint16_t rde;
  772.     int rc;
  773.  
  774.     /* accept the mount options */
  775.     ipc_callid_t callid;
  776.     size_t size;
  777.     if (!ipc_data_write_receive(&callid, &size)) {
  778.         ipc_answer_0(callid, EINVAL);
  779.         ipc_answer_0(rid, EINVAL);
  780.         return;
  781.     }
  782.     char *opts = malloc(size + 1);
  783.     if (!opts) {
  784.         ipc_answer_0(callid, ENOMEM);
  785.         ipc_answer_0(rid, ENOMEM);
  786.         return;
  787.     }
  788.     ipcarg_t retval = ipc_data_write_finalize(callid, opts, size);
  789.     if (retval != EOK) {
  790.         ipc_answer_0(rid, retval);
  791.         free(opts);
  792.         return;
  793.     }
  794.     opts[size] = '\0';
  795.  
  796.     /* initialize libblock */
  797.     rc = block_init(dev_handle, BS_SIZE);
  798.     if (rc != EOK) {
  799.         ipc_answer_0(rid, rc);
  800.         return;
  801.     }
  802.  
  803.     /* prepare the boot block */
  804.     rc = block_bb_read(dev_handle, BS_BLOCK * BS_SIZE, BS_SIZE);
  805.     if (rc != EOK) {
  806.         block_fini(dev_handle);
  807.         ipc_answer_0(rid, rc);
  808.         return;
  809.     }
  810.  
  811.     /* get the buffer with the boot sector */
  812.     bs = block_bb_get(dev_handle);
  813.    
  814.     /* Read the number of root directory entries. */
  815.     bps = uint16_t_le2host(bs->bps);
  816.     rde = uint16_t_le2host(bs->root_ent_max);
  817.  
  818.     if (bps != BS_SIZE) {
  819.         block_fini(dev_handle);
  820.         ipc_answer_0(rid, ENOTSUP);
  821.         return;
  822.     }
  823.  
  824.     /* Initialize the block cache */
  825.     rc = block_cache_init(dev_handle, bps, 0 /* XXX */);
  826.     if (rc != EOK) {
  827.         block_fini(dev_handle);
  828.         ipc_answer_0(rid, rc);
  829.         return;
  830.     }
  831.  
  832.     rc = fat_idx_init_by_dev_handle(dev_handle);
  833.     if (rc != EOK) {
  834.         block_fini(dev_handle);
  835.         ipc_answer_0(rid, rc);
  836.         return;
  837.     }
  838.  
  839.     /* Initialize the root node. */
  840.     fs_node_t *rfn = (fs_node_t *)malloc(sizeof(fs_node_t));
  841.     if (!rfn) {
  842.         block_fini(dev_handle);
  843.         fat_idx_fini_by_dev_handle(dev_handle);
  844.         ipc_answer_0(rid, ENOMEM);
  845.         return;
  846.     }
  847.     fat_node_t *rootp = (fat_node_t *)malloc(sizeof(fat_node_t));
  848.     if (!rootp) {
  849.         free(rfn);
  850.         block_fini(dev_handle);
  851.         fat_idx_fini_by_dev_handle(dev_handle);
  852.         ipc_answer_0(rid, ENOMEM);
  853.         return;
  854.     }
  855.     fat_node_initialize(rootp);
  856.  
  857.     fat_idx_t *ridxp = fat_idx_get_by_pos(dev_handle, FAT_CLST_ROOTPAR, 0);
  858.     if (!ridxp) {
  859.         free(rfn);
  860.         free(rootp);
  861.         block_fini(dev_handle);
  862.         fat_idx_fini_by_dev_handle(dev_handle);
  863.         ipc_answer_0(rid, ENOMEM);
  864.         return;
  865.     }
  866.     assert(ridxp->index == 0);
  867.     /* ridxp->lock held */
  868.  
  869.     rootp->type = FAT_DIRECTORY;
  870.     rootp->firstc = FAT_CLST_ROOT;
  871.     rootp->refcnt = 1;
  872.     rootp->lnkcnt = 0;  /* FS root is not linked */
  873.     rootp->size = rde * sizeof(fat_dentry_t);
  874.     rootp->idx = ridxp;
  875.     ridxp->nodep = rootp;
  876.     rootp->bp = rfn;
  877.     rfn->data = rootp;
  878.    
  879.     futex_up(&ridxp->lock);
  880.  
  881.     ipc_answer_3(rid, EOK, ridxp->index, rootp->size, rootp->lnkcnt);
  882. }
  883.  
  884. void fat_mount(ipc_callid_t rid, ipc_call_t *request)
  885. {
  886.     ipc_answer_0(rid, ENOTSUP);
  887. }
  888.  
  889. void fat_lookup(ipc_callid_t rid, ipc_call_t *request)
  890. {
  891.     libfs_lookup(&fat_libfs_ops, fat_reg.fs_handle, rid, request);
  892. }
  893.  
  894. void fat_read(ipc_callid_t rid, ipc_call_t *request)
  895. {
  896.     dev_handle_t dev_handle = (dev_handle_t)IPC_GET_ARG1(*request);
  897.     fs_index_t index = (fs_index_t)IPC_GET_ARG2(*request);
  898.     off_t pos = (off_t)IPC_GET_ARG3(*request);
  899.     fs_node_t *fn = fat_node_get(dev_handle, index);
  900.     fat_node_t *nodep;
  901.     fat_bs_t *bs;
  902.     uint16_t bps;
  903.     size_t bytes;
  904.     block_t *b;
  905.  
  906.     if (!fn) {
  907.         ipc_answer_0(rid, ENOENT);
  908.         return;
  909.     }
  910.     nodep = FAT_NODE(fn);
  911.  
  912.     ipc_callid_t callid;
  913.     size_t len;
  914.     if (!ipc_data_read_receive(&callid, &len)) {
  915.         fat_node_put(fn);
  916.         ipc_answer_0(callid, EINVAL);
  917.         ipc_answer_0(rid, EINVAL);
  918.         return;
  919.     }
  920.  
  921.     bs = block_bb_get(dev_handle);
  922.     bps = uint16_t_le2host(bs->bps);
  923.  
  924.     if (nodep->type == FAT_FILE) {
  925.         /*
  926.          * Our strategy for regular file reads is to read one block at
  927.          * most and make use of the possibility to return less data than
  928.          * requested. This keeps the code very simple.
  929.          */
  930.         if (pos >= nodep->size) {
  931.             /* reading beyond the EOF */
  932.             bytes = 0;
  933.             (void) ipc_data_read_finalize(callid, NULL, 0);
  934.         } else {
  935.             bytes = min(len, bps - pos % bps);
  936.             bytes = min(bytes, nodep->size - pos);
  937.             b = fat_block_get(bs, nodep, pos / bps,
  938.                 BLOCK_FLAGS_NONE);
  939.             (void) ipc_data_read_finalize(callid, b->data + pos % bps,
  940.                 bytes);
  941.             block_put(b);
  942.         }
  943.     } else {
  944.         unsigned bnum;
  945.         off_t spos = pos;
  946.         char name[FAT_NAME_LEN + 1 + FAT_EXT_LEN + 1];
  947.         fat_dentry_t *d;
  948.  
  949.         assert(nodep->type == FAT_DIRECTORY);
  950.         assert(nodep->size % bps == 0);
  951.         assert(bps % sizeof(fat_dentry_t) == 0);
  952.  
  953.         /*
  954.          * Our strategy for readdir() is to use the position pointer as
  955.          * an index into the array of all dentries. On entry, it points
  956.          * to the first unread dentry. If we skip any dentries, we bump
  957.          * the position pointer accordingly.
  958.          */
  959.         bnum = (pos * sizeof(fat_dentry_t)) / bps;
  960.         while (bnum < nodep->size / bps) {
  961.             off_t o;
  962.  
  963.             b = fat_block_get(bs, nodep, bnum, BLOCK_FLAGS_NONE);
  964.             for (o = pos % (bps / sizeof(fat_dentry_t));
  965.                 o < bps / sizeof(fat_dentry_t);
  966.                 o++, pos++) {
  967.                 d = ((fat_dentry_t *)b->data) + o;
  968.                 switch (fat_classify_dentry(d)) {
  969.                 case FAT_DENTRY_SKIP:
  970.                 case FAT_DENTRY_FREE:
  971.                     continue;
  972.                 case FAT_DENTRY_LAST:
  973.                     block_put(b);
  974.                     goto miss;
  975.                 default:
  976.                 case FAT_DENTRY_VALID:
  977.                     fat_dentry_name_get(d, name);
  978.                     block_put(b);
  979.                     goto hit;
  980.                 }
  981.             }
  982.             block_put(b);
  983.             bnum++;
  984.         }
  985. miss:
  986.         fat_node_put(fn);
  987.         ipc_answer_0(callid, ENOENT);
  988.         ipc_answer_1(rid, ENOENT, 0);
  989.         return;
  990. hit:
  991.         (void) ipc_data_read_finalize(callid, name, str_size(name) + 1);
  992.         bytes = (pos - spos) + 1;
  993.     }
  994.  
  995.     fat_node_put(fn);
  996.     ipc_answer_1(rid, EOK, (ipcarg_t)bytes);
  997. }
  998.  
  999. void fat_write(ipc_callid_t rid, ipc_call_t *request)
  1000. {
  1001.     dev_handle_t dev_handle = (dev_handle_t)IPC_GET_ARG1(*request);
  1002.     fs_index_t index = (fs_index_t)IPC_GET_ARG2(*request);
  1003.     off_t pos = (off_t)IPC_GET_ARG3(*request);
  1004.     fs_node_t *fn = fat_node_get(dev_handle, index);
  1005.     fat_node_t *nodep;
  1006.     fat_bs_t *bs;
  1007.     size_t bytes;
  1008.     block_t *b;
  1009.     uint16_t bps;
  1010.     unsigned spc;
  1011.     unsigned bpc;       /* bytes per cluster */
  1012.     off_t boundary;
  1013.     int flags = BLOCK_FLAGS_NONE;
  1014.    
  1015.     if (!fn) {
  1016.         ipc_answer_0(rid, ENOENT);
  1017.         return;
  1018.     }
  1019.     nodep = FAT_NODE(fn);
  1020.    
  1021.     ipc_callid_t callid;
  1022.     size_t len;
  1023.     if (!ipc_data_write_receive(&callid, &len)) {
  1024.         fat_node_put(fn);
  1025.         ipc_answer_0(callid, EINVAL);
  1026.         ipc_answer_0(rid, EINVAL);
  1027.         return;
  1028.     }
  1029.  
  1030.     bs = block_bb_get(dev_handle);
  1031.     bps = uint16_t_le2host(bs->bps);
  1032.     spc = bs->spc;
  1033.     bpc = bps * spc;
  1034.  
  1035.     /*
  1036.      * In all scenarios, we will attempt to write out only one block worth
  1037.      * of data at maximum. There might be some more efficient approaches,
  1038.      * but this one greatly simplifies fat_write(). Note that we can afford
  1039.      * to do this because the client must be ready to handle the return
  1040.      * value signalizing a smaller number of bytes written.
  1041.      */
  1042.     bytes = min(len, bps - pos % bps);
  1043.     if (bytes == bps)
  1044.         flags |= BLOCK_FLAGS_NOREAD;
  1045.    
  1046.     boundary = ROUND_UP(nodep->size, bpc);
  1047.     if (pos < boundary) {
  1048.         /*
  1049.          * This is the easier case - we are either overwriting already
  1050.          * existing contents or writing behind the EOF, but still within
  1051.          * the limits of the last cluster. The node size may grow to the
  1052.          * next block size boundary.
  1053.          */
  1054.         fat_fill_gap(bs, nodep, FAT_CLST_RES0, pos);
  1055.         b = fat_block_get(bs, nodep, pos / bps, flags);
  1056.         (void) ipc_data_write_finalize(callid, b->data + pos % bps,
  1057.             bytes);
  1058.         b->dirty = true;        /* need to sync block */
  1059.         block_put(b);
  1060.         if (pos + bytes > nodep->size) {
  1061.             nodep->size = pos + bytes;
  1062.             nodep->dirty = true;    /* need to sync node */
  1063.         }
  1064.         ipc_answer_2(rid, EOK, bytes, nodep->size);
  1065.         fat_node_put(fn);
  1066.         return;
  1067.     } else {
  1068.         /*
  1069.          * This is the more difficult case. We must allocate new
  1070.          * clusters for the node and zero them out.
  1071.          */
  1072.         int status;
  1073.         unsigned nclsts;
  1074.         fat_cluster_t mcl, lcl;
  1075.  
  1076.         nclsts = (ROUND_UP(pos + bytes, bpc) - boundary) / bpc;
  1077.         /* create an independent chain of nclsts clusters in all FATs */
  1078.         status = fat_alloc_clusters(bs, dev_handle, nclsts, &mcl, &lcl);
  1079.         if (status != EOK) {
  1080.             /* could not allocate a chain of nclsts clusters */
  1081.             fat_node_put(fn);
  1082.             ipc_answer_0(callid, status);
  1083.             ipc_answer_0(rid, status);
  1084.             return;
  1085.         }
  1086.         /* zero fill any gaps */
  1087.         fat_fill_gap(bs, nodep, mcl, pos);
  1088.         b = _fat_block_get(bs, dev_handle, lcl, (pos / bps) % spc,
  1089.             flags);
  1090.         (void) ipc_data_write_finalize(callid, b->data + pos % bps,
  1091.             bytes);
  1092.         b->dirty = true;        /* need to sync block */
  1093.         block_put(b);
  1094.         /*
  1095.          * Append the cluster chain starting in mcl to the end of the
  1096.          * node's cluster chain.
  1097.          */
  1098.         fat_append_clusters(bs, nodep, mcl);
  1099.         nodep->size = pos + bytes;
  1100.         nodep->dirty = true;        /* need to sync node */
  1101.         ipc_answer_2(rid, EOK, bytes, nodep->size);
  1102.         fat_node_put(fn);
  1103.         return;
  1104.     }
  1105. }
  1106.  
  1107. void fat_truncate(ipc_callid_t rid, ipc_call_t *request)
  1108. {
  1109.     dev_handle_t dev_handle = (dev_handle_t)IPC_GET_ARG1(*request);
  1110.     fs_index_t index = (fs_index_t)IPC_GET_ARG2(*request);
  1111.     size_t size = (off_t)IPC_GET_ARG3(*request);
  1112.     fs_node_t *fn = fat_node_get(dev_handle, index);
  1113.     fat_node_t *nodep;
  1114.     fat_bs_t *bs;
  1115.     uint16_t bps;
  1116.     uint8_t spc;
  1117.     unsigned bpc;   /* bytes per cluster */
  1118.     int rc;
  1119.  
  1120.     if (!fn) {
  1121.         ipc_answer_0(rid, ENOENT);
  1122.         return;
  1123.     }
  1124.     nodep = FAT_NODE(fn);
  1125.  
  1126.     bs = block_bb_get(dev_handle);
  1127.     bps = uint16_t_le2host(bs->bps);
  1128.     spc = bs->spc;
  1129.     bpc = bps * spc;
  1130.  
  1131.     if (nodep->size == size) {
  1132.         rc = EOK;
  1133.     } else if (nodep->size < size) {
  1134.         /*
  1135.          * The standard says we have the freedom to grow the node.
  1136.          * For now, we simply return an error.
  1137.          */
  1138.         rc = EINVAL;
  1139.     } else if (ROUND_UP(nodep->size, bpc) == ROUND_UP(size, bpc)) {
  1140.         /*
  1141.          * The node will be shrunk, but no clusters will be deallocated.
  1142.          */
  1143.         nodep->size = size;
  1144.         nodep->dirty = true;        /* need to sync node */
  1145.         rc = EOK;  
  1146.     } else {
  1147.         /*
  1148.          * The node will be shrunk, clusters will be deallocated.
  1149.          */
  1150.         if (size == 0) {
  1151.             fat_chop_clusters(bs, nodep, FAT_CLST_RES0);
  1152.         } else {
  1153.             fat_cluster_t lastc;
  1154.             (void) fat_cluster_walk(bs, dev_handle, nodep->firstc,
  1155.                 &lastc, (size - 1) / bpc);
  1156.             fat_chop_clusters(bs, nodep, lastc);
  1157.         }
  1158.         nodep->size = size;
  1159.         nodep->dirty = true;        /* need to sync node */
  1160.         rc = EOK;  
  1161.     }
  1162.     fat_node_put(fn);
  1163.     ipc_answer_0(rid, rc);
  1164.     return;
  1165. }
  1166.  
  1167. void fat_destroy(ipc_callid_t rid, ipc_call_t *request)
  1168. {
  1169.     dev_handle_t dev_handle = (dev_handle_t)IPC_GET_ARG1(*request);
  1170.     fs_index_t index = (fs_index_t)IPC_GET_ARG2(*request);
  1171.     int rc;
  1172.  
  1173.     fs_node_t *fn = fat_node_get(dev_handle, index);
  1174.     if (!fn) {
  1175.         ipc_answer_0(rid, ENOENT);
  1176.         return;
  1177.     }
  1178.  
  1179.     rc = fat_destroy_node(fn);
  1180.     ipc_answer_0(rid, rc);
  1181. }
  1182.  
  1183. /**
  1184.  * @}
  1185.  */
  1186.