windows-volstat-and-vista-dfs-support-20071222
[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             0
15 #define CM_CONN_HARDDEADTIME             0
16
17 extern unsigned short ConnDeadtimeout;
18 extern unsigned short HardDeadtimeout;
19 extern DWORD          RDRtimeout; 
20
21 typedef struct cm_conn {
22         struct cm_conn *nextp;          /* locked by cm_connLock */
23         struct cm_server *serverp;      /* locked by cm_serverLock */
24         struct rx_connection *callp;    /* locked by mx */
25         struct cm_user *userp;          /* locked by mx; a held reference */
26         osi_mutex_t mx;                 /* mutex for some of these fields */
27         unsigned long refCount;         /* locked by cm_connLock */
28         int ucgen;                      /* ucellp's generation number */
29         long flags;                     /* locked by mx */
30         int cryptlevel;                 /* encrytion status */
31 } cm_conn_t;
32
33 #define CM_CONN_FLAG_FORCE_NEW  1
34
35 /* 
36  * structure used for tracking RPC progress
37  * and for passing path info from the smb layer 
38  * to the cache manager functions.
39  */
40 typedef struct cm_req {
41         DWORD startTime;                /* Quit before RDR times us out */
42         int rpcError;                   /* RPC error code */
43         int volumeError;                /* volume error code */
44         int accessError;                /* access error code */
45         int flags;
46         char * tidPathp;
47         char * relPathp;
48 } cm_req_t;
49
50 /* flags in cm_req structure */
51 #define CM_REQ_NORETRY          0x1
52 #define CM_REQ_NEW_CONN_FORCED  0x2
53
54 /*
55  * Vice2 error codes
56  * 3/20/85
57  * Note:  all of the errors listed here are currently generated by the volume
58  * package.  Other vice error codes, should they be needed, could be included
59  * here also.
60  */
61
62 #define VREADONLY       EROFS   /* Attempt to write a read-only volume */
63
64 /* Special error codes, which may require special handling (other than just
65    passing them through directly to the end user) are listed below */
66
67 #define VICE_SPECIAL_ERRORS     101     /* Lowest special error code */
68
69 #define VSALVAGE        101     /* Volume needs salvage */
70 #define VNOVNODE        102     /* Bad vnode number quoted */
71 #define VNOVOL          103     /* Volume not attached, doesn't exist, 
72                                    not created or not online */
73 #define VVOLEXISTS      104     /* Volume already exists */
74 #define VNOSERVICE      105     /* Volume is not in service (i.e. it's
75                                    is out of funds, is obsolete, or somesuch) */
76 #define VOFFLINE        106     /* Volume is off line, for the reason
77                                    given in the offline message */
78 #define VONLINE         107     /* Volume is already on line */
79 #define VDISKFULL       108     /* ENOSPC - Partition is "full",
80                                    i.e. roughly within n% of full */
81 #define VOVERQUOTA      109     /* EDQUOT - Volume max quota exceeded */
82 #define VBUSY           110     /* Volume temporarily unavailable; try again.
83                                    The volume should be available again shortly;
84                                    if it isn't something is wrong.
85                                    Not normally to be propagated to the
86                                    application level */
87 #define VMOVED          111     /* Volume has moved to another server;
88                                    do a VGetVolumeInfo to THIS server to find
89                                    out where */
90 #define VIO             112     /* Vnode temporarily unaccessible, but not known
91                                  * to be permanently bad. */
92 #define VRESTRICTED     120     /* Volume is restricted from using one or more
93                                  * of the given residencies; do a
94                                  * vos examine to find out the current
95                                  * restrictions. */
96
97 #define VRESTARTING     -100    /* server is restarting, otherwise similar to 
98                                    VBUSY above.  This is negative so that old
99                                    cache managers treat it as "server is down"*/
100
101 #include "cm_server.h"
102 #ifndef AFS_PTHREAD_ENV
103 #define AFS_PTHREAD_ENV 1
104 #endif
105 #include "rx.h"
106
107 extern void cm_InitConn(void);
108
109 extern void cm_InitReq(cm_req_t *reqp);
110
111 extern int cm_Analyze(cm_conn_t *connp, struct cm_user *up, struct cm_req *reqp,
112         struct cm_fid *fidp,
113         struct AFSVolSync *volInfop,
114         cm_serverRef_t * serversp,
115         struct cm_callbackRequest *cbrp, long code);
116
117 extern long cm_ConnByMServers(struct cm_serverRef *, struct cm_user *,
118         cm_req_t *, cm_conn_t **);
119
120 extern long cm_ConnByServer(struct cm_server *, struct cm_user *, cm_conn_t **);
121
122 extern long cm_ConnFromFID(struct cm_fid *, struct cm_user *, struct cm_req *,
123         cm_conn_t **);
124
125 extern long cm_ConnFromVolume(struct cm_volume *volp, unsigned long volid, 
126                               struct cm_user *userp, cm_req_t *reqp,
127                               cm_conn_t **connpp);
128
129 extern void cm_PutConn(cm_conn_t *connp);
130
131 extern void cm_GCConnections(cm_server_t *serverp);
132
133 extern struct rx_connection * cm_GetRxConn(cm_conn_t *connp);
134
135 extern void cm_ForceNewConnections(cm_server_t *serverp);
136
137 extern long cm_ServerAvailable(struct cm_fid *fidp, struct cm_user *userp);
138
139 #endif /*  __CM_CONN_H_ENV__ */