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