~ubuntu-branches/ubuntu/warty/openafs/warty

« back to all changes in this revision

Viewing changes to src/uss/uss_fs.h

  • Committer: Bazaar Package Importer
  • Author(s): Sam Hartman
  • Date: 2004-01-10 16:37:33 UTC
  • Revision ID: james.westby@ubuntu.com-20040110163733-jvr0n1uahshlb1uu
Tags: upstream-1.2.11
ImportĀ upstreamĀ versionĀ 1.2.11

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
/*
 
2
 * Copyright 2000, International Business Machines Corporation and others.
 
3
 * All Rights Reserved.
 
4
 * 
 
5
 * This software has been released under the terms of the IBM Public
 
6
 * License.  For details, see the LICENSE file in the top-level source
 
7
 * directory or online at http://www.openafs.org/dl/license10.html
 
8
 */
 
9
 
 
10
/*
 
11
 *      Interface to the AFS system operations exported by the
 
12
 *      Cache Manager.
 
13
 */
 
14
 
 
15
#ifndef _USS_FS_H_
 
16
#define _USS_FS_H_ 1
 
17
 
 
18
/*
 
19
 * --------------------- Exported definitions ---------------------
 
20
 */
 
21
#define USS_FS_MAX_SIZE         2048
 
22
 
 
23
 
 
24
/*
 
25
 * ---------------------- Exported variables ----------------------
 
26
 */
 
27
extern char *uss_fs_InBuff;          /*Cache Manager input buff*/
 
28
extern char *uss_fs_OutBuff;         /*Cache Manager output buff*/
 
29
 
 
30
 
 
31
/*
 
32
 * ------------------------ Exported functions  -----------------------
 
33
 */
 
34
extern afs_int32 uss_fs_GetACL();
 
35
    /*
 
36
     * Summary:
 
37
     *    Given the pathname for a directory, return its ACL.
 
38
     *
 
39
     * Args:
 
40
     *    char *a_dirPath       : Directory pathname.
 
41
     *    char *a_aclBuff       : Ptr to the buffer in which to put
 
42
     *                            the directory's ACL.
 
43
     *    afs_int32 a_aclBuffBytes      : Size of the above.
 
44
     *
 
45
     * Returns:
 
46
     *    0 if everything went well,
 
47
     *    -1 otherwise, with errno set to the error.
 
48
     */
 
49
 
 
50
extern afs_int32 uss_fs_SetACL();
 
51
    /*
 
52
     * Summary:
 
53
     *    Set the ACL on the specified directory.
 
54
     *
 
55
     * Args:
 
56
     *    char *a_dirpath       : Directory pathname.
 
57
     *    char *a_aclBuff       : Ptr to the buffer from which to get
 
58
     *                            the directory's ACL.
 
59
     *    afs_int32 a_aclBuffBytes      : Size of the above.
 
60
     *
 
61
     * Returns:
 
62
     *    0 if everything went well,
 
63
     *    -1 otherwise, with errno set to the error.
 
64
     */
 
65
 
 
66
extern afs_int32 uss_fs_GetVolStat();
 
67
    /*
 
68
     * Summary:
 
69
     *    Given the pathname of an AFS mountpoint, find out what you
 
70
     *    can about the volume mounted there.
 
71
     *
 
72
     * Args:
 
73
     *    char *a_mountpoint      : Mountpoint pathname.
 
74
     *    char *a_volStatBuff     : Buffer to hold the status.
 
75
     *    afs_int32 a_volStatBuffBytes : Length of above.
 
76
     *
 
77
     * Returns:
 
78
     *    0 if everything went well,
 
79
     *    -1 otherwise, with errno set to the error.
 
80
     */
 
81
 
 
82
extern afs_int32 uss_fs_SetVolStat();
 
83
    /*
 
84
     * Summary:
 
85
     *    Given the pathname of an AFS mountpoint, set the status info
 
86
     *    for the volume mounted there.
 
87
     *
 
88
     * Args:
 
89
     *    char *a_mountpoint      : Mountpoint pathname.
 
90
     *    char *a_volStatBuff     : Buffer holding the status.
 
91
     *    afs_int32 a_volStatBuffBytes : Length of above.
 
92
     *
 
93
     * Returns:
 
94
     *    0 if everything went well,
 
95
     *    -1 otherwise, with errno set to the error.
 
96
     */
 
97
 
 
98
extern afs_int32 uss_fs_CkBackups();
 
99
    /*
 
100
     * Summary:
 
101
     *    Make sure the CacheManager doesn't have any stale volume
 
102
     *    mappings.
 
103
     *
 
104
     * Args:
 
105
     *    None.
 
106
     *
 
107
     * Returns:
 
108
     *    0 if everything went well,
 
109
     *    -1 otherwise, with errno set to the error.
 
110
     */
 
111
 
 
112
extern afs_int32 uss_fs_MkMountPoint();
 
113
    /*
 
114
     * Summary: *NEW*
 
115
     *    Given the name of the volume, the cell it lives in,
 
116
     *    whether we want the read/write version mounted, and
 
117
     *    the pathname for the desired mountpoint, go ahead and
 
118
     *    create it.
 
119
     *
 
120
     * Args:
 
121
     *    char *a_volname    : Name of volume to mount.
 
122
     *    char *a_cellname   : Name of cell where volume lives.
 
123
     *    afs_int32 a_rw             : Read/write mount?
 
124
     *    char *a_mountpoint : Name desired for the mountpoint.
 
125
     *
 
126
     * Returns:
 
127
     *    0 if everything went well,
 
128
     *    -1 otherwise, with errno set to the error.
 
129
     */
 
130
 
 
131
extern afs_int32 uss_fs_RmMountPoint();
 
132
    /*
 
133
     * Summary:
 
134
     *    Delete the given mountpoint.
 
135
     *
 
136
     * Args:
 
137
     *    char *a_mountpoint : Name of the mountpoint to delete.
 
138
     *
 
139
     * Returns:
 
140
     *    0 if everything went well,
 
141
     *    -1 otherwise, with errno set to the error.
 
142
     */
 
143
 
 
144
#endif /* _USS_FS_H_ */