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