Ana içeriğe geç

SCA'da cover edilemeyen kodlar: Ölü, Gereksiz ve Devre Dışı Bırakılmış Kodlar

· 6 dakikalık okuma
Aviyonik Yazılım Mühendisi

Ölü kod kavramını mizahi biçimde anlatan, kod yazılı mezar taşları ve hayaletlerle dolu çizgi film tarzında bir mezarlık sahnesi

Yapısal kapsam analizi (structural coverage analysis, SCA), yazılım test süreçlerinde hayati role sahip bir yöntemdir. Bu analiz, yazılımın kod kapsamını değerlendirerek hangi kod bölümlerinin testler sırasında çalıştırıldığını veya çalıştırılmadığını belirlemeye yardımcı olur. Ana hedef, yazılımın her bir satırının (statement), dalının (branch) ve koşulunun (condition) uygun şekilde test edilip edilmediğini kontrol etmektir.

Bu konu özellikle Yazılım Doğrulama ve Kapsanmayan Kodlar bölümleriyle birlikte okunursa, hangi kodun neden kapsanmadığı daha net görünür. SCA'nın kendisini ve kapsama türlerini ise Yapısal kapsam analizi yazısında bulabilirsiniz.

Kapsama verisi toplama sürecinde, yapısal kapsam analizi aracı önemli bir rol oynar. İlk olarak, bu araçlar kaynak koda instrumentation adı verilen ek kod parçalarını ekler. Bu ekleme, gereksinim tabanlı testler sırasında hangi kod parçalarının çalıştığını takip etmek için yapılır. Test sırasında toplanan kapsama verisi, daha sonra yapısal kapsam analizi araçları tarafından incelenir. Bu inceleme sonucunda, testlerde çalışmayan yani "kapsanmamış" kod satırları tespit edilir ve bir kapsam analizi raporu oluşturulur.

Bu analiz sonucunda, bazı kodların kapsanmadığı görülebilir. Kapsanmayan her satır sorunlu kod demek değildir: neden çoğu zaman eksik bir test ya da eksik bir gereksinimdir. Bu iki neden elendikten sonra geriye kalan kod üç kategoriye ayrılır.

Kod türüNe demektir?SCA açısından ne anlatır?
Ölü kodBir geliştirme hatası sonucu orada bulunan, hiçbir konfigürasyonda çalıştırılamayan kodGereksiz kodun özel hâlidir; kaldırılır
Gereksiz kodHiçbir gereksinime izlenemeyen kod; çalışabilir de çalışamayabilir deKaldırılır; kaldırmanın etkisi analiz edilir
Devre dışı bırakılmış kodGereksinime izlenen, tasarım gereği çalıştırılmayan ya da yalnızca belirli konfigürasyonlarda çalışan kodKorunur; istem dışı çalışmasının önlendiği gösterilir

Ölü kod (dead code)​

Ölü kod, bir geliştirme hatası sonucu yazılımda bulunan ve hiçbir işletim konfigürasyonunda çalıştırılamayan kod bölümleridir; hiçbir gereksinime izlenemez. Genellikle yazılımın eski sürümlerinden kalan, artık kullanılmayan veya yanlış tanımlanmış koşullu blokları içeren kodlardır. Yapısal kapsam analizinde, ölü kod testler sırasında hiç çalıştırılmaz, çünkü bu kodun çalışması için gerekli koşullar asla sağlanamaz. Yapısal kapsam analiziyle bu kodlar tespit edilir ve kaldırılır. Ayrıca, çeşitli derleyiciler, statik kod analiz araçları [3] ve IDE'ler bu tür kodlama hatalarını belirleyerek uyarıda bulunur.

Clang'de aşağıdaki derleyici parametresini projenize ekleyerek geliştirme aşamasında ulaşılamayan kodu tespit edebilirsiniz [5]:

-Wunreachable-code

GCC bu parametreyi kabul eder ama 4.5 sürümünden beri hiçbir uyarı üretmez: uyarı, optimizasyona bağlı olarak sürümden sürüme farklı sonuç verdiği için kaldırılmış, parametre yalnızca eski Makefile'lar bozulmasın diye bırakılmıştır [4]. GCC ile derlenen projelerde bu denetim statik analiz aracına bırakılır.

Gereksiz kod (extraneous code)​

Gereksiz kod, hiçbir sistem ya da yazılım gereksinimine izlenemeyen kod ya da veridir. Gereksinimi silindiği hâlde yerinde bırakılan eski kod, sonucu kullanılmayan hesaplamalar, kullanılmayan değişkenler ve fonksiyonlar bu türdendir. Ölü koddan farkı, çalıştırılabilir olabilmesidir: hiçbir gereksinim tabanlı test onu tetiklemediği için kapsam raporunda çalışmamış görünür, ama doğru girdi geldiğinde çalışır ve davranışı hiç doğrulanmamıştır. Ölü kod, gereksiz kodun hiçbir konfigürasyonda çalıştırılamayan özel hâlidir; ikisi de kaldırılır.

GCC'de aşağıdaki derleyici parametrelerini kullanarak bazı gereksiz kodları tespit etmek mümkündür [2]:

-Wunused-variable -Wunused-value

Devre dışı bırakılmış kod (deactivated code)​

Devre dışı bırakılmış kod, yazılım geliştirme sürecinde bilinçli bir şekilde planlanmış ve tasarlanmış koddur. Bu, yazılımın belirli bir konfigürasyonda aktif olmayan ancak başka bir konfigürasyonda kullanılabilecek kod parçalarını ifade eder. Örneğin, hem askerî hem de sivil konfigürasyona sahip bir helikopterin yazılımında, sadece sivil konfigürasyonda gerçekleştirilen testler sırasında askerî konfigürasyona ait kod satırları aktif olmayacaktır. Bu tür kod, yapısal kapsam analizinde genellikle kapsanmayan kod olarak görünebilir. Ancak, gereksiz veya ölü kodun aksine, devre dışı bırakılmış kod tasarım aşamasında öngörülen ve amaçlanan bir özelliktir. Bu kodlar için gereksinimler belirlenmiş ve izlenebilirliği sağlanmıştır; doğrulama beklentisi ise kategoriye göre değişir.

Devre dışı bırakılmış kodun iki temel kategorisi bulunmaktadır:

  1. Hiçbir zaman aktive edilmeyecek kod: Sertifikalı ürünün hiçbir konfigürasyonunda çalıştırılması amaçlanmayan, ama çalıştırılabilir nesne kodunda yer alan kodlardır. Önceden geliştirilmiş bir bileşenin kullanılmayan kısmı, bağlanan ama çağrılmayan kütüphane fonksiyonları ve gelecekteki büyüme için eklenmiş kod bu kategoriye girer. Bu kodun istem dışı çalışmasının önlendiği analiz ve testle gösterilir. Hata ayıklama (debug) kodları ise genellikle ön işlemci komutları (preprocessor directives) kullanılarak kontrol edilir. Ön işlemci komutları, C veya C++ gibi dillerde yaygın olarak kullanılan #ifdef, #ifndef, #endif gibi direktiflerdir. Bu direktifler, kodun belirli bölümlerinin yalnızca belirli koşullar altında derlenmesini sağlar. Örneğin, #ifdef DEBUG ve #endif arasına yazılan kodlar yalnızca DEBUG makrosu tanımlı olduğunda derlenir ve uygulamaya dâhil edilir. Üretim sürümünde bu makro tanımlanmadığında, bu kod bloğu derlenmez ve son üründe yer almaz. DO-178C'nin tanımı çalıştırılabilir nesne kodunu esas aldığı için böyle bir kod, tanımın harfiyle devre dışı bırakılmış kod sayılmaz; yine de uygulamada çoğu zaman bu başlık altında planlanır. Bu durumda gösterilmesi gereken, kodun imajda gerçekten bulunmadığı ve derleme seçeneklerinin konfigürasyon kontrolü altında tutulduğudur.
  2. Bazı konfigürasyonlarda kullanılacak kod: Belirli konfigürasyonlarda kullanılan, ancak diğerlerinde devre dışı bırakılan kodlar. Çift konfigürasyona sahip helikopter örneğinden ilerlersek: uçuş sırasında yazılım sivil modda ise askerî uçuş moduna özgü özellikler devre dışı bırakılır. Bu, yazılımın çalışma zamanında (run-time) dinamik olarak gerçekleşir. Örneğin, bir konfigürasyon dosyası, bir buton veya giriş olarak alınan bir ayrık (discrete) pin yazılımın hangi modda çalıştığını belirler ve buna göre askerî özellikleri devre dışı bırakır. Devre dışı bırakma mekanizmasının işlevselliği kanıtlanmalı, gereksinimleri ve testleri olmalıdır. Ayrıca, devre dışı bırakma yaklaşımı, aktif edilen yazılımın seviyesini desteklemelidir.

Devre dışı bırakılmış kodun yönetimi ve kontrolü için yazılım sertifikasyon planı (Plan for Software Aspects of Certification, PSAC), Software Development Plan (SDP) ve Software Verification Plan (SVP) gibi belgelerde özel hususların ele alınması gerekir.

PSAC'te: Devre dışı bırakılmış kodun yazılım içindeki rolü, kullanım amacı ve hangi koşullar altında devre dışı kalacağı açıklanmalıdır. Bu kodun neden gerektiği ve yazılımın genel işlevselliği üzerindeki etkisi detaylandırılmalıdır.

SDP'de: Devre dışı bırakılmış kodun geliştirilmesinde kullanılacak yöntemler ve teknikler detaylandırılmalıdır.

SVP'de: Devre dışı bırakılmış kodun doğru şekilde işlediğinin doğrulanması için uygulanacak test stratejileri ve metodolojileri açıklanmalıdır.

Kaynakça​

  1. Leanna Rierson — Developing Safety-Critical Software: A Practical Guide for Aviation Software and DO-178C Compliance, Chapter 17: Noncovered Code (Dead, Extraneous, and Deactivated Code)
  2. GCC, Options to Request or Suppress Warnings
  3. Carnegie Mellon University Software Engineering Institute, MSC12-C. Detect and remove code that has no effect or is never executed
  4. GCC yardım listesi, "gcc -Wunreachable-code option": uyarının neden kaldırıldığını anlatan yanıt
  5. Clang, Diagnostic flags: -Wunreachable-code

İleri okuma​

  1. Leanna Rierson — Developing Safety-Critical Software: A Practical Guide for Aviation Software and DO-178C Compliance
  2. Vance Hilderman, Tony Baghai — Avionics Certification: A Complete Guide to DO-178 (Software), DO-254 (Hardware)