043_044_204 24/01/17 21:59 Page43 microsoft 43 # 204 Vcpkg, un outil pour acquérir et compiler plus simplement les librairies open source C++ sur Windows. Eric Mittelette Acquérir une librairie open source, la compiler sur Windows et l’intégrer dans son Microsoft Corp. projet C++ reste une opération délicate, voire une galère. Pour une librairie donnée, il faut trouver les sources, les installer localement, compiler la librairie et enfin la mettre à disposition du projet dans lequel vous souhaitez l’utiliser. a phase de build est de loin la plus subtile et complexe, elle nécessi- source de la librairie. Nous voulions que cette collection de « port files » te souvent un peu d’adaptation (patch) si la librairie n’est pas encore soit open source et que la communauté des développeurs C++ puisse y Ldisponible pour la version de compilateur que vous utilisez, cette contribuer en ajoutant les librairies qu’ils maintiennent ou utilisent. adaptation nécessite encore l’usage d’incantations (sous forme de scripts, L’architecture générale en découle assez naturellement : pas de magie noire…), que seuls les grands « faiseurs » maîtrisent réelle- • Créer une liste de « port file » dans un repo Github ; ment. Nous savons par sondage et les appels au support technique de • Créer un outil en ligne de commande qui exploite cette liste et capable Microsoft que les librairies tierces restent pour plus de 30% des cas le blo- de lancer le processus de compilation au regard des instructions de queur a la migration vers les dernières versions du compilateur C++. Nous chaque « port file » ; savons également que 80% des projets C++ utilisent 2 ou 3 librairies • Installer le résultat de la compilation dans un répertoire local « « LibFolder » ; tierces en moyenne, et que la vaste majorité d’entre elles sont aujourd’hui • Permettre une intégration simple avec Visual studio, CMake ou tout des librairies open source. Intéressant de noter que cette proportion s’est autre build system de ce « LibFolder ». inversée ces 10-15 dernières années ;, au départ c’étaient essentiellement Le « LibFolder » est distribuable par simple Xcopy, ou partageable sur un des librairies propriétaires qui étaient utilisées par les développeurs C++. réseau (pas de registry, gac…). Le « LibFolder » est indépendant de Vcpkg ; Aujourd’hui la seule solution proposée par Microsoft pour acquérir des li- on peut donc ajouter ce que l’on veut dedans, comme par exemple des li- brairies tierces C++, est NuGet, mais NuGet n’a pas été pensé pour le code brairies propriétaires ou personnelles. Le « LibFolder » peut être vu comme natif, mais pour le code managé. Bien sûr il est tout à fait possible d’utiliser un cache global pour les librairies C++. Un « LibFolder » est donc un en- NuGet, mais il est important de noter que le package a été produit pour semble de librairies stables et compatibles les unes avec les autres, il n’y une ligne de compilation donnée (si vous utilisez d’autres options pour aura donc qu’une seule version d’une librairie donnée dans un votre code, ça ne marchera pas correctement !) et comme vous n’avez pas « LibFolder ». Si l’on souhaite une seconde version (ou plus) d’une même accès au code source, vous ne pourrez pas utiliser cette librairie. Or nous librairie, il faudra créer un nouveau « LibFolder ». Vcpkg ne propose pas : savons grâce aux enquêtes et interviews réalisées que les développeurs • Un format d’archive. Le « LibFolder » n’est pas compressé ; C++ veulent avoir accès aux codes sources, soit pour debugger, soit tout • Un packaging des binaires. Même s’il est tout à fait possible de placer simplement pour vérifier la qualité du code qu’ils s’apprêtent à injecter dans le « LibFolder » ce que l’on veut, comme des librairies proprié- dans leur projet. Fort de ces constats, nous avons décidé de proposer une taires en binaire (exposant .h et .lib et dll). solution pour Windows. Le parti pris pour le design était de proposer une solution open source ou tout le monde peut participer, et de s’inspirer de Vcpkg en action ce qui marche sur les autres plateformes telle Linux ou Mac. Nous avons La première chose à faire, pour utiliser Vcpkg, est d’installer l’outil en clo- passé un bon moment à regarder Debian, app-get ou Homebrew, pour nant le repo GitHub : vérifier nos hypothèses, issues de nos dernières enquêtes sur le sujet : git clone https://github.com/microsoft/vcpkg.git • 80% des projets VC++ utilisent 2 à 3 librairies externes, donc plus de 80% sont des librairies en open source ; Ensuite il faut compiler Vcpkg lui-même en exécutant cette commande • Les Dev C++ veulent avoir accès au code, pour des raisons de revues depuis le répertoire ou a été cloné le repo : de qualité ou de débogage ; powershell -exec bypass scripts\bootstrap.ps1 • Maintenir un ensemble de librairies stables entre elles est un point cri- tique (« library hell ») ; Vcpkg.exe va alors être généré ainsi que le « LibFolder », celui-ci aura la • Proposer un ensemble de librairies sur les versions les plus récentes ; hiérarchie suivante : [1]. Les librairies installées sont dans le répertoire • Il est important de pouvoir disposer de plusieurs versions d’une même installed, soit en release, soit en debug. Pour une cible donnée (dans la lib sur un même poste (pas dans un même exécutable) ; 1 • Les développeurs doivent pouvoir modifier à loisir les options de compilation ; • Les librairies doivent être utilisable en statique ou dynamique (Link). Architecture globale Vcpkg a été conçue sur une approche « port tree ». Wikipedia (https://en.wikipedia.org/wiki/Ports_collection) définit cette approche comme suit : « un ensemble de makefile et patches …. comme méthode simple pour installer des logiciels ou créer des packages binaires ». Un « port file » décrit comment compiler une libraire, il ne contient pas le code programmez! - février 2017 043_044_204 24/01/17 21:59 Page44 44 microsoft # 204 figure ci-dessous x86-windows) vous trouverez le ré- Vcpkg integrate remove pertoire include contenant les headers(.h), le répertoire lib contenant les (.lib), et le répertoire bin Cette commande va supprimer uniquement l’intégration au niveau utili- 2 contenant les dll, idem pour le mode debug. [2] sateur, pour les intégrations au niveau projet il faudra désinstaller le pac- kage NuGet du projet. Il ne peut y avoir pour un projet donné deux inté- Installer et utiliser une librairie avec Vcpkg grations, donc si vous ajoutez un package NuGet, seul ce dernier comp- Rien de plus simple ! A quand remonte votre derrière expérience en la te et l’intégration niveau utilisateur est supprimée du projet courant. On matière ? Avez-vous déjà essayé d’installer Boost ou OpenCV ? Si c’est peut tout à fait utiliser Vcpkg et son LibFolder depuis CMake, il suffit alors le cas vous devez vous rappeler que ce n’est pas toujours trivial ! Avec d’ajouter le fichier toolchain (scripts\buildsystems\vcpkg.cmake) Vcpkg il suffit de faire appel à la commande install : dans votre fichier CMake : Vcpkg install boost -DCMAKE_TOOLCHAIN_FILE=D:\src\vcpkg\scripts\buildsystems\vcpkg.cmake Et voilà c’est fait ! Bon vous aurez le temps de boire un café, voir la cafetière selon Le fichier examples.md sur github [https://github.com/Microsoft/vcpkg/blob/mas- la puissance de votre machine, car il faut du temps pour compiler OpenCV ou ter/docs/EXAMPLES.md] explique plus avant la mise en œuvre. Boost ;-) Mais cette commande suffira ! Vcpkg travaille de manière récursive et La commande update, ne va pas modifier le contenu du LibFolder (ce installera en premier les librairies dont dépend la librairie que vous souhaitez ins- serait trop dangereux, aucune mise à jour est automatique par design). taller. En fait la première commande que vous allez utiliser sera : Cette commande va juste lister les librairies qui ont été mises à jour sur le repo GitHub. C’est au développeur de faire ou non la mise à jour. [3] Vcpkg search Celle-ci vous permettra de lister toute les librairies disponibles (à la date Ajouter une nouvelle librairie : création de rédaction de cet article elles sont au nombre d’environ 100). Le nom d’un nouveau port file listé est celui à utiliser pour installer la librairie, la commande liste égale- Pour ajouter une librairie au catalogue il faut fournir : ment le numéro de version et une description sommaire de quelques • Un fichier de contrôle : mots. Par défaut c’est la version x86 dynamique (dll) qui est installée, - Très simple il contient le nom, la version, une courte description et les pour préciser la plateforme cible on ajoutera un triplet : éventuelles dépendances de la librairie. • Un port file : Vcpkg instal zlib :x64-windows - Ecrit dans la syntaxe de CMake il permet toutefois de faire appel tous La liste des triplets disponibles est dans le répertoire triplets : x64- type de build system. Il faut : uwp.cmake ; x64-windows-static.cmake ; x64-windows.cmake ; x86- - Préciser ou télécharger les sources ; uwp.cmake ; x86-windows-static.cmake ; x86-windows.cmake. - Indiquer comment les décompresser et les préparer pour la compilation ; Note, il est possible d’installer plusieurs librairies en même temps : - Appliquer les patchs le cas échéant ; - Lancer le processus de build. Vcpkg install boost, openCV, SDL • Des fichier patchs : On pourra dans cette même commande préciser les architectures cibles. - Contiennent les instructions à appliquer pour préparer le projet à être Une fois installée, il faut rendre les librairies disponibles pour Visual compile avec VC2015. Studio 2015 ou VS2017 car seules ces versions sont supportées et utili- Un exemple de création de port file et de patch file sont disponibles sur GitHub. sées. Visual Studio 2015 et 2017 utilisent la même version de la CRuntime, n’avoir qu’une seule version de la CRuntime pour toute les Contribuez ! librairies est une garantie d’inter compatibilité.