名前

       malloc_info - malloc の状態をストリームに出力する

書式

       #include <malloc.h>

       int malloc_info(int options, FILE *fp);

説明

       malloc_info() 関数は、 呼び出し元のメモリ割り当て実装の現在の状態を表す XML 文字列を出力す
       る。 文字列は、 ファイルストリーム fp に出力される。 出力された文字列には、 全ての割り当て
       領域の情報が含まれる (malloc(3) 参照)。

       現在の実装では、 options は 0 でなければならない。

返り値

       malloc_info() は、成功すると 0 を返す。 エラーの場合、-1 を返し、 errno にエラーの原因を示
       す値を設定する。

エラー

       EINVAL options が 0 でなかった。

バージョン

       malloc_info() は glibc バージョン 2.10 で追加された。

準拠

       この関数は GNU による拡張である。

注意

       メモリ割り当て情報は (C の構造体ではなく) XML 文字列として提供される。 これは、 この情報は
       時間をたつと  (内部で使用している実装によって)  変わる可能性があるからである。  出力される
       XML 文字列にはバージョンフィールドが付いている。

       open_memstream(3) 関数を使うと、 malloc_info()  の出力を、  ファイルではなくメモリ内のバッ
       ファに直接送ることができる。

       malloc_info() 関数は、 malloc_stats(3) と mallinfo(3) の不備を解決するために設定された。

例

       以下のプログラムは最大で 4 つのコマンドライン引数を取り、 最初の 3 つは必須である。 最初の
       引数は、このプログラムが生成するスレッド数を指定する。  メインスレッドを含む全てのスレッド
       が第  2 引数で指定した数のメモリブロックの割り当てを行う。 第 3 引数は割り当てるブロックの
       サイズを制御する。 メインスレッドはこのサイズのブロックを作成し、 このプログラムが生成する
       2 番目のスレッドはこのサイズの 2 倍のサイズのブロックを、 3 番目のスレッドはこのサイズの 3
       倍のサイズのブロックを割り当て、 以下同様である。

       このプログラムは malloc_info() を 2 回呼び出し、メモリ割り当て状態を表示する。  最初の呼び
       出しはスレッドの生成もメモリの割り当ても行われる前に実行される。  2 回目の呼び出しは全ての
       スレッドがメモリ割り当てを行った後に実行される。

       以下の例では、 コマンドライン引数で、 追加でスレッドを一つ生成し、メインスレッドと追加のス
       レッドの両方が 10000 個のメモリブロックを割り当てるように指定している。 メモリブロックの割
       り当て後の malloc_info() では、 2 つの割り当て領域の状態が表示されている。

           $ getconf GNU_LIBC_VERSION
           glibc 2.13
           $ ./a.out 1 10000 100
           ============ Before allocating blocks ============
           <malloc version="1">
           <heap nr="0">
           <sizes>
           </sizes>
           <total type="fast" count="0" size="0"/>
           <total type="rest" count="0" size="0"/>
           <system type="current" size="135168"/>
           <system type="max" size="135168"/>
           <aspace type="total" size="135168"/>
           <aspace type="mprotect" size="135168"/>
           </heap>
           <total type="fast" count="0" size="0"/>
           <total type="rest" count="0" size="0"/>
           <system type="current" size="135168"/>
           <system type="max" size="135168"/>
           <aspace type="total" size="135168"/>
           <aspace type="mprotect" size="135168"/>
           </malloc>

           ============ After allocating blocks ============
           <malloc version="1">
           <heap nr="0">
           <sizes>
           </sizes>
           <total type="fast" count="0" size="0"/>
           <total type="rest" count="0" size="0"/>
           <system type="current" size="1081344"/>
           <system type="max" size="1081344"/>
           <aspace type="total" size="1081344"/>
           <aspace type="mprotect" size="1081344"/>
           </heap>
           <heap nr="1">
           <sizes>
           </sizes>
           <total type="fast" count="0" size="0"/>
           <total type="rest" count="0" size="0"/>
           <system type="current" size="1032192"/>
           <system type="max" size="1032192"/>
           <aspace type="total" size="1032192"/>
           <aspace type="mprotect" size="1032192"/>
           </heap>
           <total type="fast" count="0" size="0"/>
           <total type="rest" count="0" size="0"/>
           <system type="current" size="2113536"/>
           <system type="max" size="2113536"/>
           <aspace type="total" size="2113536"/>
           <aspace type="mprotect" size="2113536"/>
           </malloc>

   プログラムのソース
       #include <unistd.h>
       #include <stdlib.h>
       #include <pthread.h>
       #include <malloc.h>
       #include <errno.h>

       static size_t blockSize;
       static int numThreads, numBlocks;

       #define errExit(msg)    do { perror(msg); exit(EXIT_FAILURE); \
                               } while (0)

       static void *
       thread_func(void *arg)
       {
           int j;
           int tn = (int) arg;

           /* The multiplier '(2 + tn)' ensures that each thread (including
              the main thread) allocates a different amount of memory */

           for (j = 0; j < numBlocks; j++)
               if (malloc(blockSize * (2 + tn)) == NULL)
                   errExit("malloc-thread");

           sleep(100);         /* Sleep until main thread terminates */
           return NULL;
       }

       int
       main(int argc, char *argv[])
       {
           int j, tn, sleepTime;
           pthread_t *thr;

           if (argc < 4) {
               fprintf(stderr,
                       "%s num-threads num-blocks block-size [sleep-time]\n",
                       argv[0]);
               exit(EXIT_FAILURE);
           }

           numThreads = atoi(argv[1]);
           numBlocks = atoi(argv[2]);
           blockSize = atoi(argv[3]);
           sleepTime = (argc > 4) ? atoi(argv[4]) : 0;

           thr = calloc(numThreads, sizeof(pthread_t));
           if (thr == NULL)
               errExit("calloc");

           printf("============ Before allocating blocks ============\n");
           malloc_info(0, stdout);

           /* Create threads that allocate different amounts of memory */

           for (tn = 0; tn < numThreads; tn++) {
               errno = pthread_create(&thr[tn], NULL, thread_func,
                                      (void *) tn);
               if (errno != 0)
                   errExit("pthread_create");

               /* If we add a sleep interval after the start-up of each
                  thread, the threads likely won't contend for malloc
                  mutexes, and therefore additional arenas won't be
                  allocated (see malloc(3)). */

               if (sleepTime > 0)
                   sleep(sleepTime);
           }

           /* The main thread also allocates some memory */

           for (j = 0; j < numBlocks; j++)
               if (malloc(blockSize) == NULL)
                   errExit("malloc");

           sleep(2);           /* Give all threads a chance to
                                  complete allocations */

           printf("\n============ After allocating blocks ============\n");
           malloc_info(0, stdout);

           exit(EXIT_SUCCESS);
       }

関連項目

       mallinfo(3), malloc(3), malloc_stats(3), mallopt(3), open_memstream(3)

この文書について

       この man ページは Linux man-pages プロジェクトのリリース 3.54 の一部  である。プロジェクト
       の説明とバグ報告に関する情報は http://www.kernel.org/doc/man-pages/ に書かれている。