Red Hat Training

A Red Hat training course is available for Red Hat Enterprise Linux

21.10. API from Programming Languages の使用

libguestfs の API は、 Red Hat Enterprise Linux 7 の C、C++、Perl、Python、Java、Ruby、OCaml の言語で直接使用することができます。
  • C および C++ バインディングをインストールするには、以下のコマンドを入力します。
    # yum install libguestfs-devel
  • Perl バインディングをインストールするには、以下を行います。
    # yum install 'perl(Sys::Guestfs)'
  • Python バインディングをインストールするには、以下を行います。
    # yum install python-libguestfs
  • Java バインディングをインストールするには、以下を実行します。
    # yum install libguestfs-java libguestfs-java-devel libguestfs-javadoc
  • Ruby バインディングをインストールするには、以下を実行します。
    # yum install ruby-libguestfs
  • OCaml バインディングをインストールするには、以下を実行します。
    # yum install ocaml-libguestfs ocaml-libguestfs-devel
各言語のバインディングは基本的に同じですが、マイナーな変更は条件となります。C ステートメント:
guestfs_launch (g);
これは Perl で以下のように表示されます。
$g->launch ()
または、OCaml で以下のようにします。
g#launch ()
本セクションでは、C からの API のみを説明します。
C および C++ バインディングでは、手動でエラーを確認する必要があります。他のバインディングでは、エラーが例外に変換されます。以下の例で示されている追加のエラーチェックは他の言語には必要ありませんが、逆に例外キャッチするためにコードを追加したい場合があります。libguestfs API のアーキテクチャーに関する興味深い点については、以下の一覧を参照してください。
  • libguestfs API は同期されています。それぞれの呼び出しが完了するまでブロックします。呼び出しを非同期に行う場合は、スレッドを作成する必要があります。
  • libguestfs API はスレッドセーフではありません。各ハンドルは単一のスレッドからのみ使用するべきか、スレッド間でハンドルを共有する場合は、独自の mutex を実装して、2 つのスレッドが 1 つの処理で同時にコマンドを実行できないようにする必要があります。
  • 同じディスクイメージに対して複数のハンドルを開けないでください。すべてのハンドルが読み取り専用だが、推奨されないと許容されます。
  • ディスクイメージ(たとえば、ライブ仮想マシン)を使用できる場合は、書き込み用にディスクイメージを追加しないでください。これを実行すると、ディスクが破損します。
  • 現在使用中のディスクイメージ(ライブ仮想マシンなど)で読み取り専用ハンドルを開くことができます。ただし、特にディスクイメージが読んでいない時に、結果の予測できない、または一貫性がない場合もしまいません。

21.10.1. C プログラムを使用した API との対話

C プログラムは <guestfs.h> ヘッダーファイルを追加して、ハンドルを作成して開始する必要があります。
#include <stdio.h>
#include <stdlib.h>
#include <guestfs.h>

int
main (int argc, char *argv[])
{
  guestfs_h *g;

  g = guestfs_create ();
  if (g == NULL) {
    perror ("failed to create libguestfs handle");
    exit (EXIT_FAILURE);
   }

   /* ... */

   guestfs_close (g);

   exit (EXIT_SUCCESS);
 }
このプログラムをファイル(test.c)に保存します。このプログラムをコンパイルし、以下の 2 つのコマンドを使用して実行します。
gcc -Wall test.c -o test -lguestfs
./test
この段階では出力は出力されません。このセクションの残りの部分では、このプログラムを拡張して、新しいディスクイメージを作成し、ext4 ファイルシステムでフォーマットしてファイルシステム内にファイルを作成する方法を示しています。ディスクイメージは disk.img と呼ばれ、現在のディレクトリーに作成されます。
プログラムの概要は以下のとおりです。
  • ハンドルの作成
  • ディスクのハンドルへの追加
  • libguestfs バックエンドの起動
  • パーティション、ファイルシステムおよびファイル群の作成
  • ハンドルを閉じて終了
以下は変更されたプログラムです。
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <fcntl.h>
#include <unistd.h>
#include <guestfs.h>

 int
 main (int argc, char *argv[])
 {
   guestfs_h *g;
   size_t i;

   g = guestfs_create ();
   if (g == NULL) {
     perror ("failed to create libguestfs handle");
     exit (EXIT_FAILURE);
  }

   /* Create a raw-format sparse disk image, 512 MB in size. */
   int fd = open ("disk.img", O_CREAT|O_WRONLY|O_TRUNC|O_NOCTTY, 0666);
   if (fd == -1) {
     perror ("disk.img");
     exit (EXIT_FAILURE);
   }
   if (ftruncate (fd, 512 * 1024 * 1024) == -1) {
     perror ("disk.img: truncate");
     exit (EXIT_FAILURE);
   }
   if (close (fd) == -1) {
     perror ("disk.img: close");
     exit (EXIT_FAILURE);
   }

   /* Set the trace flag so that we can see each libguestfs call. */
   guestfs_set_trace (g, 1);

   /* Set the autosync flag so that the disk will be synchronized
    * automatically when the libguestfs handle is closed.
    */
   guestfs_set_autosync (g, 1);

   /* Add the disk image to libguestfs. */
   if (guestfs_add_drive_opts (g, "disk.img",
         GUESTFS_ADD_DRIVE_OPTS_FORMAT, "raw", /* raw format */
         GUESTFS_ADD_DRIVE_OPTS_READONLY, 0,   /* for write */
         -1 /* this marks end of optional arguments */ )
       == -1)
     exit (EXIT_FAILURE);

   /* Run the libguestfs back-end. */
   if (guestfs_launch (g) == -1)
     exit (EXIT_FAILURE);

   /* Get the list of devices. Because we only added one drive
    * above, we expect that this list should contain a single
    * element.
    */
   char **devices = guestfs_list_devices (g);
   if (devices == NULL)
     exit (EXIT_FAILURE);
   if (devices[0] == NULL || devices[1] != NULL) {
     fprintf (stderr,
              "error: expected a single device from list-devices\n");
     exit (EXIT_FAILURE);
   }

   /* Partition the disk as one single MBR partition. */
   if (guestfs_part_disk (g, devices[0], "mbr") == -1)
     exit (EXIT_FAILURE);

   /* Get the list of partitions. We expect a single element, which
    * is the partition we have just created.
    */
   char **partitions = guestfs_list_partitions (g);
   if (partitions == NULL)
     exit (EXIT_FAILURE);
   if (partitions[0] == NULL || partitions[1] != NULL) {
     fprintf (stderr,
              "error: expected a single partition from list-partitions\n");
     exit (EXIT_FAILURE);
   }

   /* Create an ext4 filesystem on the partition. */
   if (guestfs_mkfs (g, "ext4", partitions[0]) == -1)
     exit (EXIT_FAILURE);

   /* Now mount the filesystem so that we can add files. */
   if (guestfs_mount_options (g, "", partitions[0], "/") == -1)
     exit (EXIT_FAILURE);

   /* Create some files and directories. */
   if (guestfs_touch (g, "/empty") == -1)
     exit (EXIT_FAILURE);

   const char *message = "Hello, world\n";
   if (guestfs_write (g, "/hello", message, strlen (message)) == -1)
     exit (EXIT_FAILURE);

   if (guestfs_mkdir (g, "/foo") == -1)
     exit (EXIT_FAILURE);

   /* This uploads the local file /etc/resolv.conf into the disk image. */
   if (guestfs_upload (g, "/etc/resolv.conf", "/foo/resolv.conf") == -1)
     exit (EXIT_FAILURE);

   /* Because 'autosync' was set (above) we can just close the handle
    * and the disk contents will be synchronized. You can also do
    * this manually by calling guestfs_umount_all and guestfs_sync.
    */
   guestfs_close (g);

   /* Free up the lists. */
   for (i = 0; devices[i] != NULL; ++i)
     free (devices[i]);
   free (devices);
   for (i = 0; partitions[i] != NULL; ++i)
     free (partitions[i]);
   free (partitions);

   exit (EXIT_SUCCESS);
 }
以下の 2 つのコマンドを使用して、このプログラムをコンパイルして実行します。
gcc -Wall test.c -o test -lguestfs
./test
プログラムが正常に完了したら、disk.img というディスクイメージで残す必要があります。このイメージは、guestfish で検証できます。
guestfish --ro -a disk.img -m /dev/sda1
><fs> ll /
><fs> cat /foo/resolv.conf
デフォルトでは、(C および C++ バインディングのみ)libguestfs がエラーを標準エラーに出力します。この動作を変更するには、エラーハンドラーを設定します。man ページの guestfs(3)では、これについて詳しく説明します。

このページには機械翻訳が使用されている場合があります (詳細はこちら)。