fs/orangefs/orangefs-mod.c

   1 /*
   2  * (C) 2001 Clemson University and The University of Chicago
   3  *
   4  * Changes by Acxiom Corporation to add proc file handler for pvfs2 client
   5  * parameters, Copyright Acxiom Corporation, 2005.
   6  *
   7  * See COPYING in top-level directory.
   8  */
   9
  10 #include "protocol.h"
  11 #include "orangefs-kernel.h"
  12 #include "orangefs-debugfs.h"
  13 #include "orangefs-sysfs.h"
  14
  15 /* ORANGEFS_VERSION is a ./configure define */
  16 #ifndef ORANGEFS_VERSION
  17 #define ORANGEFS_VERSION "upstream"
  18 #endif
  19
  20 /*
  21  * global variables declared here
  22  */
  23
  24 /* array of client debug keyword/mask values */
  25 struct client_debug_mask *cdm_array;
  26 int cdm_element_count;
  27
  28 char kernel_debug_string[ORANGEFS_MAX_DEBUG_STRING_LEN] = "none";
  29 char client_debug_string[ORANGEFS_MAX_DEBUG_STRING_LEN];
  30 char client_debug_array_string[ORANGEFS_MAX_DEBUG_STRING_LEN];
  31
  32 char *debug_help_string;
  33 int help_string_initialized;
  34 struct dentry *help_file_dentry;
  35 struct dentry *client_debug_dentry;
  36 struct dentry *debug_dir;
  37 int client_verbose_index;
  38 int client_all_index;
  39 struct orangefs_stats g_orangefs_stats;
  40
  41 /* the size of the hash tables for ops in progress */
  42 int hash_table_size = 509;
  43
  44 static ulong module_parm_debug_mask;
  45 __u64 gossip_debug_mask;
  46 struct client_debug_mask client_debug_mask = { NULL, 0, 0 };
  47 unsigned int kernel_mask_set_mod_init; /* implicitly false */
  48 int op_timeout_secs = ORANGEFS_DEFAULT_OP_TIMEOUT_SECS;
  49 int slot_timeout_secs = ORANGEFS_DEFAULT_SLOT_TIMEOUT_SECS;
  50
  51 MODULE_LICENSE("GPL");
  52 MODULE_AUTHOR("ORANGEFS Development Team");
  53 MODULE_DESCRIPTION("The Linux Kernel VFS interface to ORANGEFS");
  54 MODULE_PARM_DESC(module_parm_debug_mask, "debugging level (see orangefs-debug.h for values)");
  55 MODULE_PARM_DESC(op_timeout_secs, "Operation timeout in seconds");
  56 MODULE_PARM_DESC(slot_timeout_secs, "Slot timeout in seconds");
  57 MODULE_PARM_DESC(hash_table_size,
  58                  "size of hash table for operations in progress");
  59
  60 static struct file_system_type orangefs_fs_type = {
  61         .name = "pvfs2",
  62         .mount = orangefs_mount,
  63         .kill_sb = orangefs_kill_sb,
  64         .owner = THIS_MODULE,
  65 };
  66
  67 module_param(hash_table_size, int, 0);
  68 module_param(module_parm_debug_mask, ulong, 0644);
  69 module_param(op_timeout_secs, int, 0);
  70 module_param(slot_timeout_secs, int, 0);
  71
  72 /* synchronizes the request device file */
  73 DEFINE_MUTEX(devreq_mutex);
  74
  75 /*
  76  * Blocks non-priority requests from being queued for servicing.  This
  77  * could be used for protecting the request list data structure, but
  78  * for now it's only being used to stall the op addition to the request
  79  * list
  80  */
  81 DEFINE_MUTEX(request_mutex);
  82
  83 /* hash table for storing operations waiting for matching downcall */
  84 struct list_head *htable_ops_in_progress;
  85 DEFINE_SPINLOCK(htable_ops_in_progress_lock);
  86
  87 /* list for queueing upcall operations */
  88 LIST_HEAD(orangefs_request_list);
  89
  90 /* used to protect the above orangefs_request_list */
  91 DEFINE_SPINLOCK(orangefs_request_list_lock);
  92
  93 /* used for incoming request notification */
  94 DECLARE_WAIT_QUEUE_HEAD(orangefs_request_list_waitq);
  95
  96 static int __init orangefs_init(void)
  97 {
  98         int ret = -1;
  99         __u32 i = 0;
 100
 101         /* convert input debug mask to a 64-bit unsigned integer */
 102         gossip_debug_mask = (unsigned long long) module_parm_debug_mask;
 103
 104         /*
 105          * set the kernel's gossip debug string; invalid mask values will
 106          * be ignored.
 107          */
 108         debug_mask_to_string(&gossip_debug_mask, 0);
 109
 110         /* remove any invalid values from the mask */
 111         debug_string_to_mask(kernel_debug_string, &gossip_debug_mask, 0);
 112
 113         /*
 114          * if the mask has a non-zero value, then indicate that the mask
 115          * was set when the kernel module was loaded.  The orangefs dev ioctl
 116          * command will look at this boolean to determine if the kernel's
 117          * debug mask should be overwritten when the client-core is started.
 118          */
 119         if (gossip_debug_mask != 0)
 120                 kernel_mask_set_mod_init = true;
 121
 122         /* print information message to the system log */
 123         pr_info("orangefs: orangefs_init called with debug mask: :%s: :%llx:\n",
 124                kernel_debug_string,
 125                (unsigned long long)gossip_debug_mask);
 126
 127         ret = bdi_init(&orangefs_backing_dev_info);
 128
 129         if (ret)
 130                 return ret;
 131
 132         if (op_timeout_secs < 0)
 133                 op_timeout_secs = 0;
 134
 135         if (slot_timeout_secs < 0)
 136                 slot_timeout_secs = 0;
 137
 138         /* initialize global book keeping data structures */
 139         ret = op_cache_initialize();
 140         if (ret < 0)
 141                 goto err;
 142
 143         ret = orangefs_inode_cache_initialize();
 144         if (ret < 0)
 145                 goto cleanup_op;
 146
 147         /* Initialize the orangefsdev subsystem. */
 148         ret = orangefs_dev_init();
 149         if (ret < 0) {
 150                 gossip_err("orangefs: could not initialize device subsystem %d!\n",
 151                            ret);
 152                 goto cleanup_inode;
 153         }
 154
 155         htable_ops_in_progress =
 156             kcalloc(hash_table_size, sizeof(struct list_head), GFP_KERNEL);
 157         if (!htable_ops_in_progress) {
 158                 gossip_err("Failed to initialize op hashtable");
 159                 ret = -ENOMEM;
 160                 goto cleanup_device;
 161         }
 162
 163         /* initialize a doubly linked at each hash table index */
 164         for (i = 0; i < hash_table_size; i++)
 165                 INIT_LIST_HEAD(&htable_ops_in_progress[i]);
 166
 167         ret = fsid_key_table_initialize();
 168         if (ret < 0)
 169                 goto cleanup_progress_table;
 170
 171         /*
 172          * Build the contents of /sys/kernel/debug/orangefs/debug-help
 173          * from the keywords in the kernel keyword/mask array.
 174          *
 175          * The keywords in the client keyword/mask array are
 176          * unknown at boot time.
 177          *
 178          * orangefs_prepare_debugfs_help_string will be used again
 179          * later to rebuild the debug-help file after the client starts
 180          * and passes along the needed info. The argument signifies
 181          * which time orangefs_prepare_debugfs_help_string is being
 182          * called.
 183          *
 184          */
 185         ret = orangefs_prepare_debugfs_help_string(1);
 186         if (ret)
 187                 goto out;
 188
 189         orangefs_debugfs_init();
 190         orangefs_kernel_debug_init();
 191         orangefs_sysfs_init();
 192
 193         ret = register_filesystem(&orangefs_fs_type);
 194         if (ret == 0) {
 195                 pr_info("orangefs: module version %s loaded\n", ORANGEFS_VERSION);
 196                 return 0;
 197         }
 198
 199         orangefs_debugfs_cleanup();
 200         orangefs_sysfs_exit();
 201         fsid_key_table_finalize();
 202
 203 cleanup_progress_table:
 204         kfree(htable_ops_in_progress);
 205
 206 cleanup_device:
 207         orangefs_dev_cleanup();
 208
 209 cleanup_inode:
 210         orangefs_inode_cache_finalize();
 211
 212 cleanup_op:
 213         op_cache_finalize();
 214
 215 err:
 216         bdi_destroy(&orangefs_backing_dev_info);
 217
 218 out:
 219         return ret;
 220 }
 221
 222 static void __exit orangefs_exit(void)
 223 {
 224         int i = 0;
 225         gossip_debug(GOSSIP_INIT_DEBUG, "orangefs: orangefs_exit called\n");
 226
 227         unregister_filesystem(&orangefs_fs_type);
 228         orangefs_debugfs_cleanup();
 229         orangefs_sysfs_exit();
 230         fsid_key_table_finalize();
 231         orangefs_dev_cleanup();
 232         BUG_ON(!list_empty(&orangefs_request_list));
 233         for (i = 0; i < hash_table_size; i++)
 234                 BUG_ON(!list_empty(&htable_ops_in_progress[i]));
 235
 236         orangefs_inode_cache_finalize();
 237         op_cache_finalize();
 238
 239         kfree(htable_ops_in_progress);
 240
 241         bdi_destroy(&orangefs_backing_dev_info);
 242
 243         pr_info("orangefs: module version %s unloaded\n", ORANGEFS_VERSION);
 244 }
 245
 246 /*
 247  * What we do in this function is to walk the list of operations
 248  * that are in progress in the hash table and mark them as purged as well.
 249  */
 250 void purge_inprogress_ops(void)
 251 {
 252         int i;
 253
 254         for (i = 0; i < hash_table_size; i++) {
 255                 struct orangefs_kernel_op_s *op;
 256                 struct orangefs_kernel_op_s *next;
 257
 258                 spin_lock(&htable_ops_in_progress_lock);
 259                 list_for_each_entry_safe(op,
 260                                          next,
 261                                          &htable_ops_in_progress[i],
 262                                          list) {
 263                         spin_lock(&op->lock);
 264                         gossip_debug(GOSSIP_INIT_DEBUG,
 265                                 "pvfs2-client-core: purging in-progress op tag "
 266                                 "%llu %s\n",
 267                                 llu(op->tag),
 268                                 get_opname_string(op));
 269                         set_op_state_purged(op);
 270                         spin_unlock(&op->lock);
 271                 }
 272                 spin_unlock(&htable_ops_in_progress_lock);
 273         }
 274 }
 275
 276 module_init(orangefs_init);
 277 module_exit(orangefs_exit);