/*
 * Copyright (c) 1996 John S. Dyson
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice immediately at the beginning of the file, without modification,
 *    this list of conditions, and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Absolutely no warranty of function or purpose is made by the author
 *    John S. Dyson.
 * 4. This work was done expressly for inclusion into FreeBSD.  Other use
 *    is allowed if this notation is included.
 * 5. Modifications may be freely made to this file if the above conditions
 *    are met.
 *
 * $FreeBSD: src/sys/sys/pipe.h,v 1.16 1999/12/29 04:24:45 peter Exp $
 * $DragonFly: src/sys/sys/pipe.h,v 1.7 2005/03/01 23:35:16 dillon Exp $
 */

#ifndef _SYS_PIPE_H_
#define _SYS_PIPE_H_

#ifndef _KERNEL
#include <sys/time.h>			/* for struct timespec */
#include <sys/select.h>			/* for struct selinfo */
#include <machine/param.h>		/* for PAGE_SIZE */
#endif

#if !defined(_SYS_XIO_H_)
#include <sys/xio.h>			/* for struct xio */
#endif

/*
 * Pipe buffer size, keep moderate in value, pipes take kva space.
 */
#ifndef PIPE_SIZE
#define PIPE_SIZE	16384
#endif

#ifndef BIG_PIPE_SIZE
#define BIG_PIPE_SIZE	(64*1024)
#endif

/*
 * PIPE_MINDIRECT MUST be smaller than PIPE_SIZE and MUST be bigger
 * than PIPE_BUF.
 */
#ifndef PIPE_MINDIRECT
#define PIPE_MINDIRECT	8192
#endif

/*
 * Pipe buffer information.
 * Separate in, out, cnt are used to simplify calculations.
 * Buffered write is active when the buffer.cnt field is set.
 */
struct pipebuf {
	u_int	cnt;		/* number of chars currently in buffer */
	u_int	in;		/* in pointer */
	u_int	out;		/* out pointer */
	u_int	size;		/* size of buffer */
	caddr_t	buffer;		/* kva of buffer */
	struct  vm_object *object;	/* VM object containing buffer */
};

/*
 * Bits in pipe_state.
 */
#define PIPE_ASYNC	0x0004	/* Async? I/O. */
#define PIPE_WANTR	0x0008	/* Reader wants some characters. */
#define PIPE_WANTW	0x0010	/* Writer wants space to put characters. */
#define PIPE_WANT	0x0020	/* Pipe is wanted to be run-down. */
#define PIPE_SEL	0x0040	/* Pipe has a select active. */
#define PIPE_EOF	0x0080	/* Pipe is in EOF condition. */
#define PIPE_LOCK	0x0100	/* Process has exclusive access to pointers/data. */
#define PIPE_LWANT	0x0200	/* Process wants exclusive access to pointers/data. */
#define PIPE_DIRECTW	0x0400	/* Pipe direct write active. */
#define PIPE_DIRECTOK	0x0800	/* Direct mode ok. */
#define PIPE_DIRECTIP	0x1000	/* Direct write buffer build in progress */

enum pipe_feature { PIPE_COPY, PIPE_KMEM, PIPE_SFBUF1, PIPE_SFBUF2 };
/*
 * Per-pipe data structure.
 * Two of these are linked together to produce bi-directional pipes.
 *
 * NOTE: pipe_buffer.out has the dual purpose of tracking the copy offset
 * for both the direct write case (with the rest of pipe_buffer) and the
 * buffered write case (with pipe_map).
 */
struct pipe {
	struct	pipebuf pipe_buffer;	/* data storage */
	struct  xio pipe_map;		/* mapping for direct I/O */
	vm_offset_t pipe_kva;		/* kva mapping (testing only) */
	cpumask_t pipe_kvamask;		/* kva cpu mask opt */
	struct	selinfo pipe_sel;	/* for compat with select */
	struct	timespec pipe_atime;	/* time of last access */
	struct	timespec pipe_mtime;	/* time of last modify */
	struct	timespec pipe_ctime;	/* time of status change */
	struct	sigio *pipe_sigio;	/* information for async I/O */
	struct	pipe *pipe_peer;	/* link with other direction */
	u_int	pipe_state;		/* pipe status info */
	enum pipe_feature pipe_feature;	/* pipe transfer features */
	int	pipe_busy;		/* busy flag, mostly to handle rundown sanely */
};

#endif /* !_SYS_PIPE_H_ */