Manpages

NOM

io_submit - Soumettre un bloc d’entrées-sorties asynchrones

SYNOPSIS

#include <linux/aio_abi.h> /* Définit les types nécessaires */

int io_submit(io_context_t ctx_id, long nr, struct iocb **iocbpp);

Note : il n’existe pas d’enveloppe pour cet appel système dans la glibc ; voir NOTES.

DESCRIPTION

L’appel système io_submit() enregistre nr requêtes d’entrées-sorties asynchrones pour être traitées dans le contexte ctx_id. L’argument iocbpp devrait être une table de nr blocs de contrôle, qui seront soumis au contexte ctx_id.

La structure iocb (bloc de contrôle d’E/S) définie dans linux/aio_abi.h spécifie les paramètres contrôlant les opérations d’E/S.

#include <linux/aio_abi.h>


struct iocb {
    __u64   aio_data;
    __u32   PADDED(aio_key, aio_rw_flags);
    __u16   aio_lio_opcode;
    __s16   aio_reqprio;
    __u32   aio_fildes;
    __u64   aio_buf;
    __u64   aio_nbytes;
    __s64   aio_offset;
    __u64   aio_reserved2;
    __u32   aio_flags;
    __u32   aio_resfd;
};

Les champs de cette structure sont les suivants :
aio_data

This data is copied into the data field of the io_event structure upon I/O completion (see io_getevents(2)).

aio_key

This is an internal field used by the kernel. Do not modify this field after an io_submit() call.

aio_rw_flags

Cela définit les options R/W passées avec la structure. Les valeurs acceptées sont :
RWF_APPEND
(depuis Linux 4.16)

Ajouter des données à la fin du fichier. Voir la description de l’option du même nom dans pwritev2(2) ainsi que la description de O_APPEND dans open(2). Le champ aio_offset est ignoré. Le décalage du fichier est inchangé.

RWF_DSYNC (since Linux 4.13)

Opération d’écriture complète respectant l’intégrité des données d’E/S synchronisées. Voir la description de l’option du même nom dans pwritev2(2) ainsi que celle de O_DSYNC dans open(2).

RWF_HIPRI (since Linux 4.13)

Requête de haute priorité, scruter (« poll ») si possible

RWF_NOWAIT (depuis Linux 4.14)

Ne pas attendre si les E/S bloquent pour les opérations telles que les allocations de blocs de fichiers, la purge de pages sales (« dirty »), les verrous mutex ou un périphérique de bloc congestionné dans le noyau. Si une de ces conditions est remplie, le bloc de contrôle est renvoyé immédiatement avec la valeur de retour -EAGAIN dans le champ res de la structure io_event (voir io_getevents(2)).

RWF_SYNC (since Linux 4.13)

Opération d’écriture complète respectant l’intégrité des données d’E/S synchronisées. Voir la description de l’option du même nom dans pwritev2(2) ainsi que celle de O_SYNC dans open(2).

aio_lio_opcode

This defines the type of I/O to be performed by the iocb structure. The valid values are defined by the enum defined in linux/aio_abi.h:

enum {
    IOCB_CMD_PREAD = 0,
    IOCB_CMD_PWRITE = 1,
    IOCB_CMD_FSYNC = 2,
    IOCB_CMD_FDSYNC = 3,
    IOCB_CMD_POLL = 5,
    IOCB_CMD_NOOP = 6,
    IOCB_CMD_PREADV = 7,
    IOCB_CMD_PWRITEV = 8,
};

aio_reqprio

Cela définit la priorité des requêtes.

aio_fildes

Le descripteur du fichier sur lequel les opérations d’E/S sont à réaliser.

aio_buf

Le tampon utilisé pour le transfert de données des opérations de lecture ou d’écriture.

aio_nbytes

La taille du tampon pointé par aio_buf.

aio_offset

La position dans le fichier où les opérations d’E/S sont à réaliser.

aio_flags

This is the set of flags associated with the iocb structure. The valid values are:
IOCB_FLAG_RESFD

Asynchronous I/O control must signal the file descriptor mentioned in aio_resfd upon completion.

IOCB_FLAG_IOPRIO (since Linux 4.18)

Interpret the aio_reqprio field as an IOPRIO_VALUE as defined by linux/ioprio.h.

aio_resfd

Le descripteur de fichier à signaler en cas de fin d’opération d’E/S asynchrone.

VALEUR RENVOYÉE

En cas de succès, io_submit() renvoie le nombre de blocs iocb soumis (qui peut être inférieur à nr ou nul si nr vaut zéro). Pour les valeurs de retour en cas d’échec, consultez la section NOTES.

ERREURS

EAGAIN

Pas assez de ressources pour enregistrer un iocb.

EBADF

Le descripteur de fichier dans le premier iocb est invalide.

EFAULT

L’une des structures de données pointe sur une zone invalide.

EINVAL

The AIO context specified by ctx_id is invalid. nr is less than 0. The iocb at *iocbpp[0] is not properly initialized, the operation specified is invalid for the file descriptor in the iocb, or the value in the aio_reqprio field is invalid.

ENOSYS

io_submit() n’est pas implémenté dans ce noyau.

EPERM

The aio_reqprio field is set with the class IOPRIO_CLASS_RT, but the submitting context does not have the CAP_SYS_ADMIN capability.

VERSIONS

Les appels système d’entrées-sorties asynchrones sont apparus dans Linux 2.5.

CONFORMITÉ

io_submit() est spécifique à Linux et ne doit pas être utilisé dans des programmes destinés à être portables.

NOTES

La glibc ne fournit pas de fonction autour de cet appel système. Vous pourriez l’invoquer en utilisant syscall(2), mais vous préférerez sans doute utiliser la fonction enveloppe io_submit() fournie par libaio.

Remarquez que la fonction d’enveloppe libaio utilise un autre type (io_context_t) pour l’argument ctx_id. Remarquez également que l’enveloppe libaio ne suit pas les conventions classiques de la bibliothèque C concernant l’indication des erreurs : en cas d’erreur, la fonction renvoie un nombre négatif (la valeur négative de l’une des valeurs indiquées dans la section ERREURS). Si l’appel système est invoqué avec syscall(2), la valeur de renvoi suit les conventions classiques pour indiquer l’erreur : -1, avec errno défini à une valeur (positive) de l’erreur.

VOIR AUSSI

io_cancel(2), io_destroy(2), io_getevents(2), io_setup(2), aio(7)

COLOPHON

Cette page fait partie de la publication 5.07 du projet man-pages Linux. Une description du projet et des instructions pour signaler des anomalies et la dernière version de cette page, peuvent être trouvées à l’adresse https://www.kernel.org/doc/man-pages/.

TRADUCTION

La traduction française de cette page de manuel a été créée par Christophe Blaess <https://www.blaess.fr/christophe/>;, Stéphan Rafin <stephan.rafin [AT] laposte.net>, Thierry Vignaud <tvignaud [AT] mandriva.com>, François Micaux, Alain Portal <aportal [AT] univ-montp2.fr>, Jean-Philippe Guérard <fevrier [AT] tigreraye.org>, Jean-Luc Coulon (f5ibh) <jean-luc.coulon [AT] wanadoo.fr>, Julien Cristau <jcristau [AT] debian.org>, Thomas Huriaux <thomas.huriaux [AT] gmail.com>, Nicolas François <nicolas.francois [AT] centraliens.net>, Florentin Duneau <fduneau [AT] gmail.com>, Simon Paillard <simon.paillard [AT] resel.fr>, Denis Barbier <barbier [AT] debian.org> et David Prévot <david [AT] tilapin.org>

Cette traduction est une documentation libre ; veuillez vous reporter à la GNU General Public License version 3 concernant les conditions de copie et de distribution. Il n’y a aucune RESPONSABILITÉ LÉGALE.

Si vous découvrez un bogue dans la traduction de cette page de manuel, veuillez envoyer un message à <debian-l10n-french [AT] lists.org>.