#ifndef CLICK_LLRPC_H #define CLICK_LLRPC_H #if CLICK_LINUXMODULE # include CLICK_CXX_PROTECT # include # include # include CLICK_CXX_UNPROTECT # include #elif CLICK_BSDMODULE # include # include #else # include # include #endif /* Click low-level RPC interface */ /* Ioctl numbers are not consistent across platforms unless you #define HAVE_PORTABLE_LLRPC. */ #define _CLICK_NET_IOC_VOID 0x20000000 #define _CLICK_NET_IOC_OUT 0x40000000 #define _CLICK_NET_IOC_IN 0x80000000 #if HAVE_PORTABLE_LLRPC || !defined(__linux__) # define _CLICK_IOC_VOID _CLICK_NET_IOC_VOID # define _CLICK_IOC_OUT _CLICK_NET_IOC_OUT # define _CLICK_IOC_IN _CLICK_NET_IOC_IN #else # define _CLICK_IOC_VOID (_IOC_NONE << _IOC_DIRSHIFT) # define _CLICK_IOC_OUT (_IOC_READ << _IOC_DIRSHIFT) # define _CLICK_IOC_IN (_IOC_WRITE << _IOC_DIRSHIFT) #endif #define _CLICK_IOC_BASE_MASK 0x0FFFFFFF #define _CLICK_IOC_SAFE 0x00008000 #define _CLICK_IOC_FLAT 0x00004000 #define _CLICK_IOC_SIZE(io) ((io) >> 16 & 0xFFF) /* _CLICK_IO[S]: data transfer direction unknown, pass pointer unchanged; _CLICK_IOR[S]: data of specified size sent from kernel to user; _CLICK_IOW[S]: data of specified size sent from user to kernel; _CLICK_IOWR[S]: data of specified size transferred in both directions. */ /* "Non-safe" LLRPCs will not be performed in parallel with other LLRPCs or handlers. They will also block the router threads. */ #define _CLICK_IOX(d, n, sz) ((d) | ((sz) << 16) | (n)) #define _CLICK_IO(n) _CLICK_IOX(_CLICK_IOC_VOID, (n), 0) #define _CLICK_IOR(n, sz) _CLICK_IOX(_CLICK_IOC_OUT, (n), (sz)) #define _CLICK_IOW(n, sz) _CLICK_IOX(_CLICK_IOC_IN, (n), (sz)) #define _CLICK_IOWR(n, sz) _CLICK_IOX(_CLICK_IOC_IN|_CLICK_IOC_OUT, (n), (sz)) /* "Safe" LLRPCs may be performed in parallel with read handlers and other safe LLRPCs, but not with write handlers or unsafe LLRPCs. They will not block the router threads. */ #define _CLICK_IOS(n) _CLICK_IOX(_CLICK_IOC_VOID|_CLICK_IOC_SAFE, (n), 0) #define _CLICK_IORS(n, sz) _CLICK_IOX(_CLICK_IOC_OUT|_CLICK_IOC_SAFE, (n), (sz)) #define _CLICK_IOWS(n, sz) _CLICK_IOX(_CLICK_IOC_IN|_CLICK_IOC_SAFE, (n), (sz)) #define _CLICK_IOWRS(n, sz) _CLICK_IOX(_CLICK_IOC_IN|_CLICK_IOC_OUT|_CLICK_IOC_SAFE, (n), (sz)) /* "Flat" LLRPCs do not contain pointers -- all data read or written is contained in the size. They can be safe or unsafe. */ #define _CLICK_IORF(n, sz) _CLICK_IOX(_CLICK_IOC_OUT|_CLICK_IOC_FLAT, (n), (sz)) #define _CLICK_IOWF(n, sz) _CLICK_IOX(_CLICK_IOC_IN|_CLICK_IOC_FLAT, (n), (sz)) #define _CLICK_IOWRF(n, sz) _CLICK_IOX(_CLICK_IOC_IN|_CLICK_IOC_OUT|_CLICK_IOC_FLAT, (n), (sz)) #define _CLICK_IORSF(n, sz) _CLICK_IOX(_CLICK_IOC_OUT|_CLICK_IOC_SAFE|_CLICK_IOC_FLAT, (n), (sz)) #define _CLICK_IOWSF(n, sz) _CLICK_IOX(_CLICK_IOC_IN|_CLICK_IOC_SAFE|_CLICK_IOC_FLAT, (n), (sz)) #define _CLICK_IOWRSF(n, sz) _CLICK_IOX(_CLICK_IOC_IN|_CLICK_IOC_OUT|_CLICK_IOC_SAFE|_CLICK_IOC_FLAT, (n), (sz)) #define CLICK_LLRPC_PROXY _CLICK_IO(0) #define CLICK_LLRPC_GET_RATE _CLICK_IOWRSF(1, 4) #define CLICK_LLRPC_GET_RATES _CLICK_IOS(2) #define CLICK_LLRPC_GET_COUNT _CLICK_IOWRSF(3, 4) #define CLICK_LLRPC_GET_COUNTS _CLICK_IOS(4) #define CLICK_LLRPC_GET_SWITCH _CLICK_IORSF(5, 4) #define CLICK_LLRPC_SET_SWITCH _CLICK_IOWF(6, 4) #define CLICK_LLRPC_MAP_IPADDRESS _CLICK_IOWRF(7, 4) #define CLICK_LLRPC_IPREWRITER_MAP_TCP _CLICK_IOWRF(8, 12) #define CLICK_LLRPC_IPREWRITER_MAP_UDP _CLICK_IOWRF(9, 12) #define CLICK_LLRPC_IPRATEMON_LEVEL_FWD_AVG _CLICK_IO(10) #define CLICK_LLRPC_IPRATEMON_LEVEL_REV_AVG _CLICK_IO(11) #define CLICK_LLRPC_IPRATEMON_FWD_N_REV_AVG _CLICK_IO(12) #define CLICK_LLRPC_IPRATEMON_SET_ANNO_LEVEL _CLICK_IO(13) #define CLICK_IOC_TOUSERDEVICE_GET_MULTI _CLICK_IOS(15) #define CLICK_IOC_TOUSERDEVICE_SET_MULTI _CLICK_IOS(16) #define CLICK_LLRPC_RAW_HANDLER _CLICK_IOS(17) #define CLICK_LLRPC_ABANDON_HANDLER _CLICK_IOS(18) #define CLICK_LLRPC_CALL_HANDLER _CLICK_IO(19) struct click_llrpc_proxy_st { void* proxied_handler; /* const Router::Handler* */ uint32_t proxied_command; void* proxied_data; }; #define CLICK_LLRPC_COUNTS_SIZE 8 struct click_llrpc_counts_st { uint32_t n; uint32_t keys[CLICK_LLRPC_COUNTS_SIZE]; uint32_t values[CLICK_LLRPC_COUNTS_SIZE]; }; #define CLICK_LLRPC_CALL_HANDLER_FLAG_RAW 1 struct click_llrpc_call_handler_st { int flags; size_t errorlen; void *errorbuf; }; /* data manipulation */ #if CLICK_USERLEVEL || CLICK_MINIOS # define CLICK_LLRPC_GET_DATA(local, remote, size) (memcpy(local, remote, size), 0) # define CLICK_LLRPC_PUT_DATA(remote, local, size) (memcpy(remote, local, size), 0) # define CLICK_LLRPC_GET(local_obj, remote_addr) (memcpy(&(local_obj), remote_addr, sizeof(local_obj)), 0) # define CLICK_LLRPC_PUT(remote_addr, local_obj) (memcpy(remote_addr, &(local_obj), sizeof(local_obj)), 0) #elif CLICK_LINUXMODULE # ifdef __cplusplus # define __CLICK_LLRPC_CAST(x) reinterpret_cast< x > # else # define __CLICK_LLRPC_CAST(x) (x) # endif # define __CLICK_LLRPC_GENERIC_GET_DATA(local, remote, size) \ (copy_from_user(local, remote, size) > 0 ? -EFAULT : 0) # define __CLICK_LLRPC_CONSTANT_GET_DATA(local, remote, size) \ (size == 1 ? get_user(*__CLICK_LLRPC_CAST(unsigned char *)(local), __CLICK_LLRPC_CAST(unsigned char *)(remote)) \ : (size == 2 ? get_user(*__CLICK_LLRPC_CAST(unsigned short *)(local), __CLICK_LLRPC_CAST(unsigned short *)(remote)) \ : (size == 4 ? get_user(*__CLICK_LLRPC_CAST(unsigned *)(local), __CLICK_LLRPC_CAST(unsigned *)(remote)) \ : __CLICK_LLRPC_GENERIC_GET_DATA(local, remote, size)))) # define __CLICK_LLRPC_GENERIC_PUT_DATA(remote, local, size) \ (copy_to_user(remote, local, size) > 0 ? -EFAULT : 0) # define __CLICK_LLRPC_CONSTANT_PUT_DATA(remote, local, size) \ (size == 1 ? put_user(*__CLICK_LLRPC_CAST(const unsigned char *)(local), __CLICK_LLRPC_CAST(unsigned char *)(remote)) \ : (size == 2 ? put_user(*__CLICK_LLRPC_CAST(const unsigned short *)(local), __CLICK_LLRPC_CAST(unsigned short *)(remote)) \ : (size == 4 ? put_user(*__CLICK_LLRPC_CAST(const unsigned *)(local), __CLICK_LLRPC_CAST(unsigned *)(remote)) \ : __CLICK_LLRPC_GENERIC_PUT_DATA(remote, local, size)))) # define CLICK_LLRPC_GET_DATA(local, remote, size) \ (__builtin_constant_p(size) && size <= 4 \ ? __CLICK_LLRPC_CONSTANT_GET_DATA(local, remote, size) \ : __CLICK_LLRPC_GENERIC_GET_DATA(local, remote, size)) # define CLICK_LLRPC_PUT_DATA(remote, local, size) \ (__builtin_constant_p(size) && size <= 4 \ ? __CLICK_LLRPC_CONSTANT_PUT_DATA(remote, local, size) \ : __CLICK_LLRPC_GENERIC_PUT_DATA(remote, local, size)) # define CLICK_LLRPC_GET(local_obj, remote_addr) \ get_user((local_obj), (remote_addr)) # define CLICK_LLRPC_PUT(remote_addr, local_obj) \ put_user((local_obj), (remote_addr)) #elif CLICK_BSDMODULE /* * XXX LLRPC isn't implemented for BSD yet. */ # define CLICK_LLRPC_GET_DATA(local, remote, size) ((void)(local), (void)(remote), (void)(size), -EFAULT) # define CLICK_LLRPC_PUT_DATA(remote, local, size) ((void)(local), (void)(remote), (void)(size), -EFAULT) # define CLICK_LLRPC_GET(local_obj, remote_addr) ((void)(local_obj), (void)(remote_addr), -EFAULT) # define CLICK_LLRPC_PUT(remote_addr, local_obj) ((void)(local_obj), (void)(remote_addr), -EFAULT) #endif /* CLICK_NTOH_LLRPC: portable LLRPC numbers to host LLRPC numbers */ /* CLICK_HTON_LLRPC: host LLRPC numbers to portable LLRPC numbers */ /* both macros are only suitable for integer constants and the like */ #if _CLICK_IOC_VOID != _CLICK_NET_IOC_VOID || _CLICK_IOC_OUT != _CLICK_NET_IOC_OUT || _CLICK_IOC_IN != _CLICK_NET_IOC_IN # define CLICK_LLRPC_NTOH(command) \ (((command) & _CLICK_NET_IOC_VOID ? _CLICK_IOC_VOID : 0) \ | ((command) & _CLICK_NET_IOC_OUT ? _CLICK_IOC_OUT : 0) \ | ((command) & _CLICK_NET_IOC_IN ? _CLICK_IOC_IN : 0) \ | ((command) & _CLICK_IOC_BASE_MASK)) # define CLICK_LLRPC_HTON(command) \ (((command) & _CLICK_IOC_VOID ? _CLICK_NET_IOC_VOID : 0) \ | ((command) & _CLICK_IOC_OUT ? _CLICK_NET_IOC_OUT : 0) \ | ((command) & _CLICK_IOC_IN ? _CLICK_NET_IOC_IN : 0) \ | ((command) & _CLICK_IOC_BASE_MASK)) #else # define CLICK_LLRPC_NTOH(command) (command) # define CLICK_LLRPC_HTON(command) (command) #endif /* sanity checks */ #ifdef __FreeBSD__ # if _CLICK_IOC_VOID != IOC_VOID || _CLICK_IOC_OUT != IOC_OUT || _CLICK_IOC_IN != IOC_IN # error "bad _CLICK_IOC constants" # endif #endif #endif