Whamcloud - gitweb
LU-181 obdclass: fix portal_handle memory wastage
[fs/lustre-release.git] / lustre / include / lustre_export.h
index b319457..b424358 100644 (file)
@@ -1,6 +1,4 @@
-/* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
- * vim:expandtab:shiftwidth=8:tabstop=8:
- *
+/*
  * GPL HEADER START
  *
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  * GPL HEADER END
  */
 /*
- * Copyright  2008 Sun Microsystems, Inc. All rights reserved
+ * Copyright (c) 2002, 2010, Oracle and/or its affiliates. All rights reserved.
  * Use is subject to license terms.
+ *
+ * Copyright (c) 2011, 2012, Whamcloud, Inc.
  */
 /*
  * This file is part of Lustre, http://www.lustre.org/
  * Lustre is a trademark of Sun Microsystems, Inc.
  */
+/** \defgroup obd_export PortalRPC export definitions
+ *
+ * @{
+ */
 
 #ifndef __EXPORT_H
 #define __EXPORT_H
 
+/** \defgroup export export
+ *
+ * @{
+ */
+
 #include <lprocfs_status.h>
 #include <lustre/lustre_idl.h>
 #include <lustre_dlm.h>
@@ -46,31 +55,34 @@ struct mdt_client_data;
 struct mds_idmap_table;
 struct mdt_idmap_table;
 
-struct lu_export_data {
+/**
+ * Target-specific export data
+ */
+struct tg_export_data {
         /** Protects led_lcd below */
-        cfs_semaphore_t         led_lcd_lock;
+        cfs_mutex_t             ted_lcd_lock;
         /** Per-client data for each export */
-        struct lsd_client_data *led_lcd;
+        struct lsd_client_data *ted_lcd;
         /** Offset of record in last_rcvd file */
-        loff_t                  led_lr_off;
+        loff_t                  ted_lr_off;
         /** Client index in last_rcvd file */
-        int                     led_lr_idx;
+        int                     ted_lr_idx;
 };
 
+/**
+ * MDT-specific export data
+ */
 struct mdt_export_data {
-        struct lu_export_data   med_led;
+        struct tg_export_data   med_ted;
+        /** List of all files opened by client on this MDT */
         cfs_list_t              med_open_head;
         cfs_spinlock_t          med_open_lock; /* lock med_open_head, mfd_list*/
+        /** Bitmask of all ibit locks this MDT understands */
         __u64                   med_ibits_known;
-        cfs_semaphore_t         med_idmap_sem;
+        cfs_mutex_t             med_idmap_mutex;
         struct lustre_idmap_table *med_idmap;
 };
 
-#define med_lcd_lock    med_led.led_lcd_lock
-#define med_lcd         med_led.led_lcd
-#define med_lr_off      med_led.led_lr_off
-#define med_lr_idx      med_led.led_lr_idx
-
 struct osc_creator {
         cfs_spinlock_t          oscc_lock;
         cfs_list_t              oscc_wait_create_list;
@@ -92,8 +104,9 @@ struct ec_export_data { /* echo client */
 };
 
 /* In-memory access to client data from OST struct */
+/** Filter (oss-side) specific import data */
 struct filter_export_data {
-        struct lu_export_data      fed_led;
+        struct tg_export_data      fed_ted;
         cfs_spinlock_t             fed_lock;     /**< protects fed_mod_list */
         long                       fed_dirty;    /* in bytes */
         long                       fed_grant;    /* in bytes */
@@ -103,11 +116,15 @@ struct filter_export_data {
         __u32                      fed_group;
 };
 
-#define fed_lcd_lock    fed_led.led_lcd_lock
-#define fed_lcd         fed_led.led_lcd
-#define fed_lr_off      fed_led.led_lr_off
-#define fed_lr_idx      fed_led.led_lr_idx
+struct mgs_export_data {
+        cfs_list_t                 med_clients; /* mgc fs client via this exp */
+        cfs_spinlock_t             med_lock;    /* protect med_clients */
+};
 
+/**
+ * per-NID statistics structure.
+ * It tracks access patterns to this export on a per-client-NID basis
+ */
 typedef struct nid_stat {
         lnet_nid_t               nid;
         cfs_hlist_node_t         nid_hash;
@@ -139,7 +156,19 @@ enum obd_option {
         OBD_OPT_ABORT_RECOV =   0x0004,
 };
 
+/**
+ * Export structure. Represents target-side of connection in portals.
+ * Also used in Lustre to connect between layers on the same node when
+ * there is no network-connection in-between.
+ * For every connected client there is an export structure on the server
+ * attached to the same obd device.
+ */
 struct obd_export {
+        /**
+         * Export handle, it's id is provided to client on connect
+         * Subsequent client RPCs contain this handle id to identify
+         * what export they are talking to.
+         */
         struct portals_handle     exp_handle;
         cfs_atomic_t              exp_refcount;
         /**
@@ -150,34 +179,57 @@ struct obd_export {
          */
         cfs_atomic_t              exp_rpc_count; /* RPC references */
         cfs_atomic_t              exp_cb_count; /* Commit callback references */
+       /** Number of queued replay requests to be processes */
+       cfs_atomic_t              exp_replay_count;
         cfs_atomic_t              exp_locks_count; /** Lock references */
 #if LUSTRE_TRACKS_LOCK_EXP_REFS
         cfs_list_t                exp_locks_list;
         cfs_spinlock_t            exp_locks_list_guard;
 #endif
-        cfs_atomic_t              exp_replay_count;
+        /** UUID of client connected to this export */
         struct obd_uuid           exp_client_uuid;
+        /** To link all exports on an obd device */
         cfs_list_t                exp_obd_chain;
-        cfs_hlist_node_t          exp_uuid_hash; /* uuid-export hash*/
-        cfs_hlist_node_t          exp_nid_hash; /* nid-export hash */
-        /* exp_obd_chain_timed fo ping evictor, protected by obd_dev_lock */
+        cfs_hlist_node_t          exp_uuid_hash; /** uuid-export hash*/
+        cfs_hlist_node_t          exp_nid_hash; /** nid-export hash */
+        /**
+         * All exports eligible for ping evictor are linked into a list
+         * through this field in "most time since last request on this export"
+         * order
+         * protected by obd_dev_lock
+         */
         cfs_list_t                exp_obd_chain_timed;
+        /** Obd device of this export */
         struct obd_device        *exp_obd;
-        struct obd_import        *exp_imp_reverse; /* to make RPCs backwards */
+        /** "reverse" import to send requests (e.g. from ldlm) back to client */
+        struct obd_import        *exp_imp_reverse;
         struct nid_stat          *exp_nid_stats;
         struct lprocfs_stats     *exp_md_stats;
+        /** Active connetion */
         struct ptlrpc_connection *exp_connection;
+        /** Connection count value from last succesful reconnect rpc */
         __u32                     exp_conn_cnt;
-        cfs_hash_t               *exp_lock_hash; /* existing lock hash */
-        cfs_spinlock_t            exp_lock_hash_lock;
+        /** Hash list of all ldlm locks granted on this export */
+        cfs_hash_t               *exp_lock_hash;
+        /** Lock protecting access to exp_flock_wait_list */
+        cfs_rwlock_t              exp_flock_wait_lock;
+        /**
+         * Wait queue for Posix lock deadlock detection, added with
+         * ldlm_lock::l_flock_waitq.
+         */
+        cfs_list_t                exp_flock_wait_list;
         cfs_list_t                exp_outstanding_replies;
         cfs_list_t                exp_uncommitted_replies;
         cfs_spinlock_t            exp_uncommitted_replies_lock;
+        /** Last committed transno for this export */
         __u64                     exp_last_committed;
+        /** When was last request received */
         cfs_time_t                exp_last_request_time;
+        /** On replay all requests waiting for replay are linked here */
         cfs_list_t                exp_req_replay_queue;
-        cfs_spinlock_t            exp_lock; /* protects flags int below */
-        /* ^ protects exp_outstanding_replies too */
+        /** protects exp_flags and exp_outstanding_replies */
+        cfs_spinlock_t            exp_lock;
+        /** Compatibility flags for this export */
         __u64                     exp_connect_flags;
         enum obd_option           exp_flags;
         unsigned long             exp_failed:1,
@@ -197,18 +249,27 @@ struct obd_export {
                                   /* client timed out and tried to reconnect,
                                    * but couldn't because of active rpcs */
                                   exp_abort_active_req:1;
-        cfs_list_t                exp_queued_rpc;  /* RPC to be handled */
         /* also protected by exp_lock */
         enum lustre_sec_part      exp_sp_peer;
         struct sptlrpc_flavor     exp_flvr;             /* current */
         struct sptlrpc_flavor     exp_flvr_old[2];      /* about-to-expire */
         cfs_time_t                exp_flvr_expire[2];   /* seconds */
 
+        /** protects exp_hp_rpcs */
+        cfs_spinlock_t            exp_rpc_lock;
+        cfs_list_t                exp_hp_rpcs;  /* (potential) HP RPCs */
+
+        /** blocking dlm lock list, protected by exp_bl_list_lock */
+        cfs_list_t                exp_bl_list;
+        cfs_spinlock_t            exp_bl_list_lock;
+
+        /** Target specific data */
         union {
-                struct lu_export_data     eu_target_data;
+                struct tg_export_data     eu_target_data;
                 struct mdt_export_data    eu_mdt_data;
                 struct filter_export_data eu_filter_data;
                 struct ec_export_data     eu_ec_data;
+                struct mgs_export_data    eu_mgs_data;
         } u;
 };
 
@@ -275,4 +336,7 @@ static inline int imp_connect_lru_resize(struct obd_import *imp)
 extern struct obd_export *class_conn2export(struct lustre_handle *conn);
 extern struct obd_device *class_conn2obd(struct lustre_handle *conn);
 
+/** @} export */
+
 #endif /* __EXPORT_H */
+/** @} obd_export */