CMSG(3)

NOMBRE
CMSG_ALIGN, CMSG_SPACE, CMSG_NXTHDR, CMSG_FIRSTHDR - acceso a datos auxiliares

BIBLIOTECA
Biblioteca Estándar C (libc, -lc)

SINOPSIS
#include <sys/socket.h>

struct cmsghdr *CMSG_FIRSTHDR(struct msghdr *msgh);
struct cmsghdr *CMSG_NXTHDR(struct msghdr *msgh,
                            struct cmsghdr *cmsg);
size_t CMSG_ALIGN(size_t length);
size_t CMSG_SPACE(size_t length);
size_t CMSG_LEN(size_t length);
unsigned char *CMSG_DATA(struct cmsghdr *cmsg);

DESCRIPCIÓN
Estas macros se usan para crear y acceder a mensajes de control (también llamados datos auxiliares) que no son parte del contenido útil de un conector. Esta información de control puede incluir la interfaz en la que se ha recibido el paquete, diferentes campos de cabecera usados raramente, una descripción de error ampliada, un conjunto de descriptores de fichero o credenciales de UNIX. Por ejemplo, los mensajes de control se pueden usar para enviar campos de cabecera adicionales tales como opciones IP. Los datos auxiliares se envían llamando a sendmsg(2) y se reciben llamando a recvmsg(2). Vea sus páginas de manual para más información.

Los datos auxiliares son una secuencia de estructuras cmsghdr con datos añadidos. Vea las páginas de manual específicas del protocolo para conocer los tipos de mensajes de control disponibles. El tamaño máximo permitido del buffer auxiliar por conector se puede configura con /proc/sys/net/core/optmem_max. Vea socket(7).

La estructura cmsghdr se define de la siguiente manera:

    struct cmsghdr {
        size_t cmsg_len;    /* recuento de byte de datos incluyendo cabeceras
                               (el tipo en POSIX es socklen_t) */
        int    cmsg_level;  /* Protocolo origen */
        int    cmsg_type;   /* tipo específico de protocol */
    /* Seguido por
       unsigned char cmsg_data[]; */
    };

Nunca se debería acceder directamente a la secuencia de estructuras cmsghdr. En su lugar, utilice las siguientes macros:

CMSG_FIRSTHDR()
    devuelve un puntero a la primera cmsghdr en el buffer de datos auxiliares asociado con la msghdr pasada. Devolverá NULL si no se dispone de suficiente espacio para una cmsghdr en el buffer.

CMSG_NXTHDR()
    devuelve la siguiente cmsghdr válida después de la cmsghdr pasada. Devuelve NULL cuando no queda suficiente espacio en el buffer.

    Al inicializar un búfer con una serie de estructuras cmsghdr (por ejemplo, para enviar con sendmsg(2)), dicho búfer debe inicializarse primero a cero para garantizar el correcto funcionamiento de CMSG_NXTHDR().

CMSG_ALIGN(),
    CMSG_ALIGN(), dada una longitud, la devuelve incluyendo la alíneación necesaria. Ésta es una expresión constante.

CMSG_SPACE()
    devuelve la cantidad de bytes que ocupa un elemento auxiliar cuyo contenido útil es de la longitud de datos pasada. Ésta es una expresión constante.

CMSG_DATA()
    Devuelve un puntero a la porción de datos de un cmsghdr. No se puede asumir que el puntero devuelto esté correctamente alineado para acceder a tipos de datos de carga útil arbitrarios. Las aplicaciones no deben convertirlo a un tipo de puntero que coincida con la carga útil, sino que deben usar memcpy(3) para copiar datos hacia o desde un objeto declarado correctamente.

CMSG_LEN()
    devuelve el valor a almacenar en el miembro cmsg_len de la estructura cmsghdr teniendo en cuenta cualquier alíneación necesaria. Toma como argumento la longitud de los datos. Ésta es una expresión constante.

Para crear datos auxiliares, inicialice primero el miembro msg_controllen de la estructura msghdr con el tamaño del buffer de mensajes de control. Use CMSG_FIRSTHDR() sobre msghdr para obtener el primer mensaje de control y CMSG_NXTHDR() para obtener los siguientes. En cada mensaje de control, inicialice cmsg_len (con CMSG_LEN()), los otros campos cabecera de cmsghdr y la parte de datos usando CMSG_DATA(). Finalmente, debería asignar al campo msg_controllen de msghdr la suma de los CMSG_SPACE() de las longitudes de todos los mensajes de control del buffer. Para más información sobre msghdr, vea recvmsg(2).

VERSIONES
Para facilitar la portabilidad, debería accederse a los datos auxiliares utilizando únicamente las macros descritas aquí.

En Linux, CMSG_LEN(), CMSG_DATA() y CMSG_ALIGN() son expresiones constantes (suponiendo que su argumento sea constante), lo que significa que estos valores pueden usarse para declarar el tamaño de las variables globales. Sin embargo, esto podría no ser portable.

ESTÁNDARES

CMSG_FIRSTHDR()
CMSG_NXTHDR()
CMSG_DATA()
    POSIX.1-2008.

CMSG_SPACE()
CMSG_LEN()
CMSG_ALIGN()
    Linux.

HISTORIAL
Este modelo de datos auxiliares cumple con el borrador POSIX.1g, 4.4BSD-Lite, la API avanzada de IPv6 descrita en RFC 2292 y SUSv2.

CMSG_SPACE() y CMSG_LEN() se incluirán en la próxima versión de POSIX (Número 8).

EJEMPLOS
Este código busca la opción IP_TTL en un buffer auxiliar recibido:

    struct msghdr msgh;
    struct cmsghdr *cmsg;
    int received_ttl;

    /* Recibe datos auxiliares en msgh */

    for (cmsg = CMSG_FIRSTHDR(&msgh); cmsg != NULL;
            cmsg = CMSG_NXTHDR(&msgh, cmsg)) {
        if (cmsg->cmsg_level == IPPROTO_IP
                && cmsg->cmsg_type == IP_TTL) {
            memcpy(&receive_ttl, CMSG_DATA(cmsg), sizeof(received_ttl));
            break;
        }
    }

    if (cmsg == NULL) {
        /* Error: IP_TTL no activado, buffer muy pequeño o error de E/S */
    }

El código a continuación pasa una matriz de descriptores de archivo a través de un socket de dominio UNIX mediante SCM_RIGHTS:

    struct msghdr msg = { 0 };
    struct cmsghdr *cmsg;
    int myfds[NUM_FD];  /* Contiene los descriptores de archivo a pasar */
    char iobuf[1];
    struct iovec io = {
        .iov_base = iobuf,
        .iov_len = sizeof(iobuf)
    };
    union {         /* Ancillary data buffer, wrapped in a union
                       in order to ensure it is suitably aligned */
        char buf[CMSG_SPACE(sizeof(myfds))];
        struct cmsghdr align;
    } u;

    msg.msg_iov = &io;
    msg.msg_iovlen = 1;
    msg.msg_control = u.buf;
    msg.msg_controllen = sizeof(u.buf);
    cmsg = CMSG_FIRSTHDR(&msg);
    cmsg->cmsg_level = SOL_SOCKET;
    cmsg->cmsg_type = SCM_RIGHTS;
    cmsg->cmsg_len = CMSG_LEN(sizeof(myfds));
    memcpy(CMSG_DATA(cmsg), myfds, sizeof(myfds));

Para un ejemplo de código completo que muestra el paso de descriptores de archivo a través de un socket de dominio UNIX, consulte seccomp_unotify(2).

VÉASE TAMBIÉN
recvmsg(2), sendmsg(2)

RFC 2292

TRADUCCIÓN
La traducción al español de esta página del manual fue creada por Juan Piernas <piernas@ditec.um.es> y Marcos Fouces <marcos@debian.org>

Esta traducción es documentación libre; lea la GNU General Public License Version 3 (https://www.gnu.org/licenses/gpl-3.0.html) o posterior con respecto a las condiciones de copyright. No existe NINGUNA RESPONSABILIDAD.

Si encuentra algún error en la traducción de esta página del manual, envíe un correo electrónico a debian-l10n-spanish@lists.debian.org.