[mirror_ubuntu-bionic-kernel.git] / include / linux / sunrpc / sched.h

/*
 * linux/include/linux/sunrpc/sched.h
 *
 * Scheduling primitives for kernel Sun RPC.
 *
 * Copyright (C) 1996, Olaf Kirch <okir@monad.swb.de>
 */

#ifndef _LINUX_SUNRPC_SCHED_H_
#define _LINUX_SUNRPC_SCHED_H_

#include <linux/timer.h>
#include <linux/sunrpc/types.h>
#include <linux/spinlock.h>
#include <linux/wait.h>
#include <linux/workqueue.h>
#include <linux/sunrpc/xdr.h>

/*
 * This is the actual RPC procedure call info.
 */
struct rpc_procinfo;
struct rpc_message {
	struct rpc_procinfo *	rpc_proc;	/* Procedure information */
	void *			rpc_argp;	/* Arguments */
	void *			rpc_resp;	/* Result */
	struct rpc_cred *	rpc_cred;	/* Credentials */
};

struct rpc_call_ops;
struct rpc_wait_queue;
struct rpc_wait {
	struct list_head	list;		/* wait queue links */
	struct list_head	links;		/* Links to related tasks */
	struct list_head	timer_list;	/* Timer list */
	unsigned long		expires;
};

/*
 * This is the RPC task struct
 */
struct rpc_task {
#ifdef RPC_DEBUG
	unsigned long		tk_magic;	/* 0xf00baa */
#endif
	atomic_t		tk_count;	/* Reference count */
	struct list_head	tk_task;	/* global list of tasks */
	struct rpc_clnt *	tk_client;	/* RPC client */
	struct rpc_rqst *	tk_rqstp;	/* RPC request */
	int			tk_status;	/* result of last operation */

	/*
	 * RPC call state
	 */
	struct rpc_message	tk_msg;		/* RPC call info */
	__u8			tk_garb_retry;
	__u8			tk_cred_retry;

	/*
	 * callback	to be executed after waking up
	 * action	next procedure for async tasks
	 * tk_ops	caller callbacks
	 */
	void			(*tk_callback)(struct rpc_task *);
	void			(*tk_action)(struct rpc_task *);
	const struct rpc_call_ops *tk_ops;
	void *			tk_calldata;

	unsigned long		tk_timeout;	/* timeout for rpc_sleep() */
	unsigned short		tk_flags;	/* misc flags */
	unsigned long		tk_runstate;	/* Task run status */
	struct workqueue_struct	*tk_workqueue;	/* Normally rpciod, but could
						 * be any workqueue
						 */
	struct rpc_wait_queue 	*tk_waitqueue;	/* RPC wait queue we're on */
	union {
		struct work_struct	tk_work;	/* Async task work queue */
		struct rpc_wait		tk_wait;	/* RPC wait */
	} u;

	unsigned short		tk_timeouts;	/* maj timeouts */
	size_t			tk_bytes_sent;	/* total bytes sent */
	unsigned long		tk_start;	/* RPC task init timestamp */
	long			tk_rtt;		/* round-trip time (jiffies) */

	pid_t			tk_owner;	/* Process id for batching tasks */
	unsigned char		tk_priority : 2;/* Task priority */

#ifdef RPC_DEBUG
	unsigned short		tk_pid;		/* debugging aid */
#endif
};
#define tk_xprt			tk_client->cl_xprt

/* support walking a list of tasks on a wait queue */
#define	task_for_each(task, pos, head) \
	list_for_each(pos, head) \
		if ((task=list_entry(pos, struct rpc_task, u.tk_wait.list)),1)

#define	task_for_first(task, head) \
	if (!list_empty(head) &&  \
	    ((task=list_entry((head)->next, struct rpc_task, u.tk_wait.list)),1))

typedef void			(*rpc_action)(struct rpc_task *);

struct rpc_call_ops {
	void (*rpc_call_prepare)(struct rpc_task *, void *);
	void (*rpc_call_done)(struct rpc_task *, void *);
	void (*rpc_release)(void *);
};

struct rpc_task_setup {
	struct rpc_task *task;
	struct rpc_clnt *rpc_client;
	const struct rpc_message *rpc_message;
	const struct rpc_call_ops *callback_ops;
	void *callback_data;
	struct workqueue_struct *workqueue;
	unsigned short flags;
	signed char priority;
};

/*
 * RPC task flags
 */
#define RPC_TASK_ASYNC		0x0001		/* is an async task */
#define RPC_TASK_SWAPPER	0x0002		/* is swapping in/out */
#define RPC_CALL_MAJORSEEN	0x0020		/* major timeout seen */
#define RPC_TASK_ROOTCREDS	0x0040		/* force root creds */
#define RPC_TASK_DYNAMIC	0x0080		/* task was kmalloc'ed */
#define RPC_TASK_KILLED		0x0100		/* task was killed */
#define RPC_TASK_SOFT		0x0200		/* Use soft timeouts */

#define RPC_IS_ASYNC(t)		((t)->tk_flags & RPC_TASK_ASYNC)
#define RPC_IS_SWAPPER(t)	((t)->tk_flags & RPC_TASK_SWAPPER)
#define RPC_DO_ROOTOVERRIDE(t)	((t)->tk_flags & RPC_TASK_ROOTCREDS)
#define RPC_ASSASSINATED(t)	((t)->tk_flags & RPC_TASK_KILLED)
#define RPC_IS_SOFT(t)		((t)->tk_flags & RPC_TASK_SOFT)

#define RPC_TASK_RUNNING	0
#define RPC_TASK_QUEUED		1
#define RPC_TASK_ACTIVE		2

#define RPC_IS_RUNNING(t)	test_bit(RPC_TASK_RUNNING, &(t)->tk_runstate)
#define rpc_set_running(t)	set_bit(RPC_TASK_RUNNING, &(t)->tk_runstate)
#define rpc_test_and_set_running(t) \
				test_and_set_bit(RPC_TASK_RUNNING, &(t)->tk_runstate)
#define rpc_clear_running(t)	\
	do { \
		smp_mb__before_clear_bit(); \
		clear_bit(RPC_TASK_RUNNING, &(t)->tk_runstate); \
		smp_mb__after_clear_bit(); \
	} while (0)

#define RPC_IS_QUEUED(t)	test_bit(RPC_TASK_QUEUED, &(t)->tk_runstate)
#define rpc_set_queued(t)	set_bit(RPC_TASK_QUEUED, &(t)->tk_runstate)
#define rpc_clear_queued(t)	\
	do { \
		smp_mb__before_clear_bit(); \
		clear_bit(RPC_TASK_QUEUED, &(t)->tk_runstate); \
		smp_mb__after_clear_bit(); \
	} while (0)

#define RPC_IS_ACTIVATED(t)	test_bit(RPC_TASK_ACTIVE, &(t)->tk_runstate)

/*
 * Task priorities.
 * Note: if you change these, you must also change
 * the task initialization definitions below.
 */
#define RPC_PRIORITY_LOW	(-1)
#define RPC_PRIORITY_NORMAL	(0)
#define RPC_PRIORITY_HIGH	(1)
#define RPC_NR_PRIORITY		(1 + RPC_PRIORITY_HIGH - RPC_PRIORITY_LOW)

struct rpc_timer {
	struct timer_list timer;
	struct list_head list;
	unsigned long expires;
};

/*
 * RPC synchronization objects
 */
struct rpc_wait_queue {
	spinlock_t		lock;
	struct list_head	tasks[RPC_NR_PRIORITY];	/* task queue for each priority level */
	pid_t			owner;			/* process id of last task serviced */
	unsigned char		maxpriority;		/* maximum priority (0 if queue is not a priority queue) */
	unsigned char		priority;		/* current priority */
	unsigned char		count;			/* # task groups remaining serviced so far */
	unsigned char		nr;			/* # tasks remaining for cookie */
	unsigned short		qlen;			/* total # tasks waiting in queue */
	struct rpc_timer	timer_list;
#ifdef RPC_DEBUG
	const char *		name;
#endif
};

/*
 * This is the # requests to send consecutively
 * from a single cookie.  The aim is to improve
 * performance of NFS operations such as read/write.
 */
#define RPC_BATCH_COUNT			16
#define RPC_IS_PRIORITY(q)		((q)->maxpriority > 0)

/*
 * Function prototypes
 */
struct rpc_task *rpc_new_task(const struct rpc_task_setup *);
struct rpc_task *rpc_run_task(const struct rpc_task_setup *);
void		rpc_put_task(struct rpc_task *);
void		rpc_exit_task(struct rpc_task *);
void		rpc_release_calldata(const struct rpc_call_ops *, void *);
void		rpc_killall_tasks(struct rpc_clnt *);
void		rpc_execute(struct rpc_task *);
void		rpc_init_priority_wait_queue(struct rpc_wait_queue *, const char *);
void		rpc_init_wait_queue(struct rpc_wait_queue *, const char *);
void		rpc_destroy_wait_queue(struct rpc_wait_queue *);
void		rpc_sleep_on(struct rpc_wait_queue *, struct rpc_task *,
					rpc_action action);
void		rpc_wake_up_queued_task(struct rpc_wait_queue *,
					struct rpc_task *);
void		rpc_wake_up(struct rpc_wait_queue *);
struct rpc_task *rpc_wake_up_next(struct rpc_wait_queue *);
void		rpc_wake_up_status(struct rpc_wait_queue *, int);
void		rpc_delay(struct rpc_task *, unsigned long);
void *		rpc_malloc(struct rpc_task *, size_t);
void		rpc_free(void *);
int		rpciod_up(void);
void		rpciod_down(void);
int		__rpc_wait_for_completion_task(struct rpc_task *task, int (*)(void *));
#ifdef RPC_DEBUG
void		rpc_show_tasks(void);
#endif
int		rpc_init_mempool(void);
void		rpc_destroy_mempool(void);
extern struct workqueue_struct *rpciod_workqueue;

static inline void rpc_exit(struct rpc_task *task, int status)
{
	task->tk_status = status;
	task->tk_action = rpc_exit_task;
}

static inline int rpc_wait_for_completion_task(struct rpc_task *task)
{
	return __rpc_wait_for_completion_task(task, NULL);
}

#ifdef RPC_DEBUG
static inline const char * rpc_qname(struct rpc_wait_queue *q)
{
	return ((q && q->name) ? q->name : "unknown");
}
#endif

#endif /* _LINUX_SUNRPC_SCHED_H_ */
Commit	Line	Data
1da177e4 LT	1	/*
	2	* linux/include/linux/sunrpc/sched.h
	3	*
	4	* Scheduling primitives for kernel Sun RPC.
	5	*
	6	* Copyright (C) 1996, Olaf Kirch <okir@monad.swb.de>
	7	*/
	8
	9	#ifndef _LINUX_SUNRPC_SCHED_H_
	10	#define _LINUX_SUNRPC_SCHED_H_
	11
	12	#include <linux/timer.h>
	13	#include <linux/sunrpc/types.h>
	14	#include <linux/spinlock.h>
	15	#include <linux/wait.h>
	16	#include <linux/workqueue.h>
	17	#include <linux/sunrpc/xdr.h>
	18
	19	/*
	20	* This is the actual RPC procedure call info.
	21	*/
	22	struct rpc_procinfo;
	23	struct rpc_message {
	24	struct rpc_procinfo * rpc_proc; /* Procedure information */
	25	void * rpc_argp; /* Arguments */
	26	void * rpc_resp; /* Result */
	27	struct rpc_cred * rpc_cred; /* Credentials */
	28	};
	29
963d8fe5	30	struct rpc_call_ops;
1da177e4 LT	31	struct rpc_wait_queue;
	32	struct rpc_wait {
	33	struct list_head list; /* wait queue links */
	34	struct list_head links; /* Links to related tasks */
36df9aae TM	35	struct list_head timer_list; /* Timer list */
36df9aae TM	36	unsigned long expires;
1da177e4 LT	37	};
	38
	39	/*
	40	* This is the RPC task struct
	41	*/
	42	struct rpc_task {
	43	#ifdef RPC_DEBUG
	44	unsigned long tk_magic; /* 0xf00baa */
	45	#endif
44c28873	46	atomic_t tk_count; /* Reference count */
1da177e4 LT	47	struct list_head tk_task; /* global list of tasks */
	48	struct rpc_clnt * tk_client; /* RPC client */
	49	struct rpc_rqst * tk_rqstp; /* RPC request */
	50	int tk_status; /* result of last operation */
	51
	52	/*
	53	* RPC call state
	54	*/
	55	struct rpc_message tk_msg; /* RPC call info */
1da177e4 LT	56	__u8 tk_garb_retry;
	57	__u8 tk_cred_retry;
	58
1da177e4	59	/*
1da177e4 LT	60	* callback to be executed after waking up
1da177e4 LT	61	* action next procedure for async tasks
963d8fe5	62	* tk_ops caller callbacks
1da177e4	63	*/
1da177e4 LT	64	void (tk_callback)(struct rpc_task );
1da177e4 LT	65	void (tk_action)(struct rpc_task );
963d8fe5	66	const struct rpc_call_ops *tk_ops;
1da177e4 LT	67	void * tk_calldata;
1da177e4 LT	68
1da177e4 LT	69	unsigned long tk_timeout; /* timeout for rpc_sleep() */
1da177e4 LT	70	unsigned short tk_flags; /* misc flags */
1da177e4 LT	71	unsigned long tk_runstate; /* Task run status */
	72	struct workqueue_struct tk_workqueue; / Normally rpciod, but could
	73	* be any workqueue
	74	*/
96ef13b2	75	struct rpc_wait_queue tk_waitqueue; / RPC wait queue we're on */
1da177e4 LT	76	union {
	77	struct work_struct tk_work; /* Async task work queue */
	78	struct rpc_wait tk_wait; /* RPC wait */
	79	} u;
ef759a2e CL	80
	81	unsigned short tk_timeouts; /* maj timeouts */
	82	size_t tk_bytes_sent; /* total bytes sent */
	83	unsigned long tk_start; /* RPC task init timestamp */
	84	long tk_rtt; /* round-trip time (jiffies) */
	85
3ff7576d TM	86	pid_t tk_owner; /* Process id for batching tasks */
	87	unsigned char tk_priority : 2;/* Task priority */
	88
1da177e4 LT	89	#ifdef RPC_DEBUG
	90	unsigned short tk_pid; /* debugging aid */
	91	#endif
	92	};
1da177e4 LT	93	#define tk_xprt tk_client->cl_xprt
	94
	95	/* support walking a list of tasks on a wait queue */
	96	#define task_for_each(task, pos, head) \
	97	list_for_each(pos, head) \
	98	if ((task=list_entry(pos, struct rpc_task, u.tk_wait.list)),1)
	99
	100	#define task_for_first(task, head) \
	101	if (!list_empty(head) && \
	102	((task=list_entry((head)->next, struct rpc_task, u.tk_wait.list)),1))
	103
1da177e4 LT	104	typedef void (rpc_action)(struct rpc_task );
1da177e4 LT	105
963d8fe5	106	struct rpc_call_ops {
4ce70ada	107	void (rpc_call_prepare)(struct rpc_task , void *);
963d8fe5 TM	108	void (rpc_call_done)(struct rpc_task , void *);
	109	void (rpc_release)(void );
	110	};
	111
84115e1c	112	struct rpc_task_setup {
e8f5d77c	113	struct rpc_task *task;
84115e1c TM	114	struct rpc_clnt *rpc_client;
	115	const struct rpc_message *rpc_message;
	116	const struct rpc_call_ops *callback_ops;
	117	void *callback_data;
32bfb5c0	118	struct workqueue_struct *workqueue;
84115e1c	119	unsigned short flags;
3ff7576d	120	signed char priority;
84115e1c	121	};
963d8fe5	122
1da177e4 LT	123	/*
	124	* RPC task flags
	125	*/
	126	#define RPC_TASK_ASYNC 0x0001 /* is an async task */
	127	#define RPC_TASK_SWAPPER 0x0002 /* is swapping in/out */
1da177e4 LT	128	#define RPC_CALL_MAJORSEEN 0x0020 /* major timeout seen */
	129	#define RPC_TASK_ROOTCREDS 0x0040 /* force root creds */
	130	#define RPC_TASK_DYNAMIC 0x0080 /* task was kmalloc'ed */
	131	#define RPC_TASK_KILLED 0x0100 /* task was killed */
	132	#define RPC_TASK_SOFT 0x0200 /* Use soft timeouts */
1da177e4 LT	133
1da177e4 LT	134	#define RPC_IS_ASYNC(t) ((t)->tk_flags & RPC_TASK_ASYNC)
1da177e4 LT	135	#define RPC_IS_SWAPPER(t) ((t)->tk_flags & RPC_TASK_SWAPPER)
	136	#define RPC_DO_ROOTOVERRIDE(t) ((t)->tk_flags & RPC_TASK_ROOTCREDS)
	137	#define RPC_ASSASSINATED(t) ((t)->tk_flags & RPC_TASK_KILLED)
1da177e4	138	#define RPC_IS_SOFT(t) ((t)->tk_flags & RPC_TASK_SOFT)
1da177e4 LT	139
	140	#define RPC_TASK_RUNNING 0
	141	#define RPC_TASK_QUEUED 1
f5fb7b06	142	#define RPC_TASK_ACTIVE 2
1da177e4	143
7b8f850b RB	144	#define RPC_IS_RUNNING(t) test_bit(RPC_TASK_RUNNING, &(t)->tk_runstate)
7b8f850b RB	145	#define rpc_set_running(t) set_bit(RPC_TASK_RUNNING, &(t)->tk_runstate)
1da177e4	146	#define rpc_test_and_set_running(t) \
7b8f850b	147	test_and_set_bit(RPC_TASK_RUNNING, &(t)->tk_runstate)
1da177e4 LT	148	#define rpc_clear_running(t) \
	149	do { \
	150	smp_mb__before_clear_bit(); \
	151	clear_bit(RPC_TASK_RUNNING, &(t)->tk_runstate); \
	152	smp_mb__after_clear_bit(); \
	153	} while (0)
	154
7b8f850b RB	155	#define RPC_IS_QUEUED(t) test_bit(RPC_TASK_QUEUED, &(t)->tk_runstate)
7b8f850b RB	156	#define rpc_set_queued(t) set_bit(RPC_TASK_QUEUED, &(t)->tk_runstate)
1da177e4 LT	157	#define rpc_clear_queued(t) \
	158	do { \
	159	smp_mb__before_clear_bit(); \
	160	clear_bit(RPC_TASK_QUEUED, &(t)->tk_runstate); \
	161	smp_mb__after_clear_bit(); \
	162	} while (0)
1da177e4	163
7b8f850b	164	#define RPC_IS_ACTIVATED(t) test_bit(RPC_TASK_ACTIVE, &(t)->tk_runstate)
44c28873	165
1da177e4 LT	166	/*
	167	* Task priorities.
	168	* Note: if you change these, you must also change
	169	* the task initialization definitions below.
	170	*/
3ff7576d TM	171	#define RPC_PRIORITY_LOW (-1)
	172	#define RPC_PRIORITY_NORMAL (0)
	173	#define RPC_PRIORITY_HIGH (1)
	174	#define RPC_NR_PRIORITY (1 + RPC_PRIORITY_HIGH - RPC_PRIORITY_LOW)
1da177e4	175
36df9aae TM	176	struct rpc_timer {
	177	struct timer_list timer;
	178	struct list_head list;
	179	unsigned long expires;
	180	};
	181
1da177e4 LT	182	/*
	183	* RPC synchronization objects
	184	*/
	185	struct rpc_wait_queue {
	186	spinlock_t lock;
	187	struct list_head tasks[RPC_NR_PRIORITY]; /* task queue for each priority level */
3ff7576d	188	pid_t owner; /* process id of last task serviced */
1da177e4 LT	189	unsigned char maxpriority; /* maximum priority (0 if queue is not a priority queue) */
	190	unsigned char priority; /* current priority */
	191	unsigned char count; /* # task groups remaining serviced so far */
	192	unsigned char nr; /* # tasks remaining for cookie */
e19b63da	193	unsigned short qlen; /* total # tasks waiting in queue */
36df9aae	194	struct rpc_timer timer_list;
1da177e4 LT	195	#ifdef RPC_DEBUG
	196	const char * name;
	197	#endif
	198	};
	199
	200	/*
	201	* This is the # requests to send consecutively
	202	* from a single cookie. The aim is to improve
	203	* performance of NFS operations such as read/write.
	204	*/
	205	#define RPC_BATCH_COUNT 16
1da177e4 LT	206	#define RPC_IS_PRIORITY(q) ((q)->maxpriority > 0)
	207
	208	/*
	209	* Function prototypes
	210	*/
84115e1c	211	struct rpc_task rpc_new_task(const struct rpc_task_setup );
c970aa85	212	struct rpc_task rpc_run_task(const struct rpc_task_setup );
e6b3c4db	213	void rpc_put_task(struct rpc_task *);
abbcf28f	214	void rpc_exit_task(struct rpc_task *);
bbd5a1f9	215	void rpc_release_calldata(const struct rpc_call_ops , void );
1da177e4	216	void rpc_killall_tasks(struct rpc_clnt *);
2efef837	217	void rpc_execute(struct rpc_task *);
1da177e4 LT	218	void rpc_init_priority_wait_queue(struct rpc_wait_queue , const char );
1da177e4 LT	219	void rpc_init_wait_queue(struct rpc_wait_queue , const char );
f6a1cc89	220	void rpc_destroy_wait_queue(struct rpc_wait_queue *);
1da177e4	221	void rpc_sleep_on(struct rpc_wait_queue , struct rpc_task ,
5d00837b	222	rpc_action action);
96ef13b2 TM	223	void rpc_wake_up_queued_task(struct rpc_wait_queue *,
96ef13b2 TM	224	struct rpc_task *);
1da177e4 LT	225	void rpc_wake_up(struct rpc_wait_queue *);
	226	struct rpc_task rpc_wake_up_next(struct rpc_wait_queue );
	227	void rpc_wake_up_status(struct rpc_wait_queue *, int);
	228	void rpc_delay(struct rpc_task *, unsigned long);
	229	void * rpc_malloc(struct rpc_task *, size_t);
c5a4dd8b	230	void rpc_free(void *);
1da177e4 LT	231	int rpciod_up(void);
1da177e4 LT	232	void rpciod_down(void);
44c28873	233	int __rpc_wait_for_completion_task(struct rpc_task task, int ()(void *));
1da177e4 LT	234	#ifdef RPC_DEBUG
	235	void rpc_show_tasks(void);
	236	#endif
	237	int rpc_init_mempool(void);
	238	void rpc_destroy_mempool(void);
24c5d9d7	239	extern struct workqueue_struct *rpciod_workqueue;
1da177e4 LT	240
	241	static inline void rpc_exit(struct rpc_task *task, int status)
	242	{
	243	task->tk_status = status;
abbcf28f	244	task->tk_action = rpc_exit_task;
1da177e4 LT	245	}
1da177e4 LT	246
44c28873 TM	247	static inline int rpc_wait_for_completion_task(struct rpc_task *task)
	248	{
	249	return __rpc_wait_for_completion_task(task, NULL);
	250	}
	251
1da177e4 LT	252	#ifdef RPC_DEBUG
	253	static inline const char * rpc_qname(struct rpc_wait_queue *q)
	254	{
	255	return ((q && q->name) ? q->name : "unknown");
	256	}
	257	#endif
	258
	259	#endif /* _LINUX_SUNRPC_SCHED_H_ */