Watchpoint — ce este, variante și configurarea punctelor de observare în Xcode

Ce este un watchpoint și principiul de funcționare

Watchpoint — este un mecanism al debuggerului care suspendă execuția programului când valoarea de la o adresă de memorie specificată se modifică. Dacă breakpoint reacționează la atingerea unei anumite linii de cod, watchpoint reacționează la scrierea într-o anumită celulă de memorie — indiferent de ce fragment de cod a efectuat acea scriere. Acest lucru îl face de neînlocuit la căutarea modificărilor neașteptate ale variabilelor, în special în aplicațiile multi-thread.

Principiul de funcționare se bazează pe suportul hardware al procesorului. Cipurile ARM moderne (Apple Silicon, Qualcomm Snapdragon) oferă între 4 și 8 registre hardware watchpoint. Când procesorul execută o instrucțiune de scriere la o adresă care coincide cu un watchpoint, apare o întrerupere hardware pe care debuggerul o interceptează. Dacă registrele hardware se epuizează, LLDB trece în modul software — verifică pas cu pas fiecare instrucțiune de scriere, ceea ce încetinește execuția de zeci de ori.

Conform ARM Architecture Reference Manual, watchpoint-urile hardware funcționează la nivelul modulului Data Watchpoint and Trace (DWT) și nu necesită modificarea codului executabil. Timpul de reacție la declanșare este de ordinul nanosecundelor, ceea ce permite urmărirea chiar și a modificărilor de înaltă frecvență ale variabilelor în buclele de procesare a datelor, cum ar fi bufferele audio sau cadrele video.

Când watchpoint este mai eficient decât breakpoint

Watchpoint este de neînlocuit când știți ce variabilă se modifică, dar nu știți de unde. Scenarii tipice: valoarea proprietății frame la UIView se modifică fără motiv aparent; un contor într-un thread de fundal se resetează imprevizibil; un fanion isLoading se comută mai devreme decât s-a încheiat cererea de rețea. În fiecare din aceste cazuri, a pune breakpoint-uri în toate locurile unde poate avea loc scrierea este nepractic. Watchpoint rezolvă problema cu o singură comandă.

Tipuri de watchpoint-uri și metode de instalare

Xcode și LLDB suportă trei tipuri de watchpoint-uri: watchpoint set variable — pentru observarea unei variabile locale; watchpoint set expression — pentru observarea unei expresii care returnează o adresă; watchpoint set — pentru observarea unei adrese de memorie brute. Fiecare tip are domeniul său de aplicare.

Instalarea prin GUI Xcode

În Xcode, un watchpoint poate fi instalat prin Debug Area: opriți-vă la un breakpoint, găsiți variabila dorită în panoul Variables View, faceți clic dreapta și selectați Watch Variable. Xcode va executa automat comanda watchpoint set variable cu numele corect al variabilei și contextul. După aceea, debuggerul se va opri la fiecare modificare a valorii — convenabil pentru depanare rapidă fără a comuta la consolă. Cu toate acestea, această metodă funcționează doar cât timp variabila se află în domeniul de vizibilitate al cadrului curent.

func processItems(_ items: [String]) {
    var index = 0
    // Instalați watchpoint pe index prin GUI:
    // opriți-vă aici, clic dreapta → Watch Variable
    for item in items {
        index += 1
        print("Item \(index): \(item)")
    }
}

Gestionarea watchpoint-urilor prin LLDB

LLDB oferă un set complet de comenzi pentru gestionarea watchpoint-urilor din consolă. Acest lucru oferă un control mai mare decât GUI: puteți specifica dimensiunea zonei de observare, stabili o condiție de declanșare, crea watchpoint-uri pe adrese obținute din expresii calculate și executa automat acțiuni la declanșare. Interfața în linie de comandă este deosebit de utilă la depanarea scenariilor complexe unde este necesară schimbarea rapidă a parametrilor de observare.

Comenzile principale watchpoint

Comanda watchpoint set variable acceptă numele variabilei ținând cont de domeniul de vizibilitate: pentru proprietățile self din Objective-C utilizați self->_property, pentru Swift — self.property. Parametrul -w write stabilește urmărirea scrierii, -w read — a citirii (mod disponibil doar pe unele arhitecturi), -s size — dimensiunea zonei în octeți. După instalarea watchpoint-ului, puteți vedea lista cu comanda watchpoint list.

(lldb) watchpoint set variable -w write -s 8 self.balance
Watchpoint 1: addr = 0x600000c4b80 size = 8 state = enabled  type = w
    watchpoint spec: 'self.balance'
(lldb) watchpoint set expression -w write -- self->items._storage
Watchpoint 2: addr = 0x600003a4c00 size = 8
(lldb) watchpoint list
1: location = 0x600000c4b80, type = write, variable = '_balance'
2: location = 0x600003a4c00, type = write, expression = 'self->items._storage'

Watchpoint-uri condiționale

La fel ca breakpoint-urile, watchpoint-urile suportă declanșarea condițională. Parametrul -c stabilește o condiție în Swift sau Objective-C. De exemplu, un watchpoint cu condiția newValue > 1000 se va opri doar când valoarea scrisă depășește o mie. Acest lucru este critic la depanarea buclelor sau senzorilor care generează mii de modificări pe secundă — altfel debuggerul s-ar opri la fiecare modificare, făcând munca imposibilă.

(lldb) watchpoint set variable -w write self.temperature -c "(int)$newValue > 100"
Watchpoint 3: addr = 0x600000e4a20, condition = '(int)$newValue > 100'
(lldb) watchpoint modify 3 -C "po self.temperature" -G true
// Automat logați valoarea și continuați execuția

Watchpoint-uri pentru proprietățile obiectelor și colecțiilor

Particularitatea watchpoint-urilor pentru proprietățile obiectelor Objective-C și Swift — watchpoint-ul se instalează nu pe numele proprietății, ci pe adresa câmpului ivar (variabilă de instanță) din memoria obiectului. Aceasta înseamnă că la fiecare nouă alocare a obiectului (de exemplu, la recrearea unui ViewController), watchpoint-ul devine invalid deoarece adresa de memorie s-a schimbat. Pentru observarea permanentă a unei proprietăți pe parcursul restartărilor, este necesară reinstalarea watchpoint-ului în momentul inițializării obiectului.

Watchpoint pe elemente ale colecțiilor

Observarea elementelor array-urilor și dicționarelor necesită calcularea adresei elementului specific. De exemplu, pentru a observa al treilea element al unui array, utilizați watchpoint set expression -- &array[2]. Dacă array-ul realocă bufferul intern (la adăugarea de elemente peste capacitate), watchpoint-ul devine invalid — LLDB va raporta eroarea Watchpoint 1 has an invalid address. În astfel de cazuri, trebuie să reinstalați watchpoint-ul după modificarea dimensiunii colecției.

(lldb) expr var $arr = [10, 20, 30, 40, 50]
(lldb) watchpoint set expression -w write -- &$arr[2]
Watchpoint 4: addr = 0x1000a4b20, size = 8
(lldb) expr $arr[2] = 99
Watchpoint 4 hit: old value: 30, new value: 99

Urmărirea retain count prin watchpoint

În Objective-C se poate urmări retain count-ul unui obiect instalând un watchpoint pe câmpul retainCount din structura objc_object. LLDB execută aceasta prin watchpoint set expression -w write -- (int*)[object retainCount]. Cu toate acestea, pentru obiectele Swift cu ARC (Automatic Reference Counting), retain count nu este direct accesibil — în schimb, utilizați Instruments sau Memory Graph Debugger pentru analiza scurgerilor de memorie. Conform Apple, watchpoint-urile pe retain count funcționează doar în build-urile Debug cu optimizarea ARC dezactivată.

Limitări și performanța watchpoint-urilor

Watchpoint-urile au o serie de limitări care trebuie luate în considerare. Principala — numărul de watchpoint-uri hardware este limitat la 4–8 registre pe arhitectura ARM și până la 4 pe x86. Când toate registrele hardware sunt ocupate, LLDB trece în modul watchpoint software: modifică fiecare instrucțiune de scriere în intervalul urmărit pentru a genera o excepție. Aceasta încetinește execuția de 10–50 de ori, de aceea în practică se recomandă utilizarea a nu mai mult de 2–3 watchpoint-uri active simultan.

A doua limitare — invalidarea watchpoint-urilor la realocarea memoriei. La acționarea colectorului de gunoi sau ARC, când un obiect este mutat în memorie (în limbile cu compactare a heap-ului), adresa watchpoint-ului devine incorectă. În Swift și Objective-C ARC nu mută obiectele, dar realocarea array-urilor și șirurilor duce la același efect. LLDB avertizează despre aceasta cu mesajul Watchpoint N address (0x...) doesn't contain a valid allocation.

A treia limitare — vizibilitatea variabilelor. Un watchpoint pe o variabilă locală funcționează doar cât timp acea variabilă se află în domeniul de vizibilitate al cadrului de stivă curent. Imediat ce funcția se încheie, watchpoint-ul este șters automat. Pentru observarea variabilelor globale sau a câmpurilor obiectelor cu viață lungă, watchpoint-ul se păstrează până la ștergerea explicită prin watchpoint delete sau până la terminarea procesului.

(lldb) watchpoint delete 1
1 watchpoints deleted.
(lldb) watchpoint delete               # Șterge toate watchpoints
2 watchpoints deleted.
(lldb) watchpoint disable 1             # Dezactivează temporar
(lldb) watchpoint enable 1              # Activează din nou

Conform ARM, watchpoint-urile pe Apple Silicon (M1–M4) suportă dimensiunea zonei urmărite de la 1 la 8 octeți. Pentru observarea structurilor mai mari de 8 octeți este necesară instalarea mai multor watchpoint-uri pe fiecare câmp. Acest lucru este important la depanarea structurilor de date complexe, cum ar fi CGRect (16 octeți) sau UIEdgeInsets (16 octeți).