Difference between revisions of "Multithreaded Application Tutorial/de"

From Lazarus wiki
m (Worauf Sie achten sollten: typos, language)
m (Für Multithread-Anwendungen benötigte Units: typos, language)
Line 223: Line 223:
 
= Für Multithread-Anwendungen benötigte Units =
 
= Für Multithread-Anwendungen benötigte Units =
 
Unter Windows benötigen sie keine spezielle Unit, damit es funktioniert.
 
Unter Windows benötigen sie keine spezielle Unit, damit es funktioniert.
Unter Linux, MacOSX und FreeBSD benötigen sie die cthreads Unit und diese ''muss'' die erste verwendete Unit im Projekt sein (die Programm-Unit, .lpr)!
+
Unter Linux, MacOSX und FreeBSD benötigen sie die Unit cthreads und diese ''muss'' die erste verwendete Unit im Projekt sein (die Programm-Unit, .lpr)!
  
Daher sollte der Code ihrer Lazarus Anwendung etwa so aussehen:
+
Daher sollte der Code ihrer Lazarus-Anwendung etwa so aussehen:
  
 
   program MyMultiThreadedProgram;
 
   program MyMultiThreadedProgram;

Revision as of 11:23, 1 July 2007

Deutsch (de) English (en) español (es) français (fr) 日本語 (ja) polski (pl) português (pt) русский (ru) slovenčina (sk) 中文(中国大陆)‎ (zh_CN)

Überblick

Diese Seite soll zeigen, wie man unter FreePascal und Lazarus Multithread-Anwendungen erstellt und verwaltet. In einer Multithread-Anwendung lassen sich verschiedene Aufgaben auf mehrere Threads verteilen, die gleichzeitig ausgeführt werden können.

Wenn Sie bisher keinerlei Erfahrungen zur Multithread-Programmierung gemacht haben, empfehlen wie Ihnen, sich zunächst den Artikel "Benötigt Ihre Anwendung wirklich Multithread-Eigenschaften?" sorgfältig durch zu lesen, da Multithread-Programmierung kein leichtes Unterfangen ist.

Das Hauptziel der Multithread-Programmierung ist die Verfügbarkeit der Benutzeroberfläche eines Programms, während es im Hintergrund Berechnungen durchführt. Dies kann man erreichen, indem man die Berechnung in einen Thread außerhalb des sogenannten Main-Thread verlagert, welcher für die Aktualisierung der Benutzeroberfläche zuständig ist.

Andere Anwendungen, bei denen Multithread-Programmierung zum Einsatz kommt, sind Server-Anwendungen, die mehrere Klienten gleichzeitig betreuen müssen.

Multithread-Anwendungen ermöglichen auch die Aufteilungen der Lasten einer Berechnung auf mehrere Kerne einer Multi-Core-CPU.

Wichtig: Der Main Thread wird beim Start Ihrer Anwendung vom Betriebssystem erstellt. Der Main Thread ist dabei der einzige Thread (und muss auch der einzige bleiben), der für die Aktualisierung der Komponenten der Benutzeroberfläche zuständig ist (Forms, etc.) (ansonsten hängt sich Ihre Anwendung auf).

Benötigt Ihre Anwendung wirklich multithread-Eigenschaften?

Wenn Multithread Programmierung für sie Neuland ist und sie lediglich eine bessere Reaktionsfähigkeit ihrer Anwendung wärend langer Berechnungen benötigen, dann ist Multithreading nicht unbedingt die einfachste Lösung. Multithreading Applikationen sind immer schwieriger zu debuggen und auch oft viel komplexer. Ausserdem benötigen Sie in vielen Fällen kein Multithreading, um ihre Anwendung reaktionsfähig zu halten. Statt dessen können Sie ein Application.ProcessMessages in ihre Berechnungen mit einbauen. Dieses verarbeitet alle anstehenden Narichten, die an ihre Applikation gesendet wurden und Ihre Applikation reagiert auf Ereignisse. Sie können also einen Teil der Berechnung durchführen, dann Application.ProcessMessages aufrufen und die Benutzereingaben werden verarbeitet und die Oberfläche neu gezeichent. Platzieren sie das Application.Processmessages z.B. in Schleifen, so dass bei jedem Schleifendurchlauf die Benutzeroberfläche reagiert.

Zum Beispiel: In den Lazarus Beispielen unter examples/multithreading/singlethreadingexample1.lpi wird eine große Datei gelesen und verarbeitet und die oben genannte Technik benutzt.

Multithreading wird wirklich benötigt für:

  • blocking handles, wie network communications
  • Mehrprozessor- oder Mehrkernbetrieb
  • Algorithmen und Bibliotheksaufrufe, die nicht in mehrere kleine Stufen zerteilt werden können.

Die Klasse TThread

Das folgende Beispiel ist im Verzeichnis examples/multithreading/ zu finden. Der einfachste Weg, um eine Multithread-Anwendung zu erstellen, ist die Verwendung der Klasse TThread. Über diese Klasse lässt sich, neben dem Main-Thread, ein zusätzlicher Thread in einfacher Weise erstellen. Unter normalen Umständen müssen dazu bloß zwei Methoden überschrieben (override) werden: Der Konstruktor Create und die Methode Execute. Im Konstruktor Create wird der Thread für die spätere Ausführung vorbereitet. Hier werden die dem Thread zugrunde liegenden Variablen initialisiert. Der originale Konstruktor des Threads enthält einen Parameter namens "Suspended": Damit der Thread nicht automatisch nach seiner Erstellung gestartet wird, ist es empfehlenswert, diesen Parameter auf "true" zu setzen. In diesem Fall können Sie den Thread zu einem späteren Zeitpunkt über die Methode "Resume" starten. Ist es dagegen erwünscht, dass der Thread direkt nach seiner Erstellung startet, setzen Sie Suspended auf "false".

Ab der Version 2.0.1 des FreePascal-Compilers lässt sich auch die Größe des von einem Thread verwendeten Stacks über einen Parameter des Konstruktor TThread.Create einstellen. Das kann beispielsweise bei rekursiven Prozeduren oder Funktionen nützlich sein. Wird die Größe des Stack nicht explizit festgelegt, verwendet FPC die vom Betriebssystem festgelegte Standardgröße.

In die (mit Parameter Override) überschriebene Methode Execute schreibt man den vom Thread auszuführenden Quelltext hinein.

Die Klasse TThread besitzt die wichtige Eigenschaft (property): Terminated : boolean; (Standardeinstellung: Terminated=false)

Der Sinn der Eigenschaft Terminated ist, dass sich ein Thread damit zu einem beliebigen Zeitpunkt abbrechen lässt. Jedoch muss dies von dem Programmierer in den Quelltext der Methode Execute eingearbeitet werden - die Methode Terminate greift also nicht direkt in den vom Programmierer vorgesehenen Programmablauf ein. Sollten sich in Ihrem Thread also Repeatschleifen oder andere sich wiederholende Stellen finden, ist es deshalb notwendig, dass Sie in jeder Schleife explizit prüfen, ob die Eigenschaft Terminated wahr oder falsch ist. Sollte Terminated=true sein, muss die Methode Execute (ev. nach einer finalen Konfiguration) auf schnellstem Wege verlassen werden.

Wie eingangs erwähnt, sollte der erstellte Thread in keinem Fall mit den sichtbaren Komponenten der Benutzeroberfläche agieren. Die Benutzeroberfläche verändern, Eingaben abfragen, etc. darf ausschließlich der Main-Thread.

Um trotzdem aus einem Thread heraus auf die Benutzeroberfläche bzw Variablen des Hauptprogrammes zuzugreifen, existiert die Methode Synchronize. Synchronize wird mit einer procedure als Parameter aufgerufen. Wenn Sie Synchronize(@MyMethod) aufrufen, wird der Thread gestoppt, der Code in MyMethod wird im Hauptthread ausgeführt, und dann die Bearbeitung des Threads fortgesetzt. Die exakte Arbeitsweise von Synchronize hängt von der Plattform ab.

Eine andere wichtige Eigenschaft (property) von TThread ist FreeOnTerminate. Wenn diese Eigenschaft auf True gesetzt ist, wird der Thread automatisch freigegeben (wie ein Aufruf von .Free), wenn Execute beendet wird. Beispiel:

 Type
   TMyThread = class(TThread)
   private
     fStatusText : string;
     procedure ShowStatus;
   protected
     procedure Execute; override;
   public
     Constructor Create(CreateSuspended : boolean);
   end;
 constructor TMyThread.Create(CreateSuspended : boolean);
 begin
   FreeOnTerminate := True;
   inherited Create(CreateSuspended);
 end;
 procedure TMyThread.ShowStatus;
 // Diese Methode wird vom MainThread ausgeführt und kann deshalb auf alle GUI Elemente zugreifen
 begin
   Form1.Caption := fStatusText;
 end;

 procedure TMyThread.Execute;
 var
   newStatus : string;
 begin
   fStatusText := 'TMyThread Starting...';
   Synchronize(@Showstatus);
   fStatusText := 'TMyThread Running...';
   while (not Terminated) and ([any condition required]) do
     begin
       ...
       [here goes the code of the main thread loop]
       ...
       if NewStatus <> fStatusText then
         begin
           fStatusText := newStatus;
           Synchronize(@Showstatus);
         end;
     end;
 end;

On the application,

 var
   MyThread : TMyThread;
 begin
   MyThread := TMyThread.Create(True); // So startet es nicht automatisch
   ...
   [Here the code initialises anything required before the threads starts executing]
   ...
   MyThread.Resume;
 end;

Soll ihr Programm flexibler sin, können sie ein Ereignis für den Thread erzeugen - Ihr synchronisierte Methode ist dann nicht eng an eine bestimmte Form oder Klasse gebunden und Listeners können mit dem Ereignis des Threads verbunden werden. Hier ein Beispiel:

 Type
   TShowStatusEvent = procedure(Status: String) of Object;
   TMyThread = class(TThread)
   private
     fStatusText : string;
     FOnShowStatus: TShowStatusEvent;
     procedure ShowStatus;
   protected
     procedure Execute; override;
   public
     Constructor Create(CreateSuspended : boolean);
     property OnShowStatus: TShowStatusEvent read FOnShowStatus write FOnShowStatus;
   end;
 constructor TMyThread.Create(CreateSuspended : boolean);
 begin
   FreeOnTerminate := True;
   inherited Create(CreateSuspended);
 end;
 procedure TMyThread.ShowStatus;
 // Diese Methode wird vom MainThread ausgeführt und kann deshalb auf alle GUI Elemente zugreifen
 begin
   if Assigned(FOnShowStatus) then
   begin
     FOnShowStatus(fStatusText);
   end;
 end;
 procedure TMyThread.Execute;
 var
   newStatus : string;
 begin
   fStatusText := 'TMyThread Starting...';
   Synchronize(@Showstatus);
   fStatusText := 'TMyThread Running...';
   while (not Terminated) and ([any condition required]) do
     begin
       ...
       [here goes the code of the main thread loop]
       ...
       if NewStatus <> fStatusText then
         begin
           fStatusText := newStatus;
           Synchronize(@Showstatus);
         end;
     end;
 end;

On the application,

 Type
   TForm1 = class(TForm)
     Button1: TButton;
     Label1: TLabel;
     procedure FormCreate(Sender: TObject);
     procedure FormDestroy(Sender: TObject);
   private
     { private declarations }
     MyThread: TMyThread; 
     procedure ShowStatus(Status: string);
   public
     { public declarations }
   end;
 procedure TForm1.FormCreate(Sender: TObject);
 begin
   inherited;
   MyThread := TMyThread.Create(true);
   MyThread.OnShowStatus := @ShowStatus;
 end;
 procedure TForm1.FormDestroy(Sender: TObject);
 begin
   MyThread.Terminate;
   MyThread.Free;
   inherited;
 end;
 procedure TForm1.Button1Click(Sender: TObject);
 begin
  MyThread.Resume;
 end;
 procedure TForm1.ShowStatus(Status: string);
 begin
   Label1.Caption := Status;
 end;

Worauf Sie achten sollten

Wenn sie den Compilerswitch -St (Stack Check) benutzen, kann das einige Probleme mit sich bringen (Original Übersetzung : Es könnte ihnen Kopfschmerzen bereiten :)) Aus unbekannten Gründen "triggert" der Stack Check an jedem TThtead.Create, wenn sie die Standardgröße des Stacks benutzen. Die einzige Lösung ist zur Zeit, -St nicht zu benutzen.

Um auf Exceptions im Thread zu prüfen, können Sie folgendermassen vorgehen:

    MyThread:=TThread.Create(False);
    if Assigned(MyThread.FatalException) then
      raise MyThread.FatalException;


Dieser Code löst die selbe Exception des Threads in ihrem Hauptprogramm aus.

Für Multithread-Anwendungen benötigte Units

Unter Windows benötigen sie keine spezielle Unit, damit es funktioniert. Unter Linux, MacOSX und FreeBSD benötigen sie die Unit cthreads und diese muss die erste verwendete Unit im Projekt sein (die Programm-Unit, .lpr)!

Daher sollte der Code ihrer Lazarus-Anwendung etwa so aussehen:

 program MyMultiThreadedProgram;
 {$mode objfpc}{$H+}
 uses
 {$ifdef unix}
   cthreads,
 {$endif}
   Interfaces, // dies bindet das LCL Widgetset ein
   Forms
   { fügen sie ihre Units hier hinzu },

Wenn Sie dies vergessen, kommt die folgende Fehlermeldung:

 This binary has no thread support compiled in.
 Recompile the application with a thread-driver in the program uses clause before other units using thread.

SMP (Mehrprozessor) Unterstützung

Sobald sie Threads benutzen werden diese vom Betriebsystem über mehrere Prozessoren verteilt.

Debuging Multithread-Anwendungen mit Lazarus

Das Debuggen von Anwendungen wird von Lazarus zur Zeit noch nicht vollständig unterstützt.

Debugger Ausgabe

In einer Applikation mit einem Thread (dem Hauptthread), können Sie einfach auf die Konsole in ein Teminal oder ähnliches schreiben und die Reihenfolge der zeilen wird Chronologisch so angeordnet sein wie Sie es ausgegeben haben. In Multithreaded Anwendungen wird dies etwas komplizierter. Wenn 2 Threads schreiben, Sagen wir eine Zeile wird von Thread A und eine von Thread B geschrieben, dann ist es nicht gesagt das sie zeitlich in der richtigen Reihenfolge erscheinen bzw kann es vorkommen das ein Thread dem anderen in die Ausgabe hineinschreibt.

Die Unit LCLProc enthält einige Funktionen, um jeden Thread sein eigenes Logfile schriebn zu lassen:

 procedure DbgOutThreadLog(const Msg: string); overload;
 procedure DebuglnThreadLog(const Msg: string); overload;
 procedure DebuglnThreadLog(Args: array of const); overload;
 procedure DebuglnThreadLog; overload;

Zum Beispiel: Anstelle von writeln('irgendein Text ',123); verwenden sie

 DebuglnThreadLog(['irgendein Text ',123]);

Dies wird eine Zeile 'irgendein Text 123' an die Log<PID>.txt Datei anhängen, wobei <PID> die Prozess ID des aktuellen Threads ist.

Es ist eine gute Idee, die Logdateien vor jedem Lauf zu entfernen:

 rm -f Log* && ./project1

Linux

Aufgrund von Kompatibilitätsproblemen treten unter Linux beim debuggen von Programmen Probleme mit dem X-Server auf: Er stürtzt ab.

Zwar ist derzeit ist keine saubere Lösung dieses Problems bekannt, jedoch wollen wir hier einen provisorischen Weg beschreiben, das Problem zu umgehen:

Starten Sie eine neue X-Instanz. Dies können Sie über die Konsole mit folgendem Befehl erreichen:

 X :1 &

Nachdem Sie diesen Befehl ausgeführt haben, öffnet sich die neue X-Instanz. Mit den Tastenkombinationen [Strg]+[Alt]+[F7] und [Strg]+[Alt]+[F8] können Sie nun zwischen der Arbeitsoberfläche, auf der Sie arbeiten, und der neuen Instanz hin und her wechseln. (Bei der Slackware-Distribution und wenigen anderen wird dies durch die Kombination [Strg]+[Alt]+[F2] erreicht)

Als nächsten Schritt müssen Sie eine Desktop-Sitzung in der neuen X-Instanz starten. Dafür geben Sie beispielsweise für eine gnome-Sitzung in die Konsole ein:

 gnome-session --display=:1 &

Schließlich müssen Sie eine letzte Einstellung in Lazarus selbst vornehmen: Gehen Sie in der IDE in das Menü "Start"->"Start-Parameter...". Aktivieren Sie dort das Häckchen "Display verwenden", und tragen Sie in das Feld darunter die Zuordnungsnummer ":1" ein.


Jetzt wird die Anwendung auf dem zweiten X Server laufen und sie sind in der Lage, sie auf dem ersten zu debuggen.

Dies wurde getestet mit Free Pascal 2.0 und Lazarus 0.9.10 unter Windows und Linux.

Widgetsets

Die win32, gtk und carbon Schnittstellen unterstützen multithreading vollständig. This means, TThread, critical sections and Synchronize work.

Critical sections

Eine critical section (kritischer Abschnitt) stellt sicher, dass in einer multi-thread Anwendung nicht gleichzeitig von verschiedenen Threads aus auf einen bestimmten Bereich des Codes zugegriffen wird. Bevor eine critical section benutzt werden kann, muss sie erstellt und initialisiert werden; wenn sie nicht mehr gebracht wird, muss sie freigegeben werden.

Zur Verwendung von critical sections gehen Sie wie folgt vor:

Fügen Sie über uses die Unit SyncObjs hinzu, die die notwendigen Routinen beinhaltet.

Als nächsten Schritt deklarieren Sie die critical section (für alle Threads, die auf die section Zugriff haben sollen):

 MyCriticalSection: TRTLCriticalSection;

Erstellen Sie die Section mit folgender Prozedur:

 InitializeCriticalSection(MyCriticalSection);


Run some threads. Doing something exclusively

 EnterCriticalSection(MyCriticalSection);
 try
   // An dieser Stelle können Sie auf Variablen zugreifen, Dateien schreiben, auf das Netzwerk zugreifen, u.s.w.
 finally
   LeaveCriticalSection(MyCriticalSection);
 end;

Nachdem alle Threads, die Zugriff auf die critical section hatten, beendet wurden, müssen Sie sie nun deinitialisieren:

 DeleteCriticalSection(MyCriticalSection);

Alternativ können Sie die Klasse TCriticalSection benutzen. Das Erstellen eines Objektes der Klasse entspricht hier der Initialisierung, die Methode Enter entspricht obigem EnterCriticalSection, die Methode Leave entspricht der obigen LeaveCriticalSection und die Vernichtung (destruction) des Objektes erledigt das freigeben.

Beispiel: 5 Threads, die einen einzigen Zähler erhöhen: lazarus/examples/multithreading/criticalsectionexample1.lpi

ACHTUNG: Sowohl die RTL als auch die LCL beinhalten beide obige 4 Funktionen. (Die Funktionen der LCL sind in den Units LCLIntf und LCLType definiert.) Beide erfüllen den gleichen Zweck. Sie können sowohl die Funktionen der RTL als auch die Funktionen der LCL zur selben Zeit in Ihrem Programm einsetzen. Sie sollten es nur vermeiden, die "critical section"-Funktionen der LCL auf die Funktionen der RTL anzuwenden und umgekehrt.


Sharing Variables

If some threads share a variable, that is read only, then there is nothing to worry about. Just read it. But if one or several threads changes the variable, then you must make sure, that only one thread accesses the variables at a time.

For example: 5 threads incrementing a counter. See lazarus/examples/multithreading/criticalsectionexample1.lpi

Wenn ein Thread das Ergebnis eines anderen benötigt...

Wenn ein Thread A das Ergebnis eines Threads B benötigt, muss er warten, bis B fertig ist.

Wichtig: Der Main-Thread sollte niemals auf einen anderen Thread warten müssen. Für diesen Fall benutzen Sie am Besten Synchronize (oben beschrieben).

Beispiel: lazarus/examples/multithreading/waitforexample1.lpi

{ TThreadA }

procedure TThreadA.Execute;
begin
  Form1.ThreadB:=TThreadB.Create(false);
  // create event
  WaitForB:=RTLEventCreate;
  while not Application.Terminated do begin
    // wait infinitely (until B wakes A)
    RtlEventWaitFor(WaitForB);
    writeln('A: ThreadB.Counter='+IntToStr(Form1.ThreadB.Counter));
  end;
end;

{ TThreadB }

procedure TThreadB.Execute;
var
  i: Integer;
begin
  Counter:=0;
  while not Application.Terminated do begin
    // B: Working ...
    Sleep(1500);
    inc(Counter);
    // wake A
    RtlEventSetEvent(Form1.ThreadA.WaitForB);
  end;
end;