Uclang - použití modulů v C/C++

Portál AbcLinuxu, 30. dubna 2025 14:00

Uclang - použití modulů v C/C++

21.7.2015 11:25 | Přečteno: 1016× | Vývoj software | Výběrový blog | poslední úprava: 21.7.2015 11:26

Několikrát jsem se v předcházejících zápiscích zmínil o možnosti využití modulů jazyka uclang v programovacím jazyku C/C++. Za tímto účelem obsahuje kompilace jazyka uclang knihovnu libnode a modul node, které v C/C++ umožňují napojení na ostatní moduly jazyka uclang, a jejich využití při implementaci aplikací.

Mějte prosím na paměti, že níže uvedený text popisuje fungující koncept, který ještě není promyšlený do nejpodrobnějších detailů.

Základní princip

Program napsaný v jazyce C/C++ využívá hlavičkový soubor p.ucl_libnode.h, který obsahuje informace potřebné pro práci s proměnnými jazyka uclang. Proměnné jsou v programu používány prostřednictvím objektů třídy UclVar (uclang variable), které se samy starají o správu dynamické pamětí, počítání referencí na data a jiné detaily, o které se programátor využívající modul starat nemusí.

Inicializace modulů

Pro inicializaci a uvolnění vybraných modulů se využívá globální objekt g_UclNode třídy UclNode, reprezentující napojení na vlákno interpretu, které je sdílené všemi objekty třídy UclVar.

Inicializace globálního vlákna interpretu se provede zavoláním metody Initialize objektu g_UclNode:

g_UclNode.Initialize(modules);

Výše uvedená metoda akceptuje parametr typu const char **, reprezentující ukazatel na řetězce, obsahující jména modulů, které mají být v rámci inicializace interpretu importovány. Seznam jmen modulů je ukončen nulovým ukazatelem. Seznam identifikující importované moduly může být vytvořen následujícím způsobem:

// - select modules to import -
const char *modules[] = {"sys","containers","json",NULL};

Uvolnění modulů

Uvolnění globálního vlákna interpretu se provede zavoláním metody Clear objektu g_UclNode. V rámci tohoto volání jsou uvolněny všechny proměnné, které byly doposud aktivní (tj. počítadlo referencí na tuto proměnnou bylo nenulové).

g_UclNode.Clear();

Chyby a výjimky

Metody objektů jazyka uclang vyhazují výjimky stejným způsobem, jako při jejich volání v rámci interpretace zdrojového kódu. S tímto je potřeba počítat a při každém použití objektu třídy UclVar tyto výjimky odchytávat.

Výjimky se vyskytují na dvou úrovních, na úrovni jazyka uclang a na úrovni jazyka C/C++. V případě vyhození výjimky v jazyce uclang je tato výjimka popsána objektem, který je součástí vlákna interpretu. Jazyku C/C++ je informace o existenci výjimky předána vyhozením řetězce "Exception". Po odchycení C/C++ výjimky je možné informace o uclang výjimce vytisknou zavoláním metody PrintExceptionMessage.

g_UclNode.PrintExceptionMessage();

Objekty třídy UclVar vyhazují jako výjimky i řetězce, jejichž obsah popisuje chybu, která nastala. Aktuálně existuje pouze jedna událost generující takovouto výjimku, a tou je požadavek na získání C/C++ datového typu z UclVar proměnné, která neobsahuje odpovídající data.

UclVar num = 1024;
const char *data = num.__str();

Příklady programů

Zde uvedu několik jednoduchých programů demonstrujících použití proměnných UclVar.

Slovník jazyka uclang

Zdrojový soubor dict.cc obsahuje implementaci programu demonstrujícího využití slovníku z modulu containers v jazyce C/C++. Kromě kroků popsaných v rámci základních principů provádí i následující operace:

Vytvoření pole obsahujícího čtyři celé čísla.

// - create simple array -
UclVar array_data[] = {1,2,3,4};
UclVar array(ARRAY_LENGTH(array_data),array_data);

V případě, že byl uclang kompilován překladačem podporujícím C++11 je možné výše uvedené provést následovně:

UclVar array = {1,2,3,4};

Vytvoření nového slovníku prostřednictvím jeho konstruktoru.

// - create new dictionary -
UclVar dict = UclVar::Dict();

Nastavení několika hodnot slovníku, kde klíče jsou tvořeny proměnnými různých datových typů.

// - fill dictionary with data -
dict[1]       = "Number";
dict["Hello"] = "String";
dict[array]   = "Array";
dict[UclVar::Dict(array)] = "Dict";

Vytisknutí obsahu slovníku na standardní výstup.

// - print dictionary content -
printf("dict: %s\n",dict.to_string().__str());

Odpovídající výstup programu.

dict: [1:Number,Hello:String,[1,2,3,4]:Array,[1:2,3:4]:Dict]

Vytisknutí nastavených položek slovníku na standardní výstup.

// - access dictionary data -
printf("%s\n",dict[1].__str());
printf("%s\n",dict["Hello"].__str());
printf("%s\n",dict[array].__str());
printf("%s\n",dict[UclVar::Dict(array)].__str());

Odpovídající výstup programu.

Number
String
Array
Dict

Modul json

Zdrojový soubor json.cc obsahuje implementaci programu demonstrujícího využití modulu json v jazyce C/C++. Kromě kroků popsaných v rámci základních principů provádí i následující operace:

Vytvoření pole pro uložení seznamu osob.

// - create persons array -
UclVar persons = UclVar::Array();

Vytvoření objektů reprezentujících osoby a jejich vložení do seznamu osob.

UclVar person = UclVar::Dict();
person["name"] = "Avone";
person["surname"] = "Barksdale";
persons.push(person);

person = UclVar::Dict();
person["name"] = "Omar";
person["surname"] = "Little";
persons.push(person);

person = UclVar::Dict();
person["name"] = "Frank";
person["surname"] = "Sobotka";
persons.push(person);

Vytvoření slovníku reprezentujícího objekt, který bude převáděn do JSON řetězce.

// - create object dictionary -
UclVar data = UclVar::Dict();
data["count"] = persons.length();
data["persons"] = persons;

V případě, že byl uclang kompilován překladačem podporujícím C++11 je možné výše uvedené vytvoření objektu zapsat následovně:

UclVar persons = {
  UclVar::Dict({"name","Avone","surname","Barksdale"}),
  UclVar::Dict({"name","Omar","surname","Little"}),
  UclVar::Dict({"name","Frank","surname","Sobotka"})
};

UclVar data = UclVar::Dict({"count",persons.length(),"persons",persons});

Následuje vytvoření JSON řetězce a jeho vytištění na standardní výstup.

// - create json string from data -
UclVar json_str = UclVar::Json::create(data);
printf("json_str: %s\n",json_str.__str());

Odpovídající výstup programu.

json_str: {"count":3,"persons":[{"name":"Avone","surname":"Barksdale"},{"name":"Omar","surname":"Little"},{"name":"Frank","surname":"Sobotka"}]}

Vytvoření objektu (slovníku) z JSON řetězce, jeho převedení na řetězec a vytištění na standardní výstup.

// - parse json string -
UclVar json_data = UclVar::Json::parse(json_str);
printf("json_data: %s\n",json_data.to_string().__str());

Odpovídající výstup programu.

json_data: [count:3,persons:[[name:Avone,surname:Barksdale],[name:Omar,surname:Little],[name:Frank,surname:Sobotka]]]

Modul jit

Zdrojový soubor jit.cc obsahuje implementaci programu demonstrujícího využití modulu jit v jazyce C/C++. Kromě kroků popsaných v rámci základních principů provádí i následující operace:

Vytvoření nového JIT kontextu.

// - create jit context -
UclVar jit_ctx = UclVar::JitContext();

Vytvoření JIT funkce počítající nerekurzivní faktoriál.

// - create factorial function -
UclVar fact_fun = jit_ctx.create_fun(
"i64 fact(i64 a_num)\n"
"{\n"
"  i64 result = 1;\n"
"  while (a_num > 1) result *= a_num--;\n"
"  return result;\n"
"}\n"
);

Zavolání funkce počítající faktoriál.

{
  GET_ARRAY(args,{(long long int)10});
  printf("fact(10): %s\n",fact_fun.call(args).to_string().__str());
}

Odpovídající výstup programu.

fact(10): 3628800

Vytvoření JIT funkce, která volá výše vytvořenou funkci počítající faktoriál pro posloupnost čísel od 1 do a_cnt a výsledek ukládá do paměti identifikované ukazatelem.

// - create jit function -
UclVar jit_fun = jit_ctx.create_fun(
"i32 test(u64 a_ptr,i64 a_cnt)\n"
"{\n"
"  i32 *ptr = (i32 *)a_ptr;\n"
"  i32 *ptr_end = ptr + a_cnt;\n"
"\n"
"  i32 idx = 1;\n"
"  if (ptr < ptr_end)\n"
"  {\n"
"    do {\n"
"      *ptr = fact(idx++);\n"
"    } while(++ptr < ptr_end);\n"
"  }\n"
"\n"
"  return 0;\n"
"}\n"
);

Vytvoření prázdného bloku paměti, a výpis jeho obsahu. Zavolání výše vytvořené funkce a opětovný výpis obsahu bloku.

int num_cnt = 10;
int nums[num_cnt];

memset(nums,0,num_cnt*sizeof(int));
for (int idx=0;idx<num_cnt;idx++) printf("%d, ",nums[idx]); printf("\n");

{
  GET_ARRAY(args,{(long long int)nums MP_COMMA num_cnt});
  UclVar res = jit_fun.call(args);
}

for (int idx=0;idx<num_cnt;idx++) printf("%d, ",nums[idx]); printf("\n");

Odpovídající výstup programu.

0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 
1, 2, 6, 24, 120, 720, 5040, 40320, 362880, 3628800,

Další informace

Je zřejmé, že výpočet realizovaný voláním metod nad zásobníkem vlákna interpretu bude z principu podstatně pomalejší než výpočet realizovaný v C/C++. Proto není vhodné takto implementovat složité algoritmy provádějící náročné výpočty. Hlavní motivace spočívá ve využití ověřených modulů, volání kódu zapsaného ve skriptovacím jazyce a sdílení dat mezi C/C++ a interpretem skriptovacího jazyka.

Otestování jazyka uclang v jazyce C/C++

Otestovat jazyk uclang, včetně jeho použití v jazyce C/C++ je možné prostřednictvím skriptu try_uclang.sh. Tento skript naklonuje a zkompiluje interpret jazyka uclang, včetně příkladů uvedených v tomto zápisku. Aby bylo možné zkoušet jednotlivé skripty, nebo pouštět programy využívající moduly jazyka uclang je potřeba nastavit proměnnou prostředí LD_LIBRARY_PATH, tak aby obsahovala adresář uclang/uclang_build. Způsob nastavení této proměnné je možné vyčíst ze skriptu try_uclang.sh.