Manpages

NOM

st - Lecteur de bandes SCSI

SYNOPSIS

#include <sys/mtio.h>

int ioctl(int fd, int request [, (void *)arg3]);
int ioctl(int fd, MTIOCTOP, (struct mtop *)mt_cmd);
int ioctl(int fd, MTIOCGET, (struct mtget *)mt_status);
int ioctl(int fd, MTIOCPOS, (struct mtpos *)mt_pos);

DESCRIPTION

Le pilote de périphérique st fournit une interface vers un grand nombre de lecteurs de bandes SCSI. Actuellement, ce pilote prend le contrôle de tous les périphériques détectés de type « accès séquentiel ». Le pilote st utilise un numéro majeur valant 9.

Chaque périphérique utilise huit numéros mineurs. Les 5 bits de poids faible des numéros mineurs sont assignés séquentiellement dans l’ordre de détection. Avec le noyau 2.6, les bits au-delà des 8 bits de poids faible sont concaténés aux 5 bits de poids faible pour former le numéro de lecteur de bande. Les numéros mineurs peuvent être groupés en deux ensembles de quatre numéros : les numéros mineurs principaux des périphériques (avec rembobinage automatique), n, et les numéros mineurs des périphériques sans rembobinage automatique (n+ 128). Les périphériques ouverts avec le numéro principal recevront une commande REWIND à la fermeture. Les périphériques ouverts avec le numéro « no-rewind » ne la recevront pas. (Notez qu’essayer de positionner la bande d’un périphérique avec rembobinage automatique en utilisant par exemple mt, ne produit pas le résultat désiré : la bande est à nouveau rembobinée après l’utilisation de la commande mt et la commande suivante prend effet dès le début de la bande.

Au sein de chaque groupe, 4 numéros mineurs sont disponibles pour définir des périphériques avec des caractéristiques différentes (taille de bloc, compression, densité, etc.). Lorsque le système démarre, seul le premier périphérique est disponible. Les 3 autres sont activés lorsque les caractéristiques par défaut sont définies (voir plus bas). (En modifiant les constantes à la compilation, on peut modifier la répartition entre le nombre maximal de lecteurs de bandes et le nombre de numéros mineurs par lecteur. Les allocations par défaut permettent de contrôler 32 lecteurs de bandes. Par exemple, il est possible de contrôler jusqu’à 64 lecteurs avec deux numéros mineurs pour les options différentes.)

Les fichiers spéciaux sont créés typiquement ainsi :

mknod -m 660 /dev/st0   c 9 0
mknod -m 660 /dev/st0l  c 9 32
mknod -m 660 /dev/st0m  c 9 64
mknod -m 660 /dev/st0a  c 9 96
mknod -m 660 /dev/nst0  c 9 128
mknod -m 660 /dev/nst0l c 9 160
mknod -m 660 /dev/nst0m c 9 192
mknod -m 660 /dev/nst0a c 9 224

Il n’existe pas de périphériques blocs correspondants.

The driver uses an internal buffer that has to be large enough to hold at least one tape block. In kernels before 2.1.121, the buffer is allocated as one contiguous block. This limits the block size to the largest contiguous block of memory the kernel allocator can provide. The limit is currently 128 kB for 32-bit architectures and 256 kB for 64-bit architectures. In newer kernels the driver allocates the buffer in several parts if necessary. By default, the maximum number of parts is 16. This means that the maximum block size is very large (2 MB if allocation of 16 blocks of 128 kB succeeds).

La taille de la mémoire tampon interne est déterminée par une constante à la compilation du noyau, que l’on peut supplanter par une option au démarrage du système. De plus, le pilote essaie d’allouer un tampon temporaire plus grand lors de son exécution si cela s’avère nécessaire. Toutefois l’allocation à l’exécution de grands blocs contigus peut échouer, et il vaut mieux ne pas compter dessus avec les noyaux antérieurs au 2.1.121 (cela s’applique également au chargement de module à la demande avec kerneld ou kmod).

Le pilote ne gère pas spécifiquement un type ou une marque de lecteur de bandes. Après le démarrage du système, les options du périphérique sont définies par le microcode du périphérique. Par exemple, si celui-ci réclame un mode de blocs fixes, le lecteur de bandes utilisera ce mode. Les options peuvent être modifiées par des appels ioctl(2) explicites et restent effectives lorsque le périphérique est fermé puis réouvert. La configuration des options affecte aussi bien les périphériques avec rembobinage automatique que ceux sans.

Des options différentes peuvent être fournies pour différents périphériques au sein du sous-groupe de quatre. Les options prennent effet à l’ouverture du périphérique. Par exemple, l’administrateur peut définir un périphérique qui écrit des blocs fixes d’une certaine taille, et un qui écrit avec des blocs de longueur variable (si le périphérique accepte les deux modes).

Le pilote gère les partitions de bandes si elles sont acceptées par le lecteur. (Notez que les partitions de bande n’ont rien à voir avec les partitions de disques. Une bande partitionnée peut être vue comme un ensemble de bandes logiques dans le même support). La gestion des partitions doit être activé par un ioctl(2). L’emplacement de la bande est sauvegardé au sein de chaque partition au cours des changements de partitions. La partition utilisée pour les opérations ultérieures est sélectionnée avec un ioctl(2). Le changement de partition est effectué au moment de la suivante opération bande afin d’éviter les mouvements inutiles de la bande. Le nombre maximal de partitions sur une bande est défini par une constante à la compilation (4 par défaut). Le pilote contient un ioctl(2) qui peut formater une bande avec une ou deux partitions.

Le fichier spécial de périphérique /dev/tape est généralement un lien symbolique ou un matériel vers le lecteur de bandes par défaut.

Depuis le noyau 2.6.2, le pilote exporte dans le répertoire de sysfs /sys/class/scsi_tape les périphériques attachés et certains de leurs paramètres.

Transfert de données
Le pilote accepte un fonctionnement aussi bien dans un mode de blocs fixes que dans un mode de blocs de longueur variable (si c’est accepté par le lecteur). En mode de blocs fixes, le périphérique écrit les blocs de la taille indiquée et la taille des blocs ne dépend pas de la quantité de données transmises lors de l’appel système. Dans le mode de longueur variable, un bloc de données est écrit à chaque appel système write et le nombre d’octets transmis indique la taille du bloc correspondant sur la bande. Notez que les blocs de la bande ne contiennent aucune information sur le mode d’écriture utilisé : la seule chose importante est d’utiliser lors de la lecture une commande qui accepte la taille des blocs de la bande.

In variable-block mode the read byte count does not have to match the tape block size exactly. If the byte count is larger than the next block on tape, the driver returns the data and the function returns the actual block size. If the block size is larger than the byte count, an error is returned.

En mode fixe, le nombre d’octets demandé peut être arbitraire, si la mémoire tampon est activée, ou un multiple de la taille de bloc, si ce tampon est désactivé. Les noyaux antérieurs au 2.1.121 permettent l’écriture avec un nombre quelconque si les mémoires tampons sont activées. Dans tous les autres cas (les noyaux antérieurs au 2.1.121 sans mémoire tampon ou les noyaux plus récents), le nombre d’octets à écrire doit être un multiple de la taille des blocs.

Dans le noyau 2.6, le pilote essaie de transférer les données directement entre la mémoire tampon de l’utilisateur et le périphérique. Si cela n’est pas possible, la mémoire tapon interne au pilote de périphérique est utilisée. Les raisons de ne pas utiliser des transferts directs sont entre autres un mauvais alignement de la mémoire tampon de l’utilisateur (par défaut 512 octets mais cela peut être changé par le pilote HBA), l’adaptateur SCSI ne peut pas atteindre un ou plusieurs blocs de la mémoire tampon de l’utilisateur, etc.

Une marque « filemark » est automatiquement écrit sur la bande si la dernière opération avant fermeture était une écriture.

En lecture, une marque « filemark » provoque les événements suivants : s’il reste des données dans le tampon lorsqu’on trouve la marque, les données en mémoire sont renvoyées ; la lecture suivante renvoie zéro octet ; la lecture suivante renvoie les données du fichier suivant ; la fin des données enregistrées est signalée par un retour de zéro octet pour deux appels successifs en lecture. Enfin, le troisième appel renvoie une erreur.

Ioctls
Le pilote gère trois requêtes ioctl(2). Les requêtes non reconnues par st sont transmises au contrôleur SCSI. Les définitions ci-dessous sont extraites de /usr/include/linux/mtio.h :

MTIOCTOP - Effectue une opération sur la bande
Cette requête prend un paramètre de type (struct mtop *). Certains contrôleurs ne gèrent pas toutes les opérations. Le pilote renvoie une erreur EIO si le périphérique n’accepte pas l’opération.

/* Structure MTIOCTOP - pour les opérations sur bande : */
struct mtop {
    short  mt_op;     /* opérations définies ci-dessous */
    int    mt_count;  /* nombre d’opérations            */
};

Magnetic tape operations for normal tape use:

MTCOMPRESSION

Valider la compression des données sur bande dans le lecteur si mt_count est non nul, désactiver la compression si mt_count est nul. Cette commande utilise la page MODE 15 supportée par la plupart des DAT.

MTERASE

Efface la bande. Avec un noyau 2.6, un effacement rapide (bande marquée vide) est effectué si le paramètre est zéro. Sinon, un effacement long (effacement complet) est effectué.

MTMKPART

Format the tape into one or two partitions. If mt_count is positive, it gives the size of partition 1 and partition 0 contains the rest of the tape. If mt_count is zero, the tape is formatted into one partition. From kernel version 4.6, a negative mt_count specifies the size of partition 0 and the rest of the tape contains partition 1. The physical ordering of partitions depends on the drive. This command is not allowed for a drive unless the partition support is enabled for the drive (see MT_ST_CAN_PARTITIONS below).

MTRESET

Réinitialiser le lecteur.

MTRETEN

Retendre la bande.

MTSETBLK

Définit la longueur de blocs du lecteur à la valeur spécifiée dans mt_count. Une longueur de bloc nulle place le lecteur dans le mode de blocs de tailles variables.

MTSETDENSITY

Définit la densité de la bande à celle codée dans mt_count. Les codes des densités acceptées par un lecteur sont disponibles dans la documentation de celui-ci.

MTSETPART

La partition active devient celle indiquée par mt_count. Les partitions sont numérotées depuis zéro. Cette commande n’est autorisée que si la gestion du partitionnement est activée pour le lecteur (voir MT_ST_CAN_PARTITIONS plus bas).

MTUNLOAD

Exécuter la commande de déchargement SCSI (n’éjecte pas la bande).

MTUNLOCK

Déverrouiller la porte du lecteur de bande.

Magnetic tape operations for setting of device options (by the superuser):
MTSETDRVBUFFER

Set various drive and driver options according to bits encoded in mt_count. These consist of the drive’s buffering mode, a set of Boolean driver options, the buffer write threshold, defaults for the block size and density, and timeouts (only in kernels 2.1 and later). A single operation can affect only one item in the list below (the Booleans counted as one item.)

Une valeur ayant ses 4 bits de poids fort à 0 sera utilisée pour indiquer le type de tampon du lecteur. Les types de tampon sont :

Pour contrôler le seuil d’écriture, on doit inclure dans mt_count la constante MT_ST_WRITE_THRESHOLD associée avec le nombre de blocs dans les 28 bits de poids faible par un OU binaire « | ». Le nombre de blocs concerne des blocs de 1024 octets, et non pas la taille physique des blocs sur la bande. Le seuil ne peut pas excéder la taille des tampons internes du contrôleur. (voir DESCRIPTION, plus bas).

Pour valider ou invalider les options booléennes, la valeur mt_count doit inclure l’une des constantes MT_ST_BOOLEANS, MT_ST_SETBOOLEANS, MT_ST_CLEARBOOLEANS ou MT_ST_DEFBOOLEANS associées par un OU binaire avec une combinaison des options décrites ci-dessous. Avec MT_ST_BOOLEANS les options sont définies avec les valeurs indiquées. Avec MT_ST_SETBOOLEANS les options sont activées sélectivement et inhibées avec MT_ST_DEFBOOLEANS.

MT_ST_BUFFER_WRITES (Défaut : vrai)

Les opérations d’écriture en mode de bloc fixes sont mises en cache. Si cette option est invalidée, et si l’enregistreur utilise une longueur de bloc fixe, toutes les opérations d’écriture doivent se faire avec une longueur multiple de celle du bloc. Cette option doit être fausse pour créer des archives multivolumes fiables.

MT_ST_ASYNC_WRITES (Défaut : vrai)

Quand cette option est validée, les opérations d’écriture retournent immédiatement si les données tiennent dans le tampon du pilote, sans attendre que celles-ci soient effectivement transmises au lecteur de bande. Le seuil du tampon d’écriture détermine le taux de remplissage du tampon avant d’effectuer une commande SCSI. Toute erreur renvoyée par le périphérique sera conservée jusqu’à l’opération suivante. Cette option doit être fausse pour créer des archives multivolumes fiables.

MT_ST_READ_AHEAD (Défaut : vrai)

Cette option indique au pilote de fournir un cache en lecture, ainsi qu’une lecture anticipée des données en mode de blocs fixes. Si cette option est invalidée, et que le lecteur utilise une taille de blocs fixes, toutes les opérations de lecture doivent se faire avec une taille multiple de celle du bloc.

MT_ST_TWO_FM (Défaut : faux)

Cette option modifie le comportement du pilote quand un fichier est fermé. L’attitude normale consiste à écrire une seule filemark, néanmoins si cette option est validée, le pilote écrira deux filemarks et replacera la tête au-dessus de la seconde.

Note : Cette option ne doit pas être utilisée avec les lecteurs de bandes QIC car ils ne sont pas capables d’écraser une filemark. Ces lecteurs détectent la fin des données enregistrées en cherchant de la bande vierge à la place des deux filemarks consécutives habituelles. La plupart des autres lecteurs courants détectent également la présence de bande vierge, aussi l’utilisation des deux filemarks n’est généralement utile que lors d’échange de bandes avec d’autres systèmes.

MT_ST_DEBUGGING (Défaut : faux)

Cette option valide les divers messages de débogage du pilote, si celui-ci a été compilé avec la constante DEBUG ayant une valeur non nulle).

MT_ST_FAST_EOM (Défaut : faux)

Cette option indique que les opérations MTEOM doivent être envoyées directement au lecteur, ce qui peut accélérer les opérations, mais aussi faire perdre au pilote le compte des pistes du fichier en cours, normalement renvoyé par la requête MTIOCGET. Si MT_ST_FAST_EOM est fausse, le contrôleur répondra à une requête MTEOM en sautant en avant de fichiers en fichiers.

MT_ST_AUTO_LOCK (Défaut : faux)

When this option is true, the drive door is locked when the device file is opened and unlocked when it is closed.

MT_ST_DEF_WRITES (Défaut : faux)

Les options de bande (taille de bloc, mode, compression...) peuvent varier lorsque l’on passe d’un périphérique lié à un lecteur à un autre périphérique correspondant au même lecteur. Cette option définit si les changements sont fournis au pilote en utilisant les commandes SCSI, et si les capacités d’auto-détection du lecteur sont fiables. Si l’option est fausse, le pilote envoie les commandes SCSI immédiatement lorsque le périphérique change. Si cette option est vraie, les commandes SCSI ne sont pas envoyées avant une demande d’écriture. Dans ce cas, le micro-code est habilité à détecter la structure de la bande lors de la lecture, et les commandes SCSI ne sont utilisées que pour être sûrs que la bande est écrite correctement.

MT_ST_CAN_BSR (Défaut : faux)

Lorsque la lecture anticipée est utilisée, la bande doit parfois être ramenée en arrière en position correcte lors de la fermeture du périphérique, et on utilise alors la commande SCSI pour sauter en arrière par-dessus les enregistrements. Certains anciens lecteurs ne traitent pas correctement cette commande, et cette option permet d’en avertir le pilote. Le résultat final est qu’une bande avec blocs fixes et lecture anticipée peut être mal positionnée dans un fichier lors de la fermeture du périphérique. Avec un noyau 2.6, l’option est activée par défaut pour les lecteurs qui gèrent la norme SCSI-3.

MT_ST_NO_BLKLIMS (Défaut : faux)

Certains lecteurs n’acceptent pas la commande SCSI READ BLOCK LIMITS de lecture des limites de blocs. Si l’on utilise cette option, le pilote n’invoque pas cette commande. L’inconvénient est que le pilote ne peut pas vérifier, avant d’envoyer des commandes, si la taille de bloc choisie est acceptée par le lecteur.

MT_ST_CAN_PARTITIONS (Défaut : faux)

Cette option active le support des partitions multiples sur une bande. Cette option s’applique à tous les périphériques liés au lecteur.

MT_ST_SCSI2LOGICAL (Défaut : faux)

Cette option indique au pilote d’utiliser les adresses de blocs logiques définies dans le standard SCSI-2, lors d’opérations de positionnement et de lecture de la position (aussi bien lors des commandes MTSEEK et MTIOCPOS que lors des changements de partitions). Sinon, il utilise les adresses spécifiques au périphérique. Il est très recommandé d’activer cette option si le lecteur supporte les adresses logiques car elles contiennent également les filemarks. Il existe d’ailleurs quelques lecteurs qui ne supportent que les adresses logiques.

MT_ST_SYSV (Défaut : faux)

When this option is enabled, the tape devices use the System V semantics. Otherwise, the BSD semantics are used. The most important difference between the semantics is what happens when a device used for reading is closed: in System V semantics the tape is spaced forward past the next filemark if this has not happened while using the device. In BSD semantics the tape position is not changed.

MT_NO_WAIT (Défaut : faux)

Active le mode immédiat (i.e. n’attend pas la fin de la commande) pour certaines commandes comme le rembobinage.

Un exemple :

struct mtop mt_cmd;
mt_cmd.mt_op = MTSETDRVBUFFER;
mt_cmd.mt_count = MT_ST_BOOLEANS |
        MT_ST_BUFFER_WRITES | MT_ST_ASYNC_WRITES;
ioctl(fd, MTIOCTOP, mt_cmd);

MTIOCGET — Obtenir l’état
Cette requête prend un paramètre du type (struct mtget *).

/* Structure pour MTIOCGET - État de la bande magnétique */
struct mtget {
    long     mt_type;
    long     mt_resid;
    /* Les registres suivants dépendent du matériel */
    long     mt_dsreg;
    long     mt_gstat;
    long     mt_erreg;
    /* Ces deux derniers champs sont parfois inutilisés */
    daddr_t  mt_fileno;
    daddr_t  mt_blkno;
};

mt_type

Le fichier d’en-tête définit plusieurs valeurs pour mt_type, mais le pilote actuel renvoie uniquement les types génériques MT_ISSCSI1 (lecteur SCSI-1 générique) et MT_ISSCSI2 (lecteur SCSI-2 générique).

mt_resid

Contient le numéro de partition courante.

mt_dsreg

Renvoie la configuration actuelle de la longueur de bloc (dans les 24 bits de poids faible) et la densité (dans les 8 bits de poids fort). Ces champs sont définis par MT_ST_BLKSIZE_SHIFT, MT_ST_BLKSIZE_MASK, MT_ST_DENSITY_SHIFT, et MT_ST_DENSITY_MASK.

mt_gstat

Renvoie des informations génériques d’état (indépendants du périphérique). Le fichier d’en-tête définit les macros suivantes pour tester les bits d’état :

mt_erreg

The only field defined in mt_erreg is the recovered error count in the low 16 bits (as defined by MT_ST_SOFTERR_SHIFT and MT_ST_SOFTERR_MASK). Due to inconsistencies in the way drives report recovered errors, this count is often not maintained (most drives do not by default report soft errors but this can be changed with a SCSI MODE SELECT command).

mt_fileno

Renvoie le numéro du fichier en cours (commençant à 0). La valeur est mise à -1 si le numéro du fichier est inconnu (par exemple, après un MTBSS ou un MTSEEK).

mt_blkno

Renvoie le numéro de bloc (commençant à 0) à l’intérieur du fichier en cours. Cette valeur est mise à -1 quand le numéro de bloc est inconnu (par exemple, après un MTBSF, un MTBSS, ou un MTSEEK).

MTIOCPOS — Obtenir la position de la bande
Cette requête prend un paramètre du type (struct mtpos *) et renvoie une valeur spécifique au lecteur, correspondant au numéro de bloc en cours, et qui n’est pas la même que mt_blkno renvoyée par MTIOCGET. Ce lecteur doit être un modèle SCSI-2 qui supporte la commande READ POSITION ou un lecteur SCSI-1 compatible Tandberg (Tandberg, Archive Viper, Wangtek, ...).

/* Structure pour MTIOCPOS - Commande pour obtenir la position */
struct mtpos {
    long mt_blkno;    /* numéro du bloc courant */
};

VALEUR RENVOYÉE

EOVERFLOW

Tentative de lire ou d’écrire un bloc de longueur variable plus grand que la taille des tampons internes du contrôleur.

FICHIERS

/dev/st*

Les lecteurs de bandes SCSI à rembobinage automatique

/dev/nst*

Les lecteurs de bandes SCSI sans rembobinage automatique

NOTES

VOIR AUSSI

mt(1)

Le fichier drivers/scsi/README.st ou Documentation/scsi/st.txt (pour les noyaux >= 2.6) dans les sources du noyau Linux contient les informations les plus récentes à propos du pilote et de ses capacités de configuration

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>, David Prévot <david [AT] tilapin.org>, Cédric Boutillier <cedric.boutillier [AT] gmail.com> et Frédéric Hantrais <fhantrais [AT] gmail.com>

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>.