blob: ab3e913dbc80aabc1d995a84eb51eae206509548 [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
2464 int res, err, in_progress, timeout;
Guido van Rossum7b8bac12002-06-13 16:07:04 +00002465
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002466 timeout = 0;
Victor Stinnerb7df3142015-03-27 22:59:32 +01002467
2468 Py_BEGIN_ALLOW_THREADS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002469 res = connect(s->sock_fd, addr, addrlen);
Victor Stinnerb7df3142015-03-27 22:59:32 +01002470 Py_END_ALLOW_THREADS
2471
Victor Stinnerdd88d3d2015-03-31 16:08:22 +02002472 if (res < 0)
Victor Stinnerb6c15bc2015-03-31 16:35:35 +02002473 err = GET_ERROR;
Victor Stinnerdd88d3d2015-03-31 16:08:22 +02002474 else
2475 err = res;
Victor Stinnerb6c15bc2015-03-31 16:35:35 +02002476 in_progress = (err == IN_PROGRESS_ERR);
Victor Stinnerdd88d3d2015-03-31 16:08:22 +02002477
Victor Stinnerb6c15bc2015-03-31 16:35:35 +02002478 if (s->sock_timeout > 0 && in_progress && IS_SELECTABLE(s)) {
Victor Stinnere6951c62015-03-31 13:50:44 +02002479 timeout = internal_connect_select(s);
Victor Stinnerb7df3142015-03-27 22:59:32 +01002480
Victor Stinnerb6c15bc2015-03-31 16:35:35 +02002481 if (timeout == 1) {
2482 /* timed out */
2483 err = TIMEOUT_ERR;
2484 }
2485 else if (timeout == 0) {
Victor Stinnerb7df3142015-03-27 22:59:32 +01002486 socklen_t res_size = sizeof res;
Victor Stinnerb6c15bc2015-03-31 16:35:35 +02002487 if (!getsockopt(s->sock_fd, SOL_SOCKET, SO_ERROR,
2488 (char*)&res, &res_size)) {
Victor Stinnerdd88d3d2015-03-31 16:08:22 +02002489 if (res == EISCONN)
2490 res = 0;
2491 err = res;
2492 }
2493 else {
2494 /* getsockopt() failed */
Victor Stinnerb6c15bc2015-03-31 16:35:35 +02002495 err = GET_ERROR;
Victor Stinnerdd88d3d2015-03-31 16:08:22 +02002496 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002497 }
Victor Stinnerdd88d3d2015-03-31 16:08:22 +02002498 else {
Victor Stinnerb6c15bc2015-03-31 16:35:35 +02002499 /* select() failed */
2500 err = GET_ERROR;
Victor Stinnerdd88d3d2015-03-31 16:08:22 +02002501 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002502 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002503 *timeoutp = timeout;
Guido van Rossum7b8bac12002-06-13 16:07:04 +00002504
Victor Stinnerdd88d3d2015-03-31 16:08:22 +02002505 assert(err >= 0);
2506 return err;
Victor Stinnerb6c15bc2015-03-31 16:35:35 +02002507
2508#undef GET_ERROR
2509#undef IN_PROGRESS_ERR
2510#undef TIMEOUT_ERR
Guido van Rossum7b8bac12002-06-13 16:07:04 +00002511}
Guido van Rossum30a685f1991-06-27 15:51:29 +00002512
Fred Drake728819a2000-07-01 03:40:12 +00002513/* s.connect(sockaddr) method */
Guido van Rossum30a685f1991-06-27 15:51:29 +00002514
Guido van Rossum73624e91994-10-10 17:59:00 +00002515static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00002516sock_connect(PySocketSockObject *s, PyObject *addro)
Guido van Rossum6574b3e1991-06-25 21:36:08 +00002517{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002518 sock_addr_t addrbuf;
2519 int addrlen;
2520 int res;
2521 int timeout;
Jeremy Hyltonae0013d2001-10-11 16:36:35 +00002522
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002523 if (!getsockaddrarg(s, addro, SAS2SA(&addrbuf), &addrlen))
2524 return NULL;
Guido van Rossum67f7a382002-06-06 21:08:16 +00002525
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002526 res = internal_connect(s, SAS2SA(&addrbuf), addrlen, &timeout);
Guido van Rossum67f7a382002-06-06 21:08:16 +00002527
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002528 if (timeout == 1) {
2529 PyErr_SetString(socket_timeout, "timed out");
2530 return NULL;
2531 }
Victor Stinner71694d52015-03-28 01:18:54 +01002532 if (res < 0)
2533 return NULL;
2534 if (res != 0) {
Victor Stinnerdd88d3d2015-03-31 16:08:22 +02002535#ifdef MS_WINDOWS
2536 /* getsockopt also clears WSAGetLastError,
2537 so reset it back. */
2538 WSASetLastError(res);
2539#else
2540 errno = res;
2541#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002542 return s->errorhandler();
Victor Stinner71694d52015-03-28 01:18:54 +01002543 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002544 Py_INCREF(Py_None);
2545 return Py_None;
Guido van Rossum6574b3e1991-06-25 21:36:08 +00002546}
2547
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002548PyDoc_STRVAR(connect_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00002549"connect(address)\n\
2550\n\
2551Connect the socket to a remote address. For IP sockets, the address\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002552is a pair (host, port).");
Guido van Rossum82a5c661998-07-07 20:45:43 +00002553
Guido van Rossum30a685f1991-06-27 15:51:29 +00002554
Fred Drake728819a2000-07-01 03:40:12 +00002555/* s.connect_ex(sockaddr) method */
Guido van Rossumfc4255d1997-11-19 18:57:13 +00002556
2557static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00002558sock_connect_ex(PySocketSockObject *s, PyObject *addro)
Guido van Rossumfc4255d1997-11-19 18:57:13 +00002559{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002560 sock_addr_t addrbuf;
2561 int addrlen;
2562 int res;
2563 int timeout;
Jeremy Hyltonae0013d2001-10-11 16:36:35 +00002564
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002565 if (!getsockaddrarg(s, addro, SAS2SA(&addrbuf), &addrlen))
2566 return NULL;
Guido van Rossum67f7a382002-06-06 21:08:16 +00002567
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002568 res = internal_connect(s, SAS2SA(&addrbuf), addrlen, &timeout);
Guido van Rossum67f7a382002-06-06 21:08:16 +00002569
Victor Stinner71694d52015-03-28 01:18:54 +01002570 if (res < 0)
2571 return NULL;
2572
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002573 /* Signals are not errors (though they may raise exceptions). Adapted
2574 from PyErr_SetFromErrnoWithFilenameObject(). */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002575 if (res == EINTR && PyErr_CheckSignals())
2576 return NULL;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002577
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002578 return PyLong_FromLong((long) res);
Guido van Rossumfc4255d1997-11-19 18:57:13 +00002579}
2580
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002581PyDoc_STRVAR(connect_ex_doc,
Guido van Rossum22a97152002-08-08 20:37:08 +00002582"connect_ex(address) -> errno\n\
Guido van Rossum82a5c661998-07-07 20:45:43 +00002583\n\
2584This is like connect(address), but returns an error code (the errno value)\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002585instead of raising an exception when an error occurs.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00002586
Guido van Rossumfc4255d1997-11-19 18:57:13 +00002587
Guido van Rossumed233a51992-06-23 09:07:03 +00002588/* s.fileno() method */
2589
Guido van Rossum73624e91994-10-10 17:59:00 +00002590static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00002591sock_fileno(PySocketSockObject *s)
Guido van Rossumed233a51992-06-23 09:07:03 +00002592{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002593 return PyLong_FromSocket_t(s->sock_fd);
Guido van Rossumed233a51992-06-23 09:07:03 +00002594}
2595
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002596PyDoc_STRVAR(fileno_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00002597"fileno() -> integer\n\
2598\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002599Return the integer file descriptor of the socket.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00002600
Guido van Rossumed233a51992-06-23 09:07:03 +00002601
Guido van Rossumc89705d1992-11-26 08:54:07 +00002602/* s.getsockname() method */
2603
Guido van Rossum73624e91994-10-10 17:59:00 +00002604static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00002605sock_getsockname(PySocketSockObject *s)
Guido van Rossumc89705d1992-11-26 08:54:07 +00002606{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002607 sock_addr_t addrbuf;
2608 int res;
2609 socklen_t addrlen;
Guido van Rossumff3ab422000-04-24 15:16:03 +00002610
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002611 if (!getsockaddrlen(s, &addrlen))
2612 return NULL;
2613 memset(&addrbuf, 0, addrlen);
2614 Py_BEGIN_ALLOW_THREADS
2615 res = getsockname(s->sock_fd, SAS2SA(&addrbuf), &addrlen);
2616 Py_END_ALLOW_THREADS
2617 if (res < 0)
2618 return s->errorhandler();
2619 return makesockaddr(s->sock_fd, SAS2SA(&addrbuf), addrlen,
2620 s->sock_proto);
Guido van Rossumc89705d1992-11-26 08:54:07 +00002621}
2622
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002623PyDoc_STRVAR(getsockname_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00002624"getsockname() -> address info\n\
2625\n\
2626Return the address of the local endpoint. For IP sockets, the address\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002627info is a pair (hostaddr, port).");
Guido van Rossum82a5c661998-07-07 20:45:43 +00002628
Guido van Rossumc89705d1992-11-26 08:54:07 +00002629
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002630#ifdef HAVE_GETPEERNAME /* Cray APP doesn't have this :-( */
Guido van Rossumc89705d1992-11-26 08:54:07 +00002631/* s.getpeername() method */
2632
Guido van Rossum73624e91994-10-10 17:59:00 +00002633static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00002634sock_getpeername(PySocketSockObject *s)
Guido van Rossumc89705d1992-11-26 08:54:07 +00002635{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002636 sock_addr_t addrbuf;
2637 int res;
2638 socklen_t addrlen;
Guido van Rossumff3ab422000-04-24 15:16:03 +00002639
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002640 if (!getsockaddrlen(s, &addrlen))
2641 return NULL;
2642 memset(&addrbuf, 0, addrlen);
2643 Py_BEGIN_ALLOW_THREADS
2644 res = getpeername(s->sock_fd, SAS2SA(&addrbuf), &addrlen);
2645 Py_END_ALLOW_THREADS
2646 if (res < 0)
2647 return s->errorhandler();
2648 return makesockaddr(s->sock_fd, SAS2SA(&addrbuf), addrlen,
2649 s->sock_proto);
Guido van Rossumc89705d1992-11-26 08:54:07 +00002650}
Guido van Rossum82a5c661998-07-07 20:45:43 +00002651
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002652PyDoc_STRVAR(getpeername_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00002653"getpeername() -> address info\n\
2654\n\
2655Return the address of the remote endpoint. For IP sockets, the address\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002656info is a pair (hostaddr, port).");
Guido van Rossum82a5c661998-07-07 20:45:43 +00002657
Guido van Rossumb6775db1994-08-01 11:34:53 +00002658#endif /* HAVE_GETPEERNAME */
Guido van Rossumc89705d1992-11-26 08:54:07 +00002659
2660
Guido van Rossum30a685f1991-06-27 15:51:29 +00002661/* s.listen(n) method */
2662
Guido van Rossum73624e91994-10-10 17:59:00 +00002663static PyObject *
Charles-François Natali644b8f52014-05-22 19:45:39 +01002664sock_listen(PySocketSockObject *s, PyObject *args)
Guido van Rossum6574b3e1991-06-25 21:36:08 +00002665{
Charles-François Natali644b8f52014-05-22 19:45:39 +01002666 /* We try to choose a default backlog high enough to avoid connection drops
2667 * for common workloads, yet not too high to limit resource usage. */
2668 int backlog = Py_MIN(SOMAXCONN, 128);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002669 int res;
Jeremy Hyltonae0013d2001-10-11 16:36:35 +00002670
Charles-François Natali644b8f52014-05-22 19:45:39 +01002671 if (!PyArg_ParseTuple(args, "|i:listen", &backlog))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002672 return NULL;
Charles-François Natali644b8f52014-05-22 19:45:39 +01002673
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002674 Py_BEGIN_ALLOW_THREADS
Antoine Pitrou1be815a2011-05-10 19:16:29 +02002675 /* To avoid problems on systems that don't allow a negative backlog
2676 * (which doesn't make sense anyway) we force a minimum value of 0. */
2677 if (backlog < 0)
2678 backlog = 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002679 res = listen(s->sock_fd, backlog);
2680 Py_END_ALLOW_THREADS
2681 if (res < 0)
2682 return s->errorhandler();
2683 Py_INCREF(Py_None);
2684 return Py_None;
Guido van Rossum6574b3e1991-06-25 21:36:08 +00002685}
2686
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002687PyDoc_STRVAR(listen_doc,
Charles-François Natali644b8f52014-05-22 19:45:39 +01002688"listen([backlog])\n\
Guido van Rossum82a5c661998-07-07 20:45:43 +00002689\n\
Charles-François Natali644b8f52014-05-22 19:45:39 +01002690Enable a server to accept connections. If backlog is specified, it must be\n\
2691at least 0 (if it is lower, it is set to 0); it specifies the number of\n\
Antoine Pitrou1be815a2011-05-10 19:16:29 +02002692unaccepted connections that the system will allow before refusing new\n\
Charles-François Natali644b8f52014-05-22 19:45:39 +01002693connections. If not specified, a default reasonable value is chosen.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00002694
2695
Thomas Wouters477c8d52006-05-27 19:21:47 +00002696/*
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00002697 * This is the guts of the recv() and recv_into() methods, which reads into a
Thomas Wouters902d6eb2007-01-09 23:18:33 +00002698 * char buffer. If you have any inc/dec ref to do to the objects that contain
Thomas Wouters477c8d52006-05-27 19:21:47 +00002699 * the buffer, do it in the caller. This function returns the number of bytes
Ezio Melotti13925002011-03-16 11:05:33 +02002700 * successfully read. If there was an error, it returns -1. Note that it is
Thomas Wouters477c8d52006-05-27 19:21:47 +00002701 * also possible that we return a number of bytes smaller than the request
2702 * bytes.
2703 */
Antoine Pitrou3e1fd272010-09-28 21:23:11 +00002704
Antoine Pitrou19467d22010-08-17 19:33:30 +00002705static Py_ssize_t
2706sock_recv_guts(PySocketSockObject *s, char* cbuf, Py_ssize_t len, int flags)
Thomas Wouters477c8d52006-05-27 19:21:47 +00002707{
Antoine Pitrou19467d22010-08-17 19:33:30 +00002708 Py_ssize_t outlen = -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002709 int timeout;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00002710 int async_err = 0;
Thomas Wouters477c8d52006-05-27 19:21:47 +00002711
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002712 if (!IS_SELECTABLE(s)) {
2713 select_error();
2714 return -1;
2715 }
2716 if (len == 0) {
2717 /* If 0 bytes were requested, do nothing. */
2718 return 0;
2719 }
Thomas Wouters477c8d52006-05-27 19:21:47 +00002720
Antoine Pitrou3e1fd272010-09-28 21:23:11 +00002721 BEGIN_SELECT_LOOP(s)
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00002722 do {
Victor Stinner391fa712015-03-31 13:15:31 +02002723 timeout = internal_select(s, 0, interval);
Victor Stinnerb7df3142015-03-27 22:59:32 +01002724
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00002725 if (!timeout) {
Victor Stinnerb7df3142015-03-27 22:59:32 +01002726 Py_BEGIN_ALLOW_THREADS
Victor Stinner14b9b112013-06-25 00:37:25 +02002727#ifdef MS_WINDOWS
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00002728 if (len > INT_MAX)
2729 len = INT_MAX;
2730 outlen = recv(s->sock_fd, cbuf, (int)len, flags);
Victor Stinner9a644b22013-06-24 23:47:41 +02002731#else
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00002732 outlen = recv(s->sock_fd, cbuf, len, flags);
Victor Stinner9a644b22013-06-24 23:47:41 +02002733#endif
Victor Stinnerb7df3142015-03-27 22:59:32 +01002734 Py_END_ALLOW_THREADS
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00002735 }
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00002736 } while (outlen < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
Thomas Wouters477c8d52006-05-27 19:21:47 +00002737
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002738 if (timeout == 1) {
2739 PyErr_SetString(socket_timeout, "timed out");
2740 return -1;
2741 }
Antoine Pitrou3e1fd272010-09-28 21:23:11 +00002742 END_SELECT_LOOP(s)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002743 if (outlen < 0) {
2744 /* Note: the call to errorhandler() ALWAYS indirectly returned
2745 NULL, so ignore its return value */
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00002746 if (!async_err)
2747 s->errorhandler();
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002748 return -1;
2749 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002750 return outlen;
Thomas Wouters477c8d52006-05-27 19:21:47 +00002751}
2752
Guido van Rossum48a680c2001-03-02 06:34:14 +00002753
Guido van Rossumeb6b33a1993-05-25 09:38:27 +00002754/* s.recv(nbytes [,flags]) method */
Guido van Rossum30a685f1991-06-27 15:51:29 +00002755
Guido van Rossum73624e91994-10-10 17:59:00 +00002756static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00002757sock_recv(PySocketSockObject *s, PyObject *args)
Guido van Rossum30a685f1991-06-27 15:51:29 +00002758{
Antoine Pitrou19467d22010-08-17 19:33:30 +00002759 Py_ssize_t recvlen, outlen;
2760 int flags = 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002761 PyObject *buf;
Guido van Rossum67f7a382002-06-06 21:08:16 +00002762
Antoine Pitrou19467d22010-08-17 19:33:30 +00002763 if (!PyArg_ParseTuple(args, "n|i:recv", &recvlen, &flags))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002764 return NULL;
Guido van Rossum67f7a382002-06-06 21:08:16 +00002765
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002766 if (recvlen < 0) {
2767 PyErr_SetString(PyExc_ValueError,
2768 "negative buffersize in recv");
2769 return NULL;
2770 }
Guido van Rossum67f7a382002-06-06 21:08:16 +00002771
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002772 /* Allocate a new string. */
2773 buf = PyBytes_FromStringAndSize((char *) 0, recvlen);
2774 if (buf == NULL)
2775 return NULL;
Guido van Rossum67f7a382002-06-06 21:08:16 +00002776
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002777 /* Call the guts */
2778 outlen = sock_recv_guts(s, PyBytes_AS_STRING(buf), recvlen, flags);
2779 if (outlen < 0) {
2780 /* An error occurred, release the string and return an
2781 error. */
2782 Py_DECREF(buf);
2783 return NULL;
2784 }
2785 if (outlen != recvlen) {
2786 /* We did not read as many bytes as we anticipated, resize the
2787 string if possible and be successful. */
2788 _PyBytes_Resize(&buf, outlen);
2789 }
Martin v. Löwis79acb9e2002-12-06 12:48:53 +00002790
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002791 return buf;
Guido van Rossum6574b3e1991-06-25 21:36:08 +00002792}
2793
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002794PyDoc_STRVAR(recv_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00002795"recv(buffersize[, flags]) -> data\n\
2796\n\
2797Receive up to buffersize bytes from the socket. For the optional flags\n\
2798argument, see the Unix manual. When no data is available, block until\n\
2799at least one byte is available or until the remote end is closed. When\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002800the remote end is closed and all data is read, return the empty string.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00002801
Guido van Rossum30a685f1991-06-27 15:51:29 +00002802
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00002803/* s.recv_into(buffer, [nbytes [,flags]]) method */
Guido van Rossum30a685f1991-06-27 15:51:29 +00002804
Thomas Wouters477c8d52006-05-27 19:21:47 +00002805static PyObject*
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00002806sock_recv_into(PySocketSockObject *s, PyObject *args, PyObject *kwds)
Thomas Wouters477c8d52006-05-27 19:21:47 +00002807{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002808 static char *kwlist[] = {"buffer", "nbytes", "flags", 0};
Thomas Wouters477c8d52006-05-27 19:21:47 +00002809
Antoine Pitrou19467d22010-08-17 19:33:30 +00002810 int flags = 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002811 Py_buffer pbuf;
2812 char *buf;
Antoine Pitrou19467d22010-08-17 19:33:30 +00002813 Py_ssize_t buflen, readlen, recvlen = 0;
Thomas Wouters477c8d52006-05-27 19:21:47 +00002814
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002815 /* Get the buffer's memory */
Antoine Pitrou19467d22010-08-17 19:33:30 +00002816 if (!PyArg_ParseTupleAndKeywords(args, kwds, "w*|ni:recv_into", kwlist,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002817 &pbuf, &recvlen, &flags))
2818 return NULL;
2819 buf = pbuf.buf;
2820 buflen = pbuf.len;
Thomas Wouters477c8d52006-05-27 19:21:47 +00002821
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002822 if (recvlen < 0) {
2823 PyBuffer_Release(&pbuf);
2824 PyErr_SetString(PyExc_ValueError,
2825 "negative buffersize in recv_into");
2826 return NULL;
2827 }
2828 if (recvlen == 0) {
2829 /* If nbytes was not specified, use the buffer's length */
2830 recvlen = buflen;
2831 }
Thomas Wouters477c8d52006-05-27 19:21:47 +00002832
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002833 /* Check if the buffer is large enough */
2834 if (buflen < recvlen) {
2835 PyBuffer_Release(&pbuf);
2836 PyErr_SetString(PyExc_ValueError,
2837 "buffer too small for requested bytes");
2838 return NULL;
2839 }
Thomas Wouters477c8d52006-05-27 19:21:47 +00002840
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002841 /* Call the guts */
2842 readlen = sock_recv_guts(s, buf, recvlen, flags);
2843 if (readlen < 0) {
2844 /* Return an error. */
2845 PyBuffer_Release(&pbuf);
2846 return NULL;
2847 }
Thomas Wouters477c8d52006-05-27 19:21:47 +00002848
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002849 PyBuffer_Release(&pbuf);
2850 /* Return the number of bytes read. Note that we do not do anything
2851 special here in the case that readlen < recvlen. */
2852 return PyLong_FromSsize_t(readlen);
Thomas Wouters477c8d52006-05-27 19:21:47 +00002853}
2854
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00002855PyDoc_STRVAR(recv_into_doc,
2856"recv_into(buffer, [nbytes[, flags]]) -> nbytes_read\n\
Thomas Wouters477c8d52006-05-27 19:21:47 +00002857\n\
2858A version of recv() that stores its data into a buffer rather than creating \n\
2859a new string. Receive up to buffersize bytes from the socket. If buffersize \n\
2860is not specified (or 0), receive up to the size available in the given buffer.\n\
2861\n\
2862See recv() for documentation about the flags.");
2863
2864
2865/*
Christian Heimes99170a52007-12-19 02:07:34 +00002866 * This is the guts of the recvfrom() and recvfrom_into() methods, which reads
2867 * into a char buffer. If you have any inc/def ref to do to the objects that
2868 * contain the buffer, do it in the caller. This function returns the number
Ezio Melotti13925002011-03-16 11:05:33 +02002869 * of bytes successfully read. If there was an error, it returns -1. Note
Christian Heimes99170a52007-12-19 02:07:34 +00002870 * that it is also possible that we return a number of bytes smaller than the
2871 * request bytes.
Thomas Wouters477c8d52006-05-27 19:21:47 +00002872 *
2873 * 'addr' is a return value for the address object. Note that you must decref
2874 * it yourself.
2875 */
Antoine Pitrou19467d22010-08-17 19:33:30 +00002876static Py_ssize_t
2877sock_recvfrom_guts(PySocketSockObject *s, char* cbuf, Py_ssize_t len, int flags,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002878 PyObject** addr)
Guido van Rossum6574b3e1991-06-25 21:36:08 +00002879{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002880 sock_addr_t addrbuf;
2881 int timeout;
Antoine Pitrou19467d22010-08-17 19:33:30 +00002882 Py_ssize_t n = -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002883 socklen_t addrlen;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00002884 int async_err = 0;
Guido van Rossum67f7a382002-06-06 21:08:16 +00002885
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002886 *addr = NULL;
Guido van Rossum67f7a382002-06-06 21:08:16 +00002887
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002888 if (!getsockaddrlen(s, &addrlen))
2889 return -1;
Guido van Rossum67f7a382002-06-06 21:08:16 +00002890
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002891 if (!IS_SELECTABLE(s)) {
2892 select_error();
2893 return -1;
2894 }
Neal Norwitz082b2df2006-02-07 07:04:46 +00002895
Antoine Pitrou3e1fd272010-09-28 21:23:11 +00002896 BEGIN_SELECT_LOOP(s)
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00002897 do {
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00002898 memset(&addrbuf, 0, addrlen);
Victor Stinner391fa712015-03-31 13:15:31 +02002899 timeout = internal_select(s, 0, interval);
Victor Stinnerb7df3142015-03-27 22:59:32 +01002900
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00002901 if (!timeout) {
Victor Stinnerb7df3142015-03-27 22:59:32 +01002902 Py_BEGIN_ALLOW_THREADS
Victor Stinnere990c6e2013-11-16 00:18:58 +01002903#ifdef MS_WINDOWS
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00002904 if (len > INT_MAX)
2905 len = INT_MAX;
2906 n = recvfrom(s->sock_fd, cbuf, (int)len, flags,
2907 (void *) &addrbuf, &addrlen);
Guido van Rossum6a3eb5f1994-08-18 15:42:46 +00002908#else
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00002909 n = recvfrom(s->sock_fd, cbuf, len, flags,
2910 SAS2SA(&addrbuf), &addrlen);
Guido van Rossum6a3eb5f1994-08-18 15:42:46 +00002911#endif
Victor Stinnerb7df3142015-03-27 22:59:32 +01002912 Py_END_ALLOW_THREADS
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00002913 }
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00002914 } while (n < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
Guido van Rossum67f7a382002-06-06 21:08:16 +00002915
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002916 if (timeout == 1) {
2917 PyErr_SetString(socket_timeout, "timed out");
2918 return -1;
2919 }
Antoine Pitrou3e1fd272010-09-28 21:23:11 +00002920 END_SELECT_LOOP(s)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002921 if (n < 0) {
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00002922 if (!async_err)
2923 s->errorhandler();
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002924 return -1;
2925 }
Guido van Rossum67f7a382002-06-06 21:08:16 +00002926
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002927 if (!(*addr = makesockaddr(s->sock_fd, SAS2SA(&addrbuf),
2928 addrlen, s->sock_proto)))
2929 return -1;
Thomas Wouters477c8d52006-05-27 19:21:47 +00002930
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002931 return n;
Thomas Wouters477c8d52006-05-27 19:21:47 +00002932}
2933
2934/* s.recvfrom(nbytes [,flags]) method */
2935
2936static PyObject *
2937sock_recvfrom(PySocketSockObject *s, PyObject *args)
2938{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002939 PyObject *buf = NULL;
2940 PyObject *addr = NULL;
2941 PyObject *ret = NULL;
Antoine Pitrou19467d22010-08-17 19:33:30 +00002942 int flags = 0;
2943 Py_ssize_t recvlen, outlen;
Thomas Wouters477c8d52006-05-27 19:21:47 +00002944
Antoine Pitrou19467d22010-08-17 19:33:30 +00002945 if (!PyArg_ParseTuple(args, "n|i:recvfrom", &recvlen, &flags))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002946 return NULL;
Guido van Rossum48a680c2001-03-02 06:34:14 +00002947
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002948 if (recvlen < 0) {
2949 PyErr_SetString(PyExc_ValueError,
2950 "negative buffersize in recvfrom");
2951 return NULL;
2952 }
Guido van Rossumd8faa362007-04-27 19:54:29 +00002953
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002954 buf = PyBytes_FromStringAndSize((char *) 0, recvlen);
2955 if (buf == NULL)
2956 return NULL;
Thomas Wouters477c8d52006-05-27 19:21:47 +00002957
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002958 outlen = sock_recvfrom_guts(s, PyBytes_AS_STRING(buf),
2959 recvlen, flags, &addr);
2960 if (outlen < 0) {
2961 goto finally;
2962 }
Thomas Wouters477c8d52006-05-27 19:21:47 +00002963
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002964 if (outlen != recvlen) {
2965 /* We did not read as many bytes as we anticipated, resize the
Ezio Melotti13925002011-03-16 11:05:33 +02002966 string if possible and be successful. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002967 if (_PyBytes_Resize(&buf, outlen) < 0)
Ezio Melotti13925002011-03-16 11:05:33 +02002968 /* Oopsy, not so successful after all. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002969 goto finally;
2970 }
Barry Warsaw752300b1997-01-03 17:18:10 +00002971
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002972 ret = PyTuple_Pack(2, buf, addr);
Guido van Rossum67f7a382002-06-06 21:08:16 +00002973
2974finally:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002975 Py_XDECREF(buf);
2976 Py_XDECREF(addr);
2977 return ret;
Guido van Rossum6574b3e1991-06-25 21:36:08 +00002978}
2979
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002980PyDoc_STRVAR(recvfrom_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00002981"recvfrom(buffersize[, flags]) -> (data, address info)\n\
2982\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002983Like recv(buffersize, flags) but also return the sender's address info.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00002984
Thomas Wouters477c8d52006-05-27 19:21:47 +00002985
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00002986/* s.recvfrom_into(buffer[, nbytes [,flags]]) method */
Thomas Wouters477c8d52006-05-27 19:21:47 +00002987
2988static PyObject *
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00002989sock_recvfrom_into(PySocketSockObject *s, PyObject *args, PyObject* kwds)
Thomas Wouters477c8d52006-05-27 19:21:47 +00002990{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002991 static char *kwlist[] = {"buffer", "nbytes", "flags", 0};
Thomas Wouters477c8d52006-05-27 19:21:47 +00002992
Antoine Pitrou19467d22010-08-17 19:33:30 +00002993 int flags = 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002994 Py_buffer pbuf;
2995 char *buf;
Antoine Pitrou19467d22010-08-17 19:33:30 +00002996 Py_ssize_t readlen, buflen, recvlen = 0;
Thomas Wouters477c8d52006-05-27 19:21:47 +00002997
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002998 PyObject *addr = NULL;
Thomas Wouters477c8d52006-05-27 19:21:47 +00002999
Antoine Pitrou19467d22010-08-17 19:33:30 +00003000 if (!PyArg_ParseTupleAndKeywords(args, kwds, "w*|ni:recvfrom_into",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003001 kwlist, &pbuf,
3002 &recvlen, &flags))
3003 return NULL;
3004 buf = pbuf.buf;
3005 buflen = pbuf.len;
Thomas Wouters477c8d52006-05-27 19:21:47 +00003006
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003007 if (recvlen < 0) {
3008 PyBuffer_Release(&pbuf);
3009 PyErr_SetString(PyExc_ValueError,
3010 "negative buffersize in recvfrom_into");
3011 return NULL;
3012 }
3013 if (recvlen == 0) {
3014 /* If nbytes was not specified, use the buffer's length */
3015 recvlen = buflen;
Benjamin Petersonc6b37e22014-01-13 23:14:42 -05003016 } else if (recvlen > buflen) {
3017 PyBuffer_Release(&pbuf);
3018 PyErr_SetString(PyExc_ValueError,
3019 "nbytes is greater than the length of the buffer");
3020 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003021 }
Thomas Wouters477c8d52006-05-27 19:21:47 +00003022
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003023 readlen = sock_recvfrom_guts(s, buf, recvlen, flags, &addr);
3024 if (readlen < 0) {
3025 PyBuffer_Release(&pbuf);
3026 /* Return an error */
3027 Py_XDECREF(addr);
3028 return NULL;
3029 }
Thomas Wouters477c8d52006-05-27 19:21:47 +00003030
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003031 PyBuffer_Release(&pbuf);
3032 /* Return the number of bytes read and the address. Note that we do
3033 not do anything special here in the case that readlen < recvlen. */
Antoine Pitrou19467d22010-08-17 19:33:30 +00003034 return Py_BuildValue("nN", readlen, addr);
Thomas Wouters477c8d52006-05-27 19:21:47 +00003035}
3036
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00003037PyDoc_STRVAR(recvfrom_into_doc,
3038"recvfrom_into(buffer[, nbytes[, flags]]) -> (nbytes, address info)\n\
Thomas Wouters477c8d52006-05-27 19:21:47 +00003039\n\
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00003040Like recv_into(buffer[, nbytes[, flags]]) but also return the sender's address info.");
Thomas Wouters477c8d52006-05-27 19:21:47 +00003041
3042
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003043/* The sendmsg() and recvmsg[_into]() methods require a working
3044 CMSG_LEN(). See the comment near get_CMSG_LEN(). */
3045#ifdef CMSG_LEN
3046/*
3047 * Call recvmsg() with the supplied iovec structures, flags, and
3048 * ancillary data buffer size (controllen). Returns the tuple return
3049 * value for recvmsg() or recvmsg_into(), with the first item provided
3050 * by the supplied makeval() function. makeval() will be called with
3051 * the length read and makeval_data as arguments, and must return a
3052 * new reference (which will be decrefed if there is a subsequent
3053 * error). On error, closes any file descriptors received via
3054 * SCM_RIGHTS.
3055 */
3056static PyObject *
3057sock_recvmsg_guts(PySocketSockObject *s, struct iovec *iov, int iovlen,
3058 int flags, Py_ssize_t controllen,
3059 PyObject *(*makeval)(ssize_t, void *), void *makeval_data)
3060{
3061 ssize_t bytes_received = -1;
3062 int timeout;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003063 int async_err = 0;
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003064 sock_addr_t addrbuf;
3065 socklen_t addrbuflen;
Charles-François Natalie9e95ae2011-08-24 21:40:53 +02003066 struct msghdr msg = {0};
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003067 PyObject *cmsg_list = NULL, *retval = NULL;
3068 void *controlbuf = NULL;
3069 struct cmsghdr *cmsgh;
3070 size_t cmsgdatalen = 0;
3071 int cmsg_status;
3072
3073 /* XXX: POSIX says that msg_name and msg_namelen "shall be
3074 ignored" when the socket is connected (Linux fills them in
3075 anyway for AF_UNIX sockets at least). Normally msg_namelen
3076 seems to be set to 0 if there's no address, but try to
3077 initialize msg_name to something that won't be mistaken for a
3078 real address if that doesn't happen. */
3079 if (!getsockaddrlen(s, &addrbuflen))
3080 return NULL;
3081 memset(&addrbuf, 0, addrbuflen);
3082 SAS2SA(&addrbuf)->sa_family = AF_UNSPEC;
3083
3084 if (controllen < 0 || controllen > SOCKLEN_T_LIMIT) {
3085 PyErr_SetString(PyExc_ValueError,
3086 "invalid ancillary data buffer length");
3087 return NULL;
3088 }
3089 if (controllen > 0 && (controlbuf = PyMem_Malloc(controllen)) == NULL)
3090 return PyErr_NoMemory();
3091
3092 /* Make the system call. */
3093 if (!IS_SELECTABLE(s)) {
3094 select_error();
3095 goto finally;
3096 }
3097
3098 BEGIN_SELECT_LOOP(s)
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003099 do {
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003100 msg.msg_name = SAS2SA(&addrbuf);
3101 msg.msg_namelen = addrbuflen;
3102 msg.msg_iov = iov;
3103 msg.msg_iovlen = iovlen;
3104 msg.msg_control = controlbuf;
3105 msg.msg_controllen = controllen;
Victor Stinner391fa712015-03-31 13:15:31 +02003106 timeout = internal_select(s, 0, interval);
Victor Stinnerb7df3142015-03-27 22:59:32 +01003107
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003108 if (timeout == 1) {
3109 PyErr_SetString(socket_timeout, "timed out");
3110 goto finally;
3111 }
Victor Stinnerb7df3142015-03-27 22:59:32 +01003112
3113 if (!timeout) {
3114 Py_BEGIN_ALLOW_THREADS;
3115 bytes_received = recvmsg(s->sock_fd, &msg, flags);
3116 Py_END_ALLOW_THREADS;
3117 }
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003118 } while (bytes_received < 0 && errno == EINTR &&
3119 !(async_err = PyErr_CheckSignals()));
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003120 END_SELECT_LOOP(s)
3121
3122 if (bytes_received < 0) {
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003123 if (!async_err)
3124 s->errorhandler();
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003125 goto finally;
3126 }
3127
3128 /* Make list of (level, type, data) tuples from control messages. */
3129 if ((cmsg_list = PyList_New(0)) == NULL)
3130 goto err_closefds;
3131 /* Check for empty ancillary data as old CMSG_FIRSTHDR()
3132 implementations didn't do so. */
3133 for (cmsgh = ((msg.msg_controllen > 0) ? CMSG_FIRSTHDR(&msg) : NULL);
3134 cmsgh != NULL; cmsgh = CMSG_NXTHDR(&msg, cmsgh)) {
3135 PyObject *bytes, *tuple;
3136 int tmp;
3137
3138 cmsg_status = get_cmsg_data_len(&msg, cmsgh, &cmsgdatalen);
3139 if (cmsg_status != 0) {
3140 if (PyErr_WarnEx(PyExc_RuntimeWarning,
3141 "received malformed or improperly-truncated "
3142 "ancillary data", 1) == -1)
3143 goto err_closefds;
3144 }
3145 if (cmsg_status < 0)
3146 break;
3147 if (cmsgdatalen > PY_SSIZE_T_MAX) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02003148 PyErr_SetString(PyExc_OSError, "control message too long");
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003149 goto err_closefds;
3150 }
3151
3152 bytes = PyBytes_FromStringAndSize((char *)CMSG_DATA(cmsgh),
3153 cmsgdatalen);
3154 tuple = Py_BuildValue("iiN", (int)cmsgh->cmsg_level,
3155 (int)cmsgh->cmsg_type, bytes);
3156 if (tuple == NULL)
3157 goto err_closefds;
3158 tmp = PyList_Append(cmsg_list, tuple);
3159 Py_DECREF(tuple);
3160 if (tmp != 0)
3161 goto err_closefds;
3162
3163 if (cmsg_status != 0)
3164 break;
3165 }
3166
3167 retval = Py_BuildValue("NOiN",
3168 (*makeval)(bytes_received, makeval_data),
3169 cmsg_list,
3170 (int)msg.msg_flags,
3171 makesockaddr(s->sock_fd, SAS2SA(&addrbuf),
3172 ((msg.msg_namelen > addrbuflen) ?
3173 addrbuflen : msg.msg_namelen),
3174 s->sock_proto));
3175 if (retval == NULL)
3176 goto err_closefds;
3177
3178finally:
3179 Py_XDECREF(cmsg_list);
3180 PyMem_Free(controlbuf);
3181 return retval;
3182
3183err_closefds:
3184#ifdef SCM_RIGHTS
3185 /* Close all descriptors coming from SCM_RIGHTS, so they don't leak. */
3186 for (cmsgh = ((msg.msg_controllen > 0) ? CMSG_FIRSTHDR(&msg) : NULL);
3187 cmsgh != NULL; cmsgh = CMSG_NXTHDR(&msg, cmsgh)) {
3188 cmsg_status = get_cmsg_data_len(&msg, cmsgh, &cmsgdatalen);
3189 if (cmsg_status < 0)
3190 break;
3191 if (cmsgh->cmsg_level == SOL_SOCKET &&
3192 cmsgh->cmsg_type == SCM_RIGHTS) {
3193 size_t numfds;
3194 int *fdp;
3195
3196 numfds = cmsgdatalen / sizeof(int);
3197 fdp = (int *)CMSG_DATA(cmsgh);
3198 while (numfds-- > 0)
3199 close(*fdp++);
3200 }
3201 if (cmsg_status != 0)
3202 break;
3203 }
3204#endif /* SCM_RIGHTS */
3205 goto finally;
3206}
3207
3208
3209static PyObject *
3210makeval_recvmsg(ssize_t received, void *data)
3211{
3212 PyObject **buf = data;
3213
3214 if (received < PyBytes_GET_SIZE(*buf))
3215 _PyBytes_Resize(buf, received);
3216 Py_XINCREF(*buf);
3217 return *buf;
3218}
3219
3220/* s.recvmsg(bufsize[, ancbufsize[, flags]]) method */
3221
3222static PyObject *
3223sock_recvmsg(PySocketSockObject *s, PyObject *args)
3224{
3225 Py_ssize_t bufsize, ancbufsize = 0;
3226 int flags = 0;
3227 struct iovec iov;
3228 PyObject *buf = NULL, *retval = NULL;
3229
3230 if (!PyArg_ParseTuple(args, "n|ni:recvmsg", &bufsize, &ancbufsize, &flags))
3231 return NULL;
3232
3233 if (bufsize < 0) {
3234 PyErr_SetString(PyExc_ValueError, "negative buffer size in recvmsg()");
3235 return NULL;
3236 }
3237 if ((buf = PyBytes_FromStringAndSize(NULL, bufsize)) == NULL)
3238 return NULL;
3239 iov.iov_base = PyBytes_AS_STRING(buf);
3240 iov.iov_len = bufsize;
3241
3242 /* Note that we're passing a pointer to *our pointer* to the bytes
3243 object here (&buf); makeval_recvmsg() may incref the object, or
3244 deallocate it and set our pointer to NULL. */
3245 retval = sock_recvmsg_guts(s, &iov, 1, flags, ancbufsize,
3246 &makeval_recvmsg, &buf);
3247 Py_XDECREF(buf);
3248 return retval;
3249}
3250
3251PyDoc_STRVAR(recvmsg_doc,
3252"recvmsg(bufsize[, ancbufsize[, flags]]) -> (data, ancdata, msg_flags, address)\n\
3253\n\
3254Receive normal data (up to bufsize bytes) and ancillary data from the\n\
3255socket. The ancbufsize argument sets the size in bytes of the\n\
3256internal buffer used to receive the ancillary data; it defaults to 0,\n\
3257meaning that no ancillary data will be received. Appropriate buffer\n\
3258sizes for ancillary data can be calculated using CMSG_SPACE() or\n\
3259CMSG_LEN(), and items which do not fit into the buffer might be\n\
3260truncated or discarded. The flags argument defaults to 0 and has the\n\
3261same meaning as for recv().\n\
3262\n\
3263The return value is a 4-tuple: (data, ancdata, msg_flags, address).\n\
3264The data item is a bytes object holding the non-ancillary data\n\
3265received. The ancdata item is a list of zero or more tuples\n\
3266(cmsg_level, cmsg_type, cmsg_data) representing the ancillary data\n\
3267(control messages) received: cmsg_level and cmsg_type are integers\n\
3268specifying the protocol level and protocol-specific type respectively,\n\
3269and cmsg_data is a bytes object holding the associated data. The\n\
3270msg_flags item is the bitwise OR of various flags indicating\n\
3271conditions on the received message; see your system documentation for\n\
3272details. If the receiving socket is unconnected, address is the\n\
3273address of the sending socket, if available; otherwise, its value is\n\
3274unspecified.\n\
3275\n\
3276If recvmsg() raises an exception after the system call returns, it\n\
3277will first attempt to close any file descriptors received via the\n\
3278SCM_RIGHTS mechanism.");
3279
3280
3281static PyObject *
3282makeval_recvmsg_into(ssize_t received, void *data)
3283{
3284 return PyLong_FromSsize_t(received);
3285}
3286
3287/* s.recvmsg_into(buffers[, ancbufsize[, flags]]) method */
3288
3289static PyObject *
3290sock_recvmsg_into(PySocketSockObject *s, PyObject *args)
3291{
3292 Py_ssize_t ancbufsize = 0;
3293 int flags = 0;
3294 struct iovec *iovs = NULL;
3295 Py_ssize_t i, nitems, nbufs = 0;
3296 Py_buffer *bufs = NULL;
3297 PyObject *buffers_arg, *fast, *retval = NULL;
3298
3299 if (!PyArg_ParseTuple(args, "O|ni:recvmsg_into",
3300 &buffers_arg, &ancbufsize, &flags))
3301 return NULL;
3302
3303 if ((fast = PySequence_Fast(buffers_arg,
3304 "recvmsg_into() argument 1 must be an "
3305 "iterable")) == NULL)
3306 return NULL;
3307 nitems = PySequence_Fast_GET_SIZE(fast);
3308 if (nitems > INT_MAX) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02003309 PyErr_SetString(PyExc_OSError, "recvmsg_into() argument 1 is too long");
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003310 goto finally;
3311 }
3312
3313 /* Fill in an iovec for each item, and save the Py_buffer
3314 structs to release afterwards. */
3315 if (nitems > 0 && ((iovs = PyMem_New(struct iovec, nitems)) == NULL ||
3316 (bufs = PyMem_New(Py_buffer, nitems)) == NULL)) {
3317 PyErr_NoMemory();
3318 goto finally;
3319 }
3320 for (; nbufs < nitems; nbufs++) {
3321 if (!PyArg_Parse(PySequence_Fast_GET_ITEM(fast, nbufs),
3322 "w*;recvmsg_into() argument 1 must be an iterable "
3323 "of single-segment read-write buffers",
3324 &bufs[nbufs]))
3325 goto finally;
3326 iovs[nbufs].iov_base = bufs[nbufs].buf;
3327 iovs[nbufs].iov_len = bufs[nbufs].len;
3328 }
3329
3330 retval = sock_recvmsg_guts(s, iovs, nitems, flags, ancbufsize,
3331 &makeval_recvmsg_into, NULL);
3332finally:
3333 for (i = 0; i < nbufs; i++)
3334 PyBuffer_Release(&bufs[i]);
3335 PyMem_Free(bufs);
3336 PyMem_Free(iovs);
3337 Py_DECREF(fast);
3338 return retval;
3339}
3340
3341PyDoc_STRVAR(recvmsg_into_doc,
3342"recvmsg_into(buffers[, ancbufsize[, flags]]) -> (nbytes, ancdata, msg_flags, address)\n\
3343\n\
3344Receive normal data and ancillary data from the socket, scattering the\n\
3345non-ancillary data into a series of buffers. The buffers argument\n\
3346must be an iterable of objects that export writable buffers\n\
3347(e.g. bytearray objects); these will be filled with successive chunks\n\
3348of the non-ancillary data until it has all been written or there are\n\
3349no more buffers. The ancbufsize argument sets the size in bytes of\n\
3350the internal buffer used to receive the ancillary data; it defaults to\n\
33510, meaning that no ancillary data will be received. Appropriate\n\
3352buffer sizes for ancillary data can be calculated using CMSG_SPACE()\n\
3353or CMSG_LEN(), and items which do not fit into the buffer might be\n\
3354truncated or discarded. The flags argument defaults to 0 and has the\n\
3355same meaning as for recv().\n\
3356\n\
3357The return value is a 4-tuple: (nbytes, ancdata, msg_flags, address).\n\
3358The nbytes item is the total number of bytes of non-ancillary data\n\
3359written into the buffers. The ancdata item is a list of zero or more\n\
3360tuples (cmsg_level, cmsg_type, cmsg_data) representing the ancillary\n\
3361data (control messages) received: cmsg_level and cmsg_type are\n\
3362integers specifying the protocol level and protocol-specific type\n\
3363respectively, and cmsg_data is a bytes object holding the associated\n\
3364data. The msg_flags item is the bitwise OR of various flags\n\
3365indicating conditions on the received message; see your system\n\
3366documentation for details. If the receiving socket is unconnected,\n\
3367address is the address of the sending socket, if available; otherwise,\n\
3368its value is unspecified.\n\
3369\n\
3370If recvmsg_into() raises an exception after the system call returns,\n\
3371it will first attempt to close any file descriptors received via the\n\
3372SCM_RIGHTS mechanism.");
3373#endif /* CMSG_LEN */
3374
3375
Guido van Rossumeb6b33a1993-05-25 09:38:27 +00003376/* s.send(data [,flags]) method */
Guido van Rossum30a685f1991-06-27 15:51:29 +00003377
Guido van Rossum73624e91994-10-10 17:59:00 +00003378static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00003379sock_send(PySocketSockObject *s, PyObject *args)
Guido van Rossum30a685f1991-06-27 15:51:29 +00003380{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003381 char *buf;
Antoine Pitrou19467d22010-08-17 19:33:30 +00003382 Py_ssize_t len, n = -1;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003383 int async_err = 0;
Antoine Pitrou19467d22010-08-17 19:33:30 +00003384 int flags = 0, timeout;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003385 Py_buffer pbuf;
Guido van Rossum67f7a382002-06-06 21:08:16 +00003386
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003387 if (!PyArg_ParseTuple(args, "y*|i:send", &pbuf, &flags))
3388 return NULL;
Guido van Rossum67f7a382002-06-06 21:08:16 +00003389
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003390 if (!IS_SELECTABLE(s)) {
3391 PyBuffer_Release(&pbuf);
3392 return select_error();
3393 }
3394 buf = pbuf.buf;
3395 len = pbuf.len;
Neal Norwitz082b2df2006-02-07 07:04:46 +00003396
Antoine Pitrou3e1fd272010-09-28 21:23:11 +00003397 BEGIN_SELECT_LOOP(s)
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003398 do {
Victor Stinner391fa712015-03-31 13:15:31 +02003399 timeout = internal_select(s, 1, interval);
Victor Stinnerb7df3142015-03-27 22:59:32 +01003400
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003401 if (!timeout) {
Victor Stinnerb7df3142015-03-27 22:59:32 +01003402 Py_BEGIN_ALLOW_THREADS
Christian Heimesaf01f662013-12-21 16:19:10 +01003403#ifdef MS_WINDOWS
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003404 if (len > INT_MAX)
3405 len = INT_MAX;
3406 n = send(s->sock_fd, buf, (int)len, flags);
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003407#else
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003408 n = send(s->sock_fd, buf, len, flags);
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003409#endif
Victor Stinnerb7df3142015-03-27 22:59:32 +01003410 Py_END_ALLOW_THREADS
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003411 }
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003412 } while (n < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003413 if (timeout == 1) {
Antoine Pitrou3e1fd272010-09-28 21:23:11 +00003414 PyBuffer_Release(&pbuf);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003415 PyErr_SetString(socket_timeout, "timed out");
3416 return NULL;
3417 }
Antoine Pitrou3e1fd272010-09-28 21:23:11 +00003418 END_SELECT_LOOP(s)
3419
3420 PyBuffer_Release(&pbuf);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003421 if (n < 0)
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003422 return (!async_err) ? s->errorhandler() : NULL;
Antoine Pitrou19467d22010-08-17 19:33:30 +00003423 return PyLong_FromSsize_t(n);
Guido van Rossum30a685f1991-06-27 15:51:29 +00003424}
3425
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003426PyDoc_STRVAR(send_doc,
Guido van Rossum9f7a5392001-10-26 03:25:00 +00003427"send(data[, flags]) -> count\n\
Guido van Rossum82a5c661998-07-07 20:45:43 +00003428\n\
3429Send a data string to the socket. For the optional flags\n\
Guido van Rossum9f7a5392001-10-26 03:25:00 +00003430argument, see the Unix manual. Return the number of bytes\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003431sent; this may be less than len(data) if the network is busy.");
Guido van Rossum9f7a5392001-10-26 03:25:00 +00003432
3433
3434/* s.sendall(data [,flags]) method */
3435
3436static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00003437sock_sendall(PySocketSockObject *s, PyObject *args)
Guido van Rossum9f7a5392001-10-26 03:25:00 +00003438{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003439 char *buf;
Antoine Pitrou19467d22010-08-17 19:33:30 +00003440 Py_ssize_t len, n = -1;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003441 int async_err = 0;
3442 int flags = 0, timeout;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003443 Py_buffer pbuf;
Guido van Rossum67f7a382002-06-06 21:08:16 +00003444
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003445 if (!PyArg_ParseTuple(args, "y*|i:sendall", &pbuf, &flags))
3446 return NULL;
3447 buf = pbuf.buf;
3448 len = pbuf.len;
Guido van Rossum67f7a382002-06-06 21:08:16 +00003449
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003450 if (!IS_SELECTABLE(s)) {
3451 PyBuffer_Release(&pbuf);
3452 return select_error();
3453 }
Neal Norwitz082b2df2006-02-07 07:04:46 +00003454
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003455 do {
Victor Stinner391fa712015-03-31 13:15:31 +02003456 timeout = internal_select(s, 1, s->sock_timeout);
Victor Stinnerb7df3142015-03-27 22:59:32 +01003457
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003458 n = -1;
Antoine Pitrou6d7df632010-09-27 17:52:25 +00003459 if (!timeout) {
Victor Stinnerb7df3142015-03-27 22:59:32 +01003460 Py_BEGIN_ALLOW_THREADS
Christian Heimesaf01f662013-12-21 16:19:10 +01003461#ifdef MS_WINDOWS
Victor Stinner9a644b22013-06-24 23:47:41 +02003462 if (len > INT_MAX)
3463 len = INT_MAX;
3464 n = send(s->sock_fd, buf, (int)len, flags);
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003465#else
Antoine Pitrou6d7df632010-09-27 17:52:25 +00003466 n = send(s->sock_fd, buf, len, flags);
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003467#endif
Victor Stinnerb7df3142015-03-27 22:59:32 +01003468 Py_END_ALLOW_THREADS
Antoine Pitrou6d7df632010-09-27 17:52:25 +00003469 }
Antoine Pitrou6d7df632010-09-27 17:52:25 +00003470 if (timeout == 1) {
3471 PyBuffer_Release(&pbuf);
3472 PyErr_SetString(socket_timeout, "timed out");
3473 return NULL;
3474 }
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003475 if (n >= 0) {
3476 buf += n;
3477 len -= n;
Antoine Pitrou6d7df632010-09-27 17:52:25 +00003478 }
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003479 } while (len > 0 && (n >= 0 || errno == EINTR) &&
3480 !(async_err = PyErr_CheckSignals()));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003481 PyBuffer_Release(&pbuf);
Guido van Rossum67f7a382002-06-06 21:08:16 +00003482
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003483 if (n < 0 || async_err)
3484 return (!async_err) ? s->errorhandler() : NULL;
Guido van Rossum67f7a382002-06-06 21:08:16 +00003485
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003486 Py_INCREF(Py_None);
3487 return Py_None;
Guido van Rossum9f7a5392001-10-26 03:25:00 +00003488}
3489
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003490PyDoc_STRVAR(sendall_doc,
Guido van Rossum9f7a5392001-10-26 03:25:00 +00003491"sendall(data[, flags])\n\
3492\n\
3493Send a data string to the socket. For the optional flags\n\
3494argument, see the Unix manual. This calls send() repeatedly\n\
3495until all data is sent. If an error occurs, it's impossible\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003496to tell how much data has been sent.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00003497
Guido van Rossum30a685f1991-06-27 15:51:29 +00003498
Guido van Rossumeb6b33a1993-05-25 09:38:27 +00003499/* s.sendto(data, [flags,] sockaddr) method */
Guido van Rossum30a685f1991-06-27 15:51:29 +00003500
Guido van Rossum73624e91994-10-10 17:59:00 +00003501static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00003502sock_sendto(PySocketSockObject *s, PyObject *args)
Guido van Rossum6574b3e1991-06-25 21:36:08 +00003503{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003504 Py_buffer pbuf;
3505 PyObject *addro;
3506 char *buf;
Antoine Pitrou5e981412011-03-17 22:38:37 +01003507 Py_ssize_t len, arglen;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003508 sock_addr_t addrbuf;
3509 int addrlen, n = -1, flags, timeout;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003510 int async_err = 0;
Guido van Rossum67f7a382002-06-06 21:08:16 +00003511
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003512 flags = 0;
Antoine Pitrou5e981412011-03-17 22:38:37 +01003513 arglen = PyTuple_Size(args);
3514 switch (arglen) {
3515 case 2:
3516 PyArg_ParseTuple(args, "y*O:sendto", &pbuf, &addro);
3517 break;
3518 case 3:
3519 PyArg_ParseTuple(args, "y*iO:sendto",
3520 &pbuf, &flags, &addro);
3521 break;
3522 default:
3523 PyErr_Format(PyExc_TypeError,
3524 "sendto() takes 2 or 3 arguments (%d given)",
3525 arglen);
Victor Stinner77af1722011-05-26 14:05:59 +02003526 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003527 }
Antoine Pitrou5e981412011-03-17 22:38:37 +01003528 if (PyErr_Occurred())
3529 return NULL;
3530
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003531 buf = pbuf.buf;
3532 len = pbuf.len;
Guido van Rossum67f7a382002-06-06 21:08:16 +00003533
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003534 if (!IS_SELECTABLE(s)) {
3535 PyBuffer_Release(&pbuf);
3536 return select_error();
3537 }
Neal Norwitz082b2df2006-02-07 07:04:46 +00003538
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003539 if (!getsockaddrarg(s, addro, SAS2SA(&addrbuf), &addrlen)) {
3540 PyBuffer_Release(&pbuf);
3541 return NULL;
3542 }
Thomas Wouters89f507f2006-12-13 04:49:30 +00003543
Antoine Pitrou3e1fd272010-09-28 21:23:11 +00003544 BEGIN_SELECT_LOOP(s)
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003545 do {
Victor Stinner391fa712015-03-31 13:15:31 +02003546 timeout = internal_select(s, 1, interval);
Victor Stinnerb7df3142015-03-27 22:59:32 +01003547
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003548 if (!timeout) {
Victor Stinnerb7df3142015-03-27 22:59:32 +01003549 Py_BEGIN_ALLOW_THREADS
Victor Stinner14b9b112013-06-25 00:37:25 +02003550#ifdef MS_WINDOWS
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003551 if (len > INT_MAX)
3552 len = INT_MAX;
3553 n = sendto(s->sock_fd, buf, (int)len, flags,
3554 SAS2SA(&addrbuf), addrlen);
Victor Stinner9a644b22013-06-24 23:47:41 +02003555#else
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003556 n = sendto(s->sock_fd, buf, len, flags,
3557 SAS2SA(&addrbuf), addrlen);
Victor Stinner9a644b22013-06-24 23:47:41 +02003558#endif
Victor Stinnerb7df3142015-03-27 22:59:32 +01003559 Py_END_ALLOW_THREADS
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003560 }
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003561 } while (n < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
Guido van Rossum67f7a382002-06-06 21:08:16 +00003562
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003563 if (timeout == 1) {
Antoine Pitrou3e1fd272010-09-28 21:23:11 +00003564 PyBuffer_Release(&pbuf);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003565 PyErr_SetString(socket_timeout, "timed out");
3566 return NULL;
3567 }
Antoine Pitrou3e1fd272010-09-28 21:23:11 +00003568 END_SELECT_LOOP(s)
3569 PyBuffer_Release(&pbuf);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003570 if (n < 0)
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003571 return (!async_err) ? s->errorhandler() : NULL;
Antoine Pitrou19467d22010-08-17 19:33:30 +00003572 return PyLong_FromSsize_t(n);
Guido van Rossum6574b3e1991-06-25 21:36:08 +00003573}
3574
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003575PyDoc_STRVAR(sendto_doc,
Guido van Rossum22a97152002-08-08 20:37:08 +00003576"sendto(data[, flags], address) -> count\n\
Guido van Rossum82a5c661998-07-07 20:45:43 +00003577\n\
3578Like send(data, flags) but allows specifying the destination address.\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003579For IP sockets, the address is a pair (hostaddr, port).");
Guido van Rossum82a5c661998-07-07 20:45:43 +00003580
Guido van Rossum30a685f1991-06-27 15:51:29 +00003581
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003582/* The sendmsg() and recvmsg[_into]() methods require a working
3583 CMSG_LEN(). See the comment near get_CMSG_LEN(). */
3584#ifdef CMSG_LEN
3585/* s.sendmsg(buffers[, ancdata[, flags[, address]]]) method */
3586
3587static PyObject *
3588sock_sendmsg(PySocketSockObject *s, PyObject *args)
3589{
3590 Py_ssize_t i, ndataparts, ndatabufs = 0, ncmsgs, ncmsgbufs = 0;
3591 Py_buffer *databufs = NULL;
3592 struct iovec *iovs = NULL;
3593 sock_addr_t addrbuf;
Charles-François Natalie9e95ae2011-08-24 21:40:53 +02003594 struct msghdr msg = {0};
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003595 struct cmsginfo {
3596 int level;
3597 int type;
3598 Py_buffer data;
3599 } *cmsgs = NULL;
3600 void *controlbuf = NULL;
3601 size_t controllen, controllen_last;
3602 ssize_t bytes_sent = -1;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003603 int async_err = 0;
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003604 int addrlen, timeout, flags = 0;
3605 PyObject *data_arg, *cmsg_arg = NULL, *addr_arg = NULL, *data_fast = NULL,
3606 *cmsg_fast = NULL, *retval = NULL;
3607
3608 if (!PyArg_ParseTuple(args, "O|OiO:sendmsg",
3609 &data_arg, &cmsg_arg, &flags, &addr_arg))
3610 return NULL;
3611
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003612 /* Parse destination address. */
3613 if (addr_arg != NULL && addr_arg != Py_None) {
3614 if (!getsockaddrarg(s, addr_arg, SAS2SA(&addrbuf), &addrlen))
3615 goto finally;
3616 msg.msg_name = &addrbuf;
3617 msg.msg_namelen = addrlen;
3618 }
3619
3620 /* Fill in an iovec for each message part, and save the Py_buffer
3621 structs to release afterwards. */
3622 if ((data_fast = PySequence_Fast(data_arg,
3623 "sendmsg() argument 1 must be an "
3624 "iterable")) == NULL)
3625 goto finally;
3626 ndataparts = PySequence_Fast_GET_SIZE(data_fast);
3627 if (ndataparts > INT_MAX) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02003628 PyErr_SetString(PyExc_OSError, "sendmsg() argument 1 is too long");
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003629 goto finally;
3630 }
3631 msg.msg_iovlen = ndataparts;
3632 if (ndataparts > 0 &&
3633 ((msg.msg_iov = iovs = PyMem_New(struct iovec, ndataparts)) == NULL ||
3634 (databufs = PyMem_New(Py_buffer, ndataparts)) == NULL)) {
3635 PyErr_NoMemory();
3636 goto finally;
3637 }
3638 for (; ndatabufs < ndataparts; ndatabufs++) {
3639 if (!PyArg_Parse(PySequence_Fast_GET_ITEM(data_fast, ndatabufs),
3640 "y*;sendmsg() argument 1 must be an iterable of "
Serhiy Storchakab757c832014-12-05 22:25:22 +02003641 "bytes-like objects",
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003642 &databufs[ndatabufs]))
3643 goto finally;
3644 iovs[ndatabufs].iov_base = databufs[ndatabufs].buf;
3645 iovs[ndatabufs].iov_len = databufs[ndatabufs].len;
3646 }
3647
3648 if (cmsg_arg == NULL)
3649 ncmsgs = 0;
3650 else {
3651 if ((cmsg_fast = PySequence_Fast(cmsg_arg,
3652 "sendmsg() argument 2 must be an "
3653 "iterable")) == NULL)
3654 goto finally;
3655 ncmsgs = PySequence_Fast_GET_SIZE(cmsg_fast);
3656 }
3657
3658#ifndef CMSG_SPACE
3659 if (ncmsgs > 1) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02003660 PyErr_SetString(PyExc_OSError,
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003661 "sending multiple control messages is not supported "
3662 "on this system");
3663 goto finally;
3664 }
3665#endif
3666 /* Save level, type and Py_buffer for each control message,
3667 and calculate total size. */
3668 if (ncmsgs > 0 && (cmsgs = PyMem_New(struct cmsginfo, ncmsgs)) == NULL) {
3669 PyErr_NoMemory();
3670 goto finally;
3671 }
3672 controllen = controllen_last = 0;
3673 while (ncmsgbufs < ncmsgs) {
3674 size_t bufsize, space;
3675
3676 if (!PyArg_Parse(PySequence_Fast_GET_ITEM(cmsg_fast, ncmsgbufs),
3677 "(iiy*):[sendmsg() ancillary data items]",
3678 &cmsgs[ncmsgbufs].level,
3679 &cmsgs[ncmsgbufs].type,
3680 &cmsgs[ncmsgbufs].data))
3681 goto finally;
3682 bufsize = cmsgs[ncmsgbufs++].data.len;
3683
3684#ifdef CMSG_SPACE
3685 if (!get_CMSG_SPACE(bufsize, &space)) {
3686#else
3687 if (!get_CMSG_LEN(bufsize, &space)) {
3688#endif
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02003689 PyErr_SetString(PyExc_OSError, "ancillary data item too large");
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003690 goto finally;
3691 }
3692 controllen += space;
3693 if (controllen > SOCKLEN_T_LIMIT || controllen < controllen_last) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02003694 PyErr_SetString(PyExc_OSError, "too much ancillary data");
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003695 goto finally;
3696 }
3697 controllen_last = controllen;
3698 }
3699
3700 /* Construct ancillary data block from control message info. */
3701 if (ncmsgbufs > 0) {
3702 struct cmsghdr *cmsgh = NULL;
3703
3704 if ((msg.msg_control = controlbuf =
3705 PyMem_Malloc(controllen)) == NULL) {
3706 PyErr_NoMemory();
3707 goto finally;
3708 }
3709 msg.msg_controllen = controllen;
3710
3711 /* Need to zero out the buffer as a workaround for glibc's
3712 CMSG_NXTHDR() implementation. After getting the pointer to
3713 the next header, it checks its (uninitialized) cmsg_len
3714 member to see if the "message" fits in the buffer, and
3715 returns NULL if it doesn't. Zero-filling the buffer
Terry Jan Reedy0f847642013-03-11 18:34:00 -04003716 ensures that this doesn't happen. */
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003717 memset(controlbuf, 0, controllen);
3718
3719 for (i = 0; i < ncmsgbufs; i++) {
3720 size_t msg_len, data_len = cmsgs[i].data.len;
3721 int enough_space = 0;
3722
3723 cmsgh = (i == 0) ? CMSG_FIRSTHDR(&msg) : CMSG_NXTHDR(&msg, cmsgh);
3724 if (cmsgh == NULL) {
3725 PyErr_Format(PyExc_RuntimeError,
3726 "unexpected NULL result from %s()",
3727 (i == 0) ? "CMSG_FIRSTHDR" : "CMSG_NXTHDR");
3728 goto finally;
3729 }
3730 if (!get_CMSG_LEN(data_len, &msg_len)) {
3731 PyErr_SetString(PyExc_RuntimeError,
3732 "item size out of range for CMSG_LEN()");
3733 goto finally;
3734 }
3735 if (cmsg_min_space(&msg, cmsgh, msg_len)) {
3736 size_t space;
3737
3738 cmsgh->cmsg_len = msg_len;
3739 if (get_cmsg_data_space(&msg, cmsgh, &space))
3740 enough_space = (space >= data_len);
3741 }
3742 if (!enough_space) {
3743 PyErr_SetString(PyExc_RuntimeError,
3744 "ancillary data does not fit in calculated "
3745 "space");
3746 goto finally;
3747 }
3748 cmsgh->cmsg_level = cmsgs[i].level;
3749 cmsgh->cmsg_type = cmsgs[i].type;
3750 memcpy(CMSG_DATA(cmsgh), cmsgs[i].data.buf, data_len);
3751 }
3752 }
3753
3754 /* Make the system call. */
3755 if (!IS_SELECTABLE(s)) {
3756 select_error();
3757 goto finally;
3758 }
3759
3760 BEGIN_SELECT_LOOP(s)
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003761 do {
Victor Stinner391fa712015-03-31 13:15:31 +02003762 timeout = internal_select(s, 1, interval);
Victor Stinnerb7df3142015-03-27 22:59:32 +01003763
3764 if (!timeout) {
3765 Py_BEGIN_ALLOW_THREADS;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003766 bytes_sent = sendmsg(s->sock_fd, &msg, flags);
Victor Stinnerb7df3142015-03-27 22:59:32 +01003767 Py_END_ALLOW_THREADS;
3768 }
3769
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003770 if (timeout == 1) {
3771 PyErr_SetString(socket_timeout, "timed out");
3772 goto finally;
3773 }
3774 } while (bytes_sent < 0 && errno == EINTR &&
3775 !(async_err = PyErr_CheckSignals()));
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003776 END_SELECT_LOOP(s)
3777
3778 if (bytes_sent < 0) {
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003779 if (!async_err)
3780 s->errorhandler();
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003781 goto finally;
3782 }
3783 retval = PyLong_FromSsize_t(bytes_sent);
3784
3785finally:
3786 PyMem_Free(controlbuf);
3787 for (i = 0; i < ncmsgbufs; i++)
3788 PyBuffer_Release(&cmsgs[i].data);
3789 PyMem_Free(cmsgs);
3790 Py_XDECREF(cmsg_fast);
3791 for (i = 0; i < ndatabufs; i++)
3792 PyBuffer_Release(&databufs[i]);
3793 PyMem_Free(databufs);
3794 PyMem_Free(iovs);
3795 Py_XDECREF(data_fast);
3796 return retval;
3797}
3798
3799PyDoc_STRVAR(sendmsg_doc,
3800"sendmsg(buffers[, ancdata[, flags[, address]]]) -> count\n\
3801\n\
3802Send normal and ancillary data to the socket, gathering the\n\
3803non-ancillary data from a series of buffers and concatenating it into\n\
3804a single message. The buffers argument specifies the non-ancillary\n\
Serhiy Storchakab757c832014-12-05 22:25:22 +02003805data as an iterable of bytes-like objects (e.g. bytes objects).\n\
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003806The ancdata argument specifies the ancillary data (control messages)\n\
3807as an iterable of zero or more tuples (cmsg_level, cmsg_type,\n\
3808cmsg_data), where cmsg_level and cmsg_type are integers specifying the\n\
3809protocol level and protocol-specific type respectively, and cmsg_data\n\
Serhiy Storchakab757c832014-12-05 22:25:22 +02003810is a bytes-like object holding the associated data. The flags\n\
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003811argument defaults to 0 and has the same meaning as for send(). If\n\
3812address is supplied and not None, it sets a destination address for\n\
3813the message. The return value is the number of bytes of non-ancillary\n\
3814data sent.");
3815#endif /* CMSG_LEN */
3816
3817
Guido van Rossum30a685f1991-06-27 15:51:29 +00003818/* s.shutdown(how) method */
3819
Guido van Rossum73624e91994-10-10 17:59:00 +00003820static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00003821sock_shutdown(PySocketSockObject *s, PyObject *arg)
Guido van Rossum6574b3e1991-06-25 21:36:08 +00003822{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003823 int how;
3824 int res;
Jeremy Hyltonae0013d2001-10-11 16:36:35 +00003825
Serhiy Storchaka78980432013-01-15 01:12:17 +02003826 how = _PyLong_AsInt(arg);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003827 if (how == -1 && PyErr_Occurred())
3828 return NULL;
3829 Py_BEGIN_ALLOW_THREADS
3830 res = shutdown(s->sock_fd, how);
3831 Py_END_ALLOW_THREADS
3832 if (res < 0)
3833 return s->errorhandler();
3834 Py_INCREF(Py_None);
3835 return Py_None;
Guido van Rossum6574b3e1991-06-25 21:36:08 +00003836}
3837
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003838PyDoc_STRVAR(shutdown_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00003839"shutdown(flag)\n\
3840\n\
Martin v. Löwis94681fc2003-11-27 19:40:22 +00003841Shut down the reading side of the socket (flag == SHUT_RD), the writing side\n\
3842of the socket (flag == SHUT_WR), or both ends (flag == SHUT_RDWR).");
Guido van Rossum82a5c661998-07-07 20:45:43 +00003843
Amaury Forgeot d'Arc3d17a5c2008-06-13 01:09:34 +00003844#if defined(MS_WINDOWS) && defined(SIO_RCVALL)
Christian Heimesfaf2f632008-01-06 16:59:19 +00003845static PyObject*
3846sock_ioctl(PySocketSockObject *s, PyObject *arg)
3847{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003848 unsigned long cmd = SIO_RCVALL;
3849 PyObject *argO;
3850 DWORD recv;
Christian Heimesfaf2f632008-01-06 16:59:19 +00003851
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003852 if (!PyArg_ParseTuple(arg, "kO:ioctl", &cmd, &argO))
3853 return NULL;
Christian Heimesfaf2f632008-01-06 16:59:19 +00003854
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003855 switch (cmd) {
3856 case SIO_RCVALL: {
3857 unsigned int option = RCVALL_ON;
3858 if (!PyArg_ParseTuple(arg, "kI:ioctl", &cmd, &option))
3859 return NULL;
3860 if (WSAIoctl(s->sock_fd, cmd, &option, sizeof(option),
3861 NULL, 0, &recv, NULL, NULL) == SOCKET_ERROR) {
3862 return set_error();
3863 }
3864 return PyLong_FromUnsignedLong(recv); }
3865 case SIO_KEEPALIVE_VALS: {
3866 struct tcp_keepalive ka;
3867 if (!PyArg_ParseTuple(arg, "k(kkk):ioctl", &cmd,
3868 &ka.onoff, &ka.keepalivetime, &ka.keepaliveinterval))
3869 return NULL;
3870 if (WSAIoctl(s->sock_fd, cmd, &ka, sizeof(ka),
3871 NULL, 0, &recv, NULL, NULL) == SOCKET_ERROR) {
3872 return set_error();
3873 }
3874 return PyLong_FromUnsignedLong(recv); }
3875 default:
3876 PyErr_Format(PyExc_ValueError, "invalid ioctl command %d", cmd);
3877 return NULL;
3878 }
Christian Heimesfaf2f632008-01-06 16:59:19 +00003879}
3880PyDoc_STRVAR(sock_ioctl_doc,
3881"ioctl(cmd, option) -> long\n\
3882\n\
Kristján Valur Jónsson847ec752009-09-27 21:10:38 +00003883Control the socket with WSAIoctl syscall. Currently supported 'cmd' values are\n\
3884SIO_RCVALL: 'option' must be one of the socket.RCVALL_* constants.\n\
3885SIO_KEEPALIVE_VALS: 'option' is a tuple of (onoff, timeout, interval).");
Kristján Valur Jónsson10f383a2012-04-07 11:23:31 +00003886#endif
3887
3888#if defined(MS_WINDOWS)
3889static PyObject*
3890sock_share(PySocketSockObject *s, PyObject *arg)
3891{
3892 WSAPROTOCOL_INFO info;
3893 DWORD processId;
3894 int result;
3895
3896 if (!PyArg_ParseTuple(arg, "I", &processId))
3897 return NULL;
3898
3899 Py_BEGIN_ALLOW_THREADS
3900 result = WSADuplicateSocket(s->sock_fd, processId, &info);
3901 Py_END_ALLOW_THREADS
3902 if (result == SOCKET_ERROR)
3903 return set_error();
3904 return PyBytes_FromStringAndSize((const char*)&info, sizeof(info));
3905}
3906PyDoc_STRVAR(sock_share_doc,
3907"share(process_id) -> bytes\n\
3908\n\
3909Share the socket with another process. The target process id\n\
3910must be provided and the resulting bytes object passed to the target\n\
3911process. There the shared socket can be instantiated by calling\n\
3912socket.fromshare().");
3913
Christian Heimesfaf2f632008-01-06 16:59:19 +00003914
3915#endif
Guido van Rossum30a685f1991-06-27 15:51:29 +00003916
3917/* List of methods for socket objects */
Guido van Rossum6574b3e1991-06-25 21:36:08 +00003918
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00003919static PyMethodDef sock_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003920 {"_accept", (PyCFunction)sock_accept, METH_NOARGS,
3921 accept_doc},
3922 {"bind", (PyCFunction)sock_bind, METH_O,
3923 bind_doc},
3924 {"close", (PyCFunction)sock_close, METH_NOARGS,
3925 close_doc},
3926 {"connect", (PyCFunction)sock_connect, METH_O,
3927 connect_doc},
3928 {"connect_ex", (PyCFunction)sock_connect_ex, METH_O,
3929 connect_ex_doc},
Antoine Pitrou6e451df2010-08-09 20:39:54 +00003930 {"detach", (PyCFunction)sock_detach, METH_NOARGS,
3931 detach_doc},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003932 {"fileno", (PyCFunction)sock_fileno, METH_NOARGS,
3933 fileno_doc},
Guido van Rossumb6775db1994-08-01 11:34:53 +00003934#ifdef HAVE_GETPEERNAME
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003935 {"getpeername", (PyCFunction)sock_getpeername,
3936 METH_NOARGS, getpeername_doc},
Guido van Rossum9575a441993-04-07 14:06:14 +00003937#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003938 {"getsockname", (PyCFunction)sock_getsockname,
3939 METH_NOARGS, getsockname_doc},
3940 {"getsockopt", (PyCFunction)sock_getsockopt, METH_VARARGS,
3941 getsockopt_doc},
Amaury Forgeot d'Arc3d17a5c2008-06-13 01:09:34 +00003942#if defined(MS_WINDOWS) && defined(SIO_RCVALL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003943 {"ioctl", (PyCFunction)sock_ioctl, METH_VARARGS,
3944 sock_ioctl_doc},
Christian Heimesfaf2f632008-01-06 16:59:19 +00003945#endif
Kristján Valur Jónsson10f383a2012-04-07 11:23:31 +00003946#if defined(MS_WINDOWS)
3947 {"share", (PyCFunction)sock_share, METH_VARARGS,
3948 sock_share_doc},
3949#endif
Charles-François Natali644b8f52014-05-22 19:45:39 +01003950 {"listen", (PyCFunction)sock_listen, METH_VARARGS,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003951 listen_doc},
3952 {"recv", (PyCFunction)sock_recv, METH_VARARGS,
3953 recv_doc},
3954 {"recv_into", (PyCFunction)sock_recv_into, METH_VARARGS | METH_KEYWORDS,
3955 recv_into_doc},
3956 {"recvfrom", (PyCFunction)sock_recvfrom, METH_VARARGS,
3957 recvfrom_doc},
3958 {"recvfrom_into", (PyCFunction)sock_recvfrom_into, METH_VARARGS | METH_KEYWORDS,
3959 recvfrom_into_doc},
3960 {"send", (PyCFunction)sock_send, METH_VARARGS,
3961 send_doc},
3962 {"sendall", (PyCFunction)sock_sendall, METH_VARARGS,
3963 sendall_doc},
3964 {"sendto", (PyCFunction)sock_sendto, METH_VARARGS,
3965 sendto_doc},
3966 {"setblocking", (PyCFunction)sock_setblocking, METH_O,
3967 setblocking_doc},
3968 {"settimeout", (PyCFunction)sock_settimeout, METH_O,
3969 settimeout_doc},
3970 {"gettimeout", (PyCFunction)sock_gettimeout, METH_NOARGS,
3971 gettimeout_doc},
3972 {"setsockopt", (PyCFunction)sock_setsockopt, METH_VARARGS,
3973 setsockopt_doc},
3974 {"shutdown", (PyCFunction)sock_shutdown, METH_O,
3975 shutdown_doc},
Nick Coghlan96fe56a2011-08-22 11:55:57 +10003976#ifdef CMSG_LEN
3977 {"recvmsg", (PyCFunction)sock_recvmsg, METH_VARARGS,
3978 recvmsg_doc},
3979 {"recvmsg_into", (PyCFunction)sock_recvmsg_into, METH_VARARGS,
3980 recvmsg_into_doc,},
3981 {"sendmsg", (PyCFunction)sock_sendmsg, METH_VARARGS,
3982 sendmsg_doc},
3983#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003984 {NULL, NULL} /* sentinel */
Guido van Rossum6574b3e1991-06-25 21:36:08 +00003985};
3986
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00003987/* SockObject members */
3988static PyMemberDef sock_memberlist[] = {
3989 {"family", T_INT, offsetof(PySocketSockObject, sock_family), READONLY, "the socket family"},
3990 {"type", T_INT, offsetof(PySocketSockObject, sock_type), READONLY, "the socket type"},
3991 {"proto", T_INT, offsetof(PySocketSockObject, sock_proto), READONLY, "the socket protocol"},
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00003992 {0},
3993};
Guido van Rossum30a685f1991-06-27 15:51:29 +00003994
Victor Stinner71694d52015-03-28 01:18:54 +01003995static PyGetSetDef sock_getsetlist[] = {
3996 {"timeout", (getter)sock_gettimeout, NULL, PyDoc_STR("the socket timeout")},
3997 {NULL} /* sentinel */
3998};
3999
Guido van Rossum73624e91994-10-10 17:59:00 +00004000/* Deallocate a socket object in response to the last Py_DECREF().
Guido van Rossum30a685f1991-06-27 15:51:29 +00004001 First close the file description. */
4002
Guido van Rossum6574b3e1991-06-25 21:36:08 +00004003static void
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00004004sock_dealloc(PySocketSockObject *s)
Guido van Rossum6574b3e1991-06-25 21:36:08 +00004005{
Antoine Pitroue033e062010-10-29 10:38:18 +00004006 if (s->sock_fd != -1) {
4007 PyObject *exc, *val, *tb;
4008 Py_ssize_t old_refcount = Py_REFCNT(s);
4009 ++Py_REFCNT(s);
4010 PyErr_Fetch(&exc, &val, &tb);
4011 if (PyErr_WarnFormat(PyExc_ResourceWarning, 1,
4012 "unclosed %R", s))
4013 /* Spurious errors can appear at shutdown */
4014 if (PyErr_ExceptionMatches(PyExc_Warning))
4015 PyErr_WriteUnraisable((PyObject *) s);
4016 PyErr_Restore(exc, val, tb);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004017 (void) SOCKETCLOSE(s->sock_fd);
Antoine Pitroue033e062010-10-29 10:38:18 +00004018 Py_REFCNT(s) = old_refcount;
4019 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004020 Py_TYPE(s)->tp_free((PyObject *)s);
Guido van Rossum6574b3e1991-06-25 21:36:08 +00004021}
4022
Guido van Rossum30a685f1991-06-27 15:51:29 +00004023
Guido van Rossum3bbc62e1995-01-02 19:30:30 +00004024static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00004025sock_repr(PySocketSockObject *s)
Guido van Rossum3bbc62e1995-01-02 19:30:30 +00004026{
Victor Stinnere254e532014-07-26 14:36:55 +02004027 long sock_fd;
4028 /* On Windows, this test is needed because SOCKET_T is unsigned */
4029 if (s->sock_fd == INVALID_SOCKET) {
4030 sock_fd = -1;
4031 }
Fred Drakea04eaad2000-06-30 02:46:07 +00004032#if SIZEOF_SOCKET_T > SIZEOF_LONG
Victor Stinnere254e532014-07-26 14:36:55 +02004033 else if (s->sock_fd > LONG_MAX) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004034 /* this can occur on Win64, and actually there is a special
4035 ugly printf formatter for decimal pointer length integer
4036 printing, only bother if necessary*/
4037 PyErr_SetString(PyExc_OverflowError,
4038 "no printf formatter to display "
4039 "the socket descriptor in decimal");
4040 return NULL;
4041 }
Fred Drakea04eaad2000-06-30 02:46:07 +00004042#endif
Victor Stinnere254e532014-07-26 14:36:55 +02004043 else
4044 sock_fd = (long)s->sock_fd;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004045 return PyUnicode_FromFormat(
4046 "<socket object, fd=%ld, family=%d, type=%d, proto=%d>",
Victor Stinnere254e532014-07-26 14:36:55 +02004047 sock_fd, s->sock_family,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004048 s->sock_type,
4049 s->sock_proto);
Guido van Rossum3bbc62e1995-01-02 19:30:30 +00004050}
4051
4052
Guido van Rossum384ca9c2001-10-27 22:20:47 +00004053/* Create a new, uninitialized socket object. */
4054
4055static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00004056sock_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
Guido van Rossum384ca9c2001-10-27 22:20:47 +00004057{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004058 PyObject *new;
Guido van Rossum384ca9c2001-10-27 22:20:47 +00004059
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004060 new = type->tp_alloc(type, 0);
4061 if (new != NULL) {
4062 ((PySocketSockObject *)new)->sock_fd = -1;
Victor Stinner71694d52015-03-28 01:18:54 +01004063 ((PySocketSockObject *)new)->sock_timeout = -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004064 ((PySocketSockObject *)new)->errorhandler = &set_error;
4065 }
4066 return new;
Guido van Rossum384ca9c2001-10-27 22:20:47 +00004067}
4068
4069
4070/* Initialize a new socket object. */
4071
Victor Stinnerdaf45552013-08-28 00:53:59 +02004072#ifdef SOCK_CLOEXEC
4073/* socket() and socketpair() fail with EINVAL on Linux kernel older
4074 * than 2.6.27 if SOCK_CLOEXEC flag is set in the socket type. */
4075static int sock_cloexec_works = -1;
4076#endif
4077
Guido van Rossum384ca9c2001-10-27 22:20:47 +00004078/*ARGSUSED*/
4079static int
Andrew MacIntyre7aec4a22002-06-13 11:53:52 +00004080sock_initobj(PyObject *self, PyObject *args, PyObject *kwds)
Guido van Rossum384ca9c2001-10-27 22:20:47 +00004081{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004082 PySocketSockObject *s = (PySocketSockObject *)self;
4083 PyObject *fdobj = NULL;
4084 SOCKET_T fd = INVALID_SOCKET;
4085 int family = AF_INET, type = SOCK_STREAM, proto = 0;
4086 static char *keywords[] = {"family", "type", "proto", "fileno", 0};
Victor Stinnerdaf45552013-08-28 00:53:59 +02004087#ifndef MS_WINDOWS
4088#ifdef SOCK_CLOEXEC
4089 int *atomic_flag_works = &sock_cloexec_works;
4090#else
4091 int *atomic_flag_works = NULL;
4092#endif
4093#endif
Guido van Rossum384ca9c2001-10-27 22:20:47 +00004094
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004095 if (!PyArg_ParseTupleAndKeywords(args, kwds,
4096 "|iiiO:socket", keywords,
4097 &family, &type, &proto, &fdobj))
4098 return -1;
Guido van Rossum67f7a382002-06-06 21:08:16 +00004099
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004100 if (fdobj != NULL && fdobj != Py_None) {
Kristján Valur Jónsson10f383a2012-04-07 11:23:31 +00004101#ifdef MS_WINDOWS
4102 /* recreate a socket that was duplicated */
4103 if (PyBytes_Check(fdobj)) {
4104 WSAPROTOCOL_INFO info;
4105 if (PyBytes_GET_SIZE(fdobj) != sizeof(info)) {
4106 PyErr_Format(PyExc_ValueError,
4107 "socket descriptor string has wrong size, "
4108 "should be %zu bytes.", sizeof(info));
4109 return -1;
4110 }
4111 memcpy(&info, PyBytes_AS_STRING(fdobj), sizeof(info));
4112 Py_BEGIN_ALLOW_THREADS
4113 fd = WSASocket(FROM_PROTOCOL_INFO, FROM_PROTOCOL_INFO,
4114 FROM_PROTOCOL_INFO, &info, 0, WSA_FLAG_OVERLAPPED);
4115 Py_END_ALLOW_THREADS
4116 if (fd == INVALID_SOCKET) {
4117 set_error();
4118 return -1;
4119 }
4120 family = info.iAddressFamily;
4121 type = info.iSocketType;
4122 proto = info.iProtocol;
4123 }
4124 else
4125#endif
4126 {
4127 fd = PyLong_AsSocket_t(fdobj);
4128 if (fd == (SOCKET_T)(-1) && PyErr_Occurred())
4129 return -1;
4130 if (fd == INVALID_SOCKET) {
4131 PyErr_SetString(PyExc_ValueError,
4132 "can't use invalid socket value");
4133 return -1;
4134 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004135 }
4136 }
4137 else {
Victor Stinnerdaf45552013-08-28 00:53:59 +02004138#ifdef MS_WINDOWS
4139 /* Windows implementation */
4140#ifndef WSA_FLAG_NO_HANDLE_INHERIT
4141#define WSA_FLAG_NO_HANDLE_INHERIT 0x80
4142#endif
4143
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004144 Py_BEGIN_ALLOW_THREADS
Victor Stinnerdaf45552013-08-28 00:53:59 +02004145 if (support_wsa_no_inherit) {
4146 fd = WSASocket(family, type, proto,
4147 NULL, 0,
4148 WSA_FLAG_OVERLAPPED | WSA_FLAG_NO_HANDLE_INHERIT);
4149 if (fd == INVALID_SOCKET) {
4150 /* Windows 7 or Windows 2008 R2 without SP1 or the hotfix */
4151 support_wsa_no_inherit = 0;
4152 fd = socket(family, type, proto);
4153 }
4154 }
4155 else {
4156 fd = socket(family, type, proto);
4157 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004158 Py_END_ALLOW_THREADS
Guido van Rossum67f7a382002-06-06 21:08:16 +00004159
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004160 if (fd == INVALID_SOCKET) {
4161 set_error();
4162 return -1;
4163 }
Victor Stinnerdaf45552013-08-28 00:53:59 +02004164
4165 if (!support_wsa_no_inherit) {
4166 if (!SetHandleInformation((HANDLE)fd, HANDLE_FLAG_INHERIT, 0)) {
4167 closesocket(fd);
4168 PyErr_SetFromWindowsErr(0);
4169 return -1;
4170 }
4171 }
4172#else
4173 /* UNIX */
4174 Py_BEGIN_ALLOW_THREADS
4175#ifdef SOCK_CLOEXEC
4176 if (sock_cloexec_works != 0) {
4177 fd = socket(family, type | SOCK_CLOEXEC, proto);
4178 if (sock_cloexec_works == -1) {
4179 if (fd >= 0) {
4180 sock_cloexec_works = 1;
4181 }
4182 else if (errno == EINVAL) {
4183 /* Linux older than 2.6.27 does not support SOCK_CLOEXEC */
4184 sock_cloexec_works = 0;
4185 fd = socket(family, type, proto);
4186 }
4187 }
4188 }
4189 else
4190#endif
4191 {
4192 fd = socket(family, type, proto);
4193 }
4194 Py_END_ALLOW_THREADS
4195
4196 if (fd == INVALID_SOCKET) {
4197 set_error();
4198 return -1;
4199 }
4200
4201 if (_Py_set_inheritable(fd, 0, atomic_flag_works) < 0) {
4202 SOCKETCLOSE(fd);
4203 return -1;
4204 }
4205#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004206 }
4207 init_sockobject(s, fd, family, type, proto);
Guido van Rossum67f7a382002-06-06 21:08:16 +00004208
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004209 return 0;
Guido van Rossum67f7a382002-06-06 21:08:16 +00004210
Guido van Rossum384ca9c2001-10-27 22:20:47 +00004211}
4212
4213
Guido van Rossumb6775db1994-08-01 11:34:53 +00004214/* Type object for socket objects. */
Guido van Rossum30a685f1991-06-27 15:51:29 +00004215
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00004216static PyTypeObject sock_type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004217 PyVarObject_HEAD_INIT(0, 0) /* Must fill in type value later */
4218 "_socket.socket", /* tp_name */
4219 sizeof(PySocketSockObject), /* tp_basicsize */
4220 0, /* tp_itemsize */
4221 (destructor)sock_dealloc, /* tp_dealloc */
4222 0, /* tp_print */
4223 0, /* tp_getattr */
4224 0, /* tp_setattr */
4225 0, /* tp_reserved */
4226 (reprfunc)sock_repr, /* tp_repr */
4227 0, /* tp_as_number */
4228 0, /* tp_as_sequence */
4229 0, /* tp_as_mapping */
4230 0, /* tp_hash */
4231 0, /* tp_call */
4232 0, /* tp_str */
4233 PyObject_GenericGetAttr, /* tp_getattro */
4234 0, /* tp_setattro */
4235 0, /* tp_as_buffer */
4236 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
4237 sock_doc, /* tp_doc */
4238 0, /* tp_traverse */
4239 0, /* tp_clear */
4240 0, /* tp_richcompare */
4241 0, /* tp_weaklistoffset */
4242 0, /* tp_iter */
4243 0, /* tp_iternext */
4244 sock_methods, /* tp_methods */
4245 sock_memberlist, /* tp_members */
Victor Stinner71694d52015-03-28 01:18:54 +01004246 sock_getsetlist, /* tp_getset */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004247 0, /* tp_base */
4248 0, /* tp_dict */
4249 0, /* tp_descr_get */
4250 0, /* tp_descr_set */
4251 0, /* tp_dictoffset */
4252 sock_initobj, /* tp_init */
4253 PyType_GenericAlloc, /* tp_alloc */
4254 sock_new, /* tp_new */
4255 PyObject_Del, /* tp_free */
Guido van Rossum6574b3e1991-06-25 21:36:08 +00004256};
4257
Guido van Rossum30a685f1991-06-27 15:51:29 +00004258
Guido van Rossum81194471991-07-27 21:42:02 +00004259/* Python interface to gethostname(). */
4260
4261/*ARGSUSED*/
Guido van Rossum73624e91994-10-10 17:59:00 +00004262static PyObject *
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00004263socket_gethostname(PyObject *self, PyObject *unused)
Guido van Rossum81194471991-07-27 21:42:02 +00004264{
Martin v. Löwis72f48422010-10-29 18:20:08 +00004265#ifdef MS_WINDOWS
4266 /* Don't use winsock's gethostname, as this returns the ANSI
4267 version of the hostname, whereas we need a Unicode string.
4268 Otherwise, gethostname apparently also returns the DNS name. */
Hirokazu Yamamoto09fff7a2010-11-05 17:24:13 +00004269 wchar_t buf[MAX_COMPUTERNAME_LENGTH + 1];
Victor Stinner63941882011-09-29 00:42:28 +02004270 DWORD size = Py_ARRAY_LENGTH(buf);
Victor Stinner74168972011-11-17 01:11:36 +01004271 wchar_t *name;
Hirokazu Yamamoto09fff7a2010-11-05 17:24:13 +00004272 PyObject *result;
Victor Stinner74168972011-11-17 01:11:36 +01004273
4274 if (GetComputerNameExW(ComputerNamePhysicalDnsHostname, buf, &size))
Victor Stinner9d3b93b2011-11-22 02:27:30 +01004275 return PyUnicode_FromWideChar(buf, size);
Victor Stinner74168972011-11-17 01:11:36 +01004276
4277 if (GetLastError() != ERROR_MORE_DATA)
4278 return PyErr_SetFromWindowsErr(0);
4279
4280 if (size == 0)
4281 return PyUnicode_New(0, 0);
4282
4283 /* MSDN says ERROR_MORE_DATA may occur because DNS allows longer
4284 names */
Serhiy Storchaka1a1ff292015-02-16 13:28:22 +02004285 name = PyMem_New(wchar_t, size);
4286 if (!name) {
4287 PyErr_NoMemory();
Victor Stinner74168972011-11-17 01:11:36 +01004288 return NULL;
Serhiy Storchaka1a1ff292015-02-16 13:28:22 +02004289 }
Victor Stinner74168972011-11-17 01:11:36 +01004290 if (!GetComputerNameExW(ComputerNamePhysicalDnsHostname,
4291 name,
4292 &size))
4293 {
4294 PyMem_Free(name);
4295 return PyErr_SetFromWindowsErr(0);
Martin v. Löwis72f48422010-10-29 18:20:08 +00004296 }
Victor Stinner74168972011-11-17 01:11:36 +01004297
4298 result = PyUnicode_FromWideChar(name, size);
4299 PyMem_Free(name);
4300 return result;
Martin v. Löwis72f48422010-10-29 18:20:08 +00004301#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004302 char buf[1024];
4303 int res;
4304 Py_BEGIN_ALLOW_THREADS
4305 res = gethostname(buf, (int) sizeof buf - 1);
4306 Py_END_ALLOW_THREADS
4307 if (res < 0)
4308 return set_error();
4309 buf[sizeof buf - 1] = '\0';
Victor Stinnera534fc42013-06-03 22:07:27 +02004310 return PyUnicode_DecodeFSDefault(buf);
Martin v. Löwis72f48422010-10-29 18:20:08 +00004311#endif
Guido van Rossum81194471991-07-27 21:42:02 +00004312}
Guido van Rossumff4949e1992-08-05 19:58:53 +00004313
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004314PyDoc_STRVAR(gethostname_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00004315"gethostname() -> string\n\
4316\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004317Return the current host name.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00004318
Antoine Pitrou061cfb52011-02-28 22:25:22 +00004319#ifdef HAVE_SETHOSTNAME
4320PyDoc_STRVAR(sethostname_doc,
4321"sethostname(name)\n\n\
4322Sets the hostname to name.");
4323
4324static PyObject *
4325socket_sethostname(PyObject *self, PyObject *args)
4326{
4327 PyObject *hnobj;
4328 Py_buffer buf;
4329 int res, flag = 0;
4330
Christian Heimesd2774c72013-06-19 02:06:29 +02004331#ifdef _AIX
4332/* issue #18259, not declared in any useful header file */
4333extern int sethostname(const char *, size_t);
4334#endif
4335
Antoine Pitrou061cfb52011-02-28 22:25:22 +00004336 if (!PyArg_ParseTuple(args, "S:sethostname", &hnobj)) {
4337 PyErr_Clear();
4338 if (!PyArg_ParseTuple(args, "O&:sethostname",
4339 PyUnicode_FSConverter, &hnobj))
4340 return NULL;
4341 flag = 1;
4342 }
4343 res = PyObject_GetBuffer(hnobj, &buf, PyBUF_SIMPLE);
4344 if (!res) {
4345 res = sethostname(buf.buf, buf.len);
4346 PyBuffer_Release(&buf);
4347 }
4348 if (flag)
4349 Py_DECREF(hnobj);
4350 if (res)
4351 return set_error();
4352 Py_RETURN_NONE;
4353}
4354#endif
Guido van Rossumff4949e1992-08-05 19:58:53 +00004355
Guido van Rossum30a685f1991-06-27 15:51:29 +00004356/* Python interface to gethostbyname(name). */
4357
4358/*ARGSUSED*/
Guido van Rossum73624e91994-10-10 17:59:00 +00004359static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00004360socket_gethostbyname(PyObject *self, PyObject *args)
Guido van Rossum30a685f1991-06-27 15:51:29 +00004361{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004362 char *name;
4363 sock_addr_t addrbuf;
Martin v. Löwisfc0275a2010-08-22 19:33:47 +00004364 PyObject *ret = NULL;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00004365
Martin v. Löwisfc0275a2010-08-22 19:33:47 +00004366 if (!PyArg_ParseTuple(args, "et:gethostbyname", "idna", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004367 return NULL;
4368 if (setipaddr(name, SAS2SA(&addrbuf), sizeof(addrbuf), AF_INET) < 0)
Martin v. Löwisfc0275a2010-08-22 19:33:47 +00004369 goto finally;
4370 ret = makeipaddr(SAS2SA(&addrbuf), sizeof(struct sockaddr_in));
4371finally:
4372 PyMem_Free(name);
4373 return ret;
Guido van Rossum30a685f1991-06-27 15:51:29 +00004374}
4375
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004376PyDoc_STRVAR(gethostbyname_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00004377"gethostbyname(host) -> address\n\
4378\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004379Return the IP address (a string of the form '255.255.255.255') for a host.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00004380
4381
Guido van Rossum7d896ab1998-08-04 22:16:43 +00004382/* Convenience function common to gethostbyname_ex and gethostbyaddr */
4383
4384static PyObject *
Victor Stinner1a62a682014-08-17 19:33:28 +02004385gethost_common(struct hostent *h, struct sockaddr *addr, size_t alen, int af)
Guido van Rossum7d896ab1998-08-04 22:16:43 +00004386{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004387 char **pch;
4388 PyObject *rtn_tuple = (PyObject *)NULL;
4389 PyObject *name_list = (PyObject *)NULL;
4390 PyObject *addr_list = (PyObject *)NULL;
4391 PyObject *tmp;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00004392
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004393 if (h == NULL) {
4394 /* Let's get real error message to return */
4395 set_herror(h_errno);
4396 return NULL;
4397 }
Guido van Rossum67f7a382002-06-06 21:08:16 +00004398
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004399 if (h->h_addrtype != af) {
4400 /* Let's get real error message to return */
Victor Stinner1f33f2b2011-12-17 04:45:09 +01004401 errno = EAFNOSUPPORT;
4402 PyErr_SetFromErrno(PyExc_OSError);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004403 return NULL;
4404 }
Guido van Rossum67f7a382002-06-06 21:08:16 +00004405
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004406 switch (af) {
Guido van Rossum67f7a382002-06-06 21:08:16 +00004407
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004408 case AF_INET:
4409 if (alen < sizeof(struct sockaddr_in))
4410 return NULL;
4411 break;
Guido van Rossum67f7a382002-06-06 21:08:16 +00004412
Martin v. Löwis44ddbde2001-12-02 10:15:37 +00004413#ifdef ENABLE_IPV6
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004414 case AF_INET6:
4415 if (alen < sizeof(struct sockaddr_in6))
4416 return NULL;
4417 break;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00004418#endif
Guido van Rossum67f7a382002-06-06 21:08:16 +00004419
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004420 }
Guido van Rossum67f7a382002-06-06 21:08:16 +00004421
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004422 if ((name_list = PyList_New(0)) == NULL)
4423 goto err;
Guido van Rossum67f7a382002-06-06 21:08:16 +00004424
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004425 if ((addr_list = PyList_New(0)) == NULL)
4426 goto err;
Guido van Rossum67f7a382002-06-06 21:08:16 +00004427
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004428 /* SF #1511317: h_aliases can be NULL */
4429 if (h->h_aliases) {
4430 for (pch = h->h_aliases; *pch != NULL; pch++) {
4431 int status;
4432 tmp = PyUnicode_FromString(*pch);
4433 if (tmp == NULL)
4434 goto err;
Guido van Rossum67f7a382002-06-06 21:08:16 +00004435
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004436 status = PyList_Append(name_list, tmp);
4437 Py_DECREF(tmp);
Guido van Rossum67f7a382002-06-06 21:08:16 +00004438
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004439 if (status)
4440 goto err;
4441 }
4442 }
Guido van Rossum67f7a382002-06-06 21:08:16 +00004443
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004444 for (pch = h->h_addr_list; *pch != NULL; pch++) {
4445 int status;
Guido van Rossum67f7a382002-06-06 21:08:16 +00004446
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004447 switch (af) {
Guido van Rossum67f7a382002-06-06 21:08:16 +00004448
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004449 case AF_INET:
4450 {
4451 struct sockaddr_in sin;
4452 memset(&sin, 0, sizeof(sin));
4453 sin.sin_family = af;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00004454#ifdef HAVE_SOCKADDR_SA_LEN
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004455 sin.sin_len = sizeof(sin);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00004456#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004457 memcpy(&sin.sin_addr, *pch, sizeof(sin.sin_addr));
4458 tmp = makeipaddr((struct sockaddr *)&sin, sizeof(sin));
Guido van Rossum67f7a382002-06-06 21:08:16 +00004459
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004460 if (pch == h->h_addr_list && alen >= sizeof(sin))
4461 memcpy((char *) addr, &sin, sizeof(sin));
4462 break;
4463 }
Guido van Rossum67f7a382002-06-06 21:08:16 +00004464
Martin v. Löwis44ddbde2001-12-02 10:15:37 +00004465#ifdef ENABLE_IPV6
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004466 case AF_INET6:
4467 {
4468 struct sockaddr_in6 sin6;
4469 memset(&sin6, 0, sizeof(sin6));
4470 sin6.sin6_family = af;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00004471#ifdef HAVE_SOCKADDR_SA_LEN
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004472 sin6.sin6_len = sizeof(sin6);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00004473#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004474 memcpy(&sin6.sin6_addr, *pch, sizeof(sin6.sin6_addr));
4475 tmp = makeipaddr((struct sockaddr *)&sin6,
4476 sizeof(sin6));
Guido van Rossum67f7a382002-06-06 21:08:16 +00004477
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004478 if (pch == h->h_addr_list && alen >= sizeof(sin6))
4479 memcpy((char *) addr, &sin6, sizeof(sin6));
4480 break;
4481 }
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00004482#endif
Guido van Rossum67f7a382002-06-06 21:08:16 +00004483
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004484 default: /* can't happen */
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02004485 PyErr_SetString(PyExc_OSError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004486 "unsupported address family");
4487 return NULL;
4488 }
Guido van Rossum67f7a382002-06-06 21:08:16 +00004489
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004490 if (tmp == NULL)
4491 goto err;
Guido van Rossum67f7a382002-06-06 21:08:16 +00004492
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004493 status = PyList_Append(addr_list, tmp);
4494 Py_DECREF(tmp);
Guido van Rossum67f7a382002-06-06 21:08:16 +00004495
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004496 if (status)
4497 goto err;
4498 }
Guido van Rossum67f7a382002-06-06 21:08:16 +00004499
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004500 rtn_tuple = Py_BuildValue("sOO", h->h_name, name_list, addr_list);
Guido van Rossum67f7a382002-06-06 21:08:16 +00004501
Guido van Rossum7d896ab1998-08-04 22:16:43 +00004502 err:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004503 Py_XDECREF(name_list);
4504 Py_XDECREF(addr_list);
4505 return rtn_tuple;
Guido van Rossum7d896ab1998-08-04 22:16:43 +00004506}
4507
4508
4509/* Python interface to gethostbyname_ex(name). */
4510
4511/*ARGSUSED*/
4512static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00004513socket_gethostbyname_ex(PyObject *self, PyObject *args)
Guido van Rossum7d896ab1998-08-04 22:16:43 +00004514{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004515 char *name;
4516 struct hostent *h;
Charles-François Natali8b759652011-12-23 16:44:51 +01004517 sock_addr_t addr;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004518 struct sockaddr *sa;
Martin v. Löwisfc0275a2010-08-22 19:33:47 +00004519 PyObject *ret = NULL;
Guido van Rossum7d896ab1998-08-04 22:16:43 +00004520#ifdef HAVE_GETHOSTBYNAME_R
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004521 struct hostent hp_allocated;
Guido van Rossum7b6c71f1999-03-24 17:20:40 +00004522#ifdef HAVE_GETHOSTBYNAME_R_3_ARG
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004523 struct hostent_data data;
Guido van Rossum7b6c71f1999-03-24 17:20:40 +00004524#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004525 char buf[16384];
4526 int buf_len = (sizeof buf) - 1;
4527 int errnop;
Guido van Rossum7b6c71f1999-03-24 17:20:40 +00004528#endif
Ross Lagerwall8c159762012-03-06 21:36:18 +02004529#ifdef HAVE_GETHOSTBYNAME_R_3_ARG
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004530 int result;
Guido van Rossume9cd07b1999-03-15 21:40:14 +00004531#endif
Guido van Rossum7d896ab1998-08-04 22:16:43 +00004532#endif /* HAVE_GETHOSTBYNAME_R */
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00004533
Martin v. Löwisfc0275a2010-08-22 19:33:47 +00004534 if (!PyArg_ParseTuple(args, "et:gethostbyname_ex", "idna", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004535 return NULL;
Charles-François Natali8b759652011-12-23 16:44:51 +01004536 if (setipaddr(name, SAS2SA(&addr), sizeof(addr), AF_INET) < 0)
Martin v. Löwisfc0275a2010-08-22 19:33:47 +00004537 goto finally;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004538 Py_BEGIN_ALLOW_THREADS
Guido van Rossum7d896ab1998-08-04 22:16:43 +00004539#ifdef HAVE_GETHOSTBYNAME_R
Guido van Rossum7b6c71f1999-03-24 17:20:40 +00004540#if defined(HAVE_GETHOSTBYNAME_R_6_ARG)
Ross Lagerwall8c159762012-03-06 21:36:18 +02004541 gethostbyname_r(name, &hp_allocated, buf, buf_len,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004542 &h, &errnop);
Guido van Rossum7b6c71f1999-03-24 17:20:40 +00004543#elif defined(HAVE_GETHOSTBYNAME_R_5_ARG)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004544 h = gethostbyname_r(name, &hp_allocated, buf, buf_len, &errnop);
Guido van Rossum7b6c71f1999-03-24 17:20:40 +00004545#else /* HAVE_GETHOSTBYNAME_R_3_ARG */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004546 memset((void *) &data, '\0', sizeof(data));
4547 result = gethostbyname_r(name, &hp_allocated, &data);
4548 h = (result != 0) ? NULL : &hp_allocated;
Guido van Rossume9cd07b1999-03-15 21:40:14 +00004549#endif
Guido van Rossum7d896ab1998-08-04 22:16:43 +00004550#else /* not HAVE_GETHOSTBYNAME_R */
Guido van Rossum3baaa131999-03-22 21:44:51 +00004551#ifdef USE_GETHOSTBYNAME_LOCK
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004552 PyThread_acquire_lock(netdb_lock, 1);
Guido van Rossum7d896ab1998-08-04 22:16:43 +00004553#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004554 h = gethostbyname(name);
Guido van Rossum7d896ab1998-08-04 22:16:43 +00004555#endif /* HAVE_GETHOSTBYNAME_R */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004556 Py_END_ALLOW_THREADS
4557 /* Some C libraries would require addr.__ss_family instead of
4558 addr.ss_family.
4559 Therefore, we cast the sockaddr_storage into sockaddr to
4560 access sa_family. */
Charles-François Natali8b759652011-12-23 16:44:51 +01004561 sa = SAS2SA(&addr);
4562 ret = gethost_common(h, SAS2SA(&addr), sizeof(addr),
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004563 sa->sa_family);
Guido van Rossum3baaa131999-03-22 21:44:51 +00004564#ifdef USE_GETHOSTBYNAME_LOCK
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004565 PyThread_release_lock(netdb_lock);
Guido van Rossum955becc1999-03-22 20:14:53 +00004566#endif
Martin v. Löwisfc0275a2010-08-22 19:33:47 +00004567finally:
4568 PyMem_Free(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004569 return ret;
Guido van Rossum7d896ab1998-08-04 22:16:43 +00004570}
4571
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004572PyDoc_STRVAR(ghbn_ex_doc,
Guido van Rossum7d896ab1998-08-04 22:16:43 +00004573"gethostbyname_ex(host) -> (name, aliaslist, addresslist)\n\
4574\n\
4575Return the true host name, a list of aliases, and a list of IP addresses,\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004576for a host. The host argument is a string giving a host name or IP number.");
Guido van Rossum7d896ab1998-08-04 22:16:43 +00004577
4578
Guido van Rossum3bbc62e1995-01-02 19:30:30 +00004579/* Python interface to gethostbyaddr(IP). */
4580
4581/*ARGSUSED*/
4582static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00004583socket_gethostbyaddr(PyObject *self, PyObject *args)
Guido van Rossum3bbc62e1995-01-02 19:30:30 +00004584{
Charles-François Natali8b759652011-12-23 16:44:51 +01004585 sock_addr_t addr;
4586 struct sockaddr *sa = SAS2SA(&addr);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004587 char *ip_num;
4588 struct hostent *h;
Martin v. Löwisfc0275a2010-08-22 19:33:47 +00004589 PyObject *ret = NULL;
Guido van Rossum4f199ea1998-04-09 20:56:35 +00004590#ifdef HAVE_GETHOSTBYNAME_R
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004591 struct hostent hp_allocated;
Guido van Rossum7b6c71f1999-03-24 17:20:40 +00004592#ifdef HAVE_GETHOSTBYNAME_R_3_ARG
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004593 struct hostent_data data;
Guido van Rossum7b6c71f1999-03-24 17:20:40 +00004594#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004595 /* glibcs up to 2.10 assume that the buf argument to
4596 gethostbyaddr_r is 8-byte aligned, which at least llvm-gcc
4597 does not ensure. The attribute below instructs the compiler
4598 to maintain this alignment. */
4599 char buf[16384] Py_ALIGNED(8);
4600 int buf_len = (sizeof buf) - 1;
4601 int errnop;
Guido van Rossum7b6c71f1999-03-24 17:20:40 +00004602#endif
Ross Lagerwall8c159762012-03-06 21:36:18 +02004603#ifdef HAVE_GETHOSTBYNAME_R_3_ARG
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004604 int result;
Guido van Rossume9cd07b1999-03-15 21:40:14 +00004605#endif
Guido van Rossum4f199ea1998-04-09 20:56:35 +00004606#endif /* HAVE_GETHOSTBYNAME_R */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004607 char *ap;
4608 int al;
4609 int af;
Guido van Rossum3bbc62e1995-01-02 19:30:30 +00004610
Martin v. Löwisfc0275a2010-08-22 19:33:47 +00004611 if (!PyArg_ParseTuple(args, "et:gethostbyaddr", "idna", &ip_num))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004612 return NULL;
4613 af = AF_UNSPEC;
4614 if (setipaddr(ip_num, sa, sizeof(addr), af) < 0)
Martin v. Löwisfc0275a2010-08-22 19:33:47 +00004615 goto finally;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004616 af = sa->sa_family;
4617 ap = NULL;
Brett Cannonb94767f2011-02-22 20:15:44 +00004618 /* al = 0; */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004619 switch (af) {
4620 case AF_INET:
4621 ap = (char *)&((struct sockaddr_in *)sa)->sin_addr;
4622 al = sizeof(((struct sockaddr_in *)sa)->sin_addr);
4623 break;
Martin v. Löwis44ddbde2001-12-02 10:15:37 +00004624#ifdef ENABLE_IPV6
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004625 case AF_INET6:
4626 ap = (char *)&((struct sockaddr_in6 *)sa)->sin6_addr;
4627 al = sizeof(((struct sockaddr_in6 *)sa)->sin6_addr);
4628 break;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00004629#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004630 default:
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02004631 PyErr_SetString(PyExc_OSError, "unsupported address family");
Martin v. Löwisfc0275a2010-08-22 19:33:47 +00004632 goto finally;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004633 }
4634 Py_BEGIN_ALLOW_THREADS
Guido van Rossum4f199ea1998-04-09 20:56:35 +00004635#ifdef HAVE_GETHOSTBYNAME_R
Guido van Rossum7b6c71f1999-03-24 17:20:40 +00004636#if defined(HAVE_GETHOSTBYNAME_R_6_ARG)
Ross Lagerwall8c159762012-03-06 21:36:18 +02004637 gethostbyaddr_r(ap, al, af,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004638 &hp_allocated, buf, buf_len,
4639 &h, &errnop);
Guido van Rossum7b6c71f1999-03-24 17:20:40 +00004640#elif defined(HAVE_GETHOSTBYNAME_R_5_ARG)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004641 h = gethostbyaddr_r(ap, al, af,
4642 &hp_allocated, buf, buf_len, &errnop);
Guido van Rossum7b6c71f1999-03-24 17:20:40 +00004643#else /* HAVE_GETHOSTBYNAME_R_3_ARG */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004644 memset((void *) &data, '\0', sizeof(data));
4645 result = gethostbyaddr_r(ap, al, af, &hp_allocated, &data);
4646 h = (result != 0) ? NULL : &hp_allocated;
Guido van Rossume9cd07b1999-03-15 21:40:14 +00004647#endif
Guido van Rossum4f199ea1998-04-09 20:56:35 +00004648#else /* not HAVE_GETHOSTBYNAME_R */
Guido van Rossum3baaa131999-03-22 21:44:51 +00004649#ifdef USE_GETHOSTBYNAME_LOCK
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004650 PyThread_acquire_lock(netdb_lock, 1);
Guido van Rossum4f199ea1998-04-09 20:56:35 +00004651#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004652 h = gethostbyaddr(ap, al, af);
Guido van Rossum4f199ea1998-04-09 20:56:35 +00004653#endif /* HAVE_GETHOSTBYNAME_R */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004654 Py_END_ALLOW_THREADS
Charles-François Natali8b759652011-12-23 16:44:51 +01004655 ret = gethost_common(h, SAS2SA(&addr), sizeof(addr), af);
Guido van Rossum3baaa131999-03-22 21:44:51 +00004656#ifdef USE_GETHOSTBYNAME_LOCK
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004657 PyThread_release_lock(netdb_lock);
Guido van Rossum3baaa131999-03-22 21:44:51 +00004658#endif
Martin v. Löwisfc0275a2010-08-22 19:33:47 +00004659finally:
4660 PyMem_Free(ip_num);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004661 return ret;
Guido van Rossum3bbc62e1995-01-02 19:30:30 +00004662}
4663
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004664PyDoc_STRVAR(gethostbyaddr_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00004665"gethostbyaddr(host) -> (name, aliaslist, addresslist)\n\
4666\n\
4667Return the true host name, a list of aliases, and a list of IP addresses,\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004668for a host. The host argument is a string giving a host name or IP number.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00004669
Guido van Rossum30a685f1991-06-27 15:51:29 +00004670
4671/* Python interface to getservbyname(name).
4672 This only returns the port number, since the other info is already
4673 known or not useful (like the list of aliases). */
4674
4675/*ARGSUSED*/
Guido van Rossum73624e91994-10-10 17:59:00 +00004676static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00004677socket_getservbyname(PyObject *self, PyObject *args)
Guido van Rossum30a685f1991-06-27 15:51:29 +00004678{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004679 char *name, *proto=NULL;
4680 struct servent *sp;
4681 if (!PyArg_ParseTuple(args, "s|s:getservbyname", &name, &proto))
4682 return NULL;
4683 Py_BEGIN_ALLOW_THREADS
4684 sp = getservbyname(name, proto);
4685 Py_END_ALLOW_THREADS
4686 if (sp == NULL) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02004687 PyErr_SetString(PyExc_OSError, "service/proto not found");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004688 return NULL;
4689 }
4690 return PyLong_FromLong((long) ntohs(sp->s_port));
Guido van Rossum30a685f1991-06-27 15:51:29 +00004691}
4692
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004693PyDoc_STRVAR(getservbyname_doc,
Barry Warsaw11b91a02004-06-28 00:50:43 +00004694"getservbyname(servicename[, protocolname]) -> integer\n\
Guido van Rossum82a5c661998-07-07 20:45:43 +00004695\n\
4696Return a port number from a service name and protocol name.\n\
Barry Warsaw11b91a02004-06-28 00:50:43 +00004697The optional protocol name, if given, should be 'tcp' or 'udp',\n\
4698otherwise any protocol will match.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00004699
Guido van Rossum30a685f1991-06-27 15:51:29 +00004700
Barry Warsaw11b91a02004-06-28 00:50:43 +00004701/* Python interface to getservbyport(port).
4702 This only returns the service name, since the other info is already
4703 known or not useful (like the list of aliases). */
4704
4705/*ARGSUSED*/
4706static PyObject *
4707socket_getservbyport(PyObject *self, PyObject *args)
4708{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004709 int port;
4710 char *proto=NULL;
4711 struct servent *sp;
4712 if (!PyArg_ParseTuple(args, "i|s:getservbyport", &port, &proto))
4713 return NULL;
4714 if (port < 0 || port > 0xffff) {
4715 PyErr_SetString(
4716 PyExc_OverflowError,
4717 "getservbyport: port must be 0-65535.");
4718 return NULL;
4719 }
4720 Py_BEGIN_ALLOW_THREADS
4721 sp = getservbyport(htons((short)port), proto);
4722 Py_END_ALLOW_THREADS
4723 if (sp == NULL) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02004724 PyErr_SetString(PyExc_OSError, "port/proto not found");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004725 return NULL;
4726 }
4727 return PyUnicode_FromString(sp->s_name);
Barry Warsaw11b91a02004-06-28 00:50:43 +00004728}
4729
4730PyDoc_STRVAR(getservbyport_doc,
4731"getservbyport(port[, protocolname]) -> string\n\
4732\n\
4733Return the service name from a port number and protocol name.\n\
4734The optional protocol name, if given, should be 'tcp' or 'udp',\n\
4735otherwise any protocol will match.");
4736
Guido van Rossum3901d851996-12-19 16:35:04 +00004737/* Python interface to getprotobyname(name).
4738 This only returns the protocol number, since the other info is
4739 already known or not useful (like the list of aliases). */
4740
4741/*ARGSUSED*/
4742static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00004743socket_getprotobyname(PyObject *self, PyObject *args)
Guido van Rossum3901d851996-12-19 16:35:04 +00004744{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004745 char *name;
4746 struct protoent *sp;
4747 if (!PyArg_ParseTuple(args, "s:getprotobyname", &name))
4748 return NULL;
4749 Py_BEGIN_ALLOW_THREADS
4750 sp = getprotobyname(name);
4751 Py_END_ALLOW_THREADS
4752 if (sp == NULL) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02004753 PyErr_SetString(PyExc_OSError, "protocol not found");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004754 return NULL;
4755 }
4756 return PyLong_FromLong((long) sp->p_proto);
Guido van Rossum3901d851996-12-19 16:35:04 +00004757}
4758
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004759PyDoc_STRVAR(getprotobyname_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00004760"getprotobyname(name) -> integer\n\
4761\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004762Return the protocol number for the named protocol. (Rarely used.)");
Guido van Rossum82a5c661998-07-07 20:45:43 +00004763
Guido van Rossum3901d851996-12-19 16:35:04 +00004764
Guido van Rossum39eb8fa2007-11-16 01:24:05 +00004765#ifndef NO_DUP
4766/* dup() function for socket fds */
4767
4768static PyObject *
4769socket_dup(PyObject *self, PyObject *fdobj)
4770{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004771 SOCKET_T fd, newfd;
4772 PyObject *newfdobj;
Victor Stinnerdaf45552013-08-28 00:53:59 +02004773#ifdef MS_WINDOWS
4774 WSAPROTOCOL_INFO info;
4775#endif
Guido van Rossum39eb8fa2007-11-16 01:24:05 +00004776
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004777 fd = PyLong_AsSocket_t(fdobj);
4778 if (fd == (SOCKET_T)(-1) && PyErr_Occurred())
4779 return NULL;
Guido van Rossum39eb8fa2007-11-16 01:24:05 +00004780
Victor Stinnerdaf45552013-08-28 00:53:59 +02004781#ifdef MS_WINDOWS
4782 if (WSADuplicateSocket(fd, GetCurrentProcessId(), &info))
4783 return set_error();
4784
4785 newfd = WSASocket(FROM_PROTOCOL_INFO, FROM_PROTOCOL_INFO,
4786 FROM_PROTOCOL_INFO,
4787 &info, 0, WSA_FLAG_OVERLAPPED);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004788 if (newfd == INVALID_SOCKET)
4789 return set_error();
Guido van Rossum39eb8fa2007-11-16 01:24:05 +00004790
Victor Stinnerdaf45552013-08-28 00:53:59 +02004791 if (!SetHandleInformation((HANDLE)newfd, HANDLE_FLAG_INHERIT, 0)) {
4792 closesocket(newfd);
4793 PyErr_SetFromWindowsErr(0);
4794 return NULL;
4795 }
4796#else
4797 /* On UNIX, dup can be used to duplicate the file descriptor of a socket */
4798 newfd = _Py_dup(fd);
4799 if (newfd == INVALID_SOCKET)
Victor Stinnere990c6e2013-11-16 00:18:58 +01004800 return NULL;
Victor Stinnerdaf45552013-08-28 00:53:59 +02004801#endif
4802
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004803 newfdobj = PyLong_FromSocket_t(newfd);
4804 if (newfdobj == NULL)
4805 SOCKETCLOSE(newfd);
4806 return newfdobj;
Guido van Rossum39eb8fa2007-11-16 01:24:05 +00004807}
4808
4809PyDoc_STRVAR(dup_doc,
4810"dup(integer) -> integer\n\
4811\n\
4812Duplicate an integer socket file descriptor. This is like os.dup(), but for\n\
4813sockets; on some platforms os.dup() won't work for socket file descriptors.");
4814#endif
4815
4816
Dave Cole331708b2004-08-09 04:51:41 +00004817#ifdef HAVE_SOCKETPAIR
4818/* Create a pair of sockets using the socketpair() function.
Dave Cole07fda7e2004-08-23 05:16:23 +00004819 Arguments as for socket() except the default family is AF_UNIX if
Dave Colee8bbfe42004-08-26 00:51:16 +00004820 defined on the platform; otherwise, the default is AF_INET. */
Dave Cole331708b2004-08-09 04:51:41 +00004821
4822/*ARGSUSED*/
4823static PyObject *
4824socket_socketpair(PyObject *self, PyObject *args)
4825{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004826 PySocketSockObject *s0 = NULL, *s1 = NULL;
4827 SOCKET_T sv[2];
4828 int family, type = SOCK_STREAM, proto = 0;
4829 PyObject *res = NULL;
Victor Stinnerdaf45552013-08-28 00:53:59 +02004830#ifdef SOCK_CLOEXEC
4831 int *atomic_flag_works = &sock_cloexec_works;
4832#else
4833 int *atomic_flag_works = NULL;
4834#endif
4835 int ret;
Dave Cole331708b2004-08-09 04:51:41 +00004836
4837#if defined(AF_UNIX)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004838 family = AF_UNIX;
Dave Cole331708b2004-08-09 04:51:41 +00004839#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004840 family = AF_INET;
Dave Cole331708b2004-08-09 04:51:41 +00004841#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004842 if (!PyArg_ParseTuple(args, "|iii:socketpair",
4843 &family, &type, &proto))
4844 return NULL;
Victor Stinnerdaf45552013-08-28 00:53:59 +02004845
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004846 /* Create a pair of socket fds */
Victor Stinnerdaf45552013-08-28 00:53:59 +02004847 Py_BEGIN_ALLOW_THREADS
4848#ifdef SOCK_CLOEXEC
4849 if (sock_cloexec_works != 0) {
4850 ret = socketpair(family, type | SOCK_CLOEXEC, proto, sv);
4851 if (sock_cloexec_works == -1) {
4852 if (ret >= 0) {
4853 sock_cloexec_works = 1;
4854 }
4855 else if (errno == EINVAL) {
4856 /* Linux older than 2.6.27 does not support SOCK_CLOEXEC */
4857 sock_cloexec_works = 0;
4858 ret = socketpair(family, type, proto, sv);
4859 }
4860 }
4861 }
4862 else
4863#endif
4864 {
4865 ret = socketpair(family, type, proto, sv);
4866 }
4867 Py_END_ALLOW_THREADS
4868
4869 if (ret < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004870 return set_error();
Victor Stinnerdaf45552013-08-28 00:53:59 +02004871
4872 if (_Py_set_inheritable(sv[0], 0, atomic_flag_works) < 0)
4873 goto finally;
4874 if (_Py_set_inheritable(sv[1], 0, atomic_flag_works) < 0)
4875 goto finally;
4876
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004877 s0 = new_sockobject(sv[0], family, type, proto);
4878 if (s0 == NULL)
4879 goto finally;
4880 s1 = new_sockobject(sv[1], family, type, proto);
4881 if (s1 == NULL)
4882 goto finally;
4883 res = PyTuple_Pack(2, s0, s1);
Dave Cole331708b2004-08-09 04:51:41 +00004884
4885finally:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004886 if (res == NULL) {
4887 if (s0 == NULL)
4888 SOCKETCLOSE(sv[0]);
4889 if (s1 == NULL)
4890 SOCKETCLOSE(sv[1]);
4891 }
4892 Py_XDECREF(s0);
4893 Py_XDECREF(s1);
4894 return res;
Dave Cole331708b2004-08-09 04:51:41 +00004895}
4896
4897PyDoc_STRVAR(socketpair_doc,
Victor Stinnerdaf45552013-08-28 00:53:59 +02004898"socketpair([family[, type [, proto]]]) -> (socket object, socket object)\n\
Dave Cole331708b2004-08-09 04:51:41 +00004899\n\
4900Create a pair of socket objects from the sockets returned by the platform\n\
4901socketpair() function.\n\
Dave Cole07fda7e2004-08-23 05:16:23 +00004902The arguments are the same as for socket() except the default family is\n\
Dave Colee8bbfe42004-08-26 00:51:16 +00004903AF_UNIX if defined on the platform; otherwise, the default is AF_INET.");
Dave Cole331708b2004-08-09 04:51:41 +00004904
4905#endif /* HAVE_SOCKETPAIR */
4906
4907
Guido van Rossum006bf911996-06-12 04:04:55 +00004908static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00004909socket_ntohs(PyObject *self, PyObject *args)
Guido van Rossum006bf911996-06-12 04:04:55 +00004910{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004911 int x1, x2;
Guido van Rossum006bf911996-06-12 04:04:55 +00004912
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004913 if (!PyArg_ParseTuple(args, "i:ntohs", &x1)) {
4914 return NULL;
4915 }
4916 if (x1 < 0) {
4917 PyErr_SetString(PyExc_OverflowError,
4918 "can't convert negative number to unsigned long");
4919 return NULL;
4920 }
4921 x2 = (unsigned int)ntohs((unsigned short)x1);
4922 return PyLong_FromLong(x2);
Guido van Rossum006bf911996-06-12 04:04:55 +00004923}
4924
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004925PyDoc_STRVAR(ntohs_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00004926"ntohs(integer) -> integer\n\
4927\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004928Convert a 16-bit integer from network to host byte order.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00004929
4930
Guido van Rossum006bf911996-06-12 04:04:55 +00004931static PyObject *
Jeremy Hyltonc075e192002-07-25 16:01:12 +00004932socket_ntohl(PyObject *self, PyObject *arg)
Guido van Rossum006bf911996-06-12 04:04:55 +00004933{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004934 unsigned long x;
Guido van Rossum006bf911996-06-12 04:04:55 +00004935
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004936 if (PyLong_Check(arg)) {
4937 x = PyLong_AsUnsignedLong(arg);
4938 if (x == (unsigned long) -1 && PyErr_Occurred())
4939 return NULL;
Jeremy Hyltonc075e192002-07-25 16:01:12 +00004940#if SIZEOF_LONG > 4
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004941 {
4942 unsigned long y;
4943 /* only want the trailing 32 bits */
4944 y = x & 0xFFFFFFFFUL;
4945 if (y ^ x)
4946 return PyErr_Format(PyExc_OverflowError,
Serhiy Storchaka95949422013-08-27 19:40:23 +03004947 "int larger than 32 bits");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004948 x = y;
4949 }
Jeremy Hyltonc075e192002-07-25 16:01:12 +00004950#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004951 }
4952 else
4953 return PyErr_Format(PyExc_TypeError,
Serhiy Storchaka95949422013-08-27 19:40:23 +03004954 "expected int, %s found",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004955 Py_TYPE(arg)->tp_name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004956 return PyLong_FromUnsignedLong(ntohl(x));
Guido van Rossum006bf911996-06-12 04:04:55 +00004957}
4958
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004959PyDoc_STRVAR(ntohl_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00004960"ntohl(integer) -> integer\n\
4961\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004962Convert a 32-bit integer from network to host byte order.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00004963
4964
Guido van Rossum006bf911996-06-12 04:04:55 +00004965static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00004966socket_htons(PyObject *self, PyObject *args)
Guido van Rossum006bf911996-06-12 04:04:55 +00004967{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004968 int x1, x2;
Guido van Rossum006bf911996-06-12 04:04:55 +00004969
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004970 if (!PyArg_ParseTuple(args, "i:htons", &x1)) {
4971 return NULL;
4972 }
4973 if (x1 < 0) {
4974 PyErr_SetString(PyExc_OverflowError,
4975 "can't convert negative number to unsigned long");
4976 return NULL;
4977 }
4978 x2 = (unsigned int)htons((unsigned short)x1);
4979 return PyLong_FromLong(x2);
Guido van Rossum006bf911996-06-12 04:04:55 +00004980}
4981
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004982PyDoc_STRVAR(htons_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00004983"htons(integer) -> integer\n\
4984\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004985Convert a 16-bit integer from host to network byte order.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00004986
4987
Guido van Rossum006bf911996-06-12 04:04:55 +00004988static PyObject *
Jeremy Hyltonc075e192002-07-25 16:01:12 +00004989socket_htonl(PyObject *self, PyObject *arg)
Guido van Rossum006bf911996-06-12 04:04:55 +00004990{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004991 unsigned long x;
Guido van Rossum006bf911996-06-12 04:04:55 +00004992
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004993 if (PyLong_Check(arg)) {
4994 x = PyLong_AsUnsignedLong(arg);
4995 if (x == (unsigned long) -1 && PyErr_Occurred())
4996 return NULL;
Jeremy Hyltonc075e192002-07-25 16:01:12 +00004997#if SIZEOF_LONG > 4
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004998 {
4999 unsigned long y;
5000 /* only want the trailing 32 bits */
5001 y = x & 0xFFFFFFFFUL;
5002 if (y ^ x)
5003 return PyErr_Format(PyExc_OverflowError,
Serhiy Storchaka95949422013-08-27 19:40:23 +03005004 "int larger than 32 bits");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005005 x = y;
5006 }
Jeremy Hyltonc075e192002-07-25 16:01:12 +00005007#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005008 }
5009 else
5010 return PyErr_Format(PyExc_TypeError,
Serhiy Storchaka95949422013-08-27 19:40:23 +03005011 "expected int, %s found",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005012 Py_TYPE(arg)->tp_name);
5013 return PyLong_FromUnsignedLong(htonl((unsigned long)x));
Guido van Rossum006bf911996-06-12 04:04:55 +00005014}
5015
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00005016PyDoc_STRVAR(htonl_doc,
Guido van Rossum82a5c661998-07-07 20:45:43 +00005017"htonl(integer) -> integer\n\
5018\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00005019Convert a 32-bit integer from host to network byte order.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00005020
Guido van Rossum3eede5a2002-06-07 02:08:35 +00005021/* socket.inet_aton() and socket.inet_ntoa() functions. */
Guido van Rossum5c9eb211999-08-20 18:21:51 +00005022
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00005023PyDoc_STRVAR(inet_aton_doc,
Guido van Rossum7d0a8262007-05-21 23:13:11 +00005024"inet_aton(string) -> bytes giving packed 32-bit IP representation\n\
Guido van Rossum5c9eb211999-08-20 18:21:51 +00005025\n\
Guido van Rossumc6a164b1999-08-20 19:11:27 +00005026Convert 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 +00005027binary format used in low-level network functions.");
Guido van Rossum5c9eb211999-08-20 18:21:51 +00005028
5029static PyObject*
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00005030socket_inet_aton(PyObject *self, PyObject *args)
Guido van Rossum5c9eb211999-08-20 18:21:51 +00005031{
Neal Norwitz88f115b2003-02-13 02:15:42 +00005032#ifdef HAVE_INET_ATON
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005033 struct in_addr buf;
Thomas Wouters477c8d52006-05-27 19:21:47 +00005034#endif
5035
5036#if !defined(HAVE_INET_ATON) || defined(USE_INET_ATON_WEAKLINK)
Benjamin Petersonf91df042009-02-13 02:50:59 +00005037#if (SIZEOF_INT != 4)
5038#error "Not sure if in_addr_t exists and int is not 32-bits."
5039#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005040 /* Have to use inet_addr() instead */
5041 unsigned int packed_addr;
Tim Peters1df9fdd2003-02-13 03:13:40 +00005042#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005043 char *ip_addr;
Guido van Rossumc6a164b1999-08-20 19:11:27 +00005044
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005045 if (!PyArg_ParseTuple(args, "s:inet_aton", &ip_addr))
5046 return NULL;
Guido van Rossumad05cdf2003-02-12 23:08:22 +00005047
Tim Peters1df9fdd2003-02-13 03:13:40 +00005048
5049#ifdef HAVE_INET_ATON
Thomas Wouters477c8d52006-05-27 19:21:47 +00005050
5051#ifdef USE_INET_ATON_WEAKLINK
5052 if (inet_aton != NULL) {
5053#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005054 if (inet_aton(ip_addr, &buf))
5055 return PyBytes_FromStringAndSize((char *)(&buf),
5056 sizeof(buf));
Guido van Rossumad05cdf2003-02-12 23:08:22 +00005057
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02005058 PyErr_SetString(PyExc_OSError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005059 "illegal IP address string passed to inet_aton");
5060 return NULL;
Guido van Rossumad05cdf2003-02-12 23:08:22 +00005061
Thomas Wouters477c8d52006-05-27 19:21:47 +00005062#ifdef USE_INET_ATON_WEAKLINK
5063 } else {
5064#endif
5065
5066#endif
5067
5068#if !defined(HAVE_INET_ATON) || defined(USE_INET_ATON_WEAKLINK)
5069
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005070 /* special-case this address as inet_addr might return INADDR_NONE
5071 * for this */
5072 if (strcmp(ip_addr, "255.255.255.255") == 0) {
Charles-François Natali24aa0412013-08-31 14:48:25 +02005073 packed_addr = INADDR_BROADCAST;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005074 } else {
Thomas Wouters477c8d52006-05-27 19:21:47 +00005075
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005076 packed_addr = inet_addr(ip_addr);
Guido van Rossumc6a164b1999-08-20 19:11:27 +00005077
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005078 if (packed_addr == INADDR_NONE) { /* invalid address */
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02005079 PyErr_SetString(PyExc_OSError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005080 "illegal IP address string passed to inet_aton");
5081 return NULL;
5082 }
5083 }
5084 return PyBytes_FromStringAndSize((char *) &packed_addr,
5085 sizeof(packed_addr));
Thomas Wouters477c8d52006-05-27 19:21:47 +00005086
5087#ifdef USE_INET_ATON_WEAKLINK
5088 }
5089#endif
5090
Guido van Rossumad05cdf2003-02-12 23:08:22 +00005091#endif
Guido van Rossum5c9eb211999-08-20 18:21:51 +00005092}
5093
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00005094PyDoc_STRVAR(inet_ntoa_doc,
Fred Drakee0661342000-03-07 14:05:16 +00005095"inet_ntoa(packed_ip) -> ip_address_string\n\
Guido van Rossum5c9eb211999-08-20 18:21:51 +00005096\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00005097Convert an IP address from 32-bit packed binary format to string format");
Guido van Rossum5c9eb211999-08-20 18:21:51 +00005098
5099static PyObject*
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00005100socket_inet_ntoa(PyObject *self, PyObject *args)
Guido van Rossum5c9eb211999-08-20 18:21:51 +00005101{
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005102 Py_buffer packed_ip;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005103 struct in_addr packed_addr;
Guido van Rossum5c9eb211999-08-20 18:21:51 +00005104
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005105 if (!PyArg_ParseTuple(args, "y*:inet_ntoa", &packed_ip)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005106 return NULL;
5107 }
Guido van Rossum48a680c2001-03-02 06:34:14 +00005108
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005109 if (packed_ip.len != sizeof(packed_addr)) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02005110 PyErr_SetString(PyExc_OSError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005111 "packed IP wrong length for inet_ntoa");
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005112 PyBuffer_Release(&packed_ip);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005113 return NULL;
5114 }
Guido van Rossum5c9eb211999-08-20 18:21:51 +00005115
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005116 memcpy(&packed_addr, packed_ip.buf, packed_ip.len);
5117 PyBuffer_Release(&packed_ip);
Guido van Rossum5c9eb211999-08-20 18:21:51 +00005118
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005119 return PyUnicode_FromString(inet_ntoa(packed_addr));
Guido van Rossum5c9eb211999-08-20 18:21:51 +00005120}
Guido van Rossum82a5c661998-07-07 20:45:43 +00005121
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005122#if defined(HAVE_INET_PTON) || defined(MS_WINDOWS)
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00005123
5124PyDoc_STRVAR(inet_pton_doc,
5125"inet_pton(af, ip) -> packed IP address string\n\
5126\n\
5127Convert an IP address from string format to a packed string suitable\n\
5128for use with low-level network functions.");
5129
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005130#endif
5131
5132#ifdef HAVE_INET_PTON
5133
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00005134static PyObject *
5135socket_inet_pton(PyObject *self, PyObject *args)
5136{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005137 int af;
5138 char* ip;
5139 int retval;
Martin v. Löwisa94568a2003-05-10 07:36:56 +00005140#ifdef ENABLE_IPV6
Victor Stinner640c35c2013-06-04 23:14:37 +02005141 char packed[Py_MAX(sizeof(struct in_addr), sizeof(struct in6_addr))];
Martin v. Löwisa94568a2003-05-10 07:36:56 +00005142#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005143 char packed[sizeof(struct in_addr)];
Martin v. Löwisa94568a2003-05-10 07:36:56 +00005144#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005145 if (!PyArg_ParseTuple(args, "is:inet_pton", &af, &ip)) {
5146 return NULL;
5147 }
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00005148
Martin v. Löwis04697e82004-06-02 12:35:29 +00005149#if !defined(ENABLE_IPV6) && defined(AF_INET6)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005150 if(af == AF_INET6) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02005151 PyErr_SetString(PyExc_OSError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005152 "can't use AF_INET6, IPv6 is disabled");
5153 return NULL;
5154 }
Thomas Wouters477c8d52006-05-27 19:21:47 +00005155#endif
Martin v. Löwis10649092003-08-05 06:25:06 +00005156
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005157 retval = inet_pton(af, ip, packed);
5158 if (retval < 0) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02005159 PyErr_SetFromErrno(PyExc_OSError);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005160 return NULL;
5161 } else if (retval == 0) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02005162 PyErr_SetString(PyExc_OSError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005163 "illegal IP address string passed to inet_pton");
5164 return NULL;
5165 } else if (af == AF_INET) {
5166 return PyBytes_FromStringAndSize(packed,
5167 sizeof(struct in_addr));
Martin v. Löwisa94568a2003-05-10 07:36:56 +00005168#ifdef ENABLE_IPV6
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005169 } else if (af == AF_INET6) {
5170 return PyBytes_FromStringAndSize(packed,
5171 sizeof(struct in6_addr));
Martin v. Löwisa94568a2003-05-10 07:36:56 +00005172#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005173 } else {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02005174 PyErr_SetString(PyExc_OSError, "unknown address family");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005175 return NULL;
5176 }
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00005177}
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005178#elif defined(MS_WINDOWS)
5179
5180static PyObject *
5181socket_inet_pton(PyObject *self, PyObject *args)
5182{
5183 int af;
5184 char* ip;
5185 struct sockaddr_in6 addr;
5186 INT ret, size;
5187
5188 if (!PyArg_ParseTuple(args, "is:inet_pton", &af, &ip)) {
5189 return NULL;
5190 }
5191
Victor Stinnere990c6e2013-11-16 00:18:58 +01005192 size = sizeof(addr);
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005193 ret = WSAStringToAddressA(ip, af, NULL, (LPSOCKADDR)&addr, &size);
5194
5195 if (ret) {
5196 PyErr_SetExcFromWindowsErr(PyExc_OSError, WSAGetLastError());
5197 return NULL;
5198 } else if(af == AF_INET) {
5199 struct sockaddr_in *addr4 = (struct sockaddr_in*)&addr;
Victor Stinnere990c6e2013-11-16 00:18:58 +01005200 return PyBytes_FromStringAndSize((const char *)&(addr4->sin_addr),
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005201 sizeof(addr4->sin_addr));
5202 } else if (af == AF_INET6) {
Victor Stinnere990c6e2013-11-16 00:18:58 +01005203 return PyBytes_FromStringAndSize((const char *)&(addr.sin6_addr),
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005204 sizeof(addr.sin6_addr));
5205 } else {
5206 PyErr_SetString(PyExc_OSError, "unknown address family");
5207 return NULL;
5208 }
5209}
5210
5211#endif
5212
5213#if defined(HAVE_INET_PTON) || defined(MS_WINDOWS)
Thomas Wouters477c8d52006-05-27 19:21:47 +00005214
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00005215PyDoc_STRVAR(inet_ntop_doc,
5216"inet_ntop(af, packed_ip) -> string formatted IP address\n\
5217\n\
5218Convert a packed IP address of the given family to string format.");
5219
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005220#endif
5221
5222
5223#ifdef HAVE_INET_PTON
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00005224static PyObject *
5225socket_inet_ntop(PyObject *self, PyObject *args)
5226{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005227 int af;
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005228 Py_buffer packed_ip;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005229 const char* retval;
Martin v. Löwisa94568a2003-05-10 07:36:56 +00005230#ifdef ENABLE_IPV6
Victor Stinner640c35c2013-06-04 23:14:37 +02005231 char ip[Py_MAX(INET_ADDRSTRLEN, INET6_ADDRSTRLEN) + 1];
Martin v. Löwisa94568a2003-05-10 07:36:56 +00005232#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005233 char ip[INET_ADDRSTRLEN + 1];
Martin v. Löwisa94568a2003-05-10 07:36:56 +00005234#endif
Thomas Wouters477c8d52006-05-27 19:21:47 +00005235
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005236 /* Guarantee NUL-termination for PyUnicode_FromString() below */
5237 memset((void *) &ip[0], '\0', sizeof(ip));
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00005238
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005239 if (!PyArg_ParseTuple(args, "iy*:inet_ntop", &af, &packed_ip)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005240 return NULL;
5241 }
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00005242
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005243 if (af == AF_INET) {
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005244 if (packed_ip.len != sizeof(struct in_addr)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005245 PyErr_SetString(PyExc_ValueError,
5246 "invalid length of packed IP address string");
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005247 PyBuffer_Release(&packed_ip);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005248 return NULL;
5249 }
Martin v. Löwisa94568a2003-05-10 07:36:56 +00005250#ifdef ENABLE_IPV6
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005251 } else if (af == AF_INET6) {
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005252 if (packed_ip.len != sizeof(struct in6_addr)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005253 PyErr_SetString(PyExc_ValueError,
5254 "invalid length of packed IP address string");
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005255 PyBuffer_Release(&packed_ip);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005256 return NULL;
5257 }
Martin v. Löwisa94568a2003-05-10 07:36:56 +00005258#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005259 } else {
5260 PyErr_Format(PyExc_ValueError,
5261 "unknown address family %d", af);
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005262 PyBuffer_Release(&packed_ip);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005263 return NULL;
5264 }
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00005265
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005266 retval = inet_ntop(af, packed_ip.buf, ip, sizeof(ip));
5267 PyBuffer_Release(&packed_ip);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005268 if (!retval) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02005269 PyErr_SetFromErrno(PyExc_OSError);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005270 return NULL;
5271 } else {
5272 return PyUnicode_FromString(retval);
5273 }
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00005274
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005275 /* NOTREACHED */
5276 PyErr_SetString(PyExc_RuntimeError, "invalid handling of inet_ntop");
5277 return NULL;
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00005278}
5279
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005280#elif defined(MS_WINDOWS)
5281
5282static PyObject *
5283socket_inet_ntop(PyObject *self, PyObject *args)
5284{
5285 int af;
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005286 Py_buffer packed_ip;
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005287 struct sockaddr_in6 addr;
5288 DWORD addrlen, ret, retlen;
Jason R. Coombs8ec784c2013-11-10 13:43:22 -05005289#ifdef ENABLE_IPV6
5290 char ip[Py_MAX(INET_ADDRSTRLEN, INET6_ADDRSTRLEN) + 1];
5291#else
5292 char ip[INET_ADDRSTRLEN + 1];
5293#endif
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005294
5295 /* Guarantee NUL-termination for PyUnicode_FromString() below */
5296 memset((void *) &ip[0], '\0', sizeof(ip));
5297
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005298 if (!PyArg_ParseTuple(args, "iy*:inet_ntop", &af, &packed_ip)) {
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005299 return NULL;
5300 }
5301
5302 if (af == AF_INET) {
5303 struct sockaddr_in * addr4 = (struct sockaddr_in *)&addr;
5304
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005305 if (packed_ip.len != sizeof(struct in_addr)) {
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005306 PyErr_SetString(PyExc_ValueError,
5307 "invalid length of packed IP address string");
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005308 PyBuffer_Release(&packed_ip);
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005309 return NULL;
5310 }
5311 memset(addr4, 0, sizeof(struct sockaddr_in));
5312 addr4->sin_family = AF_INET;
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005313 memcpy(&(addr4->sin_addr), packed_ip.buf, sizeof(addr4->sin_addr));
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005314 addrlen = sizeof(struct sockaddr_in);
5315 } else if (af == AF_INET6) {
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005316 if (packed_ip.len != sizeof(struct in6_addr)) {
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005317 PyErr_SetString(PyExc_ValueError,
5318 "invalid length of packed IP address string");
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005319 PyBuffer_Release(&packed_ip);
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005320 return NULL;
5321 }
5322
5323 memset(&addr, 0, sizeof(addr));
5324 addr.sin6_family = AF_INET6;
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005325 memcpy(&(addr.sin6_addr), packed_ip.buf, sizeof(addr.sin6_addr));
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005326 addrlen = sizeof(addr);
5327 } else {
5328 PyErr_Format(PyExc_ValueError,
5329 "unknown address family %d", af);
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005330 PyBuffer_Release(&packed_ip);
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005331 return NULL;
5332 }
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005333 PyBuffer_Release(&packed_ip);
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005334
5335 retlen = sizeof(ip);
Victor Stinnere990c6e2013-11-16 00:18:58 +01005336 ret = WSAAddressToStringA((struct sockaddr*)&addr, addrlen, NULL,
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005337 ip, &retlen);
5338
5339 if (ret) {
5340 PyErr_SetExcFromWindowsErr(PyExc_OSError, WSAGetLastError());
5341 return NULL;
5342 } else {
5343 return PyUnicode_FromString(ip);
5344 }
5345}
5346
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00005347#endif /* HAVE_INET_PTON */
5348
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00005349/* Python interface to getaddrinfo(host, port). */
5350
5351/*ARGSUSED*/
5352static PyObject *
Giampaolo Rodolàccfb91c2010-08-17 15:30:23 +00005353socket_getaddrinfo(PyObject *self, PyObject *args, PyObject* kwargs)
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00005354{
Victor Stinner77af1722011-05-26 14:05:59 +02005355 static char* kwnames[] = {"host", "port", "family", "type", "proto",
Giampaolo Rodolàccfb91c2010-08-17 15:30:23 +00005356 "flags", 0};
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005357 struct addrinfo hints, *res;
5358 struct addrinfo *res0 = NULL;
5359 PyObject *hobj = NULL;
5360 PyObject *pobj = (PyObject *)NULL;
5361 char pbuf[30];
5362 char *hptr, *pptr;
5363 int family, socktype, protocol, flags;
5364 int error;
5365 PyObject *all = (PyObject *)NULL;
5366 PyObject *idna = NULL;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00005367
Georg Brandl6083a4b2013-10-14 06:51:46 +02005368 socktype = protocol = flags = 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005369 family = AF_UNSPEC;
Victor Stinner77af1722011-05-26 14:05:59 +02005370 if (!PyArg_ParseTupleAndKeywords(args, kwargs, "OO|iiii:getaddrinfo",
Giampaolo Rodolàccfb91c2010-08-17 15:30:23 +00005371 kwnames, &hobj, &pobj, &family, &socktype,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005372 &protocol, &flags)) {
5373 return NULL;
5374 }
5375 if (hobj == Py_None) {
5376 hptr = NULL;
5377 } else if (PyUnicode_Check(hobj)) {
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02005378 _Py_IDENTIFIER(encode);
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02005379
5380 idna = _PyObject_CallMethodId(hobj, &PyId_encode, "s", "idna");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005381 if (!idna)
5382 return NULL;
5383 assert(PyBytes_Check(idna));
5384 hptr = PyBytes_AS_STRING(idna);
5385 } else if (PyBytes_Check(hobj)) {
5386 hptr = PyBytes_AsString(hobj);
5387 } else {
5388 PyErr_SetString(PyExc_TypeError,
5389 "getaddrinfo() argument 1 must be string or None");
5390 return NULL;
5391 }
5392 if (PyLong_CheckExact(pobj)) {
5393 long value = PyLong_AsLong(pobj);
5394 if (value == -1 && PyErr_Occurred())
5395 goto err;
5396 PyOS_snprintf(pbuf, sizeof(pbuf), "%ld", value);
5397 pptr = pbuf;
5398 } else if (PyUnicode_Check(pobj)) {
5399 pptr = _PyUnicode_AsString(pobj);
Alexander Belopolskye239d232010-12-08 23:31:48 +00005400 if (pptr == NULL)
5401 goto err;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005402 } else if (PyBytes_Check(pobj)) {
Alexander Belopolskye239d232010-12-08 23:31:48 +00005403 pptr = PyBytes_AS_STRING(pobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005404 } else if (pobj == Py_None) {
5405 pptr = (char *)NULL;
5406 } else {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02005407 PyErr_SetString(PyExc_OSError, "Int or String expected");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005408 goto err;
5409 }
Ronald Oussorena822d3662013-06-10 10:36:28 +02005410#if defined(__APPLE__) && defined(AI_NUMERICSERV)
Ronald Oussoren27a4ac52013-05-24 13:47:37 +02005411 if ((flags & AI_NUMERICSERV) && (pptr == NULL || (pptr[0] == '0' && pptr[1] == 0))) {
5412 /* On OSX upto at least OSX 10.8 getaddrinfo crashes
Christian Heimesaf01f662013-12-21 16:19:10 +01005413 * if AI_NUMERICSERV is set and the servname is NULL or "0".
5414 * This workaround avoids a segfault in libsystem.
5415 */
Ronald Oussoren27a4ac52013-05-24 13:47:37 +02005416 pptr = "00";
5417 }
5418#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005419 memset(&hints, 0, sizeof(hints));
5420 hints.ai_family = family;
5421 hints.ai_socktype = socktype;
5422 hints.ai_protocol = protocol;
5423 hints.ai_flags = flags;
5424 Py_BEGIN_ALLOW_THREADS
5425 ACQUIRE_GETADDRINFO_LOCK
5426 error = getaddrinfo(hptr, pptr, &hints, &res0);
5427 Py_END_ALLOW_THREADS
5428 RELEASE_GETADDRINFO_LOCK /* see comment in setipaddr() */
5429 if (error) {
5430 set_gaierror(error);
5431 goto err;
5432 }
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00005433
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005434 if ((all = PyList_New(0)) == NULL)
5435 goto err;
5436 for (res = res0; res; res = res->ai_next) {
5437 PyObject *single;
5438 PyObject *addr =
5439 makesockaddr(-1, res->ai_addr, res->ai_addrlen, protocol);
5440 if (addr == NULL)
5441 goto err;
5442 single = Py_BuildValue("iiisO", res->ai_family,
5443 res->ai_socktype, res->ai_protocol,
5444 res->ai_canonname ? res->ai_canonname : "",
5445 addr);
5446 Py_DECREF(addr);
5447 if (single == NULL)
5448 goto err;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00005449
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005450 if (PyList_Append(all, single))
5451 goto err;
5452 Py_XDECREF(single);
5453 }
5454 Py_XDECREF(idna);
5455 if (res0)
5456 freeaddrinfo(res0);
5457 return all;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00005458 err:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005459 Py_XDECREF(all);
5460 Py_XDECREF(idna);
5461 if (res0)
5462 freeaddrinfo(res0);
5463 return (PyObject *)NULL;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00005464}
5465
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00005466PyDoc_STRVAR(getaddrinfo_doc,
Berker Peksaga6ec5ee2014-06-30 11:28:40 +03005467"getaddrinfo(host, port [, family, type, proto, flags])\n\
5468 -> list of (family, type, proto, canonname, sockaddr)\n\
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00005469\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00005470Resolve host and port into addrinfo struct.");
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00005471
5472/* Python interface to getnameinfo(sa, flags). */
5473
5474/*ARGSUSED*/
5475static PyObject *
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00005476socket_getnameinfo(PyObject *self, PyObject *args)
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00005477{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005478 PyObject *sa = (PyObject *)NULL;
5479 int flags;
5480 char *hostp;
Charles-François Natali366999a2012-01-02 15:47:29 +01005481 int port;
5482 unsigned int flowinfo, scope_id;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005483 char hbuf[NI_MAXHOST], pbuf[NI_MAXSERV];
5484 struct addrinfo hints, *res = NULL;
5485 int error;
5486 PyObject *ret = (PyObject *)NULL;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00005487
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005488 flags = flowinfo = scope_id = 0;
5489 if (!PyArg_ParseTuple(args, "Oi:getnameinfo", &sa, &flags))
5490 return NULL;
5491 if (!PyTuple_Check(sa)) {
5492 PyErr_SetString(PyExc_TypeError,
5493 "getnameinfo() argument 1 must be a tuple");
5494 return NULL;
5495 }
Charles-François Natali366999a2012-01-02 15:47:29 +01005496 if (!PyArg_ParseTuple(sa, "si|II",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005497 &hostp, &port, &flowinfo, &scope_id))
5498 return NULL;
Charles-François Natali9b0c0062012-06-23 10:17:05 +02005499 if (flowinfo > 0xfffff) {
Charles-François Natali366999a2012-01-02 15:47:29 +01005500 PyErr_SetString(PyExc_OverflowError,
5501 "getsockaddrarg: flowinfo must be 0-1048575.");
5502 return NULL;
5503 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005504 PyOS_snprintf(pbuf, sizeof(pbuf), "%d", port);
5505 memset(&hints, 0, sizeof(hints));
5506 hints.ai_family = AF_UNSPEC;
5507 hints.ai_socktype = SOCK_DGRAM; /* make numeric port happy */
Martin v. Löwis112c0f32010-08-25 07:38:15 +00005508 hints.ai_flags = AI_NUMERICHOST; /* don't do any name resolution */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005509 Py_BEGIN_ALLOW_THREADS
5510 ACQUIRE_GETADDRINFO_LOCK
5511 error = getaddrinfo(hostp, pbuf, &hints, &res);
5512 Py_END_ALLOW_THREADS
5513 RELEASE_GETADDRINFO_LOCK /* see comment in setipaddr() */
5514 if (error) {
5515 set_gaierror(error);
5516 goto fail;
5517 }
5518 if (res->ai_next) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02005519 PyErr_SetString(PyExc_OSError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005520 "sockaddr resolved to multiple addresses");
5521 goto fail;
5522 }
5523 switch (res->ai_family) {
5524 case AF_INET:
5525 {
5526 if (PyTuple_GET_SIZE(sa) != 2) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02005527 PyErr_SetString(PyExc_OSError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005528 "IPv4 sockaddr must be 2 tuple");
5529 goto fail;
5530 }
5531 break;
5532 }
Martin v. Löwis44ddbde2001-12-02 10:15:37 +00005533#ifdef ENABLE_IPV6
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005534 case AF_INET6:
5535 {
5536 struct sockaddr_in6 *sin6;
5537 sin6 = (struct sockaddr_in6 *)res->ai_addr;
Charles-François Natali366999a2012-01-02 15:47:29 +01005538 sin6->sin6_flowinfo = htonl(flowinfo);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005539 sin6->sin6_scope_id = scope_id;
5540 break;
5541 }
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00005542#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005543 }
Antoine Pitrou19467d22010-08-17 19:33:30 +00005544 error = getnameinfo(res->ai_addr, (socklen_t) res->ai_addrlen,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005545 hbuf, sizeof(hbuf), pbuf, sizeof(pbuf), flags);
5546 if (error) {
5547 set_gaierror(error);
5548 goto fail;
5549 }
5550 ret = Py_BuildValue("ss", hbuf, pbuf);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00005551
5552fail:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005553 if (res)
5554 freeaddrinfo(res);
5555 return ret;
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00005556}
5557
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00005558PyDoc_STRVAR(getnameinfo_doc,
Guido van Rossum22a97152002-08-08 20:37:08 +00005559"getnameinfo(sockaddr, flags) --> (host, port)\n\
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00005560\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00005561Get host and port for a sockaddr.");
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00005562
Guido van Rossum9d0c8ce2002-07-18 17:08:35 +00005563
5564/* Python API to getting and setting the default timeout value. */
5565
5566static PyObject *
5567socket_getdefaulttimeout(PyObject *self)
5568{
Victor Stinner71694d52015-03-28 01:18:54 +01005569 if (defaulttimeout < 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005570 Py_INCREF(Py_None);
5571 return Py_None;
5572 }
Victor Stinner71694d52015-03-28 01:18:54 +01005573 else {
5574 double seconds = _PyTime_AsSecondsDouble(defaulttimeout);
5575 return PyFloat_FromDouble(seconds);
5576 }
Guido van Rossum9d0c8ce2002-07-18 17:08:35 +00005577}
5578
5579PyDoc_STRVAR(getdefaulttimeout_doc,
Guido van Rossum22a97152002-08-08 20:37:08 +00005580"getdefaulttimeout() -> timeout\n\
Guido van Rossum9d0c8ce2002-07-18 17:08:35 +00005581\n\
Ezio Melotti388c9452011-08-14 08:28:57 +03005582Returns the default timeout in seconds (float) for new socket objects.\n\
Guido van Rossum9d0c8ce2002-07-18 17:08:35 +00005583A value of None indicates that new socket objects have no timeout.\n\
5584When the socket module is first imported, the default is None.");
5585
5586static PyObject *
5587socket_setdefaulttimeout(PyObject *self, PyObject *arg)
5588{
Victor Stinner71694d52015-03-28 01:18:54 +01005589 _PyTime_t timeout;
Guido van Rossum9d0c8ce2002-07-18 17:08:35 +00005590
Victor Stinner71694d52015-03-28 01:18:54 +01005591 if (socket_parse_timeout(&timeout, arg) < 0)
5592 return NULL;
Guido van Rossum9d0c8ce2002-07-18 17:08:35 +00005593
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005594 defaulttimeout = timeout;
Guido van Rossum9d0c8ce2002-07-18 17:08:35 +00005595
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005596 Py_INCREF(Py_None);
5597 return Py_None;
Guido van Rossum9d0c8ce2002-07-18 17:08:35 +00005598}
5599
5600PyDoc_STRVAR(setdefaulttimeout_doc,
Guido van Rossum22a97152002-08-08 20:37:08 +00005601"setdefaulttimeout(timeout)\n\
Guido van Rossum9d0c8ce2002-07-18 17:08:35 +00005602\n\
Ezio Melotti388c9452011-08-14 08:28:57 +03005603Set the default timeout in seconds (float) for new socket objects.\n\
Guido van Rossum9d0c8ce2002-07-18 17:08:35 +00005604A value of None indicates that new socket objects have no timeout.\n\
5605When the socket module is first imported, the default is None.");
5606
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005607#ifdef HAVE_IF_NAMEINDEX
5608/* Python API for getting interface indices and names */
5609
5610static PyObject *
5611socket_if_nameindex(PyObject *self, PyObject *arg)
5612{
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005613 PyObject *list;
Charles-François Natali60713592011-05-20 16:55:06 +02005614 int i;
5615 struct if_nameindex *ni;
Victor Stinner77af1722011-05-26 14:05:59 +02005616
Charles-François Natali60713592011-05-20 16:55:06 +02005617 ni = if_nameindex();
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005618 if (ni == NULL) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02005619 PyErr_SetFromErrno(PyExc_OSError);
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005620 return NULL;
5621 }
5622
5623 list = PyList_New(0);
5624 if (list == NULL) {
5625 if_freenameindex(ni);
5626 return NULL;
5627 }
5628
Charles-François Natali60713592011-05-20 16:55:06 +02005629 for (i = 0; ni[i].if_index != 0 && i < INT_MAX; i++) {
5630 PyObject *ni_tuple = Py_BuildValue("IO&",
5631 ni[i].if_index, PyUnicode_DecodeFSDefault, ni[i].if_name);
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005632
5633 if (ni_tuple == NULL || PyList_Append(list, ni_tuple) == -1) {
5634 Py_XDECREF(ni_tuple);
Charles-François Natali60713592011-05-20 16:55:06 +02005635 Py_DECREF(list);
5636 if_freenameindex(ni);
5637 return NULL;
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005638 }
5639 Py_DECREF(ni_tuple);
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005640 }
5641
5642 if_freenameindex(ni);
5643 return list;
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005644}
5645
5646PyDoc_STRVAR(if_nameindex_doc,
5647"if_nameindex()\n\
5648\n\
5649Returns a list of network interface information (index, name) tuples.");
5650
Charles-François Natali60713592011-05-20 16:55:06 +02005651static PyObject *
5652socket_if_nametoindex(PyObject *self, PyObject *args)
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005653{
Charles-François Natali60713592011-05-20 16:55:06 +02005654 PyObject *oname;
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005655 unsigned long index;
5656
Charles-François Natali60713592011-05-20 16:55:06 +02005657 if (!PyArg_ParseTuple(args, "O&:if_nametoindex",
5658 PyUnicode_FSConverter, &oname))
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005659 return NULL;
5660
Charles-François Natali60713592011-05-20 16:55:06 +02005661 index = if_nametoindex(PyBytes_AS_STRING(oname));
5662 Py_DECREF(oname);
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005663 if (index == 0) {
Charles-François Natali60713592011-05-20 16:55:06 +02005664 /* if_nametoindex() doesn't set errno */
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02005665 PyErr_SetString(PyExc_OSError, "no interface with this name");
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005666 return NULL;
5667 }
5668
5669 return PyLong_FromUnsignedLong(index);
5670}
5671
5672PyDoc_STRVAR(if_nametoindex_doc,
5673"if_nametoindex(if_name)\n\
5674\n\
5675Returns the interface index corresponding to the interface name if_name.");
5676
Charles-François Natali60713592011-05-20 16:55:06 +02005677static PyObject *
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005678socket_if_indextoname(PyObject *self, PyObject *arg)
5679{
Charles-François Natali60713592011-05-20 16:55:06 +02005680 unsigned long index;
5681 char name[IF_NAMESIZE + 1];
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005682
Charles-François Natali60713592011-05-20 16:55:06 +02005683 index = PyLong_AsUnsignedLong(arg);
5684 if (index == (unsigned long) -1)
5685 return NULL;
5686
5687 if (if_indextoname(index, name) == NULL) {
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02005688 PyErr_SetFromErrno(PyExc_OSError);
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005689 return NULL;
5690 }
5691
Charles-François Natali60713592011-05-20 16:55:06 +02005692 return PyUnicode_DecodeFSDefault(name);
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005693}
5694
5695PyDoc_STRVAR(if_indextoname_doc,
5696"if_indextoname(if_index)\n\
5697\n\
5698Returns the interface name corresponding to the interface index if_index.");
5699
5700#endif /* HAVE_IF_NAMEINDEX */
5701
5702
Nick Coghlan96fe56a2011-08-22 11:55:57 +10005703#ifdef CMSG_LEN
5704/* Python interface to CMSG_LEN(length). */
5705
5706static PyObject *
5707socket_CMSG_LEN(PyObject *self, PyObject *args)
5708{
5709 Py_ssize_t length;
5710 size_t result;
5711
5712 if (!PyArg_ParseTuple(args, "n:CMSG_LEN", &length))
5713 return NULL;
5714 if (length < 0 || !get_CMSG_LEN(length, &result)) {
5715 PyErr_Format(PyExc_OverflowError, "CMSG_LEN() argument out of range");
5716 return NULL;
5717 }
5718 return PyLong_FromSize_t(result);
5719}
5720
5721PyDoc_STRVAR(CMSG_LEN_doc,
5722"CMSG_LEN(length) -> control message length\n\
5723\n\
5724Return the total length, without trailing padding, of an ancillary\n\
5725data item with associated data of the given length. This value can\n\
5726often be used as the buffer size for recvmsg() to receive a single\n\
5727item of ancillary data, but RFC 3542 requires portable applications to\n\
5728use CMSG_SPACE() and thus include space for padding, even when the\n\
5729item will be the last in the buffer. Raises OverflowError if length\n\
5730is outside the permissible range of values.");
5731
5732
5733#ifdef CMSG_SPACE
5734/* Python interface to CMSG_SPACE(length). */
5735
5736static PyObject *
5737socket_CMSG_SPACE(PyObject *self, PyObject *args)
5738{
5739 Py_ssize_t length;
5740 size_t result;
5741
5742 if (!PyArg_ParseTuple(args, "n:CMSG_SPACE", &length))
5743 return NULL;
5744 if (length < 0 || !get_CMSG_SPACE(length, &result)) {
5745 PyErr_SetString(PyExc_OverflowError,
5746 "CMSG_SPACE() argument out of range");
5747 return NULL;
5748 }
5749 return PyLong_FromSize_t(result);
5750}
5751
5752PyDoc_STRVAR(CMSG_SPACE_doc,
5753"CMSG_SPACE(length) -> buffer size\n\
5754\n\
5755Return the buffer size needed for recvmsg() to receive an ancillary\n\
5756data item with associated data of the given length, along with any\n\
5757trailing padding. The buffer space needed to receive multiple items\n\
5758is the sum of the CMSG_SPACE() values for their associated data\n\
5759lengths. Raises OverflowError if length is outside the permissible\n\
5760range of values.");
5761#endif /* CMSG_SPACE */
5762#endif /* CMSG_LEN */
5763
5764
Guido van Rossum30a685f1991-06-27 15:51:29 +00005765/* List of functions exported by this module. */
5766
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00005767static PyMethodDef socket_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005768 {"gethostbyname", socket_gethostbyname,
5769 METH_VARARGS, gethostbyname_doc},
5770 {"gethostbyname_ex", socket_gethostbyname_ex,
5771 METH_VARARGS, ghbn_ex_doc},
5772 {"gethostbyaddr", socket_gethostbyaddr,
5773 METH_VARARGS, gethostbyaddr_doc},
5774 {"gethostname", socket_gethostname,
5775 METH_NOARGS, gethostname_doc},
Antoine Pitrou061cfb52011-02-28 22:25:22 +00005776#ifdef HAVE_SETHOSTNAME
5777 {"sethostname", socket_sethostname,
5778 METH_VARARGS, sethostname_doc},
5779#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005780 {"getservbyname", socket_getservbyname,
5781 METH_VARARGS, getservbyname_doc},
5782 {"getservbyport", socket_getservbyport,
5783 METH_VARARGS, getservbyport_doc},
5784 {"getprotobyname", socket_getprotobyname,
5785 METH_VARARGS, getprotobyname_doc},
Guido van Rossum39eb8fa2007-11-16 01:24:05 +00005786#ifndef NO_DUP
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005787 {"dup", socket_dup,
5788 METH_O, dup_doc},
Guido van Rossum39eb8fa2007-11-16 01:24:05 +00005789#endif
Dave Cole331708b2004-08-09 04:51:41 +00005790#ifdef HAVE_SOCKETPAIR
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005791 {"socketpair", socket_socketpair,
5792 METH_VARARGS, socketpair_doc},
Dave Cole331708b2004-08-09 04:51:41 +00005793#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005794 {"ntohs", socket_ntohs,
5795 METH_VARARGS, ntohs_doc},
5796 {"ntohl", socket_ntohl,
5797 METH_O, ntohl_doc},
5798 {"htons", socket_htons,
5799 METH_VARARGS, htons_doc},
5800 {"htonl", socket_htonl,
5801 METH_O, htonl_doc},
5802 {"inet_aton", socket_inet_aton,
5803 METH_VARARGS, inet_aton_doc},
5804 {"inet_ntoa", socket_inet_ntoa,
5805 METH_VARARGS, inet_ntoa_doc},
Atsuo Ishimotoda0fc142012-07-16 15:16:54 +09005806#if defined(HAVE_INET_PTON) || defined(MS_WINDOWS)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005807 {"inet_pton", socket_inet_pton,
5808 METH_VARARGS, inet_pton_doc},
5809 {"inet_ntop", socket_inet_ntop,
5810 METH_VARARGS, inet_ntop_doc},
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00005811#endif
Giampaolo Rodolàccfb91c2010-08-17 15:30:23 +00005812 {"getaddrinfo", (PyCFunction)socket_getaddrinfo,
5813 METH_VARARGS | METH_KEYWORDS, getaddrinfo_doc},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005814 {"getnameinfo", socket_getnameinfo,
5815 METH_VARARGS, getnameinfo_doc},
5816 {"getdefaulttimeout", (PyCFunction)socket_getdefaulttimeout,
5817 METH_NOARGS, getdefaulttimeout_doc},
5818 {"setdefaulttimeout", socket_setdefaulttimeout,
5819 METH_O, setdefaulttimeout_doc},
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005820#ifdef HAVE_IF_NAMEINDEX
5821 {"if_nameindex", socket_if_nameindex,
5822 METH_NOARGS, if_nameindex_doc},
5823 {"if_nametoindex", socket_if_nametoindex,
Charles-François Natali60713592011-05-20 16:55:06 +02005824 METH_VARARGS, if_nametoindex_doc},
Gregory P. Smith5ed2e772011-05-15 00:26:45 -07005825 {"if_indextoname", socket_if_indextoname,
5826 METH_O, if_indextoname_doc},
5827#endif
Nick Coghlan96fe56a2011-08-22 11:55:57 +10005828#ifdef CMSG_LEN
5829 {"CMSG_LEN", socket_CMSG_LEN,
5830 METH_VARARGS, CMSG_LEN_doc},
5831#ifdef CMSG_SPACE
5832 {"CMSG_SPACE", socket_CMSG_SPACE,
5833 METH_VARARGS, CMSG_SPACE_doc},
5834#endif
5835#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005836 {NULL, NULL} /* Sentinel */
Guido van Rossum6574b3e1991-06-25 21:36:08 +00005837};
5838
Guido van Rossum30a685f1991-06-27 15:51:29 +00005839
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00005840#ifdef MS_WINDOWS
5841#define OS_INIT_DEFINED
5842
5843/* Additional initialization and cleanup for Windows */
Guido van Rossumbe32c891996-06-20 16:25:29 +00005844
5845static void
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00005846os_cleanup(void)
Guido van Rossumbe32c891996-06-20 16:25:29 +00005847{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005848 WSACleanup();
Guido van Rossumbe32c891996-06-20 16:25:29 +00005849}
5850
5851static int
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00005852os_init(void)
Guido van Rossumbe32c891996-06-20 16:25:29 +00005853{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005854 WSADATA WSAData;
5855 int ret;
5856 ret = WSAStartup(0x0101, &WSAData);
5857 switch (ret) {
5858 case 0: /* No error */
5859 Py_AtExit(os_cleanup);
5860 return 1; /* Success */
5861 case WSASYSNOTREADY:
5862 PyErr_SetString(PyExc_ImportError,
5863 "WSAStartup failed: network not ready");
5864 break;
5865 case WSAVERNOTSUPPORTED:
5866 case WSAEINVAL:
5867 PyErr_SetString(
5868 PyExc_ImportError,
5869 "WSAStartup failed: requested version not supported");
5870 break;
5871 default:
5872 PyErr_Format(PyExc_ImportError, "WSAStartup failed: error code %d", ret);
5873 break;
5874 }
5875 return 0; /* Failure */
Guido van Rossumbe32c891996-06-20 16:25:29 +00005876}
5877
Guido van Rossum8d665e61996-06-26 18:22:49 +00005878#endif /* MS_WINDOWS */
Guido van Rossumbe32c891996-06-20 16:25:29 +00005879
Guido van Rossum8e9ebfd1997-11-22 21:53:48 +00005880
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00005881
5882#ifndef OS_INIT_DEFINED
5883static int
5884os_init(void)
5885{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005886 return 1; /* Success */
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00005887}
5888#endif
5889
5890
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00005891/* C API table - always add new things to the end for binary
5892 compatibility. */
5893static
5894PySocketModule_APIObject PySocketModuleAPI =
5895{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005896 &sock_type,
Antoine Pitrouc4df7842010-12-03 19:59:41 +00005897 NULL,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005898 NULL
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00005899};
5900
Guido van Rossum3eede5a2002-06-07 02:08:35 +00005901
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00005902/* Initialize the _socket module.
Guido van Rossum3eede5a2002-06-07 02:08:35 +00005903
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00005904 This module is actually called "_socket", and there's a wrapper
Guido van Rossum7d0a8262007-05-21 23:13:11 +00005905 "socket.py" which implements some additional functionality.
5906 The import of "_socket" may fail with an ImportError exception if
5907 os-specific initialization fails. On Windows, this does WINSOCK
Ezio Melotti13925002011-03-16 11:05:33 +02005908 initialization. When WINSOCK is initialized successfully, a call to
Guido van Rossum7d0a8262007-05-21 23:13:11 +00005909 WSACleanup() is scheduled to be made at exit time.
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00005910*/
Guido van Rossum3eede5a2002-06-07 02:08:35 +00005911
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00005912PyDoc_STRVAR(socket_doc,
Guido van Rossum22a97152002-08-08 20:37:08 +00005913"Implementation module for socket operations.\n\
5914\n\
5915See the socket module for documentation.");
Guido van Rossum82a5c661998-07-07 20:45:43 +00005916
Martin v. Löwis1a214512008-06-11 05:26:20 +00005917static struct PyModuleDef socketmodule = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005918 PyModuleDef_HEAD_INIT,
5919 PySocket_MODULE_NAME,
5920 socket_doc,
5921 -1,
5922 socket_methods,
5923 NULL,
5924 NULL,
5925 NULL,
5926 NULL
Martin v. Löwis1a214512008-06-11 05:26:20 +00005927};
5928
Mark Hammondfe51c6d2002-08-02 02:27:13 +00005929PyMODINIT_FUNC
Martin v. Löwis1a214512008-06-11 05:26:20 +00005930PyInit__socket(void)
Guido van Rossum6574b3e1991-06-25 21:36:08 +00005931{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005932 PyObject *m, *has_ipv6;
Fred Drake4baedc12002-04-01 14:53:37 +00005933
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005934 if (!os_init())
5935 return NULL;
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00005936
Victor Stinnerdaf45552013-08-28 00:53:59 +02005937#ifdef MS_WINDOWS
5938 if (support_wsa_no_inherit == -1) {
Steve Dower65e4cb12014-11-22 12:54:57 -08005939#if defined(_MSC_VER) && _MSC_VER >= 1800
5940 support_wsa_no_inherit = IsWindows7SP1OrGreater();
5941#else
Victor Stinnerdaf45552013-08-28 00:53:59 +02005942 DWORD version = GetVersion();
5943 DWORD major = (DWORD)LOBYTE(LOWORD(version));
5944 DWORD minor = (DWORD)HIBYTE(LOWORD(version));
5945 /* need Windows 7 SP1, 2008 R2 SP1 or later */
Steve Dower65e4cb12014-11-22 12:54:57 -08005946 support_wsa_no_inherit = major > 6 || (major == 6 && minor >= 1);
5947#endif
Victor Stinnerdaf45552013-08-28 00:53:59 +02005948 }
5949#endif
5950
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005951 Py_TYPE(&sock_type) = &PyType_Type;
5952 m = PyModule_Create(&socketmodule);
5953 if (m == NULL)
5954 return NULL;
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00005955
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02005956 Py_INCREF(PyExc_OSError);
5957 PySocketModuleAPI.error = PyExc_OSError;
5958 Py_INCREF(PyExc_OSError);
5959 PyModule_AddObject(m, "error", PyExc_OSError);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005960 socket_herror = PyErr_NewException("socket.herror",
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02005961 PyExc_OSError, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005962 if (socket_herror == NULL)
5963 return NULL;
5964 Py_INCREF(socket_herror);
5965 PyModule_AddObject(m, "herror", socket_herror);
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02005966 socket_gaierror = PyErr_NewException("socket.gaierror", PyExc_OSError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005967 NULL);
5968 if (socket_gaierror == NULL)
5969 return NULL;
5970 Py_INCREF(socket_gaierror);
5971 PyModule_AddObject(m, "gaierror", socket_gaierror);
5972 socket_timeout = PyErr_NewException("socket.timeout",
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02005973 PyExc_OSError, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005974 if (socket_timeout == NULL)
5975 return NULL;
Antoine Pitrouc4df7842010-12-03 19:59:41 +00005976 PySocketModuleAPI.timeout_error = socket_timeout;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005977 Py_INCREF(socket_timeout);
5978 PyModule_AddObject(m, "timeout", socket_timeout);
5979 Py_INCREF((PyObject *)&sock_type);
5980 if (PyModule_AddObject(m, "SocketType",
5981 (PyObject *)&sock_type) != 0)
5982 return NULL;
5983 Py_INCREF((PyObject *)&sock_type);
5984 if (PyModule_AddObject(m, "socket",
5985 (PyObject *)&sock_type) != 0)
5986 return NULL;
Guido van Rossum09be4091999-08-09 14:40:40 +00005987
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00005988#ifdef ENABLE_IPV6
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005989 has_ipv6 = Py_True;
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00005990#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005991 has_ipv6 = Py_False;
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00005992#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005993 Py_INCREF(has_ipv6);
5994 PyModule_AddObject(m, "has_ipv6", has_ipv6);
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00005995
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005996 /* Export C API */
5997 if (PyModule_AddObject(m, PySocket_CAPI_NAME,
5998 PyCapsule_New(&PySocketModuleAPI, PySocket_CAPSULE_NAME, NULL)
5999 ) != 0)
6000 return NULL;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00006001
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006002 /* Address families (we only support AF_INET and AF_UNIX) */
Guido van Rossum09be4091999-08-09 14:40:40 +00006003#ifdef AF_UNSPEC
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006004 PyModule_AddIntMacro(m, AF_UNSPEC);
Guido van Rossum09be4091999-08-09 14:40:40 +00006005#endif
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006006 PyModule_AddIntMacro(m, AF_INET);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006007#ifdef AF_INET6
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006008 PyModule_AddIntMacro(m, AF_INET6);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006009#endif /* AF_INET6 */
Andrew MacIntyred12dfbb2004-04-04 07:13:49 +00006010#if defined(AF_UNIX)
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006011 PyModule_AddIntMacro(m, AF_UNIX);
Guido van Rossumb6775db1994-08-01 11:34:53 +00006012#endif /* AF_UNIX */
Guido van Rossum09be4091999-08-09 14:40:40 +00006013#ifdef AF_AX25
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006014 /* Amateur Radio AX.25 */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006015 PyModule_AddIntMacro(m, AF_AX25);
Guido van Rossum09be4091999-08-09 14:40:40 +00006016#endif
6017#ifdef AF_IPX
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006018 PyModule_AddIntMacro(m, AF_IPX); /* Novell IPX */
Guido van Rossum09be4091999-08-09 14:40:40 +00006019#endif
6020#ifdef AF_APPLETALK
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006021 /* Appletalk DDP */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006022 PyModule_AddIntMacro(m, AF_APPLETALK);
Guido van Rossum09be4091999-08-09 14:40:40 +00006023#endif
6024#ifdef AF_NETROM
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006025 /* Amateur radio NetROM */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006026 PyModule_AddIntMacro(m, AF_NETROM);
Guido van Rossum09be4091999-08-09 14:40:40 +00006027#endif
6028#ifdef AF_BRIDGE
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006029 /* Multiprotocol bridge */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006030 PyModule_AddIntMacro(m, AF_BRIDGE);
Guido van Rossum09be4091999-08-09 14:40:40 +00006031#endif
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00006032#ifdef AF_ATMPVC
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006033 /* ATM PVCs */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006034 PyModule_AddIntMacro(m, AF_ATMPVC);
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00006035#endif
Guido van Rossum09be4091999-08-09 14:40:40 +00006036#ifdef AF_AAL5
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006037 /* Reserved for Werner's ATM */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006038 PyModule_AddIntMacro(m, AF_AAL5);
Guido van Rossum09be4091999-08-09 14:40:40 +00006039#endif
6040#ifdef AF_X25
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006041 /* Reserved for X.25 project */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006042 PyModule_AddIntMacro(m, AF_X25);
Guido van Rossum09be4091999-08-09 14:40:40 +00006043#endif
6044#ifdef AF_INET6
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006045 PyModule_AddIntMacro(m, AF_INET6); /* IP version 6 */
Guido van Rossum09be4091999-08-09 14:40:40 +00006046#endif
6047#ifdef AF_ROSE
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006048 /* Amateur Radio X.25 PLP */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006049 PyModule_AddIntMacro(m, AF_ROSE);
Guido van Rossum09be4091999-08-09 14:40:40 +00006050#endif
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00006051#ifdef AF_DECnet
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006052 /* Reserved for DECnet project */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006053 PyModule_AddIntMacro(m, AF_DECnet);
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00006054#endif
6055#ifdef AF_NETBEUI
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006056 /* Reserved for 802.2LLC project */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006057 PyModule_AddIntMacro(m, AF_NETBEUI);
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00006058#endif
6059#ifdef AF_SECURITY
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006060 /* Security callback pseudo AF */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006061 PyModule_AddIntMacro(m, AF_SECURITY);
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00006062#endif
6063#ifdef AF_KEY
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006064 /* PF_KEY key management API */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006065 PyModule_AddIntMacro(m, AF_KEY);
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00006066#endif
6067#ifdef AF_NETLINK
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006068 /* */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006069 PyModule_AddIntMacro(m, AF_NETLINK);
6070 PyModule_AddIntMacro(m, NETLINK_ROUTE);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00006071#ifdef NETLINK_SKIP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006072 PyModule_AddIntMacro(m, NETLINK_SKIP);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00006073#endif
6074#ifdef NETLINK_W1
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006075 PyModule_AddIntMacro(m, NETLINK_W1);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00006076#endif
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006077 PyModule_AddIntMacro(m, NETLINK_USERSOCK);
6078 PyModule_AddIntMacro(m, NETLINK_FIREWALL);
Guido van Rossum668a94a2006-02-21 01:07:27 +00006079#ifdef NETLINK_TCPDIAG
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006080 PyModule_AddIntMacro(m, NETLINK_TCPDIAG);
Guido van Rossum668a94a2006-02-21 01:07:27 +00006081#endif
6082#ifdef NETLINK_NFLOG
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006083 PyModule_AddIntMacro(m, NETLINK_NFLOG);
Guido van Rossum668a94a2006-02-21 01:07:27 +00006084#endif
Neal Norwitz65851662006-01-16 04:31:40 +00006085#ifdef NETLINK_XFRM
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006086 PyModule_AddIntMacro(m, NETLINK_XFRM);
Neal Norwitz65851662006-01-16 04:31:40 +00006087#endif
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00006088#ifdef NETLINK_ARPD
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006089 PyModule_AddIntMacro(m, NETLINK_ARPD);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00006090#endif
6091#ifdef NETLINK_ROUTE6
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006092 PyModule_AddIntMacro(m, NETLINK_ROUTE6);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00006093#endif
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006094 PyModule_AddIntMacro(m, NETLINK_IP6_FW);
Thomas Wouterscf297e42007-02-23 15:07:44 +00006095#ifdef NETLINK_DNRTMSG
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006096 PyModule_AddIntMacro(m, NETLINK_DNRTMSG);
Guido van Rossum39eb8fa2007-11-16 01:24:05 +00006097#endif
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00006098#ifdef NETLINK_TAPBASE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006099 PyModule_AddIntMacro(m, NETLINK_TAPBASE);
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00006100#endif
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00006101#endif /* AF_NETLINK */
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00006102#ifdef AF_ROUTE
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006103 /* Alias to emulate 4.4BSD */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006104 PyModule_AddIntMacro(m, AF_ROUTE);
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00006105#endif
Giampaolo Rodola'80e1c432013-05-21 21:02:04 +02006106#ifdef AF_LINK
6107 PyModule_AddIntMacro(m, AF_LINK);
6108#endif
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00006109#ifdef AF_ASH
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006110 /* Ash */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006111 PyModule_AddIntMacro(m, AF_ASH);
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00006112#endif
6113#ifdef AF_ECONET
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006114 /* Acorn Econet */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006115 PyModule_AddIntMacro(m, AF_ECONET);
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00006116#endif
6117#ifdef AF_ATMSVC
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006118 /* ATM SVCs */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006119 PyModule_AddIntMacro(m, AF_ATMSVC);
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00006120#endif
6121#ifdef AF_SNA
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006122 /* Linux SNA Project (nutters!) */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006123 PyModule_AddIntMacro(m, AF_SNA);
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00006124#endif
6125#ifdef AF_IRDA
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006126 /* IRDA sockets */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006127 PyModule_AddIntMacro(m, AF_IRDA);
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00006128#endif
6129#ifdef AF_PPPOX
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006130 /* PPPoX sockets */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006131 PyModule_AddIntMacro(m, AF_PPPOX);
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00006132#endif
6133#ifdef AF_WANPIPE
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006134 /* Wanpipe API Sockets */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006135 PyModule_AddIntMacro(m, AF_WANPIPE);
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00006136#endif
6137#ifdef AF_LLC
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006138 /* Linux LLC */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006139 PyModule_AddIntMacro(m, AF_LLC);
Martin v. Löwis81aec4b2004-07-19 17:01:20 +00006140#endif
Martin v. Löwis12af0482004-01-31 12:34:17 +00006141
Hye-Shik Chang81268602004-02-02 06:05:24 +00006142#ifdef USE_BLUETOOTH
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006143 PyModule_AddIntMacro(m, AF_BLUETOOTH);
6144 PyModule_AddIntMacro(m, BTPROTO_L2CAP);
6145 PyModule_AddIntMacro(m, BTPROTO_HCI);
6146 PyModule_AddIntMacro(m, SOL_HCI);
Gregory P. Smith3e85dfd2010-10-17 00:43:10 +00006147#if !defined(__NetBSD__) && !defined(__DragonFly__)
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006148 PyModule_AddIntMacro(m, HCI_FILTER);
Gregory P. Smith3e85dfd2010-10-17 00:43:10 +00006149#endif
Hye-Shik Chang81268602004-02-02 06:05:24 +00006150#if !defined(__FreeBSD__)
Gregory P. Smith3e85dfd2010-10-17 00:43:10 +00006151#if !defined(__NetBSD__) && !defined(__DragonFly__)
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006152 PyModule_AddIntMacro(m, HCI_TIME_STAMP);
Gregory P. Smith3e85dfd2010-10-17 00:43:10 +00006153#endif
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006154 PyModule_AddIntMacro(m, HCI_DATA_DIR);
6155 PyModule_AddIntMacro(m, BTPROTO_SCO);
Hye-Shik Chang81268602004-02-02 06:05:24 +00006156#endif
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006157 PyModule_AddIntMacro(m, BTPROTO_RFCOMM);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006158 PyModule_AddStringConstant(m, "BDADDR_ANY", "00:00:00:00:00:00");
6159 PyModule_AddStringConstant(m, "BDADDR_LOCAL", "00:00:00:FF:FF:FF");
Martin v. Löwis12af0482004-01-31 12:34:17 +00006160#endif
6161
Charles-François Natali47413c12011-10-06 19:47:44 +02006162#ifdef AF_CAN
6163 /* Controller Area Network */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006164 PyModule_AddIntMacro(m, AF_CAN);
Charles-François Natali47413c12011-10-06 19:47:44 +02006165#endif
6166#ifdef PF_CAN
6167 /* Controller Area Network */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006168 PyModule_AddIntMacro(m, PF_CAN);
Charles-François Natali47413c12011-10-06 19:47:44 +02006169#endif
6170
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006171/* Reliable Datagram Sockets */
6172#ifdef AF_RDS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006173 PyModule_AddIntMacro(m, AF_RDS);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006174#endif
6175#ifdef PF_RDS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006176 PyModule_AddIntMacro(m, PF_RDS);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006177#endif
6178
Martin v. Löwis9d6c6692012-02-03 17:44:58 +01006179/* Kernel event messages */
6180#ifdef PF_SYSTEM
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006181 PyModule_AddIntMacro(m, PF_SYSTEM);
Martin v. Löwis9d6c6692012-02-03 17:44:58 +01006182#endif
6183#ifdef AF_SYSTEM
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006184 PyModule_AddIntMacro(m, AF_SYSTEM);
Martin v. Löwis9d6c6692012-02-03 17:44:58 +01006185#endif
6186
Antoine Pitroub156a462010-10-27 20:13:57 +00006187#ifdef AF_PACKET
6188 PyModule_AddIntMacro(m, AF_PACKET);
6189#endif
6190#ifdef PF_PACKET
6191 PyModule_AddIntMacro(m, PF_PACKET);
6192#endif
6193#ifdef PACKET_HOST
6194 PyModule_AddIntMacro(m, PACKET_HOST);
6195#endif
6196#ifdef PACKET_BROADCAST
6197 PyModule_AddIntMacro(m, PACKET_BROADCAST);
6198#endif
6199#ifdef PACKET_MULTICAST
6200 PyModule_AddIntMacro(m, PACKET_MULTICAST);
6201#endif
6202#ifdef PACKET_OTHERHOST
6203 PyModule_AddIntMacro(m, PACKET_OTHERHOST);
6204#endif
6205#ifdef PACKET_OUTGOING
6206 PyModule_AddIntMacro(m, PACKET_OUTGOING);
6207#endif
6208#ifdef PACKET_LOOPBACK
6209 PyModule_AddIntMacro(m, PACKET_LOOPBACK);
6210#endif
6211#ifdef PACKET_FASTROUTE
6212 PyModule_AddIntMacro(m, PACKET_FASTROUTE);
Guido van Rossum48a680c2001-03-02 06:34:14 +00006213#endif
Guido van Rossum09be4091999-08-09 14:40:40 +00006214
Christian Heimes043d6f62008-01-07 17:19:16 +00006215#ifdef HAVE_LINUX_TIPC_H
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006216 PyModule_AddIntMacro(m, AF_TIPC);
Christian Heimes043d6f62008-01-07 17:19:16 +00006217
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006218 /* for addresses */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006219 PyModule_AddIntMacro(m, TIPC_ADDR_NAMESEQ);
6220 PyModule_AddIntMacro(m, TIPC_ADDR_NAME);
6221 PyModule_AddIntMacro(m, TIPC_ADDR_ID);
Christian Heimes043d6f62008-01-07 17:19:16 +00006222
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006223 PyModule_AddIntMacro(m, TIPC_ZONE_SCOPE);
6224 PyModule_AddIntMacro(m, TIPC_CLUSTER_SCOPE);
6225 PyModule_AddIntMacro(m, TIPC_NODE_SCOPE);
Christian Heimes043d6f62008-01-07 17:19:16 +00006226
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006227 /* for setsockopt() */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006228 PyModule_AddIntMacro(m, SOL_TIPC);
6229 PyModule_AddIntMacro(m, TIPC_IMPORTANCE);
6230 PyModule_AddIntMacro(m, TIPC_SRC_DROPPABLE);
6231 PyModule_AddIntMacro(m, TIPC_DEST_DROPPABLE);
6232 PyModule_AddIntMacro(m, TIPC_CONN_TIMEOUT);
Christian Heimes043d6f62008-01-07 17:19:16 +00006233
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006234 PyModule_AddIntMacro(m, TIPC_LOW_IMPORTANCE);
6235 PyModule_AddIntMacro(m, TIPC_MEDIUM_IMPORTANCE);
6236 PyModule_AddIntMacro(m, TIPC_HIGH_IMPORTANCE);
6237 PyModule_AddIntMacro(m, TIPC_CRITICAL_IMPORTANCE);
Christian Heimes043d6f62008-01-07 17:19:16 +00006238
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006239 /* for subscriptions */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006240 PyModule_AddIntMacro(m, TIPC_SUB_PORTS);
6241 PyModule_AddIntMacro(m, TIPC_SUB_SERVICE);
Christian Heimes25bb7832008-01-11 16:17:00 +00006242#ifdef TIPC_SUB_CANCEL
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006243 /* doesn't seem to be available everywhere */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006244 PyModule_AddIntMacro(m, TIPC_SUB_CANCEL);
Christian Heimes25bb7832008-01-11 16:17:00 +00006245#endif
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006246 PyModule_AddIntMacro(m, TIPC_WAIT_FOREVER);
6247 PyModule_AddIntMacro(m, TIPC_PUBLISHED);
6248 PyModule_AddIntMacro(m, TIPC_WITHDRAWN);
6249 PyModule_AddIntMacro(m, TIPC_SUBSCR_TIMEOUT);
6250 PyModule_AddIntMacro(m, TIPC_CFG_SRV);
6251 PyModule_AddIntMacro(m, TIPC_TOP_SRV);
Christian Heimes043d6f62008-01-07 17:19:16 +00006252#endif
6253
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006254 /* Socket types */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006255 PyModule_AddIntMacro(m, SOCK_STREAM);
6256 PyModule_AddIntMacro(m, SOCK_DGRAM);
Guido van Rossumbcc20741998-08-04 22:53:56 +00006257/* We have incomplete socket support. */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006258 PyModule_AddIntMacro(m, SOCK_RAW);
6259 PyModule_AddIntMacro(m, SOCK_SEQPACKET);
Martin v. Löwiscf8f47e2002-12-11 13:10:57 +00006260#if defined(SOCK_RDM)
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006261 PyModule_AddIntMacro(m, SOCK_RDM);
Guido van Rossumbcc20741998-08-04 22:53:56 +00006262#endif
Antoine Pitroub1c54962010-10-14 15:05:38 +00006263#ifdef SOCK_CLOEXEC
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006264 PyModule_AddIntMacro(m, SOCK_CLOEXEC);
Antoine Pitroub1c54962010-10-14 15:05:38 +00006265#endif
6266#ifdef SOCK_NONBLOCK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006267 PyModule_AddIntMacro(m, SOCK_NONBLOCK);
Antoine Pitroub1c54962010-10-14 15:05:38 +00006268#endif
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006269
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006270#ifdef SO_DEBUG
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006271 PyModule_AddIntMacro(m, SO_DEBUG);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006272#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006273#ifdef SO_ACCEPTCONN
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006274 PyModule_AddIntMacro(m, SO_ACCEPTCONN);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006275#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006276#ifdef SO_REUSEADDR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006277 PyModule_AddIntMacro(m, SO_REUSEADDR);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006278#endif
Andrew M. Kuchling42851ab2004-07-10 14:19:21 +00006279#ifdef SO_EXCLUSIVEADDRUSE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006280 PyModule_AddIntMacro(m, SO_EXCLUSIVEADDRUSE);
Andrew M. Kuchling42851ab2004-07-10 14:19:21 +00006281#endif
6282
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006283#ifdef SO_KEEPALIVE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006284 PyModule_AddIntMacro(m, SO_KEEPALIVE);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006285#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006286#ifdef SO_DONTROUTE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006287 PyModule_AddIntMacro(m, SO_DONTROUTE);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006288#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006289#ifdef SO_BROADCAST
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006290 PyModule_AddIntMacro(m, SO_BROADCAST);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006291#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006292#ifdef SO_USELOOPBACK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006293 PyModule_AddIntMacro(m, SO_USELOOPBACK);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006294#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006295#ifdef SO_LINGER
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006296 PyModule_AddIntMacro(m, SO_LINGER);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006297#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006298#ifdef SO_OOBINLINE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006299 PyModule_AddIntMacro(m, SO_OOBINLINE);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006300#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006301#ifdef SO_REUSEPORT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006302 PyModule_AddIntMacro(m, SO_REUSEPORT);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006303#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006304#ifdef SO_SNDBUF
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006305 PyModule_AddIntMacro(m, SO_SNDBUF);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006306#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006307#ifdef SO_RCVBUF
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006308 PyModule_AddIntMacro(m, SO_RCVBUF);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006309#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006310#ifdef SO_SNDLOWAT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006311 PyModule_AddIntMacro(m, SO_SNDLOWAT);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006312#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006313#ifdef SO_RCVLOWAT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006314 PyModule_AddIntMacro(m, SO_RCVLOWAT);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006315#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006316#ifdef SO_SNDTIMEO
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006317 PyModule_AddIntMacro(m, SO_SNDTIMEO);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006318#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006319#ifdef SO_RCVTIMEO
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006320 PyModule_AddIntMacro(m, SO_RCVTIMEO);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006321#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006322#ifdef SO_ERROR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006323 PyModule_AddIntMacro(m, SO_ERROR);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006324#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006325#ifdef SO_TYPE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006326 PyModule_AddIntMacro(m, SO_TYPE);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006327#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006328#ifdef SO_SETFIB
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006329 PyModule_AddIntMacro(m, SO_SETFIB);
Larry Hastingsf0f37952010-04-02 11:47:10 +00006330#endif
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006331#ifdef SO_PASSCRED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006332 PyModule_AddIntMacro(m, SO_PASSCRED);
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006333#endif
6334#ifdef SO_PEERCRED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006335 PyModule_AddIntMacro(m, SO_PEERCRED);
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006336#endif
6337#ifdef LOCAL_PEERCRED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006338 PyModule_AddIntMacro(m, LOCAL_PEERCRED);
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006339#endif
Victor Stinnercb98bed2011-10-25 13:45:48 +02006340#ifdef SO_BINDTODEVICE
6341 PyModule_AddIntMacro(m, SO_BINDTODEVICE);
6342#endif
Benjamin Peterson1314ef72013-11-27 09:18:54 -06006343#ifdef SO_PRIORITY
6344 PyModule_AddIntMacro(m, SO_PRIORITY);
6345#endif
Charles-François Nataliea07eb92014-09-18 23:18:46 +01006346#ifdef SO_MARK
6347 PyModule_AddIntMacro(m, SO_MARK);
6348#endif
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006349
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006350 /* Maximum number of connections for "listen" */
6351#ifdef SOMAXCONN
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006352 PyModule_AddIntMacro(m, SOMAXCONN);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006353#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006354 PyModule_AddIntConstant(m, "SOMAXCONN", 5); /* Common value */
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006355#endif
6356
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006357 /* Ancilliary message types */
6358#ifdef SCM_RIGHTS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006359 PyModule_AddIntMacro(m, SCM_RIGHTS);
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006360#endif
6361#ifdef SCM_CREDENTIALS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006362 PyModule_AddIntMacro(m, SCM_CREDENTIALS);
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006363#endif
6364#ifdef SCM_CREDS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006365 PyModule_AddIntMacro(m, SCM_CREDS);
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006366#endif
6367
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006368 /* Flags for send, recv */
6369#ifdef MSG_OOB
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006370 PyModule_AddIntMacro(m, MSG_OOB);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006371#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006372#ifdef MSG_PEEK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006373 PyModule_AddIntMacro(m, MSG_PEEK);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006374#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006375#ifdef MSG_DONTROUTE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006376 PyModule_AddIntMacro(m, MSG_DONTROUTE);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006377#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006378#ifdef MSG_DONTWAIT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006379 PyModule_AddIntMacro(m, MSG_DONTWAIT);
Guido van Rossum2c8bcb82000-04-25 21:34:53 +00006380#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006381#ifdef MSG_EOR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006382 PyModule_AddIntMacro(m, MSG_EOR);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006383#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006384#ifdef MSG_TRUNC
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006385 PyModule_AddIntMacro(m, MSG_TRUNC);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006386#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006387#ifdef MSG_CTRUNC
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006388 PyModule_AddIntMacro(m, MSG_CTRUNC);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006389#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006390#ifdef MSG_WAITALL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006391 PyModule_AddIntMacro(m, MSG_WAITALL);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006392#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006393#ifdef MSG_BTAG
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006394 PyModule_AddIntMacro(m, MSG_BTAG);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006395#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006396#ifdef MSG_ETAG
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006397 PyModule_AddIntMacro(m, MSG_ETAG);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006398#endif
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006399#ifdef MSG_NOSIGNAL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006400 PyModule_AddIntMacro(m, MSG_NOSIGNAL);
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006401#endif
6402#ifdef MSG_NOTIFICATION
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006403 PyModule_AddIntMacro(m, MSG_NOTIFICATION);
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006404#endif
6405#ifdef MSG_CMSG_CLOEXEC
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006406 PyModule_AddIntMacro(m, MSG_CMSG_CLOEXEC);
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006407#endif
6408#ifdef MSG_ERRQUEUE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006409 PyModule_AddIntMacro(m, MSG_ERRQUEUE);
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006410#endif
6411#ifdef MSG_CONFIRM
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006412 PyModule_AddIntMacro(m, MSG_CONFIRM);
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006413#endif
6414#ifdef MSG_MORE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006415 PyModule_AddIntMacro(m, MSG_MORE);
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006416#endif
6417#ifdef MSG_EOF
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006418 PyModule_AddIntMacro(m, MSG_EOF);
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006419#endif
6420#ifdef MSG_BCAST
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006421 PyModule_AddIntMacro(m, MSG_BCAST);
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006422#endif
6423#ifdef MSG_MCAST
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006424 PyModule_AddIntMacro(m, MSG_MCAST);
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006425#endif
Benjamin Peterson57b66722012-12-12 22:24:47 -05006426#ifdef MSG_FASTOPEN
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006427 PyModule_AddIntMacro(m, MSG_FASTOPEN);
Benjamin Peterson57b66722012-12-12 22:24:47 -05006428#endif
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006429
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006430 /* Protocol level and numbers, usable for [gs]etsockopt */
6431#ifdef SOL_SOCKET
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006432 PyModule_AddIntMacro(m, SOL_SOCKET);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006433#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006434#ifdef SOL_IP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006435 PyModule_AddIntMacro(m, SOL_IP);
Guido van Rossum09be4091999-08-09 14:40:40 +00006436#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006437 PyModule_AddIntConstant(m, "SOL_IP", 0);
Guido van Rossum09be4091999-08-09 14:40:40 +00006438#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006439#ifdef SOL_IPX
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006440 PyModule_AddIntMacro(m, SOL_IPX);
Guido van Rossum09be4091999-08-09 14:40:40 +00006441#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006442#ifdef SOL_AX25
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006443 PyModule_AddIntMacro(m, SOL_AX25);
Guido van Rossum09be4091999-08-09 14:40:40 +00006444#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006445#ifdef SOL_ATALK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006446 PyModule_AddIntMacro(m, SOL_ATALK);
Guido van Rossum09be4091999-08-09 14:40:40 +00006447#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006448#ifdef SOL_NETROM
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006449 PyModule_AddIntMacro(m, SOL_NETROM);
Guido van Rossum09be4091999-08-09 14:40:40 +00006450#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006451#ifdef SOL_ROSE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006452 PyModule_AddIntMacro(m, SOL_ROSE);
Guido van Rossum09be4091999-08-09 14:40:40 +00006453#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006454#ifdef SOL_TCP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006455 PyModule_AddIntMacro(m, SOL_TCP);
Guido van Rossum09be4091999-08-09 14:40:40 +00006456#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006457 PyModule_AddIntConstant(m, "SOL_TCP", 6);
Guido van Rossum09be4091999-08-09 14:40:40 +00006458#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006459#ifdef SOL_UDP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006460 PyModule_AddIntMacro(m, SOL_UDP);
Guido van Rossum09be4091999-08-09 14:40:40 +00006461#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006462 PyModule_AddIntConstant(m, "SOL_UDP", 17);
Guido van Rossum09be4091999-08-09 14:40:40 +00006463#endif
Charles-François Natali47413c12011-10-06 19:47:44 +02006464#ifdef SOL_CAN_BASE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006465 PyModule_AddIntMacro(m, SOL_CAN_BASE);
Charles-François Natali47413c12011-10-06 19:47:44 +02006466#endif
6467#ifdef SOL_CAN_RAW
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006468 PyModule_AddIntMacro(m, SOL_CAN_RAW);
6469 PyModule_AddIntMacro(m, CAN_RAW);
Charles-François Natali47413c12011-10-06 19:47:44 +02006470#endif
6471#ifdef HAVE_LINUX_CAN_H
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006472 PyModule_AddIntMacro(m, CAN_EFF_FLAG);
6473 PyModule_AddIntMacro(m, CAN_RTR_FLAG);
6474 PyModule_AddIntMacro(m, CAN_ERR_FLAG);
Charles-François Natali47413c12011-10-06 19:47:44 +02006475
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006476 PyModule_AddIntMacro(m, CAN_SFF_MASK);
6477 PyModule_AddIntMacro(m, CAN_EFF_MASK);
6478 PyModule_AddIntMacro(m, CAN_ERR_MASK);
Charles-François Natali47413c12011-10-06 19:47:44 +02006479#endif
6480#ifdef HAVE_LINUX_CAN_RAW_H
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006481 PyModule_AddIntMacro(m, CAN_RAW_FILTER);
6482 PyModule_AddIntMacro(m, CAN_RAW_ERR_FILTER);
6483 PyModule_AddIntMacro(m, CAN_RAW_LOOPBACK);
6484 PyModule_AddIntMacro(m, CAN_RAW_RECV_OWN_MSGS);
Charles-François Natali47413c12011-10-06 19:47:44 +02006485#endif
Charles-François Natali773e42d2013-02-05 19:42:01 +01006486#ifdef HAVE_LINUX_CAN_BCM_H
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006487 PyModule_AddIntMacro(m, CAN_BCM);
Charles-François Natali773e42d2013-02-05 19:42:01 +01006488 PyModule_AddIntConstant(m, "CAN_BCM_TX_SETUP", TX_SETUP);
6489 PyModule_AddIntConstant(m, "CAN_BCM_TX_DELETE", TX_DELETE);
6490 PyModule_AddIntConstant(m, "CAN_BCM_TX_READ", TX_READ);
6491 PyModule_AddIntConstant(m, "CAN_BCM_TX_SEND", TX_SEND);
6492 PyModule_AddIntConstant(m, "CAN_BCM_RX_SETUP", RX_SETUP);
6493 PyModule_AddIntConstant(m, "CAN_BCM_RX_DELETE", RX_DELETE);
6494 PyModule_AddIntConstant(m, "CAN_BCM_RX_READ", RX_READ);
6495 PyModule_AddIntConstant(m, "CAN_BCM_TX_STATUS", TX_STATUS);
6496 PyModule_AddIntConstant(m, "CAN_BCM_TX_EXPIRED", TX_EXPIRED);
6497 PyModule_AddIntConstant(m, "CAN_BCM_RX_STATUS", RX_STATUS);
6498 PyModule_AddIntConstant(m, "CAN_BCM_RX_TIMEOUT", RX_TIMEOUT);
6499 PyModule_AddIntConstant(m, "CAN_BCM_RX_CHANGED", RX_CHANGED);
6500#endif
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006501#ifdef SOL_RDS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006502 PyModule_AddIntMacro(m, SOL_RDS);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006503#endif
6504#ifdef RDS_CANCEL_SENT_TO
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006505 PyModule_AddIntMacro(m, RDS_CANCEL_SENT_TO);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006506#endif
6507#ifdef RDS_GET_MR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006508 PyModule_AddIntMacro(m, RDS_GET_MR);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006509#endif
6510#ifdef RDS_FREE_MR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006511 PyModule_AddIntMacro(m, RDS_FREE_MR);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006512#endif
6513#ifdef RDS_RECVERR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006514 PyModule_AddIntMacro(m, RDS_RECVERR);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006515#endif
6516#ifdef RDS_CONG_MONITOR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006517 PyModule_AddIntMacro(m, RDS_CONG_MONITOR);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006518#endif
6519#ifdef RDS_GET_MR_FOR_DEST
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006520 PyModule_AddIntMacro(m, RDS_GET_MR_FOR_DEST);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006521#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006522#ifdef IPPROTO_IP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006523 PyModule_AddIntMacro(m, IPPROTO_IP);
Guido van Rossum578de301998-05-28 20:18:18 +00006524#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006525 PyModule_AddIntConstant(m, "IPPROTO_IP", 0);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006526#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006527#ifdef IPPROTO_HOPOPTS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006528 PyModule_AddIntMacro(m, IPPROTO_HOPOPTS);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006529#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006530#ifdef IPPROTO_ICMP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006531 PyModule_AddIntMacro(m, IPPROTO_ICMP);
Guido van Rossum578de301998-05-28 20:18:18 +00006532#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006533 PyModule_AddIntConstant(m, "IPPROTO_ICMP", 1);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006534#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006535#ifdef IPPROTO_IGMP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006536 PyModule_AddIntMacro(m, IPPROTO_IGMP);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006537#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006538#ifdef IPPROTO_GGP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006539 PyModule_AddIntMacro(m, IPPROTO_GGP);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006540#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006541#ifdef IPPROTO_IPV4
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006542 PyModule_AddIntMacro(m, IPPROTO_IPV4);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006543#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006544#ifdef IPPROTO_IPV6
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006545 PyModule_AddIntMacro(m, IPPROTO_IPV6);
Martin v. Löwisa0f17342003-10-03 13:56:20 +00006546#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006547#ifdef IPPROTO_IPIP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006548 PyModule_AddIntMacro(m, IPPROTO_IPIP);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006549#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006550#ifdef IPPROTO_TCP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006551 PyModule_AddIntMacro(m, IPPROTO_TCP);
Guido van Rossum578de301998-05-28 20:18:18 +00006552#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006553 PyModule_AddIntConstant(m, "IPPROTO_TCP", 6);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006554#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006555#ifdef IPPROTO_EGP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006556 PyModule_AddIntMacro(m, IPPROTO_EGP);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006557#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006558#ifdef IPPROTO_PUP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006559 PyModule_AddIntMacro(m, IPPROTO_PUP);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006560#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006561#ifdef IPPROTO_UDP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006562 PyModule_AddIntMacro(m, IPPROTO_UDP);
Guido van Rossum578de301998-05-28 20:18:18 +00006563#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006564 PyModule_AddIntConstant(m, "IPPROTO_UDP", 17);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006565#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006566#ifdef IPPROTO_IDP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006567 PyModule_AddIntMacro(m, IPPROTO_IDP);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006568#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006569#ifdef IPPROTO_HELLO
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006570 PyModule_AddIntMacro(m, IPPROTO_HELLO);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006571#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006572#ifdef IPPROTO_ND
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006573 PyModule_AddIntMacro(m, IPPROTO_ND);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006574#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006575#ifdef IPPROTO_TP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006576 PyModule_AddIntMacro(m, IPPROTO_TP);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006577#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006578#ifdef IPPROTO_IPV6
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006579 PyModule_AddIntMacro(m, IPPROTO_IPV6);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006580#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006581#ifdef IPPROTO_ROUTING
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006582 PyModule_AddIntMacro(m, IPPROTO_ROUTING);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006583#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006584#ifdef IPPROTO_FRAGMENT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006585 PyModule_AddIntMacro(m, IPPROTO_FRAGMENT);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006586#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006587#ifdef IPPROTO_RSVP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006588 PyModule_AddIntMacro(m, IPPROTO_RSVP);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006589#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006590#ifdef IPPROTO_GRE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006591 PyModule_AddIntMacro(m, IPPROTO_GRE);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006592#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006593#ifdef IPPROTO_ESP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006594 PyModule_AddIntMacro(m, IPPROTO_ESP);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006595#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006596#ifdef IPPROTO_AH
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006597 PyModule_AddIntMacro(m, IPPROTO_AH);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006598#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006599#ifdef IPPROTO_MOBILE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006600 PyModule_AddIntMacro(m, IPPROTO_MOBILE);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006601#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006602#ifdef IPPROTO_ICMPV6
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006603 PyModule_AddIntMacro(m, IPPROTO_ICMPV6);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006604#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006605#ifdef IPPROTO_NONE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006606 PyModule_AddIntMacro(m, IPPROTO_NONE);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006607#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006608#ifdef IPPROTO_DSTOPTS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006609 PyModule_AddIntMacro(m, IPPROTO_DSTOPTS);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006610#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006611#ifdef IPPROTO_XTP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006612 PyModule_AddIntMacro(m, IPPROTO_XTP);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006613#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006614#ifdef IPPROTO_EON
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006615 PyModule_AddIntMacro(m, IPPROTO_EON);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006616#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006617#ifdef IPPROTO_PIM
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006618 PyModule_AddIntMacro(m, IPPROTO_PIM);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006619#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006620#ifdef IPPROTO_IPCOMP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006621 PyModule_AddIntMacro(m, IPPROTO_IPCOMP);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006622#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006623#ifdef IPPROTO_VRRP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006624 PyModule_AddIntMacro(m, IPPROTO_VRRP);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006625#endif
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006626#ifdef IPPROTO_SCTP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006627 PyModule_AddIntMacro(m, IPPROTO_SCTP);
Nick Coghlan96fe56a2011-08-22 11:55:57 +10006628#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006629#ifdef IPPROTO_BIP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006630 PyModule_AddIntMacro(m, IPPROTO_BIP);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006631#endif
6632/**/
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006633#ifdef IPPROTO_RAW
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006634 PyModule_AddIntMacro(m, IPPROTO_RAW);
Guido van Rossum578de301998-05-28 20:18:18 +00006635#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006636 PyModule_AddIntConstant(m, "IPPROTO_RAW", 255);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006637#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006638#ifdef IPPROTO_MAX
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006639 PyModule_AddIntMacro(m, IPPROTO_MAX);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006640#endif
6641
Martin v. Löwis9d6c6692012-02-03 17:44:58 +01006642#ifdef SYSPROTO_CONTROL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006643 PyModule_AddIntMacro(m, SYSPROTO_CONTROL);
Martin v. Löwis9d6c6692012-02-03 17:44:58 +01006644#endif
6645
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006646 /* Some port configuration */
6647#ifdef IPPORT_RESERVED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006648 PyModule_AddIntMacro(m, IPPORT_RESERVED);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006649#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006650 PyModule_AddIntConstant(m, "IPPORT_RESERVED", 1024);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006651#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006652#ifdef IPPORT_USERRESERVED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006653 PyModule_AddIntMacro(m, IPPORT_USERRESERVED);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006654#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006655 PyModule_AddIntConstant(m, "IPPORT_USERRESERVED", 5000);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006656#endif
6657
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006658 /* Some reserved IP v.4 addresses */
6659#ifdef INADDR_ANY
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006660 PyModule_AddIntMacro(m, INADDR_ANY);
Guido van Rossum5f05eb41995-02-17 15:11:07 +00006661#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006662 PyModule_AddIntConstant(m, "INADDR_ANY", 0x00000000);
Guido van Rossum5f05eb41995-02-17 15:11:07 +00006663#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006664#ifdef INADDR_BROADCAST
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006665 PyModule_AddIntMacro(m, INADDR_BROADCAST);
Guido van Rossum5f05eb41995-02-17 15:11:07 +00006666#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006667 PyModule_AddIntConstant(m, "INADDR_BROADCAST", 0xffffffff);
Guido van Rossum5f05eb41995-02-17 15:11:07 +00006668#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006669#ifdef INADDR_LOOPBACK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006670 PyModule_AddIntMacro(m, INADDR_LOOPBACK);
Guido van Rossum5f05eb41995-02-17 15:11:07 +00006671#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006672 PyModule_AddIntConstant(m, "INADDR_LOOPBACK", 0x7F000001);
Guido van Rossum5f05eb41995-02-17 15:11:07 +00006673#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006674#ifdef INADDR_UNSPEC_GROUP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006675 PyModule_AddIntMacro(m, INADDR_UNSPEC_GROUP);
Guido van Rossum5f05eb41995-02-17 15:11:07 +00006676#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006677 PyModule_AddIntConstant(m, "INADDR_UNSPEC_GROUP", 0xe0000000);
Guido van Rossum5f05eb41995-02-17 15:11:07 +00006678#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006679#ifdef INADDR_ALLHOSTS_GROUP
6680 PyModule_AddIntConstant(m, "INADDR_ALLHOSTS_GROUP",
6681 INADDR_ALLHOSTS_GROUP);
Guido van Rossum5f05eb41995-02-17 15:11:07 +00006682#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006683 PyModule_AddIntConstant(m, "INADDR_ALLHOSTS_GROUP", 0xe0000001);
Guido van Rossum5f05eb41995-02-17 15:11:07 +00006684#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006685#ifdef INADDR_MAX_LOCAL_GROUP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006686 PyModule_AddIntMacro(m, INADDR_MAX_LOCAL_GROUP);
Guido van Rossum5f05eb41995-02-17 15:11:07 +00006687#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006688 PyModule_AddIntConstant(m, "INADDR_MAX_LOCAL_GROUP", 0xe00000ff);
Guido van Rossum5f05eb41995-02-17 15:11:07 +00006689#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006690#ifdef INADDR_NONE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006691 PyModule_AddIntMacro(m, INADDR_NONE);
Guido van Rossum5f05eb41995-02-17 15:11:07 +00006692#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006693 PyModule_AddIntConstant(m, "INADDR_NONE", 0xffffffff);
Guido van Rossum5f05eb41995-02-17 15:11:07 +00006694#endif
6695
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006696 /* IPv4 [gs]etsockopt options */
6697#ifdef IP_OPTIONS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006698 PyModule_AddIntMacro(m, IP_OPTIONS);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006699#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006700#ifdef IP_HDRINCL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006701 PyModule_AddIntMacro(m, IP_HDRINCL);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006702#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006703#ifdef IP_TOS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006704 PyModule_AddIntMacro(m, IP_TOS);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006705#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006706#ifdef IP_TTL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006707 PyModule_AddIntMacro(m, IP_TTL);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006708#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006709#ifdef IP_RECVOPTS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006710 PyModule_AddIntMacro(m, IP_RECVOPTS);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006711#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006712#ifdef IP_RECVRETOPTS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006713 PyModule_AddIntMacro(m, IP_RECVRETOPTS);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006714#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006715#ifdef IP_RECVDSTADDR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006716 PyModule_AddIntMacro(m, IP_RECVDSTADDR);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006717#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006718#ifdef IP_RETOPTS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006719 PyModule_AddIntMacro(m, IP_RETOPTS);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006720#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006721#ifdef IP_MULTICAST_IF
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006722 PyModule_AddIntMacro(m, IP_MULTICAST_IF);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006723#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006724#ifdef IP_MULTICAST_TTL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006725 PyModule_AddIntMacro(m, IP_MULTICAST_TTL);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006726#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006727#ifdef IP_MULTICAST_LOOP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006728 PyModule_AddIntMacro(m, IP_MULTICAST_LOOP);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006729#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006730#ifdef IP_ADD_MEMBERSHIP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006731 PyModule_AddIntMacro(m, IP_ADD_MEMBERSHIP);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006732#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006733#ifdef IP_DROP_MEMBERSHIP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006734 PyModule_AddIntMacro(m, IP_DROP_MEMBERSHIP);
Guido van Rossum3fdf58b1995-02-07 15:39:52 +00006735#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006736#ifdef IP_DEFAULT_MULTICAST_TTL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006737 PyModule_AddIntMacro(m, IP_DEFAULT_MULTICAST_TTL);
Guido van Rossum09be4091999-08-09 14:40:40 +00006738#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006739#ifdef IP_DEFAULT_MULTICAST_LOOP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006740 PyModule_AddIntMacro(m, IP_DEFAULT_MULTICAST_LOOP);
Guido van Rossum09be4091999-08-09 14:40:40 +00006741#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006742#ifdef IP_MAX_MEMBERSHIPS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006743 PyModule_AddIntMacro(m, IP_MAX_MEMBERSHIPS);
Guido van Rossum09be4091999-08-09 14:40:40 +00006744#endif
Charles-François Natali564a42c2011-12-17 14:59:56 +01006745#ifdef IP_TRANSPARENT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006746 PyModule_AddIntMacro(m, IP_TRANSPARENT);
Charles-François Natali564a42c2011-12-17 14:59:56 +01006747#endif
Guido van Rossum09be4091999-08-09 14:40:40 +00006748
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006749 /* IPv6 [gs]etsockopt options, defined in RFC2553 */
6750#ifdef IPV6_JOIN_GROUP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006751 PyModule_AddIntMacro(m, IPV6_JOIN_GROUP);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006752#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006753#ifdef IPV6_LEAVE_GROUP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006754 PyModule_AddIntMacro(m, IPV6_LEAVE_GROUP);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006755#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006756#ifdef IPV6_MULTICAST_HOPS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006757 PyModule_AddIntMacro(m, IPV6_MULTICAST_HOPS);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006758#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006759#ifdef IPV6_MULTICAST_IF
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006760 PyModule_AddIntMacro(m, IPV6_MULTICAST_IF);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006761#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006762#ifdef IPV6_MULTICAST_LOOP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006763 PyModule_AddIntMacro(m, IPV6_MULTICAST_LOOP);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006764#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006765#ifdef IPV6_UNICAST_HOPS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006766 PyModule_AddIntMacro(m, IPV6_UNICAST_HOPS);
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006767#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006768 /* Additional IPV6 socket options, defined in RFC 3493 */
Martin v. Löwisda91d022003-12-30 11:14:01 +00006769#ifdef IPV6_V6ONLY
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006770 PyModule_AddIntMacro(m, IPV6_V6ONLY);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006771#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006772 /* Advanced IPV6 socket options, from RFC 3542 */
Martin v. Löwisda91d022003-12-30 11:14:01 +00006773#ifdef IPV6_CHECKSUM
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006774 PyModule_AddIntMacro(m, IPV6_CHECKSUM);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006775#endif
6776#ifdef IPV6_DONTFRAG
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006777 PyModule_AddIntMacro(m, IPV6_DONTFRAG);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006778#endif
6779#ifdef IPV6_DSTOPTS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006780 PyModule_AddIntMacro(m, IPV6_DSTOPTS);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006781#endif
6782#ifdef IPV6_HOPLIMIT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006783 PyModule_AddIntMacro(m, IPV6_HOPLIMIT);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006784#endif
6785#ifdef IPV6_HOPOPTS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006786 PyModule_AddIntMacro(m, IPV6_HOPOPTS);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006787#endif
6788#ifdef IPV6_NEXTHOP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006789 PyModule_AddIntMacro(m, IPV6_NEXTHOP);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006790#endif
6791#ifdef IPV6_PATHMTU
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006792 PyModule_AddIntMacro(m, IPV6_PATHMTU);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006793#endif
6794#ifdef IPV6_PKTINFO
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006795 PyModule_AddIntMacro(m, IPV6_PKTINFO);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006796#endif
6797#ifdef IPV6_RECVDSTOPTS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006798 PyModule_AddIntMacro(m, IPV6_RECVDSTOPTS);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006799#endif
6800#ifdef IPV6_RECVHOPLIMIT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006801 PyModule_AddIntMacro(m, IPV6_RECVHOPLIMIT);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006802#endif
6803#ifdef IPV6_RECVHOPOPTS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006804 PyModule_AddIntMacro(m, IPV6_RECVHOPOPTS);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006805#endif
6806#ifdef IPV6_RECVPKTINFO
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006807 PyModule_AddIntMacro(m, IPV6_RECVPKTINFO);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006808#endif
6809#ifdef IPV6_RECVRTHDR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006810 PyModule_AddIntMacro(m, IPV6_RECVRTHDR);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006811#endif
6812#ifdef IPV6_RECVTCLASS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006813 PyModule_AddIntMacro(m, IPV6_RECVTCLASS);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006814#endif
6815#ifdef IPV6_RTHDR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006816 PyModule_AddIntMacro(m, IPV6_RTHDR);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006817#endif
6818#ifdef IPV6_RTHDRDSTOPTS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006819 PyModule_AddIntMacro(m, IPV6_RTHDRDSTOPTS);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006820#endif
6821#ifdef IPV6_RTHDR_TYPE_0
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006822 PyModule_AddIntMacro(m, IPV6_RTHDR_TYPE_0);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006823#endif
6824#ifdef IPV6_RECVPATHMTU
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006825 PyModule_AddIntMacro(m, IPV6_RECVPATHMTU);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006826#endif
6827#ifdef IPV6_TCLASS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006828 PyModule_AddIntMacro(m, IPV6_TCLASS);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006829#endif
6830#ifdef IPV6_USE_MIN_MTU
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006831 PyModule_AddIntMacro(m, IPV6_USE_MIN_MTU);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006832#endif
Martin v. Löwisbcf4b352001-08-04 22:37:23 +00006833
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006834 /* TCP options */
6835#ifdef TCP_NODELAY
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006836 PyModule_AddIntMacro(m, TCP_NODELAY);
Guido van Rossum09be4091999-08-09 14:40:40 +00006837#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006838#ifdef TCP_MAXSEG
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006839 PyModule_AddIntMacro(m, TCP_MAXSEG);
Guido van Rossum09be4091999-08-09 14:40:40 +00006840#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006841#ifdef TCP_CORK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006842 PyModule_AddIntMacro(m, TCP_CORK);
Martin v. Löwis3cde2cb2001-12-22 15:05:32 +00006843#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006844#ifdef TCP_KEEPIDLE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006845 PyModule_AddIntMacro(m, TCP_KEEPIDLE);
Martin v. Löwis3cde2cb2001-12-22 15:05:32 +00006846#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006847#ifdef TCP_KEEPINTVL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006848 PyModule_AddIntMacro(m, TCP_KEEPINTVL);
Martin v. Löwis3cde2cb2001-12-22 15:05:32 +00006849#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006850#ifdef TCP_KEEPCNT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006851 PyModule_AddIntMacro(m, TCP_KEEPCNT);
Martin v. Löwis3cde2cb2001-12-22 15:05:32 +00006852#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006853#ifdef TCP_SYNCNT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006854 PyModule_AddIntMacro(m, TCP_SYNCNT);
Martin v. Löwis3cde2cb2001-12-22 15:05:32 +00006855#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006856#ifdef TCP_LINGER2
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006857 PyModule_AddIntMacro(m, TCP_LINGER2);
Martin v. Löwis3cde2cb2001-12-22 15:05:32 +00006858#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006859#ifdef TCP_DEFER_ACCEPT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006860 PyModule_AddIntMacro(m, TCP_DEFER_ACCEPT);
Martin v. Löwis3cde2cb2001-12-22 15:05:32 +00006861#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006862#ifdef TCP_WINDOW_CLAMP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006863 PyModule_AddIntMacro(m, TCP_WINDOW_CLAMP);
Martin v. Löwis3cde2cb2001-12-22 15:05:32 +00006864#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006865#ifdef TCP_INFO
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006866 PyModule_AddIntMacro(m, TCP_INFO);
Martin v. Löwis3cde2cb2001-12-22 15:05:32 +00006867#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006868#ifdef TCP_QUICKACK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006869 PyModule_AddIntMacro(m, TCP_QUICKACK);
Martin v. Löwis3cde2cb2001-12-22 15:05:32 +00006870#endif
Benjamin Peterson57b66722012-12-12 22:24:47 -05006871#ifdef TCP_FASTOPEN
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006872 PyModule_AddIntMacro(m, TCP_FASTOPEN);
Benjamin Peterson57b66722012-12-12 22:24:47 -05006873#endif
Guido van Rossum09be4091999-08-09 14:40:40 +00006874
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006875 /* IPX options */
6876#ifdef IPX_TYPE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006877 PyModule_AddIntMacro(m, IPX_TYPE);
Guido van Rossum09be4091999-08-09 14:40:40 +00006878#endif
Guido van Rossum4f199ea1998-04-09 20:56:35 +00006879
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006880/* Reliable Datagram Sockets */
6881#ifdef RDS_CMSG_RDMA_ARGS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006882 PyModule_AddIntMacro(m, RDS_CMSG_RDMA_ARGS);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006883#endif
6884#ifdef RDS_CMSG_RDMA_DEST
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006885 PyModule_AddIntMacro(m, RDS_CMSG_RDMA_DEST);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006886#endif
6887#ifdef RDS_CMSG_RDMA_MAP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006888 PyModule_AddIntMacro(m, RDS_CMSG_RDMA_MAP);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006889#endif
6890#ifdef RDS_CMSG_RDMA_STATUS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006891 PyModule_AddIntMacro(m, RDS_CMSG_RDMA_STATUS);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006892#endif
6893#ifdef RDS_CMSG_RDMA_UPDATE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006894 PyModule_AddIntMacro(m, RDS_CMSG_RDMA_UPDATE);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006895#endif
6896#ifdef RDS_RDMA_READWRITE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006897 PyModule_AddIntMacro(m, RDS_RDMA_READWRITE);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006898#endif
6899#ifdef RDS_RDMA_FENCE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006900 PyModule_AddIntMacro(m, RDS_RDMA_FENCE);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006901#endif
6902#ifdef RDS_RDMA_INVALIDATE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006903 PyModule_AddIntMacro(m, RDS_RDMA_INVALIDATE);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006904#endif
6905#ifdef RDS_RDMA_USE_ONCE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006906 PyModule_AddIntMacro(m, RDS_RDMA_USE_ONCE);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006907#endif
6908#ifdef RDS_RDMA_DONTWAIT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006909 PyModule_AddIntMacro(m, RDS_RDMA_DONTWAIT);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006910#endif
6911#ifdef RDS_RDMA_NOTIFY_ME
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006912 PyModule_AddIntMacro(m, RDS_RDMA_NOTIFY_ME);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006913#endif
6914#ifdef RDS_RDMA_SILENT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006915 PyModule_AddIntMacro(m, RDS_RDMA_SILENT);
Charles-François Natali10b8cf42011-11-10 19:21:37 +01006916#endif
6917
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006918 /* get{addr,name}info parameters */
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006919#ifdef EAI_ADDRFAMILY
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006920 PyModule_AddIntMacro(m, EAI_ADDRFAMILY);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006921#endif
6922#ifdef EAI_AGAIN
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006923 PyModule_AddIntMacro(m, EAI_AGAIN);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006924#endif
6925#ifdef EAI_BADFLAGS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006926 PyModule_AddIntMacro(m, EAI_BADFLAGS);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006927#endif
6928#ifdef EAI_FAIL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006929 PyModule_AddIntMacro(m, EAI_FAIL);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006930#endif
6931#ifdef EAI_FAMILY
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006932 PyModule_AddIntMacro(m, EAI_FAMILY);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006933#endif
6934#ifdef EAI_MEMORY
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006935 PyModule_AddIntMacro(m, EAI_MEMORY);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006936#endif
6937#ifdef EAI_NODATA
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006938 PyModule_AddIntMacro(m, EAI_NODATA);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006939#endif
6940#ifdef EAI_NONAME
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006941 PyModule_AddIntMacro(m, EAI_NONAME);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006942#endif
Martin v. Löwisda91d022003-12-30 11:14:01 +00006943#ifdef EAI_OVERFLOW
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006944 PyModule_AddIntMacro(m, EAI_OVERFLOW);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006945#endif
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006946#ifdef EAI_SERVICE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006947 PyModule_AddIntMacro(m, EAI_SERVICE);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006948#endif
6949#ifdef EAI_SOCKTYPE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006950 PyModule_AddIntMacro(m, EAI_SOCKTYPE);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006951#endif
6952#ifdef EAI_SYSTEM
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006953 PyModule_AddIntMacro(m, EAI_SYSTEM);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006954#endif
6955#ifdef EAI_BADHINTS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006956 PyModule_AddIntMacro(m, EAI_BADHINTS);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006957#endif
6958#ifdef EAI_PROTOCOL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006959 PyModule_AddIntMacro(m, EAI_PROTOCOL);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006960#endif
6961#ifdef EAI_MAX
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006962 PyModule_AddIntMacro(m, EAI_MAX);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006963#endif
6964#ifdef AI_PASSIVE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006965 PyModule_AddIntMacro(m, AI_PASSIVE);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006966#endif
6967#ifdef AI_CANONNAME
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006968 PyModule_AddIntMacro(m, AI_CANONNAME);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006969#endif
6970#ifdef AI_NUMERICHOST
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006971 PyModule_AddIntMacro(m, AI_NUMERICHOST);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006972#endif
Martin v. Löwisda91d022003-12-30 11:14:01 +00006973#ifdef AI_NUMERICSERV
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006974 PyModule_AddIntMacro(m, AI_NUMERICSERV);
Martin v. Löwisda91d022003-12-30 11:14:01 +00006975#endif
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006976#ifdef AI_MASK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006977 PyModule_AddIntMacro(m, AI_MASK);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006978#endif
6979#ifdef AI_ALL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006980 PyModule_AddIntMacro(m, AI_ALL);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006981#endif
6982#ifdef AI_V4MAPPED_CFG
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006983 PyModule_AddIntMacro(m, AI_V4MAPPED_CFG);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006984#endif
6985#ifdef AI_ADDRCONFIG
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006986 PyModule_AddIntMacro(m, AI_ADDRCONFIG);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006987#endif
6988#ifdef AI_V4MAPPED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006989 PyModule_AddIntMacro(m, AI_V4MAPPED);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006990#endif
6991#ifdef AI_DEFAULT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006992 PyModule_AddIntMacro(m, AI_DEFAULT);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006993#endif
6994#ifdef NI_MAXHOST
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006995 PyModule_AddIntMacro(m, NI_MAXHOST);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006996#endif
6997#ifdef NI_MAXSERV
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006998 PyModule_AddIntMacro(m, NI_MAXSERV);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00006999#endif
7000#ifdef NI_NOFQDN
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007001 PyModule_AddIntMacro(m, NI_NOFQDN);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00007002#endif
7003#ifdef NI_NUMERICHOST
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007004 PyModule_AddIntMacro(m, NI_NUMERICHOST);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00007005#endif
7006#ifdef NI_NAMEREQD
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007007 PyModule_AddIntMacro(m, NI_NAMEREQD);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00007008#endif
7009#ifdef NI_NUMERICSERV
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007010 PyModule_AddIntMacro(m, NI_NUMERICSERV);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00007011#endif
7012#ifdef NI_DGRAM
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007013 PyModule_AddIntMacro(m, NI_DGRAM);
Martin v. Löwis2d8d4272001-07-21 18:05:31 +00007014#endif
7015
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00007016 /* shutdown() parameters */
Martin v. Löwis94681fc2003-11-27 19:40:22 +00007017#ifdef SHUT_RD
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007018 PyModule_AddIntMacro(m, SHUT_RD);
Martin v. Löwis94681fc2003-11-27 19:40:22 +00007019#elif defined(SD_RECEIVE)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00007020 PyModule_AddIntConstant(m, "SHUT_RD", SD_RECEIVE);
Martin v. Löwis94681fc2003-11-27 19:40:22 +00007021#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00007022 PyModule_AddIntConstant(m, "SHUT_RD", 0);
Martin v. Löwis94681fc2003-11-27 19:40:22 +00007023#endif
7024#ifdef SHUT_WR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007025 PyModule_AddIntMacro(m, SHUT_WR);
Martin v. Löwis94681fc2003-11-27 19:40:22 +00007026#elif defined(SD_SEND)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00007027 PyModule_AddIntConstant(m, "SHUT_WR", SD_SEND);
Martin v. Löwis94681fc2003-11-27 19:40:22 +00007028#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00007029 PyModule_AddIntConstant(m, "SHUT_WR", 1);
Martin v. Löwis94681fc2003-11-27 19:40:22 +00007030#endif
7031#ifdef SHUT_RDWR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007032 PyModule_AddIntMacro(m, SHUT_RDWR);
Martin v. Löwis94681fc2003-11-27 19:40:22 +00007033#elif defined(SD_BOTH)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00007034 PyModule_AddIntConstant(m, "SHUT_RDWR", SD_BOTH);
Martin v. Löwis94681fc2003-11-27 19:40:22 +00007035#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00007036 PyModule_AddIntConstant(m, "SHUT_RDWR", 2);
Martin v. Löwis94681fc2003-11-27 19:40:22 +00007037#endif
7038
Christian Heimesfaf2f632008-01-06 16:59:19 +00007039#ifdef SIO_RCVALL
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00007040 {
7041 DWORD codes[] = {SIO_RCVALL, SIO_KEEPALIVE_VALS};
7042 const char *names[] = {"SIO_RCVALL", "SIO_KEEPALIVE_VALS"};
7043 int i;
Victor Stinner63941882011-09-29 00:42:28 +02007044 for(i = 0; i<Py_ARRAY_LENGTH(codes); ++i) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00007045 PyObject *tmp;
7046 tmp = PyLong_FromUnsignedLong(codes[i]);
7047 if (tmp == NULL)
7048 return NULL;
7049 PyModule_AddObject(m, names[i], tmp);
7050 }
7051 }
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007052 PyModule_AddIntMacro(m, RCVALL_OFF);
7053 PyModule_AddIntMacro(m, RCVALL_ON);
7054 PyModule_AddIntMacro(m, RCVALL_SOCKETLEVELONLY);
Amaury Forgeot d'Arc762681b2008-06-12 23:03:41 +00007055#ifdef RCVALL_IPLEVEL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007056 PyModule_AddIntMacro(m, RCVALL_IPLEVEL);
Amaury Forgeot d'Arc762681b2008-06-12 23:03:41 +00007057#endif
7058#ifdef RCVALL_MAX
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02007059 PyModule_AddIntMacro(m, RCVALL_MAX);
Amaury Forgeot d'Arc762681b2008-06-12 23:03:41 +00007060#endif
Christian Heimesfaf2f632008-01-06 16:59:19 +00007061#endif /* _MSTCPIP_ */
7062
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00007063 /* Initialize gethostbyname lock */
Just van Rossum1040d2c2003-05-09 07:53:18 +00007064#if defined(USE_GETHOSTBYNAME_LOCK) || defined(USE_GETADDRINFO_LOCK)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00007065 netdb_lock = PyThread_allocate_lock();
Guido van Rossum4f199ea1998-04-09 20:56:35 +00007066#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00007067 return m;
Guido van Rossum6574b3e1991-06-25 21:36:08 +00007068}
Martin v. Löwisb9ab1592001-06-24 21:18:26 +00007069
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00007070
Martin v. Löwisb9ab1592001-06-24 21:18:26 +00007071#ifndef HAVE_INET_PTON
Christian Heimes96e7b3d2007-11-20 06:51:17 +00007072#if !defined(NTDDI_VERSION) || (NTDDI_VERSION < NTDDI_LONGHORN)
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00007073
7074/* Simplistic emulation code for inet_pton that only works for IPv4 */
Guido van Rossum47dfa4a2003-04-25 05:48:32 +00007075/* These are not exposed because they do not set errno properly */
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00007076
Guido van Rossum3eede5a2002-06-07 02:08:35 +00007077int
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00007078inet_pton(int af, const char *src, void *dst)
Martin v. Löwisb9ab1592001-06-24 21:18:26 +00007079{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00007080 if (af == AF_INET) {
Benjamin Petersonf91df042009-02-13 02:50:59 +00007081#if (SIZEOF_INT != 4)
7082#error "Not sure if in_addr_t exists and int is not 32-bits."
7083#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00007084 unsigned int packed_addr;
7085 packed_addr = inet_addr(src);
7086 if (packed_addr == INADDR_NONE)
7087 return 0;
7088 memcpy(dst, &packed_addr, 4);
7089 return 1;
7090 }
7091 /* Should set errno to EAFNOSUPPORT */
7092 return -1;
Martin v. Löwisb9ab1592001-06-24 21:18:26 +00007093}
7094
Martin v. Löwisc925b1532001-07-21 09:42:15 +00007095const char *
7096inet_ntop(int af, const void *src, char *dst, socklen_t size)
Martin v. Löwisb9ab1592001-06-24 21:18:26 +00007097{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00007098 if (af == AF_INET) {
7099 struct in_addr packed_addr;
7100 if (size < 16)
7101 /* Should set errno to ENOSPC. */
7102 return NULL;
7103 memcpy(&packed_addr, src, sizeof(packed_addr));
7104 return strncpy(dst, inet_ntoa(packed_addr), size);
7105 }
7106 /* Should set errno to EAFNOSUPPORT */
7107 return NULL;
Martin v. Löwisb9ab1592001-06-24 21:18:26 +00007108}
Guido van Rossumc4fcfa32002-06-07 03:19:37 +00007109
Martin v. Löwisb9ab1592001-06-24 21:18:26 +00007110#endif
Christian Heimesb6150692007-11-15 23:37:07 +00007111#endif