Programming Languages Hacks

Importanti regole per linguaggi di programmazione rilevanti come Java, C, C++, C#…

  • Subscribe

  • Lettori

    I miei lettori abituali

  • Twitter

Weak Delegate: gestire Eventi senza causare Memory Leak

Posted by Ricibald on 14th December 2009

Uno dei motivi principali di memory leak è il riferimento circolare tra oggetti, come già osservato nel precedente post.

Un’istanza particolare di questo problema si trova nella gestione degli eventi. Consideriamo questo scenario: la window2 (subscriber) registra il proprio handler all’evento TextChanged della window1 padre (publisher). Ci aspetteremmo che la window2 venga deallocata quando chiusa ma questo non succederà poiché la window1 mantiene uno strong reference verso la window2 mediante la registrazione dell’handler.

La window1 in realtà detiene l’ownership di window2 poiché è la finestra padre, ma questa relazione viene già mantenuta mediante la lista Children, non tramite l’handler.
Il punto è quindi che, mentre la cancellazione della lista viene gestita dallo stesso framework grafico che quindi garantisce uno stato corretto per la deallocazione, risulta invece nostra responsabilità gestire la deferenziazione di altri strong reference mantenuti. Questo discorso non si applica quindi solo agli event handler ma anche a data binding e a command, i quali internamente mantengono strong reference.

Una soluzione consiste nel deregistrare gli handler (o databinding o command) al momento della close della window2, ma risulta una soluzione fragile: si presta facilmente a errori durante lo sviluppo.

Una soluzione migliore sarebbe registrare un “weak delegate”: in questo modo il publisher non vincolerebbe il ciclo di vita dei subscriber.

Ma come fare a creare un weak delegate? Il trucco è in sostanza questo: dobbiamo rimpiazzare il “delegate originale” con un suo “delegate proxy”, il quale invoca il delegate originale se il target del delegato non è stato deallocato. Per fare questo quindi il delegate proxy deve mantenere un weak reference verso il delegate originale. La soluzione concettuale è espressa in queste poche righe di codice:

public static EventHandler ToWeak(EventHandler eventHandler)
{
    var weakAction = new WeakReference(eventHandler);
    var handler = new EventHandler((sender, e) =>
    {
        var target = weakAction.Target as EventHandler;
        if (target != null) target(sender, e);
    });
    return handler;
}

Combinando questo con gli extension methods possiamo quindi ottenere un fantastico metodo “ToWeak” che trasforma un delegate standard in un “weak delegate”:

    public static class ExtensionMethods
    {
        public static EventHandler ToWeak(this EventHandler eventHandler)
        {
            var weakAction = new WeakReference(eventHandler);
            var handler = new EventHandler((sender, e) =>
            {
                var target = weakAction.Target as EventHandler;
                if (target != null) target(sender, e);
            });
            return handler;
        }

        public static EventHandler<TEventArgs> ToWeak<TEventArgs>(this EventHandler<TEventArgs> eventHandler)
            where TEventArgs : System.EventArgs
        {
            var weakAction = new WeakReference(eventHandler);
            var handler = new EventHandler<TEventArgs>((sender, e) =>
            {
                var target = weakAction.Target as EventHandler<TEventArgs>;
                if (target != null) target(sender, e);
            });
            return handler;
        }
    }

    class Subscriber
    {
        public void Handler(object sender, EventArgs e)
        {
            Console.WriteLine("Handler called");
        }

        ~Subscriber()
        {
            Console.WriteLine("Subscriber Cleaned");
        }
    }

    class Publisher
    {
        public event EventHandler Click;
        public string Id { get; private set; }

        public Publisher(string id)
        {
            this.Id = id;
        }

        ~Publisher()
        {
            Console.WriteLine("Publisher Cleaned");
        }

        public void OnClick()
        {
            if(Click != null)
            {
                Click(this, new EventArgs());
            }
        }
    }

    class Program
    {
        public static void Main()
        {
            Console.WriteLine("+ TEST 1: WITHOUT WakeEventHandler");
            RunTestWithWakeFlag(false);

            Console.WriteLine("+ TEST 2: WITH WakeEventHandler");
            RunTestWithWakeFlag(true);

            Console.ReadLine();
        }

        public static void RunTestWithWakeFlag(bool isWake)
        {
            waitAndWrite("+--- ***Subscriber Creation***");
            var subscriber = new Subscriber();

            waitAndWrite("+------ Holding the Subscriber's Handler");
            EventHandler h = createEventHandler(subscriber.Handler, isWake);

            waitAndWrite("+------ Raising Subscriber Event");
            h(null, EventArgs.Empty);

            waitAndWrite("+------ Subscriber not yet used by application. GC called\r\n+------ [!!!LEAK HERE IF NOT WEAK!!!] (CLASSES MANTAINES IN LIFE ALL CLASSES'S DELEGATE)");
            subscriber = null;
            garbageCollect();

            waitAndWrite("+------ Raising Subscriber Event Again");
            h(null, EventArgs.Empty);

            waitAndWrite("+------ Handler not yet used by application. GC called");
            h = null;
            garbageCollect();

            waitAndWrite("+--- ***Publisher Creation (12345)***");
            var publisher12345 = new Publisher("12345");

            waitAndWrite("+------ Publisher Registration Anonymous Event");
            publisher12345.Click +=
                createEventHandler((s, a) => Console.WriteLine(String.Format("Anonymous Subscriber Called (subscribed to {0})", publisher12345.Id)), isWake);

            waitAndWrite("+------ Raising Publisher's Events");
            publisher12345.OnClick();

            waitAndWrite("+------ Publisher not yet used by application. GC called");
            publisher12345 = null;
            garbageCollect();

            waitAndWrite("+--- ***Publisher Creation (67890)***");
            var publisher67890 = new Publisher("67890");

            waitAndWrite("+------ Publisher Registration Event in other Class");
            var subscriber67890 = new Subscriber();
            publisher67890.Click += createEventHandler(subscriber67890.Handler, isWake);

            waitAndWrite("+------ Raising Publisher's Events");
            publisher67890.OnClick();

            waitAndWrite("+------ Subscriber not yet used by application. GC called\r\n+------ [!!!LEAK HERE IF NOT WEAK!!!] (PUBLISHER MANTAINES IN LIFE ALL ITS SUBSCRIBERS)");
            subscriber67890 = null;
            garbageCollect();

            waitAndWrite("+------ Publisher not yet used by application. GC called");
            publisher67890 = null;
            garbageCollect();

            waitAndWrite("+--- End");
        }

        private static void waitAndWrite(string text)
        {
            Console.ReadLine();
            Console.WriteLine(text);
        }

        private static void garbageCollect()
        {
            GC.Collect();
            GC.WaitForPendingFinalizers();
            GC.Collect();
        }

        private static EventHandler createEventHandler(EventHandler action, bool isWake)
        {
            return isWake ? action.ToWeak() : action;
        }
    }

L’output prodotto a video dai test è il seguente:

+ TEST 1: WITHOUT WakeEventHandler

+--- ***Subscriber Creation***

+------ Holding the Subscriber's Handler

+------ Raising Subscriber Event
Handler called

+------ Subscriber not yet used by application. GC called
+------ [!!!LEAK HERE IF NOT WEAK!!!] (CLASSES MANTAINES IN LIFE ALL CLASSES'S D
ELEGATE)

+------ Raising Subscriber Event Again
Handler called

+------ Handler not yet used by application. GC called
Subscriber Cleaned

+--- ***Publisher Creation (12345)***

+------ Publisher Registration Anonymous Event

+------ Raising Publisher's Events
Anonymous Subscriber Called (subscribed to 12345)

+------ Publisher not yet used by application. GC called
Publisher Cleaned

+--- ***Publisher Creation (67890)***

+------ Publisher Registration Event in other Class

+------ Raising Publisher's Events
Handler called

+------ Subscriber not yet used by application. GC called
+------ [!!!LEAK HERE IF NOT WEAK!!!] (PUBLISHER MANTAINES IN LIFE ALL ITS SUBSC
RIBERS)

+------ Publisher not yet used by application. GC called
Subscriber Cleaned
Publisher Cleaned

+--- End

+ TEST 2: WITH WakeEventHandler

+--- ***Subscriber Creation***

+------ Holding the Subscriber's Handler

+------ Raising Subscriber Event
Handler called

+------ Subscriber not yet used by application. GC called
+------ [!!!LEAK HERE IF NOT WEAK!!!] (CLASSES MANTAINES IN LIFE ALL CLASSES'S D
ELEGATE)
Subscriber Cleaned

+------ Raising Subscriber Event Again

+------ Handler not yet used by application. GC called
WeakEventHandler Cleaned

+--- ***Publisher Creation (12345)***

+------ Publisher Registration Anonymous Event

+------ Raising Publisher's Events
Anonymous Subscriber Called (subscribed to 12345)

+------ Publisher not yet used by application. GC called
WeakEventHandler Cleaned
Publisher Cleaned

+--- ***Publisher Creation (67890)***

+------ Publisher Registration Event in other Class

+------ Raising Publisher's Events
Handler called

+------ Subscriber not yet used by application. GC called
+------ [!!!LEAK HERE IF NOT WEAK!!!] (PUBLISHER MANTAINES IN LIFE ALL ITS SUBSC
RIBERS)
Subscriber Cleaned

+------ Publisher not yet used by application. GC called
WeakEventHandler Cleaned
Publisher Cleaned

+--- End

Si noti un aspetto importante: se abbiamo 99 subscriber, la chiusura delle 99 window dei subscriber non deregistra i 99 handler dell’evento nel publisher, semplicemente i 99 handler ora punteranno a un reference ormai deallocato, ma continueranno a esistere. Perciò un leggerissimo memory leak permane e a livello computazionale il sistema continuerà ancora a gestire 99 handler. Ma la struttura dei subscriber viene deallocata correttamente ed è ciò che conta, poiché sarà il memory leak “vero” da gestire.

Infine bisogna notare che l’implementazione può essere notevolmente raffinata e resa generica come indicato nell’articolo di Greg Schechter applicando reflection o lambda expression, ma questo può causare rallentamenti di performance che secondo me devono essere giustificati dalla necessità effettiva di rendere l’approccio generico.

Posted in .net, performance | 2 Comments »

Memory Leak con Garbage Collection: WeakReference

Posted by Ricibald on 27th November 2009

Come tutti sapete, la GC è una modalità automatica di gestione della memoria tramite cui vengono liberate porzioni non più referenziate. In questo modo il programmatore non si deve più preoccupare di deallocare esplicitamente gli oggetti e si evitano i tipici problemi legati alla gestione della memoria (dangling pointer e memory leak).

Se per memory leak intendiamo il mancato rilascio di memoria non più referenziata allora il GC effettivamente evita qualunque memory leak, ma se per memory leak intendiamo il mancato rilascio di memoria non più utilizzata, allora la GC non è sufficiente: non può conoscere le nostre intenzioni!!

Ora mi spiegherò meglio, ma è necessario prima notare una cosa importante: il problema che descriverò è generale per la GC, ma non significa che implementazioni più raffinate non abbiano risolto il problema. Infatti implementazioni C# o Java non prevedono questo problema, ma si noti anche che, per quanto raffinata sia l’implementazione della GC, questi errori non potranno mai essere completamente impediti, quindi è necessario un approccio consapevole alle tematiche.

Dunque mi spiego meglio: immaginiamo di avere un oggetto che rappresenta la struttura di una società. Avremo quindi una lista di dipendenti, di cui ognuno avrà un superiore (se esiste) e avrà dei dipendenti da coordinare (se non si trova all’ultimo gradino). Di seguito riporto un esempio di istanza dopo il suo utilizzo:

Come osserviamo l’applicazione dopo aver utilizzato la struttura, ora ha ormai perso il riferimento a qualunque dipendente. Sarebbe lecito aspettarsi che gli oggetti vengano deallocati in quanto non più utilizzati. Infatti “Riccardo” non viene più usato da nessuno e quindi deve essere deallocato sé stesso e tutti i dipendenti che referenzia in quanto a loro volta perdono il riferimento “Riccardo”.

Bene, questo non è così!!! I nostri dipendenti rimarranno allocati per sempre nella nostra applicazione, sebbene nessuno li utilizzi più! Questo può essere definito come vero e proprio memory leak, anche se devia leggermente dal significato originale.

La presenza di memory leak dipende da come realizziamo la classe “Dipendente”. Andiamo per gradi: nel seguente esempio NON avviene alcun memory leak:

public class Dipendente {
	public List<Dipendente> Subordinati = new List<Dipendente>();
}

Infatti se l’applicazione perde il riferimento ai dipendenti, il primo che verrà deallocato è il capo “Riccardo” poiché non ha più alcun riferimento. Successivamente verrà deallocata la List poiché non ha più riferimenti e in seguito verranno deallocati tutti e tre i dipendenti referenziati precedentemente dalla lista. Quindi in questo caso non avremo alcun memory leak. Osserviamo invece il seguente caso:

public class Dipendente {
    public Dipendente Superiore;
	public List<Dipendente> Subordinati = new List<Dipendente>();
	public Dipendente(Dipendente superiore) {
	   this.Superiore = superiore;
	}
}

In questo caso vogliamo mantenere per comodità anche un riferimento al superiore di ogni dipendente. Ma analizziamo stavolta cosa succede nel caso in cui l’applicazione non fa più riferimento ai dipendenti. Il capo “Riccardo” dovrebbe essere il primo candidato all’eliminazione, ma non può essere eliminato poiché i tre subordinati mantengono un riferimento. Viceversa, i tre subordinati non possono essere eliminati poiché il capo ne mantiene il riferimento tramite la lista. Questo significa che la struttura non verrà MAI deallocata!! Memory leak!! Una definizione più formale:

Groups of mutually referencing objects which are not directly referenced by other objects and are unreachable can thus become permanently resident; if an application continually generates such unreachable groups of unreachable objects this will have the effect of a memory leak. Weak references may be used to solve the problem of circular references if the reference cycles are avoided by using weak references for some of the references within the group.

In molti articoli come http://www.ibm.com/developerworks/library/j-leaks/index.html o http://blogs.msdn.com/davidklinems/archive/2005/11/16/493580.aspx spesso si risolvono questi problemi eliminando i riferimenti che causerebbero il memory leak adottando soluzioni del tipo:

public class Dipendente : IDisposable {
    public Dipendente Superiore;
	public List<Dipendente> Subordinati = new List<Dipendente>();
	public Dipendente(Dipendente superiore) {
	   this.Superiore = superiore;
	}
	
	public void Dispose() {
	   foreach(Dipendente subordinato in this.Subordinati) {
	       subordinato.Superiore = null;
	   }
	}
}

public class Application {
    static void main() {
	   using(Dipendente riccardo = new Dipendente(null)) {
	       riccardo.Superiori.Add(new Dipendente(riccardo));
		   riccardo.Superiori.Add(new Dipendente(riccardo));
		   riccardo.Superiori.Add(new Dipendente(riccardo));
	   } // esegue la dispose
	   // perde il riferimento
	}
}

Sinceramente non mi piace l’approccio di “ricordarsi” lo using: troverete ovunque forum del tipo “avete memory leak? La colpa è tua che non fai la dispose degli oggetti Drawing!”. Cosa?? La colpa è mia??? No, le cose non stanno così: chi scrive la libreria non deve caricare agli utilizzatori di dettagli che possono causare problemi!!

La soluzione esiste ed è molto semplice: bisogna pensare i riferimenti a oggetti in termini di POSSESSO (OWNERSHIP). Possiedo, e quindi ho diritto di vita e morte, dell’oggetto a cui mi sto riferendo? Se sì, utilizza un normale riferimento come hai sempre fatto (Strong Reference). Altrimenti usa un WeakReference. Cosa è un WeakReference? Semplicemente è un riferimento debole a un oggetto, che ha validità fin quando esistono Strong Reference che mantengono in vita l’oggetto. Risulta comodo vedere le cose in termini di composizione UML: tutte le composizioni sono Strong Reference, altrimenti sono WeakReference.

Si noti un aspetto importante: queste sono regole generali di buona programmazione che si applicano a prescindere dalla implementazione della GC. Infatti linguaggi come C# o Java la GC elimina riferimenti non più utilizzati dal contesto di esecuzione corrente: eventuali riferimenti circolari isolati saranno quindi eliminati. Questo significa quindi che riferimenti circolari causati nel contesto di esecuzione corrente provocano lo stesso identico problema descritto. Un esempio semplice? La nostra applicazione mantiene un riferimento all’ultimo studente selezionato, lo eliminiamo ma non verrà mai cancellato poiché mantenuto dalla app.

Per evitare quindi memory leak in modo corretto e senza impatti sugli utilizzatori della nostra classe dovremo scrivere:

[
public class Dipendente {
    private WeakReference<Dipendente> _superioreWeak;
    public Dipendente Superiore { get { return _superioreWeak.Target; } }
	public List<Dipendente> Subordinati = new List<Dipendente>();
	
	public Dipendente(Dipendente superiore) {
	   this._superioreWeak =  new WeakReference<Dipendente>(superiore);
	}
}

public class Application {
    static void main() {
	   Dipendente riccardo = new Dipendente(null);
	   riccardo.Superiori.Add(new Dipendente(riccardo));
	   riccardo.Superiori.Add(new Dipendente(riccardo));
	   riccardo.Superiori.Add(new Dipendente(riccardo));
	} // perde il riferimento
}

I WeakReference risultano quindi molto utili per impedire memory leak causati da riferimenti circolari. Utilizzi tipici sono situazioni composite con riferimento al padre o situazioni di caching, in cui tramite un weak hash map vengono memorizzati gli oggetti senza impedirne la deallocazione (altrimenti nella cache vivrebbero oggetti per sempre!!). Una buona regola è comunque utilizzare un tool per la rilevazione di memory leak, come CLR Profiler.

Posted in .net, design, java, performance | 6 Comments »