Skip to content

L
linux
Commit f476c6ed authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by Jonathan Corbet
Browse files
Options

docs: filesystems: convert coda.txt to ReST 

This document has its own style. It seems to be print output
for the old matrixial printers where backspace were used to
do double prints.

For the conversion, I used several regex expressions to get
rid of some weird stuff. The patch also does almost all possible
conversions in order to get a nice output document, while keeping
it readable/editable as is:

- Add a SPDX header;
- Add a document title;
- Adjust document title;
- Adjust section titles;
- Some whitespace fixes and new line breaks;
- Mark literal blocks as such;
- Adjust list markups;
- Mark some unumbered titles with bold font;
- Use footnoote markups;
- Add table markups;
- Use notes markups;
- Add it to filesystems/index.rst.
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/25c06c40c3d7b947a131c3be124ce0e93cc00ae3.1588021877.git.mchehab+huawei@kernel.orgSigned-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent 41defb4d
Hide whitespace changes
Inline Side-by-side
Showing with 1673 additions and 2 deletions
Documentation/filesystems/coda.txt → Documentation/filesystems/coda.rst
View file @ f476c6ed
NOTE: .. SPDX-License-Identifier: GPL-2.0
This is one of the technical documents describing a component of
Coda -- this document describes the client kernel-Venus interface. ===========================
Coda Kernel-Venus Interface
===========================
.. Note::
This is one of the technical documents describing a component of
Coda -- this document describes the client kernel-Venus interface.
For more information: For more information:
http://www.coda.cs.cmu.edu http://www.coda.cs.cmu.edu
For user level software needed to run Coda: For user level software needed to run Coda:
ftp://ftp.coda.cs.cmu.edu ftp://ftp.coda.cs.cmu.edu
To run Coda you need to get a user level cache manager for the client, To run Coda you need to get a user level cache manager for the client,
...@@ -15,77 +25,18 @@ configuration. ...@@ -15,77 +25,18 @@ configuration.
The server needs a user level server and at present does not depend on The server needs a user level server and at present does not depend on
kernel support. kernel support.
The Venus kernel interface The Venus kernel interface
Peter J. Braam Peter J. Braam
v1.0, Nov 9, 1997 v1.0, Nov 9, 1997
This document describes the communication between Venus and kernel This document describes the communication between Venus and kernel
level filesystem code needed for the operation of the Coda file sys- level filesystem code needed for the operation of the Coda file sys-
tem. This document version is meant to describe the current interface tem. This document version is meant to describe the current interface
(version 1.0) as well as improvements we envisage. (version 1.0) as well as improvements we envisage.
______________________________________________________________________
Table of Contents
.. Table of Contents
1. Introduction 1. Introduction
...@@ -141,17 +92,11 @@ kernel support. ...@@ -141,17 +92,11 @@ kernel support.
6.1 Requirements 6.1 Requirements
1. Introduction
______________________________________________________________________ ===============
0wpage
11.. IInnttrroodduuccttiioonn
A key component in the Coda Distributed File System is the cache A key component in the Coda Distributed File System is the cache
manager, _V_e_n_u_s. manager, Venus.
When processes on a Coda enabled system access files in the Coda When processes on a Coda enabled system access files in the Coda
filesystem, requests are directed at the filesystem layer in the filesystem, requests are directed at the filesystem layer in the
...@@ -189,16 +134,15 @@ kernel support. ...@@ -189,16 +134,15 @@ kernel support.
kernel should be documented in great detail. This is the aim of this kernel should be documented in great detail. This is the aim of this
document. document.
0wpage 2. Servicing Coda filesystem calls
===================================
22.. SSeerrvviicciinngg CCooddaa ffiilleessyysstteemm ccaallllss
The service of a request for a Coda file system service originates in The service of a request for a Coda file system service originates in
a process PP which accessing a Coda file. It makes a system call which a process P which accessing a Coda file. It makes a system call which
traps to the OS kernel. Examples of such calls trapping to the kernel traps to the OS kernel. Examples of such calls trapping to the kernel
are _r_e_a_d_, _w_r_i_t_e_, _o_p_e_n_, _c_l_o_s_e_, _c_r_e_a_t_e_, _m_k_d_i_r_, _r_m_d_i_r_, _c_h_m_o_d in a Unix are ``read``, ``write``, ``open``, ``close``, ``create``, ``mkdir``,
context. Similar calls exist in the Win32 environment, and are named ``rmdir``, ``chmod`` in a Unix ontext. Similar calls exist in the Win32
_C_r_e_a_t_e_F_i_l_e_, . environment, and are named ``CreateFile``.
Generally the operating system handles the request in a virtual Generally the operating system handles the request in a virtual
filesystem (VFS) layer, which is named I/O Manager in NT and IFS filesystem (VFS) layer, which is named I/O Manager in NT and IFS
...@@ -230,12 +174,7 @@ kernel support. ...@@ -230,12 +174,7 @@ kernel support.
which does not block Venus since Venus must attend to other tasks even which does not block Venus since Venus must attend to other tasks even
when no messages are waiting or being processed. when no messages are waiting or being processed.
**Interfaces of the Coda FS Driver**
Interfaces of the Coda FS Driver
Furthermore the FS layer provides for a special path of communication Furthermore the FS layer provides for a special path of communication
between a user process and Venus, called the pioctl interface. The between a user process and Venus, called the pioctl interface. The
...@@ -259,11 +198,9 @@ kernel support. ...@@ -259,11 +198,9 @@ kernel support.
not go into the calls exported to the VFS layer but we will state the not go into the calls exported to the VFS layer but we will state the
requirements of the message exchange mechanism. requirements of the message exchange mechanism.
0wpage
33.. TThhee mmeessssaaggee llaayyeerr
3. The message layer
=====================
At the lowest level the communication between Venus and the FS driver At the lowest level the communication between Venus and the FS driver
proceeds through messages. The synchronization between processes proceeds through messages. The synchronization between processes
...@@ -286,7 +223,7 @@ kernel support. ...@@ -286,7 +223,7 @@ kernel support.
message. Additional platform dependent structures involve pointers to message. Additional platform dependent structures involve pointers to
determine the position of the message on queues and pointers to determine the position of the message on queues and pointers to
synchronization objects. In the upcall routine the message structure synchronization objects. In the upcall routine the message structure
is filled in, flags are set to 0, and it is placed on the _p_e_n_d_i_n_g is filled in, flags are set to 0, and it is placed on the *pending*
queue. The routine calling upcall is responsible for allocating the queue. The routine calling upcall is responsible for allocating the
data buffer; its structure will be described in the next section. data buffer; its structure will be described in the next section.
...@@ -312,7 +249,7 @@ kernel support. ...@@ -312,7 +249,7 @@ kernel support.
driver looks at the contents of the message and decides if: driver looks at the contents of the message and decides if:
+o the message is a reply for a suspended thread P. If so it removes * the message is a reply for a suspended thread P. If so it removes
the message from the processing queue and marks the message as the message from the processing queue and marks the message as
WRITTEN. Finally, the FS driver unblocks P (still in the kernel WRITTEN. Finally, the FS driver unblocks P (still in the kernel
mode context of Venus) and the sendmsg_to_kernel call returns to mode context of Venus) and the sendmsg_to_kernel call returns to
...@@ -320,7 +257,7 @@ kernel support. ...@@ -320,7 +257,7 @@ kernel support.
processing its upcall with the data buffer replaced with the reply processing its upcall with the data buffer replaced with the reply
from Venus. from Venus.
+o The message is a _d_o_w_n_c_a_l_l. A downcall is a request from Venus to * The message is a ``downcall``. A downcall is a request from Venus to
the FS Driver. The FS driver processes the request immediately the FS Driver. The FS driver processes the request immediately
(usually a cache eviction or replacement) and when it finishes (usually a cache eviction or replacement) and when it finishes
sendmsg_to_kernel returns. sendmsg_to_kernel returns.
...@@ -334,12 +271,7 @@ kernel support. ...@@ -334,12 +271,7 @@ kernel support.
with its processing. with its processing.
**Sleeping and IPC arrangements**
Sleeping and IPC arrangements
In case P is woken up by a signal and not by Venus, it will first look In case P is woken up by a signal and not by Venus, it will first look
at the flags field. If the message is not yet READ, the process P can at the flags field. If the message is not yet READ, the process P can
...@@ -355,7 +287,8 @@ kernel support. ...@@ -355,7 +287,8 @@ kernel support.
33..11.. IImmpplleemmeennttaattiioonn ddeettaaiillss 3.1. Implementation details
----------------------------
The Unix implementation of this mechanism has been through the The Unix implementation of this mechanism has been through the
implementation of a character device associated with Coda. Venus implementation of a character device associated with Coda. Venus
...@@ -372,34 +305,34 @@ kernel support. ...@@ -372,34 +305,34 @@ kernel support.
message arrival. The process P is kept waiting on a KernelEvent message arrival. The process P is kept waiting on a KernelEvent
object in NT and a semaphore in Windows 95. object in NT and a semaphore in Windows 95.
0wpage
44.. TThhee iinntteerrffaaccee aatt tthhee ccaallll lleevveell 4. The interface at the call level
===================================
This section describes the upcalls a Coda FS driver can make to Venus. This section describes the upcalls a Coda FS driver can make to Venus.
Each of these upcalls make use of two structures: inputArgs and Each of these upcalls make use of two structures: inputArgs and
outputArgs. In pseudo BNF form the structures take the following outputArgs. In pseudo BNF form the structures take the following
form: form::
struct inputArgs { struct inputArgs {
u_long opcode; u_long opcode;
u_long unique; /* Keep multiple outstanding msgs distinct */ u_long unique; /* Keep multiple outstanding msgs distinct */
u_short pid; /* Common to all */ u_short pid; /* Common to all */
u_short pgid; /* Common to all */ u_short pgid; /* Common to all */
struct CodaCred cred; /* Common to all */ struct CodaCred cred; /* Common to all */
<union "in" of call dependent parts of inputArgs> <union "in" of call dependent parts of inputArgs>
}; };
struct outputArgs { struct outputArgs {
u_long opcode; u_long opcode;
u_long unique; /* Keep multiple outstanding msgs distinct */ u_long unique; /* Keep multiple outstanding msgs distinct */
u_long result; u_long result;
<union "out" of call dependent parts of inputArgs> <union "out" of call dependent parts of inputArgs>
}; };
...@@ -417,7 +350,8 @@ kernel support. ...@@ -417,7 +350,8 @@ kernel support.
44..11.. DDaattaa ssttrruuccttuurreess sshhaarreedd bbyy tthhee kkeerrnneell aanndd VVeennuuss 4.1. Data structures shared by the kernel and Venus
----------------------------------------------------
The CodaCred structure defines a variety of user and group ids as The CodaCred structure defines a variety of user and group ids as
...@@ -425,36 +359,35 @@ kernel support. ...@@ -425,36 +359,35 @@ kernel support.
unsigned integers. It also defines group membership in an array. On unsigned integers. It also defines group membership in an array. On
Unix the CodaCred has proven sufficient to implement good security Unix the CodaCred has proven sufficient to implement good security
semantics for Coda but the structure may have to undergo modification semantics for Coda but the structure may have to undergo modification
for the Windows environment when these mature. for the Windows environment when these mature::
struct CodaCred { struct CodaCred {
vuid_t cr_uid, cr_euid, cr_suid, cr_fsuid; /* Real, effective, set, fs uid */ vuid_t cr_uid, cr_euid, cr_suid, cr_fsuid; /* Real, effective, set, fs uid */
vgid_t cr_gid, cr_egid, cr_sgid, cr_fsgid; /* same for groups */ vgid_t cr_gid, cr_egid, cr_sgid, cr_fsgid; /* same for groups */
vgid_t cr_groups[NGROUPS]; /* Group membership for caller */ vgid_t cr_groups[NGROUPS]; /* Group membership for caller */
}; };
.. Note::
NNOOTTEE It is questionable if we need CodaCreds in Venus. Finally Venus It is questionable if we need CodaCreds in Venus. Finally Venus
doesn't know about groups, although it does create files with the doesn't know about groups, although it does create files with the
default uid/gid. Perhaps the list of group membership is superfluous. default uid/gid. Perhaps the list of group membership is superfluous.
The next item is the fundamental identifier used to identify Coda The next item is the fundamental identifier used to identify Coda
files, the ViceFid. A fid of a file uniquely defines a file or files, the ViceFid. A fid of a file uniquely defines a file or
directory in the Coda filesystem within a _c_e_l_l. (-- A _c_e_l_l is a directory in the Coda filesystem within a cell [1]_::
group of Coda servers acting under the aegis of a single system
control machine or SCM. See the Coda Administration manual for a
detailed description of the role of the SCM.--)
typedef struct ViceFid {
VolumeId Volume;
VnodeId Vnode;
Unique_t Unique;
} ViceFid;
typedef struct ViceFid {
VolumeId Volume;
VnodeId Vnode;
Unique_t Unique;
} ViceFid;
.. [1] A cell is agroup of Coda servers acting under the aegis of a single
system control machine or SCM. See the Coda Administration manual
for a detailed description of the role of the SCM.
Each of the constituent fields: VolumeId, VnodeId and Unique_t are Each of the constituent fields: VolumeId, VnodeId and Unique_t are
unsigned 32 bit integers. We envisage that a further field will need unsigned 32 bit integers. We envisage that a further field will need
...@@ -464,54 +397,39 @@ kernel support. ...@@ -464,54 +397,39 @@ kernel support.
The next important structure shared between Venus and the kernel is The next important structure shared between Venus and the kernel is
the attributes of the file. The following structure is used to the attributes of the file. The following structure is used to
exchange information. It has room for future extensions such as exchange information. It has room for future extensions such as
support for device files (currently not present in Coda). support for device files (currently not present in Coda)::
struct coda_timespec {
int64_t tv_sec; /* seconds */
long tv_nsec; /* nanoseconds */
};
struct coda_vattr {
enum coda_vtype va_type; /* vnode type (for create) */
u_short va_mode; /* files access mode and type */
short va_nlink; /* number of references to file */
vuid_t va_uid; /* owner user id */
vgid_t va_gid; /* owner group id */
long va_fsid; /* file system id (dev for now) */
long va_fileid; /* file id */
u_quad_t va_size; /* file size in bytes */
struct coda_timespec { long va_blocksize; /* blocksize preferred for i/o */
int64_t tv_sec; /* seconds */ struct coda_timespec va_atime; /* time of last access */
long tv_nsec; /* nanoseconds */ struct coda_timespec va_mtime; /* time of last modification */
}; struct coda_timespec va_ctime; /* time file changed */
u_long va_gen; /* generation number of file */
struct coda_vattr { u_long va_flags; /* flags defined for file */
enum coda_vtype va_type; /* vnode type (for create) */ dev_t va_rdev; /* device special file represents */
u_short va_mode; /* files access mode and type */ u_quad_t va_bytes; /* bytes of disk space held by file */
short va_nlink; /* number of references to file */ u_quad_t va_filerev; /* file modification number */
vuid_t va_uid; /* owner user id */ u_int va_vaflags; /* operations flags, see below */
vgid_t va_gid; /* owner group id */ long va_spare; /* remain quad aligned */
long va_fsid; /* file system id (dev for now) */ };
long va_fileid; /* file id */
u_quad_t va_size; /* file size in bytes */
long va_blocksize; /* blocksize preferred for i/o */ 4.2. The pioctl interface
struct coda_timespec va_atime; /* time of last access */ --------------------------
struct coda_timespec va_mtime; /* time of last modification */
struct coda_timespec va_ctime; /* time file changed */
u_long va_gen; /* generation number of file */
u_long va_flags; /* flags defined for file */
dev_t va_rdev; /* device special file represents */
u_quad_t va_bytes; /* bytes of disk space held by file */
u_quad_t va_filerev; /* file modification number */
u_int va_vaflags; /* operations flags, see below */
long va_spare; /* remain quad aligned */
};
44..22.. TThhee ppiiooccttll iinntteerrffaaccee
Coda specific requests can be made by application through the pioctl Coda specific requests can be made by application through the pioctl
...@@ -520,98 +438,99 @@ kernel support. ...@@ -520,98 +438,99 @@ kernel support.
a file handle and makes the ioctl call. Finally it closes the file. a file handle and makes the ioctl call. Finally it closes the file.
The kernel involvement in this is limited to providing the facility to The kernel involvement in this is limited to providing the facility to
open and close and pass the ioctl message _a_n_d to verify that a path in open and close and pass the ioctl message and to verify that a path in
the pioctl data buffers is a file in a Coda filesystem. the pioctl data buffers is a file in a Coda filesystem.
The kernel is handed a data packet of the form: The kernel is handed a data packet of the form::
struct { struct {
const char *path; const char *path;
struct ViceIoctl vidata; struct ViceIoctl vidata;
int follow; int follow;
} data; } data;
where where::
struct ViceIoctl { struct ViceIoctl {
caddr_t in, out; /* Data to be transferred in, or out */ caddr_t in, out; /* Data to be transferred in, or out */
short in_size; /* Size of input buffer <= 2K */ short in_size; /* Size of input buffer <= 2K */
short out_size; /* Maximum size of output buffer, <= 2K */ short out_size; /* Maximum size of output buffer, <= 2K */
}; };
The path must be a Coda file, otherwise the ioctl upcall will not be The path must be a Coda file, otherwise the ioctl upcall will not be
made. made.
NNOOTTEE The data structures and code are a mess. We need to clean this .. Note:: The data structures and code are a mess. We need to clean this up.
up.
We now proceed to document the individual calls:
0wpage
44..33.. rroooott **We now proceed to document the individual calls**:
AArrgguummeennttss 4.3. root
----------
iinn empty
oouutt Arguments
in
struct cfs_root_out { empty
ViceFid VFid;
} cfs_root;
out::
struct cfs_root_out {
ViceFid VFid;
} cfs_root;
DDeessccrriippttiioonn This call is made to Venus during the initialization of
the Coda filesystem. If the result is zero, the cfs_root structure
contains the ViceFid of the root of the Coda filesystem. If a non-zero
result is generated, its value is a platform dependent error code
indicating the difficulty Venus encountered in locating the root of
the Coda filesystem.
0wpage
44..44.. llooookkuupp Description
This call is made to Venus during the initialization of
the Coda filesystem. If the result is zero, the cfs_root structure
contains the ViceFid of the root of the Coda filesystem. If a non-zero
result is generated, its value is a platform dependent error code
indicating the difficulty Venus encountered in locating the root of
the Coda filesystem.
4.4. lookup
------------
SSuummmmaarryy Find the ViceFid and type of an object in a directory if it
exists.
AArrgguummeennttss Summary
Find the ViceFid and type of an object in a directory if it exists.
iinn Arguments
in::
struct cfs_lookup_in { struct cfs_lookup_in {
ViceFid VFid; ViceFid VFid;
char *name; /* Place holder for data. */ char *name; /* Place holder for data. */
} cfs_lookup; } cfs_lookup;
oouutt out::
struct cfs_lookup_out { struct cfs_lookup_out {
ViceFid VFid; ViceFid VFid;
int vtype; int vtype;
} cfs_lookup; } cfs_lookup;
DDeessccrriippttiioonn This call is made to determine the ViceFid and filetype of Description
a directory entry. The directory entry requested carries name name This call is made to determine the ViceFid and filetype of
and Venus will search the directory identified by cfs_lookup_in.VFid. a directory entry. The directory entry requested carries name name
The result may indicate that the name does not exist, or that and Venus will search the directory identified by cfs_lookup_in.VFid.
difficulty was encountered in finding it (e.g. due to disconnection). The result may indicate that the name does not exist, or that
If the result is zero, the field cfs_lookup_out.VFid contains the difficulty was encountered in finding it (e.g. due to disconnection).
targets ViceFid and cfs_lookup_out.vtype the coda_vtype giving the If the result is zero, the field cfs_lookup_out.VFid contains the
type of object the name designates. targets ViceFid and cfs_lookup_out.vtype the coda_vtype giving the
type of object the name designates.
The name of the object is an 8 bit character string of maximum length The name of the object is an 8 bit character string of maximum length
CFS_MAXNAMLEN, currently set to 256 (including a 0 terminator.) CFS_MAXNAMLEN, currently set to 256 (including a 0 terminator.)
...@@ -620,813 +539,861 @@ kernel support. ...@@ -620,813 +539,861 @@ kernel support.
cfs_lookup.vtype with CFS_NOCACHE to indicate that the object should cfs_lookup.vtype with CFS_NOCACHE to indicate that the object should
not be put in the kernel name cache. not be put in the kernel name cache.
NNOOTTEE The type of the vtype is currently wrong. It should be .. Note::
coda_vtype. Linux does not take note of CFS_NOCACHE. It should.
0wpage The type of the vtype is currently wrong. It should be
coda_vtype. Linux does not take note of CFS_NOCACHE. It should.
44..55.. ggeettaattttrr
4.5. getattr
-------------
SSuummmmaarryy Get the attributes of a file.
AArrgguummeennttss Summary Get the attributes of a file.
iinn Arguments
in::
struct cfs_getattr_in { struct cfs_getattr_in {
ViceFid VFid; ViceFid VFid;
struct coda_vattr attr; /* XXXXX */ struct coda_vattr attr; /* XXXXX */
} cfs_getattr; } cfs_getattr;
oouutt out::
struct cfs_getattr_out { struct cfs_getattr_out {
struct coda_vattr attr; struct coda_vattr attr;
} cfs_getattr; } cfs_getattr;
DDeessccrriippttiioonn This call returns the attributes of the file identified by Description
fid. This call returns the attributes of the file identified by fid.
EErrrroorrss Errors can occur if the object with fid does not exist, is Errors
unaccessible or if the caller does not have permission to fetch Errors can occur if the object with fid does not exist, is
attributes. unaccessible or if the caller does not have permission to fetch
attributes.
NNoottee Many kernel FS drivers (Linux, NT and Windows 95) need to acquire .. Note::
the attributes as well as the Fid for the instantiation of an internal
"inode" or "FileHandle". A significant improvement in performance on Many kernel FS drivers (Linux, NT and Windows 95) need to acquire
such systems could be made by combining the _l_o_o_k_u_p and _g_e_t_a_t_t_r calls the attributes as well as the Fid for the instantiation of an internal
both at the Venus/kernel interaction level and at the RPC level. "inode" or "FileHandle". A significant improvement in performance on
such systems could be made by combining the lookup and getattr calls
both at the Venus/kernel interaction level and at the RPC level.
The vattr structure included in the input arguments is superfluous and The vattr structure included in the input arguments is superfluous and
should be removed. should be removed.
0wpage
44..66.. sseettaattttrr
4.6. setattr
-------------
SSuummmmaarryy Set the attributes of a file.
AArrgguummeennttss Summary
Set the attributes of a file.
iinn Arguments
in::
struct cfs_setattr_in { struct cfs_setattr_in {
ViceFid VFid; ViceFid VFid;
struct coda_vattr attr; struct coda_vattr attr;
} cfs_setattr; } cfs_setattr;
oouutt out
empty
DDeessccrriippttiioonn The structure attr is filled with attributes to be changed empty
in BSD style. Attributes not to be changed are set to -1, apart from
vtype which is set to VNON. Other are set to the value to be assigned.
The only attributes which the FS driver may request to change are the
mode, owner, groupid, atime, mtime and ctime. The return value
indicates success or failure.
EErrrroorrss A variety of errors can occur. The object may not exist, may Description
be inaccessible, or permission may not be granted by Venus. The structure attr is filled with attributes to be changed
in BSD style. Attributes not to be changed are set to -1, apart from
vtype which is set to VNON. Other are set to the value to be assigned.
The only attributes which the FS driver may request to change are the
mode, owner, groupid, atime, mtime and ctime. The return value
indicates success or failure.
0wpage Errors
A variety of errors can occur. The object may not exist, may
be inaccessible, or permission may not be granted by Venus.
44..77.. aacccceessss
4.7. access
------------
SSuummmmaarryy
AArrgguummeennttss Arguments
in::
iinn struct cfs_access_in {
ViceFid VFid;
int flags;
} cfs_access;
struct cfs_access_in {
ViceFid VFid;
int flags;
} cfs_access;
out
oouutt empty
empty
DDeessccrriippttiioonn Verify if access to the object identified by VFid for Description
operations described by flags is permitted. The result indicates if Verify if access to the object identified by VFid for
access will be granted. It is important to remember that Coda uses operations described by flags is permitted. The result indicates if
ACLs to enforce protection and that ultimately the servers, not the access will be granted. It is important to remember that Coda uses
clients enforce the security of the system. The result of this call ACLs to enforce protection and that ultimately the servers, not the
will depend on whether a _t_o_k_e_n is held by the user. clients enforce the security of the system. The result of this call
will depend on whether a token is held by the user.
EErrrroorrss The object may not exist, or the ACL describing the protection Errors
may not be accessible. The object may not exist, or the ACL describing the protection
may not be accessible.
0wpage
44..88.. ccrreeaattee 4.8. create
------------
SSuummmmaarryy Invoked to create a file Summary
Invoked to create a file
AArrgguummeennttss Arguments
in::
iinn struct cfs_create_in {
ViceFid VFid;
struct coda_vattr attr;
int excl;
int mode;
char *name; /* Place holder for data. */
} cfs_create;
struct cfs_create_in {
ViceFid VFid;
struct coda_vattr attr;
int excl;
int mode;
char *name; /* Place holder for data. */
} cfs_create;
out::
oouutt struct cfs_create_out {
ViceFid VFid;
struct coda_vattr attr;
} cfs_create;
struct cfs_create_out {
ViceFid VFid;
struct coda_vattr attr;
} cfs_create;
Description
This upcall is invoked to request creation of a file.
The file will be created in the directory identified by VFid, its name
will be name, and the mode will be mode. If excl is set an error will
be returned if the file already exists. If the size field in attr is
set to zero the file will be truncated. The uid and gid of the file
are set by converting the CodaCred to a uid using a macro CRTOUID
(this macro is platform dependent). Upon success the VFid and
attributes of the file are returned. The Coda FS Driver will normally
instantiate a vnode, inode or file handle at kernel level for the new
object.
DDeessccrriippttiioonn This upcall is invoked to request creation of a file.
The file will be created in the directory identified by VFid, its name
will be name, and the mode will be mode. If excl is set an error will
be returned if the file already exists. If the size field in attr is
set to zero the file will be truncated. The uid and gid of the file
are set by converting the CodaCred to a uid using a macro CRTOUID
(this macro is platform dependent). Upon success the VFid and
attributes of the file are returned. The Coda FS Driver will normally
instantiate a vnode, inode or file handle at kernel level for the new
object.
Errors
A variety of errors can occur. Permissions may be insufficient.
If the object exists and is not a file the error EISDIR is returned
under Unix.
EErrrroorrss A variety of errors can occur. Permissions may be insufficient. .. Note::
If the object exists and is not a file the error EISDIR is returned
under Unix.
NNOOTTEE The packing of parameters is very inefficient and appears to The packing of parameters is very inefficient and appears to
indicate confusion between the system call creat and the VFS operation indicate confusion between the system call creat and the VFS operation
create. The VFS operation create is only called to create new objects. create. The VFS operation create is only called to create new objects.
This create call differs from the Unix one in that it is not invoked This create call differs from the Unix one in that it is not invoked
to return a file descriptor. The truncate and exclusive options, to return a file descriptor. The truncate and exclusive options,
together with the mode, could simply be part of the mode as it is together with the mode, could simply be part of the mode as it is
under Unix. There should be no flags argument; this is used in open under Unix. There should be no flags argument; this is used in open
(2) to return a file descriptor for READ or WRITE mode. (2) to return a file descriptor for READ or WRITE mode.
The attributes of the directory should be returned too, since the size The attributes of the directory should be returned too, since the size
and mtime changed. and mtime changed.
0wpage
44..99.. mmkkddiirr 4.9. mkdir
-----------
SSuummmmaarryy Create a new directory. Summary
Create a new directory.
AArrgguummeennttss Arguments
in::
iinn struct cfs_mkdir_in {
ViceFid VFid;
struct coda_vattr attr;
char *name; /* Place holder for data. */
} cfs_mkdir;
struct cfs_mkdir_in {
ViceFid VFid;
struct coda_vattr attr;
char *name; /* Place holder for data. */
} cfs_mkdir;
out::
oouutt struct cfs_mkdir_out {
ViceFid VFid;
struct coda_vattr attr;
} cfs_mkdir;
struct cfs_mkdir_out {
ViceFid VFid;
struct coda_vattr attr;
} cfs_mkdir;
Description
This call is similar to create but creates a directory.
Only the mode field in the input parameters is used for creation.
Upon successful creation, the attr returned contains the attributes of
the new directory.
DDeessccrriippttiioonn This call is similar to create but creates a directory. Errors
Only the mode field in the input parameters is used for creation. As for create.
Upon successful creation, the attr returned contains the attributes of
the new directory.
EErrrroorrss As for create. .. Note::
NNOOTTEE The input parameter should be changed to mode instead of The input parameter should be changed to mode instead of
attributes. attributes.
The attributes of the parent should be returned since the size and The attributes of the parent should be returned since the size and
mtime changes. mtime changes.
0wpage
44..1100.. lliinnkk 4.10. link
-----------
SSuummmmaarryy Create a link to an existing file. Summary
Create a link to an existing file.
AArrgguummeennttss Arguments
in::
iinn struct cfs_link_in {
ViceFid sourceFid; /* cnode to link *to* */
ViceFid destFid; /* Directory in which to place link */
char *tname; /* Place holder for data. */
} cfs_link;
struct cfs_link_in {
ViceFid sourceFid; /* cnode to link *to* */
ViceFid destFid; /* Directory in which to place link */
char *tname; /* Place holder for data. */
} cfs_link;
out
oouutt empty
empty
DDeessccrriippttiioonn This call creates a link to the sourceFid in the directory Description
identified by destFid with name tname. The source must reside in the This call creates a link to the sourceFid in the directory
target's parent, i.e. the source must be have parent destFid, i.e. Coda identified by destFid with name tname. The source must reside in the
does not support cross directory hard links. Only the return value is target's parent, i.e. the source must be have parent destFid, i.e. Coda
relevant. It indicates success or the type of failure. does not support cross directory hard links. Only the return value is
relevant. It indicates success or the type of failure.
EErrrroorrss The usual errors can occur.0wpage Errors
The usual errors can occur.
44..1111.. ssyymmlliinnkk
4.11. symlink
--------------
SSuummmmaarryy create a symbolic link
AArrgguummeennttss Summary
create a symbolic link
iinn Arguments
in::
struct cfs_symlink_in { struct cfs_symlink_in {
ViceFid VFid; /* Directory to put symlink in */ ViceFid VFid; /* Directory to put symlink in */
char *srcname; char *srcname;
struct coda_vattr attr; struct coda_vattr attr;
char *tname; char *tname;
} cfs_symlink; } cfs_symlink;
oouutt out
none
DDeessccrriippttiioonn Create a symbolic link. The link is to be placed in the none
directory identified by VFid and named tname. It should point to the
pathname srcname. The attributes of the newly created object are to
be set to attr.
EErrrroorrss Description
Create a symbolic link. The link is to be placed in the
directory identified by VFid and named tname. It should point to the
pathname srcname. The attributes of the newly created object are to
be set to attr.
NNOOTTEE The attributes of the target directory should be returned since .. Note::
its size changed.
0wpage The attributes of the target directory should be returned since
its size changed.
44..1122.. rreemmoovvee
4.12. remove
-------------
SSuummmmaarryy Remove a file
AArrgguummeennttss Summary
Remove a file
iinn Arguments
in::
struct cfs_remove_in { struct cfs_remove_in {
ViceFid VFid; ViceFid VFid;
char *name; /* Place holder for data. */ char *name; /* Place holder for data. */
} cfs_remove; } cfs_remove;
oouutt out
none
DDeessccrriippttiioonn Remove file named cfs_remove_in.name in directory none
identified by VFid.
EErrrroorrss Description
Remove file named cfs_remove_in.name in directory
identified by VFid.
NNOOTTEE The attributes of the directory should be returned since its
mtime and size may change.
0wpage .. Note::
44..1133.. rrmmddiirr The attributes of the directory should be returned since its
mtime and size may change.
SSuummmmaarryy Remove a directory 4.13. rmdir
------------
AArrgguummeennttss
iinn Summary
Remove a directory
struct cfs_rmdir_in { Arguments
ViceFid VFid; in::
char *name; /* Place holder for data. */
} cfs_rmdir;
struct cfs_rmdir_in {
ViceFid VFid;
char *name; /* Place holder for data. */
} cfs_rmdir;
oouutt
none
DDeessccrriippttiioonn Remove the directory with name name from the directory out
identified by VFid.
EErrrroorrss none
NNOOTTEE The attributes of the parent directory should be returned since Description
its mtime and size may change. Remove the directory with name name from the directory
identified by VFid.
0wpage .. Note:: The attributes of the parent directory should be returned since
its mtime and size may change.
44..1144.. rreeaaddlliinnkk
4.14. readlink
---------------
SSuummmmaarryy Read the value of a symbolic link.
AArrgguummeennttss Summary
Read the value of a symbolic link.
iinn Arguments
in::
struct cfs_readlink_in { struct cfs_readlink_in {
ViceFid VFid; ViceFid VFid;
} cfs_readlink; } cfs_readlink;
oouutt out::
struct cfs_readlink_out { struct cfs_readlink_out {
int count; int count;
caddr_t data; /* Place holder for data. */ caddr_t data; /* Place holder for data. */
} cfs_readlink; } cfs_readlink;
DDeessccrriippttiioonn This routine reads the contents of symbolic link Description
identified by VFid into the buffer data. The buffer data must be able This routine reads the contents of symbolic link
to hold any name up to CFS_MAXNAMLEN (PATH or NAM??). identified by VFid into the buffer data. The buffer data must be able
to hold any name up to CFS_MAXNAMLEN (PATH or NAM??).
EErrrroorrss No unusual errors. Errors
No unusual errors.
0wpage
44..1155.. ooppeenn 4.15. open
-----------
SSuummmmaarryy Open a file. Summary
Open a file.
AArrgguummeennttss Arguments
in::
iinn struct cfs_open_in {
ViceFid VFid;
int flags;
} cfs_open;
struct cfs_open_in {
ViceFid VFid;
int flags;
} cfs_open;
out::
oouutt struct cfs_open_out {
dev_t dev;
ino_t inode;
} cfs_open;
struct cfs_open_out {
dev_t dev;
ino_t inode;
} cfs_open;
Description
This request asks Venus to place the file identified by
VFid in its cache and to note that the calling process wishes to open
it with flags as in open(2). The return value to the kernel differs
for Unix and Windows systems. For Unix systems the Coda FS Driver is
informed of the device and inode number of the container file in the
fields dev and inode. For Windows the path of the container file is
returned to the kernel.
DDeessccrriippttiioonn This request asks Venus to place the file identified by
VFid in its cache and to note that the calling process wishes to open
it with flags as in open(2). The return value to the kernel differs
for Unix and Windows systems. For Unix systems the Coda FS Driver is
informed of the device and inode number of the container file in the
fields dev and inode. For Windows the path of the container file is
returned to the kernel.
EErrrroorrss
NNOOTTEE Currently the cfs_open_out structure is not properly adapted to .. Note::
deal with the Windows case. It might be best to implement two
upcalls, one to open aiming at a container file name, the other at a
container file inode.
0wpage Currently the cfs_open_out structure is not properly adapted to
deal with the Windows case. It might be best to implement two
upcalls, one to open aiming at a container file name, the other at a
container file inode.
44..1166.. cclloossee
4.16. close
------------
SSuummmmaarryy Close a file, update it on the servers.
AArrgguummeennttss Summary
Close a file, update it on the servers.
iinn Arguments
in::
struct cfs_close_in { struct cfs_close_in {
ViceFid VFid; ViceFid VFid;
int flags; int flags;
} cfs_close; } cfs_close;
oouutt out
none
DDeessccrriippttiioonn Close the file identified by VFid. none
EErrrroorrss Description
Close the file identified by VFid.
NNOOTTEE The flags argument is bogus and not used. However, Venus' code .. Note::
has room to deal with an execp input field, probably this field should
be used to inform Venus that the file was closed but is still memory
mapped for execution. There are comments about fetching versus not
fetching the data in Venus vproc_vfscalls. This seems silly. If a
file is being closed, the data in the container file is to be the new
data. Here again the execp flag might be in play to create confusion:
currently Venus might think a file can be flushed from the cache when
it is still memory mapped. This needs to be understood.
0wpage The flags argument is bogus and not used. However, Venus' code
has room to deal with an execp input field, probably this field should
be used to inform Venus that the file was closed but is still memory
mapped for execution. There are comments about fetching versus not
fetching the data in Venus vproc_vfscalls. This seems silly. If a
file is being closed, the data in the container file is to be the new
data. Here again the execp flag might be in play to create confusion:
currently Venus might think a file can be flushed from the cache when
it is still memory mapped. This needs to be understood.
44..1177.. iiooccttll
4.17. ioctl
------------
SSuummmmaarryy Do an ioctl on a file. This includes the pioctl interface.
AArrgguummeennttss Summary
Do an ioctl on a file. This includes the pioctl interface.
iinn Arguments
in::
struct cfs_ioctl_in { struct cfs_ioctl_in {
ViceFid VFid; ViceFid VFid;
int cmd; int cmd;
int len; int len;
int rwflag; int rwflag;
char *data; /* Place holder for data. */ char *data; /* Place holder for data. */
} cfs_ioctl; } cfs_ioctl;
oouutt out::
struct cfs_ioctl_out { struct cfs_ioctl_out {
int len; int len;
caddr_t data; /* Place holder for data. */ caddr_t data; /* Place holder for data. */
} cfs_ioctl; } cfs_ioctl;
DDeessccrriippttiioonn Do an ioctl operation on a file. The command, len and Description
data arguments are filled as usual. flags is not used by Venus. Do an ioctl operation on a file. The command, len and
data arguments are filled as usual. flags is not used by Venus.
EErrrroorrss .. Note::
NNOOTTEE Another bogus parameter. flags is not used. What is the Another bogus parameter. flags is not used. What is the
business about PREFETCHING in the Venus code? business about PREFETCHING in the Venus code?
0wpage
44..1188.. rreennaammee 4.18. rename
-------------
SSuummmmaarryy Rename a fid. Summary
Rename a fid.
AArrgguummeennttss Arguments
in::
iinn struct cfs_rename_in {
ViceFid sourceFid;
char *srcname;
ViceFid destFid;
char *destname;
} cfs_rename;
struct cfs_rename_in {
ViceFid sourceFid;
char *srcname;
ViceFid destFid;
char *destname;
} cfs_rename;
out
oouutt none
none
DDeessccrriippttiioonn Rename the object with name srcname in directory Description
sourceFid to destname in destFid. It is important that the names Rename the object with name srcname in directory
srcname and destname are 0 terminated strings. Strings in Unix sourceFid to destname in destFid. It is important that the names
kernels are not always null terminated. srcname and destname are 0 terminated strings. Strings in Unix
kernels are not always null terminated.
EErrrroorrss
0wpage 4.19. readdir
--------------
44..1199.. rreeaaddddiirr
Summary
Read directory entries.
SSuummmmaarryy Read directory entries. Arguments
in::
AArrgguummeennttss struct cfs_readdir_in {
ViceFid VFid;
int count;
int offset;
} cfs_readdir;
iinn
struct cfs_readdir_in {
ViceFid VFid;
int count;
int offset;
} cfs_readdir;
out::
struct cfs_readdir_out {
int size;
caddr_t data; /* Place holder for data. */
} cfs_readdir;
oouutt
struct cfs_readdir_out {
int size;
caddr_t data; /* Place holder for data. */
} cfs_readdir;
Description
Read directory entries from VFid starting at offset and
read at most count bytes. Returns the data in data and returns
the size in size.
DDeessccrriippttiioonn Read directory entries from VFid starting at offset and .. Note::
read at most count bytes. Returns the data in data and returns
the size in size.
EErrrroorrss This call is not used. Readdir operations exploit container
files. We will re-evaluate this during the directory revamp which is
about to take place.
NNOOTTEE This call is not used. Readdir operations exploit container
files. We will re-evaluate this during the directory revamp which is
about to take place.
0wpage 4.20. vget
-----------
44..2200.. vvggeett
Summary
instructs Venus to do an FSDB->Get.
SSuummmmaarryy instructs Venus to do an FSDB->Get. Arguments
in::
AArrgguummeennttss struct cfs_vget_in {
ViceFid VFid;
} cfs_vget;
iinn
struct cfs_vget_in {
ViceFid VFid;
} cfs_vget;
out::
struct cfs_vget_out {
ViceFid VFid;
int vtype;
} cfs_vget;
oouutt
struct cfs_vget_out {
ViceFid VFid;
int vtype;
} cfs_vget;
Description
This upcall asks Venus to do a get operation on an fsobj
labelled by VFid.
.. Note::
DDeessccrriippttiioonn This upcall asks Venus to do a get operation on an fsobj This operation is not used. However, it is extremely useful
labelled by VFid. since it can be used to deal with read/write memory mapped files.
These can be "pinned" in the Venus cache using vget and released with
inactive.
EErrrroorrss
NNOOTTEE This operation is not used. However, it is extremely useful 4.21. fsync
since it can be used to deal with read/write memory mapped files. ------------
These can be "pinned" in the Venus cache using vget and released with
inactive.
0wpage
44..2211.. ffssyynncc Summary
Tell Venus to update the RVM attributes of a file.
Arguments
in::
SSuummmmaarryy Tell Venus to update the RVM attributes of a file. struct cfs_fsync_in {
ViceFid VFid;
} cfs_fsync;
AArrgguummeennttss
iinn
struct cfs_fsync_in { out
ViceFid VFid;
} cfs_fsync;
none
Description
Ask Venus to update RVM attributes of object VFid. This
should be called as part of kernel level fsync type calls. The
result indicates if the syncing was successful.
oouutt .. Note:: Linux does not implement this call. It should.
none
DDeessccrriippttiioonn Ask Venus to update RVM attributes of object VFid. This
should be called as part of kernel level fsync type calls. The
result indicates if the syncing was successful.
EErrrroorrss 4.22. inactive
---------------
NNOOTTEE Linux does not implement this call. It should.
0wpage Summary
Tell Venus a vnode is no longer in use.
44..2222.. iinnaaccttiivvee Arguments
in::
struct cfs_inactive_in {
ViceFid VFid;
} cfs_inactive;
SSuummmmaarryy Tell Venus a vnode is no longer in use.
AArrgguummeennttss
iinn out
struct cfs_inactive_in { none
ViceFid VFid;
} cfs_inactive;
Description
This operation returns EOPNOTSUPP.
.. Note:: This should perhaps be removed.
oouutt
none
DDeessccrriippttiioonn This operation returns EOPNOTSUPP. 4.23. rdwr
-----------
EErrrroorrss
NNOOTTEE This should perhaps be removed. Summary
Read or write from a file
0wpage Arguments
in::
44..2233.. rrddwwrr struct cfs_rdwr_in {
ViceFid VFid;
int rwflag;
int count;
int offset;
int ioflag;
caddr_t data; /* Place holder for data. */
} cfs_rdwr;
SSuummmmaarryy Read or write from a file
AArrgguummeennttss
iinn out::
struct cfs_rdwr_in { struct cfs_rdwr_out {
ViceFid VFid; int rwflag;
int rwflag; int count;
int count; caddr_t data; /* Place holder for data. */
int offset; } cfs_rdwr;
int ioflag;
caddr_t data; /* Place holder for data. */
} cfs_rdwr;
Description
This upcall asks Venus to read or write from a file.
oouutt
struct cfs_rdwr_out { .. Note::
int rwflag;
int count;
caddr_t data; /* Place holder for data. */
} cfs_rdwr;
It should be removed since it is against the Coda philosophy that
read/write operations never reach Venus. I have been told the
operation does not work. It is not currently used.
DDeessccrriippttiioonn This upcall asks Venus to read or write from a file.
EErrrroorrss 4.24. odymount
---------------
NNOOTTEE It should be removed since it is against the Coda philosophy that
read/write operations never reach Venus. I have been told the
operation does not work. It is not currently used.
Summary
Allows mounting multiple Coda "filesystems" on one Unix mount point.
0wpage Arguments
in::
44..2244.. ooddyymmoouunntt struct ody_mount_in {
char *name; /* Place holder for data. */
} ody_mount;
SSuummmmaarryy Allows mounting multiple Coda "filesystems" on one Unix mount
point.
AArrgguummeennttss out::
iinn struct ody_mount_out {
ViceFid VFid;
} ody_mount;
struct ody_mount_in {
char *name; /* Place holder for data. */
} ody_mount;
Description
Asks Venus to return the rootfid of a Coda system named
name. The fid is returned in VFid.
oouutt .. Note::
struct ody_mount_out { This call was used by David for dynamic sets. It should be
ViceFid VFid; removed since it causes a jungle of pointers in the VFS mounting area.
} ody_mount; It is not used by Coda proper. Call is not implemented by Venus.
4.25. ody_lookup
-----------------
DDeessccrriippttiioonn Asks Venus to return the rootfid of a Coda system named
name. The fid is returned in VFid.
EErrrroorrss Summary
Looks up something.
NNOOTTEE This call was used by David for dynamic sets. It should be Arguments
removed since it causes a jungle of pointers in the VFS mounting area. in
It is not used by Coda proper. Call is not implemented by Venus.
0wpage irrelevant
44..2255.. ooddyy__llooookkuupp
out
SSuummmmaarryy Looks up something. irrelevant
AArrgguummeennttss
iinn irrelevant .. Note:: Gut it. Call is not implemented by Venus.
oouutt 4.26. ody_expand
irrelevant -----------------
DDeessccrriippttiioonn
EErrrroorrss Summary
expands something in a dynamic set.
NNOOTTEE Gut it. Call is not implemented by Venus. Arguments
in
0wpage irrelevant
44..2266.. ooddyy__eexxppaanndd out
irrelevant
SSuummmmaarryy expands something in a dynamic set. .. Note:: Gut it. Call is not implemented by Venus.
AArrgguummeennttss
iinn irrelevant 4.27. prefetch
---------------
oouutt
irrelevant
DDeessccrriippttiioonn Summary
Prefetch a dynamic set.
EErrrroorrss Arguments
NNOOTTEE Gut it. Call is not implemented by Venus. in
0wpage Not documented.
44..2277.. pprreeffeettcchh out
Not documented.
SSuummmmaarryy Prefetch a dynamic set. Description
Venus worker.cc has support for this call, although it is
noted that it doesn't work. Not surprising, since the kernel does not
have support for it. (ODY_PREFETCH is not a defined operation).
AArrgguummeennttss
iinn Not documented. .. Note:: Gut it. It isn't working and isn't used by Coda.
oouutt
Not documented.
DDeessccrriippttiioonn Venus worker.cc has support for this call, although it is
noted that it doesn't work. Not surprising, since the kernel does not
have support for it. (ODY_PREFETCH is not a defined operation).
EErrrroorrss 4.28. signal
-------------
NNOOTTEE Gut it. It isn't working and isn't used by Coda.
Summary
Send Venus a signal about an upcall.
0wpage Arguments
in
44..2288.. ssiiggnnaall none
out
SSuummmmaarryy Send Venus a signal about an upcall. not applicable.
AArrgguummeennttss Description
This is an out-of-band upcall to Venus to inform Venus
that the calling process received a signal after Venus read the
message from the input queue. Venus is supposed to clean up the
operation.
iinn none Errors
No reply is given.
oouutt .. Note::
not applicable.
DDeessccrriippttiioonn This is an out-of-band upcall to Venus to inform Venus We need to better understand what Venus needs to clean up and if
that the calling process received a signal after Venus read the it is doing this correctly. Also we need to handle multiple upcall
message from the input queue. Venus is supposed to clean up the per system call situations correctly. It would be important to know
operation. what state changes in Venus take place after an upcall for which the
kernel is responsible for notifying Venus to clean up (e.g. open
definitely is such a state change, but many others are maybe not).
EErrrroorrss No reply is given.
NNOOTTEE We need to better understand what Venus needs to clean up and if 5. The minicache and downcalls
it is doing this correctly. Also we need to handle multiple upcall ===============================
per system call situations correctly. It would be important to know
what state changes in Venus take place after an upcall for which the
kernel is responsible for notifying Venus to clean up (e.g. open
definitely is such a state change, but many others are maybe not).
0wpage
55.. TThhee mmiinniiccaacchhee aanndd ddoowwnnccaallllss
The Coda FS Driver can cache results of lookup and access upcalls, to The Coda FS Driver can cache results of lookup and access upcalls, to
...@@ -1440,7 +1407,7 @@ kernel support. ...@@ -1440,7 +1407,7 @@ kernel support.
FileHandles in Windows) with the ViceFid's which Venus maintains. The FileHandles in Windows) with the ViceFid's which Venus maintains. The
reason is that frequent translations back and forth are needed in reason is that frequent translations back and forth are needed in
order to make upcalls and use the results of upcalls. Such linking order to make upcalls and use the results of upcalls. Such linking
objects are called ccnnooddeess. objects are called cnodes.
The current minicache implementations have cache entries which record The current minicache implementations have cache entries which record
the following: the following:
...@@ -1466,136 +1433,160 @@ kernel support. ...@@ -1466,136 +1433,160 @@ kernel support.
unless the downcall data could not be read into kernel memory. unless the downcall data could not be read into kernel memory.
55..11.. IINNVVAALLIIDDAATTEE 5.1. INVALIDATE
----------------
No information is available on this call. No information is available on this call.
55..22.. FFLLUUSSHH 5.2. FLUSH
-----------
AArrgguummeennttss None Arguments
None
SSuummmmaarryy Flush the name cache entirely. Summary
Flush the name cache entirely.
DDeessccrriippttiioonn Venus issues this call upon startup and when it dies. This Description
is to prevent stale cache information being held. Some operating Venus issues this call upon startup and when it dies. This
systems allow the kernel name cache to be switched off dynamically. is to prevent stale cache information being held. Some operating
When this is done, this downcall is made. systems allow the kernel name cache to be switched off dynamically.
When this is done, this downcall is made.
55..33.. PPUURRGGEEUUSSEERR 5.3. PURGEUSER
---------------
AArrgguummeennttss Arguments
::
struct cfs_purgeuser_out {/* CFS_PURGEUSER is a venus->kernel call */ struct cfs_purgeuser_out {/* CFS_PURGEUSER is a venus->kernel call */
struct CodaCred cred; struct CodaCred cred;
} cfs_purgeuser; } cfs_purgeuser;
DDeessccrriippttiioonn Remove all entries in the cache carrying the Cred. This Description
call is issued when tokens for a user expire or are flushed. Remove all entries in the cache carrying the Cred. This
call is issued when tokens for a user expire or are flushed.
55..44.. ZZAAPPFFIILLEE 5.4. ZAPFILE
-------------
AArrgguummeennttss Arguments
::
struct cfs_zapfile_out { /* CFS_ZAPFILE is a venus->kernel call */ struct cfs_zapfile_out { /* CFS_ZAPFILE is a venus->kernel call */
ViceFid CodaFid; ViceFid CodaFid;
} cfs_zapfile; } cfs_zapfile;
DDeessccrriippttiioonn Remove all entries which have the (dir vnode, name) pair. Description
This is issued as a result of an invalidation of cached attributes of Remove all entries which have the (dir vnode, name) pair.
a vnode. This is issued as a result of an invalidation of cached attributes of
a vnode.
NNOOTTEE Call is not named correctly in NetBSD and Mach. The minicache .. Note::
zapfile routine takes different arguments. Linux does not implement
the invalidation of attributes correctly.
Call is not named correctly in NetBSD and Mach. The minicache
zapfile routine takes different arguments. Linux does not implement
the invalidation of attributes correctly.
55..55.. ZZAAPPDDIIRR
5.5. ZAPDIR
------------
AArrgguummeennttss
struct cfs_zapdir_out { /* CFS_ZAPDIR is a venus->kernel call */ Arguments
ViceFid CodaFid; ::
} cfs_zapdir;
struct cfs_zapdir_out { /* CFS_ZAPDIR is a venus->kernel call */
ViceFid CodaFid;
} cfs_zapdir;
DDeessccrriippttiioonn Remove all entries in the cache lying in a directory
CodaFid, and all children of this directory. This call is issued when
Venus receives a callback on the directory.
Description
Remove all entries in the cache lying in a directory
CodaFid, and all children of this directory. This call is issued when
Venus receives a callback on the directory.
55..66.. ZZAAPPVVNNOODDEE
5.6. ZAPVNODE
--------------
AArrgguummeennttss
struct cfs_zapvnode_out { /* CFS_ZAPVNODE is a venus->kernel call */ Arguments
struct CodaCred cred; ::
ViceFid VFid;
} cfs_zapvnode;
struct cfs_zapvnode_out { /* CFS_ZAPVNODE is a venus->kernel call */
struct CodaCred cred;
ViceFid VFid;
} cfs_zapvnode;
DDeessccrriippttiioonn Remove all entries in the cache carrying the cred and VFid
as in the arguments. This downcall is probably never issued.
Description
Remove all entries in the cache carrying the cred and VFid
as in the arguments. This downcall is probably never issued.
55..77.. PPUURRGGEEFFIIDD
5.7. PURGEFID
--------------
SSuummmmaarryy
AArrgguummeennttss Arguments
::
struct cfs_purgefid_out { /* CFS_PURGEFID is a venus->kernel call */ struct cfs_purgefid_out { /* CFS_PURGEFID is a venus->kernel call */
ViceFid CodaFid; ViceFid CodaFid;
} cfs_purgefid; } cfs_purgefid;
DDeessccrriippttiioonn Flush the attribute for the file. If it is a dir (odd Description
vnode), purge its children from the namecache and remove the file from the Flush the attribute for the file. If it is a dir (odd
namecache. vnode), purge its children from the namecache and remove the file from the
namecache.
55..88.. RREEPPLLAACCEE 5.8. REPLACE
-------------
SSuummmmaarryy Replace the Fid's for a collection of names. Summary
Replace the Fid's for a collection of names.
AArrgguummeennttss Arguments
::
struct cfs_replace_out { /* cfs_replace is a venus->kernel call */ struct cfs_replace_out { /* cfs_replace is a venus->kernel call */
ViceFid NewFid; ViceFid NewFid;
ViceFid OldFid; ViceFid OldFid;
} cfs_replace; } cfs_replace;
DDeessccrriippttiioonn This routine replaces a ViceFid in the name cache with Description
another. It is added to allow Venus during reintegration to replace This routine replaces a ViceFid in the name cache with
locally allocated temp fids while disconnected with global fids even another. It is added to allow Venus during reintegration to replace
when the reference counts on those fids are not zero. locally allocated temp fids while disconnected with global fids even
when the reference counts on those fids are not zero.
0wpage
66.. IInniittiiaalliizzaattiioonn aanndd cclleeaannuupp 6. Initialization and cleanup
==============================
This section gives brief hints as to desirable features for the Coda This section gives brief hints as to desirable features for the Coda
...@@ -1624,11 +1615,12 @@ kernel support. ...@@ -1624,11 +1615,12 @@ kernel support.
3. pioctl interface 3. pioctl interface
Currently the _p_i_o_c_t_l passes through the VFS for Coda so we can Currently the pioctl passes through the VFS for Coda so we can
treat these similarly. treat these similarly.
66..11.. RReeqquuiirreemmeennttss 6.1. Requirements
------------------
The following requirements should be accommodated: The following requirements should be accommodated:
...@@ -1636,14 +1628,14 @@ kernel support. ...@@ -1636,14 +1628,14 @@ kernel support.
1. The message queues should have open and close routines. On Unix 1. The message queues should have open and close routines. On Unix
the opening of the character devices are such routines. the opening of the character devices are such routines.
+o Before opening, no messages can be placed. - Before opening, no messages can be placed.
+o Opening will remove any old messages still pending. - Opening will remove any old messages still pending.
+o Close will notify any sleeping processes that their upcall cannot - Close will notify any sleeping processes that their upcall cannot
be completed. be completed.
+o Close will free all memory allocated by the message queues. - Close will free all memory allocated by the message queues.
2. At open the namecache shall be initialized to empty state. 2. At open the namecache shall be initialized to empty state.
...@@ -1668,9 +1660,11 @@ kernel support. ...@@ -1668,9 +1660,11 @@ kernel support.
best implemented by Venus fetching these objects before attempting best implemented by Venus fetching these objects before attempting
to mount. to mount.
NNOOTTEE NetBSD in particular but also Linux have not implemented the .. Note::
above requirements fully. For smooth operation this needs to be
corrected. NetBSD in particular but also Linux have not implemented the
above requirements fully. For smooth operation this needs to be
corrected.
Documentation/filesystems/index.rst
View file @ f476c6ed
...@@ -63,6 +63,7 @@ Documentation for filesystem implementations. ...@@ -63,6 +63,7 @@ Documentation for filesystem implementations.
btrfs btrfs
cifs/cifsroot cifs/cifsroot
ceph ceph
coda
cramfs cramfs
debugfs debugfs
dlmfs dlmfs
......
MAINTAINERS
View file @ f476c6ed
...@@ -4203,7 +4203,7 @@ M: coda@cs.cmu.edu ...@@ -4203,7 +4203,7 @@ M: coda@cs.cmu.edu
L: codalist@coda.cs.cmu.edu L: codalist@coda.cs.cmu.edu
S: Maintained S: Maintained
W: http://www.coda.cs.cmu.edu/ W: http://www.coda.cs.cmu.edu/
F: Documentation/filesystems/coda.txt F: Documentation/filesystems/coda.rst
F: fs/coda/ F: fs/coda/
F: include/linux/coda*.h F: include/linux/coda*.h
F: include/uapi/linux/coda*.h F: include/uapi/linux/coda*.h
......
fs/coda/Kconfig
View file @ f476c6ed
...@@ -15,7 +15,7 @@ config CODA_FS ...@@ -15,7 +15,7 @@ config CODA_FS
*client*. You will need user level code as well, both for the *client*. You will need user level code as well, both for the
client and server. Servers are currently user level, i.e. they need client and server. Servers are currently user level, i.e. they need
no kernel support. Please read no kernel support. Please read
<file:Documentation/filesystems/coda.txt> and check out the Coda <file:Documentation/filesystems/coda.rst> and check out the Coda
home page <http://www.coda.cs.cmu.edu/>. home page <http://www.coda.cs.cmu.edu/>.
To compile the coda client support as a module, choose M here: the To compile the coda client support as a module, choose M here: the
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7