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