lustre/ptlrpc/ptlrpc_internal.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.sun.com/software/products/lustre/docs/GPLv2.pdf
  19  *
  20  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  21  * CA 95054 USA or visit www.sun.com if you need additional information or
  22  * have any questions.
  23  *
  24  * GPL HEADER END
  25  */
  26 /*
  27  * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
  28  * Use is subject to license terms.
  29  *
  30  * Copyright (c) 2011, 2012, Intel Corporation.
  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 /* Intramodule declarations for ptlrpc. */
  38
  39 #ifndef PTLRPC_INTERNAL_H
  40 #define PTLRPC_INTERNAL_H
  41
  42 #include "../ldlm/ldlm_internal.h"
  43
  44 struct ldlm_namespace;
  45 struct obd_import;
  46 struct ldlm_res_id;
  47 struct ptlrpc_request_set;
  48 extern int test_req_buffer_pressure;
  49 extern struct mutex ptlrpc_all_services_mutex;
  50
  51 int ptlrpc_start_thread(struct ptlrpc_service_part *svcpt, int wait);
  52 /* ptlrpcd.c */
  53 int ptlrpcd_start(int index, int max, const char *name, struct ptlrpcd_ctl *pc);
  54
  55 /* client.c */
  56 struct ptlrpc_bulk_desc *ptlrpc_new_bulk(unsigned npages, unsigned max_brw,
  57                                          unsigned type, unsigned portal);
  58 void ptlrpc_init_xid(void);
  59
  60 /* events.c */
  61 int ptlrpc_init_portals(void);
  62 void ptlrpc_exit_portals(void);
  63
  64 void ptlrpc_request_handle_notconn(struct ptlrpc_request *);
  65 void lustre_assert_wire_constants(void);
  66 int ptlrpc_import_in_recovery(struct obd_import *imp);
  67 int ptlrpc_set_import_discon(struct obd_import *imp, __u32 conn_cnt);
  68 void ptlrpc_handle_failed_import(struct obd_import *imp);
  69 int ptlrpc_replay_next(struct obd_import *imp, int *inflight);
  70 void ptlrpc_initiate_recovery(struct obd_import *imp);
  71
  72 int lustre_unpack_req_ptlrpc_body(struct ptlrpc_request *req, int offset);
  73 int lustre_unpack_rep_ptlrpc_body(struct ptlrpc_request *req, int offset);
  74
  75 #ifdef LPROCFS
  76 void ptlrpc_lprocfs_register_service(struct proc_dir_entry *proc_entry,
  77                                      struct ptlrpc_service *svc);
  78 void ptlrpc_lprocfs_unregister_service(struct ptlrpc_service *svc);
  79 void ptlrpc_lprocfs_rpc_sent(struct ptlrpc_request *req, long amount);
  80 void ptlrpc_lprocfs_do_request_stat (struct ptlrpc_request *req,
  81                                      long q_usec, long work_usec);
  82 #else
  83 #define ptlrpc_lprocfs_register_service(params...) do{}while(0)
  84 #define ptlrpc_lprocfs_unregister_service(params...) do{}while(0)
  85 #define ptlrpc_lprocfs_rpc_sent(params...) do{}while(0)
  86 #define ptlrpc_lprocfs_do_request_stat(params...) do{}while(0)
  87 #endif /* LPROCFS */
  88
  89 /* NRS */
  90
  91 /**
  92  * NRS core object.
  93  *
  94  * Holds NRS core fields.
  95  */
  96 struct nrs_core {
  97         /**
  98          * Protects nrs_core::nrs_policies, serializes external policy
  99          * registration/unregistration, and NRS core lprocfs operations.
 100          */
 101         struct mutex nrs_mutex;
 102         /* XXX: This is just for liblustre. Remove the #if defined directive
 103          * when the * "cfs_" prefix is dropped from cfs_list_head. */
 104 #if defined (__linux__) && defined(__KERNEL__)
 105         /**
 106          * List of all policy descriptors registered with NRS core; protected
 107          * by nrs_core::nrs_mutex.
 108          */
 109         struct list_head nrs_policies;
 110 #else
 111         struct cfs_list_head nrs_policies;
 112 #endif
 113
 114 };
 115
 116 int ptlrpc_service_nrs_setup(struct ptlrpc_service *svc);
 117 void ptlrpc_service_nrs_cleanup(struct ptlrpc_service *svc);
 118
 119 void ptlrpc_nrs_req_initialize(struct ptlrpc_service_part *svcpt,
 120                                struct ptlrpc_request *req, bool hp);
 121 void ptlrpc_nrs_req_finalize(struct ptlrpc_request *req);
 122 void ptlrpc_nrs_req_stop_nolock(struct ptlrpc_request *req);
 123 void ptlrpc_nrs_req_add(struct ptlrpc_service_part *svcpt,
 124                         struct ptlrpc_request *req, bool hp);
 125
 126 struct ptlrpc_request *
 127 ptlrpc_nrs_req_get_nolock0(struct ptlrpc_service_part *svcpt, bool hp,
 128                            bool peek, bool force);
 129
 130 static inline struct ptlrpc_request *
 131 ptlrpc_nrs_req_get_nolock(struct ptlrpc_service_part *svcpt, bool hp,
 132                           bool force)
 133 {
 134         return ptlrpc_nrs_req_get_nolock0(svcpt, hp, false, force);
 135 }
 136
 137 static inline struct ptlrpc_request *
 138 ptlrpc_nrs_req_peek_nolock(struct ptlrpc_service_part *svcpt, bool hp)
 139 {
 140         return ptlrpc_nrs_req_get_nolock0(svcpt, hp, true, false);
 141 }
 142
 143 void ptlrpc_nrs_req_del_nolock(struct ptlrpc_request *req);
 144 bool ptlrpc_nrs_req_pending_nolock(struct ptlrpc_service_part *svcpt, bool hp);
 145
 146 int ptlrpc_nrs_policy_control(const struct ptlrpc_service *svc,
 147                               enum ptlrpc_nrs_queue_type queue, char *name,
 148                               enum ptlrpc_nrs_ctl opc, bool single, void *arg);
 149
 150 int ptlrpc_nrs_init(void);
 151 void ptlrpc_nrs_fini(void);
 152
 153 static inline bool nrs_svcpt_has_hp(const struct ptlrpc_service_part *svcpt)
 154 {
 155         return svcpt->scp_nrs_hp != NULL;
 156 }
 157
 158 static inline bool nrs_svc_has_hp(const struct ptlrpc_service *svc)
 159 {
 160         /**
 161          * If the first service partition has an HP NRS head, all service
 162          * partitions will.
 163          */
 164         return nrs_svcpt_has_hp(svc->srv_parts[0]);
 165 }
 166
 167 static inline
 168 struct ptlrpc_nrs *nrs_svcpt2nrs(struct ptlrpc_service_part *svcpt, bool hp)
 169 {
 170         LASSERT(ergo(hp, nrs_svcpt_has_hp(svcpt)));
 171         return hp ? svcpt->scp_nrs_hp : &svcpt->scp_nrs_reg;
 172 }
 173
 174 static inline int nrs_pol2cptid(const struct ptlrpc_nrs_policy *policy)
 175 {
 176         return policy->pol_nrs->nrs_svcpt->scp_cpt;
 177 }
 178
 179 static inline
 180 struct ptlrpc_service *nrs_pol2svc(struct ptlrpc_nrs_policy *policy)
 181 {
 182         return policy->pol_nrs->nrs_svcpt->scp_service;
 183 }
 184
 185 static inline
 186 struct ptlrpc_service_part *nrs_pol2svcpt(struct ptlrpc_nrs_policy *policy)
 187 {
 188         return policy->pol_nrs->nrs_svcpt;
 189 }
 190
 191 static inline
 192 struct cfs_cpt_table *nrs_pol2cptab(struct ptlrpc_nrs_policy *policy)
 193 {
 194         return nrs_pol2svc(policy)->srv_cptable;
 195 }
 196
 197 static inline struct ptlrpc_nrs_resource *
 198 nrs_request_resource(struct ptlrpc_nrs_request *nrq)
 199 {
 200         LASSERT(nrq->nr_initialized);
 201         LASSERT(!nrq->nr_finalized);
 202
 203         return nrq->nr_res_ptrs[nrq->nr_res_idx];
 204 }
 205
 206 static inline
 207 struct ptlrpc_nrs_policy *nrs_request_policy(struct ptlrpc_nrs_request *nrq)
 208 {
 209         return nrs_request_resource(nrq)->res_policy;
 210 }
 211
 212 /* recovd_thread.c */
 213
 214 int ptlrpc_expire_one_request(struct ptlrpc_request *req, int async_unlink);
 215
 216 /* pers.c */
 217 void ptlrpc_fill_bulk_md(lnet_md_t *md, struct ptlrpc_bulk_desc *desc,
 218                          int mdcnt);
 219 void ptlrpc_add_bulk_page(struct ptlrpc_bulk_desc *desc, cfs_page_t *page,
 220                           int pageoffset, int len);
 221
 222 /* pack_generic.c */
 223 struct ptlrpc_reply_state *
 224 lustre_get_emerg_rs(struct ptlrpc_service_part *svcpt);
 225 void lustre_put_emerg_rs(struct ptlrpc_reply_state *rs);
 226
 227 /* pinger.c */
 228 int ptlrpc_start_pinger(void);
 229 int ptlrpc_stop_pinger(void);
 230 void ptlrpc_pinger_sending_on_import(struct obd_import *imp);
 231 void ptlrpc_pinger_commit_expected(struct obd_import *imp);
 232 void ptlrpc_pinger_wake_up(void);
 233 void ptlrpc_ping_import_soon(struct obd_import *imp);
 234 #ifdef __KERNEL__
 235 int ping_evictor_wake(struct obd_export *exp);
 236 #else
 237 #define ping_evictor_wake(exp)     1
 238 #endif
 239
 240 /* sec_null.c */
 241 int  sptlrpc_null_init(void);
 242 void sptlrpc_null_fini(void);
 243
 244 /* sec_plain.c */
 245 int  sptlrpc_plain_init(void);
 246 void sptlrpc_plain_fini(void);
 247
 248 /* sec_bulk.c */
 249 int  sptlrpc_enc_pool_init(void);
 250 void sptlrpc_enc_pool_fini(void);
 251 int sptlrpc_proc_read_enc_pool(char *page, char **start, off_t off, int count,
 252                                int *eof, void *data);
 253
 254 /* sec_lproc.c */
 255 int  sptlrpc_lproc_init(void);
 256 void sptlrpc_lproc_fini(void);
 257
 258 /* sec_gc.c */
 259 int sptlrpc_gc_init(void);
 260 void sptlrpc_gc_fini(void);
 261
 262 /* sec_config.c */
 263 void sptlrpc_conf_choose_flavor(enum lustre_sec_part from,
 264                                 enum lustre_sec_part to,
 265                                 struct obd_uuid *target,
 266                                 lnet_nid_t nid,
 267                                 struct sptlrpc_flavor *sf);
 268 int  sptlrpc_conf_init(void);
 269 void sptlrpc_conf_fini(void);
 270
 271 /* sec.c */
 272 int  sptlrpc_init(void);
 273 void sptlrpc_fini(void);
 274
 275 static inline int ll_rpc_recoverable_error(int rc)
 276 {
 277         return (rc == -ENOTCONN || rc == -ENODEV);
 278 }
 279
 280 #ifdef HAVE_SERVER_SUPPORT
 281 int tgt_mod_init(void);
 282 void tgt_mod_exit(void);
 283 #else
 284 static inline int tgt_mod_init(void)
 285 {
 286         return 0;
 287 }
 288
 289 static inline void tgt_mod_exit(void)
 290 {
 291         return;
 292 }
 293 #endif
 294
 295 static inline void ptlrpc_reqset_put(struct ptlrpc_request_set *set)
 296 {
 297         if (cfs_atomic_dec_and_test(&set->set_refcount))
 298                 OBD_FREE_PTR(set);
 299 }
 300 #endif /* PTLRPC_INTERNAL_H */