blob: 6c229bcc10e42a8e13a8cb05e406c5e540198a9d [file] [log] [blame]
Guido van Rossum6574b3e1991-06-25 21:36:08 +00001/* Socket module */
2
3/*
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00004
Guido van Rossum6574b3e1991-06-25 21:36:08 +00005This module provides an interface to Berkeley socket IPC.
6
7Limitations:
8
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00009- Only AF_INET, AF_INET6 and AF_UNIX address families are supported in a
Christian Heimes043d6f62008-01-07 17:19:16 +000010 portable manner, though AF_PACKET, AF_NETLINK and AF_TIPC are supported
11 under Linux.
Guido van Rossumc4fcfa32002-06-07 03:19:37 +000012- No read/write operations (use sendall/recv or makefile instead).
13- Additional restrictions apply on some non-Unix platforms (compensated
14 for by socket.py).
Guido van Rossum6574b3e1991-06-25 21:36:08 +000015
Guido van Rossum27e177d1995-03-16 15:43:47 +000016Module interface:
Guido van Rossum6574b3e1991-06-25 21:36:08 +000017
Andrew Svetlov0832af62012-12-18 23:10:48 +020018- socket.error: exception raised for socket specific errors, alias for OSError
Martin v. Löwis2d8d4272001-07-21 18:05:31 +000019- socket.gaierror: exception raised for getaddrinfo/getnameinfo errors,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000020 a subclass of socket.error
Martin v. Löwis2d8d4272001-07-21 18:05:31 +000021- socket.herror: exception raised for gethostby* errors,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000022 a subclass of socket.error
Guido van Rossum30a685f1991-06-27 15:51:29 +000023- socket.gethostbyname(hostname) --> host IP address (string: 'dd.dd.dd.dd')
Guido van Rossum3bbc62e1995-01-02 19:30:30 +000024- socket.gethostbyaddr(IP address) --> (hostname, [alias, ...], [IP addr, ...])
Guido van Rossum27e177d1995-03-16 15:43:47 +000025- socket.gethostname() --> host name (string: 'spam' or 'spam.domain.com')
Guido van Rossum25405c71996-12-19 16:42:52 +000026- socket.getprotobyname(protocolname) --> protocol number
Barry Warsaw11b91a02004-06-28 00:50:43 +000027- socket.getservbyname(servicename[, protocolname]) --> port number
28- socket.getservbyport(portnumber[, protocolname]) --> service name
Guido van Rossum7d0a8262007-05-21 23:13:11 +000029- socket.socket([family[, type [, proto, fileno]]]) --> new socket object
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000030 (fileno specifies a pre-existing socket file descriptor)
Dave Cole331708b2004-08-09 04:51:41 +000031- socket.socketpair([family[, type [, proto]]]) --> (socket, socket)
Guido van Rossum006bf911996-06-12 04:04:55 +000032- socket.ntohs(16 bit value) --> new int object
33- socket.ntohl(32 bit value) --> new int object
34- socket.htons(16 bit value) --> new int object
35- socket.htonl(32 bit value) --> new int object
Martin v. Löwis2d8d4272001-07-21 18:05:31 +000036- socket.getaddrinfo(host, port [, family, socktype, proto, flags])
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000037 --> List of (family, socktype, proto, canonname, sockaddr)
Martin v. Löwis2d8d4272001-07-21 18:05:31 +000038- socket.getnameinfo(sockaddr, flags) --> (host, port)
Guido van Rossum27e177d1995-03-16 15:43:47 +000039- socket.AF_INET, socket.SOCK_STREAM, etc.: constants from <socket.h>
Guido van Rossum47dfa4a2003-04-25 05:48:32 +000040- socket.has_ipv6: boolean value indicating if IPv6 is supported
Guido van Rossum5c9eb211999-08-20 18:21:51 +000041- socket.inet_aton(IP address) -> 32-bit packed IP representation
42- socket.inet_ntoa(packed IP) -> IP address string
Guido van Rossum9d0c8ce2002-07-18 17:08:35 +000043- socket.getdefaulttimeout() -> None | float
44- socket.setdefaulttimeout(None | float)
Gregory P. Smith5ed2e772011-05-15 00:26:45 -070045- socket.if_nameindex() -> list of tuples (if_index, if_name)
46- socket.if_nametoindex(name) -> corresponding interface index
47- socket.if_indextoname(index) -> corresponding interface name
Guido van Rossum6574b3e1991-06-25 21:36:08 +000048- an Internet socket address is a pair (hostname, port)
49 where hostname can be anything recognized by gethostbyname()
50 (including the dd.dd.dd.dd notation) and port is in host byte order
51- where a hostname is returned, the dd.dd.dd.dd notation is used
Guido van Rossum27e177d1995-03-16 15:43:47 +000052- a UNIX domain socket address is a string specifying the pathname
Jeremy Hylton22308652001-02-02 03:23:09 +000053- an AF_PACKET socket address is a tuple containing a string
54 specifying the ethernet interface and an integer specifying
55 the Ethernet protocol number to be received. For example:
Jeremy Hyltondbfb6622001-02-02 19:55:17 +000056 ("eth0",0x1234). Optional 3rd,4th,5th elements in the tuple
Andrew M. Kuchlingb8e17172004-07-10 23:39:35 +000057 specify packet-type and ha-type/addr.
Christian Heimes043d6f62008-01-07 17:19:16 +000058- an AF_TIPC socket address is expressed as
59 (addr_type, v1, v2, v3 [, scope]); where addr_type can be one of:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000060 TIPC_ADDR_NAMESEQ, TIPC_ADDR_NAME, and TIPC_ADDR_ID;
Christian Heimes043d6f62008-01-07 17:19:16 +000061 and scope can be one of:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000062 TIPC_ZONE_SCOPE, TIPC_CLUSTER_SCOPE, and TIPC_NODE_SCOPE.
Christian Heimes043d6f62008-01-07 17:19:16 +000063 The meaning of v1, v2 and v3 depends on the value of addr_type:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000064 if addr_type is TIPC_ADDR_NAME:
65 v1 is the server type
66 v2 is the port identifier
67 v3 is ignored
68 if addr_type is TIPC_ADDR_NAMESEQ:
69 v1 is the server type
70 v2 is the lower port number
71 v3 is the upper port number
72 if addr_type is TIPC_ADDR_ID:
73 v1 is the node
74 v2 is the ref
75 v3 is ignored
Christian Heimes043d6f62008-01-07 17:19:16 +000076
Guido van Rossum6574b3e1991-06-25 21:36:08 +000077
Guido van Rossumc4fcfa32002-06-07 03:19:37 +000078Local naming conventions:
Guido van Rossum6574b3e1991-06-25 21:36:08 +000079
Guido van Rossumc4fcfa32002-06-07 03:19:37 +000080- names starting with sock_ are socket object methods
81- names starting with socket_ are module-level functions
82- names starting with PySocket are exported through socketmodule.h
Guido van Rossum30a685f1991-06-27 15:51:29 +000083
Guido van Rossum6574b3e1991-06-25 21:36:08 +000084*/
85
Thomas Wouters477c8d52006-05-27 19:21:47 +000086#ifdef __APPLE__
87 /*
88 * inet_aton is not available on OSX 10.3, yet we want to use a binary
89 * that was build on 10.4 or later to work on that release, weak linking
90 * comes to the rescue.
91 */
92# pragma weak inet_aton
93#endif
94
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +000095#include "Python.h"
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000096#include "structmember.h"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +000097
Guido van Rossumc4fcfa32002-06-07 03:19:37 +000098/* Socket object documentation */
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +000099PyDoc_STRVAR(sock_doc,
Victor Stinnerdaf45552013-08-28 00:53:59 +0200100"socket(family=AF_INET, type=SOCK_STREAM, proto=0, fileno=None) -> socket object\n\
Guido van Rossumc4fcfa32002-06-07 03:19:37 +0000101\n\
102Open a socket of the given type. The family argument specifies the\n\
103address family; it defaults to AF_INET. The type argument specifies\n\
104whether this is a stream (SOCK_STREAM, this is the default)\n\
105or datagram (SOCK_DGRAM) socket. The protocol argument defaults to 0,\n\
106specifying the default protocol. Keyword arguments are accepted.\n\
Victor Stinnerdaf45552013-08-28 00:53:59 +0200107The socket is created as non-inheritable.\n\
Guido van Rossumc4fcfa32002-06-07 03:19:37 +0000108\n\
109A socket object represents one endpoint of a network connection.\n\
110\n\
111Methods of socket objects (keyword arguments not allowed):\n\
112\n\
Guido van Rossum39eb8fa2007-11-16 01:24:05 +0000113_accept() -- accept connection, returning new socket fd and client address\n\
Guido van Rossumc4fcfa32002-06-07 03:19:37 +0000114bind(addr) -- bind the socket to a local address\n\
115close() -- close the socket\n\
116connect(addr) -- connect the socket to a remote address\n\
117connect_ex(addr) -- connect, return an error code instead of an exception\n\
Victor Stinnerdaf45552013-08-28 00:53:59 +0200118dup() -- return a new socket fd duplicated from fileno()\n\
Guido van Rossumc4fcfa32002-06-07 03:19:37 +0000119fileno() -- return underlying file descriptor\n\
120getpeername() -- return remote address [*]\n\
121getsockname() -- return local address\n\
122getsockopt(level, optname[, buflen]) -- get socket options\n\
123gettimeout() -- return timeout or None\n\
124listen(n) -- start listening for incoming connections\n\
Guido van Rossumc4fcfa32002-06-07 03:19:37 +0000125recv(buflen[, flags]) -- receive data\n\
Thomas Wouters73e5a5b2006-06-08 15:35:45 +0000126recv_into(buffer[, nbytes[, flags]]) -- receive data (into a buffer)\n\
Thomas Wouters477c8d52006-05-27 19:21:47 +0000127recvfrom(buflen[, flags]) -- receive data and sender\'s address\n\
Thomas Wouters73e5a5b2006-06-08 15:35:45 +0000128recvfrom_into(buffer[, nbytes, [, flags])\n\
Thomas Wouters477c8d52006-05-27 19:21:47 +0000129 -- receive data and sender\'s address (into a buffer)\n\
Guido van Rossumc4fcfa32002-06-07 03:19:37 +0000130sendall(data[, flags]) -- send all data\n\
131send(data[, flags]) -- send data, may not send all of it\n\
132sendto(data[, flags], addr) -- send data to a given address\n\
133setblocking(0 | 1) -- set or clear the blocking I/O flag\n\
134setsockopt(level, optname, value) -- set socket options\n\
135settimeout(None | float) -- set or clear the timeout\n\
136shutdown(how) -- shut down traffic in one or both directions\n\
Gregory P. Smith5ed2e772011-05-15 00:26:45 -0700137if_nameindex() -- return all network interface indices and names\n\
Gregory P. Smithb6471db2011-05-22 22:47:55 -0700138if_nametoindex(name) -- return the corresponding interface index\n\
139if_indextoname(index) -- return the corresponding interface name\n\
Guido van Rossumc4fcfa32002-06-07 03:19:37 +0000140\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000141 [*] not available on all platforms!");
Guido van Rossum3baaa131999-03-22 21:44:51 +0000142
Walter Dörwaldf0dfc7a2003-10-20 14:01:56 +0000143/* XXX This is a terrible mess of platform-dependent preprocessor hacks.
Guido van Rossum384ca9c2001-10-27 22:20:47 +0000144 I hope some day someone can clean this up please... */
145
Guido van Rossum9376b741999-09-15 22:01:40 +0000146/* Hacks for gethostbyname_r(). On some non-Linux platforms, the configure
147 script doesn't get this right, so we hardcode some platform checks below.
148 On the other hand, not all Linux versions agree, so there the settings
149 computed by the configure script are needed! */
150
151#ifndef linux
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000152# undef HAVE_GETHOSTBYNAME_R_3_ARG
153# undef HAVE_GETHOSTBYNAME_R_5_ARG
154# undef HAVE_GETHOSTBYNAME_R_6_ARG
Guido van Rossum9376b741999-09-15 22:01:40 +0000155#endif
Guido van Rossume7de2061999-03-24 17:24:33 +0000156
Victor Stinner710d27e2011-08-23 10:57:32 +0200157#if defined(__OpenBSD__)
158# include <sys/uio.h>
159#endif
160
Guido van Rossum7a122991999-04-13 04:07:32 +0000161#ifndef WITH_THREAD
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000162# undef HAVE_GETHOSTBYNAME_R
Guido van Rossum7a122991999-04-13 04:07:32 +0000163#endif
164
Guido van Rossume7de2061999-03-24 17:24:33 +0000165#ifdef HAVE_GETHOSTBYNAME_R
Jesus Cea736e7fc2011-03-14 17:36:54 +0100166# if defined(_AIX)
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000167# define HAVE_GETHOSTBYNAME_R_3_ARG
168# elif defined(__sun) || defined(__sgi)
169# define HAVE_GETHOSTBYNAME_R_5_ARG
170# elif defined(linux)
Guido van Rossum9376b741999-09-15 22:01:40 +0000171/* Rely on the configure script */
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000172# else
173# undef HAVE_GETHOSTBYNAME_R
174# endif
Guido van Rossume7de2061999-03-24 17:24:33 +0000175#endif
176
Guido van Rossum3eede5a2002-06-07 02:08:35 +0000177#if !defined(HAVE_GETHOSTBYNAME_R) && defined(WITH_THREAD) && \
178 !defined(MS_WINDOWS)
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000179# define USE_GETHOSTBYNAME_LOCK
Guido van Rossum3baaa131999-03-22 21:44:51 +0000180#endif
181
Hye-Shik Chang9ceebd52005-09-24 14:58:47 +0000182/* To use __FreeBSD_version */
183#ifdef HAVE_SYS_PARAM_H
184#include <sys/param.h>
185#endif
Just van Rossum1040d2c2003-05-09 07:53:18 +0000186/* On systems on which getaddrinfo() is believed to not be thread-safe,
Just van Rossum09aecd72003-05-09 08:03:44 +0000187 (this includes the getaddrinfo emulation) protect access with a lock. */
Hye-Shik Chang9ceebd52005-09-24 14:58:47 +0000188#if defined(WITH_THREAD) && (defined(__APPLE__) || \
189 (defined(__FreeBSD__) && __FreeBSD_version+0 < 503000) || \
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000190 defined(__OpenBSD__) || defined(__NetBSD__) || \
Christian Heimesaf01f662013-12-21 16:19:10 +0100191 !defined(HAVE_GETADDRINFO))
Just van Rossum1040d2c2003-05-09 07:53:18 +0000192#define USE_GETADDRINFO_LOCK
193#endif
194
195#ifdef USE_GETADDRINFO_LOCK
196#define ACQUIRE_GETADDRINFO_LOCK PyThread_acquire_lock(netdb_lock, 1);
197#define RELEASE_GETADDRINFO_LOCK PyThread_release_lock(netdb_lock);
198#else
199#define ACQUIRE_GETADDRINFO_LOCK
200#define RELEASE_GETADDRINFO_LOCK
201#endif
202
203#if defined(USE_GETHOSTBYNAME_LOCK) || defined(USE_GETADDRINFO_LOCK)
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000204# include "pythread.h"
Guido van Rossum4f199ea1998-04-09 20:56:35 +0000205#endif
Guido van Rossum6574b3e1991-06-25 21:36:08 +0000206
Guido van Rossum8e9ebfd1997-11-22 21:53:48 +0000207#if defined(PYCC_VACPP)
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000208# include <types.h>
209# include <io.h>
210# include <sys/ioctl.h>
211# include <utils.h>
212# include <ctype.h>
Guido van Rossum8e9ebfd1997-11-22 21:53:48 +0000213#endif
214
Martin v. Löwis9d6c6692012-02-03 17:44:58 +0100215#ifdef __APPLE__
216# include <sys/ioctl.h>
217#endif
218
219
Jeremy Hyltonfb509a32003-07-17 16:58:48 +0000220#if defined(__sgi) && _COMPILER_VERSION>700 && !_SGIAPI
Martin v. Löwis8eb92a02002-09-19 08:03:21 +0000221/* make sure that the reentrant (gethostbyaddr_r etc)
222 functions are declared correctly if compiling with
223 MIPSPro 7.x in ANSI C mode (default) */
Jeremy Hyltonfb509a32003-07-17 16:58:48 +0000224
Thomas Wouters477c8d52006-05-27 19:21:47 +0000225/* XXX Using _SGIAPI is the wrong thing,
Jeremy Hyltonfb509a32003-07-17 16:58:48 +0000226 but I don't know what the right thing is. */
Trent Mick8ea5bdf2004-09-13 17:48:41 +0000227#undef _SGIAPI /* to avoid warning */
Martin v. Löwis8eb92a02002-09-19 08:03:21 +0000228#define _SGIAPI 1
Jeremy Hyltonfb509a32003-07-17 16:58:48 +0000229
Trent Mick8ea5bdf2004-09-13 17:48:41 +0000230#undef _XOPEN_SOURCE
231#include <sys/socket.h>
232#include <sys/types.h>
233#include <netinet/in.h>
234#ifdef _SS_ALIGNSIZE
235#define HAVE_GETADDRINFO 1
236#define HAVE_GETNAMEINFO 1
237#endif
238
Jeremy Hyltonfb509a32003-07-17 16:58:48 +0000239#define HAVE_INET_PTON
240#include <netdb.h>
Martin v. Löwis8eb92a02002-09-19 08:03:21 +0000241#endif
242
Thomas Wouters477c8d52006-05-27 19:21:47 +0000243/* Irix 6.5 fails to define this variable at all. This is needed
244 for both GCC and SGI's compiler. I'd say that the SGI headers
Georg Brandldbd83392006-02-20 09:42:33 +0000245 are just busted. Same thing for Solaris. */
246#if (defined(__sgi) || defined(sun)) && !defined(INET_ADDRSTRLEN)
Anthony Baxterbab23cf2003-10-04 08:00:49 +0000247#define INET_ADDRSTRLEN 16
248#endif
249
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000250/* Generic includes */
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000251#ifdef HAVE_SYS_TYPES_H
Guido van Rossumb6775db1994-08-01 11:34:53 +0000252#include <sys/types.h>
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000253#endif
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000254
Gregory P. Smith3b1f2c32011-05-15 12:18:23 -0700255#ifdef HAVE_SYS_SOCKET_H
256#include <sys/socket.h>
257#endif
258
259#ifdef HAVE_NET_IF_H
260#include <net/if.h>
261#endif
262
Marc-André Lemburg976ade62002-02-16 18:47:07 +0000263/* Generic socket object definitions and includes */
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000264#define PySocket_BUILDING_SOCKET
Marc-André Lemburgbb8b78b2002-02-16 18:44:52 +0000265#include "socketmodule.h"
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000266
267/* Addressing includes */
268
Guido van Rossum6f489d91996-06-28 20:15:15 +0000269#ifndef MS_WINDOWS
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000270
271/* Non-MS WINDOWS includes */
272# include <netdb.h>
Nick Coghlan4ecf6cf2011-08-22 15:45:19 +1000273# include <unistd.h>
Guido van Rossum5c9eb211999-08-20 18:21:51 +0000274
Guido van Rossum9376b741999-09-15 22:01:40 +0000275/* Headers needed for inet_ntoa() and inet_addr() */
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000276# include <arpa/inet.h>
Guido van Rossum5c9eb211999-08-20 18:21:51 +0000277
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000278# include <fcntl.h>
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000279
Guido van Rossume2ae77b2001-10-24 20:42:55 +0000280#else
Guido van Rossum48a680c2001-03-02 06:34:14 +0000281
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000282/* MS_WINDOWS includes */
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000283# ifdef HAVE_FCNTL_H
284# include <fcntl.h>
285# endif
Guido van Rossum48a680c2001-03-02 06:34:14 +0000286
Jeremy Hylton22308652001-02-02 03:23:09 +0000287#endif
288
Skip Montanaro7befb992004-02-10 16:50:21 +0000289#include <stddef.h>
Martin v. Löwisa45ecae2001-06-24 21:28:42 +0000290
291#ifndef offsetof
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000292# define offsetof(type, member) ((size_t)(&((type *)0)->member))
Martin v. Löwisa45ecae2001-06-24 21:28:42 +0000293#endif
294
Neal Norwitz39d22e52002-11-02 19:55:21 +0000295#ifndef O_NONBLOCK
296# define O_NONBLOCK O_NDELAY
Guido van Rossum3bbc62e1995-01-02 19:30:30 +0000297#endif
298
Trent Micka708d6e2004-09-07 17:48:26 +0000299/* include Python's addrinfo.h unless it causes trouble */
300#if defined(__sgi) && _COMPILER_VERSION>700 && defined(_SS_ALIGNSIZE)
301 /* Do not include addinfo.h on some newer IRIX versions.
302 * _SS_ALIGNSIZE is defined in sys/socket.h by 6.5.21,
303 * for example, but not by 6.5.10.
304 */
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000305#elif defined(_MSC_VER) && _MSC_VER>1201
Trent Micka708d6e2004-09-07 17:48:26 +0000306 /* Do not include addrinfo.h for MSVC7 or greater. 'addrinfo' and
307 * EAI_* constants are defined in (the already included) ws2tcpip.h.
308 */
309#else
310# include "addrinfo.h"
311#endif
Jason Tishlerc246cb72004-08-09 13:25:59 +0000312
Martin v. Löwisb9ab1592001-06-24 21:18:26 +0000313#ifndef HAVE_INET_PTON
Christian Heimes96e7b3d2007-11-20 06:51:17 +0000314#if !defined(NTDDI_VERSION) || (NTDDI_VERSION < NTDDI_LONGHORN)
Guido van Rossum3eede5a2002-06-07 02:08:35 +0000315int inet_pton(int af, const char *src, void *dst);
Martin v. Löwisc925b1532001-07-21 09:42:15 +0000316const char *inet_ntop(int af, const void *src, char *dst, socklen_t size);
Martin v. Löwisb9ab1592001-06-24 21:18:26 +0000317#endif
Christian Heimesb6150692007-11-15 23:37:07 +0000318#endif
Martin v. Löwisb9ab1592001-06-24 21:18:26 +0000319
Martin v. Löwisae26dc22001-08-03 10:02:29 +0000320#ifdef __APPLE__
321/* On OS X, getaddrinfo returns no error indication of lookup
322 failure, so we must use the emulation instead of the libinfo
323 implementation. Unfortunately, performing an autoconf test
324 for this bug would require DNS access for the machine performing
325 the configuration, which is not acceptable. Therefore, we
326 determine the bug just by checking for __APPLE__. If this bug
327 gets ever fixed, perhaps checking for sys/version.h would be
328 appropriate, which is 10/0 on the system with the bug. */
Jack Jansen84262fb2002-07-02 14:40:42 +0000329#ifndef HAVE_GETNAMEINFO
330/* This bug seems to be fixed in Jaguar. Ths easiest way I could
331 Find to check for Jaguar is that it has getnameinfo(), which
332 older releases don't have */
Martin v. Löwisae26dc22001-08-03 10:02:29 +0000333#undef HAVE_GETADDRINFO
Martin v. Löwisae26dc22001-08-03 10:02:29 +0000334#endif
Thomas Wouters477c8d52006-05-27 19:21:47 +0000335
336#ifdef HAVE_INET_ATON
337#define USE_INET_ATON_WEAKLINK
338#endif
339
Jack Jansen84262fb2002-07-02 14:40:42 +0000340#endif
Martin v. Löwisae26dc22001-08-03 10:02:29 +0000341
Martin v. Löwis01dfdb32001-06-23 16:30:13 +0000342/* I know this is a bad practice, but it is the easiest... */
Martin v. Löwisae26dc22001-08-03 10:02:29 +0000343#if !defined(HAVE_GETADDRINFO)
Martin v. Löwisfccac2e2003-05-01 05:20:46 +0000344/* avoid clashes with the C library definition of the symbol. */
345#define getaddrinfo fake_getaddrinfo
346#define gai_strerror fake_gai_strerror
347#define freeaddrinfo fake_freeaddrinfo
Martin v. Löwis01dfdb32001-06-23 16:30:13 +0000348#include "getaddrinfo.c"
349#endif
Martin v. Löwisae26dc22001-08-03 10:02:29 +0000350#if !defined(HAVE_GETNAMEINFO)
Martin v. Löwisfccac2e2003-05-01 05:20:46 +0000351#define getnameinfo fake_getnameinfo
Martin v. Löwis01dfdb32001-06-23 16:30:13 +0000352#include "getnameinfo.c"
353#endif
354
Guido van Rossum39eb8fa2007-11-16 01:24:05 +0000355#ifdef MS_WINDOWS
Guido van Rossum2dd8ddd2000-04-21 20:33:00 +0000356#define SOCKETCLOSE closesocket
Guido van Rossum6a3eb5f1994-08-18 15:42:46 +0000357#endif
358
Martin v. Löwis2d8d4272001-07-21 18:05:31 +0000359#ifdef MS_WIN32
Kristján Valur Jónsson310052c2012-03-31 13:35:00 +0000360#undef EAFNOSUPPORT
Guido van Rossum3eede5a2002-06-07 02:08:35 +0000361#define EAFNOSUPPORT WSAEAFNOSUPPORT
362#define snprintf _snprintf
Martin v. Löwis2d8d4272001-07-21 18:05:31 +0000363#endif
Fred Drakea04eaad2000-06-30 02:46:07 +0000364
Guido van Rossum2dd8ddd2000-04-21 20:33:00 +0000365#ifndef SOCKETCLOSE
366#define SOCKETCLOSE close
367#endif
368
Gregory P. Smith3e85dfd2010-10-17 00:43:10 +0000369#if (defined(HAVE_BLUETOOTH_H) || defined(HAVE_BLUETOOTH_BLUETOOTH_H)) && !defined(__NetBSD__) && !defined(__DragonFly__)
Hye-Shik Chang81268602004-02-02 06:05:24 +0000370#define USE_BLUETOOTH 1
371#if defined(__FreeBSD__)
372#define BTPROTO_L2CAP BLUETOOTH_PROTO_L2CAP
373#define BTPROTO_RFCOMM BLUETOOTH_PROTO_RFCOMM
Thomas Wouterscf297e42007-02-23 15:07:44 +0000374#define BTPROTO_HCI BLUETOOTH_PROTO_HCI
Guido van Rossumcd16bf62007-06-13 18:07:49 +0000375#define SOL_HCI SOL_HCI_RAW
376#define HCI_FILTER SO_HCI_RAW_FILTER
Hye-Shik Chang81268602004-02-02 06:05:24 +0000377#define sockaddr_l2 sockaddr_l2cap
378#define sockaddr_rc sockaddr_rfcomm
Guido van Rossumcd16bf62007-06-13 18:07:49 +0000379#define hci_dev hci_node
Hye-Shik Chang81268602004-02-02 06:05:24 +0000380#define _BT_L2_MEMB(sa, memb) ((sa)->l2cap_##memb)
381#define _BT_RC_MEMB(sa, memb) ((sa)->rfcomm_##memb)
Thomas Wouterscf297e42007-02-23 15:07:44 +0000382#define _BT_HCI_MEMB(sa, memb) ((sa)->hci_##memb)
Gregory P. Smith3e85dfd2010-10-17 00:43:10 +0000383#elif defined(__NetBSD__) || defined(__DragonFly__)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000384#define sockaddr_l2 sockaddr_bt
385#define sockaddr_rc sockaddr_bt
Thomas Wouterscf297e42007-02-23 15:07:44 +0000386#define sockaddr_hci sockaddr_bt
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000387#define sockaddr_sco sockaddr_bt
Gregory P. Smith3e85dfd2010-10-17 00:43:10 +0000388#define SOL_HCI BTPROTO_HCI
389#define HCI_DATA_DIR SO_HCI_DIRECTION
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000390#define _BT_L2_MEMB(sa, memb) ((sa)->bt_##memb)
391#define _BT_RC_MEMB(sa, memb) ((sa)->bt_##memb)
Thomas Wouterscf297e42007-02-23 15:07:44 +0000392#define _BT_HCI_MEMB(sa, memb) ((sa)->bt_##memb)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000393#define _BT_SCO_MEMB(sa, memb) ((sa)->bt_##memb)
Hye-Shik Chang81268602004-02-02 06:05:24 +0000394#else
Hye-Shik Chang81268602004-02-02 06:05:24 +0000395#define _BT_L2_MEMB(sa, memb) ((sa)->l2_##memb)
396#define _BT_RC_MEMB(sa, memb) ((sa)->rc_##memb)
Thomas Wouterscf297e42007-02-23 15:07:44 +0000397#define _BT_HCI_MEMB(sa, memb) ((sa)->hci_##memb)
Hye-Shik Chang81268602004-02-02 06:05:24 +0000398#define _BT_SCO_MEMB(sa, memb) ((sa)->sco_##memb)
399#endif
400#endif
401
Charles-François Natali8b759652011-12-23 16:44:51 +0100402/* Convert "sock_addr_t *" to "struct sockaddr *". */
403#define SAS2SA(x) (&((x)->sa))
Thomas Wouters89f507f2006-12-13 04:49:30 +0000404
Martin v. Löwise9416172003-05-03 10:12:45 +0000405/*
406 * Constants for getnameinfo()
407 */
408#if !defined(NI_MAXHOST)
409#define NI_MAXHOST 1025
410#endif
411#if !defined(NI_MAXSERV)
412#define NI_MAXSERV 32
413#endif
414
Guido van Rossum7d0a8262007-05-21 23:13:11 +0000415#ifndef INVALID_SOCKET /* MS defines this */
416#define INVALID_SOCKET (-1)
417#endif
418
Charles-François Natali0cc86852013-09-13 19:53:08 +0200419#ifndef INADDR_NONE
420#define INADDR_NONE (-1)
421#endif
422
Guido van Rossum384ca9c2001-10-27 22:20:47 +0000423/* XXX There's a problem here: *static* functions are not supposed to have
424 a Py prefix (or use CapitalizedWords). Later... */
425
Guido van Rossum30a685f1991-06-27 15:51:29 +0000426/* Global variable holding the exception type for errors detected
427 by this module (but not argument type or memory errors, etc.). */
Guido van Rossumc4fcfa32002-06-07 03:19:37 +0000428static PyObject *socket_herror;
429static PyObject *socket_gaierror;
Raymond Hettingeref7343c2003-06-29 03:08:05 +0000430static PyObject *socket_timeout;
Guido van Rossum30a685f1991-06-27 15:51:29 +0000431
Tim Peters643a7fc2002-02-17 04:13:21 +0000432/* A forward reference to the socket type object.
Guido van Rossumc4fcfa32002-06-07 03:19:37 +0000433 The sock_type variable contains pointers to various functions,
434 some of which call new_sockobject(), which uses sock_type, so
Tim Peters643a7fc2002-02-17 04:13:21 +0000435 there has to be a circular reference. */
Jeremy Hylton938ace62002-07-17 16:30:39 +0000436static PyTypeObject sock_type;
Guido van Rossum48a680c2001-03-02 06:34:14 +0000437
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000438#if defined(HAVE_POLL_H)
439#include <poll.h>
440#elif defined(HAVE_SYS_POLL_H)
441#include <sys/poll.h>
442#endif
443
Nick Coghlan96fe56a2011-08-22 11:55:57 +1000444/* Largest value to try to store in a socklen_t (used when handling
445 ancillary data). POSIX requires socklen_t to hold at least
446 (2**31)-1 and recommends against storing larger values, but
447 socklen_t was originally int in the BSD interface, so to be on the
448 safe side we use the smaller of (2**31)-1 and INT_MAX. */
449#if INT_MAX > 0x7fffffff
450#define SOCKLEN_T_LIMIT 0x7fffffff
451#else
452#define SOCKLEN_T_LIMIT INT_MAX
453#endif
454
Charles-François Nataliaa26b272011-08-28 17:51:43 +0200455#ifdef HAVE_POLL
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000456/* Instead of select(), we'll use poll() since poll() works on any fd. */
457#define IS_SELECTABLE(s) 1
458/* Can we call select() with this socket without a buffer overrun? */
Martin v. Löwisf84d1b92006-02-11 09:27:05 +0000459#else
Charles-François Nataliaa26b272011-08-28 17:51:43 +0200460/* If there's no timeout left, we don't have to call select, so it's a safe,
461 * little white lie. */
462#define IS_SELECTABLE(s) (_PyIsSelectable_fd((s)->sock_fd) || (s)->sock_timeout <= 0.0)
Martin v. Löwisf84d1b92006-02-11 09:27:05 +0000463#endif
Neal Norwitz082b2df2006-02-07 07:04:46 +0000464
465static PyObject*
466select_error(void)
467{
Antoine Pitrou6b4883d2011-10-12 02:54:14 +0200468 PyErr_SetString(PyExc_OSError, "unable to select on socket");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000469 return NULL;
Neal Norwitz082b2df2006-02-07 07:04:46 +0000470}
471
Antoine Pitrou3e1fd272010-09-28 21:23:11 +0000472#ifdef MS_WINDOWS
Antoine Pitrouc8f01962010-09-28 22:03:27 +0000473#ifndef WSAEAGAIN
474#define WSAEAGAIN WSAEWOULDBLOCK
475#endif
Antoine Pitrou3e1fd272010-09-28 21:23:11 +0000476#define CHECK_ERRNO(expected) \
477 (WSAGetLastError() == WSA ## expected)
478#else
479#define CHECK_ERRNO(expected) \
480 (errno == expected)
481#endif
482
Victor Stinnerdaf45552013-08-28 00:53:59 +0200483#ifdef MS_WINDOWS
484/* Does WSASocket() support the WSA_FLAG_NO_HANDLE_INHERIT flag? */
485static int support_wsa_no_inherit = -1;
486#endif
487
Guido van Rossum30a685f1991-06-27 15:51:29 +0000488/* Convenience function to raise an error according to errno
489 and return a NULL pointer from a function. */
Guido van Rossum6574b3e1991-06-25 21:36:08 +0000490
Guido van Rossum73624e91994-10-10 17:59:00 +0000491static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +0000492set_error(void)
Guido van Rossum6574b3e1991-06-25 21:36:08 +0000493{
Guido van Rossum8d665e61996-06-26 18:22:49 +0000494#ifdef MS_WINDOWS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000495 int err_no = WSAGetLastError();
496 /* PyErr_SetExcFromWindowsErr() invokes FormatMessage() which
497 recognizes the error codes used by both GetLastError() and
498 WSAGetLastError */
499 if (err_no)
Antoine Pitrou6b4883d2011-10-12 02:54:14 +0200500 return PyErr_SetExcFromWindowsErr(PyExc_OSError, err_no);
Guido van Rossum14ed0b21994-09-29 09:50:09 +0000501#endif
Guido van Rossum8e9ebfd1997-11-22 21:53:48 +0000502
Antoine Pitrou6b4883d2011-10-12 02:54:14 +0200503 return PyErr_SetFromErrno(PyExc_OSError);
Guido van Rossum6574b3e1991-06-25 21:36:08 +0000504}
505
Guido van Rossum30a685f1991-06-27 15:51:29 +0000506
Martin v. Löwis2d8d4272001-07-21 18:05:31 +0000507static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +0000508set_herror(int h_error)
Martin v. Löwis2d8d4272001-07-21 18:05:31 +0000509{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000510 PyObject *v;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +0000511
512#ifdef HAVE_HSTRERROR
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000513 v = Py_BuildValue("(is)", h_error, (char *)hstrerror(h_error));
Martin v. Löwis2d8d4272001-07-21 18:05:31 +0000514#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000515 v = Py_BuildValue("(is)", h_error, "host not found");
Martin v. Löwis2d8d4272001-07-21 18:05:31 +0000516#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000517 if (v != NULL) {
518 PyErr_SetObject(socket_herror, v);
519 Py_DECREF(v);
520 }
Martin v. Löwis2d8d4272001-07-21 18:05:31 +0000521
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000522 return NULL;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +0000523}
524
525
526static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +0000527set_gaierror(int error)
Martin v. Löwis2d8d4272001-07-21 18:05:31 +0000528{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000529 PyObject *v;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +0000530
Martin v. Löwis272cb402002-03-01 08:31:07 +0000531#ifdef EAI_SYSTEM
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000532 /* EAI_SYSTEM is not available on Windows XP. */
533 if (error == EAI_SYSTEM)
534 return set_error();
Martin v. Löwis272cb402002-03-01 08:31:07 +0000535#endif
Martin v. Löwis2d8d4272001-07-21 18:05:31 +0000536
Martin v. Löwisf95dd0a2001-08-15 17:14:33 +0000537#ifdef HAVE_GAI_STRERROR
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000538 v = Py_BuildValue("(is)", error, gai_strerror(error));
Martin v. Löwisf95dd0a2001-08-15 17:14:33 +0000539#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000540 v = Py_BuildValue("(is)", error, "getaddrinfo failed");
Martin v. Löwisf95dd0a2001-08-15 17:14:33 +0000541#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000542 if (v != NULL) {
543 PyErr_SetObject(socket_gaierror, v);
544 Py_DECREF(v);
545 }
Martin v. Löwis2d8d4272001-07-21 18:05:31 +0000546
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000547 return NULL;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +0000548}
549
Guido van Rossum3eede5a2002-06-07 02:08:35 +0000550/* Function to perform the setting of socket blocking mode
551 internally. block = (1 | 0). */
Guido van Rossum67f7a382002-06-06 21:08:16 +0000552static int
553internal_setblocking(PySocketSockObject *s, int block)
554{
Victor Stinner9a954832013-12-04 00:41:24 +0100555#if !defined(MS_WINDOWS) \
Christian Heimesaf01f662013-12-21 16:19:10 +0100556 && !((defined(HAVE_SYS_IOCTL_H) && defined(FIONBIO)))
Victor Stinner9a954832013-12-04 00:41:24 +0100557 int delay_flag, new_delay_flag;
Guido van Rossum67f7a382002-06-06 21:08:16 +0000558#endif
Antoine Pitroub1c54962010-10-14 15:05:38 +0000559#ifdef SOCK_NONBLOCK
560 if (block)
561 s->sock_type &= (~SOCK_NONBLOCK);
562 else
563 s->sock_type |= SOCK_NONBLOCK;
564#endif
Guido van Rossum67f7a382002-06-06 21:08:16 +0000565
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000566 Py_BEGIN_ALLOW_THREADS
Guido van Rossum67f7a382002-06-06 21:08:16 +0000567#ifndef MS_WINDOWS
Christian Heimesaf01f662013-12-21 16:19:10 +0100568#if (defined(HAVE_SYS_IOCTL_H) && defined(FIONBIO))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000569 block = !block;
570 ioctl(s->sock_fd, FIONBIO, (unsigned int *)&block);
Victor Stinner9a954832013-12-04 00:41:24 +0100571#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000572 delay_flag = fcntl(s->sock_fd, F_GETFL, 0);
573 if (block)
Victor Stinner9a954832013-12-04 00:41:24 +0100574 new_delay_flag = delay_flag & (~O_NONBLOCK);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000575 else
Victor Stinner9a954832013-12-04 00:41:24 +0100576 new_delay_flag = delay_flag | O_NONBLOCK;
577 if (new_delay_flag != delay_flag)
578 fcntl(s->sock_fd, F_SETFL, new_delay_flag);
579#endif
Guido van Rossum67f7a382002-06-06 21:08:16 +0000580#else /* MS_WINDOWS */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000581 block = !block;
582 ioctlsocket(s->sock_fd, FIONBIO, (u_long*)&block);
Guido van Rossum67f7a382002-06-06 21:08:16 +0000583#endif /* MS_WINDOWS */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000584 Py_END_ALLOW_THREADS
Guido van Rossum67f7a382002-06-06 21:08:16 +0000585
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000586 /* Since these don't return anything */
587 return 1;
Guido van Rossum67f7a382002-06-06 21:08:16 +0000588}
589
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000590/* Do a select()/poll() on the socket, if necessary (sock_timeout > 0).
Guido van Rossum11ba0942002-06-13 15:07:44 +0000591 The argument writing indicates the direction.
Raymond Hettingeref7343c2003-06-29 03:08:05 +0000592 This does not raise an exception; we'll let our caller do that
593 after they've reacquired the interpreter lock.
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000594 Returns 1 on timeout, -1 on error, 0 otherwise. */
Raymond Hettingeref7343c2003-06-29 03:08:05 +0000595static int
Antoine Pitrou3e1fd272010-09-28 21:23:11 +0000596internal_select_ex(PySocketSockObject *s, int writing, double interval)
Guido van Rossum67f7a382002-06-06 21:08:16 +0000597{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000598 int n;
Guido van Rossum11ba0942002-06-13 15:07:44 +0000599
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000600 /* Nothing to do unless we're in timeout mode (not non-blocking) */
601 if (s->sock_timeout <= 0.0)
602 return 0;
Guido van Rossum67f7a382002-06-06 21:08:16 +0000603
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000604 /* Guard against closed socket */
605 if (s->sock_fd < 0)
606 return 0;
Guido van Rossumad654902002-07-19 12:44:59 +0000607
Antoine Pitrou3e1fd272010-09-28 21:23:11 +0000608 /* Handling this condition here simplifies the select loops */
609 if (interval < 0.0)
610 return 1;
611
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000612 /* Prefer poll, if available, since you can poll() any fd
613 * which can't be done with select(). */
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000614#ifdef HAVE_POLL
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000615 {
616 struct pollfd pollfd;
617 int timeout;
Guido van Rossum67f7a382002-06-06 21:08:16 +0000618
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000619 pollfd.fd = s->sock_fd;
620 pollfd.events = writing ? POLLOUT : POLLIN;
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000621
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000622 /* s->sock_timeout is in seconds, timeout in ms */
Antoine Pitrou3e1fd272010-09-28 21:23:11 +0000623 timeout = (int)(interval * 1000 + 0.5);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000624 n = poll(&pollfd, 1, timeout);
625 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000626#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000627 {
628 /* Construct the arguments to select */
629 fd_set fds;
630 struct timeval tv;
Antoine Pitrou3e1fd272010-09-28 21:23:11 +0000631 tv.tv_sec = (int)interval;
632 tv.tv_usec = (int)((interval - tv.tv_sec) * 1e6);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000633 FD_ZERO(&fds);
634 FD_SET(s->sock_fd, &fds);
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000635
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000636 /* See if the socket is ready */
637 if (writing)
Antoine Pitrou19467d22010-08-17 19:33:30 +0000638 n = select(Py_SAFE_DOWNCAST(s->sock_fd+1, SOCKET_T, int),
639 NULL, &fds, NULL, &tv);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000640 else
Antoine Pitrou19467d22010-08-17 19:33:30 +0000641 n = select(Py_SAFE_DOWNCAST(s->sock_fd+1, SOCKET_T, int),
642 &fds, NULL, NULL, &tv);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000643 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000644#endif
Guido van Rossum39eb8fa2007-11-16 01:24:05 +0000645
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000646 if (n < 0)
647 return -1;
648 if (n == 0)
649 return 1;
650 return 0;
Guido van Rossum67f7a382002-06-06 21:08:16 +0000651}
652
Antoine Pitrou3e1fd272010-09-28 21:23:11 +0000653static int
654internal_select(PySocketSockObject *s, int writing)
655{
656 return internal_select_ex(s, writing, s->sock_timeout);
657}
658
659/*
660 Two macros for automatic retry of select() in case of false positives
661 (for example, select() could indicate a socket is ready for reading
662 but the data then discarded by the OS because of a wrong checksum).
663 Here is an example of use:
664
665 BEGIN_SELECT_LOOP(s)
666 Py_BEGIN_ALLOW_THREADS
667 timeout = internal_select_ex(s, 0, interval);
668 if (!timeout)
669 outlen = recv(s->sock_fd, cbuf, len, flags);
670 Py_END_ALLOW_THREADS
671 if (timeout == 1) {
672 PyErr_SetString(socket_timeout, "timed out");
673 return -1;
674 }
675 END_SELECT_LOOP(s)
676*/
677
678#define BEGIN_SELECT_LOOP(s) \
679 { \
680 _PyTime_timeval now, deadline = {0, 0}; \
681 double interval = s->sock_timeout; \
682 int has_timeout = s->sock_timeout > 0.0; \
683 if (has_timeout) { \
684 _PyTime_gettimeofday(&now); \
685 deadline = now; \
686 _PyTime_ADD_SECONDS(deadline, s->sock_timeout); \
687 } \
688 while (1) { \
689 errno = 0; \
690
691#define END_SELECT_LOOP(s) \
692 if (!has_timeout || \
693 (!CHECK_ERRNO(EWOULDBLOCK) && !CHECK_ERRNO(EAGAIN))) \
694 break; \
695 _PyTime_gettimeofday(&now); \
696 interval = _PyTime_INTERVAL(now, deadline); \
697 } \
698 } \
699
Guido van Rossum384ca9c2001-10-27 22:20:47 +0000700/* Initialize a new socket object. */
701
Tim Petersa12b4cf2002-07-18 22:38:44 +0000702static double defaulttimeout = -1.0; /* Default timeout for new sockets */
Guido van Rossum9d0c8ce2002-07-18 17:08:35 +0000703
Martin v. Löwis1a214512008-06-11 05:26:20 +0000704static void
Guido van Rossum384ca9c2001-10-27 22:20:47 +0000705init_sockobject(PySocketSockObject *s,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000706 SOCKET_T fd, int family, int type, int proto)
Guido van Rossum384ca9c2001-10-27 22:20:47 +0000707{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000708 s->sock_fd = fd;
709 s->sock_family = family;
710 s->sock_type = type;
711 s->sock_proto = proto;
Guido van Rossum67f7a382002-06-06 21:08:16 +0000712
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000713 s->errorhandler = &set_error;
Antoine Pitroub1c54962010-10-14 15:05:38 +0000714#ifdef SOCK_NONBLOCK
715 if (type & SOCK_NONBLOCK)
716 s->sock_timeout = 0.0;
717 else
718#endif
719 {
720 s->sock_timeout = defaulttimeout;
721 if (defaulttimeout >= 0.0)
722 internal_setblocking(s, 0);
723 }
Guido van Rossum9d0c8ce2002-07-18 17:08:35 +0000724
Guido van Rossum384ca9c2001-10-27 22:20:47 +0000725}
726
727
Guido van Rossum30a685f1991-06-27 15:51:29 +0000728/* Create a new socket object.
729 This just creates the object and initializes it.
730 If the creation fails, return NULL and set an exception (implicit
731 in NEWOBJ()). */
732
Guido van Rossum73624e91994-10-10 17:59:00 +0000733static PySocketSockObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +0000734new_sockobject(SOCKET_T fd, int family, int type, int proto)
Guido van Rossum6574b3e1991-06-25 21:36:08 +0000735{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000736 PySocketSockObject *s;
737 s = (PySocketSockObject *)
738 PyType_GenericNew(&sock_type, NULL, NULL);
739 if (s != NULL)
740 init_sockobject(s, fd, family, type, proto);
741 return s;
Guido van Rossum6574b3e1991-06-25 21:36:08 +0000742}
743
Guido van Rossum30a685f1991-06-27 15:51:29 +0000744
Guido van Rossum48a680c2001-03-02 06:34:14 +0000745/* Lock to allow python interpreter to continue, but only allow one
Just van Rossum1040d2c2003-05-09 07:53:18 +0000746 thread to be in gethostbyname or getaddrinfo */
747#if defined(USE_GETHOSTBYNAME_LOCK) || defined(USE_GETADDRINFO_LOCK)
Matthias Klosed182a6c2012-08-14 17:29:04 +0200748static PyThread_type_lock netdb_lock;
Guido van Rossum4f199ea1998-04-09 20:56:35 +0000749#endif
750
751
Guido van Rossum30a685f1991-06-27 15:51:29 +0000752/* Convert a string specifying a host name or one of a few symbolic
753 names to a numeric IP address. This usually calls gethostbyname()
754 to do the work; the names "" and "<broadcast>" are special.
Martin v. Löwis2d8d4272001-07-21 18:05:31 +0000755 Return the length (IPv4 should be 4 bytes), or negative if
Guido van Rossum30a685f1991-06-27 15:51:29 +0000756 an error occurred; then an exception is raised. */
757
Guido van Rossum6574b3e1991-06-25 21:36:08 +0000758static int
Martin v. Löwisddc6f472002-07-28 16:10:31 +0000759setipaddr(char *name, struct sockaddr *addr_ret, size_t addr_ret_size, int af)
Guido van Rossum6574b3e1991-06-25 21:36:08 +0000760{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000761 struct addrinfo hints, *res;
762 int error;
Guido van Rossum6574b3e1991-06-25 21:36:08 +0000763
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000764 memset((void *) addr_ret, '\0', sizeof(*addr_ret));
765 if (name[0] == '\0') {
766 int siz;
767 memset(&hints, 0, sizeof(hints));
768 hints.ai_family = af;
769 hints.ai_socktype = SOCK_DGRAM; /*dummy*/
770 hints.ai_flags = AI_PASSIVE;
771 Py_BEGIN_ALLOW_THREADS
772 ACQUIRE_GETADDRINFO_LOCK
773 error = getaddrinfo(NULL, "0", &hints, &res);
774 Py_END_ALLOW_THREADS
775 /* We assume that those thread-unsafe getaddrinfo() versions
776 *are* safe regarding their return value, ie. that a
777 subsequent call to getaddrinfo() does not destroy the
778 outcome of the first call. */
779 RELEASE_GETADDRINFO_LOCK
780 if (error) {
781 set_gaierror(error);
782 return -1;
783 }
784 switch (res->ai_family) {
785 case AF_INET:
786 siz = 4;
787 break;
Martin v. Löwis44ddbde2001-12-02 10:15:37 +0000788#ifdef ENABLE_IPV6
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000789 case AF_INET6:
790 siz = 16;
791 break;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +0000792#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000793 default:
794 freeaddrinfo(res);
Antoine Pitrou6b4883d2011-10-12 02:54:14 +0200795 PyErr_SetString(PyExc_OSError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000796 "unsupported address family");
797 return -1;
798 }
799 if (res->ai_next) {
800 freeaddrinfo(res);
Antoine Pitrou6b4883d2011-10-12 02:54:14 +0200801 PyErr_SetString(PyExc_OSError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000802 "wildcard resolved to multiple address");
803 return -1;
804 }
805 if (res->ai_addrlen < addr_ret_size)
806 addr_ret_size = res->ai_addrlen;
807 memcpy(addr_ret, res->ai_addr, addr_ret_size);
808 freeaddrinfo(res);
809 return siz;
810 }
Charles-François Natali0cc86852013-09-13 19:53:08 +0200811 /* special-case broadcast - inet_addr() below can return INADDR_NONE for
Victor Stinnere990c6e2013-11-16 00:18:58 +0100812 * this */
Charles-François Natali0cc86852013-09-13 19:53:08 +0200813 if (strcmp(name, "255.255.255.255") == 0 ||
814 strcmp(name, "<broadcast>") == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000815 struct sockaddr_in *sin;
816 if (af != AF_INET && af != AF_UNSPEC) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +0200817 PyErr_SetString(PyExc_OSError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000818 "address family mismatched");
819 return -1;
820 }
821 sin = (struct sockaddr_in *)addr_ret;
822 memset((void *) sin, '\0', sizeof(*sin));
823 sin->sin_family = AF_INET;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +0000824#ifdef HAVE_SOCKADDR_SA_LEN
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000825 sin->sin_len = sizeof(*sin);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +0000826#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000827 sin->sin_addr.s_addr = INADDR_BROADCAST;
828 return sizeof(sin->sin_addr);
829 }
Charles-François Natali0cc86852013-09-13 19:53:08 +0200830
831 /* avoid a name resolution in case of numeric address */
832#ifdef HAVE_INET_PTON
833 /* check for an IPv4 address */
834 if (af == AF_UNSPEC || af == AF_INET) {
835 struct sockaddr_in *sin = (struct sockaddr_in *)addr_ret;
836 memset(sin, 0, sizeof(*sin));
837 if (inet_pton(AF_INET, name, &sin->sin_addr) > 0) {
838 sin->sin_family = AF_INET;
Anthony Baxter0e85f9d2003-05-02 15:40:46 +0000839#ifdef HAVE_SOCKADDR_SA_LEN
Charles-François Natali0cc86852013-09-13 19:53:08 +0200840 sin->sin_len = sizeof(*sin);
Anthony Baxter0e85f9d2003-05-02 15:40:46 +0000841#endif
Charles-François Natali0cc86852013-09-13 19:53:08 +0200842 return 4;
843 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000844 }
Charles-François Natali0cc86852013-09-13 19:53:08 +0200845#ifdef ENABLE_IPV6
846 /* check for an IPv6 address - if the address contains a scope ID, we
847 * fallback to getaddrinfo(), which can handle translation from interface
848 * name to interface index */
849 if ((af == AF_UNSPEC || af == AF_INET6) && !strchr(name, '%')) {
850 struct sockaddr_in6 *sin = (struct sockaddr_in6 *)addr_ret;
851 memset(sin, 0, sizeof(*sin));
852 if (inet_pton(AF_INET6, name, &sin->sin6_addr) > 0) {
853 sin->sin6_family = AF_INET6;
854#ifdef HAVE_SOCKADDR_SA_LEN
855 sin->sin6_len = sizeof(*sin);
856#endif
857 return 16;
858 }
859 }
860#endif /* ENABLE_IPV6 */
861#else /* HAVE_INET_PTON */
862 /* check for an IPv4 address */
863 if (af == AF_INET || af == AF_UNSPEC) {
864 struct sockaddr_in *sin = (struct sockaddr_in *)addr_ret;
865 memset(sin, 0, sizeof(*sin));
866 if ((sin->sin_addr.s_addr = inet_addr(name)) != INADDR_NONE) {
867 sin->sin_family = AF_INET;
868#ifdef HAVE_SOCKADDR_SA_LEN
869 sin->sin_len = sizeof(*sin);
870#endif
871 return 4;
872 }
Victor Stinnere990c6e2013-11-16 00:18:58 +0100873 }
Charles-François Natali0cc86852013-09-13 19:53:08 +0200874#endif /* HAVE_INET_PTON */
875
876 /* perform a name resolution */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000877 memset(&hints, 0, sizeof(hints));
878 hints.ai_family = af;
879 Py_BEGIN_ALLOW_THREADS
880 ACQUIRE_GETADDRINFO_LOCK
881 error = getaddrinfo(name, NULL, &hints, &res);
Martin v. Löwis7c4b5fa2001-10-25 09:04:03 +0000882#if defined(__digital__) && defined(__unix__)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000883 if (error == EAI_NONAME && af == AF_UNSPEC) {
884 /* On Tru64 V5.1, numeric-to-addr conversion fails
885 if no address family is given. Assume IPv4 for now.*/
886 hints.ai_family = AF_INET;
887 error = getaddrinfo(name, NULL, &hints, &res);
888 }
Martin v. Löwis7c4b5fa2001-10-25 09:04:03 +0000889#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000890 Py_END_ALLOW_THREADS
891 RELEASE_GETADDRINFO_LOCK /* see comment in setipaddr() */
892 if (error) {
893 set_gaierror(error);
894 return -1;
895 }
896 if (res->ai_addrlen < addr_ret_size)
897 addr_ret_size = res->ai_addrlen;
898 memcpy((char *) addr_ret, res->ai_addr, addr_ret_size);
899 freeaddrinfo(res);
900 switch (addr_ret->sa_family) {
901 case AF_INET:
902 return 4;
Martin v. Löwis44ddbde2001-12-02 10:15:37 +0000903#ifdef ENABLE_IPV6
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000904 case AF_INET6:
905 return 16;
Guido van Rossum955becc1999-03-22 20:14:53 +0000906#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000907 default:
Antoine Pitrou6b4883d2011-10-12 02:54:14 +0200908 PyErr_SetString(PyExc_OSError, "unknown address family");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000909 return -1;
910 }
Guido van Rossum6574b3e1991-06-25 21:36:08 +0000911}
912
Guido van Rossum30a685f1991-06-27 15:51:29 +0000913
Guido van Rossum30a685f1991-06-27 15:51:29 +0000914/* Create a string object representing an IP address.
915 This is always a string of the form 'dd.dd.dd.dd' (with variable
916 size numbers). */
917
Guido van Rossum73624e91994-10-10 17:59:00 +0000918static PyObject *
Martin v. Löwis2d8d4272001-07-21 18:05:31 +0000919makeipaddr(struct sockaddr *addr, int addrlen)
Guido van Rossum30a685f1991-06-27 15:51:29 +0000920{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000921 char buf[NI_MAXHOST];
922 int error;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +0000923
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000924 error = getnameinfo(addr, addrlen, buf, sizeof(buf), NULL, 0,
925 NI_NUMERICHOST);
926 if (error) {
927 set_gaierror(error);
928 return NULL;
929 }
930 return PyUnicode_FromString(buf);
Guido van Rossum30a685f1991-06-27 15:51:29 +0000931}
932
933
Martin v. Löwis558d9bf2004-06-03 09:24:42 +0000934#ifdef USE_BLUETOOTH
935/* Convert a string representation of a Bluetooth address into a numeric
936 address. Returns the length (6), or raises an exception and returns -1 if
937 an error occurred. */
938
939static int
940setbdaddr(char *name, bdaddr_t *bdaddr)
941{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000942 unsigned int b0, b1, b2, b3, b4, b5;
943 char ch;
944 int n;
Martin v. Löwis558d9bf2004-06-03 09:24:42 +0000945
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000946 n = sscanf(name, "%X:%X:%X:%X:%X:%X%c",
947 &b5, &b4, &b3, &b2, &b1, &b0, &ch);
948 if (n == 6 && (b0 | b1 | b2 | b3 | b4 | b5) < 256) {
949 bdaddr->b[0] = b0;
950 bdaddr->b[1] = b1;
951 bdaddr->b[2] = b2;
952 bdaddr->b[3] = b3;
953 bdaddr->b[4] = b4;
954 bdaddr->b[5] = b5;
955 return 6;
956 } else {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +0200957 PyErr_SetString(PyExc_OSError, "bad bluetooth address");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000958 return -1;
959 }
Martin v. Löwis558d9bf2004-06-03 09:24:42 +0000960}
961
962/* Create a string representation of the Bluetooth address. This is always a
963 string of the form 'XX:XX:XX:XX:XX:XX' where XX is a two digit hexadecimal
964 value (zero padded if necessary). */
965
966static PyObject *
967makebdaddr(bdaddr_t *bdaddr)
968{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000969 char buf[(6 * 2) + 5 + 1];
Martin v. Löwis558d9bf2004-06-03 09:24:42 +0000970
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000971 sprintf(buf, "%02X:%02X:%02X:%02X:%02X:%02X",
972 bdaddr->b[5], bdaddr->b[4], bdaddr->b[3],
973 bdaddr->b[2], bdaddr->b[1], bdaddr->b[0]);
974 return PyUnicode_FromString(buf);
Martin v. Löwis558d9bf2004-06-03 09:24:42 +0000975}
976#endif
977
978
Guido van Rossum30a685f1991-06-27 15:51:29 +0000979/* Create an object representing the given socket address,
980 suitable for passing it back to bind(), connect() etc.
981 The family field of the sockaddr structure is inspected
982 to determine what kind of address it really is. */
983
Guido van Rossum6574b3e1991-06-25 21:36:08 +0000984/*ARGSUSED*/
Guido van Rossum73624e91994-10-10 17:59:00 +0000985static PyObject *
Antoine Pitrou19467d22010-08-17 19:33:30 +0000986makesockaddr(SOCKET_T sockfd, struct sockaddr *addr, size_t addrlen, int proto)
Guido van Rossum6574b3e1991-06-25 21:36:08 +0000987{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000988 if (addrlen == 0) {
989 /* No address -- may be recvfrom() from known socket */
990 Py_INCREF(Py_None);
991 return Py_None;
992 }
Guido van Rossum25bec8c1992-08-05 19:00:45 +0000993
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000994 switch (addr->sa_family) {
Guido van Rossum30a685f1991-06-27 15:51:29 +0000995
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000996 case AF_INET:
997 {
998 struct sockaddr_in *a;
999 PyObject *addrobj = makeipaddr(addr, sizeof(*a));
1000 PyObject *ret = NULL;
1001 if (addrobj) {
1002 a = (struct sockaddr_in *)addr;
1003 ret = Py_BuildValue("Oi", addrobj, ntohs(a->sin_port));
1004 Py_DECREF(addrobj);
1005 }
1006 return ret;
1007 }
Guido van Rossum30a685f1991-06-27 15:51:29 +00001008
Andrew MacIntyred12dfbb2004-04-04 07:13:49 +00001009#if defined(AF_UNIX)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001010 case AF_UNIX:
1011 {
1012 struct sockaddr_un *a = (struct sockaddr_un *) addr;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001013#ifdef linux
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001014 if (a->sun_path[0] == 0) { /* Linux abstract namespace */
1015 addrlen -= offsetof(struct sockaddr_un, sun_path);
Charles-François Natalib10c71d2013-05-21 10:45:46 +02001016 return PyBytes_FromStringAndSize(a->sun_path, addrlen);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001017 }
1018 else
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001019#endif /* linux */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001020 {
1021 /* regular NULL-terminated string */
Antoine Pitrou6ec29e22011-12-16 14:46:36 +01001022 return PyUnicode_DecodeFSDefault(a->sun_path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001023 }
1024 }
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00001025#endif /* AF_UNIX */
1026
Martin v. Löwis11017b12006-01-14 18:12:57 +00001027#if defined(AF_NETLINK)
1028 case AF_NETLINK:
1029 {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001030 struct sockaddr_nl *a = (struct sockaddr_nl *) addr;
1031 return Py_BuildValue("II", a->nl_pid, a->nl_groups);
Martin v. Löwis11017b12006-01-14 18:12:57 +00001032 }
1033#endif /* AF_NETLINK */
1034
Martin v. Löwis44ddbde2001-12-02 10:15:37 +00001035#ifdef ENABLE_IPV6
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001036 case AF_INET6:
1037 {
1038 struct sockaddr_in6 *a;
1039 PyObject *addrobj = makeipaddr(addr, sizeof(*a));
1040 PyObject *ret = NULL;
1041 if (addrobj) {
1042 a = (struct sockaddr_in6 *)addr;
Charles-François Natali366999a2012-01-02 15:47:29 +01001043 ret = Py_BuildValue("OiII",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001044 addrobj,
1045 ntohs(a->sin6_port),
Charles-François Natali366999a2012-01-02 15:47:29 +01001046 ntohl(a->sin6_flowinfo),
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001047 a->sin6_scope_id);
1048 Py_DECREF(addrobj);
1049 }
1050 return ret;
1051 }
Jeremy Hylton22308652001-02-02 03:23:09 +00001052#endif
Guido van Rossum30a685f1991-06-27 15:51:29 +00001053
Martin v. Löwis558d9bf2004-06-03 09:24:42 +00001054#ifdef USE_BLUETOOTH
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001055 case AF_BLUETOOTH:
1056 switch (proto) {
Martin v. Löwis558d9bf2004-06-03 09:24:42 +00001057
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001058 case BTPROTO_L2CAP:
1059 {
1060 struct sockaddr_l2 *a = (struct sockaddr_l2 *) addr;
1061 PyObject *addrobj = makebdaddr(&_BT_L2_MEMB(a, bdaddr));
1062 PyObject *ret = NULL;
1063 if (addrobj) {
1064 ret = Py_BuildValue("Oi",
1065 addrobj,
1066 _BT_L2_MEMB(a, psm));
1067 Py_DECREF(addrobj);
1068 }
1069 return ret;
1070 }
Martin v. Löwis558d9bf2004-06-03 09:24:42 +00001071
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001072 case BTPROTO_RFCOMM:
1073 {
1074 struct sockaddr_rc *a = (struct sockaddr_rc *) addr;
1075 PyObject *addrobj = makebdaddr(&_BT_RC_MEMB(a, bdaddr));
1076 PyObject *ret = NULL;
1077 if (addrobj) {
1078 ret = Py_BuildValue("Oi",
1079 addrobj,
1080 _BT_RC_MEMB(a, channel));
1081 Py_DECREF(addrobj);
1082 }
1083 return ret;
1084 }
Martin v. Löwis558d9bf2004-06-03 09:24:42 +00001085
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001086 case BTPROTO_HCI:
1087 {
1088 struct sockaddr_hci *a = (struct sockaddr_hci *) addr;
Gregory P. Smith3e85dfd2010-10-17 00:43:10 +00001089#if defined(__NetBSD__) || defined(__DragonFly__)
1090 return makebdaddr(&_BT_HCI_MEMB(a, bdaddr));
1091#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001092 PyObject *ret = NULL;
1093 ret = Py_BuildValue("i", _BT_HCI_MEMB(a, dev));
1094 return ret;
Gregory P. Smith3e85dfd2010-10-17 00:43:10 +00001095#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001096 }
Thomas Wouterscf297e42007-02-23 15:07:44 +00001097
Martin v. Löwis558d9bf2004-06-03 09:24:42 +00001098#if !defined(__FreeBSD__)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001099 case BTPROTO_SCO:
1100 {
1101 struct sockaddr_sco *a = (struct sockaddr_sco *) addr;
1102 return makebdaddr(&_BT_SCO_MEMB(a, bdaddr));
1103 }
Martin v. Löwis558d9bf2004-06-03 09:24:42 +00001104#endif
1105
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001106 default:
1107 PyErr_SetString(PyExc_ValueError,
1108 "Unknown Bluetooth protocol");
1109 return NULL;
1110 }
Martin v. Löwis558d9bf2004-06-03 09:24:42 +00001111#endif
1112
Antoine Pitroub156a462010-10-27 20:13:57 +00001113#if defined(HAVE_NETPACKET_PACKET_H) && defined(SIOCGIFNAME)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001114 case AF_PACKET:
1115 {
1116 struct sockaddr_ll *a = (struct sockaddr_ll *)addr;
1117 char *ifname = "";
1118 struct ifreq ifr;
1119 /* need to look up interface name give index */
1120 if (a->sll_ifindex) {
1121 ifr.ifr_ifindex = a->sll_ifindex;
1122 if (ioctl(sockfd, SIOCGIFNAME, &ifr) == 0)
1123 ifname = ifr.ifr_name;
1124 }
1125 return Py_BuildValue("shbhy#",
1126 ifname,
1127 ntohs(a->sll_protocol),
1128 a->sll_pkttype,
1129 a->sll_hatype,
1130 a->sll_addr,
1131 a->sll_halen);
1132 }
Jeremy Hylton22308652001-02-02 03:23:09 +00001133#endif
Guido van Rossum48a680c2001-03-02 06:34:14 +00001134
Christian Heimes043d6f62008-01-07 17:19:16 +00001135#ifdef HAVE_LINUX_TIPC_H
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001136 case AF_TIPC:
1137 {
1138 struct sockaddr_tipc *a = (struct sockaddr_tipc *) addr;
1139 if (a->addrtype == TIPC_ADDR_NAMESEQ) {
1140 return Py_BuildValue("IIIII",
1141 a->addrtype,
1142 a->addr.nameseq.type,
1143 a->addr.nameseq.lower,
1144 a->addr.nameseq.upper,
1145 a->scope);
1146 } else if (a->addrtype == TIPC_ADDR_NAME) {
1147 return Py_BuildValue("IIIII",
1148 a->addrtype,
1149 a->addr.name.name.type,
1150 a->addr.name.name.instance,
1151 a->addr.name.name.instance,
1152 a->scope);
1153 } else if (a->addrtype == TIPC_ADDR_ID) {
1154 return Py_BuildValue("IIIII",
1155 a->addrtype,
1156 a->addr.id.node,
1157 a->addr.id.ref,
1158 0,
1159 a->scope);
1160 } else {
1161 PyErr_SetString(PyExc_ValueError,
1162 "Invalid address type");
1163 return NULL;
1164 }
1165 }
Christian Heimes043d6f62008-01-07 17:19:16 +00001166#endif
1167
Charles-François Natali30589c92011-10-07 22:47:08 +02001168#ifdef AF_CAN
Charles-François Natali47413c12011-10-06 19:47:44 +02001169 case AF_CAN:
1170 {
1171 struct sockaddr_can *a = (struct sockaddr_can *)addr;
1172 char *ifname = "";
1173 struct ifreq ifr;
1174 /* need to look up interface name given index */
1175 if (a->can_ifindex) {
1176 ifr.ifr_ifindex = a->can_ifindex;
1177 if (ioctl(sockfd, SIOCGIFNAME, &ifr) == 0)
1178 ifname = ifr.ifr_name;
1179 }
1180
1181 return Py_BuildValue("O&h", PyUnicode_DecodeFSDefault,
1182 ifname,
1183 a->can_family);
1184 }
1185#endif
1186
Martin v. Löwis9d6c6692012-02-03 17:44:58 +01001187#ifdef PF_SYSTEM
1188 case PF_SYSTEM:
1189 switch(proto) {
1190#ifdef SYSPROTO_CONTROL
1191 case SYSPROTO_CONTROL:
1192 {
1193 struct sockaddr_ctl *a = (struct sockaddr_ctl *)addr;
1194 return Py_BuildValue("(II)", a->sc_id, a->sc_unit);
1195 }
1196#endif
1197 default:
1198 PyErr_SetString(PyExc_ValueError,
1199 "Invalid address type");
1200 return 0;
1201 }
1202#endif
1203
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001204 /* More cases here... */
Guido van Rossum30a685f1991-06-27 15:51:29 +00001205
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001206 default:
1207 /* If we don't know the address family, don't raise an
1208 exception -- return it as an (int, bytes) tuple. */
1209 return Py_BuildValue("iy#",
1210 addr->sa_family,
1211 addr->sa_data,
1212 sizeof(addr->sa_data));
Guido van Rossum25bec8c1992-08-05 19:00:45 +00001213
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001214 }
Guido van Rossum6574b3e1991-06-25 21:36:08 +00001215}
1216
Guido van Rossum30a685f1991-06-27 15:51:29 +00001217
1218/* Parse a socket address argument according to the socket object's
1219 address family. Return 1 if the address was in the proper format,
1220 0 of not. The address is returned through addr_ret, its length
1221 through len_ret. */
1222
Guido van Rossum6574b3e1991-06-25 21:36:08 +00001223static int
Guido van Rossum48a680c2001-03-02 06:34:14 +00001224getsockaddrarg(PySocketSockObject *s, PyObject *args,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001225 struct sockaddr *addr_ret, int *len_ret)
Guido van Rossum6574b3e1991-06-25 21:36:08 +00001226{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001227 switch (s->sock_family) {
Guido van Rossum30a685f1991-06-27 15:51:29 +00001228
Andrew MacIntyred12dfbb2004-04-04 07:13:49 +00001229#if defined(AF_UNIX)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001230 case AF_UNIX:
1231 {
1232 struct sockaddr_un* addr;
1233 char *path;
1234 int len;
Antoine Pitrou6ec29e22011-12-16 14:46:36 +01001235 int retval = 0;
1236
1237 /* PEP 383. Not using PyUnicode_FSConverter since we need to
1238 allow embedded nulls on Linux. */
1239 if (PyUnicode_Check(args)) {
1240 if ((args = PyUnicode_EncodeFSDefault(args)) == NULL)
1241 return 0;
1242 }
1243 else
1244 Py_INCREF(args);
1245 if (!PyArg_Parse(args, "y#", &path, &len))
1246 goto unix_out;
Thomas Wouters89f507f2006-12-13 04:49:30 +00001247
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001248 addr = (struct sockaddr_un*)addr_ret;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001249#ifdef linux
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001250 if (len > 0 && path[0] == 0) {
1251 /* Linux abstract namespace extension */
1252 if (len > sizeof addr->sun_path) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02001253 PyErr_SetString(PyExc_OSError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001254 "AF_UNIX path too long");
Antoine Pitrou6ec29e22011-12-16 14:46:36 +01001255 goto unix_out;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001256 }
1257 }
1258 else
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001259#endif /* linux */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001260 {
1261 /* regular NULL-terminated string */
1262 if (len >= sizeof addr->sun_path) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02001263 PyErr_SetString(PyExc_OSError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001264 "AF_UNIX path too long");
Antoine Pitrou6ec29e22011-12-16 14:46:36 +01001265 goto unix_out;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001266 }
1267 addr->sun_path[len] = 0;
1268 }
1269 addr->sun_family = s->sock_family;
1270 memcpy(addr->sun_path, path, len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001271 *len_ret = len + offsetof(struct sockaddr_un, sun_path);
Antoine Pitrou6ec29e22011-12-16 14:46:36 +01001272 retval = 1;
1273 unix_out:
1274 Py_DECREF(args);
1275 return retval;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001276 }
Guido van Rossumb6775db1994-08-01 11:34:53 +00001277#endif /* AF_UNIX */
Guido van Rossum6574b3e1991-06-25 21:36:08 +00001278
Martin v. Löwis11017b12006-01-14 18:12:57 +00001279#if defined(AF_NETLINK)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001280 case AF_NETLINK:
1281 {
1282 struct sockaddr_nl* addr;
1283 int pid, groups;
1284 addr = (struct sockaddr_nl *)addr_ret;
1285 if (!PyTuple_Check(args)) {
1286 PyErr_Format(
1287 PyExc_TypeError,
1288 "getsockaddrarg: "
1289 "AF_NETLINK address must be tuple, not %.500s",
1290 Py_TYPE(args)->tp_name);
1291 return 0;
1292 }
1293 if (!PyArg_ParseTuple(args, "II:getsockaddrarg", &pid, &groups))
1294 return 0;
1295 addr->nl_family = AF_NETLINK;
1296 addr->nl_pid = pid;
1297 addr->nl_groups = groups;
1298 *len_ret = sizeof(*addr);
1299 return 1;
1300 }
Martin v. Löwis11017b12006-01-14 18:12:57 +00001301#endif
1302
Charles-François Natali10b8cf42011-11-10 19:21:37 +01001303#ifdef AF_RDS
1304 case AF_RDS:
1305 /* RDS sockets use sockaddr_in: fall-through */
1306#endif
1307
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001308 case AF_INET:
1309 {
1310 struct sockaddr_in* addr;
1311 char *host;
1312 int port, result;
1313 if (!PyTuple_Check(args)) {
1314 PyErr_Format(
1315 PyExc_TypeError,
1316 "getsockaddrarg: "
1317 "AF_INET address must be tuple, not %.500s",
1318 Py_TYPE(args)->tp_name);
1319 return 0;
1320 }
1321 if (!PyArg_ParseTuple(args, "eti:getsockaddrarg",
1322 "idna", &host, &port))
1323 return 0;
1324 addr=(struct sockaddr_in*)addr_ret;
1325 result = setipaddr(host, (struct sockaddr *)addr,
1326 sizeof(*addr), AF_INET);
1327 PyMem_Free(host);
1328 if (result < 0)
1329 return 0;
1330 if (port < 0 || port > 0xffff) {
1331 PyErr_SetString(
1332 PyExc_OverflowError,
1333 "getsockaddrarg: port must be 0-65535.");
1334 return 0;
1335 }
1336 addr->sin_family = AF_INET;
1337 addr->sin_port = htons((short)port);
1338 *len_ret = sizeof *addr;
1339 return 1;
1340 }
Guido van Rossum6574b3e1991-06-25 21:36:08 +00001341
Martin v. Löwis44ddbde2001-12-02 10:15:37 +00001342#ifdef ENABLE_IPV6
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001343 case AF_INET6:
1344 {
1345 struct sockaddr_in6* addr;
1346 char *host;
Charles-François Natali366999a2012-01-02 15:47:29 +01001347 int port, result;
1348 unsigned int flowinfo, scope_id;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001349 flowinfo = scope_id = 0;
1350 if (!PyTuple_Check(args)) {
1351 PyErr_Format(
1352 PyExc_TypeError,
1353 "getsockaddrarg: "
1354 "AF_INET6 address must be tuple, not %.500s",
1355 Py_TYPE(args)->tp_name);
1356 return 0;
1357 }
Charles-François Natali366999a2012-01-02 15:47:29 +01001358 if (!PyArg_ParseTuple(args, "eti|II",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001359 "idna", &host, &port, &flowinfo,
1360 &scope_id)) {
1361 return 0;
1362 }
1363 addr = (struct sockaddr_in6*)addr_ret;
1364 result = setipaddr(host, (struct sockaddr *)addr,
1365 sizeof(*addr), AF_INET6);
1366 PyMem_Free(host);
1367 if (result < 0)
1368 return 0;
1369 if (port < 0 || port > 0xffff) {
1370 PyErr_SetString(
1371 PyExc_OverflowError,
1372 "getsockaddrarg: port must be 0-65535.");
1373 return 0;
1374 }
Charles-François Natali9b0c0062012-06-23 10:17:05 +02001375 if (flowinfo > 0xfffff) {
Charles-François Natali366999a2012-01-02 15:47:29 +01001376 PyErr_SetString(
1377 PyExc_OverflowError,
1378 "getsockaddrarg: flowinfo must be 0-1048575.");
1379 return 0;
1380 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001381 addr->sin6_family = s->sock_family;
1382 addr->sin6_port = htons((short)port);
Charles-François Natali366999a2012-01-02 15:47:29 +01001383 addr->sin6_flowinfo = htonl(flowinfo);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001384 addr->sin6_scope_id = scope_id;
1385 *len_ret = sizeof *addr;
1386 return 1;
1387 }
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00001388#endif
1389
Hye-Shik Chang81268602004-02-02 06:05:24 +00001390#ifdef USE_BLUETOOTH
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001391 case AF_BLUETOOTH:
1392 {
1393 switch (s->sock_proto) {
1394 case BTPROTO_L2CAP:
1395 {
1396 struct sockaddr_l2 *addr;
1397 char *straddr;
Martin v. Löwis12af0482004-01-31 12:34:17 +00001398
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001399 addr = (struct sockaddr_l2 *)addr_ret;
1400 memset(addr, 0, sizeof(struct sockaddr_l2));
1401 _BT_L2_MEMB(addr, family) = AF_BLUETOOTH;
1402 if (!PyArg_ParseTuple(args, "si", &straddr,
1403 &_BT_L2_MEMB(addr, psm))) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02001404 PyErr_SetString(PyExc_OSError, "getsockaddrarg: "
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001405 "wrong format");
1406 return 0;
1407 }
1408 if (setbdaddr(straddr, &_BT_L2_MEMB(addr, bdaddr)) < 0)
1409 return 0;
Martin v. Löwis558d9bf2004-06-03 09:24:42 +00001410
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001411 *len_ret = sizeof *addr;
1412 return 1;
1413 }
1414 case BTPROTO_RFCOMM:
1415 {
1416 struct sockaddr_rc *addr;
1417 char *straddr;
Martin v. Löwis558d9bf2004-06-03 09:24:42 +00001418
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001419 addr = (struct sockaddr_rc *)addr_ret;
1420 _BT_RC_MEMB(addr, family) = AF_BLUETOOTH;
1421 if (!PyArg_ParseTuple(args, "si", &straddr,
1422 &_BT_RC_MEMB(addr, channel))) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02001423 PyErr_SetString(PyExc_OSError, "getsockaddrarg: "
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001424 "wrong format");
1425 return 0;
1426 }
1427 if (setbdaddr(straddr, &_BT_RC_MEMB(addr, bdaddr)) < 0)
1428 return 0;
Martin v. Löwis558d9bf2004-06-03 09:24:42 +00001429
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001430 *len_ret = sizeof *addr;
1431 return 1;
1432 }
1433 case BTPROTO_HCI:
1434 {
1435 struct sockaddr_hci *addr = (struct sockaddr_hci *)addr_ret;
Gregory P. Smith3e85dfd2010-10-17 00:43:10 +00001436#if defined(__NetBSD__) || defined(__DragonFly__)
Alexander Belopolskye239d232010-12-08 23:31:48 +00001437 char *straddr = PyBytes_AS_STRING(args);
Gregory P. Smith3e85dfd2010-10-17 00:43:10 +00001438
Alexander Belopolskye239d232010-12-08 23:31:48 +00001439 _BT_HCI_MEMB(addr, family) = AF_BLUETOOTH;
Gregory P. Smith3e85dfd2010-10-17 00:43:10 +00001440 if (straddr == NULL) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02001441 PyErr_SetString(PyExc_OSError, "getsockaddrarg: "
Gregory P. Smith3e85dfd2010-10-17 00:43:10 +00001442 "wrong format");
1443 return 0;
1444 }
1445 if (setbdaddr(straddr, &_BT_HCI_MEMB(addr, bdaddr)) < 0)
1446 return 0;
1447#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001448 _BT_HCI_MEMB(addr, family) = AF_BLUETOOTH;
1449 if (!PyArg_ParseTuple(args, "i", &_BT_HCI_MEMB(addr, dev))) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02001450 PyErr_SetString(PyExc_OSError, "getsockaddrarg: "
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001451 "wrong format");
1452 return 0;
1453 }
Gregory P. Smith3e85dfd2010-10-17 00:43:10 +00001454#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001455 *len_ret = sizeof *addr;
1456 return 1;
1457 }
Martin v. Löwis558d9bf2004-06-03 09:24:42 +00001458#if !defined(__FreeBSD__)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001459 case BTPROTO_SCO:
1460 {
1461 struct sockaddr_sco *addr;
1462 char *straddr;
Martin v. Löwis558d9bf2004-06-03 09:24:42 +00001463
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001464 addr = (struct sockaddr_sco *)addr_ret;
1465 _BT_SCO_MEMB(addr, family) = AF_BLUETOOTH;
1466 if (!PyBytes_Check(args)) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02001467 PyErr_SetString(PyExc_OSError, "getsockaddrarg: "
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001468 "wrong format");
1469 return 0;
1470 }
1471 straddr = PyBytes_AS_STRING(args);
1472 if (setbdaddr(straddr, &_BT_SCO_MEMB(addr, bdaddr)) < 0)
1473 return 0;
Martin v. Löwis558d9bf2004-06-03 09:24:42 +00001474
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001475 *len_ret = sizeof *addr;
1476 return 1;
1477 }
Martin v. Löwis558d9bf2004-06-03 09:24:42 +00001478#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001479 default:
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02001480 PyErr_SetString(PyExc_OSError, "getsockaddrarg: unknown Bluetooth protocol");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001481 return 0;
1482 }
1483 }
Martin v. Löwis12af0482004-01-31 12:34:17 +00001484#endif
1485
Antoine Pitroub156a462010-10-27 20:13:57 +00001486#if defined(HAVE_NETPACKET_PACKET_H) && defined(SIOCGIFINDEX)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001487 case AF_PACKET:
1488 {
1489 struct sockaddr_ll* addr;
1490 struct ifreq ifr;
1491 char *interfaceName;
1492 int protoNumber;
1493 int hatype = 0;
1494 int pkttype = 0;
1495 char *haddr = NULL;
1496 unsigned int halen = 0;
Guido van Rossum48a680c2001-03-02 06:34:14 +00001497
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001498 if (!PyTuple_Check(args)) {
1499 PyErr_Format(
1500 PyExc_TypeError,
1501 "getsockaddrarg: "
1502 "AF_PACKET address must be tuple, not %.500s",
1503 Py_TYPE(args)->tp_name);
1504 return 0;
1505 }
1506 if (!PyArg_ParseTuple(args, "si|iiy#", &interfaceName,
1507 &protoNumber, &pkttype, &hatype,
1508 &haddr, &halen))
1509 return 0;
1510 strncpy(ifr.ifr_name, interfaceName, sizeof(ifr.ifr_name));
1511 ifr.ifr_name[(sizeof(ifr.ifr_name))-1] = '\0';
1512 if (ioctl(s->sock_fd, SIOCGIFINDEX, &ifr) < 0) {
1513 s->errorhandler();
1514 return 0;
1515 }
1516 if (halen > 8) {
1517 PyErr_SetString(PyExc_ValueError,
1518 "Hardware address must be 8 bytes or less");
1519 return 0;
1520 }
1521 if (protoNumber < 0 || protoNumber > 0xffff) {
1522 PyErr_SetString(
1523 PyExc_OverflowError,
1524 "getsockaddrarg: protoNumber must be 0-65535.");
1525 return 0;
1526 }
1527 addr = (struct sockaddr_ll*)addr_ret;
1528 addr->sll_family = AF_PACKET;
1529 addr->sll_protocol = htons((short)protoNumber);
1530 addr->sll_ifindex = ifr.ifr_ifindex;
1531 addr->sll_pkttype = pkttype;
1532 addr->sll_hatype = hatype;
1533 if (halen != 0) {
1534 memcpy(&addr->sll_addr, haddr, halen);
1535 }
1536 addr->sll_halen = halen;
1537 *len_ret = sizeof *addr;
1538 return 1;
1539 }
Guido van Rossum48a680c2001-03-02 06:34:14 +00001540#endif
1541
Christian Heimes043d6f62008-01-07 17:19:16 +00001542#ifdef HAVE_LINUX_TIPC_H
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001543 case AF_TIPC:
1544 {
1545 unsigned int atype, v1, v2, v3;
1546 unsigned int scope = TIPC_CLUSTER_SCOPE;
1547 struct sockaddr_tipc *addr;
Christian Heimes043d6f62008-01-07 17:19:16 +00001548
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001549 if (!PyTuple_Check(args)) {
1550 PyErr_Format(
1551 PyExc_TypeError,
1552 "getsockaddrarg: "
1553 "AF_TIPC address must be tuple, not %.500s",
1554 Py_TYPE(args)->tp_name);
1555 return 0;
1556 }
Christian Heimes043d6f62008-01-07 17:19:16 +00001557
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001558 if (!PyArg_ParseTuple(args,
1559 "IIII|I;Invalid TIPC address format",
1560 &atype, &v1, &v2, &v3, &scope))
1561 return 0;
Christian Heimes043d6f62008-01-07 17:19:16 +00001562
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001563 addr = (struct sockaddr_tipc *) addr_ret;
1564 memset(addr, 0, sizeof(struct sockaddr_tipc));
Christian Heimes043d6f62008-01-07 17:19:16 +00001565
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001566 addr->family = AF_TIPC;
1567 addr->scope = scope;
1568 addr->addrtype = atype;
Christian Heimes043d6f62008-01-07 17:19:16 +00001569
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001570 if (atype == TIPC_ADDR_NAMESEQ) {
1571 addr->addr.nameseq.type = v1;
1572 addr->addr.nameseq.lower = v2;
1573 addr->addr.nameseq.upper = v3;
1574 } else if (atype == TIPC_ADDR_NAME) {
1575 addr->addr.name.name.type = v1;
1576 addr->addr.name.name.instance = v2;
1577 } else if (atype == TIPC_ADDR_ID) {
1578 addr->addr.id.node = v1;
1579 addr->addr.id.ref = v2;
1580 } else {
1581 /* Shouldn't happen */
1582 PyErr_SetString(PyExc_TypeError, "Invalid address type");
1583 return 0;
1584 }
Christian Heimes043d6f62008-01-07 17:19:16 +00001585
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001586 *len_ret = sizeof(*addr);
Christian Heimes043d6f62008-01-07 17:19:16 +00001587
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001588 return 1;
1589 }
Christian Heimes043d6f62008-01-07 17:19:16 +00001590#endif
1591
Charles-François Natali30589c92011-10-07 22:47:08 +02001592#ifdef AF_CAN
Charles-François Natali47413c12011-10-06 19:47:44 +02001593 case AF_CAN:
1594 switch (s->sock_proto) {
1595 case CAN_RAW:
Charles-François Natali773e42d2013-02-05 19:42:01 +01001596 /* fall-through */
1597 case CAN_BCM:
Charles-François Natali47413c12011-10-06 19:47:44 +02001598 {
1599 struct sockaddr_can *addr;
1600 PyObject *interfaceName;
1601 struct ifreq ifr;
Charles-François Natali47413c12011-10-06 19:47:44 +02001602 Py_ssize_t len;
1603
Benjamin Peterson18b71912013-05-16 15:29:44 -05001604 addr = (struct sockaddr_can *)addr_ret;
1605
Charles-François Natali47413c12011-10-06 19:47:44 +02001606 if (!PyArg_ParseTuple(args, "O&", PyUnicode_FSConverter,
1607 &interfaceName))
1608 return 0;
1609
1610 len = PyBytes_GET_SIZE(interfaceName);
1611
1612 if (len == 0) {
1613 ifr.ifr_ifindex = 0;
1614 } else if (len < sizeof(ifr.ifr_name)) {
Christian Heimes15b68852012-09-10 01:25:50 +02001615 strncpy(ifr.ifr_name, PyBytes_AS_STRING(interfaceName), sizeof(ifr.ifr_name));
1616 ifr.ifr_name[(sizeof(ifr.ifr_name))-1] = '\0';
Charles-François Natali47413c12011-10-06 19:47:44 +02001617 if (ioctl(s->sock_fd, SIOCGIFINDEX, &ifr) < 0) {
1618 s->errorhandler();
1619 Py_DECREF(interfaceName);
1620 return 0;
1621 }
1622 } else {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02001623 PyErr_SetString(PyExc_OSError,
Charles-François Natali47413c12011-10-06 19:47:44 +02001624 "AF_CAN interface name too long");
1625 Py_DECREF(interfaceName);
1626 return 0;
1627 }
1628
1629 addr->can_family = AF_CAN;
1630 addr->can_ifindex = ifr.ifr_ifindex;
1631
1632 *len_ret = sizeof(*addr);
1633 Py_DECREF(interfaceName);
1634 return 1;
1635 }
1636 default:
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02001637 PyErr_SetString(PyExc_OSError,
Charles-François Natali47413c12011-10-06 19:47:44 +02001638 "getsockaddrarg: unsupported CAN protocol");
1639 return 0;
1640 }
1641#endif
Victor Stinnera534fc42013-06-03 22:07:27 +02001642
Martin v. Löwis9d6c6692012-02-03 17:44:58 +01001643#ifdef PF_SYSTEM
1644 case PF_SYSTEM:
1645 switch (s->sock_proto) {
1646#ifdef SYSPROTO_CONTROL
1647 case SYSPROTO_CONTROL:
1648 {
1649 struct sockaddr_ctl *addr;
Victor Stinnera534fc42013-06-03 22:07:27 +02001650
Martin v. Löwis9d6c6692012-02-03 17:44:58 +01001651 addr = (struct sockaddr_ctl *)addr_ret;
1652 addr->sc_family = AF_SYSTEM;
Victor Stinnera534fc42013-06-03 22:07:27 +02001653 addr->ss_sysaddr = AF_SYS_CONTROL;
Martin v. Löwis9d6c6692012-02-03 17:44:58 +01001654
1655 if (PyUnicode_Check(args)) {
1656 struct ctl_info info;
1657 PyObject *ctl_name;
1658
1659 if (!PyArg_Parse(args, "O&",
1660 PyUnicode_FSConverter, &ctl_name)) {
1661 return 0;
1662 }
1663
1664 if (PyBytes_GET_SIZE(ctl_name) > sizeof(info.ctl_name)) {
1665 PyErr_SetString(PyExc_ValueError,
1666 "provided string is too long");
1667 Py_DECREF(ctl_name);
1668 return 0;
1669 }
1670 strncpy(info.ctl_name, PyBytes_AS_STRING(ctl_name),
1671 sizeof(info.ctl_name));
1672 Py_DECREF(ctl_name);
1673
1674 if (ioctl(s->sock_fd, CTLIOCGINFO, &info)) {
1675 PyErr_SetString(PyExc_OSError,
1676 "cannot find kernel control with provided name");
1677 return 0;
1678 }
Victor Stinnera534fc42013-06-03 22:07:27 +02001679
Martin v. Löwis9d6c6692012-02-03 17:44:58 +01001680 addr->sc_id = info.ctl_id;
1681 addr->sc_unit = 0;
1682 } else if (!PyArg_ParseTuple(args, "II",
1683 &(addr->sc_id), &(addr->sc_unit))) {
1684 PyErr_SetString(PyExc_TypeError, "getsockaddrarg: "
1685 "expected str or tuple of two ints");
Victor Stinnera534fc42013-06-03 22:07:27 +02001686
Martin v. Löwis9d6c6692012-02-03 17:44:58 +01001687 return 0;
1688 }
Victor Stinnera534fc42013-06-03 22:07:27 +02001689
Martin v. Löwis9d6c6692012-02-03 17:44:58 +01001690 *len_ret = sizeof(*addr);
1691 return 1;
1692 }
1693#endif
1694 default:
1695 PyErr_SetString(PyExc_OSError,
1696 "getsockaddrarg: unsupported PF_SYSTEM protocol");
1697 return 0;
1698 }
1699#endif
Charles-François Natali47413c12011-10-06 19:47:44 +02001700
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001701 /* More cases here... */
Guido van Rossum30a685f1991-06-27 15:51:29 +00001702
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001703 default:
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02001704 PyErr_SetString(PyExc_OSError, "getsockaddrarg: bad family");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001705 return 0;
Guido van Rossum30a685f1991-06-27 15:51:29 +00001706
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001707 }
Guido van Rossum6574b3e1991-06-25 21:36:08 +00001708}
1709
Guido van Rossum30a685f1991-06-27 15:51:29 +00001710
Guido van Rossum48a680c2001-03-02 06:34:14 +00001711/* Get the address length according to the socket object's address family.
Guido van Rossum710e1df1992-06-12 10:39:36 +00001712 Return 1 if the family is known, 0 otherwise. The length is returned
1713 through len_ret. */
1714
1715static int
Peter Schneider-Kamp618e25d2000-07-11 23:00:12 +00001716getsockaddrlen(PySocketSockObject *s, socklen_t *len_ret)
Guido van Rossum710e1df1992-06-12 10:39:36 +00001717{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001718 switch (s->sock_family) {
Guido van Rossum710e1df1992-06-12 10:39:36 +00001719
Andrew MacIntyred12dfbb2004-04-04 07:13:49 +00001720#if defined(AF_UNIX)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001721 case AF_UNIX:
1722 {
1723 *len_ret = sizeof (struct sockaddr_un);
1724 return 1;
1725 }
Guido van Rossumb6775db1994-08-01 11:34:53 +00001726#endif /* AF_UNIX */
Martin v. Löwis11017b12006-01-14 18:12:57 +00001727#if defined(AF_NETLINK)
1728 case AF_NETLINK:
1729 {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001730 *len_ret = sizeof (struct sockaddr_nl);
1731 return 1;
Martin v. Löwis11017b12006-01-14 18:12:57 +00001732 }
1733#endif
Guido van Rossum710e1df1992-06-12 10:39:36 +00001734
Charles-François Natali10b8cf42011-11-10 19:21:37 +01001735#ifdef AF_RDS
1736 case AF_RDS:
1737 /* RDS sockets use sockaddr_in: fall-through */
1738#endif
1739
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001740 case AF_INET:
1741 {
1742 *len_ret = sizeof (struct sockaddr_in);
1743 return 1;
1744 }
Guido van Rossum710e1df1992-06-12 10:39:36 +00001745
Martin v. Löwis44ddbde2001-12-02 10:15:37 +00001746#ifdef ENABLE_IPV6
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001747 case AF_INET6:
1748 {
1749 *len_ret = sizeof (struct sockaddr_in6);
1750 return 1;
1751 }
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00001752#endif
1753
Hye-Shik Chang81268602004-02-02 06:05:24 +00001754#ifdef USE_BLUETOOTH
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001755 case AF_BLUETOOTH:
1756 {
1757 switch(s->sock_proto)
1758 {
Martin v. Löwis558d9bf2004-06-03 09:24:42 +00001759
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001760 case BTPROTO_L2CAP:
1761 *len_ret = sizeof (struct sockaddr_l2);
1762 return 1;
1763 case BTPROTO_RFCOMM:
1764 *len_ret = sizeof (struct sockaddr_rc);
1765 return 1;
1766 case BTPROTO_HCI:
1767 *len_ret = sizeof (struct sockaddr_hci);
1768 return 1;
Hye-Shik Chang81268602004-02-02 06:05:24 +00001769#if !defined(__FreeBSD__)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001770 case BTPROTO_SCO:
1771 *len_ret = sizeof (struct sockaddr_sco);
1772 return 1;
Hye-Shik Chang81268602004-02-02 06:05:24 +00001773#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001774 default:
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02001775 PyErr_SetString(PyExc_OSError, "getsockaddrlen: "
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001776 "unknown BT protocol");
1777 return 0;
Martin v. Löwis558d9bf2004-06-03 09:24:42 +00001778
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001779 }
1780 }
Martin v. Löwis12af0482004-01-31 12:34:17 +00001781#endif
1782
Martin v. Löwis1ba3fd52001-08-10 20:29:40 +00001783#ifdef HAVE_NETPACKET_PACKET_H
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001784 case AF_PACKET:
1785 {
1786 *len_ret = sizeof (struct sockaddr_ll);
1787 return 1;
1788 }
Jeremy Hylton22308652001-02-02 03:23:09 +00001789#endif
Guido van Rossum48a680c2001-03-02 06:34:14 +00001790
Christian Heimes043d6f62008-01-07 17:19:16 +00001791#ifdef HAVE_LINUX_TIPC_H
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001792 case AF_TIPC:
1793 {
1794 *len_ret = sizeof (struct sockaddr_tipc);
1795 return 1;
1796 }
Christian Heimes043d6f62008-01-07 17:19:16 +00001797#endif
1798
Charles-François Natali30589c92011-10-07 22:47:08 +02001799#ifdef AF_CAN
Charles-François Natali47413c12011-10-06 19:47:44 +02001800 case AF_CAN:
1801 {
1802 *len_ret = sizeof (struct sockaddr_can);
1803 return 1;
1804 }
1805#endif
Victor Stinnera534fc42013-06-03 22:07:27 +02001806
Martin v. Löwis9d6c6692012-02-03 17:44:58 +01001807#ifdef PF_SYSTEM
1808 case PF_SYSTEM:
1809 switch(s->sock_proto) {
1810#ifdef SYSPROTO_CONTROL
1811 case SYSPROTO_CONTROL:
1812 *len_ret = sizeof (struct sockaddr_ctl);
1813 return 1;
1814#endif
1815 default:
1816 PyErr_SetString(PyExc_OSError, "getsockaddrlen: "
1817 "unknown PF_SYSTEM protocol");
1818 return 0;
1819 }
1820#endif
Charles-François Natali47413c12011-10-06 19:47:44 +02001821
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001822 /* More cases here... */
Guido van Rossum710e1df1992-06-12 10:39:36 +00001823
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001824 default:
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02001825 PyErr_SetString(PyExc_OSError, "getsockaddrlen: bad family");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001826 return 0;
Guido van Rossum710e1df1992-06-12 10:39:36 +00001827
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001828 }
Guido van Rossum710e1df1992-06-12 10:39:36 +00001829}
1830
1831
Nick Coghlan96fe56a2011-08-22 11:55:57 +10001832/* Support functions for the sendmsg() and recvmsg[_into]() methods.
1833 Currently, these methods are only compiled if the RFC 2292/3542
1834 CMSG_LEN() macro is available. Older systems seem to have used
1835 sizeof(struct cmsghdr) + (length) where CMSG_LEN() is used now, so
1836 it may be possible to define CMSG_LEN() that way if it's not
1837 provided. Some architectures might need extra padding after the
1838 cmsghdr, however, and CMSG_LEN() would have to take account of
1839 this. */
1840#ifdef CMSG_LEN
1841/* If length is in range, set *result to CMSG_LEN(length) and return
1842 true; otherwise, return false. */
1843static int
1844get_CMSG_LEN(size_t length, size_t *result)
1845{
1846 size_t tmp;
1847
1848 if (length > (SOCKLEN_T_LIMIT - CMSG_LEN(0)))
1849 return 0;
1850 tmp = CMSG_LEN(length);
1851 if (tmp > SOCKLEN_T_LIMIT || tmp < length)
1852 return 0;
1853 *result = tmp;
1854 return 1;
1855}
1856
1857#ifdef CMSG_SPACE
1858/* If length is in range, set *result to CMSG_SPACE(length) and return
1859 true; otherwise, return false. */
1860static int
1861get_CMSG_SPACE(size_t length, size_t *result)
1862{
1863 size_t tmp;
1864
1865 /* Use CMSG_SPACE(1) here in order to take account of the padding
1866 necessary before *and* after the data. */
1867 if (length > (SOCKLEN_T_LIMIT - CMSG_SPACE(1)))
1868 return 0;
1869 tmp = CMSG_SPACE(length);
1870 if (tmp > SOCKLEN_T_LIMIT || tmp < length)
1871 return 0;
1872 *result = tmp;
1873 return 1;
1874}
1875#endif
1876
1877/* Return true iff msg->msg_controllen is valid, cmsgh is a valid
1878 pointer in msg->msg_control with at least "space" bytes after it,
1879 and its cmsg_len member inside the buffer. */
1880static int
1881cmsg_min_space(struct msghdr *msg, struct cmsghdr *cmsgh, size_t space)
1882{
1883 size_t cmsg_offset;
1884 static const size_t cmsg_len_end = (offsetof(struct cmsghdr, cmsg_len) +
1885 sizeof(cmsgh->cmsg_len));
1886
Charles-François Natali466517d2011-08-28 18:23:43 +02001887 /* Note that POSIX allows msg_controllen to be of signed type. */
Brett Cannonb05cbe62014-01-07 17:01:01 -05001888 if (cmsgh == NULL || msg->msg_control == NULL)
Nick Coghlan96fe56a2011-08-22 11:55:57 +10001889 return 0;
Brett Cannonb05cbe62014-01-07 17:01:01 -05001890 /* Note that POSIX allows msg_controllen to be of a signed type. This is
1891 annoying under OS X as it's unsigned there and so it triggers a
1892 tautological comparison warning under Clang when compared against 0.
1893 Since the check is valid on other platforms, silence the warning under
1894 Clang. */
1895 #ifdef __clang__
1896 #pragma clang diagnostic push
1897 #pragma clang diagnostic ignored "-Wtautological-compare"
1898 #endif
1899 if (msg->msg_controllen < 0)
1900 return 0;
1901 #ifdef __clang__
1902 #pragma clang diagnostic pop
1903 #endif
Nick Coghlan96fe56a2011-08-22 11:55:57 +10001904 if (space < cmsg_len_end)
1905 space = cmsg_len_end;
1906 cmsg_offset = (char *)cmsgh - (char *)msg->msg_control;
1907 return (cmsg_offset <= (size_t)-1 - space &&
1908 cmsg_offset + space <= msg->msg_controllen);
1909}
1910
1911/* If pointer CMSG_DATA(cmsgh) is in buffer msg->msg_control, set
1912 *space to number of bytes following it in the buffer and return
1913 true; otherwise, return false. Assumes cmsgh, msg->msg_control and
1914 msg->msg_controllen are valid. */
1915static int
1916get_cmsg_data_space(struct msghdr *msg, struct cmsghdr *cmsgh, size_t *space)
1917{
1918 size_t data_offset;
1919 char *data_ptr;
1920
1921 if ((data_ptr = (char *)CMSG_DATA(cmsgh)) == NULL)
1922 return 0;
1923 data_offset = data_ptr - (char *)msg->msg_control;
1924 if (data_offset > msg->msg_controllen)
1925 return 0;
1926 *space = msg->msg_controllen - data_offset;
1927 return 1;
1928}
1929
1930/* If cmsgh is invalid or not contained in the buffer pointed to by
1931 msg->msg_control, return -1. If cmsgh is valid and its associated
1932 data is entirely contained in the buffer, set *data_len to the
1933 length of the associated data and return 0. If only part of the
1934 associated data is contained in the buffer but cmsgh is otherwise
1935 valid, set *data_len to the length contained in the buffer and
1936 return 1. */
1937static int
1938get_cmsg_data_len(struct msghdr *msg, struct cmsghdr *cmsgh, size_t *data_len)
1939{
1940 size_t space, cmsg_data_len;
1941
1942 if (!cmsg_min_space(msg, cmsgh, CMSG_LEN(0)) ||
1943 cmsgh->cmsg_len < CMSG_LEN(0))
1944 return -1;
1945 cmsg_data_len = cmsgh->cmsg_len - CMSG_LEN(0);
1946 if (!get_cmsg_data_space(msg, cmsgh, &space))
1947 return -1;
1948 if (space >= cmsg_data_len) {
1949 *data_len = cmsg_data_len;
1950 return 0;
1951 }
1952 *data_len = space;
1953 return 1;
1954}
1955#endif /* CMSG_LEN */
1956
1957
Guido van Rossum39eb8fa2007-11-16 01:24:05 +00001958/* s._accept() -> (fd, address) */
Guido van Rossum30a685f1991-06-27 15:51:29 +00001959
Guido van Rossum73624e91994-10-10 17:59:00 +00001960static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00001961sock_accept(PySocketSockObject *s)
Guido van Rossum6574b3e1991-06-25 21:36:08 +00001962{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001963 sock_addr_t addrbuf;
1964 SOCKET_T newfd = INVALID_SOCKET;
1965 socklen_t addrlen;
1966 PyObject *sock = NULL;
1967 PyObject *addr = NULL;
1968 PyObject *res = NULL;
1969 int timeout;
Victor Stinnerdaf45552013-08-28 00:53:59 +02001970#if defined(HAVE_ACCEPT4) && defined(SOCK_CLOEXEC)
1971 /* accept4() is available on Linux 2.6.28+ and glibc 2.10 */
1972 static int accept4_works = -1;
1973#endif
1974
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001975 if (!getsockaddrlen(s, &addrlen))
1976 return NULL;
1977 memset(&addrbuf, 0, addrlen);
Guido van Rossum67f7a382002-06-06 21:08:16 +00001978
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001979 if (!IS_SELECTABLE(s))
1980 return select_error();
Neal Norwitz082b2df2006-02-07 07:04:46 +00001981
Antoine Pitrou3e1fd272010-09-28 21:23:11 +00001982 BEGIN_SELECT_LOOP(s)
Victor Stinnerdaf45552013-08-28 00:53:59 +02001983
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001984 Py_BEGIN_ALLOW_THREADS
Antoine Pitrou3e1fd272010-09-28 21:23:11 +00001985 timeout = internal_select_ex(s, 0, interval);
Antoine Pitroub1c54962010-10-14 15:05:38 +00001986 if (!timeout) {
Victor Stinnerdaf45552013-08-28 00:53:59 +02001987#if defined(HAVE_ACCEPT4) && defined(SOCK_CLOEXEC)
1988 if (accept4_works != 0) {
1989 newfd = accept4(s->sock_fd, SAS2SA(&addrbuf), &addrlen,
1990 SOCK_CLOEXEC);
1991 if (newfd == INVALID_SOCKET && accept4_works == -1) {
1992 /* On Linux older than 2.6.28, accept4() fails with ENOSYS */
1993 accept4_works = (errno != ENOSYS);
1994 }
1995 }
1996 if (accept4_works == 0)
1997 newfd = accept(s->sock_fd, SAS2SA(&addrbuf), &addrlen);
1998#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001999 newfd = accept(s->sock_fd, SAS2SA(&addrbuf), &addrlen);
Victor Stinnerdaf45552013-08-28 00:53:59 +02002000#endif
Antoine Pitroub1c54962010-10-14 15:05:38 +00002001 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002002 Py_END_ALLOW_THREADS
Guido van Rossum67f7a382002-06-06 21:08:16 +00002003
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002004 if (timeout == 1) {
2005 PyErr_SetString(socket_timeout, "timed out");
2006 return NULL;
2007 }
Antoine Pitrou3e1fd272010-09-28 21:23:11 +00002008 END_SELECT_LOOP(s)
Raymond Hettingeref7343c2003-06-29 03:08:05 +00002009
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002010 if (newfd == INVALID_SOCKET)
2011 return s->errorhandler();
Barry Warsaw752300b1997-01-03 17:18:10 +00002012
Victor Stinnerdaf45552013-08-28 00:53:59 +02002013#ifdef MS_WINDOWS
2014 if (!SetHandleInformation((HANDLE)newfd, HANDLE_FLAG_INHERIT, 0)) {
2015 PyErr_SetFromWindowsErr(0);
2016 SOCKETCLOSE(newfd);
2017 goto finally;
2018 }
2019#else
2020
2021#if defined(HAVE_ACCEPT4) && defined(SOCK_CLOEXEC)
2022 if (!accept4_works)
2023#endif
2024 {
2025 if (_Py_set_inheritable(newfd, 0, NULL) < 0) {
2026 SOCKETCLOSE(newfd);
2027 goto finally;
2028 }
2029 }
2030#endif
2031
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002032 sock = PyLong_FromSocket_t(newfd);
2033 if (sock == NULL) {
2034 SOCKETCLOSE(newfd);
2035 goto finally;
2036 }
Guido van Rossum39eb8fa2007-11-16 01:24:05 +00002037
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002038 addr = makesockaddr(s->sock_fd, SAS2SA(&addrbuf),
2039 addrlen, s->sock_proto);
2040 if (addr == NULL)
2041 goto finally;
Barry Warsaw752300b1997-01-03 17:18:10 +00002042
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002043 res = PyTuple_Pack(2, sock, addr);
Barry Warsaw752300b1997-01-03 17:18:10 +00002044
Guido van Rossum67f7a382002-06-06 21:08:16 +00002045finally:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002046 Py_XDECREF(sock);
2047 Py_XDECREF(addr);
2048 return res;
Guido van Rossum6574b3e1991-06-25 21:36:08 +00002049}
2050
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002051PyDoc_STRVAR(accept_doc,
Guido van Rossum39eb8fa2007-11-16 01:24:05 +00002052"_accept() -> (integer, address info)\n\
Guido van Rossum82a5c661998-07-07 20:45:43 +00002053\n\
Guido van Rossum39eb8fa2007-11-16 01:24:05 +00002054Wait for an incoming connection. Return a new socket file descriptor\n\
2055representing the connection, and the address of the client.\n\
2056For IP sockets, the address info is a pair (hostaddr, port).");
Guido van Rossum82a5c661998-07-07 20:45:43 +00002057
Guido van Rossum11ba0942002-06-13 15:07:44 +00002058/* s.setblocking(flag) method. Argument:
2059 False -- non-blocking mode; same as settimeout(0)
2060 True -- blocking mode; same as settimeout(None)
2061*/
Guido van Rossume4485b01994-09-07 14:32:49 +00002062
Guido van Rossum73624e91994-10-10 17:59:00 +00002063static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00002064sock_setblocking(PySocketSockObject *s, PyObject *arg)
Guido van Rossume4485b01994-09-07 14:32:49 +00002065{
Serhiy Storchaka78980432013-01-15 01:12:17 +02002066 long block;
Guido van Rossum67f7a382002-06-06 21:08:16 +00002067
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002068 block = PyLong_AsLong(arg);
2069 if (block == -1 && PyErr_Occurred())
2070 return NULL;
Guido van Rossum67f7a382002-06-06 21:08:16 +00002071
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002072 s->sock_timeout = block ? -1.0 : 0.0;
2073 internal_setblocking(s, block);
Guido van Rossume4485b01994-09-07 14:32:49 +00002074
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002075 Py_INCREF(Py_None);
2076 return Py_None;
Guido van Rossume4485b01994-09-07 14:32:49 +00002077}
Guido van Rossume4485b01994-09-07 14:32:49 +00002078
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002079PyDoc_STRVAR(setblocking_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00002080"setblocking(flag)\n\
2081\n\
2082Set the socket to blocking (flag is true) or non-blocking (false).\n\
Guido van Rossum11ba0942002-06-13 15:07:44 +00002083setblocking(True) is equivalent to settimeout(None);\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002084setblocking(False) is equivalent to settimeout(0.0).");
Guido van Rossum82a5c661998-07-07 20:45:43 +00002085
Guido van Rossum11ba0942002-06-13 15:07:44 +00002086/* s.settimeout(timeout) method. Argument:
2087 None -- no timeout, blocking mode; same as setblocking(True)
2088 0.0 -- non-blocking mode; same as setblocking(False)
2089 > 0 -- timeout mode; operations time out after timeout seconds
2090 < 0 -- illegal; raises an exception
2091*/
Guido van Rossum67f7a382002-06-06 21:08:16 +00002092static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00002093sock_settimeout(PySocketSockObject *s, PyObject *arg)
Guido van Rossum67f7a382002-06-06 21:08:16 +00002094{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002095 double timeout;
Guido van Rossum67f7a382002-06-06 21:08:16 +00002096
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002097 if (arg == Py_None)
2098 timeout = -1.0;
2099 else {
2100 timeout = PyFloat_AsDouble(arg);
2101 if (timeout < 0.0) {
2102 if (!PyErr_Occurred())
2103 PyErr_SetString(PyExc_ValueError,
2104 "Timeout value out of range");
2105 return NULL;
2106 }
2107 }
Guido van Rossum67f7a382002-06-06 21:08:16 +00002108
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002109 s->sock_timeout = timeout;
2110 internal_setblocking(s, timeout < 0.0);
Guido van Rossum67f7a382002-06-06 21:08:16 +00002111
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002112 Py_INCREF(Py_None);
2113 return Py_None;
Guido van Rossum67f7a382002-06-06 21:08:16 +00002114}
2115
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002116PyDoc_STRVAR(settimeout_doc,
Guido van Rossum3eede5a2002-06-07 02:08:35 +00002117"settimeout(timeout)\n\
Guido van Rossum67f7a382002-06-06 21:08:16 +00002118\n\
Guido van Rossum11ba0942002-06-13 15:07:44 +00002119Set a timeout on socket operations. 'timeout' can be a float,\n\
2120giving in seconds, or None. Setting a timeout of None disables\n\
2121the timeout feature and is equivalent to setblocking(1).\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002122Setting a timeout of zero is the same as setblocking(0).");
Guido van Rossum67f7a382002-06-06 21:08:16 +00002123
Guido van Rossum3eede5a2002-06-07 02:08:35 +00002124/* s.gettimeout() method.
2125 Returns the timeout associated with a socket. */
Guido van Rossum67f7a382002-06-06 21:08:16 +00002126static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00002127sock_gettimeout(PySocketSockObject *s)
Guido van Rossum67f7a382002-06-06 21:08:16 +00002128{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002129 if (s->sock_timeout < 0.0) {
2130 Py_INCREF(Py_None);
2131 return Py_None;
2132 }
2133 else
2134 return PyFloat_FromDouble(s->sock_timeout);
Guido van Rossum67f7a382002-06-06 21:08:16 +00002135}
2136
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002137PyDoc_STRVAR(gettimeout_doc,
Guido van Rossum22a97152002-08-08 20:37:08 +00002138"gettimeout() -> timeout\n\
Guido van Rossum67f7a382002-06-06 21:08:16 +00002139\n\
Ezio Melotti388c9452011-08-14 08:28:57 +03002140Returns the timeout in seconds (float) associated with socket \n\
Guido van Rossum67f7a382002-06-06 21:08:16 +00002141operations. A timeout of None indicates that timeouts on socket \n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002142operations are disabled.");
Guido van Rossume4485b01994-09-07 14:32:49 +00002143
Guido van Rossumaee08791992-09-08 09:05:33 +00002144/* s.setsockopt() method.
2145 With an integer third argument, sets an integer option.
2146 With a string third argument, sets an option from a buffer;
2147 use optional built-in module 'struct' to encode the string. */
Guido van Rossum0e69587d1992-06-05 15:11:30 +00002148
Guido van Rossum73624e91994-10-10 17:59:00 +00002149static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00002150sock_setsockopt(PySocketSockObject *s, PyObject *args)
Guido van Rossum0e69587d1992-06-05 15:11:30 +00002151{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002152 int level;
2153 int optname;
2154 int res;
2155 char *buf;
2156 int buflen;
2157 int flag;
Guido van Rossum0e69587d1992-06-05 15:11:30 +00002158
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002159 if (PyArg_ParseTuple(args, "iii:setsockopt",
2160 &level, &optname, &flag)) {
2161 buf = (char *) &flag;
2162 buflen = sizeof flag;
2163 }
2164 else {
2165 PyErr_Clear();
2166 if (!PyArg_ParseTuple(args, "iiy#:setsockopt",
2167 &level, &optname, &buf, &buflen))
2168 return NULL;
2169 }
2170 res = setsockopt(s->sock_fd, level, optname, (void *)buf, buflen);
2171 if (res < 0)
2172 return s->errorhandler();
2173 Py_INCREF(Py_None);
2174 return Py_None;
Guido van Rossum0e69587d1992-06-05 15:11:30 +00002175}
2176
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002177PyDoc_STRVAR(setsockopt_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00002178"setsockopt(level, option, value)\n\
2179\n\
2180Set a socket option. See the Unix manual for level and option.\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002181The value argument can either be an integer or a string.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00002182
Guido van Rossum0e69587d1992-06-05 15:11:30 +00002183
Guido van Rossumaee08791992-09-08 09:05:33 +00002184/* s.getsockopt() method.
2185 With two arguments, retrieves an integer option.
2186 With a third integer argument, retrieves a string buffer of that size;
2187 use optional built-in module 'struct' to decode the string. */
Guido van Rossum0e69587d1992-06-05 15:11:30 +00002188
Guido van Rossum73624e91994-10-10 17:59:00 +00002189static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00002190sock_getsockopt(PySocketSockObject *s, PyObject *args)
Guido van Rossum0e69587d1992-06-05 15:11:30 +00002191{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002192 int level;
2193 int optname;
2194 int res;
2195 PyObject *buf;
2196 socklen_t buflen = 0;
Guido van Rossum0e69587d1992-06-05 15:11:30 +00002197
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002198 if (!PyArg_ParseTuple(args, "ii|i:getsockopt",
2199 &level, &optname, &buflen))
2200 return NULL;
Guido van Rossum48a680c2001-03-02 06:34:14 +00002201
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002202 if (buflen == 0) {
2203 int flag = 0;
2204 socklen_t flagsize = sizeof flag;
2205 res = getsockopt(s->sock_fd, level, optname,
2206 (void *)&flag, &flagsize);
2207 if (res < 0)
2208 return s->errorhandler();
2209 return PyLong_FromLong(flag);
2210 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002211 if (buflen <= 0 || buflen > 1024) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02002212 PyErr_SetString(PyExc_OSError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002213 "getsockopt buflen out of range");
2214 return NULL;
2215 }
2216 buf = PyBytes_FromStringAndSize((char *)NULL, buflen);
2217 if (buf == NULL)
2218 return NULL;
2219 res = getsockopt(s->sock_fd, level, optname,
2220 (void *)PyBytes_AS_STRING(buf), &buflen);
2221 if (res < 0) {
2222 Py_DECREF(buf);
2223 return s->errorhandler();
2224 }
2225 _PyBytes_Resize(&buf, buflen);
2226 return buf;
Guido van Rossum0e69587d1992-06-05 15:11:30 +00002227}
2228
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002229PyDoc_STRVAR(getsockopt_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00002230"getsockopt(level, option[, buffersize]) -> value\n\
2231\n\
2232Get a socket option. See the Unix manual for level and option.\n\
2233If a nonzero buffersize argument is given, the return value is a\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002234string of that length; otherwise it is an integer.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00002235
Guido van Rossum0e69587d1992-06-05 15:11:30 +00002236
Fred Drake728819a2000-07-01 03:40:12 +00002237/* s.bind(sockaddr) method */
Guido van Rossum30a685f1991-06-27 15:51:29 +00002238
Guido van Rossum73624e91994-10-10 17:59:00 +00002239static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00002240sock_bind(PySocketSockObject *s, PyObject *addro)
Guido van Rossum6574b3e1991-06-25 21:36:08 +00002241{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002242 sock_addr_t addrbuf;
2243 int addrlen;
2244 int res;
Jeremy Hyltonae0013d2001-10-11 16:36:35 +00002245
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002246 if (!getsockaddrarg(s, addro, SAS2SA(&addrbuf), &addrlen))
2247 return NULL;
2248 Py_BEGIN_ALLOW_THREADS
2249 res = bind(s->sock_fd, SAS2SA(&addrbuf), addrlen);
2250 Py_END_ALLOW_THREADS
2251 if (res < 0)
2252 return s->errorhandler();
2253 Py_INCREF(Py_None);
2254 return Py_None;
Guido van Rossum6574b3e1991-06-25 21:36:08 +00002255}
2256
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002257PyDoc_STRVAR(bind_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00002258"bind(address)\n\
2259\n\
2260Bind the socket to a local address. For IP sockets, the address is a\n\
Jeremy Hylton22308652001-02-02 03:23:09 +00002261pair (host, port); the host must refer to the local host. For raw packet\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002262sockets the address is a tuple (ifname, proto [,pkttype [,hatype]])");
Guido van Rossum82a5c661998-07-07 20:45:43 +00002263
Guido van Rossum30a685f1991-06-27 15:51:29 +00002264
2265/* s.close() method.
2266 Set the file descriptor to -1 so operations tried subsequently
2267 will surely fail. */
2268
Guido van Rossum73624e91994-10-10 17:59:00 +00002269static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00002270sock_close(PySocketSockObject *s)
Guido van Rossum6574b3e1991-06-25 21:36:08 +00002271{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002272 SOCKET_T fd;
Jeremy Hyltonae0013d2001-10-11 16:36:35 +00002273
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002274 if ((fd = s->sock_fd) != -1) {
2275 s->sock_fd = -1;
2276 Py_BEGIN_ALLOW_THREADS
2277 (void) SOCKETCLOSE(fd);
2278 Py_END_ALLOW_THREADS
2279 }
2280 Py_INCREF(Py_None);
2281 return Py_None;
Guido van Rossum6574b3e1991-06-25 21:36:08 +00002282}
2283
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002284PyDoc_STRVAR(close_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00002285"close()\n\
2286\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002287Close the socket. It cannot be used after this call.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00002288
Antoine Pitroue43f9d02010-08-08 23:24:50 +00002289static PyObject *
Antoine Pitrou6e451df2010-08-09 20:39:54 +00002290sock_detach(PySocketSockObject *s)
Antoine Pitroue43f9d02010-08-08 23:24:50 +00002291{
Antoine Pitrou6e451df2010-08-09 20:39:54 +00002292 SOCKET_T fd = s->sock_fd;
Antoine Pitroue43f9d02010-08-08 23:24:50 +00002293 s->sock_fd = -1;
Antoine Pitrou6e451df2010-08-09 20:39:54 +00002294 return PyLong_FromSocket_t(fd);
Antoine Pitroue43f9d02010-08-08 23:24:50 +00002295}
2296
Antoine Pitrou6e451df2010-08-09 20:39:54 +00002297PyDoc_STRVAR(detach_doc,
2298"detach()\n\
Antoine Pitroue43f9d02010-08-08 23:24:50 +00002299\n\
Guido van Rossum638aebd2013-12-04 11:50:09 -08002300Close the socket object without closing the underlying file descriptor.\n\
2301The object cannot be used after this call, but the file descriptor\n\
Antoine Pitrou6e451df2010-08-09 20:39:54 +00002302can be reused for other purposes. The file descriptor is returned.");
Antoine Pitroue43f9d02010-08-08 23:24:50 +00002303
Guido van Rossum7b8bac12002-06-13 16:07:04 +00002304static int
Raymond Hettingeref7343c2003-06-29 03:08:05 +00002305internal_connect(PySocketSockObject *s, struct sockaddr *addr, int addrlen,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002306 int *timeoutp)
Guido van Rossum7b8bac12002-06-13 16:07:04 +00002307{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002308 int res, timeout;
Guido van Rossum7b8bac12002-06-13 16:07:04 +00002309
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002310 timeout = 0;
2311 res = connect(s->sock_fd, addr, addrlen);
Guido van Rossum7b8bac12002-06-13 16:07:04 +00002312
2313#ifdef MS_WINDOWS
2314
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002315 if (s->sock_timeout > 0.0) {
2316 if (res < 0 && WSAGetLastError() == WSAEWOULDBLOCK &&
2317 IS_SELECTABLE(s)) {
2318 /* This is a mess. Best solution: trust select */
2319 fd_set fds;
2320 fd_set fds_exc;
2321 struct timeval tv;
2322 tv.tv_sec = (int)s->sock_timeout;
2323 tv.tv_usec = (int)((s->sock_timeout - tv.tv_sec) * 1e6);
2324 FD_ZERO(&fds);
2325 FD_SET(s->sock_fd, &fds);
2326 FD_ZERO(&fds_exc);
2327 FD_SET(s->sock_fd, &fds_exc);
Antoine Pitrou19467d22010-08-17 19:33:30 +00002328 res = select(Py_SAFE_DOWNCAST(s->sock_fd+1, SOCKET_T, int),
2329 NULL, &fds, &fds_exc, &tv);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002330 if (res == 0) {
2331 res = WSAEWOULDBLOCK;
2332 timeout = 1;
2333 } else if (res > 0) {
2334 if (FD_ISSET(s->sock_fd, &fds))
2335 /* The socket is in the writable set - this
2336 means connected */
2337 res = 0;
2338 else {
2339 /* As per MS docs, we need to call getsockopt()
2340 to get the underlying error */
2341 int res_size = sizeof res;
2342 /* It must be in the exception set */
2343 assert(FD_ISSET(s->sock_fd, &fds_exc));
2344 if (0 == getsockopt(s->sock_fd, SOL_SOCKET, SO_ERROR,
2345 (char *)&res, &res_size))
2346 /* getsockopt also clears WSAGetLastError,
2347 so reset it back. */
2348 WSASetLastError(res);
2349 else
2350 res = WSAGetLastError();
2351 }
2352 }
2353 /* else if (res < 0) an error occurred */
2354 }
2355 }
Guido van Rossum7b8bac12002-06-13 16:07:04 +00002356
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002357 if (res < 0)
2358 res = WSAGetLastError();
Guido van Rossum7b8bac12002-06-13 16:07:04 +00002359
2360#else
2361
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002362 if (s->sock_timeout > 0.0) {
2363 if (res < 0 && errno == EINPROGRESS && IS_SELECTABLE(s)) {
2364 timeout = internal_select(s, 1);
2365 if (timeout == 0) {
2366 /* Bug #1019808: in case of an EINPROGRESS,
2367 use getsockopt(SO_ERROR) to get the real
2368 error. */
2369 socklen_t res_size = sizeof res;
2370 (void)getsockopt(s->sock_fd, SOL_SOCKET,
2371 SO_ERROR, &res, &res_size);
2372 if (res == EISCONN)
2373 res = 0;
2374 errno = res;
2375 }
2376 else if (timeout == -1) {
2377 res = errno; /* had error */
2378 }
2379 else
2380 res = EWOULDBLOCK; /* timed out */
2381 }
2382 }
Guido van Rossum7b8bac12002-06-13 16:07:04 +00002383
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002384 if (res < 0)
2385 res = errno;
Guido van Rossum7b8bac12002-06-13 16:07:04 +00002386
2387#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002388 *timeoutp = timeout;
Guido van Rossum7b8bac12002-06-13 16:07:04 +00002389
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002390 return res;
Guido van Rossum7b8bac12002-06-13 16:07:04 +00002391}
Guido van Rossum30a685f1991-06-27 15:51:29 +00002392
Fred Drake728819a2000-07-01 03:40:12 +00002393/* s.connect(sockaddr) method */
Guido van Rossum30a685f1991-06-27 15:51:29 +00002394
Guido van Rossum73624e91994-10-10 17:59:00 +00002395static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00002396sock_connect(PySocketSockObject *s, PyObject *addro)
Guido van Rossum6574b3e1991-06-25 21:36:08 +00002397{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002398 sock_addr_t addrbuf;
2399 int addrlen;
2400 int res;
2401 int timeout;
Jeremy Hyltonae0013d2001-10-11 16:36:35 +00002402
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002403 if (!getsockaddrarg(s, addro, SAS2SA(&addrbuf), &addrlen))
2404 return NULL;
Guido van Rossum67f7a382002-06-06 21:08:16 +00002405
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002406 Py_BEGIN_ALLOW_THREADS
2407 res = internal_connect(s, SAS2SA(&addrbuf), addrlen, &timeout);
2408 Py_END_ALLOW_THREADS
Guido van Rossum67f7a382002-06-06 21:08:16 +00002409
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002410 if (timeout == 1) {
2411 PyErr_SetString(socket_timeout, "timed out");
2412 return NULL;
2413 }
2414 if (res != 0)
2415 return s->errorhandler();
2416 Py_INCREF(Py_None);
2417 return Py_None;
Guido van Rossum6574b3e1991-06-25 21:36:08 +00002418}
2419
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002420PyDoc_STRVAR(connect_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00002421"connect(address)\n\
2422\n\
2423Connect the socket to a remote address. For IP sockets, the address\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002424is a pair (host, port).");
Guido van Rossum82a5c661998-07-07 20:45:43 +00002425
Guido van Rossum30a685f1991-06-27 15:51:29 +00002426
Fred Drake728819a2000-07-01 03:40:12 +00002427/* s.connect_ex(sockaddr) method */
Guido van Rossumfc4255d1997-11-19 18:57:13 +00002428
2429static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00002430sock_connect_ex(PySocketSockObject *s, PyObject *addro)
Guido van Rossumfc4255d1997-11-19 18:57:13 +00002431{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002432 sock_addr_t addrbuf;
2433 int addrlen;
2434 int res;
2435 int timeout;
Jeremy Hyltonae0013d2001-10-11 16:36:35 +00002436
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002437 if (!getsockaddrarg(s, addro, SAS2SA(&addrbuf), &addrlen))
2438 return NULL;
Guido van Rossum67f7a382002-06-06 21:08:16 +00002439
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002440 Py_BEGIN_ALLOW_THREADS
2441 res = internal_connect(s, SAS2SA(&addrbuf), addrlen, &timeout);
2442 Py_END_ALLOW_THREADS
Guido van Rossum67f7a382002-06-06 21:08:16 +00002443
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002444 /* Signals are not errors (though they may raise exceptions). Adapted
2445 from PyErr_SetFromErrnoWithFilenameObject(). */
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002446#ifdef EINTR
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002447 if (res == EINTR && PyErr_CheckSignals())
2448 return NULL;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002449#endif
2450
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002451 return PyLong_FromLong((long) res);
Guido van Rossumfc4255d1997-11-19 18:57:13 +00002452}
2453
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002454PyDoc_STRVAR(connect_ex_doc,
Guido van Rossum22a97152002-08-08 20:37:08 +00002455"connect_ex(address) -> errno\n\
Guido van Rossum82a5c661998-07-07 20:45:43 +00002456\n\
2457This is like connect(address), but returns an error code (the errno value)\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002458instead of raising an exception when an error occurs.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00002459
Guido van Rossumfc4255d1997-11-19 18:57:13 +00002460
Guido van Rossumed233a51992-06-23 09:07:03 +00002461/* s.fileno() method */
2462
Guido van Rossum73624e91994-10-10 17:59:00 +00002463static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00002464sock_fileno(PySocketSockObject *s)
Guido van Rossumed233a51992-06-23 09:07:03 +00002465{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002466 return PyLong_FromSocket_t(s->sock_fd);
Guido van Rossumed233a51992-06-23 09:07:03 +00002467}
2468
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002469PyDoc_STRVAR(fileno_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00002470"fileno() -> integer\n\
2471\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002472Return the integer file descriptor of the socket.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00002473
Guido van Rossumed233a51992-06-23 09:07:03 +00002474
Guido van Rossumc89705d1992-11-26 08:54:07 +00002475/* s.getsockname() method */
2476
Guido van Rossum73624e91994-10-10 17:59:00 +00002477static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00002478sock_getsockname(PySocketSockObject *s)
Guido van Rossumc89705d1992-11-26 08:54:07 +00002479{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002480 sock_addr_t addrbuf;
2481 int res;
2482 socklen_t addrlen;
Guido van Rossumff3ab422000-04-24 15:16:03 +00002483
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002484 if (!getsockaddrlen(s, &addrlen))
2485 return NULL;
2486 memset(&addrbuf, 0, addrlen);
2487 Py_BEGIN_ALLOW_THREADS
2488 res = getsockname(s->sock_fd, SAS2SA(&addrbuf), &addrlen);
2489 Py_END_ALLOW_THREADS
2490 if (res < 0)
2491 return s->errorhandler();
2492 return makesockaddr(s->sock_fd, SAS2SA(&addrbuf), addrlen,
2493 s->sock_proto);
Guido van Rossumc89705d1992-11-26 08:54:07 +00002494}
2495
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002496PyDoc_STRVAR(getsockname_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00002497"getsockname() -> address info\n\
2498\n\
2499Return the address of the local endpoint. For IP sockets, the address\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002500info is a pair (hostaddr, port).");
Guido van Rossum82a5c661998-07-07 20:45:43 +00002501
Guido van Rossumc89705d1992-11-26 08:54:07 +00002502
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002503#ifdef HAVE_GETPEERNAME /* Cray APP doesn't have this :-( */
Guido van Rossumc89705d1992-11-26 08:54:07 +00002504/* s.getpeername() method */
2505
Guido van Rossum73624e91994-10-10 17:59:00 +00002506static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00002507sock_getpeername(PySocketSockObject *s)
Guido van Rossumc89705d1992-11-26 08:54:07 +00002508{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002509 sock_addr_t addrbuf;
2510 int res;
2511 socklen_t addrlen;
Guido van Rossumff3ab422000-04-24 15:16:03 +00002512
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002513 if (!getsockaddrlen(s, &addrlen))
2514 return NULL;
2515 memset(&addrbuf, 0, addrlen);
2516 Py_BEGIN_ALLOW_THREADS
2517 res = getpeername(s->sock_fd, SAS2SA(&addrbuf), &addrlen);
2518 Py_END_ALLOW_THREADS
2519 if (res < 0)
2520 return s->errorhandler();
2521 return makesockaddr(s->sock_fd, SAS2SA(&addrbuf), addrlen,
2522 s->sock_proto);
Guido van Rossumc89705d1992-11-26 08:54:07 +00002523}
Guido van Rossum82a5c661998-07-07 20:45:43 +00002524
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002525PyDoc_STRVAR(getpeername_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00002526"getpeername() -> address info\n\
2527\n\
2528Return the address of the remote endpoint. For IP sockets, the address\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002529info is a pair (hostaddr, port).");
Guido van Rossum82a5c661998-07-07 20:45:43 +00002530
Guido van Rossumb6775db1994-08-01 11:34:53 +00002531#endif /* HAVE_GETPEERNAME */
Guido van Rossumc89705d1992-11-26 08:54:07 +00002532
2533
Guido van Rossum30a685f1991-06-27 15:51:29 +00002534/* s.listen(n) method */
2535
Guido van Rossum73624e91994-10-10 17:59:00 +00002536static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00002537sock_listen(PySocketSockObject *s, PyObject *arg)
Guido van Rossum6574b3e1991-06-25 21:36:08 +00002538{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002539 int backlog;
2540 int res;
Jeremy Hyltonae0013d2001-10-11 16:36:35 +00002541
Serhiy Storchaka78980432013-01-15 01:12:17 +02002542 backlog = _PyLong_AsInt(arg);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002543 if (backlog == -1 && PyErr_Occurred())
2544 return NULL;
2545 Py_BEGIN_ALLOW_THREADS
Antoine Pitrou1be815a2011-05-10 19:16:29 +02002546 /* To avoid problems on systems that don't allow a negative backlog
2547 * (which doesn't make sense anyway) we force a minimum value of 0. */
2548 if (backlog < 0)
2549 backlog = 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002550 res = listen(s->sock_fd, backlog);
2551 Py_END_ALLOW_THREADS
2552 if (res < 0)
2553 return s->errorhandler();
2554 Py_INCREF(Py_None);
2555 return Py_None;
Guido van Rossum6574b3e1991-06-25 21:36:08 +00002556}
2557
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002558PyDoc_STRVAR(listen_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00002559"listen(backlog)\n\
2560\n\
2561Enable a server to accept connections. The backlog argument must be at\n\
Antoine Pitrou1be815a2011-05-10 19:16:29 +02002562least 0 (if it is lower, it is set to 0); it specifies the number of\n\
2563unaccepted connections that the system will allow before refusing new\n\
2564connections.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00002565
2566
Thomas Wouters477c8d52006-05-27 19:21:47 +00002567/*
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00002568 * This is the guts of the recv() and recv_into() methods, which reads into a
Thomas Wouters902d6eb2007-01-09 23:18:33 +00002569 * char buffer. If you have any inc/dec ref to do to the objects that contain
Thomas Wouters477c8d52006-05-27 19:21:47 +00002570 * the buffer, do it in the caller. This function returns the number of bytes
Ezio Melotti13925002011-03-16 11:05:33 +02002571 * successfully read. If there was an error, it returns -1. Note that it is
Thomas Wouters477c8d52006-05-27 19:21:47 +00002572 * also possible that we return a number of bytes smaller than the request
2573 * bytes.
2574 */
Antoine Pitrou3e1fd272010-09-28 21:23:11 +00002575
Antoine Pitrou19467d22010-08-17 19:33:30 +00002576static Py_ssize_t
2577sock_recv_guts(PySocketSockObject *s, char* cbuf, Py_ssize_t len, int flags)
Thomas Wouters477c8d52006-05-27 19:21:47 +00002578{
Antoine Pitrou19467d22010-08-17 19:33:30 +00002579 Py_ssize_t outlen = -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002580 int timeout;
Thomas Wouters477c8d52006-05-27 19:21:47 +00002581
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002582 if (!IS_SELECTABLE(s)) {
2583 select_error();
2584 return -1;
2585 }
2586 if (len == 0) {
2587 /* If 0 bytes were requested, do nothing. */
2588 return 0;
2589 }
Thomas Wouters477c8d52006-05-27 19:21:47 +00002590
Antoine Pitrou3e1fd272010-09-28 21:23:11 +00002591 BEGIN_SELECT_LOOP(s)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002592 Py_BEGIN_ALLOW_THREADS
Antoine Pitrou3e1fd272010-09-28 21:23:11 +00002593 timeout = internal_select_ex(s, 0, interval);
Victor Stinner9a644b22013-06-24 23:47:41 +02002594 if (!timeout) {
Victor Stinner14b9b112013-06-25 00:37:25 +02002595#ifdef MS_WINDOWS
Victor Stinner9a644b22013-06-24 23:47:41 +02002596 if (len > INT_MAX)
2597 len = INT_MAX;
2598 outlen = recv(s->sock_fd, cbuf, (int)len, flags);
2599#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002600 outlen = recv(s->sock_fd, cbuf, len, flags);
Victor Stinner9a644b22013-06-24 23:47:41 +02002601#endif
2602 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002603 Py_END_ALLOW_THREADS
Thomas Wouters477c8d52006-05-27 19:21:47 +00002604
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002605 if (timeout == 1) {
2606 PyErr_SetString(socket_timeout, "timed out");
2607 return -1;
2608 }
Antoine Pitrou3e1fd272010-09-28 21:23:11 +00002609 END_SELECT_LOOP(s)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002610 if (outlen < 0) {
2611 /* Note: the call to errorhandler() ALWAYS indirectly returned
2612 NULL, so ignore its return value */
2613 s->errorhandler();
2614 return -1;
2615 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002616 return outlen;
Thomas Wouters477c8d52006-05-27 19:21:47 +00002617}
2618
Guido van Rossum48a680c2001-03-02 06:34:14 +00002619
Guido van Rossumeb6b33a1993-05-25 09:38:27 +00002620/* s.recv(nbytes [,flags]) method */
Guido van Rossum30a685f1991-06-27 15:51:29 +00002621
Guido van Rossum73624e91994-10-10 17:59:00 +00002622static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00002623sock_recv(PySocketSockObject *s, PyObject *args)
Guido van Rossum30a685f1991-06-27 15:51:29 +00002624{
Antoine Pitrou19467d22010-08-17 19:33:30 +00002625 Py_ssize_t recvlen, outlen;
2626 int flags = 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002627 PyObject *buf;
Guido van Rossum67f7a382002-06-06 21:08:16 +00002628
Antoine Pitrou19467d22010-08-17 19:33:30 +00002629 if (!PyArg_ParseTuple(args, "n|i:recv", &recvlen, &flags))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002630 return NULL;
Guido van Rossum67f7a382002-06-06 21:08:16 +00002631
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002632 if (recvlen < 0) {
2633 PyErr_SetString(PyExc_ValueError,
2634 "negative buffersize in recv");
2635 return NULL;
2636 }
Guido van Rossum67f7a382002-06-06 21:08:16 +00002637
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002638 /* Allocate a new string. */
2639 buf = PyBytes_FromStringAndSize((char *) 0, recvlen);
2640 if (buf == NULL)
2641 return NULL;
Guido van Rossum67f7a382002-06-06 21:08:16 +00002642
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002643 /* Call the guts */
2644 outlen = sock_recv_guts(s, PyBytes_AS_STRING(buf), recvlen, flags);
2645 if (outlen < 0) {
2646 /* An error occurred, release the string and return an
2647 error. */
2648 Py_DECREF(buf);
2649 return NULL;
2650 }
2651 if (outlen != recvlen) {
2652 /* We did not read as many bytes as we anticipated, resize the
2653 string if possible and be successful. */
2654 _PyBytes_Resize(&buf, outlen);
2655 }
Martin v. Löwis79acb9e2002-12-06 12:48:53 +00002656
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002657 return buf;
Guido van Rossum6574b3e1991-06-25 21:36:08 +00002658}
2659
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002660PyDoc_STRVAR(recv_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00002661"recv(buffersize[, flags]) -> data\n\
2662\n\
2663Receive up to buffersize bytes from the socket. For the optional flags\n\
2664argument, see the Unix manual. When no data is available, block until\n\
2665at least one byte is available or until the remote end is closed. When\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002666the remote end is closed and all data is read, return the empty string.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00002667
Guido van Rossum30a685f1991-06-27 15:51:29 +00002668
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00002669/* s.recv_into(buffer, [nbytes [,flags]]) method */
Guido van Rossum30a685f1991-06-27 15:51:29 +00002670
Thomas Wouters477c8d52006-05-27 19:21:47 +00002671static PyObject*
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00002672sock_recv_into(PySocketSockObject *s, PyObject *args, PyObject *kwds)
Thomas Wouters477c8d52006-05-27 19:21:47 +00002673{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002674 static char *kwlist[] = {"buffer", "nbytes", "flags", 0};
Thomas Wouters477c8d52006-05-27 19:21:47 +00002675
Antoine Pitrou19467d22010-08-17 19:33:30 +00002676 int flags = 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002677 Py_buffer pbuf;
2678 char *buf;
Antoine Pitrou19467d22010-08-17 19:33:30 +00002679 Py_ssize_t buflen, readlen, recvlen = 0;
Thomas Wouters477c8d52006-05-27 19:21:47 +00002680
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002681 /* Get the buffer's memory */
Antoine Pitrou19467d22010-08-17 19:33:30 +00002682 if (!PyArg_ParseTupleAndKeywords(args, kwds, "w*|ni:recv_into", kwlist,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002683 &pbuf, &recvlen, &flags))
2684 return NULL;
2685 buf = pbuf.buf;
2686 buflen = pbuf.len;
Thomas Wouters477c8d52006-05-27 19:21:47 +00002687
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002688 if (recvlen < 0) {
2689 PyBuffer_Release(&pbuf);
2690 PyErr_SetString(PyExc_ValueError,
2691 "negative buffersize in recv_into");
2692 return NULL;
2693 }
2694 if (recvlen == 0) {
2695 /* If nbytes was not specified, use the buffer's length */
2696 recvlen = buflen;
2697 }
Thomas Wouters477c8d52006-05-27 19:21:47 +00002698
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002699 /* Check if the buffer is large enough */
2700 if (buflen < recvlen) {
2701 PyBuffer_Release(&pbuf);
2702 PyErr_SetString(PyExc_ValueError,
2703 "buffer too small for requested bytes");
2704 return NULL;
2705 }
Thomas Wouters477c8d52006-05-27 19:21:47 +00002706
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002707 /* Call the guts */
2708 readlen = sock_recv_guts(s, buf, recvlen, flags);
2709 if (readlen < 0) {
2710 /* Return an error. */
2711 PyBuffer_Release(&pbuf);
2712 return NULL;
2713 }
Thomas Wouters477c8d52006-05-27 19:21:47 +00002714
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002715 PyBuffer_Release(&pbuf);
2716 /* Return the number of bytes read. Note that we do not do anything
2717 special here in the case that readlen < recvlen. */
2718 return PyLong_FromSsize_t(readlen);
Thomas Wouters477c8d52006-05-27 19:21:47 +00002719}
2720
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00002721PyDoc_STRVAR(recv_into_doc,
2722"recv_into(buffer, [nbytes[, flags]]) -> nbytes_read\n\
Thomas Wouters477c8d52006-05-27 19:21:47 +00002723\n\
2724A version of recv() that stores its data into a buffer rather than creating \n\
2725a new string. Receive up to buffersize bytes from the socket. If buffersize \n\
2726is not specified (or 0), receive up to the size available in the given buffer.\n\
2727\n\
2728See recv() for documentation about the flags.");
2729
2730
2731/*
Christian Heimes99170a52007-12-19 02:07:34 +00002732 * This is the guts of the recvfrom() and recvfrom_into() methods, which reads
2733 * into a char buffer. If you have any inc/def ref to do to the objects that
2734 * contain the buffer, do it in the caller. This function returns the number
Ezio Melotti13925002011-03-16 11:05:33 +02002735 * of bytes successfully read. If there was an error, it returns -1. Note
Christian Heimes99170a52007-12-19 02:07:34 +00002736 * that it is also possible that we return a number of bytes smaller than the
2737 * request bytes.
Thomas Wouters477c8d52006-05-27 19:21:47 +00002738 *
2739 * 'addr' is a return value for the address object. Note that you must decref
2740 * it yourself.
2741 */
Antoine Pitrou19467d22010-08-17 19:33:30 +00002742static Py_ssize_t
2743sock_recvfrom_guts(PySocketSockObject *s, char* cbuf, Py_ssize_t len, int flags,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002744 PyObject** addr)
Guido van Rossum6574b3e1991-06-25 21:36:08 +00002745{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002746 sock_addr_t addrbuf;
2747 int timeout;
Antoine Pitrou19467d22010-08-17 19:33:30 +00002748 Py_ssize_t n = -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002749 socklen_t addrlen;
Guido van Rossum67f7a382002-06-06 21:08:16 +00002750
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002751 *addr = NULL;
Guido van Rossum67f7a382002-06-06 21:08:16 +00002752
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002753 if (!getsockaddrlen(s, &addrlen))
2754 return -1;
Guido van Rossum67f7a382002-06-06 21:08:16 +00002755
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002756 if (!IS_SELECTABLE(s)) {
2757 select_error();
2758 return -1;
2759 }
Neal Norwitz082b2df2006-02-07 07:04:46 +00002760
Antoine Pitrou3e1fd272010-09-28 21:23:11 +00002761 BEGIN_SELECT_LOOP(s)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002762 Py_BEGIN_ALLOW_THREADS
2763 memset(&addrbuf, 0, addrlen);
Antoine Pitrou3e1fd272010-09-28 21:23:11 +00002764 timeout = internal_select_ex(s, 0, interval);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002765 if (!timeout) {
Victor Stinnere990c6e2013-11-16 00:18:58 +01002766#ifdef MS_WINDOWS
Victor Stinner9a644b22013-06-24 23:47:41 +02002767 if (len > INT_MAX)
2768 len = INT_MAX;
2769 n = recvfrom(s->sock_fd, cbuf, (int)len, flags,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002770 (void *) &addrbuf, &addrlen);
Guido van Rossum6a3eb5f1994-08-18 15:42:46 +00002771#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002772 n = recvfrom(s->sock_fd, cbuf, len, flags,
2773 SAS2SA(&addrbuf), &addrlen);
Guido van Rossum6a3eb5f1994-08-18 15:42:46 +00002774#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002775 }
2776 Py_END_ALLOW_THREADS
Guido van Rossum67f7a382002-06-06 21:08:16 +00002777
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002778 if (timeout == 1) {
2779 PyErr_SetString(socket_timeout, "timed out");
2780 return -1;
2781 }
Antoine Pitrou3e1fd272010-09-28 21:23:11 +00002782 END_SELECT_LOOP(s)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002783 if (n < 0) {
2784 s->errorhandler();
2785 return -1;
2786 }
Guido van Rossum67f7a382002-06-06 21:08:16 +00002787
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002788 if (!(*addr = makesockaddr(s->sock_fd, SAS2SA(&addrbuf),
2789 addrlen, s->sock_proto)))
2790 return -1;
Thomas Wouters477c8d52006-05-27 19:21:47 +00002791
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002792 return n;
Thomas Wouters477c8d52006-05-27 19:21:47 +00002793}
2794
2795/* s.recvfrom(nbytes [,flags]) method */
2796
2797static PyObject *
2798sock_recvfrom(PySocketSockObject *s, PyObject *args)
2799{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002800 PyObject *buf = NULL;
2801 PyObject *addr = NULL;
2802 PyObject *ret = NULL;
Antoine Pitrou19467d22010-08-17 19:33:30 +00002803 int flags = 0;
2804 Py_ssize_t recvlen, outlen;
Thomas Wouters477c8d52006-05-27 19:21:47 +00002805
Antoine Pitrou19467d22010-08-17 19:33:30 +00002806 if (!PyArg_ParseTuple(args, "n|i:recvfrom", &recvlen, &flags))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002807 return NULL;
Guido van Rossum48a680c2001-03-02 06:34:14 +00002808
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002809 if (recvlen < 0) {
2810 PyErr_SetString(PyExc_ValueError,
2811 "negative buffersize in recvfrom");
2812 return NULL;
2813 }
Guido van Rossumd8faa362007-04-27 19:54:29 +00002814
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002815 buf = PyBytes_FromStringAndSize((char *) 0, recvlen);
2816 if (buf == NULL)
2817 return NULL;
Thomas Wouters477c8d52006-05-27 19:21:47 +00002818
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002819 outlen = sock_recvfrom_guts(s, PyBytes_AS_STRING(buf),
2820 recvlen, flags, &addr);
2821 if (outlen < 0) {
2822 goto finally;
2823 }
Thomas Wouters477c8d52006-05-27 19:21:47 +00002824
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002825 if (outlen != recvlen) {
2826 /* We did not read as many bytes as we anticipated, resize the
Ezio Melotti13925002011-03-16 11:05:33 +02002827 string if possible and be successful. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002828 if (_PyBytes_Resize(&buf, outlen) < 0)
Ezio Melotti13925002011-03-16 11:05:33 +02002829 /* Oopsy, not so successful after all. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002830 goto finally;
2831 }
Barry Warsaw752300b1997-01-03 17:18:10 +00002832
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002833 ret = PyTuple_Pack(2, buf, addr);
Guido van Rossum67f7a382002-06-06 21:08:16 +00002834
2835finally:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002836 Py_XDECREF(buf);
2837 Py_XDECREF(addr);
2838 return ret;
Guido van Rossum6574b3e1991-06-25 21:36:08 +00002839}
2840
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002841PyDoc_STRVAR(recvfrom_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00002842"recvfrom(buffersize[, flags]) -> (data, address info)\n\
2843\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002844Like recv(buffersize, flags) but also return the sender's address info.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00002845
Thomas Wouters477c8d52006-05-27 19:21:47 +00002846
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00002847/* s.recvfrom_into(buffer[, nbytes [,flags]]) method */
Thomas Wouters477c8d52006-05-27 19:21:47 +00002848
2849static PyObject *
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00002850sock_recvfrom_into(PySocketSockObject *s, PyObject *args, PyObject* kwds)
Thomas Wouters477c8d52006-05-27 19:21:47 +00002851{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002852 static char *kwlist[] = {"buffer", "nbytes", "flags", 0};
Thomas Wouters477c8d52006-05-27 19:21:47 +00002853
Antoine Pitrou19467d22010-08-17 19:33:30 +00002854 int flags = 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002855 Py_buffer pbuf;
2856 char *buf;
Antoine Pitrou19467d22010-08-17 19:33:30 +00002857 Py_ssize_t readlen, buflen, recvlen = 0;
Thomas Wouters477c8d52006-05-27 19:21:47 +00002858
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002859 PyObject *addr = NULL;
Thomas Wouters477c8d52006-05-27 19:21:47 +00002860
Antoine Pitrou19467d22010-08-17 19:33:30 +00002861 if (!PyArg_ParseTupleAndKeywords(args, kwds, "w*|ni:recvfrom_into",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002862 kwlist, &pbuf,
2863 &recvlen, &flags))
2864 return NULL;
2865 buf = pbuf.buf;
2866 buflen = pbuf.len;
2867 assert(buf != 0 && buflen > 0);
Thomas Wouters477c8d52006-05-27 19:21:47 +00002868
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002869 if (recvlen < 0) {
2870 PyBuffer_Release(&pbuf);
2871 PyErr_SetString(PyExc_ValueError,
2872 "negative buffersize in recvfrom_into");
2873 return NULL;
2874 }
2875 if (recvlen == 0) {
2876 /* If nbytes was not specified, use the buffer's length */
2877 recvlen = buflen;
2878 }
Thomas Wouters477c8d52006-05-27 19:21:47 +00002879
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002880 readlen = sock_recvfrom_guts(s, buf, recvlen, flags, &addr);
2881 if (readlen < 0) {
2882 PyBuffer_Release(&pbuf);
2883 /* Return an error */
2884 Py_XDECREF(addr);
2885 return NULL;
2886 }
Thomas Wouters477c8d52006-05-27 19:21:47 +00002887
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002888 PyBuffer_Release(&pbuf);
2889 /* Return the number of bytes read and the address. Note that we do
2890 not do anything special here in the case that readlen < recvlen. */
Antoine Pitrou19467d22010-08-17 19:33:30 +00002891 return Py_BuildValue("nN", readlen, addr);
Thomas Wouters477c8d52006-05-27 19:21:47 +00002892}
2893
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00002894PyDoc_STRVAR(recvfrom_into_doc,
2895"recvfrom_into(buffer[, nbytes[, flags]]) -> (nbytes, address info)\n\
Thomas Wouters477c8d52006-05-27 19:21:47 +00002896\n\
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00002897Like recv_into(buffer[, nbytes[, flags]]) but also return the sender's address info.");
Thomas Wouters477c8d52006-05-27 19:21:47 +00002898
2899
Nick Coghlan96fe56a2011-08-22 11:55:57 +10002900/* The sendmsg() and recvmsg[_into]() methods require a working
2901 CMSG_LEN(). See the comment near get_CMSG_LEN(). */
2902#ifdef CMSG_LEN
2903/*
2904 * Call recvmsg() with the supplied iovec structures, flags, and
2905 * ancillary data buffer size (controllen). Returns the tuple return
2906 * value for recvmsg() or recvmsg_into(), with the first item provided
2907 * by the supplied makeval() function. makeval() will be called with
2908 * the length read and makeval_data as arguments, and must return a
2909 * new reference (which will be decrefed if there is a subsequent
2910 * error). On error, closes any file descriptors received via
2911 * SCM_RIGHTS.
2912 */
2913static PyObject *
2914sock_recvmsg_guts(PySocketSockObject *s, struct iovec *iov, int iovlen,
2915 int flags, Py_ssize_t controllen,
2916 PyObject *(*makeval)(ssize_t, void *), void *makeval_data)
2917{
2918 ssize_t bytes_received = -1;
2919 int timeout;
2920 sock_addr_t addrbuf;
2921 socklen_t addrbuflen;
Charles-François Natalie9e95ae2011-08-24 21:40:53 +02002922 struct msghdr msg = {0};
Nick Coghlan96fe56a2011-08-22 11:55:57 +10002923 PyObject *cmsg_list = NULL, *retval = NULL;
2924 void *controlbuf = NULL;
2925 struct cmsghdr *cmsgh;
2926 size_t cmsgdatalen = 0;
2927 int cmsg_status;
2928
2929 /* XXX: POSIX says that msg_name and msg_namelen "shall be
2930 ignored" when the socket is connected (Linux fills them in
2931 anyway for AF_UNIX sockets at least). Normally msg_namelen
2932 seems to be set to 0 if there's no address, but try to
2933 initialize msg_name to something that won't be mistaken for a
2934 real address if that doesn't happen. */
2935 if (!getsockaddrlen(s, &addrbuflen))
2936 return NULL;
2937 memset(&addrbuf, 0, addrbuflen);
2938 SAS2SA(&addrbuf)->sa_family = AF_UNSPEC;
2939
2940 if (controllen < 0 || controllen > SOCKLEN_T_LIMIT) {
2941 PyErr_SetString(PyExc_ValueError,
2942 "invalid ancillary data buffer length");
2943 return NULL;
2944 }
2945 if (controllen > 0 && (controlbuf = PyMem_Malloc(controllen)) == NULL)
2946 return PyErr_NoMemory();
2947
2948 /* Make the system call. */
2949 if (!IS_SELECTABLE(s)) {
2950 select_error();
2951 goto finally;
2952 }
2953
2954 BEGIN_SELECT_LOOP(s)
2955 Py_BEGIN_ALLOW_THREADS;
Nick Coghlan96fe56a2011-08-22 11:55:57 +10002956 msg.msg_name = SAS2SA(&addrbuf);
2957 msg.msg_namelen = addrbuflen;
2958 msg.msg_iov = iov;
2959 msg.msg_iovlen = iovlen;
2960 msg.msg_control = controlbuf;
2961 msg.msg_controllen = controllen;
2962 timeout = internal_select_ex(s, 0, interval);
2963 if (!timeout)
2964 bytes_received = recvmsg(s->sock_fd, &msg, flags);
2965 Py_END_ALLOW_THREADS;
2966 if (timeout == 1) {
2967 PyErr_SetString(socket_timeout, "timed out");
2968 goto finally;
2969 }
2970 END_SELECT_LOOP(s)
2971
2972 if (bytes_received < 0) {
2973 s->errorhandler();
2974 goto finally;
2975 }
2976
2977 /* Make list of (level, type, data) tuples from control messages. */
2978 if ((cmsg_list = PyList_New(0)) == NULL)
2979 goto err_closefds;
2980 /* Check for empty ancillary data as old CMSG_FIRSTHDR()
2981 implementations didn't do so. */
2982 for (cmsgh = ((msg.msg_controllen > 0) ? CMSG_FIRSTHDR(&msg) : NULL);
2983 cmsgh != NULL; cmsgh = CMSG_NXTHDR(&msg, cmsgh)) {
2984 PyObject *bytes, *tuple;
2985 int tmp;
2986
2987 cmsg_status = get_cmsg_data_len(&msg, cmsgh, &cmsgdatalen);
2988 if (cmsg_status != 0) {
2989 if (PyErr_WarnEx(PyExc_RuntimeWarning,
2990 "received malformed or improperly-truncated "
2991 "ancillary data", 1) == -1)
2992 goto err_closefds;
2993 }
2994 if (cmsg_status < 0)
2995 break;
2996 if (cmsgdatalen > PY_SSIZE_T_MAX) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02002997 PyErr_SetString(PyExc_OSError, "control message too long");
Nick Coghlan96fe56a2011-08-22 11:55:57 +10002998 goto err_closefds;
2999 }
3000
3001 bytes = PyBytes_FromStringAndSize((char *)CMSG_DATA(cmsgh),
3002 cmsgdatalen);
3003 tuple = Py_BuildValue("iiN", (int)cmsgh->cmsg_level,
3004 (int)cmsgh->cmsg_type, bytes);
3005 if (tuple == NULL)
3006 goto err_closefds;
3007 tmp = PyList_Append(cmsg_list, tuple);
3008 Py_DECREF(tuple);
3009 if (tmp != 0)
3010 goto err_closefds;
3011
3012 if (cmsg_status != 0)
3013 break;
3014 }
3015
3016 retval = Py_BuildValue("NOiN",
3017 (*makeval)(bytes_received, makeval_data),
3018 cmsg_list,
3019 (int)msg.msg_flags,
3020 makesockaddr(s->sock_fd, SAS2SA(&addrbuf),
3021 ((msg.msg_namelen > addrbuflen) ?
3022 addrbuflen : msg.msg_namelen),
3023 s->sock_proto));
3024 if (retval == NULL)
3025 goto err_closefds;
3026
3027finally:
3028 Py_XDECREF(cmsg_list);
3029 PyMem_Free(controlbuf);
3030 return retval;
3031
3032err_closefds:
3033#ifdef SCM_RIGHTS
3034 /* Close all descriptors coming from SCM_RIGHTS, so they don't leak. */
3035 for (cmsgh = ((msg.msg_controllen > 0) ? CMSG_FIRSTHDR(&msg) : NULL);
3036 cmsgh != NULL; cmsgh = CMSG_NXTHDR(&msg, cmsgh)) {
3037 cmsg_status = get_cmsg_data_len(&msg, cmsgh, &cmsgdatalen);
3038 if (cmsg_status < 0)
3039 break;
3040 if (cmsgh->cmsg_level == SOL_SOCKET &&
3041 cmsgh->cmsg_type == SCM_RIGHTS) {
3042 size_t numfds;
3043 int *fdp;
3044
3045 numfds = cmsgdatalen / sizeof(int);
3046 fdp = (int *)CMSG_DATA(cmsgh);
3047 while (numfds-- > 0)
3048 close(*fdp++);
3049 }
3050 if (cmsg_status != 0)
3051 break;
3052 }
3053#endif /* SCM_RIGHTS */
3054 goto finally;
3055}
3056
3057
3058static PyObject *
3059makeval_recvmsg(ssize_t received, void *data)
3060{
3061 PyObject **buf = data;
3062
3063 if (received < PyBytes_GET_SIZE(*buf))
3064 _PyBytes_Resize(buf, received);
3065 Py_XINCREF(*buf);
3066 return *buf;
3067}
3068
3069/* s.recvmsg(bufsize[, ancbufsize[, flags]]) method */
3070
3071static PyObject *
3072sock_recvmsg(PySocketSockObject *s, PyObject *args)
3073{
3074 Py_ssize_t bufsize, ancbufsize = 0;
3075 int flags = 0;
3076 struct iovec iov;
3077 PyObject *buf = NULL, *retval = NULL;
3078
3079 if (!PyArg_ParseTuple(args, "n|ni:recvmsg", &bufsize, &ancbufsize, &flags))
3080 return NULL;
3081
3082 if (bufsize < 0) {
3083 PyErr_SetString(PyExc_ValueError, "negative buffer size in recvmsg()");
3084 return NULL;
3085 }
3086 if ((buf = PyBytes_FromStringAndSize(NULL, bufsize)) == NULL)
3087 return NULL;
3088 iov.iov_base = PyBytes_AS_STRING(buf);
3089 iov.iov_len = bufsize;
3090
3091 /* Note that we're passing a pointer to *our pointer* to the bytes
3092 object here (&buf); makeval_recvmsg() may incref the object, or
3093 deallocate it and set our pointer to NULL. */
3094 retval = sock_recvmsg_guts(s, &iov, 1, flags, ancbufsize,
3095 &makeval_recvmsg, &buf);
3096 Py_XDECREF(buf);
3097 return retval;
3098}
3099
3100PyDoc_STRVAR(recvmsg_doc,
3101"recvmsg(bufsize[, ancbufsize[, flags]]) -> (data, ancdata, msg_flags, address)\n\
3102\n\
3103Receive normal data (up to bufsize bytes) and ancillary data from the\n\
3104socket. The ancbufsize argument sets the size in bytes of the\n\
3105internal buffer used to receive the ancillary data; it defaults to 0,\n\
3106meaning that no ancillary data will be received. Appropriate buffer\n\
3107sizes for ancillary data can be calculated using CMSG_SPACE() or\n\
3108CMSG_LEN(), and items which do not fit into the buffer might be\n\
3109truncated or discarded. The flags argument defaults to 0 and has the\n\
3110same meaning as for recv().\n\
3111\n\
3112The return value is a 4-tuple: (data, ancdata, msg_flags, address).\n\
3113The data item is a bytes object holding the non-ancillary data\n\
3114received. The ancdata item is a list of zero or more tuples\n\
3115(cmsg_level, cmsg_type, cmsg_data) representing the ancillary data\n\
3116(control messages) received: cmsg_level and cmsg_type are integers\n\
3117specifying the protocol level and protocol-specific type respectively,\n\
3118and cmsg_data is a bytes object holding the associated data. The\n\
3119msg_flags item is the bitwise OR of various flags indicating\n\
3120conditions on the received message; see your system documentation for\n\
3121details. If the receiving socket is unconnected, address is the\n\
3122address of the sending socket, if available; otherwise, its value is\n\
3123unspecified.\n\
3124\n\
3125If recvmsg() raises an exception after the system call returns, it\n\
3126will first attempt to close any file descriptors received via the\n\
3127SCM_RIGHTS mechanism.");
3128
3129
3130static PyObject *
3131makeval_recvmsg_into(ssize_t received, void *data)
3132{
3133 return PyLong_FromSsize_t(received);
3134}
3135
3136/* s.recvmsg_into(buffers[, ancbufsize[, flags]]) method */
3137
3138static PyObject *
3139sock_recvmsg_into(PySocketSockObject *s, PyObject *args)
3140{
3141 Py_ssize_t ancbufsize = 0;
3142 int flags = 0;
3143 struct iovec *iovs = NULL;
3144 Py_ssize_t i, nitems, nbufs = 0;
3145 Py_buffer *bufs = NULL;
3146 PyObject *buffers_arg, *fast, *retval = NULL;
3147
3148 if (!PyArg_ParseTuple(args, "O|ni:recvmsg_into",
3149 &buffers_arg, &ancbufsize, &flags))
3150 return NULL;
3151
3152 if ((fast = PySequence_Fast(buffers_arg,
3153 "recvmsg_into() argument 1 must be an "
3154 "iterable")) == NULL)
3155 return NULL;
3156 nitems = PySequence_Fast_GET_SIZE(fast);
3157 if (nitems > INT_MAX) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02003158 PyErr_SetString(PyExc_OSError, "recvmsg_into() argument 1 is too long");
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003159 goto finally;
3160 }
3161
3162 /* Fill in an iovec for each item, and save the Py_buffer
3163 structs to release afterwards. */
3164 if (nitems > 0 && ((iovs = PyMem_New(struct iovec, nitems)) == NULL ||
3165 (bufs = PyMem_New(Py_buffer, nitems)) == NULL)) {
3166 PyErr_NoMemory();
3167 goto finally;
3168 }
3169 for (; nbufs < nitems; nbufs++) {
3170 if (!PyArg_Parse(PySequence_Fast_GET_ITEM(fast, nbufs),
3171 "w*;recvmsg_into() argument 1 must be an iterable "
3172 "of single-segment read-write buffers",
3173 &bufs[nbufs]))
3174 goto finally;
3175 iovs[nbufs].iov_base = bufs[nbufs].buf;
3176 iovs[nbufs].iov_len = bufs[nbufs].len;
3177 }
3178
3179 retval = sock_recvmsg_guts(s, iovs, nitems, flags, ancbufsize,
3180 &makeval_recvmsg_into, NULL);
3181finally:
3182 for (i = 0; i < nbufs; i++)
3183 PyBuffer_Release(&bufs[i]);
3184 PyMem_Free(bufs);
3185 PyMem_Free(iovs);
3186 Py_DECREF(fast);
3187 return retval;
3188}
3189
3190PyDoc_STRVAR(recvmsg_into_doc,
3191"recvmsg_into(buffers[, ancbufsize[, flags]]) -> (nbytes, ancdata, msg_flags, address)\n\
3192\n\
3193Receive normal data and ancillary data from the socket, scattering the\n\
3194non-ancillary data into a series of buffers. The buffers argument\n\
3195must be an iterable of objects that export writable buffers\n\
3196(e.g. bytearray objects); these will be filled with successive chunks\n\
3197of the non-ancillary data until it has all been written or there are\n\
3198no more buffers. The ancbufsize argument sets the size in bytes of\n\
3199the internal buffer used to receive the ancillary data; it defaults to\n\
32000, meaning that no ancillary data will be received. Appropriate\n\
3201buffer sizes for ancillary data can be calculated using CMSG_SPACE()\n\
3202or CMSG_LEN(), and items which do not fit into the buffer might be\n\
3203truncated or discarded. The flags argument defaults to 0 and has the\n\
3204same meaning as for recv().\n\
3205\n\
3206The return value is a 4-tuple: (nbytes, ancdata, msg_flags, address).\n\
3207The nbytes item is the total number of bytes of non-ancillary data\n\
3208written into the buffers. The ancdata item is a list of zero or more\n\
3209tuples (cmsg_level, cmsg_type, cmsg_data) representing the ancillary\n\
3210data (control messages) received: cmsg_level and cmsg_type are\n\
3211integers specifying the protocol level and protocol-specific type\n\
3212respectively, and cmsg_data is a bytes object holding the associated\n\
3213data. The msg_flags item is the bitwise OR of various flags\n\
3214indicating conditions on the received message; see your system\n\
3215documentation for details. If the receiving socket is unconnected,\n\
3216address is the address of the sending socket, if available; otherwise,\n\
3217its value is unspecified.\n\
3218\n\
3219If recvmsg_into() raises an exception after the system call returns,\n\
3220it will first attempt to close any file descriptors received via the\n\
3221SCM_RIGHTS mechanism.");
3222#endif /* CMSG_LEN */
3223
3224
Guido van Rossumeb6b33a1993-05-25 09:38:27 +00003225/* s.send(data [,flags]) method */
Guido van Rossum30a685f1991-06-27 15:51:29 +00003226
Guido van Rossum73624e91994-10-10 17:59:00 +00003227static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00003228sock_send(PySocketSockObject *s, PyObject *args)
Guido van Rossum30a685f1991-06-27 15:51:29 +00003229{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003230 char *buf;
Antoine Pitrou19467d22010-08-17 19:33:30 +00003231 Py_ssize_t len, n = -1;
3232 int flags = 0, timeout;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003233 Py_buffer pbuf;
Guido van Rossum67f7a382002-06-06 21:08:16 +00003234
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003235 if (!PyArg_ParseTuple(args, "y*|i:send", &pbuf, &flags))
3236 return NULL;
Guido van Rossum67f7a382002-06-06 21:08:16 +00003237
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003238 if (!IS_SELECTABLE(s)) {
3239 PyBuffer_Release(&pbuf);
3240 return select_error();
3241 }
3242 buf = pbuf.buf;
3243 len = pbuf.len;
Neal Norwitz082b2df2006-02-07 07:04:46 +00003244
Antoine Pitrou3e1fd272010-09-28 21:23:11 +00003245 BEGIN_SELECT_LOOP(s)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003246 Py_BEGIN_ALLOW_THREADS
Antoine Pitrou3e1fd272010-09-28 21:23:11 +00003247 timeout = internal_select_ex(s, 1, interval);
Victor Stinner9a644b22013-06-24 23:47:41 +02003248 if (!timeout) {
Christian Heimesaf01f662013-12-21 16:19:10 +01003249#ifdef MS_WINDOWS
Victor Stinner9a644b22013-06-24 23:47:41 +02003250 if (len > INT_MAX)
3251 len = INT_MAX;
3252 n = send(s->sock_fd, buf, (int)len, flags);
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003253#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003254 n = send(s->sock_fd, buf, len, flags);
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003255#endif
Victor Stinner9a644b22013-06-24 23:47:41 +02003256 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003257 Py_END_ALLOW_THREADS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003258 if (timeout == 1) {
Antoine Pitrou3e1fd272010-09-28 21:23:11 +00003259 PyBuffer_Release(&pbuf);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003260 PyErr_SetString(socket_timeout, "timed out");
3261 return NULL;
3262 }
Antoine Pitrou3e1fd272010-09-28 21:23:11 +00003263 END_SELECT_LOOP(s)
3264
3265 PyBuffer_Release(&pbuf);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003266 if (n < 0)
3267 return s->errorhandler();
Antoine Pitrou19467d22010-08-17 19:33:30 +00003268 return PyLong_FromSsize_t(n);
Guido van Rossum30a685f1991-06-27 15:51:29 +00003269}
3270
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003271PyDoc_STRVAR(send_doc,
Guido van Rossum9f7a5392001-10-26 03:25:00 +00003272"send(data[, flags]) -> count\n\
Guido van Rossum82a5c661998-07-07 20:45:43 +00003273\n\
3274Send a data string to the socket. For the optional flags\n\
Guido van Rossum9f7a5392001-10-26 03:25:00 +00003275argument, see the Unix manual. Return the number of bytes\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003276sent; this may be less than len(data) if the network is busy.");
Guido van Rossum9f7a5392001-10-26 03:25:00 +00003277
3278
3279/* s.sendall(data [,flags]) method */
3280
3281static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00003282sock_sendall(PySocketSockObject *s, PyObject *args)
Guido van Rossum9f7a5392001-10-26 03:25:00 +00003283{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003284 char *buf;
Antoine Pitrou19467d22010-08-17 19:33:30 +00003285 Py_ssize_t len, n = -1;
Antoine Pitrou6d7df632010-09-27 17:52:25 +00003286 int flags = 0, timeout, saved_errno;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003287 Py_buffer pbuf;
Guido van Rossum67f7a382002-06-06 21:08:16 +00003288
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003289 if (!PyArg_ParseTuple(args, "y*|i:sendall", &pbuf, &flags))
3290 return NULL;
3291 buf = pbuf.buf;
3292 len = pbuf.len;
Guido van Rossum67f7a382002-06-06 21:08:16 +00003293
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003294 if (!IS_SELECTABLE(s)) {
3295 PyBuffer_Release(&pbuf);
3296 return select_error();
3297 }
Neal Norwitz082b2df2006-02-07 07:04:46 +00003298
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003299 do {
Antoine Pitrou6d7df632010-09-27 17:52:25 +00003300 Py_BEGIN_ALLOW_THREADS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003301 timeout = internal_select(s, 1);
3302 n = -1;
Antoine Pitrou6d7df632010-09-27 17:52:25 +00003303 if (!timeout) {
Christian Heimesaf01f662013-12-21 16:19:10 +01003304#ifdef MS_WINDOWS
Victor Stinner9a644b22013-06-24 23:47:41 +02003305 if (len > INT_MAX)
3306 len = INT_MAX;
3307 n = send(s->sock_fd, buf, (int)len, flags);
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003308#else
Antoine Pitrou6d7df632010-09-27 17:52:25 +00003309 n = send(s->sock_fd, buf, len, flags);
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003310#endif
Antoine Pitrou6d7df632010-09-27 17:52:25 +00003311 }
3312 Py_END_ALLOW_THREADS
3313 if (timeout == 1) {
3314 PyBuffer_Release(&pbuf);
3315 PyErr_SetString(socket_timeout, "timed out");
3316 return NULL;
3317 }
3318 /* PyErr_CheckSignals() might change errno */
3319 saved_errno = errno;
3320 /* We must run our signal handlers before looping again.
3321 send() can return a successful partial write when it is
3322 interrupted, so we can't restrict ourselves to EINTR. */
3323 if (PyErr_CheckSignals()) {
3324 PyBuffer_Release(&pbuf);
3325 return NULL;
3326 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003327 if (n < 0) {
Antoine Pitrou6d7df632010-09-27 17:52:25 +00003328 /* If interrupted, try again */
3329 if (saved_errno == EINTR)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003330 continue;
Antoine Pitrou6d7df632010-09-27 17:52:25 +00003331 else
3332 break;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003333 }
3334 buf += n;
3335 len -= n;
3336 } while (len > 0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003337 PyBuffer_Release(&pbuf);
Guido van Rossum67f7a382002-06-06 21:08:16 +00003338
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003339 if (n < 0)
3340 return s->errorhandler();
Guido van Rossum67f7a382002-06-06 21:08:16 +00003341
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003342 Py_INCREF(Py_None);
3343 return Py_None;
Guido van Rossum9f7a5392001-10-26 03:25:00 +00003344}
3345
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003346PyDoc_STRVAR(sendall_doc,
Guido van Rossum9f7a5392001-10-26 03:25:00 +00003347"sendall(data[, flags])\n\
3348\n\
3349Send a data string to the socket. For the optional flags\n\
3350argument, see the Unix manual. This calls send() repeatedly\n\
3351until all data is sent. If an error occurs, it's impossible\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003352to tell how much data has been sent.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00003353
Guido van Rossum30a685f1991-06-27 15:51:29 +00003354
Guido van Rossumeb6b33a1993-05-25 09:38:27 +00003355/* s.sendto(data, [flags,] sockaddr) method */
Guido van Rossum30a685f1991-06-27 15:51:29 +00003356
Guido van Rossum73624e91994-10-10 17:59:00 +00003357static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00003358sock_sendto(PySocketSockObject *s, PyObject *args)
Guido van Rossum6574b3e1991-06-25 21:36:08 +00003359{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003360 Py_buffer pbuf;
3361 PyObject *addro;
3362 char *buf;
Antoine Pitrou5e981412011-03-17 22:38:37 +01003363 Py_ssize_t len, arglen;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003364 sock_addr_t addrbuf;
3365 int addrlen, n = -1, flags, timeout;
Guido van Rossum67f7a382002-06-06 21:08:16 +00003366
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003367 flags = 0;
Antoine Pitrou5e981412011-03-17 22:38:37 +01003368 arglen = PyTuple_Size(args);
3369 switch (arglen) {
3370 case 2:
3371 PyArg_ParseTuple(args, "y*O:sendto", &pbuf, &addro);
3372 break;
3373 case 3:
3374 PyArg_ParseTuple(args, "y*iO:sendto",
3375 &pbuf, &flags, &addro);
3376 break;
3377 default:
3378 PyErr_Format(PyExc_TypeError,
3379 "sendto() takes 2 or 3 arguments (%d given)",
3380 arglen);
Victor Stinner77af1722011-05-26 14:05:59 +02003381 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003382 }
Antoine Pitrou5e981412011-03-17 22:38:37 +01003383 if (PyErr_Occurred())
3384 return NULL;
3385
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003386 buf = pbuf.buf;
3387 len = pbuf.len;
Guido van Rossum67f7a382002-06-06 21:08:16 +00003388
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003389 if (!IS_SELECTABLE(s)) {
3390 PyBuffer_Release(&pbuf);
3391 return select_error();
3392 }
Neal Norwitz082b2df2006-02-07 07:04:46 +00003393
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003394 if (!getsockaddrarg(s, addro, SAS2SA(&addrbuf), &addrlen)) {
3395 PyBuffer_Release(&pbuf);
3396 return NULL;
3397 }
Thomas Wouters89f507f2006-12-13 04:49:30 +00003398
Antoine Pitrou3e1fd272010-09-28 21:23:11 +00003399 BEGIN_SELECT_LOOP(s)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003400 Py_BEGIN_ALLOW_THREADS
Antoine Pitrou3e1fd272010-09-28 21:23:11 +00003401 timeout = internal_select_ex(s, 1, interval);
Victor Stinner9a644b22013-06-24 23:47:41 +02003402 if (!timeout) {
Victor Stinner14b9b112013-06-25 00:37:25 +02003403#ifdef MS_WINDOWS
Victor Stinner9a644b22013-06-24 23:47:41 +02003404 if (len > INT_MAX)
3405 len = INT_MAX;
3406 n = sendto(s->sock_fd, buf, (int)len, flags,
3407 SAS2SA(&addrbuf), addrlen);
3408#else
3409 n = sendto(s->sock_fd, buf, len, flags,
3410 SAS2SA(&addrbuf), addrlen);
3411#endif
3412 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003413 Py_END_ALLOW_THREADS
Guido van Rossum67f7a382002-06-06 21:08:16 +00003414
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003415 if (timeout == 1) {
Antoine Pitrou3e1fd272010-09-28 21:23:11 +00003416 PyBuffer_Release(&pbuf);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003417 PyErr_SetString(socket_timeout, "timed out");
3418 return NULL;
3419 }
Antoine Pitrou3e1fd272010-09-28 21:23:11 +00003420 END_SELECT_LOOP(s)
3421 PyBuffer_Release(&pbuf);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003422 if (n < 0)
3423 return s->errorhandler();
Antoine Pitrou19467d22010-08-17 19:33:30 +00003424 return PyLong_FromSsize_t(n);
Guido van Rossum6574b3e1991-06-25 21:36:08 +00003425}
3426
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003427PyDoc_STRVAR(sendto_doc,
Guido van Rossum22a97152002-08-08 20:37:08 +00003428"sendto(data[, flags], address) -> count\n\
Guido van Rossum82a5c661998-07-07 20:45:43 +00003429\n\
3430Like send(data, flags) but allows specifying the destination address.\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003431For IP sockets, the address is a pair (hostaddr, port).");
Guido van Rossum82a5c661998-07-07 20:45:43 +00003432
Guido van Rossum30a685f1991-06-27 15:51:29 +00003433
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003434/* The sendmsg() and recvmsg[_into]() methods require a working
3435 CMSG_LEN(). See the comment near get_CMSG_LEN(). */
3436#ifdef CMSG_LEN
3437/* s.sendmsg(buffers[, ancdata[, flags[, address]]]) method */
3438
3439static PyObject *
3440sock_sendmsg(PySocketSockObject *s, PyObject *args)
3441{
3442 Py_ssize_t i, ndataparts, ndatabufs = 0, ncmsgs, ncmsgbufs = 0;
3443 Py_buffer *databufs = NULL;
3444 struct iovec *iovs = NULL;
3445 sock_addr_t addrbuf;
Charles-François Natalie9e95ae2011-08-24 21:40:53 +02003446 struct msghdr msg = {0};
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003447 struct cmsginfo {
3448 int level;
3449 int type;
3450 Py_buffer data;
3451 } *cmsgs = NULL;
3452 void *controlbuf = NULL;
3453 size_t controllen, controllen_last;
3454 ssize_t bytes_sent = -1;
3455 int addrlen, timeout, flags = 0;
3456 PyObject *data_arg, *cmsg_arg = NULL, *addr_arg = NULL, *data_fast = NULL,
3457 *cmsg_fast = NULL, *retval = NULL;
3458
3459 if (!PyArg_ParseTuple(args, "O|OiO:sendmsg",
3460 &data_arg, &cmsg_arg, &flags, &addr_arg))
3461 return NULL;
3462
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003463 /* Parse destination address. */
3464 if (addr_arg != NULL && addr_arg != Py_None) {
3465 if (!getsockaddrarg(s, addr_arg, SAS2SA(&addrbuf), &addrlen))
3466 goto finally;
3467 msg.msg_name = &addrbuf;
3468 msg.msg_namelen = addrlen;
3469 }
3470
3471 /* Fill in an iovec for each message part, and save the Py_buffer
3472 structs to release afterwards. */
3473 if ((data_fast = PySequence_Fast(data_arg,
3474 "sendmsg() argument 1 must be an "
3475 "iterable")) == NULL)
3476 goto finally;
3477 ndataparts = PySequence_Fast_GET_SIZE(data_fast);
3478 if (ndataparts > INT_MAX) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02003479 PyErr_SetString(PyExc_OSError, "sendmsg() argument 1 is too long");
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003480 goto finally;
3481 }
3482 msg.msg_iovlen = ndataparts;
3483 if (ndataparts > 0 &&
3484 ((msg.msg_iov = iovs = PyMem_New(struct iovec, ndataparts)) == NULL ||
3485 (databufs = PyMem_New(Py_buffer, ndataparts)) == NULL)) {
3486 PyErr_NoMemory();
3487 goto finally;
3488 }
3489 for (; ndatabufs < ndataparts; ndatabufs++) {
3490 if (!PyArg_Parse(PySequence_Fast_GET_ITEM(data_fast, ndatabufs),
3491 "y*;sendmsg() argument 1 must be an iterable of "
3492 "buffer-compatible objects",
3493 &databufs[ndatabufs]))
3494 goto finally;
3495 iovs[ndatabufs].iov_base = databufs[ndatabufs].buf;
3496 iovs[ndatabufs].iov_len = databufs[ndatabufs].len;
3497 }
3498
3499 if (cmsg_arg == NULL)
3500 ncmsgs = 0;
3501 else {
3502 if ((cmsg_fast = PySequence_Fast(cmsg_arg,
3503 "sendmsg() argument 2 must be an "
3504 "iterable")) == NULL)
3505 goto finally;
3506 ncmsgs = PySequence_Fast_GET_SIZE(cmsg_fast);
3507 }
3508
3509#ifndef CMSG_SPACE
3510 if (ncmsgs > 1) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02003511 PyErr_SetString(PyExc_OSError,
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003512 "sending multiple control messages is not supported "
3513 "on this system");
3514 goto finally;
3515 }
3516#endif
3517 /* Save level, type and Py_buffer for each control message,
3518 and calculate total size. */
3519 if (ncmsgs > 0 && (cmsgs = PyMem_New(struct cmsginfo, ncmsgs)) == NULL) {
3520 PyErr_NoMemory();
3521 goto finally;
3522 }
3523 controllen = controllen_last = 0;
3524 while (ncmsgbufs < ncmsgs) {
3525 size_t bufsize, space;
3526
3527 if (!PyArg_Parse(PySequence_Fast_GET_ITEM(cmsg_fast, ncmsgbufs),
3528 "(iiy*):[sendmsg() ancillary data items]",
3529 &cmsgs[ncmsgbufs].level,
3530 &cmsgs[ncmsgbufs].type,
3531 &cmsgs[ncmsgbufs].data))
3532 goto finally;
3533 bufsize = cmsgs[ncmsgbufs++].data.len;
3534
3535#ifdef CMSG_SPACE
3536 if (!get_CMSG_SPACE(bufsize, &space)) {
3537#else
3538 if (!get_CMSG_LEN(bufsize, &space)) {
3539#endif
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02003540 PyErr_SetString(PyExc_OSError, "ancillary data item too large");
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003541 goto finally;
3542 }
3543 controllen += space;
3544 if (controllen > SOCKLEN_T_LIMIT || controllen < controllen_last) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02003545 PyErr_SetString(PyExc_OSError, "too much ancillary data");
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003546 goto finally;
3547 }
3548 controllen_last = controllen;
3549 }
3550
3551 /* Construct ancillary data block from control message info. */
3552 if (ncmsgbufs > 0) {
3553 struct cmsghdr *cmsgh = NULL;
3554
3555 if ((msg.msg_control = controlbuf =
3556 PyMem_Malloc(controllen)) == NULL) {
3557 PyErr_NoMemory();
3558 goto finally;
3559 }
3560 msg.msg_controllen = controllen;
3561
3562 /* Need to zero out the buffer as a workaround for glibc's
3563 CMSG_NXTHDR() implementation. After getting the pointer to
3564 the next header, it checks its (uninitialized) cmsg_len
3565 member to see if the "message" fits in the buffer, and
3566 returns NULL if it doesn't. Zero-filling the buffer
Terry Jan Reedy0f847642013-03-11 18:34:00 -04003567 ensures that this doesn't happen. */
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003568 memset(controlbuf, 0, controllen);
3569
3570 for (i = 0; i < ncmsgbufs; i++) {
3571 size_t msg_len, data_len = cmsgs[i].data.len;
3572 int enough_space = 0;
3573
3574 cmsgh = (i == 0) ? CMSG_FIRSTHDR(&msg) : CMSG_NXTHDR(&msg, cmsgh);
3575 if (cmsgh == NULL) {
3576 PyErr_Format(PyExc_RuntimeError,
3577 "unexpected NULL result from %s()",
3578 (i == 0) ? "CMSG_FIRSTHDR" : "CMSG_NXTHDR");
3579 goto finally;
3580 }
3581 if (!get_CMSG_LEN(data_len, &msg_len)) {
3582 PyErr_SetString(PyExc_RuntimeError,
3583 "item size out of range for CMSG_LEN()");
3584 goto finally;
3585 }
3586 if (cmsg_min_space(&msg, cmsgh, msg_len)) {
3587 size_t space;
3588
3589 cmsgh->cmsg_len = msg_len;
3590 if (get_cmsg_data_space(&msg, cmsgh, &space))
3591 enough_space = (space >= data_len);
3592 }
3593 if (!enough_space) {
3594 PyErr_SetString(PyExc_RuntimeError,
3595 "ancillary data does not fit in calculated "
3596 "space");
3597 goto finally;
3598 }
3599 cmsgh->cmsg_level = cmsgs[i].level;
3600 cmsgh->cmsg_type = cmsgs[i].type;
3601 memcpy(CMSG_DATA(cmsgh), cmsgs[i].data.buf, data_len);
3602 }
3603 }
3604
3605 /* Make the system call. */
3606 if (!IS_SELECTABLE(s)) {
3607 select_error();
3608 goto finally;
3609 }
3610
3611 BEGIN_SELECT_LOOP(s)
3612 Py_BEGIN_ALLOW_THREADS;
3613 timeout = internal_select_ex(s, 1, interval);
3614 if (!timeout)
3615 bytes_sent = sendmsg(s->sock_fd, &msg, flags);
3616 Py_END_ALLOW_THREADS;
3617 if (timeout == 1) {
3618 PyErr_SetString(socket_timeout, "timed out");
3619 goto finally;
3620 }
3621 END_SELECT_LOOP(s)
3622
3623 if (bytes_sent < 0) {
3624 s->errorhandler();
3625 goto finally;
3626 }
3627 retval = PyLong_FromSsize_t(bytes_sent);
3628
3629finally:
3630 PyMem_Free(controlbuf);
3631 for (i = 0; i < ncmsgbufs; i++)
3632 PyBuffer_Release(&cmsgs[i].data);
3633 PyMem_Free(cmsgs);
3634 Py_XDECREF(cmsg_fast);
3635 for (i = 0; i < ndatabufs; i++)
3636 PyBuffer_Release(&databufs[i]);
3637 PyMem_Free(databufs);
3638 PyMem_Free(iovs);
3639 Py_XDECREF(data_fast);
3640 return retval;
3641}
3642
3643PyDoc_STRVAR(sendmsg_doc,
3644"sendmsg(buffers[, ancdata[, flags[, address]]]) -> count\n\
3645\n\
3646Send normal and ancillary data to the socket, gathering the\n\
3647non-ancillary data from a series of buffers and concatenating it into\n\
3648a single message. The buffers argument specifies the non-ancillary\n\
3649data as an iterable of buffer-compatible objects (e.g. bytes objects).\n\
3650The ancdata argument specifies the ancillary data (control messages)\n\
3651as an iterable of zero or more tuples (cmsg_level, cmsg_type,\n\
3652cmsg_data), where cmsg_level and cmsg_type are integers specifying the\n\
3653protocol level and protocol-specific type respectively, and cmsg_data\n\
3654is a buffer-compatible object holding the associated data. The flags\n\
3655argument defaults to 0 and has the same meaning as for send(). If\n\
3656address is supplied and not None, it sets a destination address for\n\
3657the message. The return value is the number of bytes of non-ancillary\n\
3658data sent.");
3659#endif /* CMSG_LEN */
3660
3661
Guido van Rossum30a685f1991-06-27 15:51:29 +00003662/* s.shutdown(how) method */
3663
Guido van Rossum73624e91994-10-10 17:59:00 +00003664static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00003665sock_shutdown(PySocketSockObject *s, PyObject *arg)
Guido van Rossum6574b3e1991-06-25 21:36:08 +00003666{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003667 int how;
3668 int res;
Jeremy Hyltonae0013d2001-10-11 16:36:35 +00003669
Serhiy Storchaka78980432013-01-15 01:12:17 +02003670 how = _PyLong_AsInt(arg);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003671 if (how == -1 && PyErr_Occurred())
3672 return NULL;
3673 Py_BEGIN_ALLOW_THREADS
3674 res = shutdown(s->sock_fd, how);
3675 Py_END_ALLOW_THREADS
3676 if (res < 0)
3677 return s->errorhandler();
3678 Py_INCREF(Py_None);
3679 return Py_None;
Guido van Rossum6574b3e1991-06-25 21:36:08 +00003680}
3681
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003682PyDoc_STRVAR(shutdown_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00003683"shutdown(flag)\n\
3684\n\
Martin v. Löwis94681fc2003-11-27 19:40:22 +00003685Shut down the reading side of the socket (flag == SHUT_RD), the writing side\n\
3686of the socket (flag == SHUT_WR), or both ends (flag == SHUT_RDWR).");
Guido van Rossum82a5c661998-07-07 20:45:43 +00003687
Amaury Forgeot d'Arc3d17a5c2008-06-13 01:09:34 +00003688#if defined(MS_WINDOWS) && defined(SIO_RCVALL)
Christian Heimesfaf2f632008-01-06 16:59:19 +00003689static PyObject*
3690sock_ioctl(PySocketSockObject *s, PyObject *arg)
3691{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003692 unsigned long cmd = SIO_RCVALL;
3693 PyObject *argO;
3694 DWORD recv;
Christian Heimesfaf2f632008-01-06 16:59:19 +00003695
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003696 if (!PyArg_ParseTuple(arg, "kO:ioctl", &cmd, &argO))
3697 return NULL;
Christian Heimesfaf2f632008-01-06 16:59:19 +00003698
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003699 switch (cmd) {
3700 case SIO_RCVALL: {
3701 unsigned int option = RCVALL_ON;
3702 if (!PyArg_ParseTuple(arg, "kI:ioctl", &cmd, &option))
3703 return NULL;
3704 if (WSAIoctl(s->sock_fd, cmd, &option, sizeof(option),
3705 NULL, 0, &recv, NULL, NULL) == SOCKET_ERROR) {
3706 return set_error();
3707 }
3708 return PyLong_FromUnsignedLong(recv); }
3709 case SIO_KEEPALIVE_VALS: {
3710 struct tcp_keepalive ka;
3711 if (!PyArg_ParseTuple(arg, "k(kkk):ioctl", &cmd,
3712 &ka.onoff, &ka.keepalivetime, &ka.keepaliveinterval))
3713 return NULL;
3714 if (WSAIoctl(s->sock_fd, cmd, &ka, sizeof(ka),
3715 NULL, 0, &recv, NULL, NULL) == SOCKET_ERROR) {
3716 return set_error();
3717 }
3718 return PyLong_FromUnsignedLong(recv); }
3719 default:
3720 PyErr_Format(PyExc_ValueError, "invalid ioctl command %d", cmd);
3721 return NULL;
3722 }
Christian Heimesfaf2f632008-01-06 16:59:19 +00003723}
3724PyDoc_STRVAR(sock_ioctl_doc,
3725"ioctl(cmd, option) -> long\n\
3726\n\
Kristján Valur Jónsson847ec752009-09-27 21:10:38 +00003727Control the socket with WSAIoctl syscall. Currently supported 'cmd' values are\n\
3728SIO_RCVALL: 'option' must be one of the socket.RCVALL_* constants.\n\
3729SIO_KEEPALIVE_VALS: 'option' is a tuple of (onoff, timeout, interval).");
Kristján Valur Jónsson10f383a2012-04-07 11:23:31 +00003730#endif
3731
3732#if defined(MS_WINDOWS)
3733static PyObject*
3734sock_share(PySocketSockObject *s, PyObject *arg)
3735{
3736 WSAPROTOCOL_INFO info;
3737 DWORD processId;
3738 int result;
3739
3740 if (!PyArg_ParseTuple(arg, "I", &processId))
3741 return NULL;
3742
3743 Py_BEGIN_ALLOW_THREADS
3744 result = WSADuplicateSocket(s->sock_fd, processId, &info);
3745 Py_END_ALLOW_THREADS
3746 if (result == SOCKET_ERROR)
3747 return set_error();
3748 return PyBytes_FromStringAndSize((const char*)&info, sizeof(info));
3749}
3750PyDoc_STRVAR(sock_share_doc,
3751"share(process_id) -> bytes\n\
3752\n\
3753Share the socket with another process. The target process id\n\
3754must be provided and the resulting bytes object passed to the target\n\
3755process. There the shared socket can be instantiated by calling\n\
3756socket.fromshare().");
3757
Christian Heimesfaf2f632008-01-06 16:59:19 +00003758
3759#endif
Guido van Rossum30a685f1991-06-27 15:51:29 +00003760
3761/* List of methods for socket objects */
Guido van Rossum6574b3e1991-06-25 21:36:08 +00003762
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00003763static PyMethodDef sock_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003764 {"_accept", (PyCFunction)sock_accept, METH_NOARGS,
3765 accept_doc},
3766 {"bind", (PyCFunction)sock_bind, METH_O,
3767 bind_doc},
3768 {"close", (PyCFunction)sock_close, METH_NOARGS,
3769 close_doc},
3770 {"connect", (PyCFunction)sock_connect, METH_O,
3771 connect_doc},
3772 {"connect_ex", (PyCFunction)sock_connect_ex, METH_O,
3773 connect_ex_doc},
Antoine Pitrou6e451df2010-08-09 20:39:54 +00003774 {"detach", (PyCFunction)sock_detach, METH_NOARGS,
3775 detach_doc},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003776 {"fileno", (PyCFunction)sock_fileno, METH_NOARGS,
3777 fileno_doc},
Guido van Rossumb6775db1994-08-01 11:34:53 +00003778#ifdef HAVE_GETPEERNAME
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003779 {"getpeername", (PyCFunction)sock_getpeername,
3780 METH_NOARGS, getpeername_doc},
Guido van Rossum9575a441993-04-07 14:06:14 +00003781#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003782 {"getsockname", (PyCFunction)sock_getsockname,
3783 METH_NOARGS, getsockname_doc},
3784 {"getsockopt", (PyCFunction)sock_getsockopt, METH_VARARGS,
3785 getsockopt_doc},
Amaury Forgeot d'Arc3d17a5c2008-06-13 01:09:34 +00003786#if defined(MS_WINDOWS) && defined(SIO_RCVALL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003787 {"ioctl", (PyCFunction)sock_ioctl, METH_VARARGS,
3788 sock_ioctl_doc},
Christian Heimesfaf2f632008-01-06 16:59:19 +00003789#endif
Kristján Valur Jónsson10f383a2012-04-07 11:23:31 +00003790#if defined(MS_WINDOWS)
3791 {"share", (PyCFunction)sock_share, METH_VARARGS,
3792 sock_share_doc},
3793#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003794 {"listen", (PyCFunction)sock_listen, METH_O,
3795 listen_doc},
3796 {"recv", (PyCFunction)sock_recv, METH_VARARGS,
3797 recv_doc},
3798 {"recv_into", (PyCFunction)sock_recv_into, METH_VARARGS | METH_KEYWORDS,
3799 recv_into_doc},
3800 {"recvfrom", (PyCFunction)sock_recvfrom, METH_VARARGS,
3801 recvfrom_doc},
3802 {"recvfrom_into", (PyCFunction)sock_recvfrom_into, METH_VARARGS | METH_KEYWORDS,
3803 recvfrom_into_doc},
3804 {"send", (PyCFunction)sock_send, METH_VARARGS,
3805 send_doc},
3806 {"sendall", (PyCFunction)sock_sendall, METH_VARARGS,
3807 sendall_doc},
3808 {"sendto", (PyCFunction)sock_sendto, METH_VARARGS,
3809 sendto_doc},
3810 {"setblocking", (PyCFunction)sock_setblocking, METH_O,
3811 setblocking_doc},
3812 {"settimeout", (PyCFunction)sock_settimeout, METH_O,
3813 settimeout_doc},
3814 {"gettimeout", (PyCFunction)sock_gettimeout, METH_NOARGS,
3815 gettimeout_doc},
3816 {"setsockopt", (PyCFunction)sock_setsockopt, METH_VARARGS,
3817 setsockopt_doc},
3818 {"shutdown", (PyCFunction)sock_shutdown, METH_O,
3819 shutdown_doc},
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003820#ifdef CMSG_LEN
3821 {"recvmsg", (PyCFunction)sock_recvmsg, METH_VARARGS,
3822 recvmsg_doc},
3823 {"recvmsg_into", (PyCFunction)sock_recvmsg_into, METH_VARARGS,
3824 recvmsg_into_doc,},
3825 {"sendmsg", (PyCFunction)sock_sendmsg, METH_VARARGS,
3826 sendmsg_doc},
3827#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003828 {NULL, NULL} /* sentinel */
Guido van Rossum6574b3e1991-06-25 21:36:08 +00003829};
3830
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00003831/* SockObject members */
3832static PyMemberDef sock_memberlist[] = {
3833 {"family", T_INT, offsetof(PySocketSockObject, sock_family), READONLY, "the socket family"},
3834 {"type", T_INT, offsetof(PySocketSockObject, sock_type), READONLY, "the socket type"},
3835 {"proto", T_INT, offsetof(PySocketSockObject, sock_proto), READONLY, "the socket protocol"},
3836 {"timeout", T_DOUBLE, offsetof(PySocketSockObject, sock_timeout), READONLY, "the socket timeout"},
3837 {0},
3838};
Guido van Rossum30a685f1991-06-27 15:51:29 +00003839
Guido van Rossum73624e91994-10-10 17:59:00 +00003840/* Deallocate a socket object in response to the last Py_DECREF().
Guido van Rossum30a685f1991-06-27 15:51:29 +00003841 First close the file description. */
3842
Guido van Rossum6574b3e1991-06-25 21:36:08 +00003843static void
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00003844sock_dealloc(PySocketSockObject *s)
Guido van Rossum6574b3e1991-06-25 21:36:08 +00003845{
Antoine Pitroue033e062010-10-29 10:38:18 +00003846 if (s->sock_fd != -1) {
3847 PyObject *exc, *val, *tb;
3848 Py_ssize_t old_refcount = Py_REFCNT(s);
3849 ++Py_REFCNT(s);
3850 PyErr_Fetch(&exc, &val, &tb);
3851 if (PyErr_WarnFormat(PyExc_ResourceWarning, 1,
3852 "unclosed %R", s))
3853 /* Spurious errors can appear at shutdown */
3854 if (PyErr_ExceptionMatches(PyExc_Warning))
3855 PyErr_WriteUnraisable((PyObject *) s);
3856 PyErr_Restore(exc, val, tb);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003857 (void) SOCKETCLOSE(s->sock_fd);
Antoine Pitroue033e062010-10-29 10:38:18 +00003858 Py_REFCNT(s) = old_refcount;
3859 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003860 Py_TYPE(s)->tp_free((PyObject *)s);
Guido van Rossum6574b3e1991-06-25 21:36:08 +00003861}
3862
Guido van Rossum30a685f1991-06-27 15:51:29 +00003863
Guido van Rossum3bbc62e1995-01-02 19:30:30 +00003864static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00003865sock_repr(PySocketSockObject *s)
Guido van Rossum3bbc62e1995-01-02 19:30:30 +00003866{
Fred Drakea04eaad2000-06-30 02:46:07 +00003867#if SIZEOF_SOCKET_T > SIZEOF_LONG
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003868 if (s->sock_fd > LONG_MAX) {
3869 /* this can occur on Win64, and actually there is a special
3870 ugly printf formatter for decimal pointer length integer
3871 printing, only bother if necessary*/
3872 PyErr_SetString(PyExc_OverflowError,
3873 "no printf formatter to display "
3874 "the socket descriptor in decimal");
3875 return NULL;
3876 }
Fred Drakea04eaad2000-06-30 02:46:07 +00003877#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003878 return PyUnicode_FromFormat(
3879 "<socket object, fd=%ld, family=%d, type=%d, proto=%d>",
3880 (long)s->sock_fd, s->sock_family,
3881 s->sock_type,
3882 s->sock_proto);
Guido van Rossum3bbc62e1995-01-02 19:30:30 +00003883}
3884
3885
Guido van Rossum384ca9c2001-10-27 22:20:47 +00003886/* Create a new, uninitialized socket object. */
3887
3888static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00003889sock_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
Guido van Rossum384ca9c2001-10-27 22:20:47 +00003890{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003891 PyObject *new;
Guido van Rossum384ca9c2001-10-27 22:20:47 +00003892
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003893 new = type->tp_alloc(type, 0);
3894 if (new != NULL) {
3895 ((PySocketSockObject *)new)->sock_fd = -1;
3896 ((PySocketSockObject *)new)->sock_timeout = -1.0;
3897 ((PySocketSockObject *)new)->errorhandler = &set_error;
3898 }
3899 return new;
Guido van Rossum384ca9c2001-10-27 22:20:47 +00003900}
3901
3902
3903/* Initialize a new socket object. */
3904
Victor Stinnerdaf45552013-08-28 00:53:59 +02003905#ifdef SOCK_CLOEXEC
3906/* socket() and socketpair() fail with EINVAL on Linux kernel older
3907 * than 2.6.27 if SOCK_CLOEXEC flag is set in the socket type. */
3908static int sock_cloexec_works = -1;
3909#endif
3910
Guido van Rossum384ca9c2001-10-27 22:20:47 +00003911/*ARGSUSED*/
3912static int
Andrew MacIntyre7aec4a22002-06-13 11:53:52 +00003913sock_initobj(PyObject *self, PyObject *args, PyObject *kwds)
Guido van Rossum384ca9c2001-10-27 22:20:47 +00003914{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003915 PySocketSockObject *s = (PySocketSockObject *)self;
3916 PyObject *fdobj = NULL;
3917 SOCKET_T fd = INVALID_SOCKET;
3918 int family = AF_INET, type = SOCK_STREAM, proto = 0;
3919 static char *keywords[] = {"family", "type", "proto", "fileno", 0};
Victor Stinnerdaf45552013-08-28 00:53:59 +02003920#ifndef MS_WINDOWS
3921#ifdef SOCK_CLOEXEC
3922 int *atomic_flag_works = &sock_cloexec_works;
3923#else
3924 int *atomic_flag_works = NULL;
3925#endif
3926#endif
Guido van Rossum384ca9c2001-10-27 22:20:47 +00003927
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003928 if (!PyArg_ParseTupleAndKeywords(args, kwds,
3929 "|iiiO:socket", keywords,
3930 &family, &type, &proto, &fdobj))
3931 return -1;
Guido van Rossum67f7a382002-06-06 21:08:16 +00003932
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003933 if (fdobj != NULL && fdobj != Py_None) {
Kristján Valur Jónsson10f383a2012-04-07 11:23:31 +00003934#ifdef MS_WINDOWS
3935 /* recreate a socket that was duplicated */
3936 if (PyBytes_Check(fdobj)) {
3937 WSAPROTOCOL_INFO info;
3938 if (PyBytes_GET_SIZE(fdobj) != sizeof(info)) {
3939 PyErr_Format(PyExc_ValueError,
3940 "socket descriptor string has wrong size, "
3941 "should be %zu bytes.", sizeof(info));
3942 return -1;
3943 }
3944 memcpy(&info, PyBytes_AS_STRING(fdobj), sizeof(info));
3945 Py_BEGIN_ALLOW_THREADS
3946 fd = WSASocket(FROM_PROTOCOL_INFO, FROM_PROTOCOL_INFO,
3947 FROM_PROTOCOL_INFO, &info, 0, WSA_FLAG_OVERLAPPED);
3948 Py_END_ALLOW_THREADS
3949 if (fd == INVALID_SOCKET) {
3950 set_error();
3951 return -1;
3952 }
3953 family = info.iAddressFamily;
3954 type = info.iSocketType;
3955 proto = info.iProtocol;
3956 }
3957 else
3958#endif
3959 {
3960 fd = PyLong_AsSocket_t(fdobj);
3961 if (fd == (SOCKET_T)(-1) && PyErr_Occurred())
3962 return -1;
3963 if (fd == INVALID_SOCKET) {
3964 PyErr_SetString(PyExc_ValueError,
3965 "can't use invalid socket value");
3966 return -1;
3967 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003968 }
3969 }
3970 else {
Victor Stinnerdaf45552013-08-28 00:53:59 +02003971#ifdef MS_WINDOWS
3972 /* Windows implementation */
3973#ifndef WSA_FLAG_NO_HANDLE_INHERIT
3974#define WSA_FLAG_NO_HANDLE_INHERIT 0x80
3975#endif
3976
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003977 Py_BEGIN_ALLOW_THREADS
Victor Stinnerdaf45552013-08-28 00:53:59 +02003978 if (support_wsa_no_inherit) {
3979 fd = WSASocket(family, type, proto,
3980 NULL, 0,
3981 WSA_FLAG_OVERLAPPED | WSA_FLAG_NO_HANDLE_INHERIT);
3982 if (fd == INVALID_SOCKET) {
3983 /* Windows 7 or Windows 2008 R2 without SP1 or the hotfix */
3984 support_wsa_no_inherit = 0;
3985 fd = socket(family, type, proto);
3986 }
3987 }
3988 else {
3989 fd = socket(family, type, proto);
3990 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003991 Py_END_ALLOW_THREADS
Guido van Rossum67f7a382002-06-06 21:08:16 +00003992
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003993 if (fd == INVALID_SOCKET) {
3994 set_error();
3995 return -1;
3996 }
Victor Stinnerdaf45552013-08-28 00:53:59 +02003997
3998 if (!support_wsa_no_inherit) {
3999 if (!SetHandleInformation((HANDLE)fd, HANDLE_FLAG_INHERIT, 0)) {
4000 closesocket(fd);
4001 PyErr_SetFromWindowsErr(0);
4002 return -1;
4003 }
4004 }
4005#else
4006 /* UNIX */
4007 Py_BEGIN_ALLOW_THREADS
4008#ifdef SOCK_CLOEXEC
4009 if (sock_cloexec_works != 0) {
4010 fd = socket(family, type | SOCK_CLOEXEC, proto);
4011 if (sock_cloexec_works == -1) {
4012 if (fd >= 0) {
4013 sock_cloexec_works = 1;
4014 }
4015 else if (errno == EINVAL) {
4016 /* Linux older than 2.6.27 does not support SOCK_CLOEXEC */
4017 sock_cloexec_works = 0;
4018 fd = socket(family, type, proto);
4019 }
4020 }
4021 }
4022 else
4023#endif
4024 {
4025 fd = socket(family, type, proto);
4026 }
4027 Py_END_ALLOW_THREADS
4028
4029 if (fd == INVALID_SOCKET) {
4030 set_error();
4031 return -1;
4032 }
4033
4034 if (_Py_set_inheritable(fd, 0, atomic_flag_works) < 0) {
4035 SOCKETCLOSE(fd);
4036 return -1;
4037 }
4038#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004039 }
4040 init_sockobject(s, fd, family, type, proto);
Guido van Rossum67f7a382002-06-06 21:08:16 +00004041
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004042 return 0;
Guido van Rossum67f7a382002-06-06 21:08:16 +00004043
Guido van Rossum384ca9c2001-10-27 22:20:47 +00004044}
4045
4046
Guido van Rossumb6775db1994-08-01 11:34:53 +00004047/* Type object for socket objects. */
Guido van Rossum30a685f1991-06-27 15:51:29 +00004048
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00004049static PyTypeObject sock_type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004050 PyVarObject_HEAD_INIT(0, 0) /* Must fill in type value later */
4051 "_socket.socket", /* tp_name */
4052 sizeof(PySocketSockObject), /* tp_basicsize */
4053 0, /* tp_itemsize */
4054 (destructor)sock_dealloc, /* tp_dealloc */
4055 0, /* tp_print */
4056 0, /* tp_getattr */
4057 0, /* tp_setattr */
4058 0, /* tp_reserved */
4059 (reprfunc)sock_repr, /* tp_repr */
4060 0, /* tp_as_number */
4061 0, /* tp_as_sequence */
4062 0, /* tp_as_mapping */
4063 0, /* tp_hash */
4064 0, /* tp_call */
4065 0, /* tp_str */
4066 PyObject_GenericGetAttr, /* tp_getattro */
4067 0, /* tp_setattro */
4068 0, /* tp_as_buffer */
4069 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
4070 sock_doc, /* tp_doc */
4071 0, /* tp_traverse */
4072 0, /* tp_clear */
4073 0, /* tp_richcompare */
4074 0, /* tp_weaklistoffset */
4075 0, /* tp_iter */
4076 0, /* tp_iternext */
4077 sock_methods, /* tp_methods */
4078 sock_memberlist, /* tp_members */
4079 0, /* tp_getset */
4080 0, /* tp_base */
4081 0, /* tp_dict */
4082 0, /* tp_descr_get */
4083 0, /* tp_descr_set */
4084 0, /* tp_dictoffset */
4085 sock_initobj, /* tp_init */
4086 PyType_GenericAlloc, /* tp_alloc */
4087 sock_new, /* tp_new */
4088 PyObject_Del, /* tp_free */
Guido van Rossum6574b3e1991-06-25 21:36:08 +00004089};
4090
Guido van Rossum30a685f1991-06-27 15:51:29 +00004091
Guido van Rossum81194471991-07-27 21:42:02 +00004092/* Python interface to gethostname(). */
4093
4094/*ARGSUSED*/
Guido van Rossum73624e91994-10-10 17:59:00 +00004095static PyObject *
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00004096socket_gethostname(PyObject *self, PyObject *unused)
Guido van Rossum81194471991-07-27 21:42:02 +00004097{
Martin v. Löwis72f48422010-10-29 18:20:08 +00004098#ifdef MS_WINDOWS
4099 /* Don't use winsock's gethostname, as this returns the ANSI
4100 version of the hostname, whereas we need a Unicode string.
4101 Otherwise, gethostname apparently also returns the DNS name. */
Hirokazu Yamamoto09fff7a2010-11-05 17:24:13 +00004102 wchar_t buf[MAX_COMPUTERNAME_LENGTH + 1];
Victor Stinner63941882011-09-29 00:42:28 +02004103 DWORD size = Py_ARRAY_LENGTH(buf);
Victor Stinner74168972011-11-17 01:11:36 +01004104 wchar_t *name;
Hirokazu Yamamoto09fff7a2010-11-05 17:24:13 +00004105 PyObject *result;
Victor Stinner74168972011-11-17 01:11:36 +01004106
4107 if (GetComputerNameExW(ComputerNamePhysicalDnsHostname, buf, &size))
Victor Stinner9d3b93b2011-11-22 02:27:30 +01004108 return PyUnicode_FromWideChar(buf, size);
Victor Stinner74168972011-11-17 01:11:36 +01004109
4110 if (GetLastError() != ERROR_MORE_DATA)
4111 return PyErr_SetFromWindowsErr(0);
4112
4113 if (size == 0)
4114 return PyUnicode_New(0, 0);
4115
4116 /* MSDN says ERROR_MORE_DATA may occur because DNS allows longer
4117 names */
4118 name = PyMem_Malloc(size * sizeof(wchar_t));
4119 if (!name)
4120 return NULL;
4121 if (!GetComputerNameExW(ComputerNamePhysicalDnsHostname,
4122 name,
4123 &size))
4124 {
4125 PyMem_Free(name);
4126 return PyErr_SetFromWindowsErr(0);
Martin v. Löwis72f48422010-10-29 18:20:08 +00004127 }
Victor Stinner74168972011-11-17 01:11:36 +01004128
4129 result = PyUnicode_FromWideChar(name, size);
4130 PyMem_Free(name);
4131 return result;
Martin v. Löwis72f48422010-10-29 18:20:08 +00004132#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004133 char buf[1024];
4134 int res;
4135 Py_BEGIN_ALLOW_THREADS
4136 res = gethostname(buf, (int) sizeof buf - 1);
4137 Py_END_ALLOW_THREADS
4138 if (res < 0)
4139 return set_error();
4140 buf[sizeof buf - 1] = '\0';
Victor Stinnera534fc42013-06-03 22:07:27 +02004141 return PyUnicode_DecodeFSDefault(buf);
Martin v. Löwis72f48422010-10-29 18:20:08 +00004142#endif
Guido van Rossum81194471991-07-27 21:42:02 +00004143}
Guido van Rossumff4949e1992-08-05 19:58:53 +00004144
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004145PyDoc_STRVAR(gethostname_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00004146"gethostname() -> string\n\
4147\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004148Return the current host name.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00004149
Antoine Pitrou061cfb52011-02-28 22:25:22 +00004150#ifdef HAVE_SETHOSTNAME
4151PyDoc_STRVAR(sethostname_doc,
4152"sethostname(name)\n\n\
4153Sets the hostname to name.");
4154
4155static PyObject *
4156socket_sethostname(PyObject *self, PyObject *args)
4157{
4158 PyObject *hnobj;
4159 Py_buffer buf;
4160 int res, flag = 0;
4161
Christian Heimesd2774c72013-06-19 02:06:29 +02004162#ifdef _AIX
4163/* issue #18259, not declared in any useful header file */
4164extern int sethostname(const char *, size_t);
4165#endif
4166
Antoine Pitrou061cfb52011-02-28 22:25:22 +00004167 if (!PyArg_ParseTuple(args, "S:sethostname", &hnobj)) {
4168 PyErr_Clear();
4169 if (!PyArg_ParseTuple(args, "O&:sethostname",
4170 PyUnicode_FSConverter, &hnobj))
4171 return NULL;
4172 flag = 1;
4173 }
4174 res = PyObject_GetBuffer(hnobj, &buf, PyBUF_SIMPLE);
4175 if (!res) {
4176 res = sethostname(buf.buf, buf.len);
4177 PyBuffer_Release(&buf);
4178 }
4179 if (flag)
4180 Py_DECREF(hnobj);
4181 if (res)
4182 return set_error();
4183 Py_RETURN_NONE;
4184}
4185#endif
Guido van Rossumff4949e1992-08-05 19:58:53 +00004186
Guido van Rossum30a685f1991-06-27 15:51:29 +00004187/* Python interface to gethostbyname(name). */
4188
4189/*ARGSUSED*/
Guido van Rossum73624e91994-10-10 17:59:00 +00004190static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00004191socket_gethostbyname(PyObject *self, PyObject *args)
Guido van Rossum30a685f1991-06-27 15:51:29 +00004192{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004193 char *name;
4194 sock_addr_t addrbuf;
Martin v. Löwisfc0275a2010-08-22 19:33:47 +00004195 PyObject *ret = NULL;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00004196
Martin v. Löwisfc0275a2010-08-22 19:33:47 +00004197 if (!PyArg_ParseTuple(args, "et:gethostbyname", "idna", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004198 return NULL;
4199 if (setipaddr(name, SAS2SA(&addrbuf), sizeof(addrbuf), AF_INET) < 0)
Martin v. Löwisfc0275a2010-08-22 19:33:47 +00004200 goto finally;
4201 ret = makeipaddr(SAS2SA(&addrbuf), sizeof(struct sockaddr_in));
4202finally:
4203 PyMem_Free(name);
4204 return ret;
Guido van Rossum30a685f1991-06-27 15:51:29 +00004205}
4206
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004207PyDoc_STRVAR(gethostbyname_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00004208"gethostbyname(host) -> address\n\
4209\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004210Return the IP address (a string of the form '255.255.255.255') for a host.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00004211
4212
Guido van Rossum7d896ab1998-08-04 22:16:43 +00004213/* Convenience function common to gethostbyname_ex and gethostbyaddr */
4214
4215static PyObject *
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00004216gethost_common(struct hostent *h, struct sockaddr *addr, int alen, int af)
Guido van Rossum7d896ab1998-08-04 22:16:43 +00004217{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004218 char **pch;
4219 PyObject *rtn_tuple = (PyObject *)NULL;
4220 PyObject *name_list = (PyObject *)NULL;
4221 PyObject *addr_list = (PyObject *)NULL;
4222 PyObject *tmp;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00004223
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004224 if (h == NULL) {
4225 /* Let's get real error message to return */
4226 set_herror(h_errno);
4227 return NULL;
4228 }
Guido van Rossum67f7a382002-06-06 21:08:16 +00004229
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004230 if (h->h_addrtype != af) {
4231 /* Let's get real error message to return */
Victor Stinner1f33f2b2011-12-17 04:45:09 +01004232 errno = EAFNOSUPPORT;
4233 PyErr_SetFromErrno(PyExc_OSError);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004234 return NULL;
4235 }
Guido van Rossum67f7a382002-06-06 21:08:16 +00004236
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004237 switch (af) {
Guido van Rossum67f7a382002-06-06 21:08:16 +00004238
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004239 case AF_INET:
4240 if (alen < sizeof(struct sockaddr_in))
4241 return NULL;
4242 break;
Guido van Rossum67f7a382002-06-06 21:08:16 +00004243
Martin v. Löwis44ddbde2001-12-02 10:15:37 +00004244#ifdef ENABLE_IPV6
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004245 case AF_INET6:
4246 if (alen < sizeof(struct sockaddr_in6))
4247 return NULL;
4248 break;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00004249#endif
Guido van Rossum67f7a382002-06-06 21:08:16 +00004250
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004251 }
Guido van Rossum67f7a382002-06-06 21:08:16 +00004252
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004253 if ((name_list = PyList_New(0)) == NULL)
4254 goto err;
Guido van Rossum67f7a382002-06-06 21:08:16 +00004255
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004256 if ((addr_list = PyList_New(0)) == NULL)
4257 goto err;
Guido van Rossum67f7a382002-06-06 21:08:16 +00004258
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004259 /* SF #1511317: h_aliases can be NULL */
4260 if (h->h_aliases) {
4261 for (pch = h->h_aliases; *pch != NULL; pch++) {
4262 int status;
4263 tmp = PyUnicode_FromString(*pch);
4264 if (tmp == NULL)
4265 goto err;
Guido van Rossum67f7a382002-06-06 21:08:16 +00004266
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004267 status = PyList_Append(name_list, tmp);
4268 Py_DECREF(tmp);
Guido van Rossum67f7a382002-06-06 21:08:16 +00004269
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004270 if (status)
4271 goto err;
4272 }
4273 }
Guido van Rossum67f7a382002-06-06 21:08:16 +00004274
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004275 for (pch = h->h_addr_list; *pch != NULL; pch++) {
4276 int status;
Guido van Rossum67f7a382002-06-06 21:08:16 +00004277
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004278 switch (af) {
Guido van Rossum67f7a382002-06-06 21:08:16 +00004279
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004280 case AF_INET:
4281 {
4282 struct sockaddr_in sin;
4283 memset(&sin, 0, sizeof(sin));
4284 sin.sin_family = af;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00004285#ifdef HAVE_SOCKADDR_SA_LEN
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004286 sin.sin_len = sizeof(sin);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00004287#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004288 memcpy(&sin.sin_addr, *pch, sizeof(sin.sin_addr));
4289 tmp = makeipaddr((struct sockaddr *)&sin, sizeof(sin));
Guido van Rossum67f7a382002-06-06 21:08:16 +00004290
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004291 if (pch == h->h_addr_list && alen >= sizeof(sin))
4292 memcpy((char *) addr, &sin, sizeof(sin));
4293 break;
4294 }
Guido van Rossum67f7a382002-06-06 21:08:16 +00004295
Martin v. Löwis44ddbde2001-12-02 10:15:37 +00004296#ifdef ENABLE_IPV6
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004297 case AF_INET6:
4298 {
4299 struct sockaddr_in6 sin6;
4300 memset(&sin6, 0, sizeof(sin6));
4301 sin6.sin6_family = af;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00004302#ifdef HAVE_SOCKADDR_SA_LEN
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004303 sin6.sin6_len = sizeof(sin6);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00004304#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004305 memcpy(&sin6.sin6_addr, *pch, sizeof(sin6.sin6_addr));
4306 tmp = makeipaddr((struct sockaddr *)&sin6,
4307 sizeof(sin6));
Guido van Rossum67f7a382002-06-06 21:08:16 +00004308
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004309 if (pch == h->h_addr_list && alen >= sizeof(sin6))
4310 memcpy((char *) addr, &sin6, sizeof(sin6));
4311 break;
4312 }
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00004313#endif
Guido van Rossum67f7a382002-06-06 21:08:16 +00004314
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004315 default: /* can't happen */
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02004316 PyErr_SetString(PyExc_OSError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004317 "unsupported address family");
4318 return NULL;
4319 }
Guido van Rossum67f7a382002-06-06 21:08:16 +00004320
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004321 if (tmp == NULL)
4322 goto err;
Guido van Rossum67f7a382002-06-06 21:08:16 +00004323
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004324 status = PyList_Append(addr_list, tmp);
4325 Py_DECREF(tmp);
Guido van Rossum67f7a382002-06-06 21:08:16 +00004326
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004327 if (status)
4328 goto err;
4329 }
Guido van Rossum67f7a382002-06-06 21:08:16 +00004330
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004331 rtn_tuple = Py_BuildValue("sOO", h->h_name, name_list, addr_list);
Guido van Rossum67f7a382002-06-06 21:08:16 +00004332
Guido van Rossum7d896ab1998-08-04 22:16:43 +00004333 err:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004334 Py_XDECREF(name_list);
4335 Py_XDECREF(addr_list);
4336 return rtn_tuple;
Guido van Rossum7d896ab1998-08-04 22:16:43 +00004337}
4338
4339
4340/* Python interface to gethostbyname_ex(name). */
4341
4342/*ARGSUSED*/
4343static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00004344socket_gethostbyname_ex(PyObject *self, PyObject *args)
Guido van Rossum7d896ab1998-08-04 22:16:43 +00004345{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004346 char *name;
4347 struct hostent *h;
Charles-François Natali8b759652011-12-23 16:44:51 +01004348 sock_addr_t addr;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004349 struct sockaddr *sa;
Martin v. Löwisfc0275a2010-08-22 19:33:47 +00004350 PyObject *ret = NULL;
Guido van Rossum7d896ab1998-08-04 22:16:43 +00004351#ifdef HAVE_GETHOSTBYNAME_R
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004352 struct hostent hp_allocated;
Guido van Rossum7b6c71f1999-03-24 17:20:40 +00004353#ifdef HAVE_GETHOSTBYNAME_R_3_ARG
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004354 struct hostent_data data;
Guido van Rossum7b6c71f1999-03-24 17:20:40 +00004355#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004356 char buf[16384];
4357 int buf_len = (sizeof buf) - 1;
4358 int errnop;
Guido van Rossum7b6c71f1999-03-24 17:20:40 +00004359#endif
Ross Lagerwall8c159762012-03-06 21:36:18 +02004360#ifdef HAVE_GETHOSTBYNAME_R_3_ARG
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004361 int result;
Guido van Rossume9cd07b1999-03-15 21:40:14 +00004362#endif
Guido van Rossum7d896ab1998-08-04 22:16:43 +00004363#endif /* HAVE_GETHOSTBYNAME_R */
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00004364
Martin v. Löwisfc0275a2010-08-22 19:33:47 +00004365 if (!PyArg_ParseTuple(args, "et:gethostbyname_ex", "idna", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004366 return NULL;
Charles-François Natali8b759652011-12-23 16:44:51 +01004367 if (setipaddr(name, SAS2SA(&addr), sizeof(addr), AF_INET) < 0)
Martin v. Löwisfc0275a2010-08-22 19:33:47 +00004368 goto finally;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004369 Py_BEGIN_ALLOW_THREADS
Guido van Rossum7d896ab1998-08-04 22:16:43 +00004370#ifdef HAVE_GETHOSTBYNAME_R
Guido van Rossum7b6c71f1999-03-24 17:20:40 +00004371#if defined(HAVE_GETHOSTBYNAME_R_6_ARG)
Ross Lagerwall8c159762012-03-06 21:36:18 +02004372 gethostbyname_r(name, &hp_allocated, buf, buf_len,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004373 &h, &errnop);
Guido van Rossum7b6c71f1999-03-24 17:20:40 +00004374#elif defined(HAVE_GETHOSTBYNAME_R_5_ARG)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004375 h = gethostbyname_r(name, &hp_allocated, buf, buf_len, &errnop);
Guido van Rossum7b6c71f1999-03-24 17:20:40 +00004376#else /* HAVE_GETHOSTBYNAME_R_3_ARG */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004377 memset((void *) &data, '\0', sizeof(data));
4378 result = gethostbyname_r(name, &hp_allocated, &data);
4379 h = (result != 0) ? NULL : &hp_allocated;
Guido van Rossume9cd07b1999-03-15 21:40:14 +00004380#endif
Guido van Rossum7d896ab1998-08-04 22:16:43 +00004381#else /* not HAVE_GETHOSTBYNAME_R */
Guido van Rossum3baaa131999-03-22 21:44:51 +00004382#ifdef USE_GETHOSTBYNAME_LOCK
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004383 PyThread_acquire_lock(netdb_lock, 1);
Guido van Rossum7d896ab1998-08-04 22:16:43 +00004384#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004385 h = gethostbyname(name);
Guido van Rossum7d896ab1998-08-04 22:16:43 +00004386#endif /* HAVE_GETHOSTBYNAME_R */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004387 Py_END_ALLOW_THREADS
4388 /* Some C libraries would require addr.__ss_family instead of
4389 addr.ss_family.
4390 Therefore, we cast the sockaddr_storage into sockaddr to
4391 access sa_family. */
Charles-François Natali8b759652011-12-23 16:44:51 +01004392 sa = SAS2SA(&addr);
4393 ret = gethost_common(h, SAS2SA(&addr), sizeof(addr),
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004394 sa->sa_family);
Guido van Rossum3baaa131999-03-22 21:44:51 +00004395#ifdef USE_GETHOSTBYNAME_LOCK
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004396 PyThread_release_lock(netdb_lock);
Guido van Rossum955becc1999-03-22 20:14:53 +00004397#endif
Martin v. Löwisfc0275a2010-08-22 19:33:47 +00004398finally:
4399 PyMem_Free(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004400 return ret;
Guido van Rossum7d896ab1998-08-04 22:16:43 +00004401}
4402
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004403PyDoc_STRVAR(ghbn_ex_doc,
Guido van Rossum7d896ab1998-08-04 22:16:43 +00004404"gethostbyname_ex(host) -> (name, aliaslist, addresslist)\n\
4405\n\
4406Return the true host name, a list of aliases, and a list of IP addresses,\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004407for a host. The host argument is a string giving a host name or IP number.");
Guido van Rossum7d896ab1998-08-04 22:16:43 +00004408
4409
Guido van Rossum3bbc62e1995-01-02 19:30:30 +00004410/* Python interface to gethostbyaddr(IP). */
4411
4412/*ARGSUSED*/
4413static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00004414socket_gethostbyaddr(PyObject *self, PyObject *args)
Guido van Rossum3bbc62e1995-01-02 19:30:30 +00004415{
Charles-François Natali8b759652011-12-23 16:44:51 +01004416 sock_addr_t addr;
4417 struct sockaddr *sa = SAS2SA(&addr);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004418 char *ip_num;
4419 struct hostent *h;
Martin v. Löwisfc0275a2010-08-22 19:33:47 +00004420 PyObject *ret = NULL;
Guido van Rossum4f199ea1998-04-09 20:56:35 +00004421#ifdef HAVE_GETHOSTBYNAME_R
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004422 struct hostent hp_allocated;
Guido van Rossum7b6c71f1999-03-24 17:20:40 +00004423#ifdef HAVE_GETHOSTBYNAME_R_3_ARG
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004424 struct hostent_data data;
Guido van Rossum7b6c71f1999-03-24 17:20:40 +00004425#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004426 /* glibcs up to 2.10 assume that the buf argument to
4427 gethostbyaddr_r is 8-byte aligned, which at least llvm-gcc
4428 does not ensure. The attribute below instructs the compiler
4429 to maintain this alignment. */
4430 char buf[16384] Py_ALIGNED(8);
4431 int buf_len = (sizeof buf) - 1;
4432 int errnop;
Guido van Rossum7b6c71f1999-03-24 17:20:40 +00004433#endif
Ross Lagerwall8c159762012-03-06 21:36:18 +02004434#ifdef HAVE_GETHOSTBYNAME_R_3_ARG
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004435 int result;
Guido van Rossume9cd07b1999-03-15 21:40:14 +00004436#endif
Guido van Rossum4f199ea1998-04-09 20:56:35 +00004437#endif /* HAVE_GETHOSTBYNAME_R */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004438 char *ap;
4439 int al;
4440 int af;
Guido van Rossum3bbc62e1995-01-02 19:30:30 +00004441
Martin v. Löwisfc0275a2010-08-22 19:33:47 +00004442 if (!PyArg_ParseTuple(args, "et:gethostbyaddr", "idna", &ip_num))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004443 return NULL;
4444 af = AF_UNSPEC;
4445 if (setipaddr(ip_num, sa, sizeof(addr), af) < 0)
Martin v. Löwisfc0275a2010-08-22 19:33:47 +00004446 goto finally;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004447 af = sa->sa_family;
4448 ap = NULL;
Brett Cannonb94767f2011-02-22 20:15:44 +00004449 /* al = 0; */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004450 switch (af) {
4451 case AF_INET:
4452 ap = (char *)&((struct sockaddr_in *)sa)->sin_addr;
4453 al = sizeof(((struct sockaddr_in *)sa)->sin_addr);
4454 break;
Martin v. Löwis44ddbde2001-12-02 10:15:37 +00004455#ifdef ENABLE_IPV6
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004456 case AF_INET6:
4457 ap = (char *)&((struct sockaddr_in6 *)sa)->sin6_addr;
4458 al = sizeof(((struct sockaddr_in6 *)sa)->sin6_addr);
4459 break;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00004460#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004461 default:
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02004462 PyErr_SetString(PyExc_OSError, "unsupported address family");
Martin v. Löwisfc0275a2010-08-22 19:33:47 +00004463 goto finally;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004464 }
4465 Py_BEGIN_ALLOW_THREADS
Guido van Rossum4f199ea1998-04-09 20:56:35 +00004466#ifdef HAVE_GETHOSTBYNAME_R
Guido van Rossum7b6c71f1999-03-24 17:20:40 +00004467#if defined(HAVE_GETHOSTBYNAME_R_6_ARG)
Ross Lagerwall8c159762012-03-06 21:36:18 +02004468 gethostbyaddr_r(ap, al, af,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004469 &hp_allocated, buf, buf_len,
4470 &h, &errnop);
Guido van Rossum7b6c71f1999-03-24 17:20:40 +00004471#elif defined(HAVE_GETHOSTBYNAME_R_5_ARG)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004472 h = gethostbyaddr_r(ap, al, af,
4473 &hp_allocated, buf, buf_len, &errnop);
Guido van Rossum7b6c71f1999-03-24 17:20:40 +00004474#else /* HAVE_GETHOSTBYNAME_R_3_ARG */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004475 memset((void *) &data, '\0', sizeof(data));
4476 result = gethostbyaddr_r(ap, al, af, &hp_allocated, &data);
4477 h = (result != 0) ? NULL : &hp_allocated;
Guido van Rossume9cd07b1999-03-15 21:40:14 +00004478#endif
Guido van Rossum4f199ea1998-04-09 20:56:35 +00004479#else /* not HAVE_GETHOSTBYNAME_R */
Guido van Rossum3baaa131999-03-22 21:44:51 +00004480#ifdef USE_GETHOSTBYNAME_LOCK
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004481 PyThread_acquire_lock(netdb_lock, 1);
Guido van Rossum4f199ea1998-04-09 20:56:35 +00004482#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004483 h = gethostbyaddr(ap, al, af);
Guido van Rossum4f199ea1998-04-09 20:56:35 +00004484#endif /* HAVE_GETHOSTBYNAME_R */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004485 Py_END_ALLOW_THREADS
Charles-François Natali8b759652011-12-23 16:44:51 +01004486 ret = gethost_common(h, SAS2SA(&addr), sizeof(addr), af);
Guido van Rossum3baaa131999-03-22 21:44:51 +00004487#ifdef USE_GETHOSTBYNAME_LOCK
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004488 PyThread_release_lock(netdb_lock);
Guido van Rossum3baaa131999-03-22 21:44:51 +00004489#endif
Martin v. Löwisfc0275a2010-08-22 19:33:47 +00004490finally:
4491 PyMem_Free(ip_num);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004492 return ret;
Guido van Rossum3bbc62e1995-01-02 19:30:30 +00004493}
4494
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004495PyDoc_STRVAR(gethostbyaddr_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00004496"gethostbyaddr(host) -> (name, aliaslist, addresslist)\n\
4497\n\
4498Return the true host name, a list of aliases, and a list of IP addresses,\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004499for a host. The host argument is a string giving a host name or IP number.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00004500
Guido van Rossum30a685f1991-06-27 15:51:29 +00004501
4502/* Python interface to getservbyname(name).
4503 This only returns the port number, since the other info is already
4504 known or not useful (like the list of aliases). */
4505
4506/*ARGSUSED*/
Guido van Rossum73624e91994-10-10 17:59:00 +00004507static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00004508socket_getservbyname(PyObject *self, PyObject *args)
Guido van Rossum30a685f1991-06-27 15:51:29 +00004509{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004510 char *name, *proto=NULL;
4511 struct servent *sp;
4512 if (!PyArg_ParseTuple(args, "s|s:getservbyname", &name, &proto))
4513 return NULL;
4514 Py_BEGIN_ALLOW_THREADS
4515 sp = getservbyname(name, proto);
4516 Py_END_ALLOW_THREADS
4517 if (sp == NULL) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02004518 PyErr_SetString(PyExc_OSError, "service/proto not found");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004519 return NULL;
4520 }
4521 return PyLong_FromLong((long) ntohs(sp->s_port));
Guido van Rossum30a685f1991-06-27 15:51:29 +00004522}
4523
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004524PyDoc_STRVAR(getservbyname_doc,
Barry Warsaw11b91a02004-06-28 00:50:43 +00004525"getservbyname(servicename[, protocolname]) -> integer\n\
Guido van Rossum82a5c661998-07-07 20:45:43 +00004526\n\
4527Return a port number from a service name and protocol name.\n\
Barry Warsaw11b91a02004-06-28 00:50:43 +00004528The optional protocol name, if given, should be 'tcp' or 'udp',\n\
4529otherwise any protocol will match.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00004530
Guido van Rossum30a685f1991-06-27 15:51:29 +00004531
Barry Warsaw11b91a02004-06-28 00:50:43 +00004532/* Python interface to getservbyport(port).
4533 This only returns the service name, since the other info is already
4534 known or not useful (like the list of aliases). */
4535
4536/*ARGSUSED*/
4537static PyObject *
4538socket_getservbyport(PyObject *self, PyObject *args)
4539{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004540 int port;
4541 char *proto=NULL;
4542 struct servent *sp;
4543 if (!PyArg_ParseTuple(args, "i|s:getservbyport", &port, &proto))
4544 return NULL;
4545 if (port < 0 || port > 0xffff) {
4546 PyErr_SetString(
4547 PyExc_OverflowError,
4548 "getservbyport: port must be 0-65535.");
4549 return NULL;
4550 }
4551 Py_BEGIN_ALLOW_THREADS
4552 sp = getservbyport(htons((short)port), proto);
4553 Py_END_ALLOW_THREADS
4554 if (sp == NULL) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02004555 PyErr_SetString(PyExc_OSError, "port/proto not found");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004556 return NULL;
4557 }
4558 return PyUnicode_FromString(sp->s_name);
Barry Warsaw11b91a02004-06-28 00:50:43 +00004559}
4560
4561PyDoc_STRVAR(getservbyport_doc,
4562"getservbyport(port[, protocolname]) -> string\n\
4563\n\
4564Return the service name from a port number and protocol name.\n\
4565The optional protocol name, if given, should be 'tcp' or 'udp',\n\
4566otherwise any protocol will match.");
4567
Guido van Rossum3901d851996-12-19 16:35:04 +00004568/* Python interface to getprotobyname(name).
4569 This only returns the protocol number, since the other info is
4570 already known or not useful (like the list of aliases). */
4571
4572/*ARGSUSED*/
4573static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00004574socket_getprotobyname(PyObject *self, PyObject *args)
Guido van Rossum3901d851996-12-19 16:35:04 +00004575{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004576 char *name;
4577 struct protoent *sp;
4578 if (!PyArg_ParseTuple(args, "s:getprotobyname", &name))
4579 return NULL;
4580 Py_BEGIN_ALLOW_THREADS
4581 sp = getprotobyname(name);
4582 Py_END_ALLOW_THREADS
4583 if (sp == NULL) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02004584 PyErr_SetString(PyExc_OSError, "protocol not found");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004585 return NULL;
4586 }
4587 return PyLong_FromLong((long) sp->p_proto);
Guido van Rossum3901d851996-12-19 16:35:04 +00004588}
4589
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004590PyDoc_STRVAR(getprotobyname_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00004591"getprotobyname(name) -> integer\n\
4592\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004593Return the protocol number for the named protocol. (Rarely used.)");
Guido van Rossum82a5c661998-07-07 20:45:43 +00004594
Guido van Rossum3901d851996-12-19 16:35:04 +00004595
Guido van Rossum39eb8fa2007-11-16 01:24:05 +00004596#ifndef NO_DUP
4597/* dup() function for socket fds */
4598
4599static PyObject *
4600socket_dup(PyObject *self, PyObject *fdobj)
4601{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004602 SOCKET_T fd, newfd;
4603 PyObject *newfdobj;
Victor Stinnerdaf45552013-08-28 00:53:59 +02004604#ifdef MS_WINDOWS
4605 WSAPROTOCOL_INFO info;
4606#endif
Guido van Rossum39eb8fa2007-11-16 01:24:05 +00004607
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004608 fd = PyLong_AsSocket_t(fdobj);
4609 if (fd == (SOCKET_T)(-1) && PyErr_Occurred())
4610 return NULL;
Guido van Rossum39eb8fa2007-11-16 01:24:05 +00004611
Victor Stinnerdaf45552013-08-28 00:53:59 +02004612#ifdef MS_WINDOWS
4613 if (WSADuplicateSocket(fd, GetCurrentProcessId(), &info))
4614 return set_error();
4615
4616 newfd = WSASocket(FROM_PROTOCOL_INFO, FROM_PROTOCOL_INFO,
4617 FROM_PROTOCOL_INFO,
4618 &info, 0, WSA_FLAG_OVERLAPPED);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004619 if (newfd == INVALID_SOCKET)
4620 return set_error();
Guido van Rossum39eb8fa2007-11-16 01:24:05 +00004621
Victor Stinnerdaf45552013-08-28 00:53:59 +02004622 if (!SetHandleInformation((HANDLE)newfd, HANDLE_FLAG_INHERIT, 0)) {
4623 closesocket(newfd);
4624 PyErr_SetFromWindowsErr(0);
4625 return NULL;
4626 }
4627#else
4628 /* On UNIX, dup can be used to duplicate the file descriptor of a socket */
4629 newfd = _Py_dup(fd);
4630 if (newfd == INVALID_SOCKET)
Victor Stinnere990c6e2013-11-16 00:18:58 +01004631 return NULL;
Victor Stinnerdaf45552013-08-28 00:53:59 +02004632#endif
4633
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004634 newfdobj = PyLong_FromSocket_t(newfd);
4635 if (newfdobj == NULL)
4636 SOCKETCLOSE(newfd);
4637 return newfdobj;
Guido van Rossum39eb8fa2007-11-16 01:24:05 +00004638}
4639
4640PyDoc_STRVAR(dup_doc,
4641"dup(integer) -> integer\n\
4642\n\
4643Duplicate an integer socket file descriptor. This is like os.dup(), but for\n\
4644sockets; on some platforms os.dup() won't work for socket file descriptors.");
4645#endif
4646
4647
Dave Cole331708b2004-08-09 04:51:41 +00004648#ifdef HAVE_SOCKETPAIR
4649/* Create a pair of sockets using the socketpair() function.
Dave Cole07fda7e2004-08-23 05:16:23 +00004650 Arguments as for socket() except the default family is AF_UNIX if
Dave Colee8bbfe42004-08-26 00:51:16 +00004651 defined on the platform; otherwise, the default is AF_INET. */
Dave Cole331708b2004-08-09 04:51:41 +00004652
4653/*ARGSUSED*/
4654static PyObject *
4655socket_socketpair(PyObject *self, PyObject *args)
4656{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004657 PySocketSockObject *s0 = NULL, *s1 = NULL;
4658 SOCKET_T sv[2];
4659 int family, type = SOCK_STREAM, proto = 0;
4660 PyObject *res = NULL;
Victor Stinnerdaf45552013-08-28 00:53:59 +02004661#ifdef SOCK_CLOEXEC
4662 int *atomic_flag_works = &sock_cloexec_works;
4663#else
4664 int *atomic_flag_works = NULL;
4665#endif
4666 int ret;
Dave Cole331708b2004-08-09 04:51:41 +00004667
4668#if defined(AF_UNIX)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004669 family = AF_UNIX;
Dave Cole331708b2004-08-09 04:51:41 +00004670#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004671 family = AF_INET;
Dave Cole331708b2004-08-09 04:51:41 +00004672#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004673 if (!PyArg_ParseTuple(args, "|iii:socketpair",
4674 &family, &type, &proto))
4675 return NULL;
Victor Stinnerdaf45552013-08-28 00:53:59 +02004676
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004677 /* Create a pair of socket fds */
Victor Stinnerdaf45552013-08-28 00:53:59 +02004678 Py_BEGIN_ALLOW_THREADS
4679#ifdef SOCK_CLOEXEC
4680 if (sock_cloexec_works != 0) {
4681 ret = socketpair(family, type | SOCK_CLOEXEC, proto, sv);
4682 if (sock_cloexec_works == -1) {
4683 if (ret >= 0) {
4684 sock_cloexec_works = 1;
4685 }
4686 else if (errno == EINVAL) {
4687 /* Linux older than 2.6.27 does not support SOCK_CLOEXEC */
4688 sock_cloexec_works = 0;
4689 ret = socketpair(family, type, proto, sv);
4690 }
4691 }
4692 }
4693 else
4694#endif
4695 {
4696 ret = socketpair(family, type, proto, sv);
4697 }
4698 Py_END_ALLOW_THREADS
4699
4700 if (ret < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004701 return set_error();
Victor Stinnerdaf45552013-08-28 00:53:59 +02004702
4703 if (_Py_set_inheritable(sv[0], 0, atomic_flag_works) < 0)
4704 goto finally;
4705 if (_Py_set_inheritable(sv[1], 0, atomic_flag_works) < 0)
4706 goto finally;
4707
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004708 s0 = new_sockobject(sv[0], family, type, proto);
4709 if (s0 == NULL)
4710 goto finally;
4711 s1 = new_sockobject(sv[1], family, type, proto);
4712 if (s1 == NULL)
4713 goto finally;
4714 res = PyTuple_Pack(2, s0, s1);
Dave Cole331708b2004-08-09 04:51:41 +00004715
4716finally:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004717 if (res == NULL) {
4718 if (s0 == NULL)
4719 SOCKETCLOSE(sv[0]);
4720 if (s1 == NULL)
4721 SOCKETCLOSE(sv[1]);
4722 }
4723 Py_XDECREF(s0);
4724 Py_XDECREF(s1);
4725 return res;
Dave Cole331708b2004-08-09 04:51:41 +00004726}
4727
4728PyDoc_STRVAR(socketpair_doc,
Victor Stinnerdaf45552013-08-28 00:53:59 +02004729"socketpair([family[, type [, proto]]]) -> (socket object, socket object)\n\
Dave Cole331708b2004-08-09 04:51:41 +00004730\n\
4731Create a pair of socket objects from the sockets returned by the platform\n\
4732socketpair() function.\n\
Dave Cole07fda7e2004-08-23 05:16:23 +00004733The arguments are the same as for socket() except the default family is\n\
Dave Colee8bbfe42004-08-26 00:51:16 +00004734AF_UNIX if defined on the platform; otherwise, the default is AF_INET.");
Dave Cole331708b2004-08-09 04:51:41 +00004735
4736#endif /* HAVE_SOCKETPAIR */
4737
4738
Guido van Rossum006bf911996-06-12 04:04:55 +00004739static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00004740socket_ntohs(PyObject *self, PyObject *args)
Guido van Rossum006bf911996-06-12 04:04:55 +00004741{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004742 int x1, x2;
Guido van Rossum006bf911996-06-12 04:04:55 +00004743
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004744 if (!PyArg_ParseTuple(args, "i:ntohs", &x1)) {
4745 return NULL;
4746 }
4747 if (x1 < 0) {
4748 PyErr_SetString(PyExc_OverflowError,
4749 "can't convert negative number to unsigned long");
4750 return NULL;
4751 }
4752 x2 = (unsigned int)ntohs((unsigned short)x1);
4753 return PyLong_FromLong(x2);
Guido van Rossum006bf911996-06-12 04:04:55 +00004754}
4755
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004756PyDoc_STRVAR(ntohs_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00004757"ntohs(integer) -> integer\n\
4758\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004759Convert a 16-bit integer from network to host byte order.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00004760
4761
Guido van Rossum006bf911996-06-12 04:04:55 +00004762static PyObject *
Jeremy Hyltonc075e192002-07-25 16:01:12 +00004763socket_ntohl(PyObject *self, PyObject *arg)
Guido van Rossum006bf911996-06-12 04:04:55 +00004764{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004765 unsigned long x;
Guido van Rossum006bf911996-06-12 04:04:55 +00004766
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004767 if (PyLong_Check(arg)) {
4768 x = PyLong_AsUnsignedLong(arg);
4769 if (x == (unsigned long) -1 && PyErr_Occurred())
4770 return NULL;
Jeremy Hyltonc075e192002-07-25 16:01:12 +00004771#if SIZEOF_LONG > 4
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004772 {
4773 unsigned long y;
4774 /* only want the trailing 32 bits */
4775 y = x & 0xFFFFFFFFUL;
4776 if (y ^ x)
4777 return PyErr_Format(PyExc_OverflowError,
Serhiy Storchaka95949422013-08-27 19:40:23 +03004778 "int larger than 32 bits");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004779 x = y;
4780 }
Jeremy Hyltonc075e192002-07-25 16:01:12 +00004781#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004782 }
4783 else
4784 return PyErr_Format(PyExc_TypeError,
Serhiy Storchaka95949422013-08-27 19:40:23 +03004785 "expected int, %s found",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004786 Py_TYPE(arg)->tp_name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004787 return PyLong_FromUnsignedLong(ntohl(x));
Guido van Rossum006bf911996-06-12 04:04:55 +00004788}
4789
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004790PyDoc_STRVAR(ntohl_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00004791"ntohl(integer) -> integer\n\
4792\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004793Convert a 32-bit integer from network to host byte order.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00004794
4795
Guido van Rossum006bf911996-06-12 04:04:55 +00004796static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00004797socket_htons(PyObject *self, PyObject *args)
Guido van Rossum006bf911996-06-12 04:04:55 +00004798{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004799 int x1, x2;
Guido van Rossum006bf911996-06-12 04:04:55 +00004800
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004801 if (!PyArg_ParseTuple(args, "i:htons", &x1)) {
4802 return NULL;
4803 }
4804 if (x1 < 0) {
4805 PyErr_SetString(PyExc_OverflowError,
4806 "can't convert negative number to unsigned long");
4807 return NULL;
4808 }
4809 x2 = (unsigned int)htons((unsigned short)x1);
4810 return PyLong_FromLong(x2);
Guido van Rossum006bf911996-06-12 04:04:55 +00004811}
4812
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004813PyDoc_STRVAR(htons_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00004814"htons(integer) -> integer\n\
4815\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004816Convert a 16-bit integer from host to network byte order.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00004817
4818
Guido van Rossum006bf911996-06-12 04:04:55 +00004819static PyObject *
Jeremy Hyltonc075e192002-07-25 16:01:12 +00004820socket_htonl(PyObject *self, PyObject *arg)
Guido van Rossum006bf911996-06-12 04:04:55 +00004821{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004822 unsigned long x;
Guido van Rossum006bf911996-06-12 04:04:55 +00004823
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004824 if (PyLong_Check(arg)) {
4825 x = PyLong_AsUnsignedLong(arg);
4826 if (x == (unsigned long) -1 && PyErr_Occurred())
4827 return NULL;
Jeremy Hyltonc075e192002-07-25 16:01:12 +00004828#if SIZEOF_LONG > 4
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004829 {
4830 unsigned long y;
4831 /* only want the trailing 32 bits */
4832 y = x & 0xFFFFFFFFUL;
4833 if (y ^ x)
4834 return PyErr_Format(PyExc_OverflowError,
Serhiy Storchaka95949422013-08-27 19:40:23 +03004835 "int larger than 32 bits");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004836 x = y;
4837 }
Jeremy Hyltonc075e192002-07-25 16:01:12 +00004838#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004839 }
4840 else
4841 return PyErr_Format(PyExc_TypeError,
Serhiy Storchaka95949422013-08-27 19:40:23 +03004842 "expected int, %s found",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004843 Py_TYPE(arg)->tp_name);
4844 return PyLong_FromUnsignedLong(htonl((unsigned long)x));
Guido van Rossum006bf911996-06-12 04:04:55 +00004845}
4846
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004847PyDoc_STRVAR(htonl_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00004848"htonl(integer) -> integer\n\
4849\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004850Convert a 32-bit integer from host to network byte order.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00004851
Guido van Rossum3eede5a2002-06-07 02:08:35 +00004852/* socket.inet_aton() and socket.inet_ntoa() functions. */
Guido van Rossum5c9eb211999-08-20 18:21:51 +00004853
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004854PyDoc_STRVAR(inet_aton_doc,
Guido van Rossum7d0a8262007-05-21 23:13:11 +00004855"inet_aton(string) -> bytes giving packed 32-bit IP representation\n\
Guido van Rossum5c9eb211999-08-20 18:21:51 +00004856\n\
Guido van Rossumc6a164b1999-08-20 19:11:27 +00004857Convert an IP address in string format (123.45.67.89) to the 32-bit packed\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004858binary format used in low-level network functions.");
Guido van Rossum5c9eb211999-08-20 18:21:51 +00004859
4860static PyObject*
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00004861socket_inet_aton(PyObject *self, PyObject *args)
Guido van Rossum5c9eb211999-08-20 18:21:51 +00004862{
Neal Norwitz88f115b2003-02-13 02:15:42 +00004863#ifdef HAVE_INET_ATON
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004864 struct in_addr buf;
Thomas Wouters477c8d52006-05-27 19:21:47 +00004865#endif
4866
4867#if !defined(HAVE_INET_ATON) || defined(USE_INET_ATON_WEAKLINK)
Benjamin Petersonf91df042009-02-13 02:50:59 +00004868#if (SIZEOF_INT != 4)
4869#error "Not sure if in_addr_t exists and int is not 32-bits."
4870#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004871 /* Have to use inet_addr() instead */
4872 unsigned int packed_addr;
Tim Peters1df9fdd2003-02-13 03:13:40 +00004873#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004874 char *ip_addr;
Guido van Rossumc6a164b1999-08-20 19:11:27 +00004875
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004876 if (!PyArg_ParseTuple(args, "s:inet_aton", &ip_addr))
4877 return NULL;
Guido van Rossumad05cdf2003-02-12 23:08:22 +00004878
Tim Peters1df9fdd2003-02-13 03:13:40 +00004879
4880#ifdef HAVE_INET_ATON
Thomas Wouters477c8d52006-05-27 19:21:47 +00004881
4882#ifdef USE_INET_ATON_WEAKLINK
4883 if (inet_aton != NULL) {
4884#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004885 if (inet_aton(ip_addr, &buf))
4886 return PyBytes_FromStringAndSize((char *)(&buf),
4887 sizeof(buf));
Guido van Rossumad05cdf2003-02-12 23:08:22 +00004888
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02004889 PyErr_SetString(PyExc_OSError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004890 "illegal IP address string passed to inet_aton");
4891 return NULL;
Guido van Rossumad05cdf2003-02-12 23:08:22 +00004892
Thomas Wouters477c8d52006-05-27 19:21:47 +00004893#ifdef USE_INET_ATON_WEAKLINK
4894 } else {
4895#endif
4896
4897#endif
4898
4899#if !defined(HAVE_INET_ATON) || defined(USE_INET_ATON_WEAKLINK)
4900
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004901 /* special-case this address as inet_addr might return INADDR_NONE
4902 * for this */
4903 if (strcmp(ip_addr, "255.255.255.255") == 0) {
Charles-François Natali24aa0412013-08-31 14:48:25 +02004904 packed_addr = INADDR_BROADCAST;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004905 } else {
Thomas Wouters477c8d52006-05-27 19:21:47 +00004906
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004907 packed_addr = inet_addr(ip_addr);
Guido van Rossumc6a164b1999-08-20 19:11:27 +00004908
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004909 if (packed_addr == INADDR_NONE) { /* invalid address */
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02004910 PyErr_SetString(PyExc_OSError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004911 "illegal IP address string passed to inet_aton");
4912 return NULL;
4913 }
4914 }
4915 return PyBytes_FromStringAndSize((char *) &packed_addr,
4916 sizeof(packed_addr));
Thomas Wouters477c8d52006-05-27 19:21:47 +00004917
4918#ifdef USE_INET_ATON_WEAKLINK
4919 }
4920#endif
4921
Guido van Rossumad05cdf2003-02-12 23:08:22 +00004922#endif
Guido van Rossum5c9eb211999-08-20 18:21:51 +00004923}
4924
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004925PyDoc_STRVAR(inet_ntoa_doc,
Fred Drakee0661342000-03-07 14:05:16 +00004926"inet_ntoa(packed_ip) -> ip_address_string\n\
Guido van Rossum5c9eb211999-08-20 18:21:51 +00004927\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004928Convert an IP address from 32-bit packed binary format to string format");
Guido van Rossum5c9eb211999-08-20 18:21:51 +00004929
4930static PyObject*
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00004931socket_inet_ntoa(PyObject *self, PyObject *args)
Guido van Rossum5c9eb211999-08-20 18:21:51 +00004932{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004933 char *packed_str;
4934 int addr_len;
4935 struct in_addr packed_addr;
Guido van Rossum5c9eb211999-08-20 18:21:51 +00004936
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004937 if (!PyArg_ParseTuple(args, "y#:inet_ntoa", &packed_str, &addr_len)) {
4938 return NULL;
4939 }
Guido van Rossum48a680c2001-03-02 06:34:14 +00004940
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004941 if (addr_len != sizeof(packed_addr)) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02004942 PyErr_SetString(PyExc_OSError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004943 "packed IP wrong length for inet_ntoa");
4944 return NULL;
4945 }
Guido van Rossum5c9eb211999-08-20 18:21:51 +00004946
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004947 memcpy(&packed_addr, packed_str, addr_len);
Guido van Rossum5c9eb211999-08-20 18:21:51 +00004948
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004949 return PyUnicode_FromString(inet_ntoa(packed_addr));
Guido van Rossum5c9eb211999-08-20 18:21:51 +00004950}
Guido van Rossum82a5c661998-07-07 20:45:43 +00004951
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09004952#if defined(HAVE_INET_PTON) || defined(MS_WINDOWS)
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00004953
4954PyDoc_STRVAR(inet_pton_doc,
4955"inet_pton(af, ip) -> packed IP address string\n\
4956\n\
4957Convert an IP address from string format to a packed string suitable\n\
4958for use with low-level network functions.");
4959
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09004960#endif
4961
4962#ifdef HAVE_INET_PTON
4963
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00004964static PyObject *
4965socket_inet_pton(PyObject *self, PyObject *args)
4966{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004967 int af;
4968 char* ip;
4969 int retval;
Martin v. Löwisa94568a2003-05-10 07:36:56 +00004970#ifdef ENABLE_IPV6
Victor Stinner640c35c2013-06-04 23:14:37 +02004971 char packed[Py_MAX(sizeof(struct in_addr), sizeof(struct in6_addr))];
Martin v. Löwisa94568a2003-05-10 07:36:56 +00004972#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004973 char packed[sizeof(struct in_addr)];
Martin v. Löwisa94568a2003-05-10 07:36:56 +00004974#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004975 if (!PyArg_ParseTuple(args, "is:inet_pton", &af, &ip)) {
4976 return NULL;
4977 }
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00004978
Martin v. Löwis04697e82004-06-02 12:35:29 +00004979#if !defined(ENABLE_IPV6) && defined(AF_INET6)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004980 if(af == AF_INET6) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02004981 PyErr_SetString(PyExc_OSError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004982 "can't use AF_INET6, IPv6 is disabled");
4983 return NULL;
4984 }
Thomas Wouters477c8d52006-05-27 19:21:47 +00004985#endif
Martin v. Löwis10649092003-08-05 06:25:06 +00004986
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004987 retval = inet_pton(af, ip, packed);
4988 if (retval < 0) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02004989 PyErr_SetFromErrno(PyExc_OSError);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004990 return NULL;
4991 } else if (retval == 0) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02004992 PyErr_SetString(PyExc_OSError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004993 "illegal IP address string passed to inet_pton");
4994 return NULL;
4995 } else if (af == AF_INET) {
4996 return PyBytes_FromStringAndSize(packed,
4997 sizeof(struct in_addr));
Martin v. Löwisa94568a2003-05-10 07:36:56 +00004998#ifdef ENABLE_IPV6
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004999 } else if (af == AF_INET6) {
5000 return PyBytes_FromStringAndSize(packed,
5001 sizeof(struct in6_addr));
Martin v. Löwisa94568a2003-05-10 07:36:56 +00005002#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005003 } else {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02005004 PyErr_SetString(PyExc_OSError, "unknown address family");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005005 return NULL;
5006 }
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00005007}
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005008#elif defined(MS_WINDOWS)
5009
5010static PyObject *
5011socket_inet_pton(PyObject *self, PyObject *args)
5012{
5013 int af;
5014 char* ip;
5015 struct sockaddr_in6 addr;
5016 INT ret, size;
5017
5018 if (!PyArg_ParseTuple(args, "is:inet_pton", &af, &ip)) {
5019 return NULL;
5020 }
5021
Victor Stinnere990c6e2013-11-16 00:18:58 +01005022 size = sizeof(addr);
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005023 ret = WSAStringToAddressA(ip, af, NULL, (LPSOCKADDR)&addr, &size);
5024
5025 if (ret) {
5026 PyErr_SetExcFromWindowsErr(PyExc_OSError, WSAGetLastError());
5027 return NULL;
5028 } else if(af == AF_INET) {
5029 struct sockaddr_in *addr4 = (struct sockaddr_in*)&addr;
Victor Stinnere990c6e2013-11-16 00:18:58 +01005030 return PyBytes_FromStringAndSize((const char *)&(addr4->sin_addr),
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005031 sizeof(addr4->sin_addr));
5032 } else if (af == AF_INET6) {
Victor Stinnere990c6e2013-11-16 00:18:58 +01005033 return PyBytes_FromStringAndSize((const char *)&(addr.sin6_addr),
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005034 sizeof(addr.sin6_addr));
5035 } else {
5036 PyErr_SetString(PyExc_OSError, "unknown address family");
5037 return NULL;
5038 }
5039}
5040
5041#endif
5042
5043#if defined(HAVE_INET_PTON) || defined(MS_WINDOWS)
Thomas Wouters477c8d52006-05-27 19:21:47 +00005044
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00005045PyDoc_STRVAR(inet_ntop_doc,
5046"inet_ntop(af, packed_ip) -> string formatted IP address\n\
5047\n\
5048Convert a packed IP address of the given family to string format.");
5049
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005050#endif
5051
5052
5053#ifdef HAVE_INET_PTON
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00005054static PyObject *
5055socket_inet_ntop(PyObject *self, PyObject *args)
5056{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005057 int af;
5058 char* packed;
5059 int len;
5060 const char* retval;
Martin v. Löwisa94568a2003-05-10 07:36:56 +00005061#ifdef ENABLE_IPV6
Victor Stinner640c35c2013-06-04 23:14:37 +02005062 char ip[Py_MAX(INET_ADDRSTRLEN, INET6_ADDRSTRLEN) + 1];
Martin v. Löwisa94568a2003-05-10 07:36:56 +00005063#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005064 char ip[INET_ADDRSTRLEN + 1];
Martin v. Löwisa94568a2003-05-10 07:36:56 +00005065#endif
Thomas Wouters477c8d52006-05-27 19:21:47 +00005066
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005067 /* Guarantee NUL-termination for PyUnicode_FromString() below */
5068 memset((void *) &ip[0], '\0', sizeof(ip));
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00005069
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005070 if (!PyArg_ParseTuple(args, "iy#:inet_ntop", &af, &packed, &len)) {
5071 return NULL;
5072 }
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00005073
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005074 if (af == AF_INET) {
5075 if (len != sizeof(struct in_addr)) {
5076 PyErr_SetString(PyExc_ValueError,
5077 "invalid length of packed IP address string");
5078 return NULL;
5079 }
Martin v. Löwisa94568a2003-05-10 07:36:56 +00005080#ifdef ENABLE_IPV6
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005081 } else if (af == AF_INET6) {
5082 if (len != sizeof(struct in6_addr)) {
5083 PyErr_SetString(PyExc_ValueError,
5084 "invalid length of packed IP address string");
5085 return NULL;
5086 }
Martin v. Löwisa94568a2003-05-10 07:36:56 +00005087#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005088 } else {
5089 PyErr_Format(PyExc_ValueError,
5090 "unknown address family %d", af);
5091 return NULL;
5092 }
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00005093
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005094 retval = inet_ntop(af, packed, ip, sizeof(ip));
5095 if (!retval) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02005096 PyErr_SetFromErrno(PyExc_OSError);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005097 return NULL;
5098 } else {
5099 return PyUnicode_FromString(retval);
5100 }
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00005101
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005102 /* NOTREACHED */
5103 PyErr_SetString(PyExc_RuntimeError, "invalid handling of inet_ntop");
5104 return NULL;
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00005105}
5106
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005107#elif defined(MS_WINDOWS)
5108
5109static PyObject *
5110socket_inet_ntop(PyObject *self, PyObject *args)
5111{
5112 int af;
5113 char* packed;
5114 int len;
5115 struct sockaddr_in6 addr;
5116 DWORD addrlen, ret, retlen;
Jason R. Coombs8ec784c2013-11-10 13:43:22 -05005117#ifdef ENABLE_IPV6
5118 char ip[Py_MAX(INET_ADDRSTRLEN, INET6_ADDRSTRLEN) + 1];
5119#else
5120 char ip[INET_ADDRSTRLEN + 1];
5121#endif
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005122
5123 /* Guarantee NUL-termination for PyUnicode_FromString() below */
5124 memset((void *) &ip[0], '\0', sizeof(ip));
5125
5126 if (!PyArg_ParseTuple(args, "iy#:inet_ntop", &af, &packed, &len)) {
5127 return NULL;
5128 }
5129
5130 if (af == AF_INET) {
5131 struct sockaddr_in * addr4 = (struct sockaddr_in *)&addr;
5132
5133 if (len != sizeof(struct in_addr)) {
5134 PyErr_SetString(PyExc_ValueError,
5135 "invalid length of packed IP address string");
5136 return NULL;
5137 }
5138 memset(addr4, 0, sizeof(struct sockaddr_in));
5139 addr4->sin_family = AF_INET;
5140 memcpy(&(addr4->sin_addr), packed, sizeof(addr4->sin_addr));
5141 addrlen = sizeof(struct sockaddr_in);
5142 } else if (af == AF_INET6) {
5143 if (len != sizeof(struct in6_addr)) {
5144 PyErr_SetString(PyExc_ValueError,
5145 "invalid length of packed IP address string");
5146 return NULL;
5147 }
5148
5149 memset(&addr, 0, sizeof(addr));
5150 addr.sin6_family = AF_INET6;
5151 memcpy(&(addr.sin6_addr), packed, sizeof(addr.sin6_addr));
5152 addrlen = sizeof(addr);
5153 } else {
5154 PyErr_Format(PyExc_ValueError,
5155 "unknown address family %d", af);
5156 return NULL;
5157 }
5158
5159 retlen = sizeof(ip);
Victor Stinnere990c6e2013-11-16 00:18:58 +01005160 ret = WSAAddressToStringA((struct sockaddr*)&addr, addrlen, NULL,
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005161 ip, &retlen);
5162
5163 if (ret) {
5164 PyErr_SetExcFromWindowsErr(PyExc_OSError, WSAGetLastError());
5165 return NULL;
5166 } else {
5167 return PyUnicode_FromString(ip);
5168 }
5169}
5170
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00005171#endif /* HAVE_INET_PTON */
5172
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00005173/* Python interface to getaddrinfo(host, port). */
5174
5175/*ARGSUSED*/
5176static PyObject *
Giampaolo Rodolàccfb91c2010-08-17 15:30:23 +00005177socket_getaddrinfo(PyObject *self, PyObject *args, PyObject* kwargs)
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00005178{
Victor Stinner77af1722011-05-26 14:05:59 +02005179 static char* kwnames[] = {"host", "port", "family", "type", "proto",
Giampaolo Rodolàccfb91c2010-08-17 15:30:23 +00005180 "flags", 0};
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005181 struct addrinfo hints, *res;
5182 struct addrinfo *res0 = NULL;
5183 PyObject *hobj = NULL;
5184 PyObject *pobj = (PyObject *)NULL;
5185 char pbuf[30];
5186 char *hptr, *pptr;
5187 int family, socktype, protocol, flags;
5188 int error;
5189 PyObject *all = (PyObject *)NULL;
5190 PyObject *idna = NULL;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00005191
Georg Brandl6083a4b2013-10-14 06:51:46 +02005192 socktype = protocol = flags = 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005193 family = AF_UNSPEC;
Victor Stinner77af1722011-05-26 14:05:59 +02005194 if (!PyArg_ParseTupleAndKeywords(args, kwargs, "OO|iiii:getaddrinfo",
Giampaolo Rodolàccfb91c2010-08-17 15:30:23 +00005195 kwnames, &hobj, &pobj, &family, &socktype,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005196 &protocol, &flags)) {
5197 return NULL;
5198 }
5199 if (hobj == Py_None) {
5200 hptr = NULL;
5201 } else if (PyUnicode_Check(hobj)) {
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02005202 _Py_IDENTIFIER(encode);
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02005203
5204 idna = _PyObject_CallMethodId(hobj, &PyId_encode, "s", "idna");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005205 if (!idna)
5206 return NULL;
5207 assert(PyBytes_Check(idna));
5208 hptr = PyBytes_AS_STRING(idna);
5209 } else if (PyBytes_Check(hobj)) {
5210 hptr = PyBytes_AsString(hobj);
5211 } else {
5212 PyErr_SetString(PyExc_TypeError,
5213 "getaddrinfo() argument 1 must be string or None");
5214 return NULL;
5215 }
5216 if (PyLong_CheckExact(pobj)) {
5217 long value = PyLong_AsLong(pobj);
5218 if (value == -1 && PyErr_Occurred())
5219 goto err;
5220 PyOS_snprintf(pbuf, sizeof(pbuf), "%ld", value);
5221 pptr = pbuf;
5222 } else if (PyUnicode_Check(pobj)) {
5223 pptr = _PyUnicode_AsString(pobj);
Alexander Belopolskye239d232010-12-08 23:31:48 +00005224 if (pptr == NULL)
5225 goto err;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005226 } else if (PyBytes_Check(pobj)) {
Alexander Belopolskye239d232010-12-08 23:31:48 +00005227 pptr = PyBytes_AS_STRING(pobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005228 } else if (pobj == Py_None) {
5229 pptr = (char *)NULL;
5230 } else {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02005231 PyErr_SetString(PyExc_OSError, "Int or String expected");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005232 goto err;
5233 }
Ronald Oussorena822d3662013-06-10 10:36:28 +02005234#if defined(__APPLE__) && defined(AI_NUMERICSERV)
Ronald Oussoren27a4ac52013-05-24 13:47:37 +02005235 if ((flags & AI_NUMERICSERV) && (pptr == NULL || (pptr[0] == '0' && pptr[1] == 0))) {
5236 /* On OSX upto at least OSX 10.8 getaddrinfo crashes
Christian Heimesaf01f662013-12-21 16:19:10 +01005237 * if AI_NUMERICSERV is set and the servname is NULL or "0".
5238 * This workaround avoids a segfault in libsystem.
5239 */
Ronald Oussoren27a4ac52013-05-24 13:47:37 +02005240 pptr = "00";
5241 }
5242#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005243 memset(&hints, 0, sizeof(hints));
5244 hints.ai_family = family;
5245 hints.ai_socktype = socktype;
5246 hints.ai_protocol = protocol;
5247 hints.ai_flags = flags;
5248 Py_BEGIN_ALLOW_THREADS
5249 ACQUIRE_GETADDRINFO_LOCK
5250 error = getaddrinfo(hptr, pptr, &hints, &res0);
5251 Py_END_ALLOW_THREADS
5252 RELEASE_GETADDRINFO_LOCK /* see comment in setipaddr() */
5253 if (error) {
5254 set_gaierror(error);
5255 goto err;
5256 }
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00005257
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005258 if ((all = PyList_New(0)) == NULL)
5259 goto err;
5260 for (res = res0; res; res = res->ai_next) {
5261 PyObject *single;
5262 PyObject *addr =
5263 makesockaddr(-1, res->ai_addr, res->ai_addrlen, protocol);
5264 if (addr == NULL)
5265 goto err;
5266 single = Py_BuildValue("iiisO", res->ai_family,
5267 res->ai_socktype, res->ai_protocol,
5268 res->ai_canonname ? res->ai_canonname : "",
5269 addr);
5270 Py_DECREF(addr);
5271 if (single == NULL)
5272 goto err;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00005273
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005274 if (PyList_Append(all, single))
5275 goto err;
5276 Py_XDECREF(single);
5277 }
5278 Py_XDECREF(idna);
5279 if (res0)
5280 freeaddrinfo(res0);
5281 return all;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00005282 err:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005283 Py_XDECREF(all);
5284 Py_XDECREF(idna);
5285 if (res0)
5286 freeaddrinfo(res0);
5287 return (PyObject *)NULL;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00005288}
5289
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00005290PyDoc_STRVAR(getaddrinfo_doc,
Guido van Rossum22a97152002-08-08 20:37:08 +00005291"getaddrinfo(host, port [, family, socktype, proto, flags])\n\
5292 -> list of (family, socktype, proto, canonname, sockaddr)\n\
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00005293\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00005294Resolve host and port into addrinfo struct.");
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00005295
5296/* Python interface to getnameinfo(sa, flags). */
5297
5298/*ARGSUSED*/
5299static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00005300socket_getnameinfo(PyObject *self, PyObject *args)
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00005301{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005302 PyObject *sa = (PyObject *)NULL;
5303 int flags;
5304 char *hostp;
Charles-François Natali366999a2012-01-02 15:47:29 +01005305 int port;
5306 unsigned int flowinfo, scope_id;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005307 char hbuf[NI_MAXHOST], pbuf[NI_MAXSERV];
5308 struct addrinfo hints, *res = NULL;
5309 int error;
5310 PyObject *ret = (PyObject *)NULL;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00005311
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005312 flags = flowinfo = scope_id = 0;
5313 if (!PyArg_ParseTuple(args, "Oi:getnameinfo", &sa, &flags))
5314 return NULL;
5315 if (!PyTuple_Check(sa)) {
5316 PyErr_SetString(PyExc_TypeError,
5317 "getnameinfo() argument 1 must be a tuple");
5318 return NULL;
5319 }
Charles-François Natali366999a2012-01-02 15:47:29 +01005320 if (!PyArg_ParseTuple(sa, "si|II",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005321 &hostp, &port, &flowinfo, &scope_id))
5322 return NULL;
Charles-François Natali9b0c0062012-06-23 10:17:05 +02005323 if (flowinfo > 0xfffff) {
Charles-François Natali366999a2012-01-02 15:47:29 +01005324 PyErr_SetString(PyExc_OverflowError,
5325 "getsockaddrarg: flowinfo must be 0-1048575.");
5326 return NULL;
5327 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005328 PyOS_snprintf(pbuf, sizeof(pbuf), "%d", port);
5329 memset(&hints, 0, sizeof(hints));
5330 hints.ai_family = AF_UNSPEC;
5331 hints.ai_socktype = SOCK_DGRAM; /* make numeric port happy */
Martin v. Löwis112c0f32010-08-25 07:38:15 +00005332 hints.ai_flags = AI_NUMERICHOST; /* don't do any name resolution */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005333 Py_BEGIN_ALLOW_THREADS
5334 ACQUIRE_GETADDRINFO_LOCK
5335 error = getaddrinfo(hostp, pbuf, &hints, &res);
5336 Py_END_ALLOW_THREADS
5337 RELEASE_GETADDRINFO_LOCK /* see comment in setipaddr() */
5338 if (error) {
5339 set_gaierror(error);
5340 goto fail;
5341 }
5342 if (res->ai_next) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02005343 PyErr_SetString(PyExc_OSError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005344 "sockaddr resolved to multiple addresses");
5345 goto fail;
5346 }
5347 switch (res->ai_family) {
5348 case AF_INET:
5349 {
5350 if (PyTuple_GET_SIZE(sa) != 2) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02005351 PyErr_SetString(PyExc_OSError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005352 "IPv4 sockaddr must be 2 tuple");
5353 goto fail;
5354 }
5355 break;
5356 }
Martin v. Löwis44ddbde2001-12-02 10:15:37 +00005357#ifdef ENABLE_IPV6
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005358 case AF_INET6:
5359 {
5360 struct sockaddr_in6 *sin6;
5361 sin6 = (struct sockaddr_in6 *)res->ai_addr;
Charles-François Natali366999a2012-01-02 15:47:29 +01005362 sin6->sin6_flowinfo = htonl(flowinfo);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005363 sin6->sin6_scope_id = scope_id;
5364 break;
5365 }
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00005366#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005367 }
Antoine Pitrou19467d22010-08-17 19:33:30 +00005368 error = getnameinfo(res->ai_addr, (socklen_t) res->ai_addrlen,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005369 hbuf, sizeof(hbuf), pbuf, sizeof(pbuf), flags);
5370 if (error) {
5371 set_gaierror(error);
5372 goto fail;
5373 }
5374 ret = Py_BuildValue("ss", hbuf, pbuf);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00005375
5376fail:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005377 if (res)
5378 freeaddrinfo(res);
5379 return ret;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00005380}
5381
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00005382PyDoc_STRVAR(getnameinfo_doc,
Guido van Rossum22a97152002-08-08 20:37:08 +00005383"getnameinfo(sockaddr, flags) --> (host, port)\n\
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00005384\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00005385Get host and port for a sockaddr.");
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00005386
Guido van Rossum9d0c8ce2002-07-18 17:08:35 +00005387
5388/* Python API to getting and setting the default timeout value. */
5389
5390static PyObject *
5391socket_getdefaulttimeout(PyObject *self)
5392{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005393 if (defaulttimeout < 0.0) {
5394 Py_INCREF(Py_None);
5395 return Py_None;
5396 }
5397 else
5398 return PyFloat_FromDouble(defaulttimeout);
Guido van Rossum9d0c8ce2002-07-18 17:08:35 +00005399}
5400
5401PyDoc_STRVAR(getdefaulttimeout_doc,
Guido van Rossum22a97152002-08-08 20:37:08 +00005402"getdefaulttimeout() -> timeout\n\
Guido van Rossum9d0c8ce2002-07-18 17:08:35 +00005403\n\
Ezio Melotti388c9452011-08-14 08:28:57 +03005404Returns the default timeout in seconds (float) for new socket objects.\n\
Guido van Rossum9d0c8ce2002-07-18 17:08:35 +00005405A value of None indicates that new socket objects have no timeout.\n\
5406When the socket module is first imported, the default is None.");
5407
5408static PyObject *
5409socket_setdefaulttimeout(PyObject *self, PyObject *arg)
5410{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005411 double timeout;
Guido van Rossum9d0c8ce2002-07-18 17:08:35 +00005412
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005413 if (arg == Py_None)
5414 timeout = -1.0;
5415 else {
5416 timeout = PyFloat_AsDouble(arg);
5417 if (timeout < 0.0) {
5418 if (!PyErr_Occurred())
5419 PyErr_SetString(PyExc_ValueError,
5420 "Timeout value out of range");
5421 return NULL;
5422 }
5423 }
Guido van Rossum9d0c8ce2002-07-18 17:08:35 +00005424
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005425 defaulttimeout = timeout;
Guido van Rossum9d0c8ce2002-07-18 17:08:35 +00005426
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005427 Py_INCREF(Py_None);
5428 return Py_None;
Guido van Rossum9d0c8ce2002-07-18 17:08:35 +00005429}
5430
5431PyDoc_STRVAR(setdefaulttimeout_doc,
Guido van Rossum22a97152002-08-08 20:37:08 +00005432"setdefaulttimeout(timeout)\n\
Guido van Rossum9d0c8ce2002-07-18 17:08:35 +00005433\n\
Ezio Melotti388c9452011-08-14 08:28:57 +03005434Set the default timeout in seconds (float) for new socket objects.\n\
Guido van Rossum9d0c8ce2002-07-18 17:08:35 +00005435A value of None indicates that new socket objects have no timeout.\n\
5436When the socket module is first imported, the default is None.");
5437
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005438#ifdef HAVE_IF_NAMEINDEX
5439/* Python API for getting interface indices and names */
5440
5441static PyObject *
5442socket_if_nameindex(PyObject *self, PyObject *arg)
5443{
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005444 PyObject *list;
Charles-François Natali60713592011-05-20 16:55:06 +02005445 int i;
5446 struct if_nameindex *ni;
Victor Stinner77af1722011-05-26 14:05:59 +02005447
Charles-François Natali60713592011-05-20 16:55:06 +02005448 ni = if_nameindex();
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005449 if (ni == NULL) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02005450 PyErr_SetFromErrno(PyExc_OSError);
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005451 return NULL;
5452 }
5453
5454 list = PyList_New(0);
5455 if (list == NULL) {
5456 if_freenameindex(ni);
5457 return NULL;
5458 }
5459
Charles-François Natali60713592011-05-20 16:55:06 +02005460 for (i = 0; ni[i].if_index != 0 && i < INT_MAX; i++) {
5461 PyObject *ni_tuple = Py_BuildValue("IO&",
5462 ni[i].if_index, PyUnicode_DecodeFSDefault, ni[i].if_name);
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005463
5464 if (ni_tuple == NULL || PyList_Append(list, ni_tuple) == -1) {
5465 Py_XDECREF(ni_tuple);
Charles-François Natali60713592011-05-20 16:55:06 +02005466 Py_DECREF(list);
5467 if_freenameindex(ni);
5468 return NULL;
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005469 }
5470 Py_DECREF(ni_tuple);
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005471 }
5472
5473 if_freenameindex(ni);
5474 return list;
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005475}
5476
5477PyDoc_STRVAR(if_nameindex_doc,
5478"if_nameindex()\n\
5479\n\
5480Returns a list of network interface information (index, name) tuples.");
5481
Charles-François Natali60713592011-05-20 16:55:06 +02005482static PyObject *
5483socket_if_nametoindex(PyObject *self, PyObject *args)
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005484{
Charles-François Natali60713592011-05-20 16:55:06 +02005485 PyObject *oname;
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005486 unsigned long index;
5487
Charles-François Natali60713592011-05-20 16:55:06 +02005488 if (!PyArg_ParseTuple(args, "O&:if_nametoindex",
5489 PyUnicode_FSConverter, &oname))
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005490 return NULL;
5491
Charles-François Natali60713592011-05-20 16:55:06 +02005492 index = if_nametoindex(PyBytes_AS_STRING(oname));
5493 Py_DECREF(oname);
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005494 if (index == 0) {
Charles-François Natali60713592011-05-20 16:55:06 +02005495 /* if_nametoindex() doesn't set errno */
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02005496 PyErr_SetString(PyExc_OSError, "no interface with this name");
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005497 return NULL;
5498 }
5499
5500 return PyLong_FromUnsignedLong(index);
5501}
5502
5503PyDoc_STRVAR(if_nametoindex_doc,
5504"if_nametoindex(if_name)\n\
5505\n\
5506Returns the interface index corresponding to the interface name if_name.");
5507
Charles-François Natali60713592011-05-20 16:55:06 +02005508static PyObject *
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005509socket_if_indextoname(PyObject *self, PyObject *arg)
5510{
Charles-François Natali60713592011-05-20 16:55:06 +02005511 unsigned long index;
5512 char name[IF_NAMESIZE + 1];
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005513
Charles-François Natali60713592011-05-20 16:55:06 +02005514 index = PyLong_AsUnsignedLong(arg);
5515 if (index == (unsigned long) -1)
5516 return NULL;
5517
5518 if (if_indextoname(index, name) == NULL) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02005519 PyErr_SetFromErrno(PyExc_OSError);
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005520 return NULL;
5521 }
5522
Charles-François Natali60713592011-05-20 16:55:06 +02005523 return PyUnicode_DecodeFSDefault(name);
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005524}
5525
5526PyDoc_STRVAR(if_indextoname_doc,
5527"if_indextoname(if_index)\n\
5528\n\
5529Returns the interface name corresponding to the interface index if_index.");
5530
5531#endif /* HAVE_IF_NAMEINDEX */
5532
5533
Nick Coghlan96fe56a2011-08-22 11:55:57 +10005534#ifdef CMSG_LEN
5535/* Python interface to CMSG_LEN(length). */
5536
5537static PyObject *
5538socket_CMSG_LEN(PyObject *self, PyObject *args)
5539{
5540 Py_ssize_t length;
5541 size_t result;
5542
5543 if (!PyArg_ParseTuple(args, "n:CMSG_LEN", &length))
5544 return NULL;
5545 if (length < 0 || !get_CMSG_LEN(length, &result)) {
5546 PyErr_Format(PyExc_OverflowError, "CMSG_LEN() argument out of range");
5547 return NULL;
5548 }
5549 return PyLong_FromSize_t(result);
5550}
5551
5552PyDoc_STRVAR(CMSG_LEN_doc,
5553"CMSG_LEN(length) -> control message length\n\
5554\n\
5555Return the total length, without trailing padding, of an ancillary\n\
5556data item with associated data of the given length. This value can\n\
5557often be used as the buffer size for recvmsg() to receive a single\n\
5558item of ancillary data, but RFC 3542 requires portable applications to\n\
5559use CMSG_SPACE() and thus include space for padding, even when the\n\
5560item will be the last in the buffer. Raises OverflowError if length\n\
5561is outside the permissible range of values.");
5562
5563
5564#ifdef CMSG_SPACE
5565/* Python interface to CMSG_SPACE(length). */
5566
5567static PyObject *
5568socket_CMSG_SPACE(PyObject *self, PyObject *args)
5569{
5570 Py_ssize_t length;
5571 size_t result;
5572
5573 if (!PyArg_ParseTuple(args, "n:CMSG_SPACE", &length))
5574 return NULL;
5575 if (length < 0 || !get_CMSG_SPACE(length, &result)) {
5576 PyErr_SetString(PyExc_OverflowError,
5577 "CMSG_SPACE() argument out of range");
5578 return NULL;
5579 }
5580 return PyLong_FromSize_t(result);
5581}
5582
5583PyDoc_STRVAR(CMSG_SPACE_doc,
5584"CMSG_SPACE(length) -> buffer size\n\
5585\n\
5586Return the buffer size needed for recvmsg() to receive an ancillary\n\
5587data item with associated data of the given length, along with any\n\
5588trailing padding. The buffer space needed to receive multiple items\n\
5589is the sum of the CMSG_SPACE() values for their associated data\n\
5590lengths. Raises OverflowError if length is outside the permissible\n\
5591range of values.");
5592#endif /* CMSG_SPACE */
5593#endif /* CMSG_LEN */
5594
5595
Guido van Rossum30a685f1991-06-27 15:51:29 +00005596/* List of functions exported by this module. */
5597
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00005598static PyMethodDef socket_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005599 {"gethostbyname", socket_gethostbyname,
5600 METH_VARARGS, gethostbyname_doc},
5601 {"gethostbyname_ex", socket_gethostbyname_ex,
5602 METH_VARARGS, ghbn_ex_doc},
5603 {"gethostbyaddr", socket_gethostbyaddr,
5604 METH_VARARGS, gethostbyaddr_doc},
5605 {"gethostname", socket_gethostname,
5606 METH_NOARGS, gethostname_doc},
Antoine Pitrou061cfb52011-02-28 22:25:22 +00005607#ifdef HAVE_SETHOSTNAME
5608 {"sethostname", socket_sethostname,
5609 METH_VARARGS, sethostname_doc},
5610#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005611 {"getservbyname", socket_getservbyname,
5612 METH_VARARGS, getservbyname_doc},
5613 {"getservbyport", socket_getservbyport,
5614 METH_VARARGS, getservbyport_doc},
5615 {"getprotobyname", socket_getprotobyname,
5616 METH_VARARGS, getprotobyname_doc},
Guido van Rossum39eb8fa2007-11-16 01:24:05 +00005617#ifndef NO_DUP
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005618 {"dup", socket_dup,
5619 METH_O, dup_doc},
Guido van Rossum39eb8fa2007-11-16 01:24:05 +00005620#endif
Dave Cole331708b2004-08-09 04:51:41 +00005621#ifdef HAVE_SOCKETPAIR
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005622 {"socketpair", socket_socketpair,
5623 METH_VARARGS, socketpair_doc},
Dave Cole331708b2004-08-09 04:51:41 +00005624#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005625 {"ntohs", socket_ntohs,
5626 METH_VARARGS, ntohs_doc},
5627 {"ntohl", socket_ntohl,
5628 METH_O, ntohl_doc},
5629 {"htons", socket_htons,
5630 METH_VARARGS, htons_doc},
5631 {"htonl", socket_htonl,
5632 METH_O, htonl_doc},
5633 {"inet_aton", socket_inet_aton,
5634 METH_VARARGS, inet_aton_doc},
5635 {"inet_ntoa", socket_inet_ntoa,
5636 METH_VARARGS, inet_ntoa_doc},
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005637#if defined(HAVE_INET_PTON) || defined(MS_WINDOWS)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005638 {"inet_pton", socket_inet_pton,
5639 METH_VARARGS, inet_pton_doc},
5640 {"inet_ntop", socket_inet_ntop,
5641 METH_VARARGS, inet_ntop_doc},
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00005642#endif
Giampaolo Rodolàccfb91c2010-08-17 15:30:23 +00005643 {"getaddrinfo", (PyCFunction)socket_getaddrinfo,
5644 METH_VARARGS | METH_KEYWORDS, getaddrinfo_doc},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005645 {"getnameinfo", socket_getnameinfo,
5646 METH_VARARGS, getnameinfo_doc},
5647 {"getdefaulttimeout", (PyCFunction)socket_getdefaulttimeout,
5648 METH_NOARGS, getdefaulttimeout_doc},
5649 {"setdefaulttimeout", socket_setdefaulttimeout,
5650 METH_O, setdefaulttimeout_doc},
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005651#ifdef HAVE_IF_NAMEINDEX
5652 {"if_nameindex", socket_if_nameindex,
5653 METH_NOARGS, if_nameindex_doc},
5654 {"if_nametoindex", socket_if_nametoindex,
Charles-François Natali60713592011-05-20 16:55:06 +02005655 METH_VARARGS, if_nametoindex_doc},
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005656 {"if_indextoname", socket_if_indextoname,
5657 METH_O, if_indextoname_doc},
5658#endif
Nick Coghlan96fe56a2011-08-22 11:55:57 +10005659#ifdef CMSG_LEN
5660 {"CMSG_LEN", socket_CMSG_LEN,
5661 METH_VARARGS, CMSG_LEN_doc},
5662#ifdef CMSG_SPACE
5663 {"CMSG_SPACE", socket_CMSG_SPACE,
5664 METH_VARARGS, CMSG_SPACE_doc},
5665#endif
5666#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005667 {NULL, NULL} /* Sentinel */
Guido van Rossum6574b3e1991-06-25 21:36:08 +00005668};
5669
Guido van Rossum30a685f1991-06-27 15:51:29 +00005670
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00005671#ifdef MS_WINDOWS
5672#define OS_INIT_DEFINED
5673
5674/* Additional initialization and cleanup for Windows */
Guido van Rossumbe32c891996-06-20 16:25:29 +00005675
5676static void
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00005677os_cleanup(void)
Guido van Rossumbe32c891996-06-20 16:25:29 +00005678{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005679 WSACleanup();
Guido van Rossumbe32c891996-06-20 16:25:29 +00005680}
5681
5682static int
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00005683os_init(void)
Guido van Rossumbe32c891996-06-20 16:25:29 +00005684{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005685 WSADATA WSAData;
5686 int ret;
5687 ret = WSAStartup(0x0101, &WSAData);
5688 switch (ret) {
5689 case 0: /* No error */
5690 Py_AtExit(os_cleanup);
5691 return 1; /* Success */
5692 case WSASYSNOTREADY:
5693 PyErr_SetString(PyExc_ImportError,
5694 "WSAStartup failed: network not ready");
5695 break;
5696 case WSAVERNOTSUPPORTED:
5697 case WSAEINVAL:
5698 PyErr_SetString(
5699 PyExc_ImportError,
5700 "WSAStartup failed: requested version not supported");
5701 break;
5702 default:
5703 PyErr_Format(PyExc_ImportError, "WSAStartup failed: error code %d", ret);
5704 break;
5705 }
5706 return 0; /* Failure */
Guido van Rossumbe32c891996-06-20 16:25:29 +00005707}
5708
Guido van Rossum8d665e61996-06-26 18:22:49 +00005709#endif /* MS_WINDOWS */
Guido van Rossumbe32c891996-06-20 16:25:29 +00005710
Guido van Rossum8e9ebfd1997-11-22 21:53:48 +00005711
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00005712
5713#ifndef OS_INIT_DEFINED
5714static int
5715os_init(void)
5716{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005717 return 1; /* Success */
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00005718}
5719#endif
5720
5721
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00005722/* C API table - always add new things to the end for binary
5723 compatibility. */
5724static
5725PySocketModule_APIObject PySocketModuleAPI =
5726{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005727 &sock_type,
Antoine Pitrouc4df7842010-12-03 19:59:41 +00005728 NULL,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005729 NULL
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00005730};
5731
Guido van Rossum3eede5a2002-06-07 02:08:35 +00005732
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00005733/* Initialize the _socket module.
Guido van Rossum3eede5a2002-06-07 02:08:35 +00005734
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00005735 This module is actually called "_socket", and there's a wrapper
Guido van Rossum7d0a8262007-05-21 23:13:11 +00005736 "socket.py" which implements some additional functionality.
5737 The import of "_socket" may fail with an ImportError exception if
5738 os-specific initialization fails. On Windows, this does WINSOCK
Ezio Melotti13925002011-03-16 11:05:33 +02005739 initialization. When WINSOCK is initialized successfully, a call to
Guido van Rossum7d0a8262007-05-21 23:13:11 +00005740 WSACleanup() is scheduled to be made at exit time.
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00005741*/
Guido van Rossum3eede5a2002-06-07 02:08:35 +00005742
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00005743PyDoc_STRVAR(socket_doc,
Guido van Rossum22a97152002-08-08 20:37:08 +00005744"Implementation module for socket operations.\n\
5745\n\
5746See the socket module for documentation.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00005747
Martin v. Löwis1a214512008-06-11 05:26:20 +00005748static struct PyModuleDef socketmodule = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005749 PyModuleDef_HEAD_INIT,
5750 PySocket_MODULE_NAME,
5751 socket_doc,
5752 -1,
5753 socket_methods,
5754 NULL,
5755 NULL,
5756 NULL,
5757 NULL
Martin v. Löwis1a214512008-06-11 05:26:20 +00005758};
5759
Mark Hammondfe51c6d2002-08-02 02:27:13 +00005760PyMODINIT_FUNC
Martin v. Löwis1a214512008-06-11 05:26:20 +00005761PyInit__socket(void)
Guido van Rossum6574b3e1991-06-25 21:36:08 +00005762{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005763 PyObject *m, *has_ipv6;
Fred Drake4baedc12002-04-01 14:53:37 +00005764
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005765 if (!os_init())
5766 return NULL;
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00005767
Victor Stinnerdaf45552013-08-28 00:53:59 +02005768#ifdef MS_WINDOWS
5769 if (support_wsa_no_inherit == -1) {
5770 DWORD version = GetVersion();
5771 DWORD major = (DWORD)LOBYTE(LOWORD(version));
5772 DWORD minor = (DWORD)HIBYTE(LOWORD(version));
5773 /* need Windows 7 SP1, 2008 R2 SP1 or later */
5774 support_wsa_no_inherit = (major >= 6 && minor >= 1);
5775 }
5776#endif
5777
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005778 Py_TYPE(&sock_type) = &PyType_Type;
5779 m = PyModule_Create(&socketmodule);
5780 if (m == NULL)
5781 return NULL;
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00005782
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02005783 Py_INCREF(PyExc_OSError);
5784 PySocketModuleAPI.error = PyExc_OSError;
5785 Py_INCREF(PyExc_OSError);
5786 PyModule_AddObject(m, "error", PyExc_OSError);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005787 socket_herror = PyErr_NewException("socket.herror",
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02005788 PyExc_OSError, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005789 if (socket_herror == NULL)
5790 return NULL;
5791 Py_INCREF(socket_herror);
5792 PyModule_AddObject(m, "herror", socket_herror);
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02005793 socket_gaierror = PyErr_NewException("socket.gaierror", PyExc_OSError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005794 NULL);
5795 if (socket_gaierror == NULL)
5796 return NULL;
5797 Py_INCREF(socket_gaierror);
5798 PyModule_AddObject(m, "gaierror", socket_gaierror);
5799 socket_timeout = PyErr_NewException("socket.timeout",
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02005800 PyExc_OSError, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005801 if (socket_timeout == NULL)
5802 return NULL;
Antoine Pitrouc4df7842010-12-03 19:59:41 +00005803 PySocketModuleAPI.timeout_error = socket_timeout;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005804 Py_INCREF(socket_timeout);
5805 PyModule_AddObject(m, "timeout", socket_timeout);
5806 Py_INCREF((PyObject *)&sock_type);
5807 if (PyModule_AddObject(m, "SocketType",
5808 (PyObject *)&sock_type) != 0)
5809 return NULL;
5810 Py_INCREF((PyObject *)&sock_type);
5811 if (PyModule_AddObject(m, "socket",
5812 (PyObject *)&sock_type) != 0)
5813 return NULL;
Guido van Rossum09be4091999-08-09 14:40:40 +00005814
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00005815#ifdef ENABLE_IPV6
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005816 has_ipv6 = Py_True;
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00005817#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005818 has_ipv6 = Py_False;
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00005819#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005820 Py_INCREF(has_ipv6);
5821 PyModule_AddObject(m, "has_ipv6", has_ipv6);
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00005822
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005823 /* Export C API */
5824 if (PyModule_AddObject(m, PySocket_CAPI_NAME,
5825 PyCapsule_New(&PySocketModuleAPI, PySocket_CAPSULE_NAME, NULL)
5826 ) != 0)
5827 return NULL;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00005828
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005829 /* Address families (we only support AF_INET and AF_UNIX) */
Guido van Rossum09be4091999-08-09 14:40:40 +00005830#ifdef AF_UNSPEC
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02005831 PyModule_AddIntMacro(m, AF_UNSPEC);
Guido van Rossum09be4091999-08-09 14:40:40 +00005832#endif
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02005833 PyModule_AddIntMacro(m, AF_INET);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00005834#ifdef AF_INET6
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02005835 PyModule_AddIntMacro(m, AF_INET6);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00005836#endif /* AF_INET6 */
Andrew MacIntyred12dfbb2004-04-04 07:13:49 +00005837#if defined(AF_UNIX)
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02005838 PyModule_AddIntMacro(m, AF_UNIX);
Guido van Rossumb6775db1994-08-01 11:34:53 +00005839#endif /* AF_UNIX */
Guido van Rossum09be4091999-08-09 14:40:40 +00005840#ifdef AF_AX25
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005841 /* Amateur Radio AX.25 */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02005842 PyModule_AddIntMacro(m, AF_AX25);
Guido van Rossum09be4091999-08-09 14:40:40 +00005843#endif
5844#ifdef AF_IPX
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02005845 PyModule_AddIntMacro(m, AF_IPX); /* Novell IPX */
Guido van Rossum09be4091999-08-09 14:40:40 +00005846#endif
5847#ifdef AF_APPLETALK
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005848 /* Appletalk DDP */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02005849 PyModule_AddIntMacro(m, AF_APPLETALK);
Guido van Rossum09be4091999-08-09 14:40:40 +00005850#endif
5851#ifdef AF_NETROM
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005852 /* Amateur radio NetROM */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02005853 PyModule_AddIntMacro(m, AF_NETROM);
Guido van Rossum09be4091999-08-09 14:40:40 +00005854#endif
5855#ifdef AF_BRIDGE
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005856 /* Multiprotocol bridge */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02005857 PyModule_AddIntMacro(m, AF_BRIDGE);
Guido van Rossum09be4091999-08-09 14:40:40 +00005858#endif
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00005859#ifdef AF_ATMPVC
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005860 /* ATM PVCs */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02005861 PyModule_AddIntMacro(m, AF_ATMPVC);
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00005862#endif
Guido van Rossum09be4091999-08-09 14:40:40 +00005863#ifdef AF_AAL5
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005864 /* Reserved for Werner's ATM */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02005865 PyModule_AddIntMacro(m, AF_AAL5);
Guido van Rossum09be4091999-08-09 14:40:40 +00005866#endif
5867#ifdef AF_X25
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005868 /* Reserved for X.25 project */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02005869 PyModule_AddIntMacro(m, AF_X25);
Guido van Rossum09be4091999-08-09 14:40:40 +00005870#endif
5871#ifdef AF_INET6
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02005872 PyModule_AddIntMacro(m, AF_INET6); /* IP version 6 */
Guido van Rossum09be4091999-08-09 14:40:40 +00005873#endif
5874#ifdef AF_ROSE
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005875 /* Amateur Radio X.25 PLP */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02005876 PyModule_AddIntMacro(m, AF_ROSE);
Guido van Rossum09be4091999-08-09 14:40:40 +00005877#endif
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00005878#ifdef AF_DECnet
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005879 /* Reserved for DECnet project */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02005880 PyModule_AddIntMacro(m, AF_DECnet);
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00005881#endif
5882#ifdef AF_NETBEUI
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005883 /* Reserved for 802.2LLC project */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02005884 PyModule_AddIntMacro(m, AF_NETBEUI);
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00005885#endif
5886#ifdef AF_SECURITY
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005887 /* Security callback pseudo AF */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02005888 PyModule_AddIntMacro(m, AF_SECURITY);
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00005889#endif
5890#ifdef AF_KEY
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005891 /* PF_KEY key management API */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02005892 PyModule_AddIntMacro(m, AF_KEY);
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00005893#endif
5894#ifdef AF_NETLINK
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005895 /* */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02005896 PyModule_AddIntMacro(m, AF_NETLINK);
5897 PyModule_AddIntMacro(m, NETLINK_ROUTE);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00005898#ifdef NETLINK_SKIP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02005899 PyModule_AddIntMacro(m, NETLINK_SKIP);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00005900#endif
5901#ifdef NETLINK_W1
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02005902 PyModule_AddIntMacro(m, NETLINK_W1);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00005903#endif
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02005904 PyModule_AddIntMacro(m, NETLINK_USERSOCK);
5905 PyModule_AddIntMacro(m, NETLINK_FIREWALL);
Guido van Rossum668a94a2006-02-21 01:07:27 +00005906#ifdef NETLINK_TCPDIAG
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02005907 PyModule_AddIntMacro(m, NETLINK_TCPDIAG);
Guido van Rossum668a94a2006-02-21 01:07:27 +00005908#endif
5909#ifdef NETLINK_NFLOG
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02005910 PyModule_AddIntMacro(m, NETLINK_NFLOG);
Guido van Rossum668a94a2006-02-21 01:07:27 +00005911#endif
Neal Norwitz65851662006-01-16 04:31:40 +00005912#ifdef NETLINK_XFRM
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02005913 PyModule_AddIntMacro(m, NETLINK_XFRM);
Neal Norwitz65851662006-01-16 04:31:40 +00005914#endif
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00005915#ifdef NETLINK_ARPD
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02005916 PyModule_AddIntMacro(m, NETLINK_ARPD);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00005917#endif
5918#ifdef NETLINK_ROUTE6
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02005919 PyModule_AddIntMacro(m, NETLINK_ROUTE6);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00005920#endif
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02005921 PyModule_AddIntMacro(m, NETLINK_IP6_FW);
Thomas Wouterscf297e42007-02-23 15:07:44 +00005922#ifdef NETLINK_DNRTMSG
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02005923 PyModule_AddIntMacro(m, NETLINK_DNRTMSG);
Guido van Rossum39eb8fa2007-11-16 01:24:05 +00005924#endif
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00005925#ifdef NETLINK_TAPBASE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02005926 PyModule_AddIntMacro(m, NETLINK_TAPBASE);
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00005927#endif
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00005928#endif /* AF_NETLINK */
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00005929#ifdef AF_ROUTE
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005930 /* Alias to emulate 4.4BSD */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02005931 PyModule_AddIntMacro(m, AF_ROUTE);
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00005932#endif
Giampaolo Rodola'80e1c432013-05-21 21:02:04 +02005933#ifdef AF_LINK
5934 PyModule_AddIntMacro(m, AF_LINK);
5935#endif
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00005936#ifdef AF_ASH
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005937 /* Ash */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02005938 PyModule_AddIntMacro(m, AF_ASH);
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00005939#endif
5940#ifdef AF_ECONET
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005941 /* Acorn Econet */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02005942 PyModule_AddIntMacro(m, AF_ECONET);
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00005943#endif
5944#ifdef AF_ATMSVC
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005945 /* ATM SVCs */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02005946 PyModule_AddIntMacro(m, AF_ATMSVC);
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00005947#endif
5948#ifdef AF_SNA
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005949 /* Linux SNA Project (nutters!) */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02005950 PyModule_AddIntMacro(m, AF_SNA);
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00005951#endif
5952#ifdef AF_IRDA
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005953 /* IRDA sockets */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02005954 PyModule_AddIntMacro(m, AF_IRDA);
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00005955#endif
5956#ifdef AF_PPPOX
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005957 /* PPPoX sockets */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02005958 PyModule_AddIntMacro(m, AF_PPPOX);
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00005959#endif
5960#ifdef AF_WANPIPE
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005961 /* Wanpipe API Sockets */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02005962 PyModule_AddIntMacro(m, AF_WANPIPE);
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00005963#endif
5964#ifdef AF_LLC
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005965 /* Linux LLC */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02005966 PyModule_AddIntMacro(m, AF_LLC);
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00005967#endif
Martin v. Löwis12af0482004-01-31 12:34:17 +00005968
Hye-Shik Chang81268602004-02-02 06:05:24 +00005969#ifdef USE_BLUETOOTH
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02005970 PyModule_AddIntMacro(m, AF_BLUETOOTH);
5971 PyModule_AddIntMacro(m, BTPROTO_L2CAP);
5972 PyModule_AddIntMacro(m, BTPROTO_HCI);
5973 PyModule_AddIntMacro(m, SOL_HCI);
Gregory P. Smith3e85dfd2010-10-17 00:43:10 +00005974#if !defined(__NetBSD__) && !defined(__DragonFly__)
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02005975 PyModule_AddIntMacro(m, HCI_FILTER);
Gregory P. Smith3e85dfd2010-10-17 00:43:10 +00005976#endif
Hye-Shik Chang81268602004-02-02 06:05:24 +00005977#if !defined(__FreeBSD__)
Gregory P. Smith3e85dfd2010-10-17 00:43:10 +00005978#if !defined(__NetBSD__) && !defined(__DragonFly__)
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02005979 PyModule_AddIntMacro(m, HCI_TIME_STAMP);
Gregory P. Smith3e85dfd2010-10-17 00:43:10 +00005980#endif
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02005981 PyModule_AddIntMacro(m, HCI_DATA_DIR);
5982 PyModule_AddIntMacro(m, BTPROTO_SCO);
Hye-Shik Chang81268602004-02-02 06:05:24 +00005983#endif
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02005984 PyModule_AddIntMacro(m, BTPROTO_RFCOMM);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005985 PyModule_AddStringConstant(m, "BDADDR_ANY", "00:00:00:00:00:00");
5986 PyModule_AddStringConstant(m, "BDADDR_LOCAL", "00:00:00:FF:FF:FF");
Martin v. Löwis12af0482004-01-31 12:34:17 +00005987#endif
5988
Charles-François Natali47413c12011-10-06 19:47:44 +02005989#ifdef AF_CAN
5990 /* Controller Area Network */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02005991 PyModule_AddIntMacro(m, AF_CAN);
Charles-François Natali47413c12011-10-06 19:47:44 +02005992#endif
5993#ifdef PF_CAN
5994 /* Controller Area Network */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02005995 PyModule_AddIntMacro(m, PF_CAN);
Charles-François Natali47413c12011-10-06 19:47:44 +02005996#endif
5997
Charles-François Natali10b8cf42011-11-10 19:21:37 +01005998/* Reliable Datagram Sockets */
5999#ifdef AF_RDS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006000 PyModule_AddIntMacro(m, AF_RDS);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006001#endif
6002#ifdef PF_RDS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006003 PyModule_AddIntMacro(m, PF_RDS);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006004#endif
6005
Martin v. Löwis9d6c6692012-02-03 17:44:58 +01006006/* Kernel event messages */
6007#ifdef PF_SYSTEM
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006008 PyModule_AddIntMacro(m, PF_SYSTEM);
Martin v. Löwis9d6c6692012-02-03 17:44:58 +01006009#endif
6010#ifdef AF_SYSTEM
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006011 PyModule_AddIntMacro(m, AF_SYSTEM);
Martin v. Löwis9d6c6692012-02-03 17:44:58 +01006012#endif
6013
Antoine Pitroub156a462010-10-27 20:13:57 +00006014#ifdef AF_PACKET
6015 PyModule_AddIntMacro(m, AF_PACKET);
6016#endif
6017#ifdef PF_PACKET
6018 PyModule_AddIntMacro(m, PF_PACKET);
6019#endif
6020#ifdef PACKET_HOST
6021 PyModule_AddIntMacro(m, PACKET_HOST);
6022#endif
6023#ifdef PACKET_BROADCAST
6024 PyModule_AddIntMacro(m, PACKET_BROADCAST);
6025#endif
6026#ifdef PACKET_MULTICAST
6027 PyModule_AddIntMacro(m, PACKET_MULTICAST);
6028#endif
6029#ifdef PACKET_OTHERHOST
6030 PyModule_AddIntMacro(m, PACKET_OTHERHOST);
6031#endif
6032#ifdef PACKET_OUTGOING
6033 PyModule_AddIntMacro(m, PACKET_OUTGOING);
6034#endif
6035#ifdef PACKET_LOOPBACK
6036 PyModule_AddIntMacro(m, PACKET_LOOPBACK);
6037#endif
6038#ifdef PACKET_FASTROUTE
6039 PyModule_AddIntMacro(m, PACKET_FASTROUTE);
Guido van Rossum48a680c2001-03-02 06:34:14 +00006040#endif
Guido van Rossum09be4091999-08-09 14:40:40 +00006041
Christian Heimes043d6f62008-01-07 17:19:16 +00006042#ifdef HAVE_LINUX_TIPC_H
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006043 PyModule_AddIntMacro(m, AF_TIPC);
Christian Heimes043d6f62008-01-07 17:19:16 +00006044
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006045 /* for addresses */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006046 PyModule_AddIntMacro(m, TIPC_ADDR_NAMESEQ);
6047 PyModule_AddIntMacro(m, TIPC_ADDR_NAME);
6048 PyModule_AddIntMacro(m, TIPC_ADDR_ID);
Christian Heimes043d6f62008-01-07 17:19:16 +00006049
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006050 PyModule_AddIntMacro(m, TIPC_ZONE_SCOPE);
6051 PyModule_AddIntMacro(m, TIPC_CLUSTER_SCOPE);
6052 PyModule_AddIntMacro(m, TIPC_NODE_SCOPE);
Christian Heimes043d6f62008-01-07 17:19:16 +00006053
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006054 /* for setsockopt() */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006055 PyModule_AddIntMacro(m, SOL_TIPC);
6056 PyModule_AddIntMacro(m, TIPC_IMPORTANCE);
6057 PyModule_AddIntMacro(m, TIPC_SRC_DROPPABLE);
6058 PyModule_AddIntMacro(m, TIPC_DEST_DROPPABLE);
6059 PyModule_AddIntMacro(m, TIPC_CONN_TIMEOUT);
Christian Heimes043d6f62008-01-07 17:19:16 +00006060
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006061 PyModule_AddIntMacro(m, TIPC_LOW_IMPORTANCE);
6062 PyModule_AddIntMacro(m, TIPC_MEDIUM_IMPORTANCE);
6063 PyModule_AddIntMacro(m, TIPC_HIGH_IMPORTANCE);
6064 PyModule_AddIntMacro(m, TIPC_CRITICAL_IMPORTANCE);
Christian Heimes043d6f62008-01-07 17:19:16 +00006065
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006066 /* for subscriptions */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006067 PyModule_AddIntMacro(m, TIPC_SUB_PORTS);
6068 PyModule_AddIntMacro(m, TIPC_SUB_SERVICE);
Christian Heimes25bb7832008-01-11 16:17:00 +00006069#ifdef TIPC_SUB_CANCEL
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006070 /* doesn't seem to be available everywhere */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006071 PyModule_AddIntMacro(m, TIPC_SUB_CANCEL);
Christian Heimes25bb7832008-01-11 16:17:00 +00006072#endif
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006073 PyModule_AddIntMacro(m, TIPC_WAIT_FOREVER);
6074 PyModule_AddIntMacro(m, TIPC_PUBLISHED);
6075 PyModule_AddIntMacro(m, TIPC_WITHDRAWN);
6076 PyModule_AddIntMacro(m, TIPC_SUBSCR_TIMEOUT);
6077 PyModule_AddIntMacro(m, TIPC_CFG_SRV);
6078 PyModule_AddIntMacro(m, TIPC_TOP_SRV);
Christian Heimes043d6f62008-01-07 17:19:16 +00006079#endif
6080
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006081 /* Socket types */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006082 PyModule_AddIntMacro(m, SOCK_STREAM);
6083 PyModule_AddIntMacro(m, SOCK_DGRAM);
Guido van Rossumbcc20741998-08-04 22:53:56 +00006084/* We have incomplete socket support. */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006085 PyModule_AddIntMacro(m, SOCK_RAW);
6086 PyModule_AddIntMacro(m, SOCK_SEQPACKET);
Martin v. Löwiscf8f47e2002-12-11 13:10:57 +00006087#if defined(SOCK_RDM)
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006088 PyModule_AddIntMacro(m, SOCK_RDM);
Guido van Rossumbcc20741998-08-04 22:53:56 +00006089#endif
Antoine Pitroub1c54962010-10-14 15:05:38 +00006090#ifdef SOCK_CLOEXEC
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006091 PyModule_AddIntMacro(m, SOCK_CLOEXEC);
Antoine Pitroub1c54962010-10-14 15:05:38 +00006092#endif
6093#ifdef SOCK_NONBLOCK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006094 PyModule_AddIntMacro(m, SOCK_NONBLOCK);
Antoine Pitroub1c54962010-10-14 15:05:38 +00006095#endif
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006096
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006097#ifdef SO_DEBUG
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006098 PyModule_AddIntMacro(m, SO_DEBUG);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006099#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006100#ifdef SO_ACCEPTCONN
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006101 PyModule_AddIntMacro(m, SO_ACCEPTCONN);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006102#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006103#ifdef SO_REUSEADDR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006104 PyModule_AddIntMacro(m, SO_REUSEADDR);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006105#endif
Andrew M. Kuchling42851ab2004-07-10 14:19:21 +00006106#ifdef SO_EXCLUSIVEADDRUSE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006107 PyModule_AddIntMacro(m, SO_EXCLUSIVEADDRUSE);
Andrew M. Kuchling42851ab2004-07-10 14:19:21 +00006108#endif
6109
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006110#ifdef SO_KEEPALIVE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006111 PyModule_AddIntMacro(m, SO_KEEPALIVE);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006112#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006113#ifdef SO_DONTROUTE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006114 PyModule_AddIntMacro(m, SO_DONTROUTE);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006115#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006116#ifdef SO_BROADCAST
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006117 PyModule_AddIntMacro(m, SO_BROADCAST);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006118#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006119#ifdef SO_USELOOPBACK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006120 PyModule_AddIntMacro(m, SO_USELOOPBACK);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006121#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006122#ifdef SO_LINGER
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006123 PyModule_AddIntMacro(m, SO_LINGER);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006124#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006125#ifdef SO_OOBINLINE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006126 PyModule_AddIntMacro(m, SO_OOBINLINE);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006127#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006128#ifdef SO_REUSEPORT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006129 PyModule_AddIntMacro(m, SO_REUSEPORT);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006130#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006131#ifdef SO_SNDBUF
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006132 PyModule_AddIntMacro(m, SO_SNDBUF);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006133#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006134#ifdef SO_RCVBUF
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006135 PyModule_AddIntMacro(m, SO_RCVBUF);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006136#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006137#ifdef SO_SNDLOWAT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006138 PyModule_AddIntMacro(m, SO_SNDLOWAT);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006139#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006140#ifdef SO_RCVLOWAT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006141 PyModule_AddIntMacro(m, SO_RCVLOWAT);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006142#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006143#ifdef SO_SNDTIMEO
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006144 PyModule_AddIntMacro(m, SO_SNDTIMEO);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006145#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006146#ifdef SO_RCVTIMEO
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006147 PyModule_AddIntMacro(m, SO_RCVTIMEO);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006148#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006149#ifdef SO_ERROR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006150 PyModule_AddIntMacro(m, SO_ERROR);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006151#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006152#ifdef SO_TYPE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006153 PyModule_AddIntMacro(m, SO_TYPE);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006154#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006155#ifdef SO_SETFIB
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006156 PyModule_AddIntMacro(m, SO_SETFIB);
Larry Hastingsf0f37952010-04-02 11:47:10 +00006157#endif
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006158#ifdef SO_PASSCRED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006159 PyModule_AddIntMacro(m, SO_PASSCRED);
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006160#endif
6161#ifdef SO_PEERCRED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006162 PyModule_AddIntMacro(m, SO_PEERCRED);
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006163#endif
6164#ifdef LOCAL_PEERCRED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006165 PyModule_AddIntMacro(m, LOCAL_PEERCRED);
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006166#endif
Victor Stinnercb98bed2011-10-25 13:45:48 +02006167#ifdef SO_BINDTODEVICE
6168 PyModule_AddIntMacro(m, SO_BINDTODEVICE);
6169#endif
Benjamin Peterson1314ef72013-11-27 09:18:54 -06006170#ifdef SO_PRIORITY
6171 PyModule_AddIntMacro(m, SO_PRIORITY);
6172#endif
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006173
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006174 /* Maximum number of connections for "listen" */
6175#ifdef SOMAXCONN
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006176 PyModule_AddIntMacro(m, SOMAXCONN);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006177#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006178 PyModule_AddIntConstant(m, "SOMAXCONN", 5); /* Common value */
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006179#endif
6180
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006181 /* Ancilliary message types */
6182#ifdef SCM_RIGHTS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006183 PyModule_AddIntMacro(m, SCM_RIGHTS);
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006184#endif
6185#ifdef SCM_CREDENTIALS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006186 PyModule_AddIntMacro(m, SCM_CREDENTIALS);
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006187#endif
6188#ifdef SCM_CREDS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006189 PyModule_AddIntMacro(m, SCM_CREDS);
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006190#endif
6191
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006192 /* Flags for send, recv */
6193#ifdef MSG_OOB
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006194 PyModule_AddIntMacro(m, MSG_OOB);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006195#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006196#ifdef MSG_PEEK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006197 PyModule_AddIntMacro(m, MSG_PEEK);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006198#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006199#ifdef MSG_DONTROUTE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006200 PyModule_AddIntMacro(m, MSG_DONTROUTE);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006201#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006202#ifdef MSG_DONTWAIT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006203 PyModule_AddIntMacro(m, MSG_DONTWAIT);
Guido van Rossum2c8bcb82000-04-25 21:34:53 +00006204#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006205#ifdef MSG_EOR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006206 PyModule_AddIntMacro(m, MSG_EOR);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006207#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006208#ifdef MSG_TRUNC
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006209 PyModule_AddIntMacro(m, MSG_TRUNC);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006210#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006211#ifdef MSG_CTRUNC
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006212 PyModule_AddIntMacro(m, MSG_CTRUNC);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006213#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006214#ifdef MSG_WAITALL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006215 PyModule_AddIntMacro(m, MSG_WAITALL);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006216#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006217#ifdef MSG_BTAG
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006218 PyModule_AddIntMacro(m, MSG_BTAG);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006219#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006220#ifdef MSG_ETAG
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006221 PyModule_AddIntMacro(m, MSG_ETAG);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006222#endif
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006223#ifdef MSG_NOSIGNAL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006224 PyModule_AddIntMacro(m, MSG_NOSIGNAL);
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006225#endif
6226#ifdef MSG_NOTIFICATION
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006227 PyModule_AddIntMacro(m, MSG_NOTIFICATION);
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006228#endif
6229#ifdef MSG_CMSG_CLOEXEC
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006230 PyModule_AddIntMacro(m, MSG_CMSG_CLOEXEC);
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006231#endif
6232#ifdef MSG_ERRQUEUE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006233 PyModule_AddIntMacro(m, MSG_ERRQUEUE);
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006234#endif
6235#ifdef MSG_CONFIRM
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006236 PyModule_AddIntMacro(m, MSG_CONFIRM);
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006237#endif
6238#ifdef MSG_MORE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006239 PyModule_AddIntMacro(m, MSG_MORE);
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006240#endif
6241#ifdef MSG_EOF
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006242 PyModule_AddIntMacro(m, MSG_EOF);
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006243#endif
6244#ifdef MSG_BCAST
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006245 PyModule_AddIntMacro(m, MSG_BCAST);
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006246#endif
6247#ifdef MSG_MCAST
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006248 PyModule_AddIntMacro(m, MSG_MCAST);
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006249#endif
Benjamin Peterson57b66722012-12-12 22:24:47 -05006250#ifdef MSG_FASTOPEN
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006251 PyModule_AddIntMacro(m, MSG_FASTOPEN);
Benjamin Peterson57b66722012-12-12 22:24:47 -05006252#endif
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006253
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006254 /* Protocol level and numbers, usable for [gs]etsockopt */
6255#ifdef SOL_SOCKET
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006256 PyModule_AddIntMacro(m, SOL_SOCKET);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006257#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006258#ifdef SOL_IP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006259 PyModule_AddIntMacro(m, SOL_IP);
Guido van Rossum09be4091999-08-09 14:40:40 +00006260#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006261 PyModule_AddIntConstant(m, "SOL_IP", 0);
Guido van Rossum09be4091999-08-09 14:40:40 +00006262#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006263#ifdef SOL_IPX
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006264 PyModule_AddIntMacro(m, SOL_IPX);
Guido van Rossum09be4091999-08-09 14:40:40 +00006265#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006266#ifdef SOL_AX25
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006267 PyModule_AddIntMacro(m, SOL_AX25);
Guido van Rossum09be4091999-08-09 14:40:40 +00006268#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006269#ifdef SOL_ATALK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006270 PyModule_AddIntMacro(m, SOL_ATALK);
Guido van Rossum09be4091999-08-09 14:40:40 +00006271#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006272#ifdef SOL_NETROM
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006273 PyModule_AddIntMacro(m, SOL_NETROM);
Guido van Rossum09be4091999-08-09 14:40:40 +00006274#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006275#ifdef SOL_ROSE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006276 PyModule_AddIntMacro(m, SOL_ROSE);
Guido van Rossum09be4091999-08-09 14:40:40 +00006277#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006278#ifdef SOL_TCP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006279 PyModule_AddIntMacro(m, SOL_TCP);
Guido van Rossum09be4091999-08-09 14:40:40 +00006280#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006281 PyModule_AddIntConstant(m, "SOL_TCP", 6);
Guido van Rossum09be4091999-08-09 14:40:40 +00006282#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006283#ifdef SOL_UDP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006284 PyModule_AddIntMacro(m, SOL_UDP);
Guido van Rossum09be4091999-08-09 14:40:40 +00006285#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006286 PyModule_AddIntConstant(m, "SOL_UDP", 17);
Guido van Rossum09be4091999-08-09 14:40:40 +00006287#endif
Charles-François Natali47413c12011-10-06 19:47:44 +02006288#ifdef SOL_CAN_BASE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006289 PyModule_AddIntMacro(m, SOL_CAN_BASE);
Charles-François Natali47413c12011-10-06 19:47:44 +02006290#endif
6291#ifdef SOL_CAN_RAW
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006292 PyModule_AddIntMacro(m, SOL_CAN_RAW);
6293 PyModule_AddIntMacro(m, CAN_RAW);
Charles-François Natali47413c12011-10-06 19:47:44 +02006294#endif
6295#ifdef HAVE_LINUX_CAN_H
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006296 PyModule_AddIntMacro(m, CAN_EFF_FLAG);
6297 PyModule_AddIntMacro(m, CAN_RTR_FLAG);
6298 PyModule_AddIntMacro(m, CAN_ERR_FLAG);
Charles-François Natali47413c12011-10-06 19:47:44 +02006299
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006300 PyModule_AddIntMacro(m, CAN_SFF_MASK);
6301 PyModule_AddIntMacro(m, CAN_EFF_MASK);
6302 PyModule_AddIntMacro(m, CAN_ERR_MASK);
Charles-François Natali47413c12011-10-06 19:47:44 +02006303#endif
6304#ifdef HAVE_LINUX_CAN_RAW_H
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006305 PyModule_AddIntMacro(m, CAN_RAW_FILTER);
6306 PyModule_AddIntMacro(m, CAN_RAW_ERR_FILTER);
6307 PyModule_AddIntMacro(m, CAN_RAW_LOOPBACK);
6308 PyModule_AddIntMacro(m, CAN_RAW_RECV_OWN_MSGS);
Charles-François Natali47413c12011-10-06 19:47:44 +02006309#endif
Charles-François Natali773e42d2013-02-05 19:42:01 +01006310#ifdef HAVE_LINUX_CAN_BCM_H
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006311 PyModule_AddIntMacro(m, CAN_BCM);
Charles-François Natali773e42d2013-02-05 19:42:01 +01006312 PyModule_AddIntConstant(m, "CAN_BCM_TX_SETUP", TX_SETUP);
6313 PyModule_AddIntConstant(m, "CAN_BCM_TX_DELETE", TX_DELETE);
6314 PyModule_AddIntConstant(m, "CAN_BCM_TX_READ", TX_READ);
6315 PyModule_AddIntConstant(m, "CAN_BCM_TX_SEND", TX_SEND);
6316 PyModule_AddIntConstant(m, "CAN_BCM_RX_SETUP", RX_SETUP);
6317 PyModule_AddIntConstant(m, "CAN_BCM_RX_DELETE", RX_DELETE);
6318 PyModule_AddIntConstant(m, "CAN_BCM_RX_READ", RX_READ);
6319 PyModule_AddIntConstant(m, "CAN_BCM_TX_STATUS", TX_STATUS);
6320 PyModule_AddIntConstant(m, "CAN_BCM_TX_EXPIRED", TX_EXPIRED);
6321 PyModule_AddIntConstant(m, "CAN_BCM_RX_STATUS", RX_STATUS);
6322 PyModule_AddIntConstant(m, "CAN_BCM_RX_TIMEOUT", RX_TIMEOUT);
6323 PyModule_AddIntConstant(m, "CAN_BCM_RX_CHANGED", RX_CHANGED);
6324#endif
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006325#ifdef SOL_RDS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006326 PyModule_AddIntMacro(m, SOL_RDS);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006327#endif
6328#ifdef RDS_CANCEL_SENT_TO
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006329 PyModule_AddIntMacro(m, RDS_CANCEL_SENT_TO);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006330#endif
6331#ifdef RDS_GET_MR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006332 PyModule_AddIntMacro(m, RDS_GET_MR);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006333#endif
6334#ifdef RDS_FREE_MR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006335 PyModule_AddIntMacro(m, RDS_FREE_MR);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006336#endif
6337#ifdef RDS_RECVERR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006338 PyModule_AddIntMacro(m, RDS_RECVERR);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006339#endif
6340#ifdef RDS_CONG_MONITOR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006341 PyModule_AddIntMacro(m, RDS_CONG_MONITOR);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006342#endif
6343#ifdef RDS_GET_MR_FOR_DEST
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006344 PyModule_AddIntMacro(m, RDS_GET_MR_FOR_DEST);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006345#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006346#ifdef IPPROTO_IP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006347 PyModule_AddIntMacro(m, IPPROTO_IP);
Guido van Rossum578de301998-05-28 20:18:18 +00006348#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006349 PyModule_AddIntConstant(m, "IPPROTO_IP", 0);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006350#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006351#ifdef IPPROTO_HOPOPTS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006352 PyModule_AddIntMacro(m, IPPROTO_HOPOPTS);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006353#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006354#ifdef IPPROTO_ICMP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006355 PyModule_AddIntMacro(m, IPPROTO_ICMP);
Guido van Rossum578de301998-05-28 20:18:18 +00006356#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006357 PyModule_AddIntConstant(m, "IPPROTO_ICMP", 1);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006358#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006359#ifdef IPPROTO_IGMP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006360 PyModule_AddIntMacro(m, IPPROTO_IGMP);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006361#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006362#ifdef IPPROTO_GGP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006363 PyModule_AddIntMacro(m, IPPROTO_GGP);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006364#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006365#ifdef IPPROTO_IPV4
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006366 PyModule_AddIntMacro(m, IPPROTO_IPV4);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006367#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006368#ifdef IPPROTO_IPV6
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006369 PyModule_AddIntMacro(m, IPPROTO_IPV6);
Martin v. Löwisa0f17342003-10-03 13:56:20 +00006370#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006371#ifdef IPPROTO_IPIP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006372 PyModule_AddIntMacro(m, IPPROTO_IPIP);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006373#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006374#ifdef IPPROTO_TCP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006375 PyModule_AddIntMacro(m, IPPROTO_TCP);
Guido van Rossum578de301998-05-28 20:18:18 +00006376#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006377 PyModule_AddIntConstant(m, "IPPROTO_TCP", 6);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006378#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006379#ifdef IPPROTO_EGP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006380 PyModule_AddIntMacro(m, IPPROTO_EGP);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006381#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006382#ifdef IPPROTO_PUP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006383 PyModule_AddIntMacro(m, IPPROTO_PUP);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006384#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006385#ifdef IPPROTO_UDP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006386 PyModule_AddIntMacro(m, IPPROTO_UDP);
Guido van Rossum578de301998-05-28 20:18:18 +00006387#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006388 PyModule_AddIntConstant(m, "IPPROTO_UDP", 17);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006389#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006390#ifdef IPPROTO_IDP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006391 PyModule_AddIntMacro(m, IPPROTO_IDP);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006392#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006393#ifdef IPPROTO_HELLO
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006394 PyModule_AddIntMacro(m, IPPROTO_HELLO);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006395#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006396#ifdef IPPROTO_ND
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006397 PyModule_AddIntMacro(m, IPPROTO_ND);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006398#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006399#ifdef IPPROTO_TP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006400 PyModule_AddIntMacro(m, IPPROTO_TP);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006401#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006402#ifdef IPPROTO_IPV6
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006403 PyModule_AddIntMacro(m, IPPROTO_IPV6);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006404#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006405#ifdef IPPROTO_ROUTING
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006406 PyModule_AddIntMacro(m, IPPROTO_ROUTING);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006407#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006408#ifdef IPPROTO_FRAGMENT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006409 PyModule_AddIntMacro(m, IPPROTO_FRAGMENT);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006410#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006411#ifdef IPPROTO_RSVP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006412 PyModule_AddIntMacro(m, IPPROTO_RSVP);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006413#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006414#ifdef IPPROTO_GRE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006415 PyModule_AddIntMacro(m, IPPROTO_GRE);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006416#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006417#ifdef IPPROTO_ESP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006418 PyModule_AddIntMacro(m, IPPROTO_ESP);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006419#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006420#ifdef IPPROTO_AH
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006421 PyModule_AddIntMacro(m, IPPROTO_AH);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006422#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006423#ifdef IPPROTO_MOBILE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006424 PyModule_AddIntMacro(m, IPPROTO_MOBILE);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006425#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006426#ifdef IPPROTO_ICMPV6
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006427 PyModule_AddIntMacro(m, IPPROTO_ICMPV6);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006428#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006429#ifdef IPPROTO_NONE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006430 PyModule_AddIntMacro(m, IPPROTO_NONE);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006431#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006432#ifdef IPPROTO_DSTOPTS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006433 PyModule_AddIntMacro(m, IPPROTO_DSTOPTS);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006434#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006435#ifdef IPPROTO_XTP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006436 PyModule_AddIntMacro(m, IPPROTO_XTP);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006437#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006438#ifdef IPPROTO_EON
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006439 PyModule_AddIntMacro(m, IPPROTO_EON);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006440#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006441#ifdef IPPROTO_PIM
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006442 PyModule_AddIntMacro(m, IPPROTO_PIM);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006443#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006444#ifdef IPPROTO_IPCOMP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006445 PyModule_AddIntMacro(m, IPPROTO_IPCOMP);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006446#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006447#ifdef IPPROTO_VRRP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006448 PyModule_AddIntMacro(m, IPPROTO_VRRP);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006449#endif
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006450#ifdef IPPROTO_SCTP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006451 PyModule_AddIntMacro(m, IPPROTO_SCTP);
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006452#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006453#ifdef IPPROTO_BIP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006454 PyModule_AddIntMacro(m, IPPROTO_BIP);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006455#endif
6456/**/
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006457#ifdef IPPROTO_RAW
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006458 PyModule_AddIntMacro(m, IPPROTO_RAW);
Guido van Rossum578de301998-05-28 20:18:18 +00006459#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006460 PyModule_AddIntConstant(m, "IPPROTO_RAW", 255);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006461#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006462#ifdef IPPROTO_MAX
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006463 PyModule_AddIntMacro(m, IPPROTO_MAX);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006464#endif
6465
Martin v. Löwis9d6c6692012-02-03 17:44:58 +01006466#ifdef SYSPROTO_CONTROL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006467 PyModule_AddIntMacro(m, SYSPROTO_CONTROL);
Martin v. Löwis9d6c6692012-02-03 17:44:58 +01006468#endif
6469
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006470 /* Some port configuration */
6471#ifdef IPPORT_RESERVED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006472 PyModule_AddIntMacro(m, IPPORT_RESERVED);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006473#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006474 PyModule_AddIntConstant(m, "IPPORT_RESERVED", 1024);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006475#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006476#ifdef IPPORT_USERRESERVED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006477 PyModule_AddIntMacro(m, IPPORT_USERRESERVED);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006478#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006479 PyModule_AddIntConstant(m, "IPPORT_USERRESERVED", 5000);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006480#endif
6481
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006482 /* Some reserved IP v.4 addresses */
6483#ifdef INADDR_ANY
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006484 PyModule_AddIntMacro(m, INADDR_ANY);
Guido van Rossum5f05eb41995-02-17 15:11:07 +00006485#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006486 PyModule_AddIntConstant(m, "INADDR_ANY", 0x00000000);
Guido van Rossum5f05eb41995-02-17 15:11:07 +00006487#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006488#ifdef INADDR_BROADCAST
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006489 PyModule_AddIntMacro(m, INADDR_BROADCAST);
Guido van Rossum5f05eb41995-02-17 15:11:07 +00006490#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006491 PyModule_AddIntConstant(m, "INADDR_BROADCAST", 0xffffffff);
Guido van Rossum5f05eb41995-02-17 15:11:07 +00006492#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006493#ifdef INADDR_LOOPBACK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006494 PyModule_AddIntMacro(m, INADDR_LOOPBACK);
Guido van Rossum5f05eb41995-02-17 15:11:07 +00006495#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006496 PyModule_AddIntConstant(m, "INADDR_LOOPBACK", 0x7F000001);
Guido van Rossum5f05eb41995-02-17 15:11:07 +00006497#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006498#ifdef INADDR_UNSPEC_GROUP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006499 PyModule_AddIntMacro(m, INADDR_UNSPEC_GROUP);
Guido van Rossum5f05eb41995-02-17 15:11:07 +00006500#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006501 PyModule_AddIntConstant(m, "INADDR_UNSPEC_GROUP", 0xe0000000);
Guido van Rossum5f05eb41995-02-17 15:11:07 +00006502#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006503#ifdef INADDR_ALLHOSTS_GROUP
6504 PyModule_AddIntConstant(m, "INADDR_ALLHOSTS_GROUP",
6505 INADDR_ALLHOSTS_GROUP);
Guido van Rossum5f05eb41995-02-17 15:11:07 +00006506#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006507 PyModule_AddIntConstant(m, "INADDR_ALLHOSTS_GROUP", 0xe0000001);
Guido van Rossum5f05eb41995-02-17 15:11:07 +00006508#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006509#ifdef INADDR_MAX_LOCAL_GROUP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006510 PyModule_AddIntMacro(m, INADDR_MAX_LOCAL_GROUP);
Guido van Rossum5f05eb41995-02-17 15:11:07 +00006511#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006512 PyModule_AddIntConstant(m, "INADDR_MAX_LOCAL_GROUP", 0xe00000ff);
Guido van Rossum5f05eb41995-02-17 15:11:07 +00006513#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006514#ifdef INADDR_NONE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006515 PyModule_AddIntMacro(m, INADDR_NONE);
Guido van Rossum5f05eb41995-02-17 15:11:07 +00006516#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006517 PyModule_AddIntConstant(m, "INADDR_NONE", 0xffffffff);
Guido van Rossum5f05eb41995-02-17 15:11:07 +00006518#endif
6519
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006520 /* IPv4 [gs]etsockopt options */
6521#ifdef IP_OPTIONS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006522 PyModule_AddIntMacro(m, IP_OPTIONS);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006523#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006524#ifdef IP_HDRINCL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006525 PyModule_AddIntMacro(m, IP_HDRINCL);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006526#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006527#ifdef IP_TOS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006528 PyModule_AddIntMacro(m, IP_TOS);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006529#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006530#ifdef IP_TTL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006531 PyModule_AddIntMacro(m, IP_TTL);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006532#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006533#ifdef IP_RECVOPTS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006534 PyModule_AddIntMacro(m, IP_RECVOPTS);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006535#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006536#ifdef IP_RECVRETOPTS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006537 PyModule_AddIntMacro(m, IP_RECVRETOPTS);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006538#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006539#ifdef IP_RECVDSTADDR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006540 PyModule_AddIntMacro(m, IP_RECVDSTADDR);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006541#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006542#ifdef IP_RETOPTS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006543 PyModule_AddIntMacro(m, IP_RETOPTS);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006544#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006545#ifdef IP_MULTICAST_IF
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006546 PyModule_AddIntMacro(m, IP_MULTICAST_IF);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006547#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006548#ifdef IP_MULTICAST_TTL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006549 PyModule_AddIntMacro(m, IP_MULTICAST_TTL);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006550#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006551#ifdef IP_MULTICAST_LOOP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006552 PyModule_AddIntMacro(m, IP_MULTICAST_LOOP);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006553#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006554#ifdef IP_ADD_MEMBERSHIP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006555 PyModule_AddIntMacro(m, IP_ADD_MEMBERSHIP);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006556#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006557#ifdef IP_DROP_MEMBERSHIP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006558 PyModule_AddIntMacro(m, IP_DROP_MEMBERSHIP);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006559#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006560#ifdef IP_DEFAULT_MULTICAST_TTL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006561 PyModule_AddIntMacro(m, IP_DEFAULT_MULTICAST_TTL);
Guido van Rossum09be4091999-08-09 14:40:40 +00006562#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006563#ifdef IP_DEFAULT_MULTICAST_LOOP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006564 PyModule_AddIntMacro(m, IP_DEFAULT_MULTICAST_LOOP);
Guido van Rossum09be4091999-08-09 14:40:40 +00006565#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006566#ifdef IP_MAX_MEMBERSHIPS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006567 PyModule_AddIntMacro(m, IP_MAX_MEMBERSHIPS);
Guido van Rossum09be4091999-08-09 14:40:40 +00006568#endif
Charles-François Natali564a42c2011-12-17 14:59:56 +01006569#ifdef IP_TRANSPARENT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006570 PyModule_AddIntMacro(m, IP_TRANSPARENT);
Charles-François Natali564a42c2011-12-17 14:59:56 +01006571#endif
Guido van Rossum09be4091999-08-09 14:40:40 +00006572
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006573 /* IPv6 [gs]etsockopt options, defined in RFC2553 */
6574#ifdef IPV6_JOIN_GROUP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006575 PyModule_AddIntMacro(m, IPV6_JOIN_GROUP);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006576#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006577#ifdef IPV6_LEAVE_GROUP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006578 PyModule_AddIntMacro(m, IPV6_LEAVE_GROUP);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006579#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006580#ifdef IPV6_MULTICAST_HOPS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006581 PyModule_AddIntMacro(m, IPV6_MULTICAST_HOPS);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006582#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006583#ifdef IPV6_MULTICAST_IF
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006584 PyModule_AddIntMacro(m, IPV6_MULTICAST_IF);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006585#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006586#ifdef IPV6_MULTICAST_LOOP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006587 PyModule_AddIntMacro(m, IPV6_MULTICAST_LOOP);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006588#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006589#ifdef IPV6_UNICAST_HOPS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006590 PyModule_AddIntMacro(m, IPV6_UNICAST_HOPS);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006591#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006592 /* Additional IPV6 socket options, defined in RFC 3493 */
Martin v. Löwisda91d022003-12-30 11:14:01 +00006593#ifdef IPV6_V6ONLY
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006594 PyModule_AddIntMacro(m, IPV6_V6ONLY);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006595#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006596 /* Advanced IPV6 socket options, from RFC 3542 */
Martin v. Löwisda91d022003-12-30 11:14:01 +00006597#ifdef IPV6_CHECKSUM
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006598 PyModule_AddIntMacro(m, IPV6_CHECKSUM);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006599#endif
6600#ifdef IPV6_DONTFRAG
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006601 PyModule_AddIntMacro(m, IPV6_DONTFRAG);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006602#endif
6603#ifdef IPV6_DSTOPTS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006604 PyModule_AddIntMacro(m, IPV6_DSTOPTS);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006605#endif
6606#ifdef IPV6_HOPLIMIT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006607 PyModule_AddIntMacro(m, IPV6_HOPLIMIT);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006608#endif
6609#ifdef IPV6_HOPOPTS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006610 PyModule_AddIntMacro(m, IPV6_HOPOPTS);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006611#endif
6612#ifdef IPV6_NEXTHOP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006613 PyModule_AddIntMacro(m, IPV6_NEXTHOP);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006614#endif
6615#ifdef IPV6_PATHMTU
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006616 PyModule_AddIntMacro(m, IPV6_PATHMTU);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006617#endif
6618#ifdef IPV6_PKTINFO
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006619 PyModule_AddIntMacro(m, IPV6_PKTINFO);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006620#endif
6621#ifdef IPV6_RECVDSTOPTS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006622 PyModule_AddIntMacro(m, IPV6_RECVDSTOPTS);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006623#endif
6624#ifdef IPV6_RECVHOPLIMIT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006625 PyModule_AddIntMacro(m, IPV6_RECVHOPLIMIT);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006626#endif
6627#ifdef IPV6_RECVHOPOPTS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006628 PyModule_AddIntMacro(m, IPV6_RECVHOPOPTS);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006629#endif
6630#ifdef IPV6_RECVPKTINFO
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006631 PyModule_AddIntMacro(m, IPV6_RECVPKTINFO);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006632#endif
6633#ifdef IPV6_RECVRTHDR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006634 PyModule_AddIntMacro(m, IPV6_RECVRTHDR);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006635#endif
6636#ifdef IPV6_RECVTCLASS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006637 PyModule_AddIntMacro(m, IPV6_RECVTCLASS);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006638#endif
6639#ifdef IPV6_RTHDR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006640 PyModule_AddIntMacro(m, IPV6_RTHDR);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006641#endif
6642#ifdef IPV6_RTHDRDSTOPTS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006643 PyModule_AddIntMacro(m, IPV6_RTHDRDSTOPTS);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006644#endif
6645#ifdef IPV6_RTHDR_TYPE_0
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006646 PyModule_AddIntMacro(m, IPV6_RTHDR_TYPE_0);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006647#endif
6648#ifdef IPV6_RECVPATHMTU
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006649 PyModule_AddIntMacro(m, IPV6_RECVPATHMTU);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006650#endif
6651#ifdef IPV6_TCLASS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006652 PyModule_AddIntMacro(m, IPV6_TCLASS);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006653#endif
6654#ifdef IPV6_USE_MIN_MTU
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006655 PyModule_AddIntMacro(m, IPV6_USE_MIN_MTU);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006656#endif
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006657
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006658 /* TCP options */
6659#ifdef TCP_NODELAY
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006660 PyModule_AddIntMacro(m, TCP_NODELAY);
Guido van Rossum09be4091999-08-09 14:40:40 +00006661#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006662#ifdef TCP_MAXSEG
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006663 PyModule_AddIntMacro(m, TCP_MAXSEG);
Guido van Rossum09be4091999-08-09 14:40:40 +00006664#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006665#ifdef TCP_CORK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006666 PyModule_AddIntMacro(m, TCP_CORK);
Martin v. Löwis3cde2cb2001-12-22 15:05:32 +00006667#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006668#ifdef TCP_KEEPIDLE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006669 PyModule_AddIntMacro(m, TCP_KEEPIDLE);
Martin v. Löwis3cde2cb2001-12-22 15:05:32 +00006670#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006671#ifdef TCP_KEEPINTVL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006672 PyModule_AddIntMacro(m, TCP_KEEPINTVL);
Martin v. Löwis3cde2cb2001-12-22 15:05:32 +00006673#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006674#ifdef TCP_KEEPCNT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006675 PyModule_AddIntMacro(m, TCP_KEEPCNT);
Martin v. Löwis3cde2cb2001-12-22 15:05:32 +00006676#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006677#ifdef TCP_SYNCNT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006678 PyModule_AddIntMacro(m, TCP_SYNCNT);
Martin v. Löwis3cde2cb2001-12-22 15:05:32 +00006679#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006680#ifdef TCP_LINGER2
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006681 PyModule_AddIntMacro(m, TCP_LINGER2);
Martin v. Löwis3cde2cb2001-12-22 15:05:32 +00006682#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006683#ifdef TCP_DEFER_ACCEPT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006684 PyModule_AddIntMacro(m, TCP_DEFER_ACCEPT);
Martin v. Löwis3cde2cb2001-12-22 15:05:32 +00006685#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006686#ifdef TCP_WINDOW_CLAMP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006687 PyModule_AddIntMacro(m, TCP_WINDOW_CLAMP);
Martin v. Löwis3cde2cb2001-12-22 15:05:32 +00006688#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006689#ifdef TCP_INFO
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006690 PyModule_AddIntMacro(m, TCP_INFO);
Martin v. Löwis3cde2cb2001-12-22 15:05:32 +00006691#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006692#ifdef TCP_QUICKACK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006693 PyModule_AddIntMacro(m, TCP_QUICKACK);
Martin v. Löwis3cde2cb2001-12-22 15:05:32 +00006694#endif
Benjamin Peterson57b66722012-12-12 22:24:47 -05006695#ifdef TCP_FASTOPEN
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006696 PyModule_AddIntMacro(m, TCP_FASTOPEN);
Benjamin Peterson57b66722012-12-12 22:24:47 -05006697#endif
Guido van Rossum09be4091999-08-09 14:40:40 +00006698
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006699 /* IPX options */
6700#ifdef IPX_TYPE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006701 PyModule_AddIntMacro(m, IPX_TYPE);
Guido van Rossum09be4091999-08-09 14:40:40 +00006702#endif
Guido van Rossum4f199ea1998-04-09 20:56:35 +00006703
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006704/* Reliable Datagram Sockets */
6705#ifdef RDS_CMSG_RDMA_ARGS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006706 PyModule_AddIntMacro(m, RDS_CMSG_RDMA_ARGS);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006707#endif
6708#ifdef RDS_CMSG_RDMA_DEST
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006709 PyModule_AddIntMacro(m, RDS_CMSG_RDMA_DEST);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006710#endif
6711#ifdef RDS_CMSG_RDMA_MAP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006712 PyModule_AddIntMacro(m, RDS_CMSG_RDMA_MAP);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006713#endif
6714#ifdef RDS_CMSG_RDMA_STATUS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006715 PyModule_AddIntMacro(m, RDS_CMSG_RDMA_STATUS);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006716#endif
6717#ifdef RDS_CMSG_RDMA_UPDATE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006718 PyModule_AddIntMacro(m, RDS_CMSG_RDMA_UPDATE);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006719#endif
6720#ifdef RDS_RDMA_READWRITE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006721 PyModule_AddIntMacro(m, RDS_RDMA_READWRITE);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006722#endif
6723#ifdef RDS_RDMA_FENCE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006724 PyModule_AddIntMacro(m, RDS_RDMA_FENCE);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006725#endif
6726#ifdef RDS_RDMA_INVALIDATE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006727 PyModule_AddIntMacro(m, RDS_RDMA_INVALIDATE);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006728#endif
6729#ifdef RDS_RDMA_USE_ONCE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006730 PyModule_AddIntMacro(m, RDS_RDMA_USE_ONCE);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006731#endif
6732#ifdef RDS_RDMA_DONTWAIT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006733 PyModule_AddIntMacro(m, RDS_RDMA_DONTWAIT);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006734#endif
6735#ifdef RDS_RDMA_NOTIFY_ME
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006736 PyModule_AddIntMacro(m, RDS_RDMA_NOTIFY_ME);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006737#endif
6738#ifdef RDS_RDMA_SILENT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006739 PyModule_AddIntMacro(m, RDS_RDMA_SILENT);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006740#endif
6741
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006742 /* get{addr,name}info parameters */
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006743#ifdef EAI_ADDRFAMILY
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006744 PyModule_AddIntMacro(m, EAI_ADDRFAMILY);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006745#endif
6746#ifdef EAI_AGAIN
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006747 PyModule_AddIntMacro(m, EAI_AGAIN);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006748#endif
6749#ifdef EAI_BADFLAGS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006750 PyModule_AddIntMacro(m, EAI_BADFLAGS);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006751#endif
6752#ifdef EAI_FAIL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006753 PyModule_AddIntMacro(m, EAI_FAIL);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006754#endif
6755#ifdef EAI_FAMILY
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006756 PyModule_AddIntMacro(m, EAI_FAMILY);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006757#endif
6758#ifdef EAI_MEMORY
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006759 PyModule_AddIntMacro(m, EAI_MEMORY);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006760#endif
6761#ifdef EAI_NODATA
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006762 PyModule_AddIntMacro(m, EAI_NODATA);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006763#endif
6764#ifdef EAI_NONAME
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006765 PyModule_AddIntMacro(m, EAI_NONAME);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006766#endif
Martin v. Löwisda91d022003-12-30 11:14:01 +00006767#ifdef EAI_OVERFLOW
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006768 PyModule_AddIntMacro(m, EAI_OVERFLOW);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006769#endif
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006770#ifdef EAI_SERVICE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006771 PyModule_AddIntMacro(m, EAI_SERVICE);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006772#endif
6773#ifdef EAI_SOCKTYPE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006774 PyModule_AddIntMacro(m, EAI_SOCKTYPE);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006775#endif
6776#ifdef EAI_SYSTEM
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006777 PyModule_AddIntMacro(m, EAI_SYSTEM);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006778#endif
6779#ifdef EAI_BADHINTS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006780 PyModule_AddIntMacro(m, EAI_BADHINTS);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006781#endif
6782#ifdef EAI_PROTOCOL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006783 PyModule_AddIntMacro(m, EAI_PROTOCOL);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006784#endif
6785#ifdef EAI_MAX
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006786 PyModule_AddIntMacro(m, EAI_MAX);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006787#endif
6788#ifdef AI_PASSIVE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006789 PyModule_AddIntMacro(m, AI_PASSIVE);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006790#endif
6791#ifdef AI_CANONNAME
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006792 PyModule_AddIntMacro(m, AI_CANONNAME);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006793#endif
6794#ifdef AI_NUMERICHOST
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006795 PyModule_AddIntMacro(m, AI_NUMERICHOST);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006796#endif
Martin v. Löwisda91d022003-12-30 11:14:01 +00006797#ifdef AI_NUMERICSERV
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006798 PyModule_AddIntMacro(m, AI_NUMERICSERV);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006799#endif
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006800#ifdef AI_MASK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006801 PyModule_AddIntMacro(m, AI_MASK);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006802#endif
6803#ifdef AI_ALL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006804 PyModule_AddIntMacro(m, AI_ALL);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006805#endif
6806#ifdef AI_V4MAPPED_CFG
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006807 PyModule_AddIntMacro(m, AI_V4MAPPED_CFG);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006808#endif
6809#ifdef AI_ADDRCONFIG
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006810 PyModule_AddIntMacro(m, AI_ADDRCONFIG);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006811#endif
6812#ifdef AI_V4MAPPED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006813 PyModule_AddIntMacro(m, AI_V4MAPPED);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006814#endif
6815#ifdef AI_DEFAULT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006816 PyModule_AddIntMacro(m, AI_DEFAULT);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006817#endif
6818#ifdef NI_MAXHOST
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006819 PyModule_AddIntMacro(m, NI_MAXHOST);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006820#endif
6821#ifdef NI_MAXSERV
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006822 PyModule_AddIntMacro(m, NI_MAXSERV);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006823#endif
6824#ifdef NI_NOFQDN
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006825 PyModule_AddIntMacro(m, NI_NOFQDN);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006826#endif
6827#ifdef NI_NUMERICHOST
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006828 PyModule_AddIntMacro(m, NI_NUMERICHOST);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006829#endif
6830#ifdef NI_NAMEREQD
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006831 PyModule_AddIntMacro(m, NI_NAMEREQD);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006832#endif
6833#ifdef NI_NUMERICSERV
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006834 PyModule_AddIntMacro(m, NI_NUMERICSERV);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006835#endif
6836#ifdef NI_DGRAM
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006837 PyModule_AddIntMacro(m, NI_DGRAM);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006838#endif
6839
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006840 /* shutdown() parameters */
Martin v. Löwis94681fc2003-11-27 19:40:22 +00006841#ifdef SHUT_RD
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006842 PyModule_AddIntMacro(m, SHUT_RD);
Martin v. Löwis94681fc2003-11-27 19:40:22 +00006843#elif defined(SD_RECEIVE)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006844 PyModule_AddIntConstant(m, "SHUT_RD", SD_RECEIVE);
Martin v. Löwis94681fc2003-11-27 19:40:22 +00006845#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006846 PyModule_AddIntConstant(m, "SHUT_RD", 0);
Martin v. Löwis94681fc2003-11-27 19:40:22 +00006847#endif
6848#ifdef SHUT_WR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006849 PyModule_AddIntMacro(m, SHUT_WR);
Martin v. Löwis94681fc2003-11-27 19:40:22 +00006850#elif defined(SD_SEND)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006851 PyModule_AddIntConstant(m, "SHUT_WR", SD_SEND);
Martin v. Löwis94681fc2003-11-27 19:40:22 +00006852#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006853 PyModule_AddIntConstant(m, "SHUT_WR", 1);
Martin v. Löwis94681fc2003-11-27 19:40:22 +00006854#endif
6855#ifdef SHUT_RDWR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006856 PyModule_AddIntMacro(m, SHUT_RDWR);
Martin v. Löwis94681fc2003-11-27 19:40:22 +00006857#elif defined(SD_BOTH)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006858 PyModule_AddIntConstant(m, "SHUT_RDWR", SD_BOTH);
Martin v. Löwis94681fc2003-11-27 19:40:22 +00006859#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006860 PyModule_AddIntConstant(m, "SHUT_RDWR", 2);
Martin v. Löwis94681fc2003-11-27 19:40:22 +00006861#endif
6862
Christian Heimesfaf2f632008-01-06 16:59:19 +00006863#ifdef SIO_RCVALL
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006864 {
6865 DWORD codes[] = {SIO_RCVALL, SIO_KEEPALIVE_VALS};
6866 const char *names[] = {"SIO_RCVALL", "SIO_KEEPALIVE_VALS"};
6867 int i;
Victor Stinner63941882011-09-29 00:42:28 +02006868 for(i = 0; i<Py_ARRAY_LENGTH(codes); ++i) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006869 PyObject *tmp;
6870 tmp = PyLong_FromUnsignedLong(codes[i]);
6871 if (tmp == NULL)
6872 return NULL;
6873 PyModule_AddObject(m, names[i], tmp);
6874 }
6875 }
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006876 PyModule_AddIntMacro(m, RCVALL_OFF);
6877 PyModule_AddIntMacro(m, RCVALL_ON);
6878 PyModule_AddIntMacro(m, RCVALL_SOCKETLEVELONLY);
Amaury Forgeot d'Arc762681b2008-06-12 23:03:41 +00006879#ifdef RCVALL_IPLEVEL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006880 PyModule_AddIntMacro(m, RCVALL_IPLEVEL);
Amaury Forgeot d'Arc762681b2008-06-12 23:03:41 +00006881#endif
6882#ifdef RCVALL_MAX
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006883 PyModule_AddIntMacro(m, RCVALL_MAX);
Amaury Forgeot d'Arc762681b2008-06-12 23:03:41 +00006884#endif
Christian Heimesfaf2f632008-01-06 16:59:19 +00006885#endif /* _MSTCPIP_ */
6886
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006887 /* Initialize gethostbyname lock */
Just van Rossum1040d2c2003-05-09 07:53:18 +00006888#if defined(USE_GETHOSTBYNAME_LOCK) || defined(USE_GETADDRINFO_LOCK)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006889 netdb_lock = PyThread_allocate_lock();
Guido van Rossum4f199ea1998-04-09 20:56:35 +00006890#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006891 return m;
Guido van Rossum6574b3e1991-06-25 21:36:08 +00006892}
Martin v. Löwisb9ab1592001-06-24 21:18:26 +00006893
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00006894
Martin v. Löwisb9ab1592001-06-24 21:18:26 +00006895#ifndef HAVE_INET_PTON
Christian Heimes96e7b3d2007-11-20 06:51:17 +00006896#if !defined(NTDDI_VERSION) || (NTDDI_VERSION < NTDDI_LONGHORN)
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00006897
6898/* Simplistic emulation code for inet_pton that only works for IPv4 */
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00006899/* These are not exposed because they do not set errno properly */
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00006900
Guido van Rossum3eede5a2002-06-07 02:08:35 +00006901int
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00006902inet_pton(int af, const char *src, void *dst)
Martin v. Löwisb9ab1592001-06-24 21:18:26 +00006903{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006904 if (af == AF_INET) {
Benjamin Petersonf91df042009-02-13 02:50:59 +00006905#if (SIZEOF_INT != 4)
6906#error "Not sure if in_addr_t exists and int is not 32-bits."
6907#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006908 unsigned int packed_addr;
6909 packed_addr = inet_addr(src);
6910 if (packed_addr == INADDR_NONE)
6911 return 0;
6912 memcpy(dst, &packed_addr, 4);
6913 return 1;
6914 }
6915 /* Should set errno to EAFNOSUPPORT */
6916 return -1;
Martin v. Löwisb9ab1592001-06-24 21:18:26 +00006917}
6918
Martin v. Löwisc925b1532001-07-21 09:42:15 +00006919const char *
6920inet_ntop(int af, const void *src, char *dst, socklen_t size)
Martin v. Löwisb9ab1592001-06-24 21:18:26 +00006921{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006922 if (af == AF_INET) {
6923 struct in_addr packed_addr;
6924 if (size < 16)
6925 /* Should set errno to ENOSPC. */
6926 return NULL;
6927 memcpy(&packed_addr, src, sizeof(packed_addr));
6928 return strncpy(dst, inet_ntoa(packed_addr), size);
6929 }
6930 /* Should set errno to EAFNOSUPPORT */
6931 return NULL;
Martin v. Löwisb9ab1592001-06-24 21:18:26 +00006932}
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00006933
Martin v. Löwisb9ab1592001-06-24 21:18:26 +00006934#endif
Christian Heimesb6150692007-11-15 23:37:07 +00006935#endif