blob: 64db006e6caf2e72090c05f69ef60088e68867ae [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
Berker Peksaga6ec5ee2014-06-30 11:28:40 +030036- socket.getaddrinfo(host, port [, family, type, proto, flags])
37 --> List of (family, type, 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\
Charles-François Natali644b8f52014-05-22 19:45:39 +0100124listen([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
Steve Dower65e4cb12014-11-22 12:54:57 -0800287#if defined(_MSC_VER) && _MSC_VER >= 1800
288/* Provides the IsWindows7SP1OrGreater() function */
289#include <VersionHelpers.h>
290#endif
291
Jeremy Hylton22308652001-02-02 03:23:09 +0000292#endif
293
Skip Montanaro7befb992004-02-10 16:50:21 +0000294#include <stddef.h>
Martin v. Löwisa45ecae2001-06-24 21:28:42 +0000295
Neal Norwitz39d22e52002-11-02 19:55:21 +0000296#ifndef O_NONBLOCK
297# define O_NONBLOCK O_NDELAY
Guido van Rossum3bbc62e1995-01-02 19:30:30 +0000298#endif
299
Trent Micka708d6e2004-09-07 17:48:26 +0000300/* include Python's addrinfo.h unless it causes trouble */
301#if defined(__sgi) && _COMPILER_VERSION>700 && defined(_SS_ALIGNSIZE)
302 /* Do not include addinfo.h on some newer IRIX versions.
303 * _SS_ALIGNSIZE is defined in sys/socket.h by 6.5.21,
304 * for example, but not by 6.5.10.
305 */
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000306#elif defined(_MSC_VER) && _MSC_VER>1201
Trent Micka708d6e2004-09-07 17:48:26 +0000307 /* Do not include addrinfo.h for MSVC7 or greater. 'addrinfo' and
308 * EAI_* constants are defined in (the already included) ws2tcpip.h.
309 */
310#else
311# include "addrinfo.h"
312#endif
Jason Tishlerc246cb72004-08-09 13:25:59 +0000313
Martin v. Löwisb9ab1592001-06-24 21:18:26 +0000314#ifndef HAVE_INET_PTON
Christian Heimes96e7b3d2007-11-20 06:51:17 +0000315#if !defined(NTDDI_VERSION) || (NTDDI_VERSION < NTDDI_LONGHORN)
Guido van Rossum3eede5a2002-06-07 02:08:35 +0000316int inet_pton(int af, const char *src, void *dst);
Martin v. Löwisc925b1532001-07-21 09:42:15 +0000317const char *inet_ntop(int af, const void *src, char *dst, socklen_t size);
Martin v. Löwisb9ab1592001-06-24 21:18:26 +0000318#endif
Christian Heimesb6150692007-11-15 23:37:07 +0000319#endif
Martin v. Löwisb9ab1592001-06-24 21:18:26 +0000320
Martin v. Löwisae26dc22001-08-03 10:02:29 +0000321#ifdef __APPLE__
322/* On OS X, getaddrinfo returns no error indication of lookup
323 failure, so we must use the emulation instead of the libinfo
324 implementation. Unfortunately, performing an autoconf test
325 for this bug would require DNS access for the machine performing
326 the configuration, which is not acceptable. Therefore, we
327 determine the bug just by checking for __APPLE__. If this bug
328 gets ever fixed, perhaps checking for sys/version.h would be
329 appropriate, which is 10/0 on the system with the bug. */
Jack Jansen84262fb2002-07-02 14:40:42 +0000330#ifndef HAVE_GETNAMEINFO
331/* This bug seems to be fixed in Jaguar. Ths easiest way I could
332 Find to check for Jaguar is that it has getnameinfo(), which
333 older releases don't have */
Martin v. Löwisae26dc22001-08-03 10:02:29 +0000334#undef HAVE_GETADDRINFO
Martin v. Löwisae26dc22001-08-03 10:02:29 +0000335#endif
Thomas Wouters477c8d52006-05-27 19:21:47 +0000336
337#ifdef HAVE_INET_ATON
338#define USE_INET_ATON_WEAKLINK
339#endif
340
Jack Jansen84262fb2002-07-02 14:40:42 +0000341#endif
Martin v. Löwisae26dc22001-08-03 10:02:29 +0000342
Martin v. Löwis01dfdb32001-06-23 16:30:13 +0000343/* I know this is a bad practice, but it is the easiest... */
Martin v. Löwisae26dc22001-08-03 10:02:29 +0000344#if !defined(HAVE_GETADDRINFO)
Martin v. Löwisfccac2e2003-05-01 05:20:46 +0000345/* avoid clashes with the C library definition of the symbol. */
346#define getaddrinfo fake_getaddrinfo
347#define gai_strerror fake_gai_strerror
348#define freeaddrinfo fake_freeaddrinfo
Martin v. Löwis01dfdb32001-06-23 16:30:13 +0000349#include "getaddrinfo.c"
350#endif
Martin v. Löwisae26dc22001-08-03 10:02:29 +0000351#if !defined(HAVE_GETNAMEINFO)
Martin v. Löwisfccac2e2003-05-01 05:20:46 +0000352#define getnameinfo fake_getnameinfo
Martin v. Löwis01dfdb32001-06-23 16:30:13 +0000353#include "getnameinfo.c"
354#endif
355
Guido van Rossum39eb8fa2007-11-16 01:24:05 +0000356#ifdef MS_WINDOWS
Guido van Rossum2dd8ddd2000-04-21 20:33:00 +0000357#define SOCKETCLOSE closesocket
Guido van Rossum6a3eb5f1994-08-18 15:42:46 +0000358#endif
359
Martin v. Löwis2d8d4272001-07-21 18:05:31 +0000360#ifdef MS_WIN32
Kristján Valur Jónsson310052c2012-03-31 13:35:00 +0000361#undef EAFNOSUPPORT
Guido van Rossum3eede5a2002-06-07 02:08:35 +0000362#define EAFNOSUPPORT WSAEAFNOSUPPORT
363#define snprintf _snprintf
Martin v. Löwis2d8d4272001-07-21 18:05:31 +0000364#endif
Fred Drakea04eaad2000-06-30 02:46:07 +0000365
Guido van Rossum2dd8ddd2000-04-21 20:33:00 +0000366#ifndef SOCKETCLOSE
367#define SOCKETCLOSE close
368#endif
369
Gregory P. Smith3e85dfd2010-10-17 00:43:10 +0000370#if (defined(HAVE_BLUETOOTH_H) || defined(HAVE_BLUETOOTH_BLUETOOTH_H)) && !defined(__NetBSD__) && !defined(__DragonFly__)
Hye-Shik Chang81268602004-02-02 06:05:24 +0000371#define USE_BLUETOOTH 1
372#if defined(__FreeBSD__)
373#define BTPROTO_L2CAP BLUETOOTH_PROTO_L2CAP
374#define BTPROTO_RFCOMM BLUETOOTH_PROTO_RFCOMM
Thomas Wouterscf297e42007-02-23 15:07:44 +0000375#define BTPROTO_HCI BLUETOOTH_PROTO_HCI
Guido van Rossumcd16bf62007-06-13 18:07:49 +0000376#define SOL_HCI SOL_HCI_RAW
377#define HCI_FILTER SO_HCI_RAW_FILTER
Hye-Shik Chang81268602004-02-02 06:05:24 +0000378#define sockaddr_l2 sockaddr_l2cap
379#define sockaddr_rc sockaddr_rfcomm
Guido van Rossumcd16bf62007-06-13 18:07:49 +0000380#define hci_dev hci_node
Hye-Shik Chang81268602004-02-02 06:05:24 +0000381#define _BT_L2_MEMB(sa, memb) ((sa)->l2cap_##memb)
382#define _BT_RC_MEMB(sa, memb) ((sa)->rfcomm_##memb)
Thomas Wouterscf297e42007-02-23 15:07:44 +0000383#define _BT_HCI_MEMB(sa, memb) ((sa)->hci_##memb)
Gregory P. Smith3e85dfd2010-10-17 00:43:10 +0000384#elif defined(__NetBSD__) || defined(__DragonFly__)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000385#define sockaddr_l2 sockaddr_bt
386#define sockaddr_rc sockaddr_bt
Thomas Wouterscf297e42007-02-23 15:07:44 +0000387#define sockaddr_hci sockaddr_bt
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000388#define sockaddr_sco sockaddr_bt
Gregory P. Smith3e85dfd2010-10-17 00:43:10 +0000389#define SOL_HCI BTPROTO_HCI
390#define HCI_DATA_DIR SO_HCI_DIRECTION
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000391#define _BT_L2_MEMB(sa, memb) ((sa)->bt_##memb)
392#define _BT_RC_MEMB(sa, memb) ((sa)->bt_##memb)
Thomas Wouterscf297e42007-02-23 15:07:44 +0000393#define _BT_HCI_MEMB(sa, memb) ((sa)->bt_##memb)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000394#define _BT_SCO_MEMB(sa, memb) ((sa)->bt_##memb)
Hye-Shik Chang81268602004-02-02 06:05:24 +0000395#else
Hye-Shik Chang81268602004-02-02 06:05:24 +0000396#define _BT_L2_MEMB(sa, memb) ((sa)->l2_##memb)
397#define _BT_RC_MEMB(sa, memb) ((sa)->rc_##memb)
Thomas Wouterscf297e42007-02-23 15:07:44 +0000398#define _BT_HCI_MEMB(sa, memb) ((sa)->hci_##memb)
Hye-Shik Chang81268602004-02-02 06:05:24 +0000399#define _BT_SCO_MEMB(sa, memb) ((sa)->sco_##memb)
400#endif
401#endif
402
Charles-François Natali8b759652011-12-23 16:44:51 +0100403/* Convert "sock_addr_t *" to "struct sockaddr *". */
404#define SAS2SA(x) (&((x)->sa))
Thomas Wouters89f507f2006-12-13 04:49:30 +0000405
Martin v. Löwise9416172003-05-03 10:12:45 +0000406/*
407 * Constants for getnameinfo()
408 */
409#if !defined(NI_MAXHOST)
410#define NI_MAXHOST 1025
411#endif
412#if !defined(NI_MAXSERV)
413#define NI_MAXSERV 32
414#endif
415
Guido van Rossum7d0a8262007-05-21 23:13:11 +0000416#ifndef INVALID_SOCKET /* MS defines this */
417#define INVALID_SOCKET (-1)
418#endif
419
Charles-François Natali0cc86852013-09-13 19:53:08 +0200420#ifndef INADDR_NONE
421#define INADDR_NONE (-1)
422#endif
423
Guido van Rossum384ca9c2001-10-27 22:20:47 +0000424/* XXX There's a problem here: *static* functions are not supposed to have
425 a Py prefix (or use CapitalizedWords). Later... */
426
Guido van Rossum30a685f1991-06-27 15:51:29 +0000427/* Global variable holding the exception type for errors detected
428 by this module (but not argument type or memory errors, etc.). */
Guido van Rossumc4fcfa32002-06-07 03:19:37 +0000429static PyObject *socket_herror;
430static PyObject *socket_gaierror;
Raymond Hettingeref7343c2003-06-29 03:08:05 +0000431static PyObject *socket_timeout;
Guido van Rossum30a685f1991-06-27 15:51:29 +0000432
Tim Peters643a7fc2002-02-17 04:13:21 +0000433/* A forward reference to the socket type object.
Guido van Rossumc4fcfa32002-06-07 03:19:37 +0000434 The sock_type variable contains pointers to various functions,
435 some of which call new_sockobject(), which uses sock_type, so
Tim Peters643a7fc2002-02-17 04:13:21 +0000436 there has to be a circular reference. */
Jeremy Hylton938ace62002-07-17 16:30:39 +0000437static PyTypeObject sock_type;
Guido van Rossum48a680c2001-03-02 06:34:14 +0000438
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000439#if defined(HAVE_POLL_H)
440#include <poll.h>
441#elif defined(HAVE_SYS_POLL_H)
442#include <sys/poll.h>
443#endif
444
Nick Coghlan96fe56a2011-08-22 11:55:57 +1000445/* Largest value to try to store in a socklen_t (used when handling
446 ancillary data). POSIX requires socklen_t to hold at least
447 (2**31)-1 and recommends against storing larger values, but
448 socklen_t was originally int in the BSD interface, so to be on the
449 safe side we use the smaller of (2**31)-1 and INT_MAX. */
450#if INT_MAX > 0x7fffffff
451#define SOCKLEN_T_LIMIT 0x7fffffff
452#else
453#define SOCKLEN_T_LIMIT INT_MAX
454#endif
455
Charles-François Nataliaa26b272011-08-28 17:51:43 +0200456#ifdef HAVE_POLL
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000457/* Instead of select(), we'll use poll() since poll() works on any fd. */
458#define IS_SELECTABLE(s) 1
459/* Can we call select() with this socket without a buffer overrun? */
Martin v. Löwisf84d1b92006-02-11 09:27:05 +0000460#else
Charles-François Nataliaa26b272011-08-28 17:51:43 +0200461/* If there's no timeout left, we don't have to call select, so it's a safe,
462 * little white lie. */
Victor Stinner71694d52015-03-28 01:18:54 +0100463#define IS_SELECTABLE(s) (_PyIsSelectable_fd((s)->sock_fd) || (s)->sock_timeout <= 0)
Martin v. Löwisf84d1b92006-02-11 09:27:05 +0000464#endif
Neal Norwitz082b2df2006-02-07 07:04:46 +0000465
466static PyObject*
467select_error(void)
468{
Antoine Pitrou6b4883d2011-10-12 02:54:14 +0200469 PyErr_SetString(PyExc_OSError, "unable to select on socket");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000470 return NULL;
Neal Norwitz082b2df2006-02-07 07:04:46 +0000471}
472
Antoine Pitrou3e1fd272010-09-28 21:23:11 +0000473#ifdef MS_WINDOWS
Antoine Pitrouc8f01962010-09-28 22:03:27 +0000474#ifndef WSAEAGAIN
475#define WSAEAGAIN WSAEWOULDBLOCK
476#endif
Antoine Pitrou3e1fd272010-09-28 21:23:11 +0000477#define CHECK_ERRNO(expected) \
478 (WSAGetLastError() == WSA ## expected)
479#else
480#define CHECK_ERRNO(expected) \
481 (errno == expected)
482#endif
483
Victor Stinnerdaf45552013-08-28 00:53:59 +0200484#ifdef MS_WINDOWS
485/* Does WSASocket() support the WSA_FLAG_NO_HANDLE_INHERIT flag? */
486static int support_wsa_no_inherit = -1;
487#endif
488
Guido van Rossum30a685f1991-06-27 15:51:29 +0000489/* Convenience function to raise an error according to errno
490 and return a NULL pointer from a function. */
Guido van Rossum6574b3e1991-06-25 21:36:08 +0000491
Guido van Rossum73624e91994-10-10 17:59:00 +0000492static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +0000493set_error(void)
Guido van Rossum6574b3e1991-06-25 21:36:08 +0000494{
Guido van Rossum8d665e61996-06-26 18:22:49 +0000495#ifdef MS_WINDOWS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000496 int err_no = WSAGetLastError();
497 /* PyErr_SetExcFromWindowsErr() invokes FormatMessage() which
498 recognizes the error codes used by both GetLastError() and
499 WSAGetLastError */
500 if (err_no)
Antoine Pitrou6b4883d2011-10-12 02:54:14 +0200501 return PyErr_SetExcFromWindowsErr(PyExc_OSError, err_no);
Guido van Rossum14ed0b21994-09-29 09:50:09 +0000502#endif
Guido van Rossum8e9ebfd1997-11-22 21:53:48 +0000503
Antoine Pitrou6b4883d2011-10-12 02:54:14 +0200504 return PyErr_SetFromErrno(PyExc_OSError);
Guido van Rossum6574b3e1991-06-25 21:36:08 +0000505}
506
Guido van Rossum30a685f1991-06-27 15:51:29 +0000507
Martin v. Löwis2d8d4272001-07-21 18:05:31 +0000508static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +0000509set_herror(int h_error)
Martin v. Löwis2d8d4272001-07-21 18:05:31 +0000510{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000511 PyObject *v;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +0000512
513#ifdef HAVE_HSTRERROR
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000514 v = Py_BuildValue("(is)", h_error, (char *)hstrerror(h_error));
Martin v. Löwis2d8d4272001-07-21 18:05:31 +0000515#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000516 v = Py_BuildValue("(is)", h_error, "host not found");
Martin v. Löwis2d8d4272001-07-21 18:05:31 +0000517#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000518 if (v != NULL) {
519 PyErr_SetObject(socket_herror, v);
520 Py_DECREF(v);
521 }
Martin v. Löwis2d8d4272001-07-21 18:05:31 +0000522
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000523 return NULL;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +0000524}
525
526
527static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +0000528set_gaierror(int error)
Martin v. Löwis2d8d4272001-07-21 18:05:31 +0000529{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000530 PyObject *v;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +0000531
Martin v. Löwis272cb402002-03-01 08:31:07 +0000532#ifdef EAI_SYSTEM
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000533 /* EAI_SYSTEM is not available on Windows XP. */
534 if (error == EAI_SYSTEM)
535 return set_error();
Martin v. Löwis272cb402002-03-01 08:31:07 +0000536#endif
Martin v. Löwis2d8d4272001-07-21 18:05:31 +0000537
Martin v. Löwisf95dd0a2001-08-15 17:14:33 +0000538#ifdef HAVE_GAI_STRERROR
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000539 v = Py_BuildValue("(is)", error, gai_strerror(error));
Martin v. Löwisf95dd0a2001-08-15 17:14:33 +0000540#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000541 v = Py_BuildValue("(is)", error, "getaddrinfo failed");
Martin v. Löwisf95dd0a2001-08-15 17:14:33 +0000542#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000543 if (v != NULL) {
544 PyErr_SetObject(socket_gaierror, v);
545 Py_DECREF(v);
546 }
Martin v. Löwis2d8d4272001-07-21 18:05:31 +0000547
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000548 return NULL;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +0000549}
550
Guido van Rossum3eede5a2002-06-07 02:08:35 +0000551/* Function to perform the setting of socket blocking mode
552 internally. block = (1 | 0). */
Guido van Rossum67f7a382002-06-06 21:08:16 +0000553static int
554internal_setblocking(PySocketSockObject *s, int block)
555{
Victor Stinnerb6dab6b2014-07-23 22:56:55 +0200556#ifdef MS_WINDOWS
557 u_long arg;
558#endif
Victor Stinner9a954832013-12-04 00:41:24 +0100559#if !defined(MS_WINDOWS) \
Christian Heimesaf01f662013-12-21 16:19:10 +0100560 && !((defined(HAVE_SYS_IOCTL_H) && defined(FIONBIO)))
Victor Stinner9a954832013-12-04 00:41:24 +0100561 int delay_flag, new_delay_flag;
Guido van Rossum67f7a382002-06-06 21:08:16 +0000562#endif
Antoine Pitroub1c54962010-10-14 15:05:38 +0000563#ifdef SOCK_NONBLOCK
564 if (block)
565 s->sock_type &= (~SOCK_NONBLOCK);
566 else
567 s->sock_type |= SOCK_NONBLOCK;
568#endif
Guido van Rossum67f7a382002-06-06 21:08:16 +0000569
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000570 Py_BEGIN_ALLOW_THREADS
Guido van Rossum67f7a382002-06-06 21:08:16 +0000571#ifndef MS_WINDOWS
Christian Heimesaf01f662013-12-21 16:19:10 +0100572#if (defined(HAVE_SYS_IOCTL_H) && defined(FIONBIO))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000573 block = !block;
574 ioctl(s->sock_fd, FIONBIO, (unsigned int *)&block);
Victor Stinner9a954832013-12-04 00:41:24 +0100575#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000576 delay_flag = fcntl(s->sock_fd, F_GETFL, 0);
577 if (block)
Victor Stinner9a954832013-12-04 00:41:24 +0100578 new_delay_flag = delay_flag & (~O_NONBLOCK);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000579 else
Victor Stinner9a954832013-12-04 00:41:24 +0100580 new_delay_flag = delay_flag | O_NONBLOCK;
581 if (new_delay_flag != delay_flag)
582 fcntl(s->sock_fd, F_SETFL, new_delay_flag);
583#endif
Guido van Rossum67f7a382002-06-06 21:08:16 +0000584#else /* MS_WINDOWS */
Victor Stinnerb6dab6b2014-07-23 22:56:55 +0200585 arg = !block;
586 ioctlsocket(s->sock_fd, FIONBIO, &arg);
Guido van Rossum67f7a382002-06-06 21:08:16 +0000587#endif /* MS_WINDOWS */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000588 Py_END_ALLOW_THREADS
Guido van Rossum67f7a382002-06-06 21:08:16 +0000589
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000590 /* Since these don't return anything */
591 return 1;
Guido van Rossum67f7a382002-06-06 21:08:16 +0000592}
593
Raymond Hettingeref7343c2003-06-29 03:08:05 +0000594static int
Victor Stinner416f2e62015-03-31 13:56:29 +0200595internal_select_impl(PySocketSockObject *s, int writing, _PyTime_t interval,
596 int error)
Guido van Rossum67f7a382002-06-06 21:08:16 +0000597{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000598 int n;
Victor Stinner71694d52015-03-28 01:18:54 +0100599#ifdef HAVE_POLL
600 struct pollfd pollfd;
Victor Stinnere6951c62015-03-31 13:50:44 +0200601 _PyTime_t ms;
Victor Stinner71694d52015-03-28 01:18:54 +0100602#else
Victor Stinner416f2e62015-03-31 13:56:29 +0200603 fd_set fds, efds;
Victor Stinner71694d52015-03-28 01:18:54 +0100604 struct timeval tv;
605#endif
Guido van Rossum11ba0942002-06-13 15:07:44 +0000606
Victor Stinnerb7df3142015-03-27 22:59:32 +0100607#ifdef WITH_THREAD
608 /* must be called with the GIL held */
609 assert(PyGILState_Check());
610#endif
611
Victor Stinner416f2e62015-03-31 13:56:29 +0200612 /* Error condition is for output only */
613 assert(!(error && !writing));
614
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000615 /* Nothing to do unless we're in timeout mode (not non-blocking) */
Victor Stinner71694d52015-03-28 01:18:54 +0100616 if (s->sock_timeout <= 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000617 return 0;
Guido van Rossum67f7a382002-06-06 21:08:16 +0000618
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000619 /* Guard against closed socket */
620 if (s->sock_fd < 0)
621 return 0;
Guido van Rossumad654902002-07-19 12:44:59 +0000622
Antoine Pitrou3e1fd272010-09-28 21:23:11 +0000623 /* Handling this condition here simplifies the select loops */
Victor Stinner71694d52015-03-28 01:18:54 +0100624 if (interval < 0)
Antoine Pitrou3e1fd272010-09-28 21:23:11 +0000625 return 1;
626
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000627 /* Prefer poll, if available, since you can poll() any fd
628 * which can't be done with select(). */
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000629#ifdef HAVE_POLL
Victor Stinner71694d52015-03-28 01:18:54 +0100630 pollfd.fd = s->sock_fd;
631 pollfd.events = writing ? POLLOUT : POLLIN;
Victor Stinner416f2e62015-03-31 13:56:29 +0200632 if (error)
633 pollfd.events |= POLLERR;
Guido van Rossum67f7a382002-06-06 21:08:16 +0000634
Victor Stinner71694d52015-03-28 01:18:54 +0100635 /* s->sock_timeout is in seconds, timeout in ms */
Victor Stinnere6951c62015-03-31 13:50:44 +0200636 ms = _PyTime_AsMilliseconds(interval, _PyTime_ROUND_CEILING);
637 assert(ms <= INT_MAX);
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000638
Victor Stinner71694d52015-03-28 01:18:54 +0100639 Py_BEGIN_ALLOW_THREADS;
Victor Stinnere6951c62015-03-31 13:50:44 +0200640 n = poll(&pollfd, 1, (int)ms);
Victor Stinner71694d52015-03-28 01:18:54 +0100641 Py_END_ALLOW_THREADS;
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000642#else
Victor Stinner869e1772015-03-30 03:49:14 +0200643 _PyTime_AsTimeval_noraise(interval, &tv, _PyTime_ROUND_CEILING);
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000644
Victor Stinner71694d52015-03-28 01:18:54 +0100645 FD_ZERO(&fds);
646 FD_SET(s->sock_fd, &fds);
Victor Stinner416f2e62015-03-31 13:56:29 +0200647 FD_ZERO(&efds);
648 if (error)
649 FD_SET(s->sock_fd, &efds);
Victor Stinner71694d52015-03-28 01:18:54 +0100650
651 /* See if the socket is ready */
652 Py_BEGIN_ALLOW_THREADS;
653 if (writing)
654 n = select(Py_SAFE_DOWNCAST(s->sock_fd+1, SOCKET_T, int),
Victor Stinner416f2e62015-03-31 13:56:29 +0200655 NULL, &fds, &efds, &tv);
Victor Stinner71694d52015-03-28 01:18:54 +0100656 else
657 n = select(Py_SAFE_DOWNCAST(s->sock_fd+1, SOCKET_T, int),
Victor Stinner416f2e62015-03-31 13:56:29 +0200658 &fds, NULL, &efds, &tv);
Victor Stinner71694d52015-03-28 01:18:54 +0100659 Py_END_ALLOW_THREADS;
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000660#endif
Guido van Rossum39eb8fa2007-11-16 01:24:05 +0000661
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000662 if (n < 0)
663 return -1;
664 if (n == 0)
665 return 1;
666 return 0;
Guido van Rossum67f7a382002-06-06 21:08:16 +0000667}
668
Victor Stinnere6951c62015-03-31 13:50:44 +0200669/* Do a select()/poll() on the socket, if necessary (sock_timeout > 0).
670 The argument writing indicates the direction.
671 This does not raise an exception; we'll let our caller do that
672 after they've reacquired the interpreter lock.
673 Returns 1 on timeout, -1 on error, 0 otherwise. */
674static int
675internal_select(PySocketSockObject *s, int writing, _PyTime_t interval)
676{
Victor Stinner416f2e62015-03-31 13:56:29 +0200677 return internal_select_impl(s, writing, interval, 0);
Victor Stinnere6951c62015-03-31 13:50:44 +0200678}
679
680static int
681internal_connect_select(PySocketSockObject *s)
682{
Victor Stinnerdd83bd22015-03-31 14:24:47 +0200683 return internal_select_impl(s, 1, s->sock_timeout, 1);
Victor Stinnere6951c62015-03-31 13:50:44 +0200684}
685
Antoine Pitrou3e1fd272010-09-28 21:23:11 +0000686/*
687 Two macros for automatic retry of select() in case of false positives
688 (for example, select() could indicate a socket is ready for reading
689 but the data then discarded by the OS because of a wrong checksum).
690 Here is an example of use:
691
692 BEGIN_SELECT_LOOP(s)
Victor Stinnerb7df3142015-03-27 22:59:32 +0100693
Victor Stinner391fa712015-03-31 13:15:31 +0200694 timeout = internal_select(s, 0, interval);
Victor Stinnerb7df3142015-03-27 22:59:32 +0100695
696 if (!timeout) {
697 Py_BEGIN_ALLOW_THREADS
Antoine Pitrou3e1fd272010-09-28 21:23:11 +0000698 outlen = recv(s->sock_fd, cbuf, len, flags);
Victor Stinnerb7df3142015-03-27 22:59:32 +0100699 Py_END_ALLOW_THREADS
700 }
Antoine Pitrou3e1fd272010-09-28 21:23:11 +0000701 if (timeout == 1) {
702 PyErr_SetString(socket_timeout, "timed out");
703 return -1;
704 }
705 END_SELECT_LOOP(s)
706*/
707
708#define BEGIN_SELECT_LOOP(s) \
709 { \
Victor Stinner71694d52015-03-28 01:18:54 +0100710 _PyTime_t deadline = 0; \
711 _PyTime_t interval = s->sock_timeout; \
712 int has_timeout = (s->sock_timeout > 0); \
713 if (has_timeout) \
714 deadline = _PyTime_GetMonotonicClock() + interval; \
Antoine Pitrou3e1fd272010-09-28 21:23:11 +0000715 while (1) { \
716 errno = 0; \
717
718#define END_SELECT_LOOP(s) \
719 if (!has_timeout || \
720 (!CHECK_ERRNO(EWOULDBLOCK) && !CHECK_ERRNO(EAGAIN))) \
721 break; \
Victor Stinner71694d52015-03-28 01:18:54 +0100722 interval = deadline - _PyTime_GetMonotonicClock(); \
Antoine Pitrou3e1fd272010-09-28 21:23:11 +0000723 } \
724 } \
725
Guido van Rossum384ca9c2001-10-27 22:20:47 +0000726/* Initialize a new socket object. */
727
Victor Stinner71694d52015-03-28 01:18:54 +0100728static _PyTime_t defaulttimeout = -1; /* Default timeout for new sockets */
Guido van Rossum9d0c8ce2002-07-18 17:08:35 +0000729
Martin v. Löwis1a214512008-06-11 05:26:20 +0000730static void
Guido van Rossum384ca9c2001-10-27 22:20:47 +0000731init_sockobject(PySocketSockObject *s,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000732 SOCKET_T fd, int family, int type, int proto)
Guido van Rossum384ca9c2001-10-27 22:20:47 +0000733{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000734 s->sock_fd = fd;
735 s->sock_family = family;
736 s->sock_type = type;
737 s->sock_proto = proto;
Guido van Rossum67f7a382002-06-06 21:08:16 +0000738
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000739 s->errorhandler = &set_error;
Antoine Pitroub1c54962010-10-14 15:05:38 +0000740#ifdef SOCK_NONBLOCK
741 if (type & SOCK_NONBLOCK)
Victor Stinner71694d52015-03-28 01:18:54 +0100742 s->sock_timeout = 0;
Antoine Pitroub1c54962010-10-14 15:05:38 +0000743 else
744#endif
745 {
746 s->sock_timeout = defaulttimeout;
Victor Stinner71694d52015-03-28 01:18:54 +0100747 if (defaulttimeout >= 0)
Antoine Pitroub1c54962010-10-14 15:05:38 +0000748 internal_setblocking(s, 0);
749 }
Guido van Rossum9d0c8ce2002-07-18 17:08:35 +0000750
Guido van Rossum384ca9c2001-10-27 22:20:47 +0000751}
752
753
Guido van Rossum30a685f1991-06-27 15:51:29 +0000754/* Create a new socket object.
755 This just creates the object and initializes it.
756 If the creation fails, return NULL and set an exception (implicit
757 in NEWOBJ()). */
758
Guido van Rossum73624e91994-10-10 17:59:00 +0000759static PySocketSockObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +0000760new_sockobject(SOCKET_T fd, int family, int type, int proto)
Guido van Rossum6574b3e1991-06-25 21:36:08 +0000761{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000762 PySocketSockObject *s;
763 s = (PySocketSockObject *)
764 PyType_GenericNew(&sock_type, NULL, NULL);
765 if (s != NULL)
766 init_sockobject(s, fd, family, type, proto);
767 return s;
Guido van Rossum6574b3e1991-06-25 21:36:08 +0000768}
769
Guido van Rossum30a685f1991-06-27 15:51:29 +0000770
Guido van Rossum48a680c2001-03-02 06:34:14 +0000771/* Lock to allow python interpreter to continue, but only allow one
Just van Rossum1040d2c2003-05-09 07:53:18 +0000772 thread to be in gethostbyname or getaddrinfo */
773#if defined(USE_GETHOSTBYNAME_LOCK) || defined(USE_GETADDRINFO_LOCK)
Matthias Klosed182a6c2012-08-14 17:29:04 +0200774static PyThread_type_lock netdb_lock;
Guido van Rossum4f199ea1998-04-09 20:56:35 +0000775#endif
776
777
Guido van Rossum30a685f1991-06-27 15:51:29 +0000778/* Convert a string specifying a host name or one of a few symbolic
779 names to a numeric IP address. This usually calls gethostbyname()
780 to do the work; the names "" and "<broadcast>" are special.
Martin v. Löwis2d8d4272001-07-21 18:05:31 +0000781 Return the length (IPv4 should be 4 bytes), or negative if
Guido van Rossum30a685f1991-06-27 15:51:29 +0000782 an error occurred; then an exception is raised. */
783
Guido van Rossum6574b3e1991-06-25 21:36:08 +0000784static int
Martin v. Löwisddc6f472002-07-28 16:10:31 +0000785setipaddr(char *name, struct sockaddr *addr_ret, size_t addr_ret_size, int af)
Guido van Rossum6574b3e1991-06-25 21:36:08 +0000786{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000787 struct addrinfo hints, *res;
788 int error;
Guido van Rossum6574b3e1991-06-25 21:36:08 +0000789
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000790 memset((void *) addr_ret, '\0', sizeof(*addr_ret));
791 if (name[0] == '\0') {
792 int siz;
793 memset(&hints, 0, sizeof(hints));
794 hints.ai_family = af;
795 hints.ai_socktype = SOCK_DGRAM; /*dummy*/
796 hints.ai_flags = AI_PASSIVE;
797 Py_BEGIN_ALLOW_THREADS
798 ACQUIRE_GETADDRINFO_LOCK
799 error = getaddrinfo(NULL, "0", &hints, &res);
800 Py_END_ALLOW_THREADS
801 /* We assume that those thread-unsafe getaddrinfo() versions
802 *are* safe regarding their return value, ie. that a
803 subsequent call to getaddrinfo() does not destroy the
804 outcome of the first call. */
805 RELEASE_GETADDRINFO_LOCK
806 if (error) {
807 set_gaierror(error);
808 return -1;
809 }
810 switch (res->ai_family) {
811 case AF_INET:
812 siz = 4;
813 break;
Martin v. Löwis44ddbde2001-12-02 10:15:37 +0000814#ifdef ENABLE_IPV6
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000815 case AF_INET6:
816 siz = 16;
817 break;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +0000818#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000819 default:
820 freeaddrinfo(res);
Antoine Pitrou6b4883d2011-10-12 02:54:14 +0200821 PyErr_SetString(PyExc_OSError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000822 "unsupported address family");
823 return -1;
824 }
825 if (res->ai_next) {
826 freeaddrinfo(res);
Antoine Pitrou6b4883d2011-10-12 02:54:14 +0200827 PyErr_SetString(PyExc_OSError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000828 "wildcard resolved to multiple address");
829 return -1;
830 }
831 if (res->ai_addrlen < addr_ret_size)
832 addr_ret_size = res->ai_addrlen;
833 memcpy(addr_ret, res->ai_addr, addr_ret_size);
834 freeaddrinfo(res);
835 return siz;
836 }
Charles-François Natali0cc86852013-09-13 19:53:08 +0200837 /* special-case broadcast - inet_addr() below can return INADDR_NONE for
Victor Stinnere990c6e2013-11-16 00:18:58 +0100838 * this */
Charles-François Natali0cc86852013-09-13 19:53:08 +0200839 if (strcmp(name, "255.255.255.255") == 0 ||
840 strcmp(name, "<broadcast>") == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000841 struct sockaddr_in *sin;
842 if (af != AF_INET && af != AF_UNSPEC) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +0200843 PyErr_SetString(PyExc_OSError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000844 "address family mismatched");
845 return -1;
846 }
847 sin = (struct sockaddr_in *)addr_ret;
848 memset((void *) sin, '\0', sizeof(*sin));
849 sin->sin_family = AF_INET;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +0000850#ifdef HAVE_SOCKADDR_SA_LEN
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000851 sin->sin_len = sizeof(*sin);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +0000852#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000853 sin->sin_addr.s_addr = INADDR_BROADCAST;
854 return sizeof(sin->sin_addr);
855 }
Charles-François Natali0cc86852013-09-13 19:53:08 +0200856
857 /* avoid a name resolution in case of numeric address */
858#ifdef HAVE_INET_PTON
859 /* check for an IPv4 address */
860 if (af == AF_UNSPEC || af == AF_INET) {
861 struct sockaddr_in *sin = (struct sockaddr_in *)addr_ret;
862 memset(sin, 0, sizeof(*sin));
863 if (inet_pton(AF_INET, name, &sin->sin_addr) > 0) {
864 sin->sin_family = AF_INET;
Anthony Baxter0e85f9d2003-05-02 15:40:46 +0000865#ifdef HAVE_SOCKADDR_SA_LEN
Charles-François Natali0cc86852013-09-13 19:53:08 +0200866 sin->sin_len = sizeof(*sin);
Anthony Baxter0e85f9d2003-05-02 15:40:46 +0000867#endif
Charles-François Natali0cc86852013-09-13 19:53:08 +0200868 return 4;
869 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000870 }
Charles-François Natali0cc86852013-09-13 19:53:08 +0200871#ifdef ENABLE_IPV6
872 /* check for an IPv6 address - if the address contains a scope ID, we
873 * fallback to getaddrinfo(), which can handle translation from interface
874 * name to interface index */
875 if ((af == AF_UNSPEC || af == AF_INET6) && !strchr(name, '%')) {
876 struct sockaddr_in6 *sin = (struct sockaddr_in6 *)addr_ret;
877 memset(sin, 0, sizeof(*sin));
878 if (inet_pton(AF_INET6, name, &sin->sin6_addr) > 0) {
879 sin->sin6_family = AF_INET6;
880#ifdef HAVE_SOCKADDR_SA_LEN
881 sin->sin6_len = sizeof(*sin);
882#endif
883 return 16;
884 }
885 }
886#endif /* ENABLE_IPV6 */
887#else /* HAVE_INET_PTON */
888 /* check for an IPv4 address */
889 if (af == AF_INET || af == AF_UNSPEC) {
890 struct sockaddr_in *sin = (struct sockaddr_in *)addr_ret;
891 memset(sin, 0, sizeof(*sin));
892 if ((sin->sin_addr.s_addr = inet_addr(name)) != INADDR_NONE) {
893 sin->sin_family = AF_INET;
894#ifdef HAVE_SOCKADDR_SA_LEN
895 sin->sin_len = sizeof(*sin);
896#endif
897 return 4;
898 }
Victor Stinnere990c6e2013-11-16 00:18:58 +0100899 }
Charles-François Natali0cc86852013-09-13 19:53:08 +0200900#endif /* HAVE_INET_PTON */
901
902 /* perform a name resolution */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000903 memset(&hints, 0, sizeof(hints));
904 hints.ai_family = af;
905 Py_BEGIN_ALLOW_THREADS
906 ACQUIRE_GETADDRINFO_LOCK
907 error = getaddrinfo(name, NULL, &hints, &res);
Martin v. Löwis7c4b5fa2001-10-25 09:04:03 +0000908#if defined(__digital__) && defined(__unix__)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000909 if (error == EAI_NONAME && af == AF_UNSPEC) {
910 /* On Tru64 V5.1, numeric-to-addr conversion fails
911 if no address family is given. Assume IPv4 for now.*/
912 hints.ai_family = AF_INET;
913 error = getaddrinfo(name, NULL, &hints, &res);
914 }
Martin v. Löwis7c4b5fa2001-10-25 09:04:03 +0000915#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000916 Py_END_ALLOW_THREADS
917 RELEASE_GETADDRINFO_LOCK /* see comment in setipaddr() */
918 if (error) {
919 set_gaierror(error);
920 return -1;
921 }
922 if (res->ai_addrlen < addr_ret_size)
923 addr_ret_size = res->ai_addrlen;
924 memcpy((char *) addr_ret, res->ai_addr, addr_ret_size);
925 freeaddrinfo(res);
926 switch (addr_ret->sa_family) {
927 case AF_INET:
928 return 4;
Martin v. Löwis44ddbde2001-12-02 10:15:37 +0000929#ifdef ENABLE_IPV6
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000930 case AF_INET6:
931 return 16;
Guido van Rossum955becc1999-03-22 20:14:53 +0000932#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000933 default:
Antoine Pitrou6b4883d2011-10-12 02:54:14 +0200934 PyErr_SetString(PyExc_OSError, "unknown address family");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000935 return -1;
936 }
Guido van Rossum6574b3e1991-06-25 21:36:08 +0000937}
938
Guido van Rossum30a685f1991-06-27 15:51:29 +0000939
Guido van Rossum30a685f1991-06-27 15:51:29 +0000940/* Create a string object representing an IP address.
941 This is always a string of the form 'dd.dd.dd.dd' (with variable
942 size numbers). */
943
Guido van Rossum73624e91994-10-10 17:59:00 +0000944static PyObject *
Martin v. Löwis2d8d4272001-07-21 18:05:31 +0000945makeipaddr(struct sockaddr *addr, int addrlen)
Guido van Rossum30a685f1991-06-27 15:51:29 +0000946{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000947 char buf[NI_MAXHOST];
948 int error;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +0000949
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000950 error = getnameinfo(addr, addrlen, buf, sizeof(buf), NULL, 0,
951 NI_NUMERICHOST);
952 if (error) {
953 set_gaierror(error);
954 return NULL;
955 }
956 return PyUnicode_FromString(buf);
Guido van Rossum30a685f1991-06-27 15:51:29 +0000957}
958
959
Martin v. Löwis558d9bf2004-06-03 09:24:42 +0000960#ifdef USE_BLUETOOTH
961/* Convert a string representation of a Bluetooth address into a numeric
962 address. Returns the length (6), or raises an exception and returns -1 if
963 an error occurred. */
964
965static int
966setbdaddr(char *name, bdaddr_t *bdaddr)
967{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000968 unsigned int b0, b1, b2, b3, b4, b5;
969 char ch;
970 int n;
Martin v. Löwis558d9bf2004-06-03 09:24:42 +0000971
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000972 n = sscanf(name, "%X:%X:%X:%X:%X:%X%c",
973 &b5, &b4, &b3, &b2, &b1, &b0, &ch);
974 if (n == 6 && (b0 | b1 | b2 | b3 | b4 | b5) < 256) {
975 bdaddr->b[0] = b0;
976 bdaddr->b[1] = b1;
977 bdaddr->b[2] = b2;
978 bdaddr->b[3] = b3;
979 bdaddr->b[4] = b4;
980 bdaddr->b[5] = b5;
981 return 6;
982 } else {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +0200983 PyErr_SetString(PyExc_OSError, "bad bluetooth address");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000984 return -1;
985 }
Martin v. Löwis558d9bf2004-06-03 09:24:42 +0000986}
987
988/* Create a string representation of the Bluetooth address. This is always a
989 string of the form 'XX:XX:XX:XX:XX:XX' where XX is a two digit hexadecimal
990 value (zero padded if necessary). */
991
992static PyObject *
993makebdaddr(bdaddr_t *bdaddr)
994{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000995 char buf[(6 * 2) + 5 + 1];
Martin v. Löwis558d9bf2004-06-03 09:24:42 +0000996
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000997 sprintf(buf, "%02X:%02X:%02X:%02X:%02X:%02X",
998 bdaddr->b[5], bdaddr->b[4], bdaddr->b[3],
999 bdaddr->b[2], bdaddr->b[1], bdaddr->b[0]);
1000 return PyUnicode_FromString(buf);
Martin v. Löwis558d9bf2004-06-03 09:24:42 +00001001}
1002#endif
1003
1004
Guido van Rossum30a685f1991-06-27 15:51:29 +00001005/* Create an object representing the given socket address,
1006 suitable for passing it back to bind(), connect() etc.
1007 The family field of the sockaddr structure is inspected
1008 to determine what kind of address it really is. */
1009
Guido van Rossum6574b3e1991-06-25 21:36:08 +00001010/*ARGSUSED*/
Guido van Rossum73624e91994-10-10 17:59:00 +00001011static PyObject *
Antoine Pitrou19467d22010-08-17 19:33:30 +00001012makesockaddr(SOCKET_T sockfd, struct sockaddr *addr, size_t addrlen, int proto)
Guido van Rossum6574b3e1991-06-25 21:36:08 +00001013{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001014 if (addrlen == 0) {
1015 /* No address -- may be recvfrom() from known socket */
1016 Py_INCREF(Py_None);
1017 return Py_None;
1018 }
Guido van Rossum25bec8c1992-08-05 19:00:45 +00001019
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001020 switch (addr->sa_family) {
Guido van Rossum30a685f1991-06-27 15:51:29 +00001021
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001022 case AF_INET:
1023 {
1024 struct sockaddr_in *a;
1025 PyObject *addrobj = makeipaddr(addr, sizeof(*a));
1026 PyObject *ret = NULL;
1027 if (addrobj) {
1028 a = (struct sockaddr_in *)addr;
1029 ret = Py_BuildValue("Oi", addrobj, ntohs(a->sin_port));
1030 Py_DECREF(addrobj);
1031 }
1032 return ret;
1033 }
Guido van Rossum30a685f1991-06-27 15:51:29 +00001034
Andrew MacIntyred12dfbb2004-04-04 07:13:49 +00001035#if defined(AF_UNIX)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001036 case AF_UNIX:
1037 {
1038 struct sockaddr_un *a = (struct sockaddr_un *) addr;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001039#ifdef linux
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001040 if (a->sun_path[0] == 0) { /* Linux abstract namespace */
1041 addrlen -= offsetof(struct sockaddr_un, sun_path);
Charles-François Natalib10c71d2013-05-21 10:45:46 +02001042 return PyBytes_FromStringAndSize(a->sun_path, addrlen);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001043 }
1044 else
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001045#endif /* linux */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001046 {
1047 /* regular NULL-terminated string */
Antoine Pitrou6ec29e22011-12-16 14:46:36 +01001048 return PyUnicode_DecodeFSDefault(a->sun_path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001049 }
1050 }
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00001051#endif /* AF_UNIX */
1052
Martin v. Löwis11017b12006-01-14 18:12:57 +00001053#if defined(AF_NETLINK)
1054 case AF_NETLINK:
1055 {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001056 struct sockaddr_nl *a = (struct sockaddr_nl *) addr;
1057 return Py_BuildValue("II", a->nl_pid, a->nl_groups);
Martin v. Löwis11017b12006-01-14 18:12:57 +00001058 }
1059#endif /* AF_NETLINK */
1060
Martin v. Löwis44ddbde2001-12-02 10:15:37 +00001061#ifdef ENABLE_IPV6
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001062 case AF_INET6:
1063 {
1064 struct sockaddr_in6 *a;
1065 PyObject *addrobj = makeipaddr(addr, sizeof(*a));
1066 PyObject *ret = NULL;
1067 if (addrobj) {
1068 a = (struct sockaddr_in6 *)addr;
Charles-François Natali366999a2012-01-02 15:47:29 +01001069 ret = Py_BuildValue("OiII",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001070 addrobj,
1071 ntohs(a->sin6_port),
Charles-François Natali366999a2012-01-02 15:47:29 +01001072 ntohl(a->sin6_flowinfo),
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001073 a->sin6_scope_id);
1074 Py_DECREF(addrobj);
1075 }
1076 return ret;
1077 }
Jeremy Hylton22308652001-02-02 03:23:09 +00001078#endif
Guido van Rossum30a685f1991-06-27 15:51:29 +00001079
Martin v. Löwis558d9bf2004-06-03 09:24:42 +00001080#ifdef USE_BLUETOOTH
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001081 case AF_BLUETOOTH:
1082 switch (proto) {
Martin v. Löwis558d9bf2004-06-03 09:24:42 +00001083
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001084 case BTPROTO_L2CAP:
1085 {
1086 struct sockaddr_l2 *a = (struct sockaddr_l2 *) addr;
1087 PyObject *addrobj = makebdaddr(&_BT_L2_MEMB(a, bdaddr));
1088 PyObject *ret = NULL;
1089 if (addrobj) {
1090 ret = Py_BuildValue("Oi",
1091 addrobj,
1092 _BT_L2_MEMB(a, psm));
1093 Py_DECREF(addrobj);
1094 }
1095 return ret;
1096 }
Martin v. Löwis558d9bf2004-06-03 09:24:42 +00001097
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001098 case BTPROTO_RFCOMM:
1099 {
1100 struct sockaddr_rc *a = (struct sockaddr_rc *) addr;
1101 PyObject *addrobj = makebdaddr(&_BT_RC_MEMB(a, bdaddr));
1102 PyObject *ret = NULL;
1103 if (addrobj) {
1104 ret = Py_BuildValue("Oi",
1105 addrobj,
1106 _BT_RC_MEMB(a, channel));
1107 Py_DECREF(addrobj);
1108 }
1109 return ret;
1110 }
Martin v. Löwis558d9bf2004-06-03 09:24:42 +00001111
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001112 case BTPROTO_HCI:
1113 {
1114 struct sockaddr_hci *a = (struct sockaddr_hci *) addr;
Gregory P. Smith3e85dfd2010-10-17 00:43:10 +00001115#if defined(__NetBSD__) || defined(__DragonFly__)
1116 return makebdaddr(&_BT_HCI_MEMB(a, bdaddr));
1117#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001118 PyObject *ret = NULL;
1119 ret = Py_BuildValue("i", _BT_HCI_MEMB(a, dev));
1120 return ret;
Gregory P. Smith3e85dfd2010-10-17 00:43:10 +00001121#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001122 }
Thomas Wouterscf297e42007-02-23 15:07:44 +00001123
Martin v. Löwis558d9bf2004-06-03 09:24:42 +00001124#if !defined(__FreeBSD__)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001125 case BTPROTO_SCO:
1126 {
1127 struct sockaddr_sco *a = (struct sockaddr_sco *) addr;
1128 return makebdaddr(&_BT_SCO_MEMB(a, bdaddr));
1129 }
Martin v. Löwis558d9bf2004-06-03 09:24:42 +00001130#endif
1131
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001132 default:
1133 PyErr_SetString(PyExc_ValueError,
1134 "Unknown Bluetooth protocol");
1135 return NULL;
1136 }
Martin v. Löwis558d9bf2004-06-03 09:24:42 +00001137#endif
1138
Antoine Pitroub156a462010-10-27 20:13:57 +00001139#if defined(HAVE_NETPACKET_PACKET_H) && defined(SIOCGIFNAME)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001140 case AF_PACKET:
1141 {
1142 struct sockaddr_ll *a = (struct sockaddr_ll *)addr;
1143 char *ifname = "";
1144 struct ifreq ifr;
1145 /* need to look up interface name give index */
1146 if (a->sll_ifindex) {
1147 ifr.ifr_ifindex = a->sll_ifindex;
1148 if (ioctl(sockfd, SIOCGIFNAME, &ifr) == 0)
1149 ifname = ifr.ifr_name;
1150 }
1151 return Py_BuildValue("shbhy#",
1152 ifname,
1153 ntohs(a->sll_protocol),
1154 a->sll_pkttype,
1155 a->sll_hatype,
1156 a->sll_addr,
1157 a->sll_halen);
1158 }
Jeremy Hylton22308652001-02-02 03:23:09 +00001159#endif
Guido van Rossum48a680c2001-03-02 06:34:14 +00001160
Christian Heimes043d6f62008-01-07 17:19:16 +00001161#ifdef HAVE_LINUX_TIPC_H
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001162 case AF_TIPC:
1163 {
1164 struct sockaddr_tipc *a = (struct sockaddr_tipc *) addr;
1165 if (a->addrtype == TIPC_ADDR_NAMESEQ) {
1166 return Py_BuildValue("IIIII",
1167 a->addrtype,
1168 a->addr.nameseq.type,
1169 a->addr.nameseq.lower,
1170 a->addr.nameseq.upper,
1171 a->scope);
1172 } else if (a->addrtype == TIPC_ADDR_NAME) {
1173 return Py_BuildValue("IIIII",
1174 a->addrtype,
1175 a->addr.name.name.type,
1176 a->addr.name.name.instance,
1177 a->addr.name.name.instance,
1178 a->scope);
1179 } else if (a->addrtype == TIPC_ADDR_ID) {
1180 return Py_BuildValue("IIIII",
1181 a->addrtype,
1182 a->addr.id.node,
1183 a->addr.id.ref,
1184 0,
1185 a->scope);
1186 } else {
1187 PyErr_SetString(PyExc_ValueError,
1188 "Invalid address type");
1189 return NULL;
1190 }
1191 }
Christian Heimes043d6f62008-01-07 17:19:16 +00001192#endif
1193
Vinay Sajipecfc98c2014-03-20 12:42:42 +00001194#ifdef AF_CAN
Charles-François Natali47413c12011-10-06 19:47:44 +02001195 case AF_CAN:
1196 {
1197 struct sockaddr_can *a = (struct sockaddr_can *)addr;
1198 char *ifname = "";
1199 struct ifreq ifr;
1200 /* need to look up interface name given index */
1201 if (a->can_ifindex) {
1202 ifr.ifr_ifindex = a->can_ifindex;
1203 if (ioctl(sockfd, SIOCGIFNAME, &ifr) == 0)
1204 ifname = ifr.ifr_name;
1205 }
1206
1207 return Py_BuildValue("O&h", PyUnicode_DecodeFSDefault,
1208 ifname,
1209 a->can_family);
1210 }
1211#endif
1212
Martin v. Löwis9d6c6692012-02-03 17:44:58 +01001213#ifdef PF_SYSTEM
1214 case PF_SYSTEM:
1215 switch(proto) {
1216#ifdef SYSPROTO_CONTROL
1217 case SYSPROTO_CONTROL:
1218 {
1219 struct sockaddr_ctl *a = (struct sockaddr_ctl *)addr;
1220 return Py_BuildValue("(II)", a->sc_id, a->sc_unit);
1221 }
1222#endif
1223 default:
1224 PyErr_SetString(PyExc_ValueError,
1225 "Invalid address type");
1226 return 0;
1227 }
1228#endif
1229
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001230 /* More cases here... */
Guido van Rossum30a685f1991-06-27 15:51:29 +00001231
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001232 default:
1233 /* If we don't know the address family, don't raise an
1234 exception -- return it as an (int, bytes) tuple. */
1235 return Py_BuildValue("iy#",
1236 addr->sa_family,
1237 addr->sa_data,
1238 sizeof(addr->sa_data));
Guido van Rossum25bec8c1992-08-05 19:00:45 +00001239
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001240 }
Guido van Rossum6574b3e1991-06-25 21:36:08 +00001241}
1242
Martin v. Löwiseb1c28a2014-08-05 16:10:38 +02001243/* Helper for getsockaddrarg: bypass IDNA for ASCII-only host names
1244 (in particular, numeric IP addresses). */
1245struct maybe_idna {
1246 PyObject *obj;
1247 char *buf;
1248};
1249
1250static void
1251idna_cleanup(struct maybe_idna *data)
1252{
1253 Py_CLEAR(data->obj);
1254}
1255
1256static int
1257idna_converter(PyObject *obj, struct maybe_idna *data)
1258{
1259 size_t len;
1260 PyObject *obj2, *obj3;
1261 if (obj == NULL) {
1262 idna_cleanup(data);
1263 return 1;
1264 }
1265 data->obj = NULL;
1266 len = -1;
1267 if (PyBytes_Check(obj)) {
1268 data->buf = PyBytes_AsString(obj);
1269 len = PyBytes_Size(obj);
1270 }
1271 else if (PyByteArray_Check(obj)) {
1272 data->buf = PyByteArray_AsString(obj);
1273 len = PyByteArray_Size(obj);
1274 }
1275 else if (PyUnicode_Check(obj) && PyUnicode_READY(obj) == 0 && PyUnicode_IS_COMPACT_ASCII(obj)) {
1276 data->buf = PyUnicode_DATA(obj);
1277 len = PyUnicode_GET_LENGTH(obj);
1278 }
1279 else {
1280 obj2 = PyUnicode_FromObject(obj);
1281 if (!obj2) {
1282 PyErr_Format(PyExc_TypeError, "string or unicode text buffer expected, not %s",
1283 obj->ob_type->tp_name);
1284 return 0;
1285 }
1286 obj3 = PyUnicode_AsEncodedString(obj2, "idna", NULL);
1287 Py_DECREF(obj2);
1288 if (!obj3) {
1289 PyErr_SetString(PyExc_TypeError, "encoding of hostname failed");
1290 return 0;
1291 }
1292 if (!PyBytes_Check(obj3)) {
Martin v. Löwis17fd1e12014-08-05 16:13:50 +02001293 Py_DECREF(obj3);
Martin v. Löwiseb1c28a2014-08-05 16:10:38 +02001294 PyErr_SetString(PyExc_TypeError, "encoding of hostname failed to return bytes");
1295 return 0;
1296 }
1297 data->obj = obj3;
1298 data->buf = PyBytes_AS_STRING(obj3);
1299 len = PyBytes_GET_SIZE(obj3);
1300 }
1301 if (strlen(data->buf) != len) {
1302 Py_CLEAR(data->obj);
Serhiy Storchakad8a14472014-09-06 20:07:17 +03001303 PyErr_SetString(PyExc_TypeError, "host name must not contain null character");
Martin v. Löwiseb1c28a2014-08-05 16:10:38 +02001304 return 0;
1305 }
1306 return Py_CLEANUP_SUPPORTED;
Victor Stinner1a62a682014-08-17 19:33:28 +02001307}
Guido van Rossum30a685f1991-06-27 15:51:29 +00001308
1309/* Parse a socket address argument according to the socket object's
1310 address family. Return 1 if the address was in the proper format,
1311 0 of not. The address is returned through addr_ret, its length
1312 through len_ret. */
1313
Guido van Rossum6574b3e1991-06-25 21:36:08 +00001314static int
Guido van Rossum48a680c2001-03-02 06:34:14 +00001315getsockaddrarg(PySocketSockObject *s, PyObject *args,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001316 struct sockaddr *addr_ret, int *len_ret)
Guido van Rossum6574b3e1991-06-25 21:36:08 +00001317{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001318 switch (s->sock_family) {
Guido van Rossum30a685f1991-06-27 15:51:29 +00001319
Andrew MacIntyred12dfbb2004-04-04 07:13:49 +00001320#if defined(AF_UNIX)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001321 case AF_UNIX:
1322 {
1323 struct sockaddr_un* addr;
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02001324 Py_buffer path;
Antoine Pitrou6ec29e22011-12-16 14:46:36 +01001325 int retval = 0;
1326
1327 /* PEP 383. Not using PyUnicode_FSConverter since we need to
1328 allow embedded nulls on Linux. */
1329 if (PyUnicode_Check(args)) {
1330 if ((args = PyUnicode_EncodeFSDefault(args)) == NULL)
1331 return 0;
1332 }
1333 else
1334 Py_INCREF(args);
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02001335 if (!PyArg_Parse(args, "y*", &path)) {
1336 Py_DECREF(args);
1337 return retval;
1338 }
1339 assert(path.len >= 0);
Thomas Wouters89f507f2006-12-13 04:49:30 +00001340
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001341 addr = (struct sockaddr_un*)addr_ret;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001342#ifdef linux
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02001343 if (path.len > 0 && *(const char *)path.buf == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001344 /* Linux abstract namespace extension */
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02001345 if ((size_t)path.len > sizeof addr->sun_path) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02001346 PyErr_SetString(PyExc_OSError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001347 "AF_UNIX path too long");
Antoine Pitrou6ec29e22011-12-16 14:46:36 +01001348 goto unix_out;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001349 }
1350 }
1351 else
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001352#endif /* linux */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001353 {
1354 /* regular NULL-terminated string */
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02001355 if ((size_t)path.len >= sizeof addr->sun_path) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02001356 PyErr_SetString(PyExc_OSError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001357 "AF_UNIX path too long");
Antoine Pitrou6ec29e22011-12-16 14:46:36 +01001358 goto unix_out;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001359 }
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02001360 addr->sun_path[path.len] = 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001361 }
1362 addr->sun_family = s->sock_family;
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02001363 memcpy(addr->sun_path, path.buf, path.len);
1364 *len_ret = path.len + offsetof(struct sockaddr_un, sun_path);
Antoine Pitrou6ec29e22011-12-16 14:46:36 +01001365 retval = 1;
1366 unix_out:
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02001367 PyBuffer_Release(&path);
Antoine Pitrou6ec29e22011-12-16 14:46:36 +01001368 Py_DECREF(args);
1369 return retval;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001370 }
Guido van Rossumb6775db1994-08-01 11:34:53 +00001371#endif /* AF_UNIX */
Guido van Rossum6574b3e1991-06-25 21:36:08 +00001372
Martin v. Löwis11017b12006-01-14 18:12:57 +00001373#if defined(AF_NETLINK)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001374 case AF_NETLINK:
1375 {
1376 struct sockaddr_nl* addr;
1377 int pid, groups;
1378 addr = (struct sockaddr_nl *)addr_ret;
1379 if (!PyTuple_Check(args)) {
1380 PyErr_Format(
1381 PyExc_TypeError,
1382 "getsockaddrarg: "
1383 "AF_NETLINK address must be tuple, not %.500s",
1384 Py_TYPE(args)->tp_name);
1385 return 0;
1386 }
1387 if (!PyArg_ParseTuple(args, "II:getsockaddrarg", &pid, &groups))
1388 return 0;
1389 addr->nl_family = AF_NETLINK;
1390 addr->nl_pid = pid;
1391 addr->nl_groups = groups;
1392 *len_ret = sizeof(*addr);
1393 return 1;
1394 }
Martin v. Löwis11017b12006-01-14 18:12:57 +00001395#endif
1396
Charles-François Natali10b8cf42011-11-10 19:21:37 +01001397#ifdef AF_RDS
1398 case AF_RDS:
1399 /* RDS sockets use sockaddr_in: fall-through */
1400#endif
1401
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001402 case AF_INET:
1403 {
1404 struct sockaddr_in* addr;
Martin v. Löwiseb1c28a2014-08-05 16:10:38 +02001405 struct maybe_idna host = {NULL, NULL};
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001406 int port, result;
1407 if (!PyTuple_Check(args)) {
1408 PyErr_Format(
1409 PyExc_TypeError,
1410 "getsockaddrarg: "
1411 "AF_INET address must be tuple, not %.500s",
1412 Py_TYPE(args)->tp_name);
1413 return 0;
1414 }
Martin v. Löwiseb1c28a2014-08-05 16:10:38 +02001415 if (!PyArg_ParseTuple(args, "O&i:getsockaddrarg",
1416 idna_converter, &host, &port))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001417 return 0;
1418 addr=(struct sockaddr_in*)addr_ret;
Martin v. Löwiseb1c28a2014-08-05 16:10:38 +02001419 result = setipaddr(host.buf, (struct sockaddr *)addr,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001420 sizeof(*addr), AF_INET);
Martin v. Löwiseb1c28a2014-08-05 16:10:38 +02001421 idna_cleanup(&host);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001422 if (result < 0)
1423 return 0;
1424 if (port < 0 || port > 0xffff) {
1425 PyErr_SetString(
1426 PyExc_OverflowError,
1427 "getsockaddrarg: port must be 0-65535.");
1428 return 0;
1429 }
1430 addr->sin_family = AF_INET;
1431 addr->sin_port = htons((short)port);
1432 *len_ret = sizeof *addr;
1433 return 1;
1434 }
Guido van Rossum6574b3e1991-06-25 21:36:08 +00001435
Martin v. Löwis44ddbde2001-12-02 10:15:37 +00001436#ifdef ENABLE_IPV6
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001437 case AF_INET6:
1438 {
1439 struct sockaddr_in6* addr;
Martin v. Löwiseb1c28a2014-08-05 16:10:38 +02001440 struct maybe_idna host = {NULL, NULL};
Charles-François Natali366999a2012-01-02 15:47:29 +01001441 int port, result;
1442 unsigned int flowinfo, scope_id;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001443 flowinfo = scope_id = 0;
1444 if (!PyTuple_Check(args)) {
1445 PyErr_Format(
1446 PyExc_TypeError,
1447 "getsockaddrarg: "
1448 "AF_INET6 address must be tuple, not %.500s",
1449 Py_TYPE(args)->tp_name);
1450 return 0;
1451 }
Martin v. Löwiseb1c28a2014-08-05 16:10:38 +02001452 if (!PyArg_ParseTuple(args, "O&i|II",
1453 idna_converter, &host, &port, &flowinfo,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001454 &scope_id)) {
1455 return 0;
1456 }
1457 addr = (struct sockaddr_in6*)addr_ret;
Martin v. Löwiseb1c28a2014-08-05 16:10:38 +02001458 result = setipaddr(host.buf, (struct sockaddr *)addr,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001459 sizeof(*addr), AF_INET6);
Martin v. Löwiseb1c28a2014-08-05 16:10:38 +02001460 idna_cleanup(&host);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001461 if (result < 0)
1462 return 0;
1463 if (port < 0 || port > 0xffff) {
1464 PyErr_SetString(
1465 PyExc_OverflowError,
1466 "getsockaddrarg: port must be 0-65535.");
1467 return 0;
1468 }
Charles-François Natali9b0c0062012-06-23 10:17:05 +02001469 if (flowinfo > 0xfffff) {
Charles-François Natali366999a2012-01-02 15:47:29 +01001470 PyErr_SetString(
1471 PyExc_OverflowError,
1472 "getsockaddrarg: flowinfo must be 0-1048575.");
1473 return 0;
1474 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001475 addr->sin6_family = s->sock_family;
1476 addr->sin6_port = htons((short)port);
Charles-François Natali366999a2012-01-02 15:47:29 +01001477 addr->sin6_flowinfo = htonl(flowinfo);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001478 addr->sin6_scope_id = scope_id;
1479 *len_ret = sizeof *addr;
1480 return 1;
1481 }
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00001482#endif
1483
Hye-Shik Chang81268602004-02-02 06:05:24 +00001484#ifdef USE_BLUETOOTH
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001485 case AF_BLUETOOTH:
1486 {
1487 switch (s->sock_proto) {
1488 case BTPROTO_L2CAP:
1489 {
1490 struct sockaddr_l2 *addr;
1491 char *straddr;
Martin v. Löwis12af0482004-01-31 12:34:17 +00001492
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001493 addr = (struct sockaddr_l2 *)addr_ret;
1494 memset(addr, 0, sizeof(struct sockaddr_l2));
1495 _BT_L2_MEMB(addr, family) = AF_BLUETOOTH;
1496 if (!PyArg_ParseTuple(args, "si", &straddr,
1497 &_BT_L2_MEMB(addr, psm))) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02001498 PyErr_SetString(PyExc_OSError, "getsockaddrarg: "
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001499 "wrong format");
1500 return 0;
1501 }
1502 if (setbdaddr(straddr, &_BT_L2_MEMB(addr, bdaddr)) < 0)
1503 return 0;
Martin v. Löwis558d9bf2004-06-03 09:24:42 +00001504
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001505 *len_ret = sizeof *addr;
1506 return 1;
1507 }
1508 case BTPROTO_RFCOMM:
1509 {
1510 struct sockaddr_rc *addr;
1511 char *straddr;
Martin v. Löwis558d9bf2004-06-03 09:24:42 +00001512
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001513 addr = (struct sockaddr_rc *)addr_ret;
1514 _BT_RC_MEMB(addr, family) = AF_BLUETOOTH;
1515 if (!PyArg_ParseTuple(args, "si", &straddr,
1516 &_BT_RC_MEMB(addr, channel))) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02001517 PyErr_SetString(PyExc_OSError, "getsockaddrarg: "
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001518 "wrong format");
1519 return 0;
1520 }
1521 if (setbdaddr(straddr, &_BT_RC_MEMB(addr, bdaddr)) < 0)
1522 return 0;
Martin v. Löwis558d9bf2004-06-03 09:24:42 +00001523
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001524 *len_ret = sizeof *addr;
1525 return 1;
1526 }
1527 case BTPROTO_HCI:
1528 {
1529 struct sockaddr_hci *addr = (struct sockaddr_hci *)addr_ret;
Gregory P. Smith3e85dfd2010-10-17 00:43:10 +00001530#if defined(__NetBSD__) || defined(__DragonFly__)
Alexander Belopolskye239d232010-12-08 23:31:48 +00001531 char *straddr = PyBytes_AS_STRING(args);
Gregory P. Smith3e85dfd2010-10-17 00:43:10 +00001532
Alexander Belopolskye239d232010-12-08 23:31:48 +00001533 _BT_HCI_MEMB(addr, family) = AF_BLUETOOTH;
Gregory P. Smith3e85dfd2010-10-17 00:43:10 +00001534 if (straddr == NULL) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02001535 PyErr_SetString(PyExc_OSError, "getsockaddrarg: "
Gregory P. Smith3e85dfd2010-10-17 00:43:10 +00001536 "wrong format");
1537 return 0;
1538 }
1539 if (setbdaddr(straddr, &_BT_HCI_MEMB(addr, bdaddr)) < 0)
1540 return 0;
1541#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001542 _BT_HCI_MEMB(addr, family) = AF_BLUETOOTH;
1543 if (!PyArg_ParseTuple(args, "i", &_BT_HCI_MEMB(addr, dev))) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02001544 PyErr_SetString(PyExc_OSError, "getsockaddrarg: "
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001545 "wrong format");
1546 return 0;
1547 }
Gregory P. Smith3e85dfd2010-10-17 00:43:10 +00001548#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001549 *len_ret = sizeof *addr;
1550 return 1;
1551 }
Martin v. Löwis558d9bf2004-06-03 09:24:42 +00001552#if !defined(__FreeBSD__)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001553 case BTPROTO_SCO:
1554 {
1555 struct sockaddr_sco *addr;
1556 char *straddr;
Martin v. Löwis558d9bf2004-06-03 09:24:42 +00001557
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001558 addr = (struct sockaddr_sco *)addr_ret;
1559 _BT_SCO_MEMB(addr, family) = AF_BLUETOOTH;
1560 if (!PyBytes_Check(args)) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02001561 PyErr_SetString(PyExc_OSError, "getsockaddrarg: "
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001562 "wrong format");
1563 return 0;
1564 }
1565 straddr = PyBytes_AS_STRING(args);
1566 if (setbdaddr(straddr, &_BT_SCO_MEMB(addr, bdaddr)) < 0)
1567 return 0;
Martin v. Löwis558d9bf2004-06-03 09:24:42 +00001568
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001569 *len_ret = sizeof *addr;
1570 return 1;
1571 }
Martin v. Löwis558d9bf2004-06-03 09:24:42 +00001572#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001573 default:
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02001574 PyErr_SetString(PyExc_OSError, "getsockaddrarg: unknown Bluetooth protocol");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001575 return 0;
1576 }
1577 }
Martin v. Löwis12af0482004-01-31 12:34:17 +00001578#endif
1579
Antoine Pitroub156a462010-10-27 20:13:57 +00001580#if defined(HAVE_NETPACKET_PACKET_H) && defined(SIOCGIFINDEX)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001581 case AF_PACKET:
1582 {
1583 struct sockaddr_ll* addr;
1584 struct ifreq ifr;
1585 char *interfaceName;
1586 int protoNumber;
1587 int hatype = 0;
1588 int pkttype = 0;
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02001589 Py_buffer haddr = {NULL, NULL};
Guido van Rossum48a680c2001-03-02 06:34:14 +00001590
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001591 if (!PyTuple_Check(args)) {
1592 PyErr_Format(
1593 PyExc_TypeError,
1594 "getsockaddrarg: "
1595 "AF_PACKET address must be tuple, not %.500s",
1596 Py_TYPE(args)->tp_name);
1597 return 0;
1598 }
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02001599 if (!PyArg_ParseTuple(args, "si|iiy*", &interfaceName,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001600 &protoNumber, &pkttype, &hatype,
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02001601 &haddr))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001602 return 0;
1603 strncpy(ifr.ifr_name, interfaceName, sizeof(ifr.ifr_name));
1604 ifr.ifr_name[(sizeof(ifr.ifr_name))-1] = '\0';
1605 if (ioctl(s->sock_fd, SIOCGIFINDEX, &ifr) < 0) {
1606 s->errorhandler();
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02001607 PyBuffer_Release(&haddr);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001608 return 0;
1609 }
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02001610 if (haddr.buf && haddr.len > 8) {
1611 PyErr_SetString(PyExc_ValueError,
1612 "Hardware address must be 8 bytes or less");
1613 PyBuffer_Release(&haddr);
1614 return 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001615 }
1616 if (protoNumber < 0 || protoNumber > 0xffff) {
1617 PyErr_SetString(
1618 PyExc_OverflowError,
1619 "getsockaddrarg: protoNumber must be 0-65535.");
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02001620 PyBuffer_Release(&haddr);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001621 return 0;
1622 }
1623 addr = (struct sockaddr_ll*)addr_ret;
1624 addr->sll_family = AF_PACKET;
1625 addr->sll_protocol = htons((short)protoNumber);
1626 addr->sll_ifindex = ifr.ifr_ifindex;
1627 addr->sll_pkttype = pkttype;
1628 addr->sll_hatype = hatype;
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02001629 if (haddr.buf) {
1630 memcpy(&addr->sll_addr, haddr.buf, haddr.len);
1631 addr->sll_halen = haddr.len;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001632 }
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02001633 else
1634 addr->sll_halen = 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001635 *len_ret = sizeof *addr;
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02001636 PyBuffer_Release(&haddr);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001637 return 1;
1638 }
Guido van Rossum48a680c2001-03-02 06:34:14 +00001639#endif
1640
Christian Heimes043d6f62008-01-07 17:19:16 +00001641#ifdef HAVE_LINUX_TIPC_H
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001642 case AF_TIPC:
1643 {
1644 unsigned int atype, v1, v2, v3;
1645 unsigned int scope = TIPC_CLUSTER_SCOPE;
1646 struct sockaddr_tipc *addr;
Christian Heimes043d6f62008-01-07 17:19:16 +00001647
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001648 if (!PyTuple_Check(args)) {
1649 PyErr_Format(
1650 PyExc_TypeError,
1651 "getsockaddrarg: "
1652 "AF_TIPC address must be tuple, not %.500s",
1653 Py_TYPE(args)->tp_name);
1654 return 0;
1655 }
Christian Heimes043d6f62008-01-07 17:19:16 +00001656
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001657 if (!PyArg_ParseTuple(args,
1658 "IIII|I;Invalid TIPC address format",
1659 &atype, &v1, &v2, &v3, &scope))
1660 return 0;
Christian Heimes043d6f62008-01-07 17:19:16 +00001661
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001662 addr = (struct sockaddr_tipc *) addr_ret;
1663 memset(addr, 0, sizeof(struct sockaddr_tipc));
Christian Heimes043d6f62008-01-07 17:19:16 +00001664
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001665 addr->family = AF_TIPC;
1666 addr->scope = scope;
1667 addr->addrtype = atype;
Christian Heimes043d6f62008-01-07 17:19:16 +00001668
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001669 if (atype == TIPC_ADDR_NAMESEQ) {
1670 addr->addr.nameseq.type = v1;
1671 addr->addr.nameseq.lower = v2;
1672 addr->addr.nameseq.upper = v3;
1673 } else if (atype == TIPC_ADDR_NAME) {
1674 addr->addr.name.name.type = v1;
1675 addr->addr.name.name.instance = v2;
1676 } else if (atype == TIPC_ADDR_ID) {
1677 addr->addr.id.node = v1;
1678 addr->addr.id.ref = v2;
1679 } else {
1680 /* Shouldn't happen */
1681 PyErr_SetString(PyExc_TypeError, "Invalid address type");
1682 return 0;
1683 }
Christian Heimes043d6f62008-01-07 17:19:16 +00001684
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001685 *len_ret = sizeof(*addr);
Christian Heimes043d6f62008-01-07 17:19:16 +00001686
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001687 return 1;
1688 }
Christian Heimes043d6f62008-01-07 17:19:16 +00001689#endif
1690
Vinay Sajiped6783f2014-03-21 11:44:32 +00001691#if defined(AF_CAN) && defined(CAN_RAW) && defined(CAN_BCM)
Charles-François Natali47413c12011-10-06 19:47:44 +02001692 case AF_CAN:
1693 switch (s->sock_proto) {
1694 case CAN_RAW:
Charles-François Natali773e42d2013-02-05 19:42:01 +01001695 /* fall-through */
1696 case CAN_BCM:
Charles-François Natali47413c12011-10-06 19:47:44 +02001697 {
1698 struct sockaddr_can *addr;
1699 PyObject *interfaceName;
1700 struct ifreq ifr;
Charles-François Natali47413c12011-10-06 19:47:44 +02001701 Py_ssize_t len;
1702
Benjamin Peterson18b71912013-05-16 15:29:44 -05001703 addr = (struct sockaddr_can *)addr_ret;
1704
Charles-François Natali47413c12011-10-06 19:47:44 +02001705 if (!PyArg_ParseTuple(args, "O&", PyUnicode_FSConverter,
1706 &interfaceName))
1707 return 0;
1708
1709 len = PyBytes_GET_SIZE(interfaceName);
1710
1711 if (len == 0) {
1712 ifr.ifr_ifindex = 0;
Victor Stinner1a62a682014-08-17 19:33:28 +02001713 } else if ((size_t)len < sizeof(ifr.ifr_name)) {
Christian Heimes15b68852012-09-10 01:25:50 +02001714 strncpy(ifr.ifr_name, PyBytes_AS_STRING(interfaceName), sizeof(ifr.ifr_name));
1715 ifr.ifr_name[(sizeof(ifr.ifr_name))-1] = '\0';
Charles-François Natali47413c12011-10-06 19:47:44 +02001716 if (ioctl(s->sock_fd, SIOCGIFINDEX, &ifr) < 0) {
1717 s->errorhandler();
1718 Py_DECREF(interfaceName);
1719 return 0;
1720 }
1721 } else {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02001722 PyErr_SetString(PyExc_OSError,
Charles-François Natali47413c12011-10-06 19:47:44 +02001723 "AF_CAN interface name too long");
1724 Py_DECREF(interfaceName);
1725 return 0;
1726 }
1727
1728 addr->can_family = AF_CAN;
1729 addr->can_ifindex = ifr.ifr_ifindex;
1730
1731 *len_ret = sizeof(*addr);
1732 Py_DECREF(interfaceName);
1733 return 1;
1734 }
1735 default:
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02001736 PyErr_SetString(PyExc_OSError,
Charles-François Natali47413c12011-10-06 19:47:44 +02001737 "getsockaddrarg: unsupported CAN protocol");
1738 return 0;
1739 }
1740#endif
Victor Stinnera534fc42013-06-03 22:07:27 +02001741
Martin v. Löwis9d6c6692012-02-03 17:44:58 +01001742#ifdef PF_SYSTEM
1743 case PF_SYSTEM:
1744 switch (s->sock_proto) {
1745#ifdef SYSPROTO_CONTROL
1746 case SYSPROTO_CONTROL:
1747 {
1748 struct sockaddr_ctl *addr;
Victor Stinnera534fc42013-06-03 22:07:27 +02001749
Martin v. Löwis9d6c6692012-02-03 17:44:58 +01001750 addr = (struct sockaddr_ctl *)addr_ret;
1751 addr->sc_family = AF_SYSTEM;
Victor Stinnera534fc42013-06-03 22:07:27 +02001752 addr->ss_sysaddr = AF_SYS_CONTROL;
Martin v. Löwis9d6c6692012-02-03 17:44:58 +01001753
1754 if (PyUnicode_Check(args)) {
1755 struct ctl_info info;
1756 PyObject *ctl_name;
1757
1758 if (!PyArg_Parse(args, "O&",
1759 PyUnicode_FSConverter, &ctl_name)) {
1760 return 0;
1761 }
1762
Victor Stinnerf50e1872015-03-20 11:32:24 +01001763 if (PyBytes_GET_SIZE(ctl_name) > (Py_ssize_t)sizeof(info.ctl_name)) {
Martin v. Löwis9d6c6692012-02-03 17:44:58 +01001764 PyErr_SetString(PyExc_ValueError,
1765 "provided string is too long");
1766 Py_DECREF(ctl_name);
1767 return 0;
1768 }
1769 strncpy(info.ctl_name, PyBytes_AS_STRING(ctl_name),
1770 sizeof(info.ctl_name));
1771 Py_DECREF(ctl_name);
1772
1773 if (ioctl(s->sock_fd, CTLIOCGINFO, &info)) {
1774 PyErr_SetString(PyExc_OSError,
1775 "cannot find kernel control with provided name");
1776 return 0;
1777 }
Victor Stinnera534fc42013-06-03 22:07:27 +02001778
Martin v. Löwis9d6c6692012-02-03 17:44:58 +01001779 addr->sc_id = info.ctl_id;
1780 addr->sc_unit = 0;
1781 } else if (!PyArg_ParseTuple(args, "II",
1782 &(addr->sc_id), &(addr->sc_unit))) {
1783 PyErr_SetString(PyExc_TypeError, "getsockaddrarg: "
1784 "expected str or tuple of two ints");
Victor Stinnera534fc42013-06-03 22:07:27 +02001785
Martin v. Löwis9d6c6692012-02-03 17:44:58 +01001786 return 0;
1787 }
Victor Stinnera534fc42013-06-03 22:07:27 +02001788
Martin v. Löwis9d6c6692012-02-03 17:44:58 +01001789 *len_ret = sizeof(*addr);
1790 return 1;
1791 }
1792#endif
1793 default:
1794 PyErr_SetString(PyExc_OSError,
1795 "getsockaddrarg: unsupported PF_SYSTEM protocol");
1796 return 0;
1797 }
1798#endif
Charles-François Natali47413c12011-10-06 19:47:44 +02001799
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001800 /* More cases here... */
Guido van Rossum30a685f1991-06-27 15:51:29 +00001801
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001802 default:
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02001803 PyErr_SetString(PyExc_OSError, "getsockaddrarg: bad family");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001804 return 0;
Guido van Rossum30a685f1991-06-27 15:51:29 +00001805
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001806 }
Guido van Rossum6574b3e1991-06-25 21:36:08 +00001807}
1808
Guido van Rossum30a685f1991-06-27 15:51:29 +00001809
Guido van Rossum48a680c2001-03-02 06:34:14 +00001810/* Get the address length according to the socket object's address family.
Guido van Rossum710e1df1992-06-12 10:39:36 +00001811 Return 1 if the family is known, 0 otherwise. The length is returned
1812 through len_ret. */
1813
1814static int
Peter Schneider-Kamp618e25d2000-07-11 23:00:12 +00001815getsockaddrlen(PySocketSockObject *s, socklen_t *len_ret)
Guido van Rossum710e1df1992-06-12 10:39:36 +00001816{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001817 switch (s->sock_family) {
Guido van Rossum710e1df1992-06-12 10:39:36 +00001818
Andrew MacIntyred12dfbb2004-04-04 07:13:49 +00001819#if defined(AF_UNIX)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001820 case AF_UNIX:
1821 {
1822 *len_ret = sizeof (struct sockaddr_un);
1823 return 1;
1824 }
Guido van Rossumb6775db1994-08-01 11:34:53 +00001825#endif /* AF_UNIX */
Martin v. Löwis11017b12006-01-14 18:12:57 +00001826#if defined(AF_NETLINK)
1827 case AF_NETLINK:
1828 {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001829 *len_ret = sizeof (struct sockaddr_nl);
1830 return 1;
Martin v. Löwis11017b12006-01-14 18:12:57 +00001831 }
1832#endif
Guido van Rossum710e1df1992-06-12 10:39:36 +00001833
Charles-François Natali10b8cf42011-11-10 19:21:37 +01001834#ifdef AF_RDS
1835 case AF_RDS:
1836 /* RDS sockets use sockaddr_in: fall-through */
1837#endif
1838
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001839 case AF_INET:
1840 {
1841 *len_ret = sizeof (struct sockaddr_in);
1842 return 1;
1843 }
Guido van Rossum710e1df1992-06-12 10:39:36 +00001844
Martin v. Löwis44ddbde2001-12-02 10:15:37 +00001845#ifdef ENABLE_IPV6
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001846 case AF_INET6:
1847 {
1848 *len_ret = sizeof (struct sockaddr_in6);
1849 return 1;
1850 }
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00001851#endif
1852
Hye-Shik Chang81268602004-02-02 06:05:24 +00001853#ifdef USE_BLUETOOTH
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001854 case AF_BLUETOOTH:
1855 {
1856 switch(s->sock_proto)
1857 {
Martin v. Löwis558d9bf2004-06-03 09:24:42 +00001858
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001859 case BTPROTO_L2CAP:
1860 *len_ret = sizeof (struct sockaddr_l2);
1861 return 1;
1862 case BTPROTO_RFCOMM:
1863 *len_ret = sizeof (struct sockaddr_rc);
1864 return 1;
1865 case BTPROTO_HCI:
1866 *len_ret = sizeof (struct sockaddr_hci);
1867 return 1;
Hye-Shik Chang81268602004-02-02 06:05:24 +00001868#if !defined(__FreeBSD__)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001869 case BTPROTO_SCO:
1870 *len_ret = sizeof (struct sockaddr_sco);
1871 return 1;
Hye-Shik Chang81268602004-02-02 06:05:24 +00001872#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001873 default:
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02001874 PyErr_SetString(PyExc_OSError, "getsockaddrlen: "
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001875 "unknown BT protocol");
1876 return 0;
Martin v. Löwis558d9bf2004-06-03 09:24:42 +00001877
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001878 }
1879 }
Martin v. Löwis12af0482004-01-31 12:34:17 +00001880#endif
1881
Martin v. Löwis1ba3fd52001-08-10 20:29:40 +00001882#ifdef HAVE_NETPACKET_PACKET_H
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001883 case AF_PACKET:
1884 {
1885 *len_ret = sizeof (struct sockaddr_ll);
1886 return 1;
1887 }
Jeremy Hylton22308652001-02-02 03:23:09 +00001888#endif
Guido van Rossum48a680c2001-03-02 06:34:14 +00001889
Christian Heimes043d6f62008-01-07 17:19:16 +00001890#ifdef HAVE_LINUX_TIPC_H
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001891 case AF_TIPC:
1892 {
1893 *len_ret = sizeof (struct sockaddr_tipc);
1894 return 1;
1895 }
Christian Heimes043d6f62008-01-07 17:19:16 +00001896#endif
1897
Vinay Sajipecfc98c2014-03-20 12:42:42 +00001898#ifdef AF_CAN
Charles-François Natali47413c12011-10-06 19:47:44 +02001899 case AF_CAN:
1900 {
1901 *len_ret = sizeof (struct sockaddr_can);
1902 return 1;
1903 }
1904#endif
Victor Stinnera534fc42013-06-03 22:07:27 +02001905
Martin v. Löwis9d6c6692012-02-03 17:44:58 +01001906#ifdef PF_SYSTEM
1907 case PF_SYSTEM:
1908 switch(s->sock_proto) {
1909#ifdef SYSPROTO_CONTROL
1910 case SYSPROTO_CONTROL:
1911 *len_ret = sizeof (struct sockaddr_ctl);
1912 return 1;
1913#endif
1914 default:
1915 PyErr_SetString(PyExc_OSError, "getsockaddrlen: "
1916 "unknown PF_SYSTEM protocol");
1917 return 0;
1918 }
1919#endif
Charles-François Natali47413c12011-10-06 19:47:44 +02001920
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001921 /* More cases here... */
Guido van Rossum710e1df1992-06-12 10:39:36 +00001922
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001923 default:
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02001924 PyErr_SetString(PyExc_OSError, "getsockaddrlen: bad family");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001925 return 0;
Guido van Rossum710e1df1992-06-12 10:39:36 +00001926
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001927 }
Guido van Rossum710e1df1992-06-12 10:39:36 +00001928}
1929
1930
Nick Coghlan96fe56a2011-08-22 11:55:57 +10001931/* Support functions for the sendmsg() and recvmsg[_into]() methods.
1932 Currently, these methods are only compiled if the RFC 2292/3542
1933 CMSG_LEN() macro is available. Older systems seem to have used
1934 sizeof(struct cmsghdr) + (length) where CMSG_LEN() is used now, so
1935 it may be possible to define CMSG_LEN() that way if it's not
1936 provided. Some architectures might need extra padding after the
1937 cmsghdr, however, and CMSG_LEN() would have to take account of
1938 this. */
1939#ifdef CMSG_LEN
1940/* If length is in range, set *result to CMSG_LEN(length) and return
1941 true; otherwise, return false. */
1942static int
1943get_CMSG_LEN(size_t length, size_t *result)
1944{
1945 size_t tmp;
1946
1947 if (length > (SOCKLEN_T_LIMIT - CMSG_LEN(0)))
1948 return 0;
1949 tmp = CMSG_LEN(length);
1950 if (tmp > SOCKLEN_T_LIMIT || tmp < length)
1951 return 0;
1952 *result = tmp;
1953 return 1;
1954}
1955
1956#ifdef CMSG_SPACE
1957/* If length is in range, set *result to CMSG_SPACE(length) and return
1958 true; otherwise, return false. */
1959static int
1960get_CMSG_SPACE(size_t length, size_t *result)
1961{
1962 size_t tmp;
1963
1964 /* Use CMSG_SPACE(1) here in order to take account of the padding
1965 necessary before *and* after the data. */
1966 if (length > (SOCKLEN_T_LIMIT - CMSG_SPACE(1)))
1967 return 0;
1968 tmp = CMSG_SPACE(length);
1969 if (tmp > SOCKLEN_T_LIMIT || tmp < length)
1970 return 0;
1971 *result = tmp;
1972 return 1;
1973}
1974#endif
1975
1976/* Return true iff msg->msg_controllen is valid, cmsgh is a valid
1977 pointer in msg->msg_control with at least "space" bytes after it,
1978 and its cmsg_len member inside the buffer. */
1979static int
1980cmsg_min_space(struct msghdr *msg, struct cmsghdr *cmsgh, size_t space)
1981{
1982 size_t cmsg_offset;
1983 static const size_t cmsg_len_end = (offsetof(struct cmsghdr, cmsg_len) +
1984 sizeof(cmsgh->cmsg_len));
1985
Charles-François Natali466517d2011-08-28 18:23:43 +02001986 /* Note that POSIX allows msg_controllen to be of signed type. */
Brett Cannonb05cbe62014-01-07 17:01:01 -05001987 if (cmsgh == NULL || msg->msg_control == NULL)
Nick Coghlan96fe56a2011-08-22 11:55:57 +10001988 return 0;
Brett Cannonb05cbe62014-01-07 17:01:01 -05001989 /* Note that POSIX allows msg_controllen to be of a signed type. This is
1990 annoying under OS X as it's unsigned there and so it triggers a
1991 tautological comparison warning under Clang when compared against 0.
1992 Since the check is valid on other platforms, silence the warning under
1993 Clang. */
1994 #ifdef __clang__
1995 #pragma clang diagnostic push
1996 #pragma clang diagnostic ignored "-Wtautological-compare"
1997 #endif
Serhiy Storchakacaa01f82015-03-05 23:42:24 +02001998 #if defined(__GNUC__) && ((__GNUC__ > 4) || ((__GNUC__ == 4) && (__GNUC_MINOR__ > 5)))
Serhiy Storchakab48af342015-02-26 15:27:57 +02001999 #pragma GCC diagnostic push
2000 #pragma GCC diagnostic ignored "-Wtype-limits"
2001 #endif
Brett Cannonb05cbe62014-01-07 17:01:01 -05002002 if (msg->msg_controllen < 0)
2003 return 0;
Serhiy Storchakacaa01f82015-03-05 23:42:24 +02002004 #if defined(__GNUC__) && ((__GNUC__ > 4) || ((__GNUC__ == 4) && (__GNUC_MINOR__ > 5)))
Serhiy Storchakab48af342015-02-26 15:27:57 +02002005 #pragma GCC diagnostic pop
2006 #endif
Brett Cannonb05cbe62014-01-07 17:01:01 -05002007 #ifdef __clang__
2008 #pragma clang diagnostic pop
2009 #endif
Nick Coghlan96fe56a2011-08-22 11:55:57 +10002010 if (space < cmsg_len_end)
2011 space = cmsg_len_end;
2012 cmsg_offset = (char *)cmsgh - (char *)msg->msg_control;
2013 return (cmsg_offset <= (size_t)-1 - space &&
2014 cmsg_offset + space <= msg->msg_controllen);
2015}
2016
2017/* If pointer CMSG_DATA(cmsgh) is in buffer msg->msg_control, set
2018 *space to number of bytes following it in the buffer and return
2019 true; otherwise, return false. Assumes cmsgh, msg->msg_control and
2020 msg->msg_controllen are valid. */
2021static int
2022get_cmsg_data_space(struct msghdr *msg, struct cmsghdr *cmsgh, size_t *space)
2023{
2024 size_t data_offset;
2025 char *data_ptr;
2026
2027 if ((data_ptr = (char *)CMSG_DATA(cmsgh)) == NULL)
2028 return 0;
2029 data_offset = data_ptr - (char *)msg->msg_control;
2030 if (data_offset > msg->msg_controllen)
2031 return 0;
2032 *space = msg->msg_controllen - data_offset;
2033 return 1;
2034}
2035
2036/* If cmsgh is invalid or not contained in the buffer pointed to by
2037 msg->msg_control, return -1. If cmsgh is valid and its associated
2038 data is entirely contained in the buffer, set *data_len to the
2039 length of the associated data and return 0. If only part of the
2040 associated data is contained in the buffer but cmsgh is otherwise
2041 valid, set *data_len to the length contained in the buffer and
2042 return 1. */
2043static int
2044get_cmsg_data_len(struct msghdr *msg, struct cmsghdr *cmsgh, size_t *data_len)
2045{
2046 size_t space, cmsg_data_len;
2047
2048 if (!cmsg_min_space(msg, cmsgh, CMSG_LEN(0)) ||
2049 cmsgh->cmsg_len < CMSG_LEN(0))
2050 return -1;
2051 cmsg_data_len = cmsgh->cmsg_len - CMSG_LEN(0);
2052 if (!get_cmsg_data_space(msg, cmsgh, &space))
2053 return -1;
2054 if (space >= cmsg_data_len) {
2055 *data_len = cmsg_data_len;
2056 return 0;
2057 }
2058 *data_len = space;
2059 return 1;
2060}
2061#endif /* CMSG_LEN */
2062
2063
Guido van Rossum39eb8fa2007-11-16 01:24:05 +00002064/* s._accept() -> (fd, address) */
Guido van Rossum30a685f1991-06-27 15:51:29 +00002065
Guido van Rossum73624e91994-10-10 17:59:00 +00002066static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00002067sock_accept(PySocketSockObject *s)
Guido van Rossum6574b3e1991-06-25 21:36:08 +00002068{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002069 sock_addr_t addrbuf;
2070 SOCKET_T newfd = INVALID_SOCKET;
2071 socklen_t addrlen;
2072 PyObject *sock = NULL;
2073 PyObject *addr = NULL;
2074 PyObject *res = NULL;
2075 int timeout;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00002076 int async_err = 0;
Victor Stinnerdaf45552013-08-28 00:53:59 +02002077#if defined(HAVE_ACCEPT4) && defined(SOCK_CLOEXEC)
2078 /* accept4() is available on Linux 2.6.28+ and glibc 2.10 */
2079 static int accept4_works = -1;
2080#endif
2081
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002082 if (!getsockaddrlen(s, &addrlen))
2083 return NULL;
2084 memset(&addrbuf, 0, addrlen);
Guido van Rossum67f7a382002-06-06 21:08:16 +00002085
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002086 if (!IS_SELECTABLE(s))
2087 return select_error();
Neal Norwitz082b2df2006-02-07 07:04:46 +00002088
Antoine Pitrou3e1fd272010-09-28 21:23:11 +00002089 BEGIN_SELECT_LOOP(s)
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00002090 do {
Victor Stinner391fa712015-03-31 13:15:31 +02002091 timeout = internal_select(s, 0, interval);
Victor Stinnerb7df3142015-03-27 22:59:32 +01002092
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00002093 if (!timeout) {
Victor Stinnerb7df3142015-03-27 22:59:32 +01002094 Py_BEGIN_ALLOW_THREADS
Victor Stinnerdaf45552013-08-28 00:53:59 +02002095#if defined(HAVE_ACCEPT4) && defined(SOCK_CLOEXEC)
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00002096 if (accept4_works != 0) {
2097 newfd = accept4(s->sock_fd, SAS2SA(&addrbuf), &addrlen,
2098 SOCK_CLOEXEC);
2099 if (newfd == INVALID_SOCKET && accept4_works == -1) {
2100 /* On Linux older than 2.6.28, accept4() fails with ENOSYS */
2101 accept4_works = (errno != ENOSYS);
2102 }
Victor Stinnerdaf45552013-08-28 00:53:59 +02002103 }
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00002104 if (accept4_works == 0)
2105 newfd = accept(s->sock_fd, SAS2SA(&addrbuf), &addrlen);
Victor Stinnerdaf45552013-08-28 00:53:59 +02002106#else
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00002107 newfd = accept(s->sock_fd, SAS2SA(&addrbuf), &addrlen);
Victor Stinnerdaf45552013-08-28 00:53:59 +02002108#endif
Victor Stinnerb7df3142015-03-27 22:59:32 +01002109 Py_END_ALLOW_THREADS
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00002110 }
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00002111 } while (newfd < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002112 if (timeout == 1) {
2113 PyErr_SetString(socket_timeout, "timed out");
2114 return NULL;
2115 }
Antoine Pitrou3e1fd272010-09-28 21:23:11 +00002116 END_SELECT_LOOP(s)
Raymond Hettingeref7343c2003-06-29 03:08:05 +00002117
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002118 if (newfd == INVALID_SOCKET)
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00002119 return (!async_err) ? s->errorhandler() : NULL;
Barry Warsaw752300b1997-01-03 17:18:10 +00002120
Victor Stinnerdaf45552013-08-28 00:53:59 +02002121#ifdef MS_WINDOWS
2122 if (!SetHandleInformation((HANDLE)newfd, HANDLE_FLAG_INHERIT, 0)) {
2123 PyErr_SetFromWindowsErr(0);
2124 SOCKETCLOSE(newfd);
2125 goto finally;
2126 }
2127#else
2128
2129#if defined(HAVE_ACCEPT4) && defined(SOCK_CLOEXEC)
2130 if (!accept4_works)
2131#endif
2132 {
2133 if (_Py_set_inheritable(newfd, 0, NULL) < 0) {
2134 SOCKETCLOSE(newfd);
2135 goto finally;
2136 }
2137 }
2138#endif
2139
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002140 sock = PyLong_FromSocket_t(newfd);
2141 if (sock == NULL) {
2142 SOCKETCLOSE(newfd);
2143 goto finally;
2144 }
Guido van Rossum39eb8fa2007-11-16 01:24:05 +00002145
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002146 addr = makesockaddr(s->sock_fd, SAS2SA(&addrbuf),
2147 addrlen, s->sock_proto);
2148 if (addr == NULL)
2149 goto finally;
Barry Warsaw752300b1997-01-03 17:18:10 +00002150
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002151 res = PyTuple_Pack(2, sock, addr);
Barry Warsaw752300b1997-01-03 17:18:10 +00002152
Guido van Rossum67f7a382002-06-06 21:08:16 +00002153finally:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002154 Py_XDECREF(sock);
2155 Py_XDECREF(addr);
2156 return res;
Guido van Rossum6574b3e1991-06-25 21:36:08 +00002157}
2158
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002159PyDoc_STRVAR(accept_doc,
Guido van Rossum39eb8fa2007-11-16 01:24:05 +00002160"_accept() -> (integer, address info)\n\
Guido van Rossum82a5c661998-07-07 20:45:43 +00002161\n\
Guido van Rossum39eb8fa2007-11-16 01:24:05 +00002162Wait for an incoming connection. Return a new socket file descriptor\n\
2163representing the connection, and the address of the client.\n\
2164For IP sockets, the address info is a pair (hostaddr, port).");
Guido van Rossum82a5c661998-07-07 20:45:43 +00002165
Guido van Rossum11ba0942002-06-13 15:07:44 +00002166/* s.setblocking(flag) method. Argument:
2167 False -- non-blocking mode; same as settimeout(0)
2168 True -- blocking mode; same as settimeout(None)
2169*/
Guido van Rossume4485b01994-09-07 14:32:49 +00002170
Guido van Rossum73624e91994-10-10 17:59:00 +00002171static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00002172sock_setblocking(PySocketSockObject *s, PyObject *arg)
Guido van Rossume4485b01994-09-07 14:32:49 +00002173{
Serhiy Storchaka78980432013-01-15 01:12:17 +02002174 long block;
Guido van Rossum67f7a382002-06-06 21:08:16 +00002175
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002176 block = PyLong_AsLong(arg);
2177 if (block == -1 && PyErr_Occurred())
2178 return NULL;
Guido van Rossum67f7a382002-06-06 21:08:16 +00002179
Victor Stinner71694d52015-03-28 01:18:54 +01002180 s->sock_timeout = block ? -1 : 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002181 internal_setblocking(s, block);
Guido van Rossume4485b01994-09-07 14:32:49 +00002182
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002183 Py_INCREF(Py_None);
2184 return Py_None;
Guido van Rossume4485b01994-09-07 14:32:49 +00002185}
Guido van Rossume4485b01994-09-07 14:32:49 +00002186
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002187PyDoc_STRVAR(setblocking_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00002188"setblocking(flag)\n\
2189\n\
2190Set the socket to blocking (flag is true) or non-blocking (false).\n\
Guido van Rossum11ba0942002-06-13 15:07:44 +00002191setblocking(True) is equivalent to settimeout(None);\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002192setblocking(False) is equivalent to settimeout(0.0).");
Guido van Rossum82a5c661998-07-07 20:45:43 +00002193
Victor Stinner71694d52015-03-28 01:18:54 +01002194static int
2195socket_parse_timeout(_PyTime_t *timeout, PyObject *timeout_obj)
2196{
2197#ifdef MS_WINDOWS
2198 struct timeval tv;
2199#endif
Victor Stinner1bb0aef2015-03-31 16:31:19 +02002200#ifndef HAVE_POLL
2201 _PyTime_t ms;
2202#endif
Victor Stinner71694d52015-03-28 01:18:54 +01002203 int overflow = 0;
2204
2205 if (timeout_obj == Py_None) {
2206 *timeout = -1;
2207 return 0;
2208 }
2209
Victor Stinner869e1772015-03-30 03:49:14 +02002210 if (_PyTime_FromSecondsObject(timeout,
2211 timeout_obj, _PyTime_ROUND_CEILING) < 0)
Victor Stinner71694d52015-03-28 01:18:54 +01002212 return -1;
2213
2214 if (*timeout < 0) {
2215 PyErr_SetString(PyExc_ValueError, "Timeout value out of range");
2216 return -1;
2217 }
2218
2219#ifdef MS_WINDOWS
Victor Stinner1bb0aef2015-03-31 16:31:19 +02002220 overflow |= (_PyTime_AsTimeval(*timeout, &tv, _PyTime_ROUND_CEILING) < 0);
Victor Stinner71694d52015-03-28 01:18:54 +01002221#endif
2222#ifndef HAVE_POLL
Victor Stinner1bb0aef2015-03-31 16:31:19 +02002223 ms = _PyTime_AsMilliseconds(*timeout, _PyTime_ROUND_CEILING);
2224 overflow |= (ms > INT_MAX);
Victor Stinner71694d52015-03-28 01:18:54 +01002225#endif
2226 if (overflow) {
2227 PyErr_SetString(PyExc_OverflowError,
2228 "timeout doesn't fit into C timeval");
2229 return -1;
2230 }
2231
2232 return 0;
2233}
2234
Guido van Rossum11ba0942002-06-13 15:07:44 +00002235/* s.settimeout(timeout) method. Argument:
2236 None -- no timeout, blocking mode; same as setblocking(True)
2237 0.0 -- non-blocking mode; same as setblocking(False)
2238 > 0 -- timeout mode; operations time out after timeout seconds
2239 < 0 -- illegal; raises an exception
2240*/
Guido van Rossum67f7a382002-06-06 21:08:16 +00002241static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00002242sock_settimeout(PySocketSockObject *s, PyObject *arg)
Guido van Rossum67f7a382002-06-06 21:08:16 +00002243{
Victor Stinner71694d52015-03-28 01:18:54 +01002244 _PyTime_t timeout;
Guido van Rossum67f7a382002-06-06 21:08:16 +00002245
Victor Stinner71694d52015-03-28 01:18:54 +01002246 if (socket_parse_timeout(&timeout, arg) < 0)
2247 return NULL;
Guido van Rossum67f7a382002-06-06 21:08:16 +00002248
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002249 s->sock_timeout = timeout;
Victor Stinner71694d52015-03-28 01:18:54 +01002250 internal_setblocking(s, timeout < 0);
Guido van Rossum67f7a382002-06-06 21:08:16 +00002251
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002252 Py_INCREF(Py_None);
2253 return Py_None;
Guido van Rossum67f7a382002-06-06 21:08:16 +00002254}
2255
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002256PyDoc_STRVAR(settimeout_doc,
Guido van Rossum3eede5a2002-06-07 02:08:35 +00002257"settimeout(timeout)\n\
Guido van Rossum67f7a382002-06-06 21:08:16 +00002258\n\
Guido van Rossum11ba0942002-06-13 15:07:44 +00002259Set a timeout on socket operations. 'timeout' can be a float,\n\
2260giving in seconds, or None. Setting a timeout of None disables\n\
2261the timeout feature and is equivalent to setblocking(1).\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002262Setting a timeout of zero is the same as setblocking(0).");
Guido van Rossum67f7a382002-06-06 21:08:16 +00002263
Guido van Rossum3eede5a2002-06-07 02:08:35 +00002264/* s.gettimeout() method.
2265 Returns the timeout associated with a socket. */
Guido van Rossum67f7a382002-06-06 21:08:16 +00002266static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00002267sock_gettimeout(PySocketSockObject *s)
Guido van Rossum67f7a382002-06-06 21:08:16 +00002268{
Victor Stinner71694d52015-03-28 01:18:54 +01002269 if (s->sock_timeout < 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002270 Py_INCREF(Py_None);
2271 return Py_None;
2272 }
Victor Stinner71694d52015-03-28 01:18:54 +01002273 else {
2274 double seconds = _PyTime_AsSecondsDouble(s->sock_timeout);
2275 return PyFloat_FromDouble(seconds);
2276 }
Guido van Rossum67f7a382002-06-06 21:08:16 +00002277}
2278
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002279PyDoc_STRVAR(gettimeout_doc,
Guido van Rossum22a97152002-08-08 20:37:08 +00002280"gettimeout() -> timeout\n\
Guido van Rossum67f7a382002-06-06 21:08:16 +00002281\n\
Ezio Melotti388c9452011-08-14 08:28:57 +03002282Returns the timeout in seconds (float) associated with socket \n\
Guido van Rossum67f7a382002-06-06 21:08:16 +00002283operations. A timeout of None indicates that timeouts on socket \n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002284operations are disabled.");
Guido van Rossume4485b01994-09-07 14:32:49 +00002285
Guido van Rossumaee08791992-09-08 09:05:33 +00002286/* s.setsockopt() method.
2287 With an integer third argument, sets an integer option.
2288 With a string third argument, sets an option from a buffer;
2289 use optional built-in module 'struct' to encode the string. */
Guido van Rossum0e69587d1992-06-05 15:11:30 +00002290
Guido van Rossum73624e91994-10-10 17:59:00 +00002291static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00002292sock_setsockopt(PySocketSockObject *s, PyObject *args)
Guido van Rossum0e69587d1992-06-05 15:11:30 +00002293{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002294 int level;
2295 int optname;
2296 int res;
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02002297 Py_buffer optval;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002298 int flag;
Guido van Rossum0e69587d1992-06-05 15:11:30 +00002299
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002300 if (PyArg_ParseTuple(args, "iii:setsockopt",
2301 &level, &optname, &flag)) {
Victor Stinnerb6c15bc2015-03-31 16:35:35 +02002302 res = setsockopt(s->sock_fd, level, optname,
2303 (char*)&flag, sizeof flag);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002304 }
2305 else {
2306 PyErr_Clear();
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02002307 if (!PyArg_ParseTuple(args, "iiy*:setsockopt",
2308 &level, &optname, &optval))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002309 return NULL;
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02002310 res = setsockopt(s->sock_fd, level, optname, optval.buf, optval.len);
2311 PyBuffer_Release(&optval);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002312 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002313 if (res < 0)
2314 return s->errorhandler();
2315 Py_INCREF(Py_None);
2316 return Py_None;
Guido van Rossum0e69587d1992-06-05 15:11:30 +00002317}
2318
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002319PyDoc_STRVAR(setsockopt_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00002320"setsockopt(level, option, value)\n\
2321\n\
2322Set a socket option. See the Unix manual for level and option.\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002323The value argument can either be an integer or a string.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00002324
Guido van Rossum0e69587d1992-06-05 15:11:30 +00002325
Guido van Rossumaee08791992-09-08 09:05:33 +00002326/* s.getsockopt() method.
2327 With two arguments, retrieves an integer option.
2328 With a third integer argument, retrieves a string buffer of that size;
2329 use optional built-in module 'struct' to decode the string. */
Guido van Rossum0e69587d1992-06-05 15:11:30 +00002330
Guido van Rossum73624e91994-10-10 17:59:00 +00002331static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00002332sock_getsockopt(PySocketSockObject *s, PyObject *args)
Guido van Rossum0e69587d1992-06-05 15:11:30 +00002333{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002334 int level;
2335 int optname;
2336 int res;
2337 PyObject *buf;
2338 socklen_t buflen = 0;
Guido van Rossum0e69587d1992-06-05 15:11:30 +00002339
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002340 if (!PyArg_ParseTuple(args, "ii|i:getsockopt",
2341 &level, &optname, &buflen))
2342 return NULL;
Guido van Rossum48a680c2001-03-02 06:34:14 +00002343
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002344 if (buflen == 0) {
2345 int flag = 0;
2346 socklen_t flagsize = sizeof flag;
2347 res = getsockopt(s->sock_fd, level, optname,
2348 (void *)&flag, &flagsize);
2349 if (res < 0)
2350 return s->errorhandler();
2351 return PyLong_FromLong(flag);
2352 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002353 if (buflen <= 0 || buflen > 1024) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02002354 PyErr_SetString(PyExc_OSError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002355 "getsockopt buflen out of range");
2356 return NULL;
2357 }
2358 buf = PyBytes_FromStringAndSize((char *)NULL, buflen);
2359 if (buf == NULL)
2360 return NULL;
2361 res = getsockopt(s->sock_fd, level, optname,
2362 (void *)PyBytes_AS_STRING(buf), &buflen);
2363 if (res < 0) {
2364 Py_DECREF(buf);
2365 return s->errorhandler();
2366 }
2367 _PyBytes_Resize(&buf, buflen);
2368 return buf;
Guido van Rossum0e69587d1992-06-05 15:11:30 +00002369}
2370
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002371PyDoc_STRVAR(getsockopt_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00002372"getsockopt(level, option[, buffersize]) -> value\n\
2373\n\
2374Get a socket option. See the Unix manual for level and option.\n\
2375If a nonzero buffersize argument is given, the return value is a\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002376string of that length; otherwise it is an integer.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00002377
Guido van Rossum0e69587d1992-06-05 15:11:30 +00002378
Fred Drake728819a2000-07-01 03:40:12 +00002379/* s.bind(sockaddr) method */
Guido van Rossum30a685f1991-06-27 15:51:29 +00002380
Guido van Rossum73624e91994-10-10 17:59:00 +00002381static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00002382sock_bind(PySocketSockObject *s, PyObject *addro)
Guido van Rossum6574b3e1991-06-25 21:36:08 +00002383{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002384 sock_addr_t addrbuf;
2385 int addrlen;
2386 int res;
Jeremy Hyltonae0013d2001-10-11 16:36:35 +00002387
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002388 if (!getsockaddrarg(s, addro, SAS2SA(&addrbuf), &addrlen))
2389 return NULL;
2390 Py_BEGIN_ALLOW_THREADS
2391 res = bind(s->sock_fd, SAS2SA(&addrbuf), addrlen);
2392 Py_END_ALLOW_THREADS
2393 if (res < 0)
2394 return s->errorhandler();
2395 Py_INCREF(Py_None);
2396 return Py_None;
Guido van Rossum6574b3e1991-06-25 21:36:08 +00002397}
2398
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002399PyDoc_STRVAR(bind_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00002400"bind(address)\n\
2401\n\
2402Bind the socket to a local address. For IP sockets, the address is a\n\
Jeremy Hylton22308652001-02-02 03:23:09 +00002403pair (host, port); the host must refer to the local host. For raw packet\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002404sockets the address is a tuple (ifname, proto [,pkttype [,hatype]])");
Guido van Rossum82a5c661998-07-07 20:45:43 +00002405
Guido van Rossum30a685f1991-06-27 15:51:29 +00002406
2407/* s.close() method.
2408 Set the file descriptor to -1 so operations tried subsequently
2409 will surely fail. */
2410
Guido van Rossum73624e91994-10-10 17:59:00 +00002411static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00002412sock_close(PySocketSockObject *s)
Guido van Rossum6574b3e1991-06-25 21:36:08 +00002413{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002414 SOCKET_T fd;
Jeremy Hyltonae0013d2001-10-11 16:36:35 +00002415
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00002416 /* We do not want to retry upon EINTR: see http://lwn.net/Articles/576478/
2417 * and http://linux.derkeiler.com/Mailing-Lists/Kernel/2005-09/3000.html
2418 * for more details.
2419 */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002420 if ((fd = s->sock_fd) != -1) {
2421 s->sock_fd = -1;
2422 Py_BEGIN_ALLOW_THREADS
2423 (void) SOCKETCLOSE(fd);
2424 Py_END_ALLOW_THREADS
2425 }
2426 Py_INCREF(Py_None);
2427 return Py_None;
Guido van Rossum6574b3e1991-06-25 21:36:08 +00002428}
2429
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002430PyDoc_STRVAR(close_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00002431"close()\n\
2432\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002433Close the socket. It cannot be used after this call.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00002434
Antoine Pitroue43f9d02010-08-08 23:24:50 +00002435static PyObject *
Antoine Pitrou6e451df2010-08-09 20:39:54 +00002436sock_detach(PySocketSockObject *s)
Antoine Pitroue43f9d02010-08-08 23:24:50 +00002437{
Antoine Pitrou6e451df2010-08-09 20:39:54 +00002438 SOCKET_T fd = s->sock_fd;
Antoine Pitroue43f9d02010-08-08 23:24:50 +00002439 s->sock_fd = -1;
Antoine Pitrou6e451df2010-08-09 20:39:54 +00002440 return PyLong_FromSocket_t(fd);
Antoine Pitroue43f9d02010-08-08 23:24:50 +00002441}
2442
Antoine Pitrou6e451df2010-08-09 20:39:54 +00002443PyDoc_STRVAR(detach_doc,
2444"detach()\n\
Antoine Pitroue43f9d02010-08-08 23:24:50 +00002445\n\
Guido van Rossum638aebd2013-12-04 11:50:09 -08002446Close the socket object without closing the underlying file descriptor.\n\
2447The object cannot be used after this call, but the file descriptor\n\
Antoine Pitrou6e451df2010-08-09 20:39:54 +00002448can be reused for other purposes. The file descriptor is returned.");
Antoine Pitroue43f9d02010-08-08 23:24:50 +00002449
Guido van Rossum7b8bac12002-06-13 16:07:04 +00002450static int
Raymond Hettingeref7343c2003-06-29 03:08:05 +00002451internal_connect(PySocketSockObject *s, struct sockaddr *addr, int addrlen,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002452 int *timeoutp)
Guido van Rossum7b8bac12002-06-13 16:07:04 +00002453{
Victor Stinnerb6c15bc2015-03-31 16:35:35 +02002454#ifdef MS_WINDOWS
2455# define GET_ERROR WSAGetLastError()
2456# define IN_PROGRESS_ERR WSAEWOULDBLOCK
2457# define TIMEOUT_ERR WSAEWOULDBLOCK
2458#else
2459# define GET_ERROR errno
2460# define IN_PROGRESS_ERR EINPROGRESS
2461# define TIMEOUT_ERR EWOULDBLOCK
2462#endif
2463
Victor Stinner70a46f62015-03-31 22:03:59 +02002464 int res, err, wait_connect, timeout;
2465 socklen_t res_size;
Guido van Rossum7b8bac12002-06-13 16:07:04 +00002466
Victor Stinner70a46f62015-03-31 22:03:59 +02002467 *timeoutp = 0;
Victor Stinnerb7df3142015-03-27 22:59:32 +01002468
2469 Py_BEGIN_ALLOW_THREADS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002470 res = connect(s->sock_fd, addr, addrlen);
Victor Stinnerb7df3142015-03-27 22:59:32 +01002471 Py_END_ALLOW_THREADS
2472
Victor Stinner70a46f62015-03-31 22:03:59 +02002473 if (!res) {
2474 /* connect() succeeded, the socket is connected */
2475 return 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002476 }
Guido van Rossum7b8bac12002-06-13 16:07:04 +00002477
Victor Stinner70a46f62015-03-31 22:03:59 +02002478 err = GET_ERROR;
Victor Stinnera7726622015-04-01 11:09:43 +02002479 if (CHECK_ERRNO(EINTR) && PyErr_CheckSignals())
Victor Stinneree699e92015-03-31 21:28:42 +02002480 return -1;
2481
Victor Stinner70a46f62015-03-31 22:03:59 +02002482 wait_connect = (s->sock_timeout > 0 && err == IN_PROGRESS_ERR
2483 && IS_SELECTABLE(s));
2484 if (!wait_connect)
2485 return err;
2486
2487 timeout = internal_connect_select(s);
2488 if (timeout == -1) {
2489 /* select() failed */
2490 err = GET_ERROR;
Victor Stinnera7726622015-04-01 11:09:43 +02002491 if (CHECK_ERRNO(EINTR) && PyErr_CheckSignals())
Victor Stinner70a46f62015-03-31 22:03:59 +02002492 return -1;
2493 return err;
2494 }
2495
2496 if (timeout == 1) {
2497 /* select() timed out */
2498 *timeoutp = 1;
2499 return TIMEOUT_ERR;
2500 }
2501
2502 res_size = sizeof res;
2503 if (getsockopt(s->sock_fd, SOL_SOCKET, SO_ERROR,
2504 (void *)&res, &res_size)) {
2505 /* getsockopt() failed */
2506 return GET_ERROR;
2507 }
2508
2509 if (res == EISCONN)
2510 return 0;
2511 return res;
Victor Stinnerb6c15bc2015-03-31 16:35:35 +02002512
2513#undef GET_ERROR
2514#undef IN_PROGRESS_ERR
2515#undef TIMEOUT_ERR
Guido van Rossum7b8bac12002-06-13 16:07:04 +00002516}
Guido van Rossum30a685f1991-06-27 15:51:29 +00002517
Fred Drake728819a2000-07-01 03:40:12 +00002518/* s.connect(sockaddr) method */
Guido van Rossum30a685f1991-06-27 15:51:29 +00002519
Guido van Rossum73624e91994-10-10 17:59:00 +00002520static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00002521sock_connect(PySocketSockObject *s, PyObject *addro)
Guido van Rossum6574b3e1991-06-25 21:36:08 +00002522{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002523 sock_addr_t addrbuf;
2524 int addrlen;
2525 int res;
2526 int timeout;
Jeremy Hyltonae0013d2001-10-11 16:36:35 +00002527
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002528 if (!getsockaddrarg(s, addro, SAS2SA(&addrbuf), &addrlen))
2529 return NULL;
Guido van Rossum67f7a382002-06-06 21:08:16 +00002530
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002531 res = internal_connect(s, SAS2SA(&addrbuf), addrlen, &timeout);
Victor Stinneree699e92015-03-31 21:28:42 +02002532 if (res < 0)
2533 return NULL;
Guido van Rossum67f7a382002-06-06 21:08:16 +00002534
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002535 if (timeout == 1) {
2536 PyErr_SetString(socket_timeout, "timed out");
2537 return NULL;
2538 }
Victor Stinneree699e92015-03-31 21:28:42 +02002539
Victor Stinner71694d52015-03-28 01:18:54 +01002540 if (res != 0) {
Victor Stinnerdd88d3d2015-03-31 16:08:22 +02002541#ifdef MS_WINDOWS
Victor Stinnerdd88d3d2015-03-31 16:08:22 +02002542 WSASetLastError(res);
2543#else
2544 errno = res;
2545#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002546 return s->errorhandler();
Victor Stinner71694d52015-03-28 01:18:54 +01002547 }
Victor Stinneree699e92015-03-31 21:28:42 +02002548
2549 Py_RETURN_NONE;
Guido van Rossum6574b3e1991-06-25 21:36:08 +00002550}
2551
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002552PyDoc_STRVAR(connect_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00002553"connect(address)\n\
2554\n\
2555Connect the socket to a remote address. For IP sockets, the address\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002556is a pair (host, port).");
Guido van Rossum82a5c661998-07-07 20:45:43 +00002557
Guido van Rossum30a685f1991-06-27 15:51:29 +00002558
Fred Drake728819a2000-07-01 03:40:12 +00002559/* s.connect_ex(sockaddr) method */
Guido van Rossumfc4255d1997-11-19 18:57:13 +00002560
2561static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00002562sock_connect_ex(PySocketSockObject *s, PyObject *addro)
Guido van Rossumfc4255d1997-11-19 18:57:13 +00002563{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002564 sock_addr_t addrbuf;
2565 int addrlen;
2566 int res;
2567 int timeout;
Jeremy Hyltonae0013d2001-10-11 16:36:35 +00002568
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002569 if (!getsockaddrarg(s, addro, SAS2SA(&addrbuf), &addrlen))
2570 return NULL;
Guido van Rossum67f7a382002-06-06 21:08:16 +00002571
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002572 res = internal_connect(s, SAS2SA(&addrbuf), addrlen, &timeout);
Victor Stinner71694d52015-03-28 01:18:54 +01002573 if (res < 0)
2574 return NULL;
2575
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002576 return PyLong_FromLong((long) res);
Guido van Rossumfc4255d1997-11-19 18:57:13 +00002577}
2578
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002579PyDoc_STRVAR(connect_ex_doc,
Guido van Rossum22a97152002-08-08 20:37:08 +00002580"connect_ex(address) -> errno\n\
Guido van Rossum82a5c661998-07-07 20:45:43 +00002581\n\
2582This is like connect(address), but returns an error code (the errno value)\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002583instead of raising an exception when an error occurs.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00002584
Guido van Rossumfc4255d1997-11-19 18:57:13 +00002585
Guido van Rossumed233a51992-06-23 09:07:03 +00002586/* s.fileno() method */
2587
Guido van Rossum73624e91994-10-10 17:59:00 +00002588static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00002589sock_fileno(PySocketSockObject *s)
Guido van Rossumed233a51992-06-23 09:07:03 +00002590{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002591 return PyLong_FromSocket_t(s->sock_fd);
Guido van Rossumed233a51992-06-23 09:07:03 +00002592}
2593
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002594PyDoc_STRVAR(fileno_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00002595"fileno() -> integer\n\
2596\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002597Return the integer file descriptor of the socket.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00002598
Guido van Rossumed233a51992-06-23 09:07:03 +00002599
Guido van Rossumc89705d1992-11-26 08:54:07 +00002600/* s.getsockname() method */
2601
Guido van Rossum73624e91994-10-10 17:59:00 +00002602static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00002603sock_getsockname(PySocketSockObject *s)
Guido van Rossumc89705d1992-11-26 08:54:07 +00002604{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002605 sock_addr_t addrbuf;
2606 int res;
2607 socklen_t addrlen;
Guido van Rossumff3ab422000-04-24 15:16:03 +00002608
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002609 if (!getsockaddrlen(s, &addrlen))
2610 return NULL;
2611 memset(&addrbuf, 0, addrlen);
2612 Py_BEGIN_ALLOW_THREADS
2613 res = getsockname(s->sock_fd, SAS2SA(&addrbuf), &addrlen);
2614 Py_END_ALLOW_THREADS
2615 if (res < 0)
2616 return s->errorhandler();
2617 return makesockaddr(s->sock_fd, SAS2SA(&addrbuf), addrlen,
2618 s->sock_proto);
Guido van Rossumc89705d1992-11-26 08:54:07 +00002619}
2620
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002621PyDoc_STRVAR(getsockname_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00002622"getsockname() -> address info\n\
2623\n\
2624Return the address of the local endpoint. For IP sockets, the address\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002625info is a pair (hostaddr, port).");
Guido van Rossum82a5c661998-07-07 20:45:43 +00002626
Guido van Rossumc89705d1992-11-26 08:54:07 +00002627
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002628#ifdef HAVE_GETPEERNAME /* Cray APP doesn't have this :-( */
Guido van Rossumc89705d1992-11-26 08:54:07 +00002629/* s.getpeername() method */
2630
Guido van Rossum73624e91994-10-10 17:59:00 +00002631static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00002632sock_getpeername(PySocketSockObject *s)
Guido van Rossumc89705d1992-11-26 08:54:07 +00002633{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002634 sock_addr_t addrbuf;
2635 int res;
2636 socklen_t addrlen;
Guido van Rossumff3ab422000-04-24 15:16:03 +00002637
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002638 if (!getsockaddrlen(s, &addrlen))
2639 return NULL;
2640 memset(&addrbuf, 0, addrlen);
2641 Py_BEGIN_ALLOW_THREADS
2642 res = getpeername(s->sock_fd, SAS2SA(&addrbuf), &addrlen);
2643 Py_END_ALLOW_THREADS
2644 if (res < 0)
2645 return s->errorhandler();
2646 return makesockaddr(s->sock_fd, SAS2SA(&addrbuf), addrlen,
2647 s->sock_proto);
Guido van Rossumc89705d1992-11-26 08:54:07 +00002648}
Guido van Rossum82a5c661998-07-07 20:45:43 +00002649
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002650PyDoc_STRVAR(getpeername_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00002651"getpeername() -> address info\n\
2652\n\
2653Return the address of the remote endpoint. For IP sockets, the address\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002654info is a pair (hostaddr, port).");
Guido van Rossum82a5c661998-07-07 20:45:43 +00002655
Guido van Rossumb6775db1994-08-01 11:34:53 +00002656#endif /* HAVE_GETPEERNAME */
Guido van Rossumc89705d1992-11-26 08:54:07 +00002657
2658
Guido van Rossum30a685f1991-06-27 15:51:29 +00002659/* s.listen(n) method */
2660
Guido van Rossum73624e91994-10-10 17:59:00 +00002661static PyObject *
Charles-François Natali644b8f52014-05-22 19:45:39 +01002662sock_listen(PySocketSockObject *s, PyObject *args)
Guido van Rossum6574b3e1991-06-25 21:36:08 +00002663{
Charles-François Natali644b8f52014-05-22 19:45:39 +01002664 /* We try to choose a default backlog high enough to avoid connection drops
2665 * for common workloads, yet not too high to limit resource usage. */
2666 int backlog = Py_MIN(SOMAXCONN, 128);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002667 int res;
Jeremy Hyltonae0013d2001-10-11 16:36:35 +00002668
Charles-François Natali644b8f52014-05-22 19:45:39 +01002669 if (!PyArg_ParseTuple(args, "|i:listen", &backlog))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002670 return NULL;
Charles-François Natali644b8f52014-05-22 19:45:39 +01002671
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002672 Py_BEGIN_ALLOW_THREADS
Antoine Pitrou1be815a2011-05-10 19:16:29 +02002673 /* To avoid problems on systems that don't allow a negative backlog
2674 * (which doesn't make sense anyway) we force a minimum value of 0. */
2675 if (backlog < 0)
2676 backlog = 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002677 res = listen(s->sock_fd, backlog);
2678 Py_END_ALLOW_THREADS
2679 if (res < 0)
2680 return s->errorhandler();
2681 Py_INCREF(Py_None);
2682 return Py_None;
Guido van Rossum6574b3e1991-06-25 21:36:08 +00002683}
2684
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002685PyDoc_STRVAR(listen_doc,
Charles-François Natali644b8f52014-05-22 19:45:39 +01002686"listen([backlog])\n\
Guido van Rossum82a5c661998-07-07 20:45:43 +00002687\n\
Charles-François Natali644b8f52014-05-22 19:45:39 +01002688Enable a server to accept connections. If backlog is specified, it must be\n\
2689at least 0 (if it is lower, it is set to 0); it specifies the number of\n\
Antoine Pitrou1be815a2011-05-10 19:16:29 +02002690unaccepted connections that the system will allow before refusing new\n\
Charles-François Natali644b8f52014-05-22 19:45:39 +01002691connections. If not specified, a default reasonable value is chosen.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00002692
2693
Thomas Wouters477c8d52006-05-27 19:21:47 +00002694/*
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00002695 * This is the guts of the recv() and recv_into() methods, which reads into a
Thomas Wouters902d6eb2007-01-09 23:18:33 +00002696 * char buffer. If you have any inc/dec ref to do to the objects that contain
Thomas Wouters477c8d52006-05-27 19:21:47 +00002697 * the buffer, do it in the caller. This function returns the number of bytes
Ezio Melotti13925002011-03-16 11:05:33 +02002698 * successfully read. If there was an error, it returns -1. Note that it is
Thomas Wouters477c8d52006-05-27 19:21:47 +00002699 * also possible that we return a number of bytes smaller than the request
2700 * bytes.
2701 */
Antoine Pitrou3e1fd272010-09-28 21:23:11 +00002702
Antoine Pitrou19467d22010-08-17 19:33:30 +00002703static Py_ssize_t
2704sock_recv_guts(PySocketSockObject *s, char* cbuf, Py_ssize_t len, int flags)
Thomas Wouters477c8d52006-05-27 19:21:47 +00002705{
Antoine Pitrou19467d22010-08-17 19:33:30 +00002706 Py_ssize_t outlen = -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002707 int timeout;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00002708 int async_err = 0;
Thomas Wouters477c8d52006-05-27 19:21:47 +00002709
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002710 if (!IS_SELECTABLE(s)) {
2711 select_error();
2712 return -1;
2713 }
2714 if (len == 0) {
2715 /* If 0 bytes were requested, do nothing. */
2716 return 0;
2717 }
Thomas Wouters477c8d52006-05-27 19:21:47 +00002718
Antoine Pitrou3e1fd272010-09-28 21:23:11 +00002719 BEGIN_SELECT_LOOP(s)
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00002720 do {
Victor Stinner391fa712015-03-31 13:15:31 +02002721 timeout = internal_select(s, 0, interval);
Victor Stinnerb7df3142015-03-27 22:59:32 +01002722
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00002723 if (!timeout) {
Victor Stinnerb7df3142015-03-27 22:59:32 +01002724 Py_BEGIN_ALLOW_THREADS
Victor Stinner14b9b112013-06-25 00:37:25 +02002725#ifdef MS_WINDOWS
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00002726 if (len > INT_MAX)
2727 len = INT_MAX;
2728 outlen = recv(s->sock_fd, cbuf, (int)len, flags);
Victor Stinner9a644b22013-06-24 23:47:41 +02002729#else
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00002730 outlen = recv(s->sock_fd, cbuf, len, flags);
Victor Stinner9a644b22013-06-24 23:47:41 +02002731#endif
Victor Stinnerb7df3142015-03-27 22:59:32 +01002732 Py_END_ALLOW_THREADS
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00002733 }
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00002734 } while (outlen < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
Thomas Wouters477c8d52006-05-27 19:21:47 +00002735
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002736 if (timeout == 1) {
2737 PyErr_SetString(socket_timeout, "timed out");
2738 return -1;
2739 }
Antoine Pitrou3e1fd272010-09-28 21:23:11 +00002740 END_SELECT_LOOP(s)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002741 if (outlen < 0) {
2742 /* Note: the call to errorhandler() ALWAYS indirectly returned
2743 NULL, so ignore its return value */
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00002744 if (!async_err)
2745 s->errorhandler();
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002746 return -1;
2747 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002748 return outlen;
Thomas Wouters477c8d52006-05-27 19:21:47 +00002749}
2750
Guido van Rossum48a680c2001-03-02 06:34:14 +00002751
Guido van Rossumeb6b33a1993-05-25 09:38:27 +00002752/* s.recv(nbytes [,flags]) method */
Guido van Rossum30a685f1991-06-27 15:51:29 +00002753
Guido van Rossum73624e91994-10-10 17:59:00 +00002754static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00002755sock_recv(PySocketSockObject *s, PyObject *args)
Guido van Rossum30a685f1991-06-27 15:51:29 +00002756{
Antoine Pitrou19467d22010-08-17 19:33:30 +00002757 Py_ssize_t recvlen, outlen;
2758 int flags = 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002759 PyObject *buf;
Guido van Rossum67f7a382002-06-06 21:08:16 +00002760
Antoine Pitrou19467d22010-08-17 19:33:30 +00002761 if (!PyArg_ParseTuple(args, "n|i:recv", &recvlen, &flags))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002762 return NULL;
Guido van Rossum67f7a382002-06-06 21:08:16 +00002763
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002764 if (recvlen < 0) {
2765 PyErr_SetString(PyExc_ValueError,
2766 "negative buffersize in recv");
2767 return NULL;
2768 }
Guido van Rossum67f7a382002-06-06 21:08:16 +00002769
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002770 /* Allocate a new string. */
2771 buf = PyBytes_FromStringAndSize((char *) 0, recvlen);
2772 if (buf == NULL)
2773 return NULL;
Guido van Rossum67f7a382002-06-06 21:08:16 +00002774
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002775 /* Call the guts */
2776 outlen = sock_recv_guts(s, PyBytes_AS_STRING(buf), recvlen, flags);
2777 if (outlen < 0) {
2778 /* An error occurred, release the string and return an
2779 error. */
2780 Py_DECREF(buf);
2781 return NULL;
2782 }
2783 if (outlen != recvlen) {
2784 /* We did not read as many bytes as we anticipated, resize the
2785 string if possible and be successful. */
2786 _PyBytes_Resize(&buf, outlen);
2787 }
Martin v. Löwis79acb9e2002-12-06 12:48:53 +00002788
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002789 return buf;
Guido van Rossum6574b3e1991-06-25 21:36:08 +00002790}
2791
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002792PyDoc_STRVAR(recv_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00002793"recv(buffersize[, flags]) -> data\n\
2794\n\
2795Receive up to buffersize bytes from the socket. For the optional flags\n\
2796argument, see the Unix manual. When no data is available, block until\n\
2797at least one byte is available or until the remote end is closed. When\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002798the remote end is closed and all data is read, return the empty string.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00002799
Guido van Rossum30a685f1991-06-27 15:51:29 +00002800
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00002801/* s.recv_into(buffer, [nbytes [,flags]]) method */
Guido van Rossum30a685f1991-06-27 15:51:29 +00002802
Thomas Wouters477c8d52006-05-27 19:21:47 +00002803static PyObject*
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00002804sock_recv_into(PySocketSockObject *s, PyObject *args, PyObject *kwds)
Thomas Wouters477c8d52006-05-27 19:21:47 +00002805{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002806 static char *kwlist[] = {"buffer", "nbytes", "flags", 0};
Thomas Wouters477c8d52006-05-27 19:21:47 +00002807
Antoine Pitrou19467d22010-08-17 19:33:30 +00002808 int flags = 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002809 Py_buffer pbuf;
2810 char *buf;
Antoine Pitrou19467d22010-08-17 19:33:30 +00002811 Py_ssize_t buflen, readlen, recvlen = 0;
Thomas Wouters477c8d52006-05-27 19:21:47 +00002812
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002813 /* Get the buffer's memory */
Antoine Pitrou19467d22010-08-17 19:33:30 +00002814 if (!PyArg_ParseTupleAndKeywords(args, kwds, "w*|ni:recv_into", kwlist,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002815 &pbuf, &recvlen, &flags))
2816 return NULL;
2817 buf = pbuf.buf;
2818 buflen = pbuf.len;
Thomas Wouters477c8d52006-05-27 19:21:47 +00002819
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002820 if (recvlen < 0) {
2821 PyBuffer_Release(&pbuf);
2822 PyErr_SetString(PyExc_ValueError,
2823 "negative buffersize in recv_into");
2824 return NULL;
2825 }
2826 if (recvlen == 0) {
2827 /* If nbytes was not specified, use the buffer's length */
2828 recvlen = buflen;
2829 }
Thomas Wouters477c8d52006-05-27 19:21:47 +00002830
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002831 /* Check if the buffer is large enough */
2832 if (buflen < recvlen) {
2833 PyBuffer_Release(&pbuf);
2834 PyErr_SetString(PyExc_ValueError,
2835 "buffer too small for requested bytes");
2836 return NULL;
2837 }
Thomas Wouters477c8d52006-05-27 19:21:47 +00002838
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002839 /* Call the guts */
2840 readlen = sock_recv_guts(s, buf, recvlen, flags);
2841 if (readlen < 0) {
2842 /* Return an error. */
2843 PyBuffer_Release(&pbuf);
2844 return NULL;
2845 }
Thomas Wouters477c8d52006-05-27 19:21:47 +00002846
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002847 PyBuffer_Release(&pbuf);
2848 /* Return the number of bytes read. Note that we do not do anything
2849 special here in the case that readlen < recvlen. */
2850 return PyLong_FromSsize_t(readlen);
Thomas Wouters477c8d52006-05-27 19:21:47 +00002851}
2852
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00002853PyDoc_STRVAR(recv_into_doc,
2854"recv_into(buffer, [nbytes[, flags]]) -> nbytes_read\n\
Thomas Wouters477c8d52006-05-27 19:21:47 +00002855\n\
2856A version of recv() that stores its data into a buffer rather than creating \n\
2857a new string. Receive up to buffersize bytes from the socket. If buffersize \n\
2858is not specified (or 0), receive up to the size available in the given buffer.\n\
2859\n\
2860See recv() for documentation about the flags.");
2861
2862
2863/*
Christian Heimes99170a52007-12-19 02:07:34 +00002864 * This is the guts of the recvfrom() and recvfrom_into() methods, which reads
2865 * into a char buffer. If you have any inc/def ref to do to the objects that
2866 * contain the buffer, do it in the caller. This function returns the number
Ezio Melotti13925002011-03-16 11:05:33 +02002867 * of bytes successfully read. If there was an error, it returns -1. Note
Christian Heimes99170a52007-12-19 02:07:34 +00002868 * that it is also possible that we return a number of bytes smaller than the
2869 * request bytes.
Thomas Wouters477c8d52006-05-27 19:21:47 +00002870 *
2871 * 'addr' is a return value for the address object. Note that you must decref
2872 * it yourself.
2873 */
Antoine Pitrou19467d22010-08-17 19:33:30 +00002874static Py_ssize_t
2875sock_recvfrom_guts(PySocketSockObject *s, char* cbuf, Py_ssize_t len, int flags,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002876 PyObject** addr)
Guido van Rossum6574b3e1991-06-25 21:36:08 +00002877{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002878 sock_addr_t addrbuf;
2879 int timeout;
Antoine Pitrou19467d22010-08-17 19:33:30 +00002880 Py_ssize_t n = -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002881 socklen_t addrlen;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00002882 int async_err = 0;
Guido van Rossum67f7a382002-06-06 21:08:16 +00002883
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002884 *addr = NULL;
Guido van Rossum67f7a382002-06-06 21:08:16 +00002885
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002886 if (!getsockaddrlen(s, &addrlen))
2887 return -1;
Guido van Rossum67f7a382002-06-06 21:08:16 +00002888
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002889 if (!IS_SELECTABLE(s)) {
2890 select_error();
2891 return -1;
2892 }
Neal Norwitz082b2df2006-02-07 07:04:46 +00002893
Antoine Pitrou3e1fd272010-09-28 21:23:11 +00002894 BEGIN_SELECT_LOOP(s)
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00002895 do {
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00002896 memset(&addrbuf, 0, addrlen);
Victor Stinner391fa712015-03-31 13:15:31 +02002897 timeout = internal_select(s, 0, interval);
Victor Stinnerb7df3142015-03-27 22:59:32 +01002898
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00002899 if (!timeout) {
Victor Stinnerb7df3142015-03-27 22:59:32 +01002900 Py_BEGIN_ALLOW_THREADS
Victor Stinnere990c6e2013-11-16 00:18:58 +01002901#ifdef MS_WINDOWS
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00002902 if (len > INT_MAX)
2903 len = INT_MAX;
2904 n = recvfrom(s->sock_fd, cbuf, (int)len, flags,
2905 (void *) &addrbuf, &addrlen);
Guido van Rossum6a3eb5f1994-08-18 15:42:46 +00002906#else
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00002907 n = recvfrom(s->sock_fd, cbuf, len, flags,
2908 SAS2SA(&addrbuf), &addrlen);
Guido van Rossum6a3eb5f1994-08-18 15:42:46 +00002909#endif
Victor Stinnerb7df3142015-03-27 22:59:32 +01002910 Py_END_ALLOW_THREADS
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00002911 }
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00002912 } while (n < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
Guido van Rossum67f7a382002-06-06 21:08:16 +00002913
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002914 if (timeout == 1) {
2915 PyErr_SetString(socket_timeout, "timed out");
2916 return -1;
2917 }
Antoine Pitrou3e1fd272010-09-28 21:23:11 +00002918 END_SELECT_LOOP(s)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002919 if (n < 0) {
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00002920 if (!async_err)
2921 s->errorhandler();
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002922 return -1;
2923 }
Guido van Rossum67f7a382002-06-06 21:08:16 +00002924
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002925 if (!(*addr = makesockaddr(s->sock_fd, SAS2SA(&addrbuf),
2926 addrlen, s->sock_proto)))
2927 return -1;
Thomas Wouters477c8d52006-05-27 19:21:47 +00002928
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002929 return n;
Thomas Wouters477c8d52006-05-27 19:21:47 +00002930}
2931
2932/* s.recvfrom(nbytes [,flags]) method */
2933
2934static PyObject *
2935sock_recvfrom(PySocketSockObject *s, PyObject *args)
2936{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002937 PyObject *buf = NULL;
2938 PyObject *addr = NULL;
2939 PyObject *ret = NULL;
Antoine Pitrou19467d22010-08-17 19:33:30 +00002940 int flags = 0;
2941 Py_ssize_t recvlen, outlen;
Thomas Wouters477c8d52006-05-27 19:21:47 +00002942
Antoine Pitrou19467d22010-08-17 19:33:30 +00002943 if (!PyArg_ParseTuple(args, "n|i:recvfrom", &recvlen, &flags))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002944 return NULL;
Guido van Rossum48a680c2001-03-02 06:34:14 +00002945
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002946 if (recvlen < 0) {
2947 PyErr_SetString(PyExc_ValueError,
2948 "negative buffersize in recvfrom");
2949 return NULL;
2950 }
Guido van Rossumd8faa362007-04-27 19:54:29 +00002951
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002952 buf = PyBytes_FromStringAndSize((char *) 0, recvlen);
2953 if (buf == NULL)
2954 return NULL;
Thomas Wouters477c8d52006-05-27 19:21:47 +00002955
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002956 outlen = sock_recvfrom_guts(s, PyBytes_AS_STRING(buf),
2957 recvlen, flags, &addr);
2958 if (outlen < 0) {
2959 goto finally;
2960 }
Thomas Wouters477c8d52006-05-27 19:21:47 +00002961
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002962 if (outlen != recvlen) {
2963 /* We did not read as many bytes as we anticipated, resize the
Ezio Melotti13925002011-03-16 11:05:33 +02002964 string if possible and be successful. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002965 if (_PyBytes_Resize(&buf, outlen) < 0)
Ezio Melotti13925002011-03-16 11:05:33 +02002966 /* Oopsy, not so successful after all. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002967 goto finally;
2968 }
Barry Warsaw752300b1997-01-03 17:18:10 +00002969
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002970 ret = PyTuple_Pack(2, buf, addr);
Guido van Rossum67f7a382002-06-06 21:08:16 +00002971
2972finally:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002973 Py_XDECREF(buf);
2974 Py_XDECREF(addr);
2975 return ret;
Guido van Rossum6574b3e1991-06-25 21:36:08 +00002976}
2977
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002978PyDoc_STRVAR(recvfrom_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00002979"recvfrom(buffersize[, flags]) -> (data, address info)\n\
2980\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002981Like recv(buffersize, flags) but also return the sender's address info.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00002982
Thomas Wouters477c8d52006-05-27 19:21:47 +00002983
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00002984/* s.recvfrom_into(buffer[, nbytes [,flags]]) method */
Thomas Wouters477c8d52006-05-27 19:21:47 +00002985
2986static PyObject *
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00002987sock_recvfrom_into(PySocketSockObject *s, PyObject *args, PyObject* kwds)
Thomas Wouters477c8d52006-05-27 19:21:47 +00002988{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002989 static char *kwlist[] = {"buffer", "nbytes", "flags", 0};
Thomas Wouters477c8d52006-05-27 19:21:47 +00002990
Antoine Pitrou19467d22010-08-17 19:33:30 +00002991 int flags = 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002992 Py_buffer pbuf;
2993 char *buf;
Antoine Pitrou19467d22010-08-17 19:33:30 +00002994 Py_ssize_t readlen, buflen, recvlen = 0;
Thomas Wouters477c8d52006-05-27 19:21:47 +00002995
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002996 PyObject *addr = NULL;
Thomas Wouters477c8d52006-05-27 19:21:47 +00002997
Antoine Pitrou19467d22010-08-17 19:33:30 +00002998 if (!PyArg_ParseTupleAndKeywords(args, kwds, "w*|ni:recvfrom_into",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002999 kwlist, &pbuf,
3000 &recvlen, &flags))
3001 return NULL;
3002 buf = pbuf.buf;
3003 buflen = pbuf.len;
Thomas Wouters477c8d52006-05-27 19:21:47 +00003004
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003005 if (recvlen < 0) {
3006 PyBuffer_Release(&pbuf);
3007 PyErr_SetString(PyExc_ValueError,
3008 "negative buffersize in recvfrom_into");
3009 return NULL;
3010 }
3011 if (recvlen == 0) {
3012 /* If nbytes was not specified, use the buffer's length */
3013 recvlen = buflen;
Benjamin Petersonc6b37e22014-01-13 23:14:42 -05003014 } else if (recvlen > buflen) {
3015 PyBuffer_Release(&pbuf);
3016 PyErr_SetString(PyExc_ValueError,
3017 "nbytes is greater than the length of the buffer");
3018 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003019 }
Thomas Wouters477c8d52006-05-27 19:21:47 +00003020
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003021 readlen = sock_recvfrom_guts(s, buf, recvlen, flags, &addr);
3022 if (readlen < 0) {
3023 PyBuffer_Release(&pbuf);
3024 /* Return an error */
3025 Py_XDECREF(addr);
3026 return NULL;
3027 }
Thomas Wouters477c8d52006-05-27 19:21:47 +00003028
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003029 PyBuffer_Release(&pbuf);
3030 /* Return the number of bytes read and the address. Note that we do
3031 not do anything special here in the case that readlen < recvlen. */
Antoine Pitrou19467d22010-08-17 19:33:30 +00003032 return Py_BuildValue("nN", readlen, addr);
Thomas Wouters477c8d52006-05-27 19:21:47 +00003033}
3034
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00003035PyDoc_STRVAR(recvfrom_into_doc,
3036"recvfrom_into(buffer[, nbytes[, flags]]) -> (nbytes, address info)\n\
Thomas Wouters477c8d52006-05-27 19:21:47 +00003037\n\
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00003038Like recv_into(buffer[, nbytes[, flags]]) but also return the sender's address info.");
Thomas Wouters477c8d52006-05-27 19:21:47 +00003039
3040
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003041/* The sendmsg() and recvmsg[_into]() methods require a working
3042 CMSG_LEN(). See the comment near get_CMSG_LEN(). */
3043#ifdef CMSG_LEN
3044/*
3045 * Call recvmsg() with the supplied iovec structures, flags, and
3046 * ancillary data buffer size (controllen). Returns the tuple return
3047 * value for recvmsg() or recvmsg_into(), with the first item provided
3048 * by the supplied makeval() function. makeval() will be called with
3049 * the length read and makeval_data as arguments, and must return a
3050 * new reference (which will be decrefed if there is a subsequent
3051 * error). On error, closes any file descriptors received via
3052 * SCM_RIGHTS.
3053 */
3054static PyObject *
3055sock_recvmsg_guts(PySocketSockObject *s, struct iovec *iov, int iovlen,
3056 int flags, Py_ssize_t controllen,
3057 PyObject *(*makeval)(ssize_t, void *), void *makeval_data)
3058{
3059 ssize_t bytes_received = -1;
3060 int timeout;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003061 int async_err = 0;
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003062 sock_addr_t addrbuf;
3063 socklen_t addrbuflen;
Charles-François Natalie9e95ae2011-08-24 21:40:53 +02003064 struct msghdr msg = {0};
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003065 PyObject *cmsg_list = NULL, *retval = NULL;
3066 void *controlbuf = NULL;
3067 struct cmsghdr *cmsgh;
3068 size_t cmsgdatalen = 0;
3069 int cmsg_status;
3070
3071 /* XXX: POSIX says that msg_name and msg_namelen "shall be
3072 ignored" when the socket is connected (Linux fills them in
3073 anyway for AF_UNIX sockets at least). Normally msg_namelen
3074 seems to be set to 0 if there's no address, but try to
3075 initialize msg_name to something that won't be mistaken for a
3076 real address if that doesn't happen. */
3077 if (!getsockaddrlen(s, &addrbuflen))
3078 return NULL;
3079 memset(&addrbuf, 0, addrbuflen);
3080 SAS2SA(&addrbuf)->sa_family = AF_UNSPEC;
3081
3082 if (controllen < 0 || controllen > SOCKLEN_T_LIMIT) {
3083 PyErr_SetString(PyExc_ValueError,
3084 "invalid ancillary data buffer length");
3085 return NULL;
3086 }
3087 if (controllen > 0 && (controlbuf = PyMem_Malloc(controllen)) == NULL)
3088 return PyErr_NoMemory();
3089
3090 /* Make the system call. */
3091 if (!IS_SELECTABLE(s)) {
3092 select_error();
3093 goto finally;
3094 }
3095
3096 BEGIN_SELECT_LOOP(s)
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003097 do {
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003098 msg.msg_name = SAS2SA(&addrbuf);
3099 msg.msg_namelen = addrbuflen;
3100 msg.msg_iov = iov;
3101 msg.msg_iovlen = iovlen;
3102 msg.msg_control = controlbuf;
3103 msg.msg_controllen = controllen;
Victor Stinner391fa712015-03-31 13:15:31 +02003104 timeout = internal_select(s, 0, interval);
Victor Stinnerb7df3142015-03-27 22:59:32 +01003105
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003106 if (timeout == 1) {
3107 PyErr_SetString(socket_timeout, "timed out");
3108 goto finally;
3109 }
Victor Stinnerb7df3142015-03-27 22:59:32 +01003110
3111 if (!timeout) {
3112 Py_BEGIN_ALLOW_THREADS;
3113 bytes_received = recvmsg(s->sock_fd, &msg, flags);
3114 Py_END_ALLOW_THREADS;
3115 }
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003116 } while (bytes_received < 0 && errno == EINTR &&
3117 !(async_err = PyErr_CheckSignals()));
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003118 END_SELECT_LOOP(s)
3119
3120 if (bytes_received < 0) {
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003121 if (!async_err)
3122 s->errorhandler();
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003123 goto finally;
3124 }
3125
3126 /* Make list of (level, type, data) tuples from control messages. */
3127 if ((cmsg_list = PyList_New(0)) == NULL)
3128 goto err_closefds;
3129 /* Check for empty ancillary data as old CMSG_FIRSTHDR()
3130 implementations didn't do so. */
3131 for (cmsgh = ((msg.msg_controllen > 0) ? CMSG_FIRSTHDR(&msg) : NULL);
3132 cmsgh != NULL; cmsgh = CMSG_NXTHDR(&msg, cmsgh)) {
3133 PyObject *bytes, *tuple;
3134 int tmp;
3135
3136 cmsg_status = get_cmsg_data_len(&msg, cmsgh, &cmsgdatalen);
3137 if (cmsg_status != 0) {
3138 if (PyErr_WarnEx(PyExc_RuntimeWarning,
3139 "received malformed or improperly-truncated "
3140 "ancillary data", 1) == -1)
3141 goto err_closefds;
3142 }
3143 if (cmsg_status < 0)
3144 break;
3145 if (cmsgdatalen > PY_SSIZE_T_MAX) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02003146 PyErr_SetString(PyExc_OSError, "control message too long");
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003147 goto err_closefds;
3148 }
3149
3150 bytes = PyBytes_FromStringAndSize((char *)CMSG_DATA(cmsgh),
3151 cmsgdatalen);
3152 tuple = Py_BuildValue("iiN", (int)cmsgh->cmsg_level,
3153 (int)cmsgh->cmsg_type, bytes);
3154 if (tuple == NULL)
3155 goto err_closefds;
3156 tmp = PyList_Append(cmsg_list, tuple);
3157 Py_DECREF(tuple);
3158 if (tmp != 0)
3159 goto err_closefds;
3160
3161 if (cmsg_status != 0)
3162 break;
3163 }
3164
3165 retval = Py_BuildValue("NOiN",
3166 (*makeval)(bytes_received, makeval_data),
3167 cmsg_list,
3168 (int)msg.msg_flags,
3169 makesockaddr(s->sock_fd, SAS2SA(&addrbuf),
3170 ((msg.msg_namelen > addrbuflen) ?
3171 addrbuflen : msg.msg_namelen),
3172 s->sock_proto));
3173 if (retval == NULL)
3174 goto err_closefds;
3175
3176finally:
3177 Py_XDECREF(cmsg_list);
3178 PyMem_Free(controlbuf);
3179 return retval;
3180
3181err_closefds:
3182#ifdef SCM_RIGHTS
3183 /* Close all descriptors coming from SCM_RIGHTS, so they don't leak. */
3184 for (cmsgh = ((msg.msg_controllen > 0) ? CMSG_FIRSTHDR(&msg) : NULL);
3185 cmsgh != NULL; cmsgh = CMSG_NXTHDR(&msg, cmsgh)) {
3186 cmsg_status = get_cmsg_data_len(&msg, cmsgh, &cmsgdatalen);
3187 if (cmsg_status < 0)
3188 break;
3189 if (cmsgh->cmsg_level == SOL_SOCKET &&
3190 cmsgh->cmsg_type == SCM_RIGHTS) {
3191 size_t numfds;
3192 int *fdp;
3193
3194 numfds = cmsgdatalen / sizeof(int);
3195 fdp = (int *)CMSG_DATA(cmsgh);
3196 while (numfds-- > 0)
3197 close(*fdp++);
3198 }
3199 if (cmsg_status != 0)
3200 break;
3201 }
3202#endif /* SCM_RIGHTS */
3203 goto finally;
3204}
3205
3206
3207static PyObject *
3208makeval_recvmsg(ssize_t received, void *data)
3209{
3210 PyObject **buf = data;
3211
3212 if (received < PyBytes_GET_SIZE(*buf))
3213 _PyBytes_Resize(buf, received);
3214 Py_XINCREF(*buf);
3215 return *buf;
3216}
3217
3218/* s.recvmsg(bufsize[, ancbufsize[, flags]]) method */
3219
3220static PyObject *
3221sock_recvmsg(PySocketSockObject *s, PyObject *args)
3222{
3223 Py_ssize_t bufsize, ancbufsize = 0;
3224 int flags = 0;
3225 struct iovec iov;
3226 PyObject *buf = NULL, *retval = NULL;
3227
3228 if (!PyArg_ParseTuple(args, "n|ni:recvmsg", &bufsize, &ancbufsize, &flags))
3229 return NULL;
3230
3231 if (bufsize < 0) {
3232 PyErr_SetString(PyExc_ValueError, "negative buffer size in recvmsg()");
3233 return NULL;
3234 }
3235 if ((buf = PyBytes_FromStringAndSize(NULL, bufsize)) == NULL)
3236 return NULL;
3237 iov.iov_base = PyBytes_AS_STRING(buf);
3238 iov.iov_len = bufsize;
3239
3240 /* Note that we're passing a pointer to *our pointer* to the bytes
3241 object here (&buf); makeval_recvmsg() may incref the object, or
3242 deallocate it and set our pointer to NULL. */
3243 retval = sock_recvmsg_guts(s, &iov, 1, flags, ancbufsize,
3244 &makeval_recvmsg, &buf);
3245 Py_XDECREF(buf);
3246 return retval;
3247}
3248
3249PyDoc_STRVAR(recvmsg_doc,
3250"recvmsg(bufsize[, ancbufsize[, flags]]) -> (data, ancdata, msg_flags, address)\n\
3251\n\
3252Receive normal data (up to bufsize bytes) and ancillary data from the\n\
3253socket. The ancbufsize argument sets the size in bytes of the\n\
3254internal buffer used to receive the ancillary data; it defaults to 0,\n\
3255meaning that no ancillary data will be received. Appropriate buffer\n\
3256sizes for ancillary data can be calculated using CMSG_SPACE() or\n\
3257CMSG_LEN(), and items which do not fit into the buffer might be\n\
3258truncated or discarded. The flags argument defaults to 0 and has the\n\
3259same meaning as for recv().\n\
3260\n\
3261The return value is a 4-tuple: (data, ancdata, msg_flags, address).\n\
3262The data item is a bytes object holding the non-ancillary data\n\
3263received. The ancdata item is a list of zero or more tuples\n\
3264(cmsg_level, cmsg_type, cmsg_data) representing the ancillary data\n\
3265(control messages) received: cmsg_level and cmsg_type are integers\n\
3266specifying the protocol level and protocol-specific type respectively,\n\
3267and cmsg_data is a bytes object holding the associated data. The\n\
3268msg_flags item is the bitwise OR of various flags indicating\n\
3269conditions on the received message; see your system documentation for\n\
3270details. If the receiving socket is unconnected, address is the\n\
3271address of the sending socket, if available; otherwise, its value is\n\
3272unspecified.\n\
3273\n\
3274If recvmsg() raises an exception after the system call returns, it\n\
3275will first attempt to close any file descriptors received via the\n\
3276SCM_RIGHTS mechanism.");
3277
3278
3279static PyObject *
3280makeval_recvmsg_into(ssize_t received, void *data)
3281{
3282 return PyLong_FromSsize_t(received);
3283}
3284
3285/* s.recvmsg_into(buffers[, ancbufsize[, flags]]) method */
3286
3287static PyObject *
3288sock_recvmsg_into(PySocketSockObject *s, PyObject *args)
3289{
3290 Py_ssize_t ancbufsize = 0;
3291 int flags = 0;
3292 struct iovec *iovs = NULL;
3293 Py_ssize_t i, nitems, nbufs = 0;
3294 Py_buffer *bufs = NULL;
3295 PyObject *buffers_arg, *fast, *retval = NULL;
3296
3297 if (!PyArg_ParseTuple(args, "O|ni:recvmsg_into",
3298 &buffers_arg, &ancbufsize, &flags))
3299 return NULL;
3300
3301 if ((fast = PySequence_Fast(buffers_arg,
3302 "recvmsg_into() argument 1 must be an "
3303 "iterable")) == NULL)
3304 return NULL;
3305 nitems = PySequence_Fast_GET_SIZE(fast);
3306 if (nitems > INT_MAX) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02003307 PyErr_SetString(PyExc_OSError, "recvmsg_into() argument 1 is too long");
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003308 goto finally;
3309 }
3310
3311 /* Fill in an iovec for each item, and save the Py_buffer
3312 structs to release afterwards. */
3313 if (nitems > 0 && ((iovs = PyMem_New(struct iovec, nitems)) == NULL ||
3314 (bufs = PyMem_New(Py_buffer, nitems)) == NULL)) {
3315 PyErr_NoMemory();
3316 goto finally;
3317 }
3318 for (; nbufs < nitems; nbufs++) {
3319 if (!PyArg_Parse(PySequence_Fast_GET_ITEM(fast, nbufs),
3320 "w*;recvmsg_into() argument 1 must be an iterable "
3321 "of single-segment read-write buffers",
3322 &bufs[nbufs]))
3323 goto finally;
3324 iovs[nbufs].iov_base = bufs[nbufs].buf;
3325 iovs[nbufs].iov_len = bufs[nbufs].len;
3326 }
3327
3328 retval = sock_recvmsg_guts(s, iovs, nitems, flags, ancbufsize,
3329 &makeval_recvmsg_into, NULL);
3330finally:
3331 for (i = 0; i < nbufs; i++)
3332 PyBuffer_Release(&bufs[i]);
3333 PyMem_Free(bufs);
3334 PyMem_Free(iovs);
3335 Py_DECREF(fast);
3336 return retval;
3337}
3338
3339PyDoc_STRVAR(recvmsg_into_doc,
3340"recvmsg_into(buffers[, ancbufsize[, flags]]) -> (nbytes, ancdata, msg_flags, address)\n\
3341\n\
3342Receive normal data and ancillary data from the socket, scattering the\n\
3343non-ancillary data into a series of buffers. The buffers argument\n\
3344must be an iterable of objects that export writable buffers\n\
3345(e.g. bytearray objects); these will be filled with successive chunks\n\
3346of the non-ancillary data until it has all been written or there are\n\
3347no more buffers. The ancbufsize argument sets the size in bytes of\n\
3348the internal buffer used to receive the ancillary data; it defaults to\n\
33490, meaning that no ancillary data will be received. Appropriate\n\
3350buffer sizes for ancillary data can be calculated using CMSG_SPACE()\n\
3351or CMSG_LEN(), and items which do not fit into the buffer might be\n\
3352truncated or discarded. The flags argument defaults to 0 and has the\n\
3353same meaning as for recv().\n\
3354\n\
3355The return value is a 4-tuple: (nbytes, ancdata, msg_flags, address).\n\
3356The nbytes item is the total number of bytes of non-ancillary data\n\
3357written into the buffers. The ancdata item is a list of zero or more\n\
3358tuples (cmsg_level, cmsg_type, cmsg_data) representing the ancillary\n\
3359data (control messages) received: cmsg_level and cmsg_type are\n\
3360integers specifying the protocol level and protocol-specific type\n\
3361respectively, and cmsg_data is a bytes object holding the associated\n\
3362data. The msg_flags item is the bitwise OR of various flags\n\
3363indicating conditions on the received message; see your system\n\
3364documentation for details. If the receiving socket is unconnected,\n\
3365address is the address of the sending socket, if available; otherwise,\n\
3366its value is unspecified.\n\
3367\n\
3368If recvmsg_into() raises an exception after the system call returns,\n\
3369it will first attempt to close any file descriptors received via the\n\
3370SCM_RIGHTS mechanism.");
3371#endif /* CMSG_LEN */
3372
3373
Guido van Rossumeb6b33a1993-05-25 09:38:27 +00003374/* s.send(data [,flags]) method */
Guido van Rossum30a685f1991-06-27 15:51:29 +00003375
Guido van Rossum73624e91994-10-10 17:59:00 +00003376static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00003377sock_send(PySocketSockObject *s, PyObject *args)
Guido van Rossum30a685f1991-06-27 15:51:29 +00003378{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003379 char *buf;
Antoine Pitrou19467d22010-08-17 19:33:30 +00003380 Py_ssize_t len, n = -1;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003381 int async_err = 0;
Antoine Pitrou19467d22010-08-17 19:33:30 +00003382 int flags = 0, timeout;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003383 Py_buffer pbuf;
Guido van Rossum67f7a382002-06-06 21:08:16 +00003384
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003385 if (!PyArg_ParseTuple(args, "y*|i:send", &pbuf, &flags))
3386 return NULL;
Guido van Rossum67f7a382002-06-06 21:08:16 +00003387
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003388 if (!IS_SELECTABLE(s)) {
3389 PyBuffer_Release(&pbuf);
3390 return select_error();
3391 }
3392 buf = pbuf.buf;
3393 len = pbuf.len;
Neal Norwitz082b2df2006-02-07 07:04:46 +00003394
Antoine Pitrou3e1fd272010-09-28 21:23:11 +00003395 BEGIN_SELECT_LOOP(s)
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003396 do {
Victor Stinner391fa712015-03-31 13:15:31 +02003397 timeout = internal_select(s, 1, interval);
Victor Stinnerb7df3142015-03-27 22:59:32 +01003398
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003399 if (!timeout) {
Victor Stinnerb7df3142015-03-27 22:59:32 +01003400 Py_BEGIN_ALLOW_THREADS
Christian Heimesaf01f662013-12-21 16:19:10 +01003401#ifdef MS_WINDOWS
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003402 if (len > INT_MAX)
3403 len = INT_MAX;
3404 n = send(s->sock_fd, buf, (int)len, flags);
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003405#else
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003406 n = send(s->sock_fd, buf, len, flags);
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003407#endif
Victor Stinnerb7df3142015-03-27 22:59:32 +01003408 Py_END_ALLOW_THREADS
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003409 }
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003410 } while (n < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003411 if (timeout == 1) {
Antoine Pitrou3e1fd272010-09-28 21:23:11 +00003412 PyBuffer_Release(&pbuf);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003413 PyErr_SetString(socket_timeout, "timed out");
3414 return NULL;
3415 }
Antoine Pitrou3e1fd272010-09-28 21:23:11 +00003416 END_SELECT_LOOP(s)
3417
3418 PyBuffer_Release(&pbuf);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003419 if (n < 0)
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003420 return (!async_err) ? s->errorhandler() : NULL;
Antoine Pitrou19467d22010-08-17 19:33:30 +00003421 return PyLong_FromSsize_t(n);
Guido van Rossum30a685f1991-06-27 15:51:29 +00003422}
3423
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003424PyDoc_STRVAR(send_doc,
Guido van Rossum9f7a5392001-10-26 03:25:00 +00003425"send(data[, flags]) -> count\n\
Guido van Rossum82a5c661998-07-07 20:45:43 +00003426\n\
3427Send a data string to the socket. For the optional flags\n\
Guido van Rossum9f7a5392001-10-26 03:25:00 +00003428argument, see the Unix manual. Return the number of bytes\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003429sent; this may be less than len(data) if the network is busy.");
Guido van Rossum9f7a5392001-10-26 03:25:00 +00003430
3431
3432/* s.sendall(data [,flags]) method */
3433
3434static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00003435sock_sendall(PySocketSockObject *s, PyObject *args)
Guido van Rossum9f7a5392001-10-26 03:25:00 +00003436{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003437 char *buf;
Antoine Pitrou19467d22010-08-17 19:33:30 +00003438 Py_ssize_t len, n = -1;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003439 int async_err = 0;
3440 int flags = 0, timeout;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003441 Py_buffer pbuf;
Guido van Rossum67f7a382002-06-06 21:08:16 +00003442
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003443 if (!PyArg_ParseTuple(args, "y*|i:sendall", &pbuf, &flags))
3444 return NULL;
3445 buf = pbuf.buf;
3446 len = pbuf.len;
Guido van Rossum67f7a382002-06-06 21:08:16 +00003447
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003448 if (!IS_SELECTABLE(s)) {
3449 PyBuffer_Release(&pbuf);
3450 return select_error();
3451 }
Neal Norwitz082b2df2006-02-07 07:04:46 +00003452
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003453 do {
Victor Stinner391fa712015-03-31 13:15:31 +02003454 timeout = internal_select(s, 1, s->sock_timeout);
Victor Stinnerb7df3142015-03-27 22:59:32 +01003455
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003456 n = -1;
Antoine Pitrou6d7df632010-09-27 17:52:25 +00003457 if (!timeout) {
Victor Stinnerb7df3142015-03-27 22:59:32 +01003458 Py_BEGIN_ALLOW_THREADS
Christian Heimesaf01f662013-12-21 16:19:10 +01003459#ifdef MS_WINDOWS
Victor Stinner9a644b22013-06-24 23:47:41 +02003460 if (len > INT_MAX)
3461 len = INT_MAX;
3462 n = send(s->sock_fd, buf, (int)len, flags);
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003463#else
Antoine Pitrou6d7df632010-09-27 17:52:25 +00003464 n = send(s->sock_fd, buf, len, flags);
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003465#endif
Victor Stinnerb7df3142015-03-27 22:59:32 +01003466 Py_END_ALLOW_THREADS
Antoine Pitrou6d7df632010-09-27 17:52:25 +00003467 }
Antoine Pitrou6d7df632010-09-27 17:52:25 +00003468 if (timeout == 1) {
3469 PyBuffer_Release(&pbuf);
3470 PyErr_SetString(socket_timeout, "timed out");
3471 return NULL;
3472 }
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003473 if (n >= 0) {
3474 buf += n;
3475 len -= n;
Antoine Pitrou6d7df632010-09-27 17:52:25 +00003476 }
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003477 } while (len > 0 && (n >= 0 || errno == EINTR) &&
3478 !(async_err = PyErr_CheckSignals()));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003479 PyBuffer_Release(&pbuf);
Guido van Rossum67f7a382002-06-06 21:08:16 +00003480
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003481 if (n < 0 || async_err)
3482 return (!async_err) ? s->errorhandler() : NULL;
Guido van Rossum67f7a382002-06-06 21:08:16 +00003483
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003484 Py_INCREF(Py_None);
3485 return Py_None;
Guido van Rossum9f7a5392001-10-26 03:25:00 +00003486}
3487
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003488PyDoc_STRVAR(sendall_doc,
Guido van Rossum9f7a5392001-10-26 03:25:00 +00003489"sendall(data[, flags])\n\
3490\n\
3491Send a data string to the socket. For the optional flags\n\
3492argument, see the Unix manual. This calls send() repeatedly\n\
3493until all data is sent. If an error occurs, it's impossible\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003494to tell how much data has been sent.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00003495
Guido van Rossum30a685f1991-06-27 15:51:29 +00003496
Guido van Rossumeb6b33a1993-05-25 09:38:27 +00003497/* s.sendto(data, [flags,] sockaddr) method */
Guido van Rossum30a685f1991-06-27 15:51:29 +00003498
Guido van Rossum73624e91994-10-10 17:59:00 +00003499static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00003500sock_sendto(PySocketSockObject *s, PyObject *args)
Guido van Rossum6574b3e1991-06-25 21:36:08 +00003501{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003502 Py_buffer pbuf;
3503 PyObject *addro;
3504 char *buf;
Antoine Pitrou5e981412011-03-17 22:38:37 +01003505 Py_ssize_t len, arglen;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003506 sock_addr_t addrbuf;
3507 int addrlen, n = -1, flags, timeout;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003508 int async_err = 0;
Guido van Rossum67f7a382002-06-06 21:08:16 +00003509
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003510 flags = 0;
Antoine Pitrou5e981412011-03-17 22:38:37 +01003511 arglen = PyTuple_Size(args);
3512 switch (arglen) {
3513 case 2:
3514 PyArg_ParseTuple(args, "y*O:sendto", &pbuf, &addro);
3515 break;
3516 case 3:
3517 PyArg_ParseTuple(args, "y*iO:sendto",
3518 &pbuf, &flags, &addro);
3519 break;
3520 default:
3521 PyErr_Format(PyExc_TypeError,
3522 "sendto() takes 2 or 3 arguments (%d given)",
3523 arglen);
Victor Stinner77af1722011-05-26 14:05:59 +02003524 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003525 }
Antoine Pitrou5e981412011-03-17 22:38:37 +01003526 if (PyErr_Occurred())
3527 return NULL;
3528
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003529 buf = pbuf.buf;
3530 len = pbuf.len;
Guido van Rossum67f7a382002-06-06 21:08:16 +00003531
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003532 if (!IS_SELECTABLE(s)) {
3533 PyBuffer_Release(&pbuf);
3534 return select_error();
3535 }
Neal Norwitz082b2df2006-02-07 07:04:46 +00003536
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003537 if (!getsockaddrarg(s, addro, SAS2SA(&addrbuf), &addrlen)) {
3538 PyBuffer_Release(&pbuf);
3539 return NULL;
3540 }
Thomas Wouters89f507f2006-12-13 04:49:30 +00003541
Antoine Pitrou3e1fd272010-09-28 21:23:11 +00003542 BEGIN_SELECT_LOOP(s)
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003543 do {
Victor Stinner391fa712015-03-31 13:15:31 +02003544 timeout = internal_select(s, 1, interval);
Victor Stinnerb7df3142015-03-27 22:59:32 +01003545
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003546 if (!timeout) {
Victor Stinnerb7df3142015-03-27 22:59:32 +01003547 Py_BEGIN_ALLOW_THREADS
Victor Stinner14b9b112013-06-25 00:37:25 +02003548#ifdef MS_WINDOWS
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003549 if (len > INT_MAX)
3550 len = INT_MAX;
3551 n = sendto(s->sock_fd, buf, (int)len, flags,
3552 SAS2SA(&addrbuf), addrlen);
Victor Stinner9a644b22013-06-24 23:47:41 +02003553#else
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003554 n = sendto(s->sock_fd, buf, len, flags,
3555 SAS2SA(&addrbuf), addrlen);
Victor Stinner9a644b22013-06-24 23:47:41 +02003556#endif
Victor Stinnerb7df3142015-03-27 22:59:32 +01003557 Py_END_ALLOW_THREADS
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003558 }
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003559 } while (n < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
Guido van Rossum67f7a382002-06-06 21:08:16 +00003560
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003561 if (timeout == 1) {
Antoine Pitrou3e1fd272010-09-28 21:23:11 +00003562 PyBuffer_Release(&pbuf);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003563 PyErr_SetString(socket_timeout, "timed out");
3564 return NULL;
3565 }
Antoine Pitrou3e1fd272010-09-28 21:23:11 +00003566 END_SELECT_LOOP(s)
3567 PyBuffer_Release(&pbuf);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003568 if (n < 0)
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003569 return (!async_err) ? s->errorhandler() : NULL;
Antoine Pitrou19467d22010-08-17 19:33:30 +00003570 return PyLong_FromSsize_t(n);
Guido van Rossum6574b3e1991-06-25 21:36:08 +00003571}
3572
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003573PyDoc_STRVAR(sendto_doc,
Guido van Rossum22a97152002-08-08 20:37:08 +00003574"sendto(data[, flags], address) -> count\n\
Guido van Rossum82a5c661998-07-07 20:45:43 +00003575\n\
3576Like send(data, flags) but allows specifying the destination address.\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003577For IP sockets, the address is a pair (hostaddr, port).");
Guido van Rossum82a5c661998-07-07 20:45:43 +00003578
Guido van Rossum30a685f1991-06-27 15:51:29 +00003579
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003580/* The sendmsg() and recvmsg[_into]() methods require a working
3581 CMSG_LEN(). See the comment near get_CMSG_LEN(). */
3582#ifdef CMSG_LEN
3583/* s.sendmsg(buffers[, ancdata[, flags[, address]]]) method */
3584
3585static PyObject *
3586sock_sendmsg(PySocketSockObject *s, PyObject *args)
3587{
3588 Py_ssize_t i, ndataparts, ndatabufs = 0, ncmsgs, ncmsgbufs = 0;
3589 Py_buffer *databufs = NULL;
3590 struct iovec *iovs = NULL;
3591 sock_addr_t addrbuf;
Charles-François Natalie9e95ae2011-08-24 21:40:53 +02003592 struct msghdr msg = {0};
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003593 struct cmsginfo {
3594 int level;
3595 int type;
3596 Py_buffer data;
3597 } *cmsgs = NULL;
3598 void *controlbuf = NULL;
3599 size_t controllen, controllen_last;
3600 ssize_t bytes_sent = -1;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003601 int async_err = 0;
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003602 int addrlen, timeout, flags = 0;
3603 PyObject *data_arg, *cmsg_arg = NULL, *addr_arg = NULL, *data_fast = NULL,
3604 *cmsg_fast = NULL, *retval = NULL;
3605
3606 if (!PyArg_ParseTuple(args, "O|OiO:sendmsg",
3607 &data_arg, &cmsg_arg, &flags, &addr_arg))
3608 return NULL;
3609
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003610 /* Parse destination address. */
3611 if (addr_arg != NULL && addr_arg != Py_None) {
3612 if (!getsockaddrarg(s, addr_arg, SAS2SA(&addrbuf), &addrlen))
3613 goto finally;
3614 msg.msg_name = &addrbuf;
3615 msg.msg_namelen = addrlen;
3616 }
3617
3618 /* Fill in an iovec for each message part, and save the Py_buffer
3619 structs to release afterwards. */
3620 if ((data_fast = PySequence_Fast(data_arg,
3621 "sendmsg() argument 1 must be an "
3622 "iterable")) == NULL)
3623 goto finally;
3624 ndataparts = PySequence_Fast_GET_SIZE(data_fast);
3625 if (ndataparts > INT_MAX) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02003626 PyErr_SetString(PyExc_OSError, "sendmsg() argument 1 is too long");
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003627 goto finally;
3628 }
3629 msg.msg_iovlen = ndataparts;
3630 if (ndataparts > 0 &&
3631 ((msg.msg_iov = iovs = PyMem_New(struct iovec, ndataparts)) == NULL ||
3632 (databufs = PyMem_New(Py_buffer, ndataparts)) == NULL)) {
3633 PyErr_NoMemory();
3634 goto finally;
3635 }
3636 for (; ndatabufs < ndataparts; ndatabufs++) {
3637 if (!PyArg_Parse(PySequence_Fast_GET_ITEM(data_fast, ndatabufs),
3638 "y*;sendmsg() argument 1 must be an iterable of "
Serhiy Storchakab757c832014-12-05 22:25:22 +02003639 "bytes-like objects",
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003640 &databufs[ndatabufs]))
3641 goto finally;
3642 iovs[ndatabufs].iov_base = databufs[ndatabufs].buf;
3643 iovs[ndatabufs].iov_len = databufs[ndatabufs].len;
3644 }
3645
3646 if (cmsg_arg == NULL)
3647 ncmsgs = 0;
3648 else {
3649 if ((cmsg_fast = PySequence_Fast(cmsg_arg,
3650 "sendmsg() argument 2 must be an "
3651 "iterable")) == NULL)
3652 goto finally;
3653 ncmsgs = PySequence_Fast_GET_SIZE(cmsg_fast);
3654 }
3655
3656#ifndef CMSG_SPACE
3657 if (ncmsgs > 1) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02003658 PyErr_SetString(PyExc_OSError,
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003659 "sending multiple control messages is not supported "
3660 "on this system");
3661 goto finally;
3662 }
3663#endif
3664 /* Save level, type and Py_buffer for each control message,
3665 and calculate total size. */
3666 if (ncmsgs > 0 && (cmsgs = PyMem_New(struct cmsginfo, ncmsgs)) == NULL) {
3667 PyErr_NoMemory();
3668 goto finally;
3669 }
3670 controllen = controllen_last = 0;
3671 while (ncmsgbufs < ncmsgs) {
3672 size_t bufsize, space;
3673
3674 if (!PyArg_Parse(PySequence_Fast_GET_ITEM(cmsg_fast, ncmsgbufs),
3675 "(iiy*):[sendmsg() ancillary data items]",
3676 &cmsgs[ncmsgbufs].level,
3677 &cmsgs[ncmsgbufs].type,
3678 &cmsgs[ncmsgbufs].data))
3679 goto finally;
3680 bufsize = cmsgs[ncmsgbufs++].data.len;
3681
3682#ifdef CMSG_SPACE
3683 if (!get_CMSG_SPACE(bufsize, &space)) {
3684#else
3685 if (!get_CMSG_LEN(bufsize, &space)) {
3686#endif
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02003687 PyErr_SetString(PyExc_OSError, "ancillary data item too large");
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003688 goto finally;
3689 }
3690 controllen += space;
3691 if (controllen > SOCKLEN_T_LIMIT || controllen < controllen_last) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02003692 PyErr_SetString(PyExc_OSError, "too much ancillary data");
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003693 goto finally;
3694 }
3695 controllen_last = controllen;
3696 }
3697
3698 /* Construct ancillary data block from control message info. */
3699 if (ncmsgbufs > 0) {
3700 struct cmsghdr *cmsgh = NULL;
3701
3702 if ((msg.msg_control = controlbuf =
3703 PyMem_Malloc(controllen)) == NULL) {
3704 PyErr_NoMemory();
3705 goto finally;
3706 }
3707 msg.msg_controllen = controllen;
3708
3709 /* Need to zero out the buffer as a workaround for glibc's
3710 CMSG_NXTHDR() implementation. After getting the pointer to
3711 the next header, it checks its (uninitialized) cmsg_len
3712 member to see if the "message" fits in the buffer, and
3713 returns NULL if it doesn't. Zero-filling the buffer
Terry Jan Reedy0f847642013-03-11 18:34:00 -04003714 ensures that this doesn't happen. */
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003715 memset(controlbuf, 0, controllen);
3716
3717 for (i = 0; i < ncmsgbufs; i++) {
3718 size_t msg_len, data_len = cmsgs[i].data.len;
3719 int enough_space = 0;
3720
3721 cmsgh = (i == 0) ? CMSG_FIRSTHDR(&msg) : CMSG_NXTHDR(&msg, cmsgh);
3722 if (cmsgh == NULL) {
3723 PyErr_Format(PyExc_RuntimeError,
3724 "unexpected NULL result from %s()",
3725 (i == 0) ? "CMSG_FIRSTHDR" : "CMSG_NXTHDR");
3726 goto finally;
3727 }
3728 if (!get_CMSG_LEN(data_len, &msg_len)) {
3729 PyErr_SetString(PyExc_RuntimeError,
3730 "item size out of range for CMSG_LEN()");
3731 goto finally;
3732 }
3733 if (cmsg_min_space(&msg, cmsgh, msg_len)) {
3734 size_t space;
3735
3736 cmsgh->cmsg_len = msg_len;
3737 if (get_cmsg_data_space(&msg, cmsgh, &space))
3738 enough_space = (space >= data_len);
3739 }
3740 if (!enough_space) {
3741 PyErr_SetString(PyExc_RuntimeError,
3742 "ancillary data does not fit in calculated "
3743 "space");
3744 goto finally;
3745 }
3746 cmsgh->cmsg_level = cmsgs[i].level;
3747 cmsgh->cmsg_type = cmsgs[i].type;
3748 memcpy(CMSG_DATA(cmsgh), cmsgs[i].data.buf, data_len);
3749 }
3750 }
3751
3752 /* Make the system call. */
3753 if (!IS_SELECTABLE(s)) {
3754 select_error();
3755 goto finally;
3756 }
3757
3758 BEGIN_SELECT_LOOP(s)
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003759 do {
Victor Stinner391fa712015-03-31 13:15:31 +02003760 timeout = internal_select(s, 1, interval);
Victor Stinnerb7df3142015-03-27 22:59:32 +01003761
3762 if (!timeout) {
3763 Py_BEGIN_ALLOW_THREADS;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003764 bytes_sent = sendmsg(s->sock_fd, &msg, flags);
Victor Stinnerb7df3142015-03-27 22:59:32 +01003765 Py_END_ALLOW_THREADS;
3766 }
3767
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003768 if (timeout == 1) {
3769 PyErr_SetString(socket_timeout, "timed out");
3770 goto finally;
3771 }
3772 } while (bytes_sent < 0 && errno == EINTR &&
3773 !(async_err = PyErr_CheckSignals()));
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003774 END_SELECT_LOOP(s)
3775
3776 if (bytes_sent < 0) {
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003777 if (!async_err)
3778 s->errorhandler();
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003779 goto finally;
3780 }
3781 retval = PyLong_FromSsize_t(bytes_sent);
3782
3783finally:
3784 PyMem_Free(controlbuf);
3785 for (i = 0; i < ncmsgbufs; i++)
3786 PyBuffer_Release(&cmsgs[i].data);
3787 PyMem_Free(cmsgs);
3788 Py_XDECREF(cmsg_fast);
3789 for (i = 0; i < ndatabufs; i++)
3790 PyBuffer_Release(&databufs[i]);
3791 PyMem_Free(databufs);
3792 PyMem_Free(iovs);
3793 Py_XDECREF(data_fast);
3794 return retval;
3795}
3796
3797PyDoc_STRVAR(sendmsg_doc,
3798"sendmsg(buffers[, ancdata[, flags[, address]]]) -> count\n\
3799\n\
3800Send normal and ancillary data to the socket, gathering the\n\
3801non-ancillary data from a series of buffers and concatenating it into\n\
3802a single message. The buffers argument specifies the non-ancillary\n\
Serhiy Storchakab757c832014-12-05 22:25:22 +02003803data as an iterable of bytes-like objects (e.g. bytes objects).\n\
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003804The ancdata argument specifies the ancillary data (control messages)\n\
3805as an iterable of zero or more tuples (cmsg_level, cmsg_type,\n\
3806cmsg_data), where cmsg_level and cmsg_type are integers specifying the\n\
3807protocol level and protocol-specific type respectively, and cmsg_data\n\
Serhiy Storchakab757c832014-12-05 22:25:22 +02003808is a bytes-like object holding the associated data. The flags\n\
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003809argument defaults to 0 and has the same meaning as for send(). If\n\
3810address is supplied and not None, it sets a destination address for\n\
3811the message. The return value is the number of bytes of non-ancillary\n\
3812data sent.");
3813#endif /* CMSG_LEN */
3814
3815
Guido van Rossum30a685f1991-06-27 15:51:29 +00003816/* s.shutdown(how) method */
3817
Guido van Rossum73624e91994-10-10 17:59:00 +00003818static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00003819sock_shutdown(PySocketSockObject *s, PyObject *arg)
Guido van Rossum6574b3e1991-06-25 21:36:08 +00003820{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003821 int how;
3822 int res;
Jeremy Hyltonae0013d2001-10-11 16:36:35 +00003823
Serhiy Storchaka78980432013-01-15 01:12:17 +02003824 how = _PyLong_AsInt(arg);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003825 if (how == -1 && PyErr_Occurred())
3826 return NULL;
3827 Py_BEGIN_ALLOW_THREADS
3828 res = shutdown(s->sock_fd, how);
3829 Py_END_ALLOW_THREADS
3830 if (res < 0)
3831 return s->errorhandler();
3832 Py_INCREF(Py_None);
3833 return Py_None;
Guido van Rossum6574b3e1991-06-25 21:36:08 +00003834}
3835
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003836PyDoc_STRVAR(shutdown_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00003837"shutdown(flag)\n\
3838\n\
Martin v. Löwis94681fc2003-11-27 19:40:22 +00003839Shut down the reading side of the socket (flag == SHUT_RD), the writing side\n\
3840of the socket (flag == SHUT_WR), or both ends (flag == SHUT_RDWR).");
Guido van Rossum82a5c661998-07-07 20:45:43 +00003841
Amaury Forgeot d'Arc3d17a5c2008-06-13 01:09:34 +00003842#if defined(MS_WINDOWS) && defined(SIO_RCVALL)
Christian Heimesfaf2f632008-01-06 16:59:19 +00003843static PyObject*
3844sock_ioctl(PySocketSockObject *s, PyObject *arg)
3845{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003846 unsigned long cmd = SIO_RCVALL;
3847 PyObject *argO;
3848 DWORD recv;
Christian Heimesfaf2f632008-01-06 16:59:19 +00003849
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003850 if (!PyArg_ParseTuple(arg, "kO:ioctl", &cmd, &argO))
3851 return NULL;
Christian Heimesfaf2f632008-01-06 16:59:19 +00003852
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003853 switch (cmd) {
3854 case SIO_RCVALL: {
3855 unsigned int option = RCVALL_ON;
3856 if (!PyArg_ParseTuple(arg, "kI:ioctl", &cmd, &option))
3857 return NULL;
3858 if (WSAIoctl(s->sock_fd, cmd, &option, sizeof(option),
3859 NULL, 0, &recv, NULL, NULL) == SOCKET_ERROR) {
3860 return set_error();
3861 }
3862 return PyLong_FromUnsignedLong(recv); }
3863 case SIO_KEEPALIVE_VALS: {
3864 struct tcp_keepalive ka;
3865 if (!PyArg_ParseTuple(arg, "k(kkk):ioctl", &cmd,
3866 &ka.onoff, &ka.keepalivetime, &ka.keepaliveinterval))
3867 return NULL;
3868 if (WSAIoctl(s->sock_fd, cmd, &ka, sizeof(ka),
3869 NULL, 0, &recv, NULL, NULL) == SOCKET_ERROR) {
3870 return set_error();
3871 }
3872 return PyLong_FromUnsignedLong(recv); }
3873 default:
3874 PyErr_Format(PyExc_ValueError, "invalid ioctl command %d", cmd);
3875 return NULL;
3876 }
Christian Heimesfaf2f632008-01-06 16:59:19 +00003877}
3878PyDoc_STRVAR(sock_ioctl_doc,
3879"ioctl(cmd, option) -> long\n\
3880\n\
Kristján Valur Jónsson847ec752009-09-27 21:10:38 +00003881Control the socket with WSAIoctl syscall. Currently supported 'cmd' values are\n\
3882SIO_RCVALL: 'option' must be one of the socket.RCVALL_* constants.\n\
3883SIO_KEEPALIVE_VALS: 'option' is a tuple of (onoff, timeout, interval).");
Kristján Valur Jónsson10f383a2012-04-07 11:23:31 +00003884#endif
3885
3886#if defined(MS_WINDOWS)
3887static PyObject*
3888sock_share(PySocketSockObject *s, PyObject *arg)
3889{
3890 WSAPROTOCOL_INFO info;
3891 DWORD processId;
3892 int result;
3893
3894 if (!PyArg_ParseTuple(arg, "I", &processId))
3895 return NULL;
3896
3897 Py_BEGIN_ALLOW_THREADS
3898 result = WSADuplicateSocket(s->sock_fd, processId, &info);
3899 Py_END_ALLOW_THREADS
3900 if (result == SOCKET_ERROR)
3901 return set_error();
3902 return PyBytes_FromStringAndSize((const char*)&info, sizeof(info));
3903}
3904PyDoc_STRVAR(sock_share_doc,
3905"share(process_id) -> bytes\n\
3906\n\
3907Share the socket with another process. The target process id\n\
3908must be provided and the resulting bytes object passed to the target\n\
3909process. There the shared socket can be instantiated by calling\n\
3910socket.fromshare().");
3911
Christian Heimesfaf2f632008-01-06 16:59:19 +00003912
3913#endif
Guido van Rossum30a685f1991-06-27 15:51:29 +00003914
3915/* List of methods for socket objects */
Guido van Rossum6574b3e1991-06-25 21:36:08 +00003916
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00003917static PyMethodDef sock_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003918 {"_accept", (PyCFunction)sock_accept, METH_NOARGS,
3919 accept_doc},
3920 {"bind", (PyCFunction)sock_bind, METH_O,
3921 bind_doc},
3922 {"close", (PyCFunction)sock_close, METH_NOARGS,
3923 close_doc},
3924 {"connect", (PyCFunction)sock_connect, METH_O,
3925 connect_doc},
3926 {"connect_ex", (PyCFunction)sock_connect_ex, METH_O,
3927 connect_ex_doc},
Antoine Pitrou6e451df2010-08-09 20:39:54 +00003928 {"detach", (PyCFunction)sock_detach, METH_NOARGS,
3929 detach_doc},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003930 {"fileno", (PyCFunction)sock_fileno, METH_NOARGS,
3931 fileno_doc},
Guido van Rossumb6775db1994-08-01 11:34:53 +00003932#ifdef HAVE_GETPEERNAME
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003933 {"getpeername", (PyCFunction)sock_getpeername,
3934 METH_NOARGS, getpeername_doc},
Guido van Rossum9575a441993-04-07 14:06:14 +00003935#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003936 {"getsockname", (PyCFunction)sock_getsockname,
3937 METH_NOARGS, getsockname_doc},
3938 {"getsockopt", (PyCFunction)sock_getsockopt, METH_VARARGS,
3939 getsockopt_doc},
Amaury Forgeot d'Arc3d17a5c2008-06-13 01:09:34 +00003940#if defined(MS_WINDOWS) && defined(SIO_RCVALL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003941 {"ioctl", (PyCFunction)sock_ioctl, METH_VARARGS,
3942 sock_ioctl_doc},
Christian Heimesfaf2f632008-01-06 16:59:19 +00003943#endif
Kristján Valur Jónsson10f383a2012-04-07 11:23:31 +00003944#if defined(MS_WINDOWS)
3945 {"share", (PyCFunction)sock_share, METH_VARARGS,
3946 sock_share_doc},
3947#endif
Charles-François Natali644b8f52014-05-22 19:45:39 +01003948 {"listen", (PyCFunction)sock_listen, METH_VARARGS,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003949 listen_doc},
3950 {"recv", (PyCFunction)sock_recv, METH_VARARGS,
3951 recv_doc},
3952 {"recv_into", (PyCFunction)sock_recv_into, METH_VARARGS | METH_KEYWORDS,
3953 recv_into_doc},
3954 {"recvfrom", (PyCFunction)sock_recvfrom, METH_VARARGS,
3955 recvfrom_doc},
3956 {"recvfrom_into", (PyCFunction)sock_recvfrom_into, METH_VARARGS | METH_KEYWORDS,
3957 recvfrom_into_doc},
3958 {"send", (PyCFunction)sock_send, METH_VARARGS,
3959 send_doc},
3960 {"sendall", (PyCFunction)sock_sendall, METH_VARARGS,
3961 sendall_doc},
3962 {"sendto", (PyCFunction)sock_sendto, METH_VARARGS,
3963 sendto_doc},
3964 {"setblocking", (PyCFunction)sock_setblocking, METH_O,
3965 setblocking_doc},
3966 {"settimeout", (PyCFunction)sock_settimeout, METH_O,
3967 settimeout_doc},
3968 {"gettimeout", (PyCFunction)sock_gettimeout, METH_NOARGS,
3969 gettimeout_doc},
3970 {"setsockopt", (PyCFunction)sock_setsockopt, METH_VARARGS,
3971 setsockopt_doc},
3972 {"shutdown", (PyCFunction)sock_shutdown, METH_O,
3973 shutdown_doc},
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003974#ifdef CMSG_LEN
3975 {"recvmsg", (PyCFunction)sock_recvmsg, METH_VARARGS,
3976 recvmsg_doc},
3977 {"recvmsg_into", (PyCFunction)sock_recvmsg_into, METH_VARARGS,
3978 recvmsg_into_doc,},
3979 {"sendmsg", (PyCFunction)sock_sendmsg, METH_VARARGS,
3980 sendmsg_doc},
3981#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003982 {NULL, NULL} /* sentinel */
Guido van Rossum6574b3e1991-06-25 21:36:08 +00003983};
3984
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00003985/* SockObject members */
3986static PyMemberDef sock_memberlist[] = {
3987 {"family", T_INT, offsetof(PySocketSockObject, sock_family), READONLY, "the socket family"},
3988 {"type", T_INT, offsetof(PySocketSockObject, sock_type), READONLY, "the socket type"},
3989 {"proto", T_INT, offsetof(PySocketSockObject, sock_proto), READONLY, "the socket protocol"},
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00003990 {0},
3991};
Guido van Rossum30a685f1991-06-27 15:51:29 +00003992
Victor Stinner71694d52015-03-28 01:18:54 +01003993static PyGetSetDef sock_getsetlist[] = {
3994 {"timeout", (getter)sock_gettimeout, NULL, PyDoc_STR("the socket timeout")},
3995 {NULL} /* sentinel */
3996};
3997
Guido van Rossum73624e91994-10-10 17:59:00 +00003998/* Deallocate a socket object in response to the last Py_DECREF().
Guido van Rossum30a685f1991-06-27 15:51:29 +00003999 First close the file description. */
4000
Guido van Rossum6574b3e1991-06-25 21:36:08 +00004001static void
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00004002sock_dealloc(PySocketSockObject *s)
Guido van Rossum6574b3e1991-06-25 21:36:08 +00004003{
Antoine Pitroue033e062010-10-29 10:38:18 +00004004 if (s->sock_fd != -1) {
4005 PyObject *exc, *val, *tb;
4006 Py_ssize_t old_refcount = Py_REFCNT(s);
4007 ++Py_REFCNT(s);
4008 PyErr_Fetch(&exc, &val, &tb);
4009 if (PyErr_WarnFormat(PyExc_ResourceWarning, 1,
4010 "unclosed %R", s))
4011 /* Spurious errors can appear at shutdown */
4012 if (PyErr_ExceptionMatches(PyExc_Warning))
4013 PyErr_WriteUnraisable((PyObject *) s);
4014 PyErr_Restore(exc, val, tb);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004015 (void) SOCKETCLOSE(s->sock_fd);
Antoine Pitroue033e062010-10-29 10:38:18 +00004016 Py_REFCNT(s) = old_refcount;
4017 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004018 Py_TYPE(s)->tp_free((PyObject *)s);
Guido van Rossum6574b3e1991-06-25 21:36:08 +00004019}
4020
Guido van Rossum30a685f1991-06-27 15:51:29 +00004021
Guido van Rossum3bbc62e1995-01-02 19:30:30 +00004022static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00004023sock_repr(PySocketSockObject *s)
Guido van Rossum3bbc62e1995-01-02 19:30:30 +00004024{
Victor Stinnere254e532014-07-26 14:36:55 +02004025 long sock_fd;
4026 /* On Windows, this test is needed because SOCKET_T is unsigned */
4027 if (s->sock_fd == INVALID_SOCKET) {
4028 sock_fd = -1;
4029 }
Fred Drakea04eaad2000-06-30 02:46:07 +00004030#if SIZEOF_SOCKET_T > SIZEOF_LONG
Victor Stinnere254e532014-07-26 14:36:55 +02004031 else if (s->sock_fd > LONG_MAX) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004032 /* this can occur on Win64, and actually there is a special
4033 ugly printf formatter for decimal pointer length integer
4034 printing, only bother if necessary*/
4035 PyErr_SetString(PyExc_OverflowError,
4036 "no printf formatter to display "
4037 "the socket descriptor in decimal");
4038 return NULL;
4039 }
Fred Drakea04eaad2000-06-30 02:46:07 +00004040#endif
Victor Stinnere254e532014-07-26 14:36:55 +02004041 else
4042 sock_fd = (long)s->sock_fd;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004043 return PyUnicode_FromFormat(
4044 "<socket object, fd=%ld, family=%d, type=%d, proto=%d>",
Victor Stinnere254e532014-07-26 14:36:55 +02004045 sock_fd, s->sock_family,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004046 s->sock_type,
4047 s->sock_proto);
Guido van Rossum3bbc62e1995-01-02 19:30:30 +00004048}
4049
4050
Guido van Rossum384ca9c2001-10-27 22:20:47 +00004051/* Create a new, uninitialized socket object. */
4052
4053static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00004054sock_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
Guido van Rossum384ca9c2001-10-27 22:20:47 +00004055{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004056 PyObject *new;
Guido van Rossum384ca9c2001-10-27 22:20:47 +00004057
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004058 new = type->tp_alloc(type, 0);
4059 if (new != NULL) {
4060 ((PySocketSockObject *)new)->sock_fd = -1;
Victor Stinner71694d52015-03-28 01:18:54 +01004061 ((PySocketSockObject *)new)->sock_timeout = -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004062 ((PySocketSockObject *)new)->errorhandler = &set_error;
4063 }
4064 return new;
Guido van Rossum384ca9c2001-10-27 22:20:47 +00004065}
4066
4067
4068/* Initialize a new socket object. */
4069
Victor Stinnerdaf45552013-08-28 00:53:59 +02004070#ifdef SOCK_CLOEXEC
4071/* socket() and socketpair() fail with EINVAL on Linux kernel older
4072 * than 2.6.27 if SOCK_CLOEXEC flag is set in the socket type. */
4073static int sock_cloexec_works = -1;
4074#endif
4075
Guido van Rossum384ca9c2001-10-27 22:20:47 +00004076/*ARGSUSED*/
4077static int
Andrew MacIntyre7aec4a22002-06-13 11:53:52 +00004078sock_initobj(PyObject *self, PyObject *args, PyObject *kwds)
Guido van Rossum384ca9c2001-10-27 22:20:47 +00004079{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004080 PySocketSockObject *s = (PySocketSockObject *)self;
4081 PyObject *fdobj = NULL;
4082 SOCKET_T fd = INVALID_SOCKET;
4083 int family = AF_INET, type = SOCK_STREAM, proto = 0;
4084 static char *keywords[] = {"family", "type", "proto", "fileno", 0};
Victor Stinnerdaf45552013-08-28 00:53:59 +02004085#ifndef MS_WINDOWS
4086#ifdef SOCK_CLOEXEC
4087 int *atomic_flag_works = &sock_cloexec_works;
4088#else
4089 int *atomic_flag_works = NULL;
4090#endif
4091#endif
Guido van Rossum384ca9c2001-10-27 22:20:47 +00004092
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004093 if (!PyArg_ParseTupleAndKeywords(args, kwds,
4094 "|iiiO:socket", keywords,
4095 &family, &type, &proto, &fdobj))
4096 return -1;
Guido van Rossum67f7a382002-06-06 21:08:16 +00004097
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004098 if (fdobj != NULL && fdobj != Py_None) {
Kristján Valur Jónsson10f383a2012-04-07 11:23:31 +00004099#ifdef MS_WINDOWS
4100 /* recreate a socket that was duplicated */
4101 if (PyBytes_Check(fdobj)) {
4102 WSAPROTOCOL_INFO info;
4103 if (PyBytes_GET_SIZE(fdobj) != sizeof(info)) {
4104 PyErr_Format(PyExc_ValueError,
4105 "socket descriptor string has wrong size, "
4106 "should be %zu bytes.", sizeof(info));
4107 return -1;
4108 }
4109 memcpy(&info, PyBytes_AS_STRING(fdobj), sizeof(info));
4110 Py_BEGIN_ALLOW_THREADS
4111 fd = WSASocket(FROM_PROTOCOL_INFO, FROM_PROTOCOL_INFO,
4112 FROM_PROTOCOL_INFO, &info, 0, WSA_FLAG_OVERLAPPED);
4113 Py_END_ALLOW_THREADS
4114 if (fd == INVALID_SOCKET) {
4115 set_error();
4116 return -1;
4117 }
4118 family = info.iAddressFamily;
4119 type = info.iSocketType;
4120 proto = info.iProtocol;
4121 }
4122 else
4123#endif
4124 {
4125 fd = PyLong_AsSocket_t(fdobj);
4126 if (fd == (SOCKET_T)(-1) && PyErr_Occurred())
4127 return -1;
4128 if (fd == INVALID_SOCKET) {
4129 PyErr_SetString(PyExc_ValueError,
4130 "can't use invalid socket value");
4131 return -1;
4132 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004133 }
4134 }
4135 else {
Victor Stinnerdaf45552013-08-28 00:53:59 +02004136#ifdef MS_WINDOWS
4137 /* Windows implementation */
4138#ifndef WSA_FLAG_NO_HANDLE_INHERIT
4139#define WSA_FLAG_NO_HANDLE_INHERIT 0x80
4140#endif
4141
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004142 Py_BEGIN_ALLOW_THREADS
Victor Stinnerdaf45552013-08-28 00:53:59 +02004143 if (support_wsa_no_inherit) {
4144 fd = WSASocket(family, type, proto,
4145 NULL, 0,
4146 WSA_FLAG_OVERLAPPED | WSA_FLAG_NO_HANDLE_INHERIT);
4147 if (fd == INVALID_SOCKET) {
4148 /* Windows 7 or Windows 2008 R2 without SP1 or the hotfix */
4149 support_wsa_no_inherit = 0;
4150 fd = socket(family, type, proto);
4151 }
4152 }
4153 else {
4154 fd = socket(family, type, proto);
4155 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004156 Py_END_ALLOW_THREADS
Guido van Rossum67f7a382002-06-06 21:08:16 +00004157
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004158 if (fd == INVALID_SOCKET) {
4159 set_error();
4160 return -1;
4161 }
Victor Stinnerdaf45552013-08-28 00:53:59 +02004162
4163 if (!support_wsa_no_inherit) {
4164 if (!SetHandleInformation((HANDLE)fd, HANDLE_FLAG_INHERIT, 0)) {
4165 closesocket(fd);
4166 PyErr_SetFromWindowsErr(0);
4167 return -1;
4168 }
4169 }
4170#else
4171 /* UNIX */
4172 Py_BEGIN_ALLOW_THREADS
4173#ifdef SOCK_CLOEXEC
4174 if (sock_cloexec_works != 0) {
4175 fd = socket(family, type | SOCK_CLOEXEC, proto);
4176 if (sock_cloexec_works == -1) {
4177 if (fd >= 0) {
4178 sock_cloexec_works = 1;
4179 }
4180 else if (errno == EINVAL) {
4181 /* Linux older than 2.6.27 does not support SOCK_CLOEXEC */
4182 sock_cloexec_works = 0;
4183 fd = socket(family, type, proto);
4184 }
4185 }
4186 }
4187 else
4188#endif
4189 {
4190 fd = socket(family, type, proto);
4191 }
4192 Py_END_ALLOW_THREADS
4193
4194 if (fd == INVALID_SOCKET) {
4195 set_error();
4196 return -1;
4197 }
4198
4199 if (_Py_set_inheritable(fd, 0, atomic_flag_works) < 0) {
4200 SOCKETCLOSE(fd);
4201 return -1;
4202 }
4203#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004204 }
4205 init_sockobject(s, fd, family, type, proto);
Guido van Rossum67f7a382002-06-06 21:08:16 +00004206
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004207 return 0;
Guido van Rossum67f7a382002-06-06 21:08:16 +00004208
Guido van Rossum384ca9c2001-10-27 22:20:47 +00004209}
4210
4211
Guido van Rossumb6775db1994-08-01 11:34:53 +00004212/* Type object for socket objects. */
Guido van Rossum30a685f1991-06-27 15:51:29 +00004213
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00004214static PyTypeObject sock_type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004215 PyVarObject_HEAD_INIT(0, 0) /* Must fill in type value later */
4216 "_socket.socket", /* tp_name */
4217 sizeof(PySocketSockObject), /* tp_basicsize */
4218 0, /* tp_itemsize */
4219 (destructor)sock_dealloc, /* tp_dealloc */
4220 0, /* tp_print */
4221 0, /* tp_getattr */
4222 0, /* tp_setattr */
4223 0, /* tp_reserved */
4224 (reprfunc)sock_repr, /* tp_repr */
4225 0, /* tp_as_number */
4226 0, /* tp_as_sequence */
4227 0, /* tp_as_mapping */
4228 0, /* tp_hash */
4229 0, /* tp_call */
4230 0, /* tp_str */
4231 PyObject_GenericGetAttr, /* tp_getattro */
4232 0, /* tp_setattro */
4233 0, /* tp_as_buffer */
4234 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
4235 sock_doc, /* tp_doc */
4236 0, /* tp_traverse */
4237 0, /* tp_clear */
4238 0, /* tp_richcompare */
4239 0, /* tp_weaklistoffset */
4240 0, /* tp_iter */
4241 0, /* tp_iternext */
4242 sock_methods, /* tp_methods */
4243 sock_memberlist, /* tp_members */
Victor Stinner71694d52015-03-28 01:18:54 +01004244 sock_getsetlist, /* tp_getset */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004245 0, /* tp_base */
4246 0, /* tp_dict */
4247 0, /* tp_descr_get */
4248 0, /* tp_descr_set */
4249 0, /* tp_dictoffset */
4250 sock_initobj, /* tp_init */
4251 PyType_GenericAlloc, /* tp_alloc */
4252 sock_new, /* tp_new */
4253 PyObject_Del, /* tp_free */
Guido van Rossum6574b3e1991-06-25 21:36:08 +00004254};
4255
Guido van Rossum30a685f1991-06-27 15:51:29 +00004256
Guido van Rossum81194471991-07-27 21:42:02 +00004257/* Python interface to gethostname(). */
4258
4259/*ARGSUSED*/
Guido van Rossum73624e91994-10-10 17:59:00 +00004260static PyObject *
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00004261socket_gethostname(PyObject *self, PyObject *unused)
Guido van Rossum81194471991-07-27 21:42:02 +00004262{
Martin v. Löwis72f48422010-10-29 18:20:08 +00004263#ifdef MS_WINDOWS
4264 /* Don't use winsock's gethostname, as this returns the ANSI
4265 version of the hostname, whereas we need a Unicode string.
4266 Otherwise, gethostname apparently also returns the DNS name. */
Hirokazu Yamamoto09fff7a2010-11-05 17:24:13 +00004267 wchar_t buf[MAX_COMPUTERNAME_LENGTH + 1];
Victor Stinner63941882011-09-29 00:42:28 +02004268 DWORD size = Py_ARRAY_LENGTH(buf);
Victor Stinner74168972011-11-17 01:11:36 +01004269 wchar_t *name;
Hirokazu Yamamoto09fff7a2010-11-05 17:24:13 +00004270 PyObject *result;
Victor Stinner74168972011-11-17 01:11:36 +01004271
4272 if (GetComputerNameExW(ComputerNamePhysicalDnsHostname, buf, &size))
Victor Stinner9d3b93b2011-11-22 02:27:30 +01004273 return PyUnicode_FromWideChar(buf, size);
Victor Stinner74168972011-11-17 01:11:36 +01004274
4275 if (GetLastError() != ERROR_MORE_DATA)
4276 return PyErr_SetFromWindowsErr(0);
4277
4278 if (size == 0)
4279 return PyUnicode_New(0, 0);
4280
4281 /* MSDN says ERROR_MORE_DATA may occur because DNS allows longer
4282 names */
Serhiy Storchaka1a1ff292015-02-16 13:28:22 +02004283 name = PyMem_New(wchar_t, size);
4284 if (!name) {
4285 PyErr_NoMemory();
Victor Stinner74168972011-11-17 01:11:36 +01004286 return NULL;
Serhiy Storchaka1a1ff292015-02-16 13:28:22 +02004287 }
Victor Stinner74168972011-11-17 01:11:36 +01004288 if (!GetComputerNameExW(ComputerNamePhysicalDnsHostname,
4289 name,
4290 &size))
4291 {
4292 PyMem_Free(name);
4293 return PyErr_SetFromWindowsErr(0);
Martin v. Löwis72f48422010-10-29 18:20:08 +00004294 }
Victor Stinner74168972011-11-17 01:11:36 +01004295
4296 result = PyUnicode_FromWideChar(name, size);
4297 PyMem_Free(name);
4298 return result;
Martin v. Löwis72f48422010-10-29 18:20:08 +00004299#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004300 char buf[1024];
4301 int res;
4302 Py_BEGIN_ALLOW_THREADS
4303 res = gethostname(buf, (int) sizeof buf - 1);
4304 Py_END_ALLOW_THREADS
4305 if (res < 0)
4306 return set_error();
4307 buf[sizeof buf - 1] = '\0';
Victor Stinnera534fc42013-06-03 22:07:27 +02004308 return PyUnicode_DecodeFSDefault(buf);
Martin v. Löwis72f48422010-10-29 18:20:08 +00004309#endif
Guido van Rossum81194471991-07-27 21:42:02 +00004310}
Guido van Rossumff4949e1992-08-05 19:58:53 +00004311
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004312PyDoc_STRVAR(gethostname_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00004313"gethostname() -> string\n\
4314\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004315Return the current host name.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00004316
Antoine Pitrou061cfb52011-02-28 22:25:22 +00004317#ifdef HAVE_SETHOSTNAME
4318PyDoc_STRVAR(sethostname_doc,
4319"sethostname(name)\n\n\
4320Sets the hostname to name.");
4321
4322static PyObject *
4323socket_sethostname(PyObject *self, PyObject *args)
4324{
4325 PyObject *hnobj;
4326 Py_buffer buf;
4327 int res, flag = 0;
4328
Christian Heimesd2774c72013-06-19 02:06:29 +02004329#ifdef _AIX
4330/* issue #18259, not declared in any useful header file */
4331extern int sethostname(const char *, size_t);
4332#endif
4333
Antoine Pitrou061cfb52011-02-28 22:25:22 +00004334 if (!PyArg_ParseTuple(args, "S:sethostname", &hnobj)) {
4335 PyErr_Clear();
4336 if (!PyArg_ParseTuple(args, "O&:sethostname",
4337 PyUnicode_FSConverter, &hnobj))
4338 return NULL;
4339 flag = 1;
4340 }
4341 res = PyObject_GetBuffer(hnobj, &buf, PyBUF_SIMPLE);
4342 if (!res) {
4343 res = sethostname(buf.buf, buf.len);
4344 PyBuffer_Release(&buf);
4345 }
4346 if (flag)
4347 Py_DECREF(hnobj);
4348 if (res)
4349 return set_error();
4350 Py_RETURN_NONE;
4351}
4352#endif
Guido van Rossumff4949e1992-08-05 19:58:53 +00004353
Guido van Rossum30a685f1991-06-27 15:51:29 +00004354/* Python interface to gethostbyname(name). */
4355
4356/*ARGSUSED*/
Guido van Rossum73624e91994-10-10 17:59:00 +00004357static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00004358socket_gethostbyname(PyObject *self, PyObject *args)
Guido van Rossum30a685f1991-06-27 15:51:29 +00004359{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004360 char *name;
4361 sock_addr_t addrbuf;
Martin v. Löwisfc0275a2010-08-22 19:33:47 +00004362 PyObject *ret = NULL;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00004363
Martin v. Löwisfc0275a2010-08-22 19:33:47 +00004364 if (!PyArg_ParseTuple(args, "et:gethostbyname", "idna", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004365 return NULL;
4366 if (setipaddr(name, SAS2SA(&addrbuf), sizeof(addrbuf), AF_INET) < 0)
Martin v. Löwisfc0275a2010-08-22 19:33:47 +00004367 goto finally;
4368 ret = makeipaddr(SAS2SA(&addrbuf), sizeof(struct sockaddr_in));
4369finally:
4370 PyMem_Free(name);
4371 return ret;
Guido van Rossum30a685f1991-06-27 15:51:29 +00004372}
4373
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004374PyDoc_STRVAR(gethostbyname_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00004375"gethostbyname(host) -> address\n\
4376\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004377Return the IP address (a string of the form '255.255.255.255') for a host.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00004378
4379
Guido van Rossum7d896ab1998-08-04 22:16:43 +00004380/* Convenience function common to gethostbyname_ex and gethostbyaddr */
4381
4382static PyObject *
Victor Stinner1a62a682014-08-17 19:33:28 +02004383gethost_common(struct hostent *h, struct sockaddr *addr, size_t alen, int af)
Guido van Rossum7d896ab1998-08-04 22:16:43 +00004384{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004385 char **pch;
4386 PyObject *rtn_tuple = (PyObject *)NULL;
4387 PyObject *name_list = (PyObject *)NULL;
4388 PyObject *addr_list = (PyObject *)NULL;
4389 PyObject *tmp;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00004390
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004391 if (h == NULL) {
4392 /* Let's get real error message to return */
4393 set_herror(h_errno);
4394 return NULL;
4395 }
Guido van Rossum67f7a382002-06-06 21:08:16 +00004396
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004397 if (h->h_addrtype != af) {
4398 /* Let's get real error message to return */
Victor Stinner1f33f2b2011-12-17 04:45:09 +01004399 errno = EAFNOSUPPORT;
4400 PyErr_SetFromErrno(PyExc_OSError);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004401 return NULL;
4402 }
Guido van Rossum67f7a382002-06-06 21:08:16 +00004403
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004404 switch (af) {
Guido van Rossum67f7a382002-06-06 21:08:16 +00004405
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004406 case AF_INET:
4407 if (alen < sizeof(struct sockaddr_in))
4408 return NULL;
4409 break;
Guido van Rossum67f7a382002-06-06 21:08:16 +00004410
Martin v. Löwis44ddbde2001-12-02 10:15:37 +00004411#ifdef ENABLE_IPV6
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004412 case AF_INET6:
4413 if (alen < sizeof(struct sockaddr_in6))
4414 return NULL;
4415 break;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00004416#endif
Guido van Rossum67f7a382002-06-06 21:08:16 +00004417
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004418 }
Guido van Rossum67f7a382002-06-06 21:08:16 +00004419
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004420 if ((name_list = PyList_New(0)) == NULL)
4421 goto err;
Guido van Rossum67f7a382002-06-06 21:08:16 +00004422
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004423 if ((addr_list = PyList_New(0)) == NULL)
4424 goto err;
Guido van Rossum67f7a382002-06-06 21:08:16 +00004425
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004426 /* SF #1511317: h_aliases can be NULL */
4427 if (h->h_aliases) {
4428 for (pch = h->h_aliases; *pch != NULL; pch++) {
4429 int status;
4430 tmp = PyUnicode_FromString(*pch);
4431 if (tmp == NULL)
4432 goto err;
Guido van Rossum67f7a382002-06-06 21:08:16 +00004433
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004434 status = PyList_Append(name_list, tmp);
4435 Py_DECREF(tmp);
Guido van Rossum67f7a382002-06-06 21:08:16 +00004436
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004437 if (status)
4438 goto err;
4439 }
4440 }
Guido van Rossum67f7a382002-06-06 21:08:16 +00004441
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004442 for (pch = h->h_addr_list; *pch != NULL; pch++) {
4443 int status;
Guido van Rossum67f7a382002-06-06 21:08:16 +00004444
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004445 switch (af) {
Guido van Rossum67f7a382002-06-06 21:08:16 +00004446
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004447 case AF_INET:
4448 {
4449 struct sockaddr_in sin;
4450 memset(&sin, 0, sizeof(sin));
4451 sin.sin_family = af;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00004452#ifdef HAVE_SOCKADDR_SA_LEN
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004453 sin.sin_len = sizeof(sin);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00004454#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004455 memcpy(&sin.sin_addr, *pch, sizeof(sin.sin_addr));
4456 tmp = makeipaddr((struct sockaddr *)&sin, sizeof(sin));
Guido van Rossum67f7a382002-06-06 21:08:16 +00004457
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004458 if (pch == h->h_addr_list && alen >= sizeof(sin))
4459 memcpy((char *) addr, &sin, sizeof(sin));
4460 break;
4461 }
Guido van Rossum67f7a382002-06-06 21:08:16 +00004462
Martin v. Löwis44ddbde2001-12-02 10:15:37 +00004463#ifdef ENABLE_IPV6
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004464 case AF_INET6:
4465 {
4466 struct sockaddr_in6 sin6;
4467 memset(&sin6, 0, sizeof(sin6));
4468 sin6.sin6_family = af;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00004469#ifdef HAVE_SOCKADDR_SA_LEN
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004470 sin6.sin6_len = sizeof(sin6);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00004471#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004472 memcpy(&sin6.sin6_addr, *pch, sizeof(sin6.sin6_addr));
4473 tmp = makeipaddr((struct sockaddr *)&sin6,
4474 sizeof(sin6));
Guido van Rossum67f7a382002-06-06 21:08:16 +00004475
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004476 if (pch == h->h_addr_list && alen >= sizeof(sin6))
4477 memcpy((char *) addr, &sin6, sizeof(sin6));
4478 break;
4479 }
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00004480#endif
Guido van Rossum67f7a382002-06-06 21:08:16 +00004481
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004482 default: /* can't happen */
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02004483 PyErr_SetString(PyExc_OSError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004484 "unsupported address family");
4485 return NULL;
4486 }
Guido van Rossum67f7a382002-06-06 21:08:16 +00004487
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004488 if (tmp == NULL)
4489 goto err;
Guido van Rossum67f7a382002-06-06 21:08:16 +00004490
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004491 status = PyList_Append(addr_list, tmp);
4492 Py_DECREF(tmp);
Guido van Rossum67f7a382002-06-06 21:08:16 +00004493
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004494 if (status)
4495 goto err;
4496 }
Guido van Rossum67f7a382002-06-06 21:08:16 +00004497
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004498 rtn_tuple = Py_BuildValue("sOO", h->h_name, name_list, addr_list);
Guido van Rossum67f7a382002-06-06 21:08:16 +00004499
Guido van Rossum7d896ab1998-08-04 22:16:43 +00004500 err:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004501 Py_XDECREF(name_list);
4502 Py_XDECREF(addr_list);
4503 return rtn_tuple;
Guido van Rossum7d896ab1998-08-04 22:16:43 +00004504}
4505
4506
4507/* Python interface to gethostbyname_ex(name). */
4508
4509/*ARGSUSED*/
4510static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00004511socket_gethostbyname_ex(PyObject *self, PyObject *args)
Guido van Rossum7d896ab1998-08-04 22:16:43 +00004512{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004513 char *name;
4514 struct hostent *h;
Charles-François Natali8b759652011-12-23 16:44:51 +01004515 sock_addr_t addr;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004516 struct sockaddr *sa;
Martin v. Löwisfc0275a2010-08-22 19:33:47 +00004517 PyObject *ret = NULL;
Guido van Rossum7d896ab1998-08-04 22:16:43 +00004518#ifdef HAVE_GETHOSTBYNAME_R
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004519 struct hostent hp_allocated;
Guido van Rossum7b6c71f1999-03-24 17:20:40 +00004520#ifdef HAVE_GETHOSTBYNAME_R_3_ARG
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004521 struct hostent_data data;
Guido van Rossum7b6c71f1999-03-24 17:20:40 +00004522#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004523 char buf[16384];
4524 int buf_len = (sizeof buf) - 1;
4525 int errnop;
Guido van Rossum7b6c71f1999-03-24 17:20:40 +00004526#endif
Ross Lagerwall8c159762012-03-06 21:36:18 +02004527#ifdef HAVE_GETHOSTBYNAME_R_3_ARG
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004528 int result;
Guido van Rossume9cd07b1999-03-15 21:40:14 +00004529#endif
Guido van Rossum7d896ab1998-08-04 22:16:43 +00004530#endif /* HAVE_GETHOSTBYNAME_R */
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00004531
Martin v. Löwisfc0275a2010-08-22 19:33:47 +00004532 if (!PyArg_ParseTuple(args, "et:gethostbyname_ex", "idna", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004533 return NULL;
Charles-François Natali8b759652011-12-23 16:44:51 +01004534 if (setipaddr(name, SAS2SA(&addr), sizeof(addr), AF_INET) < 0)
Martin v. Löwisfc0275a2010-08-22 19:33:47 +00004535 goto finally;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004536 Py_BEGIN_ALLOW_THREADS
Guido van Rossum7d896ab1998-08-04 22:16:43 +00004537#ifdef HAVE_GETHOSTBYNAME_R
Guido van Rossum7b6c71f1999-03-24 17:20:40 +00004538#if defined(HAVE_GETHOSTBYNAME_R_6_ARG)
Ross Lagerwall8c159762012-03-06 21:36:18 +02004539 gethostbyname_r(name, &hp_allocated, buf, buf_len,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004540 &h, &errnop);
Guido van Rossum7b6c71f1999-03-24 17:20:40 +00004541#elif defined(HAVE_GETHOSTBYNAME_R_5_ARG)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004542 h = gethostbyname_r(name, &hp_allocated, buf, buf_len, &errnop);
Guido van Rossum7b6c71f1999-03-24 17:20:40 +00004543#else /* HAVE_GETHOSTBYNAME_R_3_ARG */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004544 memset((void *) &data, '\0', sizeof(data));
4545 result = gethostbyname_r(name, &hp_allocated, &data);
4546 h = (result != 0) ? NULL : &hp_allocated;
Guido van Rossume9cd07b1999-03-15 21:40:14 +00004547#endif
Guido van Rossum7d896ab1998-08-04 22:16:43 +00004548#else /* not HAVE_GETHOSTBYNAME_R */
Guido van Rossum3baaa131999-03-22 21:44:51 +00004549#ifdef USE_GETHOSTBYNAME_LOCK
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004550 PyThread_acquire_lock(netdb_lock, 1);
Guido van Rossum7d896ab1998-08-04 22:16:43 +00004551#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004552 h = gethostbyname(name);
Guido van Rossum7d896ab1998-08-04 22:16:43 +00004553#endif /* HAVE_GETHOSTBYNAME_R */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004554 Py_END_ALLOW_THREADS
4555 /* Some C libraries would require addr.__ss_family instead of
4556 addr.ss_family.
4557 Therefore, we cast the sockaddr_storage into sockaddr to
4558 access sa_family. */
Charles-François Natali8b759652011-12-23 16:44:51 +01004559 sa = SAS2SA(&addr);
4560 ret = gethost_common(h, SAS2SA(&addr), sizeof(addr),
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004561 sa->sa_family);
Guido van Rossum3baaa131999-03-22 21:44:51 +00004562#ifdef USE_GETHOSTBYNAME_LOCK
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004563 PyThread_release_lock(netdb_lock);
Guido van Rossum955becc1999-03-22 20:14:53 +00004564#endif
Martin v. Löwisfc0275a2010-08-22 19:33:47 +00004565finally:
4566 PyMem_Free(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004567 return ret;
Guido van Rossum7d896ab1998-08-04 22:16:43 +00004568}
4569
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004570PyDoc_STRVAR(ghbn_ex_doc,
Guido van Rossum7d896ab1998-08-04 22:16:43 +00004571"gethostbyname_ex(host) -> (name, aliaslist, addresslist)\n\
4572\n\
4573Return the true host name, a list of aliases, and a list of IP addresses,\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004574for a host. The host argument is a string giving a host name or IP number.");
Guido van Rossum7d896ab1998-08-04 22:16:43 +00004575
4576
Guido van Rossum3bbc62e1995-01-02 19:30:30 +00004577/* Python interface to gethostbyaddr(IP). */
4578
4579/*ARGSUSED*/
4580static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00004581socket_gethostbyaddr(PyObject *self, PyObject *args)
Guido van Rossum3bbc62e1995-01-02 19:30:30 +00004582{
Charles-François Natali8b759652011-12-23 16:44:51 +01004583 sock_addr_t addr;
4584 struct sockaddr *sa = SAS2SA(&addr);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004585 char *ip_num;
4586 struct hostent *h;
Martin v. Löwisfc0275a2010-08-22 19:33:47 +00004587 PyObject *ret = NULL;
Guido van Rossum4f199ea1998-04-09 20:56:35 +00004588#ifdef HAVE_GETHOSTBYNAME_R
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004589 struct hostent hp_allocated;
Guido van Rossum7b6c71f1999-03-24 17:20:40 +00004590#ifdef HAVE_GETHOSTBYNAME_R_3_ARG
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004591 struct hostent_data data;
Guido van Rossum7b6c71f1999-03-24 17:20:40 +00004592#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004593 /* glibcs up to 2.10 assume that the buf argument to
4594 gethostbyaddr_r is 8-byte aligned, which at least llvm-gcc
4595 does not ensure. The attribute below instructs the compiler
4596 to maintain this alignment. */
4597 char buf[16384] Py_ALIGNED(8);
4598 int buf_len = (sizeof buf) - 1;
4599 int errnop;
Guido van Rossum7b6c71f1999-03-24 17:20:40 +00004600#endif
Ross Lagerwall8c159762012-03-06 21:36:18 +02004601#ifdef HAVE_GETHOSTBYNAME_R_3_ARG
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004602 int result;
Guido van Rossume9cd07b1999-03-15 21:40:14 +00004603#endif
Guido van Rossum4f199ea1998-04-09 20:56:35 +00004604#endif /* HAVE_GETHOSTBYNAME_R */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004605 char *ap;
4606 int al;
4607 int af;
Guido van Rossum3bbc62e1995-01-02 19:30:30 +00004608
Martin v. Löwisfc0275a2010-08-22 19:33:47 +00004609 if (!PyArg_ParseTuple(args, "et:gethostbyaddr", "idna", &ip_num))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004610 return NULL;
4611 af = AF_UNSPEC;
4612 if (setipaddr(ip_num, sa, sizeof(addr), af) < 0)
Martin v. Löwisfc0275a2010-08-22 19:33:47 +00004613 goto finally;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004614 af = sa->sa_family;
4615 ap = NULL;
Brett Cannonb94767f2011-02-22 20:15:44 +00004616 /* al = 0; */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004617 switch (af) {
4618 case AF_INET:
4619 ap = (char *)&((struct sockaddr_in *)sa)->sin_addr;
4620 al = sizeof(((struct sockaddr_in *)sa)->sin_addr);
4621 break;
Martin v. Löwis44ddbde2001-12-02 10:15:37 +00004622#ifdef ENABLE_IPV6
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004623 case AF_INET6:
4624 ap = (char *)&((struct sockaddr_in6 *)sa)->sin6_addr;
4625 al = sizeof(((struct sockaddr_in6 *)sa)->sin6_addr);
4626 break;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00004627#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004628 default:
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02004629 PyErr_SetString(PyExc_OSError, "unsupported address family");
Martin v. Löwisfc0275a2010-08-22 19:33:47 +00004630 goto finally;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004631 }
4632 Py_BEGIN_ALLOW_THREADS
Guido van Rossum4f199ea1998-04-09 20:56:35 +00004633#ifdef HAVE_GETHOSTBYNAME_R
Guido van Rossum7b6c71f1999-03-24 17:20:40 +00004634#if defined(HAVE_GETHOSTBYNAME_R_6_ARG)
Ross Lagerwall8c159762012-03-06 21:36:18 +02004635 gethostbyaddr_r(ap, al, af,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004636 &hp_allocated, buf, buf_len,
4637 &h, &errnop);
Guido van Rossum7b6c71f1999-03-24 17:20:40 +00004638#elif defined(HAVE_GETHOSTBYNAME_R_5_ARG)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004639 h = gethostbyaddr_r(ap, al, af,
4640 &hp_allocated, buf, buf_len, &errnop);
Guido van Rossum7b6c71f1999-03-24 17:20:40 +00004641#else /* HAVE_GETHOSTBYNAME_R_3_ARG */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004642 memset((void *) &data, '\0', sizeof(data));
4643 result = gethostbyaddr_r(ap, al, af, &hp_allocated, &data);
4644 h = (result != 0) ? NULL : &hp_allocated;
Guido van Rossume9cd07b1999-03-15 21:40:14 +00004645#endif
Guido van Rossum4f199ea1998-04-09 20:56:35 +00004646#else /* not HAVE_GETHOSTBYNAME_R */
Guido van Rossum3baaa131999-03-22 21:44:51 +00004647#ifdef USE_GETHOSTBYNAME_LOCK
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004648 PyThread_acquire_lock(netdb_lock, 1);
Guido van Rossum4f199ea1998-04-09 20:56:35 +00004649#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004650 h = gethostbyaddr(ap, al, af);
Guido van Rossum4f199ea1998-04-09 20:56:35 +00004651#endif /* HAVE_GETHOSTBYNAME_R */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004652 Py_END_ALLOW_THREADS
Charles-François Natali8b759652011-12-23 16:44:51 +01004653 ret = gethost_common(h, SAS2SA(&addr), sizeof(addr), af);
Guido van Rossum3baaa131999-03-22 21:44:51 +00004654#ifdef USE_GETHOSTBYNAME_LOCK
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004655 PyThread_release_lock(netdb_lock);
Guido van Rossum3baaa131999-03-22 21:44:51 +00004656#endif
Martin v. Löwisfc0275a2010-08-22 19:33:47 +00004657finally:
4658 PyMem_Free(ip_num);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004659 return ret;
Guido van Rossum3bbc62e1995-01-02 19:30:30 +00004660}
4661
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004662PyDoc_STRVAR(gethostbyaddr_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00004663"gethostbyaddr(host) -> (name, aliaslist, addresslist)\n\
4664\n\
4665Return the true host name, a list of aliases, and a list of IP addresses,\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004666for a host. The host argument is a string giving a host name or IP number.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00004667
Guido van Rossum30a685f1991-06-27 15:51:29 +00004668
4669/* Python interface to getservbyname(name).
4670 This only returns the port number, since the other info is already
4671 known or not useful (like the list of aliases). */
4672
4673/*ARGSUSED*/
Guido van Rossum73624e91994-10-10 17:59:00 +00004674static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00004675socket_getservbyname(PyObject *self, PyObject *args)
Guido van Rossum30a685f1991-06-27 15:51:29 +00004676{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004677 char *name, *proto=NULL;
4678 struct servent *sp;
4679 if (!PyArg_ParseTuple(args, "s|s:getservbyname", &name, &proto))
4680 return NULL;
4681 Py_BEGIN_ALLOW_THREADS
4682 sp = getservbyname(name, proto);
4683 Py_END_ALLOW_THREADS
4684 if (sp == NULL) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02004685 PyErr_SetString(PyExc_OSError, "service/proto not found");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004686 return NULL;
4687 }
4688 return PyLong_FromLong((long) ntohs(sp->s_port));
Guido van Rossum30a685f1991-06-27 15:51:29 +00004689}
4690
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004691PyDoc_STRVAR(getservbyname_doc,
Barry Warsaw11b91a02004-06-28 00:50:43 +00004692"getservbyname(servicename[, protocolname]) -> integer\n\
Guido van Rossum82a5c661998-07-07 20:45:43 +00004693\n\
4694Return a port number from a service name and protocol name.\n\
Barry Warsaw11b91a02004-06-28 00:50:43 +00004695The optional protocol name, if given, should be 'tcp' or 'udp',\n\
4696otherwise any protocol will match.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00004697
Guido van Rossum30a685f1991-06-27 15:51:29 +00004698
Barry Warsaw11b91a02004-06-28 00:50:43 +00004699/* Python interface to getservbyport(port).
4700 This only returns the service name, since the other info is already
4701 known or not useful (like the list of aliases). */
4702
4703/*ARGSUSED*/
4704static PyObject *
4705socket_getservbyport(PyObject *self, PyObject *args)
4706{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004707 int port;
4708 char *proto=NULL;
4709 struct servent *sp;
4710 if (!PyArg_ParseTuple(args, "i|s:getservbyport", &port, &proto))
4711 return NULL;
4712 if (port < 0 || port > 0xffff) {
4713 PyErr_SetString(
4714 PyExc_OverflowError,
4715 "getservbyport: port must be 0-65535.");
4716 return NULL;
4717 }
4718 Py_BEGIN_ALLOW_THREADS
4719 sp = getservbyport(htons((short)port), proto);
4720 Py_END_ALLOW_THREADS
4721 if (sp == NULL) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02004722 PyErr_SetString(PyExc_OSError, "port/proto not found");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004723 return NULL;
4724 }
4725 return PyUnicode_FromString(sp->s_name);
Barry Warsaw11b91a02004-06-28 00:50:43 +00004726}
4727
4728PyDoc_STRVAR(getservbyport_doc,
4729"getservbyport(port[, protocolname]) -> string\n\
4730\n\
4731Return the service name from a port number and protocol name.\n\
4732The optional protocol name, if given, should be 'tcp' or 'udp',\n\
4733otherwise any protocol will match.");
4734
Guido van Rossum3901d851996-12-19 16:35:04 +00004735/* Python interface to getprotobyname(name).
4736 This only returns the protocol number, since the other info is
4737 already known or not useful (like the list of aliases). */
4738
4739/*ARGSUSED*/
4740static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00004741socket_getprotobyname(PyObject *self, PyObject *args)
Guido van Rossum3901d851996-12-19 16:35:04 +00004742{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004743 char *name;
4744 struct protoent *sp;
4745 if (!PyArg_ParseTuple(args, "s:getprotobyname", &name))
4746 return NULL;
4747 Py_BEGIN_ALLOW_THREADS
4748 sp = getprotobyname(name);
4749 Py_END_ALLOW_THREADS
4750 if (sp == NULL) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02004751 PyErr_SetString(PyExc_OSError, "protocol not found");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004752 return NULL;
4753 }
4754 return PyLong_FromLong((long) sp->p_proto);
Guido van Rossum3901d851996-12-19 16:35:04 +00004755}
4756
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004757PyDoc_STRVAR(getprotobyname_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00004758"getprotobyname(name) -> integer\n\
4759\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004760Return the protocol number for the named protocol. (Rarely used.)");
Guido van Rossum82a5c661998-07-07 20:45:43 +00004761
Guido van Rossum3901d851996-12-19 16:35:04 +00004762
Guido van Rossum39eb8fa2007-11-16 01:24:05 +00004763#ifndef NO_DUP
4764/* dup() function for socket fds */
4765
4766static PyObject *
4767socket_dup(PyObject *self, PyObject *fdobj)
4768{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004769 SOCKET_T fd, newfd;
4770 PyObject *newfdobj;
Victor Stinnerdaf45552013-08-28 00:53:59 +02004771#ifdef MS_WINDOWS
4772 WSAPROTOCOL_INFO info;
4773#endif
Guido van Rossum39eb8fa2007-11-16 01:24:05 +00004774
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004775 fd = PyLong_AsSocket_t(fdobj);
4776 if (fd == (SOCKET_T)(-1) && PyErr_Occurred())
4777 return NULL;
Guido van Rossum39eb8fa2007-11-16 01:24:05 +00004778
Victor Stinnerdaf45552013-08-28 00:53:59 +02004779#ifdef MS_WINDOWS
4780 if (WSADuplicateSocket(fd, GetCurrentProcessId(), &info))
4781 return set_error();
4782
4783 newfd = WSASocket(FROM_PROTOCOL_INFO, FROM_PROTOCOL_INFO,
4784 FROM_PROTOCOL_INFO,
4785 &info, 0, WSA_FLAG_OVERLAPPED);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004786 if (newfd == INVALID_SOCKET)
4787 return set_error();
Guido van Rossum39eb8fa2007-11-16 01:24:05 +00004788
Victor Stinnerdaf45552013-08-28 00:53:59 +02004789 if (!SetHandleInformation((HANDLE)newfd, HANDLE_FLAG_INHERIT, 0)) {
4790 closesocket(newfd);
4791 PyErr_SetFromWindowsErr(0);
4792 return NULL;
4793 }
4794#else
4795 /* On UNIX, dup can be used to duplicate the file descriptor of a socket */
4796 newfd = _Py_dup(fd);
4797 if (newfd == INVALID_SOCKET)
Victor Stinnere990c6e2013-11-16 00:18:58 +01004798 return NULL;
Victor Stinnerdaf45552013-08-28 00:53:59 +02004799#endif
4800
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004801 newfdobj = PyLong_FromSocket_t(newfd);
4802 if (newfdobj == NULL)
4803 SOCKETCLOSE(newfd);
4804 return newfdobj;
Guido van Rossum39eb8fa2007-11-16 01:24:05 +00004805}
4806
4807PyDoc_STRVAR(dup_doc,
4808"dup(integer) -> integer\n\
4809\n\
4810Duplicate an integer socket file descriptor. This is like os.dup(), but for\n\
4811sockets; on some platforms os.dup() won't work for socket file descriptors.");
4812#endif
4813
4814
Dave Cole331708b2004-08-09 04:51:41 +00004815#ifdef HAVE_SOCKETPAIR
4816/* Create a pair of sockets using the socketpair() function.
Dave Cole07fda7e2004-08-23 05:16:23 +00004817 Arguments as for socket() except the default family is AF_UNIX if
Dave Colee8bbfe42004-08-26 00:51:16 +00004818 defined on the platform; otherwise, the default is AF_INET. */
Dave Cole331708b2004-08-09 04:51:41 +00004819
4820/*ARGSUSED*/
4821static PyObject *
4822socket_socketpair(PyObject *self, PyObject *args)
4823{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004824 PySocketSockObject *s0 = NULL, *s1 = NULL;
4825 SOCKET_T sv[2];
4826 int family, type = SOCK_STREAM, proto = 0;
4827 PyObject *res = NULL;
Victor Stinnerdaf45552013-08-28 00:53:59 +02004828#ifdef SOCK_CLOEXEC
4829 int *atomic_flag_works = &sock_cloexec_works;
4830#else
4831 int *atomic_flag_works = NULL;
4832#endif
4833 int ret;
Dave Cole331708b2004-08-09 04:51:41 +00004834
4835#if defined(AF_UNIX)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004836 family = AF_UNIX;
Dave Cole331708b2004-08-09 04:51:41 +00004837#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004838 family = AF_INET;
Dave Cole331708b2004-08-09 04:51:41 +00004839#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004840 if (!PyArg_ParseTuple(args, "|iii:socketpair",
4841 &family, &type, &proto))
4842 return NULL;
Victor Stinnerdaf45552013-08-28 00:53:59 +02004843
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004844 /* Create a pair of socket fds */
Victor Stinnerdaf45552013-08-28 00:53:59 +02004845 Py_BEGIN_ALLOW_THREADS
4846#ifdef SOCK_CLOEXEC
4847 if (sock_cloexec_works != 0) {
4848 ret = socketpair(family, type | SOCK_CLOEXEC, proto, sv);
4849 if (sock_cloexec_works == -1) {
4850 if (ret >= 0) {
4851 sock_cloexec_works = 1;
4852 }
4853 else if (errno == EINVAL) {
4854 /* Linux older than 2.6.27 does not support SOCK_CLOEXEC */
4855 sock_cloexec_works = 0;
4856 ret = socketpair(family, type, proto, sv);
4857 }
4858 }
4859 }
4860 else
4861#endif
4862 {
4863 ret = socketpair(family, type, proto, sv);
4864 }
4865 Py_END_ALLOW_THREADS
4866
4867 if (ret < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004868 return set_error();
Victor Stinnerdaf45552013-08-28 00:53:59 +02004869
4870 if (_Py_set_inheritable(sv[0], 0, atomic_flag_works) < 0)
4871 goto finally;
4872 if (_Py_set_inheritable(sv[1], 0, atomic_flag_works) < 0)
4873 goto finally;
4874
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004875 s0 = new_sockobject(sv[0], family, type, proto);
4876 if (s0 == NULL)
4877 goto finally;
4878 s1 = new_sockobject(sv[1], family, type, proto);
4879 if (s1 == NULL)
4880 goto finally;
4881 res = PyTuple_Pack(2, s0, s1);
Dave Cole331708b2004-08-09 04:51:41 +00004882
4883finally:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004884 if (res == NULL) {
4885 if (s0 == NULL)
4886 SOCKETCLOSE(sv[0]);
4887 if (s1 == NULL)
4888 SOCKETCLOSE(sv[1]);
4889 }
4890 Py_XDECREF(s0);
4891 Py_XDECREF(s1);
4892 return res;
Dave Cole331708b2004-08-09 04:51:41 +00004893}
4894
4895PyDoc_STRVAR(socketpair_doc,
Victor Stinnerdaf45552013-08-28 00:53:59 +02004896"socketpair([family[, type [, proto]]]) -> (socket object, socket object)\n\
Dave Cole331708b2004-08-09 04:51:41 +00004897\n\
4898Create a pair of socket objects from the sockets returned by the platform\n\
4899socketpair() function.\n\
Dave Cole07fda7e2004-08-23 05:16:23 +00004900The arguments are the same as for socket() except the default family is\n\
Dave Colee8bbfe42004-08-26 00:51:16 +00004901AF_UNIX if defined on the platform; otherwise, the default is AF_INET.");
Dave Cole331708b2004-08-09 04:51:41 +00004902
4903#endif /* HAVE_SOCKETPAIR */
4904
4905
Guido van Rossum006bf911996-06-12 04:04:55 +00004906static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00004907socket_ntohs(PyObject *self, PyObject *args)
Guido van Rossum006bf911996-06-12 04:04:55 +00004908{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004909 int x1, x2;
Guido van Rossum006bf911996-06-12 04:04:55 +00004910
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004911 if (!PyArg_ParseTuple(args, "i:ntohs", &x1)) {
4912 return NULL;
4913 }
4914 if (x1 < 0) {
4915 PyErr_SetString(PyExc_OverflowError,
4916 "can't convert negative number to unsigned long");
4917 return NULL;
4918 }
4919 x2 = (unsigned int)ntohs((unsigned short)x1);
4920 return PyLong_FromLong(x2);
Guido van Rossum006bf911996-06-12 04:04:55 +00004921}
4922
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004923PyDoc_STRVAR(ntohs_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00004924"ntohs(integer) -> integer\n\
4925\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004926Convert a 16-bit integer from network to host byte order.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00004927
4928
Guido van Rossum006bf911996-06-12 04:04:55 +00004929static PyObject *
Jeremy Hyltonc075e192002-07-25 16:01:12 +00004930socket_ntohl(PyObject *self, PyObject *arg)
Guido van Rossum006bf911996-06-12 04:04:55 +00004931{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004932 unsigned long x;
Guido van Rossum006bf911996-06-12 04:04:55 +00004933
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004934 if (PyLong_Check(arg)) {
4935 x = PyLong_AsUnsignedLong(arg);
4936 if (x == (unsigned long) -1 && PyErr_Occurred())
4937 return NULL;
Jeremy Hyltonc075e192002-07-25 16:01:12 +00004938#if SIZEOF_LONG > 4
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004939 {
4940 unsigned long y;
4941 /* only want the trailing 32 bits */
4942 y = x & 0xFFFFFFFFUL;
4943 if (y ^ x)
4944 return PyErr_Format(PyExc_OverflowError,
Serhiy Storchaka95949422013-08-27 19:40:23 +03004945 "int larger than 32 bits");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004946 x = y;
4947 }
Jeremy Hyltonc075e192002-07-25 16:01:12 +00004948#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004949 }
4950 else
4951 return PyErr_Format(PyExc_TypeError,
Serhiy Storchaka95949422013-08-27 19:40:23 +03004952 "expected int, %s found",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004953 Py_TYPE(arg)->tp_name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004954 return PyLong_FromUnsignedLong(ntohl(x));
Guido van Rossum006bf911996-06-12 04:04:55 +00004955}
4956
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004957PyDoc_STRVAR(ntohl_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00004958"ntohl(integer) -> integer\n\
4959\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004960Convert a 32-bit integer from network to host byte order.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00004961
4962
Guido van Rossum006bf911996-06-12 04:04:55 +00004963static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00004964socket_htons(PyObject *self, PyObject *args)
Guido van Rossum006bf911996-06-12 04:04:55 +00004965{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004966 int x1, x2;
Guido van Rossum006bf911996-06-12 04:04:55 +00004967
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004968 if (!PyArg_ParseTuple(args, "i:htons", &x1)) {
4969 return NULL;
4970 }
4971 if (x1 < 0) {
4972 PyErr_SetString(PyExc_OverflowError,
4973 "can't convert negative number to unsigned long");
4974 return NULL;
4975 }
4976 x2 = (unsigned int)htons((unsigned short)x1);
4977 return PyLong_FromLong(x2);
Guido van Rossum006bf911996-06-12 04:04:55 +00004978}
4979
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004980PyDoc_STRVAR(htons_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00004981"htons(integer) -> integer\n\
4982\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004983Convert a 16-bit integer from host to network byte order.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00004984
4985
Guido van Rossum006bf911996-06-12 04:04:55 +00004986static PyObject *
Jeremy Hyltonc075e192002-07-25 16:01:12 +00004987socket_htonl(PyObject *self, PyObject *arg)
Guido van Rossum006bf911996-06-12 04:04:55 +00004988{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004989 unsigned long x;
Guido van Rossum006bf911996-06-12 04:04:55 +00004990
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004991 if (PyLong_Check(arg)) {
4992 x = PyLong_AsUnsignedLong(arg);
4993 if (x == (unsigned long) -1 && PyErr_Occurred())
4994 return NULL;
Jeremy Hyltonc075e192002-07-25 16:01:12 +00004995#if SIZEOF_LONG > 4
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004996 {
4997 unsigned long y;
4998 /* only want the trailing 32 bits */
4999 y = x & 0xFFFFFFFFUL;
5000 if (y ^ x)
5001 return PyErr_Format(PyExc_OverflowError,
Serhiy Storchaka95949422013-08-27 19:40:23 +03005002 "int larger than 32 bits");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005003 x = y;
5004 }
Jeremy Hyltonc075e192002-07-25 16:01:12 +00005005#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005006 }
5007 else
5008 return PyErr_Format(PyExc_TypeError,
Serhiy Storchaka95949422013-08-27 19:40:23 +03005009 "expected int, %s found",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005010 Py_TYPE(arg)->tp_name);
5011 return PyLong_FromUnsignedLong(htonl((unsigned long)x));
Guido van Rossum006bf911996-06-12 04:04:55 +00005012}
5013
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00005014PyDoc_STRVAR(htonl_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00005015"htonl(integer) -> integer\n\
5016\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00005017Convert a 32-bit integer from host to network byte order.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00005018
Guido van Rossum3eede5a2002-06-07 02:08:35 +00005019/* socket.inet_aton() and socket.inet_ntoa() functions. */
Guido van Rossum5c9eb211999-08-20 18:21:51 +00005020
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00005021PyDoc_STRVAR(inet_aton_doc,
Guido van Rossum7d0a8262007-05-21 23:13:11 +00005022"inet_aton(string) -> bytes giving packed 32-bit IP representation\n\
Guido van Rossum5c9eb211999-08-20 18:21:51 +00005023\n\
Guido van Rossumc6a164b1999-08-20 19:11:27 +00005024Convert 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 +00005025binary format used in low-level network functions.");
Guido van Rossum5c9eb211999-08-20 18:21:51 +00005026
5027static PyObject*
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00005028socket_inet_aton(PyObject *self, PyObject *args)
Guido van Rossum5c9eb211999-08-20 18:21:51 +00005029{
Neal Norwitz88f115b2003-02-13 02:15:42 +00005030#ifdef HAVE_INET_ATON
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005031 struct in_addr buf;
Thomas Wouters477c8d52006-05-27 19:21:47 +00005032#endif
5033
5034#if !defined(HAVE_INET_ATON) || defined(USE_INET_ATON_WEAKLINK)
Benjamin Petersonf91df042009-02-13 02:50:59 +00005035#if (SIZEOF_INT != 4)
5036#error "Not sure if in_addr_t exists and int is not 32-bits."
5037#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005038 /* Have to use inet_addr() instead */
5039 unsigned int packed_addr;
Tim Peters1df9fdd2003-02-13 03:13:40 +00005040#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005041 char *ip_addr;
Guido van Rossumc6a164b1999-08-20 19:11:27 +00005042
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005043 if (!PyArg_ParseTuple(args, "s:inet_aton", &ip_addr))
5044 return NULL;
Guido van Rossumad05cdf2003-02-12 23:08:22 +00005045
Tim Peters1df9fdd2003-02-13 03:13:40 +00005046
5047#ifdef HAVE_INET_ATON
Thomas Wouters477c8d52006-05-27 19:21:47 +00005048
5049#ifdef USE_INET_ATON_WEAKLINK
5050 if (inet_aton != NULL) {
5051#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005052 if (inet_aton(ip_addr, &buf))
5053 return PyBytes_FromStringAndSize((char *)(&buf),
5054 sizeof(buf));
Guido van Rossumad05cdf2003-02-12 23:08:22 +00005055
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02005056 PyErr_SetString(PyExc_OSError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005057 "illegal IP address string passed to inet_aton");
5058 return NULL;
Guido van Rossumad05cdf2003-02-12 23:08:22 +00005059
Thomas Wouters477c8d52006-05-27 19:21:47 +00005060#ifdef USE_INET_ATON_WEAKLINK
5061 } else {
5062#endif
5063
5064#endif
5065
5066#if !defined(HAVE_INET_ATON) || defined(USE_INET_ATON_WEAKLINK)
5067
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005068 /* special-case this address as inet_addr might return INADDR_NONE
5069 * for this */
5070 if (strcmp(ip_addr, "255.255.255.255") == 0) {
Charles-François Natali24aa0412013-08-31 14:48:25 +02005071 packed_addr = INADDR_BROADCAST;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005072 } else {
Thomas Wouters477c8d52006-05-27 19:21:47 +00005073
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005074 packed_addr = inet_addr(ip_addr);
Guido van Rossumc6a164b1999-08-20 19:11:27 +00005075
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005076 if (packed_addr == INADDR_NONE) { /* invalid address */
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02005077 PyErr_SetString(PyExc_OSError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005078 "illegal IP address string passed to inet_aton");
5079 return NULL;
5080 }
5081 }
5082 return PyBytes_FromStringAndSize((char *) &packed_addr,
5083 sizeof(packed_addr));
Thomas Wouters477c8d52006-05-27 19:21:47 +00005084
5085#ifdef USE_INET_ATON_WEAKLINK
5086 }
5087#endif
5088
Guido van Rossumad05cdf2003-02-12 23:08:22 +00005089#endif
Guido van Rossum5c9eb211999-08-20 18:21:51 +00005090}
5091
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00005092PyDoc_STRVAR(inet_ntoa_doc,
Fred Drakee0661342000-03-07 14:05:16 +00005093"inet_ntoa(packed_ip) -> ip_address_string\n\
Guido van Rossum5c9eb211999-08-20 18:21:51 +00005094\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00005095Convert an IP address from 32-bit packed binary format to string format");
Guido van Rossum5c9eb211999-08-20 18:21:51 +00005096
5097static PyObject*
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00005098socket_inet_ntoa(PyObject *self, PyObject *args)
Guido van Rossum5c9eb211999-08-20 18:21:51 +00005099{
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005100 Py_buffer packed_ip;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005101 struct in_addr packed_addr;
Guido van Rossum5c9eb211999-08-20 18:21:51 +00005102
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005103 if (!PyArg_ParseTuple(args, "y*:inet_ntoa", &packed_ip)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005104 return NULL;
5105 }
Guido van Rossum48a680c2001-03-02 06:34:14 +00005106
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005107 if (packed_ip.len != sizeof(packed_addr)) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02005108 PyErr_SetString(PyExc_OSError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005109 "packed IP wrong length for inet_ntoa");
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005110 PyBuffer_Release(&packed_ip);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005111 return NULL;
5112 }
Guido van Rossum5c9eb211999-08-20 18:21:51 +00005113
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005114 memcpy(&packed_addr, packed_ip.buf, packed_ip.len);
5115 PyBuffer_Release(&packed_ip);
Guido van Rossum5c9eb211999-08-20 18:21:51 +00005116
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005117 return PyUnicode_FromString(inet_ntoa(packed_addr));
Guido van Rossum5c9eb211999-08-20 18:21:51 +00005118}
Guido van Rossum82a5c661998-07-07 20:45:43 +00005119
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005120#if defined(HAVE_INET_PTON) || defined(MS_WINDOWS)
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00005121
5122PyDoc_STRVAR(inet_pton_doc,
5123"inet_pton(af, ip) -> packed IP address string\n\
5124\n\
5125Convert an IP address from string format to a packed string suitable\n\
5126for use with low-level network functions.");
5127
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005128#endif
5129
5130#ifdef HAVE_INET_PTON
5131
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00005132static PyObject *
5133socket_inet_pton(PyObject *self, PyObject *args)
5134{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005135 int af;
5136 char* ip;
5137 int retval;
Martin v. Löwisa94568a2003-05-10 07:36:56 +00005138#ifdef ENABLE_IPV6
Victor Stinner640c35c2013-06-04 23:14:37 +02005139 char packed[Py_MAX(sizeof(struct in_addr), sizeof(struct in6_addr))];
Martin v. Löwisa94568a2003-05-10 07:36:56 +00005140#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005141 char packed[sizeof(struct in_addr)];
Martin v. Löwisa94568a2003-05-10 07:36:56 +00005142#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005143 if (!PyArg_ParseTuple(args, "is:inet_pton", &af, &ip)) {
5144 return NULL;
5145 }
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00005146
Martin v. Löwis04697e82004-06-02 12:35:29 +00005147#if !defined(ENABLE_IPV6) && defined(AF_INET6)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005148 if(af == AF_INET6) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02005149 PyErr_SetString(PyExc_OSError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005150 "can't use AF_INET6, IPv6 is disabled");
5151 return NULL;
5152 }
Thomas Wouters477c8d52006-05-27 19:21:47 +00005153#endif
Martin v. Löwis10649092003-08-05 06:25:06 +00005154
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005155 retval = inet_pton(af, ip, packed);
5156 if (retval < 0) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02005157 PyErr_SetFromErrno(PyExc_OSError);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005158 return NULL;
5159 } else if (retval == 0) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02005160 PyErr_SetString(PyExc_OSError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005161 "illegal IP address string passed to inet_pton");
5162 return NULL;
5163 } else if (af == AF_INET) {
5164 return PyBytes_FromStringAndSize(packed,
5165 sizeof(struct in_addr));
Martin v. Löwisa94568a2003-05-10 07:36:56 +00005166#ifdef ENABLE_IPV6
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005167 } else if (af == AF_INET6) {
5168 return PyBytes_FromStringAndSize(packed,
5169 sizeof(struct in6_addr));
Martin v. Löwisa94568a2003-05-10 07:36:56 +00005170#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005171 } else {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02005172 PyErr_SetString(PyExc_OSError, "unknown address family");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005173 return NULL;
5174 }
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00005175}
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005176#elif defined(MS_WINDOWS)
5177
5178static PyObject *
5179socket_inet_pton(PyObject *self, PyObject *args)
5180{
5181 int af;
5182 char* ip;
5183 struct sockaddr_in6 addr;
5184 INT ret, size;
5185
5186 if (!PyArg_ParseTuple(args, "is:inet_pton", &af, &ip)) {
5187 return NULL;
5188 }
5189
Victor Stinnere990c6e2013-11-16 00:18:58 +01005190 size = sizeof(addr);
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005191 ret = WSAStringToAddressA(ip, af, NULL, (LPSOCKADDR)&addr, &size);
5192
5193 if (ret) {
5194 PyErr_SetExcFromWindowsErr(PyExc_OSError, WSAGetLastError());
5195 return NULL;
5196 } else if(af == AF_INET) {
5197 struct sockaddr_in *addr4 = (struct sockaddr_in*)&addr;
Victor Stinnere990c6e2013-11-16 00:18:58 +01005198 return PyBytes_FromStringAndSize((const char *)&(addr4->sin_addr),
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005199 sizeof(addr4->sin_addr));
5200 } else if (af == AF_INET6) {
Victor Stinnere990c6e2013-11-16 00:18:58 +01005201 return PyBytes_FromStringAndSize((const char *)&(addr.sin6_addr),
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005202 sizeof(addr.sin6_addr));
5203 } else {
5204 PyErr_SetString(PyExc_OSError, "unknown address family");
5205 return NULL;
5206 }
5207}
5208
5209#endif
5210
5211#if defined(HAVE_INET_PTON) || defined(MS_WINDOWS)
Thomas Wouters477c8d52006-05-27 19:21:47 +00005212
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00005213PyDoc_STRVAR(inet_ntop_doc,
5214"inet_ntop(af, packed_ip) -> string formatted IP address\n\
5215\n\
5216Convert a packed IP address of the given family to string format.");
5217
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005218#endif
5219
5220
5221#ifdef HAVE_INET_PTON
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00005222static PyObject *
5223socket_inet_ntop(PyObject *self, PyObject *args)
5224{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005225 int af;
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005226 Py_buffer packed_ip;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005227 const char* retval;
Martin v. Löwisa94568a2003-05-10 07:36:56 +00005228#ifdef ENABLE_IPV6
Victor Stinner640c35c2013-06-04 23:14:37 +02005229 char ip[Py_MAX(INET_ADDRSTRLEN, INET6_ADDRSTRLEN) + 1];
Martin v. Löwisa94568a2003-05-10 07:36:56 +00005230#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005231 char ip[INET_ADDRSTRLEN + 1];
Martin v. Löwisa94568a2003-05-10 07:36:56 +00005232#endif
Thomas Wouters477c8d52006-05-27 19:21:47 +00005233
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005234 /* Guarantee NUL-termination for PyUnicode_FromString() below */
5235 memset((void *) &ip[0], '\0', sizeof(ip));
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00005236
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005237 if (!PyArg_ParseTuple(args, "iy*:inet_ntop", &af, &packed_ip)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005238 return NULL;
5239 }
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00005240
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005241 if (af == AF_INET) {
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005242 if (packed_ip.len != sizeof(struct in_addr)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005243 PyErr_SetString(PyExc_ValueError,
5244 "invalid length of packed IP address string");
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005245 PyBuffer_Release(&packed_ip);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005246 return NULL;
5247 }
Martin v. Löwisa94568a2003-05-10 07:36:56 +00005248#ifdef ENABLE_IPV6
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005249 } else if (af == AF_INET6) {
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005250 if (packed_ip.len != sizeof(struct in6_addr)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005251 PyErr_SetString(PyExc_ValueError,
5252 "invalid length of packed IP address string");
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005253 PyBuffer_Release(&packed_ip);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005254 return NULL;
5255 }
Martin v. Löwisa94568a2003-05-10 07:36:56 +00005256#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005257 } else {
5258 PyErr_Format(PyExc_ValueError,
5259 "unknown address family %d", af);
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005260 PyBuffer_Release(&packed_ip);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005261 return NULL;
5262 }
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00005263
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005264 retval = inet_ntop(af, packed_ip.buf, ip, sizeof(ip));
5265 PyBuffer_Release(&packed_ip);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005266 if (!retval) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02005267 PyErr_SetFromErrno(PyExc_OSError);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005268 return NULL;
5269 } else {
5270 return PyUnicode_FromString(retval);
5271 }
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00005272
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005273 /* NOTREACHED */
5274 PyErr_SetString(PyExc_RuntimeError, "invalid handling of inet_ntop");
5275 return NULL;
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00005276}
5277
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005278#elif defined(MS_WINDOWS)
5279
5280static PyObject *
5281socket_inet_ntop(PyObject *self, PyObject *args)
5282{
5283 int af;
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005284 Py_buffer packed_ip;
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005285 struct sockaddr_in6 addr;
5286 DWORD addrlen, ret, retlen;
Jason R. Coombs8ec784c2013-11-10 13:43:22 -05005287#ifdef ENABLE_IPV6
5288 char ip[Py_MAX(INET_ADDRSTRLEN, INET6_ADDRSTRLEN) + 1];
5289#else
5290 char ip[INET_ADDRSTRLEN + 1];
5291#endif
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005292
5293 /* Guarantee NUL-termination for PyUnicode_FromString() below */
5294 memset((void *) &ip[0], '\0', sizeof(ip));
5295
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005296 if (!PyArg_ParseTuple(args, "iy*:inet_ntop", &af, &packed_ip)) {
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005297 return NULL;
5298 }
5299
5300 if (af == AF_INET) {
5301 struct sockaddr_in * addr4 = (struct sockaddr_in *)&addr;
5302
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005303 if (packed_ip.len != sizeof(struct in_addr)) {
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005304 PyErr_SetString(PyExc_ValueError,
5305 "invalid length of packed IP address string");
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005306 PyBuffer_Release(&packed_ip);
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005307 return NULL;
5308 }
5309 memset(addr4, 0, sizeof(struct sockaddr_in));
5310 addr4->sin_family = AF_INET;
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005311 memcpy(&(addr4->sin_addr), packed_ip.buf, sizeof(addr4->sin_addr));
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005312 addrlen = sizeof(struct sockaddr_in);
5313 } else if (af == AF_INET6) {
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005314 if (packed_ip.len != sizeof(struct in6_addr)) {
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005315 PyErr_SetString(PyExc_ValueError,
5316 "invalid length of packed IP address string");
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005317 PyBuffer_Release(&packed_ip);
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005318 return NULL;
5319 }
5320
5321 memset(&addr, 0, sizeof(addr));
5322 addr.sin6_family = AF_INET6;
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005323 memcpy(&(addr.sin6_addr), packed_ip.buf, sizeof(addr.sin6_addr));
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005324 addrlen = sizeof(addr);
5325 } else {
5326 PyErr_Format(PyExc_ValueError,
5327 "unknown address family %d", af);
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005328 PyBuffer_Release(&packed_ip);
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005329 return NULL;
5330 }
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005331 PyBuffer_Release(&packed_ip);
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005332
5333 retlen = sizeof(ip);
Victor Stinnere990c6e2013-11-16 00:18:58 +01005334 ret = WSAAddressToStringA((struct sockaddr*)&addr, addrlen, NULL,
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005335 ip, &retlen);
5336
5337 if (ret) {
5338 PyErr_SetExcFromWindowsErr(PyExc_OSError, WSAGetLastError());
5339 return NULL;
5340 } else {
5341 return PyUnicode_FromString(ip);
5342 }
5343}
5344
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00005345#endif /* HAVE_INET_PTON */
5346
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00005347/* Python interface to getaddrinfo(host, port). */
5348
5349/*ARGSUSED*/
5350static PyObject *
Giampaolo Rodolàccfb91c2010-08-17 15:30:23 +00005351socket_getaddrinfo(PyObject *self, PyObject *args, PyObject* kwargs)
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00005352{
Victor Stinner77af1722011-05-26 14:05:59 +02005353 static char* kwnames[] = {"host", "port", "family", "type", "proto",
Giampaolo Rodolàccfb91c2010-08-17 15:30:23 +00005354 "flags", 0};
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005355 struct addrinfo hints, *res;
5356 struct addrinfo *res0 = NULL;
5357 PyObject *hobj = NULL;
5358 PyObject *pobj = (PyObject *)NULL;
5359 char pbuf[30];
5360 char *hptr, *pptr;
5361 int family, socktype, protocol, flags;
5362 int error;
5363 PyObject *all = (PyObject *)NULL;
5364 PyObject *idna = NULL;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00005365
Georg Brandl6083a4b2013-10-14 06:51:46 +02005366 socktype = protocol = flags = 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005367 family = AF_UNSPEC;
Victor Stinner77af1722011-05-26 14:05:59 +02005368 if (!PyArg_ParseTupleAndKeywords(args, kwargs, "OO|iiii:getaddrinfo",
Giampaolo Rodolàccfb91c2010-08-17 15:30:23 +00005369 kwnames, &hobj, &pobj, &family, &socktype,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005370 &protocol, &flags)) {
5371 return NULL;
5372 }
5373 if (hobj == Py_None) {
5374 hptr = NULL;
5375 } else if (PyUnicode_Check(hobj)) {
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02005376 _Py_IDENTIFIER(encode);
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02005377
5378 idna = _PyObject_CallMethodId(hobj, &PyId_encode, "s", "idna");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005379 if (!idna)
5380 return NULL;
5381 assert(PyBytes_Check(idna));
5382 hptr = PyBytes_AS_STRING(idna);
5383 } else if (PyBytes_Check(hobj)) {
5384 hptr = PyBytes_AsString(hobj);
5385 } else {
5386 PyErr_SetString(PyExc_TypeError,
5387 "getaddrinfo() argument 1 must be string or None");
5388 return NULL;
5389 }
5390 if (PyLong_CheckExact(pobj)) {
5391 long value = PyLong_AsLong(pobj);
5392 if (value == -1 && PyErr_Occurred())
5393 goto err;
5394 PyOS_snprintf(pbuf, sizeof(pbuf), "%ld", value);
5395 pptr = pbuf;
5396 } else if (PyUnicode_Check(pobj)) {
5397 pptr = _PyUnicode_AsString(pobj);
Alexander Belopolskye239d232010-12-08 23:31:48 +00005398 if (pptr == NULL)
5399 goto err;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005400 } else if (PyBytes_Check(pobj)) {
Alexander Belopolskye239d232010-12-08 23:31:48 +00005401 pptr = PyBytes_AS_STRING(pobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005402 } else if (pobj == Py_None) {
5403 pptr = (char *)NULL;
5404 } else {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02005405 PyErr_SetString(PyExc_OSError, "Int or String expected");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005406 goto err;
5407 }
Ronald Oussorena822d3662013-06-10 10:36:28 +02005408#if defined(__APPLE__) && defined(AI_NUMERICSERV)
Ronald Oussoren27a4ac52013-05-24 13:47:37 +02005409 if ((flags & AI_NUMERICSERV) && (pptr == NULL || (pptr[0] == '0' && pptr[1] == 0))) {
5410 /* On OSX upto at least OSX 10.8 getaddrinfo crashes
Christian Heimesaf01f662013-12-21 16:19:10 +01005411 * if AI_NUMERICSERV is set and the servname is NULL or "0".
5412 * This workaround avoids a segfault in libsystem.
5413 */
Ronald Oussoren27a4ac52013-05-24 13:47:37 +02005414 pptr = "00";
5415 }
5416#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005417 memset(&hints, 0, sizeof(hints));
5418 hints.ai_family = family;
5419 hints.ai_socktype = socktype;
5420 hints.ai_protocol = protocol;
5421 hints.ai_flags = flags;
5422 Py_BEGIN_ALLOW_THREADS
5423 ACQUIRE_GETADDRINFO_LOCK
5424 error = getaddrinfo(hptr, pptr, &hints, &res0);
5425 Py_END_ALLOW_THREADS
5426 RELEASE_GETADDRINFO_LOCK /* see comment in setipaddr() */
5427 if (error) {
5428 set_gaierror(error);
5429 goto err;
5430 }
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00005431
Benjamin Peterson4fd929b2015-04-01 11:16:40 -04005432 all = PyList_New(0);
5433 if (all == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005434 goto err;
5435 for (res = res0; res; res = res->ai_next) {
5436 PyObject *single;
5437 PyObject *addr =
5438 makesockaddr(-1, res->ai_addr, res->ai_addrlen, protocol);
5439 if (addr == NULL)
5440 goto err;
5441 single = Py_BuildValue("iiisO", res->ai_family,
5442 res->ai_socktype, res->ai_protocol,
5443 res->ai_canonname ? res->ai_canonname : "",
5444 addr);
5445 Py_DECREF(addr);
5446 if (single == NULL)
5447 goto err;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00005448
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005449 if (PyList_Append(all, single))
5450 goto err;
5451 Py_XDECREF(single);
5452 }
5453 Py_XDECREF(idna);
5454 if (res0)
5455 freeaddrinfo(res0);
5456 return all;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00005457 err:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005458 Py_XDECREF(all);
5459 Py_XDECREF(idna);
5460 if (res0)
5461 freeaddrinfo(res0);
5462 return (PyObject *)NULL;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00005463}
5464
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00005465PyDoc_STRVAR(getaddrinfo_doc,
Berker Peksaga6ec5ee2014-06-30 11:28:40 +03005466"getaddrinfo(host, port [, family, type, proto, flags])\n\
5467 -> list of (family, type, proto, canonname, sockaddr)\n\
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00005468\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00005469Resolve host and port into addrinfo struct.");
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00005470
5471/* Python interface to getnameinfo(sa, flags). */
5472
5473/*ARGSUSED*/
5474static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00005475socket_getnameinfo(PyObject *self, PyObject *args)
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00005476{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005477 PyObject *sa = (PyObject *)NULL;
5478 int flags;
5479 char *hostp;
Charles-François Natali366999a2012-01-02 15:47:29 +01005480 int port;
5481 unsigned int flowinfo, scope_id;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005482 char hbuf[NI_MAXHOST], pbuf[NI_MAXSERV];
5483 struct addrinfo hints, *res = NULL;
5484 int error;
5485 PyObject *ret = (PyObject *)NULL;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00005486
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005487 flags = flowinfo = scope_id = 0;
5488 if (!PyArg_ParseTuple(args, "Oi:getnameinfo", &sa, &flags))
5489 return NULL;
5490 if (!PyTuple_Check(sa)) {
5491 PyErr_SetString(PyExc_TypeError,
5492 "getnameinfo() argument 1 must be a tuple");
5493 return NULL;
5494 }
Charles-François Natali366999a2012-01-02 15:47:29 +01005495 if (!PyArg_ParseTuple(sa, "si|II",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005496 &hostp, &port, &flowinfo, &scope_id))
5497 return NULL;
Charles-François Natali9b0c0062012-06-23 10:17:05 +02005498 if (flowinfo > 0xfffff) {
Charles-François Natali366999a2012-01-02 15:47:29 +01005499 PyErr_SetString(PyExc_OverflowError,
5500 "getsockaddrarg: flowinfo must be 0-1048575.");
5501 return NULL;
5502 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005503 PyOS_snprintf(pbuf, sizeof(pbuf), "%d", port);
5504 memset(&hints, 0, sizeof(hints));
5505 hints.ai_family = AF_UNSPEC;
5506 hints.ai_socktype = SOCK_DGRAM; /* make numeric port happy */
Martin v. Löwis112c0f32010-08-25 07:38:15 +00005507 hints.ai_flags = AI_NUMERICHOST; /* don't do any name resolution */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005508 Py_BEGIN_ALLOW_THREADS
5509 ACQUIRE_GETADDRINFO_LOCK
5510 error = getaddrinfo(hostp, pbuf, &hints, &res);
5511 Py_END_ALLOW_THREADS
5512 RELEASE_GETADDRINFO_LOCK /* see comment in setipaddr() */
5513 if (error) {
5514 set_gaierror(error);
5515 goto fail;
5516 }
5517 if (res->ai_next) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02005518 PyErr_SetString(PyExc_OSError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005519 "sockaddr resolved to multiple addresses");
5520 goto fail;
5521 }
5522 switch (res->ai_family) {
5523 case AF_INET:
5524 {
5525 if (PyTuple_GET_SIZE(sa) != 2) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02005526 PyErr_SetString(PyExc_OSError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005527 "IPv4 sockaddr must be 2 tuple");
5528 goto fail;
5529 }
5530 break;
5531 }
Martin v. Löwis44ddbde2001-12-02 10:15:37 +00005532#ifdef ENABLE_IPV6
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005533 case AF_INET6:
5534 {
5535 struct sockaddr_in6 *sin6;
5536 sin6 = (struct sockaddr_in6 *)res->ai_addr;
Charles-François Natali366999a2012-01-02 15:47:29 +01005537 sin6->sin6_flowinfo = htonl(flowinfo);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005538 sin6->sin6_scope_id = scope_id;
5539 break;
5540 }
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00005541#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005542 }
Antoine Pitrou19467d22010-08-17 19:33:30 +00005543 error = getnameinfo(res->ai_addr, (socklen_t) res->ai_addrlen,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005544 hbuf, sizeof(hbuf), pbuf, sizeof(pbuf), flags);
5545 if (error) {
5546 set_gaierror(error);
5547 goto fail;
5548 }
5549 ret = Py_BuildValue("ss", hbuf, pbuf);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00005550
5551fail:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005552 if (res)
5553 freeaddrinfo(res);
5554 return ret;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00005555}
5556
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00005557PyDoc_STRVAR(getnameinfo_doc,
Guido van Rossum22a97152002-08-08 20:37:08 +00005558"getnameinfo(sockaddr, flags) --> (host, port)\n\
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00005559\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00005560Get host and port for a sockaddr.");
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00005561
Guido van Rossum9d0c8ce2002-07-18 17:08:35 +00005562
5563/* Python API to getting and setting the default timeout value. */
5564
5565static PyObject *
5566socket_getdefaulttimeout(PyObject *self)
5567{
Victor Stinner71694d52015-03-28 01:18:54 +01005568 if (defaulttimeout < 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005569 Py_INCREF(Py_None);
5570 return Py_None;
5571 }
Victor Stinner71694d52015-03-28 01:18:54 +01005572 else {
5573 double seconds = _PyTime_AsSecondsDouble(defaulttimeout);
5574 return PyFloat_FromDouble(seconds);
5575 }
Guido van Rossum9d0c8ce2002-07-18 17:08:35 +00005576}
5577
5578PyDoc_STRVAR(getdefaulttimeout_doc,
Guido van Rossum22a97152002-08-08 20:37:08 +00005579"getdefaulttimeout() -> timeout\n\
Guido van Rossum9d0c8ce2002-07-18 17:08:35 +00005580\n\
Ezio Melotti388c9452011-08-14 08:28:57 +03005581Returns the default timeout in seconds (float) for new socket objects.\n\
Guido van Rossum9d0c8ce2002-07-18 17:08:35 +00005582A value of None indicates that new socket objects have no timeout.\n\
5583When the socket module is first imported, the default is None.");
5584
5585static PyObject *
5586socket_setdefaulttimeout(PyObject *self, PyObject *arg)
5587{
Victor Stinner71694d52015-03-28 01:18:54 +01005588 _PyTime_t timeout;
Guido van Rossum9d0c8ce2002-07-18 17:08:35 +00005589
Victor Stinner71694d52015-03-28 01:18:54 +01005590 if (socket_parse_timeout(&timeout, arg) < 0)
5591 return NULL;
Guido van Rossum9d0c8ce2002-07-18 17:08:35 +00005592
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005593 defaulttimeout = timeout;
Guido van Rossum9d0c8ce2002-07-18 17:08:35 +00005594
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005595 Py_INCREF(Py_None);
5596 return Py_None;
Guido van Rossum9d0c8ce2002-07-18 17:08:35 +00005597}
5598
5599PyDoc_STRVAR(setdefaulttimeout_doc,
Guido van Rossum22a97152002-08-08 20:37:08 +00005600"setdefaulttimeout(timeout)\n\
Guido van Rossum9d0c8ce2002-07-18 17:08:35 +00005601\n\
Ezio Melotti388c9452011-08-14 08:28:57 +03005602Set the default timeout in seconds (float) for new socket objects.\n\
Guido van Rossum9d0c8ce2002-07-18 17:08:35 +00005603A value of None indicates that new socket objects have no timeout.\n\
5604When the socket module is first imported, the default is None.");
5605
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005606#ifdef HAVE_IF_NAMEINDEX
5607/* Python API for getting interface indices and names */
5608
5609static PyObject *
5610socket_if_nameindex(PyObject *self, PyObject *arg)
5611{
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005612 PyObject *list;
Charles-François Natali60713592011-05-20 16:55:06 +02005613 int i;
5614 struct if_nameindex *ni;
Victor Stinner77af1722011-05-26 14:05:59 +02005615
Charles-François Natali60713592011-05-20 16:55:06 +02005616 ni = if_nameindex();
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005617 if (ni == NULL) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02005618 PyErr_SetFromErrno(PyExc_OSError);
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005619 return NULL;
5620 }
5621
5622 list = PyList_New(0);
5623 if (list == NULL) {
5624 if_freenameindex(ni);
5625 return NULL;
5626 }
5627
Charles-François Natali60713592011-05-20 16:55:06 +02005628 for (i = 0; ni[i].if_index != 0 && i < INT_MAX; i++) {
5629 PyObject *ni_tuple = Py_BuildValue("IO&",
5630 ni[i].if_index, PyUnicode_DecodeFSDefault, ni[i].if_name);
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005631
5632 if (ni_tuple == NULL || PyList_Append(list, ni_tuple) == -1) {
5633 Py_XDECREF(ni_tuple);
Charles-François Natali60713592011-05-20 16:55:06 +02005634 Py_DECREF(list);
5635 if_freenameindex(ni);
5636 return NULL;
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005637 }
5638 Py_DECREF(ni_tuple);
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005639 }
5640
5641 if_freenameindex(ni);
5642 return list;
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005643}
5644
5645PyDoc_STRVAR(if_nameindex_doc,
5646"if_nameindex()\n\
5647\n\
5648Returns a list of network interface information (index, name) tuples.");
5649
Charles-François Natali60713592011-05-20 16:55:06 +02005650static PyObject *
5651socket_if_nametoindex(PyObject *self, PyObject *args)
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005652{
Charles-François Natali60713592011-05-20 16:55:06 +02005653 PyObject *oname;
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005654 unsigned long index;
5655
Charles-François Natali60713592011-05-20 16:55:06 +02005656 if (!PyArg_ParseTuple(args, "O&:if_nametoindex",
5657 PyUnicode_FSConverter, &oname))
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005658 return NULL;
5659
Charles-François Natali60713592011-05-20 16:55:06 +02005660 index = if_nametoindex(PyBytes_AS_STRING(oname));
5661 Py_DECREF(oname);
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005662 if (index == 0) {
Charles-François Natali60713592011-05-20 16:55:06 +02005663 /* if_nametoindex() doesn't set errno */
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02005664 PyErr_SetString(PyExc_OSError, "no interface with this name");
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005665 return NULL;
5666 }
5667
5668 return PyLong_FromUnsignedLong(index);
5669}
5670
5671PyDoc_STRVAR(if_nametoindex_doc,
5672"if_nametoindex(if_name)\n\
5673\n\
5674Returns the interface index corresponding to the interface name if_name.");
5675
Charles-François Natali60713592011-05-20 16:55:06 +02005676static PyObject *
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005677socket_if_indextoname(PyObject *self, PyObject *arg)
5678{
Charles-François Natali60713592011-05-20 16:55:06 +02005679 unsigned long index;
5680 char name[IF_NAMESIZE + 1];
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005681
Charles-François Natali60713592011-05-20 16:55:06 +02005682 index = PyLong_AsUnsignedLong(arg);
5683 if (index == (unsigned long) -1)
5684 return NULL;
5685
5686 if (if_indextoname(index, name) == NULL) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02005687 PyErr_SetFromErrno(PyExc_OSError);
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005688 return NULL;
5689 }
5690
Charles-François Natali60713592011-05-20 16:55:06 +02005691 return PyUnicode_DecodeFSDefault(name);
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005692}
5693
5694PyDoc_STRVAR(if_indextoname_doc,
5695"if_indextoname(if_index)\n\
5696\n\
5697Returns the interface name corresponding to the interface index if_index.");
5698
5699#endif /* HAVE_IF_NAMEINDEX */
5700
5701
Nick Coghlan96fe56a2011-08-22 11:55:57 +10005702#ifdef CMSG_LEN
5703/* Python interface to CMSG_LEN(length). */
5704
5705static PyObject *
5706socket_CMSG_LEN(PyObject *self, PyObject *args)
5707{
5708 Py_ssize_t length;
5709 size_t result;
5710
5711 if (!PyArg_ParseTuple(args, "n:CMSG_LEN", &length))
5712 return NULL;
5713 if (length < 0 || !get_CMSG_LEN(length, &result)) {
5714 PyErr_Format(PyExc_OverflowError, "CMSG_LEN() argument out of range");
5715 return NULL;
5716 }
5717 return PyLong_FromSize_t(result);
5718}
5719
5720PyDoc_STRVAR(CMSG_LEN_doc,
5721"CMSG_LEN(length) -> control message length\n\
5722\n\
5723Return the total length, without trailing padding, of an ancillary\n\
5724data item with associated data of the given length. This value can\n\
5725often be used as the buffer size for recvmsg() to receive a single\n\
5726item of ancillary data, but RFC 3542 requires portable applications to\n\
5727use CMSG_SPACE() and thus include space for padding, even when the\n\
5728item will be the last in the buffer. Raises OverflowError if length\n\
5729is outside the permissible range of values.");
5730
5731
5732#ifdef CMSG_SPACE
5733/* Python interface to CMSG_SPACE(length). */
5734
5735static PyObject *
5736socket_CMSG_SPACE(PyObject *self, PyObject *args)
5737{
5738 Py_ssize_t length;
5739 size_t result;
5740
5741 if (!PyArg_ParseTuple(args, "n:CMSG_SPACE", &length))
5742 return NULL;
5743 if (length < 0 || !get_CMSG_SPACE(length, &result)) {
5744 PyErr_SetString(PyExc_OverflowError,
5745 "CMSG_SPACE() argument out of range");
5746 return NULL;
5747 }
5748 return PyLong_FromSize_t(result);
5749}
5750
5751PyDoc_STRVAR(CMSG_SPACE_doc,
5752"CMSG_SPACE(length) -> buffer size\n\
5753\n\
5754Return the buffer size needed for recvmsg() to receive an ancillary\n\
5755data item with associated data of the given length, along with any\n\
5756trailing padding. The buffer space needed to receive multiple items\n\
5757is the sum of the CMSG_SPACE() values for their associated data\n\
5758lengths. Raises OverflowError if length is outside the permissible\n\
5759range of values.");
5760#endif /* CMSG_SPACE */
5761#endif /* CMSG_LEN */
5762
5763
Guido van Rossum30a685f1991-06-27 15:51:29 +00005764/* List of functions exported by this module. */
5765
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00005766static PyMethodDef socket_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005767 {"gethostbyname", socket_gethostbyname,
5768 METH_VARARGS, gethostbyname_doc},
5769 {"gethostbyname_ex", socket_gethostbyname_ex,
5770 METH_VARARGS, ghbn_ex_doc},
5771 {"gethostbyaddr", socket_gethostbyaddr,
5772 METH_VARARGS, gethostbyaddr_doc},
5773 {"gethostname", socket_gethostname,
5774 METH_NOARGS, gethostname_doc},
Antoine Pitrou061cfb52011-02-28 22:25:22 +00005775#ifdef HAVE_SETHOSTNAME
5776 {"sethostname", socket_sethostname,
5777 METH_VARARGS, sethostname_doc},
5778#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005779 {"getservbyname", socket_getservbyname,
5780 METH_VARARGS, getservbyname_doc},
5781 {"getservbyport", socket_getservbyport,
5782 METH_VARARGS, getservbyport_doc},
5783 {"getprotobyname", socket_getprotobyname,
5784 METH_VARARGS, getprotobyname_doc},
Guido van Rossum39eb8fa2007-11-16 01:24:05 +00005785#ifndef NO_DUP
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005786 {"dup", socket_dup,
5787 METH_O, dup_doc},
Guido van Rossum39eb8fa2007-11-16 01:24:05 +00005788#endif
Dave Cole331708b2004-08-09 04:51:41 +00005789#ifdef HAVE_SOCKETPAIR
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005790 {"socketpair", socket_socketpair,
5791 METH_VARARGS, socketpair_doc},
Dave Cole331708b2004-08-09 04:51:41 +00005792#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005793 {"ntohs", socket_ntohs,
5794 METH_VARARGS, ntohs_doc},
5795 {"ntohl", socket_ntohl,
5796 METH_O, ntohl_doc},
5797 {"htons", socket_htons,
5798 METH_VARARGS, htons_doc},
5799 {"htonl", socket_htonl,
5800 METH_O, htonl_doc},
5801 {"inet_aton", socket_inet_aton,
5802 METH_VARARGS, inet_aton_doc},
5803 {"inet_ntoa", socket_inet_ntoa,
5804 METH_VARARGS, inet_ntoa_doc},
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005805#if defined(HAVE_INET_PTON) || defined(MS_WINDOWS)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005806 {"inet_pton", socket_inet_pton,
5807 METH_VARARGS, inet_pton_doc},
5808 {"inet_ntop", socket_inet_ntop,
5809 METH_VARARGS, inet_ntop_doc},
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00005810#endif
Giampaolo Rodolàccfb91c2010-08-17 15:30:23 +00005811 {"getaddrinfo", (PyCFunction)socket_getaddrinfo,
5812 METH_VARARGS | METH_KEYWORDS, getaddrinfo_doc},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005813 {"getnameinfo", socket_getnameinfo,
5814 METH_VARARGS, getnameinfo_doc},
5815 {"getdefaulttimeout", (PyCFunction)socket_getdefaulttimeout,
5816 METH_NOARGS, getdefaulttimeout_doc},
5817 {"setdefaulttimeout", socket_setdefaulttimeout,
5818 METH_O, setdefaulttimeout_doc},
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005819#ifdef HAVE_IF_NAMEINDEX
5820 {"if_nameindex", socket_if_nameindex,
5821 METH_NOARGS, if_nameindex_doc},
5822 {"if_nametoindex", socket_if_nametoindex,
Charles-François Natali60713592011-05-20 16:55:06 +02005823 METH_VARARGS, if_nametoindex_doc},
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005824 {"if_indextoname", socket_if_indextoname,
5825 METH_O, if_indextoname_doc},
5826#endif
Nick Coghlan96fe56a2011-08-22 11:55:57 +10005827#ifdef CMSG_LEN
5828 {"CMSG_LEN", socket_CMSG_LEN,
5829 METH_VARARGS, CMSG_LEN_doc},
5830#ifdef CMSG_SPACE
5831 {"CMSG_SPACE", socket_CMSG_SPACE,
5832 METH_VARARGS, CMSG_SPACE_doc},
5833#endif
5834#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005835 {NULL, NULL} /* Sentinel */
Guido van Rossum6574b3e1991-06-25 21:36:08 +00005836};
5837
Guido van Rossum30a685f1991-06-27 15:51:29 +00005838
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00005839#ifdef MS_WINDOWS
5840#define OS_INIT_DEFINED
5841
5842/* Additional initialization and cleanup for Windows */
Guido van Rossumbe32c891996-06-20 16:25:29 +00005843
5844static void
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00005845os_cleanup(void)
Guido van Rossumbe32c891996-06-20 16:25:29 +00005846{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005847 WSACleanup();
Guido van Rossumbe32c891996-06-20 16:25:29 +00005848}
5849
5850static int
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00005851os_init(void)
Guido van Rossumbe32c891996-06-20 16:25:29 +00005852{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005853 WSADATA WSAData;
5854 int ret;
5855 ret = WSAStartup(0x0101, &WSAData);
5856 switch (ret) {
5857 case 0: /* No error */
5858 Py_AtExit(os_cleanup);
5859 return 1; /* Success */
5860 case WSASYSNOTREADY:
5861 PyErr_SetString(PyExc_ImportError,
5862 "WSAStartup failed: network not ready");
5863 break;
5864 case WSAVERNOTSUPPORTED:
5865 case WSAEINVAL:
5866 PyErr_SetString(
5867 PyExc_ImportError,
5868 "WSAStartup failed: requested version not supported");
5869 break;
5870 default:
5871 PyErr_Format(PyExc_ImportError, "WSAStartup failed: error code %d", ret);
5872 break;
5873 }
5874 return 0; /* Failure */
Guido van Rossumbe32c891996-06-20 16:25:29 +00005875}
5876
Guido van Rossum8d665e61996-06-26 18:22:49 +00005877#endif /* MS_WINDOWS */
Guido van Rossumbe32c891996-06-20 16:25:29 +00005878
Guido van Rossum8e9ebfd1997-11-22 21:53:48 +00005879
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00005880
5881#ifndef OS_INIT_DEFINED
5882static int
5883os_init(void)
5884{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005885 return 1; /* Success */
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00005886}
5887#endif
5888
5889
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00005890/* C API table - always add new things to the end for binary
5891 compatibility. */
5892static
5893PySocketModule_APIObject PySocketModuleAPI =
5894{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005895 &sock_type,
Antoine Pitrouc4df7842010-12-03 19:59:41 +00005896 NULL,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005897 NULL
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00005898};
5899
Guido van Rossum3eede5a2002-06-07 02:08:35 +00005900
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00005901/* Initialize the _socket module.
Guido van Rossum3eede5a2002-06-07 02:08:35 +00005902
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00005903 This module is actually called "_socket", and there's a wrapper
Guido van Rossum7d0a8262007-05-21 23:13:11 +00005904 "socket.py" which implements some additional functionality.
5905 The import of "_socket" may fail with an ImportError exception if
5906 os-specific initialization fails. On Windows, this does WINSOCK
Ezio Melotti13925002011-03-16 11:05:33 +02005907 initialization. When WINSOCK is initialized successfully, a call to
Guido van Rossum7d0a8262007-05-21 23:13:11 +00005908 WSACleanup() is scheduled to be made at exit time.
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00005909*/
Guido van Rossum3eede5a2002-06-07 02:08:35 +00005910
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00005911PyDoc_STRVAR(socket_doc,
Guido van Rossum22a97152002-08-08 20:37:08 +00005912"Implementation module for socket operations.\n\
5913\n\
5914See the socket module for documentation.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00005915
Martin v. Löwis1a214512008-06-11 05:26:20 +00005916static struct PyModuleDef socketmodule = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005917 PyModuleDef_HEAD_INIT,
5918 PySocket_MODULE_NAME,
5919 socket_doc,
5920 -1,
5921 socket_methods,
5922 NULL,
5923 NULL,
5924 NULL,
5925 NULL
Martin v. Löwis1a214512008-06-11 05:26:20 +00005926};
5927
Mark Hammondfe51c6d2002-08-02 02:27:13 +00005928PyMODINIT_FUNC
Martin v. Löwis1a214512008-06-11 05:26:20 +00005929PyInit__socket(void)
Guido van Rossum6574b3e1991-06-25 21:36:08 +00005930{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005931 PyObject *m, *has_ipv6;
Fred Drake4baedc12002-04-01 14:53:37 +00005932
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005933 if (!os_init())
5934 return NULL;
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00005935
Victor Stinnerdaf45552013-08-28 00:53:59 +02005936#ifdef MS_WINDOWS
5937 if (support_wsa_no_inherit == -1) {
Steve Dower65e4cb12014-11-22 12:54:57 -08005938#if defined(_MSC_VER) && _MSC_VER >= 1800
5939 support_wsa_no_inherit = IsWindows7SP1OrGreater();
5940#else
Victor Stinnerdaf45552013-08-28 00:53:59 +02005941 DWORD version = GetVersion();
5942 DWORD major = (DWORD)LOBYTE(LOWORD(version));
5943 DWORD minor = (DWORD)HIBYTE(LOWORD(version));
5944 /* need Windows 7 SP1, 2008 R2 SP1 or later */
Steve Dower65e4cb12014-11-22 12:54:57 -08005945 support_wsa_no_inherit = major > 6 || (major == 6 && minor >= 1);
5946#endif
Victor Stinnerdaf45552013-08-28 00:53:59 +02005947 }
5948#endif
5949
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005950 Py_TYPE(&sock_type) = &PyType_Type;
5951 m = PyModule_Create(&socketmodule);
5952 if (m == NULL)
5953 return NULL;
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00005954
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02005955 Py_INCREF(PyExc_OSError);
5956 PySocketModuleAPI.error = PyExc_OSError;
5957 Py_INCREF(PyExc_OSError);
5958 PyModule_AddObject(m, "error", PyExc_OSError);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005959 socket_herror = PyErr_NewException("socket.herror",
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02005960 PyExc_OSError, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005961 if (socket_herror == NULL)
5962 return NULL;
5963 Py_INCREF(socket_herror);
5964 PyModule_AddObject(m, "herror", socket_herror);
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02005965 socket_gaierror = PyErr_NewException("socket.gaierror", PyExc_OSError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005966 NULL);
5967 if (socket_gaierror == NULL)
5968 return NULL;
5969 Py_INCREF(socket_gaierror);
5970 PyModule_AddObject(m, "gaierror", socket_gaierror);
5971 socket_timeout = PyErr_NewException("socket.timeout",
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02005972 PyExc_OSError, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005973 if (socket_timeout == NULL)
5974 return NULL;
Antoine Pitrouc4df7842010-12-03 19:59:41 +00005975 PySocketModuleAPI.timeout_error = socket_timeout;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005976 Py_INCREF(socket_timeout);
5977 PyModule_AddObject(m, "timeout", socket_timeout);
5978 Py_INCREF((PyObject *)&sock_type);
5979 if (PyModule_AddObject(m, "SocketType",
5980 (PyObject *)&sock_type) != 0)
5981 return NULL;
5982 Py_INCREF((PyObject *)&sock_type);
5983 if (PyModule_AddObject(m, "socket",
5984 (PyObject *)&sock_type) != 0)
5985 return NULL;
Guido van Rossum09be4091999-08-09 14:40:40 +00005986
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00005987#ifdef ENABLE_IPV6
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005988 has_ipv6 = Py_True;
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00005989#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005990 has_ipv6 = Py_False;
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00005991#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005992 Py_INCREF(has_ipv6);
5993 PyModule_AddObject(m, "has_ipv6", has_ipv6);
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00005994
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005995 /* Export C API */
5996 if (PyModule_AddObject(m, PySocket_CAPI_NAME,
5997 PyCapsule_New(&PySocketModuleAPI, PySocket_CAPSULE_NAME, NULL)
5998 ) != 0)
5999 return NULL;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00006000
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006001 /* Address families (we only support AF_INET and AF_UNIX) */
Guido van Rossum09be4091999-08-09 14:40:40 +00006002#ifdef AF_UNSPEC
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006003 PyModule_AddIntMacro(m, AF_UNSPEC);
Guido van Rossum09be4091999-08-09 14:40:40 +00006004#endif
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006005 PyModule_AddIntMacro(m, AF_INET);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006006#ifdef AF_INET6
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006007 PyModule_AddIntMacro(m, AF_INET6);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006008#endif /* AF_INET6 */
Andrew MacIntyred12dfbb2004-04-04 07:13:49 +00006009#if defined(AF_UNIX)
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006010 PyModule_AddIntMacro(m, AF_UNIX);
Guido van Rossumb6775db1994-08-01 11:34:53 +00006011#endif /* AF_UNIX */
Guido van Rossum09be4091999-08-09 14:40:40 +00006012#ifdef AF_AX25
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006013 /* Amateur Radio AX.25 */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006014 PyModule_AddIntMacro(m, AF_AX25);
Guido van Rossum09be4091999-08-09 14:40:40 +00006015#endif
6016#ifdef AF_IPX
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006017 PyModule_AddIntMacro(m, AF_IPX); /* Novell IPX */
Guido van Rossum09be4091999-08-09 14:40:40 +00006018#endif
6019#ifdef AF_APPLETALK
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006020 /* Appletalk DDP */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006021 PyModule_AddIntMacro(m, AF_APPLETALK);
Guido van Rossum09be4091999-08-09 14:40:40 +00006022#endif
6023#ifdef AF_NETROM
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006024 /* Amateur radio NetROM */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006025 PyModule_AddIntMacro(m, AF_NETROM);
Guido van Rossum09be4091999-08-09 14:40:40 +00006026#endif
6027#ifdef AF_BRIDGE
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006028 /* Multiprotocol bridge */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006029 PyModule_AddIntMacro(m, AF_BRIDGE);
Guido van Rossum09be4091999-08-09 14:40:40 +00006030#endif
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00006031#ifdef AF_ATMPVC
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006032 /* ATM PVCs */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006033 PyModule_AddIntMacro(m, AF_ATMPVC);
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00006034#endif
Guido van Rossum09be4091999-08-09 14:40:40 +00006035#ifdef AF_AAL5
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006036 /* Reserved for Werner's ATM */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006037 PyModule_AddIntMacro(m, AF_AAL5);
Guido van Rossum09be4091999-08-09 14:40:40 +00006038#endif
6039#ifdef AF_X25
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006040 /* Reserved for X.25 project */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006041 PyModule_AddIntMacro(m, AF_X25);
Guido van Rossum09be4091999-08-09 14:40:40 +00006042#endif
6043#ifdef AF_INET6
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006044 PyModule_AddIntMacro(m, AF_INET6); /* IP version 6 */
Guido van Rossum09be4091999-08-09 14:40:40 +00006045#endif
6046#ifdef AF_ROSE
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006047 /* Amateur Radio X.25 PLP */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006048 PyModule_AddIntMacro(m, AF_ROSE);
Guido van Rossum09be4091999-08-09 14:40:40 +00006049#endif
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00006050#ifdef AF_DECnet
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006051 /* Reserved for DECnet project */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006052 PyModule_AddIntMacro(m, AF_DECnet);
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00006053#endif
6054#ifdef AF_NETBEUI
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006055 /* Reserved for 802.2LLC project */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006056 PyModule_AddIntMacro(m, AF_NETBEUI);
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00006057#endif
6058#ifdef AF_SECURITY
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006059 /* Security callback pseudo AF */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006060 PyModule_AddIntMacro(m, AF_SECURITY);
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00006061#endif
6062#ifdef AF_KEY
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006063 /* PF_KEY key management API */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006064 PyModule_AddIntMacro(m, AF_KEY);
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00006065#endif
6066#ifdef AF_NETLINK
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006067 /* */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006068 PyModule_AddIntMacro(m, AF_NETLINK);
6069 PyModule_AddIntMacro(m, NETLINK_ROUTE);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00006070#ifdef NETLINK_SKIP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006071 PyModule_AddIntMacro(m, NETLINK_SKIP);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00006072#endif
6073#ifdef NETLINK_W1
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006074 PyModule_AddIntMacro(m, NETLINK_W1);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00006075#endif
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006076 PyModule_AddIntMacro(m, NETLINK_USERSOCK);
6077 PyModule_AddIntMacro(m, NETLINK_FIREWALL);
Guido van Rossum668a94a2006-02-21 01:07:27 +00006078#ifdef NETLINK_TCPDIAG
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006079 PyModule_AddIntMacro(m, NETLINK_TCPDIAG);
Guido van Rossum668a94a2006-02-21 01:07:27 +00006080#endif
6081#ifdef NETLINK_NFLOG
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006082 PyModule_AddIntMacro(m, NETLINK_NFLOG);
Guido van Rossum668a94a2006-02-21 01:07:27 +00006083#endif
Neal Norwitz65851662006-01-16 04:31:40 +00006084#ifdef NETLINK_XFRM
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006085 PyModule_AddIntMacro(m, NETLINK_XFRM);
Neal Norwitz65851662006-01-16 04:31:40 +00006086#endif
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00006087#ifdef NETLINK_ARPD
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006088 PyModule_AddIntMacro(m, NETLINK_ARPD);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00006089#endif
6090#ifdef NETLINK_ROUTE6
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006091 PyModule_AddIntMacro(m, NETLINK_ROUTE6);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00006092#endif
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006093 PyModule_AddIntMacro(m, NETLINK_IP6_FW);
Thomas Wouterscf297e42007-02-23 15:07:44 +00006094#ifdef NETLINK_DNRTMSG
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006095 PyModule_AddIntMacro(m, NETLINK_DNRTMSG);
Guido van Rossum39eb8fa2007-11-16 01:24:05 +00006096#endif
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00006097#ifdef NETLINK_TAPBASE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006098 PyModule_AddIntMacro(m, NETLINK_TAPBASE);
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00006099#endif
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00006100#endif /* AF_NETLINK */
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00006101#ifdef AF_ROUTE
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006102 /* Alias to emulate 4.4BSD */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006103 PyModule_AddIntMacro(m, AF_ROUTE);
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00006104#endif
Giampaolo Rodola'80e1c432013-05-21 21:02:04 +02006105#ifdef AF_LINK
6106 PyModule_AddIntMacro(m, AF_LINK);
6107#endif
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00006108#ifdef AF_ASH
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006109 /* Ash */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006110 PyModule_AddIntMacro(m, AF_ASH);
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00006111#endif
6112#ifdef AF_ECONET
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006113 /* Acorn Econet */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006114 PyModule_AddIntMacro(m, AF_ECONET);
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00006115#endif
6116#ifdef AF_ATMSVC
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006117 /* ATM SVCs */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006118 PyModule_AddIntMacro(m, AF_ATMSVC);
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00006119#endif
6120#ifdef AF_SNA
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006121 /* Linux SNA Project (nutters!) */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006122 PyModule_AddIntMacro(m, AF_SNA);
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00006123#endif
6124#ifdef AF_IRDA
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006125 /* IRDA sockets */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006126 PyModule_AddIntMacro(m, AF_IRDA);
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00006127#endif
6128#ifdef AF_PPPOX
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006129 /* PPPoX sockets */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006130 PyModule_AddIntMacro(m, AF_PPPOX);
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00006131#endif
6132#ifdef AF_WANPIPE
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006133 /* Wanpipe API Sockets */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006134 PyModule_AddIntMacro(m, AF_WANPIPE);
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00006135#endif
6136#ifdef AF_LLC
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006137 /* Linux LLC */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006138 PyModule_AddIntMacro(m, AF_LLC);
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00006139#endif
Martin v. Löwis12af0482004-01-31 12:34:17 +00006140
Hye-Shik Chang81268602004-02-02 06:05:24 +00006141#ifdef USE_BLUETOOTH
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006142 PyModule_AddIntMacro(m, AF_BLUETOOTH);
6143 PyModule_AddIntMacro(m, BTPROTO_L2CAP);
6144 PyModule_AddIntMacro(m, BTPROTO_HCI);
6145 PyModule_AddIntMacro(m, SOL_HCI);
Gregory P. Smith3e85dfd2010-10-17 00:43:10 +00006146#if !defined(__NetBSD__) && !defined(__DragonFly__)
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006147 PyModule_AddIntMacro(m, HCI_FILTER);
Gregory P. Smith3e85dfd2010-10-17 00:43:10 +00006148#endif
Hye-Shik Chang81268602004-02-02 06:05:24 +00006149#if !defined(__FreeBSD__)
Gregory P. Smith3e85dfd2010-10-17 00:43:10 +00006150#if !defined(__NetBSD__) && !defined(__DragonFly__)
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006151 PyModule_AddIntMacro(m, HCI_TIME_STAMP);
Gregory P. Smith3e85dfd2010-10-17 00:43:10 +00006152#endif
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006153 PyModule_AddIntMacro(m, HCI_DATA_DIR);
6154 PyModule_AddIntMacro(m, BTPROTO_SCO);
Hye-Shik Chang81268602004-02-02 06:05:24 +00006155#endif
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006156 PyModule_AddIntMacro(m, BTPROTO_RFCOMM);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006157 PyModule_AddStringConstant(m, "BDADDR_ANY", "00:00:00:00:00:00");
6158 PyModule_AddStringConstant(m, "BDADDR_LOCAL", "00:00:00:FF:FF:FF");
Martin v. Löwis12af0482004-01-31 12:34:17 +00006159#endif
6160
Charles-François Natali47413c12011-10-06 19:47:44 +02006161#ifdef AF_CAN
6162 /* Controller Area Network */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006163 PyModule_AddIntMacro(m, AF_CAN);
Charles-François Natali47413c12011-10-06 19:47:44 +02006164#endif
6165#ifdef PF_CAN
6166 /* Controller Area Network */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006167 PyModule_AddIntMacro(m, PF_CAN);
Charles-François Natali47413c12011-10-06 19:47:44 +02006168#endif
6169
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006170/* Reliable Datagram Sockets */
6171#ifdef AF_RDS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006172 PyModule_AddIntMacro(m, AF_RDS);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006173#endif
6174#ifdef PF_RDS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006175 PyModule_AddIntMacro(m, PF_RDS);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006176#endif
6177
Martin v. Löwis9d6c6692012-02-03 17:44:58 +01006178/* Kernel event messages */
6179#ifdef PF_SYSTEM
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006180 PyModule_AddIntMacro(m, PF_SYSTEM);
Martin v. Löwis9d6c6692012-02-03 17:44:58 +01006181#endif
6182#ifdef AF_SYSTEM
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006183 PyModule_AddIntMacro(m, AF_SYSTEM);
Martin v. Löwis9d6c6692012-02-03 17:44:58 +01006184#endif
6185
Antoine Pitroub156a462010-10-27 20:13:57 +00006186#ifdef AF_PACKET
6187 PyModule_AddIntMacro(m, AF_PACKET);
6188#endif
6189#ifdef PF_PACKET
6190 PyModule_AddIntMacro(m, PF_PACKET);
6191#endif
6192#ifdef PACKET_HOST
6193 PyModule_AddIntMacro(m, PACKET_HOST);
6194#endif
6195#ifdef PACKET_BROADCAST
6196 PyModule_AddIntMacro(m, PACKET_BROADCAST);
6197#endif
6198#ifdef PACKET_MULTICAST
6199 PyModule_AddIntMacro(m, PACKET_MULTICAST);
6200#endif
6201#ifdef PACKET_OTHERHOST
6202 PyModule_AddIntMacro(m, PACKET_OTHERHOST);
6203#endif
6204#ifdef PACKET_OUTGOING
6205 PyModule_AddIntMacro(m, PACKET_OUTGOING);
6206#endif
6207#ifdef PACKET_LOOPBACK
6208 PyModule_AddIntMacro(m, PACKET_LOOPBACK);
6209#endif
6210#ifdef PACKET_FASTROUTE
6211 PyModule_AddIntMacro(m, PACKET_FASTROUTE);
Guido van Rossum48a680c2001-03-02 06:34:14 +00006212#endif
Guido van Rossum09be4091999-08-09 14:40:40 +00006213
Christian Heimes043d6f62008-01-07 17:19:16 +00006214#ifdef HAVE_LINUX_TIPC_H
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006215 PyModule_AddIntMacro(m, AF_TIPC);
Christian Heimes043d6f62008-01-07 17:19:16 +00006216
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006217 /* for addresses */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006218 PyModule_AddIntMacro(m, TIPC_ADDR_NAMESEQ);
6219 PyModule_AddIntMacro(m, TIPC_ADDR_NAME);
6220 PyModule_AddIntMacro(m, TIPC_ADDR_ID);
Christian Heimes043d6f62008-01-07 17:19:16 +00006221
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006222 PyModule_AddIntMacro(m, TIPC_ZONE_SCOPE);
6223 PyModule_AddIntMacro(m, TIPC_CLUSTER_SCOPE);
6224 PyModule_AddIntMacro(m, TIPC_NODE_SCOPE);
Christian Heimes043d6f62008-01-07 17:19:16 +00006225
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006226 /* for setsockopt() */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006227 PyModule_AddIntMacro(m, SOL_TIPC);
6228 PyModule_AddIntMacro(m, TIPC_IMPORTANCE);
6229 PyModule_AddIntMacro(m, TIPC_SRC_DROPPABLE);
6230 PyModule_AddIntMacro(m, TIPC_DEST_DROPPABLE);
6231 PyModule_AddIntMacro(m, TIPC_CONN_TIMEOUT);
Christian Heimes043d6f62008-01-07 17:19:16 +00006232
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006233 PyModule_AddIntMacro(m, TIPC_LOW_IMPORTANCE);
6234 PyModule_AddIntMacro(m, TIPC_MEDIUM_IMPORTANCE);
6235 PyModule_AddIntMacro(m, TIPC_HIGH_IMPORTANCE);
6236 PyModule_AddIntMacro(m, TIPC_CRITICAL_IMPORTANCE);
Christian Heimes043d6f62008-01-07 17:19:16 +00006237
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006238 /* for subscriptions */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006239 PyModule_AddIntMacro(m, TIPC_SUB_PORTS);
6240 PyModule_AddIntMacro(m, TIPC_SUB_SERVICE);
Christian Heimes25bb7832008-01-11 16:17:00 +00006241#ifdef TIPC_SUB_CANCEL
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006242 /* doesn't seem to be available everywhere */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006243 PyModule_AddIntMacro(m, TIPC_SUB_CANCEL);
Christian Heimes25bb7832008-01-11 16:17:00 +00006244#endif
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006245 PyModule_AddIntMacro(m, TIPC_WAIT_FOREVER);
6246 PyModule_AddIntMacro(m, TIPC_PUBLISHED);
6247 PyModule_AddIntMacro(m, TIPC_WITHDRAWN);
6248 PyModule_AddIntMacro(m, TIPC_SUBSCR_TIMEOUT);
6249 PyModule_AddIntMacro(m, TIPC_CFG_SRV);
6250 PyModule_AddIntMacro(m, TIPC_TOP_SRV);
Christian Heimes043d6f62008-01-07 17:19:16 +00006251#endif
6252
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006253 /* Socket types */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006254 PyModule_AddIntMacro(m, SOCK_STREAM);
6255 PyModule_AddIntMacro(m, SOCK_DGRAM);
Guido van Rossumbcc20741998-08-04 22:53:56 +00006256/* We have incomplete socket support. */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006257 PyModule_AddIntMacro(m, SOCK_RAW);
6258 PyModule_AddIntMacro(m, SOCK_SEQPACKET);
Martin v. Löwiscf8f47e2002-12-11 13:10:57 +00006259#if defined(SOCK_RDM)
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006260 PyModule_AddIntMacro(m, SOCK_RDM);
Guido van Rossumbcc20741998-08-04 22:53:56 +00006261#endif
Antoine Pitroub1c54962010-10-14 15:05:38 +00006262#ifdef SOCK_CLOEXEC
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006263 PyModule_AddIntMacro(m, SOCK_CLOEXEC);
Antoine Pitroub1c54962010-10-14 15:05:38 +00006264#endif
6265#ifdef SOCK_NONBLOCK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006266 PyModule_AddIntMacro(m, SOCK_NONBLOCK);
Antoine Pitroub1c54962010-10-14 15:05:38 +00006267#endif
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006268
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006269#ifdef SO_DEBUG
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006270 PyModule_AddIntMacro(m, SO_DEBUG);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006271#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006272#ifdef SO_ACCEPTCONN
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006273 PyModule_AddIntMacro(m, SO_ACCEPTCONN);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006274#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006275#ifdef SO_REUSEADDR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006276 PyModule_AddIntMacro(m, SO_REUSEADDR);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006277#endif
Andrew M. Kuchling42851ab2004-07-10 14:19:21 +00006278#ifdef SO_EXCLUSIVEADDRUSE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006279 PyModule_AddIntMacro(m, SO_EXCLUSIVEADDRUSE);
Andrew M. Kuchling42851ab2004-07-10 14:19:21 +00006280#endif
6281
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006282#ifdef SO_KEEPALIVE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006283 PyModule_AddIntMacro(m, SO_KEEPALIVE);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006284#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006285#ifdef SO_DONTROUTE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006286 PyModule_AddIntMacro(m, SO_DONTROUTE);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006287#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006288#ifdef SO_BROADCAST
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006289 PyModule_AddIntMacro(m, SO_BROADCAST);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006290#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006291#ifdef SO_USELOOPBACK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006292 PyModule_AddIntMacro(m, SO_USELOOPBACK);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006293#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006294#ifdef SO_LINGER
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006295 PyModule_AddIntMacro(m, SO_LINGER);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006296#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006297#ifdef SO_OOBINLINE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006298 PyModule_AddIntMacro(m, SO_OOBINLINE);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006299#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006300#ifdef SO_REUSEPORT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006301 PyModule_AddIntMacro(m, SO_REUSEPORT);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006302#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006303#ifdef SO_SNDBUF
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006304 PyModule_AddIntMacro(m, SO_SNDBUF);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006305#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006306#ifdef SO_RCVBUF
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006307 PyModule_AddIntMacro(m, SO_RCVBUF);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006308#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006309#ifdef SO_SNDLOWAT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006310 PyModule_AddIntMacro(m, SO_SNDLOWAT);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006311#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006312#ifdef SO_RCVLOWAT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006313 PyModule_AddIntMacro(m, SO_RCVLOWAT);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006314#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006315#ifdef SO_SNDTIMEO
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006316 PyModule_AddIntMacro(m, SO_SNDTIMEO);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006317#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006318#ifdef SO_RCVTIMEO
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006319 PyModule_AddIntMacro(m, SO_RCVTIMEO);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006320#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006321#ifdef SO_ERROR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006322 PyModule_AddIntMacro(m, SO_ERROR);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006323#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006324#ifdef SO_TYPE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006325 PyModule_AddIntMacro(m, SO_TYPE);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006326#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006327#ifdef SO_SETFIB
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006328 PyModule_AddIntMacro(m, SO_SETFIB);
Larry Hastingsf0f37952010-04-02 11:47:10 +00006329#endif
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006330#ifdef SO_PASSCRED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006331 PyModule_AddIntMacro(m, SO_PASSCRED);
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006332#endif
6333#ifdef SO_PEERCRED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006334 PyModule_AddIntMacro(m, SO_PEERCRED);
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006335#endif
6336#ifdef LOCAL_PEERCRED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006337 PyModule_AddIntMacro(m, LOCAL_PEERCRED);
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006338#endif
Victor Stinnercb98bed2011-10-25 13:45:48 +02006339#ifdef SO_BINDTODEVICE
6340 PyModule_AddIntMacro(m, SO_BINDTODEVICE);
6341#endif
Benjamin Peterson1314ef72013-11-27 09:18:54 -06006342#ifdef SO_PRIORITY
6343 PyModule_AddIntMacro(m, SO_PRIORITY);
6344#endif
Charles-François Nataliea07eb92014-09-18 23:18:46 +01006345#ifdef SO_MARK
6346 PyModule_AddIntMacro(m, SO_MARK);
6347#endif
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006348
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006349 /* Maximum number of connections for "listen" */
6350#ifdef SOMAXCONN
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006351 PyModule_AddIntMacro(m, SOMAXCONN);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006352#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006353 PyModule_AddIntConstant(m, "SOMAXCONN", 5); /* Common value */
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006354#endif
6355
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006356 /* Ancilliary message types */
6357#ifdef SCM_RIGHTS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006358 PyModule_AddIntMacro(m, SCM_RIGHTS);
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006359#endif
6360#ifdef SCM_CREDENTIALS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006361 PyModule_AddIntMacro(m, SCM_CREDENTIALS);
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006362#endif
6363#ifdef SCM_CREDS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006364 PyModule_AddIntMacro(m, SCM_CREDS);
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006365#endif
6366
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006367 /* Flags for send, recv */
6368#ifdef MSG_OOB
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006369 PyModule_AddIntMacro(m, MSG_OOB);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006370#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006371#ifdef MSG_PEEK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006372 PyModule_AddIntMacro(m, MSG_PEEK);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006373#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006374#ifdef MSG_DONTROUTE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006375 PyModule_AddIntMacro(m, MSG_DONTROUTE);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006376#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006377#ifdef MSG_DONTWAIT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006378 PyModule_AddIntMacro(m, MSG_DONTWAIT);
Guido van Rossum2c8bcb82000-04-25 21:34:53 +00006379#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006380#ifdef MSG_EOR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006381 PyModule_AddIntMacro(m, MSG_EOR);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006382#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006383#ifdef MSG_TRUNC
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006384 PyModule_AddIntMacro(m, MSG_TRUNC);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006385#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006386#ifdef MSG_CTRUNC
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006387 PyModule_AddIntMacro(m, MSG_CTRUNC);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006388#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006389#ifdef MSG_WAITALL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006390 PyModule_AddIntMacro(m, MSG_WAITALL);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006391#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006392#ifdef MSG_BTAG
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006393 PyModule_AddIntMacro(m, MSG_BTAG);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006394#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006395#ifdef MSG_ETAG
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006396 PyModule_AddIntMacro(m, MSG_ETAG);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006397#endif
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006398#ifdef MSG_NOSIGNAL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006399 PyModule_AddIntMacro(m, MSG_NOSIGNAL);
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006400#endif
6401#ifdef MSG_NOTIFICATION
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006402 PyModule_AddIntMacro(m, MSG_NOTIFICATION);
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006403#endif
6404#ifdef MSG_CMSG_CLOEXEC
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006405 PyModule_AddIntMacro(m, MSG_CMSG_CLOEXEC);
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006406#endif
6407#ifdef MSG_ERRQUEUE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006408 PyModule_AddIntMacro(m, MSG_ERRQUEUE);
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006409#endif
6410#ifdef MSG_CONFIRM
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006411 PyModule_AddIntMacro(m, MSG_CONFIRM);
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006412#endif
6413#ifdef MSG_MORE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006414 PyModule_AddIntMacro(m, MSG_MORE);
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006415#endif
6416#ifdef MSG_EOF
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006417 PyModule_AddIntMacro(m, MSG_EOF);
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006418#endif
6419#ifdef MSG_BCAST
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006420 PyModule_AddIntMacro(m, MSG_BCAST);
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006421#endif
6422#ifdef MSG_MCAST
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006423 PyModule_AddIntMacro(m, MSG_MCAST);
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006424#endif
Benjamin Peterson57b66722012-12-12 22:24:47 -05006425#ifdef MSG_FASTOPEN
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006426 PyModule_AddIntMacro(m, MSG_FASTOPEN);
Benjamin Peterson57b66722012-12-12 22:24:47 -05006427#endif
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006428
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006429 /* Protocol level and numbers, usable for [gs]etsockopt */
6430#ifdef SOL_SOCKET
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006431 PyModule_AddIntMacro(m, SOL_SOCKET);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006432#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006433#ifdef SOL_IP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006434 PyModule_AddIntMacro(m, SOL_IP);
Guido van Rossum09be4091999-08-09 14:40:40 +00006435#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006436 PyModule_AddIntConstant(m, "SOL_IP", 0);
Guido van Rossum09be4091999-08-09 14:40:40 +00006437#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006438#ifdef SOL_IPX
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006439 PyModule_AddIntMacro(m, SOL_IPX);
Guido van Rossum09be4091999-08-09 14:40:40 +00006440#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006441#ifdef SOL_AX25
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006442 PyModule_AddIntMacro(m, SOL_AX25);
Guido van Rossum09be4091999-08-09 14:40:40 +00006443#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006444#ifdef SOL_ATALK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006445 PyModule_AddIntMacro(m, SOL_ATALK);
Guido van Rossum09be4091999-08-09 14:40:40 +00006446#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006447#ifdef SOL_NETROM
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006448 PyModule_AddIntMacro(m, SOL_NETROM);
Guido van Rossum09be4091999-08-09 14:40:40 +00006449#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006450#ifdef SOL_ROSE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006451 PyModule_AddIntMacro(m, SOL_ROSE);
Guido van Rossum09be4091999-08-09 14:40:40 +00006452#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006453#ifdef SOL_TCP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006454 PyModule_AddIntMacro(m, SOL_TCP);
Guido van Rossum09be4091999-08-09 14:40:40 +00006455#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006456 PyModule_AddIntConstant(m, "SOL_TCP", 6);
Guido van Rossum09be4091999-08-09 14:40:40 +00006457#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006458#ifdef SOL_UDP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006459 PyModule_AddIntMacro(m, SOL_UDP);
Guido van Rossum09be4091999-08-09 14:40:40 +00006460#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006461 PyModule_AddIntConstant(m, "SOL_UDP", 17);
Guido van Rossum09be4091999-08-09 14:40:40 +00006462#endif
Charles-François Natali47413c12011-10-06 19:47:44 +02006463#ifdef SOL_CAN_BASE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006464 PyModule_AddIntMacro(m, SOL_CAN_BASE);
Charles-François Natali47413c12011-10-06 19:47:44 +02006465#endif
6466#ifdef SOL_CAN_RAW
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006467 PyModule_AddIntMacro(m, SOL_CAN_RAW);
6468 PyModule_AddIntMacro(m, CAN_RAW);
Charles-François Natali47413c12011-10-06 19:47:44 +02006469#endif
6470#ifdef HAVE_LINUX_CAN_H
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006471 PyModule_AddIntMacro(m, CAN_EFF_FLAG);
6472 PyModule_AddIntMacro(m, CAN_RTR_FLAG);
6473 PyModule_AddIntMacro(m, CAN_ERR_FLAG);
Charles-François Natali47413c12011-10-06 19:47:44 +02006474
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006475 PyModule_AddIntMacro(m, CAN_SFF_MASK);
6476 PyModule_AddIntMacro(m, CAN_EFF_MASK);
6477 PyModule_AddIntMacro(m, CAN_ERR_MASK);
Charles-François Natali47413c12011-10-06 19:47:44 +02006478#endif
6479#ifdef HAVE_LINUX_CAN_RAW_H
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006480 PyModule_AddIntMacro(m, CAN_RAW_FILTER);
6481 PyModule_AddIntMacro(m, CAN_RAW_ERR_FILTER);
6482 PyModule_AddIntMacro(m, CAN_RAW_LOOPBACK);
6483 PyModule_AddIntMacro(m, CAN_RAW_RECV_OWN_MSGS);
Charles-François Natali47413c12011-10-06 19:47:44 +02006484#endif
Charles-François Natali773e42d2013-02-05 19:42:01 +01006485#ifdef HAVE_LINUX_CAN_BCM_H
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006486 PyModule_AddIntMacro(m, CAN_BCM);
Charles-François Natali773e42d2013-02-05 19:42:01 +01006487 PyModule_AddIntConstant(m, "CAN_BCM_TX_SETUP", TX_SETUP);
6488 PyModule_AddIntConstant(m, "CAN_BCM_TX_DELETE", TX_DELETE);
6489 PyModule_AddIntConstant(m, "CAN_BCM_TX_READ", TX_READ);
6490 PyModule_AddIntConstant(m, "CAN_BCM_TX_SEND", TX_SEND);
6491 PyModule_AddIntConstant(m, "CAN_BCM_RX_SETUP", RX_SETUP);
6492 PyModule_AddIntConstant(m, "CAN_BCM_RX_DELETE", RX_DELETE);
6493 PyModule_AddIntConstant(m, "CAN_BCM_RX_READ", RX_READ);
6494 PyModule_AddIntConstant(m, "CAN_BCM_TX_STATUS", TX_STATUS);
6495 PyModule_AddIntConstant(m, "CAN_BCM_TX_EXPIRED", TX_EXPIRED);
6496 PyModule_AddIntConstant(m, "CAN_BCM_RX_STATUS", RX_STATUS);
6497 PyModule_AddIntConstant(m, "CAN_BCM_RX_TIMEOUT", RX_TIMEOUT);
6498 PyModule_AddIntConstant(m, "CAN_BCM_RX_CHANGED", RX_CHANGED);
6499#endif
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006500#ifdef SOL_RDS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006501 PyModule_AddIntMacro(m, SOL_RDS);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006502#endif
6503#ifdef RDS_CANCEL_SENT_TO
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006504 PyModule_AddIntMacro(m, RDS_CANCEL_SENT_TO);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006505#endif
6506#ifdef RDS_GET_MR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006507 PyModule_AddIntMacro(m, RDS_GET_MR);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006508#endif
6509#ifdef RDS_FREE_MR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006510 PyModule_AddIntMacro(m, RDS_FREE_MR);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006511#endif
6512#ifdef RDS_RECVERR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006513 PyModule_AddIntMacro(m, RDS_RECVERR);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006514#endif
6515#ifdef RDS_CONG_MONITOR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006516 PyModule_AddIntMacro(m, RDS_CONG_MONITOR);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006517#endif
6518#ifdef RDS_GET_MR_FOR_DEST
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006519 PyModule_AddIntMacro(m, RDS_GET_MR_FOR_DEST);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006520#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006521#ifdef IPPROTO_IP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006522 PyModule_AddIntMacro(m, IPPROTO_IP);
Guido van Rossum578de301998-05-28 20:18:18 +00006523#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006524 PyModule_AddIntConstant(m, "IPPROTO_IP", 0);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006525#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006526#ifdef IPPROTO_HOPOPTS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006527 PyModule_AddIntMacro(m, IPPROTO_HOPOPTS);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006528#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006529#ifdef IPPROTO_ICMP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006530 PyModule_AddIntMacro(m, IPPROTO_ICMP);
Guido van Rossum578de301998-05-28 20:18:18 +00006531#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006532 PyModule_AddIntConstant(m, "IPPROTO_ICMP", 1);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006533#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006534#ifdef IPPROTO_IGMP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006535 PyModule_AddIntMacro(m, IPPROTO_IGMP);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006536#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006537#ifdef IPPROTO_GGP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006538 PyModule_AddIntMacro(m, IPPROTO_GGP);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006539#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006540#ifdef IPPROTO_IPV4
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006541 PyModule_AddIntMacro(m, IPPROTO_IPV4);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006542#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006543#ifdef IPPROTO_IPV6
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006544 PyModule_AddIntMacro(m, IPPROTO_IPV6);
Martin v. Löwisa0f17342003-10-03 13:56:20 +00006545#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006546#ifdef IPPROTO_IPIP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006547 PyModule_AddIntMacro(m, IPPROTO_IPIP);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006548#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006549#ifdef IPPROTO_TCP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006550 PyModule_AddIntMacro(m, IPPROTO_TCP);
Guido van Rossum578de301998-05-28 20:18:18 +00006551#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006552 PyModule_AddIntConstant(m, "IPPROTO_TCP", 6);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006553#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006554#ifdef IPPROTO_EGP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006555 PyModule_AddIntMacro(m, IPPROTO_EGP);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006556#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006557#ifdef IPPROTO_PUP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006558 PyModule_AddIntMacro(m, IPPROTO_PUP);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006559#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006560#ifdef IPPROTO_UDP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006561 PyModule_AddIntMacro(m, IPPROTO_UDP);
Guido van Rossum578de301998-05-28 20:18:18 +00006562#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006563 PyModule_AddIntConstant(m, "IPPROTO_UDP", 17);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006564#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006565#ifdef IPPROTO_IDP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006566 PyModule_AddIntMacro(m, IPPROTO_IDP);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006567#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006568#ifdef IPPROTO_HELLO
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006569 PyModule_AddIntMacro(m, IPPROTO_HELLO);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006570#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006571#ifdef IPPROTO_ND
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006572 PyModule_AddIntMacro(m, IPPROTO_ND);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006573#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006574#ifdef IPPROTO_TP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006575 PyModule_AddIntMacro(m, IPPROTO_TP);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006576#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006577#ifdef IPPROTO_IPV6
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006578 PyModule_AddIntMacro(m, IPPROTO_IPV6);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006579#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006580#ifdef IPPROTO_ROUTING
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006581 PyModule_AddIntMacro(m, IPPROTO_ROUTING);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006582#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006583#ifdef IPPROTO_FRAGMENT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006584 PyModule_AddIntMacro(m, IPPROTO_FRAGMENT);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006585#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006586#ifdef IPPROTO_RSVP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006587 PyModule_AddIntMacro(m, IPPROTO_RSVP);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006588#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006589#ifdef IPPROTO_GRE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006590 PyModule_AddIntMacro(m, IPPROTO_GRE);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006591#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006592#ifdef IPPROTO_ESP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006593 PyModule_AddIntMacro(m, IPPROTO_ESP);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006594#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006595#ifdef IPPROTO_AH
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006596 PyModule_AddIntMacro(m, IPPROTO_AH);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006597#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006598#ifdef IPPROTO_MOBILE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006599 PyModule_AddIntMacro(m, IPPROTO_MOBILE);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006600#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006601#ifdef IPPROTO_ICMPV6
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006602 PyModule_AddIntMacro(m, IPPROTO_ICMPV6);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006603#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006604#ifdef IPPROTO_NONE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006605 PyModule_AddIntMacro(m, IPPROTO_NONE);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006606#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006607#ifdef IPPROTO_DSTOPTS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006608 PyModule_AddIntMacro(m, IPPROTO_DSTOPTS);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006609#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006610#ifdef IPPROTO_XTP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006611 PyModule_AddIntMacro(m, IPPROTO_XTP);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006612#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006613#ifdef IPPROTO_EON
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006614 PyModule_AddIntMacro(m, IPPROTO_EON);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006615#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006616#ifdef IPPROTO_PIM
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006617 PyModule_AddIntMacro(m, IPPROTO_PIM);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006618#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006619#ifdef IPPROTO_IPCOMP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006620 PyModule_AddIntMacro(m, IPPROTO_IPCOMP);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006621#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006622#ifdef IPPROTO_VRRP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006623 PyModule_AddIntMacro(m, IPPROTO_VRRP);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006624#endif
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006625#ifdef IPPROTO_SCTP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006626 PyModule_AddIntMacro(m, IPPROTO_SCTP);
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006627#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006628#ifdef IPPROTO_BIP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006629 PyModule_AddIntMacro(m, IPPROTO_BIP);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006630#endif
6631/**/
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006632#ifdef IPPROTO_RAW
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006633 PyModule_AddIntMacro(m, IPPROTO_RAW);
Guido van Rossum578de301998-05-28 20:18:18 +00006634#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006635 PyModule_AddIntConstant(m, "IPPROTO_RAW", 255);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006636#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006637#ifdef IPPROTO_MAX
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006638 PyModule_AddIntMacro(m, IPPROTO_MAX);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006639#endif
6640
Martin v. Löwis9d6c6692012-02-03 17:44:58 +01006641#ifdef SYSPROTO_CONTROL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006642 PyModule_AddIntMacro(m, SYSPROTO_CONTROL);
Martin v. Löwis9d6c6692012-02-03 17:44:58 +01006643#endif
6644
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006645 /* Some port configuration */
6646#ifdef IPPORT_RESERVED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006647 PyModule_AddIntMacro(m, IPPORT_RESERVED);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006648#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006649 PyModule_AddIntConstant(m, "IPPORT_RESERVED", 1024);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006650#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006651#ifdef IPPORT_USERRESERVED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006652 PyModule_AddIntMacro(m, IPPORT_USERRESERVED);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006653#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006654 PyModule_AddIntConstant(m, "IPPORT_USERRESERVED", 5000);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006655#endif
6656
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006657 /* Some reserved IP v.4 addresses */
6658#ifdef INADDR_ANY
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006659 PyModule_AddIntMacro(m, INADDR_ANY);
Guido van Rossum5f05eb41995-02-17 15:11:07 +00006660#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006661 PyModule_AddIntConstant(m, "INADDR_ANY", 0x00000000);
Guido van Rossum5f05eb41995-02-17 15:11:07 +00006662#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006663#ifdef INADDR_BROADCAST
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006664 PyModule_AddIntMacro(m, INADDR_BROADCAST);
Guido van Rossum5f05eb41995-02-17 15:11:07 +00006665#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006666 PyModule_AddIntConstant(m, "INADDR_BROADCAST", 0xffffffff);
Guido van Rossum5f05eb41995-02-17 15:11:07 +00006667#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006668#ifdef INADDR_LOOPBACK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006669 PyModule_AddIntMacro(m, INADDR_LOOPBACK);
Guido van Rossum5f05eb41995-02-17 15:11:07 +00006670#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006671 PyModule_AddIntConstant(m, "INADDR_LOOPBACK", 0x7F000001);
Guido van Rossum5f05eb41995-02-17 15:11:07 +00006672#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006673#ifdef INADDR_UNSPEC_GROUP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006674 PyModule_AddIntMacro(m, INADDR_UNSPEC_GROUP);
Guido van Rossum5f05eb41995-02-17 15:11:07 +00006675#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006676 PyModule_AddIntConstant(m, "INADDR_UNSPEC_GROUP", 0xe0000000);
Guido van Rossum5f05eb41995-02-17 15:11:07 +00006677#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006678#ifdef INADDR_ALLHOSTS_GROUP
6679 PyModule_AddIntConstant(m, "INADDR_ALLHOSTS_GROUP",
6680 INADDR_ALLHOSTS_GROUP);
Guido van Rossum5f05eb41995-02-17 15:11:07 +00006681#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006682 PyModule_AddIntConstant(m, "INADDR_ALLHOSTS_GROUP", 0xe0000001);
Guido van Rossum5f05eb41995-02-17 15:11:07 +00006683#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006684#ifdef INADDR_MAX_LOCAL_GROUP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006685 PyModule_AddIntMacro(m, INADDR_MAX_LOCAL_GROUP);
Guido van Rossum5f05eb41995-02-17 15:11:07 +00006686#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006687 PyModule_AddIntConstant(m, "INADDR_MAX_LOCAL_GROUP", 0xe00000ff);
Guido van Rossum5f05eb41995-02-17 15:11:07 +00006688#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006689#ifdef INADDR_NONE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006690 PyModule_AddIntMacro(m, INADDR_NONE);
Guido van Rossum5f05eb41995-02-17 15:11:07 +00006691#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006692 PyModule_AddIntConstant(m, "INADDR_NONE", 0xffffffff);
Guido van Rossum5f05eb41995-02-17 15:11:07 +00006693#endif
6694
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006695 /* IPv4 [gs]etsockopt options */
6696#ifdef IP_OPTIONS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006697 PyModule_AddIntMacro(m, IP_OPTIONS);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006698#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006699#ifdef IP_HDRINCL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006700 PyModule_AddIntMacro(m, IP_HDRINCL);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006701#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006702#ifdef IP_TOS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006703 PyModule_AddIntMacro(m, IP_TOS);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006704#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006705#ifdef IP_TTL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006706 PyModule_AddIntMacro(m, IP_TTL);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006707#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006708#ifdef IP_RECVOPTS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006709 PyModule_AddIntMacro(m, IP_RECVOPTS);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006710#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006711#ifdef IP_RECVRETOPTS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006712 PyModule_AddIntMacro(m, IP_RECVRETOPTS);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006713#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006714#ifdef IP_RECVDSTADDR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006715 PyModule_AddIntMacro(m, IP_RECVDSTADDR);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006716#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006717#ifdef IP_RETOPTS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006718 PyModule_AddIntMacro(m, IP_RETOPTS);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006719#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006720#ifdef IP_MULTICAST_IF
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006721 PyModule_AddIntMacro(m, IP_MULTICAST_IF);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006722#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006723#ifdef IP_MULTICAST_TTL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006724 PyModule_AddIntMacro(m, IP_MULTICAST_TTL);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006725#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006726#ifdef IP_MULTICAST_LOOP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006727 PyModule_AddIntMacro(m, IP_MULTICAST_LOOP);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006728#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006729#ifdef IP_ADD_MEMBERSHIP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006730 PyModule_AddIntMacro(m, IP_ADD_MEMBERSHIP);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006731#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006732#ifdef IP_DROP_MEMBERSHIP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006733 PyModule_AddIntMacro(m, IP_DROP_MEMBERSHIP);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006734#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006735#ifdef IP_DEFAULT_MULTICAST_TTL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006736 PyModule_AddIntMacro(m, IP_DEFAULT_MULTICAST_TTL);
Guido van Rossum09be4091999-08-09 14:40:40 +00006737#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006738#ifdef IP_DEFAULT_MULTICAST_LOOP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006739 PyModule_AddIntMacro(m, IP_DEFAULT_MULTICAST_LOOP);
Guido van Rossum09be4091999-08-09 14:40:40 +00006740#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006741#ifdef IP_MAX_MEMBERSHIPS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006742 PyModule_AddIntMacro(m, IP_MAX_MEMBERSHIPS);
Guido van Rossum09be4091999-08-09 14:40:40 +00006743#endif
Charles-François Natali564a42c2011-12-17 14:59:56 +01006744#ifdef IP_TRANSPARENT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006745 PyModule_AddIntMacro(m, IP_TRANSPARENT);
Charles-François Natali564a42c2011-12-17 14:59:56 +01006746#endif
Guido van Rossum09be4091999-08-09 14:40:40 +00006747
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006748 /* IPv6 [gs]etsockopt options, defined in RFC2553 */
6749#ifdef IPV6_JOIN_GROUP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006750 PyModule_AddIntMacro(m, IPV6_JOIN_GROUP);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006751#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006752#ifdef IPV6_LEAVE_GROUP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006753 PyModule_AddIntMacro(m, IPV6_LEAVE_GROUP);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006754#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006755#ifdef IPV6_MULTICAST_HOPS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006756 PyModule_AddIntMacro(m, IPV6_MULTICAST_HOPS);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006757#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006758#ifdef IPV6_MULTICAST_IF
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006759 PyModule_AddIntMacro(m, IPV6_MULTICAST_IF);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006760#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006761#ifdef IPV6_MULTICAST_LOOP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006762 PyModule_AddIntMacro(m, IPV6_MULTICAST_LOOP);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006763#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006764#ifdef IPV6_UNICAST_HOPS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006765 PyModule_AddIntMacro(m, IPV6_UNICAST_HOPS);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006766#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006767 /* Additional IPV6 socket options, defined in RFC 3493 */
Martin v. Löwisda91d022003-12-30 11:14:01 +00006768#ifdef IPV6_V6ONLY
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006769 PyModule_AddIntMacro(m, IPV6_V6ONLY);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006770#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006771 /* Advanced IPV6 socket options, from RFC 3542 */
Martin v. Löwisda91d022003-12-30 11:14:01 +00006772#ifdef IPV6_CHECKSUM
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006773 PyModule_AddIntMacro(m, IPV6_CHECKSUM);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006774#endif
6775#ifdef IPV6_DONTFRAG
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006776 PyModule_AddIntMacro(m, IPV6_DONTFRAG);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006777#endif
6778#ifdef IPV6_DSTOPTS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006779 PyModule_AddIntMacro(m, IPV6_DSTOPTS);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006780#endif
6781#ifdef IPV6_HOPLIMIT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006782 PyModule_AddIntMacro(m, IPV6_HOPLIMIT);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006783#endif
6784#ifdef IPV6_HOPOPTS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006785 PyModule_AddIntMacro(m, IPV6_HOPOPTS);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006786#endif
6787#ifdef IPV6_NEXTHOP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006788 PyModule_AddIntMacro(m, IPV6_NEXTHOP);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006789#endif
6790#ifdef IPV6_PATHMTU
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006791 PyModule_AddIntMacro(m, IPV6_PATHMTU);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006792#endif
6793#ifdef IPV6_PKTINFO
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006794 PyModule_AddIntMacro(m, IPV6_PKTINFO);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006795#endif
6796#ifdef IPV6_RECVDSTOPTS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006797 PyModule_AddIntMacro(m, IPV6_RECVDSTOPTS);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006798#endif
6799#ifdef IPV6_RECVHOPLIMIT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006800 PyModule_AddIntMacro(m, IPV6_RECVHOPLIMIT);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006801#endif
6802#ifdef IPV6_RECVHOPOPTS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006803 PyModule_AddIntMacro(m, IPV6_RECVHOPOPTS);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006804#endif
6805#ifdef IPV6_RECVPKTINFO
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006806 PyModule_AddIntMacro(m, IPV6_RECVPKTINFO);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006807#endif
6808#ifdef IPV6_RECVRTHDR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006809 PyModule_AddIntMacro(m, IPV6_RECVRTHDR);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006810#endif
6811#ifdef IPV6_RECVTCLASS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006812 PyModule_AddIntMacro(m, IPV6_RECVTCLASS);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006813#endif
6814#ifdef IPV6_RTHDR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006815 PyModule_AddIntMacro(m, IPV6_RTHDR);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006816#endif
6817#ifdef IPV6_RTHDRDSTOPTS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006818 PyModule_AddIntMacro(m, IPV6_RTHDRDSTOPTS);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006819#endif
6820#ifdef IPV6_RTHDR_TYPE_0
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006821 PyModule_AddIntMacro(m, IPV6_RTHDR_TYPE_0);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006822#endif
6823#ifdef IPV6_RECVPATHMTU
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006824 PyModule_AddIntMacro(m, IPV6_RECVPATHMTU);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006825#endif
6826#ifdef IPV6_TCLASS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006827 PyModule_AddIntMacro(m, IPV6_TCLASS);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006828#endif
6829#ifdef IPV6_USE_MIN_MTU
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006830 PyModule_AddIntMacro(m, IPV6_USE_MIN_MTU);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006831#endif
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006832
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006833 /* TCP options */
6834#ifdef TCP_NODELAY
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006835 PyModule_AddIntMacro(m, TCP_NODELAY);
Guido van Rossum09be4091999-08-09 14:40:40 +00006836#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006837#ifdef TCP_MAXSEG
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006838 PyModule_AddIntMacro(m, TCP_MAXSEG);
Guido van Rossum09be4091999-08-09 14:40:40 +00006839#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006840#ifdef TCP_CORK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006841 PyModule_AddIntMacro(m, TCP_CORK);
Martin v. Löwis3cde2cb2001-12-22 15:05:32 +00006842#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006843#ifdef TCP_KEEPIDLE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006844 PyModule_AddIntMacro(m, TCP_KEEPIDLE);
Martin v. Löwis3cde2cb2001-12-22 15:05:32 +00006845#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006846#ifdef TCP_KEEPINTVL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006847 PyModule_AddIntMacro(m, TCP_KEEPINTVL);
Martin v. Löwis3cde2cb2001-12-22 15:05:32 +00006848#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006849#ifdef TCP_KEEPCNT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006850 PyModule_AddIntMacro(m, TCP_KEEPCNT);
Martin v. Löwis3cde2cb2001-12-22 15:05:32 +00006851#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006852#ifdef TCP_SYNCNT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006853 PyModule_AddIntMacro(m, TCP_SYNCNT);
Martin v. Löwis3cde2cb2001-12-22 15:05:32 +00006854#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006855#ifdef TCP_LINGER2
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006856 PyModule_AddIntMacro(m, TCP_LINGER2);
Martin v. Löwis3cde2cb2001-12-22 15:05:32 +00006857#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006858#ifdef TCP_DEFER_ACCEPT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006859 PyModule_AddIntMacro(m, TCP_DEFER_ACCEPT);
Martin v. Löwis3cde2cb2001-12-22 15:05:32 +00006860#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006861#ifdef TCP_WINDOW_CLAMP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006862 PyModule_AddIntMacro(m, TCP_WINDOW_CLAMP);
Martin v. Löwis3cde2cb2001-12-22 15:05:32 +00006863#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006864#ifdef TCP_INFO
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006865 PyModule_AddIntMacro(m, TCP_INFO);
Martin v. Löwis3cde2cb2001-12-22 15:05:32 +00006866#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006867#ifdef TCP_QUICKACK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006868 PyModule_AddIntMacro(m, TCP_QUICKACK);
Martin v. Löwis3cde2cb2001-12-22 15:05:32 +00006869#endif
Benjamin Peterson57b66722012-12-12 22:24:47 -05006870#ifdef TCP_FASTOPEN
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006871 PyModule_AddIntMacro(m, TCP_FASTOPEN);
Benjamin Peterson57b66722012-12-12 22:24:47 -05006872#endif
Guido van Rossum09be4091999-08-09 14:40:40 +00006873
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006874 /* IPX options */
6875#ifdef IPX_TYPE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006876 PyModule_AddIntMacro(m, IPX_TYPE);
Guido van Rossum09be4091999-08-09 14:40:40 +00006877#endif
Guido van Rossum4f199ea1998-04-09 20:56:35 +00006878
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006879/* Reliable Datagram Sockets */
6880#ifdef RDS_CMSG_RDMA_ARGS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006881 PyModule_AddIntMacro(m, RDS_CMSG_RDMA_ARGS);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006882#endif
6883#ifdef RDS_CMSG_RDMA_DEST
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006884 PyModule_AddIntMacro(m, RDS_CMSG_RDMA_DEST);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006885#endif
6886#ifdef RDS_CMSG_RDMA_MAP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006887 PyModule_AddIntMacro(m, RDS_CMSG_RDMA_MAP);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006888#endif
6889#ifdef RDS_CMSG_RDMA_STATUS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006890 PyModule_AddIntMacro(m, RDS_CMSG_RDMA_STATUS);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006891#endif
6892#ifdef RDS_CMSG_RDMA_UPDATE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006893 PyModule_AddIntMacro(m, RDS_CMSG_RDMA_UPDATE);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006894#endif
6895#ifdef RDS_RDMA_READWRITE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006896 PyModule_AddIntMacro(m, RDS_RDMA_READWRITE);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006897#endif
6898#ifdef RDS_RDMA_FENCE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006899 PyModule_AddIntMacro(m, RDS_RDMA_FENCE);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006900#endif
6901#ifdef RDS_RDMA_INVALIDATE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006902 PyModule_AddIntMacro(m, RDS_RDMA_INVALIDATE);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006903#endif
6904#ifdef RDS_RDMA_USE_ONCE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006905 PyModule_AddIntMacro(m, RDS_RDMA_USE_ONCE);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006906#endif
6907#ifdef RDS_RDMA_DONTWAIT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006908 PyModule_AddIntMacro(m, RDS_RDMA_DONTWAIT);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006909#endif
6910#ifdef RDS_RDMA_NOTIFY_ME
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006911 PyModule_AddIntMacro(m, RDS_RDMA_NOTIFY_ME);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006912#endif
6913#ifdef RDS_RDMA_SILENT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006914 PyModule_AddIntMacro(m, RDS_RDMA_SILENT);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006915#endif
6916
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006917 /* get{addr,name}info parameters */
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006918#ifdef EAI_ADDRFAMILY
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006919 PyModule_AddIntMacro(m, EAI_ADDRFAMILY);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006920#endif
6921#ifdef EAI_AGAIN
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006922 PyModule_AddIntMacro(m, EAI_AGAIN);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006923#endif
6924#ifdef EAI_BADFLAGS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006925 PyModule_AddIntMacro(m, EAI_BADFLAGS);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006926#endif
6927#ifdef EAI_FAIL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006928 PyModule_AddIntMacro(m, EAI_FAIL);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006929#endif
6930#ifdef EAI_FAMILY
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006931 PyModule_AddIntMacro(m, EAI_FAMILY);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006932#endif
6933#ifdef EAI_MEMORY
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006934 PyModule_AddIntMacro(m, EAI_MEMORY);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006935#endif
6936#ifdef EAI_NODATA
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006937 PyModule_AddIntMacro(m, EAI_NODATA);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006938#endif
6939#ifdef EAI_NONAME
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006940 PyModule_AddIntMacro(m, EAI_NONAME);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006941#endif
Martin v. Löwisda91d022003-12-30 11:14:01 +00006942#ifdef EAI_OVERFLOW
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006943 PyModule_AddIntMacro(m, EAI_OVERFLOW);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006944#endif
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006945#ifdef EAI_SERVICE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006946 PyModule_AddIntMacro(m, EAI_SERVICE);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006947#endif
6948#ifdef EAI_SOCKTYPE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006949 PyModule_AddIntMacro(m, EAI_SOCKTYPE);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006950#endif
6951#ifdef EAI_SYSTEM
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006952 PyModule_AddIntMacro(m, EAI_SYSTEM);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006953#endif
6954#ifdef EAI_BADHINTS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006955 PyModule_AddIntMacro(m, EAI_BADHINTS);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006956#endif
6957#ifdef EAI_PROTOCOL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006958 PyModule_AddIntMacro(m, EAI_PROTOCOL);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006959#endif
6960#ifdef EAI_MAX
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006961 PyModule_AddIntMacro(m, EAI_MAX);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006962#endif
6963#ifdef AI_PASSIVE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006964 PyModule_AddIntMacro(m, AI_PASSIVE);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006965#endif
6966#ifdef AI_CANONNAME
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006967 PyModule_AddIntMacro(m, AI_CANONNAME);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006968#endif
6969#ifdef AI_NUMERICHOST
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006970 PyModule_AddIntMacro(m, AI_NUMERICHOST);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006971#endif
Martin v. Löwisda91d022003-12-30 11:14:01 +00006972#ifdef AI_NUMERICSERV
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006973 PyModule_AddIntMacro(m, AI_NUMERICSERV);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006974#endif
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006975#ifdef AI_MASK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006976 PyModule_AddIntMacro(m, AI_MASK);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006977#endif
6978#ifdef AI_ALL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006979 PyModule_AddIntMacro(m, AI_ALL);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006980#endif
6981#ifdef AI_V4MAPPED_CFG
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006982 PyModule_AddIntMacro(m, AI_V4MAPPED_CFG);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006983#endif
6984#ifdef AI_ADDRCONFIG
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006985 PyModule_AddIntMacro(m, AI_ADDRCONFIG);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006986#endif
6987#ifdef AI_V4MAPPED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006988 PyModule_AddIntMacro(m, AI_V4MAPPED);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006989#endif
6990#ifdef AI_DEFAULT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006991 PyModule_AddIntMacro(m, AI_DEFAULT);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006992#endif
6993#ifdef NI_MAXHOST
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006994 PyModule_AddIntMacro(m, NI_MAXHOST);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006995#endif
6996#ifdef NI_MAXSERV
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006997 PyModule_AddIntMacro(m, NI_MAXSERV);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006998#endif
6999#ifdef NI_NOFQDN
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007000 PyModule_AddIntMacro(m, NI_NOFQDN);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00007001#endif
7002#ifdef NI_NUMERICHOST
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007003 PyModule_AddIntMacro(m, NI_NUMERICHOST);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00007004#endif
7005#ifdef NI_NAMEREQD
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007006 PyModule_AddIntMacro(m, NI_NAMEREQD);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00007007#endif
7008#ifdef NI_NUMERICSERV
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007009 PyModule_AddIntMacro(m, NI_NUMERICSERV);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00007010#endif
7011#ifdef NI_DGRAM
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007012 PyModule_AddIntMacro(m, NI_DGRAM);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00007013#endif
7014
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00007015 /* shutdown() parameters */
Martin v. Löwis94681fc2003-11-27 19:40:22 +00007016#ifdef SHUT_RD
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007017 PyModule_AddIntMacro(m, SHUT_RD);
Martin v. Löwis94681fc2003-11-27 19:40:22 +00007018#elif defined(SD_RECEIVE)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00007019 PyModule_AddIntConstant(m, "SHUT_RD", SD_RECEIVE);
Martin v. Löwis94681fc2003-11-27 19:40:22 +00007020#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00007021 PyModule_AddIntConstant(m, "SHUT_RD", 0);
Martin v. Löwis94681fc2003-11-27 19:40:22 +00007022#endif
7023#ifdef SHUT_WR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007024 PyModule_AddIntMacro(m, SHUT_WR);
Martin v. Löwis94681fc2003-11-27 19:40:22 +00007025#elif defined(SD_SEND)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00007026 PyModule_AddIntConstant(m, "SHUT_WR", SD_SEND);
Martin v. Löwis94681fc2003-11-27 19:40:22 +00007027#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00007028 PyModule_AddIntConstant(m, "SHUT_WR", 1);
Martin v. Löwis94681fc2003-11-27 19:40:22 +00007029#endif
7030#ifdef SHUT_RDWR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007031 PyModule_AddIntMacro(m, SHUT_RDWR);
Martin v. Löwis94681fc2003-11-27 19:40:22 +00007032#elif defined(SD_BOTH)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00007033 PyModule_AddIntConstant(m, "SHUT_RDWR", SD_BOTH);
Martin v. Löwis94681fc2003-11-27 19:40:22 +00007034#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00007035 PyModule_AddIntConstant(m, "SHUT_RDWR", 2);
Martin v. Löwis94681fc2003-11-27 19:40:22 +00007036#endif
7037
Christian Heimesfaf2f632008-01-06 16:59:19 +00007038#ifdef SIO_RCVALL
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00007039 {
7040 DWORD codes[] = {SIO_RCVALL, SIO_KEEPALIVE_VALS};
7041 const char *names[] = {"SIO_RCVALL", "SIO_KEEPALIVE_VALS"};
7042 int i;
Victor Stinner63941882011-09-29 00:42:28 +02007043 for(i = 0; i<Py_ARRAY_LENGTH(codes); ++i) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00007044 PyObject *tmp;
7045 tmp = PyLong_FromUnsignedLong(codes[i]);
7046 if (tmp == NULL)
7047 return NULL;
7048 PyModule_AddObject(m, names[i], tmp);
7049 }
7050 }
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007051 PyModule_AddIntMacro(m, RCVALL_OFF);
7052 PyModule_AddIntMacro(m, RCVALL_ON);
7053 PyModule_AddIntMacro(m, RCVALL_SOCKETLEVELONLY);
Amaury Forgeot d'Arc762681b2008-06-12 23:03:41 +00007054#ifdef RCVALL_IPLEVEL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007055 PyModule_AddIntMacro(m, RCVALL_IPLEVEL);
Amaury Forgeot d'Arc762681b2008-06-12 23:03:41 +00007056#endif
7057#ifdef RCVALL_MAX
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007058 PyModule_AddIntMacro(m, RCVALL_MAX);
Amaury Forgeot d'Arc762681b2008-06-12 23:03:41 +00007059#endif
Christian Heimesfaf2f632008-01-06 16:59:19 +00007060#endif /* _MSTCPIP_ */
7061
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00007062 /* Initialize gethostbyname lock */
Just van Rossum1040d2c2003-05-09 07:53:18 +00007063#if defined(USE_GETHOSTBYNAME_LOCK) || defined(USE_GETADDRINFO_LOCK)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00007064 netdb_lock = PyThread_allocate_lock();
Guido van Rossum4f199ea1998-04-09 20:56:35 +00007065#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00007066 return m;
Guido van Rossum6574b3e1991-06-25 21:36:08 +00007067}
Martin v. Löwisb9ab1592001-06-24 21:18:26 +00007068
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00007069
Martin v. Löwisb9ab1592001-06-24 21:18:26 +00007070#ifndef HAVE_INET_PTON
Christian Heimes96e7b3d2007-11-20 06:51:17 +00007071#if !defined(NTDDI_VERSION) || (NTDDI_VERSION < NTDDI_LONGHORN)
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00007072
7073/* Simplistic emulation code for inet_pton that only works for IPv4 */
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00007074/* These are not exposed because they do not set errno properly */
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00007075
Guido van Rossum3eede5a2002-06-07 02:08:35 +00007076int
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00007077inet_pton(int af, const char *src, void *dst)
Martin v. Löwisb9ab1592001-06-24 21:18:26 +00007078{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00007079 if (af == AF_INET) {
Benjamin Petersonf91df042009-02-13 02:50:59 +00007080#if (SIZEOF_INT != 4)
7081#error "Not sure if in_addr_t exists and int is not 32-bits."
7082#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00007083 unsigned int packed_addr;
7084 packed_addr = inet_addr(src);
7085 if (packed_addr == INADDR_NONE)
7086 return 0;
7087 memcpy(dst, &packed_addr, 4);
7088 return 1;
7089 }
7090 /* Should set errno to EAFNOSUPPORT */
7091 return -1;
Martin v. Löwisb9ab1592001-06-24 21:18:26 +00007092}
7093
Martin v. Löwisc925b1532001-07-21 09:42:15 +00007094const char *
7095inet_ntop(int af, const void *src, char *dst, socklen_t size)
Martin v. Löwisb9ab1592001-06-24 21:18:26 +00007096{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00007097 if (af == AF_INET) {
7098 struct in_addr packed_addr;
7099 if (size < 16)
7100 /* Should set errno to ENOSPC. */
7101 return NULL;
7102 memcpy(&packed_addr, src, sizeof(packed_addr));
7103 return strncpy(dst, inet_ntoa(packed_addr), size);
7104 }
7105 /* Should set errno to EAFNOSUPPORT */
7106 return NULL;
Martin v. Löwisb9ab1592001-06-24 21:18:26 +00007107}
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00007108
Martin v. Löwisb9ab1592001-06-24 21:18:26 +00007109#endif
Christian Heimesb6150692007-11-15 23:37:07 +00007110#endif