Número mágico (programación)

Por ejemplo, si se requiere barajar aleatoriamente los valores de una matriz que representa una baraja estándar de cartas , este pseudocódigo realiza la tarea utilizando el algoritmo de barajado de Fisher-Yates :

para i de 1 a 52 j := i + randomInt(53 - i) - 1 a.swapEntries(i, j)

donde aes un objeto de matriz, la función randomInt(x)elige un entero aleatorio entre 1 y x , ambos inclusive, e swapEntries(i, j)intercambia las entradas i y j52 de la matriz. En el ejemplo anterior, y 53son números mágicos, que tampoco están claramente relacionados entre sí. Se considera un mejor estilo de programación escribir lo siguiente:

int tamañoMazo:= 52 para i desde 1 hasta tamañoMazo j := i + randomInt(deckSize + 1 - i) - 1 a.swapEntries(i, j)

Esto es preferible por varias razones:

• Mayor legibilidad . Un programador que lea el primer ejemplo podría preguntarse: ¿Qué significa el número 52 aquí? ¿Por qué 52? El programador podría inferir el significado después de leer el código con atención, pero no es obvio. ^{[ 5 ]} Los números mágicos se vuelven particularmente confusos cuando el mismo número se usa para diferentes propósitos en una sección de código.
• Más fácil de mantener . Es más fácil alterar el valor del número, ya que no está duplicado. Cambiar el valor de un número mágico es propenso a errores, porque el mismo valor se usa a menudo varias veces en diferentes lugares dentro de un programa. ^{[ 5 ]} Además, cuando dos variables o números semánticamente distintos tienen el mismo valor, pueden editarse accidentalmente juntos. ^{[ 5 ]} Para modificar el primer ejemplo para barajar una baraja de Tarot , que tiene 78 cartas, un programador podría ingenuamente reemplazar cada instancia de 52 en el programa por 78. Esto causaría dos problemas. Primero, se omitiría el valor 53 en la segunda línea del ejemplo, lo que haría que el algoritmo fallara de forma sutil. Segundo, probablemente reemplazaría los caracteres "52" en todas partes, independientemente de si se refieren al tamaño de la baraja o a algo completamente distinto, como el número de semanas en un año del calendario gregoriano, o más insidiosamente, son parte de un número como "1523", todo lo cual introduciría errores. Por el contrario, cambiar el valor de la deckSizevariable en el segundo ejemplo sería un cambio sencillo de una sola línea.
• Fomenta la documentación . ^{[ 5 ]} El único lugar donde se declara la variable con nombre es un buen lugar para documentar qué significa el valor y por qué tiene ese valor. Tener el mismo valor en multitud de lugares lleva a comentarios duplicados (y los problemas consiguientes al actualizar algunos pero omitir otros) o no deja ningún lugar donde sea natural para el autor explicar el valor y donde probablemente el lector busque una explicación.
• Agrupa la información . Las declaraciones de variables de "número mágico" se pueden colocar juntas, generalmente al principio de una función o archivo, lo que facilita su revisión y modificación. ^{[ 5 ]}
• Detecta errores tipográficos . Usar una variable (en lugar de un literal) aprovecha la comprobación del compilador. Escribir accidentalmente "62" en lugar de "52" no se detectaría, mientras que escribir " dekSize" en lugar de " deckSize" daría como resultado la advertencia del compilador de que dekSizeno está declarado.
• Reduce la cantidad de escritura . Si un IDE admite la función de autocompletado de código , completará la mayor parte del nombre de la variable a partir de las primeras letras.
• Facilita la parametrización . Por ejemplo, para generalizar el ejemplo anterior a un procedimiento que baraje una baraja de cualquier número de cartas, bastaría con convertirlo deckSizeen un parámetro de ese procedimiento, mientras que el primer ejemplo requeriría varios cambios.

función barajar ( int tamañoMazo) para i desde 1 hasta tamañoMazo j := i + randomInt(deckSize + 1 - i) - 1 a.swapEntries(i, j)

Las desventajas son:

• Rompe la localidad . Cuando una constante con nombre no se define cerca de su uso, perjudica la localidad y, por lo tanto, la comprensibilidad del código. Colocar el 52 en un lugar posiblemente distante significa que, para comprender completamente el funcionamiento del bucle "for" (por ejemplo, para estimar su tiempo de ejecución), hay que localizar la definición y verificar que sea el número esperado. Esto es fácil de evitar (reubicando la declaración) cuando la constante se usa solo en una parte del código. En cambio, cuando la constante con nombre se usa en partes dispares, la ubicación remota indica al lector que el mismo valor aparece en otros lugares del código, lo cual también puede ser relevante.
• Genera verbosidad . La declaración de la constante añade una línea. Cuando el nombre de la constante es más largo que su valor, sobre todo si aparecen varias constantes en una misma línea, puede ser necesario dividir una instrucción lógica del código en varias líneas. Un aumento en la verbosidad puede justificarse cuando existe la posibilidad de confusión respecto a la constante, o cuando existe la posibilidad de que sea necesario modificarla, como por ejemplo al reutilizar una rutina de barajado para otros juegos de cartas. También puede justificarse como una mejora en la expresividad.
• Consideraciones de rendimientodeckSize + 1 . El procesamiento de la expresión en tiempo de ejecución puede ser más lento que el del valor "53". Sin embargo, la mayoría de los compiladores modernos utilizan técnicas como la optimización de constantes y bucles para resolver la suma durante la compilación, por lo que la penalización en velocidad suele ser nula o insignificante en comparación con el uso de números mágicos en el código. En particular, el costo de la depuración y el tiempo necesario para comprender un código poco explicativo deben sopesarse frente al mínimo costo computacional.

Cuando un literal numérico carece de significado especial, su uso no se clasifica como mágico, aunque lo que constituye algo especial es subjetivo. Algunos ejemplos de literales que a menudo no se consideran mágicos son:

• Uso de 0 y 1 como valores iniciales o incrementales en un bucle for , como por ejemplo:for(inti=0;i<max;i+=1)

• Se utiliza el operador 2 para comprobar si un número es par o impar, como en , donde es el operador módulo.isEven = (x % 2 == 0)%

• Uso de literales simples, por ejemplo, en expresiones como circumference = 2 * Math.PI * radius, ^{[ 1 ]} o para calcular el discriminante de una ecuación cuadrática comod = b^2 − 4*a*c

• Uso de potencias de 10 para convertir valores métricos (por ejemplo, entre gramos y kilogramos) o para calcular porcentajes y valores por mil.

• Exponentes en expresiones como (f(x) ** 2 + f(y) ** 2) ** 0.5para${\displaystyle {\sqrt {f(x)^{2}+f(y)^{2}}}}$

• Los literales 1 y 0 se utilizan a veces para representar los valores booleanos verdadero y falso. Sin embargo, podría ser mejor asignarles nombres como VERDADERO y FALSO.

• En C y C++, 0 se usa a menudo para referirse a un puntero nulo, aunque la biblioteca estándar de C define una macro NULLy el C++ moderno incluye una palabra clave nullptr.

Los indicadores de formato se utilizaron por primera vez en las primeras versiones del código fuente de Unix (Versión 7) .

Unix se adaptó a uno de los primeros DEC PDP-11 /20, que no tenía protección de memoria . Por lo tanto, las primeras versiones de Unix usaban el modelo de referencia de memoria reubicable . ^{[ 6 ]} Las versiones de Unix anteriores a la Sexta Edición leían un archivo ejecutable en la memoria y saltaban a la primera dirección de memoria baja del programa, la dirección relativa cero. Con el desarrollo de las versiones paginadas de Unix, se creó una cabecera para describir los componentes de la imagen ejecutable . Además, se insertó una instrucción de salto como la primera palabra de la cabecera para omitirla e iniciar el programa. De esta manera, un programa podía ejecutarse en el modo de referencia de memoria reubicable (regular) anterior o en modo paginado. A medida que se desarrollaron más formatos ejecutables, se agregaron nuevas constantes incrementando el desplazamiento de salto . ^{[ 7 ]}

En el código fuente de la sexta edición del cargador de programas de Unix, la función exec() leía la imagen ejecutable ( binaria ) del sistema de archivos. Los primeros 8 bytes del archivo eran una cabecera que contenía los tamaños de las áreas de datos del programa (texto) e inicializadas (globales). Además, la primera palabra de 16 bits de la cabecera se comparaba con dos constantes para determinar si la imagen ejecutable contenía referencias de memoria reubicables (normal), la imagen ejecutable paginada de solo lectura recientemente implementada o la imagen paginada de instrucciones y datos separada. ^{[ 8 ]} No se mencionaba la doble función de la constante de la cabecera, pero el byte de orden superior de la constante era, de hecho, el código de operación para la instrucción de salto del PDP-11 ( octal 000407 o hexadecimal 0107). Si se sumaba siete al contador de programa, se indicaba que si se ejecutaba esta constante, se realizaría un salto en el servicio Unix exec() a través de la cabecera de ocho bytes de la imagen ejecutable y se iniciaría el programa.

Dado que la sexta y séptima edición de Unix empleaban código de paginación, la doble función de la constante de encabezado quedaba oculta. Es decir, el servicio exec() leía los datos de encabezado ( meta ) del archivo ejecutable en un búfer del espacio del kernel , pero leía la imagen ejecutable en el espacio de usuario , sin utilizar así la función de ramificación de la constante. La creación de números mágicos se implementó en el enlazador y el cargador de Unix , y la ramificación mediante números mágicos probablemente todavía se utilizaba en el conjunto de programas de diagnóstico independientes que venían con la sexta y séptima edición. Por lo tanto, la constante de encabezado sí proporcionaba una ilusión y cumplía los criterios para ser considerada mágica .

En la versión siete de Unix, la constante de encabezado no se probaba directamente, sino que se asignaba a una variable denominada ux_mag ^{[ 9 ]} y posteriormente se la conocía como el número mágico . Probablemente debido a su singularidad, el término número mágico pasó a significar tipo de formato ejecutable, luego se amplió para significar tipo de sistema de archivos, y se amplió nuevamente para significar cualquier tipo de archivo.

Los números mágicos son comunes en programas de diversos sistemas operativos. Implementan datos fuertemente tipados y sirven como señalización interna para el programa controlador, que lee el tipo de datos durante la ejecución. Muchos archivos contienen constantes que identifican los datos que incluyen. Detectar estas constantes en los archivos es una forma sencilla y eficaz de distinguir entre diferentes formatos y puede proporcionar información adicional durante la ejecución .

Ejemplos

• Los archivos de clase Java compilados ( bytecode ) y los binarios Mach-O comienzan con hexadecimal . Cuando se comprimen con Pack200, los bytes se cambian a .CA FE BA BECA FE D0 0D
• Los archivos de imagen GIF tienen el código ASCII para "GIF89a" ( ) o "GIF87a" ( ).47 49 46 38 39 6147 49 46 38 37 61
• Los archivos de imagen JPEG comienzan con y terminan con . Los archivos JPEG/ JFIF contienen la cadena terminada en nulo "JFIF" ( ). Los archivos JPEG/ Exif contienen la cadena terminada en nulo "Exif" ( ), seguida de más metadatos sobre el archivo.FF D8FF D94A 46 49 46 0045 78 69 66 00
• Los archivos de imagen PNG comienzan con una firma de 8 bytes que identifica el archivo como PNG y permite detectar problemas comunes de transferencia de archivos: "\211PNG\r\n\032\n" ( ). Esta firma contiene varios caracteres de salto de línea para permitir la detección de conversiones automáticas de salto de línea no justificadas, como la transferencia del archivo mediante FTP con el modo de transferencia ASCII en lugar del modo binario . ^{[ 10 ]}89 50 4E 47 0D 0A 1A 0A
• Los archivos de audio MIDI estándar tienen el código ASCII para "MThd" ( encabezado de pista MIDI ), seguido de más metadatos.4D 54 68 64
• Los scripts de Unix o Linux pueden comenzar con un shebang ("#!", ) seguido de la ruta a un intérprete , si es probable que el intérprete sea diferente de aquel desde el que se invocó el script.23 21
• Los ejecutables ELF comienzan con el byte 7Fseguido de "ELF" ( ).7F 45 4C 46
• Los archivos y programas PostScript comienzan con "%!" ( ).25 21
• Los archivos PDF comienzan con "%PDF" (hexadecimal ).25 50 44 46
• Los archivos ejecutables DOS MZ y el stub EXE de los archivos PE (Portable Executable) de Microsoft Windows comienzan con los caracteres "MZ" ( ), las iniciales del diseñador del formato de archivo, Mark Zbikowski . La definición también permite el poco común "ZM" ( ) para dosZMXP, un EXE que no es PE. ^{[ 11 ]}4D 5A5A 4D
• El formato de superbloque del sistema de archivos rápidos de Berkeley se identifica como o dependiendo de la versión; ambos representan el cumpleaños del autor, Marshall Kirk McKusick .19 54 01 1901 19 54
• El registro de arranque maestro de los dispositivos de almacenamiento de arranque en casi todos los PC compatibles con IBM IA-32 tiene un código como sus dos últimos bytes.55 AA
• Los archivos ejecutables para las consolas portátiles Game Boy y Game Boy Advance tienen un número mágico de 48 o 156 bytes, respectivamente, en una posición fija del encabezado. Este número mágico codifica un mapa de bits del logotipo de Nintendo .
• Los archivos ejecutables Hunk de software de Amiga que se ejecutaban en las máquinas Amiga Classic 68000 comenzaban todos con el número hexadecimal $000003f3, apodado "Magic Cookie".
• En el Amiga, la única dirección absoluta del sistema es hexadecimal $0000 0004 (ubicación de memoria 4), que contiene la ubicación de inicio llamada SysBase, un puntero a exec.library, el llamado núcleo del Amiga.
• Los archivos PEF , utilizados por los ejecutables clásicos de Mac OS y BeOS para PowerPC , contienen el código ASCII de "¡Alegría!" ( ) como prefijo.4A 6F 79 21
• Los archivos TIFF comienzan con "II" o "MM" seguido de 42 como un entero de dos bytes en orden de bytes little endian o big endian . "II" es para Intel, que usa el orden de bytes little endian , por lo que el número mágico es . "MM" es para Motorola, que usa el orden de bytes big endian , por lo que el número mágico es .49 49 2A 004D 4D 00 2A
• Los archivos de texto Unicode codificados en UTF-16 a menudo comienzan con la marca de orden de bytes para detectar el orden de bytes ( para big endian y para little endian). Y en Microsoft Windows , los archivos de texto UTF-8 a menudo comienzan con la codificación UTF-8 del mismo carácter, .FE FFFF FEEF BB BF
• Los archivos Bitcode de LLVM comienzan con "BC" ( ).42 43
• Los archivos WAD comienzan con "IWAD" o "PWAD" (para Doom ), "WAD2" (para Quake ) y "WAD3" (para Half-Life ).
• Los archivos en formato binario de archivo compuesto de Microsoft (conocido principalmente como uno de los formatos más antiguos de documentos de Microsoft Office ) comienzan con , lo que sugiere visualmente la palabra "DOCFILE0".D0 CF 11 E0
• Los encabezados en los archivos ZIP a menudo aparecen en los editores de texto como "PK♥♦" ( ), donde "PK" son las iniciales de Phil Katz , autor de la utilidad de compresión de DOS PKZIP .50 4B 03 04
• Los encabezados en los archivos 7z comienzan con "7z" (número mágico completo: ).37 7A BC AF 27 1C

Detección

El programa de utilidad de Unix filepuede leer e interpretar números mágicos de archivos, y el archivo que se utiliza para analizar la información se llama magic . La utilidad de Windows TrID tiene un propósito similar.

Ejemplos

• El protocolo OSCAR , utilizado en AIM / ICQ , antepone a las solicitudes el prefijo 2A.
• En el protocolo RFB utilizado por VNC , un cliente inicia su conversación con un servidor enviando "RFB" ( por "Remote Frame Buffer") seguido del número de versión del protocolo del cliente.52 46 42
• En el protocolo SMB utilizado por Microsoft Windows, cada solicitud SMB o respuesta del servidor comienza con , o al inicio de la solicitud SMB.FF 53 4D 42\xFFSMB
• En el protocolo MSRPC utilizado por Microsoft Windows, cada solicitud basada en TCP comienza con 05al inicio de la solicitud (que representa la versión 5 de Microsoft DCE/RPC), seguido inmediatamente de un 00o 01para la versión menor. En las solicitudes MSRPC basadas en UDP, el primer byte siempre es 04.
• En las interfaces serializadas COM y DCOM , llamadas OBJREFs , siempre comienzan con la secuencia de bytes "MEOW" ( ). Las extensiones de depuración (utilizadas para la interceptación de canales DCOM) se preceden con la secuencia de bytes "MARB" ( ).4D 45 4F 574D 41 52 42
• Las solicitudes de seguimiento de BitTorrent sin cifrar comienzan con un solo byte que contiene el valor 19que representa la longitud del encabezado, seguido inmediatamente por la frase "Protocolo BitTorrent" en la posición del byte 1.
• El tráfico de eDonkey2000 / eMule comienza con un solo byte que representa la versión del cliente. Actualmente E3representa un cliente eDonkey, C5representa eMule y D4representa eMule comprimido.
• Los primeros 4 bytes de un bloque en la cadena de bloques de Bitcoin contienen un número mágico que sirve como identificador de red. El valor es , que indica la red principal, mientras que indica la red de prueba.D9 B4 BE F9DA B5 BF FA
• Las transacciones SSL siempre comienzan con un mensaje "client hello". El esquema de encapsulación de registros utilizado para anteponer a todos los paquetes SSL consta de encabezados de dos y tres bytes. Normalmente, un mensaje client hello de SSL versión 2 tiene como prefijo un 80y una respuesta del servidor SSLv3 a un client hello comienza con 16(aunque esto puede variar).
• Los paquetes DHCP utilizan un valor de "cookie mágica" al inicio de la sección de opciones del paquete. Este valor se incluye en todos los tipos de paquetes DHCP.63 82 53 63
• Las conexiones HTTP/2 comienzan con la cadena de 24 caracteres . Está diseñada para evitar el procesamiento de tramas por parte de servidores e intermediarios que admiten versiones anteriores de HTTP pero no la 2.0.PRI * HTTP/2.0\r\n\r\nSM\r\n\r\n
• El protocolo de enlace de apertura de WebSocket utiliza una cadena que contiene el UUIDv4258EAFA5-E914-47DA-95CA-C5AB0DC85B11 .

Los números mágicos son comunes en las funciones e interfaces de API en muchos sistemas operativos , incluidos DOS , Windows y NetWare :

Ejemplos

• Las BIOS compatibles con IBM PC utilizan valores mágicos para decidir si el sistema debe contar la memoria o no al reiniciar, realizando así un arranque en frío o en caliente. Estos valores también son utilizados por los administradores de memoria EMM386 que interceptan las solicitudes de arranque. ^{[ 12 ]} Las BIOS también utilizan valores mágicos para determinar si un disco es arrancable. ^{[ 13 ]}00 0012 3455 AA
• La caché de disco de MS-DOS SMARTDRV (nombre en clave "Bambi") utiliza valores mágicos y en funciones API. ^{[ 12 ]}BA BEEB AB
• Muchos controladores de DR-DOS , Novell DOS y OpenDOS desarrollados en el antiguo Centro Europeo de Desarrollo en el Reino Unido utilizan el valor como token mágico al invocar o proporcionar funcionalidad adicional sobre las funciones estándar de DOS (emuladas), siendo NWCACHE un ejemplo. ^{[ 12 ]}0E DC

Ejemplos

• La dirección MAC predeterminada en los SOC de Texas Instruments es DE:AD:BE:EF:00:00. ^{[ 14 ]}