sslcl - czyli zrzucamy stan pamięci po kosztownych obliczeniach

Od razu zacznę, że projekt nie jest górnych lotów, ale pewnie wielu początkujących programistów (w szczególności C), miałoby problemy z napisaniem czegoś podobnego. Wspomniana w tytule biblioteka rozwiązuje problem serializacji (a może cachowania) struktur danych programów popełnionych w C. Jest to kolejny projekt, popełniony całkowicie przeze mnie. Właściwie, to trudno mi określić czy jest to biblioteka do serializacji (za Wikipedią serializacja dotyczy obiektów) czy do Cachowania (za Wikipedią cachowanie dotyczy części z pełnej puli danych), ale przychylam się do cachowania.

Możliwości

Założenia są proste. Biblioteka wymaga inicjalizacji, więc podania nazwy programu i wersji, a także parametrów wejściowych i ich liczbę. Nazwa programu, jak i jego wersja musi być stringiem. Dodatkowo pozwala na wrapowanie specjalnie okrojonych funkcji, które nie powinny robić nic innego niż wykonywać obliczenia. Jednak przed podaniem do funkcji cache_this adresu funkcji wykonującej obliczenia, trzeba pozyskać wszystkie parametry mogące wpłynąć na wynik obliczeń, gdyż podamy je funkcji cache_this. Trzeba również zastanowić się nad przekazaniem mojej bibliotece informacji o serializowanych/cachowanych typach (tylko rozmiarów struktur), a także o położeniu wskaźników wewnątrz struktur tych typów, jak i typach struktur, na które te wskaźniki mają wskazywać. Całość nie jest tak ciężka, jak się wydaje.

Co i jak?

Przekazanie informacji o typach możemy wykonać sami, lub poprzez funkcję na którą wskaźnik podajemy cache_this. Ma to taką zaletę, że w razie braku konieczności ponownego wywołania naszej funkcji do obliczeń, funkcja initializująca nie zostanie wywołana (wtedy wszystkie typy są pobierane z pliku ze strukturami - trzeba pamiętać, że dla każdego typu strukturalnego pamiętamy tylko jego rozmiar i dane o wskaźnikach).

Biblioteka obsługuje więc tylko struktury, które muszą być określonych przez aplikację klas, liczby na 4 bajtach i wskaźniki. Nie obsługuje tablic, ciągów znaków, itd. W tej chwili rozważam, co dodać do przyszłego wydania, lecz nie chcę, by kod się zbytnio rozrósł.

Przykładowy program


#include <stddef.h>
#include <stdarg.h>
#include <stdlib.h>
#include <sslcl.h>

int cn;  // Identyfikator klasy dla poniższej struktury

struct test_class {

  int a;
  char b;
  struct test_class *ts;
};

// Poniżej niby przeprowadzamy obliczenia
intptr_t to_cache(void *context, va_list args)
{
  struct test_class *a = (struct test_class*) malloc(sizeof(*a));
  struct test_class *b = (struct test_class*) malloc(sizeof(*b));
  
  a->ts = b;
  b->ts = a;
  
  a->a = 1;
  a->b = 0;
  
  b->a = 0;
  b->b = 1;
  
  /* Dodajemy struktury spod a i b do kontekstu funkcji - 
     po wyjściu z funkcji, zostaną one zapisane na dysk - 
    ważne jest też poprawne określenie i typów (cn) */
  add_object_to_context(context, a, cn);
  add_object_to_context(context, b, cn);
  
  // Wynik funkcji też zostanie zapisane
  return (intptr_t)a;
}

  /* Inicjalizator powyższej funkcji - zostanie wywołany zawsze 
      przed powyższą funkcją, i tylko wtedy */
void init(va_list va_arg)
{
  // Rejestrujemy naszą klasę
  cn = register_new_class(sizeof(struct test_class));
  /* Nasza klasa zawiera jeden wskaźnik. 
   Zamiast notacji podłożonej pod drugi 
  argument, można posłużyć się makrodefinicją offsetof */
  register_class_pointer(cn, &((struct test_class *)NULL)->ts, cn);
}

int main(int argc, char **argv)
{
  struct test_class *fA;
  int error_code;
  
  // Inicjalizacja
  sslcl_init("Libsslcl internal program test 1", "0.0.1", &argc, &argv);
  
  /* Najistotniejsze - zapisujemy i wykonujemy obliczenia, 
  lub odczytujemy dane z zapisanego na dysku twardym pliku. 
  Ciąg to_cache jest częścią ścieżki pliku z cachem, podobnie jak 
  nazwa programu i jego wersja. 
  Error_code służy do informowania o wystąpieniu błędu - 
  różny od 0 w przypadku błędu. TYPE_POINTER wskazuje, że funkcja zwraca 
   wynik w postaci wskaźnika, a zero mówi, że nie przekazujemy parametrów */
  fA = (struct test_class*) cache_this(&error_code, "to_cache", to_cache, init, TYPE_POINTER,  0);
  
  printf("%p %d\n", fA, fA->a);
  printf("%p %d %d\n", fA->ts, fA->ts->a, fA->ts->b);
}

W przypadku, gdy chcemy do naszej funkcji obliczającej przekazać jakieś argumenty, to 0 należy zamienić ich liczbą, a każdą wartość/nazwę zmiennej naszego argumentu, należy poprzedzić jego typem.

Nie wykonywałem testów obciążeniowych, bo nie bardzo wiedziałem, jak je wykonać, ale biblioteka na pewno przyda się w programach długo obliczających jakieś dane. W przyszłości powinienem również usprawnić alokację pamięci, obliczając dokładną liczbę potrzebnych bajtów pamięci i przesuwając limit pamięci, przed dokonaniem alokacji.

sslcl dostępny jest na sourceforge.net.