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