[thirdparty/kernel/linux.git] / include / linux / splice.h

/* SPDX-License-Identifier: GPL-2.0 */
/*
 * Function declerations and data structures related to the splice
 * implementation.
 *
 * Copyright (C) 2007 Jens Axboe <jens.axboe@oracle.com>
 *
 */
#ifndef SPLICE_H
#define SPLICE_H

#include <linux/pipe_fs_i.h>

/*
 * Flags passed in from splice/tee/vmsplice
 */
#define SPLICE_F_MOVE	(0x01)	/* move pages instead of copying */
#define SPLICE_F_NONBLOCK (0x02) /* don't block on the pipe splicing (but */
				 /* we may still block on the fd we splice */
				 /* from/to, of course */
#define SPLICE_F_MORE	(0x04)	/* expect more data */
#define SPLICE_F_GIFT	(0x08)	/* pages passed in are a gift */

#define SPLICE_F_ALL (SPLICE_F_MOVE|SPLICE_F_NONBLOCK|SPLICE_F_MORE|SPLICE_F_GIFT)

/*
 * Passed to the actors
 */
struct splice_desc {
	size_t total_len;		/* remaining length */
	unsigned int len;		/* current length */
	unsigned int flags;		/* splice flags */
	/*
	 * actor() private data
	 */
	union {
		void __user *userptr;	/* memory to write to */
		struct file *file;	/* file to read/write */
		void *data;		/* cookie */
	} u;
	void (*splice_eof)(struct splice_desc *sd); /* Unexpected EOF handler */
	loff_t pos;			/* file position */
	loff_t *opos;			/* sendfile: output position */
	size_t num_spliced;		/* number of bytes already spliced */
	bool need_wakeup;		/* need to wake up writer */
};

struct partial_page {
	unsigned int offset;
	unsigned int len;
	unsigned long private;
};

/*
 * Passed to splice_to_pipe
 */
struct splice_pipe_desc {
	struct page **pages;		/* page map */
	struct partial_page *partial;	/* pages[] may not be contig */
	int nr_pages;			/* number of populated pages in map */
	unsigned int nr_pages_max;	/* pages[] & partial[] arrays size */
	const struct pipe_buf_operations *ops;/* ops associated with output pipe */
	void (*spd_release)(struct splice_pipe_desc *, unsigned int);
};

typedef int (splice_actor)(struct pipe_inode_info *, struct pipe_buffer *,
			   struct splice_desc *);
typedef int (splice_direct_actor)(struct pipe_inode_info *,
				  struct splice_desc *);

ssize_t splice_from_pipe(struct pipe_inode_info *pipe, struct file *out,
			 loff_t *ppos, size_t len, unsigned int flags,
			 splice_actor *actor);
ssize_t __splice_from_pipe(struct pipe_inode_info *pipe,
			   struct splice_desc *sd, splice_actor *actor);
ssize_t splice_to_pipe(struct pipe_inode_info *pipe,
			      struct splice_pipe_desc *spd);
ssize_t add_to_pipe(struct pipe_inode_info *pipe, struct pipe_buffer *buf);
ssize_t vfs_splice_read(struct file *in, loff_t *ppos,
			struct pipe_inode_info *pipe, size_t len,
			unsigned int flags);
ssize_t splice_direct_to_actor(struct file *file, struct splice_desc *sd,
			       splice_direct_actor *actor);
ssize_t do_splice(struct file *in, loff_t *off_in, struct file *out,
		  loff_t *off_out, size_t len, unsigned int flags);
ssize_t do_splice_direct(struct file *in, loff_t *ppos, struct file *out,
			 loff_t *opos, size_t len, unsigned int flags);
ssize_t splice_file_range(struct file *in, loff_t *ppos, struct file *out,
			  loff_t *opos, size_t len);

ssize_t do_tee(struct file *in, struct file *out, size_t len,
	       unsigned int flags);
ssize_t splice_to_socket(struct pipe_inode_info *pipe, struct file *out,
			 loff_t *ppos, size_t len, unsigned int flags);

/*
 * for dynamic pipe sizing
 */
extern int splice_grow_spd(const struct pipe_inode_info *, struct splice_pipe_desc *);
extern void splice_shrink_spd(struct splice_pipe_desc *);

extern const struct pipe_buf_operations page_cache_pipe_buf_ops;
extern const struct pipe_buf_operations default_pipe_buf_ops;
#endif
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
d6b29d7c JA	2	/*
	3	* Function declerations and data structures related to the splice
	4	* implementation.
	5	*
	6	* Copyright (C) 2007 Jens Axboe <jens.axboe@oracle.com>
	7	*
	8	*/
	9	#ifndef SPLICE_H
	10	#define SPLICE_H
	11
	12	#include <linux/pipe_fs_i.h>
	13
	14	/*
2b1ccc0e	15	* Flags passed in from splice/tee/vmsplice
d6b29d7c JA	16	*/
	17	#define SPLICE_F_MOVE (0x01) /* move pages instead of copying */
	18	#define SPLICE_F_NONBLOCK (0x02) /* don't block on the pipe splicing (but */
	19	/* we may still block on the fd we splice */
	20	/* from/to, of course */
	21	#define SPLICE_F_MORE (0x04) /* expect more data */
	22	#define SPLICE_F_GIFT (0x08) /* pages passed in are a gift */
	23
3d6ea290 AV	24	#define SPLICE_F_ALL (SPLICE_F_MOVE\|SPLICE_F_NONBLOCK\|SPLICE_F_MORE\|SPLICE_F_GIFT)
3d6ea290 AV	25
d6b29d7c JA	26	/*
	27	* Passed to the actors
	28	*/
	29	struct splice_desc {
53e0ee9f XG	30	size_t total_len; /* remaining length */
53e0ee9f XG	31	unsigned int len; /* current length */
d6b29d7c JA	32	unsigned int flags; /* splice flags */
	33	/*
	34	* actor() private data
	35	*/
	36	union {
	37	void __user userptr; / memory to write to */
	38	struct file file; / file to read/write */
	39	void data; / cookie */
	40	} u;
2bfc6685	41	void (splice_eof)(struct splice_desc sd); /* Unexpected EOF handler */
d6b29d7c	42	loff_t pos; /* file position */
7995bd28	43	loff_t opos; / sendfile: output position */
b3c2d2dd MS	44	size_t num_spliced; /* number of bytes already spliced */
b3c2d2dd MS	45	bool need_wakeup; /* need to wake up writer */
d6b29d7c JA	46	};
	47
	48	struct partial_page {
	49	unsigned int offset;
	50	unsigned int len;
497f9625	51	unsigned long private;
d6b29d7c JA	52	};
	53
	54	/*
	55	* Passed to splice_to_pipe
	56	*/
	57	struct splice_pipe_desc {
	58	struct page *pages; / page map */
	59	struct partial_page partial; / pages[] may not be contig */
047fe360 ED	60	int nr_pages; /* number of populated pages in map */
047fe360 ED	61	unsigned int nr_pages_max; /* pages[] & partial[] arrays size */
d6b29d7c	62	const struct pipe_buf_operations ops;/ ops associated with output pipe */
bbdfc2f7	63	void (spd_release)(struct splice_pipe_desc , unsigned int);
d6b29d7c JA	64	};
	65
	66	typedef int (splice_actor)(struct pipe_inode_info , struct pipe_buffer ,
	67	struct splice_desc *);
	68	typedef int (splice_direct_actor)(struct pipe_inode_info *,
	69	struct splice_desc *);
	70
0f292086 AG	71	ssize_t splice_from_pipe(struct pipe_inode_info pipe, struct file out,
	72	loff_t *ppos, size_t len, unsigned int flags,
	73	splice_actor *actor);
	74	ssize_t __splice_from_pipe(struct pipe_inode_info *pipe,
	75	struct splice_desc sd, splice_actor actor);
	76	ssize_t splice_to_pipe(struct pipe_inode_info *pipe,
	77	struct splice_pipe_desc *spd);
	78	ssize_t add_to_pipe(struct pipe_inode_info pipe, struct pipe_buffer buf);
	79	ssize_t vfs_splice_read(struct file in, loff_t ppos,
	80	struct pipe_inode_info *pipe, size_t len,
	81	unsigned int flags);
488e8f68 AG	82	ssize_t splice_direct_to_actor(struct file file, struct splice_desc sd,
488e8f68 AG	83	splice_direct_actor *actor);
0f292086 AG	84	ssize_t do_splice(struct file in, loff_t off_in, struct file *out,
	85	loff_t *off_out, size_t len, unsigned int flags);
	86	ssize_t do_splice_direct(struct file in, loff_t ppos, struct file *out,
	87	loff_t *opos, size_t len, unsigned int flags);
	88	ssize_t splice_file_range(struct file in, loff_t ppos, struct file *out,
	89	loff_t *opos, size_t len);
d6b29d7c	90
0f292086 AG	91	ssize_t do_tee(struct file in, struct file out, size_t len,
	92	unsigned int flags);
	93	ssize_t splice_to_socket(struct pipe_inode_info pipe, struct file out,
	94	loff_t *ppos, size_t len, unsigned int flags);
9dafdfc2	95
35f3d14d JA	96	/*
	97	* for dynamic pipe sizing
	98	*/
047fe360 ED	99	extern int splice_grow_spd(const struct pipe_inode_info , struct splice_pipe_desc );
047fe360 ED	100	extern void splice_shrink_spd(struct splice_pipe_desc *);
35f3d14d	101
708e3508	102	extern const struct pipe_buf_operations page_cache_pipe_buf_ops;
241699cd	103	extern const struct pipe_buf_operations default_pipe_buf_ops;
d6b29d7c	104	#endif