lustre/include/lustre_import.h

   1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
   2  * vim:expandtab:shiftwidth=8:tabstop=8:
   3  *
   4  * GPL HEADER START
   5  *
   6  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License version 2 only,
  10  * as published by the Free Software Foundation.
  11  *
  12  * This program is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * General Public License version 2 for more details (a copy is included
  16  * in the LICENSE file that accompanied this code).
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * version 2 along with this program; If not, see
  20  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
  21  *
  22  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  23  * CA 95054 USA or visit www.sun.com if you need additional information or
  24  * have any questions.
  25  *
  26  * GPL HEADER END
  27  */
  28 /*
  29  * Copyright  2008 Sun Microsystems, Inc. All rights reserved
  30  * Use is subject to license terms.
  31  */
  32 /*
  33  * This file is part of Lustre, http://www.lustre.org/
  34  * Lustre is a trademark of Sun Microsystems, Inc.
  35  */
  36
  37 #ifndef __IMPORT_H
  38 #define __IMPORT_H
  39
  40 #include <lustre_handles.h>
  41 #include <lustre/lustre_idl.h>
  42
  43
  44 /* Adaptive Timeout stuff */
  45 #define D_ADAPTTO D_OTHER
  46 #define AT_BINS 4                  /* "bin" means "N seconds of history" */
  47 #define AT_FLG_NOHIST 0x1          /* use last reported value only */
  48
  49 struct adaptive_timeout {
  50         time_t       at_binstart;         /* bin start time */
  51         unsigned int at_hist[AT_BINS];    /* timeout history bins */
  52         unsigned int at_flags;
  53         unsigned int at_current;          /* current timeout value */
  54         unsigned int at_worst_ever;       /* worst-ever timeout value */
  55         time_t       at_worst_time;       /* worst-ever timeout timestamp */
  56         spinlock_t   at_lock;
  57 };
  58
  59 enum lustre_imp_state {
  60         LUSTRE_IMP_CLOSED     = 1,
  61         LUSTRE_IMP_NEW        = 2,
  62         LUSTRE_IMP_DISCON     = 3,
  63         LUSTRE_IMP_CONNECTING = 4,
  64         LUSTRE_IMP_REPLAY     = 5,
  65         LUSTRE_IMP_REPLAY_LOCKS = 6,
  66         LUSTRE_IMP_REPLAY_WAIT  = 7,
  67         LUSTRE_IMP_RECOVER    = 8,
  68         LUSTRE_IMP_FULL       = 9,
  69         LUSTRE_IMP_EVICTED    = 10,
  70 };
  71
  72 struct ptlrpc_at_array {
  73         struct list_head *paa_reqs_array; /* array to hold requests */
  74         __u32             paa_size;       /* the size of array */
  75         __u32             paa_count;      /* the total count of reqs */
  76         time_t            paa_deadline;   /* the earliest deadline of reqs */
  77         __u32            *paa_reqs_count; /* the count of reqs in each entry */
  78 };
  79
  80 static inline char * ptlrpc_import_state_name(enum lustre_imp_state state)
  81 {
  82         static char* import_state_names[] = {
  83                 "<UNKNOWN>", "CLOSED",  "NEW", "DISCONN",
  84                 "CONNECTING", "REPLAY", "REPLAY_LOCKS", "REPLAY_WAIT",
  85                 "RECOVER", "FULL", "EVICTED",
  86         };
  87
  88         LASSERT (state <= LUSTRE_IMP_EVICTED);
  89         return import_state_names[state];
  90 }
  91
  92 enum obd_import_event {
  93         IMP_EVENT_DISCON     = 0x808001,
  94         IMP_EVENT_INACTIVE   = 0x808002,
  95         IMP_EVENT_INVALIDATE = 0x808003,
  96         IMP_EVENT_ACTIVE     = 0x808004,
  97         IMP_EVENT_OCD        = 0x808005,
  98 };
  99
 100 struct obd_import_conn {
 101         struct list_head          oic_item;
 102         struct ptlrpc_connection *oic_conn;
 103         struct obd_uuid           oic_uuid;
 104         __u64                     oic_last_attempt; /* jiffies, 64-bit */
 105 };
 106
 107 #define IMP_AT_MAX_PORTALS 8
 108 struct imp_at {
 109         int                     iat_portal[IMP_AT_MAX_PORTALS];
 110         struct adaptive_timeout iat_net_latency;
 111         struct adaptive_timeout iat_service_estimate[IMP_AT_MAX_PORTALS];
 112 };
 113
 114 /* state history */
 115 #define IMP_STATE_HIST_LEN 16
 116 struct import_state_hist {
 117         enum lustre_imp_state ish_state;
 118         time_t                ish_time;
 119 };
 120
 121 struct obd_import {
 122         struct portals_handle     imp_handle;
 123         atomic_t                  imp_refcount;
 124         struct lustre_handle      imp_dlm_handle; /* client's ldlm export */
 125         struct ptlrpc_connection *imp_connection;
 126         struct ptlrpc_client     *imp_client;
 127         struct list_head          imp_pinger_chain;
 128         struct list_head          imp_zombie_chain; /* queue for destruction */
 129
 130         /* Lists of requests that are retained for replay, waiting for a reply,
 131          * or waiting for recovery to complete, respectively.
 132          */
 133         struct list_head          imp_replay_list;
 134         struct list_head          imp_sending_list;
 135         struct list_head          imp_delayed_list;
 136
 137         struct obd_device        *imp_obd;
 138         struct ptlrpc_sec        *imp_sec;
 139         struct semaphore          imp_sec_mutex;
 140         cfs_time_t                imp_sec_expire;
 141         cfs_waitq_t               imp_recovery_waitq;
 142
 143         atomic_t                  imp_inflight;
 144         atomic_t                  imp_unregistering;
 145         atomic_t                  imp_replay_inflight;
 146         atomic_t                  imp_inval_count;  /* in-progress invalidations */
 147         atomic_t                  imp_timeouts;
 148         enum lustre_imp_state     imp_state;
 149         struct import_state_hist  imp_state_hist[IMP_STATE_HIST_LEN];
 150         int                       imp_state_hist_idx;
 151         int                       imp_generation;
 152         __u32                     imp_conn_cnt;
 153         int                       imp_last_generation_checked;
 154         __u64                     imp_last_replay_transno;
 155         __u64                     imp_peer_committed_transno;
 156         __u64                     imp_last_transno_checked;
 157         struct lustre_handle      imp_remote_handle;
 158         cfs_time_t                imp_next_ping;   /* jiffies */
 159         __u64                     imp_last_success_conn;   /* jiffies, 64-bit */
 160
 161         /* all available obd_import_conn linked here */
 162         struct list_head          imp_conn_list;
 163         struct obd_import_conn   *imp_conn_current;
 164
 165         /* Protects flags, level, generation, conn_cnt, *_list */
 166         spinlock_t                imp_lock;
 167
 168         /* flags */
 169         unsigned long             imp_no_timeout:1,       /* timeouts are disabled */
 170                                   imp_invalid:1,          /* evicted */
 171                                   imp_deactive:1,         /* administratively disabled */
 172                                   imp_replayable:1,       /* try to recover the import */
 173                                   imp_dlm_fake:1,         /* don't run recovery (timeout instead) */
 174                                   imp_server_timeout:1,   /* use 1/2 timeout on MDS' OSCs */
 175                                   imp_initial_recov:1,    /* retry the initial connection */
 176                                   imp_initial_recov_bk:1, /* turn off init_recov after trying all failover nids */
 177                                   imp_delayed_recovery:1, /* VBR: imp in delayed recovery */
 178                                   imp_no_lock_replay:1,   /* VBR: if gap was found then no lock replays */
 179                                   imp_vbr_failed:1,       /* recovery by versions was failed */
 180                                   imp_force_verify:1,     /* force an immidiate ping */
 181                                   imp_pingable:1,         /* pingable */
 182                                   imp_resend_replay:1,    /* resend for replay */
 183                                   imp_recon_bk:1,         /* turn off reconnect if all failovers fail */
 184                                   imp_last_recon:1;       /* internally used by above */
 185         __u32                     imp_connect_op;
 186         struct obd_connect_data   imp_connect_data;
 187         __u64                     imp_connect_flags_orig;
 188         int                       imp_connect_error;
 189
 190         __u32                     imp_msg_magic;
 191         __u32                     imp_msghdr_flags;       /* adjusted based on server capability */
 192
 193         struct ptlrpc_request_pool *imp_rq_pool;          /* emergency request pool */
 194
 195         struct imp_at             imp_at;                 /* adaptive timeout data */
 196         time_t                    imp_last_reply_time;    /* for health check */
 197 };
 198
 199 typedef void (*obd_import_callback)(struct obd_import *imp, void *closure,
 200                                     int event, void *event_arg, void *cb_data);
 201
 202 struct obd_import_observer {
 203         struct list_head     oio_chain;
 204         obd_import_callback  oio_cb;
 205         void                *oio_cb_data;
 206 };
 207
 208 void class_observe_import(struct obd_import *imp, obd_import_callback cb,
 209                           void *cb_data);
 210 void class_unobserve_import(struct obd_import *imp, obd_import_callback cb,
 211                             void *cb_data);
 212 void class_notify_import_observers(struct obd_import *imp, int event,
 213                                    void *event_arg);
 214
 215 /* import.c */
 216 static inline unsigned int at_est2timeout(unsigned int val)
 217 {
 218         /* add an arbitrary minimum: 125% +5 sec */
 219         return (val + (val >> 2) + 5);
 220 }
 221
 222 static inline unsigned int at_timeout2est(unsigned int val)
 223 {
 224         /* restore estimate value from timeout: e=4/5(t-5) */
 225         LASSERT(val);
 226         return (max((val << 2) / 5, 5U) - 4);
 227 }
 228
 229 static inline void at_init(struct adaptive_timeout *at, int val, int flags) {
 230         memset(at, 0, sizeof(*at));
 231         at->at_current = val;
 232         at->at_worst_ever = val;
 233         at->at_worst_time = cfs_time_current_sec();
 234         at->at_flags = flags;
 235         spin_lock_init(&at->at_lock);
 236 }
 237 static inline int at_get(struct adaptive_timeout *at) {
 238         return at->at_current;
 239 }
 240 int at_add(struct adaptive_timeout *at, unsigned int val);
 241 int import_at_get_index(struct obd_import *imp, int portal);
 242 extern unsigned int at_max;
 243 #define AT_OFF (at_max == 0)
 244
 245 /* genops.c */
 246 struct obd_export;
 247 extern struct obd_import *class_exp2cliimp(struct obd_export *);
 248 extern struct obd_import *class_conn2cliimp(struct lustre_handle *);
 249
 250 #endif /* __IMPORT_H */