{"id":3550,"date":"2013-04-29T08:00:37","date_gmt":"2013-04-29T07:00:37","guid":{"rendered":"http:\/\/www.blaess.fr\/christophe\/?p=3550"},"modified":"2013-04-29T08:17:05","modified_gmt":"2013-04-29T07:17:05","slug":"configuration-dune-application-embarquee","status":"publish","type":"post","link":"https:\/\/www.blaess.fr\/christophe\/2013\/04\/29\/configuration-dune-application-embarquee\/","title":{"rendered":"Configuration d’une application embarqu\u00e9e (2\/2)"},"content":{"rendered":"

\"Configuration<\/a>Cet article a \u00e9t\u00e9 \u00e9crit en collaboration avec mon ami Fran\u00e7ois Beaulier (dont je vous recommande le blog<\/a>). Nous avons r\u00e9fl\u00e9chi ensemble sur les possibilit\u00e9s qui s’offrent au d\u00e9veloppeur d’application embarqu\u00e9e pour enregistrer le param\u00e9trage, la configuration, les pr\u00e9f\u00e9rences… bref tout ce qui constitue les donn\u00e9es persistantes de son syst\u00e8me.<\/p>\n

\n\n<\/p>\n

Nous avons examin\u00e9 dans la premi\u00e8re partie de cet article<\/strong><\/a> plusieurs m\u00e9thodes de stockage des donn\u00e9es persistantes (configuration, pr\u00e9f\u00e9rences, etc.) d\u2019une application embarqu\u00e9e : sauvegarde binaire \u201cbrute\u201d, formatage ASCII avec fprintf(), fichier de type .ini \u00e0 la mani\u00e8re de Windows. Aucune de ces m\u00e9thodes ne nous donnent enti\u00e8rement satisfaction d\u00e8s lors qu\u2019il nous faut garantir une certaine portabilit\u00e9 entre plate-formes, et que nos donn\u00e9es peuvent \u00eatre organis\u00e9es en tableaux ou en structure arborescente.<\/p>\n

Dans cette seconde partie nous allons aborder des solutions plus \u00e9volu\u00e9es qui permettent de r\u00e9pondre beaucoup mieux au besoin.<\/p>\n

Format sp\u00e9cifique libconfig<\/h1>\n

Il est int\u00e9ressant d\u2019\u00e9tudier la solution des biblioth\u00e8ques open source<\/em> d\u00e9di\u00e9es \u00e0 ce probl\u00e8me des fichiers de configuration. Une des plus connues est libconfig<\/strong> qui propose un format de fichier sp\u00e9cifique de type texte avec un parser<\/em> dot\u00e9 d\u2019une API simple et efficace.<\/p>\n

Voila ce que dit la documentation sur l\u2019objectif du projet :<\/p>\n

------------------- >\n1.1 Why Another Configuration File Library?\n\nThere are several open-source configuration file libraries available as of this writing. This library was written because each of those libraries falls short in one or more ways. The main features of libconfig that set it apart from the other libraries are:\n\n    A fully reentrant parser. Independent configurations can be parsed in concurrent threads at the same time.\n\n    Both C and C++ bindings, as well as hooks to allow for the creation of wrappers in other languages.\n\n    A simple, structured configuration file format that is more readable and compact than XML and more flexible than the obsolete but prevalent Windows \u201cINI\u201d file format.\n\n    A low-footprint implementation (just 37K for the C library and 76K for the C++ library) that is suitable for memory-constrained systems.\n\n    Proper documentation.     \n\n<-------------------<\/em><\/pre>\n
La prise en main de la biblioth\u00e8que est rapide et le format de fichier assez intuitif. La biblioth\u00e8que g\u00e8re directement les types de donn\u00e9es de base : integer<\/code>, integer64<\/code>, double<\/code>, boolean<\/code> et string<\/code>. On peut d\u00e9finir des groupes nomm\u00e9s, comme les sections du .ini<\/code>, sauf que l\u2019on peut les imbriquer. Il y a \u00e9galement une syntaxe pour d\u00e9clarer des tableaux et des listes.<\/p>\n
Les tableaux doivent contenir des types de base, on ne peut donc pas faire de tableaux d\u2019objets comme des structures mais par contre les listes permettent de le faire.<\/p>\n
Voici une mani\u00e8re de repr\u00e9senter les donn\u00e9es de notre application de domotique, en int\u00e9grant l\u2019aspect relatif \u00e0 la composition : les objets capteurs et actionneurs sont d\u00e9finis comme des listes \u00e0 l\u2019int\u00e9rieur de chaque pi\u00e8ce.<\/p>\n
# Demo application domotique\n\nversion = \"1.0\";\n\nsite:\n{\n  Nom = \"Restaurant le Marco Polo\";\n  Adresse = \"4 avenue d'Italie 75013 Paris\";\n  Pieces = (\n    {\n      Nom = \"Cuisine\";\n      Volume = 92.4;\n      Capteurs = (\n        {\n          Type = \"PT100\";\n          Identifiant = 100;\n        },\n        {\n          Type = \"KZ08\";\n          Identifiant = 101;\n        }\n      )\n      Actionneurs = (\n        {\n          Type = \"REL01\";\n          Identifiant = 200;\n        },\n        {\n          Type = \"REL01\";\n          Identifiant = 201;\n        }\n      )\n    },\n    {\n      Nom = \"Salle\";\n      Volume = 148.3;\n      Capteurs = (\n        {\n          Type = \"PT100\";\n          Identifiant = 102;\n        },\n        {\n          Type = \"AS12\";\n          Identifiant = 103;\n        },\n        {\n          Type = \"AS12\";\n          Identifiant = 104;\n        }\n      )\n      Actionneurs = (\n        {\n          Type = \"REL01\";\n          Identifiant = 202;\n        },\n        {\n          Type = \"REL01\";\n          Identifiant = 203;\n        }\n      )\n    }\n  )\n}<\/pre>\n
Bien s\u00fbr comme nous l\u2019avions pr\u00e9cis\u00e9 avec le format .ini<\/code> ce n\u2019est pas la seule mani\u00e8re de faire, les liens de composition peuvent \u00eatre enregistr\u00e9s explicitement avec des champs suppl\u00e9mentaires dans les objets.<\/p>\n
Voici le code source permettant de remplir nos structures \u00e0 partir de ce fichier de configuration. La d\u00e9finition des structures a \u00e9t\u00e9 un peu revue pour avoir des cha\u00eenes de caract\u00e8res allou\u00e9es dynamiquement.<\/p>\n
\/*************************************************************************\n** Demo utilisation de Libconfig\n*************************************************************************\/\n#include <stdio.h>\n#include <stdlib.h>\n#include <string.h>\n#include <stdint.h>\n#include \"..\/libconfig-1.4.9\/lib\/libconfig.h\"\n\n#define MAX_CAPTEURS_PAR_PIECE     10\n#define MAX_ACTIONNEURS_PAR_PIECE  10\n\n#define MAX_PIECES                 10\n\nenum capteur_t {CAPT_UNDEFINED = 0, CAPT_PT100, CAPT_KZ08, CAPT_AS12, CAPT_LAST };\nenum actionneur_t {ACT_UNDEFINED = 0, ACT_REL01, ACT_LAST };\n\nchar *capt_names[] = {\"UNDEFINED\", \"PT100\", \"KZ08\", \"AS12\"};\nchar *act_names[] = {\"UNDEFINED\", \"REL01\"};\n\nstruct s_capteur {\n   enum capteur_t type;\n   int identifiant;\n};\n\nstruct s_actionneur {\n   enum actionneur_t type;\n   int identifiant;\n};\n\nstruct s_piece{\n   char *nom;\n   double volume;\n   struct s_capteur tabCapteurs[MAX_CAPTEURS_PAR_PIECE ];\n   struct s_actionneur tabActionneurs[MAX_ACTIONNEURS_PAR_PIECE ];\n};\n\nstruct s_site {\n   char *nom;\n   char *adresse;\n   struct s_piece tabPieces[MAX_PIECES];\n};\n\nstruct s_site site_config;\nstruct config_t cfg;\n\nint main(void)\n{\n   const char *s = NULL;\n   char *version = NULL;\n   int name;\n\n   \/* Initialize the configuration *\/\n   config_init(& cfg);\n\n   \/* Load the file *\/\n   printf(\"loading domotic.cfg ..\");\n   if (!config_read_file(& cfg, \"domotic.cfg\")){\n     printf(\"failed : %s\\n\", config_error_text(& cfg));\n     exit(1);\n   }\n   config_setting_t *cfs = NULL;\n   printf(\" ok\\n\");\n\n   \/* Get the first item at root *\/\n   if(config_lookup_string(& cfg, \"version\", & s) == CONFIG_TRUE)\n       version = strdup(s);\n   if(version)\n       printf(\"version = %s\\n\", version);\n\n   \/* Get the site group *\/\n   cfs = config_lookup(& cfg, \"site\");\n   if(!cfs){\n       printf(\"error\\n\");\n       exit(1);\n   }\n\n   \/* Get name and address in site *\/\n   if(config_setting_lookup_string(cfs, \"Nom\", & s) == CONFIG_TRUE)\n       site_config.nom = strdup(s);\n   if(config_setting_lookup_string(cfs, \"Adresse\", & s) == CONFIG_TRUE)\n       site_config.adresse = strdup(s);\n\n   \/* Parse all pieces *\/\n   config_setting_t *list_pieces = config_setting_get_member(cfs, \"Pieces\");\n   int piece = 0;\n   int capt = 0;\n   int act = 0;\n   while(list_pieces) {\n       struct s_piece *pPiece = & site_config.tabPieces[piece];\n       config_setting_t *pcs = config_setting_get_elem(list_pieces, piece);\n       if(!pcs)\n           break;\n       if(config_setting_lookup_string(pcs, \"Nom\", & s) == CONFIG_TRUE)\n           pPiece->nom = strdup(s);\n       config_setting_lookup_float(pcs, \"Volume\", & pPiece->volume);\n       \/* Parse all capteurs *\/\n       config_setting_t *list_capteurs = config_setting_get_member(pcs, \"Capteurs\");\n       capt = 0;\n       while(list_capteurs){\n           config_setting_t *cpt = config_setting_get_elem(list_capteurs, capt);\n           if(!cpt)\n               break;\n           if(config_setting_lookup_string(cpt, \"Type\", & s) == CONFIG_FALSE)\n               continue;\n           for(name = 0; name < CAPT_LAST; name++)\n               if(!strcmp(s, capt_names[name]))\n                   pPiece->tabCapteurs[capt].type = name;\n           config_setting_lookup_int(cpt, \"Identifiant\", & pPiece->tabCapteurs[capt].identifiant);\n           capt++;\n           if(capt >= MAX_CAPTEURS_PAR_PIECE)\n               break;\n       }\n       \/* Parse all actionneurs *\/\n       config_setting_t *list_actionneurs = config_setting_get_member(pcs, \"Actionneurs\");\n       act = 0;\n       while(list_actionneurs){\n           config_setting_t *ant = config_setting_get_elem(list_actionneurs, act);\n           if(!ant)\n               break;\n           if(config_setting_lookup_string(ant, \"Type\", &s) == CONFIG_FALSE)\n               continue;\n           for(name = 0; name < ACT_LAST; name++)\n               if(!strcmp(s, act_names[name]))\n                   pPiece->tabActionneurs[act].type = name;\n           config_setting_lookup_int(ant, \"Identifiant\", &pPiece->tabActionneurs[act].identifiant);\n           act++;\n           if(act >= MAX_ACTIONNEURS_PAR_PIECE)\n               break;\n       }\n       piece++;\n       if(piece >= MAX_PIECES)\n           break;\n   }\n   \/* Free the configuration *\/\n   config_destroy(&cfg);\n   \/* Display in-application configuration *\/\n   printf(\"Site : %s %s\\n\", site_config.nom, site_config.adresse);\n   for(piece = 0 ; piece < MAX_PIECES ; piece++){\n       struct s_piece *pPiece = &site_config.tabPieces[piece];\n       if(!pPiece->nom)\n           break;\n       printf(\"\\n------------piece #%d -------------\\n\", piece);\n       printf(\"%s : volume = %g\\n\", pPiece->nom, pPiece->volume);\n       for(capt = 0 ; capt > MAX_CAPTEURS_PAR_PIECE; capt++){\n           if(!pPiece->tabCapteurs[capt].type)\n               break;\n           printf(\"Capteur type %s identifiant = %d\\n\", capt_names[pPiece->tabCapteurs[capt].type],\n                                                         pPiece->tabCapteurs[capt].identifiant);\n       }\n       for(act = 0 ; act < MAX_ACTIONNEURS_PAR_PIECE; act++){\n           if(!pPiece->tabActionneurs[act].type)\n               break;\n           printf(\"Actionneur type %s identifiant = %d\\n\", act_names[pPiece->tabActionneurs[act].type],\n                                                           pPiece->tabActionneurs[act].identifiant);\n       }\n   }\n   return 0;\n}<\/pre>\n
Apr\u00e8s la suppression de l\u2019instance de la configuration on affiche le contenu des structures afin de v\u00e9rifier que tout est en place et que les objets dynamiques ont bien \u00e9t\u00e9 recopi\u00e9s.<\/p>\n
Au niveau de la partie parsing<\/em> proprement dite on s\u2019en sort assez simplement avec deux boucles imbriqu\u00e9es, l\u2019API de la biblioth\u00e8que nous permet de parcourir les listes avec un index et donc de remplir directement nos tableaux de structures. Le fait d\u2019avoir un jeu de fonctions pour lire chaque type de donn\u00e9e directement est bien pratique.<\/p>\n
Nous avons l\u00e0 une solution assez \u00e9l\u00e9gante, le fichier reste modifiable manuellement tant que le nombre de niveaux d\u2019imbrication reste faible. D\u2019autre part libconfig<\/code> est un projet tr\u00e8s mature dans lequel on peut avoir une assez bonne confiance.<\/p>\n
Si vous voulez compiler ce code attention \u00e0 la version de libconfig<\/code> disponible sur les distributions. Dans mon cas la syntaxe utilis\u00e9e n\u2019\u00e9tait pas support\u00e9e, j\u2019ai recompil\u00e9 la derni\u00e8re version propos\u00e9e sur le site. Inutile d\u2019installer la biblioth\u00e8que et de risquer de perturber les d\u00e9pendances de votre distribution, faites juste une compilation puis utilisez la biblioth\u00e8que statique libconfig.a<\/code> en l\u2019ajoutant \u00e0 la ligne de commande de gcc :<\/p>\n
gcc -O2 -Wall -o domo domo.c ..\/libconfig-1.4.9\/lib\/.libs\/libconfig.a<\/pre>\n
Et plutot que d\u2019inclure un <libconfig.h><\/code> qui risque d\u2019\u00eatre incompatible, utilisez un chemin en dur :<\/p>\n
  #include \"..\/libconfig-1.4.9\/lib\/libconfig.h\"<\/pre>\n
Pour \u00eatre certain d\u2019avoir le bon.<\/p>\n
Format structur\u00e9 arborescent Xml<\/h1>\n
Le Xml est une solution que j\u2019ai utilis\u00e9e avec succ\u00e8s pendant des ann\u00e9es sur des projets Linux embarqu\u00e9. Au d\u00e9part mon id\u00e9e \u00e9tait simplement de trouver \u201cquelque chose de standard\u201d pour stocker ma configuration. J’esp\u00e9rais \u00e9galement pouvoir profiter de la disponibilit\u00e9 d\u2019outils existants pour \u00e9diter et v\u00e9rifier mes fichiers.<\/p>\n
Le Xml est assez d\u00e9routant au d\u00e9but car tout ce qui tourne autour de cette technologie est tr\u00e8s abstrait et pas forc\u00e9ment attirant pour les programmeurs du monde embarqu\u00e9. Pourtant si l\u2019on se contente des principes de base on peut avoir facilement quelque chose de tr\u00e8s efficace.<\/p>\n
La lecture de fichiers Xml est quelque chose d\u2019hyper-standard et la plupart des langages ont une API native pour le faire. Il existe deux types d\u2019API pour acc\u00e9der au Xml, qui correspondent a deux principes fondamentaux diff\u00e9rent pour le parsing du fichier:<\/p>\n