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