Eio

Introduction

Cette extension fournit un système POSIX I/O asynchrone via la bibliothèque C » libeio écrite par Marc Lehmann.

Note: Cette extension n'est pas disponible sur les plates-formes Windows.

Avertissement

Il est important de noter que chaque demande est exécutée dans un thread, et l'ordre d'exécution des demandes en attente n'est pas assuré. Pour l'instant, le code suivant n'est pas correct.

Exemple #1 Demandes incorrectes

<?php
// Demande la création d'un lien symbolique $filename vers $link
eio_symlink($filename, $link);

// Demande de déplacement de $filename vers $new_filename
eio_rename($filename, $new_filename);

// Exécution des demandes
eio_event_loop();
?>

Dans l'exemple ci-dessus, la fonction eio_rename() peut se terminer avant la fonction eio_symlink(). Pour résoudre ce problème, il est possible d'appeler la fonction eio_rename() dans la fonction de rappel de la fonction eio_symlink():

Exemple #2 Exécution d'une demande dans la fonction de rappel d'une autre

<?php
function my_symlink_done($filename, $result) {
 // Demande de déplacement de $filename vers $new_filename
 eio_rename($filename, "/path/to/new-name");

 // Exécution des demandes
 eio_event_loop();
}

// Demande de création d'un lien symbolique $filename vers $link
eio_symlink($filename, $link, EIO_PRI_DEFAULT, "my_symlink_done", $filename);

// Exécution des demandes
eio_event_loop();
?>

Alternativement, il est possible de créer un groupe de demandes :

Exemple #3 Exécution d'une demande depuis la fonction de rappel d'une autre

<?php
/* Sera appelé lorsque le groupe de demandes aura terminé */
function my_grp_done($data, $result) {
 // ...
}

function my_symlink_done($filename, $result) {
 // Crée une demande eio_rename et l'ajoute au groupe
 $req = eio_rename($filename, "/path/to/new-name");
 eio_grp_add($grp, $req);
 // Vous pouvez vouloir d'autres actions...
}

// Création d'un groupe de demandes
$grp = eio_grp("my_grp_done", "my_grp_data");

// Crée une demande eio_symlink et l'ajoute au groupe
// Passage de $filename à la fonction de rappel
$req = eio_symlink($filename, $link,
  EIO_PRI_DEFAULT, "my_symlink_done", $filename);
eio_grp_add($grp, $req);

// Exécution des demandes
eio_event_loop();
?>

Un groupe est une demande spéciale qui peut cumuler un jeu de demandes eio. Ce mécanisme peut être utile pour créer une demande complexe qui ouvre, lit et ferme un fichier.

À partir de la version 0.3.0 alpha, une variable utilisée dans les communications internes avec libeio peut être récupérée avec la fonction eio_get_event_stream(). La variable peut être utilisée pour lier une boucle d'événements avec d'autres extensions. Il est possible d'organiser une boucle d'événements où libeio et libevent fonctionnent ensemble :

Exemple #4 Utilisation d'eio et libevent

<?php
function my_eio_poll($fd, $events, $arg) {
    /* Quelques régulations libevent peuvent venir ici .. */
    if (eio_nreqs()) {
        eio_poll();
    }
    /* .. et ici */
}

function my_res_cb($d, $r) {
    var_dump($r); var_dump($d);
}

$base = event_base_new();
$event = event_new();

// Ce flux est utilisé pour se lier avec libevent
$fd = eio_get_event_stream();

eio_nop(EIO_PRI_DEFAULT, "my_res_cb", "nop data");
eio_mkdir("/tmp/abc-eio-temp", 0750, EIO_PRI_DEFAULT, "my_res_cb", "mkdir data");
/* d'autres appels eio_* ici ... */


// Définit les drapeaux des événements
event_set($event, $fd, EV_READ /*| EV_PERSIST*/, "my_eio_poll", array($event, $base));

// Définit l'événement de base
event_base_set($event, $base);

// Active l'événement
event_add($event);

// Démarre la boucle des événements
event_base_loop($base);

/* La même chose est disponible via l'interface libevent bufferisée */
?>

Installation/Configuration
Constantes pré-définies
Exemples
Fonctions Eio
- eio_busy — Augmente artificiellement la charge. Utile dans le cadre de tests
- eio_cancel — Annule une requête
- eio_chmod — Modifie les permissions d'un fichier/dossier
- eio_chown — Modifie les permissions d'un fichier/dossier
- eio_close — Ferme un fichier
- eio_custom — Exécute une demande personnalisée comme l'appel à une des fonctions eio_*
- eio_dup2 — Duplique un descripteur de fichier
- eio_event_loop — Boucle libeio tant que les requêtes s'exécutent
- eio_fallocate — Autorise l'appelant à manipuler directement l'espace disque alloué pour un fichier
- eio_fchmod — Modifie les permissions sur un fichier
- eio_fchown — Modifie le propriétaire du fichier
- eio_fdatasync — Synchronise le statut interne d'un fichier avec le périphérique de stockage
- eio_fstat — Récupère le statut d'un fichier
- eio_fstatvfs — Récupère des statistiques sur le système de fichiers
- eio_fsync — Synchronise le statut interne d'un fichier avec le périphérique de stockage
- eio_ftruncate — Tronque un fichier
- eio_futime — Modifie l'heure du dernier accès et de la dernière modification d'un fichier
- eio_get_event_stream — Récupère le flux représentant une variable utilisée dans les communications internes avec libeio
- eio_get_last_error — Retourne une chaîne décrivant la dernière erreur associée avec la ressource demandée
- eio_grp — Crée un groupe de requêtes
- eio_grp_add — Ajoute une requête au groupe de requêtes
- eio_grp_cancel — Annule un groupe de requêtes
- eio_grp_limit — Définit la limite d'un groupe
- eio_init — (Re-)initialise Eio
- eio_link — Crée un lien fort sur un fichier
- eio_lstat — Récupère le statut d'un fichier
- eio_mkdir — Crée un dossier
- eio_mknod — Crée un fichier spécial ou ordinaire
- eio_nop — Ne fait rien, mis à part le fait de parcourir l'ensemble du cycle des requêtes
- eio_npending — Retourne le nombre de requêtes terminées
- eio_nready — Retourne le nombre de requêtes pas encore gérées
- eio_nreqs — Retourne le nombre de requêtes restant à exécuter
- eio_nthreads — Retourne le nombre de threads actuellement utilisés
- eio_open — Ouvre un fichier
- eio_poll — Vérifie s'il reste des requêtes en cours d'exécution
- eio_read — Lit un descripteur de fichier à une position donnée
- eio_readahead — Effectue un readahead sur le fichier dans le cache d'une page
- eio_readdir — Lit le contenu d'un dossier
- eio_readlink — Lit la valeur d'un lien symbolique
- eio_realpath — Récupère le nom du chemin absolu canonisé
- eio_rename — Modifie le nom ou le chemin d'un fichier
- eio_rmdir — Supprime un dossier
- eio_seek — Repositionne le curseur d'un fichier ouvert
- eio_sendfile — Transfère des données entre des descripteurs de fichiers
- eio_set_max_idle — Définit le nombre maximal de threads inactifs
- eio_set_max_parallel — Définit le nombre maximal de threads en parallèle
- eio_set_max_poll_reqs — Définit le nombre maximal de requêtes à exécuter dans une file d'attente
- eio_set_max_poll_time — Définit la durée maximale de la file d'attente
- eio_set_min_parallel — Définit le nombre minimum de threads parallèles
- eio_stat — Récupère le statut d'un fichier
- eio_statvfs — Récupère les statistiques du système de fichiers
- eio_symlink — Crée un lien symbolique
- eio_sync — Valide le cache du buffer sur le disque
- eio_sync_file_range — Synchronise un segment de fichier avec le disque
- eio_syncfs — Appelle la fonction système Linux syncfs, si disponible
- eio_truncate — Tronque un fichier
- eio_unlink — Supprime un nom et éventuellement, le fichier qui s'y réfère
- eio_utime — Modifie l'heure du dernier accès et de la dernière modification d'un fichier
- eio_write — Écrit dans un fichier