hacking.rst 35 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855
  1. .. include:: ../disclaimer-ita.rst
  2. .. note:: Per leggere la documentazione originale in inglese:
  3. :ref:`Documentation/kernel-hacking/hacking.rst <kernel_hacking_hack>`
  4. :Original: :ref:`Documentation/kernel-hacking/hacking.rst <kernel_hacking_hack>`
  5. :Translator: Federico Vaga <federico.vaga@vaga.pv.it>
  6. .. _it_kernel_hacking_hack:
  7. =================================================
  8. L'inaffidabile guida all'hacking del kernel Linux
  9. =================================================
  10. :Author: Rusty Russell
  11. Introduzione
  12. ============
  13. Benvenuto, gentile lettore, alla notevole ed inaffidabile guida all'hacking
  14. del kernel Linux ad opera di Rusty. Questo documento descrive le procedure
  15. più usate ed i concetti necessari per scrivere codice per il kernel: lo scopo
  16. è di fornire ai programmatori C più esperti un manuale di base per sviluppo.
  17. Eviterò dettagli implementativi: per questo abbiamo il codice,
  18. ed ignorerò intere parti di alcune procedure.
  19. Prima di leggere questa guida, sappiate che non ho mai voluto scriverla,
  20. essendo esageratamente sotto qualificato, ma ho sempre voluto leggere
  21. qualcosa di simile, e quindi questa era l'unica via. Spero che possa
  22. crescere e diventare un compendio di buone pratiche, punti di partenza
  23. e generiche informazioni.
  24. Gli attori
  25. ==========
  26. In qualsiasi momento ognuna delle CPU di un sistema può essere:
  27. - non associata ad alcun processo, servendo un'interruzione hardware;
  28. - non associata ad alcun processo, servendo un softirq o tasklet;
  29. - in esecuzione nello spazio kernel, associata ad un processo
  30. (contesto utente);
  31. - in esecuzione di un processo nello spazio utente;
  32. Esiste un ordine fra questi casi. Gli ultimi due possono avvicendarsi (preempt)
  33. l'un l'altro, ma a parte questo esiste una gerarchia rigida: ognuno di questi
  34. può avvicendarsi solo ad uno di quelli sottostanti. Per esempio, mentre un
  35. softirq è in esecuzione su d'una CPU, nessun altro softirq può avvicendarsi
  36. nell'esecuzione, ma un'interruzione hardware può. Ciò nonostante, le altre CPU
  37. del sistema operano indipendentemente.
  38. Più avanti vedremo alcuni modi in cui dal contesto utente è possibile bloccare
  39. le interruzioni, così da impedirne davvero il diritto di prelazione.
  40. Contesto utente
  41. ---------------
  42. Ci si trova nel contesto utente quando si arriva da una chiamata di sistema
  43. od altre eccezioni: come nello spazio utente, altre procedure più importanti,
  44. o le interruzioni, possono far valere il proprio diritto di prelazione sul
  45. vostro processo. Potete sospendere l'esecuzione chiamando :c:func:`schedule()`.
  46. .. note::
  47. Si è sempre in contesto utente quando un modulo viene caricato o rimosso,
  48. e durante le operazioni nello strato dei dispositivi a blocchi
  49. (*block layer*).
  50. Nel contesto utente, il puntatore ``current`` (il quale indica il processo al
  51. momento in esecuzione) è valido, e :c:func:`in_interrupt()`
  52. (``include/linux/preempt.h``) è falsa.
  53. .. warning::
  54. Attenzione che se avete la prelazione o i softirq disabilitati (vedere
  55. di seguito), :c:func:`in_interrupt()` ritornerà un falso positivo.
  56. Interruzioni hardware (Hard IRQs)
  57. ---------------------------------
  58. Temporizzatori, schede di rete e tastiere sono esempi di vero hardware
  59. che possono produrre interruzioni in un qualsiasi momento. Il kernel esegue
  60. i gestori d'interruzione che prestano un servizio all'hardware. Il kernel
  61. garantisce che questi gestori non vengano mai interrotti: se una stessa
  62. interruzione arriva, questa verrà accodata (o scartata).
  63. Dato che durante la loro esecuzione le interruzioni vengono disabilitate,
  64. i gestori d'interruzioni devono essere veloci: spesso si limitano
  65. esclusivamente a notificare la presa in carico dell'interruzione,
  66. programmare una 'interruzione software' per l'esecuzione e quindi terminare.
  67. Potete dire d'essere in una interruzione hardware perché :c:func:`in_irq()`
  68. ritorna vero.
  69. .. warning::
  70. Attenzione, questa ritornerà un falso positivo se le interruzioni
  71. sono disabilitate (vedere di seguito).
  72. Contesto d'interruzione software: softirq e tasklet
  73. ---------------------------------------------------
  74. Quando una chiamata di sistema sta per tornare allo spazio utente,
  75. oppure un gestore d'interruzioni termina, qualsiasi 'interruzione software'
  76. marcata come pendente (solitamente da un'interruzione hardware) viene
  77. eseguita (``kernel/softirq.c``).
  78. La maggior parte del lavoro utile alla gestione di un'interruzione avviene qui.
  79. All'inizio della transizione ai sistemi multiprocessore, c'erano solo i
  80. cosiddetti 'bottom half' (BH), i quali non traevano alcun vantaggio da questi
  81. sistemi. Non appena abbandonammo i computer raffazzonati con fiammiferi e
  82. cicche, abbandonammo anche questa limitazione e migrammo alle interruzioni
  83. software 'softirqs'.
  84. Il file ``include/linux/interrupt.h`` elenca i differenti tipi di 'softirq'.
  85. Un tipo di softirq molto importante è il timer (``include/linux/timer.h``):
  86. potete programmarlo per far si che esegua funzioni dopo un determinato
  87. periodo di tempo.
  88. Dato che i softirq possono essere eseguiti simultaneamente su più di un
  89. processore, spesso diventa estenuante l'averci a che fare. Per questa ragione,
  90. i tasklet (``include/linux/interrupt.h``) vengo usati più di frequente:
  91. possono essere registrati dinamicamente (il che significa che potete averne
  92. quanti ne volete), e garantiscono che un qualsiasi tasklet verrà eseguito
  93. solo su un processore alla volta, sebbene diversi tasklet possono essere
  94. eseguiti simultaneamente.
  95. .. warning::
  96. Il nome 'tasklet' è ingannevole: non hanno niente a che fare
  97. con i 'processi' ('tasks'), e probabilmente hanno più a che vedere
  98. con qualche pessima vodka che Alexey Kuznetsov si fece a quel tempo.
  99. Potete determinate se siete in un softirq (o tasklet) utilizzando la
  100. macro :c:func:`in_softirq()` (``include/linux/preempt.h``).
  101. .. warning::
  102. State attenti che questa macro ritornerà un falso positivo
  103. se :ref:`botton half lock <it_local_bh_disable>` è bloccato.
  104. Alcune regole basilari
  105. ======================
  106. Nessuna protezione della memoria
  107. Se corrompete la memoria, che sia in contesto utente o d'interruzione,
  108. la macchina si pianterà. Siete sicuri che quello che volete fare
  109. non possa essere fatto nello spazio utente?
  110. Nessun numero in virgola mobile o MMX
  111. Il contesto della FPU non è salvato; anche se siete in contesto utente
  112. lo stato dell'FPU probabilmente non corrisponde a quello del processo
  113. corrente: vi incasinerete con lo stato di qualche altro processo. Se
  114. volete davvero usare la virgola mobile, allora dovrete salvare e recuperare
  115. lo stato dell'FPU (ed evitare cambi di contesto). Generalmente è una
  116. cattiva idea; usate l'aritmetica a virgola fissa.
  117. Un limite rigido dello stack
  118. A seconda della configurazione del kernel lo stack è fra 3K e 6K per la
  119. maggior parte delle architetture a 32-bit; è di 14K per la maggior
  120. parte di quelle a 64-bit; e spesso è condiviso con le interruzioni,
  121. per cui non si può usare.
  122. Evitare profonde ricorsioni ad enormi array locali nello stack
  123. (allocateli dinamicamente).
  124. Il kernel Linux è portabile
  125. Quindi mantenetelo tale. Il vostro codice dovrebbe essere a 64-bit ed
  126. indipendente dall'ordine dei byte (endianess) di un processore. Inoltre,
  127. dovreste minimizzare il codice specifico per un processore; per esempio
  128. il codice assembly dovrebbe essere incapsulato in modo pulito e minimizzato
  129. per facilitarne la migrazione. Generalmente questo codice dovrebbe essere
  130. limitato alla parte di kernel specifica per un'architettura.
  131. ioctl: non scrivere nuove chiamate di sistema
  132. =============================================
  133. Una chiamata di sistema, generalmente, è scritta così::
  134. asmlinkage long sys_mycall(int arg)
  135. {
  136. return 0;
  137. }
  138. Primo, nella maggior parte dei casi non volete creare nuove chiamate di
  139. sistema.
  140. Create un dispositivo a caratteri ed implementate l'appropriata chiamata ioctl.
  141. Questo meccanismo è molto più flessibile delle chiamate di sistema: esso non
  142. dev'essere dichiarato in tutte le architetture nei file
  143. ``include/asm/unistd.h`` e ``arch/kernel/entry.S``; inoltre, è improbabile
  144. che questo venga accettato da Linus.
  145. Se tutto quello che il vostro codice fa è leggere o scrivere alcuni parametri,
  146. considerate l'implementazione di un'interfaccia :c:func:`sysfs()`.
  147. All'interno di una ioctl vi trovate nel contesto utente di un processo. Quando
  148. avviene un errore dovete ritornare un valore negativo di errno (consultate
  149. ``include/uapi/asm-generic/errno-base.h``,
  150. ``include/uapi/asm-generic/errno.h`` e ``include/linux/errno.h``), altrimenti
  151. ritornate 0.
  152. Dopo aver dormito dovreste verificare se ci sono stati dei segnali: il modo
  153. Unix/Linux di gestire un segnale è di uscire temporaneamente dalla chiamata
  154. di sistema con l'errore ``-ERESTARTSYS``. La chiamata di sistema ritornerà
  155. al contesto utente, eseguirà il gestore del segnale e poi la vostra chiamata
  156. di sistema riprenderà (a meno che l'utente non l'abbia disabilitata). Quindi,
  157. dovreste essere pronti per continuare l'esecuzione, per esempio nel mezzo
  158. della manipolazione di una struttura dati.
  159. ::
  160. if (signal_pending(current))
  161. return -ERESTARTSYS;
  162. Se dovete eseguire dei calcoli molto lunghi: pensate allo spazio utente.
  163. Se **davvero** volete farlo nel kernel ricordatevi di verificare periodicamente
  164. se dovete *lasciare* il processore (ricordatevi che, per ogni processore, c'è
  165. un sistema multi-processo senza diritto di prelazione).
  166. Esempio::
  167. cond_resched(); /* Will sleep */
  168. Una breve nota sulla progettazione delle interfacce: il motto dei sistemi
  169. UNIX è "fornite meccanismi e non politiche"
  170. La ricetta per uno stallo
  171. =========================
  172. Non è permesso invocare una procedura che potrebbe dormire, fanno eccezione
  173. i seguenti casi:
  174. - Siete in un contesto utente.
  175. - Non trattenete alcun spinlock.
  176. - Avete abilitato le interruzioni (in realtà, Andy Kleen dice che
  177. lo schedulatore le abiliterà per voi, ma probabilmente questo non è quello
  178. che volete).
  179. Da tener presente che alcune funzioni potrebbero dormire implicitamente:
  180. le più comuni sono quelle per l'accesso allo spazio utente (\*_user) e
  181. quelle per l'allocazione della memoria senza l'opzione ``GFP_ATOMIC``
  182. Dovreste sempre compilare il kernel con l'opzione ``CONFIG_DEBUG_ATOMIC_SLEEP``
  183. attiva, questa vi avviserà se infrangete una di queste regole.
  184. Se **infrangete** le regole, allora potreste bloccare il vostro scatolotto.
  185. Veramente.
  186. Alcune delle procedure più comuni
  187. =================================
  188. :c:func:`printk()`
  189. ------------------
  190. Definita in ``include/linux/printk.h``
  191. :c:func:`printk()` fornisce messaggi alla console, dmesg, e al demone syslog.
  192. Essa è utile per il debugging o per la notifica di errori; può essere
  193. utilizzata anche all'interno del contesto d'interruzione, ma usatela con
  194. cautela: una macchina che ha la propria console inondata da messaggi diventa
  195. inutilizzabile. La funzione utilizza un formato stringa quasi compatibile con
  196. la printf ANSI C, e la concatenazione di una stringa C come primo argomento
  197. per indicare la "priorità"::
  198. printk(KERN_INFO "i = %u\n", i);
  199. Consultate ``include/linux/kern_levels.h`` per gli altri valori ``KERN_``;
  200. questi sono interpretati da syslog come livelli. Un caso speciale:
  201. per stampare un indirizzo IP usate::
  202. __be32 ipaddress;
  203. printk(KERN_INFO "my ip: %pI4\n", &ipaddress);
  204. :c:func:`printk()` utilizza un buffer interno di 1K e non s'accorge di
  205. eventuali sforamenti. Accertatevi che vi basti.
  206. .. note::
  207. Saprete di essere un vero hacker del kernel quando inizierete a digitare
  208. nei vostri programmi utenti le printf come se fossero printk :)
  209. .. note::
  210. Un'altra nota a parte: la versione originale di Unix 6 aveva un commento
  211. sopra alla funzione printf: "Printf non dovrebbe essere usata per il
  212. chiacchiericcio". Dovreste seguire questo consiglio.
  213. :c:func:`copy_to_user()` / :c:func:`copy_from_user()` / :c:func:`get_user()` / :c:func:`put_user()`
  214. ---------------------------------------------------------------------------------------------------
  215. Definite in ``include/linux/uaccess.h`` / ``asm/uaccess.h``
  216. **[DORMONO]**
  217. :c:func:`put_user()` e :c:func:`get_user()` sono usate per ricevere ed
  218. impostare singoli valori (come int, char, o long) da e verso lo spazio utente.
  219. Un puntatore nello spazio utente non dovrebbe mai essere dereferenziato: i dati
  220. dovrebbero essere copiati usando suddette procedure. Entrambe ritornano
  221. ``-EFAULT`` oppure 0.
  222. :c:func:`copy_to_user()` e :c:func:`copy_from_user()` sono più generiche:
  223. esse copiano una quantità arbitraria di dati da e verso lo spazio utente.
  224. .. warning::
  225. Al contrario di:c:func:`put_user()` e :c:func:`get_user()`, queste
  226. funzioni ritornano la quantità di dati copiati (0 è comunque un successo).
  227. [Sì, questa stupida interfaccia mi imbarazza. La battaglia torna in auge anno
  228. dopo anno. --RR]
  229. Le funzioni potrebbero dormire implicitamente. Queste non dovrebbero mai essere
  230. invocate fuori dal contesto utente (non ha senso), con le interruzioni
  231. disabilitate, o con uno spinlock trattenuto.
  232. :c:func:`kmalloc()`/:c:func:`kfree()`
  233. -------------------------------------
  234. Definite in ``include/linux/slab.h``
  235. **[POTREBBERO DORMIRE: LEGGI SOTTO]**
  236. Queste procedure sono utilizzate per la richiesta dinamica di un puntatore ad
  237. un pezzo di memoria allineato, esattamente come malloc e free nello spazio
  238. utente, ma :c:func:`kmalloc()` ha un argomento aggiuntivo per indicare alcune
  239. opzioni. Le opzioni più importanti sono:
  240. ``GFP_KERNEL``
  241. Potrebbe dormire per librarare della memoria. L'opzione fornisce il modo
  242. più affidabile per allocare memoria, ma il suo uso è strettamente limitato
  243. allo spazio utente.
  244. ``GFP_ATOMIC``
  245. Non dorme. Meno affidabile di ``GFP_KERNEL``, ma può essere usata in un
  246. contesto d'interruzione. Dovreste avere **davvero** una buona strategia
  247. per la gestione degli errori in caso di mancanza di memoria.
  248. ``GFP_DMA``
  249. Alloca memoria per il DMA sul bus ISA nello spazio d'indirizzamento
  250. inferiore ai 16MB. Se non sapete cos'è allora non vi serve.
  251. Molto inaffidabile.
  252. Se vedete un messaggio d'avviso per una funzione dormiente che viene chiamata
  253. da un contesto errato, allora probabilmente avete usato una funzione
  254. d'allocazione dormiente da un contesto d'interruzione senza ``GFP_ATOMIC``.
  255. Dovreste correggerlo. Sbrigatevi, non cincischiate.
  256. Se allocate almeno ``PAGE_SIZE``(``asm/page.h`` o ``asm/page_types.h``) byte,
  257. considerate l'uso di :c:func:`__get_free_pages()` (``include/linux/gfp.h``).
  258. Accetta un argomento che definisce l'ordine (0 per per la dimensione di una
  259. pagine, 1 per una doppia pagina, 2 per quattro pagine, eccetra) e le stesse
  260. opzioni d'allocazione viste precedentemente.
  261. Se state allocando un numero di byte notevolemnte superiore ad una pagina
  262. potete usare :c:func:`vmalloc()`. Essa allocherà memoria virtuale all'interno
  263. dello spazio kernel. Questo è un blocco di memoria fisica non contiguo, ma
  264. la MMU vi darà l'impressione che lo sia (quindi, sarà contiguo solo dal punto
  265. di vista dei processori, non dal punto di vista dei driver dei dispositivi
  266. esterni).
  267. Se per qualche strana ragione avete davvero bisogno di una grossa quantità di
  268. memoria fisica contigua, avete un problema: Linux non ha un buon supporto per
  269. questo caso d'uso perché, dopo un po' di tempo, la frammentazione della memoria
  270. rende l'operazione difficile. Il modo migliore per allocare un simile blocco
  271. all'inizio dell'avvio del sistema è attraverso la procedura
  272. :c:func:`alloc_bootmem()`.
  273. Prima di inventare la vostra cache per gli oggetti più usati, considerate
  274. l'uso di una cache slab disponibile in ``include/linux/slab.h``.
  275. :c:func:`current()`
  276. -------------------
  277. Definita in ``include/asm/current.h``
  278. Questa variabile globale (in realtà una macro) contiene un puntatore alla
  279. struttura del processo corrente, quindi è valido solo dal contesto utente.
  280. Per esempio, quando un processo esegue una chiamata di sistema, questo
  281. punterà alla struttura dati del processo chiamate.
  282. Nel contesto d'interruzione in suo valore **non è NULL**.
  283. :c:func:`mdelay()`/:c:func:`udelay()`
  284. -------------------------------------
  285. Definite in ``include/asm/delay.h`` / ``include/linux/delay.h``
  286. Le funzioni :c:func:`udelay()` e :c:func:`ndelay()` possono essere utilizzate
  287. per brevi pause. Non usate grandi valori perché rischiate d'avere un
  288. overflow - in questo contesto la funzione :c:func:`mdelay()` è utile,
  289. oppure considerate :c:func:`msleep()`.
  290. :c:func:`cpu_to_be32()`/:c:func:`be32_to_cpu()`/:c:func:`cpu_to_le32()`/:c:func:`le32_to_cpu()`
  291. -----------------------------------------------------------------------------------------------
  292. Definite in ``include/asm/byteorder.h``
  293. La famiglia di funzioni :c:func:`cpu_to_be32()` (dove "32" può essere
  294. sostituito da 64 o 16, e "be" con "le") forniscono un modo generico
  295. per fare conversioni sull'ordine dei byte (endianess): esse ritornano
  296. il valore convertito. Tutte le varianti supportano anche il processo inverso:
  297. :c:func:`be32_to_cpu()`, eccetera.
  298. Queste funzioni hanno principalmente due varianti: la variante per
  299. puntatori, come :c:func:`cpu_to_be32p(), che prende un puntatore
  300. ad un tipo, e ritorna il valore convertito. L'altra variante per
  301. la famiglia di conversioni "in-situ", come :c:func:`cpu_to_be32s()`,
  302. che convertono il valore puntato da un puntatore, e ritornano void.
  303. :c:func:`local_irq_save()`/:c:func:`local_irq_restore()`
  304. --------------------------------------------------------
  305. Definite in ``include/linux/irqflags.h``
  306. Queste funzioni abilitano e disabilitano le interruzioni hardware
  307. sul processore locale. Entrambe sono rientranti; esse salvano lo stato
  308. precedente nel proprio argomento ``unsigned long flags``. Se sapete
  309. che le interruzioni sono abilite, potete semplicemente utilizzare
  310. :c:func:`local_irq_disable()` e :c:func:`local_irq_enable()`.
  311. .. _it_local_bh_disable:
  312. :c:func:`local_bh_disable()`/:c:func:`local_bh_enable()`
  313. --------------------------------------------------------
  314. Definite in ``include/linux/bottom_half.h``
  315. Queste funzioni abilitano e disabilitano le interruzioni software
  316. sul processore locale. Entrambe sono rientranti; se le interruzioni
  317. software erano già state disabilitate in precedenza, rimarranno
  318. disabilitate anche dopo aver invocato questa coppia di funzioni.
  319. Lo scopo è di prevenire l'esecuzione di softirq e tasklet sul processore
  320. attuale.
  321. :c:func:`smp_processor_id()`
  322. ----------------------------
  323. Definita in ``include/linux/smp.h``
  324. :c:func:`get_cpu()` nega il diritto di prelazione (quindi non potete essere
  325. spostati su un altro processore all'improvviso) e ritorna il numero
  326. del processore attuale, fra 0 e ``NR_CPUS``. Da notare che non è detto
  327. che la numerazione dei processori sia continua. Quando avete terminato,
  328. ritornate allo stato precedente con :c:func:`put_cpu()`.
  329. Se sapete che non dovete essere interrotti da altri processi (per esempio,
  330. se siete in un contesto d'interruzione, o il diritto di prelazione
  331. è disabilitato) potete utilizzare smp_processor_id().
  332. ``__init``/``__exit``/``__initdata``
  333. ------------------------------------
  334. Definite in ``include/linux/init.h``
  335. Dopo l'avvio, il kernel libera una sezione speciale; le funzioni marcate
  336. con ``__init`` e le strutture dati marcate con ``__initdata`` vengono
  337. eliminate dopo il completamento dell'avvio: in modo simile i moduli eliminano
  338. questa memoria dopo l'inizializzazione. ``__exit`` viene utilizzato per
  339. dichiarare che una funzione verrà utilizzata solo in fase di rimozione:
  340. la detta funzione verrà eliminata quando il file che la contiene non è
  341. compilato come modulo. Guardate l'header file per informazioni. Da notare che
  342. non ha senso avere una funzione marcata come ``__init`` e al tempo stesso
  343. esportata ai moduli utilizzando :c:func:`EXPORT_SYMBOL()` o
  344. :c:func:`EXPORT_SYMBOL_GPL()` - non funzionerà.
  345. :c:func:`__initcall()`/:c:func:`module_init()`
  346. ----------------------------------------------
  347. Definite in ``include/linux/init.h`` / ``include/linux/module.h``
  348. Molte parti del kernel funzionano bene come moduli (componenti del kernel
  349. caricabili dinamicamente). L'utilizzo delle macro :c:func:`module_init()`
  350. e :c:func:`module_exit()` semplifica la scrittura di codice che può funzionare
  351. sia come modulo, sia come parte del kernel, senza l'ausilio di #ifdef.
  352. La macro :c:func:`module_init()` definisce quale funzione dev'essere
  353. chiamata quando il modulo viene inserito (se il file è stato compilato come
  354. tale), o in fase di avvio : se il file non è stato compilato come modulo la
  355. macro :c:func:`module_init()` diventa equivalente a :c:func:`__initcall()`,
  356. la quale, tramite qualche magia del linker, s'assicura che la funzione venga
  357. chiamata durante l'avvio.
  358. La funzione può ritornare un numero d'errore negativo per scatenare un
  359. fallimento del caricamento (sfortunatamente, questo non ha effetto se il
  360. modulo è compilato come parte integrante del kernel). Questa funzione è chiamata
  361. in contesto utente con le interruzioni abilitate, quindi potrebbe dormire.
  362. :c:func:`module_exit()`
  363. -----------------------
  364. Definita in ``include/linux/module.h``
  365. Questa macro definisce la funzione che dev'essere chiamata al momento della
  366. rimozione (o mai, nel caso in cui il file sia parte integrante del kernel).
  367. Essa verrà chiamata solo quando il contatore d'uso del modulo raggiunge lo
  368. zero. Questa funzione può anche dormire, ma non può fallire: tutto dev'essere
  369. ripulito prima che la funzione ritorni.
  370. Da notare che questa macro è opzionale: se non presente, il modulo non sarà
  371. removibile (a meno che non usiate 'rmmod -f' ).
  372. :c:func:`try_module_get()`/:c:func:`module_put()`
  373. -------------------------------------------------
  374. Definite in ``include/linux/module.h``
  375. Queste funzioni maneggiano il contatore d'uso del modulo per proteggerlo dalla
  376. rimozione (in aggiunta, un modulo non può essere rimosso se un altro modulo
  377. utilizzo uno dei sui simboli esportati: vedere di seguito). Prima di eseguire
  378. codice del modulo, dovreste chiamare :c:func:`try_module_get()` su quel modulo:
  379. se fallisce significa che il modulo è stato rimosso e dovete agire come se
  380. non fosse presente. Altrimenti, potete accedere al modulo in sicurezza, e
  381. chiamare :c:func:`module_put()` quando avete finito.
  382. La maggior parte delle strutture registrabili hanno un campo owner
  383. (proprietario), come nella struttura
  384. :c:type:`struct file_operations <file_operations>`.
  385. Impostate questo campo al valore della macro ``THIS_MODULE``.
  386. Code d'attesa ``include/linux/wait.h``
  387. ======================================
  388. **[DORMONO]**
  389. Una coda d'attesa è usata per aspettare che qualcuno vi attivi quando una
  390. certa condizione s'avvera. Per evitare corse critiche, devono essere usate
  391. con cautela. Dichiarate una :c:type:`wait_queue_head_t`, e poi i processi
  392. che vogliono attendere il verificarsi di quella condizione dichiareranno
  393. una :c:type:`wait_queue_entry_t` facendo riferimento a loro stessi, poi
  394. metteranno questa in coda.
  395. Dichiarazione
  396. -------------
  397. Potere dichiarare una ``wait_queue_head_t`` utilizzando la macro
  398. :c:func:`DECLARE_WAIT_QUEUE_HEAD()` oppure utilizzando la procedura
  399. :c:func:`init_waitqueue_head()` nel vostro codice d'inizializzazione.
  400. Accodamento
  401. -----------
  402. Mettersi in una coda d'attesa è piuttosto complesso, perché dovete
  403. mettervi in coda prima di verificare la condizione. Esiste una macro
  404. a questo scopo: :c:func:`wait_event_interruptible()` (``include/linux/wait.h``).
  405. Il primo argomento è la testa della coda d'attesa, e il secondo è
  406. un'espressione che dev'essere valutata; la macro ritorna 0 quando questa
  407. espressione è vera, altrimenti ``-ERESTARTSYS`` se è stato ricevuto un segnale.
  408. La versione :c:func:`wait_event()` ignora i segnali.
  409. Svegliare una procedura in coda
  410. -------------------------------
  411. Chiamate :c:func:`wake_up()` (``include/linux/wait.h``); questa attiverà tutti
  412. i processi in coda. Ad eccezione se uno di questi è impostato come
  413. ``TASK_EXCLUSIVE``, in questo caso i rimanenti non verranno svegliati.
  414. Nello stesso header file esistono altre varianti di questa funzione.
  415. Operazioni atomiche
  416. ===================
  417. Certe operazioni sono garantite come atomiche su tutte le piattaforme.
  418. Il primo gruppo di operazioni utilizza :c:type:`atomic_t`
  419. (``include/asm/atomic.h``); questo contiene un intero con segno (minimo 32bit),
  420. e dovete utilizzare queste funzione per modificare o leggere variabili di tipo
  421. :c:type:`atomic_t`. :c:func:`atomic_read()` e :c:func:`atomic_set()` leggono ed
  422. impostano il contatore, :c:func:`atomic_add()`, :c:func:`atomic_sub()`,
  423. :c:func:`atomic_inc()`, :c:func:`atomic_dec()`, e
  424. :c:func:`atomic_dec_and_test()` (ritorna vero se raggiunge zero dopo essere
  425. stata decrementata).
  426. Sì. Ritorna vero (ovvero != 0) se la variabile atomica è zero.
  427. Da notare che queste funzioni sono più lente rispetto alla normale aritmetica,
  428. e quindi non dovrebbero essere usate a sproposito.
  429. Il secondo gruppo di operazioni atomiche sono definite in
  430. ``include/linux/bitops.h`` ed agiscono sui bit d'una variabile di tipo
  431. ``unsigned long``. Queste operazioni prendono come argomento un puntatore
  432. alla variabile, e un numero di bit dove 0 è quello meno significativo.
  433. :c:func:`set_bit()`, :c:func:`clear_bit()` e :c:func:`change_bit()`
  434. impostano, cancellano, ed invertono il bit indicato.
  435. :c:func:`test_and_set_bit()`, :c:func:`test_and_clear_bit()` e
  436. :c:func:`test_and_change_bit()` fanno la stessa cosa, ad eccezione che
  437. ritornano vero se il bit era impostato; queste sono particolarmente
  438. utili quando si vuole impostare atomicamente dei flag.
  439. Con queste operazioni è possibile utilizzare indici di bit che eccedono
  440. il valore ``BITS_PER_LONG``. Il comportamento è strano sulle piattaforme
  441. big-endian quindi è meglio evitarlo.
  442. Simboli
  443. =======
  444. All'interno del kernel, si seguono le normali regole del linker (ovvero,
  445. a meno che un simbolo non venga dichiarato con visibilita limitata ad un
  446. file con la parola chiave ``static``, esso può essere utilizzato in qualsiasi
  447. parte del kernel). Nonostante ciò, per i moduli, esiste una tabella dei
  448. simboli esportati che limita i punti di accesso al kernel. Anche i moduli
  449. possono esportare simboli.
  450. :c:func:`EXPORT_SYMBOL()`
  451. -------------------------
  452. Definita in ``include/linux/export.h``
  453. Questo è il classico metodo per esportare un simbolo: i moduli caricati
  454. dinamicamente potranno utilizzare normalmente il simbolo.
  455. :c:func:`EXPORT_SYMBOL_GPL()`
  456. -----------------------------
  457. Definita in ``include/linux/export.h``
  458. Essa è simile a :c:func:`EXPORT_SYMBOL()` ad eccezione del fatto che i
  459. simboli esportati con :c:func:`EXPORT_SYMBOL_GPL()` possono essere
  460. utilizzati solo dai moduli che hanno dichiarato una licenza compatibile
  461. con la GPL attraverso :c:func:`MODULE_LICENSE()`. Questo implica che la
  462. funzione esportata è considerata interna, e non una vera e propria interfaccia.
  463. Alcuni manutentori e sviluppatori potrebbero comunque richiedere
  464. :c:func:`EXPORT_SYMBOL_GPL()` quando si aggiungono nuove funzionalità o
  465. interfacce.
  466. Procedure e convenzioni
  467. =======================
  468. Liste doppiamente concatenate ``include/linux/list.h``
  469. ------------------------------------------------------
  470. Un tempo negli header del kernel c'erano tre gruppi di funzioni per
  471. le liste concatenate, ma questa è stata la vincente. Se non avete particolari
  472. necessità per una semplice lista concatenata, allora questa è una buona scelta.
  473. In particolare, :c:func:`list_for_each_entry()` è utile.
  474. Convenzione dei valori di ritorno
  475. ---------------------------------
  476. Per codice chiamato in contesto utente, è molto comune sfidare le convenzioni
  477. C e ritornare 0 in caso di successo, ed un codice di errore negativo
  478. (eg. ``-EFAULT``) nei casi fallimentari. Questo potrebbe essere controintuitivo
  479. a prima vista, ma è abbastanza diffuso nel kernel.
  480. Utilizzate :c:func:`ERR_PTR()` (``include/linux/err.h``) per codificare
  481. un numero d'errore negativo in un puntatore, e :c:func:`IS_ERR()` e
  482. :c:func:`PTR_ERR()` per recuperarlo di nuovo: così si evita d'avere un
  483. puntatore dedicato per il numero d'errore. Da brividi, ma in senso positivo.
  484. Rompere la compilazione
  485. -----------------------
  486. Linus e gli altri sviluppatori a volte cambiano i nomi delle funzioni e
  487. delle strutture nei kernel in sviluppo; questo non è solo per tenere
  488. tutti sulle spine: questo riflette cambiamenti fondamentati (eg. la funzione
  489. non può più essere chiamata con le funzioni attive, o fa controlli aggiuntivi,
  490. o non fa più controlli che venivano fatti in precedenza). Solitamente a questo
  491. s'accompagna un'adeguata e completa nota sulla lista di discussone
  492. linux-kernel; cercate negli archivi.
  493. Solitamente eseguire una semplice sostituzione su tutto un file rendere
  494. le cose **peggiori**.
  495. Inizializzazione dei campi d'una struttura
  496. ------------------------------------------
  497. Il metodo preferito per l'inizializzazione delle strutture è quello
  498. di utilizzare gli inizializzatori designati, come definiti nello
  499. standard ISO C99, eg::
  500. static struct block_device_operations opt_fops = {
  501. .open = opt_open,
  502. .release = opt_release,
  503. .ioctl = opt_ioctl,
  504. .check_media_change = opt_media_change,
  505. };
  506. Questo rende più facile la ricerca con grep, e rende più chiaro quale campo
  507. viene impostato. Dovreste fare così perché si mostra meglio.
  508. Estensioni GNU
  509. --------------
  510. Le estensioni GNU sono esplicitamente permesse nel kernel Linux. Da notare
  511. che alcune delle più complesse non sono ben supportate, per via dello scarso
  512. sviluppo, ma le seguenti sono da considerarsi la norma (per maggiori dettagli,
  513. leggete la sezione "C Extensions" nella pagina info di GCC - Sì, davvero
  514. la pagina info, la pagina man è solo un breve riassunto delle cose nella
  515. pagina info).
  516. - Funzioni inline
  517. - Istruzioni in espressioni (ie. il costrutto ({ and }) ).
  518. - Dichiarate attributi di una funzione / variabile / tipo
  519. (__attribute__)
  520. - typeof
  521. - Array con lunghezza zero
  522. - Macro varargs
  523. - Aritmentica sui puntatori void
  524. - Inizializzatori non costanti
  525. - Istruzioni assembler (non al di fuori di 'arch/' e 'include/asm/')
  526. - Nomi delle funzioni come stringhe (__func__).
  527. - __builtin_constant_p()
  528. Siate sospettosi quando utilizzate long long nel kernel, il codice generato
  529. da gcc è orribile ed anche peggio: le divisioni e le moltiplicazioni non
  530. funzionano sulle piattaforme i386 perché le rispettive funzioni di runtime
  531. di GCC non sono incluse nell'ambiente del kernel.
  532. C++
  533. ---
  534. Solitamente utilizzare il C++ nel kernel è una cattiva idea perché
  535. il kernel non fornisce il necessario ambiente di runtime e gli header file
  536. non sono stati verificati. Rimane comunque possibile, ma non consigliato.
  537. Se davvero volete usarlo, almeno evitate le eccezioni.
  538. NUMif
  539. -----
  540. Viene generalmente considerato più pulito l'uso delle macro negli header file
  541. (o all'inizio dei file .c) per astrarre funzioni piuttosto che utlizzare
  542. l'istruzione di pre-processore \`#if' all'interno del codice sorgente.
  543. Mettere le vostre cose nel kernel
  544. =================================
  545. Al fine d'avere le vostre cose in ordine per l'inclusione ufficiale, o
  546. anche per avere patch pulite, c'è del lavoro amministrativo da fare:
  547. - Trovare di chi è lo stagno in cui state pisciando. Guardare in cima
  548. ai file sorgenti, all'interno del file ``MAINTAINERS``, ed alla fine
  549. di tutti nel file ``CREDITS``. Dovreste coordinarvi con queste persone
  550. per evitare di duplicare gli sforzi, o provare qualcosa che è già stato
  551. rigettato.
  552. Assicuratevi di mettere il vostro nome ed indirizzo email in cima a
  553. tutti i file che create o che mangeggiate significativamente. Questo è
  554. il primo posto dove le persone guarderanno quando troveranno un baco,
  555. o quando **loro** vorranno fare una modifica.
  556. - Solitamente vorrete un'opzione di configurazione per la vostra modifica
  557. al kernel. Modificate ``Kconfig`` nella cartella giusta. Il linguaggio
  558. Config è facile con copia ed incolla, e c'è una completa documentazione
  559. nel file ``Documentation/kbuild/kconfig-language.txt``.
  560. Nella descrizione della vostra opzione, assicuratevi di parlare sia agli
  561. utenti esperti sia agli utente che non sanno nulla del vostro lavoro.
  562. Menzionate qui le incompatibilità ed i problemi. Chiaramente la
  563. descrizione deve terminare con “if in doubt, say N” (se siete in dubbio,
  564. dite N) (oppure, occasionalmente, \`Y'); questo è per le persone che non
  565. hanno idea di che cosa voi stiate parlando.
  566. - Modificate il file ``Makefile``: le variabili CONFIG sono esportate qui,
  567. quindi potete solitamente aggiungere una riga come la seguete
  568. "obj-$(CONFIG_xxx) += xxx.o". La sintassi è documentata nel file
  569. ``Documentation/kbuild/makefiles.txt``.
  570. - Aggiungete voi stessi in ``CREDITS`` se avete fatto qualcosa di notevole,
  571. solitamente qualcosa che supera il singolo file (comunque il vostro nome
  572. dovrebbe essere all'inizio dei file sorgenti). ``MAINTAINERS`` significa
  573. che volete essere consultati quando vengono fatte delle modifiche ad un
  574. sottosistema, e quando ci sono dei bachi; questo implica molto di più
  575. di un semplice impegno su una parte del codice.
  576. - Infine, non dimenticatevi di leggere
  577. ``Documentation/process/submitting-patches.rst`` e possibilmente anche
  578. ``Documentation/process/submitting-drivers.rst``.
  579. Trucchetti del kernel
  580. =====================
  581. Dopo una rapida occhiata al codice, questi sono i preferiti. Sentitevi liberi
  582. di aggiungerne altri.
  583. ``arch/x86/include/asm/delay.h``::
  584. #define ndelay(n) (__builtin_constant_p(n) ? \
  585. ((n) > 20000 ? __bad_ndelay() : __const_udelay((n) * 5ul)) : \
  586. __ndelay(n))
  587. ``include/linux/fs.h``::
  588. /*
  589. * Kernel pointers have redundant information, so we can use a
  590. * scheme where we can return either an error code or a dentry
  591. * pointer with the same return value.
  592. *
  593. * This should be a per-architecture thing, to allow different
  594. * error and pointer decisions.
  595. */
  596. #define ERR_PTR(err) ((void *)((long)(err)))
  597. #define PTR_ERR(ptr) ((long)(ptr))
  598. #define IS_ERR(ptr) ((unsigned long)(ptr) > (unsigned long)(-1000))
  599. ``arch/x86/include/asm/uaccess_32.h:``::
  600. #define copy_to_user(to,from,n) \
  601. (__builtin_constant_p(n) ? \
  602. __constant_copy_to_user((to),(from),(n)) : \
  603. __generic_copy_to_user((to),(from),(n)))
  604. ``arch/sparc/kernel/head.S:``::
  605. /*
  606. * Sun people can't spell worth damn. "compatability" indeed.
  607. * At least we *know* we can't spell, and use a spell-checker.
  608. */
  609. /* Uh, actually Linus it is I who cannot spell. Too much murky
  610. * Sparc assembly will do this to ya.
  611. */
  612. C_LABEL(cputypvar):
  613. .asciz "compatibility"
  614. /* Tested on SS-5, SS-10. Probably someone at Sun applied a spell-checker. */
  615. .align 4
  616. C_LABEL(cputypvar_sun4m):
  617. .asciz "compatible"
  618. ``arch/sparc/lib/checksum.S:``::
  619. /* Sun, you just can't beat me, you just can't. Stop trying,
  620. * give up. I'm serious, I am going to kick the living shit
  621. * out of you, game over, lights out.
  622. */
  623. Ringraziamenti
  624. ==============
  625. Ringrazio Andi Kleen per le sue idee, le risposte alle mie domande,
  626. le correzioni dei miei errori, l'aggiunta di contenuti, eccetera.
  627. Philipp Rumpf per l'ortografia e per aver reso più chiaro il testo, e
  628. per alcuni eccellenti punti tutt'altro che ovvi. Werner Almesberger
  629. per avermi fornito un ottimo riassunto di :c:func:`disable_irq()`,
  630. e Jes Sorensen e Andrea Arcangeli per le precisazioni. Michael Elizabeth
  631. Chastain per aver verificato ed aggiunto la sezione configurazione.
  632. Telsa Gwynne per avermi insegnato DocBook.