Description du projet

Simple Virtual Machine est une machine virtuelle multi-thread et extensible sous license GPLv3.

But du projet

La Simple Virtual Machine est un projet open-source permettant d'écrire des applications avec :

Contenu du projet

La machine virtuelle

L'élément central du projet est la machine virtuelle elle-même. C'est elle qui compile directement le fichier d'application et le code machine, intègre les extensions et exécute le code de l'application.

En plus de la machine, sont fournies :

• les pages de manuel de la machine, des outils annexes et des extensions officielles (Vous pouvez contribuer en relisant et proposant des ajouts ou améliorations sur la documentation !),
• les fichiers de coloration syntaxique et de gestion du code source pour certains éditeurs de texte (Vous pouvez contribuer en proposant le support d'éditeurs non encore gérés !).

La machine est versionnée XX.YY.AAAAMMJJ où :

1. XX est le numéro de version majeur, correspondant à la maturité du projet. Il est augmenté lorsqu'une fonctionnalité importante est ajoutée au projet.
2. YY est le numéro de version mineur, indicateur de compatibilité de l'interface de la machine. Il est augmenté lorsque l'interface des extensions subit un changement non compatible.
3. AAAAMMJJ est la date, incrémenté à chaque micro publication de la machine virtuelle.

Le générateur d'extensions

En plus de la machine virtuelle, un autre binaire est fourni : il permet d'écrire des extensions en C ou en C++ pour la machine virtuelle dans un format de fichier regroupant les éléments de la machine associés au code C ou C++ qui leur correspond.

Le générateur produit un script shell qui peut être exécuté par Bash et qui lui-même créera un répertoire contenant :

• le code source de l'extension,
• la page de manuel de l'extension,
• deux systèmes de compilation (Makefile simple et fichiers Autotools),
• des scripts de maintenance.

Extensions

Des exemples ?

Au lieu de proposer des exemples ici, qui demeureraient abscons sans une explication poussée, il est plutôt recommandé de suivre directement les didacticiels, qui présentent pas à pas les syntaxes et les sémantiques associées des fichiers sources de la machine et du générateur d'extension.

Pour jouer avec ?

Le projet

Pour télécharger l'archive et la compiler, il vous faudra les outils standards de compilation. Sous gentoo, ces outils sont installés de base dans le système. Sur une debian-like, il faudra build-essential, flex, bison, libtool et autotools-dev pour pouvoir compiler la machine virtuelle.

Une installation très classique consiste à décompresser l'archive de la machine, puis d'exécuter dans le répertoire de l'archive :

• ./configure
• make -j
• sudo make install

Toutes les instructions sont indiquées dans le fichier INSTALL de l'archive.

Comme alternative, il est possible d'utiliser un conteneur Docker avec la machine et les extensions installées avec une de ces commandes :

• docker run -it pappysvm/svm
• podman run -it pappysvm/svm

Les dernières versions utilisables sont :

• svm-2.8.20250319.tar.gz
• svm-2.8.20250318.tar.gz
• svm-2.8.20250310.tar.gz
• svm-2.8.20250305.tar.gz
• svm-2.8.20250302.tar.gz
• svm-2.8.20250228.tar.gz

Les versions du projet sont élaborées en fonction des changements dans le projet :

• Le premier nombre est un marqueur de l'aboutissement du projet et n'a donc qu'une signification informative,
• le second nombre augmente lorsque la mise à jour du projet comporte une incompatibilité inverse rompue au niveau de l'interface de programmation de la machine.
• le dernier nombre est la date AAAAMMJJ, et une mise à jour où seulement ce nombre change ne devrait pas perturber l'exécution des programmes (compatibilité inverse conservée).

Quelques extensions

Pour installer une extension, il faut en premier avoir installé la machine virtuelle. Puis l'installation de l'extension se fait en deux commandes (ici, l'extension array est prise en exemple) :

• svm_plugin -fi array.svm_plugin | bash
• ./svmpluginarray/plugin_install -m

Quelques fichiers de description d'extensions :

• array.svm_plugin
• bit.svm_plugin
• coroutine.svm_plugin
• enc.svm_plugin
• funccache.svm_plugin
• html.svm_plugin
• http.svm_plugin
• inline.svm_plugin
• json.svm_plugin
• library.svm_plugin
• long.svm_plugin
• sandbox.svm_plugin
• secret.svm_plugin
• serial.svm_plugin
• share.svm_plugin
• shell.svm_plugin
• sqlite.svm_plugin
• sys.svm_plugin
• task.svm_plugin
• tcp.svm_plugin
• tribe.svm_plugin
• unittest.svm_plugin
• uri.svm_plugin
• ws.svm_plugin

Ces fichiers sont à utiliser avec le générateur d'extensions, puis à compiler et installer sur le système selon votre convenance.

Des didacticiels

Pour une prise en main plus rapide et plus souple de la machine, ces didacticiels peuvent aider :

• didacticiel_fr_000_prerequis.html

• didacticiel_fr_001_invocation_application.html

• didacticiel_fr_002_invocation_application_avec_debugueur.html

• didacticiel_fr_003_ecriture_application_simple.html

• didacticiel_fr_004_interaction_simple_avec_debugueur.html

• didacticiel_fr_005_sauts.html

• didacticiel_fr_006_manipulations_basiques_memoire.html

• didacticiel_fr_007_adresses_memoire_et_pointeurs.html

• didacticiel_fr_008_tableaux.html

• didacticiel_fr_009_structures_de_controle.html

• didacticiel_fr_010_arret.html

• didacticiel_fr_011_booleens.html

• didacticiel_fr_012_fonctions.html

• didacticiel_fr_013_allocation_et_liberation_memoire.html

• didacticiel_fr_014_memoire_globale.html

• didacticiel_fr_015_interruptions_logicielles.html

• didacticiel_fr_016_instructions_extension.html

• didacticiel_fr_017_types_interruptions_extension.html

• didacticiel_fr_018_points_entree_extension.html

• didacticiel_fr_019_interaction_avancee_avec_debugueur.html

• didacticiel_fr_020_drapeaux.html

• didacticiel_fr_021_bibliotheques.html

• didacticiel_fr_022_interruptions_materielles.html

• didacticiel_fr_023_entrees_sorties.html

• didacticiel_fr_024_fonctions_recursives.html

• didacticiel_fr_099_application.html

• didacticiel_fr_101_processeur.html

• didacticiel_fr_102_memoire.html

• didacticiel_fr_103_noyau.html

• didacticiel_fr_104_sequenceur.html

• didacticiel_fr_105_processus.html

• didacticiel_fr_106_ordonnanceurs.html

• didacticiel_fr_107_systeme.html

• didacticiel_fr_108_base.html

• didacticiel_fr_200_generation_extension.html

• didacticiel_fr_201_ecriture_extension.html

• didacticiel_fr_202_interactions_machine.html

• didacticiel_fr_203_variables_svm.html

• didacticiel_fr_204_instructions.html

• didacticiel_fr_205_valeurs.html

• didacticiel_fr_206_interruptions.html

• didacticiel_fr_207_processeur.html

• didacticiel_fr_208_memoire.html

• didacticiel_fr_209_code.html

• didacticiel_fr_210_types.html

• didacticiel_fr_211_noyaux.html

• didacticiel_fr_212_sequenceurs.html

• didacticiel_fr_213_processus.html

• didacticiel_fr_214_ordonnanceurs.html

• didacticiel_fr_215_structures.html

• didacticiel_fr_216_fonctions.html

• didacticiel_fr_217_synchronisation.html

• didacticiel_fr_218_debugueur.html

• didacticiel_fr_219_extensions.html

• didacticiel_fr_220_aide.html

• didacticiel_fr_221_fichiers_et_patchs.html

• didacticiel_fr_222_tests.html

• didacticiel_fr_299_publication.html

Ces didacticiels sont donnés en français ou en anglais, sur des sujets plus ou moins variés.

Des bibliothèques

Pour accélérer vos développements, des petites bibliothèques écrits en langage machine sont disponibles :

• list.lib.svm

Elles sont données en l'état, sans aucune garantie de fonctionnement avec une version de la machine virtuelle ne correspondant pas à la date indiquée sur l'archive des bibliothèques.

Des outils supplémentaires

• plugins_migration_to_svm_2.0.sh
• plugins_migration_to_svm_2.2.sh
• plugins_migration_to_svm_2.3.sh
• updateSVM.sh
• update_machine_plugin_declarations.sh

Pour contribuer ?

Le projet n'étant pas terminé, des petites contributions seront appréciées :

1. je n'ai pour le moment aucune relecture faite sur la documentation (en anglais),
2. ni de traduction en français de cette documentation,
3. je manque de volontaires qui veulent bien écrire des didacticiels permettant aux autres de s'investir dans le projet,
4. la machine virtuelle est normalement stable suite aux tests que j'ai moi-même pu réaliser à travers des petites applications, mais d'autres personnes pourraient trouver des bugs en codant en langage machine, et je serais ravi d'avoir les rapports de bugs…
5. pour ceux qui veulent voir leur extension intégrée au projet, ils peuvent faire leur proposition.

Me contacter…

Pour une question sur le projet, une amélioration possible, un rapport de bug, envoyez-moi un email à l'adresse projet.svm [chez] pappy.tf, merci !