separate-capabilities-by-source-20051217
[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     afs_int32 flags;                    /* by mx */
29     afs_int32 capabilities;             /* by mx */
30     struct cm_cell *cellp;              /* cell containing this server */
31     unsigned long refCount;             /* locked by cm_serverLock */
32     osi_mutex_t mx;
33     unsigned short ipRank;              /* server priority */
34 } cm_server_t;
35
36 enum repstate {not_busy, busy, offline};
37
38 typedef struct cm_serverRef {
39     struct cm_serverRef *next;      /* locked by cm_serverLock */
40     struct cm_server *server;       /* locked by cm_serverLock */
41     enum repstate status;           /* locked by cm_serverLock */
42     unsigned long refCount;                   /* locked by cm_serverLock */
43 } cm_serverRef_t;
44
45 /* types */
46 #define CM_SERVER_VLDB          1       /* a VLDB server */
47 #define CM_SERVER_FILE          2       /* a file server */
48
49 /* flags */
50 #define CM_SERVERFLAG_DOWN      1       /* server is down */
51 #define CM_SERVERFLAG_PREF_SET  2       /* server preference set by user */
52
53 /* flags for procedures */
54 #define CM_FLAG_CHECKUPSERVERS          1       /* check working servers */
55 #define CM_FLAG_CHECKDOWNSERVERS        2       /* check down servers */
56
57 /* values for ipRank */
58 #define CM_IPRANK_TOP   5000    /* on same machine */
59 #define CM_IPRANK_HI    20000   /* on same subnet  */
60 #define CM_IPRANK_MED   30000   /* on same network */
61 #define CM_IPRANK_LOW   40000   /* on different networks */
62
63 /* the maximum number of network interfaces that this client has */ 
64
65 #define CM_MAXINTERFACE_ADDR          16
66
67 extern cm_server_t *cm_NewServer(struct sockaddr_in *addrp, int type,
68         struct cm_cell *cellp);
69
70 extern cm_serverRef_t *cm_NewServerRef(struct cm_server *serverp);
71
72 extern LONG_PTR cm_ChecksumServerList(cm_serverRef_t *serversp);
73
74 extern void cm_GetServer(cm_server_t *);
75
76 extern void cm_GetServerNoLock(cm_server_t *);
77
78 extern void cm_PutServer(cm_server_t *);
79
80 extern void cm_PutServerNoLock(cm_server_t *);
81
82 extern cm_server_t *cm_FindServer(struct sockaddr_in *addrp, int type);
83
84 extern osi_rwlock_t cm_serverLock;
85
86 extern void cm_InitServer(void);
87
88 extern void cm_CheckServers(long flags, struct cm_cell *cellp);
89
90 extern cm_server_t *cm_allServersp;
91
92 extern void cm_SetServerPrefs(cm_server_t * serverp);
93
94 extern void cm_InsertServerList(cm_serverRef_t** list,cm_serverRef_t* element);
95
96 extern long cm_ChangeRankServer(cm_serverRef_t** list, cm_server_t* server); 
97
98 extern void cm_RandomizeServer(cm_serverRef_t** list); 
99
100 extern void cm_FreeServer(cm_server_t* server);
101
102 extern void cm_FreeServerList(cm_serverRef_t** list);
103
104 #endif /*  __CM_SERVER_H_ENV__ */