Import translated manuals from JM CVS Repository.

[linuxjm/jm.git] / manual / LDP_man-pages / draft / man2 / query_module.2

.\" Copyright (C) 1996 Free Software Foundation, Inc.
.\" This file is distributed according to the GNU General Public License.
.\" See the file COPYING in the top level source directory for details.
.\"
.\" 2006-02-09, some reformatting by Luc Van Oostenryck; some
.\" reformatting and rewordings by mtk
.\"
.\" Japanese Version Copyright (c) 2006 Akihiro MOTOKI all rights reserved.
.\" Translated 2006-07-29, Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>
.\"
.TH QUERY_MODULE 2 2007-06-03 "Linux" "Linux Programmer's Manual"
.\"O .SH NAME
.SH ̾Á°
.\"O query_module \- query the kernel for various bits pertaining to modules
query_module \- ¥â¥¸¥å¡¼¥ë¤Ë´ØÏ¢¤¹¤ë³Æ¼ï¤Î¾ðÊó¤ò¥«¡¼¥Í¥ë¤ËÌ䤤¹ç¤ï¤»¤ë
.\"O .SH SYNOPSIS
.SH ½ñ¼°
.nf
.B #include <linux/module.h>
.sp
.BI "int query_module(const char *" name ", int " which ", void *" buf ,
.BI "                 size_t " bufsize ", size_t *" ret );
.fi
.\"O .SH DESCRIPTION
.SH ÀâÌÀ
.\"O .BR query_module ()
.\"O requests information from the kernel about loadable modules.
.\"O The returned information is placed in the buffer pointed to by
.\"O .IR buf .
.\"O The caller must specify the size of
.\"O .I buf
.\"O in
.\"O .IR bufsize .
.\"O The precise nature and format of the returned information
.\"O depend on the operation specified by
.\"O .IR which .
.\"O Some operations require
.\"O .I name
.\"O to identify a currently loaded module, some allow
.\"O .I name
.\"O to be NULL, indicating the kernel proper.
.BR query_module ()
¤Ï¡¢¥í¡¼¥À¥Ö¥ë¥â¥¸¥å¡¼¥ë¤Ë´Ø¤¹¤ë¾ðÊó¤ò¥«¡¼¥Í¥ë¤ËÌ䤤¹ç¤ï¤»¤ë¡£
¾ðÊó¤Ï
.I buf
¤¬»Ø¤·¼¨¤¹¥Ð¥Ã¥Õ¥¡¤Ë³ÊǼ¤µ¤ì¤ÆÊÖ¤µ¤ì¤ë¡£
¸Æ¤Ó½Ð¤·¸µ¤Ï
.I buf
¤Î¥µ¥¤¥º¤ò
.I bufsize
¤Ë»ØÄꤷ¤Ê¤±¤ì¤Ð¤Ê¤é¤Ê¤¤¡£
ÆÀ¤é¤ì¤ë¾ðÊó¤ÎÀµ³Î¤Ê°ÕÌ£¤È¥Õ¥©¡¼¥Þ¥Ã¥È¤Ï¡¢
.I which
¤Ç¤É¤ÎÁàºî¤ò»ØÄꤹ¤ë¤«¤Ë¤è¤Ã¤Æ°Û¤Ê¤ë¡£
¸½ºß¥í¡¼¥É¤µ¤ì¤Æ¤¤¤ë¥â¥¸¥å¡¼¥ë¤òÆÃÄꤹ¤ë¤¿¤á¤Ë
.I name
¤òɬÍפȤ¹¤ëÁàºî¤¬¤¢¤ì¤Ð¡¢
¥«¡¼¥Í¥ë¸ÇÍ­¤Ç¤¢¤ë¤³¤È¤ò¼¨¤¹ NULL ¤ò»ØÄê¤Ç¤­¤ëÁàºî¤â¤¢¤ë¡£

.\"O The following values can be specified for
.\"O .IR which :
.I which
¤Ë¤Ï°Ê²¼¤ÎÃͤò»ØÄê¤Ç¤­¤ë:
.TP
.B 0
.\"O Returns success, if the kernel supports
.\"O .BR query_module ().
.\"O Used to probe for availability of the system call.
¥«¡¼¥Í¥ë¤¬
.BR query_module ()
¤ò¥µ¥Ý¡¼¥È¤·¤Æ¤¤¤ë¾ì¹ç¡¢À®¸ù¤òÊÖ¤¹¡£
¤³¤Î¥·¥¹¥Æ¥à¥³¡¼¥ë¤¬ÍøÍѲÄǽ¤«¤òÄ´¤Ù¤ë¤¿¤á¤Ë»È¤ï¤ì¤ë¡£
.TP
.B QM_MODULES
.\"O Returns the names of all loaded modules.
.\"O The returned buffer consists of a sequence of null-terminated strings;
.\"O .I ret
.\"O is set to the number of
.\"O modules.
¥í¡¼¥É¤µ¤ì¤Æ¤¤¤ëÁ´¤Æ¤Î¥â¥¸¥å¡¼¥ë¤Î̾Á°¤òÊÖ¤¹¡£
¥Ð¥Ã¥Õ¥¡¤Ë¤Ï¡¢NULL ½ªÃ¼¤µ¤ì¤¿Ê¸»úÎ󤬽ç¤ËÆþ¤ë¡£
ÊÖ¤µ¤ì¤ë¥Ð¥Ã¥Õ¥¡
.I ret
¤Ë¤Ï¥â¥¸¥å¡¼¥ë¤Î¿ô¤¬ÀßÄꤵ¤ì¤ë¡£
.\" ret is set on ENOSPC
.TP
.B QM_DEPS
.\"O Returns the names of all modules used by the indicated module.
.\"O The returned buffer consists of a sequence of null-terminated strings;
.\"O .I ret
.\"O is set to the number of modules.
»ØÄꤵ¤ì¤¿¥â¥¸¥å¡¼¥ë¤¬»ÈÍѤ·¤Æ¤¤¤ëÁ´¥â¥¸¥å¡¼¥ë¤Î̾Á°¤òÊÖ¤¹¡£
¥Ð¥Ã¥Õ¥¡¤Ë¤Ï¡¢NULL ½ªÃ¼¤µ¤ì¤¿Ê¸»úÎ󤬽ç¤ËÆþ¤ë¡£
ÊÖ¤µ¤ì¤ë¥Ð¥Ã¥Õ¥¡
.I ret
¤Ë¤Ï¥â¥¸¥å¡¼¥ë¤Î¿ô¤¬ÀßÄꤵ¤ì¤ë¡£
.\" ret is set on ENOSPC
.TP
.B QM_REFS
.\"O Returns the names of all modules using the indicated module.
.\"O This is the inverse of
.\"O .BR QM_DEPS .
.\"O The returned buffer consists of a sequence of null-terminated strings;
.\"O .I ret
.\"O is set to the number of modules.
»ØÄꤵ¤ì¤¿¥â¥¸¥å¡¼¥ë¤ò»ÈÍѤ·¤Æ¤¤¤ëÁ´¥â¥¸¥å¡¼¥ë¤Î̾Á°¤òÊÖ¤¹¡£
¤³¤ì¤Ï
.B QM_DEPS
¤ÈµÕ¤Îµ¡Ç½¤Ç¤¢¤ë¡£
¥Ð¥Ã¥Õ¥¡¤Ë¤Ï¡¢NULL ½ªÃ¼¤µ¤ì¤¿Ê¸»úÎ󤬽ç¤ËÆþ¤ë¡£
ÊÖ¤µ¤ì¤ë¥Ð¥Ã¥Õ¥¡
.I ret
¤Ë¤Ï¥â¥¸¥å¡¼¥ë¤Î¿ô¤¬ÀßÄꤵ¤ì¤ë¡£
.\" ret is set on ENOSPC
.TP
.B QM_SYMBOLS
.\"O Returns the symbols and values exported by the kernel or the indicated
.\"O module.
.\"O The returned buffer is an array of structures of the following form
¥«¡¼¥Í¥ë¤Þ¤¿¤Ï»ØÄꤵ¤ì¤¿¥â¥¸¥å¡¼¥ë¤¬¥¨¥¯¥¹¥Ý¡¼¥È¤·¤Æ¤¤¤ë¥·¥ó¥Ü¥ë¤È
ÃͤòÊÖ¤¹¡£
¥Ð¥Ã¥Õ¥¡¤Î¥Ç¡¼¥¿¤Ï¡¢
°Ê²¼¤Î¹½Â¤ÂΤÎÇÛÎó¤Ë NULL ½ªÃ¼¤µ¤ì¤¿Ê¸»úÎó¤¬Â³¤¯·Á¤È¤Ê¤ë¡£
.\" ret is set on ENOSPC
.in +4n
.nf

struct module_symbol {
    unsigned long value;
    unsigned long name;
};
.fi
.in
.IP
.\"O followed by null-terminated strings.
.\"O The value of
.\"O .I name
.\"O is the character offset of the string relative to the start of
.\"O .IR buf ;
.\"O .I ret
.\"O is set to the number of symbols.
.I name
¤ÎÃͤϡ¢
.I buf
¤ÎÀèƬ¤«¤é¤Îʸ»úÎó¤Þ¤Ç¤Î¥ª¥Õ¥»¥Ã¥Èʸ»ú¿ô¤Ç¤¢¤ë¡£
.I ret
¤Ë¤Ï¥·¥ó¥Ü¥ë¤Î¿ô¤¬ÀßÄꤵ¤ì¤ë¡£
.TP
.B QM_INFO
.\"O Returns miscellaneous information about the indicated module.
.\"O The output buffer format is:
»ØÄꤵ¤ì¤¿¥â¥¸¥å¡¼¥ë¤Ë´Ø¤¹¤ëÍÍ¡¹¤Ê¾ðÊó¤òÊÖ¤¹¡£
½ÐÎϥХåե¡¤Î¥Õ¥©¡¼¥Þ¥Ã¥È¤Ï°Ê²¼¤Î·Á¼°¤È¤Ê¤ë:
.in +4n
.nf

struct module_info {
    unsigned long address;
    unsigned long size;
    unsigned long flags;
};
.fi
.in
.IP
.\"O where
.\"O .I address
.\"O is the kernel address at which the module resides,
.\"O .I size
.\"O is the size of the module in bytes, and
.\"O .I flags
.\"O is a mask of
.\"O .BR MOD_RUNNING ,
.\"O .BR MOD_AUTOCLEAN ,
.\"O etc. that indicates the current status of the module
.\"O (see the kernel source file
.\"O .IR include/linux/module.h ).
.\"O .I ret
.\"O is set to the size of the
.\"O .I module_info
.\"O structure.
.I address
¤Ï¤½¤Î¥â¥¸¥å¡¼¥ë¤¬ÇÛÃÖ¤µ¤ì¤Æ¤¤¤ë¥«¡¼¥Í¥ë¶õ´Ö¾å¤Î¥¢¥É¥ì¥¹¡¢
.I size
¤Ï¤½¤Î¥â¥¸¥å¡¼¥ë¤Î¥Ð¥¤¥Èñ°Ì¤Î¥µ¥¤¥º¡¢
.I flags
¤Ï
.BR MOD_RUNNING ,
.B MOD_AUTOCLEAN
Åù¤Î¥Þ¥¹¥¯¤Ç¤¢¤ê¡¢¤½¤Î¥â¥¸¥å¡¼¥ë¤Î¸½ºß¤Î¾õÂÖ¤ò¼¨¤¹
(¥«¡¼¥Í¥ë¤Î¥½¡¼¥¹¥Õ¥¡¥¤¥ë
.I include/linux/module.h
¤ò»²¾È)¡£
.I ret
¤Ë¤Ï
.I module_info
¹½Â¤ÂΤΥµ¥¤¥º¤¬ÀßÄꤵ¤ì¤ë¡£
.\"O .SH "RETURN VALUE"
.SH ÊÖ¤êÃÍ
.\"O On success, zero is returned.
.\"O On error, \-1 is returned and
.\"O .I errno
.\"O is set appropriately.
À®¸ù¤Î¾ì¹ç 0 ¤¬ÊÖ¤µ¤ì¤ë¡£¥¨¥é¡¼¤Î¾ì¹ç \-1 ¤¬ÊÖ¤µ¤ì¡¢
.I errno
¤ËŬÀÚ¤ÊÃͤ¬ÀßÄꤵ¤ì¤ë¡£
.\"O .SH ERRORS
.SH ¥¨¥é¡¼
.TP
.B EFAULT
.\"O At least one of
.\"O .IR name ,
.\"O .IR buf ,
.\"O or
.\"O .I ret
.\"O was outside the program's accessible address space.
.IR name ,
.IR buf ,
.I ret
¤Î¾¯¤Ê¤¯¤È¤â°ì¤Ä¤¬¡¢¥×¥í¥°¥é¥à¤¬¥¢¥¯¥»¥¹¤Ç¤­¤ë
¥¢¥É¥ì¥¹¶õ´Ö¤Î³°Éô¤Ç¤¢¤Ã¤¿¡£
.TP
.B EINVAL
.\"O Invalid
.\"O .IR which ;
.\"O or
.\"O .I name
.\"O is NULL (indicating "the kernel"),
.\"O but this is not permitted with the specified value of
.\"O .IR which .
.I which
¤¬ÉÔÀµ¤Ç¤¢¤ë¡£¤¢¤ë¤¤¤Ï
.I name
¤¬ NULL ¤À¤¬ (NULL ¤Ï "¥«¡¼¥Í¥ë" ¤ò¼¨¤¹)¡¢
.I which
¤Ç»ØÄꤵ¤ì¤¿ÃͤȤÎÁȤ߹ç¤ï¤»¤Ïµö²Ä¤µ¤ì¤Æ¤¤¤Ê¤¤¡£
.\" Not permitted with QM_DEPS, QM_REFS, or QM_INFO.
.TP
.B ENOENT
.\"O No module by that
.\"O .I name
.\"O exists.
.I name
¤È¤¤¤¦Ì¾Á°¤Î¥â¥¸¥å¡¼¥ë¤¬Â¸ºß¤·¤Ê¤¤¡£
.TP
.B ENOSPC
.\"O The buffer size provided was too small.
.\"O .I ret
.\"O is set to the minimum size needed.
Í¿¤¨¤é¤ì¤¿¥Ð¥Ã¥Õ¥¡¤ÎÂ礭¤µ¤¬¾®¤µ¤¹¤®¤ë¡£
.I ret
¤Ë¤ÏºÇ¾®¸ÂɬÍפʥХåե¡¤Î¥µ¥¤¥º¤¬ÀßÄꤵ¤ì¤ë¡£
.TP
.B ENOSYS
.\"O .BR query_module ()
.\"O is not supported in this version of the kernel.
.BR query_module ()
¤Ï¤³¤Î¥Ð¡¼¥¸¥ç¥ó¤Î¥«¡¼¥Í¥ë¤Ç¤Ï¥µ¥Ý¡¼¥È¤µ¤ì¤Æ¤¤¤Ê¤¤¡£
.\"O .SH "CONFORMING TO"
.SH ½àµò
.\"O .BR query_module ()
.\"O is Linux-specific.
.BR query_module ()
¤Ï Linux ¸ÇÍ­¤Ç¤¢¤ë¡£
.\"O .SH NOTES
.SH Ãí°Õ
.\"O This system call is only present on Linux up until kernel 2.4;
.\"O it was removed in Linux 2.6.
.\"O .\" Removed in Linux-2.5.48
.\"O Some of the information that was available via
.\"O .BR query_module ()
.\"O can be obtained from
.\"O .IR /proc/modules ,
.\"O .IR /proc/kallsyms ,
.\"O and
.\"O .IR /sys/modules .
¤³¤Î¥·¥¹¥Æ¥à¥³¡¼¥ë¤¬Â¸ºß¤¹¤ë¤Î¤Ï¥«¡¼¥Í¥ë 2.4 ¤Þ¤Ç¤Î Linux ¤À¤±¤Ç¤¢¤ë¡£
Linux 2.6 ¤Ç¤Ïºï½ü¤µ¤ì¤¿¡£
.\" Removed in Linux 2.5.48
.BR query_module ()
¤ÇÆÀ¤é¤ì¤¿¾ðÊó¤Î¤¤¤¯¤Ä¤«¤Ï¡¢
.IR /proc/modules ,
.IR /proc/kallsyms ,
.I /sys/modules
¤«¤é¼èÆÀ¤Ç¤­¤ë¡£
.\"O .SH "SEE ALSO"
.SH ´ØÏ¢¹àÌÜ
.BR create_module (2),
.BR delete_module (2),
.BR get_kernel_syms (2),
.BR init_module (2)