docs/zh_CN: format the magic-number doc as rst

to Make it readble in html etc doc making. And fix the wrong
translation for 'number' in form.

Signed-off-by: Alex Shi <alex.shi@linux.alibaba.com>
Cc: Harry Wei <harryxiyou@gmail.com>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Jia Wei Wei <harryxiyou@gmail.com>
Cc: Li Zefan <lizefan@huawei.com>
Cc: Shawn Guo <shawn.guo@linaro.org>
Cc: Fengguang Wu <fengguang.wu@intel.com>
Cc: Coly Li <colyli@suse.de>
Signed-off-by: Weiwei Jia <harryxiyou@gmail.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
This commit is contained in:
Alex Shi 2019-03-13 21:49:48 +08:00 committed by Jonathan Corbet
parent 95dcdb6e12
commit 4cc4e49a41
1 changed files with 104 additions and 106 deletions

View File

@ -1,33 +1,29 @@
Chinese translated version of Documentation/process/magic-number.rst .. _cn_magicnumbers:
If you have any comment or update to the content, please post to LKML directly. .. include:: ../disclaimer-zh_CN.rst
However, if you have problem communicating in English you can also ask the
Chinese maintainer for help. Contact the Chinese maintainer, if this
translation is outdated or there is problem with translation.
Chinese maintainer: Jia Wei Wei <harryxiyou@gmail.com> :Original: :ref:`Documentation/process/magic-number.rst <magicnumbers>`
---------------------------------------------------------------------
Documentation/process/magic-number.rst的中文翻译
如果想评论或更新本文的内容请直接发信到LKML。如果你使用英文交流有困难的话也可 如果想评论或更新本文的内容请直接发信到LKML。如果你使用英文交流有困难的话也可
以向中文版维护者求助。如果本翻译更新不及时或者翻译存在问题,请联系中文版维护者 以向中文版维护者求助。如果本翻译更新不及时或者翻译存在问题,请联系中文版维护者::
中文版维护者: 贾威威 Jia Wei Wei <harryxiyou@gmail.com> 中文版维护者: 贾威威 Jia Wei Wei <harryxiyou@gmail.com>
中文版翻译者: 贾威威 Jia Wei Wei <harryxiyou@gmail.com> 中文版翻译者: 贾威威 Jia Wei Wei <harryxiyou@gmail.com>
中文版校译者: 贾威威 Jia Wei Wei <harryxiyou@gmail.com> 中文版校译者: 贾威威 Jia Wei Wei <harryxiyou@gmail.com>
Linux 魔术数
============
以下为正文
---------------------------------------------------------------------
这个文件是有关当前使用的魔术值注册表。当你给一个结构添加了一个魔术值,你也应该把这个魔术值添加到这个文件,因为我们最好把用于各种结构的魔术值统一起来。 这个文件是有关当前使用的魔术值注册表。当你给一个结构添加了一个魔术值,你也应该把这个魔术值添加到这个文件,因为我们最好把用于各种结构的魔术值统一起来。
使用魔术值来保护内核数据结构是一个非常好的主意。这就允许你在运行期检查(a)一个结构是否已经被攻击,或者(b)你已经给一个例行程序通过了一个错误的结构。后一种情况特别地有用---特别是当你通过一个空指针指向结构体的时候。tty源码例如经常通过特定驱动使用这种方法并且反复地排列特定方面的结构。 使用魔术值来保护内核数据结构是一个非常好的主意。这就允许你在运行期检查(a)一个结构是否已经被攻击,或者(b)你已经给一个例行程序通过了一个错误的结构。后一种情况特别地有用---特别是当你通过一个空指针指向结构体的时候。tty源码例如经常通过特定驱动使用这种方法并且反复地排列特定方面的结构。
使用魔术值的方法是在结构的开始处声明的,如下 使用魔术值的方法是在结构的开始处声明的,如下::
struct tty_ldisc { struct tty_ldisc {
int magic; int magic;
... ...
}; };
当你以后给内核添加增强功能的时候,请遵守这条规则!这样就会节省数不清的调试时间,特别是一些古怪的情况,例如,数组超出范围并且重新写了超出部分。遵守这个规则,‪这些情况可以被快速地,安全地避免。 当你以后给内核添加增强功能的时候,请遵守这条规则!这样就会节省数不清的调试时间,特别是一些古怪的情况,例如,数组超出范围并且重新写了超出部分。遵守这个规则,‪这些情况可以被快速地,安全地避免。
@ -58,93 +54,95 @@ struct tty_ldisc {
<ffrederick@users.sourceforge.net> <ffrederick@users.sourceforge.net>
09 Jul 2003 09 Jul 2003
魔术名 地址 结构 所在文件 ===================== ================ ======================== ==========================================
=========================================================================== 魔术数名 数字 结构 文件
PG_MAGIC 'P' pg_{read,write}_hdr include/linux/pg.h ===================== ================ ======================== ==========================================
CMAGIC 0x0111 user include/linux/a.out.h PG_MAGIC 'P' pg_{read,write}_hdr ``include/linux/pg.h``
MKISS_DRIVER_MAGIC 0x04bf mkiss_channel drivers/net/mkiss.h CMAGIC 0x0111 user ``include/linux/a.out.h``
HDLC_MAGIC 0x239e n_hdlc drivers/char/n_hdlc.c MKISS_DRIVER_MAGIC 0x04bf mkiss_channel ``drivers/net/mkiss.h``
APM_BIOS_MAGIC 0x4101 apm_user arch/x86/kernel/apm_32.c HDLC_MAGIC 0x239e n_hdlc ``drivers/char/n_hdlc.c``
CYCLADES_MAGIC 0x4359 cyclades_port include/linux/cyclades.h APM_BIOS_MAGIC 0x4101 apm_user ``arch/x86/kernel/apm_32.c``
DB_MAGIC 0x4442 fc_info drivers/net/iph5526_novram.c CYCLADES_MAGIC 0x4359 cyclades_port ``include/linux/cyclades.h``
DL_MAGIC 0x444d fc_info drivers/net/iph5526_novram.c DB_MAGIC 0x4442 fc_info ``drivers/net/iph5526_novram.c``
FASYNC_MAGIC 0x4601 fasync_struct include/linux/fs.h DL_MAGIC 0x444d fc_info ``drivers/net/iph5526_novram.c``
FF_MAGIC 0x4646 fc_info drivers/net/iph5526_novram.c FASYNC_MAGIC 0x4601 fasync_struct ``include/linux/fs.h``
ISICOM_MAGIC 0x4d54 isi_port include/linux/isicom.h FF_MAGIC 0x4646 fc_info ``drivers/net/iph5526_novram.c``
PTY_MAGIC 0x5001 drivers/char/pty.c ISICOM_MAGIC 0x4d54 isi_port ``include/linux/isicom.h``
PPP_MAGIC 0x5002 ppp include/linux/if_pppvar.h PTY_MAGIC 0x5001 ``drivers/char/pty.c``
SERIAL_MAGIC 0x5301 async_struct include/linux/serial.h PPP_MAGIC 0x5002 ppp ``include/linux/if_pppvar.h``
SSTATE_MAGIC 0x5302 serial_state include/linux/serial.h SERIAL_MAGIC 0x5301 async_struct ``include/linux/serial.h``
SLIP_MAGIC 0x5302 slip drivers/net/slip.h SSTATE_MAGIC 0x5302 serial_state ``include/linux/serial.h``
STRIP_MAGIC 0x5303 strip drivers/net/strip.c SLIP_MAGIC 0x5302 slip ``drivers/net/slip.h``
X25_ASY_MAGIC 0x5303 x25_asy drivers/net/x25_asy.h STRIP_MAGIC 0x5303 strip ``drivers/net/strip.c``
SIXPACK_MAGIC 0x5304 sixpack drivers/net/hamradio/6pack.h X25_ASY_MAGIC 0x5303 x25_asy ``drivers/net/x25_asy.h``
AX25_MAGIC 0x5316 ax_disp drivers/net/mkiss.h SIXPACK_MAGIC 0x5304 sixpack ``drivers/net/hamradio/6pack.h``
TTY_MAGIC 0x5401 tty_struct include/linux/tty.h AX25_MAGIC 0x5316 ax_disp ``drivers/net/mkiss.h``
MGSL_MAGIC 0x5401 mgsl_info drivers/char/synclink.c TTY_MAGIC 0x5401 tty_struct ``include/linux/tty.h``
TTY_DRIVER_MAGIC 0x5402 tty_driver include/linux/tty_driver.h MGSL_MAGIC 0x5401 mgsl_info ``drivers/char/synclink.c``
MGSLPC_MAGIC 0x5402 mgslpc_info drivers/char/pcmcia/synclink_cs.c TTY_DRIVER_MAGIC 0x5402 tty_driver ``include/linux/tty_driver.h``
TTY_LDISC_MAGIC 0x5403 tty_ldisc include/linux/tty_ldisc.h MGSLPC_MAGIC 0x5402 mgslpc_info ``drivers/char/pcmcia/synclink_cs.c``
USB_SERIAL_MAGIC 0x6702 usb_serial drivers/usb/serial/usb-serial.h TTY_LDISC_MAGIC 0x5403 tty_ldisc ``include/linux/tty_ldisc.h``
FULL_DUPLEX_MAGIC 0x6969 drivers/net/ethernet/dec/tulip/de2104x.c USB_SERIAL_MAGIC 0x6702 usb_serial ``drivers/usb/serial/usb-serial.h``
USB_BLUETOOTH_MAGIC 0x6d02 usb_bluetooth drivers/usb/class/bluetty.c FULL_DUPLEX_MAGIC 0x6969 ``drivers/net/ethernet/dec/tulip/de2104x.c``
RFCOMM_TTY_MAGIC 0x6d02 net/bluetooth/rfcomm/tty.c USB_BLUETOOTH_MAGIC 0x6d02 usb_bluetooth ``drivers/usb/class/bluetty.c``
USB_SERIAL_PORT_MAGIC 0x7301 usb_serial_port drivers/usb/serial/usb-serial.h RFCOMM_TTY_MAGIC 0x6d02 ``net/bluetooth/rfcomm/tty.c``
CG_MAGIC 0x00090255 ufs_cylinder_group include/linux/ufs_fs.h USB_SERIAL_PORT_MAGIC 0x7301 usb_serial_port ``drivers/usb/serial/usb-serial.h``
RPORT_MAGIC 0x00525001 r_port drivers/char/rocket_int.h CG_MAGIC 0x00090255 ufs_cylinder_group ``include/linux/ufs_fs.h``
LSEMAGIC 0x05091998 lse drivers/fc4/fc.c RPORT_MAGIC 0x00525001 r_port ``drivers/char/rocket_int.h``
GDTIOCTL_MAGIC 0x06030f07 gdth_iowr_str drivers/scsi/gdth_ioctl.h LSEMAGIC 0x05091998 lse ``drivers/fc4/fc.c``
RIEBL_MAGIC 0x09051990 drivers/net/atarilance.c GDTIOCTL_MAGIC 0x06030f07 gdth_iowr_str ``drivers/scsi/gdth_ioctl.h``
NBD_REQUEST_MAGIC 0x12560953 nbd_request include/linux/nbd.h RIEBL_MAGIC 0x09051990 ``drivers/net/atarilance.c``
RED_MAGIC2 0x170fc2a5 (any) mm/slab.c NBD_REQUEST_MAGIC 0x12560953 nbd_request ``include/linux/nbd.h``
BAYCOM_MAGIC 0x19730510 baycom_state drivers/net/baycom_epp.c RED_MAGIC2 0x170fc2a5 (any) ``mm/slab.c``
ISDN_X25IFACE_MAGIC 0x1e75a2b9 isdn_x25iface_proto_data BAYCOM_MAGIC 0x19730510 baycom_state ``drivers/net/baycom_epp.c``
drivers/isdn/isdn_x25iface.h ISDN_X25IFACE_MAGIC 0x1e75a2b9 isdn_x25iface_proto_data ``drivers/isdn/isdn_x25iface.h``
ECP_MAGIC 0x21504345 cdkecpsig include/linux/cdk.h ECP_MAGIC 0x21504345 cdkecpsig ``include/linux/cdk.h``
LSOMAGIC 0x27091997 lso drivers/fc4/fc.c LSOMAGIC 0x27091997 lso ``drivers/fc4/fc.c``
LSMAGIC 0x2a3b4d2a ls drivers/fc4/fc.c LSMAGIC 0x2a3b4d2a ls ``drivers/fc4/fc.c``
WANPIPE_MAGIC 0x414C4453 sdla_{dump,exec} include/linux/wanpipe.h WANPIPE_MAGIC 0x414C4453 sdla_{dump,exec} ``include/linux/wanpipe.h``
CS_CARD_MAGIC 0x43525553 cs_card sound/oss/cs46xx.c CS_CARD_MAGIC 0x43525553 cs_card ``sound/oss/cs46xx.c``
LABELCL_MAGIC 0x4857434c labelcl_info_s include/asm/ia64/sn/labelcl.h LABELCL_MAGIC 0x4857434c labelcl_info_s ``include/asm/ia64/sn/labelcl.h``
ISDN_ASYNC_MAGIC 0x49344C01 modem_info include/linux/isdn.h ISDN_ASYNC_MAGIC 0x49344C01 modem_info ``include/linux/isdn.h``
CTC_ASYNC_MAGIC 0x49344C01 ctc_tty_info drivers/s390/net/ctctty.c CTC_ASYNC_MAGIC 0x49344C01 ctc_tty_info ``drivers/s390/net/ctctty.c``
ISDN_NET_MAGIC 0x49344C02 isdn_net_local_s drivers/isdn/i4l/isdn_net_lib.h ISDN_NET_MAGIC 0x49344C02 isdn_net_local_s ``drivers/isdn/i4l/isdn_net_lib.h``
SAVEKMSG_MAGIC2 0x4B4D5347 savekmsg arch/*/amiga/config.c SAVEKMSG_MAGIC2 0x4B4D5347 savekmsg ``arch/*/amiga/config.c``
CS_STATE_MAGIC 0x4c4f4749 cs_state sound/oss/cs46xx.c CS_STATE_MAGIC 0x4c4f4749 cs_state ``sound/oss/cs46xx.c``
SLAB_C_MAGIC 0x4f17a36d kmem_cache mm/slab.c SLAB_C_MAGIC 0x4f17a36d kmem_cache ``mm/slab.c``
COW_MAGIC 0x4f4f4f4d cow_header_v1 arch/um/drivers/ubd_user.c COW_MAGIC 0x4f4f4f4d cow_header_v1 ``arch/um/drivers/ubd_user.c``
I810_CARD_MAGIC 0x5072696E i810_card sound/oss/i810_audio.c I810_CARD_MAGIC 0x5072696E i810_card ``sound/oss/i810_audio.c``
TRIDENT_CARD_MAGIC 0x5072696E trident_card sound/oss/trident.c TRIDENT_CARD_MAGIC 0x5072696E trident_card ``sound/oss/trident.c``
ROUTER_MAGIC 0x524d4157 wan_device [in wanrouter.h pre 3.9] ROUTER_MAGIC 0x524d4157 wan_device [in ``wanrouter.h`` pre 3.9]
SAVEKMSG_MAGIC1 0x53415645 savekmsg arch/*/amiga/config.c SAVEKMSG_MAGIC1 0x53415645 savekmsg ``arch/*/amiga/config.c``
GDA_MAGIC 0x58464552 gda arch/mips/include/asm/sn/gda.h GDA_MAGIC 0x58464552 gda ``arch/mips/include/asm/sn/gda.h``
RED_MAGIC1 0x5a2cf071 (any) mm/slab.c RED_MAGIC1 0x5a2cf071 (any) ``mm/slab.c``
EEPROM_MAGIC_VALUE 0x5ab478d2 lanai_dev drivers/atm/lanai.c EEPROM_MAGIC_VALUE 0x5ab478d2 lanai_dev ``drivers/atm/lanai.c``
HDLCDRV_MAGIC 0x5ac6e778 hdlcdrv_state include/linux/hdlcdrv.h HDLCDRV_MAGIC 0x5ac6e778 hdlcdrv_state ``include/linux/hdlcdrv.h``
PCXX_MAGIC 0x5c6df104 channel drivers/char/pcxx.h PCXX_MAGIC 0x5c6df104 channel ``drivers/char/pcxx.h``
KV_MAGIC 0x5f4b565f kernel_vars_s arch/mips/include/asm/sn/klkernvars.h KV_MAGIC 0x5f4b565f kernel_vars_s ``arch/mips/include/asm/sn/klkernvars.h``
I810_STATE_MAGIC 0x63657373 i810_state sound/oss/i810_audio.c I810_STATE_MAGIC 0x63657373 i810_state ``sound/oss/i810_audio.c``
TRIDENT_STATE_MAGIC 0x63657373 trient_state sound/oss/trident.c TRIDENT_STATE_MAGIC 0x63657373 trient_state ``sound/oss/trident.c``
M3_CARD_MAGIC 0x646e6f50 m3_card sound/oss/maestro3.c M3_CARD_MAGIC 0x646e6f50 m3_card ``sound/oss/maestro3.c``
FW_HEADER_MAGIC 0x65726F66 fw_header drivers/atm/fore200e.h FW_HEADER_MAGIC 0x65726F66 fw_header ``drivers/atm/fore200e.h``
SLOT_MAGIC 0x67267321 slot drivers/hotplug/cpqphp.h SLOT_MAGIC 0x67267321 slot ``drivers/hotplug/cpqphp.h``
SLOT_MAGIC 0x67267322 slot drivers/hotplug/acpiphp.h SLOT_MAGIC 0x67267322 slot ``drivers/hotplug/acpiphp.h``
LO_MAGIC 0x68797548 nbd_device include/linux/nbd.h LO_MAGIC 0x68797548 nbd_device ``include/linux/nbd.h``
OPROFILE_MAGIC 0x6f70726f super_block drivers/oprofile/oprofilefs.h OPROFILE_MAGIC 0x6f70726f super_block ``drivers/oprofile/oprofilefs.h``
M3_STATE_MAGIC 0x734d724d m3_state sound/oss/maestro3.c M3_STATE_MAGIC 0x734d724d m3_state ``sound/oss/maestro3.c``
VMALLOC_MAGIC 0x87654320 snd_alloc_track sound/core/memory.c VMALLOC_MAGIC 0x87654320 snd_alloc_track ``sound/core/memory.c``
KMALLOC_MAGIC 0x87654321 snd_alloc_track sound/core/memory.c KMALLOC_MAGIC 0x87654321 snd_alloc_track ``sound/core/memory.c``
PWC_MAGIC 0x89DC10AB pwc_device drivers/usb/media/pwc.h PWC_MAGIC 0x89DC10AB pwc_device ``drivers/usb/media/pwc.h``
NBD_REPLY_MAGIC 0x96744668 nbd_reply include/linux/nbd.h NBD_REPLY_MAGIC 0x96744668 nbd_reply ``include/linux/nbd.h``
ENI155_MAGIC 0xa54b872d midway_eprom drivers/atm/eni.h ENI155_MAGIC 0xa54b872d midway_eprom ``drivers/atm/eni.h``
CODA_MAGIC 0xC0DAC0DA coda_file_info include/linux/coda_fs_i.h CODA_MAGIC 0xC0DAC0DA coda_file_info ``fs/coda/coda_fs_i.h``
DPMEM_MAGIC 0xc0ffee11 gdt_pci_sram drivers/scsi/gdth.h DPMEM_MAGIC 0xc0ffee11 gdt_pci_sram ``drivers/scsi/gdth.h``
YAM_MAGIC 0xF10A7654 yam_port drivers/net/hamradio/yam.c YAM_MAGIC 0xF10A7654 yam_port ``drivers/net/hamradio/yam.c``
CCB_MAGIC 0xf2691ad2 ccb drivers/scsi/ncr53c8xx.c CCB_MAGIC 0xf2691ad2 ccb ``drivers/scsi/ncr53c8xx.c``
QUEUE_MAGIC_FREE 0xf7e1c9a3 queue_entry drivers/scsi/arm/queue.c QUEUE_MAGIC_FREE 0xf7e1c9a3 queue_entry ``drivers/scsi/arm/queue.c``
QUEUE_MAGIC_USED 0xf7e1cc33 queue_entry drivers/scsi/arm/queue.c QUEUE_MAGIC_USED 0xf7e1cc33 queue_entry ``drivers/scsi/arm/queue.c``
HTB_CMAGIC 0xFEFAFEF1 htb_class net/sched/sch_htb.c HTB_CMAGIC 0xFEFAFEF1 htb_class ``net/sched/sch_htb.c``
NMI_MAGIC 0x48414d4d455201 nmi_s arch/mips/include/asm/sn/nmi.h NMI_MAGIC 0x48414d4d455201 nmi_s ``arch/mips/include/asm/sn/nmi.h``
===================== ================ ======================== ==========================================
请注意在声音记忆管理中仍然有一些特殊的为每个驱动定义的魔术值。查看include/sound/sndmagic.h来获取他们完整的列表信息。很多OSS声音驱动拥有自己从声卡PCI ID构建的魔术值-他们也没有被列在这里。 请注意在声音记忆管理中仍然有一些特殊的为每个驱动定义的魔术值。查看include/sound/sndmagic.h来获取他们完整的列表信息。很多OSS声音驱动拥有自己从声卡PCI ID构建的魔术值-他们也没有被列在这里。