windows-afsd-service-20051121
[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 #ifndef DJGPP
14 #include <winsock2.h>
15 #else /* DJGPP */
16 #include <netinet/in.h>
17 #endif /* !DJGPP */
18 #include <osi.h>
19
20 /* pointed to by volumes and cells without holds; cm_serverLock is obtained
21  * at the appropriate times to change the pointers to these servers.
22  */
23 typedef struct cm_server {
24     struct cm_server *allNextp;         /* locked by cm_serverLock */
25     struct sockaddr_in addr;            /* by mx */
26     int type;                           /* by mx */
27     struct cm_conn *connsp;             /* locked by cm_connLock */
28     long flags;                         /* by mx */
29     struct cm_cell *cellp;              /* cell containing this server */
30     unsigned long refCount;             /* locked by cm_serverLock */
31     osi_mutex_t mx;
32     unsigned short ipRank;              /* server priority */
33 } cm_server_t;
34
35 enum repstate {not_busy, busy, offline};
36
37 typedef struct cm_serverRef {
38     struct cm_serverRef *next;      /* locked by cm_serverLock */
39     struct cm_server *server;       /* locked by cm_serverLock */
40     enum repstate status;           /* locked by cm_serverLock */
41     unsigned long refCount;                   /* locked by cm_serverLock */
42 } cm_serverRef_t;
43
44 /* types */
45 #define CM_SERVER_VLDB          1       /* a VLDB server */
46 #define CM_SERVER_FILE          2       /* a file server */
47
48 /* flags */
49 #define CM_SERVERFLAG_DOWN      1       /* server is down */
50 #define CM_SERVERFLAG_PREF_SET  2       /* server preference set by user */
51
52 /* flags for procedures */
53 #define CM_FLAG_CHECKUPSERVERS          1       /* check working servers */
54 #define CM_FLAG_CHECKDOWNSERVERS        2       /* check down servers */
55
56 /* values for ipRank */
57 #define CM_IPRANK_TOP   5000    /* on same machine */
58 #define CM_IPRANK_HI    20000   /* on same subnet  */
59 #define CM_IPRANK_MED   30000   /* on same network */
60 #define CM_IPRANK_LOW   40000   /* on different networks */
61
62 /* the maximum number of network interfaces that this client has */ 
63
64 #define CM_MAXINTERFACE_ADDR          16
65
66 extern cm_server_t *cm_NewServer(struct sockaddr_in *addrp, int type,
67         struct cm_cell *cellp);
68
69 extern cm_serverRef_t *cm_NewServerRef(struct cm_server *serverp);
70
71 extern LONG_PTR cm_ChecksumServerList(cm_serverRef_t *serversp);
72
73 extern void cm_GetServer(cm_server_t *);
74
75 extern void cm_GetServerNoLock(cm_server_t *);
76
77 extern void cm_PutServer(cm_server_t *);
78
79 extern void cm_PutServerNoLock(cm_server_t *);
80
81 extern cm_server_t *cm_FindServer(struct sockaddr_in *addrp, int type);
82
83 extern osi_rwlock_t cm_serverLock;
84
85 extern void cm_InitServer(void);
86
87 extern void cm_CheckServers(long flags, struct cm_cell *cellp);
88
89 extern cm_server_t *cm_allServersp;
90
91 extern void cm_SetServerPrefs(cm_server_t * serverp);
92
93 extern void cm_InsertServerList(cm_serverRef_t** list,cm_serverRef_t* element);
94
95 extern long cm_ChangeRankServer(cm_serverRef_t** list, cm_server_t* server); 
96
97 extern void cm_RandomizeServer(cm_serverRef_t** list); 
98
99 extern void cm_FreeServer(cm_server_t* server);
100
101 extern void cm_FreeServerList(cm_serverRef_t** list);
102
103 #endif /*  __CM_SERVER_H_ENV__ */