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, 2013, 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 int ptlrpc_request_cache_init(void);
  59 void ptlrpc_request_cache_fini(void);
  60 struct ptlrpc_request *ptlrpc_request_cache_alloc(int flags);
  61 void ptlrpc_request_cache_free(struct ptlrpc_request *req);
  62 void ptlrpc_init_xid(void);
  63
  64 /* events.c */
  65 int ptlrpc_init_portals(void);
  66 void ptlrpc_exit_portals(void);
  67
  68 void ptlrpc_request_handle_notconn(struct ptlrpc_request *);
  69 void lustre_assert_wire_constants(void);
  70 int ptlrpc_import_in_recovery(struct obd_import *imp);
  71 int ptlrpc_set_import_discon(struct obd_import *imp, __u32 conn_cnt);
  72 void ptlrpc_handle_failed_import(struct obd_import *imp);
  73 int ptlrpc_replay_next(struct obd_import *imp, int *inflight);
  74 void ptlrpc_initiate_recovery(struct obd_import *imp);
  75
  76 int lustre_unpack_req_ptlrpc_body(struct ptlrpc_request *req, int offset);
  77 int lustre_unpack_rep_ptlrpc_body(struct ptlrpc_request *req, int offset);
  78
  79 #ifdef LPROCFS
  80 void ptlrpc_lprocfs_register_service(struct proc_dir_entry *proc_entry,
  81                                      struct ptlrpc_service *svc);
  82 void ptlrpc_lprocfs_unregister_service(struct ptlrpc_service *svc);
  83 void ptlrpc_lprocfs_rpc_sent(struct ptlrpc_request *req, long amount);
  84 void ptlrpc_lprocfs_do_request_stat (struct ptlrpc_request *req,
  85                                      long q_usec, long work_usec);
  86 #else
  87 #define ptlrpc_lprocfs_register_service(params...) do{}while(0)
  88 #define ptlrpc_lprocfs_unregister_service(params...) do{}while(0)
  89 #define ptlrpc_lprocfs_rpc_sent(params...) do{}while(0)
  90 #define ptlrpc_lprocfs_do_request_stat(params...) do{}while(0)
  91 #endif /* LPROCFS */
  92
  93 /* NRS */
  94
  95 /**
  96  * NRS core object.
  97  *
  98  * Holds NRS core fields.
  99  */
 100 struct nrs_core {
 101         /**
 102          * Protects nrs_core::nrs_policies, serializes external policy
 103          * registration/unregistration, and NRS core lprocfs operations.
 104          */
 105         struct mutex nrs_mutex;
 106         /**
 107          * List of all policy descriptors registered with NRS core; protected
 108          * by nrs_core::nrs_mutex.
 109          */
 110         struct list_head nrs_policies;
 111 };
 112
 113 int ptlrpc_service_nrs_setup(struct ptlrpc_service *svc);
 114 void ptlrpc_service_nrs_cleanup(struct ptlrpc_service *svc);
 115
 116 void ptlrpc_nrs_req_initialize(struct ptlrpc_service_part *svcpt,
 117                                struct ptlrpc_request *req, bool hp);
 118 void ptlrpc_nrs_req_finalize(struct ptlrpc_request *req);
 119 void ptlrpc_nrs_req_stop_nolock(struct ptlrpc_request *req);
 120 void ptlrpc_nrs_req_add(struct ptlrpc_service_part *svcpt,
 121                         struct ptlrpc_request *req, bool hp);
 122
 123 struct ptlrpc_request *
 124 ptlrpc_nrs_req_get_nolock0(struct ptlrpc_service_part *svcpt, bool hp,
 125                            bool peek, bool force);
 126
 127 static inline struct ptlrpc_request *
 128 ptlrpc_nrs_req_get_nolock(struct ptlrpc_service_part *svcpt, bool hp,
 129                           bool force)
 130 {
 131         return ptlrpc_nrs_req_get_nolock0(svcpt, hp, false, force);
 132 }
 133
 134 static inline struct ptlrpc_request *
 135 ptlrpc_nrs_req_peek_nolock(struct ptlrpc_service_part *svcpt, bool hp)
 136 {
 137         return ptlrpc_nrs_req_get_nolock0(svcpt, hp, true, false);
 138 }
 139
 140 void ptlrpc_nrs_req_del_nolock(struct ptlrpc_request *req);
 141 bool ptlrpc_nrs_req_pending_nolock(struct ptlrpc_service_part *svcpt, bool hp);
 142
 143 int ptlrpc_nrs_policy_control(const struct ptlrpc_service *svc,
 144                               enum ptlrpc_nrs_queue_type queue, char *name,
 145                               enum ptlrpc_nrs_ctl opc, bool single, void *arg);
 146
 147 int ptlrpc_nrs_init(void);
 148 void ptlrpc_nrs_fini(void);
 149
 150 static inline bool nrs_svcpt_has_hp(const struct ptlrpc_service_part *svcpt)
 151 {
 152         return svcpt->scp_nrs_hp != NULL;
 153 }
 154
 155 static inline bool nrs_svc_has_hp(const struct ptlrpc_service *svc)
 156 {
 157         /**
 158          * If the first service partition has an HP NRS head, all service
 159          * partitions will.
 160          */
 161         return nrs_svcpt_has_hp(svc->srv_parts[0]);
 162 }
 163
 164 static inline
 165 struct ptlrpc_nrs *nrs_svcpt2nrs(struct ptlrpc_service_part *svcpt, bool hp)
 166 {
 167         LASSERT(ergo(hp, nrs_svcpt_has_hp(svcpt)));
 168         return hp ? svcpt->scp_nrs_hp : &svcpt->scp_nrs_reg;
 169 }
 170
 171 static inline int nrs_pol2cptid(const struct ptlrpc_nrs_policy *policy)
 172 {
 173         return policy->pol_nrs->nrs_svcpt->scp_cpt;
 174 }
 175
 176 static inline
 177 struct ptlrpc_service *nrs_pol2svc(struct ptlrpc_nrs_policy *policy)
 178 {
 179         return policy->pol_nrs->nrs_svcpt->scp_service;
 180 }
 181
 182 static inline
 183 struct ptlrpc_service_part *nrs_pol2svcpt(struct ptlrpc_nrs_policy *policy)
 184 {
 185         return policy->pol_nrs->nrs_svcpt;
 186 }
 187
 188 static inline
 189 struct cfs_cpt_table *nrs_pol2cptab(struct ptlrpc_nrs_policy *policy)
 190 {
 191         return nrs_pol2svc(policy)->srv_cptable;
 192 }
 193
 194 static inline struct ptlrpc_nrs_resource *
 195 nrs_request_resource(struct ptlrpc_nrs_request *nrq)
 196 {
 197         LASSERT(nrq->nr_initialized);
 198         LASSERT(!nrq->nr_finalized);
 199
 200         return nrq->nr_res_ptrs[nrq->nr_res_idx];
 201 }
 202
 203 static inline
 204 struct ptlrpc_nrs_policy *nrs_request_policy(struct ptlrpc_nrs_request *nrq)
 205 {
 206         return nrs_request_resource(nrq)->res_policy;
 207 }
 208
 209 #define NRS_LPROCFS_QUANTUM_NAME_REG    "reg_quantum:"
 210 #define NRS_LPROCFS_QUANTUM_NAME_HP     "hp_quantum:"
 211
 212 /**
 213  * the maximum size of nrs_crrn_client::cc_quantum and nrs_orr_data::od_quantum.
 214  */
 215 #define LPROCFS_NRS_QUANTUM_MAX         65535
 216
 217 /**
 218  * Max valid command string is the size of the labels, plus "65535" twice, plus
 219  * a separating space character.
 220  */
 221 #define LPROCFS_NRS_WR_QUANTUM_MAX_CMD                                         \
 222  sizeof(NRS_LPROCFS_QUANTUM_NAME_REG __stringify(LPROCFS_NRS_QUANTUM_MAX) " "  \
 223         NRS_LPROCFS_QUANTUM_NAME_HP __stringify(LPROCFS_NRS_QUANTUM_MAX))
 224
 225 /* recovd_thread.c */
 226
 227 int ptlrpc_expire_one_request(struct ptlrpc_request *req, int async_unlink);
 228
 229 /* pers.c */
 230 void ptlrpc_fill_bulk_md(lnet_md_t *md, struct ptlrpc_bulk_desc *desc,
 231                          int mdcnt);
 232 void ptlrpc_add_bulk_page(struct ptlrpc_bulk_desc *desc, struct page *page,
 233                           int pageoffset, int len);
 234
 235 /* pack_generic.c */
 236 struct ptlrpc_reply_state *
 237 lustre_get_emerg_rs(struct ptlrpc_service_part *svcpt);
 238 void lustre_put_emerg_rs(struct ptlrpc_reply_state *rs);
 239
 240 /* pinger.c */
 241 int ptlrpc_start_pinger(void);
 242 int ptlrpc_stop_pinger(void);
 243 void ptlrpc_pinger_sending_on_import(struct obd_import *imp);
 244 void ptlrpc_pinger_commit_expected(struct obd_import *imp);
 245 void ptlrpc_pinger_wake_up(void);
 246 void ptlrpc_ping_import_soon(struct obd_import *imp);
 247 #ifdef __KERNEL__
 248 int ping_evictor_wake(struct obd_export *exp);
 249 #else
 250 #define ping_evictor_wake(exp)     1
 251 #endif
 252
 253 /* sec_null.c */
 254 int  sptlrpc_null_init(void);
 255 void sptlrpc_null_fini(void);
 256
 257 /* sec_plain.c */
 258 int  sptlrpc_plain_init(void);
 259 void sptlrpc_plain_fini(void);
 260
 261 /* sec_bulk.c */
 262 int  sptlrpc_enc_pool_init(void);
 263 void sptlrpc_enc_pool_fini(void);
 264 int sptlrpc_proc_enc_pool_seq_show(struct seq_file *m, void *v);
 265
 266 /* sec_lproc.c */
 267 int  sptlrpc_lproc_init(void);
 268 void sptlrpc_lproc_fini(void);
 269
 270 /* sec_gc.c */
 271 int sptlrpc_gc_init(void);
 272 void sptlrpc_gc_fini(void);
 273
 274 /* sec_config.c */
 275 void sptlrpc_conf_choose_flavor(enum lustre_sec_part from,
 276                                 enum lustre_sec_part to,
 277                                 struct obd_uuid *target,
 278                                 lnet_nid_t nid,
 279                                 struct sptlrpc_flavor *sf);
 280 int  sptlrpc_conf_init(void);
 281 void sptlrpc_conf_fini(void);
 282
 283 /* sec.c */
 284 int  sptlrpc_init(void);
 285 void sptlrpc_fini(void);
 286
 287 static inline int ll_rpc_recoverable_error(int rc)
 288 {
 289         return (rc == -ENOTCONN || rc == -ENODEV);
 290 }
 291
 292 #ifdef HAVE_SERVER_SUPPORT
 293 int tgt_mod_init(void);
 294 void tgt_mod_exit(void);
 295 #else
 296 static inline int tgt_mod_init(void)
 297 {
 298         return 0;
 299 }
 300
 301 static inline void tgt_mod_exit(void)
 302 {
 303         return;
 304 }
 305 #endif
 306
 307 static inline void ptlrpc_reqset_put(struct ptlrpc_request_set *set)
 308 {
 309         if (cfs_atomic_dec_and_test(&set->set_refcount))
 310                 OBD_FREE_PTR(set);
 311 }
 312 #endif /* PTLRPC_INTERNAL_H */