Teknik Makale

Delphi vs FPC: PDFium Derlemelerinde 4 Gizli PDF Kod Tuzağı

Aynı Object Pascal kaynağı, Delphi ve FPC/Lazarus altında PDFium Bileşeni kodunu tekrar tekrar etkileyen dört şekilde farklı davranabilir: FPC, bir in üyelik testi onları okumayı bitirmeden önce işlev sonucu geçici kayıtları (record temporaries) serbest bırakır; dcc32 aralık kontrolü kapalı olarak geldiği için sınırların dışındaki dizi indeksleri sessizce çöp veri okur; yalnızca Delphi 13 anonim bir array of Byte ifadesini bir dönüşüm olmadan TBytes değişkenine atamayı kabul eder ve Delphi'nin AnsiString birleştirmesi, gizli bir kod sayfası çift yönlü döngüsü nedeniyle $80 veya üzerindeki baytları yok edebilir. Her biri bir derleyicide yeşil, diğerinde ise kırmızı veya daha kötüsü sessizce yanlış sonuç üreten bir duruma yol açar

Çift derleyicili bir projeyi ilk kez kuruyorsanız, Lazarus ve FPC görüntüleyici kılavuzu mutlu yolu kapsar: paketler, arama yolları ve ekrana bir rendering penceresi getirme. Bu yazı bir öğreticinin tam tersidir. Mutlu yol çalıştıktan sonra bozulan şeyleri anlatır: bir derleyicide geçen bir değişiklik diğerinde patlar. Aşağıdaki her tuzak, minimal bir yeniden üretim, kök neden ve standartlaştırdığımız kuralla birlikte gelir

Neden bir küme FPC altında boş okunurken Delphi'de okunmaz?

Tek cümlelik versiyon: FPC, bir işlevin kayıt sonucunu tutan geçici değişkeni, o sonucun bir alanını okuyan bir ifade bitmeden önce sonlandırabilir; bu nedenle X in Func().Issues, eşdeğer Delphi ifadesi çalışırken zaten serbest bırakılmış bir kümeye karşı üyelik testi yapabilir. Test iddiaları buna tipik bir yerdir: bir PDF/E doğrulayıcısı, Issues alanı ihlal bayraklarından oluşan bir küme olan bir kayıt döndürür ve çağrıyı iddianın içine satır içi almak doğaldır

Delphi'nin bir PDFium işlev-sonucu kayıt geçici değişkenini deyim sona erene dek canlı tuttuğunu, FPC'nin ise in-operatörü Issues kümesini okumadan önce serbest bıraktığını gösteren şema; iddia yalnızca Delphi altında geçer
Delphi işlev-sonucu kayıt geçici değişkenini deyim bitene dek canlı tutar; FPC ise in-operatörü Issues kümesini okumadan önce serbest bırakabilir
// FPC altında güvenilmez: işlev sonucu kayıt geçici değişkeni
// 'in' testi Issues değerini okumadan önce serbest bırakılabilir
AssertTrue(pveiLzwUsed in ValidateAnsi(Pdf).Issues);

// Her iki derleyicide de güvenilir: sonucu önce bir yerel değişkene sabitleyin
var
  Vr: TPdfEValidationResult;
begin
  Vr := ValidateAnsi(Pdf);
  AssertTrue(pveiLzwUsed in Vr.Issues);
end;

Satır içine alınmış (inlined) biçim kümeyi FPC altında boş olarak okudu; bir bayrak bekleyen her iddia başarısız oldu, birebir aynı Delphi derlemesi ise geçti. Kök neden, iki derleyicinin büyük ifadelerin içindeki işlev-sonucu geçici değişkenlerinin ömrünü farklı yönetmesidir: Delphi geçici değişkeni deyimin sonuna dek canlı tutar; FPC'nin kayıt geçici değişkenini serbest bırakışı ise hâlâ onu okumakta olan küme üyeliği operatörüyle yarışabilir. Bozuk biçim, davranışı bir kez belgelemiş olmanıza rağmen geri sızacak kadar doğal görünür. Düzeltme mekaniktir ve genel bir kural olarak benimsenmeye değerdir: bir kayıt döndüren işlev çağrısına asla doğrudan alan erişimi ya da küme testi zincirlemeyin; önce sonucu yerel bir değişkene atayın, sonra alanı okuyun. Bir satıra mal olur ve derleyiciye bağlı tüm bir kararsızlık sınıfını ortadan kaldırır

Delphi neden FPC'nin derlemeyi reddettiği bir dizi indeksini kabul eder?

Tek cümlelik versiyon: dcc32, sabit sınırlı bir diziye yönelik sınır dışı bir indeksi derler ve varsayılan aralık kontrolü kapalıyken çalışma zamanında hiçbir hata olmadan bitişik belleği okur ya da yazar; FPC ise aynı indeksi derleme zamanında reddeder. PDFium Component, dörtgen noktaları PDF'in QuadPoints girdilerinin genellikle numaralandırılışına uygun biçimde 1 tabanlı bir dizi olarak bildirir: TQuadrilateralPoint = array [1..4] of TPdfPoint. Onu refleks olarak 0 tabanlı indeksle dolduran bir demo, Delphi altında çalışıyormuş gibi görünür

PDFium Component şeması: 1 tabanlı bir PDF quad-points dizisinde 0 indeksi dcc32 altında sessizce komşu kayıt alanına dokunurken FPC aynı döngüyü derleme-zamanı aralık kontrolü hatasıyla durdurur
dcc32 aralık kontrolü kapalıyken 0 indeksi sessizce komşu kayıt alanına düşer; FPC aynı döngüyü derleme zamanında reddeder
var
  I: Integer;
begin
  for I := 0 to 3 do                       // yanlış: dizi [1..4]
    Data.AttachmentPoints[I] := Corner[I]; // dcc32 default: compiles, index 0
                                           // komşu belleğe sessizce dokunur
                                           // FPC: derleme zamanı aralık denetimi hatası
  for I := Low(TQuadrilateralPoint) to High(TQuadrilateralPoint) do
    Data.AttachmentPoints[I] := Corner[I - 1];  // her iki derleyicide de doğru
end;

Delphi derlemesi bir hatalı pozitiftir: aralık kontrolü kapalıyken — ki dcc32 varsayılanı budur — indeks 0, kayıtta diziden önce gelen ne varsa onun üzerine düşer ve demo çalışıyormuş gibi görünür. Aynı kod Lazarus altında FPC'den anında bir derleme-zamanı aralık kontrolü hatası üretir. Quadpoints'in annotation tarafı quad-points annotation yazısında ele alınır. Buradan iki ders çıkar. Birincisi, dizi türü yapı gereği 0 tabanlı değilse sabit sınırlar yerine her zaman Low() ve High()'u tercih edin. İkincisi, bir FPC derlemesini — ya da en azından {$R+} açık tek bir Delphi derlemesini — yeni her demo ya da test için zorunlu bir ilk-koşu kapısı olarak ele alın: dcc32'nin varsayılanları size bu hata sınıfını söylemez ve koşan bir program, doğru olduğunun kanıtı değildir

Yalnızca Delphi 13'ün kabul ettiği TBytes ataması

Tek cümlelik versiyon: anonim array of Byte olarak bildirilen bir alanı bir TBytes değişkenine atamak Delphi 13'te (derleyici sürümü 37.0) derlenir ancak Delphi 12 Athens ve önceki tüm sürümlerde E2010 Incompatible types: 'TArray<Byte>' and 'Dynamic array' hatasıyla başarısız olur. Bu durum Delphi-FPC ayrımından ziyade Delphi'nin kendi geçmişiyle olan bir ayrımıdır ancak aynı çoklu derleyicili kod tabanını aynı şekilde etkiler: en yeni derleyici, diğer her şeyin reddettiği bir yapıyı sessizce kabul eder

type
  TValidator = class
  private
    FBuffer: array of Byte;   // anonim dinamik dizi türü
  end;

var
  OrigBytes: TBytes;
begin
  OrigBytes := FBuffer;          // Delphi 13 only; E2010 on Delphi 12
                                 // Athens ve daha eski sürümler
  OrigBytes := TBytes(FBuffer);  // her yerde derlenir; aynı bayt düzeni,
                                 // güvenli zorunlu tür dönüşümü
end;

Tuzak, örtük dönüşümün sessizce kabul edildiği Delphi 13 üzerinde geliştiriyorsanız kolayca yayılır: aynı kaynağı Delphi 12 ve eskisinde derleyen kullanıcılar bunun yerine E2010 alır. Yapısal çözüm ya yukarıda gösterilen sert dönüşümdür — anonim bir array of Byte ile TBytes aynı dinamik dizi düzenini paylaştığı için güvenlidir — ya da daha iyisi, alanı baştan TBytes gibi adlandırılmış bir tür olarak bildirmektir; böylece dönüşüm hiç doğmaz. Süreç çözümü daha önemlidir: en yeni araç zincirinizde derlenen bir yapı, kullanıcılarınızın gerçekten koştuğu eski derleyiciler hakkında hiçbir şey kanıtlamaz ve bu sorun sınıfı, desteklenen her sürüme karşı derleyene kadar görünmez kalır; çünkü yerel bir 37.0 derlemesi, yalnızca 13'ün hoşgörüsünü yakalayamaz

Çince Windows Makinesinde Kaybolan AnsiString Baytı

Tek cümlelik versiyon: $80 veya üzerindeki ham bir baytı + ile bir AnsiString'e eklemek, Delphi altında o baytı sessizce ? ($3F) ile değiştirebilir; çünkü ifade, sistem kod sayfası üzerinden örtük bir AnsiString → UnicodeString → AnsiString gidiş-dönüşü yapar. Tipik olarak, ISO 19005-2 madde 6.1.8'e göre geçerli UTF-8 olmayan adları doğrulayıcının işaretlediğini doğrulamak için, hiçbir zaman geçerli bir UTF-8 öncü baytı olmayan izole bir $FE baytı içeren bir ad kuran bir PDF/A testinde yüzeye çıkar

Ham bir $FE baytını CP936 Çince Windows makinesinde soru işaretiyle değiştiren AnsiString'den UnicodeString'e gidiş dönüşün şeması; yanında Delphi'de güvenli yerinde bayt yaması
Örtük UnicodeString gidiş-dönüşü, CP936 altında eşlenemeyen bir $FE baytını $3F ile değiştirir; güvenli yol baytı yerinde yamalar
var
  BadName: AnsiString;
begin
  // Çok baytlı sistem kod sayfasına sahip Delphi'de (CP936'da gözlemlendi),
  // birleştirme UnicodeString ve $FE üzerinden döner ve bu,
  // geçerli bir CP936 dizisi olmadığından '?' ($3F) olarak geri döner
  BadName := '/Bad' + AnsiChar($FE) + 'Name';

  // Güvenli: bir ASCII yer tutucuyla oluşturun, ardından baytı yerinde yamalayın;
  // yerleşmiş bir AnsiString'e dizinli atama geri dönüş yapmaz
  BadName := '/Bad' + #1 + 'Name';
  BadName[5] := AnsiChar($FE);
end;

Kod sayfası 936 koşturan bir Çince Windows sisteminde birleştirilen dize hiçbir zaman $FE içermedi; doğrulayıcı haklı olarak hiçbir şey bildirmedi ve test, doğrulayıcıyla hiçbir ilgisi olmayan bir nedenden kırmızıya döndü: gerçekten $FE baytını içeren bir PDF verildiğinde beklenen bayrağı bildiriyordu. Bozulma, dize ifadesi değerlendirilirken Delphi test yürütülebilir dosyasının içinde gerçekleşti; çünkü Delphi'nin önce-Unicode dize modeli karışık AnsiString ifadelerini UnicodeString üzerinden dönüştürür ve $FE, CP936'da geçerli bir öncü bayt olmadığı için gidiş-dönüş onu değiştirir. Buradaki sınır konusunda dürüst olun: CP1252 gibi tek baytlık bir Batı kod sayfasında aynı ifade genellikle hayatta kalır; sorunun çoğu geliştirme makinesinde gizlenip yalnızca Doğu Asya sistemlerinde ya da yerelleştirilmiş CI çalıştırıcılarında ortaya çıkmasının nedeni tam olarak budur. Benimsediğimiz kural: $80 ve üzerinde bayt içeren ikili test vektörlerini asla AnsiString birleştirmesiyle kurmayın; ya yukarıdaki gibi dize yerleştikten sonra baytları yerinde yamalayın ya da vektörü baştan TBytes ile kurun

Çift derleyicili bir iş akışı varsayılan olarak neleri kontrol etmeli?

Dört tuzak, tek bir desen: her derleyici size hatalarınızın farklı bir alt kümesini söyler. FPC'nin derleme-zamanı aralık analizi, dcc32'nin sessizce koşturduğu sınır dışı bir indeksi yakalar; dcc32'nin Unicode dize modeli ise saf bayt yönelimli bir FPC derlemesinin hiç tetiklemeyeceği bir kod sayfası bağımlılığını açığa çıkarır. Pratik sonuç, hiçbir yeşil hattın tek başına yeterli olmadığıdır. Çapraz derleme yalnızca bir taşınabilirlik onay kutusu değildir; aynı kaynağa uygulanan ikinci bir statik analizör ve ikinci bir çalışma zamanı modelidir — ABI ve bellek güvenliği sertleştirme yazısındaki savunmacı sınır kontrolleriyle aynı ruhta

Bu olaylardan ortaya çıkan kurallar ezberlenecek kadar kısadır. Alanları okumadan önce işlev sonucu kayıtlarını yerel bir değişkene sabitleyin. Sabit sınırlı dizileri Low() ve High() ile yineleyin ve yeni bir demoya güvenmeden önce en az bir aralık kontrollü veya FPC derlemesi çalıştırın. Anonim dinamik dizi alanlarını açıkça dönüştürün veya en başta adlandırılmış türlerle bildirin ve sürümden önce tam derleyici matrisini derleyin. Ham yüksek baytları AnsiString birleştirmesinden tamamen uzak tutun. Bunların hiçbiri alışkanlık haline geldikten sonra ölçülebilir bir çaba gerektirmez ve her biri tek derleyicili bir iş akışının yapısal olarak göremediği bir başarısızlık modunu kapatır

Bu kurallar, Delphi, C++Builder ve FPC/Lazarus için aynı Object Pascal kaynağını gönderen PDFium Component'in bakımından gelir