Standardize License information
[openafs.git] / src / WINNT / afsd / cm_conn.h
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 #ifndef __CM_CONN_H_ENV__
11 #define __CM_CONN_H_ENV__ 1
12
13 #define CM_CONN_DEFAULTRDRTIMEOUT       45
14 #define CM_CONN_CONNDEADTIME            20
15 #define CM_CONN_HARDDEADTIME            40
16
17 typedef struct cm_conn {
18         struct cm_conn *nextp;          /* locked by cm_connLock */
19         struct cm_server *serverp;      /* locked by cm_serverLock */
20         struct rx_connection *callp;    /* locked by mx */
21         struct cm_user *userp;          /* locked by mx; a held reference */
22         osi_mutex_t mx;                 /* mutex for some of these fields */
23         int refCount;                   /* locked by cm_connLock */
24         int ucgen;                      /* ucellp's generation number */
25         long flags;                     /* locked by mx */
26 } cm_conn_t;
27
28 /* structure used for tracking RPC progress */
29 typedef struct cm_req {
30         DWORD startTime;                /* Quit before RDR times us out */
31         int rpcError;                   /* RPC error code */
32         int volumeError;                /* volume error code */
33         int accessError;                /* access error code */
34         int flags;
35 } cm_req_t;
36
37 /* flags in cm_req structure */
38 #define CM_REQ_NORETRY          0x1
39
40 /*
41  * Vice2 error codes
42  * 3/20/85
43  * Note:  all of the errors listed here are currently generated by the volume
44  * package.  Other vice error codes, should they be needed, could be included
45  * here also.
46  */
47
48 #define VREADONLY       EROFS   /* Attempt to write a read-only volume */
49
50 /* Special error codes, which may require special handling (other than just
51    passing them through directly to the end user) are listed below */
52
53 #define VICE_SPECIAL_ERRORS     101     /* Lowest special error code */
54
55 #define VSALVAGE        101     /* Volume needs salvage */
56 #define VNOVNODE        102     /* Bad vnode number quoted */
57 #define VNOVOL          103     /* Volume not attached, doesn't exist, 
58                                    not created or not online */
59 #define VVOLEXISTS      104     /* Volume already exists */
60 #define VNOSERVICE      105     /* Volume is not in service (i.e. it's
61                                    is out of funds, is obsolete, or somesuch) */
62 #define VOFFLINE        106     /* Volume is off line, for the reason
63                                    given in the offline message */
64 #define VONLINE         107     /* Volume is already on line */
65 #define VDISKFULL       108     /* ENOSPC - Partition is "full",
66                                    i.e. roughly within n% of full */
67 #define VOVERQUOTA      109     /* EDQUOT - Volume max quota exceeded */
68 #define VBUSY           110     /* Volume temporarily unavailable; try again.
69                                    The volume should be available again shortly;
70                                    if it isn't something is wrong.
71                                    Not normally to be propagated to the
72                                    application level */
73 #define VMOVED          111     /* Volume has moved to another server;
74                                    do a VGetVolumeInfo to THIS server to find
75                                    out where */
76
77 #define VRESTARTING     -100    /* server is restarting, otherwise similar to 
78                                    VBUSY above.  This is negative so that old
79                                    cache managers treat it as "server is down"*/
80
81 extern void cm_InitConn(void);
82
83 extern void cm_InitReq(cm_req_t *reqp);
84
85 extern int cm_Analyze(cm_conn_t *connp, struct cm_user *up, struct cm_req *reqp,
86         struct cm_fid *fidp,
87         struct AFSVolSync *volInfop,
88         struct cm_callbackRequest *cbrp, long code);
89
90 extern long cm_ConnByMServers(struct cm_serverRef *, struct cm_user *,
91         cm_req_t *, cm_conn_t **);
92
93 extern long cm_ConnByServer(struct cm_server *, struct cm_user *, cm_conn_t **);
94
95 extern long cm_Conn(struct cm_fid *, struct cm_user *, struct cm_req *,
96         cm_conn_t **);
97
98 extern void cm_PutConn(cm_conn_t *connp);
99
100 extern void cm_GCConnections(cm_server_t *serverp);
101
102 #endif /*  __CM_CONN_H_ENV__ */