Compatibility Issue with `socket` Module and OpenBSD Multicast Options

Bug report

Bug description:

Dear Python Developers,

I am writing to report a compatibility issue with the socket module in Python 3.11.10 when running on OpenBSD 7.6. Specifically, the issue occurs with the handling of multicast socket options, such as IP_MULTICAST_TTL and IP_MULTICAST_LOOP.

---

Problem Description

On OpenBSD, the setsockopt system call expects specific types for certain multicast socket options:

• IP_MULTICAST_TTL and IP_MULTICAST_LOOP expect an unsigned 8-bit integer (u_char), with a length of 1 byte.
• IP_ADD_MEMBERSHIP expects a structure consisting of two IPv4 addresses, typically represented as struct { 4s, 4s }.

These expectations are defined in the OpenBSD source code, particularly in the file sys/netinet/in.h.

In contrast, Python's socket module passes these options using a 4-byte integer by default. This discrepancy causes the following error when attempting to use these options on OpenBSD:

socket.error: [Errno 22] Invalid argument

---

Steps to Reproduce

1. Run the following code on OpenBSD 7.6:

   import socket
   
   MCAST_GRP = "224.0.0.251"
   MCAST_PORT = 5353
   
   sock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM, socket.IPPROTO_UDP)
   sock.setsockopt(socket.IPPROTO_IP, socket.IP_MULTICAST_TTL, 1)  # This will raise an error
   

2. This will raise the error:

   socket.error: [Errno 22] Invalid argument
   

---

Expected Behavior

The setsockopt call should successfully set the IP_MULTICAST_TTL option with the provided value.

---

Root Cause

The issue arises because Python's socket module passes a 4-byte integer for the IP_MULTICAST_TTL and IP_MULTICAST_LOOP options, which is incompatible with OpenBSD's requirements.

On OpenBSD:

• IP_MULTICAST_TTL and IP_MULTICAST_LOOP require a u_char type (1 byte).
• The length of the option value is validated against this type in the OpenBSD kernel.

This discrepancy leads to the EINVAL error when setsockopt is called with these options.

---

Suggested Solution

The socket module should adapt to use the correct type (u_char) for these options when running on OpenBSD. This could involve special-casing these options to ensure the expected type and length are passed.

For example, the following workaround resolves the issue:

from ctypes import CDLL, c_ubyte, c_int, byref
import socket

libc = CDLL("libc.so")

def set_multicast_ttl(sock, ttl):
    u_char_ttl = c_ubyte(ttl)
    libc.setsockopt(
        sock.fileno(),
        socket.IPPROTO_IP,
        socket.IP_MULTICAST_TTL,
        byref(u_char_ttl),
        c_int(1)
    )

This workaround ensures that the correct type and size are passed to the setsockopt system call on OpenBSD.

---

Request for Upstream Fix

I believe this issue should be resolved upstream in the Python socket module. The current behavior prevents multicast functionality from working out of the box on OpenBSD and requires platform-specific workarounds.

I kindly request that the development team:

1. Investigate this issue further.
2. Adapt the socket module to handle platform-specific requirements for these multicast options.

This change should ensure compatibility with OpenBSD while maintaining backward compatibility on other platforms.

---

Thank you for your attention to this matter.

Best regards.

CPython versions tested on:

3.11

Operating systems tested on:

Other

Python's socket.setsockopt のエントリーポイントから始め、OpenBSD's sys/netinet/in.h にあるマルチキャストオプションの要件を報告された挙動と比較します。OpenBSD 7.6 で IP_MULTICAST_TTL と IP_MULTICAST_LOOP を再現します。これらのオプションが EINVAL なしで成功し、他のプラットフォームでの挙動が互換性を保っていれば完了です。