- PDF Téléchargement Gratuit

Transcription

1 Ceci est un extrait électronique d'une publication de Diamond Editions : Ce chier ne peut être distribué que sur le CDROM offert accompagnant le numéro 100 de GNU/Linux Magazine France. La reproduction totale ou partielle des articles publiés dans Linux Magazine France et présents sur ce CDROM est interdite sans accord écrit de la société Diamond Editions. Retrouvez sur le site tous les anciens numéros en vente par correspondance ainsi que les tarifs d'abonnement. Pour vous tenir au courant de l'actualité du magazine, visitez : Ainsi que : et

2 développement compilation Auto-tools : génération du./congure Yves Mettier EN DEUX MOTS Le mois précédent, nous avions vu comment générer la commande congure et automatiser la compilation avec les auto-tools. Ce mois-ci, nous allons le rendre capable d exécuter la commande suivante :./congure --enable-syslog --with-compression_level=9. Introduction tiliser les auto-tools présente un grand intérêt pour la conguration de la compilation. En effet, le script congure est capable de comprendre un certain nombre d options de la ligne de commande pour peu que nous lui ayons expliqué de quoi il s agissait. Dans cet article, nous allons travailler avec les options --enable-feature et --with- PACKAGE que vous pouvez lire dans l aide en ligne du script congure lorsqu il est exécuté avec l option --help. Pour illustrer cet article, nous allons nous servir d un exemple, un programme qui stocke une chaîne de caractères dans un chier compressé. Le programme principal fera appel à une fonction de prototype int stocker (const char *str, const char *chier, int compression_level); src/main.c #dene COMPRESSION_LEVEL 3 Nous allons proposer ci-dessous une implémentation simple de cette fonction. L étape suivante consistera à coder un taux de compression par défaut, par l intermédiaire de la commande congure --with-compression_level=4 (valeur xée ici à 4 par défaut). Et nous nirons en rendant facultative l utilisation de zlib (sans support zlib, le chier est alors non compressé évidemment). Mais voici, dans un premier temps, notre exemple de départ : int stocker(const char*str, const char*chier, int compression) { gzfile *fh; char mode[] = wb3 ; /* Vérication du taux de compression */ if((0 <= compression) && ( 9 >= compression)) mode[2] = 0 +compression; mode[2] = 0 +COMPRESSION_LEVEL; /* Ecriture de la chaîne dans le chier */ if (NULL == (fh = gzopen(chier, mode))) { fprintf(stderr, «Impossible d ouvrir %s en écriture\n, chier); exit(exit_failure); gzprintf(fh, «%s», str); gzclose(fh); return(0); int main(int argc, char**argv) { stocker(«bonjour», «/tmp/test.gz»,5); exit(exit_success); congure.ac AC_INIT(bonjour, 0.1, ymettier@libertysurf.fr) AC_SEARCH_LIBS(gzopen,z, [], [exit Makele src/makele Makele.am SUBDIRS=src src/makele.am bin_programs=bonjour bonjour_sources=main.c Rappel Si vous n avez pas sous la main l article du mois précédent, nous vous rappelons que pour générer le nécessaire pour compiler le projet, vous devez lancer d abord aclocal, puis dans l ordre que vous voulez, autoconf et automake -a -c. Pour ce dernier, créez les chiers (vides si vous ne savez pas quoi mettre dedans au début) dont il ne manquera pas de vous signaler l absence. Un nouveau chier d en-tête cong.h Nous allons modier notre exemple pour que la macro COMPRESSION_LEVEL ne soit plus codée en dur dans main.c. Pour cela, nous allons disposer d un chier d en-tête cong. h généré par le script congure, dans lequel ce dernier 56 GNU Linux Magazine France

3 mettra la valeur indiquée. Le chier congure.ac devient le suivant : AC_INIT(bonjour, 0.2, ymettier@libertysurf.fr) AC_CONFIG_HEADER([cong.h AC_SEARCH_LIBS(gzopen,z, [], [exit AC_DEFINE_UNQUOTED(COMPRESSION_LEVEL, 3, [Niveau de compression Makele src/makele Relancez la chaîne aclocal, autoconf. Mais ici, cela change. En effet, nous avons ajouté la ligne avec AC_CONFIG_HEADER qui signale qu il faut générer un chier d en-têtes cong.h. Pour qu elle soit prise en compte, vous devez exécuter autoheader qui génère un chier cong.h.in. L exécution du script congure créera entre autres un chier cong.h à partir du chier cong.h.in. Terminez avec automake -a c : aclocal autoconf autoheader automake -a -c La ligne AC_DEFINE_UNQUOTED ajoute une macro au chier cong.h. Le premier argument correspond au nom et le deuxième à sa valeur. Le troisième est un commentaire qui précède la dénition de la macro. Nous dénissons ainsi notre macro COMPRESSION_LEVEL et forçons son contenu à 3. Il ne reste plus qu à adapter le code de main.c de la sorte : #include «cong.h» int stocker(const char*str, const char*chier, int compression) {... La dénition de la macro a disparu ici, mais nous incluons le chier cong.h dès le début. M4 et shell portable Dans la section suivante, nous allons voir la présence de tests de la forme if test «x$withval» = «xno»; then. En effet, le test if [ «x${withval = «xno» ] ; then ne fonctionne pas. De quel langage s agit-il? Lorsque autoconf analyse le chier congure. ac, il fait, entre autres, appel au processeur de macros m4. Celui-ci remplace ainsi chaque macro du chier congure.ac par sa description. Le langage m4 prévoit aussi la possibilité de changer les caractères servant aux citations. Dans la plupart des langages, y compris m4, ces caractères sont soit l apostrophe soit le guillemet, (parfois les deux). Vous indiquez par exemple une chaîne ainsi : «chaîne». Cependant, autoconf prote de la fonctionnalité de changement de caractère de citation pour utiliser les crochets. Dans congure.ac, vous écrivez plutôt [chaîne]. Vous comprenez ici pourquoi l utilisation des crochets dans un test avec if ne fonctionne pas et vous devez donc utiliser test. Le langage m4 ne sert qu à remplacer les macros par leur contenu. Dans ce cas, de quel shell s agit-il? Nous ne pouvons répondre à cette question pour la simple et bonne raison que cela varie d un système à l autre. En effet, /bin/sh n a de point commun sur chaque système que le fait d être un shell de la famille des Bourne Shell. Que ce soit ash, ksh ou tout simplement la dernière version de bash, vous ne pouvez être sûr que d une chose : cela sera peut-être différent sur une autre machine. Il faut donc écrire dans un langage Bourne Shell le plus simple possible, ce que nous faisons ici. De nombreux exemples de choses à faire et à ne pas faire se trouvent dans la documentation d autoconf, dans la section «Limitations of Shell Builtins» du chapitre «Portable Shell Programming». AC_ARG_WITH Maintenant que nous avons déplacé la dénition de la macro COMPRESSION_LEVEL dans le chier congure.ac, nous allons le rendre paramétrable à l aide de AC_ARG_WITH. Ses quatre arguments sont, dans l ordre, le nom qui sera collé à --with-. Nous allons mettre compression_level pour que l option de la ligne de commande devienne, par exemple, --with-compression_level=8. En deuxième argument, nous avons l aide en ligne. Ce que nous mettons ici sera afché lorsque l utilisateur exécute congure -- help. Pour cela, il est recommandé d utiliser AC_HELP_STRING que nous allons voir plus Numéro 76 / Octobre

4 Développement compilation loin. En troisième argument se trouve un script, exécuté lorsque --with-xxx se trouvait effectivement sur la ligne de commande. Nous pouvons utiliser la variable dont le nom est toujours ${withval qui contient ce que l utilisateur a pu fournir comme valeur. En l absence de valeur, cette variable contient yes. Et en quatrième argument se trouve un autre script, exécuté lui quand se trouvait --without-xxx. Remarquez que rien n est exécuté si rien ne se trouve sur la ligne de commande. Voici ce que devient le chier congure.ac : AC_ARG_WITH(compression_level, [AC_HELP_STRING([--with-compression_level],[Niveau de compression (3 par défaut)], [ if test «x$withval» = «xno»; then COMPRESSION_LEVEL=0 ; elif test «x$withval» = «xyes»; then AC_MSG_ERROR([Vous devez specier un nombre entre 0 et 9 pour le niveau de compression COMPRESSION_LEVEL=${withval ], [ COMPRESSION_LEVEL=3 AC_DEFINE_UNQUOTED(COMPRESSION_LEVEL, ${COMPRESSION_LEVEL, [Niveau de compression AC_MSG_ERROR Cette macro porte bien son nom : elle est chargée d afcher un message d erreur sur la sortie du script congure. Contrairement aux autres de sa famille, celle-ci arrête l exécution du script. Les autres sont : AC_MSG_CHECKING (description) ; AC_MSG_RESULT (résultat) ; AC_MSG_NOTICE (message) ; AC_MSG_ERROR (description, [code pour exit ; AC_MSG_FAILURE (description, [code pour exit ; AC_MSG_WARN (description). AC_HELP_STRING Nous avons vu plus haut un exemple d utilisation d AC_HELP_STRING. Il s agit en fait de réaliser simplement un afchage formaté lorsque l utilisateur exécute congure --help. Il est tout à fait possible de s en passer en comptant les espaces, mais voilà le premier problème pour les flemmards : il faut compter. Le problème le plus gênant est que cet espacement peut éventuellement varier à l avenir, dans une nouvelle version d autoconf. Dans ce cas, AC_HELP_STRING serait mis à jour en fonction, mais pas votre espacement si vous le faites à la main. Conclusion : soyez flemmards! AC_HELP_STRING prend deux arguments. Le premier correspond aux arguments de la ligne de commande, donc --withcompression_level dans notre cas. Et le second indique la signication du premier : Niveau de compression (3 par défaut). Voici le résultat de la commande./congure -- help (extraits) : Optional Packages: --with-package[=arg] use PACKAGE [ARG=yes] --without-package do not use PACKAGE (same as --with- PACKAGE=no) --with-compression_level Niveau de compression (3 par défaut) Remarque AC_HELP_STRING est capable d aller sur la ligne suivante pour le texte explicatif lorsque l option indiquée dans le premier argument est trop longue. Voulez-vous journaliser les erreurs? Lorsque dans notre programme, nous échouons à l ouverture du chier en écriture, un message d erreur est envoyé sur la sortie d erreur, avant la sortie. Souhaitez-vous que votre programme soit capable d envoyer ce message au journal système (syslog)? Nous allons considérer cela comme une fonctionnalité que l on peut désactiver. Pour cela, nous allons utiliser une macro ENABLE_SYSLOG et voici à nouveau le code de notre programme : #include «cong.h» #ifdef ENABLE_SYSLOG #include <syslog.h> #include <stdarg.h> #include <string.h> #include <errno.h> #endif int stocker(const char*str, const char*chier, int compression_ level) { gzfile *fh; char mode[] = wb3 ; /* Vérication du taux de compression */ if((0 <= compression_level) && ( 9 >= compression_level)) mode[2] = 0 +compression_level; mode[2] = 0 +COMPRESSION_LEVEL; /* Ecriture de la chaîne dans le chier */ if (NULL == (fh = gzopen(chier, mode))) { fprintf(stderr, «Impossible d ouvrir %s en écriture\n», chier); #ifdef ENABLE_SYSLOG syslog(log_err LOG_USER, «Impossible d ouvrir %s en écriture (%s)\n», chier, errno?strerror(errno): mémoire insufsante»); #endif exit(exit_failure); 58 GNU Linux Magazine France

5 Auto-tools : génération du./congure gzprintf(fh, «%s», str); gzclose(fh); return(0); int main(int argc, char**argv) { stocker(«bonjour», «/tmp/test.gz»,5); exit(exit_success); Il n y a plus qu à compiler en dénissant ou non la macro ENABLE_SYSLOG. AC_ARG_ENABLE Pour proposer à l utilisateur de dénir ou non la macro ENABLE_SYSLOG, nous pourrions utiliser AC_ARG_WITH, ce qui donnerait./congure --with-syslog. Mais il s agit plutôt d activer ou non syslog et nous préférons AC_ARG_ENABLE, ce qui amène l utilisateur à./congure --enable-syslog. AC_ARG_ENABLE s utilise comme AC_ARG_WITH à peu de choses près. La différence notable se trouve dans le nom de la variable ${enableval au lieu de ${withval. Ajoutez les lignes AC_ARG_ENABLE suivi du test sur la variable ${ENABLE_SYSLOG, et le chier congure.ac devient le suivant : AC_INIT(bonjour, 0.2, ymettier@libertysurf.fr) AC_CONFIG_HEADER([cong.h AC_ARG_ENABLE(syslog,[AC_HELP_STRING([--enable-syslog], [Compiler avec le support syslog],[ if test «x${enableval»!= «xno»; then ENABLE_SYSLOG=1 ], [ ENABLE_SYSLOG=1 if test «x${enable_syslog» = «x1»; then AC_CHECK_FUNC(syslog, [], [exit AC_DEFINE_UNQUOTED(ENABLE_SYSLOG, 1, [Support de syslog AC_SEARCH_LIBS(gzopen,z, [], [exit AC_ARG_WITH(compression_level, [AC_HELP_STRING([--with-compression_level],[Niveau de compression (3 par défaut)], [ if test «x$withval» = «xno»; then COMPRESSION_LEVEL=0 ; elif test «x$withval» = «xyes»; then AC_MSG_ERROR([Vous devez specier un nombre entre 0 et 9 pour le niveau de compression COMPRESSION_LEVEL=${withval ], [ COMPRESSION_LEVEL=3 AC_DEFINE_UNQUOTED(COMPRESSION_LEVEL, ${COMPRESSION_LEVEL, [Niveau de compression Makele src/makele echo Zlib : taux de compression = ${COMPRESSION_LEVEL if test «x${enable_syslog» = «x1»; then echo «Syslog : support active» echo Syslog : support desactive Différence entre AC_ ARG_WITH et AC_ ARG_ENABLE Si AC_ARG_WITH et AC_ARG_ENABLE s utilisent de la même manière (à la variable ${withval/ ${enableval près), pourquoi utiliser l un plutôt que l autre? Le premier, AC_ARG_ WITH, sert à indiquer des valeurs, comme le taux de compression dans notre exemple précédent. C est avec lui que vous pouvez aussi décider si vous utilisez par exemple un code natif ou une bibliothèque. Le second, AC_ARG_ENABLE, s utilise pour activer ou non une fonctionnalité. Voulez-vous journaliser les messages ou non? Lorsqu il s agit d une fonctionnalité, nous résumons la situation ainsi : la question de savoir si la fonctionnalité doit être activée se pose avec AC_ARG_ENABLE et celle pour choisir l implémentation parmi toutes les implémentations possibles se pose avec AC_ARG_WITH. Et dans les autres cas, AC_ARG_ WITH permet de proposer à l utilisateur de passer des paramètres pour congurer la compilation. Conclusion Nous avons vu comment démarrer un projet le mois dernier et comment permettre à l utilisateur d indiquer des paramètres pour la conguration de la compilation. Il nous reste encore tant à voir. Le mois prochain peut-être? Yves Mettier, Remarque À la n, nous avons ajouté quelques lignes afchant le résumé des paramètres qui nous intéressent. Libre à vous de les supprimer ou au contraire d améliorer cet afchage. liens Le manuel d autoconf : org/manual/autoconf/index.html ; Le manuel d automake : org/manual/automake/index.html ; La page de manuel de syslog ; Le chier d en-tête zlib.h ; C en action (O Reilly). Numéro 76 / Octobre