SJ MMF File Reader 0.2 - Schneller Textdatei Reader

[jaenicke]

Hallo!

Diese Unit stellt eine Klasse zum schnellen zeichenweisen sequentiellen Auslesen von Textdateien bereit. Dabei werden Memory Mapped Files benutzt, so dass der entsprechende Teil der Datei zuerst in den Arbeitsspeicher eingeblendet wird.
Die Buffergröße ist entsprechend der eigenen Anforderungen einstellbar.

Derzeit wird nur das Auslesen von Strings mit einem festlegbaren Delimiterzeichen unterstützt, aber ich werde noch das Auslesen anderer Datentypen usw. implementieren.

Eine Demo ist mit im Download enthalten, dort wird auch auf Wunsch die Geschwindigkeit gemessen. Dabei komme ich hier bei mir auf ca. 84 MiB/s, also schon eine extrem hohe Geschwindigkeit:
Anhang 31242

Features:

• Schnelles Lesen von Strings via ReadLn
• Festlegen des gewünschten Delimiters
• Destlegen der Buffergröße zur besseren Anpassung an eigene Daten
• Delphi 2009 und 2010 Unterstützung inkl. Unicodedateien *neu*

Lizenz:
MPL 1.1 oder GPL 2.0 oder LGPL 2.1

Installation:
Die Unit muss entweder in den Bibliothekspfad aufgenommen oder dem Projekt hinzugefügt werden, damit die Unit über die uses-Klausel eingebunden werden kann. Dann genügt es das Objekt zu erstellen und damit zu arbeiten:

Delphi-Quellcode:

var
  FileReader: TSJMmfFileReader;
begin
  FileReader := TSJMmfFileReader.Create(edtFileName.Text);
  try
    while FileReader.Position < FileReader.Size do
    begin
      FileReader.Readln(CurrentReadString);
      // ...
    end;
  finally
    FileReader.Free;
  end;

Unterstützte Delphiversionen:
Delphi 6, 7, 2006, 2010
(andere nicht getestet, aber es sollte ab Delphi 6 überall gehen)

Unterstützte Windowsversionen:
Windows 2000, XP, Vista und 7

Weitere Planung:

• Weitere Datentypen hinzufügen
• Direkter Zugriff auf den Speicherbereich

Bekannte Probleme:

• keine

Ich habe die Unit auch hier vorgestellt:
http://www.delphi-forum.de/viewtopic...=607865#607865
http://forum.delphi-treff.de/showthr...333#post210333

Schönen Gruß,
Sebastian

[himitsu]

Beim .Free gibst du die MMF-Handles/Pointer nicht mit frei.
Diese bleiben aktiv/nutzbar, selbst wenn man das FileHandle schließt.

Ab Delphi 2009 könnte/wird es einige Probleme mit deinen PChars geben.


PS:

Delphi-Quellcode:

SetString(AValue, nil, LineLen);
CopyMemory(PChar(AValue), StartPointer, LineLen);
// aka
SetLength(AValue, LineLen);
CopyMemory(PChar(AValue), StartPointer, LineLen);

// entspricht
SetString(AValue, StartPointer, LineLen);

[jaenicke]

Zitat:

Zitat von himitsu (Beitrag 1025936)

Beim .Free gibst du die MMF-Handles/Pointer nicht mit frei.

:oops: Und das mir...
Danke, ich habe es korrigiert (neue Version liegt oben).

Zitat:

Zitat von himitsu (Beitrag 1025936)

Ab Delphi 2009 könnte/wird es einige Probleme mit deinen PChars geben.

Deshalb steht da ja auch, dass nur Delphi 2006 unterstützt wird. Denn bei Unicode schummele ich ja ganz schön, da ich nur die Ascii-Hälfte auslese. Probleme gibts eben, wenn es "echte" Unicodezeichen in der Datei gibt.
Vielleicht setze ich das bald auch nochmal sauber um, so dass es auch mit D2009/D2010 geht. Wenn ich mal die Zeit finde.

Zitat:

Zitat von himitsu (Beitrag 1025936)

PS:

Delphi-Quellcode:

// entspricht
SetString(AValue, StartPointer, LineLen);

Nicht ganz, nen Cast muss noch sein, aber ich habe es entsprechend angepasst, ich weiß gar nicht warum ich das nicht sowieso gemacht hatte. :gruebel:
Danke ;-)

[himitsu]

Achso, dachte du meinst ab Delphi 2006.

Vom Code her könnte es sogar von Delphi 7 bis 2007 laufen (so vom Ansehn her)

Du könntest ja einen Hinweis einfügen, welcher sich notfalls meldet.

Delphi-Quellcode:

{$IF CompilerVersion >= 20.0}
  {$MESSAGE Fatal 'this is not compatible with unicode (Delphi 2009+)'}
{$IFEND}

Aber am Einfachsten du verwendest erstmal AnsiString und PAnsiChar, dann wäre es zumindestens in D2009+ lauffähig und dann halt nur Sowas oder garkein Hinweis.

Delphi-Quellcode:

{$IF CompilerVersion >= 20.0}
  {$MESSAGE Hint 'this are only an ANSI-Version'}
{$IFEND}

OK, dann kann ich ja weiterhin für meinen TTextStream Werbung machen, welcher ja grundsätzlich nur für die Unicodedelphis ausgelegt ist. :stupid:

[add]
CreateFile liefert keine 0 bei Fehlern.

Und da die Datei doch eh sequentiell gelesen wird, könnte man dieses Windows mitteilen, damit es vielleicht noch'n bissl die Cache optimieren kann.

Und die leere Exception ist auch nett. :zwinker:

Delphi-Quellcode:

FFile := CreateFile(PChar(AFileName), GENERIC_READ, FILE_SHARE_READ, nil,
  OPEN_EXISTING, FILE_FLAG_SEQUENTIAL_SCAN, 0);
if FFile = INVALID_HANDLE_VALUE then
  RaiseLastOSError;
FSize := FileSeek(FFile, Int64(0), Ord(soEnd));
FMapping := CreateFileMapping(FFile, nil, PAGE_READONLY, 0, 0, nil);

[jaenicke]

So, ich habe mich da nochmal rangesetzt. Es funktionieren jetzt Delphi 6 bis 2010 und Unicodedateien genauso wie Ansidateien. Wobei die Unicodedateien bei Delphi <= 2007 eben so gut es geht auf Ansi gefaltet werden.

Nebenbei:
Entstanden ist das als Nebenprodukt eines schnellen Registryeditors, deshalb weiß ich nicht ob auch andere Unicodedateien usw. korrekt erkannt werden. Die .reg Dateien funktionieren auf jeden Fall.

Zitat:

Zitat von himitsu (Beitrag 1025954)

[add]
CreateFile liefert keine 0 bei Fehlern.

Nein, aber laut Doku INVALID_HANDLE_VALUE, und genau das frage ich ja ab. ;-)

[himitsu]

:roll:

Delphi-Quellcode:

FFile := CreateFile(PChar(AFileName), GENERIC_READ, FILE_SHARE_READ, nil,
  OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, 0);
if FFile = 0 then
  raise Exception.Create('')
else

Also, solange ein BOM vorhanden ist, wird Unicode theoretisch korrekt gelesen.
OK, ohne BOM ist keine automatische Auswahl möglich und dann stört es nicht wenn immer das erste Zeichen in der Datei ignoriert wird (da es ja nur ein BOM sein kann)

[jaenicke]

Tut mir leid, irgendwie bin ich da mit den Projekten durcheinander gekommen. In einem anderen hatte ich INVALID_HANDLE_VALUE benutzt. :oops:
Ich habe es korrigiert.

[himitsu]

Macht nix.

Das ist auch einer der Gründe, warum ich viele Projekte überarbeite,
da die verschiedensten Codes extrahiere in diese als "Einzelprojekte" nun global verwalte und auch hier inner DP mit hochlad.
(die DPler als Bugfinder finden mehr, als man selber)

Weil auch ich irgendwann mal den Überblick verlor, vorallem wenn man fast das Selbe in verschiedenen Projekten nutzt.
(nja, und gleichzeitig wird die Gelegenheit für eine komplette Überprüfung/Überarbeitung/Neuaufsetzung genutzt)

[jaenicke]

Genau, ich benutze dafür NTFS Junctions. Das heißt das Source-Verzeichnis der verschiedenen Projekte klinke ich in das der Programme ein, die diese nutzen.

Dadurch kann ich die Buildskripte sehr einfach basteln und die ganzen verwendeten Units einfach einpacken ohne die von überallher zusammenkopieren zu müssen. :D
Und nebenbei nimmt das auch sehr viel Arbeit ab, wenn man jeweils für Zusammenstellung und Upload der Pakete einer neuen Version nur ein Skript ausführen muss.

Dem Reader fehlt jetzt nur noch die Unterstützung beliebiger Datentypen. Und ich überlege ob ich die Klasse vielleicht besser von TStream ableiten und so standardisieren sollte. Das würde die universelle Verwendung einfacher machen. Da man auch dort meistens sequentiell liest oder schreibt könnten auch dann MMFs noch Vorteile bringen. Aber das muss ich noch überlegen und testen.

[himitsu]

Beliebige Dateitypen?

[idefix2]

Was ich gerne wissen würde: Welchen Vorteil bringt ein TFileStream gegenüber einem normalen Textfile, vor allem bei sequenziellem Zugriff? Ich stelle mir vor, das beim sequentiellen Lesen ein Textfile genauso im Windows Cache gepuffert wird wie ein Filestream, und dass deshalb hinsichtlich der Geschwindigkeit kaum ein Vorteil zu erzielen ist?

[himitsu]

Erstmal kann AssignFile+ReadLn nur mit ANSI-Dateien umgehen (auch unter Delphi 2009+).

Standardmäßig hat diese wirklich alte Pascal-Funktion auch für Textdateien einen sehr schlecht eingestellten eigenen Puffer (gut, daß kann man etwas ändern)

Und dann sind diese Funktionen auch nicht gerade OOP-Konform.
TStringList, TStringStream und Co. haben das "Problem, daß sie die komplette Datei in den Arbeitsspeicher laden, also schlecht für große Dateien.

[p80286]

Zitat:

Zitat von himitsu (Beitrag 1026260)

Erstmal kann AssignFile+ReadLn nur mit ANSI-Dateien umgehen (auch unter Delphi 2009+).

Geschenkt (warum ist das eigentlich noch immer so?)

Zitat:

Zitat von himitsu (Beitrag 1026260)

Standardmäßig hat diese wirklich alte Pascal-Funktion auch für Textdateien einen sehr schlecht eingestellten eigenen Puffer (gut, daß kann man etwas ändern)

Wer es nicht tut dem ist nicht zu helfen, obwohl bei einem solchen Hilfetext auch nicht Naheliegend (D7 settextbuf):

Zitat:

Jede Textdateivariable verfügt über einen internen 128 Byte großen Puffer, in dem die Read- und Write-Operationen zwischengespeichert werden. Die Standardgröße des Puffers ist für die meisten Operationen ausreichend. Bei Programmen mit umfangreichen E/A-Operationen kann der Puffer vergrößert werden, um die Anzahl der Festplattenzugriffe zu verringern und das Dateisystem zu entlasten.

Zitat:

Zitat von himitsu (Beitrag 1026260)

Und dann sind diese Funktionen auch nicht gerade OOP-Konform.

Und wie wirkt sich das aus?

Zitat:

Zitat von himitsu (Beitrag 1026260)

TStringList, TStringStream und Co. haben das "Problem, daß sie die komplette Datei in den Arbeitsspeicher laden, also schlecht für große Dateien.

Da kommt es doch wohl darauf an was ich mit den Daten machen will. Auch bei TStringlist od Co verbietet mir niemand erst einmal ein paar Zeilen für dem Mülleimer zu lesen, und dann erst die Zeilen in den Speicher zu laden (für die weitere Verarbeitung).

Was wirklich fehlt ist ein seek was auf Zeilenbasis funktioniert.

Gruß
K-H

[himitsu]

Zitat:

Zitat von p80286 (Beitrag 1026341)

Und wie wirkt sich das aus?

Nicht viel ... eigentlich nur in der Art der Verwendung.

Die Dateivariable ist ein großer Record (auch wenn man es ihr nicht ansieht)
Und dieses kann bei Weitergabe an andere Funktionen Probleme bereiten (es muß mit VAR übergeben werden und der Compiler bemängelt ein Fehlen von VAR nicht).

Zitat:

Zitat von p80286 (Beitrag 1026341)

Was wirklich fehlt ist ein seek was auf Zeilenbasis funktioniert.

Sowas ist nicht gerade einfach, vorallem wenn man dann auch gleich noch eventuelle Schreibzugriffe mit in Betracht zieht.
Hier hab ich ja sowas versucht umzusetzen und da steckt jetzt schon eine ganze Menge an Arbeit drin und dennoch gefällt es mir noch nicht richtig.

Zitat:

Zitat von p80286 (Beitrag 1026341)

(warum ist das eigentlich noch immer so?)

Kompatibilitätsgründe für alte Codes.
Praktisch sind diese funktionen nur noch für eine Abwärtskompatibilität enthalten und da hat man sich eine Umstellung einfach gespart und nur alles so geändert, daß der Dateiinhalt sicher mit Ansi läuft (AnsiString, AnsiChar-Array und Co.)

[jaenicke]

Ich möchte an der Stelle auch einmal auf eine Umsetzung als Stream von Flamefire hinweisen:
http://www.delphi-forum.de/viewtopic.php?t=100088
Es ist praktisch eine Weiterentwicklung als Nachfahre von TStream und damit universell einsetzbar. Da er dies dort schon umgesetzt hat, spare ich mir den Aufwand, denn etwas ähnliches hatte ich auch im Sinn. :mrgreen:

[Jens01]

Hallo Sebastian,

ich habe versucht, Dein Programm für meine Zwecke zu erweitern. Das ist mir auch gelungen, aber an einer Stelle haut es ihn immer wieder raus. Er soll die Position eines String suchen und setzt gleichzeitig die Position des Readers auf diese :

Beispiel :
f := TSJMmfFileReader.Create(Dateiname);
f.Position := f.StringPos(S);

Delphi-Quellcode:

function TSJMmfFileReader.StringPos(AValue: string): Int64;
var
  s: string;
begin
  Result := -1;

  while Position < FSize do
  begin
    ReadLn(s);
    if s = AValue then
    begin
      Result := Position;
      Exit;
    end;
  end;
end;

Das Setzen der Position geht bei mir solange gut, bis ich zu einer Position mit der Größe von 2.386.487 komme. Bei SetPosition ruft er ReInitView auf. MapViewOfFile setzt dann FPointer auf nil. In ReadLn haut es ihn dann raus.

Kannst Du mir sagen, was ich falsch mache?

Gruss Jens

Edit:
Sooo..., warum der Fehler auftritt, weiß ich immer noch nicht, aber so scheint es zu funktionieren :

Beispiel:
f := TSJMmfFileReader.Create(Dateiname);
f.GotoString(S);

Delphi-Quellcode:

function TSJMmfFileReader.GotoString(AValue: string): Boolean;
var
  s: string;
begin
  Result := False;
  Position := 0;

  while Position < FSize do
  begin
    ReadLn(s);
    if s = AValue then
    begin
      Result := True;
      Exit;
    end;
  end;
end;

[Jens01]

Hier noch einige Erweiterungen. Vielleicht sind sie hilfreich.

Delphi-Quellcode:

uses
  .., AnsiStrings, Math;

procedure TSJMmfFileReader.ReadlnFloat(var AValue: Double);
var
  s: string;
begin
  Readln(s);
  if ContainsText(UpperCase(s), '+INF') then
  begin
    AValue := Infinity;
    Exit;
  end;
  if ContainsText(UpperCase(s), '-INF') then
  begin
    AValue := NegInfinity;
    Exit;
  end;
  if ContainsText(UpperCase(s), 'NAN') then
  begin
    AValue := NaN;
    Exit;
  end;
  s := StringReplace(s, '.', ',', [rfReplaceAll]);
  AValue := StrToFloat(s);
end;

Delphi-Quellcode:

procedure TSJMmfFileReader.ReadlnBool(var AValue: Boolean);
var
  s: string;
begin
  Readln(s);
  if UpperCase(s) = 'TRUE' then
    AValue := True;
  if UpperCase(s) = 'FALSE' then
    AValue := False;
end;

Delphi-Quellcode:

procedure TSJMmfFileReader.ReadlnInt(var AValue: Integer);
var
  s: string;
begin
  Readln(s);

  AValue := StrToInt(s);
end;