X-Git-Url: https://git.whamcloud.com/?a=blobdiff_plain;f=lustre%2Finclude%2Flustre_net.h;h=8df763a243a827b5e26ba2be8c8891f9ac792d52;hb=1f0e2723f37eb86f3a88807d1200e78c10ab9565;hp=179219ab59439996023ddfe3a443113df555b011;hpb=05e00a80f9aea1a1be7ed4ed4a3dc7d4ced3b2c8;p=fs%2Flustre-release.git diff --git a/lustre/include/lustre_net.h b/lustre/include/lustre_net.h index 179219a..8df763a 100644 --- a/lustre/include/lustre_net.h +++ b/lustre/include/lustre_net.h @@ -26,17 +26,35 @@ * GPL HEADER END */ /* - * Copyright 2008 Sun Microsystems, Inc. All rights reserved + * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved. * Use is subject to license terms. */ /* * This file is part of Lustre, http://www.lustre.org/ * Lustre is a trademark of Sun Microsystems, Inc. */ +/** \defgroup PtlRPC Portal RPC and networking module. + * + * PortalRPC is the layer used by rest of lustre code to achieve network + * communications: establish connections with corresponding export and import + * states, listen for a service, send and receive RPCs. + * PortalRPC also includes base recovery framework: packet resending and + * replaying, reconnections, pinger. + * + * PortalRPC utilizes LNet as its transport layer. + * + * @{ + */ + #ifndef _LUSTRE_NET_H #define _LUSTRE_NET_H +/** \defgroup net net + * + * @{ + */ + #if defined(__linux__) #include #elif defined(__APPLE__) @@ -59,11 +77,13 @@ #include #include +#include /* MD flags we _always_ use */ #define PTLRPC_MD_OPTIONS 0 -/* Define maxima for bulk I/O +/** + * Define maxima for bulk I/O * CAVEAT EMPTOR, with multinet (i.e. routers forwarding between networks) * these limits are system wide and not interface-local. */ #define PTLRPC_MAX_BRW_BITS LNET_MTU_BITS @@ -90,7 +110,8 @@ * buffers */ #define SVC_BUF_VMALLOC_THRESHOLD (2 * CFS_PAGE_SIZE) -/* The following constants determine how memory is used to buffer incoming +/** + * The following constants determine how memory is used to buffer incoming * service requests. * * ?_NBUFS # buffers to allocate when growing the pool @@ -103,12 +124,11 @@ * Messages larger than ?_MAXREQSIZE are dropped. Request buffers are * considered full when less than ?_MAXREQSIZE is left in them. */ - -#define LDLM_THREADS_AUTO_MIN \ - min((int)(num_online_cpus() * num_online_cpus() * 2), 8) -#define LDLM_THREADS_AUTO_MAX (LDLM_THREADS_AUTO_MIN * 16) +#define LDLM_THREADS_AUTO_MIN (2) +#define LDLM_THREADS_AUTO_MAX min_t(unsigned, cfs_num_online_cpus() * \ + cfs_num_online_cpus() * 32, 128) #define LDLM_BL_THREADS LDLM_THREADS_AUTO_MIN -#define LDLM_NBUFS (64 * num_online_cpus()) +#define LDLM_NBUFS (64 * cfs_num_online_cpus()) #define LDLM_BUFSIZE (8 * 1024) #define LDLM_MAXREQSIZE (5 * 1024) #define LDLM_MAXREPSIZE (1024) @@ -116,19 +136,17 @@ #define MDT_MIN_THREADS 2UL #define MDT_MAX_THREADS 512UL #define MDT_NUM_THREADS max(min_t(unsigned long, MDT_MAX_THREADS, \ - num_physpages >> (25 - CFS_PAGE_SHIFT)), 2UL) -#define FLD_NUM_THREADS max(min_t(unsigned long, MDT_MAX_THREADS, \ - num_physpages >> (25 - CFS_PAGE_SHIFT)), 2UL) -#define SEQ_NUM_THREADS max(min_t(unsigned long, MDT_MAX_THREADS, \ - num_physpages >> (25 - CFS_PAGE_SHIFT)), 2UL) + cfs_num_physpages >> (25 - CFS_PAGE_SHIFT)), \ + 2UL) -/* Absolute limits */ +/** Absolute limits */ #define MDS_THREADS_MIN 2 #define MDS_THREADS_MAX 512 #define MDS_THREADS_MIN_READPAGE 2 -#define MDS_NBUFS (64 * num_online_cpus()) +#define MDS_NBUFS (64 * cfs_num_online_cpus()) #define MDS_BUFSIZE (8 * 1024) -/* Assume file name length = FNAME_MAX = 256 (true for ext3). +/** + * Assume file name length = FNAME_MAX = 256 (true for ext3). * path name length = PATH_MAX = 4096 * LOV MD size max = EA_MAX = 4000 * symlink: FNAME_MAX + PATH_MAX <- largest @@ -146,34 +164,38 @@ * except in the open case where there are a large number of OSTs in a LOV. */ #define MDS_MAXREQSIZE (5 * 1024) -#define MDS_MAXREPSIZE max(9 * 1024, 280 + LOV_MAX_STRIPE_COUNT * 56) +#define MDS_MAXREPSIZE max(9 * 1024, 362 + LOV_MAX_STRIPE_COUNT * 56) -/* FLD_MAXREQSIZE == lustre_msg + __u32 padding + ptlrpc_body + opc + md_fld */ +/** FLD_MAXREQSIZE == lustre_msg + __u32 padding + ptlrpc_body + opc + md_fld */ #define FLD_MAXREQSIZE (160) -/* FLD_MAXREPSIZE == lustre_msg + ptlrpc_body + md_fld */ +/** FLD_MAXREPSIZE == lustre_msg + ptlrpc_body + md_fld */ #define FLD_MAXREPSIZE (152) -/* SEQ_MAXREQSIZE == lustre_msg + __u32 padding + ptlrpc_body + opc + lu_range + +/** + * SEQ_MAXREQSIZE == lustre_msg + __u32 padding + ptlrpc_body + opc + lu_range + * __u32 padding */ #define SEQ_MAXREQSIZE (160) -/* SEQ_MAXREPSIZE == lustre_msg + ptlrpc_body + lu_range */ +/** SEQ_MAXREPSIZE == lustre_msg + ptlrpc_body + lu_range */ #define SEQ_MAXREPSIZE (152) -#define MGS_THREADS_AUTO_MIN 2 +/** MGS threads must be >= 3, see bug 22458 comment #28 */ +#define MGS_THREADS_AUTO_MIN 3 #define MGS_THREADS_AUTO_MAX 32 -#define MGS_NBUFS (64 * num_online_cpus()) +#define MGS_NBUFS (64 * cfs_num_online_cpus()) #define MGS_BUFSIZE (8 * 1024) #define MGS_MAXREQSIZE (7 * 1024) #define MGS_MAXREPSIZE (9 * 1024) -/* Absolute limits */ +/** Absolute OSS limits */ #define OSS_THREADS_MIN 3 /* difficult replies, HPQ, others */ #define OSS_THREADS_MAX 512 -#define OST_NBUFS (64 * num_online_cpus()) +#define OST_NBUFS (64 * cfs_num_online_cpus()) #define OST_BUFSIZE (8 * 1024) -/* OST_MAXREQSIZE ~= 4768 bytes = + +/** + * OST_MAXREQSIZE ~= 4768 bytes = * lustre_msg + obdo + 16 * obd_ioobj + 256 * niobuf_remote * * - single object with 16 pages is 512 bytes @@ -185,21 +207,33 @@ /* Macro to hide a typecast. */ #define ptlrpc_req_async_args(req) ((void *)&req->rq_async_args) +/** + * Structure to single define portal connection. + */ struct ptlrpc_connection { - struct hlist_node c_hash; + /** linkage for connections hash table */ + cfs_hlist_node_t c_hash; + /** Our own lnet nid for this connection */ lnet_nid_t c_self; + /** Remote side nid for this connection */ lnet_process_id_t c_peer; + /** UUID of the other side */ struct obd_uuid c_remote_uuid; - atomic_t c_refcount; + /** reference counter for this connection */ + cfs_atomic_t c_refcount; }; +/** Client definition for PortalRPC */ struct ptlrpc_client { + /** What lnet portal does this client send messages to by default */ __u32 cli_request_portal; + /** What portal do we expect replies on */ __u32 cli_reply_portal; + /** Name of the client */ char *cli_name; }; -/* state flags of requests */ +/** state flags of requests */ /* XXX only ones left are those used by the bulk descs as well! */ #define PTL_RPC_FL_INTR (1 << 0) /* reply wait was interrupted by user */ #define PTL_RPC_FL_TIMEOUT (1 << 7) /* request timed out waiting for reply */ @@ -207,11 +241,13 @@ struct ptlrpc_client { #define REQ_MAX_ACK_LOCKS 8 union ptlrpc_async_args { - /* Scratchpad for passing args to completion interpreter. Users + /** + * Scratchpad for passing args to completion interpreter. Users * cast to the struct of their choosing, and LASSERT that this is * big enough. For _tons_ of context, OBD_ALLOC a struct and store * a pointer to it here. The pointer_arg ensures this struct is at - * least big enough for that. */ + * least big enough for that. + */ void *pointer_arg[11]; __u64 space[6]; }; @@ -219,29 +255,60 @@ union ptlrpc_async_args { struct ptlrpc_request_set; typedef int (*set_interpreter_func)(struct ptlrpc_request_set *, void *, int); +/** + * Definition of request set structure. + * Request set is a list of requests (not necessary to the same target) that + * once populated with RPCs could be sent in parallel. + * There are two kinds of request sets. General purpose and with dedicated + * serving thread. Example of the latter is ptlrpcd set. + * For general purpose sets once request set started sending it is impossible + * to add new requests to such set. + * Provides a way to call "completion callbacks" when all requests in the set + * returned. + */ struct ptlrpc_request_set { - int set_remaining; /* # uncompleted requests */ - cfs_waitq_t set_waitq; - cfs_waitq_t *set_wakeup_ptr; - struct list_head set_requests; - struct list_head set_cblist; /* list of completion callbacks */ - set_interpreter_func set_interpret; /* completion callback */ - void *set_arg; /* completion context */ - /* locked so that any old caller can communicate requests to - * the set holder who can then fold them into the lock-free set */ - spinlock_t set_new_req_lock; - struct list_head set_new_requests; + /** number of uncompleted requests */ + cfs_atomic_t set_remaining; + /** wait queue to wait on for request events */ + cfs_waitq_t set_waitq; + cfs_waitq_t *set_wakeup_ptr; + /** List of requests in the set */ + cfs_list_t set_requests; + /** + * List of completion callbacks to be called when the set is completed + * This is only used if \a set_interpret is NULL. + * Links struct ptlrpc_set_cbdata. + */ + cfs_list_t set_cblist; + /** Completion callback, if only one. */ + set_interpreter_func set_interpret; + /** opaq argument passed to completion \a set_interpret callback. */ + void *set_arg; + /** + * Lock for \a set_new_requests manipulations + * locked so that any old caller can communicate requests to + * the set holder who can then fold them into the lock-free set + */ + cfs_spinlock_t set_new_req_lock; + /** List of new yet unsent requests. Only used with ptlrpcd now. */ + cfs_list_t set_new_requests; }; +/** + * Description of a single ptrlrpc_set callback + */ struct ptlrpc_set_cbdata { - struct list_head psc_item; + /** List linkage item */ + cfs_list_t psc_item; + /** Pointer to interpreting function */ set_interpreter_func psc_interpret; + /** Opaq argument to pass to the callback */ void *psc_data; }; struct ptlrpc_bulk_desc; -/* +/** * ptlrpc callback & work item stuff */ struct ptlrpc_cb_id { @@ -249,20 +316,32 @@ struct ptlrpc_cb_id { void *cbid_arg; /* additional arg */ }; +/** Maximum number of locks to fit into reply state */ #define RS_MAX_LOCKS 8 #define RS_DEBUG 1 +/** + * Structure to define reply state on the server + * Reply state holds various reply message information. Also for "difficult" + * replies (rep-ack case) we store the state after sending reply and wait + * for the client to acknowledge the reception. In these cases locks could be + * added to the state for replay/failover consistency guarantees. + */ struct ptlrpc_reply_state { + /** Callback description */ struct ptlrpc_cb_id rs_cb_id; - struct list_head rs_list; - struct list_head rs_exp_list; - struct list_head rs_obd_list; + /** Linkage for list of all reply states in a system */ + cfs_list_t rs_list; + /** Linkage for list of all reply states on same export */ + cfs_list_t rs_exp_list; + /** Linkage for list of all reply states for same obd */ + cfs_list_t rs_obd_list; #if RS_DEBUG - struct list_head rs_debug_list; + cfs_list_t rs_debug_list; #endif - /* A spinlock to protect the reply state flags */ - spinlock_t rs_lock; - /* Reply state flags */ + /** A spinlock to protect the reply state flags */ + cfs_spinlock_t rs_lock; + /** Reply state flags */ unsigned long rs_difficult:1; /* ACK/commit stuff */ unsigned long rs_no_ack:1; /* no ACK, even for difficult requests */ @@ -271,29 +350,49 @@ struct ptlrpc_reply_state { unsigned long rs_handled:1; /* been handled yet? */ unsigned long rs_on_net:1; /* reply_out_callback pending? */ unsigned long rs_prealloc:1; /* rs from prealloc list */ - + unsigned long rs_committed:1;/* the transaction was committed + and the rs was dispatched + by ptlrpc_commit_replies */ + /** Size of the state */ int rs_size; + /** opcode */ + __u32 rs_opc; + /** Transaction number */ __u64 rs_transno; + /** xid */ __u64 rs_xid; struct obd_export *rs_export; struct ptlrpc_service *rs_service; + /** Lnet metadata handle for the reply */ lnet_handle_md_t rs_md_h; - atomic_t rs_refcount; + cfs_atomic_t rs_refcount; + /** Context for the sevice thread */ struct ptlrpc_svc_ctx *rs_svc_ctx; + /** Reply buffer (actually sent to the client), encoded if needed */ struct lustre_msg *rs_repbuf; /* wrapper */ + /** Size of the reply buffer */ int rs_repbuf_len; /* wrapper buf length */ + /** Size of the reply message */ int rs_repdata_len; /* wrapper msg length */ + /** + * Actual reply message. Its content is encrupted (if needed) to + * produce reply buffer for actual sending. In simple case + * of no network encryption we jus set \a rs_repbuf to \a rs_msg + */ struct lustre_msg *rs_msg; /* reply message */ - /* locks awaiting client reply ACK */ + /** Number of locks awaiting client ACK */ int rs_nlocks; + /** Handles of locks awaiting client reply ACK */ struct lustre_handle rs_locks[RS_MAX_LOCKS]; + /** Lock modes of locks in \a rs_locks */ ldlm_mode_t rs_modes[RS_MAX_LOCKS]; }; struct ptlrpc_thread; +/** RPC stages */ enum rq_phase { RQ_PHASE_NEW = 0xebc0de00, RQ_PHASE_RPC = 0xebc0de01, @@ -309,10 +408,20 @@ typedef int (*ptlrpc_interpterer_t)(const struct lu_env *env, struct ptlrpc_request *req, void *arg, int rc); +/** + * Definition of request pool structure. + * The pool is used to store empty preallocated requests for the case + * when we would actually need to send something without performing + * any allocations (to avoid e.g. OOM). + */ struct ptlrpc_request_pool { - spinlock_t prp_lock; - struct list_head prp_req_list; /* list of ptlrpc_request structs */ + /** Locks the list */ + cfs_spinlock_t prp_lock; + /** list of ptlrpc_request structs */ + cfs_list_t prp_req_list; + /** Maximum message size that would fit into a rquest from this pool */ int prp_rq_size; + /** Function to allocate more requests for this pool */ void (*prp_populate)(struct ptlrpc_request_pool *, int); }; @@ -321,6 +430,15 @@ struct lu_env; struct ldlm_lock; +/** + * Basic request prioritization operations structure. + * The whole idea is centered around locks and RPCs that might affect locks. + * When a lock is contended we try to give priority to RPCs that might lead + * to fastest release of that lock. + * Currently only implemented for OSTs only in a way that makes all + * IO and truncate RPCs that are coming from a locked region where a lock is + * contended a priority over other requests. + */ struct ptlrpc_hpreq_ops { /** * Check if the lock handle of the given lock is the same as @@ -335,70 +453,116 @@ struct ptlrpc_hpreq_ops { /** * Represents remote procedure call. + * + * This is a staple structure used by everybody wanting to send a request + * in Lustre. */ struct ptlrpc_request { - int rq_type; /* one of PTL_RPC_MSG_* */ - struct list_head rq_list; - struct list_head rq_timed_list; /* server-side early replies */ - struct list_head rq_history_list; /* server-side history */ - struct list_head rq_exp_list; /* server-side per-export list */ - struct ptlrpc_hpreq_ops *rq_ops; /* server-side hp handlers */ - __u64 rq_history_seq; /* history sequence # */ - /* the index of service's srv_at_array into which request is linked */ + /* Request type: one of PTL_RPC_MSG_* */ + int rq_type; + /** + * Linkage item through which this request is included into + * sending/delayed lists on client and into rqbd list on server + */ + cfs_list_t rq_list; + /** + * Server side list of incoming unserved requests sorted by arrival + * time. Traversed from time to time to notice about to expire + * requests and sent back "early replies" to clients to let them + * know server is alive and well, just very busy to service their + * requests in time + */ + cfs_list_t rq_timed_list; + /** server-side history, used for debuging purposes. */ + cfs_list_t rq_history_list; + /** server-side per-export list */ + cfs_list_t rq_exp_list; + /** server-side hp handlers */ + struct ptlrpc_hpreq_ops *rq_ops; + /** history sequence # */ + __u64 rq_history_seq; + /** the index of service's srv_at_array into which request is linked */ time_t rq_at_index; + /** Result of request processing */ int rq_status; - spinlock_t rq_lock; - /* client-side flags are serialized by rq_lock */ + /** Lock to protect request flags and some other important bits, like + * rq_list + */ + cfs_spinlock_t rq_lock; + /** client-side flags are serialized by rq_lock */ unsigned long rq_intr:1, rq_replied:1, rq_err:1, rq_timedout:1, rq_resend:1, rq_restart:1, - /* + /** * when ->rq_replay is set, request is kept by the client even * after server commits corresponding transaction. This is * used for operations that require sequence of multiple * requests to be replayed. The only example currently is file - * open/close/dw/setattr. When last request in such a sequence - * is committed, ->rq_replay is cleared on all requests in the + * open/close. When last request in such a sequence is + * committed, ->rq_replay is cleared on all requests in the * sequence. */ rq_replay:1, - /* this is the last request in the sequence. */ - rq_sequence:1, rq_no_resend:1, rq_waiting:1, rq_receiving_reply:1, rq_no_delay:1, rq_net_err:1, rq_wait_ctx:1, rq_early:1, rq_must_unlink:1, + rq_fake:1, /* this fake req */ + rq_memalloc:1, /* req originated from "kswapd" */ /* server-side flags */ rq_packed_final:1, /* packed final reply */ - rq_sent_final:1, /* stop sending early replies */ rq_hp:1, /* high priority RPC */ - rq_at_linked:1; /* link into service's srv_at_array */ + rq_at_linked:1, /* link into service's srv_at_array */ + rq_reply_truncate:1, + rq_committed:1, + /* whether the "rq_set" is a valid one */ + rq_invalid_rqset:1; enum rq_phase rq_phase; /* one of RQ_PHASE_* */ enum rq_phase rq_next_phase; /* one of RQ_PHASE_* to be used next */ - atomic_t rq_refcount; /* client-side refcount for SENT race, - server-side refcounf for multiple replies */ + cfs_atomic_t rq_refcount;/* client-side refcount for SENT race, + server-side refcounf for multiple replies */ - struct ptlrpc_thread *rq_svc_thread; /* initial thread servicing req */ + /** initial thread servicing this request */ + struct ptlrpc_thread *rq_svc_thread; + /** Portal to which this request would be sent */ int rq_request_portal; /* XXX FIXME bug 249 */ + /** Portal where to wait for reply and where reply would be sent */ int rq_reply_portal; /* XXX FIXME bug 249 */ - int rq_nob_received; /* client-side # reply bytes actually received */ - + /** + * client-side: + * !rq_truncate : # reply bytes actually received, + * rq_truncate : required repbuf_len for resend + */ + int rq_nob_received; + /** Request length */ int rq_reqlen; + /** Request message - what client sent */ struct lustre_msg *rq_reqmsg; + /** Reply length */ int rq_replen; + /** Reply message - server response */ struct lustre_msg *rq_repmsg; + /** Transaction number */ __u64 rq_transno; + /** xid */ __u64 rq_xid; - struct list_head rq_replay_list; - struct list_head rq_mod_list; + /** + * List item to for replay list. Not yet commited requests get linked + * there. + * Also see \a rq_replay comment above. + */ + cfs_list_t rq_replay_list; - struct ptlrpc_cli_ctx *rq_cli_ctx; /* client's half ctx */ - struct ptlrpc_svc_ctx *rq_svc_ctx; /* server's half ctx */ - struct list_head rq_ctx_chain; /* link to waited ctx */ + /** + * security and encryption data + * @{ */ + struct ptlrpc_cli_ctx *rq_cli_ctx; /**< client's half ctx */ + struct ptlrpc_svc_ctx *rq_svc_ctx; /**< server's half ctx */ + cfs_list_t rq_ctx_chain; /**< link to waited ctx */ - struct sptlrpc_flavor rq_flvr; /* client & server */ + struct sptlrpc_flavor rq_flvr; /**< for client & server */ enum lustre_sec_part rq_sp_from; unsigned long /* client/server security flags */ @@ -415,7 +579,8 @@ struct ptlrpc_request { rq_pack_udesc:1, rq_pack_bulk:1, /* doesn't expect reply FIXME */ - rq_no_reply:1; + rq_no_reply:1, + rq_pill_init:1; /* pill initialized */ uid_t rq_auth_uid; /* authed uid */ uid_t rq_auth_mapped_uid; /* authed uid mapped to */ @@ -423,7 +588,7 @@ struct ptlrpc_request { /* (server side), pointed directly into req buffer */ struct ptlrpc_user_desc *rq_user_desc; - /* early replies go to offset 0, regular replies go after that */ + /** early replies go to offset 0, regular replies go after that */ unsigned int rq_reply_off; /* various buffer pointers */ @@ -438,101 +603,182 @@ struct ptlrpc_request { int rq_clrbuf_len; /* only in priv mode */ int rq_clrdata_len; /* only in priv mode */ + /** @} */ + + /** Fields that help to see if request and reply were swabbed or not */ __u32 rq_req_swab_mask; __u32 rq_rep_swab_mask; + /** What was import generation when this request was sent */ int rq_import_generation; enum lustre_imp_state rq_send_state; - int rq_early_count; /* how many early replies (for stats) */ + /** how many early replies (for stats) */ + int rq_early_count; - /* client+server request */ + /** client+server request */ lnet_handle_md_t rq_req_md_h; struct ptlrpc_cb_id rq_req_cbid; + /** optional time limit for send attempts */ + cfs_duration_t rq_delay_limit; + /** time request was first queued */ + cfs_time_t rq_queued_time; /* server-side... */ - struct timeval rq_arrival_time; /* request arrival time */ - struct ptlrpc_reply_state *rq_reply_state; /* separated reply state */ - struct ptlrpc_request_buffer_desc *rq_rqbd; /* incoming request buffer*/ + /** request arrival time */ + struct timeval rq_arrival_time; + /** separated reply state */ + struct ptlrpc_reply_state *rq_reply_state; + /** incoming request buffer */ + struct ptlrpc_request_buffer_desc *rq_rqbd; #ifdef CRAY_XT3 __u32 rq_uid; /* peer uid, used in MDS only */ #endif - /* client-only incoming reply */ + /** client-only incoming reply */ lnet_handle_md_t rq_reply_md_h; cfs_waitq_t rq_reply_waitq; struct ptlrpc_cb_id rq_reply_cbid; + /** our LNet NID */ lnet_nid_t rq_self; + /** Peer description (the other side) */ lnet_process_id_t rq_peer; + /** Server-side, export on which request was received */ struct obd_export *rq_export; + /** Client side, import where request is being sent */ struct obd_import *rq_import; + /** Replay callback, called after request is replayed at recovery */ void (*rq_replay_cb)(struct ptlrpc_request *); + /** + * Commit callback, called when request is committed and about to be + * freed. + */ void (*rq_commit_cb)(struct ptlrpc_request *); + /** Opaq data for replay and commit callbacks. */ void *rq_cb_data; - struct ptlrpc_bulk_desc *rq_bulk;/* client side bulk */ - - /* client outgoing req */ - time_t rq_sent; /* when request/reply sent (secs), or - * time when request should be sent */ - - volatile time_t rq_deadline; /* when request must finish. volatile - so that servers' early reply updates to the deadline aren't - kept in per-cpu cache */ - time_t rq_reply_deadline; /* when req reply unlink must finish. */ - time_t rq_bulk_deadline; /* when req bulk unlink must finish. */ - int rq_timeout; /* service time estimate (secs) */ + /** For bulk requests on client only: bulk descriptor */ + struct ptlrpc_bulk_desc *rq_bulk; - /* Multi-rpc bits */ - struct list_head rq_set_chain; + /** client outgoing req */ + /** + * when request/reply sent (secs), or time when request should be sent + */ + time_t rq_sent; + /** time for request really sent out */ + time_t rq_real_sent; + + /** when request must finish. volatile + * so that servers' early reply updates to the deadline aren't + * kept in per-cpu cache */ + volatile time_t rq_deadline; + /** when req reply unlink must finish. */ + time_t rq_reply_deadline; + /** when req bulk unlink must finish. */ + time_t rq_bulk_deadline; + /** + * service time estimate (secs) + * If the requestsis not served by this time, it is marked as timed out. + */ + int rq_timeout; + + /** Multi-rpc bits */ + /** Link item for request set lists */ + cfs_list_t rq_set_chain; + /** Per-request waitq introduced by bug 21938 for recovery waiting */ + cfs_waitq_t rq_set_waitq; + /** Link back to the request set */ struct ptlrpc_request_set *rq_set; - /** Async completion handler */ + /** Async completion handler, called when reply is received */ ptlrpc_interpterer_t rq_interpret_reply; - union ptlrpc_async_args rq_async_args; /* Async completion context */ - struct ptlrpc_request_pool *rq_pool; /* Pool if request from - preallocated list */ + /** Async completion context */ + union ptlrpc_async_args rq_async_args; + + /** Pool if request is from preallocated list */ + struct ptlrpc_request_pool *rq_pool; + struct lu_context rq_session; + struct lu_context rq_recov_session; - /* request format */ + /** request format description */ struct req_capsule rq_pill; }; -static inline void ptlrpc_close_replay_seq(struct ptlrpc_request *req) +/** + * Call completion handler for rpc if any, return it's status or original + * rc if there was no handler defined for this request. + */ +static inline int ptlrpc_req_interpret(const struct lu_env *env, + struct ptlrpc_request *req, int rc) { - spin_lock(&req->rq_lock); - req->rq_replay = 0; - req->rq_sequence = 1; - spin_unlock(&req->rq_lock); + if (req->rq_interpret_reply != NULL) { + req->rq_status = req->rq_interpret_reply(env, req, + &req->rq_async_args, + rc); + return req->rq_status; + } + return rc; } -static inline void lustre_set_req_swabbed(struct ptlrpc_request *req, int index) +/** + * Returns 1 if request buffer at offset \a index was already swabbed + */ +static inline int lustre_req_swabbed(struct ptlrpc_request *req, int index) { LASSERT(index < sizeof(req->rq_req_swab_mask) * 8); - LASSERT((req->rq_req_swab_mask & (1 << index)) == 0); - req->rq_req_swab_mask |= 1 << index; + return req->rq_req_swab_mask & (1 << index); } -static inline void lustre_set_rep_swabbed(struct ptlrpc_request *req, int index) +/** + * Returns 1 if request reply buffer at offset \a index was already swabbed + */ +static inline int lustre_rep_swabbed(struct ptlrpc_request *req, int index) { LASSERT(index < sizeof(req->rq_rep_swab_mask) * 8); - LASSERT((req->rq_rep_swab_mask & (1 << index)) == 0); - req->rq_rep_swab_mask |= 1 << index; + return req->rq_rep_swab_mask & (1 << index); } -static inline int lustre_req_swabbed(struct ptlrpc_request *req, int index) +/** + * Returns 1 if request needs to be swabbed into local cpu byteorder + */ +static inline int ptlrpc_req_need_swab(struct ptlrpc_request *req) +{ + return lustre_req_swabbed(req, MSG_PTLRPC_HEADER_OFF); +} + +/** + * Returns 1 if request reply needs to be swabbed into local cpu byteorder + */ +static inline int ptlrpc_rep_need_swab(struct ptlrpc_request *req) +{ + return lustre_rep_swabbed(req, MSG_PTLRPC_HEADER_OFF); +} + +/** + * Mark request buffer at offset \a index that it was already swabbed + */ +static inline void lustre_set_req_swabbed(struct ptlrpc_request *req, int index) { LASSERT(index < sizeof(req->rq_req_swab_mask) * 8); - return req->rq_req_swab_mask & (1 << index); + LASSERT((req->rq_req_swab_mask & (1 << index)) == 0); + req->rq_req_swab_mask |= 1 << index; } -static inline int lustre_rep_swabbed(struct ptlrpc_request *req, int index) +/** + * Mark request reply buffer at offset \a index that it was already swabbed + */ +static inline void lustre_set_rep_swabbed(struct ptlrpc_request *req, int index) { LASSERT(index < sizeof(req->rq_rep_swab_mask) * 8); - return req->rq_rep_swab_mask & (1 << index); + LASSERT((req->rq_rep_swab_mask & (1 << index)) == 0); + req->rq_rep_swab_mask |= 1 << index; } +/** + * Convert numerical request phase value \a phase into text string description + */ static inline const char * ptlrpc_phase2str(enum rq_phase phase) { @@ -554,15 +800,24 @@ ptlrpc_phase2str(enum rq_phase phase) } } +/** + * Convert numerical request phase of the request \a req into text stringi + * description + */ static inline const char * ptlrpc_rqphase2str(struct ptlrpc_request *req) { return ptlrpc_phase2str(req->rq_phase); } +/** + * Debugging functions and helpers to print request structure into debug log + * @{ + */ /* Spare the preprocessor, spoil the bugs. */ #define FLAG(field, str) (field ? str : "") +/** Convert bit flags into a string */ #define DEBUG_REQ_FLAGS(req) \ ptlrpc_rqphase2str(req), \ FLAG(req->rq_intr, "I"), FLAG(req->rq_replied, "R"), \ @@ -571,17 +826,22 @@ ptlrpc_rqphase2str(struct ptlrpc_request *req) FLAG(req->rq_restart, "T"), FLAG(req->rq_replay, "P"), \ FLAG(req->rq_no_resend, "N"), \ FLAG(req->rq_waiting, "W"), \ - FLAG(req->rq_wait_ctx, "C"), FLAG(req->rq_hp, "H") + FLAG(req->rq_wait_ctx, "C"), FLAG(req->rq_hp, "H"), \ + FLAG(req->rq_committed, "M") -#define REQ_FLAGS_FMT "%s:%s%s%s%s%s%s%s%s%s%s%s" +#define REQ_FLAGS_FMT "%s:%s%s%s%s%s%s%s%s%s%s%s%s" void _debug_req(struct ptlrpc_request *req, __u32 mask, struct libcfs_debug_msg_data *data, const char *fmt, ...) __attribute__ ((format (printf, 4, 5))); +/** + * Helper that decides if we need to print request accordig to current debug + * level settings + */ #define debug_req(cdls, level, req, file, func, line, fmt, a...) \ do { \ - CHECK_STACK(); \ + CFS_CHECK_STACK(); \ \ if (((level) & D_CANTMASK) != 0 || \ ((libcfs_debug & (level)) != 0 && \ @@ -592,7 +852,10 @@ do { \ } \ } while(0) -/* for most callers (level is a constant) this is resolved at compile time */ +/** + * This is the debug print function you need to use to print request sturucture + * content into lustre debug log. + * for most callers (level is a constant) this is resolved at compile time */ #define DEBUG_REQ(level, req, fmt, args...) \ do { \ if ((level) & (D_ERROR | D_WARNING)) { \ @@ -603,11 +866,21 @@ do { \ debug_req(NULL, level, req, __FILE__, __func__, __LINE__, \ "@@@ "fmt" ", ## args); \ } while (0) +/** @} */ +/** + * Structure that defines a single page of a bulk transfer + */ struct ptlrpc_bulk_page { - struct list_head bp_link; + /** Linkage to list of pages in a bulk */ + cfs_list_t bp_link; + /** + * Number of bytes in a page to transfer starting from \a bp_pageoffset + */ int bp_buflen; - int bp_pageoffset; /* offset within a page */ + /** offset within a page */ + int bp_pageoffset; + /** The page itself */ struct page *bp_page; }; @@ -616,17 +889,37 @@ struct ptlrpc_bulk_page { #define BULK_GET_SINK 2 #define BULK_PUT_SOURCE 3 +/** + * Definition of buk descriptor. + * Bulks are special "Two phase" RPCs where initial request message + * is sent first and it is followed bt a transfer (o receiving) of a large + * amount of data to be settled into pages referenced from the bulk descriptors. + * Bulks transfers (the actual data following the small requests) are done + * on separate LNet portals. + * In lustre we use bulk transfers for READ and WRITE transfers from/to OSTs. + * Another user is readpage for MDT. + */ struct ptlrpc_bulk_desc { - unsigned long bd_success:1; /* completed successfully */ - unsigned long bd_network_rw:1; /* accessible to the network */ - unsigned long bd_type:2; /* {put,get}{source,sink} */ - unsigned long bd_registered:1; /* client side */ - spinlock_t bd_lock; /* serialise with callback */ + /** completed successfully */ + unsigned long bd_success:1; + /** accessible to the network (network io potentially in progress) */ + unsigned long bd_network_rw:1; + /** {put,get}{source,sink} */ + unsigned long bd_type:2; + /** client side */ + unsigned long bd_registered:1; + /** For serialization with callback */ + cfs_spinlock_t bd_lock; + /** Import generation when request for this bulk was sent */ int bd_import_generation; + /** Server side - export this bulk created for */ struct obd_export *bd_export; + /** Client side - import this bulk was sent on */ struct obd_import *bd_import; + /** LNet portal for this bulk */ __u32 bd_portal; - struct ptlrpc_request *bd_req; /* associated request */ + /** Back pointer to the request */ + struct ptlrpc_request *bd_req; cfs_waitq_t bd_waitq; /* server side only WQ */ int bd_iov_count; /* # entries in bd_iov */ int bd_max_iov; /* allocated size of bd_iov */ @@ -651,11 +944,14 @@ struct ptlrpc_bulk_desc { #endif }; +/** + * Definition of server service thread structure + */ struct ptlrpc_thread { /** - * active threads in svc->srv_threads + * List of active threads in svc->srv_threads */ - struct list_head t_link; + cfs_list_t t_link; /** * thread-private data (preallocated memory) */ @@ -666,21 +962,45 @@ struct ptlrpc_thread { */ unsigned int t_id; /** + * service thread pid + */ + pid_t t_pid; + /** * put watchdog in the structure per thread b=14840 */ struct lc_watchdog *t_watchdog; + /** + * the svc this thread belonged to b=18582 + */ + struct ptlrpc_service *t_svc; cfs_waitq_t t_ctl_waitq; struct lu_env *t_env; }; +/** + * Request buffer descriptor structure. + * This is a structure that contains one posted request buffer for service. + * Once data land into a buffer, event callback creates actual request and + * notifies wakes one of the service threads to process new incoming request. + * More than one request can fit into the buffer. + */ struct ptlrpc_request_buffer_desc { - struct list_head rqbd_list; - struct list_head rqbd_reqs; + /** Link item for rqbds on a service */ + cfs_list_t rqbd_list; + /** History of requests for this buffer */ + cfs_list_t rqbd_reqs; + /** Back pointer to service for which this buffer is registered */ struct ptlrpc_service *rqbd_service; + /** LNet descriptor */ lnet_handle_md_t rqbd_md_h; int rqbd_refcount; + /** The buffer itself */ char *rqbd_buffer; struct ptlrpc_cb_id rqbd_cbid; + /** + * This "embedded" request structure is only used for the + * last request to fit into the buffer + */ struct ptlrpc_request rqbd_req; }; @@ -688,10 +1008,20 @@ typedef int (*svc_handler_t)(struct ptlrpc_request *req); typedef void (*svcreq_printfn_t)(void *, struct ptlrpc_request *); typedef int (*svc_hpreq_handler_t)(struct ptlrpc_request *); +/** + * How many high priority requests to serve before serving one normal + * priority request + */ #define PTLRPC_SVC_HP_RATIO 10 +/** + * Definition of PortalRPC service. + * The service is listening on a particular portal (like tcp port) + * and perform actions for a specific server like IO service for OST + * or general metadata service for MDS. + */ struct ptlrpc_service { - struct list_head srv_list; /* chain thru all services */ + cfs_list_t srv_list; /* chain thru all services */ int srv_max_req_size; /* biggest request to receive */ int srv_max_reply_size; /* biggest reply to send */ int srv_buf_size; /* size of individual buffers */ @@ -701,82 +1031,89 @@ struct ptlrpc_service { int srv_threads_max; /* thread upper limit */ int srv_threads_started; /* index of last started thread */ int srv_threads_running; /* # running threads */ - atomic_t srv_n_difficult_replies; /* # 'difficult' replies */ + cfs_atomic_t srv_n_difficult_replies; /* # 'difficult' replies */ int srv_n_active_reqs; /* # reqs being served */ int srv_n_hpreq; /* # HPreqs being served */ cfs_duration_t srv_rqbd_timeout; /* timeout before re-posting reqs, in tick */ - int srv_watchdog_factor; /* soft watchdog timeout mutiplier */ + int srv_watchdog_factor; /* soft watchdog timeout multiplier */ unsigned srv_cpu_affinity:1; /* bind threads to CPUs */ unsigned srv_at_check:1; /* check early replies */ unsigned srv_is_stopping:1; /* under unregister_service */ cfs_time_t srv_at_checktime; /* debug */ + /** Local portal on which to receive requests */ __u32 srv_req_portal; + /** Portal on the client to send replies to */ __u32 srv_rep_portal; - /* AT stuff */ + /** AT stuff */ + /** @{ */ struct adaptive_timeout srv_at_estimate;/* estimated rpc service time */ - spinlock_t srv_at_lock; + cfs_spinlock_t srv_at_lock; struct ptlrpc_at_array srv_at_array; /* reqs waiting for replies */ - cfs_timer_t srv_at_timer; /* early reply timer */ - - int srv_n_queued_reqs; /* # reqs in either of the queues below */ - int srv_hpreq_count; /* # hp requests handled */ - int srv_hpreq_ratio; /* # hp per lp reqs to handle */ - struct list_head srv_req_in_queue; /* incoming reqs */ - struct list_head srv_request_queue; /* reqs waiting for service */ - struct list_head srv_request_hpq; /* high priority queue */ - - struct list_head srv_request_history; /* request history */ - __u64 srv_request_seq; /* next request sequence # */ - __u64 srv_request_max_cull_seq; /* highest seq culled from history */ - svcreq_printfn_t srv_request_history_print_fn; /* service-specific print fn */ - - struct list_head srv_idle_rqbds; /* request buffers to be reposted */ - struct list_head srv_active_rqbds; /* req buffers receiving */ - struct list_head srv_history_rqbds; /* request buffer history */ - int srv_nrqbd_receiving; /* # posted request buffers */ - int srv_n_history_rqbds; /* # request buffers in history */ - int srv_max_history_rqbds;/* max # request buffers in history */ - - atomic_t srv_outstanding_replies; - struct list_head srv_active_replies; /* all the active replies */ + cfs_timer_t srv_at_timer; /* early reply timer */ + /** @} */ + + int srv_n_queued_reqs; /* # reqs in either of the queues below */ + int srv_hpreq_count; /* # hp requests handled */ + int srv_hpreq_ratio; /* # hp per lp reqs to handle */ + cfs_list_t srv_req_in_queue; /* incoming reqs */ + cfs_list_t srv_request_queue; /* reqs waiting for service */ + cfs_list_t srv_request_hpq; /* high priority queue */ + + cfs_list_t srv_request_history; /* request history */ + __u64 srv_request_seq; /* next request sequence # */ + __u64 srv_request_max_cull_seq; /* highest seq culled from history */ + svcreq_printfn_t srv_request_history_print_fn; /* service-specific print fn */ + + cfs_list_t srv_idle_rqbds; /* request buffers to be reposted */ + cfs_list_t srv_active_rqbds; /* req buffers receiving */ + cfs_list_t srv_history_rqbds; /* request buffer history */ + int srv_nrqbd_receiving; /* # posted request buffers */ + int srv_n_history_rqbds; /* # request buffers in history */ + int srv_max_history_rqbds;/* max # request buffers in history */ + + cfs_atomic_t srv_outstanding_replies; + cfs_list_t srv_active_replies; /* all the active replies */ #ifndef __KERNEL__ - struct list_head srv_reply_queue; /* replies waiting for service */ + cfs_list_t srv_reply_queue; /* replies waiting for service */ #endif - cfs_waitq_t srv_waitq; /* all threads sleep on this. This - * wait-queue is signalled when new - * incoming request arrives and when - * difficult reply has to be handled. */ + cfs_waitq_t srv_waitq; /* all threads sleep on this. This + * wait-queue is signalled when new + * incoming request arrives and when + * difficult reply has to be handled. */ - struct list_head srv_threads; /* service thread list */ - svc_handler_t srv_handler; - svc_hpreq_handler_t srv_hpreq_handler; /* hp request handler */ + cfs_list_t srv_threads; /* service thread list */ + /** Handler function for incoming requests for this service */ + svc_handler_t srv_handler; + svc_hpreq_handler_t srv_hpreq_handler; /* hp request handler */ char *srv_name; /* only statically allocated strings here; we don't clean them */ char *srv_thread_name; /* only statically allocated strings here; we don't clean them */ - spinlock_t srv_lock; + cfs_spinlock_t srv_lock; - cfs_proc_dir_entry_t *srv_procroot; - struct lprocfs_stats *srv_stats; + /** Root of /proc dir tree for this service */ + cfs_proc_dir_entry_t *srv_procroot; + /** Pointer to statistic data for this service */ + struct lprocfs_stats *srv_stats; - /* List of free reply_states */ - struct list_head srv_free_rs_list; - /* waitq to run, when adding stuff to srv_free_rs_list */ - cfs_waitq_t srv_free_rs_waitq; + /** List of free reply_states */ + cfs_list_t srv_free_rs_list; + /** waitq to run, when adding stuff to srv_free_rs_list */ + cfs_waitq_t srv_free_rs_waitq; - /* + /** * Tags for lu_context associated with this thread, see struct * lu_context. */ - __u32 srv_ctx_tags; - /* + __u32 srv_ctx_tags; + /** * if non-NULL called during thread creation (ptlrpc_start_thread()) * to initialize service specific per-thread state. */ int (*srv_init)(struct ptlrpc_thread *thread); - /* + /** * if non-NULL called during thread shutdown (ptlrpc_main()) to * destruct state created by ->srv_init(). */ @@ -785,6 +1122,9 @@ struct ptlrpc_service { //struct ptlrpc_srv_ni srv_interfaces[0]; }; +/** + * Declaration of ptlrpcd control structure + */ struct ptlrpcd_ctl { /** * Ptlrpc thread control flags (LIOD_START, LIOD_STOP, LIOD_FORCE) @@ -793,15 +1133,15 @@ struct ptlrpcd_ctl { /** * Thread lock protecting structure fields. */ - spinlock_t pc_lock; + cfs_spinlock_t pc_lock; /** * Start completion. */ - struct completion pc_starting; + cfs_completion_t pc_starting; /** * Stop completion. */ - struct completion pc_finishing; + cfs_completion_t pc_finishing; /** * Thread requests set. */ @@ -861,12 +1201,18 @@ enum ptlrpcd_ctl_flags { extern lnet_handle_eq_t ptlrpc_eq_h; extern int ptlrpc_uuid_to_peer(struct obd_uuid *uuid, lnet_process_id_t *peer, lnet_nid_t *self); +/** + * These callbacks are invoked by LNet when something happened to + * underlying buffer + * @{ + */ extern void request_out_callback (lnet_event_t *ev); extern void reply_in_callback(lnet_event_t *ev); extern void client_bulk_callback (lnet_event_t *ev); extern void request_in_callback(lnet_event_t *ev); extern void reply_out_callback(lnet_event_t *ev); extern void server_bulk_callback (lnet_event_t *ev); +/** @} */ /* ptlrpc/connection.c */ struct ptlrpc_connection *ptlrpc_connection_get(lnet_process_id_t peer, @@ -879,6 +1225,10 @@ void ptlrpc_connection_fini(void); extern lnet_pid_t ptl_get_pid(void); /* ptlrpc/niobuf.c */ +/** + * Actual interfacing with LNet to put/get/register/unregister stuff + * @{ + */ int ptlrpc_start_bulk_transfer(struct ptlrpc_bulk_desc *desc); void ptlrpc_abort_bulk(struct ptlrpc_bulk_desc *desc); int ptlrpc_register_bulk(struct ptlrpc_request *req); @@ -890,9 +1240,9 @@ static inline int ptlrpc_server_bulk_active(struct ptlrpc_bulk_desc *desc) LASSERT(desc != NULL); - spin_lock(&desc->bd_lock); + cfs_spin_lock(&desc->bd_lock); rc = desc->bd_network_rw; - spin_unlock(&desc->bd_lock); + cfs_spin_unlock(&desc->bd_lock); return rc; } @@ -910,9 +1260,9 @@ static inline int ptlrpc_client_bulk_active(struct ptlrpc_request *req) if (!desc) return 0; - spin_lock(&desc->bd_lock); + cfs_spin_lock(&desc->bd_lock); rc = desc->bd_network_rw; - spin_unlock(&desc->bd_lock); + cfs_spin_unlock(&desc->bd_lock); return rc; } @@ -926,8 +1276,14 @@ void ptlrpc_resend_req(struct ptlrpc_request *request); int ptlrpc_at_get_net_latency(struct ptlrpc_request *req); int ptl_send_rpc(struct ptlrpc_request *request, int noreply); int ptlrpc_register_rqbd (struct ptlrpc_request_buffer_desc *rqbd); +/** @} */ /* ptlrpc/client.c */ +/** + * Client-side portals API. Everything to send requests, receive replies, + * request queues, request management, etc. + * @{ + */ void ptlrpc_init_client(int req_portal, int rep_portal, char *name, struct ptlrpc_client *); void ptlrpc_cleanup_client(struct obd_import *imp); @@ -938,6 +1294,7 @@ int ptlrpc_replay_req(struct ptlrpc_request *req); int ptlrpc_unregister_reply(struct ptlrpc_request *req, int async); void ptlrpc_restart_req(struct ptlrpc_request *req); void ptlrpc_abort_inflight(struct obd_import *imp); +void ptlrpc_cleanup_imp(struct obd_import *imp); void ptlrpc_abort_set(struct ptlrpc_request_set *set); struct ptlrpc_request_set *ptlrpc_prep_set(void); @@ -976,6 +1333,11 @@ struct ptlrpc_request *ptlrpc_request_alloc_pack(struct obd_import *imp, int ptlrpc_request_bufs_pack(struct ptlrpc_request *request, __u32 version, int opcode, char **bufs, struct ptlrpc_cli_ctx *ctx); +struct ptlrpc_request *ptlrpc_prep_fakereq(struct obd_import *imp, + unsigned int timeout, + ptlrpc_interpterer_t interpreter); +void ptlrpc_fakereq_finished(struct ptlrpc_request *req); + struct ptlrpc_request *ptlrpc_prep_req(struct obd_import *imp, __u32 version, int opcode, int count, __u32 *lengths, char **bufs); @@ -999,6 +1361,8 @@ __u64 ptlrpc_next_xid(void); __u64 ptlrpc_sample_next_xid(void); __u64 ptlrpc_req_xid(struct ptlrpc_request *request); +/** @} */ + struct ptlrpc_service_conf { int psc_nbufs; int psc_bufsize; @@ -1013,9 +1377,15 @@ struct ptlrpc_service_conf { }; /* ptlrpc/service.c */ +/** + * Server-side services API. Register/unregister service, request state + * management, service thread management + * + * @{ + */ void ptlrpc_save_lock (struct ptlrpc_request *req, struct lustre_handle *lock, int mode, int no_ack); -void ptlrpc_commit_replies (struct obd_device *obd); +void ptlrpc_commit_replies(struct obd_export *exp); void ptlrpc_dispatch_difficult_reply (struct ptlrpc_reply_state *rs); void ptlrpc_schedule_difficult_reply (struct ptlrpc_reply_state *rs); struct ptlrpc_service *ptlrpc_init_svc_conf(struct ptlrpc_service_conf *c, @@ -1043,6 +1413,9 @@ int liblustre_check_services (void *arg); void ptlrpc_daemonize(char *name); int ptlrpc_service_health_check(struct ptlrpc_service *); void ptlrpc_hpreq_reorder(struct ptlrpc_request *req); +void ptlrpc_server_active_request_inc(struct ptlrpc_request *req); +void ptlrpc_server_active_request_dec(struct ptlrpc_request *req); +void ptlrpc_server_drop_request(struct ptlrpc_request *req); #ifdef __KERNEL__ int ptlrpc_hr_init(void); @@ -1058,8 +1431,13 @@ struct ptlrpc_svc_data { struct ptlrpc_thread *thread; struct obd_device *dev; }; +/** @} */ /* ptlrpc/import.c */ +/** + * Import API + * @{ + */ int ptlrpc_connect_import(struct obd_import *imp, char * new_uuid); int ptlrpc_init_import(struct obd_import *imp); int ptlrpc_disconnect_import(struct obd_import *imp, int noclose); @@ -1067,7 +1445,20 @@ int ptlrpc_import_recovery_state_machine(struct obd_import *imp); /* ptlrpc/pack_generic.c */ int ptlrpc_reconnect_import(struct obd_import *imp); -int lustre_msg_swabbed(struct lustre_msg *msg); +/** @} */ + +/** + * ptlrpc msg buffer and swab interface + * + * @{ + */ +int ptlrpc_buf_need_swab(struct ptlrpc_request *req, const int inout, + int index); +void ptlrpc_buf_set_swabbed(struct ptlrpc_request *req, const int inout, + int index); +int ptlrpc_unpack_rep_msg(struct ptlrpc_request *req, int len); +int ptlrpc_unpack_req_msg(struct ptlrpc_request *req, int len); + int lustre_msg_check_version(struct lustre_msg *msg, __u32 version); void lustre_init_msg_v2(struct lustre_msg_v2 *msg, int count, __u32 *lens, char **bufs); @@ -1083,23 +1474,18 @@ int lustre_pack_reply_flags(struct ptlrpc_request *, int count, __u32 *lens, int lustre_shrink_msg(struct lustre_msg *msg, int segment, unsigned int newlen, int move_data); void lustre_free_reply_state(struct ptlrpc_reply_state *rs); +int __lustre_unpack_msg(struct lustre_msg *m, int len); int lustre_msg_hdr_size(__u32 magic, int count); int lustre_msg_size(__u32 magic, int count, __u32 *lengths); int lustre_msg_size_v2(int count, __u32 *lengths); int lustre_packed_msg_size(struct lustre_msg *msg); int lustre_msg_early_size(void); -int lustre_unpack_msg(struct lustre_msg *m, int len); void *lustre_msg_buf_v2(struct lustre_msg_v2 *m, int n, int min_size); void *lustre_msg_buf(struct lustre_msg *m, int n, int minlen); int lustre_msg_buflen(struct lustre_msg *m, int n); void lustre_msg_set_buflen(struct lustre_msg *m, int n, int len); int lustre_msg_bufcount(struct lustre_msg *m); char *lustre_msg_string (struct lustre_msg *m, int n, int max_len); -void *lustre_swab_buf(struct lustre_msg *, int n, int minlen, void *swabber); -void *lustre_swab_reqbuf(struct ptlrpc_request *req, int n, int minlen, - void *swabber); -void *lustre_swab_repbuf(struct ptlrpc_request *req, int n, int minlen, - void *swabber); __u32 lustre_msghdr_get_flags(struct lustre_msg *msg); void lustre_msghdr_set_flags(struct lustre_msg *msg, __u32 flags); __u32 lustre_msg_get_flags(struct lustre_msg *msg); @@ -1116,6 +1502,7 @@ void lustre_msg_add_version(struct lustre_msg *msg, int version); __u32 lustre_msg_get_opc(struct lustre_msg *msg); __u64 lustre_msg_get_last_xid(struct lustre_msg *msg); __u64 lustre_msg_get_last_committed(struct lustre_msg *msg); +__u64 *lustre_msg_get_versions(struct lustre_msg *msg); __u64 lustre_msg_get_transno(struct lustre_msg *msg); __u64 lustre_msg_get_slv(struct lustre_msg *msg); __u32 lustre_msg_get_limit(struct lustre_msg *msg); @@ -1128,12 +1515,18 @@ __u32 lustre_msg_get_magic(struct lustre_msg *msg); __u32 lustre_msg_get_timeout(struct lustre_msg *msg); __u32 lustre_msg_get_service_time(struct lustre_msg *msg); __u32 lustre_msg_get_cksum(struct lustre_msg *msg); +#if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 9, 0, 0) +__u32 lustre_msg_calc_cksum(struct lustre_msg *msg, int compat18); +#else +# warning "remove checksum compatibility support for b1_8" __u32 lustre_msg_calc_cksum(struct lustre_msg *msg); +#endif void lustre_msg_set_handle(struct lustre_msg *msg,struct lustre_handle *handle); void lustre_msg_set_type(struct lustre_msg *msg, __u32 type); void lustre_msg_set_opc(struct lustre_msg *msg, __u32 opc); void lustre_msg_set_last_xid(struct lustre_msg *msg, __u64 last_xid); void lustre_msg_set_last_committed(struct lustre_msg *msg,__u64 last_committed); +void lustre_msg_set_versions(struct lustre_msg *msg, __u64 *versions); void lustre_msg_set_transno(struct lustre_msg *msg, __u64 transno); void lustre_msg_set_status(struct lustre_msg *msg, __u32 status); void lustre_msg_set_conn_cnt(struct lustre_msg *msg, __u32 conn_cnt); @@ -1152,30 +1545,35 @@ lustre_shrink_reply(struct ptlrpc_request *req, int segment, req->rq_replen = lustre_shrink_msg(req->rq_repmsg, segment, newlen, move_data); } +/** @} */ +/** Change request phase of \a req to \a new_phase */ static inline void ptlrpc_rqphase_move(struct ptlrpc_request *req, enum rq_phase new_phase) { if (req->rq_phase == new_phase) return; - + if (new_phase == RQ_PHASE_UNREGISTERING) { req->rq_next_phase = req->rq_phase; if (req->rq_import) - atomic_inc(&req->rq_import->imp_unregistering); + cfs_atomic_inc(&req->rq_import->imp_unregistering); } - + if (req->rq_phase == RQ_PHASE_UNREGISTERING) { if (req->rq_import) - atomic_dec(&req->rq_import->imp_unregistering); + cfs_atomic_dec(&req->rq_import->imp_unregistering); } - DEBUG_REQ(D_RPCTRACE, req, "move req \"%s\" -> \"%s\"", + DEBUG_REQ(D_INFO, req, "move req \"%s\" -> \"%s\"", ptlrpc_rqphase2str(req), ptlrpc_phase2str(new_phase)); req->rq_phase = new_phase; } +/** + * Returns true if request \a req got early reply and hard deadline is not met + */ static inline int ptlrpc_client_early(struct ptlrpc_request *req) { @@ -1185,6 +1583,9 @@ ptlrpc_client_early(struct ptlrpc_request *req) return req->rq_early; } +/** + * Returns true if we got real reply from server for this request + */ static inline int ptlrpc_client_replied(struct ptlrpc_request *req) { @@ -1194,6 +1595,7 @@ ptlrpc_client_replied(struct ptlrpc_request *req) return req->rq_replied; } +/** Returns true if request \a req is in process of receiving server reply */ static inline int ptlrpc_client_recv(struct ptlrpc_request *req) { @@ -1208,14 +1610,14 @@ ptlrpc_client_recv_or_unlink(struct ptlrpc_request *req) { int rc; - spin_lock(&req->rq_lock); + cfs_spin_lock(&req->rq_lock); if (OBD_FAIL_CHECK(OBD_FAIL_PTLRPC_LONG_REPL_UNLINK) && req->rq_reply_deadline > cfs_time_current_sec()) { - spin_unlock(&req->rq_lock); + cfs_spin_unlock(&req->rq_lock); return 1; } rc = req->rq_receiving_reply || req->rq_must_unlink; - spin_unlock(&req->rq_lock); + cfs_spin_unlock(&req->rq_lock); return rc; } @@ -1231,15 +1633,15 @@ ptlrpc_client_wake_req(struct ptlrpc_request *req) static inline void ptlrpc_rs_addref(struct ptlrpc_reply_state *rs) { - LASSERT(atomic_read(&rs->rs_refcount) > 0); - atomic_inc(&rs->rs_refcount); + LASSERT(cfs_atomic_read(&rs->rs_refcount) > 0); + cfs_atomic_inc(&rs->rs_refcount); } static inline void ptlrpc_rs_decref(struct ptlrpc_reply_state *rs) { - LASSERT(atomic_read(&rs->rs_refcount) > 0); - if (atomic_dec_and_test(&rs->rs_refcount)) + LASSERT(cfs_atomic_read(&rs->rs_refcount) > 0); + if (cfs_atomic_dec_and_test(&rs->rs_refcount)) lustre_free_reply_state(rs); } @@ -1270,7 +1672,32 @@ static inline int ptlrpc_req_get_repsize(struct ptlrpc_request *req) } } +static inline int ptlrpc_send_limit_expired(struct ptlrpc_request *req) +{ + if (req->rq_delay_limit != 0 && + cfs_time_before(cfs_time_add(req->rq_queued_time, + cfs_time_seconds(req->rq_delay_limit)), + cfs_time_current())) { + return 1; + } + return 0; +} + +static inline int ptlrpc_no_resend(struct ptlrpc_request *req) +{ + if (!req->rq_no_resend && ptlrpc_send_limit_expired(req)) { + cfs_spin_lock(&req->rq_lock); + req->rq_no_resend = 1; + cfs_spin_unlock(&req->rq_lock); + } + return req->rq_no_resend; +} + /* ldlm/ldlm_lib.c */ +/** + * Target client logic + * @{ + */ int client_obd_setup(struct obd_device *obddev, struct lustre_cfg *lcfg); int client_obd_cleanup(struct obd_device *obddev); int client_connect_import(const struct lu_env *env, @@ -1282,10 +1709,18 @@ int client_import_add_conn(struct obd_import *imp, struct obd_uuid *uuid, int priority); int client_import_del_conn(struct obd_import *imp, struct obd_uuid *uuid); int import_set_conn_priority(struct obd_import *imp, struct obd_uuid *uuid); +void client_destroy_import(struct obd_import *imp); +/** @} */ + +int server_disconnect_export(struct obd_export *exp); /* ptlrpc/pinger.c */ +/** + * Pinger API (client side only) + * @{ + */ enum timeout_event { - TIMEOUT_GRANT = 1 + TIMEOUT_GRANT = 1 }; struct timeout_item; typedef int (*timeout_cb_t)(struct timeout_item *, void *); @@ -1293,8 +1728,9 @@ int ptlrpc_pinger_add_import(struct obd_import *imp); int ptlrpc_pinger_del_import(struct obd_import *imp); int ptlrpc_add_timeout_client(int time, enum timeout_event event, timeout_cb_t cb, void *data, - struct list_head *obd_list); -int ptlrpc_del_timeout_client(struct list_head *obd_list); + cfs_list_t *obd_list); +int ptlrpc_del_timeout_client(cfs_list_t *obd_list, + enum timeout_event event); struct ptlrpc_request * ptlrpc_prep_ping(struct obd_import *imp); int ptlrpc_obd_ping(struct obd_device *obd); cfs_time_t ptlrpc_suspend_wakeup_time(void); @@ -1306,6 +1742,7 @@ void ping_evictor_stop(void); #define ping_evictor_stop() do {} while (0) #endif int ptlrpc_check_and_wait_suspend(struct ptlrpc_request *req); +/** @} */ /* ptlrpc/ptlrpcd.c */ @@ -1326,11 +1763,16 @@ enum ptlrpcd_scope { int ptlrpcd_start(const char *name, struct ptlrpcd_ctl *pc); void ptlrpcd_stop(struct ptlrpcd_ctl *pc, int force); void ptlrpcd_wake(struct ptlrpc_request *req); -void ptlrpcd_add_req(struct ptlrpc_request *req, enum ptlrpcd_scope scope); +int ptlrpcd_add_req(struct ptlrpc_request *req, enum ptlrpcd_scope scope); +void ptlrpcd_add_rqset(struct ptlrpc_request_set *set); int ptlrpcd_addref(void); void ptlrpcd_decref(void); /* ptlrpc/lproc_ptlrpc.c */ +/** + * procfs output related functions + * @{ + */ const char* ll_opcode2str(__u32 opcode); #ifdef LPROCFS void ptlrpc_lprocfs_register_obd(struct obd_device *obd); @@ -1341,6 +1783,7 @@ static inline void ptlrpc_lprocfs_register_obd(struct obd_device *obd) {} static inline void ptlrpc_lprocfs_unregister_obd(struct obd_device *obd) {} static inline void ptlrpc_lprocfs_brw(struct ptlrpc_request *req, int bytes) {} #endif +/** @} */ /* ptlrpc/llog_server.c */ int llog_origin_handle_create(struct ptlrpc_request *req); @@ -1355,4 +1798,7 @@ int llog_catinfo(struct ptlrpc_request *req); /* ptlrpc/llog_client.c */ extern struct llog_operations llog_client_ops; +/** @} net */ + #endif +/** @} PtlRPC */