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