Whamcloud - gitweb
b=16098
[fs/lustre-release.git] / 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 static inline char * ptlrpc_import_state_name(enum lustre_imp_state state)
73 {
74         static char* import_state_names[] = {
75                 "<UNKNOWN>", "CLOSED",  "NEW", "DISCONN",
76                 "CONNECTING", "REPLAY", "REPLAY_LOCKS", "REPLAY_WAIT",
77                 "RECOVER", "FULL", "EVICTED",
78         };
79
80         LASSERT (state <= LUSTRE_IMP_EVICTED);
81         return import_state_names[state];
82 }
83
84 enum obd_import_event {
85         IMP_EVENT_DISCON     = 0x808001,
86         IMP_EVENT_INACTIVE   = 0x808002,
87         IMP_EVENT_INVALIDATE = 0x808003,
88         IMP_EVENT_ACTIVE     = 0x808004,
89         IMP_EVENT_OCD        = 0x808005,
90 };
91
92 struct obd_import_conn {
93         struct list_head          oic_item;
94         struct ptlrpc_connection *oic_conn;
95         struct obd_uuid           oic_uuid;
96         __u64                     oic_last_attempt; /* jiffies, 64-bit */
97 };
98
99 #define IMP_AT_MAX_PORTALS 8
100 struct imp_at {
101         int                     iat_portal[IMP_AT_MAX_PORTALS];
102         struct adaptive_timeout iat_net_latency;
103         struct adaptive_timeout iat_service_estimate[IMP_AT_MAX_PORTALS];
104 };
105
106 struct obd_import {
107         struct portals_handle     imp_handle;
108         atomic_t                  imp_refcount;
109         struct lustre_handle      imp_dlm_handle; /* client's ldlm export */
110         struct ptlrpc_connection *imp_connection;
111         struct ptlrpc_client     *imp_client;
112         struct list_head          imp_pinger_chain;
113         struct list_head          imp_zombie_chain; /* queue for destruction */
114
115         /* Lists of requests that are retained for replay, waiting for a reply,
116          * or waiting for recovery to complete, respectively.
117          */
118         struct list_head          imp_replay_list;
119         struct list_head          imp_sending_list;
120         struct list_head          imp_delayed_list;
121
122         struct obd_device        *imp_obd;
123         struct ptlrpc_sec        *imp_sec;
124         struct semaphore          imp_sec_mutex;
125         cfs_time_t                imp_sec_expire;
126         cfs_waitq_t               imp_recovery_waitq;
127
128         atomic_t                  imp_inflight;
129         atomic_t                  imp_replay_inflight;
130         atomic_t                  imp_inval_count;
131         enum lustre_imp_state     imp_state;
132         int                       imp_generation;
133         __u32                     imp_conn_cnt;
134         int                       imp_last_generation_checked;
135         __u64                     imp_last_replay_transno;
136         __u64                     imp_peer_committed_transno;
137         __u64                     imp_last_transno_checked;
138         struct lustre_handle      imp_remote_handle;
139         cfs_time_t                imp_next_ping;   /* jiffies */
140         __u64                     imp_last_success_conn;   /* jiffies, 64-bit */
141
142         /* all available obd_import_conn linked here */
143         struct list_head          imp_conn_list;
144         struct obd_import_conn   *imp_conn_current;
145
146         /* Protects flags, level, generation, conn_cnt, *_list */
147         spinlock_t                imp_lock;
148
149         /* flags */
150         unsigned long             imp_no_timeout:1,       /* timeouts are disabled */
151                                   imp_invalid:1,          /* evicted */
152                                   imp_deactive:1,         /* administratively disabled */
153                                   imp_replayable:1,       /* try to recover the import */
154                                   imp_dlm_fake:1,         /* don't run recovery (timeout instead) */
155                                   imp_server_timeout:1,   /* use 1/2 timeout on MDS' OSCs */
156                                   imp_initial_recov:1,    /* retry the initial connection */  
157                                   imp_initial_recov_bk:1, /* turn off init_recov after trying all failover nids */
158                                   imp_force_verify:1,     /* force an immidiate ping */
159                                   imp_pingable:1,         /* pingable */
160                                   imp_resend_replay:1,    /* resend for replay */
161                                   imp_recon_bk:1,         /* turn off reconnect if all failovers fail */
162                                   imp_last_recon:1;       /* internally used by above */
163         __u32                     imp_connect_op;
164         struct obd_connect_data   imp_connect_data;
165         __u64                     imp_connect_flags_orig;
166         int                       imp_connect_error;
167
168         __u32                     imp_msg_magic;
169         __u32                     imp_msghdr_flags;       /* adjusted based on server capability */
170
171         struct ptlrpc_request_pool *imp_rq_pool;          /* emergency request pool */
172
173         struct imp_at             imp_at;                 /* adaptive timeout data */
174         time_t                    imp_last_reply_time;    /* for health check */
175 };
176
177 typedef void (*obd_import_callback)(struct obd_import *imp, void *closure,
178                                     int event, void *event_arg, void *cb_data);
179
180 struct obd_import_observer {
181         struct list_head     oio_chain;
182         obd_import_callback  oio_cb;
183         void                *oio_cb_data;
184 };
185
186 void class_observe_import(struct obd_import *imp, obd_import_callback cb,
187                           void *cb_data);
188 void class_unobserve_import(struct obd_import *imp, obd_import_callback cb,
189                             void *cb_data);
190 void class_notify_import_observers(struct obd_import *imp, int event,
191                                    void *event_arg);
192
193 /* import.c */
194 static inline void at_init(struct adaptive_timeout *at, int val, int flags) {
195         memset(at, 0, sizeof(*at));
196         at->at_current = val;
197         at->at_worst_ever = val;
198         at->at_worst_time = cfs_time_current_sec();
199         at->at_flags = flags;
200         spin_lock_init(&at->at_lock);
201 }
202 static inline int at_get(struct adaptive_timeout *at) {
203         return at->at_current;
204 }
205 int at_add(struct adaptive_timeout *at, unsigned int val);
206 int import_at_get_index(struct obd_import *imp, int portal);
207 extern unsigned int at_max;
208 #define AT_OFF (at_max == 0)
209
210 /* genops.c */
211 struct obd_export;
212 extern struct obd_import *class_exp2cliimp(struct obd_export *);
213 extern struct obd_import *class_conn2cliimp(struct lustre_handle *);
214
215 #endif /* __IMPORT_H */