release/man3/malloc_hook.3

   1 .\" Copyright 2002 Walter Harms (walter.harms@informatik.uni-oldenburg.de)
   2 .\"
   3 .\" %%%LICENSE_START(GPL_NOVERSION_ONELINE)
   4 .\" Distributed under GPL
   5 .\" %%%LICENSE_END
   6 .\"
   7 .\" Heavily based on glibc documentation
   8 .\" Polished, added docs, removed glibc doc bug, 2002-07-20, aeb
   9 .\"
  10 .\"*******************************************************************
  11 .\"
  12 .\" This file was generated with po4a. Translate the source file.
  13 .\"
  14 .\"*******************************************************************
  15 .\"
  16 .\" Japanese Version Copyright (c) 2002 Akihiro MOTOKI all rights reserved.
  17 .\" Translated Thu 05 Dec 2002 by Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>
  18 .\" Updated 2013-05-01, Akihiro MOTOKI <amotoki@gmail.com>
  19 .\" Updated 2013-05-06, Akihiro MOTOKI <amotoki@gmail.com>
  20 .\"
  21 .TH MALLOC_HOOK 3 2010\-10\-13 GNU "Linux Programmer's Manual"
  22 .SH 名前
  23 __malloc_hook, __malloc_initialize_hook, __memalign_hook, __free_hook,
  24 __realloc_hook, __after_morecore_hook \- malloc デバッグ用の変数
  25 .SH 書式
  26 .nf
  27 \fB#include <malloc.h>\fP
  28 .sp
  29 \fBvoid *(*__malloc_hook)(size_t \fP\fIsize\fP\fB, const void *\fP\fIcaller\fP\fB);\fP
  30 .sp
  31 \fBvoid *(*__realloc_hook)(void *\fP\fIptr\fP\fB, size_t \fP\fIsize\fP\fB, const void *\fP\fIcaller\fP\fB);\fP
  32 .sp
  33 \fBvoid *(*__memalign_hook)(size_t \fP\fIalignment\fP\fB, size_t \fP\fIsize\fP\fB,\fP
  34 \fB                         const void *\fP\fIcaller\fP\fB);\fP
  35 .sp
  36 \fBvoid (*__free_hook)(void *\fP\fIptr\fP\fB, const void *\fP\fIcaller\fP\fB);\fP
  37 .sp
  38 \fBvoid (*__malloc_initialize_hook)(void);\fP
  39 .sp
  40 \fBvoid (*__after_morecore_hook)(void);\fP
  41 .fi
  42 .SH 説明
  43 GNU C ライブラリでは、適切なフック関数 (hook function) を指定することで \fBmalloc\fP(3), \fBrealloc\fP(3),
  44 \fBfree\fP(3)  の動作を変更することができる。例えば、動的にメモリ割り当てを行う プログラムのデバッグにこれらのフックを使うことができる。
  45 .LP
  46 変数 \fB__malloc_initialize_hook\fP は malloc の実装が初期化される際に一度だけ呼ばれる関数へのポインタである。
  47 この変数は書き換え可能 (weak) であり、アプリケーション内で 以下のような定義で上書きできる:
  48 .nf
  49
  50     void (*__malloc_initialize_hook)(void) = my_init_hook;
  51
  52 .fi
  53 なお、関数 \fImy_init_hook\fP()  で全てのフックの初期化をすることができる。
  54 .LP
  55 \fB__malloc_hook\fP, \fB__realloc_hook\fP, \fB__memalign_hook\fP, \fB__free_hook\fP
  56 で指される 4 つの関数は、各々 \fBmalloc\fP(3), \fBrealloc\fP(3), \fBmemalign\fP(3), \fBfree\fP(3)
  57 とよく似たプロトタイプを持っているが、 一番最後の引き数 \fIcaller\fP をとる点が異なる。 引き数 \fIcaller\fP には、
  58 \fBmalloc\fP(3)  などの呼び出し元 (caller) のアドレスが格納される。
  59 .LP
  60 変数 \fB__after_morecore_hook\fP は、領域の追加要求があり \fBsbrk\fP(2)
  61 が呼ばれた後で毎回呼び出される関数へのポインタである。
  62 .SH 準拠
  63 これらの関数は GNU による拡張である。
  64 .SH 注意
  65 .\" https://bugzilla.redhat.com/show_bug.cgi?id=450187
  66 .\" http://sourceware.org/bugzilla/show_bug.cgi?id=9957
  67 マルチスレッドプログラムでは、 これらのフック関数の使用は安全ではなく、 今では非推奨である。 プログラマは、 "malloc" や "free"
  68 のような関数を定義して公開して、 関連する関数を呼び出すようにすべきである。
  69 .SH 例
  70 これらの変数の使い方の簡単な例を以下に示す。
  71 .sp
  72 .nf
  73 #include <stdio.h>
  74 #include <malloc.h>
  75
  76 /* 使おうとするフックのプロトタイプ宣言 */
  77 static void my_init_hook(void);
  78 static void *my_malloc_hook(size_t, const void *);
  79
  80 /* 元々のフックを保存するための変数 */
  81 static void *(*old_malloc_hook)(size_t, const void *);
  82
  83 /* C ライブラリから呼ばれる初期化フックを上書きする */
  84 void (*__malloc_initialize_hook) (void) = my_init_hook;
  85
  86 static void
  87 my_init_hook(void)
  88 {
  89     old_malloc_hook = __malloc_hook;
  90     __malloc_hook = my_malloc_hook;
  91 }
  92
  93 static void *
  94 my_malloc_hook(size_t size, const void *caller)
  95 {
  96     void *result;
  97
  98     /* 元々のフックを全て戻す */
  99     __malloc_hook = old_malloc_hook;
 100
 101     /* malloc の再帰的呼び出し */
 102     result = malloc(size);
 103
 104     /* 現在設定されているフック (underlying hook) を保存する */
 105     old_malloc_hook = __malloc_hook;
 106
 107     /* printf() は malloc() を呼び出す可能性があるので
 108         ここでもガードを行う (元々のフックのままにしておく) */
 109     printf("malloc(%u) called from %p returns %p\en",
 110             (unsigned int) size, caller, result);
 111
 112     /* ユーザが使おうとするフックを再設定する */
 113     __malloc_hook = my_malloc_hook;
 114
 115     return result;
 116 }
 117 .fi
 118 .SH 関連項目
 119 \fBmallinfo\fP(3), \fBmalloc\fP(3), \fBmcheck\fP(3), \fBmtrace\fP(3)
 120 .SH この文書について
 121 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.65 の一部
 122 である。プロジェクトの説明とバグ報告に関する情報は
 123 http://www.kernel.org/doc/man\-pages/ に書かれている。