1 /* 2 * Copyright (c) 2002 - 2003 3 * NetGroup, Politecnico di Torino (Italy) 4 * All rights reserved. 5 * 6 * Redistribution and use in source and binary forms, with or without 7 * modification, are permitted provided that the following conditions 8 * are met: 9 * 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 3. Neither the name of the Politecnico di Torino nor the names of its 16 * contributors may be used to endorse or promote products derived from 17 * this software without specific prior written permission. 18 * 19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 20 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 21 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 22 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 23 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 24 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 25 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 26 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 27 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 28 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 29 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 30 * 31 */ 32 33 #ifndef __SOCKUTILS_H__ 34 #define __SOCKUTILS_H__ 35 36 #if _MSC_VER > 1000 37 #pragma once 38 #endif 39 40 #ifdef _WIN32 41 /* Windows */ 42 /* 43 * Prevents a compiler warning in case this was already defined (to 44 * avoid that windows.h includes winsock.h) 45 */ 46 #ifdef _WINSOCKAPI_ 47 #undef _WINSOCKAPI_ 48 #endif 49 /* Need windef.h for defines used in winsock2.h under MingW32 */ 50 #ifdef __MINGW32__ 51 #include <windef.h> 52 #endif 53 #include <winsock2.h> 54 #include <ws2tcpip.h> 55 #else 56 /* UN*X */ 57 #include <stdio.h> 58 #include <string.h> /* for memset() */ 59 #include <sys/types.h> 60 #include <sys/socket.h> 61 #include <netdb.h> /* DNS lookup */ 62 #include <unistd.h> /* close() */ 63 #include <errno.h> /* errno() */ 64 #include <netinet/in.h> /* for sockaddr_in, in BSD at least */ 65 #include <arpa/inet.h> 66 #include <net/if.h> 67 68 /*! 69 * \brief In Winsock, a socket handle is of type SOCKET; in UN*X, it's 70 * a file descriptor, and therefore a signed integer. 71 * We define SOCKET to be a signed integer on UN*X, so that it can 72 * be used on both platforms. 73 */ 74 #ifndef SOCKET 75 #define SOCKET int 76 #endif 77 78 /*! 79 * \brief In Winsock, the error return if socket() fails is INVALID_SOCKET; 80 * in UN*X, it's -1. 81 * We define INVALID_SOCKET to be -1 on UN*X, so that it can be used on 82 * both platforms. 83 */ 84 #ifndef INVALID_SOCKET 85 #define INVALID_SOCKET -1 86 #endif 87 #endif 88 89 /* 90 * MingW headers include this definition, but only for Windows XP and above. 91 * MSDN states that this function is available for most versions on Windows. 92 */ 93 #if ((defined(__MINGW32__)) && (_WIN32_WINNT < 0x0501)) 94 int WSAAPI getnameinfo(const struct sockaddr*,socklen_t,char*,DWORD, 95 char*,DWORD,int); 96 #endif 97 98 /* 99 * \defgroup SockUtils Cross-platform socket utilities (IPv4-IPv6) 100 */ 101 102 /* 103 * \addtogroup SockUtils 104 * \{ 105 */ 106 107 /* 108 * \defgroup ExportedStruct Exported Structures and Definitions 109 */ 110 111 /* 112 * \addtogroup ExportedStruct 113 * \{ 114 */ 115 116 /* 117 * Some minor differences between UN*X sockets and and Winsock sockets. 118 */ 119 #ifdef _WIN32 120 /* 121 * Winsock doesn't have these UN*X types; they're used in the UN*X 122 * sockets API. 123 * 124 * XXX - do we need to worry about UN*Xes so old that *they* don't 125 * have them, either? 126 */ 127 typedef int socklen_t; 128 #else 129 /*! 130 * \brief In Winsock, the close() call cannot be used on a socket; 131 * closesocket() must be used. 132 * We define closesocket() to be a wrapper around close() on UN*X, 133 * so that it can be used on both platforms. 134 */ 135 #define closesocket(a) close(a) 136 #endif 137 138 /* 139 * \brief DEBUG facility: it prints an error message on the screen (stderr) 140 * 141 * This macro prints the error on the standard error stream (stderr); 142 * if we are working in debug mode (i.e. there is no NDEBUG defined) and we are in 143 * Microsoft Visual C++, the error message will appear on the MSVC console as well. 144 * 145 * When NDEBUG is defined, this macro is empty. 146 * 147 * \param msg: the message you want to print. 148 * 149 * \param expr: 'false' if you want to abort the program, 'true' it you want 150 * to print the message and continue. 151 * 152 * \return No return values. 153 */ 154 #ifdef NDEBUG 155 #define SOCK_ASSERT(msg, expr) ((void)0) 156 #else 157 #include <assert.h> 158 #if (defined(_WIN32) && defined(_MSC_VER)) 159 #include <crtdbg.h> /* for _CrtDbgReport */ 160 /* Use MessageBox(NULL, msg, "warning", MB_OK)' instead of the other calls if you want to debug a Win32 service */ 161 /* Remember to activate the 'allow service to interact with desktop' flag of the service */ 162 #define SOCK_ASSERT(msg, expr) { _CrtDbgReport(_CRT_WARN, NULL, 0, NULL, "%s\n", msg); fprintf(stderr, "%s\n", msg); assert(expr); } 163 #else 164 #define SOCK_ASSERT(msg, expr) { fprintf(stderr, "%s\n", msg); assert(expr); } 165 #endif 166 #endif 167 168 /**************************************************** 169 * * 170 * Exported functions / definitions * 171 * * 172 ****************************************************/ 173 174 /* 'checkonly' flag, into the rpsock_bufferize() */ 175 #define SOCKBUF_CHECKONLY 1 176 /* no 'checkonly' flag, into the rpsock_bufferize() */ 177 #define SOCKBUF_BUFFERIZE 0 178 179 /* no 'server' flag; it opens a client socket */ 180 #define SOCKOPEN_CLIENT 0 181 /* 'server' flag; it opens a server socket */ 182 #define SOCKOPEN_SERVER 1 183 184 /* Changes the behaviour of the sock_recv(); it does not wait to receive all data */ 185 #define SOCK_RECEIVEALL_NO 0 186 /* Changes the behaviour of the sock_recv(); it waits to receive all data */ 187 #define SOCK_RECEIVEALL_YES 1 188 189 /* 190 * \} 191 */ 192 193 #ifdef __cplusplus 194 extern "C" { 195 #endif 196 197 /* 198 * \defgroup ExportedFunc Exported Functions 199 */ 200 201 /* 202 * \addtogroup ExportedFunc 203 * \{ 204 */ 205 206 int sock_init(char *errbuf, int errbuflen); 207 void sock_cleanup(void); 208 /* It is 'public' because there are calls (like accept() ) which are not managed from inside the sockutils files */ 209 void sock_geterror(const char *caller, char *errbuf, int errbufsize); 210 int sock_initaddress(const char *address, const char *port, 211 struct addrinfo *hints, struct addrinfo **addrinfo, 212 char *errbuf, int errbuflen); 213 int sock_recv(SOCKET socket, void *buffer, size_t size, int receiveall, 214 char *errbuf, int errbuflen); 215 SOCKET sock_open(struct addrinfo *addrinfo, int server, int nconn, char *errbuf, int errbuflen); 216 int sock_close(SOCKET sock, char *errbuf, int errbuflen); 217 218 int sock_send(SOCKET socket, const char *buffer, int size, char *errbuf, int errbuflen); 219 int sock_bufferize(const char *buffer, int size, char *tempbuf, int *offset, int totsize, int checkonly, char *errbuf, int errbuflen); 220 int sock_discard(SOCKET socket, int size, char *errbuf, int errbuflen); 221 int sock_check_hostlist(char *hostlist, const char *sep, struct sockaddr_storage *from, char *errbuf, int errbuflen); 222 int sock_cmpaddr(struct sockaddr_storage *first, struct sockaddr_storage *second); 223 224 int sock_getmyinfo(SOCKET sock, char *address, int addrlen, char *port, int portlen, int flags, char *errbuf, int errbuflen); 225 226 int sock_getascii_addrport(const struct sockaddr_storage *sockaddr, char *address, int addrlen, char *port, int portlen, int flags, char *errbuf, int errbuflen); 227 int sock_present2network(const char *address, struct sockaddr_storage *sockaddr, int addr_family, char *errbuf, int errbuflen); 228 229 #ifdef __cplusplus 230 } 231 #endif 232 233 /* 234 * \} 235 */ 236 237 /* 238 * \} 239 */ 240 241 #endif 242