Dlaczego wiele funkcji zwracających struktury w C faktycznie zwraca wskaźniki do struktur?

Jaka jest zaleta zwracania wskaźnika do struktury w porównaniu do zwracania całej struktury w returninstrukcji funkcji?

Mówię o funkcjach takich jak fopeni innych funkcjach niskiego poziomu, ale prawdopodobnie istnieją funkcje wyższego poziomu, które zwracają również wskaźniki do struktur.

Uważam, że jest to raczej wybór projektowy niż tylko kwestia programowania i jestem ciekawy, aby dowiedzieć się więcej o zaletach i wadach tych dwóch metod.

Jednym z powodów, dla których pomyślałem, że byłoby korzystne, aby zwrócić wskaźnik do struktury, jest łatwiejsze określenie, czy funkcja zakończyła się niepowodzeniem przez zwrócenie NULLwskaźnika.

Zwrócenie pełnej struktury, która NULLbyłaby trudniejsza, mniej wydajna. Czy to ważny powód?

Istnieje kilka praktycznych powodów, dla których funkcje takie jak fopenwskaźniki powrotu zamiast instancji structtypów:

1. Chcesz ukryć reprezentację structtypu przed użytkownikiem;
2. Przydzielasz obiekt dynamicznie;
3. Odwołujesz się do pojedynczego wystąpienia obiektu za pomocą wielu odniesień;

W przypadku typów takich FILE *jest to spowodowane tym, że nie chcesz ujawniać użytkownikowi szczegółów reprezentacji typu - FILE *obiekt służy jako nieprzezroczysty uchwyt, a Ty po prostu przekazujesz ten uchwyt do różnych procedur we / wy (i chociaż FILEjest to często zaimplementowany jako structtyp, nie musi tak być).

Możesz więc ujawnić gdzieś niekompletny struct typ w nagłówku:

typedef struct __some_internal_stream_implementation FILE;

Chociaż nie możesz zadeklarować wystąpienia niekompletnego typu, możesz zadeklarować do niego wskaźnik. Więc mogę utworzyć FILE *i przypisać do niego poprzez fopen, freopenitp, ale nie mogą bezpośrednio manipulować obiekt to wskazuje.

Jest również prawdopodobne, że fopenfunkcja przydziela FILEobiekt dynamicznie, używając malloclub podobnie. W takim przypadku warto zwrócić wskaźnik.

Wreszcie możliwe jest, że przechowujesz jakiś stan w structobiekcie i musisz udostępnić ten stan w kilku różnych miejscach. Jeśli zwrócisz instancje tego structtypu, będą one oddzielnymi obiektami w pamięci i ostatecznie zsynchronizują się. Zwracając wskaźnik do jednego obiektu, wszyscy odnoszą się do tego samego obiektu.

Istnieją dwa sposoby „zwrócenia struktury”. Możesz zwrócić kopię danych lub referencję (wskaźnik) do niej. Generalnie preferowane jest zwrócenie (i ogólnie przekazanie) wskaźnika z kilku powodów.

Po pierwsze, kopiowanie struktury zajmuje dużo więcej czasu procesora niż kopiowanie wskaźnika. Jeśli jest to czynność często wykonywana przez kod, może powodować zauważalną różnicę wydajności.

Po drugie, bez względu na to, ile razy kopiujesz wskaźnik, nadal wskazuje on na tę samą strukturę w pamięci. Wszystkie modyfikacje zostaną odzwierciedlone w tej samej strukturze. Ale jeśli skopiujesz samą strukturę, a następnie dokonasz modyfikacji, zmiana pojawi się tylko na tej kopii . Kod zawierający inną kopię nie zobaczy zmiany. Czasami, bardzo rzadko, tego właśnie chcesz, ale przez większość czasu tak nie jest i może powodować błędy, jeśli pomylisz się.

Oprócz innych odpowiedzi czasem warto zwrócić niewielką struct wartość. Na przykład można zwrócić parę jednych danych i związany z nimi kod błędu (lub sukcesu).

Na przykład fopenzwraca tylko jedno dane (otwarte FILE*), aw przypadku błędu podaje kod błędu przez errnozmienną pseudo-globalną. Ale być może lepiej byłoby zwrócić jeden structz dwóch elementów: FILE*uchwyt i kod błędu (który zostałby ustawiony, jeśli uchwyt pliku jest NULL). Z przyczyn historycznych tak nie jest (a błędy zgłaszane są przez errnoglobalny, który dziś jest makrem).

Zauważ, że język Go ma niezłą notację zwracającą dwie (lub kilka) wartości.

Zauważ też, że w Linux / x86-64 ABI i konwencje wywoływania (patrz strona x86-psABI ) określają, że jeden structz dwóch elementów skalarnych (np. Wskaźnik i liczba całkowita lub dwa wskaźniki lub dwie liczby całkowite) jest zwracany przez dwa rejestry (a to jest bardzo wydajne i nie przechodzi przez pamięć).

Tak więc w nowym kodzie C zwracanie małego C structmoże być bardziej czytelne, przyjazne dla wątków i bardziej wydajne.

Jesteś na dobrej drodze

Oba wymienione przez Ciebie powody są ważne:

Jednym z powodów, dla których pomyślałem, że byłoby korzystne, aby zwrócić wskaźnik do struktury, jest łatwiejsze określenie, czy funkcja zakończyła się niepowodzeniem przez zwrócenie wskaźnika NULL.

Zwracanie PEŁNEJ struktury, która ma wartość NULL, byłoby trudniejsze lub mniej wydajne. Czy to ważny powód?

Jeśli masz teksturę (na przykład) gdzieś w pamięci i chcesz odwoływać się do tej tekstury w kilku miejscach w programie; nie byłoby rozsądnie tworzyć kopii za każdym razem, gdy chciałbyś się do niej odwoływać. Zamiast tego, jeśli po prostu przekażesz wskaźnik, aby odnieść się do tekstury, twój program będzie działał znacznie szybciej.

Największym powodem jest jednak dynamiczna alokacja pamięci. Często podczas kompilacji programu nie masz pewności, ile dokładnie pamięci potrzebujesz na określone struktury danych. Gdy tak się stanie, ilość pamięci, którą należy użyć, zostanie określona w czasie wykonywania. Możesz zażądać pamięci za pomocą „malloc”, a następnie zwolnić ją, gdy skończysz używać „free”.

Dobrym przykładem tego jest czytanie z pliku określonego przez użytkownika. W takim przypadku nie masz pojęcia, jak duży może być plik podczas kompilacji programu. Możesz tylko dowiedzieć się, ile pamięci potrzebujesz, gdy program faktycznie działa.

Zarówno malloc, jak i bezpłatne wskaźniki powrotu do lokalizacji w pamięci. Funkcje korzystające z dynamicznego przydziału pamięci zwracają wskaźniki do miejsca, w którym utworzyły swoje struktury w pamięci.

Ponadto w komentarzach widzę pytanie, czy możesz zwrócić strukturę z funkcji. Rzeczywiście możesz to zrobić. Następujące powinny działać:

struct s1 {
   int integer;
};

struct s1 f(struct s1 input){
   struct s1 returnValue = xinput
   return returnValue;
}

int main(void){
   struct s1 a = { 42 };
   struct s1 b= f(a);

   return 0;
}

Coś w rodzaju FILE*kodu nie jest tak naprawdę wskaźnikiem do struktury, jeśli chodzi o kod klienta, ale jest raczej formą nieprzezroczystego identyfikatora powiązanego z jakimś innym bytem, ​​takim jak plik. Kiedy program wywołuje fopen, na ogół nie obchodzi go żadna zawartość zwracanej struktury - wszystko, na czym mu zależy, to to, że inne funkcje freadzrobią wszystko, co trzeba z tym zrobić.

Jeśli standardowa biblioteka przechowuje FILE*informacje o np. Bieżącej pozycji odczytu w tym pliku, wywołanie do freadmusiałoby być w stanie zaktualizować te informacje. Mając freadotrzymywać wskaźnik do FILEmarek takie proste. Gdyby freadzamiast tego otrzymał FILE, nie miałby możliwości zaktualizowania FILEobiektu przechowywanego przez dzwoniącego.

Ukrywanie informacji

Jaka jest zaleta zwracania wskaźnika do struktury w porównaniu do zwracania całej struktury w instrukcji return funkcji?

Najczęstszym z nich jest ukrywanie informacji . C nie ma, powiedzmy, możliwości tworzenia pól structprywatnych, nie mówiąc już o zapewnieniu metod dostępu do nich.

Jeśli więc chcesz silnie uniemożliwić programistom wyświetlanie i manipulowanie zawartością pointee, na przykład FILE, jedynym sposobem jest zapobieganie narażeniu ich na definicję poprzez traktowanie wskaźnika jako nieprzezroczystego, którego rozmiar pointee i definicje są nieznane światu zewnętrznemu. Definicja FILEbędzie wtedy widoczna tylko dla tych, którzy wykonują operacje wymagające jej definicji, na przykład fopen, podczas gdy tylko deklaracja struktury będzie widoczna dla nagłówka publicznego.

Kompatybilność binarna

Ukrywanie definicji struktury może również pomóc w zapewnieniu oddechu w celu zachowania zgodności binarnej w interfejsach API dylib. Pozwala to implementatorom bibliotek zmieniać pola w nieprzezroczystej strukturze bez naruszania binarnej kompatybilności z tymi, którzy korzystają z biblioteki, ponieważ charakter ich kodu musi tylko wiedzieć, co mogą zrobić ze strukturą, a nie jej wielkości lub pól to ma.

Jako przykład mogę dziś uruchomić niektóre starożytne programy zbudowane w czasach Windows 95 (nie zawsze idealnie, ale zaskakująco wiele nadal działa). Istnieje prawdopodobieństwo, że część kodu tych starożytnych plików binarnych używała nieprzezroczystych wskaźników do struktur, których rozmiar i zawartość zmieniły się od czasów Windows 95. Jednak programy nadal działają w nowych wersjach systemu Windows, ponieważ nie były narażone na zawartość tych struktur. Podczas pracy nad biblioteką, w której ważna jest zgodność binarna, to, na co klient nie jest narażony, zwykle może się zmieniać bez naruszania zgodności wstecznej.

Wydajność

Zwrócenie pełnej struktury, która ma wartość NULL, byłoby trudniejsze lub mniej wydajne. Czy to ważny powód?

Zazwyczaj jest mniej wydajny, zakładając, że ten typ może praktycznie pasować i być alokowany na stosie, chyba że za sceną jest używany znacznie mniej uogólniony alokator pamięci malloc, niż , jak już przydzielona pamięć puli alokatora o stałej wielkości zamiast zmiennej. W tym przypadku jest to kompromis w zakresie bezpieczeństwa, który najprawdopodobniej pozwala twórcom bibliotek zachować niezmienniki (gwarancje koncepcyjne) FILE.

Nie jest to tak ważny powód, przynajmniej z punktu widzenia wydajności, aby fopenzwrócić wskaźnik, ponieważ jedynym powodem, dla którego zwraca NULLto niepowodzenie otwarcia pliku. Byłoby to optymalizowanie wyjątkowego scenariusza w zamian za spowolnienie wszystkich ścieżek wykonywania typowych przypadków. W niektórych przypadkach może istnieć uzasadniony powód produktywności, aby uprościć projekty, aby zwracały wskaźniki i pozwalały NULLna zwrot w określonych warunkach.

W przypadku operacji na plikach narzut jest stosunkowo dość trywialny w porównaniu z samymi operacjami na plikach, a instrukcji i fclosetak nie można uniknąć. Więc to nie tak, że możemy zaoszczędzić klientowi kłopotów z uwolnieniem (zamknięciem) zasobu poprzez ujawnienie definicji FILEi zwrócenie jej wartości fopenlub oczekiwanie znacznego wzrostu wydajności, biorąc pod uwagę względny koszt samych operacji na plikach, aby uniknąć przydziału sterty .

Hotspoty i poprawki

W innych przypadkach jednak sprofilowałem wiele marnotrawczego kodu C w starszych bazach kodów z punktami dostępowymi malloci niepotrzebnymi obowiązkowymi brakami pamięci podręcznej w wyniku zbyt częstego używania tej praktyki z nieprzejrzystymi wskaźnikami i niepotrzebnego przydzielania zbyt wielu rzeczy na stosie, czasem w duże pętle.

Alternatywną praktyką, której używam, jest ujawnianie definicji struktur, nawet jeśli klient nie ma zamiaru ich modyfikować, używając standardu konwencji nazewnictwa, aby poinformować, że nikt inny nie powinien dotykać pól:

struct Foo
{
   /* priv_* indicates that you shouldn't tamper with these fields! */
   int priv_internal_field;
   int priv_other_one;
};

struct Foo foo_create(void);
void foo_destroy(struct Foo* foo);
void foo_something(struct Foo* foo);

Jeśli w przyszłości pojawią się problemy z kompatybilnością binarną, uważam, że wystarczające jest rezerwowanie dodatkowej przestrzeni na przyszłe cele, na przykład:

struct Foo
{
   /* priv_* indicates that you shouldn't tamper with these fields! */
   int priv_internal_field;
   int priv_other_one;

   /* reserved for possible future uses (emergency backup plan).
     currently just set to null. */
   void* priv_reserved;
};

Ta zarezerwowana przestrzeń jest trochę marnotrawstwem, ale może uratować życie, jeśli w przyszłości okaże się, że musimy dodać więcej danych Foobez niszczenia plików binarnych, które korzystają z naszej biblioteki.

Moim zdaniem ukrywanie informacji i zgodność binarna to zazwyczaj jedyny słuszny powód, aby zezwolić na alokację sterty struktur oprócz struktur o zmiennej długości (które zawsze tego wymagałyby, lub przynajmniej byłyby trochę niewygodne w użyciu, gdyby klient musiał przydzielić pamięć na stosie w sposób VLA do alokacji VLS). Nawet duże struktury są często tańsze w zwracaniu według wartości, jeśli oznacza to, że oprogramowanie działa znacznie bardziej z gorącą pamięcią na stosie. I nawet jeśli nie byłyby tańsze, by zwracać wartość po stworzeniu, można po prostu to zrobić:

int foo_create(struct Foo* foo);
...
/* In the client code: */
struct Foo foo;
if (foo_create(&foo))
{
    foo_something(&foo);
    foo_destroy(&foo);
}

... aby zainicjować Fooze stosu bez możliwości zbędnej kopii. Lub klient ma nawet swobodę alokacji Foona stercie, jeśli z jakiegoś powodu tego chce.