From: Manfred Spraul <manfred.spraul@xxxxxxxxxxxx> The magic number documentation refers to old values for NBD_REQUEST_MAGIC and NBD_REPLY_MAGIC: The documented values were used until Linux 2.1.116pre2. Thus: - Update the documentation. - Update the header file: The authorative source for the nbd protocol is proto.md from the nbd package, thus mention this. - Remove the historic values from the header file. The historic values are still documented in proto.md from the nbd package. Removing the historic values is intentional: The values are stale for > 20 years, and this was not noticed. My guess is that everyone used grep to confirm that the values are still in use - and the historic values resulted that there were still hits with grep, ... Signed-off-by: Manfred Spraul <manfred.spraul@xxxxxxxxxxxx> Link: https://github.com/NetworkBlockDevice/nbd/commit/107356ee528eb30744d518a8ac1cb6d379da4868 Link: https://lore.kernel.org/all/20220318200446.14648-1-manfred@xxxxxxxxxxxxxxxx/ Link: https://lists.debian.org/nbd/2022/01/msg00039.html --- V2: - more links added, especially a link to the commit for proto.md - typo corrected in the commit summary @Jonathan: I've created one patch that updates the English text and the 3 translations that contain magic-number.rst. Is this the right approach? I could also split the patch into 4 changes. Documentation/process/magic-number.rst | 4 ++-- Documentation/translations/it_IT/process/magic-number.rst | 4 ++-- Documentation/translations/zh_CN/process/magic-number.rst | 4 ++-- Documentation/translations/zh_TW/process/magic-number.rst | 4 ++-- include/uapi/linux/nbd.h | 3 ++- 5 files changed, 10 insertions(+), 9 deletions(-) diff --git a/Documentation/process/magic-number.rst b/Documentation/process/magic-number.rst index f5ba36e96461..133ecfa10607 100644 --- a/Documentation/process/magic-number.rst +++ b/Documentation/process/magic-number.rst @@ -96,11 +96,11 @@ USB_SERIAL_PORT_MAGIC 0x7301 usb_serial_port ``drivers/usb/se CG_MAGIC 0x00090255 ufs_cylinder_group ``include/linux/ufs_fs.h`` LSEMAGIC 0x05091998 lse ``drivers/fc4/fc.c`` RIEBL_MAGIC 0x09051990 ``drivers/net/atarilance.c`` -NBD_REQUEST_MAGIC 0x12560953 nbd_request ``include/linux/nbd.h`` RED_MAGIC2 0x170fc2a5 (any) ``mm/slab.c`` BAYCOM_MAGIC 0x19730510 baycom_state ``drivers/net/baycom_epp.c`` ISDN_X25IFACE_MAGIC 0x1e75a2b9 isdn_x25iface_proto_data ``drivers/isdn/isdn_x25iface.h`` ECP_MAGIC 0x21504345 cdkecpsig ``include/linux/cdk.h`` +NBD_REQUEST_MAGIC 0x25609513 nbd_request ``include/uapi/linux/nbd.h`` LSOMAGIC 0x27091997 lso ``drivers/fc4/fc.c`` LSMAGIC 0x2a3b4d2a ls ``drivers/fc4/fc.c`` WANPIPE_MAGIC 0x414C4453 sdla_{dump,exec} ``include/linux/wanpipe.h`` @@ -129,12 +129,12 @@ M3_CARD_MAGIC 0x646e6f50 m3_card ``sound/oss/maes FW_HEADER_MAGIC 0x65726F66 fw_header ``drivers/atm/fore200e.h`` SLOT_MAGIC 0x67267321 slot ``drivers/hotplug/cpqphp.h`` SLOT_MAGIC 0x67267322 slot ``drivers/hotplug/acpiphp.h`` +NBD_REPLY_MAGIC 0x67446698 nbd_reply ``include/uapi/linux/nbd.h`` LO_MAGIC 0x68797548 nbd_device ``include/linux/nbd.h`` M3_STATE_MAGIC 0x734d724d m3_state ``sound/oss/maestro3.c`` VMALLOC_MAGIC 0x87654320 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`` -NBD_REPLY_MAGIC 0x96744668 nbd_reply ``include/linux/nbd.h`` ENI155_MAGIC 0xa54b872d midway_eprom ``drivers/atm/eni.h`` CODA_MAGIC 0xC0DAC0DA coda_file_info ``fs/coda/coda_fs_i.h`` YAM_MAGIC 0xF10A7654 yam_port ``drivers/net/hamradio/yam.c`` diff --git a/Documentation/translations/it_IT/process/magic-number.rst b/Documentation/translations/it_IT/process/magic-number.rst index f452fafb1e84..17401994f2e8 100644 --- a/Documentation/translations/it_IT/process/magic-number.rst +++ b/Documentation/translations/it_IT/process/magic-number.rst @@ -102,11 +102,11 @@ USB_SERIAL_PORT_MAGIC 0x7301 usb_serial_port ``drivers/usb/se CG_MAGIC 0x00090255 ufs_cylinder_group ``include/linux/ufs_fs.h`` LSEMAGIC 0x05091998 lse ``drivers/fc4/fc.c`` RIEBL_MAGIC 0x09051990 ``drivers/net/atarilance.c`` -NBD_REQUEST_MAGIC 0x12560953 nbd_request ``include/linux/nbd.h`` RED_MAGIC2 0x170fc2a5 (any) ``mm/slab.c`` BAYCOM_MAGIC 0x19730510 baycom_state ``drivers/net/baycom_epp.c`` ISDN_X25IFACE_MAGIC 0x1e75a2b9 isdn_x25iface_proto_data ``drivers/isdn/isdn_x25iface.h`` ECP_MAGIC 0x21504345 cdkecpsig ``include/linux/cdk.h`` +NBD_REQUEST_MAGIC 0x25609513 nbd_request ``include/uapi/linux/nbd.h`` LSOMAGIC 0x27091997 lso ``drivers/fc4/fc.c`` LSMAGIC 0x2a3b4d2a ls ``drivers/fc4/fc.c`` WANPIPE_MAGIC 0x414C4453 sdla_{dump,exec} ``include/linux/wanpipe.h`` @@ -135,12 +135,12 @@ M3_CARD_MAGIC 0x646e6f50 m3_card ``sound/oss/maes FW_HEADER_MAGIC 0x65726F66 fw_header ``drivers/atm/fore200e.h`` SLOT_MAGIC 0x67267321 slot ``drivers/hotplug/cpqphp.h`` SLOT_MAGIC 0x67267322 slot ``drivers/hotplug/acpiphp.h`` +NBD_REPLY_MAGIC 0x67446698 nbd_reply ``include/uapi/linux/nbd.h`` LO_MAGIC 0x68797548 nbd_device ``include/linux/nbd.h`` M3_STATE_MAGIC 0x734d724d m3_state ``sound/oss/maestro3.c`` VMALLOC_MAGIC 0x87654320 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`` -NBD_REPLY_MAGIC 0x96744668 nbd_reply ``include/linux/nbd.h`` ENI155_MAGIC 0xa54b872d midway_eprom ``drivers/atm/eni.h`` CODA_MAGIC 0xC0DAC0DA coda_file_info ``fs/coda/coda_fs_i.h`` YAM_MAGIC 0xF10A7654 yam_port ``drivers/net/hamradio/yam.c`` diff --git a/Documentation/translations/zh_CN/process/magic-number.rst b/Documentation/translations/zh_CN/process/magic-number.rst index 42f0635ca70a..1b376fe087b5 100644 --- a/Documentation/translations/zh_CN/process/magic-number.rst +++ b/Documentation/translations/zh_CN/process/magic-number.rst @@ -86,11 +86,11 @@ CG_MAGIC 0x00090255 ufs_cylinder_group ``include/linux/ LSEMAGIC 0x05091998 lse ``drivers/fc4/fc.c`` GDTIOCTL_MAGIC 0x06030f07 gdth_iowr_str ``drivers/scsi/gdth_ioctl.h`` RIEBL_MAGIC 0x09051990 ``drivers/net/atarilance.c`` -NBD_REQUEST_MAGIC 0x12560953 nbd_request ``include/linux/nbd.h`` RED_MAGIC2 0x170fc2a5 (any) ``mm/slab.c`` BAYCOM_MAGIC 0x19730510 baycom_state ``drivers/net/baycom_epp.c`` ISDN_X25IFACE_MAGIC 0x1e75a2b9 isdn_x25iface_proto_data ``drivers/isdn/isdn_x25iface.h`` ECP_MAGIC 0x21504345 cdkecpsig ``include/linux/cdk.h`` +NBD_REQUEST_MAGIC 0x25609513 nbd_request ``include/uapi/linux/nbd.h`` LSOMAGIC 0x27091997 lso ``drivers/fc4/fc.c`` LSMAGIC 0x2a3b4d2a ls ``drivers/fc4/fc.c`` WANPIPE_MAGIC 0x414C4453 sdla_{dump,exec} ``include/linux/wanpipe.h`` @@ -119,12 +119,12 @@ M3_CARD_MAGIC 0x646e6f50 m3_card ``sound/oss/maes FW_HEADER_MAGIC 0x65726F66 fw_header ``drivers/atm/fore200e.h`` SLOT_MAGIC 0x67267321 slot ``drivers/hotplug/cpqphp.h`` SLOT_MAGIC 0x67267322 slot ``drivers/hotplug/acpiphp.h`` +NBD_REPLY_MAGIC 0x67446698 nbd_reply ``include/uapi/linux/nbd.h`` LO_MAGIC 0x68797548 nbd_device ``include/linux/nbd.h`` M3_STATE_MAGIC 0x734d724d m3_state ``sound/oss/maestro3.c`` VMALLOC_MAGIC 0x87654320 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`` -NBD_REPLY_MAGIC 0x96744668 nbd_reply ``include/linux/nbd.h`` ENI155_MAGIC 0xa54b872d midway_eprom ``drivers/atm/eni.h`` CODA_MAGIC 0xC0DAC0DA coda_file_info ``fs/coda/coda_fs_i.h`` DPMEM_MAGIC 0xc0ffee11 gdt_pci_sram ``drivers/scsi/gdth.h`` diff --git a/Documentation/translations/zh_TW/process/magic-number.rst b/Documentation/translations/zh_TW/process/magic-number.rst index ae321a9aaece..ff385a369c7b 100644 --- a/Documentation/translations/zh_TW/process/magic-number.rst +++ b/Documentation/translations/zh_TW/process/magic-number.rst @@ -89,11 +89,11 @@ CG_MAGIC 0x00090255 ufs_cylinder_group ``include/linux/ LSEMAGIC 0x05091998 lse ``drivers/fc4/fc.c`` GDTIOCTL_MAGIC 0x06030f07 gdth_iowr_str ``drivers/scsi/gdth_ioctl.h`` RIEBL_MAGIC 0x09051990 ``drivers/net/atarilance.c`` -NBD_REQUEST_MAGIC 0x12560953 nbd_request ``include/linux/nbd.h`` RED_MAGIC2 0x170fc2a5 (any) ``mm/slab.c`` BAYCOM_MAGIC 0x19730510 baycom_state ``drivers/net/baycom_epp.c`` ISDN_X25IFACE_MAGIC 0x1e75a2b9 isdn_x25iface_proto_data ``drivers/isdn/isdn_x25iface.h`` ECP_MAGIC 0x21504345 cdkecpsig ``include/linux/cdk.h`` +NBD_REQUEST_MAGIC 0x25609513 nbd_request ``include/uapi/linux/nbd.h`` LSOMAGIC 0x27091997 lso ``drivers/fc4/fc.c`` LSMAGIC 0x2a3b4d2a ls ``drivers/fc4/fc.c`` WANPIPE_MAGIC 0x414C4453 sdla_{dump,exec} ``include/linux/wanpipe.h`` @@ -122,12 +122,12 @@ M3_CARD_MAGIC 0x646e6f50 m3_card ``sound/oss/maes FW_HEADER_MAGIC 0x65726F66 fw_header ``drivers/atm/fore200e.h`` SLOT_MAGIC 0x67267321 slot ``drivers/hotplug/cpqphp.h`` SLOT_MAGIC 0x67267322 slot ``drivers/hotplug/acpiphp.h`` +NBD_REPLY_MAGIC 0x67446698 nbd_reply ``include/uapi/linux/nbd.h`` LO_MAGIC 0x68797548 nbd_device ``include/linux/nbd.h`` M3_STATE_MAGIC 0x734d724d m3_state ``sound/oss/maestro3.c`` VMALLOC_MAGIC 0x87654320 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`` -NBD_REPLY_MAGIC 0x96744668 nbd_reply ``include/linux/nbd.h`` ENI155_MAGIC 0xa54b872d midway_eprom ``drivers/atm/eni.h`` CODA_MAGIC 0xC0DAC0DA coda_file_info ``fs/coda/coda_fs_i.h`` DPMEM_MAGIC 0xc0ffee11 gdt_pci_sram ``drivers/scsi/gdth.h`` diff --git a/include/uapi/linux/nbd.h b/include/uapi/linux/nbd.h index 20d6cc91435d..88752b20e6c8 100644 --- a/include/uapi/linux/nbd.h +++ b/include/uapi/linux/nbd.h @@ -11,6 +11,8 @@ * Cleanup PARANOIA usage & code. * 2004/02/19 Paul Clements * Removed PARANOIA, plus various cleanup and comments + * + * See doc/proto.md of the nbd package for more details on the protocol. */ #ifndef _UAPILINUX_NBD_H @@ -63,7 +65,6 @@ enum { #define NBD_REQUEST_MAGIC 0x25609513 #define NBD_REPLY_MAGIC 0x67446698 -/* Do *not* use magics: 0x12560953 0x96744668. */ /* * This is the packet used for communication between client and -- 2.37.1
