Windows: Do not recycle deleted scache on refcnt 0
[openafs.git] / src / WINNT / afsd / cm_server.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_SERVER_H
11 #define OPENAFS_WINNT_AFSD_CM_SERVER_H 1
12
13 #include <winsock2.h>
14 #include <osi.h>
15
16 /* this value is set to 1022 in order to  */
17 #define NUM_SERVER_VOLS         (32 - sizeof(void *) / 4)
18 typedef struct cm_server_vols {
19     afs_uint32             ids[NUM_SERVER_VOLS];
20     struct cm_server_vols *nextp;
21 } cm_server_vols_t;
22
23 /* pointed to by volumes and cells without holds; cm_serverLock is obtained
24  * at the appropriate times to change the pointers to these servers.
25  */
26 typedef struct cm_server {
27     struct cm_server *allNextp;         /* locked by cm_serverLock */
28     struct sockaddr_in addr;            /* by mx */
29     int type;                           /* by mx */
30     struct cm_conn *connsp;             /* locked by cm_connLock */
31     afs_int32 flags;                    /* by mx */
32     afs_int32 waitCount;                /* by mx */
33     afs_int32 capabilities;             /* by mx */
34     struct cm_cell *cellp;              /* cell containing this server */
35     afs_int32 refCount;                 /* Interlocked with cm_serverLock */
36     osi_mutex_t mx;
37     unsigned short ipRank;              /* network class rank */
38     unsigned short adminRank;           /* set if admin sets a rank
39                                          * (fs setserverpref or registry or dns)
40                                          */
41     unsigned short activeRank;          /* Computed rank combining ipRank, adminRank,
42                                          * and performance data.
43                                          */
44     cm_server_vols_t *  vols;           /* by mx */
45     time_t downTime;                    /* by mx */
46     afsUUID uuid;                       /* by mx */
47 } cm_server_t;
48
49 enum repstate {srv_not_busy, srv_busy, srv_offline, srv_deleted};
50
51 typedef struct cm_serverRef {
52     struct cm_serverRef *next;      /* locked by cm_serverLock */
53     struct cm_server *server;       /* locked by cm_serverLock */
54     enum repstate status;           /* locked by cm_serverLock */
55     afs_int32 refCount;             /* locked by cm_serverLock */
56     afs_uint32 volID;               /* locked by cm_serverLock */
57 } cm_serverRef_t;
58
59 /* types */
60 #define CM_SERVER_VLDB          1       /* a VLDB server */
61 #define CM_SERVER_FILE          2       /* a file server */
62
63 /* flags */
64 #define CM_SERVERFLAG_DOWN      0x1     /* server is down */
65 #define CM_SERVERFLAG_PREF_SET  0x2     /* server preference set by user */
66 #define CM_SERVERFLAG_PINGING   0x4     /* a ping against this server in progress */
67 #define CM_SERVERFLAG_NO64BIT   0x8     /* server has no support for
68                                            64-bit operations. */
69 #define CM_SERVERFLAG_NOINLINEBULK 0x10 /* server has no support for inline bulk */
70 #define CM_SERVERFLAG_UUID      0x20    /* server uuid is known */
71
72 /* flags for procedures */
73 #define CM_FLAG_CHECKUPSERVERS          1       /* check working servers */
74 #define CM_FLAG_CHECKDOWNSERVERS        2       /* check down servers */
75 #define CM_FLAG_CHECKVLDBSERVERS        4       /* check only vldb servers */
76 #define CM_FLAG_CHECKFILESERVERS        8       /* check only file servers */
77
78 /* values for ipRank */
79 #define CM_IPRANK_TOP   5000    /* on same machine */
80 #define CM_IPRANK_HI    20000   /* on same subnet  */
81 #define CM_IPRANK_MED   30000   /* on same network */
82 #define CM_IPRANK_LOW   40000   /* on different networks */
83 #define CM_IPRANK_DOWN  65535   /* unavailable */
84
85 /* the maximum number of network interfaces that this client has */
86
87 #define CM_MAXINTERFACE_ADDR          16
88
89 extern cm_server_t *cm_NewServer(struct sockaddr_in *addrp, int type,
90         struct cm_cell *cellp, afsUUID *uuidp, afs_uint32 flags);
91
92 extern cm_serverRef_t *cm_NewServerRef(struct cm_server *serverp, afs_uint32 volID);
93
94 extern void cm_GetServerRef(cm_serverRef_t *tsrp, int locked);
95
96 extern afs_int32 cm_PutServerRef(cm_serverRef_t *tsrp, int locked);
97
98 extern LONG_PTR cm_ChecksumServerList(cm_serverRef_t *serversp);
99
100 extern void cm_GetServer(cm_server_t *);
101
102 extern void cm_GetServerNoLock(cm_server_t *);
103
104 extern void cm_PutServer(cm_server_t *);
105
106 extern void cm_PutServerNoLock(cm_server_t *);
107
108 extern cm_server_t *cm_FindServer(struct sockaddr_in *addrp, int type, int locked);
109
110 extern osi_rwlock_t cm_serverLock;
111
112 extern osi_rwlock_t cm_syscfgLock;
113
114 extern void cm_InitServer(void);
115
116 extern void cm_CheckServers(afs_uint32 flags, struct cm_cell *cellp);
117
118 extern cm_server_t *cm_allServersp;
119
120 extern afs_int32 cm_RankServer(cm_server_t * server);
121
122 extern void cm_RankUpServers();
123
124 extern void cm_SetServerIPRank(cm_server_t * serverp);
125
126 extern void cm_InsertServerList(cm_serverRef_t** list,cm_serverRef_t* element);
127
128 extern long cm_ChangeRankServer(cm_serverRef_t** list, cm_server_t* server);
129
130 extern void cm_RandomizeServer(cm_serverRef_t** list);
131
132 extern void cm_FreeServer(cm_server_t* server);
133
134 extern afs_uint32 cm_ServerListSize(cm_serverRef_t* list);
135
136 #define CM_FREESERVERLIST_DELETE 1
137
138 extern void cm_FreeServerList(cm_serverRef_t** list, afs_uint32 flags);
139
140 extern void cm_ForceNewConnectionsAllServers(void);
141
142 extern void cm_SetServerNo64Bit(cm_server_t * serverp, int no64bit);
143
144 extern void cm_SetServerNoInlineBulk(cm_server_t * serverp, int no);
145
146 extern cm_server_t * cm_FindServerByIP(afs_uint32 addr, unsigned short port, int type, int locked);
147
148 extern cm_server_t * cm_FindServerByUuid(afsUUID* uuid, int type, int locked);
149
150 extern void cm_SetLanAdapterChangeDetected(void);
151
152 extern void cm_RemoveVolumeFromServer(cm_server_t * serverp, afs_uint32 volID);
153
154 extern int cm_DumpServers(FILE *outputFile, char *cookie, int lock);
155
156 extern int cm_ServerEqual(cm_server_t *srv1, cm_server_t *srv2);
157
158 extern int cm_IsServerListEmpty(cm_serverRef_t *serversp);
159
160 extern void cm_ServerClearRPCStats(void);
161
162 /* Protected by cm_syscfgLock (rw) */
163 extern int cm_noIPAddr;         /* number of client network interfaces */
164 extern int cm_IPAddr[CM_MAXINTERFACE_ADDR];    /* client's IP address in host order */
165 extern int cm_SubnetMask[CM_MAXINTERFACE_ADDR];/* client's subnet mask in host order*/
166 extern int cm_NetMtu[CM_MAXINTERFACE_ADDR];    /* client's MTU sizes */
167 extern int cm_NetFlags[CM_MAXINTERFACE_ADDR];  /* network flags */
168 extern int cm_LanAdapterChangeDetected;
169
170 /* Protected by cm_serverLock */
171 extern cm_server_t *cm_allServersp;
172 extern afs_uint32   cm_numFileServers;
173 extern afs_uint32   cm_numVldbServers;
174 #endif /*  OPENAFS_WINNT_AFSD_CM_SERVER_H */