lustre/include/lustre_import.h

   1 /*
   2  * GPL HEADER START
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License version 2 only,
   8  * as published by the Free Software Foundation.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * General Public License version 2 for more details (a copy is included
  14  * in the LICENSE file that accompanied this code).
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * version 2 along with this program; If not, see
  18  * http://www.gnu.org/licenses/gpl-2.0.html
  19  *
  20  * GPL HEADER END
  21  */
  22 /*
  23  * Copyright (c) 2002, 2010, Oracle and/or its affiliates. All rights reserved.
  24  * Use is subject to license terms.
  25  *
  26  * Copyright (c) 2011, 2016, Intel Corporation.
  27  */
  28 /*
  29  * This file is part of Lustre, http://www.lustre.org/
  30  * Lustre is a trademark of Sun Microsystems, Inc.
  31  */
  32 /** \defgroup obd_import PtlRPC import definitions
  33  * Imports are client-side representation of remote obd target.
  34  *
  35  * @{
  36  */
  37
  38 #ifndef __IMPORT_H
  39 #define __IMPORT_H
  40
  41 /** \defgroup export export
  42  *
  43  * @{
  44  */
  45 #include <linux/workqueue.h>
  46
  47 #include <lustre_handles.h>
  48 #include <uapi/linux/lustre/lustre_idl.h>
  49
  50 /**
  51  * Adaptive Timeout stuff
  52  *
  53  * @{
  54  */
  55 #define D_ADAPTTO D_OTHER
  56 #define AT_BINS 4                  /* "bin" means "N seconds of history" */
  57 #define AT_FLG_NOHIST 0x1          /* use last reported value only */
  58
  59 struct adaptive_timeout {
  60         time64_t        at_binstart;         /* bin start time */
  61         unsigned int    at_hist[AT_BINS];    /* timeout history bins */
  62         unsigned int    at_flags;
  63         unsigned int    at_current;          /* current timeout value */
  64         unsigned int    at_worst_ever;       /* worst-ever timeout value */
  65         time64_t        at_worst_time;       /* worst-ever timeout timestamp */
  66         spinlock_t      at_lock;
  67 };
  68
  69 enum lustre_at_flags {
  70         LATF_SKIP       = 0x0,
  71         LATF_STATS      = 0x1,
  72 };
  73
  74 struct ptlrpc_at_array {
  75         struct list_head *paa_reqs_array; /** array to hold requests */
  76         __u32             paa_size;       /** the size of array */
  77         __u32             paa_count;      /** the total count of reqs */
  78         time64_t          paa_deadline;   /** the earliest deadline of reqs */
  79         __u32            *paa_reqs_count; /** the count of reqs in each entry */
  80 };
  81
  82 #define IMP_AT_MAX_PORTALS 8
  83 struct imp_at {
  84         int                     iat_portal[IMP_AT_MAX_PORTALS];
  85         struct adaptive_timeout iat_net_latency;
  86         struct adaptive_timeout iat_service_estimate[IMP_AT_MAX_PORTALS];
  87 };
  88
  89
  90 /** @} */
  91
  92 /** Possible import states */
  93 enum lustre_imp_state {
  94         LUSTRE_IMP_CLOSED     = 1,
  95         LUSTRE_IMP_NEW        = 2,
  96         LUSTRE_IMP_DISCON     = 3,
  97         LUSTRE_IMP_CONNECTING = 4,
  98         LUSTRE_IMP_REPLAY     = 5,
  99         LUSTRE_IMP_REPLAY_LOCKS = 6,
 100         LUSTRE_IMP_REPLAY_WAIT  = 7,
 101         LUSTRE_IMP_RECOVER    = 8,
 102         LUSTRE_IMP_FULL       = 9,
 103         LUSTRE_IMP_EVICTED    = 10,
 104 };
 105
 106 /** Returns test string representation of numeric import state \a state */
 107 static inline char * ptlrpc_import_state_name(enum lustre_imp_state state)
 108 {
 109         static char* import_state_names[] = {
 110                 "<UNKNOWN>", "CLOSED",  "NEW", "DISCONN",
 111                 "CONNECTING", "REPLAY", "REPLAY_LOCKS", "REPLAY_WAIT",
 112                 "RECOVER", "FULL", "EVICTED",
 113         };
 114
 115         LASSERT (state <= LUSTRE_IMP_EVICTED);
 116         return import_state_names[state];
 117 }
 118
 119 /**
 120  * List of import event types
 121  */
 122 enum obd_import_event {
 123         IMP_EVENT_DISCON     = 0x808001,
 124         IMP_EVENT_INACTIVE   = 0x808002,
 125         IMP_EVENT_INVALIDATE = 0x808003,
 126         IMP_EVENT_ACTIVE     = 0x808004,
 127         IMP_EVENT_OCD        = 0x808005,
 128         IMP_EVENT_DEACTIVATE = 0x808006,
 129         IMP_EVENT_ACTIVATE   = 0x808007,
 130 };
 131
 132 /**
 133  * Definition of import connection structure
 134  */
 135 struct obd_import_conn {
 136         /** Item for linking connections together */
 137         struct list_head          oic_item;
 138         /** Pointer to actual PortalRPC connection */
 139         struct ptlrpc_connection *oic_conn;
 140         /** uuid of remote side */
 141         struct obd_uuid           oic_uuid;
 142         /**
 143          * Time (64 bit seconds) of last connection attempt on this connection
 144          */
 145         time64_t                  oic_last_attempt;
 146 };
 147
 148 /* state history */
 149 #define IMP_STATE_HIST_LEN 16
 150 struct import_state_hist {
 151         enum lustre_imp_state   ish_state;
 152         time64_t                ish_time;
 153 };
 154
 155 /**
 156  * Defintion of PortalRPC import structure.
 157  * Imports are representing client-side view to remote target.
 158  */
 159 struct obd_import {
 160         /** Local handle (== id) for this import. */
 161         struct portals_handle     imp_handle;
 162         /** Reference counter */
 163         atomic_t                  imp_refcount;
 164         struct lustre_handle      imp_dlm_handle; /* client's ldlm export */
 165         /** Currently active connection */
 166         struct ptlrpc_connection *imp_connection;
 167         /** PortalRPC client structure for this import */
 168         struct ptlrpc_client     *imp_client;
 169         /** List element for linking into pinger chain */
 170         struct list_head          imp_pinger_chain;
 171         /** work struct for destruction of import */
 172         struct work_struct        imp_zombie_work;
 173
 174         /**
 175          * Lists of requests that are retained for replay, waiting for a reply,
 176          * or waiting for recovery to complete, respectively.
 177          * @{
 178          */
 179         struct list_head        imp_replay_list;
 180         struct list_head        imp_sending_list;
 181         struct list_head        imp_delayed_list;
 182         /** @} */
 183
 184         /**
 185          * List of requests that are retained for committed open replay. Once
 186          * open is committed, open replay request will be moved from the
 187          * imp_replay_list into the imp_committed_list.
 188          * The imp_replay_cursor is for accelerating searching during replay.
 189          * @{
 190          */
 191         struct list_head        imp_committed_list;
 192         struct list_head        *imp_replay_cursor;
 193         /** @} */
 194
 195         /** List of not replied requests */
 196         struct list_head        imp_unreplied_list;
 197         /** Known maximal replied XID */
 198         __u64                   imp_known_replied_xid;
 199
 200         /** obd device for this import */
 201         struct obd_device       *imp_obd;
 202
 203         /**
 204          * some seciruty-related fields
 205          * @{
 206          */
 207         struct ptlrpc_sec        *imp_sec;
 208         struct mutex              imp_sec_mutex;
 209         time64_t                imp_sec_expire;
 210         pid_t                     imp_sec_refpid;
 211         /** @} */
 212
 213         /** Wait queue for those who need to wait for recovery completion */
 214         wait_queue_head_t         imp_recovery_waitq;
 215
 216         /** Number of requests currently in-flight */
 217         atomic_t                  imp_inflight;
 218         /** Number of requests currently unregistering */
 219         atomic_t                  imp_unregistering;
 220         /** Number of replay requests inflight */
 221         atomic_t                  imp_replay_inflight;
 222         /** Number of currently happening import invalidations */
 223         atomic_t                  imp_inval_count;
 224         /** Numbner of request timeouts */
 225         atomic_t                  imp_timeouts;
 226         /** Current import state */
 227         enum lustre_imp_state     imp_state;
 228         /** Last replay state */
 229         enum lustre_imp_state     imp_replay_state;
 230         /** History of import states */
 231         struct import_state_hist  imp_state_hist[IMP_STATE_HIST_LEN];
 232         int                       imp_state_hist_idx;
 233         /** Current import generation. Incremented on every reconnect */
 234         int                       imp_generation;
 235         /** Incremented every time we send reconnection request */
 236         __u32                     imp_conn_cnt;
 237        /**
 238         * \see ptlrpc_free_committed remembers imp_generation value here
 239         * after a check to save on unnecessary replay list iterations
 240         */
 241         int                       imp_last_generation_checked;
 242         /** Last tranno we replayed */
 243         __u64                     imp_last_replay_transno;
 244         /** Last transno committed on remote side */
 245         __u64                     imp_peer_committed_transno;
 246         /**
 247          * \see ptlrpc_free_committed remembers last_transno since its last
 248          * check here and if last_transno did not change since last run of
 249          * ptlrpc_free_committed and import generation is the same, we can
 250          * skip looking for requests to remove from replay list as optimisation
 251          */
 252         __u64                     imp_last_transno_checked;
 253         /**
 254          * Remote export handle. This is how remote side knows what export
 255          * we are talking to. Filled from response to connect request
 256          */
 257         struct lustre_handle      imp_remote_handle;
 258         /** When to perform next ping. time in jiffies. */
 259         time64_t                imp_next_ping;
 260         /** When we last successfully connected. time in 64bit jiffies */
 261         time64_t                imp_last_success_conn;
 262
 263         /** List of all possible connection for import. */
 264         struct list_head        imp_conn_list;
 265         /**
 266          * Current connection. \a imp_connection is imp_conn_current->oic_conn
 267          */
 268         struct obd_import_conn   *imp_conn_current;
 269
 270         /** Protects flags, level, generation, conn_cnt, *_list */
 271         spinlock_t                imp_lock;
 272
 273         /* flags */
 274         unsigned long             imp_no_timeout:1, /* timeouts are disabled */
 275                                   imp_invalid:1,    /* evicted */
 276                                   /* administratively disabled */
 277                                   imp_deactive:1,
 278                                   /* try to recover the import */
 279                                   imp_replayable:1,
 280                                   /* don't run recovery (timeout instead) */
 281                                   imp_dlm_fake:1,
 282                                   /* use 1/2 timeout on MDS' OSCs */
 283                                   imp_server_timeout:1,
 284                                   /* VBR: imp in delayed recovery */
 285                                   imp_delayed_recovery:1,
 286                                   /* recovery by versions was failed */
 287                                   imp_vbr_failed:1,
 288                                   /* force an immidiate ping */
 289                                   imp_force_verify:1,
 290                                   /* force a scheduled ping */
 291                                   imp_force_next_verify:1,
 292                                   /* pingable */
 293                                   imp_pingable:1,
 294                                   /* resend for replay */
 295                                   imp_resend_replay:1,
 296                                   /* disable normal recovery, for test only. */
 297                                   imp_no_pinger_recover:1,
 298 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(3, 0, 53, 0)
 299                                   /* need IR MNE swab */
 300                                   imp_need_mne_swab:1,
 301 #endif
 302                                   /* import must be reconnected instead of
 303                                    * chouse new connection */
 304                                   imp_force_reconnect:1,
 305                                   /* import has tried to connect with server */
 306                                   imp_connect_tried:1,
 307                                   /* connected but not FULL yet */
 308                                   imp_connected:1;
 309         __u32                     imp_connect_op;
 310         struct obd_connect_data   imp_connect_data;
 311         __u64                     imp_connect_flags_orig;
 312         __u64                     imp_connect_flags2_orig;
 313         int                       imp_connect_error;
 314
 315         enum lustre_msg_magic   imp_msg_magic;
 316                                 /* adjusted based on server capability */
 317         enum lustre_msghdr      imp_msghdr_flags;
 318
 319                                 /* adaptive timeout data */
 320         struct imp_at           imp_at;
 321         time64_t                imp_last_reply_time;    /* for health check */
 322 };
 323
 324 /* import.c */
 325 static inline unsigned int at_est2timeout(unsigned int val)
 326 {
 327         /* add an arbitrary minimum: 125% +5 sec */
 328         return (val + (val >> 2) + 5);
 329 }
 330
 331 static inline unsigned int at_timeout2est(unsigned int val)
 332 {
 333         /* restore estimate value from timeout: e=4/5(t-5) */
 334         LASSERT(val);
 335         return (max((val << 2) / 5, 5U) - 4);
 336 }
 337
 338 static inline void at_reset_nolock(struct adaptive_timeout *at, int val)
 339 {
 340         at->at_current = val;
 341         at->at_worst_ever = val;
 342         at->at_worst_time = ktime_get_real_seconds();
 343 }
 344
 345 static inline void at_reset(struct adaptive_timeout *at, int val)
 346 {
 347         spin_lock(&at->at_lock);
 348         at_reset_nolock(at, val);
 349         spin_unlock(&at->at_lock);
 350 }
 351
 352 static inline void at_init(struct adaptive_timeout *at, int val, int flags) {
 353         memset(at, 0, sizeof(*at));
 354         spin_lock_init(&at->at_lock);
 355         at->at_flags = flags;
 356         at_reset(at, val);
 357 }
 358
 359 static inline void at_reinit(struct adaptive_timeout *at, int val, int flags)
 360 {
 361         spin_lock(&at->at_lock);
 362         at->at_binstart = 0;
 363         memset(at->at_hist, 0, sizeof(at->at_hist));
 364         at->at_flags = flags;
 365         at_reset_nolock(at, val);
 366         spin_unlock(&at->at_lock);
 367 }
 368
 369 extern unsigned int at_min;
 370 static inline int at_get(struct adaptive_timeout *at) {
 371         return (at->at_current > at_min) ? at->at_current : at_min;
 372 }
 373 int at_measured(struct adaptive_timeout *at, unsigned int val);
 374 int import_at_get_index(struct obd_import *imp, int portal);
 375 extern unsigned int at_max;
 376 #define AT_OFF (at_max == 0)
 377
 378 /* genops.c */
 379 struct obd_export;
 380 extern struct obd_import *class_exp2cliimp(struct obd_export *);
 381 extern struct obd_import *class_conn2cliimp(struct lustre_handle *);
 382
 383 /** @} import */
 384
 385 #endif /* __IMPORT_H */
 386
 387 /** @} obd_import */