2 * Copyright 2000, International Business Machines Corporation and others.
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
10 #ifndef _RX_PROTOTYPES_H
11 #define _RX_PROTOTYPES_H
15 #ifndef AFS_PTHREAD_ENV
16 extern int (*registerProgram) (PROCESS, char *);
17 extern int (*swapNameProgram) (PROCESS, const char *, char *);
20 extern int (*rx_justReceived) (struct rx_packet *, struct sockaddr_in *);
21 extern int (*rx_almostSent) (struct rx_packet *, struct sockaddr_in *);
23 extern void rx_rto_setPeerTimeoutSecs(struct rx_peer *, int secs);
25 extern void rx_SetEpoch(afs_uint32 epoch);
26 extern int rx_Init(u_int port);
27 extern int rx_InitHost(u_int host, u_int port);
28 extern void rx_SetBusyChannelError(afs_int32 onoff);
30 extern void rx_DebugOnOff(int on);
31 extern void rx_StatsOnOff(int on);
32 extern void rx_StartClientThread(void);
34 extern void rx_StartServer(int donateMe);
35 extern struct rx_connection *rx_NewConnection(afs_uint32 shost,
36 u_short sport, u_short sservice,
37 struct rx_securityClass
39 int serviceSecurityIndex);
40 extern void rx_SetConnDeadTime(struct rx_connection *conn,
42 extern void rx_SetConnHardDeadTime(struct rx_connection *conn, int seconds);
43 extern void rx_SetConnIdleDeadTime(struct rx_connection *conn, int seconds);
44 extern void rxi_DestroyConnection(struct rx_connection *conn);
45 extern void rx_GetConnection(struct rx_connection *conn);
46 extern void rx_DestroyConnection(struct rx_connection *conn);
47 extern struct rx_call *rx_NewCall(struct rx_connection *conn);
48 extern int rxi_GetCallNumberVector(struct rx_connection *aconn,
50 extern int rxi_SetCallNumberVector(struct rx_connection *aconn,
52 extern struct rx_service *rx_NewService(u_short port, u_short serviceId,
54 struct rx_securityClass
57 afs_int32(*serviceProc) (struct
60 extern struct rx_service *rx_NewServiceHost(afs_uint32 host, u_short port,
63 struct rx_securityClass
66 afs_int32(*serviceProc) (struct
69 extern void rxi_ServerProc(int threadID, struct rx_call *newcall,
70 osi_socket * socketp);
71 extern void rx_WakeupServerProcs(void);
72 extern struct rx_call *rx_GetCall(int tno, struct rx_service *cur_service,
73 osi_socket * socketp);
74 extern void rx_SetArrivalProc(struct rx_call *call,
75 void (*proc) (struct rx_call *
79 void * handle, int arg);
80 extern afs_int32 rx_EndCall(struct rx_call *call, afs_int32 rc);
81 extern void rx_InterruptCall(struct rx_call *call, afs_int32 error);
82 extern void rx_Finalize(void);
83 extern void *rxi_Alloc(size_t size);
84 extern void rxi_Free(void *addr, size_t size);
85 extern void rxi_CallError(struct rx_call *call, afs_int32 error);
86 extern void rx_SetConnSecondsUntilNatPing(struct rx_connection *conn,
88 extern void rx_KeepAliveOn(struct rx_call *call);
89 extern void rx_KeepAliveOff(struct rx_call *call);
90 extern int rxs_Release(struct rx_securityClass *aobj);
92 extern void rx_PrintTheseStats(FILE * file, struct rx_statistics *s, int size,
93 afs_int32 freePackets, char version);
94 extern void rx_PrintStats(FILE * file);
95 extern void rx_PrintPeerStats(FILE * file, struct rx_peer *peer);
97 extern afs_int32 rx_GetServerDebug(osi_socket socket, afs_uint32 remoteAddr,
98 afs_uint16 remotePort,
99 struct rx_debugStats *stat,
100 afs_uint32 * supportedValues);
101 extern afs_int32 rx_GetServerStats(osi_socket socket, afs_uint32 remoteAddr,
102 afs_uint16 remotePort,
103 struct rx_statistics *stat,
104 afs_uint32 * supportedValues);
105 extern afs_int32 rx_GetServerVersion(osi_socket socket, afs_uint32 remoteAddr,
106 afs_uint16 remotePort,
107 size_t version_length, char *version);
108 extern afs_int32 rx_GetServerConnections(osi_socket socket,
109 afs_uint32 remoteAddr,
110 afs_uint16 remotePort,
111 afs_int32 * nextConnection,
113 afs_uint32 debugSupportedValues,
114 struct rx_debugConn *conn,
115 afs_uint32 * supportedValues);
116 extern afs_int32 rx_GetServerPeers(osi_socket socket, afs_uint32 remoteAddr,
117 afs_uint16 remotePort,
118 afs_int32 * nextPeer,
119 afs_uint32 debugSupportedValues,
120 struct rx_debugPeer *peer,
121 afs_uint32 * supportedValues);
122 extern afs_int32 rx_GetLocalPeers(afs_uint32 peerHost, afs_uint16 peerPort,
123 struct rx_debugPeer * peerStats);
124 extern void shutdown_rx(void);
125 #ifndef osirx_AssertMine
126 extern void osirx_AssertMine(afs_kmutex_t * lockaddr, char *msg);
129 extern int rx_KeyCreate(rx_destructor_t rtn);
131 extern void rx_SetSpecific(struct rx_connection *conn, int key, void *ptr);
132 extern void *rx_GetSpecific(struct rx_connection *conn, int key);
133 extern void rx_SetServiceSpecific(struct rx_service *svc, int key, void *ptr);
134 extern void * rx_GetServiceSpecific(struct rx_service *svc, int key);
135 extern void rx_IncrementTimeAndCount(struct rx_peer *peer,
136 afs_uint32 rxInterface,
137 afs_uint32 currentFunc,
138 afs_uint32 totalFunc,
139 struct clock *queueTime,
140 struct clock *execTime,
141 afs_hyper_t * bytesSent,
142 afs_hyper_t * bytesRcvd, int isServer);
143 extern void rx_MarshallProcessRPCStats(afs_uint32 callerVersion, int count,
144 rx_function_entry_v1_t * stats,
146 extern int rx_RetrieveProcessRPCStats(afs_uint32 callerVersion,
147 afs_uint32 * myVersion,
148 afs_uint32 * clock_sec,
149 afs_uint32 * clock_usec,
151 afs_uint32 * statCount,
152 afs_uint32 ** stats);
153 extern int rx_RetrievePeerRPCStats(afs_uint32 callerVersion,
154 afs_uint32 * myVersion,
155 afs_uint32 * clock_sec,
156 afs_uint32 * clock_usec,
157 size_t * allocSize, afs_uint32 * statCount,
158 afs_uint32 ** stats);
159 extern void rx_FreeRPCStats(afs_uint32 * stats, size_t allocSize);
160 extern int rx_queryProcessRPCStats(void);
161 extern int rx_queryPeerRPCStats(void);
162 extern void rx_enableProcessRPCStats(void);
163 extern void rx_enablePeerRPCStats(void);
164 extern void rx_disableProcessRPCStats(void);
165 extern void rx_disablePeerRPCStats(void);
166 extern void rx_clearProcessRPCStats(afs_uint32 clearFlag);
167 extern void rx_clearPeerRPCStats(afs_uint32 clearFlag);
168 extern void rx_SetRxStatUserOk(int (*proc) (struct rx_call * call));
169 extern int rx_RxStatUserOk(struct rx_call *call);
170 extern afs_int32 rx_SetSecurityConfiguration(struct rx_service *service,
171 rx_securityConfigVariables type,
173 extern int rx_GetThreadNum(void);
174 extern int rx_SetThreadNum(void);
176 void rxi_DebugInit(void);
177 void rxi_DebugPrint(char *format, ...)
178 AFS_ATTRIBUTE_FORMAT(__printf__, 1, 2);
181 #if !defined(clock_Init)
182 extern void clock_Init(void);
184 #if !defined(clock_UnInit)
185 extern int clock_UnInit(void);
187 #if !defined(clock_UpdateTime)
188 extern void clock_UpdateTime(void);
190 #if defined(UKERNEL) && !defined(osi_GetTime)
191 extern int osi_GetTime(struct timeval *tv);
198 extern void rxi_DeleteCachedConnections(void);
199 extern struct rx_connection *rx_GetCachedConnection(unsigned int remoteAddr,
201 unsigned short service,
202 struct rx_securityClass
205 extern void rx_ReleaseCachedConnection(struct rx_connection *conn);
212 extern int rxevent_nFree;
213 extern int rxevent_nPosted;
214 extern struct rxevent *rxevent_Post(struct clock *when, struct clock *now,
215 void (*func) (struct rxevent *, void *,
217 void *arg, void *arg1, int arg2);
218 extern void shutdown_rxevent(void);
219 extern struct rxepoch *rxepoch_Allocate(struct clock *when);
220 extern void rxevent_Init(int nEvents, void (*scheduler) (void));
221 extern void rxevent_Cancel(struct rxevent **ev, struct rx_call *call,
223 extern int rxevent_RaiseEvents(struct clock *next);
229 extern void rxi_setaddr(afs_uint32 x);
230 extern afs_uint32 rxi_getaddr(void);
231 extern int rx_getAllAddr(afs_uint32 * buffer, int maxSize);
232 extern int rx_getAllAddrMaskMtu(afs_uint32 addrBuffer[],
233 afs_uint32 maskBuffer[],
234 afs_uint32 mtuBuffer[],
238 extern int rx_GetMaxReceiveWindow(void);
239 extern int rx_GetMaxSendWindow(void);
240 extern void rx_SetMaxReceiveWindow(int packets);
241 extern void rx_SetMaxSendWindow(int packets);
242 extern int rx_GetMinPeerTimeout(void);
243 extern void rx_SetMinPeerTimeout(int msecs);
248 extern int (*rxk_PacketArrivalProc) (struct rx_packet * ahandle,
249 struct sockaddr_in * afrom,
250 struct socket *arock,
252 extern int (*rxk_GetPacketProc) (struct rx_packet **ahandle, int asize);
253 extern afs_int32 afs_termState;
254 extern int rxk_initDone;
256 extern int rxk_DelPort(u_short aport);
257 extern void rxk_shutdownPorts(void);
258 extern osi_socket rxi_GetUDPSocket(u_short port);
259 extern osi_socket rxi_GetHostUDPSocket(u_int host, u_short port);
260 # if defined(AFS_LINUX26_ENV)
261 # define osi_Panic(msg...) do { printk(KERN_CRIT "openafs: " msg); BUG(); } while (0)
263 # define osi_Assert(expr) \
264 do { if (!(expr)) osi_Panic("assertion failed: %s, file: %s, line: %d\n", #expr, __FILE__, __LINE__); } while (0)
265 # elif defined(AFS_AIX_ENV)
266 extern void osi_Panic(char *fmt, void *a1, void *a2, void *a3);
268 extern void osi_Panic(char *fmt, ...)
269 AFS_ATTRIBUTE_FORMAT(__printf__, 1, 2)
272 extern int osi_utoa(char *buf, size_t len, unsigned long val);
273 extern void rxi_InitPeerParams(struct rx_peer *pp);
274 extern void shutdown_rxkernel(void);
275 # ifdef AFS_USERSPACE_IP_ADDR
276 extern int rxi_GetcbiInfo(void);
277 extern afs_int32 rxi_Findcbi(afs_uint32 addr);
279 extern int rxi_GetIFInfo(void);
282 extern int rxk_FreeSocket(struct socket *asocket);
283 extern osi_socket *rxk_NewSocket(short aport);
285 extern int rxk_ReadPacket(osi_socket so, struct rx_packet *p, int *host,
288 extern void *rx_ServerProc(void *);
290 # ifndef AFS_LINUX26_ENV
291 extern void osi_AssertFailK(const char *expr, const char *file, int line) AFS_NORETURN;
293 extern void rxk_ListenerProc(void);
294 extern void rxk_Listener(void);
296 extern void afs_rxevent_daemon(void);
298 extern rx_ifnet_t rxi_FindIfnet(afs_uint32 addr, afs_uint32 * maskp);
299 extern void osi_StopListener(void);
301 /* ARCH/rx_kmutex.c */
302 # if defined(AFS_LINUX20_ENV)
303 extern void afs_mutex_init(afs_kmutex_t * l);
304 extern void afs_mutex_enter(afs_kmutex_t * l);
305 extern int afs_mutex_tryenter(afs_kmutex_t * l);
306 extern void afs_mutex_exit(afs_kmutex_t * l);
307 extern int afs_cv_wait(afs_kcondvar_t * cv, afs_kmutex_t * l, int sigok);
308 extern void afs_cv_timedwait(afs_kcondvar_t * cv, afs_kmutex_t * l,
315 # if !defined(AFS_SGI_ENV)
316 extern int osi_NetSend(osi_socket asocket, struct sockaddr_in *addr,
317 struct iovec *dvec, int nvecs, afs_int32 asize,
320 # ifdef RXK_UPCALL_ENV
321 extern void rx_upcall(socket_t so, void *arg, __unused int waitflag);
323 extern int osi_NetReceive(osi_socket so, struct sockaddr_in *addr,
324 struct iovec *dvec, int nvecs, int *lengthp);
326 # if defined(AFS_SUN510_ENV)
327 extern void osi_StartNetIfPoller(void);
328 extern void osi_NetIfPoller(void);
329 extern void osi_StopNetIfPoller(void);
330 extern struct afs_ifinfo afsifinfo[ADDRSPERSITE];
332 extern void osi_StopListener(void);
333 extern int rxi_FindIfMTU(afs_uint32 addr);
334 # if defined(UKERNEL)
335 extern void rxi_ListenerProc(osi_socket usockp, int *tnop,
336 struct rx_call **newcallp);
339 # if !defined(RXK_LISTENER_ENV) && !defined(RXK_UPCALL_ENV)
340 extern void rxk_init(void);
343 /* UKERNEL/rx_knet.c */
345 extern void afs_rxevent_daemon(void);
350 extern void rxi_Sleep(void *addr);
351 extern void rxi_Delay(int seconds);
352 extern void rxi_InitializeThreadSupport(void);
353 extern void rxi_Wakeup(void *addr);
354 extern void rxi_StopListener(void);
356 extern void rxi_ReScheduleEvents(void);
358 extern void rxi_InitializeThreadSupport(void);
359 extern void rxi_StartServerProc(void *(*proc) (void *), int stacksize);
360 extern void rxi_StartListener(void);
361 extern void *rx_ServerProc(void *);
362 extern int rxi_Listen(osi_socket sock);
363 extern int rxi_Recvmsg(osi_socket socket, struct msghdr *msg_p, int flags);
364 extern int rxi_Sendmsg(osi_socket socket, struct msghdr *msg_p, int flags);
369 extern char *osi_alloc(afs_int32 x);
372 extern int osi_free(char *x, afs_int32 size);
374 extern int hton_syserr_conv(afs_int32 code);
375 extern int ntoh_syserr_conv(int code);
379 extern struct multi_handle *multi_Init(struct rx_connection **conns,
381 extern int multi_Select(struct multi_handle *mh);
382 extern void multi_Ready(struct rx_call *call,
383 void *mh, int index);
384 extern void multi_Finalize(struct multi_handle *mh);
385 extern void multi_Finalize_Ignore(struct multi_handle *mh);
390 extern struct rx_securityClass *rxnull_NewServerSecurityObject(void);
391 extern struct rx_securityClass *rxnull_NewClientSecurityObject(void);
395 extern afs_int32 rx_SlowGetInt32(struct rx_packet *packet, size_t offset);
396 extern afs_int32 rx_SlowPutInt32(struct rx_packet *packet, size_t offset,
398 extern afs_int32 rx_SlowReadPacket(struct rx_packet *packet,
399 unsigned int offset, int resid, char *out);
400 extern afs_int32 rx_SlowWritePacket(struct rx_packet *packet, int offset,
401 int resid, char *in);
402 extern int rxi_RoundUpPacket(struct rx_packet *p, unsigned int nb);
403 extern int rxi_AllocDataBuf(struct rx_packet *p, int nb, int cla_ss);
404 extern void rxi_MorePackets(int apackets);
405 extern void rxi_MorePacketsNoLock(int apackets);
406 #if defined(AFS_PTHREAD_ENV)
407 extern void rxi_MorePacketsTSFPQ(int apackets, int flush_global, int num_keep_local); /* more flexible packet alloc function */
408 extern void rxi_AdjustLocalPacketsTSFPQ(int num_keep_local, int allow_overcommit); /* adjust thread-local queue length, for places where we know how many packets we will need a priori */
409 extern void rxi_FlushLocalPacketsTSFPQ(void); /* flush all thread-local packets to global queue */
411 extern void rxi_FreeAllPackets(void);
412 extern void rx_CheckPackets(void);
413 extern void rxi_FreePacketNoLock(struct rx_packet *p);
414 extern int rxi_FreeDataBufsNoLock(struct rx_packet *p, afs_uint32 first);
415 extern void rxi_RestoreDataBufs(struct rx_packet *p);
416 extern int rxi_TrimDataBufs(struct rx_packet *p, int first);
417 extern void rxi_FreePacket(struct rx_packet *p);
418 extern struct rx_packet *rxi_AllocPacketNoLock(int cla_ss);
419 extern struct rx_packet *rxi_AllocPacket(int cla_ss);
420 extern int rxi_AllocPackets(int cla_ss, int num_pkts, struct rx_queue *q);
421 extern int rxi_FreePackets(int num_pkts, struct rx_queue *q);
422 extern struct rx_packet *rxi_AllocSendPacket(struct rx_call *call,
424 extern int rxi_ReadPacket(osi_socket socket, struct rx_packet *p,
425 afs_uint32 * host, u_short * port);
426 extern struct rx_packet *rxi_SplitJumboPacket(struct rx_packet *p,
427 afs_uint32 host, short port,
430 extern int osi_NetSend(osi_socket socket, void *addr, struct iovec *dvec,
431 int nvecs, int length, int istack);
433 extern struct rx_packet *rxi_ReceiveDebugPacket(struct rx_packet *ap,
435 afs_uint32 ahost, short aport,
437 extern struct rx_packet *rxi_ReceiveVersionPacket(struct rx_packet
438 *ap, osi_socket asocket,
440 short aport, int istack);
441 extern void rxi_SendPacket(struct rx_call *call, struct rx_connection *conn,
442 struct rx_packet *p, int istack);
443 extern void rxi_SendPacketList(struct rx_call *call,
444 struct rx_connection *conn,
445 struct rx_packet **list, int len, int istack);
446 extern struct rx_packet *rxi_SendSpecial(struct rx_call *call,
447 struct rx_connection *conn,
448 struct rx_packet *optionalPacket,
449 int type, char *data, int nbytes,
451 extern void rxi_EncodePacketHeader(struct rx_packet *p);
452 extern void rxi_DecodePacketHeader(struct rx_packet *p);
453 extern void rxi_PrepareSendPacket(struct rx_call *call,
456 extern int rxi_AdjustIfMTU(int mtu);
457 extern int rxi_AdjustMaxMTU(int mtu, int peerMaxMTU);
458 extern int rxi_AdjustDgramPackets(int frags, int mtu);
459 #ifdef AFS_GLOBAL_RXLOCK_KERNEL
460 extern void rxi_WaitforTQBusy(struct rx_call *call);
467 extern int rx_NewThreadId(void);
468 extern void rxi_Delay(int sec);
469 extern void rxi_InitializeThreadSupport(void);
470 extern void rxi_StartServerProc(void *(*proc) (void *), int stacksize);
471 #ifndef rxi_ReScheduleEvents
472 extern void rxi_ReScheduleEvents(void);
474 extern void *rx_ServerProc(void *);
475 extern void rxi_StartListener(void);
476 extern int rxi_Listen(osi_socket sock);
477 extern int rxi_Recvmsg(osi_socket socket, struct msghdr *msg_p, int flags);
478 extern int rxi_Sendmsg(osi_socket socket, struct msghdr *msg_p, int flags);
481 extern int rxi_ReadProc(struct rx_call *call, char *buf,
483 extern int rx_ReadProc(struct rx_call *call, char *buf, int nbytes);
484 extern int rx_ReadProc32(struct rx_call *call, afs_int32 * value);
485 extern int rxi_FillReadVec(struct rx_call *call, afs_uint32 serial);
486 extern int rxi_ReadvProc(struct rx_call *call, struct iovec *iov, int *nio,
487 int maxio, int nbytes);
488 extern int rx_ReadvProc(struct rx_call *call, struct iovec *iov, int *nio,
489 int maxio, int nbytes);
490 extern int rxi_WriteProc(struct rx_call *call, char *buf,
492 extern int rx_WriteProc(struct rx_call *call, char *buf, int nbytes);
493 extern int rx_WriteProc32(struct rx_call *call,
495 extern int rx_WritevAlloc(struct rx_call *call, struct iovec *iov, int *nio,
496 int maxio, int nbytes);
497 extern int rxi_WritevProc(struct rx_call *call, struct iovec *iov, int nio,
499 extern int rx_WritevProc(struct rx_call *call, struct iovec *iov, int nio,
501 extern void rxi_FlushWrite(struct rx_call *call);
502 extern void rx_FlushWrite(struct rx_call *call);
507 extern struct rx_statistics * rx_GetStatistics(void);
508 extern void rx_FreeStatistics(struct rx_statistics **);
514 #ifdef AFS_PTHREAD_ENV
515 extern afs_kmutex_t rx_if_init_mutex;
516 extern afs_kmutex_t rx_if_mutex;
518 extern osi_socket rxi_GetUDPSocket(u_short port);
519 extern void osi_AssertFailU(const char *expr, const char *file, int line) AFS_NORETURN;
520 extern void rxi_InitPeerParams(struct rx_peer *pp);
521 extern int rxi_HandleSocketError(int socket);
523 #if defined(AFS_AIX32_ENV) && !defined(KERNEL)
525 extern void *osi_Alloc(afs_int32 x);
528 extern void osi_Free(void *x, afs_int32 size);
530 #endif /* defined(AFS_AIX32_ENV) && !defined(KERNEL) */
532 extern void osi_Panic(char *fmt, ...) AFS_NORETURN;
535 extern void rx_GetIFInfo(void);
536 extern void rx_SetNoJumbo(void);
537 extern int rx_SetMaxMTU(int mtu);
542 /* MISC PROTOTYPES - MOVE TO APPROPRIATE LOCATION LATER */
544 /* EXTERNAL PROTOTYPES - include here cause it causes too many issues to
545 include the afs_prototypes.h file - just make sure they match */
546 #ifndef afs_osi_Alloc
547 extern void *afs_osi_Alloc(size_t x);
550 extern void afs_osi_Free(void *x, size_t asize);
552 #ifndef afs_osi_Wakeup
553 extern int afs_osi_Wakeup(void *event);
555 #ifndef afs_osi_Sleep
556 extern void afs_osi_Sleep(void *event);
558 extern unsigned int afs_random(void);
559 extern void osi_linux_rxkreg(void);
561 #endif /* _RX_PROTOTYPES_H */