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