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