Subversion Repositories HelenOS

Rev

Rev 2742 | Rev 2756 | 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    tmpfs_ops.c
  35.  * @brief   Implementation of VFS operations for the TMPFS file system
  36.  *      server.
  37.  */
  38.  
  39. #include "tmpfs.h"
  40. #include "../../vfs/vfs.h"
  41. #include <ipc/ipc.h>
  42. #include <async.h>
  43. #include <errno.h>
  44. #include <atomic.h>
  45. #include <stdlib.h>
  46. #include <string.h>
  47. #include <stdio.h>
  48. #include <assert.h>
  49. #include <sys/types.h>
  50. #include <libadt/hash_table.h>
  51. #include <as.h>
  52. #include <libfs.h>
  53.  
  54. #define min(a, b)       ((a) < (b) ? (a) : (b))
  55. #define max(a, b)       ((a) > (b) ? (a) : (b))
  56.  
  57. #define DENTRIES_BUCKETS    256
  58.  
  59. /*
  60.  * For now, we don't distinguish between different dev_handles/instances. All
  61.  * requests resolve to the only instance, rooted in the following variable.
  62.  */
  63. static tmpfs_dentry_t *root;
  64.  
  65. /*
  66.  * Implementation of the libfs interface.
  67.  */
  68.  
  69. /* Forward declarations of static functions. */
  70. static bool tmpfs_match(void *, const char *);
  71. static void *tmpfs_create_node(int);
  72. static bool tmpfs_link_node(void *, void *, const char *);
  73. static int tmpfs_unlink_node(void *);
  74. static void tmpfs_destroy_node(void *);
  75.  
  76. /* Implementation of helper functions. */
  77. static unsigned long tmpfs_index_get(void *nodep)
  78. {
  79.     return ((tmpfs_dentry_t *) nodep)->index;
  80. }
  81.  
  82. static unsigned long tmpfs_size_get(void *nodep)
  83. {
  84.     return ((tmpfs_dentry_t *) nodep)->size;
  85. }
  86.  
  87. static unsigned tmpfs_lnkcnt_get(void *nodep)
  88. {
  89.     return 1;
  90. }
  91.  
  92. static void *tmpfs_child_get(void *nodep)
  93. {
  94.     return ((tmpfs_dentry_t *) nodep)->child;
  95. }
  96.  
  97. static void *tmpfs_sibling_get(void *nodep)
  98. {
  99.     return ((tmpfs_dentry_t *) nodep)->sibling;
  100. }
  101.  
  102. static void *tmpfs_root_get(void)
  103. {
  104.     return root;
  105. }
  106.  
  107. static char tmpfs_plb_get_char(unsigned pos)
  108. {
  109.     return tmpfs_reg.plb_ro[pos % PLB_SIZE];
  110. }
  111.  
  112. static bool tmpfs_is_directory(void *nodep)
  113. {
  114.     return ((tmpfs_dentry_t *) nodep)->type == TMPFS_DIRECTORY;
  115. }
  116.  
  117. static bool tmpfs_is_file(void *nodep)
  118. {
  119.     return ((tmpfs_dentry_t *) nodep)->type == TMPFS_FILE;
  120. }
  121.  
  122. /** libfs operations */
  123. libfs_ops_t tmpfs_libfs_ops = {
  124.     .match = tmpfs_match,
  125.     .create = tmpfs_create_node,
  126.     .destroy = tmpfs_destroy_node,
  127.     .link = tmpfs_link_node,
  128.     .unlink = tmpfs_unlink_node,
  129.     .index_get = tmpfs_index_get,
  130.     .size_get = tmpfs_size_get,
  131.     .lnkcnt_get = tmpfs_lnkcnt_get,
  132.     .child_get = tmpfs_child_get,
  133.     .sibling_get = tmpfs_sibling_get,
  134.     .root_get = tmpfs_root_get,
  135.     .plb_get_char = tmpfs_plb_get_char,
  136.     .is_directory = tmpfs_is_directory,
  137.     .is_file = tmpfs_is_file
  138. };
  139.  
  140. /** Hash table of all directory entries. */
  141. hash_table_t dentries;
  142.  
  143. /* Implementation of hash table interface. */
  144. static hash_index_t dentries_hash(unsigned long *key)
  145. {
  146.     return *key % DENTRIES_BUCKETS;
  147. }
  148.  
  149. static int dentries_compare(unsigned long *key, hash_count_t keys,
  150.     link_t *item)
  151. {
  152.     tmpfs_dentry_t *dentry = hash_table_get_instance(item, tmpfs_dentry_t,
  153.         dh_link);
  154.     return dentry->index == *key;
  155. }
  156.  
  157. static void dentries_remove_callback(link_t *item)
  158. {
  159. }
  160.  
  161. /** TMPFS dentries hash table operations. */
  162. hash_table_operations_t dentries_ops = {
  163.     .hash = dentries_hash,
  164.     .compare = dentries_compare,
  165.     .remove_callback = dentries_remove_callback
  166. };
  167.  
  168. unsigned tmpfs_next_index = 1;
  169.  
  170. static void tmpfs_dentry_initialize(tmpfs_dentry_t *dentry)
  171. {
  172.     dentry->index = 0;
  173.     dentry->parent = NULL;
  174.     dentry->sibling = NULL;
  175.     dentry->child = NULL;
  176.     dentry->name = NULL;
  177.     dentry->type = TMPFS_NONE;
  178.     dentry->size = 0;
  179.     dentry->data = NULL;
  180.     link_initialize(&dentry->dh_link);
  181. }
  182.  
  183. static bool tmpfs_init(void)
  184. {
  185.     if (!hash_table_create(&dentries, DENTRIES_BUCKETS, 1, &dentries_ops))
  186.         return false;
  187.     root = (tmpfs_dentry_t *) tmpfs_create_node(L_DIRECTORY);
  188.     return root != NULL;
  189. }
  190.  
  191. /** Compare one component of path to a directory entry.
  192.  *
  193.  * @param nodep     Node to compare the path component with.
  194.  * @param component Array of characters holding component name.
  195.  *
  196.  * @return      True on match, false otherwise.
  197.  */
  198. bool tmpfs_match(void *nodep, const char *component)
  199. {
  200.     tmpfs_dentry_t *dentry = (tmpfs_dentry_t *) nodep;
  201.  
  202.     return !strcmp(dentry->name, component);
  203. }
  204.  
  205. void *tmpfs_create_node(int lflag)
  206. {
  207.     assert((lflag & L_FILE) ^ (lflag & L_DIRECTORY));
  208.  
  209.     tmpfs_dentry_t *node = malloc(sizeof(tmpfs_dentry_t));
  210.     if (!node)
  211.         return NULL;
  212.  
  213.     tmpfs_dentry_initialize(node);
  214.     node->index = tmpfs_next_index++;
  215.     if (lflag & L_DIRECTORY)
  216.         node->type = TMPFS_DIRECTORY;
  217.     else
  218.         node->type = TMPFS_FILE;
  219.  
  220.     /* Insert the new node into the dentry hash table. */
  221.     hash_table_insert(&dentries, &node->index, &node->dh_link);
  222.     return (void *) node;
  223. }
  224.  
  225. bool tmpfs_link_node(void *prnt, void *chld, const char *nm)
  226. {
  227.     tmpfs_dentry_t *parentp = (tmpfs_dentry_t *) prnt;
  228.     tmpfs_dentry_t *childp = (tmpfs_dentry_t *) chld;
  229.  
  230.     assert(parentp->type == TMPFS_DIRECTORY);
  231.  
  232.     size_t len = strlen(nm);
  233.     char *name = malloc(len + 1);
  234.     if (!name)
  235.         return false;
  236.     strcpy(name, nm);
  237.     childp->name = name;
  238.  
  239.     /* Insert the new node into the namespace. */
  240.     if (parentp->child) {
  241.         tmpfs_dentry_t *tmp = parentp->child;
  242.         while (tmp->sibling)
  243.             tmp = tmp->sibling;
  244.         tmp->sibling = childp;
  245.     } else {
  246.         parentp->child = childp;
  247.     }
  248.     childp->parent = parentp;
  249.  
  250.     return true;
  251. }
  252.  
  253. int tmpfs_unlink_node(void *nodeptr)
  254. {
  255.     tmpfs_dentry_t *dentry = (tmpfs_dentry_t *)nodeptr;
  256.  
  257.     if (dentry->child)
  258.         return ENOTEMPTY;
  259.  
  260.     if (!dentry->parent)
  261.         return EBUSY;
  262.  
  263.     if (dentry->parent->child == dentry) {
  264.         dentry->parent->child = dentry->sibling;
  265.     } else {
  266.         /* TODO: consider doubly linked list for organizing siblings. */
  267.         tmpfs_dentry_t *tmp = dentry->parent->child;
  268.         while (tmp->sibling != dentry)
  269.             tmp = tmp->sibling;
  270.         tmp->sibling = dentry->sibling;
  271.     }
  272.     dentry->sibling = NULL;
  273.     dentry->parent = NULL;
  274.  
  275.     free(dentry->name);
  276.     dentry->name = NULL;
  277.  
  278.     return EOK;
  279. }
  280.  
  281. void tmpfs_destroy_node(void *nodep)
  282. {
  283.     tmpfs_dentry_t *dentry = (tmpfs_dentry_t *) nodep;
  284.    
  285.     assert(!dentry->child);
  286.     assert(!dentry->sibling);
  287.  
  288.     unsigned long index = dentry->index;
  289.     hash_table_remove(&dentries, &index, 1);
  290.  
  291.     if (dentry->type == TMPFS_FILE)
  292.         free(dentry->data);
  293.     free(dentry);
  294. }
  295.  
  296. void tmpfs_lookup(ipc_callid_t rid, ipc_call_t *request)
  297. {
  298.     /* Initialize TMPFS. */
  299.     if (!root && !tmpfs_init()) {
  300.         ipc_answer_0(rid, ENOMEM);
  301.         return;
  302.     }
  303.     libfs_lookup(&tmpfs_libfs_ops, tmpfs_reg.fs_handle, rid, request);
  304. }
  305.  
  306. void tmpfs_read(ipc_callid_t rid, ipc_call_t *request)
  307. {
  308.     int dev_handle = IPC_GET_ARG1(*request);
  309.     unsigned long index = IPC_GET_ARG2(*request);
  310.     off_t pos = IPC_GET_ARG3(*request);
  311.  
  312.     /*
  313.      * Lookup the respective dentry.
  314.      */
  315.     link_t *hlp;
  316.     hlp = hash_table_find(&dentries, &index);
  317.     if (!hlp) {
  318.         ipc_answer_0(rid, ENOENT);
  319.         return;
  320.     }
  321.     tmpfs_dentry_t *dentry = hash_table_get_instance(hlp, tmpfs_dentry_t,
  322.         dh_link);
  323.  
  324.     /*
  325.      * Receive the read request.
  326.      */
  327.     ipc_callid_t callid;
  328.     size_t len;
  329.     if (!ipc_data_read_receive(&callid, &len)) {
  330.         ipc_answer_0(callid, EINVAL);  
  331.         ipc_answer_0(rid, EINVAL);
  332.         return;
  333.     }
  334.  
  335.     size_t bytes;
  336.     if (dentry->type == TMPFS_FILE) {
  337.         bytes = max(0, min(dentry->size - pos, len));
  338.         (void) ipc_data_read_finalize(callid, dentry->data + pos,
  339.             bytes);
  340.     } else {
  341.         int i;
  342.         tmpfs_dentry_t *cur;
  343.        
  344.         assert(dentry->type == TMPFS_DIRECTORY);
  345.        
  346.         /*
  347.          * Yes, we really use O(n) algorithm here.
  348.          * If it bothers someone, it could be fixed by introducing a
  349.          * hash table.
  350.          */
  351.         for (i = 0, cur = dentry->child; i < pos && cur; i++,
  352.             cur = cur->sibling)
  353.             ;
  354.  
  355.         if (!cur) {
  356.             ipc_answer_0(callid, ENOENT);
  357.             ipc_answer_1(rid, ENOENT, 0);
  358.             return;
  359.         }
  360.  
  361.         (void) ipc_data_read_finalize(callid, cur->name,
  362.             strlen(cur->name) + 1);
  363.         bytes = 1;
  364.     }
  365.  
  366.     /*
  367.      * Answer the VFS_READ call.
  368.      */
  369.     ipc_answer_1(rid, EOK, bytes);
  370. }
  371.  
  372. void tmpfs_write(ipc_callid_t rid, ipc_call_t *request)
  373. {
  374.     int dev_handle = IPC_GET_ARG1(*request);
  375.     unsigned long index = IPC_GET_ARG2(*request);
  376.     off_t pos = IPC_GET_ARG3(*request);
  377.  
  378.     /*
  379.      * Lookup the respective dentry.
  380.      */
  381.     link_t *hlp;
  382.     hlp = hash_table_find(&dentries, &index);
  383.     if (!hlp) {
  384.         ipc_answer_0(rid, ENOENT);
  385.         return;
  386.     }
  387.     tmpfs_dentry_t *dentry = hash_table_get_instance(hlp, tmpfs_dentry_t,
  388.         dh_link);
  389.  
  390.     /*
  391.      * Receive the write request.
  392.      */
  393.     ipc_callid_t callid;
  394.     size_t len;
  395.     if (!ipc_data_write_receive(&callid, &len)) {
  396.         ipc_answer_0(callid, EINVAL);  
  397.         ipc_answer_0(rid, EINVAL);
  398.         return;
  399.     }
  400.  
  401.     /*
  402.      * Check whether the file needs to grow.
  403.      */
  404.     if (pos + len <= dentry->size) {
  405.         /* The file size is not changing. */
  406.         (void) ipc_data_write_finalize(callid, dentry->data + pos, len);
  407.         ipc_answer_2(rid, EOK, len, dentry->size);
  408.         return;
  409.     }
  410.     size_t delta = (pos + len) - dentry->size;
  411.     /*
  412.      * At this point, we are deliberately extremely straightforward and
  413.      * simply realloc the contents of the file on every write that grows the
  414.      * file. In the end, the situation might not be as bad as it may look:
  415.      * our heap allocator can save us and just grow the block whenever
  416.      * possible.
  417.      */
  418.     void *newdata = realloc(dentry->data, dentry->size + delta);
  419.     if (!newdata) {
  420.         ipc_answer_0(callid, ENOMEM);
  421.         ipc_answer_2(rid, EOK, 0, dentry->size);
  422.         return;
  423.     }
  424.     /* Clear any newly allocated memory in order to emulate gaps. */
  425.     memset(newdata + dentry->size, 0, delta);
  426.     dentry->size += delta;
  427.     dentry->data = newdata;
  428.     (void) ipc_data_write_finalize(callid, dentry->data + pos, len);
  429.     ipc_answer_2(rid, EOK, len, dentry->size);
  430. }
  431.  
  432. void tmpfs_truncate(ipc_callid_t rid, ipc_call_t *request)
  433. {
  434.     int dev_handle = IPC_GET_ARG1(*request);
  435.     unsigned long index = IPC_GET_ARG2(*request);
  436.     size_t size = IPC_GET_ARG3(*request);
  437.  
  438.     /*
  439.      * Lookup the respective dentry.
  440.      */
  441.     link_t *hlp;
  442.     hlp = hash_table_find(&dentries, &index);
  443.     if (!hlp) {
  444.         ipc_answer_0(rid, ENOENT);
  445.         return;
  446.     }
  447.     tmpfs_dentry_t *dentry = hash_table_get_instance(hlp, tmpfs_dentry_t,
  448.         dh_link);
  449.  
  450.     if (size == dentry->size) {
  451.         ipc_answer_0(rid, EOK);
  452.         return;
  453.     }
  454.  
  455.     void *newdata = realloc(dentry->data, size);
  456.     if (!newdata) {
  457.         ipc_answer_0(rid, ENOMEM);
  458.         return;
  459.     }
  460.     if (size > dentry->size) {
  461.         size_t delta = size - dentry->size;
  462.         memset(newdata + dentry->size, 0, delta);
  463.     }
  464.     dentry->size = size;
  465.     dentry->data = newdata;
  466.     ipc_answer_0(rid, EOK);
  467. }
  468.  
  469. void tmpfs_destroy(ipc_callid_t rid, ipc_call_t *request)
  470. {
  471.     int dev_handle = IPC_GET_ARG1(*request);
  472.     unsigned long index = IPC_GET_ARG2(*request);
  473.  
  474.     link_t *hlp;
  475.     hlp = hash_table_find(&dentries, &index);
  476.     if (!hlp) {
  477.         ipc_answer_0(rid, ENOENT);
  478.         return;
  479.     }
  480.     tmpfs_dentry_t *dentry = hash_table_get_instance(hlp, tmpfs_dentry_t,
  481.         dh_link);
  482.     tmpfs_destroy_node(dentry);
  483.     ipc_answer_0(rid, EOK);
  484. }
  485.  
  486. /**
  487.  * @}
  488.  */
  489.