windows-remove-give-up-callbacks-scache-recycling-20070627
[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 __CM_SERVER_H_ENV__
11 #define __CM_SERVER_H_ENV__ 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     unsigned long refCount;             /* locked by cm_serverLock */
36     osi_mutex_t mx;
37     unsigned short ipRank;              /* server priority */
38     cm_server_vols_t *  vols;           /* by mx */
39 } cm_server_t;
40
41 enum repstate {srv_not_busy, srv_busy, srv_offline, srv_deleted};
42
43 typedef struct cm_serverRef {
44     struct cm_serverRef *next;      /* locked by cm_serverLock */
45     struct cm_server *server;       /* locked by cm_serverLock */
46     enum repstate status;           /* locked by cm_serverLock */
47     unsigned long refCount;         /* locked by cm_serverLock */
48     afs_uint32 volID;               /* locked by cm_serverLock */
49 } cm_serverRef_t;
50
51 /* types */
52 #define CM_SERVER_VLDB          1       /* a VLDB server */
53 #define CM_SERVER_FILE          2       /* a file server */
54
55 /* flags */
56 #define CM_SERVERFLAG_DOWN      0x1     /* server is down */
57 #define CM_SERVERFLAG_PREF_SET  0x2     /* server preference set by user */
58 #define CM_SERVERFLAG_PINGING   0x4     /* a ping against this server in progress */
59 #define CM_SERVERFLAG_NO64BIT   0x8     /* server has no support for
60                                            64-bit operations. */
61 #define CM_SERVERFLAG_NOINLINEBULK 0x10 /* server has no support for inline bulk */
62
63 /* flags for procedures */
64 #define CM_FLAG_CHECKUPSERVERS          1       /* check working servers */
65 #define CM_FLAG_CHECKDOWNSERVERS        2       /* check down servers */
66 #define CM_FLAG_CHECKVLDBSERVERS        4       /* check only vldb servers */
67 #define CM_FLAG_CHECKFILESERVERS        8       /* check only file servers */
68
69 /* values for ipRank */
70 #define CM_IPRANK_TOP   5000    /* on same machine */
71 #define CM_IPRANK_HI    20000   /* on same subnet  */
72 #define CM_IPRANK_MED   30000   /* on same network */
73 #define CM_IPRANK_LOW   40000   /* on different networks */
74
75 /* the maximum number of network interfaces that this client has */ 
76
77 #define CM_MAXINTERFACE_ADDR          16
78
79 extern cm_server_t *cm_NewServer(struct sockaddr_in *addrp, int type,
80         struct cm_cell *cellp);
81
82 extern cm_serverRef_t *cm_NewServerRef(struct cm_server *serverp, afs_uint32 volID);
83
84 extern LONG_PTR cm_ChecksumServerList(cm_serverRef_t *serversp);
85
86 extern void cm_GetServer(cm_server_t *);
87
88 extern void cm_GetServerNoLock(cm_server_t *);
89
90 extern void cm_PutServer(cm_server_t *);
91
92 extern void cm_PutServerNoLock(cm_server_t *);
93
94 extern cm_server_t *cm_FindServer(struct sockaddr_in *addrp, int type);
95
96 extern osi_rwlock_t cm_serverLock;
97
98 extern void cm_InitServer(void);
99
100 extern void cm_CheckServers(long flags, struct cm_cell *cellp);
101
102 extern cm_server_t *cm_allServersp;
103
104 extern void cm_SetServerPrefs(cm_server_t * serverp);
105
106 extern void cm_InsertServerList(cm_serverRef_t** list,cm_serverRef_t* element);
107
108 extern long cm_ChangeRankServer(cm_serverRef_t** list, cm_server_t* server); 
109
110 extern void cm_RandomizeServer(cm_serverRef_t** list); 
111
112 extern void cm_FreeServer(cm_server_t* server);
113
114 #define CM_FREESERVERLIST_DELETE 1
115
116 extern void cm_FreeServerList(cm_serverRef_t** list, afs_uint32 flags);
117
118 extern void cm_ForceNewConnectionsAllServers(void);
119
120 extern void cm_SetServerNo64Bit(cm_server_t * serverp, int no64bit);
121
122 extern void cm_SetServerNoInlineBulk(cm_server_t * serverp, int no);
123
124 extern cm_server_t * cm_FindServerByIP(afs_uint32 addr, int type);
125
126 #endif /*  __CM_SERVER_H_ENV__ */