Numero magico (programmazione)

In unix, il comando viene fileutilizzato per individuare il formato di un file da una firma. Ci sono diversi progetti che tentano di elencarli.

• Il protocollo OSCAR utilizzato da AIM / ICQ prefissa le richieste con 2A.
• Nel protocollo RFB utilizzato da VNC , il programma client inizia con send RFB( 52 46 42) seguito dal numero di versione del protocollo utilizzato dal client.
• Nel protocollo SMB viene utilizzato da Windows, ogni applicazione e ogni risposta del server iniziano con FF 53 4D 42, vale a dire mediante la conversione esadecimale ASCII  : \xFFSMB.
• Nel protocollo MSRPC  (in) Windows, ogni richiesta TCP inizia 05a "Microsoft DCE / RPC versione 5" seguita da 00o 01per il numero di versioni secondarie . Le richieste UDP iniziano sempre con 04.
• Le interfacce COM e DCOM serializzate come OBJREF  (en) iniziano sempre con "MEOW" ( 4D 45 4F 57). Le estensioni di debug utilizzate da DCOM iniziano con "MARB" ( 4D 41 52 42).
• Una richiesta non crittografata da un tracker BitTorrent inizia con 13(che rappresenta la lunghezza dell'intestazione), seguita dalla frase "protocollo BitTorrent".
• I pacchetti a byte singolo eDonkey2000 ed eMule contengono la versione del client in uso: attualmente E3rappresenta un client eDonkey, C5un client eMule e D4un client eMule che utilizza la compressione.
• Le transazioni SSL iniziano sempre con il messaggio "  client hello ". Lo schema di incapsulamento del pacchetto SSL riserva due o tre byte per l'intestazione. Di solito un "  client hello " da un client SSL versione 2 inizia con 80e la risposta di un server versione 3 a un client inizia con 16(ma questo può variare).
• I pacchetti DHCP utilizzano un cookie magico 63 82 53 63 all'inizio della sezione delle opzioni di tutti i pacchetti. Questo numero magico corrisponde alla sequenza ASCII “? R5? (Trattare i valori esadecimali come decimali), è definito nella revisione 5 del protocollo BOOTP, il precursore di DHCP.

Costanti numeriche senza nome

Il termine numero magico può anche riferirsi all'uso di costanti numeriche senza nome nel codice sorgente di un programma. L'uso di queste costanti viola le vecchie regole di programmazione di COBOL , FORTRAN e PL / I , non rende più chiara la scelta di questo valore e generalmente causa errori di programmazione. Secondo alcuni, la denominazione di tutte le costanti rende il codice più leggibile, più comprensibile e più facilmente manutenibile.

Il nome delle costanti deve avere un significato in base al contesto; ad esempio, è meglio evitare codici del genere SEIZE = 32quando NOMBRE_DE_BITSsarebbe stato più chiaro.

I problemi con questi numeri magici non sono limitati alle costanti numeriche; il termine è utilizzato anche per altri tipi di dati, essendo la dichiarazione di costanti più flessibile e significativa. Quindi dichiarare const string testNomUtilisateur = "Jean"è meglio che usare la parola chiave " Jean" sparsa nel programma; inoltre semplifica la fase di test .

Ad esempio, il seguente pseudo-codice consente di mescolare in modo casuale i valori di un array che rappresenta un mazzo di 52 carte  :

dove jeuè un oggetto di tipo array, la funzione randomInt(x)sceglie un numero a caso compreso tra 1 e x incluso e swapEntries(i, j)scambia la posizione dei dati inseriti in i e j nell'array. In questo esempio, 52è un numero magico . Piuttosto, è consigliabile scrivere:

E questo per molte ragioni:

• Il secondo esempio è più facile da leggere e da capire. Uno sviluppatore che legge il primo esempio chiederà: "Perché 52?" Anche se sarebbe certamente in grado di capire leggendo attentamente l'intero codice. Il numero magico diventa confuso quando lo stesso valore viene utilizzato per indicare cose diverse nello stesso pezzo di codice.
• È più facile modificare il valore della costante perché non è duplicato. La modifica del valore di un numero magico è fonte di errore perché lo stesso valore viene utilizzato molto spesso in più punti del programma. È anche possibile che due variabili con significati diversi abbiano lo stesso valore; questo pone un problema per differenziarli. Per adattare il primo esempio a un mazzo di tarocchi da 78 carte, lo sviluppatore potrebbe sostituire ingenuamente tutte le occorrenze di 52 con 78. Ciò potrebbe causare due problemi: primo, il valore 53 nella seconda riga dell'esempio non verrà modificato. il programma per elaborare solo una parte del mazzo di carte; secondo, potrebbe sostituire la stringa "52" in tutto il programma senza prestare attenzione a ciò che significa che molto probabilmente introdurrebbe bug. In confronto, la modifica del valore di nombreDeCartesnel secondo esempio è un'operazione molto semplice e richiede la modifica di una sola riga.
• Le dichiarazioni di variabili che sostituiscono il numero magico sono poste all'inizio di funzioni o file per facilitarne la ricerca e la modifica.
• L'immissione dei parametri è più semplice. Ad esempio, per generalizzare l'esempio e renderlo in grado di mescolare qualsiasi pila di carte, sarebbe necessario passare nombreDeCartescome parametro della procedura:

• È più facile rilevare errori di battitura perché una variabile dichiarata viene controllata dal compilatore. Ad esempio, l'immissione di "62" invece di "52" non verrà rilevato mentre "numberOfCates" invece di "numberOfCards" genererà un avviso (o un errore) dal compilatore che informa che "numberOfCates" non è definito.
• Ciò rende anche possibile ridurre al minimo le sequenze di tasti negli IDE consentendo il completamento automatico  : basta inserire le prime lettere della variabile affinché l'IDE la completi automaticamente.

Ci sono ancora alcuni difetti:

• L'esecuzione dell'espressione nombreDeCartes + 1richiede più tempo dell'espressione 53. Tuttavia, la maggior parte dei compilatori e degli interpreti moderni sono in grado di capire che la variabile nombreDeCartesè stata dichiarata come costante e precalcola il valore 53 nel codice compilato.
• L'uso di nomi di variabili di grandi dimensioni allunga le righe di codice, costringendo alcune righe di codice a estendersi su più righe.
• Il debug può essere più difficile se il debugger non abbina i nomi delle variabili ai loro valori.

Usi accettati come costanti numeriche senza nome

In alcuni casi, a seconda delle abitudini di codifica, è accettato l'uso di costanti numeriche senza nome:

• uso di 0 o 1 come valore iniziale o valore di incremento nei cicli for  : for (int i=0;i<max;i=i+1)(supponendo che l' incremento i++ non sia supportato);
• l'uso di 2 nelle espressioni matematiche périmètre = rayon * Math.PI * 2 ;
• utilizzando 2 per verificare che un numero sia pari o dispari :,bool estPair = (x%2==0) dove %è l' operatore modulo .

Le costanti 1 e 0 sono talvolta utilizzate per rappresentare i valori booleani "True" e "False" nei linguaggi di programmazione che non hanno questo tipo (come le versioni precedenti di C).

In C / C ++ , 0 viene talvolta utilizzato per rappresentare un puntatore o un riferimento nullo . Come nel caso di valori booleani, le librerie C standard contengono macro-definizioni di NULLcui uso è fortemente raccomandato. Altre lingue offrono valori nullo nilspecifici.

Magics GUID

È possibile creare o modificare GUID in modo che siano facilmente ricordati sebbene ciò possa influire sulla loro efficienza e unicità. Le regole per la generazione di GUID e UUID sono complesse ma assicurano di avere numeri univoci se vengono seguiti scrupolosamente.

Diversi GUID Java iniziano con "  CAFEEFAC ".

Debug del numero magico

Alcuni "numeri magici" sono costituiti da un valore particolare che viene scritto nella RAM durante l'allocazione della memoria per facilitare il debug in caso di crash. Durante il debug, il contenuto della memoria viene solitamente visualizzato in esadecimale . I valori scelti con cura per formare sequenze ripetute di lettere esadecimali, o parole in Hexspeak , sono più facilmente identificabili da un operatore umano.

L'uso di valori dispari è particolarmente utile su processori che non possono indirizzare la memoria a livello di byte , poiché questi andranno in crash se tentano di usarli come puntatori. Allo stesso modo, saranno preferiti i valori che non fanno parte del set di istruzioni .

Poiché è raro che un intero a 32 bit assuma un valore così speciale, la comparsa di uno di questi numeri in un debugger o in un core dump di solito indica un overflow del buffer o una variabile non inizializzata.

La maggior parte di questi valori ha una  dimensione di 32 bit : la dimensione di una parola su processori a 32 bit.

L'uso diffuso di tali valori nelle tecnologie Microsoft non è un caso, poiché questi sono ampiamente riportati nel libro di Steve Maguire  (in) Writing Solid Code  (in) , presso Microsoft Press  (en) . Fornisce diversi criteri per sceglierli:

• Non dovrebbero essere di uso comune; "0" non soddisfa questo criterio;
• Dovrebbero essere facilmente riconoscibili in un debugger  ;
• Sulle macchine senza allineamento dei dati di byte, devono essere dispari perché la loro dereferenziazione provochi un'eccezione  ;
• Dovrebbero causare eccezioni o un punto di interruzione se eseguiti come istruzione.

Poiché sono spesso usati per identificare aree di memoria che dovrebbero essere vuote, a volte tendono ad essere usati nel linguaggio quotidiano nel senso di "perso, abbandonato, svuotato di memoria": ad esempio, "Il tuo programma è DEADBEEF".

Il linguaggio di programmazione ZUG di Pietr Brandehörst inizializza la memoria con i valori 0000, DEADo in FFFFfase di sviluppo, e 0000in produzione, per le variabili non inizializzate restano rilevabili dagli sviluppatori ma minano la parte meno stabile del programma di produzione .

Note e riferimenti

• (it) Questo articolo è parzialmente o interamente tratto dall'articolo di Wikipedia in inglese intitolato "  Magic number (programming)  " ( vedi la lista degli autori ) .

1. (in) The Linux Information Project, "  Magic Number Definition  " ,21 agosto 2006(visitato il 19 novembre 2009 )
2. dispari Commenti e Strano Doings in Unix (in) "  http://cm.bell-labs.com/cm/cs/who/dmr/odd.html  " ( Archivio • Wikiwix • Archive.is • Google • Cosa fare? ) (Accesso 7 novembre 2013 ) .
3. Comunicazione personale con Dennis M. Ritchie
4. File sorgente system1 versione sei [1]
5. File sorgente system1 versione sette [2]
6. (in) Gary C. Kessler, "  Linux Magic Numbers  " (visitato il 19 novembre 2009 )
7. (a) Richard Ogley, "  File magic numbers  " ,17 febbraio 2003(visitato il 19 novembre 2009 )
8. Gary C. Kessler, "  File signatures Table  " ,10 giugno 2009(visitato il 19 novembre 2009 )
9. (en) Robert C Martin , codice pulito: Un manuale di artigianato agile del software , Boston, Prentice Hall ,2009, 300  p. ( ISBN  978-0-13-235088-4 e 0-13-235088-2 , OCLC  223933035 ) , p.  Capitolo 17: Odori ed euristica - G25 Sostituisci i numeri magici con costanti con nome
10. (a) Robert C. Martin , Clean Code: A Handbook of Agile Software craftsmanship , Boston, Prentice Hall ,2009, 300  p. ( ISBN  978-0-13-235088-4 e 0-13-235088-2 , OCLC  223933035 ) , p.  Capitolo 17: Odori ed euristica - G16 Oscurato Intento
11. (in) Jeff Vogel, "  Sei modi per scrivere codice più comprensibile  " ,29 maggio 2007(visitato il 19 novembre 2009 )
12. (in) Joseph M. Newcomer, "  Message Management - Guaranteeing uniqueness  " ,13 ottobre 2001(visitato il 6 settembre 2009 )
13. Nota dell'editore: specialmente in inglese; qui, se la costante DANNO (danneggiato) esistesse in esadecimale, l'esempio darebbe: "Il tuo programma è DANNO".

Appendici

Articoli Correlati

• NaN ( Not a Number ), una categoria di numeri magici
• Hexspeak

Link esterno

• (it) Specifica PNG (Portable Network Graphics) , il capitolo sulla firma dei file PNG.