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