Artykuł techniczny

Delphi vs FPC: 4 ukryte pułapki w kodzie PDF dla PDFium

Ten sam kod źródłowy w Object Pascalu może zachowywać się różnie w Delphi i FPC/Lazarus na cztery sposoby, które regularnie utrudniają pracę z kodem komponentu PDFium: FPC usuwa tymczasowe rekordy zwracane przez funkcje przed zakończeniem testu przynależności in, dcc32 jest dostarczany z wyłączonym sprawdzaniem zakresów, co sprawia, że wyjście poza tablicę po cichu odczytuje śmieci z pamięci, tylko Delphi 13 pozwala na przypisanie anonimowego typu array of Byte do TBytes bez rzutowania, a delphiowa konkatenacja typów AnsiString może uszkodzić bajty o wartościach $80 lub wyższych poprzez niejawne konwersje strony kodowej. Każdy z tych przypadków sprawia, że kod działa na jednym kompilatorze, a na drugim zgłasza błędy lub, co gorsza, daje nieprawidłowe wyniki w milczeniu

Jeśli po raz pierwszy konfigurujesz projekt na dwa kompilatory, przewodnik po viewerze Lazarus i FPC opisuje optymistyczną ścieżkę: pakiety, ścieżki wyszukiwania i wyświetlenie okna renderowania na ekranie. Ten artykuł jest przeciwieństwem samouczka. Opisuje, co zwykle psuje się po tym, jak optymistyczna ścieżka działa, gdy zmiana zatwierdzona na jednym kompilatorze wybucha na drugim. Każda pułapka poniżej ma minimalną reprodukcję, przyczynę źródłową i regułę, którą ustandaryzowaliśmy

Dlaczego pod FPC zbiór wydaje się pusty, a w Delphi nie?

W skrócie: FPC może sfinalizować zmienną tymczasową przechowującą wynikowy rekord funkcji, zanim wyrażenie czytające pole tego wyniku zdąży się zakończyć, więc X in Func().Issues może testować przynależność względem już zwolnionego zbioru, podczas gdy równoważne wyrażenie w Delphi działa. Asercje testowe to typowe miejsce, gdzie się to trafia: walidator PDF/E zwraca rekord, którego pole Issues jest zbiorem flag naruszeń, a naturalne jest wpisanie wywołania wprost do asercji

Diagram pokazujący, że Delphi utrzymuje tymczasowy rekord-wynik funkcji PDFium przy życiu do końca instrukcji, podczas gdy FPC zwalnia go, zanim operator in odczyta zbiór Issues, więc asercja przechodzi tylko pod Delphi
Delphi utrzymuje tymczasowy rekord wyniku funkcji przy życiu do końca instrukcji, podczas gdy FPC może zwolnić go, zanim operator in przeczyta zbiór Issues
// Niewiarygodne pod FPC: tymczasowy rekord wyniku funkcji
// może zostać zwolniony, zanim test 'in' odczyta Issues
AssertTrue(pveiLzwUsed in ValidateAnsi(Pdf).Issues);

// Wiarygodne na obu kompilatorach: najpierw przypnij wynik do lokalnej zmiennej
var
  Vr: TPdfEValidationResult;
begin
  Vr := ValidateAnsi(Pdf);
  AssertTrue(pveiLzwUsed in Vr.Issues);
end;

Forma z wywołaniem w linii odczytywała zbiór jako pusty pod FPC, przez co każda asercja oczekująca flagi kończyła się błędem, podczas gdy identyczna kompilacja w Delphi przechodziła. Przyczyną źródłową jest różnica w zarządzaniu czasem życia tymczasowych rekordów-wyników wewnątrz większych wyrażeń: Delphi utrzymuje tymczasową zmienną do końca instrukcji, podczas gdy usuwanie rekordu tymczasowego w FPC może wyścigować operator przynależności do zbioru, który wciąż go czyta. Zepsuta forma wygląda na tyle naturalnie, że wraca nawet po tym, jak raz udokumentujesz to zachowanie. Poprawka jest mechaniczna i warto przyjąć ją jako regułę ogólną: nigdy nie łańcuchuj dostępu do pola ani testu zbioru bezpośrednio na wywołaniu funkcji zwracającej rekord; najpierw przypisz wynik do zmiennej lokalnej, potem czytaj pole. Kosztuje jedną linię i usuwa całą klasę zależnej od kompilatora loterii

Dlaczego Delphi akceptuje indeks tablicy, którego FPC nie pozwala nawet skompilować?

W skrócie: dcc32 kompiluje indeks poza zakresem dla tablicy o stałych granicach i, przy domyślnie wyłączonym sprawdzaniu zakresów, odczytuje lub zapisuje sąsiednią pamięć w czasie wykonania bez żadnego błędu, podczas gdy FPC odrzuca taki indeks na etapie kompilacji. PDFium Component deklaruje punkty czworokąta jako tablicę indeksowaną od 1, TQuadrilateralPoint = array [1..4] of TPdfPoint, co odpowiada typowej numeracji wpisów QuadPoints w PDF. Pętla demonstracyjna wypełniająca ją zwyczajowym indeksem od zera wygląda na działającą pod Delphi

Diagram PDFium Component tablicy quad-points PDF indeksowanej od 1, gdzie indeks 0 pod dcc32 po cichu dotyka sąsiedniego pola rekordu, a FPC zatrzymuje tę samą pętlę błędem sprawdzania zakresu na etapie kompilacji
Przy wyłączonej kontroli zakresu w dcc32 indeks 0 po cichu ląduje na sąsiednim polu rekordu, podczas gdy FPC odrzuca tę samą pętlę w czasie kompilacji
var
  I: Integer;
begin
  for I := 0 to 3 do                       // błędnie: tablica to [1..4]
    Data.AttachmentPoints[I] := Corner[I]; // domyślne dcc32: kompiluje się, indeks 0
                                           // po cichu dotyka sąsiedniej pamięci
                                           // FPC: błąd sprawdzania zakresu w czasie kompilacji
  for I := Low(TQuadrilateralPoint) to High(TQuadrilateralPoint) do
    Data.AttachmentPoints[I] := Corner[I - 1];  // poprawne na obu kompilatorach
end;

Kompilacja w Delphi to fałszywy pozytyw: przy wyłączonym sprawdzaniu zakresów, co jest domyślnym ustawieniem dcc32, indeks 0 ląduje na tym polu rekordu, które poprzedza tablicę, a demo wygląda na działające. Ten sam kod pod Lazarusem daje natychmiastowy błąd sprawdzania zakresu z FPC na etapie kompilacji. Stronę adnotacyjną punktów czworokąta omawia artykuł o adnotacjach z quad points. Płyną z tego dwie nauki. Po pierwsze, preferuj Low() i High() nad granicami wpisanymi wprost, ilekroć typ tablicy nie jest od zera z konstrukcji. Po drugie, traktuj kompilację FPC, albo przynajmniej jedną kompilację Delphi z włączonym {$R+}, jako obowiązkową bramkę pierwszego uruchomienia dla każdego nowego dema albo testu: domyślne ustawienia dcc32 nie powiedzą ci o tej klasie błędów, a działający program nie jest dowodem poprawności

Przypisanie do TBytes, które akceptuje wyłącznie Delphi 13

W skrócie: przypisanie pola zadeklarowanego jako anonimowa tablica array of Byte do zmiennej typu TBytes kompiluje się w Delphi 13 (wersja kompilatora 37.0), ale kończy się błędem w Delphi 12 Athens i wcześniejszych wersjach jako E2010 Incompatible types: 'TArray<Byte>' and 'Dynamic array'. Nie jest to różnica typu Delphi vs FPC, lecz Delphi vs jego starsze wersje, niemniej jednak wpływa to na wielokompilatorowy kod w ten sam sposób: najnowszy kompilator po cichu akceptuje konstrukcję, którą starsze odrzucają

type
  TValidator = class
  private
    FBuffer: array of Byte;   // anonimowy typ tablicy dynamicznej
  end;

var
  OrigBytes: TBytes;
begin
  OrigBytes := FBuffer;          // tylko Delphi 13; E2010 w Delphi 12
                                 // Athens i starszych
  OrigBytes := TBytes(FBuffer);  // kompiluje się wszędzie; ten sam układ bajtów,
                                 // bezpieczne twarde rzutowanie
end;

W tę pułapkę łatwo wpaść, gdy rozwijasz na Delphi 13, gdzie niejawna konwersja jest po cichu akceptowana: użytkownicy kompilujący to samo źródło na Delphi 12 i starszych dostają zamiast tego E2010. Poprawką strukturalną jest albo twarde rzutowanie jak wyżej, bezpieczne, bo anonimowy array of Byte i TBytes dzielą identyczny układ tablicy dynamicznej, albo — lepiej — zadeklarowanie pola od razu jako typu nazwanego, takiego jak TBytes, żeby konwersja w ogóle nie powstała. Poprawka procesowa znaczy więcej: konstrukcja, która kompiluje się na twoim najnowszym toolchainie, nie dowodzi niczego o starszych kompilatorach, które użytkownicy faktycznie mają, a ta kategoria problemów jest niewidoczna, dopóki nie zbudujesz przeciw każdej wspieranej wersji, bo lokalna kompilacja 37.0 nie wykryje pobłaźliwości obecnej tylko w 13

Bajt AnsiString, który znika na chińskiej wersji systemu Windows

W skrócie: sklejanie surowego bajta o wartości $80 lub wyższej z AnsiString przez + może po cichu zastąpić ten bajt znakiem ? ($3F) pod Delphi, bo wyrażenie przechodzi niejawne koło AnsiString → UnicodeString → AnsiString przez systemową stronę kodową. Typowo wychodzi na jaw w teście PDF/A, który buduje nazwę zawierającą izolowany bajt $FE — nigdy legalny bajt wiodący UTF-8 — żeby sprawdzić, że walidator flaguje nazwy nieważne jako UTF-8 według klauzuli 6.1.8 ISO 19005-2

Diagram obiegu AnsiString–UnicodeString zastępującego surowy bajt $FE znakiem zapytania na chińskiej maszynie Windows z CP936, obok bezpiecznej poprawki bajtu w miejscu w Delphi
Niejawna wycieczka UnicodeString tam i z powrotem zamienia niemapowalny bajt $FE na $3F pod CP936, więc bezpieczna ścieżka podłatuje bajt na miejscu
var
  BadName: AnsiString;
begin
  // W Delphi z wielobajtową systemową stroną kodową (zaobserwowane na CP936),
  // konkatenacja okrężnie przechodzi przez UnicodeString, a $FE, który
  // nie jest poprawną sekwencją CP936, wraca jako '?' ($3F)
  BadName := '/Bad' + AnsiChar($FE) + 'Name';

  // Bezpiecznie: zbuduj z ASCII-owym znakiem zastępczym, potem wstaw bajt na miejscu;
  // przypisanie indeksowane do ustalonego AnsiString nie przechodzi okrężnie
  BadName := '/Bad' + #1 + 'Name';
  BadName[5] := AnsiChar($FE);
end;

W systemie Windows z chińską stroną kodową 936 sklejony ciąg w ogóle nie zawierał bajta $FE, więc walidator zgodnie z prawdą nic nie zgłaszał, a test czerwieniał się z powodu, który nie miał z walidatorem nic wspólnego: na PDF-ie faktycznie zawierającym bajt $FE raportuje oczekiwaną flagę. Uszkodzenie wydarzyło się wewnątrz testowego pliku wykonywalnego Delphi podczas liczenia wyrażenia tekstowego, bo stawiający Unicode naprzód model stringów Delphi przelicza mieszane wyrażenia AnsiString przez UnicodeString, a $FE nie jest ważnym bajtem wiodącym w CP936, więc koło zwrotne go zastępuje. Bądź szczery co do granicy: na jednobajtowej zachodniej stronie kodowej, takiej jak CP1252, to samo wyrażenie zwykle przeżywa — dlatego ten problem ukrywa się na większości maszyn deweloperskich, a wychodzi na systemach wschodnioazjatyckich albo zlokalizowanych runnerach CI. Przyjęta reguła: nigdy nie buduj binarnych wektorów testowych z bajtami $80 i wyżej przez konkatenację AnsiString; albo podłatuj bajty w miejscu, gdy ciąg jest już ustalony, jak wyżej, albo buduj wektor od początku w TBytes

Co powinien domyślnie sprawdzać przepływ pracy oparty na dwóch kompilatorach

Cztery pułapki, jeden wzorzec: każdy kompilator mówi ci o innym podzbiorze twoich błędów. Analiza zakresów FPC na etapie kompilacji łapie indeks poza zakresem, który dcc32 przechodzi po cichu, a model stringów Unicode w dcc32 ujawnia zależność od strony kodowej, której czysto bajtowa kompilacja FPC nigdy nie uruchamia. Praktyczny wniosek: żadna z zielonych ścieżek nie wystarcza sama. Kompilacja skrośna to nie tylko odhaczona przenośność — to drugi analizator statyczny i drugi model wykonania nałożone na to samo źródło, w tym samym duchu co defensywne sprawdzenia granic w artykule o utwardzaniu ABI i bezpieczeństwie pamięci

Reguły, które wypadają z tych pułapek, są krótkie i łatwe do zapamiętania. Przypinaj rekordy-wyniki funkcji do zmiennej lokalnej, zanim poczytasz pola. Iteruj tablice o stałych granicach przez Low() i High() i uruchom przynajmniej jedną kompilację ze sprawdzaniem zakresów albo pod FPC, zanim zaufasz każdemu nowemu demo. Rzutuj anonimowe pola tablic dynamicznych jawnie albo deklaruj je typami nazwanymi i buduj pełną macierz kompilatorów przed wydaniem. Trzymaj surowe wysokie bajty z dala od konkatenacji AnsiString w ogóle. Żadna z nich nie kosztuje mierzalnego wysiłku, gdy stanie się nawykiem, a każda zamyka tryb awarii, którego przepływ z jednym kompilatorem strukturalnie nie widzi

Te reguły pochodzą z utrzymywania PDFium Component, który dostarcza to samo źródło w Object Pascalu dla Delphi, C++Buildera i FPC/Lazarusa