61a7d8a0e3a40564254407b5020c0159bcfa3d45
[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     afs_int32 refCount;                 /* Interlocked with cm_serverLock */
36     osi_mutex_t mx;
37     unsigned short ipRank;              /* server priority */
38     cm_server_vols_t *  vols;           /* by mx */
39     time_t downTime;                    /* by mx */
40     afsUUID uuid;                       /* by mx */
41 } cm_server_t;
42
43 enum repstate {srv_not_busy, srv_busy, srv_offline, srv_deleted};
44
45 typedef struct cm_serverRef {
46     struct cm_serverRef *next;      /* locked by cm_serverLock */
47     struct cm_server *server;       /* locked by cm_serverLock */
48     enum repstate status;           /* locked by cm_serverLock */
49     afs_int32 refCount;             /* locked by cm_serverLock */
50     afs_uint32 volID;               /* locked by cm_serverLock */
51 } cm_serverRef_t;
52
53 /* types */
54 #define CM_SERVER_VLDB          1       /* a VLDB server */
55 #define CM_SERVER_FILE          2       /* a file server */
56
57 /* flags */
58 #define CM_SERVERFLAG_DOWN      0x1     /* server is down */
59 #define CM_SERVERFLAG_PREF_SET  0x2     /* server preference set by user */
60 #define CM_SERVERFLAG_PINGING   0x4     /* a ping against this server in progress */
61 #define CM_SERVERFLAG_NO64BIT   0x8     /* server has no support for
62                                            64-bit operations. */
63 #define CM_SERVERFLAG_NOINLINEBULK 0x10 /* server has no support for inline bulk */
64 #define CM_SERVERFLAG_UUID      0x20    /* server uuid is known */
65
66 /* flags for procedures */
67 #define CM_FLAG_CHECKUPSERVERS          1       /* check working servers */
68 #define CM_FLAG_CHECKDOWNSERVERS        2       /* check down servers */
69 #define CM_FLAG_CHECKVLDBSERVERS        4       /* check only vldb servers */
70 #define CM_FLAG_CHECKFILESERVERS        8       /* check only file servers */
71
72 /* values for ipRank */
73 #define CM_IPRANK_TOP   5000    /* on same machine */
74 #define CM_IPRANK_HI    20000   /* on same subnet  */
75 #define CM_IPRANK_MED   30000   /* on same network */
76 #define CM_IPRANK_LOW   40000   /* on different networks */
77
78 /* the maximum number of network interfaces that this client has */ 
79
80 #define CM_MAXINTERFACE_ADDR          16
81
82 extern cm_server_t *cm_NewServer(struct sockaddr_in *addrp, int type,
83         struct cm_cell *cellp, afsUUID *uuidp, afs_uint32 flags);
84
85 extern cm_serverRef_t *cm_NewServerRef(struct cm_server *serverp, afs_uint32 volID);
86
87 extern LONG_PTR cm_ChecksumServerList(cm_serverRef_t *serversp);
88
89 extern void cm_GetServer(cm_server_t *);
90
91 extern void cm_GetServerNoLock(cm_server_t *);
92
93 extern void cm_PutServer(cm_server_t *);
94
95 extern void cm_PutServerNoLock(cm_server_t *);
96
97 extern cm_server_t *cm_FindServer(struct sockaddr_in *addrp, int type);
98
99 extern osi_rwlock_t cm_serverLock;
100
101 extern osi_rwlock_t cm_syscfgLock;
102
103 extern void cm_InitServer(void);
104
105 extern void cm_CheckServers(afs_uint32 flags, struct cm_cell *cellp);
106
107 extern cm_server_t *cm_allServersp;
108
109 extern void cm_SetServerPrefs(cm_server_t * serverp);
110
111 extern void cm_InsertServerList(cm_serverRef_t** list,cm_serverRef_t* element);
112
113 extern long cm_ChangeRankServer(cm_serverRef_t** list, cm_server_t* server); 
114
115 extern void cm_RandomizeServer(cm_serverRef_t** list); 
116
117 extern void cm_FreeServer(cm_server_t* server);
118
119 #define CM_FREESERVERLIST_DELETE 1
120
121 extern void cm_FreeServerList(cm_serverRef_t** list, afs_uint32 flags);
122
123 extern void cm_ForceNewConnectionsAllServers(void);
124
125 extern void cm_SetServerNo64Bit(cm_server_t * serverp, int no64bit);
126
127 extern void cm_SetServerNoInlineBulk(cm_server_t * serverp, int no);
128
129 extern cm_server_t * cm_FindServerByIP(afs_uint32 addr, int type);
130
131 extern void cm_SetLanAdapterChangeDetected(void);
132
133 extern void cm_RemoveVolumeFromServer(cm_server_t * serverp, afs_uint32 volID);
134
135 extern int cm_DumpServers(FILE *outputFile, char *cookie, int lock);
136
137 /* Protected by cm_syscfgLock (rw) */
138 extern int cm_noIPAddr;         /* number of client network interfaces */
139 extern int cm_IPAddr[CM_MAXINTERFACE_ADDR];    /* client's IP address in host order */
140 extern int cm_SubnetMask[CM_MAXINTERFACE_ADDR];/* client's subnet mask in host order*/
141 extern int cm_NetMtu[CM_MAXINTERFACE_ADDR];    /* client's MTU sizes */
142 extern int cm_NetFlags[CM_MAXINTERFACE_ADDR];  /* network flags */
143 extern int cm_LanAdapterChangeDetected;
144 #endif /*  __CM_SERVER_H_ENV__ */