1 \chapter{I file: l'interfaccia standard ANSI C}
2 \label{cha:files_std_interface}
4 Esamineremo in questo capitolo l'interfaccia standard ANSI C per i file,
5 quella che viene comunemente detta interfaccia degli \textit{stream}. Dopo
6 una breve sezione introduttiva tratteremo le funzioni base per la gestione
7 dell'input/output, mentre tratteremo le caratteristiche più avanzate
8 dell'interfaccia nell'ultima sezione.
11 \section{Introduzione}
12 \label{sec:file_stream_intro}
14 Come visto in \capref{cha:file_unix_interface} le operazioni di I/O sui file
15 sono gestibili a basso livello con l'interfaccia standard unix, che ricorre
16 direttamente alle system call messe a disposizione dal kernel.
18 Questa interfaccia però non provvede le funzionalità previste dallo standard
19 ANSI C, che invece sono realizzate attraverso opportune funzioni di libreria,
20 queste, insieme alle altre funzioni definite dallo standard, vengono a
21 costituire il nucleo\footnote{queste funzioni sono state implementate la prima
22 volta da Ritchie nel 1976 e da allora sono rimaste sostanzialmente
23 immutate.} delle \acr{glibc}.
26 \subsection{I \textit{file stream}}
27 \label{sec:file_stream}
29 Come più volte ribadito l'interfaccia dei file descriptor è un'interfaccia di
30 basso livello, che non provvede nessuna forma di formattazione dei dati e
31 nessuna forma di bufferizzazione per ottimizzare le operazioni di I/O.
33 In \cite{APUE} Stevens descrive una serie di test sull'influenza delle
34 dimensioni del blocco di dati (il parametro \param{buf} di \func{read} e
35 \func{write}) nell'efficienza nelle operazioni di I/O con i file descriptor,
36 evidenziando come le prestazioni ottimali si ottengano a partire da dimensioni
37 del buffer dei dati pari a quelle dei blocchi del filesystem (il valore dato
38 dal campo \var{st\_blksize} di \var{fstat}).
40 Se il programmatore non si cura di effettuare le operazioni in blocchi di
41 dimensioni adeguate, le prestazioni sono inferiori. La caratteristica
42 principale dell'interfaccia degli stream è che essa provvede da sola alla
43 gestione dei dettagli della bufferizzazione e all'esecuzione delle operazioni
44 di lettura e scrittura in blocchi di dimensioni appropriate all'ottenimento
45 della massima efficienza.
47 Per questo motivo l'interfaccia viene chiamata anche interfaccia dei
48 \textit{file stream}, dato che non è più necessario doversi preoccupare
49 dei dettagli della comunicazione con il tipo di hardware sottostante
50 (come nel caso della dimensione dei blocchi del filesystem), ed un file
51 può essere sempre considerato come composto da un flusso continuo (da
52 cui il nome \textit{stream}) di dati.
54 A parte i dettagli legati alla gestione delle operazioni di lettura e
55 scrittura (sia per quel che riguarda la bufferizzazione, che le
56 formattazioni), i file stream restano del tutto equivalenti ai file descriptor
57 (sui quali sono basati), ed in particolare continua a valere quanto visto in
58 \secref{sec:file_sharing} a proposito dell'accesso condiviso ed in
59 \secref{sec:file_access_control} per il controllo di accesso.
62 \subsection{Gli oggetti \ctyp{FILE}}
65 Per ragioni storiche la struttura di dati che rappresenta uno stream è stata
66 chiamata \ctyp{FILE}, questi oggetti sono creati dalle funzioni di libreria e
67 contengono tutte le informazioni necessarie a gestire le operazioni sugli
68 stream, come la posizione corrente, lo stato del buffer e degli indicatori di
69 stato e di fine del file.
71 Per questo motivo gli utenti non devono mai utilizzare direttamente o
72 allocare queste strutture, ma usare sempre puntatori del tipo \ctyp{FILE
73 *} ottenuti dalla libreria stessa (tanto che in certi casi il termine
74 di puntatore a file è diventato sinonimo di stream). Tutte le funzioni
75 della libreria che operano sui file accettano come parametri solo
76 variabili di questo tipo, che diventa accessibile includendo l'header
81 \subsection{Gli stream standard}
82 \label{sec:file_std_stream}
84 Ai tre file descriptor standard (vedi \secref{sec:file_std_descr})
85 aperti per ogni processo, corrispondono altrettanti stream, che
86 rappresentano i canali standard di input/output prestabiliti; anche
87 questi tre stream sono identificabili attraverso dei nomi simbolici
88 definiti nell'header \file{stdio.h} che sono:
90 \begin{basedescript}{\desclabelwidth{3.0cm}}
91 \item[\var{FILE *stdin}] Lo \textit{standard input} cioè lo stream da
92 cui il processo riceve ordinariamente i dati in ingresso. Normalmente
93 è associato dalla shell all'input del terminale e prende i caratteri
95 \item[\var{FILE *stdout}] Lo \textit{standard output} cioè lo stream su
96 cui il processo invia ordinariamente i dati in uscita. Normalmente è
97 associato dalla shell all'output del terminale e scrive sullo schermo.
98 \item[\var{FILE *stderr}] Lo \textit{standard error} cioè lo stream su
99 cui il processo è supposto inviare i messaggi di errore. Normalmente
100 anch'esso è associato dalla shell all'output del terminale e scrive
104 Nelle \acr{glibc} \var{stdin}, \var{stdout} e \var{stderr} sono
105 effettivamente tre variabili di tipo \ctyp{FILE *} che possono essere
106 usate come tutte le altre, ad esempio si può effettuare una redirezione
107 dell'output di un programma con il semplice codice:
108 \begin{lstlisting}[labelstep=0,frame=,indent=1cm]{}
110 stdout = fopen("standard-output-file", "w");
112 ma in altri sistemi queste variabili possono essere definite da macro, e
113 se si hanno problemi di portabilità e si vuole essere sicuri, diventa
114 opportuno usare la funzione \func{freopen}.
117 \subsection{Le modalità di bufferizzazione}
118 \label{sec:file_buffering}
120 La bufferizzazione è una delle caratteristiche principali della
121 interfaccia degli stream; lo scopo è quello di ridurre al minimo il
122 numero di system call (\func{read} o \func{write}) eseguite nelle
123 operazioni di input/output. Questa funzionalità è assicurata
124 automaticamente dalla libreria, ma costituisce anche uno degli aspetti
125 più comunemente fraintesi, in particolare per quello che riguarda
126 l'aspetto della scrittura dei dati sul file.
128 I caratteri che vengono scritti su uno stream normalmente vengono
129 accumulati in un buffer e poi trasmessi in blocco in maniera asincrona
130 rispetto alla scrittura (quello che viene chiamato lo \textsl{scarico}
131 dei dati, dall'inglese \textit{flush}) tutte le volte che il buffer
132 viene riempito. Un comportamento analogo avviene anche in lettura (cioè
133 dal file viene letto un blocco di dati, anche se se ne sono richiesti
134 una quantità inferiore), ma la cosa ovviamente ha rilevanza inferiore,
135 dato che i dati letti sono sempre gli stessi; in caso di scrittura
136 invece, quando si ha un accesso contemporaneo allo stesso file (ad
137 esempio da parte di un altro processo) si potranno vedere solo le parti
138 effettivamente scritte, e non quelle ancora presenti nel buffer.
140 Allo stesso modo, se si sta facendo dell'input/output interattivo
141 bisognerà tenere presente le caratteristiche delle operazioni di scarico
142 dei dati, poiché non è detto che ad una scrittura sullo stream
143 corrisponda una immediata scrittura sul dispositivo.
145 Per rispondere ad esigenze diverse, lo standard definisce tre distinte
146 modalità in cui può essere eseguita la bufferizzazione, delle quali
147 occorre essere ben consapevoli, specie in caso di lettura e scrittura da
148 dispositivi interattivi:
150 \item \textit{unbuffered}: in questo caso non c'è bufferizzazione ed i
151 caratteri vengono trasmessi direttamente al file non appena possibile
152 (effettuando immediatamente una \func{write}).
153 \item \textit{line buffered}: in questo caso i caratteri vengono
154 normalmente trasmessi al file in blocco ogni volta che viene
155 incontrato un carattere di \textit{newline} (il carattere ASCII
157 \item \textit{fully buffered}: in questo caso i caratteri vengono
158 trasmessi da e verso il file in blocchi di dimensione opportuna.
161 Lo standard ANSI C specifica inoltre che lo standard output e lo
162 standard input siano aperti in modalità \textit{fully buffered} quando
163 non fanno riferimento ad un dispositivo interattivo, e che lo standard
164 error non sia mai aperto in modalità \textit{fully buffered}.
166 Linux, come BSD e SVr4, specifica il comportamento di default in maniera
167 ancora più precisa, e cioè impone che lo standard error sia sempre
168 \textit{unbuffered} (in modo che i messaggi di errore siano mostrati il più
169 rapidamente possibile) e che standard input e standard output siano aperti in
170 modalità \textit{line buffered} quando sono associati ad un terminale (od
171 altro dispositivo interattivo) ed in modalità \textit{fully buffered}
174 Il comportamento specificato per standard input e standard output vale anche
175 per tutti i nuovi stream aperti da un processo; la selezione comunque avviene
176 automaticamente, e la libreria apre lo stream nella modalità più opportuna a
177 seconda del file o del dispositivo scelto.
179 La modalità \textit{line buffered} è quella che necessita di maggiori
180 chiarimenti e attenzioni per quel che concerne il suo funzionamento. Come già
181 accennato nella descrizione, \emph{di norma} i dati vengono inviati al kernel
182 alla ricezione di un carattere di a capo; questo non è vero in tutti i casi,
183 infatti, dato che le dimensioni del buffer usato dalle librerie sono fisse, se
184 le si eccedono si può avere uno scarico dei dati anche prima che sia stato
185 inviato un carattere di \textit{newline}.
187 Un secondo punto da tenere presente, particolarmente quando si ha a che fare
188 con I/O interattivo, è che quando si effettua una lettura su uno stream che
189 comporta l'accesso al kernel\footnote{questo vuol dire sempre se lo stream da
190 cui si legge è in modalità \textit{unbuffered}.} viene anche eseguito lo
191 scarico di tutti i buffer degli stream in scrittura.
193 In \secref{sec:file_buffering_ctrl} vedremo come la libreria definisca delle
194 opportune funzioni per controllare le modalità di bufferizzazione e lo scarico
199 \section{Funzioni base}
200 \label{sec:file_ansi_base_func}
202 Esamineremo in questa sezione le funzioni base dell'interfaccia degli stream,
203 analoghe a quelle di \secref{sec:file_base_func} per i file descriptor. In
204 particolare vedremo come aprire, leggere, scrivere e cambiare la posizione
205 corrente in uno stream.
208 \subsection{Apertura e chiusura di uno stream}
209 \label{sec:file_fopen}
211 Le funzioni che si possono usare per aprire uno stream sono solo tre:
212 \func{fopen}, \func{fdopen} e \func{freopen},\footnote{\func{fopen} e
213 \func{freopen} fanno parte dello standard ANSI C, \func{fdopen} è parte
214 dello standard POSIX.1.} i loro prototipi sono:
217 \funcdecl{FILE *fopen(const char *path, const char *mode)}
218 Apre il file specificato da \param{path}.
219 \funcdecl{FILE *fdopen(int fildes, const char *mode)}
220 Associa uno stream al file descriptor \param{fildes}.
221 \funcdecl{FILE *freopen(const char *path, const char *mode, FILE *stream)}
222 Apre il file specificato da \param{path} associandolo allo stream
223 specificato da \param{stream}, se questo è già aperto prima lo chiude.
225 \bodydesc{Le funzioni ritornano un puntatore valido in caso di
226 successo e \macro{NULL} in caso di errore, in tal caso \var{errno}
227 viene settata al valore ricevuto dalla funzione sottostante di cui è
228 fallita l'esecuzione.
230 Gli errori pertanto possono essere quelli di \code{malloc} per tutte
231 e tre le funzioni, quelli \func{open} per \func{fopen}, quelli di
232 \func{fcntl} per \func{fdopen} e quelli di \func{fopen},
233 \func{fclose} e \func{fflush} per \func{freopen}.}
236 Normalmente la funzione che si usa per aprire uno stream è \func{fopen},
237 essa apre il file specificato nella modalità specificata da
238 \param{mode}, che è una stringa che deve iniziare con almeno uno dei
239 valori indicati in \tabref{tab:file_fopen_mode} (sono possibili varie
240 estensioni che vedremo in seguito).
242 L'uso più comune di \func{freopen} è per redirigere uno dei tre file
243 standard (vedi \secref{sec:file_std_stream}): il file \param{path} viene
244 associato a \param{stream} e se questo è uno stream già aperto viene
245 preventivamente chiuso.
247 Infine \func{fdopen} viene usata per associare uno stream ad un file
248 descriptor esistente ottenuto tramite una altra funzione (ad esempio con
249 una \func{open}, una \func{dup}, o una \func{pipe}) e serve quando si
250 vogliono usare gli stream con file come le fifo o i socket, che non
251 possono essere aperti con le funzioni delle librerie standard del C.
256 \begin{tabular}[c]{|l|p{8cm}|}
258 \textbf{Valore} & \textbf{Significato}\\
261 \texttt{r} & Il file viene aperto, l'accesso viene posto in sola
262 lettura, lo stream è posizionato all'inizio del file.\\
263 \texttt{r+} & Il file viene aperto, l'accesso viene posto in lettura e
264 scrittura, lo stream è posizionato all'inizio del file. \\
266 \texttt{w} & Il file viene aperto e troncato a lunghezza nulla (o
267 creato se non esiste), l'accesso viene posto in sola scrittura, lo
268 stream è posizionato all'inizio del file.\\
269 \texttt{w+} & Il file viene aperto e troncato a lunghezza nulla (o
270 creato se non esiste), l'accesso viene posto in scrittura e lettura,
271 lo stream è posizionato all'inizio del file.\\
273 \texttt{a} & Il file viene aperto (o creato se non esiste) in
274 \textit{append mode}, l'accesso viene posto in sola scrittura. \\
275 \texttt{a+} & Il file viene aperto (o creato se non esiste) in
276 \textit{append mode}, l'accesso viene posto in lettura e scrittura. \\
278 \texttt{b} & specifica che il file è binario, non ha alcun effetto. \\
279 \texttt{x} & la apertura fallisce se il file esiste già. \\
282 \caption{Modalità di apertura di uno stream dello standard ANSI C che
283 sono sempre presenti in qualunque sistema POSIX.}
284 \label{tab:file_fopen_mode}
287 In realtà lo standard ANSI C prevede un totale di 15 possibili valori
288 diversi per \param{mode}, ma in \tabref{tab:file_fopen_mode} si sono
289 riportati solo i sei valori effettivi, ad essi può essere aggiunto pure
290 il carattere \texttt{b} (come ultimo carattere o nel mezzo agli altri per
291 le stringhe di due caratteri) che in altri sistemi operativi serve a
292 distinguere i file binari dai file di testo; in un sistema POSIX questa
293 distinzione non esiste e il valore viene accettato solo per
294 compatibilità, ma non ha alcun effetto.
296 Le \acr{glibc} supportano alcune estensioni, queste devono essere sempre
297 indicate dopo aver specificato il \param{mode} con uno dei valori di
298 \tabref{tab:file_fopen_mode}. L'uso del carattere \texttt{x} serve per
299 evitare di sovrascrivere un file già esistente (è analoga all'uso
300 dell'opzione \macro{O\_EXCL} in \func{open}), se il file specificato già
301 esiste e si aggiunge questo carattere a \param{mode} la \func{fopen}
304 Un'altra estensione serve a supportare la localizzazione, quando si
305 aggiunge a \param{mode} una stringa della forma \verb|",ccs=STRING"| il
306 valore \verb|STRING| è considerato il nome di una codifica dei caratteri
307 e \func{fopen} marca il file per l'uso dei caratteri estesi e abilita le
308 opportune funzioni di conversione in lettura e scrittura.
310 Nel caso si usi \func{fdopen} i valori specificati da \param{mode} devono
311 essere compatibili con quelli con cui il file descriptor è stato aperto.
312 Inoltre i modi \cmd{w} e \cmd{w+} non troncano il file. La posizione nello
313 stream viene settata a quella corrente nel file descriptor, e le variabili di
314 errore e di fine del file (vedi \secref{sec:file_io}) sono cancellate. Il file
315 non viene duplicato e verrà chiuso alla chiusura dello stream.
317 I nuovi file saranno creati secondo quanto visto in
318 \secref{sec:file_ownership} ed avranno i permessi di accesso settati al
319 valore \macro{S\_IRUSR|S\_IWUSR|S\_IRGRP|S\_IWGRP|S\_IROTH|S\_IWOTH}
320 (pari a \macro{0666}) modificato secondo il valore di \acr{umask} per il
321 processo (si veda \secref{sec:file_umask}).
323 In caso di file aperti in lettura e scrittura occorre ricordarsi che c'è
324 di mezzo una bufferizzazione; per questo motivo lo standard ANSI C
325 richiede che ci sia un'operazione di posizionamento fra un'operazione
326 di output ed una di input o viceversa (eccetto il caso in cui l'input ha
327 incontrato la fine del file), altrimenti una lettura può ritornare anche
328 il risultato di scritture precedenti l'ultima effettuata.
330 Per questo motivo è una buona pratica (e talvolta necessario) far seguire ad
331 una scrittura una delle funzioni \func{fflush}, \func{fseek}, \func{fsetpos} o
332 \func{rewind} prima di eseguire una rilettura; viceversa nel caso in cui si
333 voglia fare una scrittura subito dopo aver eseguito una lettura occorre prima
334 usare una delle funzioni \func{fseek}, \func{fsetpos} o \func{rewind}. Anche
335 un'operazione nominalmente nulla come \code{fseek(file, 0, SEEK\_CUR)} è
336 sufficiente a garantire la sincronizzazione.
338 Una volta aperto lo stream, si può cambiare la modalità di bufferizzazione
339 (si veda \secref{sec:file_buffering_ctrl}) fintanto che non si è effettuato
340 alcuna operazione di I/O sul file.
342 Uno stream viene chiuso con la funzione \func{fclose} il cui prototipo è:
343 \begin{prototype}{stdio.h}{int fclose(FILE *stream)}
344 Chiude lo stream \param{stream}.
346 \bodydesc{Restituisce 0 in caso di successo e \macro{EOF} in caso di errore,
347 nel qual caso setta \var{errno} a \macro{EBADF} se il file descriptor
348 indicato da \param{stream} non è valido, o uno dei valori specificati
349 dalla sottostante funzione che è fallita (\func{close}, \func{write} o
353 La funzione effettua lo scarico di tutti i dati presenti nei buffer di uscita
354 e scarta tutti i dati in ingresso; se era stato allocato un buffer per lo
355 stream questo verrà rilasciato. La funzione effettua lo scarico solo per i
356 dati presenti nei buffer in user space usati dalle \acr{glibc}; se si vuole
357 essere sicuri che il kernel forzi la scrittura su disco occorrerà effettuare
358 una \func{sync} (vedi \secref{sec:file_sync}).
360 Linux supporta anche una altra funzione, \func{fcloseall}, come estensione GNU
361 implementata dalle \acr{glibc}, accessibile avendo definito
362 \macro{\_GNU\_SOURCE}, il suo prototipo è:
363 \begin{prototype}{stdio.h}{int fcloseall(void)}
364 Chiude tutti gli stream.
366 \bodydesc{Restituisce 0 se non ci sono errori ed \macro{EOF} altrimenti.}
368 \noindent la funzione esegue lo scarico dei dati bufferizzati in uscita
369 e scarta quelli in ingresso, chiudendo tutti i file. Questa funzione è
370 provvista solo per i casi di emergenza, quando si è verificato un errore
371 ed il programma deve essere abortito, ma si vuole compiere qualche altra
372 operazione dopo aver chiuso i file e prima di uscire (si ricordi quanto
373 visto in \secref{sec:proc_exit}).
376 \subsection{Lettura e scrittura su uno stream}
379 Una delle caratteristiche più utili dell'interfaccia degli stream è la
380 ricchezza delle funzioni disponibili per le operazioni di lettura e
381 scrittura sui file. Sono infatti previste ben tre diverse modalità
382 modalità di input/output non formattato:
384 \item\textsl{binario} in cui legge/scrive un blocco di dati alla
385 volta, vedi \secref{sec:file_binary_io}.
386 \item\textsl{a caratteri} in cui si legge/scrive un carattere alla
387 volta (con la bufferizzazione gestita automaticamente dalla libreria),
388 vedi \secref{sec:file_char_io}.
389 \item\textsl{di linea} in cui si legge/scrive una linea (terminata dal
390 carattere di newline \verb|\n|) alla volta, vedi
391 \secref{sec:file_line_io}.
393 ed inoltre la modalità di input/output formattato.
395 A differenza dell'interfaccia dei file descriptor, con gli stream il
396 raggiungimento della fine del file è considerato un errore, e viene
397 notificato come tale dai valori di uscita delle varie funzioni. Nella
398 maggior parte dei casi questo avviene con la restituzione del valore
399 intero (di tipo \ctyp{int}) \macro{EOF}\footnote{la costante deve essere
400 negativa, le \acr{glibc} usano -1, altre implementazioni possono avere
401 valori diversi.} definito anch'esso nell'header \file{stdlib.h}.
403 Dato che le funzioni dell'interfaccia degli stream sono funzioni di libreria
404 che si appoggiano a delle system call, esse non settano direttamente la
405 variabile \var{errno}, che mantiene il valore settato dalla system call che ha
408 Siccome la condizione di end-of-file è anch'essa segnalata come errore, nasce
409 il problema di come distinguerla da un errore effettivo; basarsi solo sul
410 valore di ritorno della funzione e controllare il valore di \var{errno}
411 infatti non basta, dato che quest'ultimo potrebbe essere stato settato in una
412 altra occasione, (si veda \secref{sec:sys_errno} per i dettagli del
413 funzionamento di \var{errno}).
415 Per questo motivo tutte le implementazioni delle librerie standard
416 mantengono per ogni stream almeno due flag all'interno dell'oggetto
417 \ctyp{FILE}, il flag di \textit{end-of-file}, che segnala che si è
418 raggiunta la fine del file in lettura, e quello di errore, che segnala
419 la presenza di un qualche errore nelle operazioni di input/output;
420 questi due flag possono essere riletti dalle funzioni:
423 \funcdecl{int feof(FILE *stream)}
424 Controlla il flag di end-of-file di \param{stream}.
425 \funcdecl{int ferror(FILE *stream)}
426 Controlla il flag di errore di \param{stream}.
428 \bodydesc{Entrambe le funzioni ritornano un valore diverso da zero se
429 i relativi flag sono settati.}
431 \noindent si tenga presente comunque che la lettura di questi flag segnala
432 soltanto che c'è stato un errore, o che si è raggiunta la fine del file in una
433 qualunque operazione sullo stream, il controllo quindi deve essere effettuato
434 ogni volta che si chiama una funzione di libreria.
436 Entrambi i flag (di errore e di end-of-file) possono essere cancellati usando
437 la funzione \func{clearerr}, il cui prototipo è:
438 \begin{prototype}{stdio.h}{void clearerr(FILE *stream)}
439 Cancella i flag di errore ed end-of-file di \param{stream}.
441 \noindent in genere si usa questa funziona una volta che si sia identificata e
442 corretta la causa di un errore per evitare di mantenere i flag attivi, così da
443 poter rilevare una successiva ulteriore condizione di errore. Di questa
444 funzione esiste una analoga \func{clearerr\_unlocked} che non esegue il blocco
445 dello stream (vedi \secref{sec:file_stream_thread}).
448 \subsection{Input/output binario}
449 \label{sec:file_binary_io}
451 La prima modalità di input/output non formattato ricalca quella della
452 interfaccia dei file descriptor, e provvede semplicemente la scrittura e
453 la lettura dei dati da un buffer verso un file e viceversa. In generale
454 questa è la modalità che si usa quando si ha a che fare con dati non
455 formattati. Le due funzioni che si usano per l'I/O binario sono:
459 \funcdecl{size\_t fread(void *ptr, size\_t size, size\_t nmemb, FILE
462 \funcdecl{size\_t fwrite(const void *ptr, size\_t size, size\_t
463 nmemb, FILE *stream)}
465 Rispettivamente leggono e scrivono \param{nmemb} elementi di dimensione
466 \param{size} dal buffer \param{ptr} al file \param{stream}.
468 \bodydesc{Entrambe le funzioni ritornano il numero di elementi letti o
469 scritti, in caso di errore o fine del file viene restituito un numero di
470 elementi inferiore al richiesto.}
473 In genere si usano queste funzioni quando si devono trasferire su file
474 blocchi di dati binari in maniera compatta e veloce; un primo caso di uso
475 tipico è quello in cui si salva un vettore (o un certo numero dei suoi
476 elementi) con una chiamata del tipo:
478 \begin{lstlisting}[labelstep=0,frame=,indent=1cm]{}
479 int WriteVect(FILE *stream, double *vec, size_t nelem)
483 if ( (nread = fwrite(vec, size, nelem, stream)) != nelem) {
484 perror("Write error");
490 in questo caso devono essere specificate le dimensioni di ciascun
491 elemento ed il numero di quelli che si vogliono scrivere. Un secondo
492 caso è invece quello in cui si vuole trasferire su file una struttura;
493 si avrà allora una chiamata tipo:
495 \begin{lstlisting}[labelstep=0,frame=,indent=1cm]{}
502 int WriteStruct(FILE *stream, struct histogram *histo, size_t nelem)
504 if ( fwrite(vec, sizeof(*histo), 1, stream) !=1) {
505 perror("Write error");
511 in cui si specifica la dimensione dell'intera struttura ed un solo
514 In realtà quello che conta nel trasferimento dei dati sono le dimensioni
515 totali, che sono sempre pari al prodotto \code{size * nelem}; la sola
516 differenza è che le funzioni non ritornano il numero di byte scritti,
517 ma il numero di elementi.
519 La funzione \func{fread} legge sempre un numero intero di elementi, se
520 incontra la fine del file l'oggetto letto parzialmente viene scartato
521 (lo stesso avviene in caso di errore). In questo caso la posizione dello
522 stream viene settata alla fine del file (e non a quella corrispondente
523 alla quantità di dati letti).
525 In caso di errore (o fine del file per \func{fread}) entrambe le
526 funzioni restituiscono il numero di oggetti effettivamente letti o
527 scritti, che sarà inferiore a quello richiesto. Contrariamente a quanto
528 avviene per i file descriptor, questo segnala una condizione di errore e
529 occorrerà usare \func{feof} e \func{ferror} per stabilire la natura del
532 Benché queste funzioni assicurino la massima efficienza per il
533 salvataggio dei dati, i dati memorizzati attraverso di esse presentano
534 lo svantaggio di dipendere strettamente dalla piattaforma di sviluppo
535 usata ed in genere possono essere riletti senza problemi solo dallo
536 stesso programma che li ha prodotti.
538 Infatti diversi compilatori possono eseguire ottimizzazioni diverse
539 delle strutture dati e alcuni compilatori (come il \cmd{gcc}) possono
540 anche scegliere se ottimizzare l'occupazione di spazio, impacchettando
541 più strettamente i dati, o la velocità inserendo opportuni
542 \textit{padding} per l'allineamento dei medesimi generando quindi output
543 binari diversi. Inoltre altre incompatibilità si possono presentare
544 quando entrano in gioco differenze di architettura hardware, come la
545 dimensione del bus o la modalità di ordinamento dei bit o il formato
546 delle variabili in floating point.
548 Per questo motivo quando si usa l'input/output binario occorre sempre
549 essere prendere le opportune precauzioni (in genere usare un formato di
550 più alto livello che permetta di recuperare l'informazione completa),
551 per assicurarsi che versioni diverse del programma siano in grado di
552 rileggere i dati tenendo conto delle eventuali differenze.
554 Le \acr{glibc} definiscono altre due funzioni per l'I/O binario, che
555 evitano il lock implicito dello stream, usato per dalla librerie per la
556 gestione delle applicazioni multi-thread (si veda
557 \secref{sec:file_stream_thread} per i dettagli):
561 \funcdecl{size\_t fread\_unlocked(void *ptr, size\_t size, size\_t
562 nmemb, FILE *stream)}
564 \funcdecl{size\_t fwrite\_unlocked(const void *ptr, size\_t size,
565 size\_t nmemb, FILE *stream)}
567 \bodydesc{Le funzioni sono identiche alle analoghe \func{fread} e
568 \func{fwrite} ma non acquisiscono il lock implicito sullo stream.}
570 \noindent entrambe le funzioni sono estensioni GNU previste solo dalle
574 \subsection{Input/output a caratteri}
575 \label{sec:file_char_io}
577 La seconda modalità di input/output è quella a caratteri, in cui si
578 trasferisce un carattere alla volta. Le funzioni per la lettura a
579 caratteri sono tre, \func{fgetc}, \func{getc} e \func{getchar}, i
580 rispettivi prototipi sono:
584 \funcdecl{int getc(FILE *stream)} Legge un byte da \param{stream} e lo
585 restituisce come intero. In genere è implementata come una macro.
587 \funcdecl{int fgetc(FILE *stream)} Legge un byte da \param{stream} e lo
588 restituisce come intero. È una sempre una funzione.
590 \funcdecl{int getchar(void)} Equivalente a \code{getc(stdin)}.
592 \bodydesc{Tutte queste funzioni leggono un byte alla volta, che viene
593 restituito come intero; in caso di errore o fine del file il valore
594 di ritorno è \macro{EOF}.}
597 A parte \func{getchar}, che si usa in genere per leggere un carattere da
598 tastiera, le altre due funzioni sono sostanzialmente equivalenti. La
599 differenza è che \func{getc} è ottimizzata al massimo e normalmente
600 viene implementata con una macro, per cui occorre stare attenti a cosa
601 le si passa come argomento, infatti \param{stream} può essere valutato
602 più volte nell'esecuzione, e non viene passato in copia con il
603 meccanismo visto in \secref{sec:proc_var_passing}; per questo motivo se
604 si passa un'espressione si possono avere effetti indesiderati.
606 Invece \func{fgetc} è assicurata essere sempre una funzione, per questo
607 motivo la sua esecuzione normalmente è più lenta per via dell'overhead
608 della chiamata, ma è altresì possibile ricavarne l'indirizzo, che può
609 essere passato come parametro ad un altra funzione (e non si hanno i
610 problemi accennati in precedenza con \param{stream}).
612 Le tre funzioni restituiscono tutte un \ctyp{unsigned char} convertito
613 ad \ctyp{int} (si usa \ctyp{unsigned char} in modo da evitare
614 l'espansione del segno). In questo modo il valore di ritorno è sempre
615 positivo, tranne in caso di errore o fine del file.
617 Nelle estensioni GNU che provvedono la localizzazione sono definite tre
618 funzioni equivalenti alle precedenti che invece di un carattere di un
619 byte restituiscono un carattere in formato esteso (cioè di tipo
620 \ctyp{wint\_t}, il loro prototipo è:
625 \funcdecl{wint\_t getwc(FILE *stream)} Legge un carattere esteso da
626 \param{stream}. In genere è implementata come una macro.
628 \funcdecl{wint\_t fgetwc(FILE *stream)} Legge un carattere esteso da
629 \param{stream} È una sempre una funzione.
631 \funcdecl{wint\_t getwchar(void)} Equivalente a \code{getwc(stdin)}.
633 \bodydesc{Tutte queste funzioni leggono un carattere alla volta, in
634 caso di errore o fine del file il valore di ritorno è \macro{WEOF}.}
637 Per scrivere un carattere si possono usare tre funzioni analoghe alle
638 precedenti usate per leggere: \func{putc}, \func{fputc} e
639 \func{putchar}; i loro prototipi sono:
643 \funcdecl{int putc(int c, FILE *stream)} Scrive il carattere \param{c}
644 su \param{stream}. In genere è implementata come una macro.
646 \funcdecl{int fputc(FILE *stream)} Scrive il carattere \param{c} su
647 \param{stream}. È una sempre una funzione.
649 \funcdecl{int putchar(void)} Equivalente a \code{putc(stdin)}.
651 \bodydesc{Le funzioni scrivono sempre un carattere alla volta, il cui
652 valore viene restituito in caso di successo; in caso di errore o
653 fine del file il valore di ritorno è \macro{EOF}.}
656 Tutte queste funzioni scrivono sempre un byte alla volta, anche se
657 prendono come parametro un \ctyp{int} (che pertanto deve essere ottenuto
658 con un cast da un \ctyp{unsigned char}). Anche il valore di ritorno è
659 sempre un intero; in caso di errore o fine del file il valore di ritorno
662 Come nel caso dell'I/O binario le \acr{glibc} provvedono per ciascuna
663 delle funzioni precedenti, come estensione GNU, una seconda funzione, il
664 cui nome è ottenuto aggiungendo un \code{\_unlocked}, che esegue
665 esattamente le stesse operazioni evitando però il lock implicito dello
668 Per compatibilità con SVID sono provviste anche due funzioni per leggere
669 e scrivere una \textit{word} (che è sempre definita come \ctyp{int}); i
674 \funcdecl{int getw(FILE *stream)} Legge una parola da \param{stream}.
675 \funcdecl{int putw(int w, FILE *stream)} Scrive la parola \param{w} su
678 \bodydesc{Le funzioni restituiscono la parola \param{w}, o \macro{EOF}
679 in caso di errore o di fine del file.}
681 \noindent l'uso di queste funzioni è deprecato in favore dell'uso di
682 \func{fread} e \func{fwrite}, in quanto non è possibile distinguere il
683 valore -1 da una condizione di errore che restituisce \macro{EOF}.
685 Una degli usi più frequenti dell'input/output a caratteri è nei
686 programmi di \textit{parsing} in cui si analizza il testo; in questo
687 contesto diventa utile poter analizzare il carattere successivo da uno
688 stream senza estrarlo effettivamente (la tecnica è detta \textit{peeking
689 ahead}) in modo che il programma possa regolarsi sulla base avendo
690 dato una \textsl{sbirciatina} a quello che viene dopo.
692 Nel nostro caso questo tipo di comportamento può essere realizzato prima
693 leggendo il carattere, e poi rimandandolo indietro, cosicché ridiventi
694 disponibile per una lettura successiva; la funzione che inverte la
695 lettura si chiama \func{ungetc} ed il suo prototipo è:
696 \begin{prototype}{stdio.h}{int ungetc(int c, FILE *stream)}
697 Rimanda indietro il carattere \param{c}, con un cast a \ctyp{unsigned
698 char}, sullo stream \param{stream}.
700 \bodydesc{La funzione ritorna \param{c} in caso di successo e
701 \macro{EOF} in caso di errore.}
703 \noindent benché lo standard ANSI C preveda che l'operazione possa
704 essere ripetuta per un numero arbitrario di caratteri, alle
705 implementazioni è richiesto di garantire solo un livello; questo è
706 quello che fa la \acr{glibc}, che richiede che avvenga un'altra
707 operazione fra due \func{ungetc} successive.
709 Non è necessario che il carattere che si manda indietro sia l'ultimo che
710 si è letto, e non è necessario neanche avere letto nessun carattere
711 prima di usare \func{ungetc}, ma di norma la funzione è intesa per
712 essere usata per rimandare indietro l'ultimo carattere letto.
714 Nel caso \param{c} sia un \macro{EOF} la funzione non fa nulla, e
715 restituisce sempre \macro{EOF}; così si può usare \func{ungetc} anche
716 con il risultato di una lettura alla fine del file.
718 Se si è alla fine del file si può comunque rimandare indietro un
719 carattere, il flag di end-of-file verrà automaticamente cancellato
720 perché c'è un nuovo carattere disponibile che potrà essere riletto
723 Infine si tenga presente che \func{ungetc} non altera il contenuto del
724 file, ma opera esclusivamente sul buffer interno. Se si esegue una
725 qualunque delle operazioni di riposizionamento (vedi
726 \secref{sec:file_fseek}) i caratteri rimandati indietro vengono
730 \subsection{Input/output di linea}
731 \label{sec:file_line_io}
733 La terza ed ultima modalità di input/output non formattato è quella di
734 linea, in cui legge o scrive una riga alla volta; questa è una modalità
735 molto usata per l'I/O da terminale, ma che presenta le caratteristiche
738 Le funzioni previste dallo standard ANSI C per leggere una linea sono
739 sostanzialmente due, \func{gets} e \func{fgets}, i cui rispettivi
744 \funcdecl{char *gets(char *string)} Scrive su \param{string} una
745 linea letta da \var{stdin}.
747 \funcdecl{char *fgets(char *string, int size, FILE *stream)}
748 Scrive su \param{string} la linea letta da \param{stream} per un
749 massimo di \param{size} byte.
751 \bodydesc{Le funzioni restituiscono l'indirizzo \param{string} in caso
752 di successo o \macro{NULL} in caso di errore.}
755 Entrambe le funzioni effettuano la lettura (dal file specificato \func{fgets},
756 dallo standard input \func{gets}) di una linea di caratteri (terminata dal
757 carattere \textit{newline}, \verb|\n|, quello mappato sul tasto di ritorno a
758 capo della tastiera), ma \func{gets} sostituisce \verb|\n| con uno zero,
759 mentre \func{fgets} aggiunge uno zero dopo il \textit{newline}, che resta
760 dentro la stringa. Se la lettura incontra la fine del file (o c'è un errore)
761 viene restituito un \macro{NULL}, ed il buffer \param{buf} non viene toccato.
762 L'uso di \func{gets} è deprecato e deve essere assolutamente evitato; la
763 funzione infatti non controlla il numero di byte letti, per cui nel caso
764 la stringa letta superi le dimensioni del buffer, si avrà un
765 \textit{buffer overflow}, con sovrascrittura della memoria del processo
768 Questa è una delle vulnerabilità più sfruttate per guadagnare accessi
769 non autorizzati al sistema (i cosiddetti \textit{exploit}), basta
770 infatti inviare una stringa sufficientemente lunga ed opportunamente
771 forgiata per sovrascrivere gli indirizzi di ritorno nello stack
772 (supposto che la \func{gets} sia stata chiamata da una subroutine), in
773 modo da far ripartire l'esecuzione nel codice inviato nella stringa
774 stessa (in genere uno \textit{shell code} cioè una sezione di programma
777 La funzione \func{fgets} non ha i precedenti problemi di \func{gets} in
778 quanto prende in input la dimensione del buffer \param{size}, che non
779 verrà mai ecceduta in lettura. La funzione legge fino ad un massimo di
780 \param{size} caratteri (newline compreso), ed aggiunge uno zero di
781 terminazione; questo comporta che la stringa possa essere al massimo di
782 \var{size-1} caratteri. Se la linea eccede la dimensione del buffer
783 verranno letti solo \var{size-1} caratteri, ma la stringa sarà sempre
784 terminata correttamente con uno zero finale; sarà possibile leggere i
785 restanti caratteri in una chiamata successiva.
787 Per la scrittura di una linea lo standard ANSI C prevede altre due
788 funzioni, \func{fputs} e \func{puts}, analoghe a quelle di lettura, i
789 rispettivi prototipi sono:
793 \funcdecl{int puts(const char *string)} Scrive su \var{stdout} la
794 linea \param{string}.
796 \funcdecl{int fputs(const char *string, FILE *stream)} Scrive su
797 \param{stream} la linea \param{string}.
799 \bodydesc{Le funzioni restituiscono un valore non negativo in caso di
800 successo o \macro{EOF} in caso di errore.}
803 Dato che in questo caso si scrivono i dati in uscita \func{puts} non ha i
804 problemi di \func{gets} ed è in genere la forma più immediata per scrivere
805 messaggi sullo standard output; la funzione prende una stringa terminata da
806 uno zero ed aggiunge automaticamente il ritorno a capo. La differenza con
807 \func{fputs} (a parte la possibilità di specificare un file diverso da
808 \var{stdout}) è che quest'ultima non aggiunge il newline, che deve essere
809 previsto esplicitamente.
811 Come per le funzioni di input/output a caratteri esistono le estensioni
812 per leggere e scrivere caratteri estesi, i loro prototipi sono:
815 \funcdecl{wchar\_t *fgetws(wchar\_t *ws, int n, FILE *stream)}
816 Legge un massimo di \param{n} caratteri estesi dal file
817 \param{stream} al buffer \param{ws}.
819 \funcdecl{int fputws(const wchar\_t *ws, FILE *stream)} Scrive la
820 linea \param{ws} di caratteri estesi sul file \param{stream}.
822 \bodydesc{Le funzioni ritornano rispettivamente \param{ws} o un numero
823 non negativo in caso di successo e \macro{NULL} o \macro{EOF} in
824 caso di errore o fine del file.}
826 \noindent il comportamento è identico a quello di \func{fgets} e
827 \func{fputs} solo che tutto (numero di caratteri massimo, terminatore
828 della stringa, newline) è espresso in termini di caratteri estesi
829 anziché di caratteri ASCII.
831 Come nel caso dell'I/O binario e a caratteri nelle \acr{glibc} sono
832 previste una serie di altre funzioni, estensione di tutte quelle
833 illustrate finora (eccetto \func{gets} e \func{puts}), il cui nome si
834 ottiene aggiungendo un \code{\_unlocked}, e che eseguono esattamente le
835 stesse operazioni delle loro equivalenti, evitando però il lock
836 implicito dello stream (vedi \secref{sec:file_stream_thread}).
838 Come abbiamo visto, le funzioni di lettura per l'input/output di linea
839 previste dallo standard ANSI C presentano svariati inconvenienti. Benché
840 \func{fgets} non abbia i gravissimi problemi di \func{gets}, può
841 comunque dare risultati ambigui se l'input contiene degli zeri; questi
842 infatti saranno scritti sul buffer di uscita e la stringa in output
843 apparirà come più corta dei byte effettivamente letti. Questa è una
844 condizione che è sempre possibile controllare (deve essere presente un
845 newline prima della effettiva conclusione della stringa presente nel
846 buffer), ma a costo di una complicazione ulteriore della logica del
847 programma. Lo stesso dicasi quando si deve gestire il caso di stringa
848 che eccede le dimensioni del buffer.
850 Per questo motivo le \acr{glibc} prevedono, come estensione GNU, due
851 nuove funzioni per la gestione dell'input/output di linea, il cui uso
852 permette di risolvere questi problemi. L'uso di queste funzioni deve
853 essere attivato definendo la macro \macro{\_GNU\_SOURCE} prima di
854 includere \file{stdio.h}. La prima delle due, \func{getline}, serve per
855 leggere una linea terminata da un newline esattamente allo stesso modo
856 di \func{fgets}, il suo prototipo è:
857 \begin{prototype}{stdio.h}
858 {ssize\_t getline(char **buffer, size\_t *n, FILE *stream)} Legge una
859 linea dal file \param{stream} sul buffer indicato da \param{buffer}
860 riallocandolo se necessario (l'indirizzo del buffer e la sua
861 dimensione vengono sempre riscritte).
863 \bodydesc{La funzione ritorna il numero di caratteri letti in caso di
864 successo e -1 in caso di errore o di raggiungimento della fine del
868 La funzione permette di eseguire una lettura senza doversi preoccupare
869 della eventuale lunghezza eccessiva della stringa da leggere. Essa
870 prende come primo parametro l'indirizzo del puntatore al buffer su cui
871 si vuole leggere la linea. Quest'ultimo \emph{deve} essere stato
872 allocato in precedenza con una \func{malloc} (non si può passare
873 l'indirizzo di un puntatore ad una variabile locale); come secondo
874 parametro la funzione vuole l'indirizzo della variabile contenente le
875 dimensioni del buffer suddetto.
877 Se il buffer di destinazione è sufficientemente ampio la stringa viene
878 scritta subito, altrimenti il buffer viene allargato usando
879 \func{realloc} e la nuova dimensione ed il nuovo puntatore vengono
880 passata indietro (si noti infatti come per entrambi i parametri si siano
881 usati dei \textit{value result argument}, passando dei puntatori anzichè
882 i valori delle variabili, secondo la tecnica spiegata in
883 \secref{sec:proc_var_passing}).
885 Se si passa alla funzione l'indirizzo ad un puntatore settato a
886 \macro{NULL} e \var{*n} è zero, la funzione provvede da sola
887 all'allocazione della memoria necessaria a contenere la linea. In tutti
888 i casi si ottiene dalla funzione un puntatore all'inizio del testo della
889 linea. Un esempio di codice può essere il seguente:
890 \begin{lstlisting}[labelstep=0,frame=,indent=1cm]{}
896 nread = getline(&ptr, &n, file);
898 e per evitare memory leak occorre ricordarsi di liberare \var{ptr} con
901 Il valore di ritorno della funzione indica il numero di caratteri letti
902 dallo stream (quindi compreso il newline, ma non lo zero di
903 terminazione); questo permette anche di distinguere eventuali zeri letti
904 dallo stream da quello inserito dalla funzione per terminare la linea.
905 Se si è alla fine del file e non si è potuto leggere nulla o c'è stato
906 un errore la funzione restituisce -1.
908 La seconda estensione GNU è una generalizzazione di \func{getline} per
909 poter usare come separatore un carattere qualsiasi, la funzione si
910 chiama \func{getdelim} ed il suo prototipo è:
911 \begin{prototype}{stdio.h}
912 {ssize\_t getdelim(char **buffer, size\_t *n, int delim, FILE *stream)}
913 Identica a \func{getline} solo che usa \param{delim} al posto del
914 carattere di newline come separatore di linea.
917 Il comportamento di \func{getdelim} è identico a quello di \func{getline} (che
918 può essere implementata da questa passando \verb|'\n'| come valore di
922 \subsection{L'input/output formattato}
923 \label{sec:file_formatted_io}
925 L'ultima modalità di input/output è quella formattata, che è una delle
926 caratteristiche più utilizzate delle librerie standard del C; in genere questa
927 è la modalità in cui si esegue normalmente l'output su terminale poiché
928 permette di stampare in maniera facile e veloce dati, tabelle e messaggi.
930 L'output formattato viene eseguito con una delle 13 funzioni della famiglia
931 \func{printf}; le tre più usate sono le seguenti:
934 \funcdecl{int printf(const char *format, ...)} Stampa su \file{stdout}
935 gli argomenti, secondo il formato specificato da \param{format}.
937 \funcdecl{int fprintf(FILE *stream, const char *format, ...)} Stampa
938 su \param{stream} gli argomenti, secondo il formato specificato da
941 \funcdecl{int sprintf(char *str, const char *format, ...)} Stampa
942 sulla stringa \param{str} gli argomenti, secondo il formato
943 specificato da \param{format}.
945 \bodydesc{Le funzioni ritornano il numero di caratteri stampati.}
947 \noindent le prime due servono per stampare su file (lo standard output
948 o quello specificato) la terza permette di stampare su una stringa, in genere
949 l'uso di \func{sprintf} è sconsigliato in quanto è possibile, se non si ha la
950 sicurezza assoluta sulle dimensioni del risultato della stampa, eccedere le
951 dimensioni di \param{str} con conseguente sovrascrittura di altre variabili e
952 possibili buffer overflow; per questo motivo si consiglia l'uso
954 \begin{prototype}{stdio.h}
955 {snprintf(char *str, size\_t size, const char *format, ...)}
956 Identica a \func{sprintf}, ma non scrive su \param{str} più di
957 \param{size} caratteri.
960 La parte più complessa di queste funzioni è il formato della stringa
961 \param{format} che indica le conversioni da fare, da cui poi deriva il numero
962 dei parametri che dovranno essere passati a seguire.
967 \begin{tabular}[c]{|l|l|p{10cm}|}
969 \textbf{Valore} & \textbf{Tipo} & \textbf{Significato} \\
972 \cmd{\%d} &\ctyp{int} & Stampa un numero intero in formato decimale
974 \cmd{\%i} &\ctyp{int} & Identico a \cmd{\%i} in output, \\
975 \cmd{\%o} &\ctyp{unsigned int}& Stampa un numero intero come ottale\\
976 \cmd{\%u} &\ctyp{unsigned int}& Stampa un numero intero in formato
977 decimale senza segno \\
979 \cmd{\%X} &\ctyp{unsigned int}& Stampano un intero in formato esadecimale,
980 rispettivamente con lettere minuscole e
982 \cmd{\%f} &\ctyp{unsigned int}& Stampa un numero in virgola mobile con la
983 notazione a virgola fissa \\
985 \cmd{\%E} &\ctyp{double} & Stampano un numero in virgola mobile con la
986 notazione esponenziale, rispettivamente con
987 lettere minuscole e maiuscole. \\
989 \cmd{\%G} &\ctyp{double} & Stampano un numero in virgola mobile con la
990 notazione più appropriate delle due precedenti,
991 rispettivamente con lettere minuscole e
994 \cmd{\%A} &\ctyp{double} & Stampano un numero in virgola mobile in
995 notazione esadecimale frazionaria\\
996 \cmd{\%c} &\ctyp{int} & Stampa un carattere singolo\\
997 \cmd{\%s} &\ctyp{char *} & Stampa una stringa \\
998 \cmd{\%p} &\ctyp{void *} & Stampa il valore di un puntatore\\
999 \cmd{\%n} &\ctyp{\&int} & Prende il numero di caratteri stampati finora\\
1000 \cmd{\%\%}& & Stampa un \% \\
1003 \caption{Valori possibili per gli specificatori di conversione in una
1004 stringa di formato di \func{printf}.}
1005 \label{tab:file_format_spec}
1008 La stringa è costituita da caratteri normali (tutti eccetto \texttt{\%}), che
1009 vengono passati invariati all'output, e da direttive di conversione, in cui
1010 devono essere sempre presenti il carattere \texttt{\%}, che introduce la
1011 direttiva, ed uno degli specificatori di conversione (riportati in
1012 \tabref{tab:file_format_spec}) che la conclude.
1017 \begin{tabular}[c]{|l|p{10cm}|}
1019 \textbf{Valore} & \textbf{Significato}\\
1022 \cmd{\#} & Chiede la conversione in forma alternativa. \\
1023 \cmd{0} & La conversione è riempita con zeri alla sinistra del valore.\\
1024 \cmd{-} & La conversione viene allineata a sinistra sul bordo del campo.\\
1025 \cmd{' '}& Mette uno spazio prima di un numero con segno di valore
1027 \cmd{+} & Mette sempre il segno ($+$ o $-$) prima di un numero.\\
1030 \caption{I valori dei flag per il formato di \func{printf}}
1031 \label{tab:file_format_flag}
1034 Il formato di una direttiva di conversione prevede una serie di possibili
1035 elementi opzionali oltre al \cmd{\%} e allo specificatore di conversione. In
1036 generale essa è sempre del tipo:
1039 % [n. parametro $] [flag] [[larghezza] [. precisione]] [tipo] conversione
1042 in cui tutti i valori tranne il \cmd{\%} e lo specificatore di conversione
1043 sono opzionali (e per questo sono indicati fra parentesi quadre); si possono
1044 usare più elementi opzionali, nel qual caso devono essere specificati in
1047 \item uno specificatore del parametro da usare (terminato da un \cmd{\$}),
1048 \item uno o più flag (i cui valori possibili sono riassunti in
1049 \tabref{tab:file_format_flag}) che controllano il formato di stampa della
1051 \item uno specificatore di larghezza (un numero decimale), eventualmente
1052 seguito (per i numeri in virgola mobile) da un specificatore di precisione
1053 (un altro numero decimale),
1054 \item uno specificatore del tipo di dato, che ne indica la dimensione (i cui
1055 valori possibili sono riassunti in \tabref{tab:file_format_type}).
1059 Dettagli ulteriori sulle varie opzioni possono essere trovati nella man page
1060 di \func{printf} e nella documentazione delle \acr{glibc}.
1065 \begin{tabular}[c]{|l|p{10cm}|}
1067 \textbf{Valore} & \textbf{Significato} \\
1070 \cmd{hh} & una conversione intera corrisponde a un \ctyp{char} con o senza
1071 segno, o il puntatore per il numero dei parametri \cmd{n} è di
1073 \cmd{h} & una conversione intera corrisponde a uno \ctyp{short} con o
1074 senza segno, o il puntatore per il numero dei parametri \cmd{n}
1075 è di tipo \ctyp{short}.\\
1076 \cmd{l} & una conversione intera corrisponde a un \ctyp{long} con o
1077 senza segno, o il puntatore per il numero dei parametri \cmd{n}
1078 è di tipo \ctyp{long}, o il carattere o la stringa seguenti
1079 sono in formato esteso.\\
1080 \cmd{ll} & una conversione intera corrisponde a un \ctyp{long long} con o
1081 senza segno, o il puntatore per il numero dei parametri \cmd{n}
1082 è di tipo \ctyp{long long}.\\
1083 \cmd{L} & una conversione in virgola mobile corrisponde a un
1085 \cmd{q} & sinonimo di \cmd{ll}.\\
1086 \cmd{j} & una conversione intera corrisponde a un \type{intmax\_t} o
1087 \type{uintmax\_t}.\\
1088 \cmd{z} & una conversione intera corrisponde a un \type{size\_t} o
1090 \cmd{t} & una conversione intera corrisponde a un \type{ptrdiff\_t}.\\
1093 \caption{Il modificatore di tipo di dato per il formato di \func{printf}}
1094 \label{tab:file_format_type}
1097 Una versione alternativa delle funzioni di output formattato, che permettono
1098 di usare il puntatore ad una lista di argomenti (vedi
1099 \secref{sec:proc_variadic}), sono le seguenti:
1103 \funcdecl{int vprintf(const char *format, va\_list ap)} Stampa su
1104 \var{stdout} gli argomenti della lista \param{ap}, secondo il formato
1105 specificato da \param{format}.
1107 \funcdecl{int vfprintf(FILE *stream, const char *format, va\_list ap)}
1108 Stampa su \param{stream} gli argomenti della lista \param{ap}, secondo il
1109 formato specificato da \param{format}.
1111 \funcdecl{int vsprintf(char *str, const char *format, va\_list ap)} Stampa
1112 sulla stringa \param{str} gli argomenti della lista \param{ap}, secondo il
1113 formato specificato da \param{format}.
1115 \bodydesc{Le funzioni ritornano il numero di caratteri stampati.}
1117 \noindent con queste funzioni diventa possibile selezionare gli argomenti che
1118 si vogliono passare ad una routine di stampa, passando direttamente la lista
1119 tramite il parametro \param{ap}. Per poter far questo ovviamente la lista dei
1120 parametri dovrà essere opportunamente trattata (l'argomento è esaminato in
1121 \secref{sec:proc_variadic}), e dopo l'esecuzione della funzione l'argomento
1122 \param{ap} non sarà più utilizzabile (in generale dovrebbe essere eseguito un
1123 \macro{va\_end(ap)} ma in Linux questo non è necessario).
1125 Come per \func{sprintf} anche per \func{vsprintf} esiste una analoga
1126 \func{vsnprintf} che pone un limite sul numero di caratteri che vengono
1127 scritti sulla stringa di destinazione:
1128 \begin{prototype}{stdio.h}
1129 {vsnprintf(char *str, size\_t size, const char *format, va\_list ap)}
1130 Identica a \func{vsprintf}, ma non scrive su \param{str} più di
1131 \param{size} caratteri.
1133 \noindent in modo da evitare possibili buffer overflow.
1136 Per eliminare alla radice questi problemi, le \acr{glibc} supportano una
1137 estensione specifica GNU che alloca dinamicamente tutto lo spazio necessario;
1138 l'estensione si attiva al solito definendo \macro{\_GNU\_SOURCE}, le due
1143 \funcdecl{int asprintf(char **strptr, const char *format, ...)} Stampa gli
1144 argomenti specificati secondo il formato specificato da \param{format} su
1145 una stringa allocata automaticamente all'indirizzo \param{*strptr}.
1147 \funcdecl{int vasprintf(char **strptr, const char *format, va\_list ap)}
1148 Stampa gli argomenti della lista \param{ap} secondo il formato specificato
1149 da \param{format} su una stringa allocata automaticamente all'indirizzo
1152 \bodydesc{Le funzioni ritornano il numero di caratteri stampati.}
1154 Entrambe le funzioni prendono come parametro \param{strptr} che deve essere
1155 l'indirizzo di un puntatore ad una stringa di caratteri, in cui verrà
1156 restituito (si ricordi quanto detto in \secref{sec:proc_var_passing} a
1157 proposito dei \textit{value result argument}) l'indirizzo della stringa
1158 allocata automaticamente dalle funzioni. Occorre inoltre ricordarsi di
1159 invocare \func{free} per liberare detto puntatore quando la stringa non serve
1160 più, onde evitare memory leak.
1162 Infine una ulteriore estensione GNU definisce le due funzioni \func{dprintf} e
1163 \func{vdprintf}, che prendono un file descriptor al posto dello stream. Altre
1164 estensioni permettono di scrivere con caratteri estesi. Anche queste funzioni,
1165 il cui nome è generato dalle precedenti funzioni aggiungendo una \texttt{w}
1166 davanti a \texttt{print}, sono trattate in dettaglio nella documentazione delle
1169 In corrispondenza alla famiglia di funzioni \func{printf} che si usano per
1170 l'output formattato, l'input formattato viene eseguito con le funzioni della
1171 famiglia \func{scanf}; fra queste le tre più importanti sono:
1173 \headdecl{stdio.h} \funcdecl{int scanf(const char *format, ...)} Esegue una
1174 scansione di \file{stdin} cercando una corrispondenza di quanto letto con il
1175 formato dei dati specificato da \param{format}, ed effettua le relative
1176 conversione memorizzando il risultato nei parametri seguenti.
1178 \funcdecl{int fscanf(FILE *stream, const char *format, ...)} Analoga alla
1179 precedente, ma effettua la scansione su \param{stream}.
1181 \funcdecl{int sscanf(char *str, const char *format, ...)} Analoga alle
1182 precedenti, ma effettua la scansione dalla stringa \param{str}.
1184 \bodydesc{Le funzioni ritornano il numero di elementi assegnati. Questi
1185 possono essere in numero inferiore a quelli specificati, ed anche zero.
1186 Quest'ultimo valore significa che non si è trovata corrispondenza. In caso
1187 di errore o fine del file viene invece restituito \macro{EOF}.}
1189 \noindent e come per le analoghe funzioni di scrittura esistono le relative
1190 \func{vscanf}, \func{vfscanf} \func{vsscanf} che usano un puntatore ad una
1193 Tutte le funzioni della famiglia delle \func{scanf} vogliono come argomenti i
1194 puntatori alle variabili che dovranno contenere le conversioni; questo è un
1195 primo elemento di disagio in quanto è molto facile dimenticarsi di questa
1198 Le funzioni leggono i caratteri dallo stream (o dalla stringa) di input ed
1199 eseguono un confronto con quanto indicato in \param{format}, la sintassi di
1200 questo parametro è simile a quella usata per l'analogo di \func{printf}, ma ci
1201 sono varie differenze. Le funzioni di input infatti sono più orientate verso
1202 la lettura di testo libero che verso un input formattato in campi fissi. Uno
1203 spazio in \param{format} corrisponde con un numero qualunque di caratteri di
1204 separazione (che possono essere spazi, tabulatori, virgole etc.), mentre
1205 caratteri diversi richiedono una corrispondenza esatta. Le direttive di
1206 conversione sono analoghe a quelle di \func{printf} e si trovano descritte in
1207 dettaglio nelle man page e nel manuale delle \acr{glibc}.
1209 Le funzioni eseguono la lettura dall'input, scartano i separatori (e gli
1210 eventuali caratteri diversi indicati dalla stringa di formato) effettuando le
1211 conversioni richieste; in caso la corrispondenza fallisca (o la funzione non
1212 sia in grado di effettuare una delle conversioni richieste) la scansione viene
1213 interrotta immediatamente e la funzione ritorna lasciando posizionato lo
1214 stream al primo carattere che non corrisponde.
1216 Data la notevole complessità di uso di queste funzioni, che richiedono molta
1217 cura nella definizione delle corrette stringhe di formato e sono facilmente
1218 soggette ad errori, e considerato anche il fatto che è estremamente macchinoso
1219 recuperare in caso di fallimento nelle corrispondenze, l'input formattato non
1220 è molto usato. In genere infatti quando si ha a che fare con un input
1221 relativamente semplice si preferisce usare l'input di linea ed effettuare
1222 scansione e conversione di quanto serve direttamente con una delle funzioni di
1223 conversione delle stringhe; se invece il formato è più complesso diventa più
1224 facile utilizzare uno strumento come il \cmd{flex} per generare un
1225 analizzatore lessicale o il \cmd{bison} per generare un parser.
1228 \subsection{Posizionamento su uno stream}
1229 \label{sec:file_fseek}
1231 Come per i file descriptor è possibile anche con gli stream spostarsi
1232 all'interno di un file per effettuare operazioni di lettura o scrittura in un
1233 punto prestabilito; questo fintanto che l'operazione di riposizionamento è
1234 supportata dal file sottostante lo stream, quando cioè si ha a che fare con
1235 quello che viene detto un file ad \textsl{accesso casuale}.
1237 In GNU/Linux ed in generale in ogni sistema unix-like la posizione nel file è
1238 espressa da un intero positivo, rappresentato dal tipo \type{off\_t}, il
1239 problema è alcune delle funzioni usate per il riposizionamento sugli stream
1240 originano dalle prime versioni di Unix, in cui questo tipo non era ancora
1241 stato definito, e che in altri sistemi non è detto che la posizione su un file
1242 venga sempre rappresentata con il numero di caratteri dall'inizio (ad esempio
1243 in VMS può essere rappresentata come numero di record, e offset rispetto al
1246 Tutto questo comporta la presenza di diverse funzioni che eseguono
1247 sostanzialmente le stesse operazioni, ma usano parametri di tipo
1248 diverso. Le funzioni tradizionali usate per il riposizionamento della
1249 posizione in uno stream sono:
1253 \funcdecl{int fseek(FILE *stream, long offset, int whence)} Sposta la
1254 posizione nello stream secondo quanto specificato tramite \param{offset}
1257 \funcdecl{void rewind(FILE *stream)} Riporta la posizione nello stream
1258 all'inizio del file.
1261 L'uso di \func{fseek} è del tutto analogo a quello di \func{lseek} per i file
1262 descriptor, ed i parametri, a parte il tipo, hanno lo stesso significato; in
1263 particolare \param{whence} assume gli stessi valori già visti in
1264 \secref{sec:file_lseek}. La funzione restituisce 0 in caso di successo e -1
1265 in caso di errore. La funzione \func{rewind} riporta semplicemente la
1266 posizione corrente all'inizio dello stream, ma non esattamente equivalente ad
1267 una \code{fseek(stream, 0L, SEEK\_SET)} in quanto vengono cancellati anche i
1268 flag di errore e fine del file.
1270 Per ottenere la posizione corrente si usa invece la funzione \func{ftell}, il
1272 \begin{prototype}{stdio.h}{long ftell(FILE *stream)}
1273 Legge la posizione attuale nello stream \param{stream}.
1275 \bodydesc{La funzione restituisce la posizione corrente, o -1 in caso
1276 di fallimento, che può esser dovuto sia al fatto che il file non
1277 supporta il riposizionamento che al fatto che la posizione non può
1278 essere espressa con un \ctyp{long int}}
1280 \noindent la funzione restituisce la posizione come numero di byte
1281 dall'inizio dello stream.
1283 Queste funzioni esprimono tutte la posizione nel file come un \func{long int},
1284 dato che (ad esempio quando si usa un filesystem indicizzato a 64 bit) questo
1285 può non essere possibile lo standard POSIX ha introdotto le nuove funzioni
1286 \func{fgetpos} e \func{fsetpos}, che invece usano il nuovo tipo
1287 \type{fpos\_t}, ed i cui prototipi sono:
1291 \funcdecl{int fsetpos(FILE *stream, fpos\_t *pos)} Setta la posizione
1292 corrente nello stream \param{stream} al valore specificato da \param{pos}.
1294 \funcdecl{int fgetpos(FILE *stream, fpos\_t *pos)} Scrive la posizione
1295 corrente nello stream \param{stream} in \param{pos}.
1297 \bodydesc{Le funzioni ritornano 0 in caso di successo e -1 in caso di
1301 In Linux, a partire dalle glibc 2.1, sono presenti anche le due funzioni
1302 \func{fseeko} e \func{ftello}, che assolutamente identiche alle precedenti
1303 \func{fseek} e \func{ftell} ma hanno argomenti di tipo \type{off\_t} anziché
1304 di tipo \ctyp{long int}.
1308 \section{Funzioni avanzate}
1309 \label{sec:file_stream_adv_func}
1311 In questa sezione esamineremo alcune funzioni avanzate che permettono di
1312 eseguire operazioni particolari sugli stream, come leggerne gli attributi,
1313 controllarne le modalità di bufferizzazione, gestire direttamente i lock
1314 impliciti per la programmazione multi thread.
1317 \subsection{Le funzioni di controllo}
1318 \label{sec:file_stream_cntrl}
1320 Al contrario di quanto avviene con i file descriptor le librerie standard del
1321 C non prevedono nessuna funzione come la \func{fcntl} per il controllo degli
1322 attributi dei file. Però siccome ogni stream si appoggia ad un file descriptor
1323 si può usare la funzione \func{fileno} per ottenere quest'ultimo, il prototipo
1325 \begin{prototype}{stdio.h}{int fileno(FILE *stream)}
1326 Legge il file descriptor sottostante lo stream \param{stream}.
1328 \bodydesc{Restituisce il numero del file descriptor in caso di successo, e
1329 -1 qualora \param{stream} non sia valido, nel qual caso setta \var{errno}
1332 \noindent ed in questo modo diventa possibile usare direttamente \func{fcntl}.
1334 Questo permette di accedere agli attributi del file descriptor sottostante lo
1335 stream, ma non ci da nessuna informazione riguardo alle proprietà dello stream
1336 medesimo. Le \acr{glibc} però supportano alcune estensioni derivate da
1337 Solaris, che permettono di ottenere informazioni utili.
1339 Ad esempio in certi casi può essere necessario sapere se un certo stream è
1340 accessibile in lettura o scrittura. In genere questa informazione non è
1341 disponibile, e si deve ricordare come il file è stato aperto. La cosa può
1342 essere complessa se le operazioni vengono effettuate in una subroutine, che a
1343 questo punto necessiterà di informazioni aggiuntive rispetto al semplice
1344 puntatore allo stream; questo può essere evitato con le due funzioni
1345 \func{\_\_freadable} e \func{\_\_fwritable} i cui prototipi sono:
1347 \headdecl{stdio\_ext.h}
1348 \funcdecl{int \_\_freadable(FILE *stream)}
1349 Restituisce un valore diverso da zero se \param{stream} consente la lettura.
1351 \funcdecl{int \_\_fwritable(FILE *stream)}
1352 Restituisce un valore diverso da zero se \param{stream} consente la
1355 \noindent che permettono di ottenere questa informazione.
1357 La conoscenza dell'ultima operazione effettuata su uno stream aperto è utile
1358 in quanto permette di trarre conclusioni sullo stato del buffer e del suo
1359 contenuto. Altre due funzioni, \func{\_\_freading} e \func{\_\_fwriting}
1360 servono a tale scopo, il loro prototipo è:
1362 \headdecl{stdio\_ext.h}
1363 \funcdecl{int \_\_freading(FILE *stream)}
1364 Restituisce un valore diverso da zero se \param{stream} è aperto in sola
1365 lettura o se l'ultima operazione è stata di lettura.
1367 \funcdecl{int \_\_fwriting(FILE *stream)}
1368 Restituisce un valore diverso da zero se \param{stream} è aperto in sola
1369 scrittura o se l'ultima operazione è stata di scrittura.
1372 Le due funzioni permettono di determinare di che tipo è stata l'ultima
1373 operazione eseguita su uno stream aperto in lettura/scrittura; ovviamente se
1374 uno stream è aperto in sola lettura (o sola scrittura) la modalità dell'ultima
1375 operazione è sempre determinata; l'unica ambiguità è quando non sono state
1376 ancora eseguite operazioni, in questo caso le funzioni rispondono come se una
1377 operazione ci fosse comunque stata.
1380 \subsection{Il controllo della bufferizzazione}
1381 \label{sec:file_buffering_ctrl}
1383 Come accennato in \secref{sec:file_buffering} le librerie definiscono una
1384 serie di funzioni che permettono di controllare il comportamento degli stream;
1385 se non si è specificato nulla la modalità di buffering viene decisa
1386 autonomamente sulla base del tipo di file sottostante, ed i buffer vengono
1387 allocati automaticamente.
1389 Però una volta che si sia aperto lo stream (ma prima di aver compiuto
1390 operazioni su di esso) è possibile intervenire sulle modalità di buffering; la
1391 funzione che permette di controllare la bufferizzazione è \func{setvbuf}, il
1393 \begin{prototype}{stdio.h}{int setvbuf(FILE *stream, char *buf, int mode,
1396 Setta la bufferizzazione dello stream \param{stream} nella modalità indicata
1397 da \param{mode}, usando \param{buf} come buffer di lunghezza \param{size}.
1399 \bodydesc{Restituisce zero in caso di successo, ed un valore qualunque in
1400 caso di errore, nel qual caso \var{errno} viene settata opportunamente.}
1403 La funzione permette di controllare tutti gli aspetti della bufferizzazione;
1404 l'utente può specificare un buffer da usare al posto di quello allocato dal
1405 sistema passandone alla funzione l'indirizzo in \param{buf} e la dimensione in
1408 Ovviamente se si usa un buffer specificato dall'utente questo deve essere
1409 stato allocato e restare disponibile per tutto il tempo in cui si opera sullo
1410 stream. In genere conviene allocarlo con \func{malloc} e disallocarlo dopo la
1411 chiusura del file; ma fintanto che il file è usato all'interno di una
1412 funzione, può anche essere usata una variabile automatica. In \file{stdio.h}
1413 definita la macro \macro{BUFSIZ}, che indica le dimensioni generiche del
1414 buffer di uno stream; queste vengono usate dalla funzione \func{setbuf},
1415 questa però non è detto corrisponda in tutti i casi al valore ottimale (che
1416 può variare a seconda del dispositivo).
1418 Dato che la procedura di allocazione manuale è macchinosa, comporta dei rischi
1419 (come delle scritture accidentali sul buffer) e non assicura la scelta delle
1420 dimensioni ottimali, è sempre meglio lasciare allocare il buffer alle funzioni
1421 di libreria, che sono in grado di farlo in maniera ottimale e trasparente
1422 all'utente (in quanto la disallocazione avviene automaticamente). Inoltre
1423 siccome alcune implementazioni usano parte del buffer per mantenere delle
1424 informazioni di controllo, non è detto che le dimensioni dello stesso
1425 coincidano con quelle su cui viene effettuato l'I/O.
1430 \begin{tabular}[c]{|l|l|}
1432 \textbf{Valore} & \textbf{Modalità} \\
1435 \macro{\_IONBF} & \textit{unbuffered}\\
1436 \macro{\_IOLBF} & \textit{line buffered}\\
1437 \macro{\_IOFBF} & \textit{fully buffered}\\
1440 \caption{Valori del parametro \param{mode} di \func{setvbuf}
1441 per il settaggio delle modalità di bufferizzazione.}
1442 \label{tab:file_stream_buf_mode}
1445 Per evitare che \func{setvbuf} setti il buffer basta passare un valore
1446 \macro{NULL} per \param{buf} e la funzione ignorerà il parametro \param{size}
1447 usando il buffer allocato automaticamente dal sistema. Si potrà comunque
1448 modificare la modalità di bufferizzazione, passando in \param{mode} uno degli
1449 opportuni valori elencati in \tabref{tab:file_stream_buf_mode}. Qualora si
1450 specifichi la modalità non bufferizzata i valori di \param{buf} e \param{size}
1451 vengono sempre ignorati.
1453 Oltre a \func{setvbuf} le \acr{glibc} definiscono altre tre funzioni per la
1454 gestione della bufferizzazione di uno stream: \func{setbuf}, \func{setbuffer}
1455 e \func{setlinebuf}, i loro prototipi sono:
1459 \funcdecl{void setbuf(FILE *stream, char *buf)} Disabilita la
1460 bufferizzazione se \param{buf} è \macro{NULL}, altrimenti usa \param{buf}
1461 come buffer di dimensione \macro{BUFSIZ} in modalità \textit{fully buffered}.
1463 \funcdecl{void setbuffer(FILE *stream, char *buf, size\_t size)} Disabilita
1464 la bufferizzazione se \param{buf} è \macro{NULL}, altrimenti usa \param{buf}
1465 come buffer di dimensione \param{size} in modalità \textit{fully buffered}.
1467 \funcdecl{void setlinebuf(FILE *stream)} Pone lo stream in modalità
1468 \textit{line buffered}.
1470 \noindent tutte queste funzioni sono realizzate con opportune chiamate a
1471 \func{setvbuf} e sono definite solo per compatibilità con le vecchie librerie
1472 BSD. Infine le \acr{glibc} provvedono le funzioni non standard\footnote{anche
1473 queste funzioni sono originarie di Solaris.} \func{\_\_flbf} e
1474 \func{\_\_fbufsize} che permettono di leggere le proprietà di bufferizzazione
1475 di uno stream; i cui prototipi sono:
1477 \headdecl{stdio\_ext.h}
1479 \funcdecl{int \_\_flbf(FILE *stream)} Restituisce un valore diverso da zero
1480 se \param{stream} è in modalità \textit{line buffered}.
1482 \funcdecl{size\_t \_\_fbufsize(FILE *stream)} Restituisce le dimensioni del
1483 buffer di \param{stream}.
1486 Come già accennato, indipendentemente dalla modalità di bufferizzazione
1487 scelta, si può forzare lo scarico dei dati sul file con la funzione
1488 \func{fflush}, il suo prototipo è:
1489 \begin{prototype}{stdio.h}{int fflush(FILE *stream)}
1491 Forza la scrittura di tutti i dati bufferizzati dello stream \param{stream}.
1493 \bodydesc{Restituisce zero in caso di successo, ed \macro{EOF} in caso di
1494 errore, settando \var{errno} a \macro{EBADF} se \param{stream} non è
1495 aperto o non è aperto in scrittura, o ad uno degli errori di
1498 \noindent anche di questa funzione esiste una analoga
1499 \func{fflush\_unlocked}\footnote{accessibile definendo \macro{\_BSD\_SOURCE} o
1500 \macro{\_SVID\_SOURCE} o \macro{\_GNU\_SOURCE}.} che non effettua il blocco
1503 Se \param{stream} è \macro{NULL} lo scarico dei dati è forzato per tutti gli
1504 stream aperti. Esistono però circostanze, ad esempio quando si vuole essere
1505 sicuri che sia stato eseguito tutto l'output su terminale, in cui serve poter
1506 effettuare lo scarico dei dati solo per gli stream in modalità line buffered;
1507 per questo motivo le \acr{glibc} supportano una estensione di Solaris, la
1508 funzione \func{\_flushlbf}, il cui prototipo è:
1509 \begin{prototype}{stdio-ext.h}{void \_flushlbf(void)}
1510 Forza la scrittura di tutti i dati bufferizzati degli stream in modalità
1514 Si ricordi comunque che lo scarico dei dati dai buffer effettuato da queste
1515 funzioni non comporta la scrittura di questi su disco; se si vuole che il
1516 kernel dia effettivamente avvio alle operazioni di scrittura su disco occorre
1517 usare \func{sync} o \func{fsync} (si veda~\secref{sec:file_sync}).
1519 Infine esistono anche circostanze in cui si vuole scartare tutto l'output
1520 pendente, per questo si può usare \func{fpurge}, il cui prototipo è:
1521 \begin{prototype}{stdio.h}{int fpurge(FILE *stream)}
1523 Cancella i buffer di input e di output dello stream \param{stream}.
1525 \bodydesc{Restituisce zero in caso di successo, ed \macro{EOF} in caso di
1529 La funzione scarta tutti i dati non ancora scritti (se il file è aperto in
1530 scrittura), e tutto l'input non ancora letto (se è aperto in lettura),
1531 compresi gli eventuali caratteri rimandati indietro con \func{ungetc}.
1534 \subsection{Gli stream e i thread}
1535 \label{sec:file_stream_thread}
1537 Gli stream possono essere usati in applicazioni multi-thread allo stesso
1538 modo in cui sono usati nelle applicazioni normali, ma si deve essere
1539 consapevoli delle possibili complicazioni anche quando non si usano i
1540 thread, dato che l'implementazione delle librerie è influenzata
1541 pesantemente dalle richieste necessarie per garantirne l'uso coi thread.
1543 Lo standard POSIX richiede che le operazioni sui file siano atomiche rispetto
1544 ai thread, per questo le operazioni sui buffer effettuate dalle funzioni di
1545 libreria durante la lettura e la scrittura di uno stream devono essere
1546 opportunamente protette (in quanto il sistema assicura l'atomicità solo per le
1547 system call). Questo viene fatto associando ad ogni stream un opportuno blocco
1548 che deve essere implicitamente acquisito prima dell'esecuzione di qualunque
1551 Ci sono comunque situazioni in cui questo non basta, come quando un thread
1552 necessita di compiere più di una operazione sullo stream atomicamente, per
1553 questo motivo le librerie provvedono anche delle funzioni che permettono la
1554 gestione esplicita dei blocchi sugli stream; queste funzioni sono disponibili
1555 definendo \macro{\_POSIX\_THREAD\_SAFE\_FUNCTIONS} ed i loro prototipi sono:
1559 \funcdecl{void flockfile(FILE *stream)} Esegue l'acquisizione del
1560 lock dello stream \param{stream}, bloccandosi in caso il lock non
1563 \funcdecl{int ftrylockfile(FILE *stream)} Tenta l'acquisizione del
1564 lock dello stream \param{stream}, senza bloccarsi in caso il lock non sia
1565 disponibile. Ritorna zero in caso di acquisizione del lock, diverso da
1568 \funcdecl{void funlockfile(FILE *stream)} Rilascia il lock dello
1569 stream \param{stream}.
1571 \noindent con queste funzioni diventa possibile acquisire un blocco ed
1572 eseguire tutte le operazioni volute, per poi rilasciarlo.
1574 Ma, vista la complessità delle strutture di dati coinvolte, le operazioni di
1575 blocco non sono del tutto indolori, e quando il locking dello stream non è
1576 necessario (come in tutti i programmi che non usano i thread), tutta la
1577 procedura può comportare dei costi pesanti in termini di prestazioni. Per
1578 questo motivo abbiamo visto come alle usuali funzioni di I/O non formattato
1579 siano associate delle versioni \code{\_unlocked} (alcune previste dallo stesso
1580 standard POSIX, altre aggiunte come estensioni dalle \acr{glibc}) che possono
1581 essere usate quando il locking non serve\footnote{in certi casi dette funzioni
1582 possono essere usate, visto che sono molto più efficienti, anche in caso di
1583 necessità di locking, una volta che questo sia stato acquisito manualmente.}
1584 con prestazioni molto più elevate, dato che spesso queste versioni (come
1585 accade per \func{getc} e \func{putc}) sono realizzate come macro.
1587 La sostituzione di tutte le funzioni di I/O con le relative versioni
1588 \code{\_unlocked} in un programma che non usa i thread è però un lavoro
1589 abbastanza noioso; per questo motivo le \acr{glibc} provvedono al
1590 programmatore pigro un'altra via\footnote{anche questa mutuata da estensioni
1591 introdotte in Solaris.} da poter utilizzare per disabilitare in blocco il
1592 locking degli stream: l'uso della funzione \func{\_\_fsetlocking}, il cui
1594 \begin{prototype}{stdio\_ext.h}{int \_\_fsetlocking (FILE *stream, int type)}
1595 Specifica o richiede a seconda del valore di \param{type} la modalità in cui
1596 le operazioni di I/O su \param{stream} vengono effettuate rispetto
1597 all'acquisizione implicita del blocco sullo stream.
1599 \bodydesc{Restituisce lo stato di locking interno dello stream con uno dei
1600 valori \macro{FSETLOCKING\_INTERNAL} o \macro{FSETLOCKING\_BYCALLER}.}
1603 La funzione setta o legge lo stato della modalità di operazione di uno stream
1604 nei confronti del locking a seconda del valore specificato con \param{type},
1605 che può essere uno dei seguenti:
1606 \begin{basedescript}{\desclabelwidth{4.0cm}}
1607 \item[\macro{FSETLOCKING\_INTERNAL}] Lo stream userà da ora in poi il blocco
1608 implicito di default.
1609 \item[\macro{FSETLOCKING\_BYCALLER}] Al ritorno della funzione sarà l'utente a
1610 dover gestire da solo il locking dello stream.
1611 \item[\macro{FSETLOCKING\_QUERY}] Restituisce lo stato corrente della modalità
1612 di blocco dello stream.
1616 %%% Local Variables:
1618 %%% TeX-master: "gapil"