Skip to content

bpo-41798: Allocate socket extension module CAPI on the heap #24126

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 6, 2021
Merged

bpo-41798: Allocate socket extension module CAPI on the heap #24126

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5abe199
Allocate socket extension module CAPI on the heap
Jan 5, 2021
4af45ab
Address review: Remove empty line
Jan 6, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 45 additions & 15 deletions Modules/socketmodule.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7033,16 +7033,36 @@ os_init(void)
}
#endif

static void
sock_free_api(PySocketModule_APIObject *capi)
{
Py_DECREF(capi->Sock_Type);
Py_DECREF(capi->error);
Py_DECREF(capi->timeout_error);
PyMem_Free(capi);
}

/* C API table - always add new things to the end for binary
compatibility. */
static
PySocketModule_APIObject PySocketModuleAPI =
static void
sock_destroy_api(PyObject *capsule)
{
&sock_type,
NULL,
NULL
};
void *capi = PyCapsule_GetPointer(capsule, PySocket_CAPSULE_NAME);
sock_free_api(capi);
}

static PySocketModule_APIObject *
sock_get_api(void)
{
PySocketModule_APIObject *capi = PyMem_Malloc(sizeof(PySocketModule_APIObject));
if (capi == NULL) {
PyErr_NoMemory();
return NULL;
}

capi->Sock_Type = (PyTypeObject *)Py_NewRef(&sock_type);
capi->error = Py_NewRef(PyExc_OSError);
capi->timeout_error = Py_NewRef(PyExc_TimeoutError);
return capi;
}


/* Initialize the _socket module.
Expand Down Expand Up @@ -7091,8 +7111,6 @@ PyInit__socket(void)
if (m == NULL)
return NULL;

Py_INCREF(PyExc_OSError);
PySocketModuleAPI.error = PyExc_OSError;
Py_INCREF(PyExc_OSError);
PyModule_AddObject(m, "error", PyExc_OSError);
socket_herror = PyErr_NewException("socket.herror",
Expand All @@ -7107,8 +7125,6 @@ PyInit__socket(void)
return NULL;
Py_INCREF(socket_gaierror);
PyModule_AddObject(m, "gaierror", socket_gaierror);

PySocketModuleAPI.timeout_error = PyExc_TimeoutError;
PyModule_AddObjectRef(m, "timeout", PyExc_TimeoutError);

Py_INCREF((PyObject *)&sock_type);
Expand All @@ -7129,10 +7145,24 @@ PyInit__socket(void)
PyModule_AddObject(m, "has_ipv6", has_ipv6);

/* Export C API */
if (PyModule_AddObject(m, PySocket_CAPI_NAME,
PyCapsule_New(&PySocketModuleAPI, PySocket_CAPSULE_NAME, NULL)
) != 0)
PySocketModule_APIObject *capi = sock_get_api();
if (capi == NULL) {
Py_DECREF(m);
return NULL;
}
PyObject *capsule = PyCapsule_New(capi,
PySocket_CAPSULE_NAME,
sock_destroy_api);
if (capsule == NULL) {
sock_free_api(capi);
Py_DECREF(m);
return NULL;
}
if (PyModule_AddObject(m, PySocket_CAPI_NAME, capsule) < 0) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about using PyModule_AddObjectRef() in here?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we can leave it as it is for now. We can do a thorough clean up of the module init function when we convert it to multi-phase init. Ok?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No problem.

Py_DECREF(capsule);
Py_DECREF(m);
return NULL;
}

/* Address families (we only support AF_INET and AF_UNIX) */
#ifdef AF_UNSPEC
Expand Down
3 changes: 2 additions & 1 deletion Modules/socketmodule.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -342,7 +342,8 @@ typedef struct {

*/

/* C API for usage by other Python modules */
/* C API for usage by other Python modules.
* Always add new things to the end for binary compatibility. */
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not sure this note is correct or not. The binary compatibilty also depends how to use it, no?

Copy link
Contributor Author

@erlend-aasland erlend-aasland Jan 6, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You're right. I just copied the comment from the .c file. I figured it made more sense together with the definition in the header file. However, I don't think this comment is really needed. I'd recommend just deleting it.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In case of doubt, I prefer to keep it. It makes sense to only add new members at the end. If a C extension is built with Python 3.10 and a new filed is added to Python 3.11, the Python 3.10 remains ABI compatible. The comment looks correct.

typedef struct {
PyTypeObject *Sock_Type;
PyObject *error;
Expand Down