Buone Feste!

I Misteri delle Funzioni del C come funzionano alcune funzioni speciali in C - pt.2

Sig.ra Talmann: Il tuo discorso, Louis, sta diventando meteorologico.

È giunto il momento di tornare su I misteri del giardino di Compton House, anzi meglio, sulla seconda parte de I Misteri delle Funzioni del C (...e una ripassatina alla prima parte non ci starebbe male, prima di proseguire...). E giuro che cercherò di non cadere in discorsi meteorologici e incomprensibili come Louis Talmann.

...misteri? Quali misteri?...

(...una doverosa premessa: sicuramente per qualcuno, o per molti, i misteri trattati nella prima parte e, probabilmente, anche questi della seconda non sono affatto misteri. Ma voglio ribadire quanto già detto nella prima parte: girando su vari siti di programmazione (tipo l'ottimo stackoverflow, per intenderci), si nota che anche programmatori "scafati" hanno, a volte, dubbi su concetti di base (e chi non ne ha mai avuti scagli la prima pietra!) e poi, più in generale, la lettura di "un altra campana tecnica" può risultare sempre interessante, dando per scontato che la "curiosità tecnologica" è una dote che dovrebbe (anzi, deve!) essere sempre presente negli appassionati di programmazione. Che poi, se uno questa curiosità non ce l'ha... va beh, meglio fermarsi qui, No Comment...) 

Veniamo al dunque: dopo aver visto i primi tre misteri e cioè 1.Il mistero delle funzioni con un parametro array, 2.Il mistero delle funzioni che restituiscono una stringa letterale e 3.Il mistero delle funzioni che restituiscono un char pointer direi che il quarto mistero è quasi scontato, ed è:

4) Il mistero delle funzioni che restituiscono un void pointer
Nella libc ci sono un bel po' di funzioni che restituiscono un void* (per gli amici "void star"), come ad esempio quelle delle famiglia mem (memcpy(), memccpy(), ecc.). Come sono fatte? Ci sono alternative valide alla struttura "classica"? Vediamo un semplice esempio con una implementazione minimale della memcpy(), senza controlli, senza ottimizzazioni, senza tutto, ma per un esempio è più che sufficiente. Vediamo il codice, che anche in questo caso include un piccolo e semplice main() di test:

#include <stdio.h>
#include <stdlib.h>
#include <string.h>

// prototipi locali
void *myMemcpy(void *dest, const void *src, size_t len);
void *myMemcpyMalloc(void *dest, const void *src, size_t len);

// funzione main
int main(int argc, char *argv[])
{
    // eseguo myMemcpy() e mostro il risultato
    char *src1 = "pluto";
    char dest1[32];
    myMemcpy(dest1, src1, strlen(src1) + 1);
    dest1[strlen(src1)] = 0;    // ricordarsi del terminatore se copiamo una stringa
    printf("myMemcpy(): dest = %s\n", dest1);

    // eseguo myMemcpyMalloc() e mostro il risultato
    char *src2 = "minnie";
    char *dest2 = myMemcpyMalloc(dest2, src2, strlen(src2) + 1);
    dest2[strlen(src2)] = 0;    // ricordarsi del terminatore se copiamo una stringa
    printf("myMemcpyMalloc(): dest = %s\n", dest2);
    free(dest2);                // ricordarsi di questa free()

    return 0;
}

// myMemcpy - versione semplificata della memcpy() della libc
void *myMemcpy(void *dest, const void *src, size_t len)
{
    // salvo localmente dest e src ed eseguo un recast a char*
    char *my_dest = (char *)dest;
    const char *my_src  = (const char *)src;

    // copio la copia locale di src sulla copia locale di dest (copio solo <len> caratteri)
    while (len--)
        *my_dest++ = *my_src++;

    // ritorno il dest salvato
    return dest;
}

// myMemcpyMalloc - versione con malloc interna di myMemcpy()
void *myMemcpyMalloc(void *dest, const void *src, size_t len)
{
    // alloco dest (N.B.: la free() la deve fare il chiamante della myMemcpyMalloc())
    dest = malloc(len);

    // salvo localmente dest e src ed eseguo un recast a char*
    char *my_dest = (char *)dest;
    const char *my_src  = (const char *)src;

    // copio la copia locale di src sulla copia locale di dest (copio solo <len> caratteri)
    while (len--)
        *my_dest++ = *my_src++;

    // ritorno il dest salvato
    return dest;
}

Anche in questo caso il meccanismo è semplice e quasi identico a quello della strncpy() mostrato nella parte 1 dell'articolo. Senza entrare di nuovo nei dettagli (per non ripeterci, e poi il codice è ben commentato), notiamo che la unica differenza vera è che la copia viene eseguita usando copie locali di src e dest "ricastate" a char: perché? La riposta è semplice: questo tipo di funzioni accettano parametri generici (grazie all'uso di void*), quindi si possono passare pointer a strutture, array, ecc. Ma poi, internamente, la copia si fa byte-a-byte, per cui si riconduce tutto al (magico) tipo char*. E, ovviamente, si ritorna sempre l'argomento dest originale, per i motivi già descritti sopra. E anche in questo caso ho pensato di aggiungere una memcpy() poco canonica, con allocazione interna, per la quale valgono tutte le considerazione fatte per la myStrncpyMalloc() già descritta.

Notare che, per coerenza con gli esempi della prima parte del post (e anche per mostrare con semplicità un risultato pratico) ho usato le due myMemcpy() per copiare una stringa (non è un uso classico, ma chi lo vieta?). Ovviamente ho provveduto, a livello main(), ad aggiungere un string terminator, visto che la myMemcpy() a differenza della myStrncpy() già vista, non può (anzi, non deve) pensare a eventuali terminatori di stringa già che è una funzione generica di copia di memoria.

E adesso possiamo cambiare un po' argomento (basta con 'ste funzioni di copia!) e possiamo passare, per esempio a:

5) il mistero delle funzioni con vettori di pointer
Come possiamo generare e maneggiare un vettore di pointer (o meglio: pointer-to-pointers, per gli amici star-star) usando funzioni? Vediamo un esempio semplice semplice, con il solito main() per mostrare i risultati:

#include <stdio.h>
#include <stdlib.h>

#define N_ELEMS 3   // numero di elementi da allocare nel vettore

// una semplice struttura di dati
typedef struct {
    int  id;
    char name[32];
} s_data;

// prototipi locali
s_data **allocVect(s_data **dest, size_t n_elems);
void   freeVect(s_data **dest, size_t n_elems);

// funzione main
int main(int argc, char *argv[])
{
    // alloco il vettore per il test
    s_data **datalist = allocVect(datalist, N_ELEMS);

    // scorro il vettore e mostro il contenuto
    for (int i = 0; i < N_ELEMS; i++)
        printf("allocVect(): datalist[%d]: id=%d name=%s\n",
               i, datalist[i]->id, datalist[i]->name);

    // libero il vettore
    freeVect(datalist, N_ELEMS);

    return 0;
}

// allocVect - alloca un vettore di pointer
s_data **allocVect(s_data **dest, size_t n_elems)
{
    // alloco il pointer-to-pointers
    dest = malloc(n_elems * sizeof(s_data));

    // alloco i pointer
    for (int i = 0; i < n_elems; i++) {
        dest[i] = malloc(sizeof(s_data));

        // questa parte è solo un esempio per mettere dei dati da mostrare nel main()
        dest[i]->id = i;
        snprintf(dest[i]->name, sizeof(dest[i]->name), "name_%d", i);
    }

    // ritorna il pointer-to-pointers
    return dest;
}

// freeVect - libera un vettore di pointer
void freeVect(s_data **dest, size_t n_elems)
{
    // scorro il vettore e libero ogni pointer
    for (int i = 0; i < n_elems; i++)
        free(dest[i]);

    // libera il pointer-to-pointers
    free(dest);
}

Avete visto? Ho scritto due semplicissime funzioni per allocare e liberare un vettore di puntatori (star-star), e la chiave del funzionamento (ben commentata, direi) è la seguente: quando abbiamo un vettore di pointer bisogna creare prima il pointer-to-pointers base (con malloc()) e poi bisogna creare i singoli puntatori del vettore (sempre con malloc()). E quando si libera il vettore bisogna, ovviamente, seguire l'ordine inverso (prima i puntatori singoli e poi il pointer-to-pointers principale). nell'esempio appena mostrato ho aggiunto nel loop di creazione una inserzione di dati, per avere qualcosa da mostrare nel main(): compilatelo, vi assicuro che funziona...

Notare che in questo caso il meccanismo di passaggio e uso degli argomenti è quello visto negli esempi "non canonici" visti nei precedenti misteri: si passa un argomento spurio (un dest non allocato) e lo si restituisce allocato al chiamante. Semplice, no?

E dopo questo esempio credo che siamo pronti per l'ultimo mistero di questa seconda e (per il momento) ultima parte dell'articolo:

6) il mistero delle funzioni per maneggiare linked-list
Le linked-list sono uno dei grandi misteri del C, eppure sono utilissime, e sono anche molto semplici da usare! Vediamo un esempio veramente elementare:

#include <stdio.h>
#include <stdlib.h>

#define N_NODES 3   // numero di nodi nella linked list

// nodo di una linked list singola con campo dati
typedef struct snode {
    int data;
    struct snode *next;
} node_t;

// prototipi locali
void addNode(node_t **head, int data);

// funzione main
int main(int argc, char *argv[])
{
    // init lista vuota e inserisce con addNode() N_NODES nodi con data = indice loop
    node_t *head = NULL;
    for (int i = 1; i <= N_NODES; i++)
        addNode(&head, i);

    // scorre la lista e stampa i valori (compresi gli indirizzi)
    node_t *my_head = head;
    printf("my_head=%p\n", my_head);
    while (my_head) {
        printf("data=%d (my_head=%p next=%p)\n", my_head->data, my_head, my_head->next);
        my_head = my_head->next ;
    }

    return 0;
}

// addNode - alloca in testa a una lista un node con dati e puntatore al prossimo elemento
void addNode(node_t **head, int data)
{
    // alloca un nuovo node
    node_t *node = malloc(sizeof(node_t));
    node->data = data;
    node->next = *head;

    // assegna head lista al nuovo node
    *head = node;
}

Cosa dire? più elementare di così! Eppure funziona... Come si evince dagli abbondanti commenti per fare una linked-list basta creare un punto di inizio (un "head") e aggiungere nodi con una semplicissima funzione che ho chiamato (in modo veramente originale) addNode(). Il segreto sta nella struttura del "nodo", che deve sempre contenere un puntatore al nodo successivo (ma va? Sarà mica per questo che si chiamano linked-list?). Ovviamente l'esempio fornito è abbastanza limitato, e mancano le funzioni per cancellare nodi, per appendere (invece di aggiungere) nodi, oppure per gestire la lista in modo doppio (double-linked-list), ecc., ecc. Ma sulla (solida) base fornita è possibile costruire, in modo relativamente semplice, tutte le estensioni che vogliamo.

Una ultima cosa: notare che il main() mostra, a titolo di esempio, il campo data dei nodi aggiunti insieme agli indirizzi del nodo corrente e del prossimo, e questo ci aiuta a vedere in pratica come funziona il meccanismo.

Beh, direi che con i tre misteri di oggi abbiamo svelato ulteriori dettagli arcani delle funzioni C. Ne rimangono ancora molti, ma per il momento ci prenderemo una pausa, perché sento già friggere molti neuroni e non vorrei creare danni irreversibili...

Ciao e al prossimo post!

I Misteri delle Funzioni del C come funzionano alcune funzioni speciali in C - pt.1

Mr. Neville: quattro indumenti e una scala non ci portano a un cadavere.
Sig.ra Talmann: Sig. Neville, non ho parlato di un cadavere.

Nel gran film I misteri del giardino di Compton House, un disegnatore (un programmatore?) riceve l'incarico di disegnare 12 disegni (12 funzioni?) di una aristocratica casa di campagna: si scoprirà, poi, che ogni disegno contiene e rappresenta un mistero (come funziona questa funzione?). Ebbene, girando su vari siti di programmazione (tipo l'ottimo stackoverflow, per intenderci), ho notato che, a volte, anche programmatori "scafati" hanno dubbi su concetti di base (...ammettiamolo, siamo umani...). Ecco, oggi parleremo di funzioni: sono il pane quotidiano di ogni programmatore C eppure, in alcuni casi, hanno un funzionamento misterioso. Vediamone qualcuna...

...siamo qui riuniti per spiegare una funzione misteriosa...

Cominciamo con un caso semplice semplice, che possiamo chiamare così:

1) Il mistero delle funzioni con un parametro array
Quando dobbiamo passare un array a una funzione è meglio usare come argomento un array? E quando dobbiamo passare un pointer è meglio usare un argomento pointer? Beh, visto che il caso è semplice diamo subito la risposta: È la stessa cosa! Gli argomenti array di una funzione vengono (magicamente) trasformati in pointer dal compilatore: è un comportamento standard  ben documentato anche sul mitico K&R:

"Quando il nome di un vettore viene passato ad una funzione, ciò che viene passato è la posizione dell’elemento iniziale. All’interno della funzione chiamata, questo argomento è una variabile locale, quindi un nome di vettore passato come parametro è in realtà un puntatore, ovvero una variabile che contiene un indirizzo." (Il Linguaggio C - 2a.ed. - B.W.Kernighan, D.M.Ritchie)

Comunque, già che ci siamo, vediamo due piccoli esempi che ci serviranno anche più avanti. Vai con l'esempio che usa l'array!

// prototipi locali
void myfunc(char arg[]);

// funzione main
int main(int argc, char *argv[])
{
    // set variabile e chiamo myfunc()
    char string[] = "pippo";
    myfunc(string);

    return 0;
}

// funzione myfunc con array
// anche mettendo la dimensione (i.e.: char arg[100]) il codice 
// generato è identico
void myfunc(char arg[])
{
    char a = arg[3]
}

E, a seguire, l'esempio che usa il pointer!

// prototipi locali
void myfunc(char *arg);

// funzione main
int main(int argc, char *argv[])
{
    // set variabile e chiamo myfunc()
    char *string = "pippo";
    myfunc(string);

    return 0;
}

// funzione myfunc con pointer
// questa è la versione a cui viene ricondotta dal compilatore una eventuale 
// versione con array
void myfunc(char *arg)
{
    char a = arg[3];
}

Allora: le due funzioni myFunc() sono perfettamente equivalenti, o meglio: la myFunc() con l'array si trasforma in quella con il pointer (e non importa se scriviamo anche la dimensione dell'array: 10, 100, 1000, non cambia nulla!). E per quelli che sono come San Tommaso (che non ci crede se non ci mette il naso) consiglio un piccolo esperimento: compilare per ottenere l'assembly (con gcc -S, per esempio) e verificare che il codice delle funzioni è identico, e che le uniche differenze sono nel corpo del main()... ma non dovrebbe essere praticamente identico anche quest'ultimo? Forse che "char *string = "pippo";" sviluppa codice assembly molto diverso da quello di "char string[] = "pippo";"? Ebbene si, quindi siamo pronti per analizzare un altro mistero:

2) Il mistero delle funzioni che restituiscono una stringa letterale
Sicuramente saprete tutti che una funzione non deve mai restituire l'indirizzo di una variabile locale (vabbè: una variabile automatica allocata nello stack della funzione), perché quando la funzione "esce" la variabile va out-of-scope e l'indirizzo passato al chiamante non è più valido. E allora come si fa una funzione che ritorna una stringa? Vediamo un esempio:

#include <stdio.h>

// prototipi locali
char *myfunc1(void);
char *myfunc2(void);

// funzione main
int main(int argc, char *argv[])
{
    // mostro il risultato delle funzioni
    printf("myfunc1(): %s\n", myfunc1());
    printf("myfunc2(): %s\n", myfunc2());

    return 0;
}

// funzione myfunc1 - questa funziona
char *myfunc1(void)
{
    char *string = "pippo";
    return string;  // Ok: string è (implicitamente) una variabile statica
}

// funzione myfunc2 - questa non funziona
char *myfunc2(void)
{
    char string[] = "pluto";
    return string;  // NOk: string è una variabile locale (con Warning in compilazione!)

} 

a prima vista anche myFunc1() sembrerebbe un esempio da manuale di come non fare una buona funzione! Eppure funziona (leggere i commenti), e non per caso. Il fatto è che la stringa string in myFunc1() non è una variabile locale, infatti viene (implicitamente) allocata, direttamente dal compilatore, in una zona Read Only della memoria e quindi è, a tutti gli effetti, una variabile statica. Per cui l'esempio qui sopra funziona ed è la maniera migliore di fare una funzione che ritorna una stringa. Ed attenzione: se invece usiamo un array, come è il caso della myFunc2() non funziona: questo si che viene trattato come variabile locale (ecco perché i due main() del mistero numero 1 erano diversi!). Notare, infine, che myFunc1() e la sua variabile string interna dovrebbero essere dichiarate const, visto che la stringa "pippo" ritornata non è modificabile, quindi usando il qualificatore const permettiamo al compilatore di segnalarci eventuali operazioni non permesse (provate a modificare il contenuto di una inmutable string, vedrete che bell'effetto!). Ho scritto "dovrebbero essere dichiarate const" in corsivo perché non è obbligatorio: è solo consigliabile farlo, ma non è che rende il codice a prova di bomba...

E dopo aver visto i due casi precedenti siamo ben preparati e pronti a vedere il terzo mistero:

3) Il mistero delle funzioni che restituiscono un char pointer
Nella libc ci sono un bel po' di funzioni che restituiscono un char* (per gli amici "char star"), come ad esempio quelle delle famiglia string. Come sono fatte? Ci sono alternative valide alla struttura "classica"? Vediamo un esempio con una implementazione minimale delle strcpy() e strncpy(), senza controlli, senza ottimizzazioni, senza tutto, ma per un esempio è più che sufficiente. Vediamo il codice, che include anche un piccolo e semplice main() di test:

#include <stdio.h>
#include <stdlib.h>
#include <string.h>

// prototipi locali
char *myStrcpy(char *dest, const char *src);
char *myStrncpy(char *dest, const char *src, size_t len);
char *myStrncpyMalloc(char *dest, const char *src, size_t len);

// funzione main
int main(int argc, char *argv[])
{
    // eseguo myStrcpy() e mostro il risultato
    char *src1 = "pippo";
    char dest1[32];
    printf("myStrcpy(): dest = %s\n", myStrcpy(dest1, src1));

    // eseguo myStrncpy() e mostro il risultato
    char *src2 = "paperino";
    char dest2[32];
    printf("myStrncpy(): dest = %s\n", myStrncpy(dest2, src2, strlen(src2)));

    // eseguo myStrncpyMalloc() e mostro il risultato
    char *src3 = "paperone";
    char *dest3 = myStrncpyMalloc(dest3, src3, strlen(src3));
    printf("myStrncpyMalloc(): dest = %s\n", dest3);
    free(dest3);    // ricordarsi di questa free()

    return 0;
}

// myStrcpy - versione semplificata della strcpy() della libc
char *myStrcpy(char *dest, const char *src)
{
    // salvo localmente dest
    char *my_dest = dest;

    // loop per copiare src sulla copia locale di dest
    while (*src)
       *my_dest++ = *src++;

    // ritorno il dest salvato
    return dest;
}

// myStrncpy - versione semplificata della strncpy() della libc
char *myStrncpy(char *dest, const char *src, size_t len)
{
    // salvo localmente dest
    char *my_dest = dest;

    // loop per copiare src sulla copia locale di dest (copio solo <len> caratteri)
    while (*src && len--)
       *my_dest++ = *src++;

    // aggiungo il terminatore di stringa
    *my_dest = 0;

    // ritorno il dest salvato
    return dest;
}

// myStrncpy - versione con malloc interna di myStrncpy()
char *myStrncpyMalloc(char *dest, const char *src, size_t len)
{
    // alloco dest (N.B.: la free() la deve fare il chiamante della myMemcpyMalloc())
    dest = malloc(len + 1); // il +1 è per il terminatore di stringa

    // salvo localmente dest
    char *my_dest = dest;

    // loop per copiare src sulla copia locale di dest (copio solo <len> caratteri)
    while (*src && len--)
       *my_dest++ = *src++;

    // aggiungo il terminatore di stringa
    *my_dest = 0;

    // ritorno il dest salvato
    return dest;
}

Avete notato la semplicità del meccanismo? Nella myStrcpy() Si salva localmente il destino <dest> e, in un loop, si copia "byte-a-byte" <src> sulla copia locale di <dest> (fermandosi quando si raggiunge il terminatore di stringa di <src>). Infine, si restituisce il pointer originale <dest> e non la sua copia. E perché l'originale? perchè l'operazione viene eseguita incrementando i pointer di <src> e <dest>, quindi dobbiamo restituire il pointer originale e non quello incrementato nel loop. E la myStrncpy()? Come si nota è formalmente identica alla myStrcpy(), con la unica differenza che usa un argomento addizionale <len> per copiare solo <len> caratteri (invece di arrivare fino al terminatore di stringa). Il terminatore viene aggiunto poi internamente alla funzione, proprio perché è possibile che la copia non arrivi fino alla fine della stringa originale.

E visto che volevo strafare (si, strafacciamo: Punto! Due punti!... ma sì, fai vedere che abbondiamo... Abbondandis in abbondandum...) ho creato e aggiunto anche un altra funzione, la myStrncpyMalloc(), che è una versione poco canonica della strncpy() che si occupa anche di allocare internamente (con malloc()) il destino della copia: è molto comoda, visto che possiamo passare direttamente un pointer non allocato nell'argomento <dest> (vedi il main() qui sopra), ma poi dobbiamo ricordarci di liberarlo! (vedi di nuovo il main() qua sopra). E se ci dimentichiamo di fare la free() sono dolori...

Beh, direi che con i tre misteri di oggi abbiamo già svelato molti dettagli arcani di alcune funzioni C. Ne rimangono ancora molti, e avremo tempo di parlarne più avanti nella seconda parte del post dove, sicuramente, troveremo un altro vecchio amico: void* (per gli amici "void star")... e mi raccomando: non trattenete il respiro nell'attesa...

Ciao e al prossimo post!