Kiedy używać funkcji inline, a kiedy jej nie używać?

Wiem, że inline jest wskazówką lub żądaniem kompilatora i służy do unikania narzutów wywołania funkcji.

Na jakiej podstawie można ustalić, czy funkcja jest kandydatem do inklinacji, czy nie? W którym przypadku należy unikać wkładania?

Uniknięcie kosztów wywołania funkcji to tylko połowa sukcesu.

robić:

• użyj inlinezamiast#define
• bardzo małe funkcje są dobrymi kandydatami na inline: szybszy kod i mniejsze pliki wykonywalne (większe szanse na pozostanie w pamięci podręcznej kodu)
• funkcja jest niewielka i wywoływana bardzo często

nie:

• duże funkcje: prowadzi do większych plików wykonywalnych, co znacznie obniża wydajność bez względu na szybsze wykonanie wynikające z narzutu wywołania
• funkcje wbudowane, które są powiązane we / wy
• funkcja jest rzadko używana
• konstruktory i destruktory: nawet gdy jest pusty, kompilator generuje dla nich kod
• łamanie kompatybilności binarnej podczas tworzenia bibliotek:
  • wstaw istniejącą funkcję
  • zmienić funkcję wbudowaną lub uczynić funkcję wbudowaną inną niż wbudowana: poprzednia wersja biblioteki wywołuje starą implementację

opracowując bibliotekę, aby uczynić klasę rozszerzalną w przyszłości, powinieneś:

• dodaj nieliniowy wirtualny destruktor, nawet jeśli ciało jest puste
• uczyń wszystkich konstruktorów nieliniowymi
• napisz nieliniowe implementacje konstruktora kopiowania i operatora przypisania, chyba że klasy nie można skopiować za pomocą wartości

Pamiętaj, że inlinesłowo kluczowe jest wskazówką dla kompilatora: kompilator może zdecydować, że nie wstawi funkcji, i może zdecydować o wstawieniu funkcji, które nie zostały oznaczone inlinew pierwszej kolejności. Generalnie unikam funkcji znakowaniainline (może poza pisaniem bardzo małych funkcji).

Jeśli chodzi o wydajność, rozsądnym podejściem jest (jak zawsze) profilowanie aplikacji, a następnie inlinezestaw funkcji reprezentujących wąskie gardło.

Bibliografia:

• Aby wstawić lub nie wstawić
• [9] Funkcje wbudowane
• Problemy z zasadami / kompatybilnością binarną w C ++
• GotW # 33: Inline
• Inline Redux
• Skuteczne C ++ - pozycja 33: Używaj ostrożnie wprowadzania

EDYCJA: Bjarne Stroustrup, język programowania C ++:

Można zdefiniować funkcję inline. Na przykład:

inline int fac(int n)
{
  return (n < 2) ? 1 : n * fac(n-1);
}

Specyfikator inlinejest wskazówką dla kompilatora, że ​​powinien on próbować wygenerować kod dla wywołania fac()inline, a nie ustanowić kod dla funkcji raz, a następnie wywołać za pomocą zwykłego mechanizmu wywoływania funkcji. Sprytny kompilator może wygenerować stałą 720dla połączenia fac(6). Możliwość wzajemnie rekurencyjnych funkcji inline, funkcji inline, które powtarzają się lub nie zależą od danych wejściowych itp., Uniemożliwia zagwarantowanie, że każde wywołanie inlinefunkcji jest wstawiane. Stopień sprytności kompilatora nie może być regulowany, więc jeden kompilator może wygenerować 720, inny 6 * fac(5), a jeszcze inny niewymagane wywołaniefac(6) .

Aby inlinizacja była możliwa przy braku niezwykle sprytnych narzędzi do kompilacji i łączenia, należy uwzględnić definicję - a nie tylko deklarację - funkcji wbudowanej (§9.2). inlineEspecifier nie wpływa semantyki funkcji. W szczególności funkcja wbudowana nadal ma unikalny adres, podobnie jak staticzmienne (§7.1.2) funkcji wbudowanej.

EDIT2: ISO-IEC 14882-1998, 7.1.2 Specyfikatory funkcji

Deklaracja funkcji (8.3.5, 9.3, 11.4) ze inlinespecyfikatorem deklaruje funkcję wbudowaną. Specyfikator wbudowany wskazuje implementacji, że podstawienie wbudowane funkcji w punkcie wywołania powinno być preferowane zamiast zwykłego mechanizmu wywoływania funkcji. Implementacja nie jest wymagana do wykonania tego wbudowanego podstawienia w punkcie wywołania; jednak nawet jeśli to wbudowane podstawienie zostanie pominięte, pozostałe zasady dla funkcji wbudowanych określone w 7.1.2 powinny być nadal przestrzegane.

inline ma bardzo mało wspólnego z optymalizacją. inlinejest instrukcją dla kompilatora, aby nie generować błędu, jeśli dana funkcja występuje wielokrotnie w programie, i obietnica, że ​​definicja pojawi się w każdym używanym tłumaczeniu i wszędzie tam, gdzie się pojawi, będzie miała dokładnie tę samą definicję.

Biorąc pod uwagę powyższe zasady, inlinenadaje się do krótkich funkcji, których ciało nie musi zawierać dodatkowych zależności od tego, czego potrzebowałaby tylko deklaracja. Za każdym razem, gdy napotyka się definicję, należy ją przeanalizować, a kod dla jej treści może zostać wygenerowany, co oznacza narzut kompilatora na funkcję zdefiniowaną tylko raz w jednym pliku źródłowym.

Kompilator może inline (tj zastąpić wywołanie funkcji z kodu, który wykonuje, że działanie tej funkcji) każde wywołanie funkcji, które wybiera. Kiedyś było tak, że „oczywiście” nie można było wstawić funkcji, która nie została zadeklarowana w tej samej jednostce tłumaczenia co wywołanie, ale przy rosnącym wykorzystaniu optymalizacji czasu łącza nawet teraz nie jest to prawdą. Równie prawdą jest fakt, że zaznaczone funkcje inlinenie mogą być wstawiane.

Mówienie kompilatorowi, aby wstawił funkcję, jest optymalizacją, a najważniejszą zasadą optymalizacji jest to, że przedwczesna optymalizacja jest źródłem wszelkiego zła. Zawsze pisz czysty kod (używając wydajnych algorytmów), następnie profiluj swój program i optymalizuj tylko funkcje, które trwają zbyt długo.

Jeśli okaże się, że dana funkcja jest bardzo krótka i prosta, a wywoływana jest dziesiątki tysięcy razy w ciasnej pętli wewnętrznej, może być dobrym kandydatem.

Możesz być zaskoczony - wiele kompilatorów C ++ automatycznie wstawi za ciebie małe funkcje - i mogą zignorować twoją prośbę o wstawienie.

Najlepszym sposobem, aby się tego dowiedzieć, jest profilowanie programu i oznaczanie małych funkcji, które są wywoływane wiele razy i przechodzą przez cykle procesora tak jak inline. Słowo kluczowe jest tutaj „małe” - gdy narzut wywołania funkcji jest nieznaczny w porównaniu do czasu spędzonego w funkcji, nie ma sensu wstawiać ich.

Innym zastosowaniem, które zasugerowałem, jest to, że jeśli masz małe funkcje, które są wywoływane w kodzie krytycznym pod względem wydajności wystarczająco często, aby sprawić, że pamięć podręczna nie trafi, prawdopodobnie powinieneś je również wpisać. Znów jest to coś, co profiler powinien móc ci powiedzieć.

Przedwczesna optymalizacja jest źródłem wszelkiego zła!

Zazwyczaj umieszczam tylko „getters” i „setters”. Gdy kod działa i jest stabilny, profilowanie może pokazać, które funkcje mogą skorzystać z wstawiania.

Z drugiej strony, większość współczesnych kompilatorów ma całkiem dobre algorytmy optymalizacyjne i określi to, co powinieneś dla siebie napisać.

Reasuming - pisz wbudowane funkcje jednowierszowe, a później martw się o inne.

Funkcje wbudowane mogą wbudowane poprawić wydajność kodu, eliminując potrzebę wypychania argumentów do stosu. jeśli dana funkcja znajduje się w kluczowej części kodu, powinieneś podjąć decyzję inline inline w części dotyczącej optymalizacji projektu,

możesz przeczytać więcej o wstawieniach w często zadawanych pytaniach o c ++

Często używam funkcji wbudowanych nie jako optymalizacji, ale aby uczynić kod bardziej czytelnym. Czasami sam kod jest krótszy i łatwiejszy do zrozumienia niż komentarze, nazwy opisowe itp. Na przykład:

void IncreaseCount() { freeInstancesCnt++; }

Czytelnik natychmiast zna pełną semantykę kodu.

Generalnie stosuję zasadę kciuka, w której wykonuję funkcję z 3-4 prostymi instrukcjami jako wstawionymi. Warto jednak pamiętać, że jest to tylko wskazówka dla kompilatora. Ostatnie wywołanie, aby ustawić je jako wbudowane lub nie, jest podejmowane tylko przez kompilator. Jeśli jest ich więcej niż tyle, nie będę deklarować w wierszu, ponieważ w przypadku głupiego kompilatora może to prowadzić do wzdęcia kodu.

Najlepszym sposobem byłoby sprawdzenie i porównanie wygenerowanych instrukcji dla wstawionych i nie wstawionych. Jednak zawsze można to bezpiecznie pominąć inline. Używanie inlinemoże prowadzić do problemów, których nie chcesz.

Decydując się na użycie w trybie inline, zwykle pamiętam o następującym pomyśle: Opóźnienie pamięci na nowoczesnych maszynach może być większym wąskim gardłem niż surowe obliczenia. Często wywoływane funkcje wstawiania zwiększają rozmiar pliku wykonywalnego. Ponadto taka funkcja może być przechowywana w pamięci podręcznej kodu procesora, co zmniejsza liczbę braków pamięci podręcznej, gdy potrzebny jest dostęp do tego kodu.

Dlatego musisz sam zdecydować: czy wstawianie zwiększa lub zmniejsza rozmiar generowanego kodu maszynowego? Jak prawdopodobne jest, że wywołanie funkcji spowoduje brak pamięci podręcznej? Jeśli jest on przeszyty całym kodem, powiedziałbym, że prawdopodobieństwo jest wysokie. Jeśli jest ograniczony do jednej ciasnej pętli, prawdopodobieństwo jest niskie.

Zazwyczaj używam inlinizacji w przypadkach, które wymienię poniżej. Jednak jeśli naprawdę zależy Ci na wydajności, profilowanie jest niezbędne. Ponadto możesz sprawdzić, czy kompilator rzeczywiście bierze podpowiedź.

• Krótkie procedury, które są wywoływane w ciasnej pętli.
• Bardzo podstawowe akcesoria (get / set) i funkcje otoki.
• Kod szablonu w plikach nagłówkowych niestety automatycznie uzyskuje podpowiedź.
• Krótki kod używany jak makro. (Np. Min () / max ())
• Krótkie rutyny matematyczne.

Również metoda wbudowana ma poważne skutki uboczne przy utrzymywaniu dużych projektów. Po zmianie kodu wbudowanego wszystkie pliki, które go używają, zostaną automatycznie odbudowane przez kompilator (jest to dobry kompilator). Może to zmarnować dużo czasu na rozwój.

Kiedy inlinemetoda jest przenoszona do pliku źródłowego i nie jest już wstawiana, cały projekt musi zostać przebudowany (przynajmniej takie było moje doświadczenie). A także, gdy metody są konwertowane na wbudowane.

Kwalifikatora funkcji wbudowanej należy używać tylko wtedy, gdy kod funkcji jest mały. Jeśli funkcje są większe, należy preferować normalne funkcje, ponieważ oszczędność miejsca w pamięci jest warta stosunkowo niewielkiego poświęcenia w szybkości wykonywania.

Kiedy uważasz, że Twój kod jest wystarczająco mały, aby go używać jako wbudowanego i pamiętasz, że funkcja wbudowana powiela kod i wkleja go, gdy funkcja jest wywoływana, więc może być wystarczająco dobry, aby wydłużyć czas wykonywania, ale również zwiększyć zużycie pamięci. Nie możesz używać funkcji inline, gdy używasz pętli / zmiennej statycznej / rekurencyjnej / switch / goto / funkcji wirtualnej. Wirtualne oznacza poczekanie, aż środowisko wykonawcze i wbudowane oznaczają podczas kompilacji, więc nie można ich używać jednocześnie.

Przeczytałem kilka odpowiedzi i widzę, że czegoś brakuje.

Zasadą, której używam, nie jest używanie wbudowane, chyba że chcę, aby było wbudowane. Wygląda głupio, teraz wyjaśnienie.

Kompilatory są wystarczająco inteligentne, a krótkie funkcje są zawsze dostępne. I nigdy nie tworzy długiej funkcji jako wbudowanej, chyba że programista tak mówi.

Wiem, że inline jest wskazówką lub prośbą do kompilatora

W rzeczywistości inlinejest to zamówienie na kompilator, nie ma możliwości wyboru, a po inlinesłowach kluczowych cały kod jest wstawiany. Dlatego nigdy nie możesz użyć inlinesłowa kluczowego, a kompilator zaprojektuje najkrótszy kod.

Więc kiedy używać inline?

Do użycia, jeśli chcesz mieć wbudowany kod. Znam tylko jeden przykład, ponieważ używam go tylko w jednej sytuacji. To jest uwierzytelnianie użytkownika.

Na przykład mam tę funkcję:

inline bool ValidUser(const std::string& username, const std::string& password)
{
    //here it is quite long function
}

Bez względu na to, jak duża jest ta funkcja, chcę mieć ją wbudowaną, ponieważ utrudnia to złamanie mojego oprogramowania.