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, 2014, 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 list_head ptlrpc_all_services;
  50 extern struct mutex ptlrpc_all_services_mutex;
  51 extern struct ptlrpc_nrs_pol_conf nrs_conf_fifo;
  52
  53 #ifdef HAVE_SERVER_SUPPORT
  54 extern struct ptlrpc_nrs_pol_conf nrs_conf_crrn;
  55 extern struct ptlrpc_nrs_pol_conf nrs_conf_orr;
  56 extern struct ptlrpc_nrs_pol_conf nrs_conf_trr;
  57 extern struct ptlrpc_nrs_pol_conf nrs_conf_tbf;
  58 #endif /* HAVE_SERVER_SUPPORT */
  59
  60 /**
  61  * \addtogoup nrs
  62  * @{
  63  */
  64 extern struct nrs_core nrs_core;
  65
  66 extern struct mutex ptlrpcd_mutex;
  67 extern struct mutex pinger_mutex;
  68
  69 int ptlrpc_start_thread(struct ptlrpc_service_part *svcpt, int wait);
  70 /* ptlrpcd.c */
  71 int ptlrpcd_start(int index, int max, const char *name, struct ptlrpcd_ctl *pc);
  72
  73 /* client.c */
  74 void ptlrpc_at_adj_net_latency(struct ptlrpc_request *req,
  75                                unsigned int service_time);
  76 struct ptlrpc_bulk_desc *ptlrpc_new_bulk(unsigned npages, unsigned max_brw,
  77                                          unsigned type, unsigned portal);
  78 int ptlrpc_request_cache_init(void);
  79 void ptlrpc_request_cache_fini(void);
  80 struct ptlrpc_request *ptlrpc_request_cache_alloc(gfp_t flags);
  81 void ptlrpc_request_cache_free(struct ptlrpc_request *req);
  82 void ptlrpc_init_xid(void);
  83
  84 /* events.c */
  85 int ptlrpc_init_portals(void);
  86 void ptlrpc_exit_portals(void);
  87
  88 void ptlrpc_request_handle_notconn(struct ptlrpc_request *);
  89 void lustre_assert_wire_constants(void);
  90 int ptlrpc_import_in_recovery(struct obd_import *imp);
  91 int ptlrpc_set_import_discon(struct obd_import *imp, __u32 conn_cnt);
  92 void ptlrpc_handle_failed_import(struct obd_import *imp);
  93 int ptlrpc_replay_next(struct obd_import *imp, int *inflight);
  94 void ptlrpc_initiate_recovery(struct obd_import *imp);
  95
  96 int lustre_unpack_req_ptlrpc_body(struct ptlrpc_request *req, int offset);
  97 int lustre_unpack_rep_ptlrpc_body(struct ptlrpc_request *req, int offset);
  98
  99 #ifdef LPROCFS
 100 void ptlrpc_lprocfs_register_service(struct proc_dir_entry *proc_entry,
 101                                      struct ptlrpc_service *svc);
 102 void ptlrpc_lprocfs_unregister_service(struct ptlrpc_service *svc);
 103 void ptlrpc_lprocfs_rpc_sent(struct ptlrpc_request *req, long amount);
 104 void ptlrpc_lprocfs_do_request_stat (struct ptlrpc_request *req,
 105                                      long q_usec, long work_usec);
 106 #else
 107 #define ptlrpc_lprocfs_register_service(params...) do{}while(0)
 108 #define ptlrpc_lprocfs_unregister_service(params...) do{}while(0)
 109 #define ptlrpc_lprocfs_rpc_sent(params...) do{}while(0)
 110 #define ptlrpc_lprocfs_do_request_stat(params...) do{}while(0)
 111 #endif /* LPROCFS */
 112
 113 /* NRS */
 114
 115 /**
 116  * NRS core object.
 117  *
 118  * Holds NRS core fields.
 119  */
 120 struct nrs_core {
 121         /**
 122          * Protects nrs_core::nrs_policies, serializes external policy
 123          * registration/unregistration, and NRS core lprocfs operations.
 124          */
 125         struct mutex nrs_mutex;
 126         /**
 127          * List of all policy descriptors registered with NRS core; protected
 128          * by nrs_core::nrs_mutex.
 129          */
 130         struct list_head nrs_policies;
 131 };
 132
 133 int ptlrpc_service_nrs_setup(struct ptlrpc_service *svc);
 134 void ptlrpc_service_nrs_cleanup(struct ptlrpc_service *svc);
 135
 136 void ptlrpc_nrs_req_initialize(struct ptlrpc_service_part *svcpt,
 137                                struct ptlrpc_request *req, bool hp);
 138 void ptlrpc_nrs_req_finalize(struct ptlrpc_request *req);
 139 void ptlrpc_nrs_req_stop_nolock(struct ptlrpc_request *req);
 140 void ptlrpc_nrs_req_add(struct ptlrpc_service_part *svcpt,
 141                         struct ptlrpc_request *req, bool hp);
 142
 143 struct ptlrpc_request *
 144 ptlrpc_nrs_req_get_nolock0(struct ptlrpc_service_part *svcpt, bool hp,
 145                            bool peek, bool force);
 146
 147 static inline struct ptlrpc_request *
 148 ptlrpc_nrs_req_get_nolock(struct ptlrpc_service_part *svcpt, bool hp,
 149                           bool force)
 150 {
 151         return ptlrpc_nrs_req_get_nolock0(svcpt, hp, false, force);
 152 }
 153
 154 static inline struct ptlrpc_request *
 155 ptlrpc_nrs_req_peek_nolock(struct ptlrpc_service_part *svcpt, bool hp)
 156 {
 157         return ptlrpc_nrs_req_get_nolock0(svcpt, hp, true, false);
 158 }
 159
 160 void ptlrpc_nrs_req_del_nolock(struct ptlrpc_request *req);
 161 bool ptlrpc_nrs_req_pending_nolock(struct ptlrpc_service_part *svcpt, bool hp);
 162 bool ptlrpc_nrs_req_throttling_nolock(struct ptlrpc_service_part *svcpt,
 163                                       bool hp);
 164
 165 int ptlrpc_nrs_policy_control(const struct ptlrpc_service *svc,
 166                               enum ptlrpc_nrs_queue_type queue, char *name,
 167                               enum ptlrpc_nrs_ctl opc, bool single, void *arg);
 168
 169 int ptlrpc_nrs_init(void);
 170 void ptlrpc_nrs_fini(void);
 171
 172 static inline bool nrs_svcpt_has_hp(const struct ptlrpc_service_part *svcpt)
 173 {
 174         return svcpt->scp_nrs_hp != NULL;
 175 }
 176
 177 static inline bool nrs_svc_has_hp(const struct ptlrpc_service *svc)
 178 {
 179         /**
 180          * If the first service partition has an HP NRS head, all service
 181          * partitions will.
 182          */
 183         return nrs_svcpt_has_hp(svc->srv_parts[0]);
 184 }
 185
 186 static inline
 187 struct ptlrpc_nrs *nrs_svcpt2nrs(struct ptlrpc_service_part *svcpt, bool hp)
 188 {
 189         LASSERT(ergo(hp, nrs_svcpt_has_hp(svcpt)));
 190         return hp ? svcpt->scp_nrs_hp : &svcpt->scp_nrs_reg;
 191 }
 192
 193 static inline int nrs_pol2cptid(const struct ptlrpc_nrs_policy *policy)
 194 {
 195         return policy->pol_nrs->nrs_svcpt->scp_cpt;
 196 }
 197
 198 static inline
 199 struct ptlrpc_service *nrs_pol2svc(struct ptlrpc_nrs_policy *policy)
 200 {
 201         return policy->pol_nrs->nrs_svcpt->scp_service;
 202 }
 203
 204 static inline
 205 struct ptlrpc_service_part *nrs_pol2svcpt(struct ptlrpc_nrs_policy *policy)
 206 {
 207         return policy->pol_nrs->nrs_svcpt;
 208 }
 209
 210 static inline
 211 struct cfs_cpt_table *nrs_pol2cptab(struct ptlrpc_nrs_policy *policy)
 212 {
 213         return nrs_pol2svc(policy)->srv_cptable;
 214 }
 215
 216 static inline struct ptlrpc_nrs_resource *
 217 nrs_request_resource(struct ptlrpc_nrs_request *nrq)
 218 {
 219         LASSERT(nrq->nr_initialized);
 220         LASSERT(!nrq->nr_finalized);
 221
 222         return nrq->nr_res_ptrs[nrq->nr_res_idx];
 223 }
 224
 225 static inline
 226 struct ptlrpc_nrs_policy *nrs_request_policy(struct ptlrpc_nrs_request *nrq)
 227 {
 228         return nrs_request_resource(nrq)->res_policy;
 229 }
 230
 231 #define NRS_LPROCFS_QUANTUM_NAME_REG    "reg_quantum:"
 232 #define NRS_LPROCFS_QUANTUM_NAME_HP     "hp_quantum:"
 233
 234 /**
 235  * the maximum size of nrs_crrn_client::cc_quantum and nrs_orr_data::od_quantum.
 236  */
 237 #define LPROCFS_NRS_QUANTUM_MAX         65535
 238
 239 /**
 240  * Max valid command string is the size of the labels, plus "65535" twice, plus
 241  * a separating space character.
 242  */
 243 #define LPROCFS_NRS_WR_QUANTUM_MAX_CMD                                         \
 244  sizeof(NRS_LPROCFS_QUANTUM_NAME_REG __stringify(LPROCFS_NRS_QUANTUM_MAX) " "  \
 245         NRS_LPROCFS_QUANTUM_NAME_HP __stringify(LPROCFS_NRS_QUANTUM_MAX))
 246
 247 /* recovd_thread.c */
 248
 249 int ptlrpc_expire_one_request(struct ptlrpc_request *req, int async_unlink);
 250
 251 /* pers.c */
 252 void ptlrpc_fill_bulk_md(lnet_md_t *md, struct ptlrpc_bulk_desc *desc,
 253                          int mdcnt);
 254 void ptlrpc_add_bulk_page(struct ptlrpc_bulk_desc *desc, struct page *page,
 255                           int pageoffset, int len);
 256
 257 /* pack_generic.c */
 258 struct ptlrpc_reply_state *
 259 lustre_get_emerg_rs(struct ptlrpc_service_part *svcpt);
 260 void lustre_put_emerg_rs(struct ptlrpc_reply_state *rs);
 261
 262 /* pinger.c */
 263 int ptlrpc_start_pinger(void);
 264 int ptlrpc_stop_pinger(void);
 265 void ptlrpc_pinger_sending_on_import(struct obd_import *imp);
 266 void ptlrpc_pinger_commit_expected(struct obd_import *imp);
 267 void ptlrpc_pinger_wake_up(void);
 268 void ptlrpc_ping_import_soon(struct obd_import *imp);
 269 int ping_evictor_wake(struct obd_export *exp);
 270
 271 /* sec_null.c */
 272 int  sptlrpc_null_init(void);
 273 void sptlrpc_null_fini(void);
 274
 275 /* sec_plain.c */
 276 int  sptlrpc_plain_init(void);
 277 void sptlrpc_plain_fini(void);
 278
 279 /* sec_bulk.c */
 280 int  sptlrpc_enc_pool_init(void);
 281 void sptlrpc_enc_pool_fini(void);
 282 int sptlrpc_proc_enc_pool_seq_show(struct seq_file *m, void *v);
 283
 284 /* sec_lproc.c */
 285 int  sptlrpc_lproc_init(void);
 286 void sptlrpc_lproc_fini(void);
 287
 288 /* sec_gc.c */
 289 int sptlrpc_gc_init(void);
 290 void sptlrpc_gc_fini(void);
 291
 292 /* sec_config.c */
 293 void sptlrpc_conf_choose_flavor(enum lustre_sec_part from,
 294                                 enum lustre_sec_part to,
 295                                 struct obd_uuid *target,
 296                                 lnet_nid_t nid,
 297                                 struct sptlrpc_flavor *sf);
 298 int  sptlrpc_conf_init(void);
 299 void sptlrpc_conf_fini(void);
 300
 301 struct dentry;
 302 struct vfsmount;
 303 int lustre_rename(struct dentry *dir, struct vfsmount *mnt, char *old_name,
 304                   char *new_name);
 305
 306 /* sec.c */
 307 int  sptlrpc_init(void);
 308 void sptlrpc_fini(void);
 309
 310 static inline bool ptlrpc_recoverable_error(int rc)
 311 {
 312         return (rc == -ENOTCONN || rc == -ENODEV);
 313 }
 314
 315 #ifdef HAVE_SERVER_SUPPORT
 316 int tgt_mod_init(void);
 317 void tgt_mod_exit(void);
 318 int nodemap_mod_init(void);
 319 void nodemap_mod_exit(void);
 320 #else /* HAVE_SERVER_SUPPORT */
 321 static inline int tgt_mod_init(void)
 322 {
 323         return 0;
 324 }
 325
 326 static inline void tgt_mod_exit(void)
 327 {
 328         return;
 329 }
 330
 331 static inline int nodemap_mod_init(void)
 332 {
 333         return 0;
 334 }
 335
 336 static inline void nodemap_mod_exit(void)
 337 {
 338         return;
 339 }
 340 #endif /* !HAVE_SERVER_SUPPORT */
 341
 342 static inline void ptlrpc_reqset_put(struct ptlrpc_request_set *set)
 343 {
 344         if (atomic_dec_and_test(&set->set_refcount))
 345                 OBD_FREE_PTR(set);
 346 }
 347
 348 /** initialise ptlrpc common fields */
 349 static inline void ptlrpc_req_comm_init(struct ptlrpc_request *req)
 350 {
 351         spin_lock_init(&req->rq_lock);
 352         atomic_set(&req->rq_refcount, 1);
 353         INIT_LIST_HEAD(&req->rq_list);
 354         INIT_LIST_HEAD(&req->rq_replay_list);
 355 }
 356
 357 /** initialise client side ptlrpc request */
 358 static inline void ptlrpc_cli_req_init(struct ptlrpc_request *req)
 359 {
 360         struct ptlrpc_cli_req *cr = &req->rq_cli;
 361
 362         ptlrpc_req_comm_init(req);
 363
 364         req->rq_receiving_reply = 0;
 365         req->rq_req_unlinked = req->rq_reply_unlinked = 1;
 366
 367         INIT_LIST_HEAD(&cr->cr_set_chain);
 368         INIT_LIST_HEAD(&cr->cr_ctx_chain);
 369         init_waitqueue_head(&cr->cr_reply_waitq);
 370         init_waitqueue_head(&cr->cr_set_waitq);
 371 }
 372
 373 /** initialise server side ptlrpc request */
 374 static inline void ptlrpc_srv_req_init(struct ptlrpc_request *req)
 375 {
 376         struct ptlrpc_srv_req *sr = &req->rq_srv;
 377
 378         ptlrpc_req_comm_init(req);
 379         req->rq_srv_req = 1;
 380         INIT_LIST_HEAD(&sr->sr_exp_list);
 381         INIT_LIST_HEAD(&sr->sr_timed_list);
 382         INIT_LIST_HEAD(&sr->sr_hist_list);
 383 }
 384
 385 #endif /* PTLRPC_INTERNAL_H */