Annotare il codice con NVTX

Una timeline grezza è piena di barre anonime. NVTX le permette di aggiungere i propri nomi, così il profiler legge il codice come lo legge lei. 🏷️

NVTX è NVIDIA's Tools Extension: una piccola libreria per contrassegnare regioni ed eventi che Nsight mostra poi nella timeline.

Inizi includendo un solo header. Dopodiché le chiamate di annotazione sono disponibili in qualsiasi punto del codice host.

Racchiuda una sezione di lavoro in un range con nome. Il push lo avvia e il pop lo conclude, disegnando una barra con etichetta.

I range si annidano come parentesi. Un push interno deve essere seguito dal pop prima di quello esterno, così le etichette si dispongono ordinatamente nella timeline.

Per indicare un singolo momento nel tempo, inserisca un marker invece di un range. Fissa un evento, come l'inizio di un'epoca.

Può assegnare un colore a ogni range, così le fasi risaltano a colpo d'occhio. Il caricamento potrebbe essere blu e il calcolo verde.

Con NVTX, la vista di Nsight mostra per nome fasi come preprocess e inference. Non deve più decifrare simboli di kernel criptici.

Quando non è collegato alcun profiler, le chiamate NVTX sono quasi gratuite. Può lasciare le annotazioni nel codice senza un costo reale.

NVTX annota il codice host, cioè la parte CPU che coordina il lavoro. Inquadra le regioni in cui vengono eseguiti kernel e copie.

Nel C++ moderno si racchiude spesso un range in un piccolo oggetto RAII. Esegue automaticamente il pop quando termina lo scope, così non può dimenticarsene.

NVTX trasforma le barre misteriose in range e marker con nome. Bastano alcune chiamate push e pop per rendere immediatamente leggibili le timeline di Nsight. 👏