Windows: Checksum server lists on Volume Errors
[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 OPENAFS_WINNT_AFSD_CM_CONN_H
11 #define OPENAFS_WINNT_AFSD_CM_CONN_H 1
12
13 #define CM_CONN_DEFAULTRDRTIMEOUT       45
14 #ifndef CM_CONN_CONNDEADTIME
15 #define CM_CONN_CONNDEADTIME             0
16 #endif
17 #ifndef CM_CONN_HARDDEADTIME
18 #define CM_CONN_HARDDEADTIME             0
19 #endif
20 #ifndef CM_CONN_IDLEDEADTIME
21 #define CM_CONN_IDLEDEADTIME             0
22 #endif
23 #ifndef CM_CONN_IDLEDEADTIME_REP
24 #define CM_CONN_IDLEDEADTIME_REP         0
25 #endif
26 #ifndef CM_CONN_NATPINGINTERVAL
27 #define CM_CONN_NATPINGINTERVAL          0
28 #endif
29
30 #define CM_CONN_IFS_HARDDEADTIME       120
31 #define CM_CONN_IFS_CONNDEADTIME        60
32 #define CM_CONN_IFS_IDLEDEADTIME      1200
33 #define CM_CONN_IFS_IDLEDEADTIME_REP   180      /* must be larger than file server hard dead timeout = 120 */
34
35 extern unsigned short ConnDeadtimeout;
36 extern unsigned short HardDeadtimeout;
37 extern DWORD          RDRtimeout;
38 extern afs_uint32     rx_pmtu_discovery;
39
40 typedef struct cm_conn {
41         struct cm_conn *nextp;          /* locked by cm_connLock */
42         struct cm_server *serverp;      /* locked by cm_serverLock */
43         struct rx_connection *rxconnp;  /* locked by mx */
44         struct cm_user *userp;          /* locked by mx; a held reference */
45         osi_mutex_t mx;                 /* mutex for some of these fields */
46         afs_int32 refCount;             /* Interlocked */
47         int ucgen;                      /* ucellp's generation number */
48         afs_uint32 flags;               /* locked by mx */
49         int cryptlevel;                 /* encrytion status */
50 } cm_conn_t;
51
52 #define CM_CONN_FLAG_FORCE_NEW          1
53 #define CM_CONN_FLAG_REPLICATION        2
54
55 /*
56  * structure used for tracking RPC progress
57  * and for passing path info from the smb layer
58  * to the cache manager functions.
59  */
60 typedef struct cm_req {
61     DWORD startTime;            /* GetTickCount() when this struct was initialized */
62     int rpcError;               /* RPC error code */
63     int volumeError;            /* volume error code */
64     int accessError;            /* access error code */
65     struct cm_server * errorServp;  /* server that reported a token/idle error other than expired */
66     int tokenError;
67     int idleError;
68     int vnovolError;
69     afs_uint32 flags;
70     clientchar_t * tidPathp;
71     clientchar_t * relPathp;
72 } cm_req_t;
73
74 /* flags in cm_req structure */
75 #define CM_REQ_NORETRY          0x01
76 #define CM_REQ_NEW_CONN_FORCED  0x02
77 #define CM_REQ_SOURCE_SMB       0x04
78 #define CM_REQ_VOLUME_UPDATED   0x08
79 #define CM_REQ_WOW64            0x10
80 #define CM_REQ_SOURCE_REDIR     0x20
81 #define CM_REQ_OFFLINE_VOL_CHK  0x40
82
83 /*
84  * Vice2 error codes
85  * 3/20/85
86  * Note:  all of the errors listed here are currently generated by the volume
87  * package.  Other vice error codes, should they be needed, could be included
88  * here also.
89  */
90
91 #define VREADONLY       EROFS   /* Attempt to write a read-only volume */
92
93 /* Special error codes, which may require special handling (other than just
94    passing them through directly to the end user) are listed below */
95
96 #define VICE_SPECIAL_ERRORS     101     /* Lowest special error code */
97
98 #define VSALVAGE        101     /* Volume needs salvage */
99 #define VNOVNODE        102     /* Bad vnode number quoted */
100 #define VNOVOL          103     /* Volume not attached, doesn't exist,
101                                    not created or not online */
102 #define VVOLEXISTS      104     /* Volume already exists */
103 #define VNOSERVICE      105     /* Volume is not in service (i.e. it's
104                                    is out of funds, is obsolete, or somesuch) */
105 #define VOFFLINE        106     /* Volume is off line, for the reason
106                                    given in the offline message */
107 #define VONLINE         107     /* Volume is already on line */
108 #define VDISKFULL       108     /* ENOSPC - Partition is "full",
109                                    i.e. roughly within n% of full */
110 #define VOVERQUOTA      109     /* EDQUOT - Volume max quota exceeded */
111 #define VBUSY           110     /* Volume temporarily unavailable; try again.
112                                    The volume should be available again shortly;
113                                    if it isn't something is wrong.
114                                    Not normally to be propagated to the
115                                    application level */
116 #define VMOVED          111     /* Volume has moved to another server;
117                                    do a VGetVolumeInfo to THIS server to find
118                                    out where */
119 #define VIO             112     /* Vnode temporarily unaccessible, but not known
120                                  * to be permanently bad. */
121 #define VRESTRICTED     120     /* Volume is restricted from using one or more
122                                  * of the given residencies; do a
123                                  * vos examine to find out the current
124                                  * restrictions. */
125
126 #define VRESTARTING     -100    /* server is restarting, otherwise similar to
127                                    VBUSY above.  This is negative so that old
128                                    cache managers treat it as "server is down"*/
129
130 #include "cm_server.h"
131 #ifndef AFS_PTHREAD_ENV
132 #define AFS_PTHREAD_ENV 1
133 #endif
134 #include "rx.h"
135
136 extern void cm_InitConn(void);
137
138 extern void cm_InitReq(cm_req_t *reqp);
139
140 extern int cm_Analyze(cm_conn_t *connp, struct cm_user *up, struct cm_req *reqp,
141                       struct cm_fid *fidp,
142                       afs_uint32 storeOp,
143                       struct AFSVolSync *volInfop,
144                       cm_serverRef_t * serversp,
145                       struct cm_callbackRequest *cbrp, long code);
146
147 extern long cm_ConnByMServers(struct cm_serverRef *, afs_uint32, struct cm_user *,
148         cm_req_t *, cm_conn_t **);
149
150 extern long cm_ConnByServer(struct cm_server *, struct cm_user *, afs_uint32, cm_conn_t **);
151
152 extern long cm_ConnFromFID(struct cm_fid *, struct cm_user *, struct cm_req *,
153         cm_conn_t **);
154
155 extern long cm_ConnFromVolume(struct cm_volume *volp, unsigned long volid,
156                               struct cm_user *userp, cm_req_t *reqp,
157                               cm_conn_t **connpp);
158
159 extern void cm_PutConn(cm_conn_t *connp);
160
161 extern void cm_GCConnections(cm_server_t *serverp);
162
163 extern struct rx_connection * cm_GetRxConn(cm_conn_t *connp);
164
165 extern void cm_ForceNewConnections(cm_server_t *serverp);
166
167 extern long cm_ServerAvailable(struct cm_fid *fidp, struct cm_user *userp);
168
169 extern long cm_GetServerList(struct cm_fid *fidp, struct cm_user *userp,
170                              struct cm_req *reqp, afs_uint32 *replicated,
171                              cm_serverRef_t ***serversppp);
172
173 #endif /*  OPENAFS_WINNT_AFSD_CM_CONN_H */