1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
6 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 only,
10 * as published by the Free Software Foundation.
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License version 2 for more details (a copy is included
16 * in the LICENSE file that accompanied this code).
18 * You should have received a copy of the GNU General Public License
19 * version 2 along with this program; If not, see
20 * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
22 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
23 * CA 95054 USA or visit www.sun.com if you need additional information or
29 * Copyright 2008 Sun Microsystems, Inc. All rights reserved
30 * Use is subject to license terms.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
40 #if defined(__linux__)
41 #include <linux/lustre_net.h>
42 #elif defined(__APPLE__)
43 #include <darwin/lustre_net.h>
44 #elif defined(__WINNT__)
45 #include <winnt/lustre_net.h>
47 #error Unsupported operating system.
50 #include <libcfs/libcfs.h>
52 #include <lnet/lnet.h>
53 #include <lustre/lustre_idl.h>
54 #include <lustre_ha.h>
55 #include <lustre_sec.h>
56 #include <lustre_import.h>
57 #include <lprocfs_status.h>
58 #include <lu_object.h>
59 #include <lustre_req_layout.h>
61 /* MD flags we _always_ use */
62 #define PTLRPC_MD_OPTIONS 0
64 /* Define maxima for bulk I/O
65 * CAVEAT EMPTOR, with multinet (i.e. routers forwarding between networks)
66 * these limits are system wide and not interface-local. */
67 #define PTLRPC_MAX_BRW_BITS LNET_MTU_BITS
68 #define PTLRPC_MAX_BRW_SIZE (1<<LNET_MTU_BITS)
69 #define PTLRPC_MAX_BRW_PAGES (PTLRPC_MAX_BRW_SIZE >> CFS_PAGE_SHIFT)
71 /* When PAGE_SIZE is a constant, we can check our arithmetic here with cpp! */
73 # if ((PTLRPC_MAX_BRW_PAGES & (PTLRPC_MAX_BRW_PAGES - 1)) != 0)
74 # error "PTLRPC_MAX_BRW_PAGES isn't a power of two"
76 # if (PTLRPC_MAX_BRW_SIZE != (PTLRPC_MAX_BRW_PAGES * CFS_PAGE_SIZE))
77 # error "PTLRPC_MAX_BRW_SIZE isn't PTLRPC_MAX_BRW_PAGES * CFS_PAGE_SIZE"
79 # if (PTLRPC_MAX_BRW_SIZE > LNET_MTU)
80 # error "PTLRPC_MAX_BRW_SIZE too big"
82 # if (PTLRPC_MAX_BRW_PAGES > LNET_MAX_IOV)
83 # error "PTLRPC_MAX_BRW_PAGES too big"
85 #endif /* __KERNEL__ */
87 /* Size over which to OBD_VMALLOC() rather than OBD_ALLOC() service request
89 #define SVC_BUF_VMALLOC_THRESHOLD (2 * CFS_PAGE_SIZE)
91 /* The following constants determine how memory is used to buffer incoming
94 * ?_NBUFS # buffers to allocate when growing the pool
95 * ?_BUFSIZE # bytes in a single request buffer
96 * ?_MAXREQSIZE # maximum request service will receive
98 * When fewer than ?_NBUFS/2 buffers are posted for receive, another chunk
99 * of ?_NBUFS is added to the pool.
101 * Messages larger than ?_MAXREQSIZE are dropped. Request buffers are
102 * considered full when less than ?_MAXREQSIZE is left in them.
105 #define LDLM_THREADS_AUTO_MIN \
106 min((int)(num_online_cpus() * num_online_cpus() * 2), 8)
107 #define LDLM_THREADS_AUTO_MAX (LDLM_THREADS_AUTO_MIN * 16)
108 #define LDLM_BL_THREADS LDLM_THREADS_AUTO_MIN
109 #define LDLM_NBUFS (64 * num_online_cpus())
110 #define LDLM_BUFSIZE (8 * 1024)
111 #define LDLM_MAXREQSIZE (5 * 1024)
112 #define LDLM_MAXREPSIZE (1024)
114 #define MDT_MIN_THREADS 2UL
115 #define MDT_MAX_THREADS 512UL
116 #define MDT_NUM_THREADS max(min_t(unsigned long, MDT_MAX_THREADS, \
117 num_physpages >> (25 - CFS_PAGE_SHIFT)), 2UL)
118 #define FLD_NUM_THREADS max(min_t(unsigned long, MDT_MAX_THREADS, \
119 num_physpages >> (25 - CFS_PAGE_SHIFT)), 2UL)
120 #define SEQ_NUM_THREADS max(min_t(unsigned long, MDT_MAX_THREADS, \
121 num_physpages >> (25 - CFS_PAGE_SHIFT)), 2UL)
123 /* Absolute limits */
124 #define MDS_THREADS_MIN 2
125 #define MDS_THREADS_MAX 512
126 #define MDS_THREADS_MIN_READPAGE 2
127 #define MDS_NBUFS (64 * num_online_cpus())
128 #define MDS_BUFSIZE (8 * 1024)
129 /* Assume file name length = FNAME_MAX = 256 (true for ext3).
130 * path name length = PATH_MAX = 4096
131 * LOV MD size max = EA_MAX = 4000
132 * symlink: FNAME_MAX + PATH_MAX <- largest
133 * link: FNAME_MAX + PATH_MAX (mds_rec_link < mds_rec_create)
134 * rename: FNAME_MAX + FNAME_MAX
135 * open: FNAME_MAX + EA_MAX
137 * MDS_MAXREQSIZE ~= 4736 bytes =
138 * lustre_msg + ldlm_request + mds_body + mds_rec_create + FNAME_MAX + PATH_MAX
139 * MDS_MAXREPSIZE ~= 8300 bytes = lustre_msg + llog_header
140 * or, for mds_close() and mds_reint_unlink() on a many-OST filesystem:
141 * = 9210 bytes = lustre_msg + mds_body + 160 * (easize + cookiesize)
143 * Realistic size is about 512 bytes (20 character name + 128 char symlink),
144 * except in the open case where there are a large number of OSTs in a LOV.
146 #define MDS_MAXREQSIZE (5 * 1024)
147 #define MDS_MAXREPSIZE max(9 * 1024, 280 + LOV_MAX_STRIPE_COUNT * 56)
149 /* FLD_MAXREQSIZE == lustre_msg + __u32 padding + ptlrpc_body + opc + md_fld */
150 #define FLD_MAXREQSIZE (160)
152 /* FLD_MAXREPSIZE == lustre_msg + ptlrpc_body + md_fld */
153 #define FLD_MAXREPSIZE (152)
155 /* SEQ_MAXREQSIZE == lustre_msg + __u32 padding + ptlrpc_body + opc + lu_range +
157 #define SEQ_MAXREQSIZE (160)
159 /* SEQ_MAXREPSIZE == lustre_msg + ptlrpc_body + lu_range */
160 #define SEQ_MAXREPSIZE (152)
162 #define MGS_THREADS_AUTO_MIN 2
163 #define MGS_THREADS_AUTO_MAX 32
164 #define MGS_NBUFS (64 * num_online_cpus())
165 #define MGS_BUFSIZE (8 * 1024)
166 #define MGS_MAXREQSIZE (7 * 1024)
167 #define MGS_MAXREPSIZE (9 * 1024)
169 /* Absolute limits */
170 #define OSS_THREADS_MIN 2
171 #define OSS_THREADS_MAX 512
172 #define OST_NBUFS (64 * num_online_cpus())
173 #define OST_BUFSIZE (8 * 1024)
174 /* OST_MAXREQSIZE ~= 4768 bytes =
175 * lustre_msg + obdo + 16 * obd_ioobj + 256 * niobuf_remote
177 * - single object with 16 pages is 512 bytes
178 * - OST_MAXREQSIZE must be at least 1 page of cookies plus some spillover
180 #define OST_MAXREQSIZE (5 * 1024)
181 #define OST_MAXREPSIZE (9 * 1024)
183 /* Macro to hide a typecast. */
184 #define ptlrpc_req_async_args(req) ((void *)&req->rq_async_args)
186 struct ptlrpc_connection {
187 struct hlist_node c_hash;
189 lnet_process_id_t c_peer;
190 struct obd_uuid c_remote_uuid;
194 struct ptlrpc_client {
195 __u32 cli_request_portal;
196 __u32 cli_reply_portal;
200 /* state flags of requests */
201 /* XXX only ones left are those used by the bulk descs as well! */
202 #define PTL_RPC_FL_INTR (1 << 0) /* reply wait was interrupted by user */
203 #define PTL_RPC_FL_TIMEOUT (1 << 7) /* request timed out waiting for reply */
205 #define REQ_MAX_ACK_LOCKS 8
207 union ptlrpc_async_args {
208 /* Scratchpad for passing args to completion interpreter. Users
209 * cast to the struct of their choosing, and LASSERT that this is
210 * big enough. For _tons_ of context, OBD_ALLOC a struct and store
211 * a pointer to it here. The pointer_arg ensures this struct is at
212 * least big enough for that. */
213 void *pointer_arg[9];
217 struct ptlrpc_request_set;
218 typedef int (*set_interpreter_func)(struct ptlrpc_request_set *, void *, int);
220 struct ptlrpc_request_set {
221 int set_remaining; /* # uncompleted requests */
222 cfs_waitq_t set_waitq;
223 cfs_waitq_t *set_wakeup_ptr;
224 struct list_head set_requests;
225 struct list_head set_cblist; /* list of completion callbacks */
226 set_interpreter_func set_interpret; /* completion callback */
227 void *set_arg; /* completion context */
228 /* locked so that any old caller can communicate requests to
229 * the set holder who can then fold them into the lock-free set */
230 spinlock_t set_new_req_lock;
231 struct list_head set_new_requests;
234 struct ptlrpc_set_cbdata {
235 struct list_head psc_item;
236 set_interpreter_func psc_interpret;
240 struct ptlrpc_bulk_desc;
243 * ptlrpc callback & work item stuff
245 struct ptlrpc_cb_id {
246 void (*cbid_fn)(lnet_event_t *ev); /* specific callback fn */
247 void *cbid_arg; /* additional arg */
250 #define RS_MAX_LOCKS 8
253 struct ptlrpc_reply_state {
254 struct ptlrpc_cb_id rs_cb_id;
255 struct list_head rs_list;
256 struct list_head rs_exp_list;
257 struct list_head rs_obd_list;
259 struct list_head rs_debug_list;
261 /* updates to following flag serialised by srv_request_lock */
262 unsigned long rs_difficult:1; /* ACK/commit stuff */
263 unsigned long rs_scheduled:1; /* being handled? */
264 unsigned long rs_scheduled_ever:1;/* any schedule attempts? */
265 unsigned long rs_handled:1; /* been handled yet? */
266 unsigned long rs_on_net:1; /* reply_out_callback pending? */
267 unsigned long rs_prealloc:1; /* rs from prealloc list */
272 struct obd_export *rs_export;
273 struct ptlrpc_service *rs_service;
274 lnet_handle_md_t rs_md_h;
275 atomic_t rs_refcount;
277 struct ptlrpc_svc_ctx *rs_svc_ctx;
278 struct lustre_msg *rs_repbuf; /* wrapper */
279 int rs_repbuf_len; /* wrapper buf length */
280 int rs_repdata_len; /* wrapper msg length */
281 struct lustre_msg *rs_msg; /* reply message */
283 /* locks awaiting client reply ACK */
285 struct lustre_handle rs_locks[RS_MAX_LOCKS];
286 ldlm_mode_t rs_modes[RS_MAX_LOCKS];
289 struct ptlrpc_thread;
292 RQ_PHASE_NEW = 0xebc0de00,
293 RQ_PHASE_RPC = 0xebc0de01,
294 RQ_PHASE_BULK = 0xebc0de02,
295 RQ_PHASE_INTERPRET = 0xebc0de03,
296 RQ_PHASE_COMPLETE = 0xebc0de04,
299 struct ptlrpc_request_pool {
301 struct list_head prp_req_list; /* list of ptlrpc_request structs */
303 void (*prp_populate)(struct ptlrpc_request_pool *, int);
310 * Represents remote procedure call.
312 struct ptlrpc_request {
313 int rq_type; /* one of PTL_RPC_MSG_* */
314 struct list_head rq_list;
315 struct list_head rq_timed_list; /* server-side early replies */
316 struct list_head rq_history_list; /* server-side history */
317 __u64 rq_history_seq; /* history sequence # */
320 /* client-side flags are serialized by rq_lock */
321 unsigned long rq_intr:1, rq_replied:1, rq_err:1,
322 rq_timedout:1, rq_resend:1, rq_restart:1,
324 * when ->rq_replay is set, request is kept by the client even
325 * after server commits corresponding transaction. This is
326 * used for operations that require sequence of multiple
327 * requests to be replayed. The only example currently is file
328 * open/close/dw/setattr. When last request in such a sequence
329 * is committed, ->rq_replay is cleared on all requests in the
333 /* this is the last request in the sequence. */
335 rq_no_resend:1, rq_waiting:1, rq_receiving_reply:1,
336 rq_no_delay:1, rq_net_err:1, rq_wait_ctx:1,
337 rq_early:1, rq_must_unlink:1,
338 /* server-side flags */
339 rq_packed_final:1, /* packed final reply */
340 rq_sent_final:1; /* stop sending early replies */
342 enum rq_phase rq_phase; /* one of RQ_PHASE_* */
343 atomic_t rq_refcount; /* client-side refcount for SENT race,
344 server-side refcounf for multiple replies */
346 struct ptlrpc_thread *rq_svc_thread; /* initial thread servicing req */
348 int rq_request_portal; /* XXX FIXME bug 249 */
349 int rq_reply_portal; /* XXX FIXME bug 249 */
351 int rq_nob_received; /* client-side # reply bytes actually received */
354 struct lustre_msg *rq_reqmsg;
357 struct lustre_msg *rq_repmsg;
360 struct list_head rq_replay_list;
361 struct list_head rq_mod_list;
363 struct ptlrpc_cli_ctx *rq_cli_ctx; /* client's half ctx */
364 struct ptlrpc_svc_ctx *rq_svc_ctx; /* server's half ctx */
365 struct list_head rq_ctx_chain; /* link to waited ctx */
367 struct sptlrpc_flavor rq_flvr; /* client & server */
368 enum lustre_sec_part rq_sp_from;
370 unsigned long /* client/server security flags */
371 rq_ctx_init:1, /* context initiation */
372 rq_ctx_fini:1, /* context destroy */
373 rq_bulk_read:1, /* request bulk read */
374 rq_bulk_write:1, /* request bulk write */
375 /* server authentication flags */
376 rq_auth_gss:1, /* authenticated by gss */
377 rq_auth_remote:1, /* authed as remote user */
378 rq_auth_usr_root:1, /* authed as root */
379 rq_auth_usr_mdt:1, /* authed as mdt */
380 /* security tfm flags */
383 /* doesn't expect reply FIXME */
386 uid_t rq_auth_uid; /* authed uid */
387 uid_t rq_auth_mapped_uid; /* authed uid mapped to */
389 /* (server side), pointed directly into req buffer */
390 struct ptlrpc_user_desc *rq_user_desc;
392 /* early replies go to offset 0, regular replies go after that */
393 unsigned int rq_reply_off;
395 /* various buffer pointers */
396 struct lustre_msg *rq_reqbuf; /* req wrapper */
397 int rq_reqbuf_len; /* req wrapper buf len */
398 int rq_reqdata_len; /* req wrapper msg len */
399 char *rq_repbuf; /* rep buffer */
400 int rq_repbuf_len; /* rep buffer len */
401 struct lustre_msg *rq_repdata; /* rep wrapper msg */
402 int rq_repdata_len; /* rep wrapper msg len */
403 struct lustre_msg *rq_clrbuf; /* only in priv mode */
404 int rq_clrbuf_len; /* only in priv mode */
405 int rq_clrdata_len; /* only in priv mode */
407 __u32 rq_req_swab_mask;
408 __u32 rq_rep_swab_mask;
410 int rq_import_generation;
411 enum lustre_imp_state rq_send_state;
413 int rq_early_count; /* how many early replies (for stats) */
415 /* client+server request */
416 lnet_handle_md_t rq_req_md_h;
417 struct ptlrpc_cb_id rq_req_cbid;
420 struct timeval rq_arrival_time; /* request arrival time */
421 struct ptlrpc_reply_state *rq_reply_state; /* separated reply state */
422 struct ptlrpc_request_buffer_desc *rq_rqbd; /* incoming request buffer*/
424 __u32 rq_uid; /* peer uid, used in MDS only */
427 /* client-only incoming reply */
428 lnet_handle_md_t rq_reply_md_h;
429 cfs_waitq_t rq_reply_waitq;
430 struct ptlrpc_cb_id rq_reply_cbid;
433 lnet_process_id_t rq_peer;
434 struct obd_export *rq_export;
435 struct obd_import *rq_import;
437 void (*rq_replay_cb)(struct ptlrpc_request *);
438 void (*rq_commit_cb)(struct ptlrpc_request *);
441 struct ptlrpc_bulk_desc *rq_bulk;/* client side bulk */
443 /* client outgoing req */
444 time_t rq_sent; /* when request/reply sent (secs), or
445 * time when request should be sent */
447 volatile time_t rq_deadline; /* when request must finish. volatile
448 so that servers' early reply updates to the deadline aren't
449 kept in per-cpu cache */
450 int rq_timeout; /* service time estimate (secs) */
453 struct list_head rq_set_chain;
454 struct ptlrpc_request_set *rq_set;
455 /** Async completion handler */
456 ptlrpc_interpterer_t rq_interpret_reply;
457 union ptlrpc_async_args rq_async_args; /* Async completion context */
458 struct ptlrpc_request_pool *rq_pool; /* Pool if request from
460 struct lu_context rq_session;
463 struct req_capsule rq_pill;
466 static inline void ptlrpc_close_replay_seq(struct ptlrpc_request *req)
468 spin_lock(&req->rq_lock);
470 req->rq_sequence = 1;
471 spin_unlock(&req->rq_lock);
474 static inline void lustre_set_req_swabbed(struct ptlrpc_request *req, int index)
476 LASSERT(index < sizeof(req->rq_req_swab_mask) * 8);
477 LASSERT((req->rq_req_swab_mask & (1 << index)) == 0);
478 req->rq_req_swab_mask |= 1 << index;
481 static inline void lustre_set_rep_swabbed(struct ptlrpc_request *req, int index)
483 LASSERT(index < sizeof(req->rq_rep_swab_mask) * 8);
484 LASSERT((req->rq_rep_swab_mask & (1 << index)) == 0);
485 req->rq_rep_swab_mask |= 1 << index;
488 static inline int lustre_req_swabbed(struct ptlrpc_request *req, int index)
490 LASSERT(index < sizeof(req->rq_req_swab_mask) * 8);
491 return req->rq_req_swab_mask & (1 << index);
494 static inline int lustre_rep_swabbed(struct ptlrpc_request *req, int index)
496 LASSERT(index < sizeof(req->rq_rep_swab_mask) * 8);
497 return req->rq_rep_swab_mask & (1 << index);
500 static inline const char *
501 ptlrpc_rqphase2str(const struct ptlrpc_request *req)
503 switch (req->rq_phase) {
510 case RQ_PHASE_INTERPRET:
512 case RQ_PHASE_COMPLETE:
519 /* Spare the preprocessor, spoil the bugs. */
520 #define FLAG(field, str) (field ? str : "")
522 #define DEBUG_REQ_FLAGS(req) \
523 ptlrpc_rqphase2str(req), \
524 FLAG(req->rq_intr, "I"), FLAG(req->rq_replied, "R"), \
525 FLAG(req->rq_err, "E"), \
526 FLAG(req->rq_timedout, "X") /* eXpired */, FLAG(req->rq_resend, "S"), \
527 FLAG(req->rq_restart, "T"), FLAG(req->rq_replay, "P"), \
528 FLAG(req->rq_no_resend, "N"), \
529 FLAG(req->rq_waiting, "W"), \
530 FLAG(req->rq_wait_ctx, "C")
532 #define REQ_FLAGS_FMT "%s:%s%s%s%s%s%s%s%s%s%s"
534 void _debug_req(struct ptlrpc_request *req, __u32 mask,
535 struct libcfs_debug_msg_data *data, const char *fmt, ...)
536 __attribute__ ((format (printf, 4, 5)));
538 #define debug_req(cdls, level, req, file, func, line, fmt, a...) \
542 if (((level) & D_CANTMASK) != 0 || \
543 ((libcfs_debug & (level)) != 0 && \
544 (libcfs_subsystem_debug & DEBUG_SUBSYSTEM) != 0)) { \
545 static struct libcfs_debug_msg_data _req_dbg_data = \
546 DEBUG_MSG_DATA_INIT(cdls, DEBUG_SUBSYSTEM, file, func, line); \
547 _debug_req((req), (level), &_req_dbg_data, fmt, ##a); \
551 /* for most callers (level is a constant) this is resolved at compile time */
552 #define DEBUG_REQ(level, req, fmt, args...) \
554 if ((level) & (D_ERROR | D_WARNING)) { \
555 static cfs_debug_limit_state_t cdls; \
556 debug_req(&cdls, level, req, __FILE__, __func__, __LINE__, \
557 "@@@ "fmt" ", ## args); \
559 debug_req(NULL, level, req, __FILE__, __func__, __LINE__, \
560 "@@@ "fmt" ", ## args); \
563 struct ptlrpc_bulk_page {
564 struct list_head bp_link;
566 int bp_pageoffset; /* offset within a page */
567 struct page *bp_page;
570 #define BULK_GET_SOURCE 0
571 #define BULK_PUT_SINK 1
572 #define BULK_GET_SINK 2
573 #define BULK_PUT_SOURCE 3
575 struct ptlrpc_bulk_desc {
576 unsigned long bd_success:1; /* completed successfully */
577 unsigned long bd_network_rw:1; /* accessible to the network */
578 unsigned long bd_type:2; /* {put,get}{source,sink} */
579 unsigned long bd_registered:1; /* client side */
580 spinlock_t bd_lock; /* serialise with callback */
581 int bd_import_generation;
582 struct obd_export *bd_export;
583 struct obd_import *bd_import;
585 struct ptlrpc_request *bd_req; /* associated request */
586 cfs_waitq_t bd_waitq; /* server side only WQ */
587 int bd_iov_count; /* # entries in bd_iov */
588 int bd_max_iov; /* allocated size of bd_iov */
589 int bd_nob; /* # bytes covered */
590 int bd_nob_transferred; /* # bytes GOT/PUT */
594 struct ptlrpc_cb_id bd_cbid; /* network callback info */
595 lnet_handle_md_t bd_md_h; /* associated MD */
596 lnet_nid_t bd_sender; /* stash event::sender */
598 cfs_page_t **bd_enc_pages;
599 #if defined(__KERNEL__)
600 lnet_kiov_t bd_iov[0];
602 lnet_md_iovec_t bd_iov[0];
606 struct ptlrpc_thread {
608 struct list_head t_link; /* active threads in svc->srv_threads */
610 void *t_data; /* thread-private data (preallocated memory) */
613 unsigned int t_id; /* service thread index, from ptlrpc_start_threads */
614 cfs_waitq_t t_ctl_waitq;
615 struct lu_env *t_env;
618 struct ptlrpc_request_buffer_desc {
619 struct list_head rqbd_list;
620 struct list_head rqbd_reqs;
621 struct ptlrpc_service *rqbd_service;
622 lnet_handle_md_t rqbd_md_h;
625 struct ptlrpc_cb_id rqbd_cbid;
626 struct ptlrpc_request rqbd_req;
629 typedef int (*svc_handler_t)(struct ptlrpc_request *req);
630 typedef void (*svcreq_printfn_t)(void *, struct ptlrpc_request *);
632 struct ptlrpc_service {
633 struct list_head srv_list; /* chain thru all services */
634 int srv_max_req_size; /* biggest request to receive */
635 int srv_max_reply_size; /* biggest reply to send */
636 int srv_buf_size; /* size of individual buffers */
637 int srv_nbuf_per_group; /* # buffers to allocate in 1 group */
638 int srv_nbufs; /* total # req buffer descs allocated */
639 int srv_threads_min; /* threads to start at SOW */
640 int srv_threads_max; /* thread upper limit */
641 int srv_threads_started; /* index of last started thread */
642 int srv_threads_running; /* # running threads */
643 int srv_n_difficult_replies; /* # 'difficult' replies */
644 int srv_n_active_reqs; /* # reqs being served */
645 cfs_duration_t srv_rqbd_timeout; /* timeout before re-posting reqs, in tick */
646 int srv_watchdog_factor; /* soft watchdog timeout mutiplier */
647 unsigned srv_cpu_affinity:1; /* bind threads to CPUs */
648 unsigned srv_at_check:1; /* check early replies */
649 cfs_time_t srv_at_checktime; /* debug */
651 __u32 srv_req_portal;
652 __u32 srv_rep_portal;
655 struct adaptive_timeout srv_at_estimate;/* estimated rpc service time */
656 spinlock_t srv_at_lock;
657 struct list_head srv_at_list; /* reqs waiting for replies */
658 cfs_timer_t srv_at_timer; /* early reply timer */
660 int srv_n_queued_reqs; /* # reqs in either of the queues below */
661 struct list_head srv_req_in_queue; /* incoming reqs */
662 struct list_head srv_request_queue; /* reqs waiting for service */
664 struct list_head srv_request_history; /* request history */
665 __u64 srv_request_seq; /* next request sequence # */
666 __u64 srv_request_max_cull_seq; /* highest seq culled from history */
667 svcreq_printfn_t srv_request_history_print_fn; /* service-specific print fn */
669 struct list_head srv_idle_rqbds; /* request buffers to be reposted */
670 struct list_head srv_active_rqbds; /* req buffers receiving */
671 struct list_head srv_history_rqbds; /* request buffer history */
672 int srv_nrqbd_receiving; /* # posted request buffers */
673 int srv_n_history_rqbds; /* # request buffers in history */
674 int srv_max_history_rqbds;/* max # request buffers in history */
676 atomic_t srv_outstanding_replies;
677 struct list_head srv_active_replies; /* all the active replies */
678 struct list_head srv_reply_queue; /* replies waiting for service */
680 cfs_waitq_t srv_waitq; /* all threads sleep on this. This
681 * wait-queue is signalled when new
682 * incoming request arrives and when
683 * difficult reply has to be handled. */
685 struct list_head srv_threads; /* service thread list */
686 svc_handler_t srv_handler;
688 char *srv_name; /* only statically allocated strings here; we don't clean them */
689 char *srv_thread_name; /* only statically allocated strings here; we don't clean them */
693 cfs_proc_dir_entry_t *srv_procroot;
694 struct lprocfs_stats *srv_stats;
696 /* List of free reply_states */
697 struct list_head srv_free_rs_list;
698 /* waitq to run, when adding stuff to srv_free_rs_list */
699 cfs_waitq_t srv_free_rs_waitq;
702 * Tags for lu_context associated with this thread, see struct
707 * if non-NULL called during thread creation (ptlrpc_start_thread())
708 * to initialize service specific per-thread state.
710 int (*srv_init)(struct ptlrpc_thread *thread);
712 * if non-NULL called during thread shutdown (ptlrpc_main()) to
713 * destruct state created by ->srv_init().
715 void (*srv_done)(struct ptlrpc_thread *thread);
717 //struct ptlrpc_srv_ni srv_interfaces[0];
722 * Ptlrpc thread control flags (LIOD_START, LIOD_STOP, LIOD_STOP_FORCE)
724 unsigned long pc_flags;
726 * Thread lock protecting structure fields.
732 struct completion pc_starting;
736 struct completion pc_finishing;
738 * Thread requests set.
740 struct ptlrpc_request_set *pc_set;
742 * Thread name used in cfs_daemonize()
747 * Async rpcs flag to make sure that ptlrpcd_check() is called only
752 * Currently not used.
756 * User-space async rpcs callback.
758 void *pc_wait_callback;
760 * User-space check idle rpcs callback.
762 void *pc_idle_callback;
766 /* Bits for pc_flags */
767 enum ptlrpcd_ctl_flags {
769 * Ptlrpc thread start flag.
773 * Ptlrpc thread stop flag.
777 * Ptlrpc thread stop force flag. This will cause also
778 * aborting any inflight rpcs handled by thread.
780 LIOD_STOP_FORCE = 1 << 2
783 /* ptlrpc/events.c */
784 extern lnet_handle_eq_t ptlrpc_eq_h;
785 extern int ptlrpc_uuid_to_peer(struct obd_uuid *uuid,
786 lnet_process_id_t *peer, lnet_nid_t *self);
787 extern void request_out_callback (lnet_event_t *ev);
788 extern void reply_in_callback(lnet_event_t *ev);
789 extern void client_bulk_callback (lnet_event_t *ev);
790 extern void request_in_callback(lnet_event_t *ev);
791 extern void reply_out_callback(lnet_event_t *ev);
792 extern void server_bulk_callback (lnet_event_t *ev);
794 /* ptlrpc/connection.c */
795 struct ptlrpc_connection *ptlrpc_connection_get(lnet_process_id_t peer,
797 struct obd_uuid *uuid);
798 int ptlrpc_connection_put(struct ptlrpc_connection *c);
799 struct ptlrpc_connection *ptlrpc_connection_addref(struct ptlrpc_connection *);
800 int ptlrpc_connection_init(void);
801 void ptlrpc_connection_fini(void);
802 extern lnet_pid_t ptl_get_pid(void);
804 /* ptlrpc/niobuf.c */
805 int ptlrpc_start_bulk_transfer(struct ptlrpc_bulk_desc *desc);
806 void ptlrpc_abort_bulk(struct ptlrpc_bulk_desc *desc);
807 int ptlrpc_register_bulk(struct ptlrpc_request *req);
808 void ptlrpc_unregister_bulk (struct ptlrpc_request *req);
810 static inline int ptlrpc_bulk_active (struct ptlrpc_bulk_desc *desc)
814 spin_lock(&desc->bd_lock);
815 rc = desc->bd_network_rw;
816 spin_unlock(&desc->bd_lock);
820 #define PTLRPC_REPLY_MAYBE_DIFFICULT 0x01
821 #define PTLRPC_REPLY_EARLY 0x02
822 int ptlrpc_send_reply(struct ptlrpc_request *req, int flags);
823 int ptlrpc_reply(struct ptlrpc_request *req);
824 int ptlrpc_send_error(struct ptlrpc_request *req, int difficult);
825 int ptlrpc_error(struct ptlrpc_request *req);
826 void ptlrpc_resend_req(struct ptlrpc_request *request);
827 int ptlrpc_at_get_net_latency(struct ptlrpc_request *req);
828 int ptl_send_rpc(struct ptlrpc_request *request, int noreply);
829 int ptlrpc_register_rqbd (struct ptlrpc_request_buffer_desc *rqbd);
831 /* ptlrpc/client.c */
832 void ptlrpc_init_client(int req_portal, int rep_portal, char *name,
833 struct ptlrpc_client *);
834 void ptlrpc_cleanup_client(struct obd_import *imp);
835 struct ptlrpc_connection *ptlrpc_uuid_to_connection(struct obd_uuid *uuid);
838 ptlrpc_client_recv_or_unlink (struct ptlrpc_request *req)
842 spin_lock(&req->rq_lock);
843 rc = req->rq_receiving_reply || req->rq_must_unlink;
844 spin_unlock(&req->rq_lock);
849 ptlrpc_wake_client_req (struct ptlrpc_request *req)
851 if (req->rq_set == NULL)
852 cfs_waitq_signal(&req->rq_reply_waitq);
854 cfs_waitq_signal(&req->rq_set->set_waitq);
857 int ptlrpc_queue_wait(struct ptlrpc_request *req);
858 int ptlrpc_replay_req(struct ptlrpc_request *req);
859 void ptlrpc_unregister_reply(struct ptlrpc_request *req);
860 void ptlrpc_restart_req(struct ptlrpc_request *req);
861 void ptlrpc_abort_inflight(struct obd_import *imp);
862 void ptlrpc_abort_set(struct ptlrpc_request_set *set);
864 struct ptlrpc_request_set *ptlrpc_prep_set(void);
865 int ptlrpc_set_add_cb(struct ptlrpc_request_set *set,
866 set_interpreter_func fn, void *data);
867 int ptlrpc_set_next_timeout(struct ptlrpc_request_set *);
868 int ptlrpc_check_set(struct ptlrpc_request_set *set);
869 int ptlrpc_set_wait(struct ptlrpc_request_set *);
870 int ptlrpc_expired_set(void *data);
871 void ptlrpc_interrupted_set(void *data);
872 void ptlrpc_mark_interrupted(struct ptlrpc_request *req);
873 void ptlrpc_set_destroy(struct ptlrpc_request_set *);
874 void ptlrpc_set_add_req(struct ptlrpc_request_set *, struct ptlrpc_request *);
875 int ptlrpc_set_add_new_req(struct ptlrpcd_ctl *pc,
876 struct ptlrpc_request *req);
878 void ptlrpc_free_rq_pool(struct ptlrpc_request_pool *pool);
879 void ptlrpc_add_rqs_to_pool(struct ptlrpc_request_pool *pool, int num_rq);
881 struct ptlrpc_request_pool *
882 ptlrpc_init_rq_pool(int, int,
883 void (*populate_pool)(struct ptlrpc_request_pool *, int));
885 void ptlrpc_at_set_req_timeout(struct ptlrpc_request *req);
886 struct ptlrpc_request *ptlrpc_request_alloc(struct obd_import *imp,
887 const struct req_format *format);
888 struct ptlrpc_request *ptlrpc_request_alloc_pool(struct obd_import *imp,
889 struct ptlrpc_request_pool *,
890 const struct req_format *format);
891 void ptlrpc_request_free(struct ptlrpc_request *request);
892 int ptlrpc_request_pack(struct ptlrpc_request *request,
893 __u32 version, int opcode);
894 struct ptlrpc_request *ptlrpc_request_alloc_pack(struct obd_import *imp,
895 const struct req_format *format,
896 __u32 version, int opcode);
897 int ptlrpc_request_bufs_pack(struct ptlrpc_request *request,
898 __u32 version, int opcode, char **bufs,
899 struct ptlrpc_cli_ctx *ctx);
900 struct ptlrpc_request *ptlrpc_prep_req(struct obd_import *imp, __u32 version,
901 int opcode, int count, __u32 *lengths,
903 struct ptlrpc_request *ptlrpc_prep_req_pool(struct obd_import *imp,
904 __u32 version, int opcode,
905 int count, __u32 *lengths, char **bufs,
906 struct ptlrpc_request_pool *pool);
907 void ptlrpc_req_finished(struct ptlrpc_request *request);
908 void ptlrpc_req_finished_with_imp_lock(struct ptlrpc_request *request);
909 struct ptlrpc_request *ptlrpc_request_addref(struct ptlrpc_request *req);
910 struct ptlrpc_bulk_desc *ptlrpc_prep_bulk_imp (struct ptlrpc_request *req,
911 int npages, int type, int portal);
912 struct ptlrpc_bulk_desc *ptlrpc_prep_bulk_exp(struct ptlrpc_request *req,
913 int npages, int type, int portal);
914 void ptlrpc_free_bulk(struct ptlrpc_bulk_desc *bulk);
915 void ptlrpc_prep_bulk_page(struct ptlrpc_bulk_desc *desc,
916 cfs_page_t *page, int pageoffset, int len);
917 void ptlrpc_retain_replayable_request(struct ptlrpc_request *req,
918 struct obd_import *imp);
919 __u64 ptlrpc_next_xid(void);
920 __u64 ptlrpc_sample_next_xid(void);
921 __u64 ptlrpc_req_xid(struct ptlrpc_request *request);
923 struct ptlrpc_service_conf {
926 int psc_max_req_size;
927 int psc_max_reply_size;
930 int psc_watchdog_factor;
936 /* ptlrpc/service.c */
937 void ptlrpc_save_lock (struct ptlrpc_request *req,
938 struct lustre_handle *lock, int mode);
939 void ptlrpc_commit_replies (struct obd_device *obd);
940 void ptlrpc_schedule_difficult_reply (struct ptlrpc_reply_state *rs);
941 struct ptlrpc_service *ptlrpc_init_svc_conf(struct ptlrpc_service_conf *c,
942 svc_handler_t h, char *name,
943 struct proc_dir_entry *proc_entry,
944 svcreq_printfn_t prntfn,
947 struct ptlrpc_service *ptlrpc_init_svc(int nbufs, int bufsize, int max_req_size,
949 int req_portal, int rep_portal,
951 svc_handler_t, char *name,
952 cfs_proc_dir_entry_t *proc_entry,
954 int min_threads, int max_threads,
955 char *threadname, __u32 ctx_tags);
956 void ptlrpc_stop_all_threads(struct ptlrpc_service *svc);
958 int ptlrpc_start_threads(struct obd_device *dev, struct ptlrpc_service *svc);
959 int ptlrpc_start_thread(struct obd_device *dev, struct ptlrpc_service *svc);
960 int ptlrpc_unregister_service(struct ptlrpc_service *service);
961 int liblustre_check_services (void *arg);
962 void ptlrpc_daemonize(char *name);
963 int ptlrpc_service_health_check(struct ptlrpc_service *);
966 struct ptlrpc_svc_data {
968 struct ptlrpc_service *svc;
969 struct ptlrpc_thread *thread;
970 struct obd_device *dev;
973 /* ptlrpc/import.c */
974 int ptlrpc_connect_import(struct obd_import *imp, char * new_uuid);
975 int ptlrpc_init_import(struct obd_import *imp);
976 int ptlrpc_disconnect_import(struct obd_import *imp, int noclose);
977 int ptlrpc_import_recovery_state_machine(struct obd_import *imp);
979 /* ptlrpc/pack_generic.c */
980 int ptlrpc_reconnect_import(struct obd_import *imp);
981 int lustre_msg_swabbed(struct lustre_msg *msg);
982 int lustre_msg_check_version(struct lustre_msg *msg, __u32 version);
983 void lustre_init_msg_v2(struct lustre_msg_v2 *msg, int count, __u32 *lens,
985 int lustre_pack_request(struct ptlrpc_request *, __u32 magic, int count,
986 __u32 *lens, char **bufs);
987 int lustre_pack_reply(struct ptlrpc_request *, int count, __u32 *lens,
989 int lustre_pack_reply_v2(struct ptlrpc_request *req, int count,
990 __u32 *lens, char **bufs, int flags);
991 #define LPRFL_EARLY_REPLY 1
992 int lustre_pack_reply_flags(struct ptlrpc_request *, int count, __u32 *lens,
993 char **bufs, int flags);
994 int lustre_shrink_msg(struct lustre_msg *msg, int segment,
995 unsigned int newlen, int move_data);
996 void lustre_free_reply_state(struct ptlrpc_reply_state *rs);
997 int lustre_msg_hdr_size(__u32 magic, int count);
998 int lustre_msg_size(__u32 magic, int count, __u32 *lengths);
999 int lustre_msg_size_v2(int count, __u32 *lengths);
1000 int lustre_packed_msg_size(struct lustre_msg *msg);
1001 int lustre_msg_early_size(void);
1002 int lustre_unpack_msg(struct lustre_msg *m, int len);
1003 void *lustre_msg_buf_v2(struct lustre_msg_v2 *m, int n, int min_size);
1004 void *lustre_msg_buf(struct lustre_msg *m, int n, int minlen);
1005 int lustre_msg_buflen(struct lustre_msg *m, int n);
1006 void lustre_msg_set_buflen(struct lustre_msg *m, int n, int len);
1007 int lustre_msg_bufcount(struct lustre_msg *m);
1008 char *lustre_msg_string (struct lustre_msg *m, int n, int max_len);
1009 void *lustre_swab_buf(struct lustre_msg *, int n, int minlen, void *swabber);
1010 void *lustre_swab_reqbuf(struct ptlrpc_request *req, int n, int minlen,
1012 void *lustre_swab_repbuf(struct ptlrpc_request *req, int n, int minlen,
1014 __u32 lustre_msghdr_get_flags(struct lustre_msg *msg);
1015 void lustre_msghdr_set_flags(struct lustre_msg *msg, __u32 flags);
1016 __u32 lustre_msg_get_flags(struct lustre_msg *msg);
1017 void lustre_msg_add_flags(struct lustre_msg *msg, int flags);
1018 void lustre_msg_set_flags(struct lustre_msg *msg, int flags);
1019 void lustre_msg_clear_flags(struct lustre_msg *msg, int flags);
1020 __u32 lustre_msg_get_op_flags(struct lustre_msg *msg);
1021 void lustre_msg_add_op_flags(struct lustre_msg *msg, int flags);
1022 void lustre_msg_set_op_flags(struct lustre_msg *msg, int flags);
1023 struct lustre_handle *lustre_msg_get_handle(struct lustre_msg *msg);
1024 __u32 lustre_msg_get_type(struct lustre_msg *msg);
1025 __u32 lustre_msg_get_version(struct lustre_msg *msg);
1026 void lustre_msg_add_version(struct lustre_msg *msg, int version);
1027 __u32 lustre_msg_get_opc(struct lustre_msg *msg);
1028 __u64 lustre_msg_get_last_xid(struct lustre_msg *msg);
1029 __u64 lustre_msg_get_last_committed(struct lustre_msg *msg);
1030 __u64 lustre_msg_get_transno(struct lustre_msg *msg);
1031 __u64 lustre_msg_get_slv(struct lustre_msg *msg);
1032 __u32 lustre_msg_get_limit(struct lustre_msg *msg);
1033 void lustre_msg_set_slv(struct lustre_msg *msg, __u64 slv);
1034 void lustre_msg_set_limit(struct lustre_msg *msg, __u64 limit);
1035 int lustre_msg_get_status(struct lustre_msg *msg);
1036 __u32 lustre_msg_get_conn_cnt(struct lustre_msg *msg);
1037 int lustre_msg_is_v1(struct lustre_msg *msg);
1038 __u32 lustre_msg_get_magic(struct lustre_msg *msg);
1039 __u32 lustre_msg_get_timeout(struct lustre_msg *msg);
1040 __u32 lustre_msg_get_service_time(struct lustre_msg *msg);
1041 __u32 lustre_msg_get_cksum(struct lustre_msg *msg);
1042 __u32 lustre_msg_calc_cksum(struct lustre_msg *msg);
1043 void lustre_msg_set_handle(struct lustre_msg *msg,struct lustre_handle *handle);
1044 void lustre_msg_set_type(struct lustre_msg *msg, __u32 type);
1045 void lustre_msg_set_opc(struct lustre_msg *msg, __u32 opc);
1046 void lustre_msg_set_last_xid(struct lustre_msg *msg, __u64 last_xid);
1047 void lustre_msg_set_last_committed(struct lustre_msg *msg,__u64 last_committed);
1048 void lustre_msg_set_transno(struct lustre_msg *msg, __u64 transno);
1049 void lustre_msg_set_status(struct lustre_msg *msg, __u32 status);
1050 void lustre_msg_set_conn_cnt(struct lustre_msg *msg, __u32 conn_cnt);
1051 void ptlrpc_req_set_repsize(struct ptlrpc_request *req, int count, __u32 *sizes);
1052 void ptlrpc_request_set_replen(struct ptlrpc_request *req);
1053 void lustre_msg_set_timeout(struct lustre_msg *msg, __u32 timeout);
1054 void lustre_msg_set_service_time(struct lustre_msg *msg, __u32 service_time);
1055 void lustre_msg_set_cksum(struct lustre_msg *msg, __u32 cksum);
1058 lustre_shrink_reply(struct ptlrpc_request *req, int segment,
1059 unsigned int newlen, int move_data)
1061 LASSERT(req->rq_reply_state);
1062 LASSERT(req->rq_repmsg);
1063 req->rq_replen = lustre_shrink_msg(req->rq_repmsg, segment,
1068 ptlrpc_rs_addref(struct ptlrpc_reply_state *rs)
1070 LASSERT(atomic_read(&rs->rs_refcount) > 0);
1071 atomic_inc(&rs->rs_refcount);
1075 ptlrpc_rs_decref(struct ptlrpc_reply_state *rs)
1077 LASSERT(atomic_read(&rs->rs_refcount) > 0);
1078 if (atomic_dec_and_test(&rs->rs_refcount))
1079 lustre_free_reply_state(rs);
1082 /* Should only be called once per req */
1083 static inline void ptlrpc_req_drop_rs(struct ptlrpc_request *req)
1085 if (req->rq_reply_state == NULL)
1086 return; /* shouldn't occur */
1087 ptlrpc_rs_decref(req->rq_reply_state);
1088 req->rq_reply_state = NULL;
1089 req->rq_repmsg = NULL;
1092 static inline __u32 lustre_request_magic(struct ptlrpc_request *req)
1094 return lustre_msg_get_magic(req->rq_reqmsg);
1097 static inline int ptlrpc_req_get_repsize(struct ptlrpc_request *req)
1099 switch (req->rq_reqmsg->lm_magic) {
1100 case LUSTRE_MSG_MAGIC_V2:
1101 return req->rq_reqmsg->lm_repsize;
1103 LASSERTF(0, "incorrect message magic: %08x\n",
1104 req->rq_reqmsg->lm_magic);
1109 /* ldlm/ldlm_lib.c */
1110 int client_obd_setup(struct obd_device *obddev, struct lustre_cfg *lcfg);
1111 int client_obd_cleanup(struct obd_device *obddev);
1112 int client_connect_import(const struct lu_env *env,
1113 struct lustre_handle *conn, struct obd_device *obd,
1114 struct obd_uuid *cluuid, struct obd_connect_data *,
1116 int client_disconnect_export(struct obd_export *exp);
1117 int client_import_add_conn(struct obd_import *imp, struct obd_uuid *uuid,
1119 int client_import_del_conn(struct obd_import *imp, struct obd_uuid *uuid);
1120 int import_set_conn_priority(struct obd_import *imp, struct obd_uuid *uuid);
1122 /* ptlrpc/pinger.c */
1123 int ptlrpc_pinger_add_import(struct obd_import *imp);
1124 int ptlrpc_pinger_del_import(struct obd_import *imp);
1125 cfs_time_t ptlrpc_suspend_wakeup_time(void);
1127 void ping_evictor_start(void);
1128 void ping_evictor_stop(void);
1130 #define ping_evictor_start() do {} while (0)
1131 #define ping_evictor_stop() do {} while (0)
1133 int ptlrpc_check_and_wait_suspend(struct ptlrpc_request *req);
1135 /* ptlrpc/ptlrpcd.c */
1136 int ptlrpcd_start(char *name, struct ptlrpcd_ctl *pc);
1137 void ptlrpcd_stop(struct ptlrpcd_ctl *pc, int force);
1138 void ptlrpcd_wake(struct ptlrpc_request *req);
1139 void ptlrpcd_add_req(struct ptlrpc_request *req);
1140 int ptlrpcd_addref(void);
1141 void ptlrpcd_decref(void);
1143 /* ptlrpc/lproc_ptlrpc.c */
1144 const char* ll_opcode2str(__u32 opcode);
1146 void ptlrpc_lprocfs_register_obd(struct obd_device *obd);
1147 void ptlrpc_lprocfs_unregister_obd(struct obd_device *obd);
1148 void ptlrpc_lprocfs_brw(struct ptlrpc_request *req, int bytes);
1150 static inline void ptlrpc_lprocfs_register_obd(struct obd_device *obd) {}
1151 static inline void ptlrpc_lprocfs_unregister_obd(struct obd_device *obd) {}
1152 static inline void ptlrpc_lprocfs_brw(struct ptlrpc_request *req, int bytes) {}
1155 /* ptlrpc/llog_server.c */
1156 int llog_origin_handle_create(struct ptlrpc_request *req);
1157 int llog_origin_handle_destroy(struct ptlrpc_request *req);
1158 int llog_origin_handle_prev_block(struct ptlrpc_request *req);
1159 int llog_origin_handle_next_block(struct ptlrpc_request *req);
1160 int llog_origin_handle_read_header(struct ptlrpc_request *req);
1161 int llog_origin_handle_close(struct ptlrpc_request *req);
1162 int llog_origin_handle_cancel(struct ptlrpc_request *req);
1163 int llog_catinfo(struct ptlrpc_request *req);
1165 /* ptlrpc/llog_client.c */
1166 extern struct llog_operations llog_client_ops;