File:  [DragonFly] / src / sys / sys / pipe.h
Revision 1.5: download - view: text, annotated - select for diffs
Thu Apr 1 17:58:06 2004 UTC (10 years ago) by dillon
Branches: MAIN
CVS tags: HEAD
Enhance the pmap_kenter*() API and friends, separating out entries which
only need invalidation on the local cpu against entries which need invalidation
across the entire system, and provide a synchronization abstraction.

Enhance sf_buf_alloc() and friends to allow the caller to specify whether the
sf_buf's kernel mapping is going to be used on just the current cpu or
whether it needs to be valid across all cpus.  This is done by maintaining
a cpumask of known-synchronized cpus in the struct sf_buf

Optimize sf_buf_alloc() and friends by removing both TAILQ operations in the
critical path.  TAILQ operations to remove the sf_buf from the free queue
are now done in a lazy fashion.  Most sf_buf operations allocate a buf,
work on it, and free it, so why waste time moving the sf_buf off the freelist
if we are only going to move back onto the free list a microsecond later?

Fix a bug in sf_buf_alloc() code as it was being used by the PIPE code.
sf_buf_alloc() was unconditionally using PCATCH in its tsleep() call, which
is only correct when called from the sendfile() interface.

Optimize the PIPE code to require only local cpu_invlpg()'s when mapping
sf_buf's, greatly reducing the number of IPIs required.  On a DELL-2550,
a pipe test which explicitly blows out the sf_buf caching by using huge
buffers improves from 350 to 550 MBytes/sec.  However, note that buildworld
times were not found to have changed.

Replace the PIPE code's custom 'struct pipemapping' structure with a
struct xio and use the XIO API functions rather then its own.

 * 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.5 2004/04/01 17:58:06 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 */

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

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

#define BIG_PIPE_SIZE	(64*1024)

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

 * 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 */

 * Per-pipe data structure.
 * Two of these are linked together to produce bi-directional pipes.
struct pipe {
	struct	pipebuf pipe_buffer;	/* data storage */
	struct  xio pipe_map;		/* mapping for direct I/O */
	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 */
	int	pipe_busy;		/* busy flag, mostly to handle rundown sanely */

#endif /* !_SYS_PIPE_H_ */