Java Native Interface: propojujeme Javu a C/C++ – 3

7. 12. 2010 | Luboš Doležel | Programování | 3218×

Tentokrát si předvedeme lokální, globální a slabé globální reference na javovské objekty.

Obsah

• Reference
• Správné používání lokálních a globálních referencí
• Zásobník s lokálními referencemi
• Slabé globální reference
• Usnadňujeme si práci v C++
• Co bude příště

Reference

Protože javovský garbage collector (GC) nevidí do našeho nativího kódu, je dobré mu pomáhat se správou paměti. Do určité úrovně složitosti kódu ale není zapotřebí se správou referencí zabývat. Pokud vytváříme jen málo objektů a nechceme si je uchovávat "na později", můžeme se spokojit jen s tím, že GC naše objekty zruší po návratu z nativní funkce zpět do Javy. Jakmile objekty vytváříme cyklicky nebo je potřebujeme při dalších voláních, tématika referencí je pro nás důležitá.

Máme tři typy referencí:

• lokální reference – ruší se buď ručně, při pop-nutí javovského zásobníku lokálních referencí nebo nejpozději při návratu do JVM, které naší funkci zavolalo
• globální reference – jejich správa je plně v našich rukou; co zapomeneme zrušit, to bude únik paměti
• slabé globální reference – speciální typ globální reference, která bude mít hodnotu null, jakmile jsou zrušeny všechny lokální a obyčejné globální reference

Správné používání lokálních a globálních referencí

První pravidlo je, že všechna volání JNI, se kterými získáváme nový objekt, vracejí lokální referenci. Opomenutí této skutečnosti má za následek pády nebo nelogické a náhodné chování programu. Toto je tedy zásadní chyba:

jstring g_myDanglingString = NULL;

void Java_test_TestNative_pokus(JNIEnv* env, jclass myClass, jstring str)
{
    g_myDanglingString = str; // ŠPATNĚ!
}

Korektní způsob je vytvořit si vlastní referenci a nezapomenout ji ve správný moment zrušit.

jstring g_mySafeString = NULL;

void Java_test_TestNative_copy(JNIEnv* env, jclass myClass, jstring str)
{
    g_mySafeString = env->NewGlobalRef(str);
}
void Java_test_TestNative_destroy(JNIEnv* env, jclass myClass)
{
    env->DeleteGlobalRef(g_mySafeString);
    g_mySafeString = NULL;
}

Vidíme tedy dvě jednoduché funkce JNI – NewGlobalRef, které nám vytvoří novou globální referenci podle libovolné jiné reference. Protikladem je pak DeleteGlobalRef, kterým naopak reference rušíme (jen ty globální). Ekvivalentem pro lokální reference je dle očekávání NewLocalRef a DeleteLocalRef.

void Java_test_TestNative_cycle(JNIEnv* env, jclass myClass)
{
    int count = INT_MAX;
    for (int i=0; i<count; i++)
    {
        jstring str = env->NewStringUTF("cycle");
        // ...pracujeme s objektem

        // uděláme si druhou referenci
        jstring theSameStr = env->NewLocalRef(str);

        // a uklízíme po sobě
        env->DeleteLocalRef(str);
        env->DeleteLocalRef(theSameStr); // od tohoto momentu je String předmětem GC
    }
}

Zásobník s lokálními referencemi

Pokud by count bylo nějaké relativně malé číslo, program by fungoval dobře i bez používání DeleteLocalRef. S velkým číslem (jako INT_MAX) by ale jistě zhavaroval, protože javovský stack lokálních referencí by takové množství referencí nepojmul. Rovnou se podíváme na vytváření vlastních zásobníků referencí a alternativní způsob řešení takového cyklu. Co by se v čistém C++ kódu s lokálními objekty na stacku řešilo pomocí obalení do „{“ a „}“, to v JNI řeší následující pár funkcí:

• jint PushLocalFrame(jint capacity)

  Vytvoří nám nový scope („{“), neboli zásobník lokálních referencí. Kapacita zásobníku bude alespoň capacity referencí. Pokud operace uspěje, funkce vrátí nulu. V opačném případě došla paměť a čeká na nás výjimka OutOfMemoryException, kterou bychom měli zpracovat. O výjimkách si povíme v některém z dalších dílů.

• jobject PopLocalFrame(jobject result)

  Zruší poslední vytvořený scope („}“). Všechny lokální reference vytvořené od příslušného volání PushLocalFrame budou zrušeny garbage collectorem. Pokud rušíme zásobník po volání funkce, která vrací nějaký Object, předáme tento jako volitelný argument a z druhé strany nám vyleze lokální reference na tuto návratovou hodnotu s platností v tomto scope.

Naší funkci s cyklem tedy můžeme přepsat takto:

void Java_test_TestNative_cycle(JNIEnv* env, jclass myClass)
{
    int count = INT_MAX;
    for (int i=0; i<count; i++)
    {
        env->PushLocalFrame(10);

        jstring str = env->NewStringUTF("cycle");
        // ...pracujeme s objektem

        // uděláme si druhou referenci
        jstring theSameStr = env->NewLocalRef(str);

        env->PopLocalFrame(NULL); // lokální reference od předchozího PushLocalFrame se zruší
    }
}

Předvedeme si volání funkce s použitím její návratové hodnoty:

void Java_test_TestNative_outer(JNIEnv* env, jclass myClass)
{
    // děláme nějakou práci
    // .....
    // a rozhodneme se zavolat jinou funkci

    env->PushLocalFrame(10);
    jobject retval = native_inner();
    retval = env->PopLocalFrame(retval);

    // Nyní můžeme retval bezpečně používat
    // objekt bude zrušen, jakmile Java_test_TestNative_outer skončí svou práci
}

Pokud bychom „neprohnali“ retval přes PopLocalFrame, měli bychom pak v rukou neplatnou referenci.

Slabé globální reference

Abych pravdu řekl, nikdy jsem slabé globální reference nepoužil, a to ani ze strany C/C++, tak ani ze strany Javy (java.lang.ref.WeakReference). Díky nim se můžeme dozvědět, kdy byl nějaký objekt zrušen, a dokud existuje, tak jej můžeme používat. Toto chování může najít využití například při cachování.

V moment, kdy budou všechny lokální a běžné globální reference zrušeny, naše slabá reference bude ekvivalentní k null. Toto se ale může stát naprosto kdykoliv (na pozadí), proto není spolehlivé předpokládat, že reference nebude nulová, když ještě o řádek výš nebyla. Proto, než začneme nad slabou referencí provádět nějaká volání javovských metod, je pro odolnost proti race conditions nezbytné vytvořit si lokální či globální referenci. V případě, že bude objekt zrušen ještě před voláním NewLocalRef nebo NewGlobalRef na slabou referenci, vrátí tyto funkce NULL.

Samotnou slabou referenci pak musíme sami také zrušit, a to pro uvolnění paměti spojené s touto referencí na straně JNI; kvůli opomenuté slabé referenci ale nikdy nehrozí únik paměti na straně odkazovaného javovského objektu.

jweak g_myWeakRef = NULL;

void Java_test_TestNative_call1(JNIEnv* env, jclass myClass, jobject someObject)
{
    // Vytvoříme si slabou globální referenci a objekt si mezitím bude žít
    // vlastním životem

    g_myWeakRef = env->NewWeakGlobalRef(env, someObject);
}

void Java_test_TestNative_call2(JNIEnv* env, jclass myClass)
{
    // Podíváme se, jestli je reference nulová a objekt už tedy neexistuje
    if (env->IsSameObject(myWeakRef, NULL) == JNI_TRUE)
    {
        cout << "Objekt uz neexistuje\n";
    }
    else
    {
        // Víme, že objekt existoval v době volání IsSameObject
        // Teď už tomu ale může být jinak

        // Pokud chceme s objektem pracovat, můžeme přeskočit
        // volání IsSameObject a rovnou si vytvořit referenci

        jobject thatObject = env->NewLocalRef(g_myWeakRef);
        if (thatObject)
            cout << "Objekt nahle prestal existovat\n";
        else
            ; // Můžeme bez obav pracovat s referencí
    }

    // Zrušíme naší slabou referenci
    env->DeleteWeakGlobalRef(g_myWeakRef);
}

Usnadňujeme si práci v C++

Jazyk C++ má tu výhodu, že si v něm můžeme snadno ulehčit práci s referencemi. Můj vlastní přístup je takový, že mám obalující třídu JObject, která se o reference stará automaticky. U podobných wrapper tříd je vždy nutné používat globální reference: jednak proto, že objekty v C++ mohou putovat volně mimo aktuální scope (dynamicky alokované objekty) a druhak pak nemusíme řešit nějaké místo na zásobníku lokálních referencí. Vše za nás vyřeší konstruktor, destruktor a kopírovací operátor. Takto by mohla vypadat zjednodušená kostra naší třídy:

class JObject
{
public:
    JObject(jobject obj = NULL)
    : m_obj(0)
    {
       if (obj)
           m_obj = env->NewGlobalRef(obj);
    }

    JObject(const JObject& that)
    : m_obj(0)
    {
        if (that.m_obj)
            m_obj = env->NewGlobalRef(that.m_obj);
    }

    virtual ~JObject()
    {
        if (m_obj)
            env->DeleteGlobalRef(m_obj);
    }
    
    JObject& operator=(jobject obj)
    {
        if (m_obj)
            env->DeleteGlobalRef(m_obj);
        if (obj)
            m_obj = env->NewGlobalRef(obj);
        else
            m_obj = 0;
        return *this;
    }

    // a tak dále...
private:
    jobject m_obj;
};

Co bude příště

V příštím díle se vrhneme na načítání javovských tříd z nativního kódu a vytváření jejich instancí.

       

Komentáře

[Jardík]

To už jsem někde jednou četl ...

[Jardík]

Sakra, nevyšlo to už minule?

[Luboš Doležel (Doli)]

Chybou se tenhle článek už jednou krátce na úvodní stránce objevil, těžce jsem se popral s redakčním systémem a málem jsem to musel opravovat v databázi.

[Jardík]

Aha, tak to bude ono, já tu vždycky o půlnoci sedím a čekám, co vyjde

[jekub]

V tom poslednim prikladu (trida JObject) je operator= "volaaky cudny". Vypada jako zkombinovany ze dvou a prehlidnutim pri oprave.

[Luboš Doležel (Doli)]

Nevidím na něm nic špatně.

[Jardík]

Já jo:

JObject obj(jobj);
obj = obj; // tady může být problém, protože nejprve vezmeš referenci a pak ji přidáš

[Jardík]

Aha, přehlídnul jsem se, takový operátor tam není. Ale každopádně není zakázané v metodě třídy JObject provést *this = m_obj.

[jekub]

nerozumim tomu, kde se vezme to "that". nemelo by tam byt misto

env->NewGlobalRef(that.m_obj);

env->NewGlobalRef(obj);

?

[Luboš Doležel (Doli)]

Jo, pravda. Už je to dobře.

[Jardík]

A ještě bych to celý dal do bloku if (m_obj != obj) { /* ... */}, nebo ještě lépe jako argument dal const JObject& (to tam možná dříve bylo, vysvětlilo by se tím to that). Ale ono je to stejně jedno, protože java nemá neznaménkové typy a je tedy nepoužitelná