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