wtorek, 20 grudnia 2011

Używanie słówka kluczowego inline zamiast makr w C



Dobry kod zawiera zwykle dużą liczbę relatywnie małych funkcji czy metod, które mogą być łączone ze sobą na wiele sposobów (jak klocki Lego). Często jednak pisząc kod tworzymy mniej, bardziej złożonych i mniej uniwersalnych funkcji. Sprawia to, że kod jest bardziej podatny na błędy i często sprawia problemy przy testowaniu czy szukaniu błędów.

Często powodem takiego stanu rzeczy jest nieużywanie małych funkcji aby nie obniżać wydajności systemu. Ciągłe wywoływanie  małej funkcji może znacznie zmniejszyć prędkość wykonywania całego programu. Oczywiście można zainwestować w szybszy procesor ale nie zawsze jest to możliwe do wykonania. Może nam zależeć na minimalizacji czasu wykonania jakiejś funkcji.

Rozważmy taki przykład. Mamy funkcję, która dodaje 1 do jakiejś wartości ale z tzw. nasyceniem aby nie przekroczyć maksymalnej wartości (żeby zmienna się nie "przekręciła"):

  int SaturatingIncrement(int x)
  { if (x != MAXINT)
    { x++;
    }
    return(x);
  }

Możemy mieć więc kod wyglądający jak poniżej:
  ...
  x = SaturatingIncrement(x);
  ...
  z = SaturatingIncrement(z);

Na pewno zauważysz, że jeśli wielokrotnie funkcja ta będzie wykonywana to kod będzie wykonywał się wolno. Zwykle rozwiązania są 2. Niektórzy, kopiują kod z funkcji i używają go mniej więcej tak:
  ...
  if (x != MAXINT)  { x++; }
  ...
  if (z != MAXINT)  { z++; }

Dużym problemem z tym jest to, że jeśli znajdziesz błąd, musisz przejrzeć cały program i poszukać wszystkich wystąpień takich fragmentów kodu i ręcznie je poprawić.

Trochę lepszym rozwiązaniem jest użycie makr:
#define SaturatingIncrement(w)  { if ((w) != MAXINT)  { (w)++; } }

które, pozwala wrócić mniej więcej do oryginalnego kodu. Kod więc może wówczas wyglądać tak:
  ...
  SaturatingIncrement(x);
  ...
  SaturatingIncrement(z);

ale preprocesor wykryje użycie makra i zamieni to na taki kod dla kompilatora:
  ...
  if (x != MAXINT)  { x++; }
  ...
  if (z != MAXINT)  { z++; }

eliminując tym samym kilka niepotrzebnych taktów przy wywołaniu funkcji.

Fajną rzeczą w makrach jest to, że jeśli znajdziesz błąd to musisz poprawić go tylko w jednym miejscu i sprawia, że kod jest dużo bardziej czytelny. Tak czy inaczej złożone makra mogą być niewygodne i być źródłem tajemniczych błędów (np. wiesz dlaczego jest "(w)" zamiast po prostu w?).

Dobrą wiadomością jest to, że we większości kompilatorów C jest lepsze rozwiązanie. Zamiast używać makr można użyć funkcji ze słówkiem kluczowym "inline".

  inline int SaturatingIncrement(int x)
  { if (x != MAXINT)
    { x++; }
    return(x);
  }

Słówko inline mówi kompilatorowi aby rozwinął kod funkcji w linii gdzie wywołana jest funkcja (tak jak makro). Ale zamiast zamiany tekstu w preprocesorze jest do dokonywane przez sam kompilator. Można więc pisać tyle funkcji inline ile się chce bez płacenie niepotrzebnymi taktami zegara. Dodatkowo, kompilator sprawdzi poprawność typów czy inne analizy aby pomóc wykryć błędy co nie było możliwe z makrami.

Można się jednak spotkać z kilkoma dziwactwami związanymi z inline. Niektóre kompilatory ignorują słówko inline jeśli funkcja przekracza jakąś określoną liczbę linii kodu. Inne z kolei pozwalają wywołać w ten sposób funkcje która jest zdefiniowana w tym samym pliku .c. Niektóre kompilatory muszą mieć zaznaczoną flagę aby wymusić inline zamiast zwykłego słówka inline przy definicji funkcji. Niestety aby być pewnym, że inline działa poprawnie, trzeba sprawdzić kod wyjściowy (w asemblerze) i zobaczyć jak nasz kompilator to obsługuje.

Brak komentarzy:

Publikowanie komentarza