man.bsd.lv manual page server

Manual Page Search Parameters
COPY(9) Kernel Developer's Manual COPY(9)

copy, copyin, copyout, copystr, copyinstr, copyoutstr — kernel space to/from user space copy functions

#include <sys/types.h>
#include <sys/systm.h>

int
copyin(const void *uaddr, void *kaddr, size_t len);

int
copyout(const void *kaddr, void *uaddr, size_t len);

int
copystr(const void *kfaddr, void *kdaddr, size_t len, size_t *done);

int
copyinstr(const void *uaddr, void *kaddr, size_t len, size_t *done);

int
copyoutstr(const void *kaddr, void *uaddr, size_t len, size_t *done);

int
copyin_proc(struct proc *p, const void *uaddr, void *kaddr, size_t len);

int
copyout_proc(struct proc *p, const void *kaddr, void *uaddr, size_t len);

int
ioctl_copyin(int ioctlflags, const void *src, void *dst, size_t len);

int
ioctl_copyout(int ioctlflags, const void *src, void *dst, size_t len);

The copy functions are designed to copy contiguous data from one address to another. All but () copy data from user-space to kernel-space or vice-versa.

The copy routines provide the following functionality:

()
Copies len bytes of data from the user-space address uaddr in the current process to the kernel-space address kaddr.
()
Copies len bytes of data from the kernel-space address kaddr to the user-space address uaddr in the current process.
copystr()
Copies a NUL-terminated string, at most len bytes long, from kernel-space address kfaddr to kernel-space address kdaddr. If the done argument is non-NULL, the number of bytes actually copied, including the terminating NUL, is returned in *done.
()
Copies a NUL-terminated string, at most len bytes long, from user-space address uaddr in the current process to kernel-space address kaddr. If the done argument is non-NULL, the number of bytes actually copied, including the terminating NUL, is returned in *done.
()
Copies a NUL-terminated string, at most len bytes long, from kernel-space address kaddr to user-space address uaddr in the current process. If the done argument is non-NULL, the number of bytes actually copied, including the terminating NUL, is returned in *done.
()
Like copyin(), except it operates on the address space of the process p.
()
Like copyout(), except it operates on the address space of the process p.
()
Like copyin(), except it operates on kernel addresses when the FKIOCTL flag is passed in ioctlflags from the ioctl call.
()
Like copyout(), except it operates on kernel addresses when the FKIOCTL flag is passed in ioctlflags from the ioctl call.

The copy functions return 0 on success or EFAULT if a bad address is encountered. In addition, the copystr(), copyinstr(), and copyoutstr() functions return ENAMETOOLONG if the string is longer than len bytes.

ufetch(9), ustore(9)

August 28, 2005 NetBSD-9.2