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