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