1/*-
  2 * SPDX-License-Identifier: BSD-3-Clause
  3 *
  4 * Copyright (c) 1982, 1986, 1993, 1994
  5 *	The Regents of the University of California.  All rights reserved.
  6 *
  7 * Redistribution and use in source and binary forms, with or without
  8 * modification, are permitted provided that the following conditions
  9 * are met:
 10 * 1. Redistributions of source code must retain the above copyright
 11 *    notice, this list of conditions and the following disclaimer.
 12 * 2. Redistributions in binary form must reproduce the above copyright
 13 *    notice, this list of conditions and the following disclaimer in the
 14 *    documentation and/or other materials provided with the distribution.
 15 * 3. Neither the name of the University nor the names of its contributors
 16 *    may be used to endorse or promote products derived from this software
 17 *    without specific prior written permission.
 18 *
 19 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 22 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 29 * SUCH DAMAGE.
 30 *
 31 *	@(#)uio.h	8.5 (Berkeley) 2/22/94
 32 */
 33
 34#ifndef _SYS_UIO_H_
 35#define	_SYS_UIO_H_
 36
 37#include <sys/cdefs.h>
 38#include <sys/_types.h>
 39#include <sys/_iovec.h>
 40#include <sys/_uio.h>
 41
 42#ifndef _SSIZE_T_DECLARED
 43typedef	__ssize_t	ssize_t;
 44#define	_SSIZE_T_DECLARED
 45#endif
 46
 47#ifndef _OFF_T_DECLARED
 48typedef	__off_t	off_t;
 49#define	_OFF_T_DECLARED
 50#endif
 51
 52#ifdef _KERNEL
 53
 54struct uio {
 55	struct	iovec *uio_iov;		/* scatter/gather list */
 56	int	uio_iovcnt;		/* length of scatter/gather list */
 57	off_t	uio_offset;		/* offset in target object */
 58	ssize_t	uio_resid;		/* remaining bytes to process */
 59	enum	uio_seg uio_segflg;	/* address space */
 60	enum	uio_rw uio_rw;		/* operation */
 61	struct	thread *uio_td;		/* owner */
 62};
 63
 64/*
 65 * Limits
 66 *
 67 * N.B.: UIO_MAXIOV must be no less than IOV_MAX from <sys/syslimits.h>
 68 * which in turn must be no less than _XOPEN_IOV_MAX from <limits.h>.  If
 69 * we ever make this tunable (probably pointless), then IOV_MAX should be
 70 * removed from <sys/syslimits.h> and applications would be expected to use
 71 * sysconf(3) to find out the correct value, or else assume the worst
 72 * (_XOPEN_IOV_MAX).  Perhaps UIO_MAXIOV should be simply defined as
 73 * IOV_MAX.
 74 */
 75#define UIO_MAXIOV	1024		/* max 1K of iov's */
 76
 77struct vm_object;
 78struct vm_page;
 79struct bus_dma_segment;
 80
 81struct uio *allocuio(u_int iovcnt);
 82void	freeuio(struct uio *uio);
 83struct uio *cloneuio(struct uio *uiop);
 84int	copyiniov(const struct iovec *iovp, u_int iovcnt, struct iovec **iov,
 85	    int error);
 86int	copyinuio(const struct iovec *iovp, u_int iovcnt, struct uio **uiop);
 87int	copyout_map(struct thread *td, vm_offset_t *addr, size_t sz);
 88int	copyout_unmap(struct thread *td, vm_offset_t addr, size_t sz);
 89int	physcopyin(void *src, vm_paddr_t dst, size_t len);
 90int	physcopyout(vm_paddr_t src, void *dst, size_t len);
 91int	physcopyin_vlist(struct bus_dma_segment *src, off_t offset,
 92	    vm_paddr_t dst, size_t len);
 93int	physcopyout_vlist(vm_paddr_t src, struct bus_dma_segment *dst,
 94	    off_t offset, size_t len);
 95int	uiomove(void *cp, int n, struct uio *uio);
 96int	uiomove_frombuf(void *buf, int buflen, struct uio *uio);
 97int	uiomove_fromphys(struct vm_page *ma[], vm_offset_t offset, int n,
 98	    struct uio *uio);
 99int	uiomove_nofault(void *cp, int n, struct uio *uio);
100int	uiomove_object(struct vm_object *obj, off_t obj_size, struct uio *uio);
101
102#else /* !_KERNEL */
103
104__BEGIN_DECLS
105ssize_t	readv(int, const struct iovec *, int);
106ssize_t	writev(int, const struct iovec *, int);
107#if __BSD_VISIBLE
108ssize_t	preadv(int, const struct iovec *, int, off_t);
109ssize_t	pwritev(int, const struct iovec *, int, off_t);
110#endif
111__END_DECLS
112
113#endif /* _KERNEL */
114
115#endif /* !_SYS_UIO_H_ */