Avoiding implicit try finally section

This is an old revision of Avoiding implicit try finally section, edited by HowardPC at . The current revision is 30014.

minor rephrasing for clarity

Overview

When optimizing code it helps to know that the compiler will wrap certain code constructs in an implicit try ... finally block. This is needed whenever you use variables such as ansistrings, variants or dynamic arrays which require initialization and finalization (i.e. where the standard procedures Initialize() and Finalize() are needed for correct allocation/deallocation of the memory used).

E.g. a procedure like

procedure P;
var 
  S: AnsiString;
begin
  ... do something with S ...
end;

is actually expanded by the compiler to look like this:

procedure P;
var 
  S: AnsiString;
begin
 Initialize(S);
 try
  ... do something with S ...
 finally Finalize(S) end;
end;

The compiler thereby ensures that the reference count of S will be properly decremented when procedure P exits with exception(s). However, often this can significantly affect the speed of given code adversely.

Here's a link to archived discussion on the fpc-devel list regarding this issue, with the subject "TList slowness in classes" : http://www.mail-archive.com/fpc-devel@lists.freepascal.org/msg01367.html

Note that temporary ansistring variables can be created implicitly. The only way to be completely sure what's going on is to read the assembler output.

Possible solutions

Risks and when to apply

These exception frames are generated for a reason. If you leave them out any exception in that code will leave a memory leak

In 2007 $implicitexceptions was added to the strutils unit. Meanwhile, sysutils has probably followed (to do: verify). For this, the following approach was followed:

If you detect problems with these changes please contact Marco.

Demo program

Below is a small demo program that

Time of Foo_Normal: 141
Time of Foo_Faster: 17
{$mode objfpc}{$H+}

uses
  {BaseUnix, Unix needed only to implement Clock} BaseUnix, Unix,
  SysUtils;

function Clock: Int64;
var Dummy: tms;
begin
 Clock := FpTimes(Dummy);
end;

procedure Foo_Normal(i: Integer);
var S: string;
begin
 if i = -1 then
 begin
  S := 'Some operation with AnsiString';
  raise Exception.Create(S);
 end;
end;

procedure Foo_Faster(i: Integer);

  procedure RaiseError;
  var S: string;
  begin
   S := 'Some operation with AnsiString';
   raise Exception.Create(S);
  end;

begin
 if i = -1 then RaiseError;
end;

{ Note that when I call Foo_Normal and Foo_ResourceString
  i is always >= 0 so Exception is never actually raised.
  So string constants SNormal and SResString are not really used. }

const
  TestCount = 10000000;
var
  i: Integer;
  Start: Int64;
begin
 Start := Clock;
 for i := 0 to TestCount do Foo_Normal(i);
 Writeln('Time of Foo_Normal: ', Clock - Start);

 Start := Clock;
 for i := 0 to TestCount do Foo_Faster(i);
 Writeln('Time of Foo_Faster: ', Clock - Start);
end.