xref: /freebsd/share/man/man9/VOP_READLINK.9 (revision e42b09643997affce935b2197814381c7ee856c1)
1fab63cc4SDoug Rabson.\" -*- nroff -*-
2fab63cc4SDoug Rabson.\"
3fab63cc4SDoug Rabson.\" Copyright (c) 1996 Doug Rabson
4fab63cc4SDoug Rabson.\"
5fab63cc4SDoug Rabson.\" All rights reserved.
6fab63cc4SDoug Rabson.\"
7fab63cc4SDoug Rabson.\" This program is free software.
8fab63cc4SDoug Rabson.\"
9fab63cc4SDoug Rabson.\" Redistribution and use in source and binary forms, with or without
10fab63cc4SDoug Rabson.\" modification, are permitted provided that the following conditions
11fab63cc4SDoug Rabson.\" are met:
12fab63cc4SDoug Rabson.\" 1. Redistributions of source code must retain the above copyright
13fab63cc4SDoug Rabson.\"    notice, this list of conditions and the following disclaimer.
14fab63cc4SDoug Rabson.\" 2. Redistributions in binary form must reproduce the above copyright
15fab63cc4SDoug Rabson.\"    notice, this list of conditions and the following disclaimer in the
16fab63cc4SDoug Rabson.\"    documentation and/or other materials provided with the distribution.
17fab63cc4SDoug Rabson.\"
18fab63cc4SDoug Rabson.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
19fab63cc4SDoug Rabson.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20fab63cc4SDoug Rabson.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21fab63cc4SDoug Rabson.\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
22fab63cc4SDoug Rabson.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23fab63cc4SDoug Rabson.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24fab63cc4SDoug Rabson.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25fab63cc4SDoug Rabson.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26fab63cc4SDoug Rabson.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27fab63cc4SDoug Rabson.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28fab63cc4SDoug Rabson.\"
297f3dea24SPeter Wemm.\" $FreeBSD$
30fab63cc4SDoug Rabson.\"
31*e42b0964SJohn Baldwin.Dd March 30, 2020
32fab63cc4SDoug Rabson.Dt VOP_READLINK 9
33aa12cea2SUlrich Spörlein.Os
34fab63cc4SDoug Rabson.Sh NAME
35fab63cc4SDoug Rabson.Nm VOP_READLINK
36fab63cc4SDoug Rabson.Nd read the target of a symbolic link
37fab63cc4SDoug Rabson.Sh SYNOPSIS
3832eef9aeSRuslan Ermilov.In sys/param.h
3932eef9aeSRuslan Ermilov.In sys/vnode.h
4032eef9aeSRuslan Ermilov.In sys/uio.h
41fab63cc4SDoug Rabson.Ft int
42fab63cc4SDoug Rabson.Fn VOP_READLINK "struct vnode *vp" "struct uio *uio" "struct ucred *cred"
43fab63cc4SDoug Rabson.Sh DESCRIPTION
44fab63cc4SDoug RabsonThis reads the target pathname of a symbolic link
45fab63cc4SDoug Rabson.Bl -tag -width uio
460640e9e0SHiten Pandya.It Fa vp
470a57ea7dSRuslan ErmilovThe vnode of the symlink.
480640e9e0SHiten Pandya.It Fa uio
490a57ea7dSRuslan ErmilovThe location of the data to be read or written.
500640e9e0SHiten Pandya.It Fa cred
510a57ea7dSRuslan ErmilovThe credentials of the caller.
52fab63cc4SDoug Rabson.El
53fab63cc4SDoug Rabson.Sh LOCKS
54fab63cc4SDoug RabsonThe vnode should be locked on entry and will still be locked on exit.
55fab63cc4SDoug Rabson.Sh RETURN VALUES
56fab63cc4SDoug RabsonZero is returned on success, otherwise an error code is returned.
57fab63cc4SDoug Rabson.Sh ERRORS
58eaa8b244SMike Pritchard.Bl -tag -width Er
59fab63cc4SDoug Rabson.It Bq Er EIO
60cc258457SDon LewisA read error occurred while reading the contents of the symlink.
61*e42b0964SJohn Baldwin.It Bq Er EINTEGRITY
62*e42b0964SJohn BaldwinCorrupted data was detected while reading the contents of the symlink.
63fab63cc4SDoug Rabson.El
64fab63cc4SDoug Rabson.Sh SEE ALSO
65bceb8aedSWolfram Schneider.Xr uiomove 9 ,
66bceb8aedSWolfram Schneider.Xr vnode 9
67fab63cc4SDoug Rabson.Sh AUTHORS
68571dba6eSHiten PandyaThis manual page was written by
69aaf1f16eSPhilippe Charnier.An Doug Rabson .
70