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 mutex ptlrpc_all_services_mutex;
  50
  51 int ptlrpc_start_thread(struct ptlrpc_service_part *svcpt, int wait);
  52 /* ptlrpcd.c */
  53 int ptlrpcd_start(int index, int max, const char *name, struct ptlrpcd_ctl *pc);
  54
  55 /* client.c */
  56 struct ptlrpc_bulk_desc *ptlrpc_new_bulk(unsigned npages, unsigned max_brw,
  57                                          unsigned type, unsigned portal);
  58 int ptlrpc_request_cache_init(void);
  59 void ptlrpc_request_cache_fini(void);
  60 struct ptlrpc_request *ptlrpc_request_cache_alloc(int flags);
  61 void ptlrpc_request_cache_free(struct ptlrpc_request *req);
  62 void ptlrpc_init_xid(void);
  63
  64 /* events.c */
  65 int ptlrpc_init_portals(void);
  66 void ptlrpc_exit_portals(void);
  67
  68 void ptlrpc_request_handle_notconn(struct ptlrpc_request *);
  69 void lustre_assert_wire_constants(void);
  70 int ptlrpc_import_in_recovery(struct obd_import *imp);
  71 int ptlrpc_set_import_discon(struct obd_import *imp, __u32 conn_cnt);
  72 void ptlrpc_handle_failed_import(struct obd_import *imp);
  73 int ptlrpc_replay_next(struct obd_import *imp, int *inflight);
  74 void ptlrpc_initiate_recovery(struct obd_import *imp);
  75
  76 int lustre_unpack_req_ptlrpc_body(struct ptlrpc_request *req, int offset);
  77 int lustre_unpack_rep_ptlrpc_body(struct ptlrpc_request *req, int offset);
  78
  79 #ifdef LPROCFS
  80 void ptlrpc_lprocfs_register_service(struct proc_dir_entry *proc_entry,
  81                                      struct ptlrpc_service *svc);
  82 void ptlrpc_lprocfs_unregister_service(struct ptlrpc_service *svc);
  83 void ptlrpc_lprocfs_rpc_sent(struct ptlrpc_request *req, long amount);
  84 void ptlrpc_lprocfs_do_request_stat (struct ptlrpc_request *req,
  85                                      long q_usec, long work_usec);
  86 #else
  87 #define ptlrpc_lprocfs_register_service(params...) do{}while(0)
  88 #define ptlrpc_lprocfs_unregister_service(params...) do{}while(0)
  89 #define ptlrpc_lprocfs_rpc_sent(params...) do{}while(0)
  90 #define ptlrpc_lprocfs_do_request_stat(params...) do{}while(0)
  91 #endif /* LPROCFS */
  92
  93 /* NRS */
  94
  95 /**
  96  * NRS core object.
  97  *
  98  * Holds NRS core fields.
  99  */
 100 struct nrs_core {
 101         /**
 102          * Protects nrs_core::nrs_policies, serializes external policy
 103          * registration/unregistration, and NRS core lprocfs operations.
 104          */
 105         struct mutex nrs_mutex;
 106         /* XXX: This is just for liblustre. Remove the #if defined directive
 107          * when the * "cfs_" prefix is dropped from cfs_list_head. */
 108 #if defined (__linux__) && defined(__KERNEL__)
 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 #else
 115         struct cfs_list_head nrs_policies;
 116 #endif
 117
 118 };
 119
 120 int ptlrpc_service_nrs_setup(struct ptlrpc_service *svc);
 121 void ptlrpc_service_nrs_cleanup(struct ptlrpc_service *svc);
 122
 123 void ptlrpc_nrs_req_initialize(struct ptlrpc_service_part *svcpt,
 124                                struct ptlrpc_request *req, bool hp);
 125 void ptlrpc_nrs_req_finalize(struct ptlrpc_request *req);
 126 void ptlrpc_nrs_req_stop_nolock(struct ptlrpc_request *req);
 127 void ptlrpc_nrs_req_add(struct ptlrpc_service_part *svcpt,
 128                         struct ptlrpc_request *req, bool hp);
 129
 130 struct ptlrpc_request *
 131 ptlrpc_nrs_req_get_nolock0(struct ptlrpc_service_part *svcpt, bool hp,
 132                            bool peek, bool force);
 133
 134 static inline struct ptlrpc_request *
 135 ptlrpc_nrs_req_get_nolock(struct ptlrpc_service_part *svcpt, bool hp,
 136                           bool force)
 137 {
 138         return ptlrpc_nrs_req_get_nolock0(svcpt, hp, false, force);
 139 }
 140
 141 static inline struct ptlrpc_request *
 142 ptlrpc_nrs_req_peek_nolock(struct ptlrpc_service_part *svcpt, bool hp)
 143 {
 144         return ptlrpc_nrs_req_get_nolock0(svcpt, hp, true, false);
 145 }
 146
 147 void ptlrpc_nrs_req_del_nolock(struct ptlrpc_request *req);
 148 bool ptlrpc_nrs_req_pending_nolock(struct ptlrpc_service_part *svcpt, bool hp);
 149
 150 int ptlrpc_nrs_policy_control(const struct ptlrpc_service *svc,
 151                               enum ptlrpc_nrs_queue_type queue, char *name,
 152                               enum ptlrpc_nrs_ctl opc, bool single, void *arg);
 153
 154 int ptlrpc_nrs_init(void);
 155 void ptlrpc_nrs_fini(void);
 156
 157 static inline bool nrs_svcpt_has_hp(const struct ptlrpc_service_part *svcpt)
 158 {
 159         return svcpt->scp_nrs_hp != NULL;
 160 }
 161
 162 static inline bool nrs_svc_has_hp(const struct ptlrpc_service *svc)
 163 {
 164         /**
 165          * If the first service partition has an HP NRS head, all service
 166          * partitions will.
 167          */
 168         return nrs_svcpt_has_hp(svc->srv_parts[0]);
 169 }
 170
 171 static inline
 172 struct ptlrpc_nrs *nrs_svcpt2nrs(struct ptlrpc_service_part *svcpt, bool hp)
 173 {
 174         LASSERT(ergo(hp, nrs_svcpt_has_hp(svcpt)));
 175         return hp ? svcpt->scp_nrs_hp : &svcpt->scp_nrs_reg;
 176 }
 177
 178 static inline int nrs_pol2cptid(const struct ptlrpc_nrs_policy *policy)
 179 {
 180         return policy->pol_nrs->nrs_svcpt->scp_cpt;
 181 }
 182
 183 static inline
 184 struct ptlrpc_service *nrs_pol2svc(struct ptlrpc_nrs_policy *policy)
 185 {
 186         return policy->pol_nrs->nrs_svcpt->scp_service;
 187 }
 188
 189 static inline
 190 struct ptlrpc_service_part *nrs_pol2svcpt(struct ptlrpc_nrs_policy *policy)
 191 {
 192         return policy->pol_nrs->nrs_svcpt;
 193 }
 194
 195 static inline
 196 struct cfs_cpt_table *nrs_pol2cptab(struct ptlrpc_nrs_policy *policy)
 197 {
 198         return nrs_pol2svc(policy)->srv_cptable;
 199 }
 200
 201 static inline struct ptlrpc_nrs_resource *
 202 nrs_request_resource(struct ptlrpc_nrs_request *nrq)
 203 {
 204         LASSERT(nrq->nr_initialized);
 205         LASSERT(!nrq->nr_finalized);
 206
 207         return nrq->nr_res_ptrs[nrq->nr_res_idx];
 208 }
 209
 210 static inline
 211 struct ptlrpc_nrs_policy *nrs_request_policy(struct ptlrpc_nrs_request *nrq)
 212 {
 213         return nrs_request_resource(nrq)->res_policy;
 214 }
 215
 216 #define NRS_LPROCFS_QUANTUM_NAME_REG    "reg_quantum:"
 217 #define NRS_LPROCFS_QUANTUM_NAME_HP     "hp_quantum:"
 218
 219 /**
 220  * the maximum size of nrs_crrn_client::cc_quantum and nrs_orr_data::od_quantum.
 221  */
 222 #define LPROCFS_NRS_QUANTUM_MAX         65535
 223
 224 /**
 225  * Max valid command string is the size of the labels, plus "65535" twice, plus
 226  * a separating space character.
 227  */
 228 #define LPROCFS_NRS_WR_QUANTUM_MAX_CMD                                         \
 229  sizeof(NRS_LPROCFS_QUANTUM_NAME_REG __stringify(LPROCFS_NRS_QUANTUM_MAX) " "  \
 230         NRS_LPROCFS_QUANTUM_NAME_HP __stringify(LPROCFS_NRS_QUANTUM_MAX))
 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(lnet_md_t *md, struct ptlrpc_bulk_desc *desc,
 238                          int mdcnt);
 239 void ptlrpc_add_bulk_page(struct ptlrpc_bulk_desc *desc, struct page *page,
 240                           int pageoffset, int len);
 241
 242 /* pack_generic.c */
 243 struct ptlrpc_reply_state *
 244 lustre_get_emerg_rs(struct ptlrpc_service_part *svcpt);
 245 void lustre_put_emerg_rs(struct ptlrpc_reply_state *rs);
 246
 247 /* pinger.c */
 248 int ptlrpc_start_pinger(void);
 249 int ptlrpc_stop_pinger(void);
 250 void ptlrpc_pinger_sending_on_import(struct obd_import *imp);
 251 void ptlrpc_pinger_commit_expected(struct obd_import *imp);
 252 void ptlrpc_pinger_wake_up(void);
 253 void ptlrpc_ping_import_soon(struct obd_import *imp);
 254 #ifdef __KERNEL__
 255 int ping_evictor_wake(struct obd_export *exp);
 256 #else
 257 #define ping_evictor_wake(exp)     1
 258 #endif
 259
 260 /* sec_null.c */
 261 int  sptlrpc_null_init(void);
 262 void sptlrpc_null_fini(void);
 263
 264 /* sec_plain.c */
 265 int  sptlrpc_plain_init(void);
 266 void sptlrpc_plain_fini(void);
 267
 268 /* sec_bulk.c */
 269 int  sptlrpc_enc_pool_init(void);
 270 void sptlrpc_enc_pool_fini(void);
 271 int sptlrpc_proc_read_enc_pool(char *page, char **start, off_t off, int count,
 272                                int *eof, void *data);
 273
 274 /* sec_lproc.c */
 275 int  sptlrpc_lproc_init(void);
 276 void sptlrpc_lproc_fini(void);
 277
 278 /* sec_gc.c */
 279 int sptlrpc_gc_init(void);
 280 void sptlrpc_gc_fini(void);
 281
 282 /* sec_config.c */
 283 void sptlrpc_conf_choose_flavor(enum lustre_sec_part from,
 284                                 enum lustre_sec_part to,
 285                                 struct obd_uuid *target,
 286                                 lnet_nid_t nid,
 287                                 struct sptlrpc_flavor *sf);
 288 int  sptlrpc_conf_init(void);
 289 void sptlrpc_conf_fini(void);
 290
 291 /* sec.c */
 292 int  sptlrpc_init(void);
 293 void sptlrpc_fini(void);
 294
 295 static inline int ll_rpc_recoverable_error(int rc)
 296 {
 297         return (rc == -ENOTCONN || rc == -ENODEV);
 298 }
 299
 300 #ifdef HAVE_SERVER_SUPPORT
 301 int tgt_mod_init(void);
 302 void tgt_mod_exit(void);
 303 #else
 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 #endif
 314
 315 static inline void ptlrpc_reqset_put(struct ptlrpc_request_set *set)
 316 {
 317         if (cfs_atomic_dec_and_test(&set->set_refcount))
 318                 OBD_FREE_PTR(set);
 319 }
 320 #endif /* PTLRPC_INTERNAL_H */