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