Correzioni ortografiche generali, con creazione dei vocabolari locali
[gapil.git] / filestd.tex
1 %% filestd.tex
2 %%
3 %% Copyright (C) 2000-2006 Simone Piccardi.  Permission is granted to
4 %% copy, distribute and/or modify this document under the terms of the GNU Free
5 %% Documentation License, Version 1.1 or any later version published by the
6 %% Free Software Foundation; with the Invariant Sections being "Un preambolo",
7 %% with no Front-Cover Texts, and with no Back-Cover Texts.  A copy of the
8 %% license is included in the section entitled "GNU Free Documentation
9 %% License".
10 %%
11 \chapter{I file: l'interfaccia standard ANSI C}
12 \label{cha:files_std_interface}
13
14 Esamineremo in questo capitolo l'interfaccia standard ANSI C per i file,
15 quella che viene comunemente detta interfaccia degli \textit{stream}.  Dopo
16 una breve sezione introduttiva tratteremo le funzioni base per la gestione
17 dell'input/output, mentre tratteremo le caratteristiche più avanzate
18 dell'interfaccia nell'ultima sezione.
19
20
21 \section{Introduzione}
22 \label{sec:file_stream_intro}
23
24 Come visto in cap.~\ref{cha:file_unix_interface} le operazioni di I/O sui file
25 sono gestibili a basso livello con l'interfaccia standard unix, che ricorre
26 direttamente alle system call messe a disposizione dal kernel.
27
28 Questa interfaccia però non provvede le funzionalità previste dallo standard
29 ANSI C, che invece sono realizzate attraverso opportune funzioni di libreria,
30 queste, insieme alle altre funzioni definite dallo standard, vengono a
31 costituire il nucleo\footnote{queste funzioni sono state implementate la prima
32   volta da Ritchie nel 1976 e da allora sono rimaste sostanzialmente
33   immutate.} delle \acr{glibc}.
34
35
36 \subsection{I \textit{file stream}}
37 \label{sec:file_stream}
38
39 \index{file!stream|(}
40 Come più volte ribadito, l'interfaccia dei file descriptor è un'interfaccia di
41 basso livello, che non provvede nessuna forma di formattazione dei dati e
42 nessuna forma di bufferizzazione per ottimizzare le operazioni di I/O.
43
44 In \cite{APUE} Stevens descrive una serie di test sull'influenza delle
45 dimensioni del blocco di dati (l'argomento \param{buf} di \func{read} e
46 \func{write}) nell'efficienza nelle operazioni di I/O con i file descriptor,
47 evidenziando come le prestazioni ottimali si ottengano a partire da dimensioni
48 del buffer dei dati pari a quelle dei blocchi del filesystem (il valore dato
49 dal campo \var{st\_blksize} di \struct{stat}), che di norma corrispondono alle
50 dimensioni dei settori fisici in cui è suddiviso il disco.
51
52 Se il programmatore non si cura di effettuare le operazioni in blocchi di
53 dimensioni adeguate, le prestazioni sono inferiori.  La caratteristica
54 principale dell'interfaccia degli stream è che essa provvede da sola alla
55 gestione dei dettagli della bufferizzazione e all'esecuzione delle operazioni
56 di lettura e scrittura in blocchi di dimensioni appropriate all'ottenimento
57 della massima efficienza.
58
59 Per questo motivo l'interfaccia viene chiamata anche interfaccia dei
60 \textit{file stream}, dato che non è più necessario doversi preoccupare
61 dei dettagli della comunicazione con il tipo di hardware sottostante
62 (come nel caso della dimensione dei blocchi del filesystem), ed un file
63 può essere sempre considerato come composto da un flusso continuo (da
64 cui il nome \textit{stream}) di dati.
65
66 A parte i dettagli legati alla gestione delle operazioni di lettura e
67 scrittura (sia per quel che riguarda la bufferizzazione, che le
68 formattazioni), i file stream restano del tutto equivalenti ai file descriptor
69 (sui quali sono basati), ed in particolare continua a valere quanto visto in
70 sez.~\ref{sec:file_sharing} a proposito dell'accesso condiviso ed in
71 sez.~\ref{sec:file_access_control} per il controllo di accesso.
72 \index{file!stream|)}
73
74
75 \subsection{Gli oggetti \type{FILE}}
76 \label{sec:file_FILE}
77
78
79 Per ragioni storiche la struttura di dati che rappresenta uno stream è stata
80 chiamata \type{FILE}, questi oggetti sono creati dalle funzioni di libreria e
81 contengono tutte le informazioni necessarie a gestire le operazioni sugli
82 stream, come la posizione corrente, lo stato del buffer e degli indicatori di
83 stato e di fine del file.
84
85 Per questo motivo gli utenti non devono mai utilizzare direttamente o allocare
86 queste strutture (che sono dei \textsl{tipi opachi}\index{tipo!opaco}) ma
87 usare sempre puntatori del tipo \texttt{FILE *} ottenuti dalla libreria stessa
88 (tanto che in certi casi il termine di puntatore a file è diventato sinonimo
89 di stream).  Tutte le funzioni della libreria che operano sui file accettano
90 come argomenti solo variabili di questo tipo, che diventa accessibile
91 includendo l'header file \file{stdio.h}.
92
93
94 \subsection{Gli stream standard}
95 \label{sec:file_std_stream}
96
97 Ai tre file descriptor standard (vedi sez.~\ref{sec:file_std_descr})
98 aperti per ogni processo, corrispondono altrettanti stream, che
99 rappresentano i canali standard di input/output prestabiliti; anche
100 questi tre stream sono identificabili attraverso dei nomi simbolici
101 definiti nell'header \file{stdio.h} che sono:
102
103 \begin{basedescript}{\desclabelwidth{3.0cm}}
104 \item[\var{FILE *stdin}] Lo \textit{standard input} cioè lo stream da
105   cui il processo riceve ordinariamente i dati in ingresso. Normalmente
106   è associato dalla shell all'input del terminale e prende i caratteri
107   dalla tastiera.
108 \item[\var{FILE *stdout}] Lo \textit{standard output} cioè lo stream su
109   cui il processo invia ordinariamente i dati in uscita. Normalmente è
110   associato dalla shell all'output del terminale e scrive sullo schermo.
111 \item[\var{FILE *stderr}] Lo \textit{standard error} cioè lo stream su
112   cui il processo è supposto inviare i messaggi di errore. Normalmente
113   anch'esso è associato dalla shell all'output del terminale e scrive
114   sullo schermo.
115 \end{basedescript}
116
117 Nelle \acr{glibc} \var{stdin}, \var{stdout} e \var{stderr} sono effettivamente
118 tre variabili di tipo \type{FILE}\texttt{ *} che possono essere usate come
119 tutte le altre, ad esempio si può effettuare una redirezione dell'output di un
120 programma con il semplice codice: \includecodesnip{listati/redir_stdout.c} ma
121 in altri sistemi queste variabili possono essere definite da macro, e se si
122 hanno problemi di portabilità e si vuole essere sicuri, diventa opportuno
123 usare la funzione \func{freopen}.
124
125
126 \subsection{Le modalità di bufferizzazione}
127 \label{sec:file_buffering}
128
129 La bufferizzazione è una delle caratteristiche principali dell'interfaccia
130 degli stream; lo scopo è quello di ridurre al minimo il numero di system call
131 (\func{read} o \func{write}) eseguite nelle operazioni di input/output. Questa
132 funzionalità è assicurata automaticamente dalla libreria, ma costituisce anche
133 uno degli aspetti più comunemente fraintesi, in particolare per quello che
134 riguarda l'aspetto della scrittura dei dati sul file.
135
136 I caratteri che vengono scritti su di uno stream normalmente vengono
137 accumulati in un buffer e poi trasmessi in blocco\footnote{questa operazione
138   viene usualmente chiamata \textsl{scaricamento} dei dati, dal termine
139   inglese \textit{flush}.} tutte le volte che il buffer viene riempito, in
140 maniera asincrona rispetto alla scrittura. Un comportamento analogo avviene
141 anche in lettura (cioè dal file viene letto un blocco di dati, anche se ne
142 sono richiesti una quantità inferiore), ma la cosa ovviamente ha rilevanza
143 inferiore, dato che i dati letti sono sempre gli stessi. In caso di scrittura
144 invece, quando si ha un accesso contemporaneo allo stesso file (ad esempio da
145 parte di un altro processo) si potranno vedere solo le parti effettivamente
146 scritte, e non quelle ancora presenti nel buffer.
147
148 Per lo stesso motivo, in tutte le situazioni in cui si sta facendo
149 dell'input/output interattivo, bisognerà tenere presente le caratteristiche
150 delle operazioni di scaricamento dei dati, poiché non è detto che ad una
151 scrittura sullo stream corrisponda una immediata scrittura sul dispositivo (la
152 cosa è particolarmente evidente quando con le operazioni di input/output su
153 terminale).
154
155 Per rispondere ad esigenze diverse, lo standard definisce tre distinte
156 modalità in cui può essere eseguita la bufferizzazione, delle quali
157 occorre essere ben consapevoli, specie in caso di lettura e scrittura da
158 dispositivi interattivi:
159 \begin{itemize}
160 \item \textit{unbuffered}: in questo caso non c'è bufferizzazione ed i
161   caratteri vengono trasmessi direttamente al file non appena possibile
162   (effettuando immediatamente una \func{write}).
163 \item \textit{line buffered}: in questo caso i caratteri vengono
164   normalmente trasmessi al file in blocco ogni volta che viene
165   incontrato un carattere di \textit{newline} (il carattere ASCII
166   \verb|\n|).
167 \item \textit{fully buffered}: in questo caso i caratteri vengono
168   trasmessi da e verso il file in blocchi di dimensione opportuna.
169 \end{itemize}
170
171 Lo standard ANSI C specifica inoltre che lo standard output e lo
172 standard input siano aperti in modalità \textit{fully buffered} quando
173 non fanno riferimento ad un dispositivo interattivo, e che lo standard
174 error non sia mai aperto in modalità \textit{fully buffered}.
175
176 Linux, come BSD e SVr4, specifica il comportamento predefinito in maniera
177 ancora più precisa, e cioè impone che lo standard error sia sempre
178 \textit{unbuffered} (in modo che i messaggi di errore siano mostrati il più
179 rapidamente possibile) e che standard input e standard output siano aperti in
180 modalità \textit{line buffered} quando sono associati ad un terminale (od
181 altro dispositivo interattivo) ed in modalità \textit{fully buffered}
182 altrimenti.
183
184 Il comportamento specificato per standard input e standard output vale anche
185 per tutti i nuovi stream aperti da un processo; la selezione comunque avviene
186 automaticamente, e la libreria apre lo stream nella modalità più opportuna a
187 seconda del file o del dispositivo scelto.
188
189 La modalità \textit{line buffered} è quella che necessita di maggiori
190 chiarimenti e attenzioni per quel che concerne il suo funzionamento. Come già
191 accennato nella descrizione, \emph{di norma} i dati vengono inviati al kernel
192 alla ricezione di un carattere di \textsl{a capo} (\textit{newline}); questo
193 non è vero in tutti i casi, infatti, dato che le dimensioni del buffer usato
194 dalle librerie sono fisse, se le si eccedono si può avere uno scarico dei dati
195 anche prima che sia stato inviato un carattere di \textit{newline}.
196
197 Un secondo punto da tenere presente, particolarmente quando si ha a che fare
198 con I/O interattivo, è che quando si effettua una lettura da uno stream che
199 comporta l'accesso al kernel\footnote{questo vuol dire che lo stream da cui si
200   legge è in modalità \textit{unbuffered}.} viene anche eseguito lo scarico di
201 tutti i buffer degli stream in scrittura.
202
203 In sez.~\ref{sec:file_buffering_ctrl} vedremo come la libreria definisca delle
204 opportune funzioni per controllare le modalità di bufferizzazione e lo scarico
205 dei dati.
206
207
208
209 \section{Funzioni base}
210 \label{sec:file_ansi_base_func}
211
212 Esamineremo in questa sezione le funzioni base dell'interfaccia degli stream,
213 analoghe a quelle di sez.~\ref{sec:file_base_func} per i file descriptor. In
214 particolare vedremo come aprire, leggere, scrivere e cambiare la posizione
215 corrente in uno stream.
216
217
218 \subsection{Apertura e chiusura di uno stream}
219 \label{sec:file_fopen}
220
221 Le funzioni che si possono usare per aprire uno stream sono solo tre:
222 \funcd{fopen}, \funcd{fdopen} e \funcd{freopen},\footnote{\func{fopen} e
223   \func{freopen} fanno parte dello standard ANSI C, \func{fdopen} è parte
224   dello standard POSIX.1.} i loro prototipi sono:
225 \begin{functions}
226   \headdecl{stdio.h}
227   \funcdecl{FILE *fopen(const char *path, const char *mode)}
228   Apre il file specificato da \param{path}.
229   \funcdecl{FILE *fdopen(int fildes, const char *mode)}
230   Associa uno stream al file descriptor \param{fildes}.
231   \funcdecl{FILE *freopen(const char *path, const char *mode, FILE *stream)}
232   Apre il file specificato da \param{path} associandolo allo stream
233   specificato da \param{stream}, se questo è già aperto prima lo chiude.
234   
235   \bodydesc{Le funzioni ritornano un puntatore valido in caso di successo e
236     \val{NULL} in caso di errore, in tal caso \var{errno} assumerà il valore
237     ricevuto dalla funzione sottostante di cui è fallita l'esecuzione.
238   
239     Gli errori pertanto possono essere quelli di \func{malloc} per tutte
240     e tre le funzioni, quelli \func{open} per \func{fopen}, quelli di
241     \func{fcntl} per \func{fdopen} e quelli di \func{fopen},
242     \func{fclose} e \func{fflush} per \func{freopen}.}
243 \end{functions}
244
245 Normalmente la funzione che si usa per aprire uno stream è \func{fopen},
246 essa apre il file specificato nella modalità specificata da
247 \param{mode}, che è una stringa che deve iniziare con almeno uno dei
248 valori indicati in tab.~\ref{tab:file_fopen_mode} (sono possibili varie
249 estensioni che vedremo in seguito).
250
251 L'uso più comune di \func{freopen} è per redirigere uno dei tre file
252 standard (vedi sez.~\ref{sec:file_std_stream}): il file \param{path} viene
253 associato a \param{stream} e se questo è uno stream già aperto viene
254 preventivamente chiuso.
255
256 Infine \func{fdopen} viene usata per associare uno stream ad un file
257 descriptor esistente ottenuto tramite una altra funzione (ad esempio con una
258 \func{open}, una \func{dup}, o una \func{pipe}) e serve quando si vogliono
259 usare gli stream con file come le fifo o i socket\index{socket}, che non
260 possono essere aperti con le funzioni delle librerie standard del C.
261
262 \begin{table}[htb]
263   \centering
264   \footnotesize
265   \begin{tabular}[c]{|l|p{8cm}|}
266     \hline
267     \textbf{Valore} & \textbf{Significato}\\
268     \hline
269     \hline
270     \texttt{r} & Il file viene aperto, l'accesso viene posto in sola
271     lettura, lo stream è posizionato all'inizio del file.\\
272     \texttt{r+} & Il file viene aperto, l'accesso viene posto in lettura e
273     scrittura, lo stream è posizionato all'inizio del file. \\
274 %    \hline
275     \texttt{w} & Il file viene aperto e troncato a lunghezza nulla (o
276     creato se non esiste), l'accesso viene posto in sola scrittura, lo
277     stream è posizionato all'inizio del file.\\
278     \texttt{w+} & Il file viene aperto e troncato a lunghezza nulla (o
279     creato se non esiste), l'accesso viene posto in scrittura e lettura,
280     lo stream è posizionato all'inizio del file.\\
281 %    \hline
282     \texttt{a} & Il file viene aperto (o creato se non esiste) in
283     \textit{append mode}, l'accesso viene posto in sola scrittura. \\
284     \texttt{a+} & Il file viene aperto (o creato se non esiste) in
285     \textit{append mode}, l'accesso viene posto in lettura e scrittura. \\
286     \hline
287     \texttt{b} & specifica che il file è binario, non ha alcun effetto. \\
288     \texttt{x} & l'apertura fallisce se il file esiste già. \\
289     \hline
290   \end{tabular}
291   \caption{Modalità di apertura di uno stream dello standard ANSI C che
292     sono sempre presenti in qualunque sistema POSIX.}
293   \label{tab:file_fopen_mode}
294 \end{table}
295
296 In realtà lo standard ANSI C prevede un totale di 15 possibili valori
297 diversi per \param{mode}, ma in tab.~\ref{tab:file_fopen_mode} si sono
298 riportati solo i sei valori effettivi, ad essi può essere aggiunto pure
299 il carattere \texttt{b} (come ultimo carattere o nel mezzo agli altri per
300 le stringhe di due caratteri) che in altri sistemi operativi serve a
301 distinguere i file binari dai file di testo; in un sistema POSIX questa
302 distinzione non esiste e il valore viene accettato solo per
303 compatibilità, ma non ha alcun effetto.
304
305 Le \acr{glibc} supportano alcune estensioni, queste devono essere sempre
306 indicate dopo aver specificato il \param{mode} con uno dei valori di
307 tab.~\ref{tab:file_fopen_mode}. L'uso del carattere \texttt{x} serve per
308 evitare di sovrascrivere un file già esistente (è analoga all'uso
309 dell'opzione \const{O\_EXCL} in \func{open}), se il file specificato già
310 esiste e si aggiunge questo carattere a \param{mode} la \func{fopen}
311 fallisce. 
312
313 Un'altra estensione serve a supportare la localizzazione, quando si
314 aggiunge a \param{mode} una stringa della forma \verb|",ccs=STRING"| il
315 valore \verb|STRING| è considerato il nome di una codifica dei caratteri
316 e \func{fopen} marca il file per l'uso dei caratteri estesi e abilita le
317 opportune funzioni di conversione in lettura e scrittura.
318
319 Nel caso si usi \func{fdopen} i valori specificati da \param{mode} devono
320 essere compatibili con quelli con cui il file descriptor è stato aperto.
321 Inoltre i modi \cmd{w} e \cmd{w+} non troncano il file. La posizione nello
322 stream viene impostata a quella corrente nel file descriptor, e le variabili
323 di errore e di fine del file (vedi sez.~\ref{sec:file_io}) sono cancellate. Il
324 file non viene duplicato e verrà chiuso alla chiusura dello stream.
325
326 I nuovi file saranno creati secondo quanto visto in
327 sez.~\ref{sec:file_ownership} ed avranno i permessi di accesso impostati al
328 valore \code{S\_IRUSR|S\_IWUSR|S\_IRGRP|S\_IWGRP|S\_IROTH|S\_IWOTH} (pari a
329 \val{0666}) modificato secondo il valore di \acr{umask} per il processo (si
330 veda sez.~\ref{sec:file_umask}).
331
332 In caso di file aperti in lettura e scrittura occorre ricordarsi che c'è
333 di mezzo una bufferizzazione; per questo motivo lo standard ANSI C
334 richiede che ci sia un'operazione di posizionamento fra un'operazione
335 di output ed una di input o viceversa (eccetto il caso in cui l'input ha
336 incontrato la fine del file), altrimenti una lettura può ritornare anche
337 il risultato di scritture precedenti l'ultima effettuata. 
338
339 Per questo motivo è una buona pratica (e talvolta necessario) far seguire ad
340 una scrittura una delle funzioni \func{fflush}, \func{fseek}, \func{fsetpos} o
341 \func{rewind} prima di eseguire una rilettura; viceversa nel caso in cui si
342 voglia fare una scrittura subito dopo aver eseguito una lettura occorre prima
343 usare una delle funzioni \func{fseek}, \func{fsetpos} o \func{rewind}. Anche
344 un'operazione nominalmente nulla come \code{fseek(file, 0, SEEK\_CUR)} è
345 sufficiente a garantire la sincronizzazione.
346
347 Una volta aperto lo stream, si può cambiare la modalità di bufferizzazione
348 (si veda sez.~\ref{sec:file_buffering_ctrl}) fintanto che non si è effettuato
349 alcuna operazione di I/O sul file.
350
351 Uno stream viene chiuso con la funzione \funcd{fclose} il cui prototipo è:
352 \begin{prototype}{stdio.h}{int fclose(FILE *stream)}
353   Chiude lo stream \param{stream}. 
354   
355   \bodydesc{Restituisce 0 in caso di successo e \val{EOF} in caso di errore,
356     nel qual caso imposta \var{errno} a \errval{EBADF} se il file descriptor
357     indicato da \param{stream} non è valido, o uno dei valori specificati
358     dalla sottostante funzione che è fallita (\func{close}, \func{write} o
359     \func{fflush}).}
360 \end{prototype}
361
362 La funzione effettua lo scarico di tutti i dati presenti nei buffer di uscita
363 e scarta tutti i dati in ingresso; se era stato allocato un buffer per lo
364 stream questo verrà rilasciato. La funzione effettua lo scarico solo per i
365 dati presenti nei buffer in user space usati dalle \acr{glibc}; se si vuole
366 essere sicuri che il kernel forzi la scrittura su disco occorrerà effettuare
367 una \func{sync} (vedi sez.~\ref{sec:file_sync}).
368
369 Linux supporta anche una altra funzione, \funcd{fcloseall}, come estensione
370 GNU implementata dalle \acr{glibc}, accessibile avendo definito
371 \macro{\_GNU\_SOURCE}, il suo prototipo è:
372 \begin{prototype}{stdio.h}{int fcloseall(void)}
373   Chiude tutti gli stream. 
374   
375   \bodydesc{Restituisce 0 se non ci sono errori ed \val{EOF} altrimenti.}
376 \end{prototype}
377 \noindent la funzione esegue lo scarico dei dati bufferizzati in uscita
378 e scarta quelli in ingresso, chiudendo tutti i file. Questa funzione è
379 provvista solo per i casi di emergenza, quando si è verificato un errore
380 ed il programma deve essere abortito, ma si vuole compiere qualche altra
381 operazione dopo aver chiuso i file e prima di uscire (si ricordi quanto
382 visto in sez.~\ref{sec:proc_exit}).
383
384
385 \subsection{Lettura e scrittura su uno stream}
386 \label{sec:file_io}
387
388 Una delle caratteristiche più utili dell'interfaccia degli stream è la
389 ricchezza delle funzioni disponibili per le operazioni di lettura e
390 scrittura sui file. Sono infatti previste ben tre diverse modalità
391 modalità di input/output non formattato:
392 \begin{enumerate*}
393 \item\textsl{binario} in cui legge/scrive un blocco di dati alla
394   volta, vedi sez.~\ref{sec:file_binary_io}.
395 \item\textsl{a caratteri} in cui si legge/scrive un carattere alla
396   volta (con la bufferizzazione gestita automaticamente dalla libreria),
397   vedi sez.~\ref{sec:file_char_io}.
398 \item\textsl{di linea} in cui si legge/scrive una linea alla volta (terminata
399   dal carattere di newline \verb|'\n'|), vedi sez.~\ref{sec:file_line_io}.
400 \end{enumerate*}
401 ed inoltre la modalità di input/output formattato.
402
403 A differenza dell'interfaccia dei file descriptor, con gli stream il
404 raggiungimento della fine del file è considerato un errore, e viene
405 notificato come tale dai valori di uscita delle varie funzioni. Nella
406 maggior parte dei casi questo avviene con la restituzione del valore
407 intero (di tipo \ctyp{int}) \val{EOF}\footnote{la costante deve essere
408   negativa, le \acr{glibc} usano -1, altre implementazioni possono avere
409   valori diversi.}  definito anch'esso nell'header \file{stdlib.h}.
410
411 Dato che le funzioni dell'interfaccia degli stream sono funzioni di libreria
412 che si appoggiano a delle system call, esse non impostano direttamente la
413 variabile \var{errno}, che mantiene il valore impostato dalla system call che
414 ha riportato l'errore.
415
416 Siccome la condizione di end-of-file è anch'essa segnalata come errore, nasce
417 il problema di come distinguerla da un errore effettivo; basarsi solo sul
418 valore di ritorno della funzione e controllare il valore di \var{errno}
419 infatti non basta, dato che quest'ultimo potrebbe essere stato impostato in
420 una altra occasione, (si veda sez.~\ref{sec:sys_errno} per i dettagli del
421 funzionamento di \var{errno}).
422
423 Per questo motivo tutte le implementazioni delle librerie standard
424 mantengono per ogni stream almeno due flag all'interno dell'oggetto
425 \type{FILE}, il flag di \textit{end-of-file}, che segnala che si è
426 raggiunta la fine del file in lettura, e quello di errore, che segnala
427 la presenza di un qualche errore nelle operazioni di input/output;
428 questi due flag possono essere riletti dalle funzioni \funcd{feof} e
429 \funcd{ferror}, i cui prototipi sono:
430 \begin{functions}
431   \headdecl{stdio.h}
432   \funcdecl{int feof(FILE *stream)}
433   Controlla il flag di end-of-file di \param{stream}.
434   \funcdecl{int ferror(FILE *stream)}
435   Controlla il flag di errore di \param{stream}.
436   
437   \bodydesc{Entrambe le funzioni ritornano un valore diverso da zero se
438     i relativi flag sono impostati.}
439 \end{functions}
440 \noindent si tenga presente comunque che la lettura di questi flag segnala
441 soltanto che c'è stato un errore, o che si è raggiunta la fine del file in una
442 qualunque operazione sullo stream, il controllo quindi deve essere effettuato
443 ogni volta che si chiama una funzione di libreria.
444
445 Entrambi i flag (di errore e di end-of-file) possono essere cancellati usando
446 la funzione \funcd{clearerr}, il cui prototipo è:
447 \begin{prototype}{stdio.h}{void clearerr(FILE *stream)}
448   Cancella i flag di errore ed end-of-file di \param{stream}. 
449 \end{prototype}
450 \noindent in genere si usa questa funzione una volta che si sia identificata e
451 corretta la causa di un errore per evitare di mantenere i flag attivi, così da
452 poter rilevare una successiva ulteriore condizione di errore. Di questa
453 funzione esiste una analoga \func{clearerr\_unlocked} che non esegue il blocco
454 dello stream (vedi sez.~\ref{sec:file_stream_thread}).
455
456
457 \subsection{Input/output binario}
458 \label{sec:file_binary_io}
459
460 La prima modalità di input/output non formattato ricalca quella della
461 interfaccia dei file descriptor, e provvede semplicemente la scrittura e la
462 lettura dei dati da un buffer verso un file e viceversa. In generale questa è
463 la modalità che si usa quando si ha a che fare con dati non formattati. Le due
464 funzioni che si usano per l'I/O binario sono \funcd{fread} ed \funcd{fwrite};
465 i loro prototipi sono:
466 \begin{functions}
467   \headdecl{stdio.h} 
468   
469   \funcdecl{size\_t fread(void *ptr, size\_t size, size\_t nmemb, FILE
470     *stream)}
471   
472   \funcdecl{size\_t fwrite(const void *ptr, size\_t size, size\_t
473     nmemb, FILE *stream)}
474   
475   Rispettivamente leggono e scrivono \param{nmemb} elementi di dimensione
476   \param{size} dal buffer \param{ptr} al file \param{stream}.
477   
478   \bodydesc{Entrambe le funzioni ritornano il numero di elementi letti o
479     scritti, in caso di errore o fine del file viene restituito un numero di
480     elementi inferiore al richiesto.}
481 \end{functions}
482
483 In genere si usano queste funzioni quando si devono trasferire su file
484 blocchi di dati binari in maniera compatta e veloce; un primo caso di uso
485 tipico è quello in cui si salva un vettore (o un certo numero dei suoi
486 elementi) con una chiamata del tipo:
487 \includecodesnip{listati/WriteVect.c}
488 in questo caso devono essere specificate le dimensioni di ciascun
489 elemento ed il numero di quelli che si vogliono scrivere. Un secondo
490 caso è invece quello in cui si vuole trasferire su file una struttura;
491 si avrà allora una chiamata tipo:
492 \includecodesnip{listati/WriteStruct.c}
493 in cui si specifica la dimensione dell'intera struttura ed un solo
494 elemento. 
495
496 In realtà quello che conta nel trasferimento dei dati sono le dimensioni
497 totali, che sono sempre pari al prodotto \code{size * nelem}; la sola
498 differenza è che le funzioni non ritornano il numero di byte scritti,
499 ma il numero di elementi.
500
501 La funzione \func{fread} legge sempre un numero intero di elementi, se
502 incontra la fine del file l'oggetto letto parzialmente viene scartato
503 (lo stesso avviene in caso di errore). In questo caso la posizione dello
504 stream viene impostata alla fine del file (e non a quella corrispondente
505 alla quantità di dati letti).
506
507 In caso di errore (o fine del file per \func{fread}) entrambe le
508 funzioni restituiscono il numero di oggetti effettivamente letti o
509 scritti, che sarà inferiore a quello richiesto. Contrariamente a quanto
510 avviene per i file descriptor, questo segnala una condizione di errore e
511 occorrerà usare \func{feof} e \func{ferror} per stabilire la natura del
512 problema.
513
514 Benché queste funzioni assicurino la massima efficienza per il
515 salvataggio dei dati, i dati memorizzati attraverso di esse presentano
516 lo svantaggio di dipendere strettamente dalla piattaforma di sviluppo
517 usata ed in genere possono essere riletti senza problemi solo dallo
518 stesso programma che li ha prodotti.
519
520 Infatti diversi compilatori possono eseguire ottimizzazioni diverse delle
521 strutture dati e alcuni compilatori (come il \cmd{gcc}) possono anche
522 scegliere se ottimizzare l'occupazione di spazio, impacchettando più
523 strettamente i dati, o la velocità inserendo opportuni \textit{padding} per
524 l'allineamento dei medesimi generando quindi output binari diversi. Inoltre
525 altre incompatibilità si possono presentare quando entrano in gioco differenze
526 di architettura hardware, come la dimensione del bus o la modalità di
527 ordinamento dei bit o il formato delle variabili in floating point.
528
529 Per questo motivo quando si usa l'input/output binario occorre sempre prendere
530 le opportune precauzioni (in genere usare un formato di più alto livello che
531 permetta di recuperare l'informazione completa), per assicurarsi che versioni
532 diverse del programma siano in grado di rileggere i dati tenendo conto delle
533 eventuali differenze.
534
535 Le \acr{glibc} definiscono altre due funzioni per l'I/O binario,
536 \funcd{fread\_unlocked} e \funcd{fwrite\_unlocked} che evitano il lock
537 implicito dello stream, usato per dalla librerie per la gestione delle
538 applicazioni multi-thread (si veda sez.~\ref{sec:file_stream_thread} per i
539 dettagli), i loro prototipi sono:
540 \begin{functions}
541   \headdecl{stdio.h}
542   
543   \funcdecl{size\_t fread\_unlocked(void *ptr, size\_t size, size\_t
544     nmemb, FILE *stream)}
545   
546   \funcdecl{size\_t fwrite\_unlocked(const void *ptr, size\_t size,
547     size\_t nmemb, FILE *stream)}
548   
549   \bodydesc{Le funzioni sono identiche alle analoghe \func{fread} e
550     \func{fwrite} ma non acquisiscono il lock implicito sullo stream.}
551 \end{functions}
552 \noindent entrambe le funzioni sono estensioni GNU previste solo dalle
553 \acr{glibc}.
554
555
556 \subsection{Input/output a caratteri}
557 \label{sec:file_char_io}
558
559 La seconda modalità di input/output è quella a caratteri, in cui si
560 trasferisce un carattere alla volta.  Le funzioni per la lettura a
561 caratteri sono tre, \funcd{fgetc}, \funcd{getc} e \funcd{getchar}, i
562 rispettivi prototipi sono:
563 \begin{functions}
564   \headdecl{stdio.h} 
565
566   \funcdecl{int getc(FILE *stream)} Legge un byte da \param{stream} e lo
567   restituisce come intero. In genere è implementata come una macro. 
568   
569   \funcdecl{int fgetc(FILE *stream)} Legge un byte da \param{stream} e lo
570   restituisce come intero. È sempre una funzione.
571   
572   \funcdecl{int getchar(void)} Equivalente a \code{getc(stdin)}.
573   
574   \bodydesc{Tutte queste funzioni leggono un byte alla volta, che viene
575     restituito come intero; in caso di errore o fine del file il valore
576     di ritorno è \val{EOF}.}
577 \end{functions}
578
579 A parte \func{getchar}, che si usa in genere per leggere un carattere da
580 tastiera, le altre due funzioni sono sostanzialmente equivalenti. La
581 differenza è che \func{getc} è ottimizzata al massimo e normalmente
582 viene implementata con una macro, per cui occorre stare attenti a cosa
583 le si passa come argomento, infatti \param{stream} può essere valutato
584 più volte nell'esecuzione, e non viene passato in copia con il
585 meccanismo visto in sez.~\ref{sec:proc_var_passing}; per questo motivo se
586 si passa un'espressione si possono avere effetti indesiderati.
587
588 Invece \func{fgetc} è assicurata essere sempre una funzione, per questo motivo
589 la sua esecuzione normalmente è più lenta per via dell'overhead della
590 chiamata, ma è altresì possibile ricavarne l'indirizzo, che può essere passato
591 come argomento ad un altra funzione (e non si hanno i problemi accennati in
592 precedenza nel tipo di argomento).
593
594 Le tre funzioni restituiscono tutte un \ctyp{unsigned char} convertito
595 ad \ctyp{int} (si usa \ctyp{unsigned char} in modo da evitare
596 l'espansione del segno). In questo modo il valore di ritorno è sempre
597 positivo, tranne in caso di errore o fine del file.
598
599 Nelle estensioni GNU che provvedono la localizzazione sono definite tre
600 funzioni equivalenti alle precedenti, \funcd{getwc}, \funcd{fgetwc} e
601 \funcd{getwchar}, che invece di un carattere di un byte restituiscono un
602 carattere in formato esteso (cioè di tipo \ctyp{wint\_t}), il loro prototipo
603 è:
604 \begin{functions}
605   \headdecl{stdio.h} 
606   \headdecl{wchar.h} 
607   
608   \funcdecl{wint\_t getwc(FILE *stream)} Legge un carattere esteso da
609   \param{stream}. In genere è implementata come una macro.
610   
611   \funcdecl{wint\_t fgetwc(FILE *stream)} Legge un carattere esteso da
612   \param{stream} È una sempre una funzione.
613   
614   \funcdecl{wint\_t getwchar(void)} Equivalente a \code{getwc(stdin)}.
615   
616   \bodydesc{Tutte queste funzioni leggono un carattere alla volta, in
617     caso di errore o fine del file il valore di ritorno è \const{WEOF}.}
618 \end{functions}
619
620 Per scrivere un carattere si possono usare tre funzioni, analoghe alle
621 precedenti usate per leggere: \funcd{putc}, \funcd{fputc} e \funcd{putchar}; i
622 loro prototipi sono:
623 \begin{functions}
624   \headdecl{stdio.h} 
625   
626   \funcdecl{int putc(int c, FILE *stream)} Scrive il carattere \param{c}
627   su \param{stream}. In genere è implementata come una macro.
628   
629   \funcdecl{int fputc(FILE *stream)} Scrive il carattere \param{c} su
630   \param{stream}. È una sempre una funzione.
631   
632   \funcdecl{int putchar(void)} Equivalente a \code{putc(stdin)}.
633   
634   \bodydesc{Le funzioni scrivono sempre un carattere alla volta, il cui
635     valore viene restituito in caso di successo; in caso di errore o
636     fine del file il valore di ritorno è \val{EOF}.}
637 \end{functions}
638
639 Tutte queste funzioni scrivono sempre un byte alla volta, anche se prendono
640 come argomento un \ctyp{int} (che pertanto deve essere ottenuto con un cast da
641 un \ctyp{unsigned char}). Anche il valore di ritorno è sempre un intero; in
642 caso di errore o fine del file il valore di ritorno è \val{EOF}.
643
644 Come nel caso dell'I/O binario con \func{fread} e \func{fwrite} le \acr{glibc}
645 provvedono come estensione, per ciascuna delle funzioni precedenti,
646 un'ulteriore funzione, il cui nome è ottenuto aggiungendo un
647 \code{\_unlocked}, che esegue esattamente le stesse operazioni, evitando però
648 il lock implicito dello stream.
649
650 Per compatibilità con SVID sono inoltre provviste anche due funzioni,
651 \funcd{getw} e \funcd{putw}, da usare per leggere e scrivere una \textit{word}
652 (cioè due byte in una volta); i loro prototipi sono:
653 \begin{functions}
654   \headdecl{stdio.h} 
655   
656   \funcdecl{int getw(FILE *stream)} Legge una parola da \param{stream}.
657   \funcdecl{int putw(int w, FILE *stream)} Scrive la parola \param{w} su
658   \param{stream}.
659   
660   \bodydesc{Le funzioni restituiscono la parola \param{w}, o \val{EOF}
661     in caso di errore o di fine del file.}
662 \end{functions}
663
664 Le funzioni leggono e scrivono una \textit{word} di due byte, usando comunque
665 una variabile di tipo \ctyp{int}; il loro uso è deprecato in favore dell'uso
666 di \func{fread} e \func{fwrite}, in quanto non è possibile distinguere il
667 valore -1 da una condizione di errore che restituisce \val{EOF}.
668
669 Uno degli usi più frequenti dell'input/output a caratteri è nei programmi di
670 \textit{parsing} in cui si analizza il testo; in questo contesto diventa utile
671 poter analizzare il carattere successivo da uno stream senza estrarlo
672 effettivamente (la tecnica è detta \textit{peeking ahead}) in modo che il
673 programma possa regolarsi avendo dato una \textsl{sbirciatina} a quello che
674 viene dopo.
675
676 Nel nostro caso questo tipo di comportamento può essere realizzato prima
677 leggendo il carattere, e poi rimandandolo indietro, cosicché ridiventi
678 disponibile per una lettura successiva; la funzione che inverte la
679 lettura si chiama \funcd{ungetc} ed il suo prototipo è:
680 \begin{prototype}{stdio.h}{int ungetc(int c, FILE *stream)}
681   Rimanda indietro il carattere \param{c}, con un cast a \ctyp{unsigned
682     char}, sullo stream \param{stream}.
683
684   \bodydesc{La funzione ritorna \param{c} in caso di successo e
685   \val{EOF} in caso di errore.}
686 \end{prototype}
687 \noindent benché lo standard ANSI C preveda che l'operazione possa
688 essere ripetuta per un numero arbitrario di caratteri, alle
689 implementazioni è richiesto di garantire solo un livello; questo è
690 quello che fa la \acr{glibc}, che richiede che avvenga un'altra
691 operazione fra due \func{ungetc} successive.
692
693 Non è necessario che il carattere che si manda indietro sia l'ultimo che
694 si è letto, e non è necessario neanche avere letto nessun carattere
695 prima di usare \func{ungetc}, ma di norma la funzione è intesa per
696 essere usata per rimandare indietro l'ultimo carattere letto.
697
698 Nel caso \param{c} sia un \val{EOF} la funzione non fa nulla, e
699 restituisce sempre \val{EOF}; così si può usare \func{ungetc} anche
700 con il risultato di una lettura alla fine del file.
701
702 Se si è alla fine del file si può comunque rimandare indietro un
703 carattere, il flag di end-of-file verrà automaticamente cancellato
704 perché c'è un nuovo carattere disponibile che potrà essere riletto
705 successivamente.
706
707 Infine si tenga presente che \func{ungetc} non altera il contenuto del
708 file, ma opera esclusivamente sul buffer interno. Se si esegue una
709 qualunque delle operazioni di riposizionamento (vedi
710 sez.~\ref{sec:file_fseek}) i caratteri rimandati indietro vengono
711 scartati.
712
713
714 \subsection{Input/output di linea}
715 \label{sec:file_line_io}
716
717 La terza ed ultima modalità di input/output non formattato è quella di linea,
718 in cui si legge o si scrive una riga alla volta; questa è una modalità molto
719 usata per l'I/O da terminale, ma è anche quella che presenta le
720 caratteristiche più controverse.
721
722 Le funzioni previste dallo standard ANSI C per leggere una linea sono
723 sostanzialmente due, \funcd{gets} e \funcd{fgets}, i cui rispettivi
724 prototipi sono:
725 \begin{functions}
726   \headdecl{stdio.h} 
727   
728   \funcdecl{char *gets(char *string)} Scrive su \param{string} una
729   linea letta da \var{stdin}.
730   
731   \funcdecl{char *fgets(char *string, int size, FILE *stream)}
732   Scrive su \param{string} la linea letta da \param{stream} per un
733   massimo di \param{size} byte.
734   
735   \bodydesc{Le funzioni restituiscono l'indirizzo \param{string} in caso
736     di successo o \val{NULL} in caso di errore.}
737 \end{functions}
738
739 Entrambe le funzioni effettuano la lettura (dal file specificato \func{fgets},
740 dallo standard input \func{gets}) di una linea di caratteri (terminata dal
741 carattere \textit{newline}, \verb|'\n'|, quello mappato sul tasto di ritorno a
742 capo della tastiera), ma \func{gets} sostituisce \verb|'\n'| con uno zero,
743 mentre \func{fgets} aggiunge uno zero dopo il \textit{newline}, che resta
744 dentro la stringa. Se la lettura incontra la fine del file (o c'è un errore)
745 viene restituito un \val{NULL}, ed il buffer \param{buf} non viene toccato.
746 L'uso di \func{gets} è deprecato e deve essere assolutamente evitato; la
747 funzione infatti non controlla il numero di byte letti, per cui nel caso la
748 stringa letta superi le dimensioni del buffer, si avrà un \textit{buffer
749   overflow}\itindex{buffer~overflow}, con sovrascrittura della memoria del
750 processo adiacente al buffer.\footnote{questa tecnica è spiegata in dettaglio
751   e con molta efficacia nell'ormai famoso articolo di Aleph1 \cite{StS}.}
752
753 Questa è una delle vulnerabilità più sfruttate per guadagnare accessi non
754 autorizzati al sistema (i cosiddetti \textit{exploit}), basta infatti inviare
755 una stringa sufficientemente lunga ed opportunamente forgiata per
756 sovrascrivere gli indirizzi di ritorno nello \itindex{stack} \textit{stack}
757 (supposto che la \func{gets} sia stata chiamata da una subroutine), in modo da
758 far ripartire l'esecuzione nel codice inviato nella stringa stessa (in genere
759 uno \textit{shell code} cioè una sezione di programma che lancia una shell).
760
761 La funzione \func{fgets} non ha i precedenti problemi di \func{gets} in quanto
762 prende in input la dimensione del buffer \param{size}, che non verrà mai
763 ecceduta in lettura. La funzione legge fino ad un massimo di \param{size}
764 caratteri (newline compreso), ed aggiunge uno zero di terminazione; questo
765 comporta che la stringa possa essere al massimo di \code{size-1} caratteri.  Se
766 la linea eccede la dimensione del buffer verranno letti solo \code{size-1}
767 caratteri, ma la stringa sarà sempre terminata correttamente con uno zero
768 finale; sarà possibile leggere i rimanenti caratteri in una chiamata
769 successiva.
770
771 Per la scrittura di una linea lo standard ANSI C prevede altre due
772 funzioni, \funcd{fputs} e \funcd{puts}, analoghe a quelle di lettura, i
773 rispettivi prototipi sono:
774 \begin{functions}
775   \headdecl{stdio.h} 
776   
777   \funcdecl{int puts(const char *string)} Scrive su \var{stdout} la
778   linea \param{string}.
779   
780   \funcdecl{int fputs(const char *string, FILE *stream)} Scrive su
781   \param{stream} la linea \param{string}.
782   
783   \bodydesc{Le funzioni restituiscono un valore non negativo in caso di
784     successo o \val{EOF} in caso di errore.}
785 \end{functions}
786
787 Dato che in questo caso si scrivono i dati in uscita \func{puts} non ha i
788 problemi di \func{gets} ed è in genere la forma più immediata per scrivere
789 messaggi sullo standard output; la funzione prende una stringa terminata da
790 uno zero ed aggiunge automaticamente il ritorno a capo. La differenza con
791 \func{fputs} (a parte la possibilità di specificare un file diverso da
792 \var{stdout}) è che quest'ultima non aggiunge il newline, che deve essere
793 previsto esplicitamente.
794
795 Come per le analoghe funzioni di input/output a caratteri, anche per l'I/O di
796 linea esistono delle estensioni per leggere e scrivere linee di caratteri
797 estesi, le funzioni in questione sono \funcd{fgetws} e \funcd{fputws} ed i
798 loro prototipi sono:
799 \begin{functions}
800   \headdecl{wchar.h} 
801   \funcdecl{wchar\_t *fgetws(wchar\_t *ws, int n, FILE *stream)}
802   Legge un massimo di \param{n} caratteri estesi dal file
803   \param{stream} al buffer \param{ws}.
804   
805   \funcdecl{int fputws(const wchar\_t *ws, FILE *stream)} Scrive la
806   linea \param{ws} di caratteri estesi sul file \param{stream}.
807   
808   \bodydesc{Le funzioni ritornano rispettivamente \param{ws} o un numero
809     non negativo in caso di successo e \val{NULL} o \val{EOF} in
810     caso di errore o fine del file.}
811 \end{functions}
812
813 Il comportamento di queste due funzioni è identico a quello di \func{fgets} e
814 \func{fputs}, a parte il fatto che tutto (numero di caratteri massimo,
815 terminatore della stringa, newline) è espresso in termini di caratteri estesi
816 anziché di normali caratteri ASCII.
817
818 Come per l'I/O binario e quello a caratteri, anche per l'I/O di linea le
819 \acr{glibc} supportano una serie di altre funzioni, estensioni di tutte quelle
820 illustrate finora (eccetto \func{gets} e \func{puts}), che eseguono
821 esattamente le stesse operazioni delle loro equivalenti, evitando però il lock
822 implicito dello stream (vedi sez.~\ref{sec:file_stream_thread}). Come per le
823 altre forma di I/O, dette funzioni hanno lo stesso nome della loro analoga
824 normale, con l'aggiunta dell'estensione \code{\_unlocked}.
825
826 Come abbiamo visto, le funzioni di lettura per l'input/output di linea
827 previste dallo standard ANSI C presentano svariati inconvenienti. Benché
828 \func{fgets} non abbia i gravissimi problemi di \func{gets}, può
829 comunque dare risultati ambigui se l'input contiene degli zeri; questi
830 infatti saranno scritti sul buffer di uscita e la stringa in output
831 apparirà come più corta dei byte effettivamente letti. Questa è una
832 condizione che è sempre possibile controllare (deve essere presente un
833 newline prima della effettiva conclusione della stringa presente nel
834 buffer), ma a costo di una complicazione ulteriore della logica del
835 programma. Lo stesso dicasi quando si deve gestire il caso di stringa
836 che eccede le dimensioni del buffer.
837
838 Per questo motivo le \acr{glibc} prevedono, come estensione GNU, due nuove
839 funzioni per la gestione dell'input/output di linea, il cui uso permette di
840 risolvere questi problemi. L'uso di queste funzioni deve essere attivato
841 definendo la macro \macro{\_GNU\_SOURCE} prima di includere \file{stdio.h}. La
842 prima delle due, \funcd{getline}, serve per leggere una linea terminata da un
843 newline, esattamente allo stesso modo di \func{fgets}, il suo prototipo è:
844 \begin{prototype}{stdio.h}
845   {ssize\_t getline(char **buffer, size\_t *n, FILE *stream)} Legge una linea
846   dal file \param{stream} copiandola sul buffer indicato da \param{buffer}
847   riallocandolo se necessario (l'indirizzo del buffer e la sua dimensione
848   vengono sempre riscritte).
849
850   \bodydesc{La funzione ritorna il numero di caratteri letti in caso di
851   successo e -1 in caso di errore o di raggiungimento della fine del
852   file.}
853 \end{prototype}
854
855 La funzione permette di eseguire una lettura senza doversi preoccupare della
856 eventuale lunghezza eccessiva della stringa da leggere. Essa prende come primo
857 argomento l'indirizzo del puntatore al buffer su cui si vuole copiare la
858 linea. Quest'ultimo \emph{deve} essere stato allocato in precedenza con una
859 \func{malloc} (non si può passare l'indirizzo di un puntatore ad una variabile
860 locale); come secondo argomento la funzione vuole l'indirizzo della variabile
861 contenente le dimensioni del buffer suddetto.
862
863 Se il buffer di destinazione è sufficientemente ampio la stringa viene scritta
864 subito, altrimenti il buffer viene allargato usando \func{realloc} e la nuova
865 dimensione ed il nuovo puntatore vengono restituiti indietro (si noti infatti
866 come per entrambi gli argomenti si siano usati dei
867 \itindex{value~result~argument}\textit{value result argument}, passando dei
868 puntatori anziché i valori delle variabili, secondo la tecnica spiegata in
869 sez.~\ref{sec:proc_var_passing}).
870
871 Se si passa alla funzione l'indirizzo di un puntatore impostato a \val{NULL} e
872 \var{*n} è zero, la funzione provvede da sola all'allocazione della memoria
873 necessaria a contenere la linea. In tutti i casi si ottiene dalla funzione un
874 puntatore all'inizio del testo della linea letta. Un esempio di codice può
875 essere il seguente: 
876 \includecodesnip{listati/getline.c} 
877 e per evitare \textit{memory leak}\itindex{memory~leak} occorre ricordarsi di
878 liberare \var{ptr} con una \func{free}.
879
880 Il valore di ritorno della funzione indica il numero di caratteri letti
881 dallo stream (quindi compreso il newline, ma non lo zero di
882 terminazione); questo permette anche di distinguere eventuali zeri letti
883 dallo stream da quello inserito dalla funzione per terminare la linea.
884 Se si è alla fine del file e non si è potuto leggere nulla o c'è stato
885 un errore la funzione restituisce -1.
886
887 La seconda estensione GNU è una generalizzazione di \func{getline} per
888 poter usare come separatore un carattere qualsiasi, la funzione si
889 chiama \funcd{getdelim} ed il suo prototipo è:
890 \begin{prototype}{stdio.h}
891 {ssize\_t getdelim(char **buffer, size\_t *n, int delim, FILE *stream)} 
892   Identica a \func{getline} solo che usa \param{delim} al posto del
893   carattere di newline come separatore di linea.
894 \end{prototype}
895
896 Il comportamento di \func{getdelim} è identico a quello di \func{getline} (che
897 può essere implementata da questa passando \verb|'\n'| come valore di
898 \param{delim}).
899
900
901 \subsection{L'input/output formattato}
902 \label{sec:file_formatted_io}
903
904 L'ultima modalità di input/output è quella formattata, che è una delle
905 caratteristiche più utilizzate delle librerie standard del C; in genere questa
906 è la modalità in cui si esegue normalmente l'output su terminale poiché
907 permette di stampare in maniera facile e veloce dati, tabelle e messaggi.
908
909 L'output formattato viene eseguito con una delle 13 funzioni della famiglia
910 \func{printf}; le tre più usate sono \funcd{printf}, \funcd{fprintf} e
911 \funcd{sprintf}, i cui prototipi sono:
912 \begin{functions}
913   \headdecl{stdio.h} 
914   \funcdecl{int printf(const char *format, ...)} Stampa su \file{stdout}
915   gli argomenti, secondo il formato specificato da \param{format}.
916   
917   \funcdecl{int fprintf(FILE *stream, const char *format, ...)}  Stampa
918   su \param{stream} gli argomenti, secondo il formato specificato da
919   \param{format}.
920   
921   \funcdecl{int sprintf(char *str, const char *format, ...)} Stampa
922   sulla stringa \param{str} gli argomenti, secondo il formato
923   specificato da \param{format}.
924
925   \bodydesc{Le funzioni ritornano il numero di caratteri stampati.}
926 \end{functions}
927 \noindent le prime due servono per stampare su file (lo standard output o
928 quello specificato) la terza permette di stampare su una stringa, in genere
929 l'uso di \func{sprintf} è sconsigliato in quanto è possibile, se non si ha la
930 sicurezza assoluta sulle dimensioni del risultato della stampa, eccedere le
931 dimensioni di \param{str}, con conseguente sovrascrittura di altre variabili e
932 possibili \textit{buffer overflow}\itindex{buffer~overflow}; per questo motivo
933 si consiglia l'uso dell'alternativa \funcd{snprintf}, il cui prototipo è:
934 \begin{prototype}{stdio.h}
935 {snprintf(char *str, size\_t size, const char *format, ...)} 
936   Identica a \func{sprintf}, ma non scrive su \param{str} più di
937   \param{size} caratteri.
938 \end{prototype}
939
940 La parte più complessa delle funzioni di scrittura formattata è il formato
941 della stringa \param{format} che indica le conversioni da fare, e da cui
942 deriva anche il numero degli argomenti che dovranno essere passati a seguire
943 (si noti come tutte queste funzioni siano \textit{variadic}\index{variadic},
944 prendendo un numero di argomenti variabile che dipende appunto da quello che
945 si è specificato in \param{format}).
946
947 \begin{table}[htb]
948   \centering
949   \footnotesize
950   \begin{tabular}[c]{|l|l|p{10cm}|}
951     \hline
952     \textbf{Valore} & \textbf{Tipo} & \textbf{Significato} \\
953     \hline
954     \hline
955    \cmd{\%d} &\ctyp{int}         & Stampa un numero intero in formato decimale
956                                    con segno \\
957    \cmd{\%i} &\ctyp{int}         & Identico a \cmd{\%i} in output, \\
958    \cmd{\%o} &\ctyp{unsigned int}& Stampa un numero intero come ottale\\
959    \cmd{\%u} &\ctyp{unsigned int}& Stampa un numero intero in formato
960                                    decimale senza segno \\
961    \cmd{\%x}, 
962    \cmd{\%X} &\ctyp{unsigned int}& Stampano un intero in formato esadecimale,
963                                    rispettivamente con lettere minuscole e
964                                    maiuscole. \\
965    \cmd{\%f} &\ctyp{double}      & Stampa un numero in virgola mobile con la
966                                    notazione a virgola fissa \\
967    \cmd{\%e}, 
968    \cmd{\%E} &\ctyp{double} & Stampano un numero in virgola mobile con la
969                               notazione esponenziale, rispettivamente con
970                               lettere minuscole e maiuscole. \\
971    \cmd{\%g}, 
972    \cmd{\%G} &\ctyp{double} & Stampano un numero in virgola mobile con la
973                               notazione più appropriate delle due precedenti,
974                               rispettivamente con lettere minuscole e
975                               maiuscole. \\
976    \cmd{\%a}, 
977    \cmd{\%A} &\ctyp{double} & Stampano un numero in virgola mobile in
978                               notazione esadecimale frazionaria\\
979    \cmd{\%c} &\ctyp{int}    & Stampa un carattere singolo\\
980    \cmd{\%s} &\ctyp{char *} & Stampa una stringa \\
981    \cmd{\%p} &\ctyp{void *} & Stampa il valore di un puntatore\\
982    \cmd{\%n} &\ctyp{\&int}  & Prende il numero di caratteri stampati finora\\
983    \cmd{\%\%}&              & Stampa un \% \\
984     \hline
985   \end{tabular}
986   \caption{Valori possibili per gli specificatori di conversione in una
987     stringa di formato di \func{printf}.} 
988   \label{tab:file_format_spec}
989 \end{table}
990
991 La stringa è costituita da caratteri normali (tutti eccetto \texttt{\%}), che
992 vengono passati invariati all'output, e da direttive di conversione, in cui
993 devono essere sempre presenti il carattere \texttt{\%}, che introduce la
994 direttiva, ed uno degli specificatori di conversione (riportati in
995 tab.~\ref{tab:file_format_spec}) che la conclude.
996
997 \begin{table}[htb]
998   \centering
999   \footnotesize
1000   \begin{tabular}[c]{|l|p{10cm}|}
1001     \hline
1002     \textbf{Valore} & \textbf{Significato}\\
1003     \hline
1004     \hline
1005     \val{\#} & Chiede la conversione in forma alternativa. \\
1006     \val{0}  & La conversione è riempita con zeri alla sinistra del valore.\\
1007     \val{-}  & La conversione viene allineata a sinistra sul bordo del campo.\\
1008     \val{' '}& Mette uno spazio prima di un numero con segno di valore 
1009                positivo\\
1010     \val{+}  & Mette sempre il segno ($+$ o $-$) prima di un numero.\\
1011     \hline
1012   \end{tabular}
1013   \caption{I valori dei flag per il formato di \func{printf}}
1014   \label{tab:file_format_flag}
1015 \end{table}
1016
1017 Il formato di una direttiva di conversione prevede una serie di possibili
1018 elementi opzionali oltre al \cmd{\%} e allo specificatore di conversione. In
1019 generale essa è sempre del tipo:
1020 \begin{center}
1021 \begin{verbatim}
1022 % [n. parametro $] [flag] [[larghezza] [. precisione]] [tipo] conversione
1023 \end{verbatim}
1024 \end{center}
1025 in cui tutti i valori tranne il \val{\%} e lo specificatore di conversione
1026 sono opzionali (e per questo sono indicati fra parentesi quadre); si possono
1027 usare più elementi opzionali, nel qual caso devono essere specificati in
1028 questo ordine:
1029 \begin{itemize*}
1030 \item uno specificatore del parametro da usare (terminato da un \val{\$}),
1031 \item uno o più flag (i cui valori possibili sono riassunti in
1032   tab.~\ref{tab:file_format_flag}) che controllano il formato di stampa della
1033   conversione,
1034 \item uno specificatore di larghezza (un numero decimale), eventualmente
1035   seguito (per i numeri in virgola mobile) da un specificatore di precisione
1036   (un altro numero decimale),
1037 \item uno specificatore del tipo di dato, che ne indica la dimensione (i cui
1038   valori possibili sono riassunti in tab.~\ref{tab:file_format_type}).
1039 \end{itemize*}
1040
1041
1042 Dettagli ulteriori sulle varie opzioni possono essere trovati nella pagina di
1043 manuale di \func{printf} e nella documentazione delle \acr{glibc}.
1044
1045 \begin{table}[htb]
1046   \centering
1047   \footnotesize
1048   \begin{tabular}[c]{|l|p{10cm}|}
1049     \hline
1050     \textbf{Valore} & \textbf{Significato} \\
1051     \hline
1052     \hline
1053     \cmd{hh} & una conversione intera corrisponde a un \ctyp{char} con o senza
1054                segno, o il puntatore per il numero dei parametri \cmd{n} è di 
1055                tipo \ctyp{char}.\\
1056     \cmd{h}  & una conversione intera corrisponde a uno \ctyp{short} con o 
1057                senza segno, o il puntatore per il numero dei parametri \cmd{n}
1058                è di tipo \ctyp{short}.\\
1059     \cmd{l}  & una conversione intera corrisponde a un \ctyp{long} con o 
1060                senza segno, o il puntatore per il numero dei parametri \cmd{n}
1061                è di tipo \ctyp{long}, o il carattere o la stringa seguenti
1062                sono in formato esteso.\\ 
1063     \cmd{ll} & una conversione intera corrisponde a un \ctyp{long long} con o 
1064                senza segno, o il puntatore per il numero dei parametri \cmd{n}
1065                è di tipo \ctyp{long long}.\\
1066     \cmd{L}  & una conversione in virgola mobile corrisponde a un
1067                \ctyp{double}.\\
1068     \cmd{q}  & sinonimo di \cmd{ll}.\\
1069     \cmd{j}  & una conversione intera corrisponde a un \type{intmax\_t} o 
1070                \type{uintmax\_t}.\\
1071     \cmd{z}  & una conversione intera corrisponde a un \type{size\_t} o 
1072                \type{ssize\_t}.\\
1073     \cmd{t}  & una conversione intera corrisponde a un \type{ptrdiff\_t}.\\
1074     \hline
1075   \end{tabular}
1076   \caption{Il modificatore di tipo di dato per il formato di \func{printf}}
1077   \label{tab:file_format_type}
1078 \end{table}
1079
1080 Una versione alternativa delle funzioni di output formattato, che permettono
1081 di usare il puntatore ad una lista di argomenti (vedi
1082 sez.~\ref{sec:proc_variadic}), sono \funcd{vprintf}, \funcd{vfprintf} e
1083 \funcd{vsprintf}, i cui prototipi sono:
1084 \begin{functions}
1085   \headdecl{stdio.h} 
1086   
1087   \funcdecl{int vprintf(const char *format, va\_list ap)} Stampa su
1088   \var{stdout} gli argomenti della lista \param{ap}, secondo il formato
1089   specificato da \param{format}.
1090   
1091   \funcdecl{int vfprintf(FILE *stream, const char *format, va\_list ap)}
1092   Stampa su \param{stream} gli argomenti della lista \param{ap}, secondo il
1093   formato specificato da \param{format}.
1094   
1095   \funcdecl{int vsprintf(char *str, const char *format, va\_list ap)} Stampa
1096   sulla stringa \param{str} gli argomenti della lista \param{ap}, secondo il
1097   formato specificato da \param{format}.
1098
1099   \bodydesc{Le funzioni ritornano il numero di caratteri stampati.}
1100 \end{functions}
1101 \noindent con queste funzioni diventa possibile selezionare gli argomenti che
1102 si vogliono passare ad una funzione di stampa, passando direttamente la lista
1103 tramite l'argomento \param{ap}. Per poter far questo ovviamente la lista degli
1104 argomenti dovrà essere opportunamente trattata (l'argomento è esaminato in
1105 sez.~\ref{sec:proc_variadic}), e dopo l'esecuzione della funzione l'argomento
1106 \param{ap} non sarà più utilizzabile (in generale dovrebbe essere eseguito un
1107 \code{va\_end(ap)} ma in Linux questo non è necessario). 
1108
1109 Come per \func{sprintf} anche per \func{vsprintf} esiste una analoga
1110 \funcd{vsnprintf} che pone un limite sul numero di caratteri che vengono
1111 scritti sulla stringa di destinazione:
1112 \begin{prototype}{stdio.h}
1113 {vsnprintf(char *str, size\_t size, const char *format, va\_list ap)} 
1114   Identica a \func{vsprintf}, ma non scrive su \param{str} più di
1115   \param{size} caratteri.
1116 \end{prototype}
1117 \noindent in modo da evitare possibili buffer
1118 overflow\itindex{buffer~overflow}.
1119
1120
1121 Per eliminare alla radice questi problemi, le \acr{glibc} supportano una
1122 specifica estensione GNU che alloca dinamicamente tutto lo spazio necessario;
1123 l'estensione si attiva al solito definendo \macro{\_GNU\_SOURCE}, le due
1124 funzioni sono \funcd{asprintf} e \funcd{vasprintf}, ed i rispettivi prototipi
1125 sono:
1126 \begin{functions}
1127   \headdecl{stdio.h} 
1128     
1129   \funcdecl{int asprintf(char **strptr, const char *format, ...)}  Stampa gli
1130   argomenti specificati secondo il formato specificato da \param{format} su
1131   una stringa allocata automaticamente all'indirizzo \param{*strptr}.
1132   
1133   \funcdecl{int vasprintf(char **strptr, const char *format, va\_list ap)}
1134   Stampa gli argomenti della lista \param{ap} secondo il formato specificato
1135   da \param{format} su una stringa allocata automaticamente all'indirizzo
1136   \param{*strptr}.
1137
1138   \bodydesc{Le funzioni ritornano il numero di caratteri stampati.}
1139 \end{functions}
1140
1141 Entrambe le funzioni prendono come argomento \param{strptr} che deve essere
1142 l'indirizzo di un puntatore ad una stringa di caratteri, in cui verrà
1143 restituito (si ricordi quanto detto in sez.~\ref{sec:proc_var_passing} a
1144 proposito dei \itindex{value~result~argument}\textit{value result argument})
1145 l'indirizzo della stringa allocata automaticamente dalle funzioni. Occorre
1146 inoltre ricordarsi di invocare \func{free} per liberare detto puntatore quando
1147 la stringa non serve più, onde evitare \textit{memory
1148   leak}\itindex{memory~leak}.
1149
1150 Infine una ulteriore estensione GNU definisce le due funzioni \func{dprintf} e
1151 \func{vdprintf}, che prendono un file descriptor al posto dello stream. Altre
1152 estensioni permettono di scrivere con caratteri estesi. Anche queste funzioni,
1153 il cui nome è generato dalle precedenti funzioni aggiungendo una \texttt{w}
1154 davanti a \texttt{print}, sono trattate in dettaglio nella documentazione delle
1155 \acr{glibc}.
1156
1157 In corrispondenza alla famiglia di funzioni \func{printf} che si usano per
1158 l'output formattato, l'input formattato viene eseguito con le funzioni della
1159 famiglia \func{scanf}; fra queste le tre più importanti sono \funcd{scanf},
1160 \funcd{fscanf} e \funcd{sscanf}, i cui prototipi sono:
1161 \begin{functions}
1162   \headdecl{stdio.h} \funcdecl{int scanf(const char *format, ...)} Esegue una
1163   scansione di \file{stdin} cercando una corrispondenza di quanto letto con il
1164   formato dei dati specificato da \param{format}, ed effettua le relative
1165   conversione memorizzando il risultato negli argomenti seguenti.
1166   
1167   \funcdecl{int fscanf(FILE *stream, const char *format, ...)}  Analoga alla
1168   precedente, ma effettua la scansione su \param{stream}.
1169   
1170   \funcdecl{int sscanf(char *str, const char *format, ...)} Analoga alle
1171   precedenti, ma effettua la scansione dalla stringa \param{str}.
1172   
1173   \bodydesc{Le funzioni ritornano il numero di elementi assegnati. Questi
1174     possono essere in numero inferiore a quelli specificati, ed anche zero.
1175     Quest'ultimo valore significa che non si è trovata corrispondenza. In caso
1176     di errore o fine del file viene invece restituito \val{EOF}.}
1177 \end{functions}
1178 \noindent e come per le analoghe funzioni di scrittura esistono le relative
1179 \func{vscanf}, \func{vfscanf} \func{vsscanf} che usano un puntatore ad una
1180 lista di argomenti.
1181
1182 Tutte le funzioni della famiglia delle \func{scanf} vogliono come argomenti i
1183 puntatori alle variabili che dovranno contenere le conversioni; questo è un
1184 primo elemento di disagio in quanto è molto facile dimenticarsi di questa
1185 caratteristica.
1186
1187 Le funzioni leggono i caratteri dallo stream (o dalla stringa) di input ed
1188 eseguono un confronto con quanto indicato in \param{format}, la sintassi di
1189 questo argomento è simile a quella usata per l'analogo di \func{printf}, ma ci
1190 sono varie differenze.  Le funzioni di input infatti sono più orientate verso
1191 la lettura di testo libero che verso un input formattato in campi fissi. Uno
1192 spazio in \param{format} corrisponde con un numero qualunque di caratteri di
1193 separazione (che possono essere spazi, tabulatori, virgole ecc.), mentre
1194 caratteri diversi richiedono una corrispondenza esatta. Le direttive di
1195 conversione sono analoghe a quelle di \func{printf} e si trovano descritte in
1196 dettaglio nelle pagine di manuale e nel manuale delle \acr{glibc}.
1197
1198 Le funzioni eseguono la lettura dall'input, scartano i separatori (e gli
1199 eventuali caratteri diversi indicati dalla stringa di formato) effettuando le
1200 conversioni richieste; in caso la corrispondenza fallisca (o la funzione non
1201 sia in grado di effettuare una delle conversioni richieste) la scansione viene
1202 interrotta immediatamente e la funzione ritorna lasciando posizionato lo
1203 stream al primo carattere che non corrisponde.
1204
1205 Data la notevole complessità di uso di queste funzioni, che richiedono molta
1206 cura nella definizione delle corrette stringhe di formato e sono facilmente
1207 soggette ad errori, e considerato anche il fatto che è estremamente macchinoso
1208 recuperare in caso di fallimento nelle corrispondenze, l'input formattato non
1209 è molto usato. In genere infatti quando si ha a che fare con un input
1210 relativamente semplice si preferisce usare l'input di linea ed effettuare
1211 scansione e conversione di quanto serve direttamente con una delle funzioni di
1212 conversione delle stringhe; se invece il formato è più complesso diventa più
1213 facile utilizzare uno strumento come \cmd{flex}\footnote{il programma
1214   \cmd{flex}, è una implementazione libera di \cmd{lex} un generatore di
1215   analizzatori lessicali. Per i dettagli si può fare riferimento al manuale
1216   \cite{flex}.} per generare un analizzatore lessicale o il
1217 \cmd{bison}\footnote{il programma \cmd{bison} è un clone del generatore di
1218   parser \cmd{yacc}, maggiori dettagli possono essere trovati nel relativo
1219   manuale \cite{bison}.} per generare un parser.
1220
1221
1222 \subsection{Posizionamento su uno stream}
1223 \label{sec:file_fseek}
1224
1225 Come per i file descriptor anche per gli stream è possibile spostarsi
1226 all'interno di un file per effettuare operazioni di lettura o scrittura in un
1227 punto prestabilito; sempre che l'operazione di riposizionamento sia supportata
1228 dal file sottostante lo stream, quando cioè si ha a che fare con quello che
1229 viene detto un file ad \textsl{accesso casuale}.\footnote{dato che in un
1230   sistema Unix esistono vari tipi di file, come le fifo ed i file di
1231   dispositivo\index{file!di~dispositivo}, non è scontato che questo sia sempre
1232   vero.}
1233
1234 In GNU/Linux ed in generale in ogni sistema unix-like la posizione nel file è
1235 espressa da un intero positivo, rappresentato dal tipo \type{off\_t}, il
1236 problema è che alcune delle funzioni usate per il riposizionamento sugli
1237 stream originano dalle prime versioni di Unix, in cui questo tipo non era
1238 ancora stato definito, e che in altri sistemi non è detto che la posizione su
1239 un file venga sempre rappresentata con il numero di caratteri dall'inizio (ad
1240 esempio in VMS può essere rappresentata come numero di record, più l'offset
1241 rispetto al record corrente).
1242
1243 Tutto questo comporta la presenza di diverse funzioni che eseguono
1244 sostanzialmente le stesse operazioni, ma usano argomenti di tipo diverso. Le
1245 funzioni tradizionali usate per il riposizionamento della posizione in uno
1246 stream sono \funcd{fseek} e \funcd{rewind} i cui prototipi sono:
1247 \begin{functions}
1248   \headdecl{stdio.h} 
1249   
1250   \funcdecl{int fseek(FILE *stream, long offset, int whence)} Sposta la
1251   posizione nello stream secondo quanto specificato tramite \param{offset}
1252   e \param{whence}.  
1253
1254   \funcdecl{void rewind(FILE *stream)} Riporta la posizione nello stream
1255   all'inizio del file.
1256 \end{functions}
1257
1258 L'uso di \func{fseek} è del tutto analogo a quello di \func{lseek} per i file
1259 descriptor, e gli argomenti, a parte il tipo, hanno lo stesso significato; in
1260 particolare \param{whence} assume gli stessi valori già visti in
1261 sez.~\ref{sec:file_lseek}.  La funzione restituisce 0 in caso di successo e -1
1262 in caso di errore.  La funzione \func{rewind} riporta semplicemente la
1263 posizione corrente all'inizio dello stream, ma non esattamente equivalente ad
1264 una \code{fseek(stream, 0L, SEEK\_SET)} in quanto vengono cancellati anche i
1265 flag di errore e fine del file.
1266
1267 Per ottenere la posizione corrente si usa invece la funzione \funcd{ftell}, il
1268 cui prototipo è:
1269 \begin{prototype}{stdio.h}{long ftell(FILE *stream)} 
1270   Legge la posizione attuale nello stream \param{stream}.
1271   
1272   \bodydesc{La funzione restituisce la posizione corrente, o -1 in caso
1273     di fallimento, che può esser dovuto sia al fatto che il file non
1274     supporta il riposizionamento che al fatto che la posizione non può
1275     essere espressa con un \ctyp{long int}}
1276 \end{prototype}
1277 \noindent la funzione restituisce la posizione come numero di byte
1278 dall'inizio dello stream. 
1279
1280 Queste funzioni esprimono tutte la posizione nel file come un \ctyp{long int}.
1281 Dato che (ad esempio quando si usa un filesystem indicizzato a 64 bit) questo
1282 può non essere possibile lo standard POSIX ha introdotto le nuove funzioni
1283 \funcd{fgetpos} e \funcd{fsetpos}, che invece usano il nuovo tipo
1284 \type{fpos\_t}, ed i cui prototipi sono:
1285 \begin{functions}
1286   \headdecl{stdio.h} 
1287   
1288   \funcdecl{int fsetpos(FILE *stream, fpos\_t *pos)} Imposta la posizione
1289   corrente nello stream \param{stream} al valore specificato da \param{pos}.
1290   
1291   \funcdecl{int fgetpos(FILE *stream, fpos\_t *pos)} Legge la posizione
1292   corrente nello stream \param{stream} e la scrive in \param{pos}.
1293   
1294   \bodydesc{Le funzioni ritornano 0 in caso di successo e -1 in caso di
1295     errore.}
1296 \end{functions}
1297
1298 In Linux, a partire dalle glibc 2.1, sono presenti anche le due funzioni
1299 \func{fseeko} e \func{ftello}, che sono assolutamente identiche alle
1300 precedenti \func{fseek} e \func{ftell} ma hanno argomenti di tipo
1301 \type{off\_t} anziché di tipo \ctyp{long int}.
1302
1303
1304
1305 \section{Funzioni avanzate}
1306 \label{sec:file_stream_adv_func}
1307
1308 In questa sezione esamineremo alcune funzioni avanzate che permettono di
1309 eseguire operazioni particolari sugli stream, come leggerne gli attributi,
1310 controllarne le modalità di bufferizzazione, gestire direttamente i lock
1311 impliciti per la programmazione multi thread.
1312
1313
1314 \subsection{Le funzioni di controllo}
1315 \label{sec:file_stream_cntrl}
1316
1317 Al contrario di quanto avviene con i file descriptor, le librerie standard del
1318 C non prevedono nessuna funzione come la \func{fcntl} per il controllo degli
1319 attributi dei file. Però, dato che ogni stream si appoggia ad un file
1320 descriptor, si può usare la funzione \funcd{fileno} per ottenere quest'ultimo,
1321 il prototipo della funzione è:
1322 \begin{prototype}{stdio.h}{int fileno(FILE *stream)}
1323   Legge il file descriptor sottostante lo stream \param{stream}.
1324   
1325   \bodydesc{Restituisce il numero del file descriptor in caso di successo, e
1326     -1 qualora \param{stream} non sia valido, nel qual caso imposta
1327     \var{errno} a \errval{EBADF}.}
1328 \end{prototype}
1329 \noindent ed in questo modo diventa possibile usare direttamente \func{fcntl}.
1330
1331 Questo permette di accedere agli attributi del file descriptor sottostante lo
1332 stream, ma non ci dà nessuna informazione riguardo alle proprietà dello stream
1333 medesimo.  Le \acr{glibc} però supportano alcune estensioni derivate da
1334 Solaris, che permettono di ottenere informazioni utili.
1335
1336 Ad esempio in certi casi può essere necessario sapere se un certo stream è
1337 accessibile in lettura o scrittura. In genere questa informazione non è
1338 disponibile, e si deve ricordare come il file è stato aperto. La cosa può
1339 essere complessa se le operazioni vengono effettuate in una subroutine, che a
1340 questo punto necessiterà di informazioni aggiuntive rispetto al semplice
1341 puntatore allo stream; questo può essere evitato con le due funzioni
1342 \funcd{\_\_freadable} e \funcd{\_\_fwritable} i cui prototipi sono:
1343 \begin{functions}
1344   \headdecl{stdio\_ext.h}
1345   \funcdecl{int \_\_freadable(FILE *stream)}
1346   Restituisce un valore diverso da zero se \param{stream} consente la lettura.
1347
1348   \funcdecl{int \_\_fwritable(FILE *stream)}  
1349   Restituisce un valore diverso da zero se \param{stream} consente la
1350   scrittura.
1351 \end{functions}
1352 \noindent che permettono di ottenere questa informazione.
1353
1354 La conoscenza dell'ultima operazione effettuata su uno stream aperto è utile
1355 in quanto permette di trarre conclusioni sullo stato del buffer e del suo
1356 contenuto. Altre due funzioni, \funcd{\_\_freading} e \funcd{\_\_fwriting}
1357 servono a tale scopo, il loro prototipo è:
1358 \begin{functions}
1359   \headdecl{stdio\_ext.h}
1360   \funcdecl{int \_\_freading(FILE *stream)}
1361   Restituisce un valore diverso da zero se \param{stream} è aperto in sola
1362   lettura o se l'ultima operazione è stata di lettura.
1363
1364   \funcdecl{int \_\_fwriting(FILE *stream)}  
1365   Restituisce un valore diverso da zero se \param{stream} è aperto in sola
1366   scrittura o se l'ultima operazione è stata di scrittura.
1367 \end{functions}
1368
1369 Le due funzioni permettono di determinare di che tipo è stata l'ultima
1370 operazione eseguita su uno stream aperto in lettura/scrittura; ovviamente se
1371 uno stream è aperto in sola lettura (o sola scrittura) la modalità dell'ultima
1372 operazione è sempre determinata; l'unica ambiguità è quando non sono state
1373 ancora eseguite operazioni, in questo caso le funzioni rispondono come se una
1374 operazione ci fosse comunque stata.
1375
1376
1377 \subsection{Il controllo della bufferizzazione}
1378 \label{sec:file_buffering_ctrl}
1379
1380 Come accennato in sez.~\ref{sec:file_buffering} le librerie definiscono una
1381 serie di funzioni che permettono di controllare il comportamento degli stream;
1382 se non si è specificato nulla, la modalità di buffering viene decisa
1383 autonomamente sulla base del tipo di file sottostante, ed i buffer vengono
1384 allocati automaticamente.
1385
1386 Però una volta che si sia aperto lo stream (ma prima di aver compiuto
1387 operazioni su di esso) è possibile intervenire sulle modalità di buffering; la
1388 funzione che permette di controllare la bufferizzazione è \funcd{setvbuf}, il
1389 suo prototipo è:
1390 \begin{prototype}{stdio.h}{int setvbuf(FILE *stream, char *buf, int mode, 
1391     size\_t size)}
1392   
1393   Imposta la bufferizzazione dello stream \param{stream} nella modalità
1394   indicata da \param{mode}, usando \param{buf} come buffer di lunghezza
1395   \param{size}.
1396   
1397   \bodydesc{Restituisce zero in caso di successo, ed un valore qualunque in
1398     caso di errore, nel qual caso \var{errno} viene impostata opportunamente.}
1399 \end{prototype}
1400
1401 La funzione permette di controllare tutti gli aspetti della bufferizzazione;
1402 l'utente può specificare un buffer da usare al posto di quello allocato dal
1403 sistema passandone alla funzione l'indirizzo in \param{buf} e la dimensione in
1404 \param{size}. 
1405
1406 Ovviamente se si usa un buffer specificato dall'utente questo deve essere
1407 stato allocato e rimanere disponibile per tutto il tempo in cui si opera sullo
1408 stream. In genere conviene allocarlo con \func{malloc} e disallocarlo dopo la
1409 chiusura del file; ma fintanto che il file è usato all'interno di una
1410 funzione, può anche essere usata una variabile automatica. In \file{stdio.h} è
1411 definita la macro \const{BUFSIZ}, che indica le dimensioni generiche del
1412 buffer di uno stream; queste vengono usate dalla funzione \func{setbuf}.  Non
1413 è detto però che tale dimensione corrisponda sempre al valore ottimale (che
1414 può variare a seconda del dispositivo).
1415
1416 Dato che la procedura di allocazione manuale è macchinosa, comporta dei rischi
1417 (come delle scritture accidentali sul buffer) e non assicura la scelta delle
1418 dimensioni ottimali, è sempre meglio lasciare allocare il buffer alle funzioni
1419 di libreria, che sono in grado di farlo in maniera ottimale e trasparente
1420 all'utente (in quanto la deallocazione avviene automaticamente). Inoltre
1421 siccome alcune implementazioni usano parte del buffer per mantenere delle
1422 informazioni di controllo, non è detto che le dimensioni dello stesso
1423 coincidano con quelle su cui viene effettuato l'I/O.
1424
1425 \begin{table}[htb]
1426   \centering
1427   \footnotesize
1428     \begin{tabular}[c]{|l|l|}
1429       \hline
1430       \textbf{Valore} & \textbf{Modalità} \\
1431       \hline
1432       \hline
1433       \const{\_IONBF} & \textit{unbuffered}\\
1434       \const{\_IOLBF} & \textit{line buffered}\\
1435       \const{\_IOFBF} & \textit{fully buffered}\\
1436       \hline
1437     \end{tabular}
1438     \caption{Valori dell'argomento \param{mode} di \func{setvbuf} 
1439       per l'impostazione delle modalità di bufferizzazione.}
1440   \label{tab:file_stream_buf_mode}
1441 \end{table}
1442
1443 Per evitare che \func{setvbuf} imposti il buffer basta passare un valore
1444 \val{NULL} per \param{buf} e la funzione ignorerà l'argomento \param{size}
1445 usando il buffer allocato automaticamente dal sistema.  Si potrà comunque
1446 modificare la modalità di bufferizzazione, passando in \param{mode} uno degli
1447 opportuni valori elencati in tab.~\ref{tab:file_stream_buf_mode}. Qualora si
1448 specifichi la modalità non bufferizzata i valori di \param{buf} e \param{size}
1449 vengono sempre ignorati.
1450
1451 Oltre a \func{setvbuf} le \acr{glibc} definiscono altre tre funzioni per la
1452 gestione della bufferizzazione di uno stream: \funcd{setbuf}, \funcd{setbuffer}
1453 e \funcd{setlinebuf}; i loro prototipi sono:
1454 \begin{functions}
1455   \headdecl{stdio.h} 
1456   
1457   \funcdecl{void setbuf(FILE *stream, char *buf)} Disabilita la
1458   bufferizzazione se \param{buf} è \val{NULL}, altrimenti usa \param{buf}
1459   come buffer di dimensione \const{BUFSIZ} in modalità \textit{fully buffered}.
1460   
1461   \funcdecl{void setbuffer(FILE *stream, char *buf, size\_t size)} Disabilita
1462   la bufferizzazione se \param{buf} è \val{NULL}, altrimenti usa \param{buf}
1463   come buffer di dimensione \param{size} in modalità \textit{fully buffered}.
1464   
1465   \funcdecl{void setlinebuf(FILE *stream)} Pone lo stream in modalità
1466   \textit{line buffered}.
1467 \end{functions}
1468 \noindent tutte queste funzioni sono realizzate con opportune chiamate a
1469 \func{setvbuf} e sono definite solo per compatibilità con le vecchie librerie
1470 BSD. Infine le \acr{glibc} provvedono le funzioni non standard\footnote{anche
1471   queste funzioni sono originarie di Solaris.} \funcd{\_\_flbf} e
1472 \funcd{\_\_fbufsize} che permettono di leggere le proprietà di bufferizzazione
1473 di uno stream; i cui prototipi sono:
1474 \begin{functions}
1475   \headdecl{stdio\_ext.h} 
1476   
1477   \funcdecl{int \_\_flbf(FILE *stream)} Restituisce un valore diverso da zero
1478   se \param{stream} è in modalità \textit{line buffered}.
1479   
1480   \funcdecl{size\_t \_\_fbufsize(FILE *stream)} Restituisce le dimensioni del
1481   buffer di \param{stream}.
1482 \end{functions}
1483
1484 Come già accennato, indipendentemente dalla modalità di bufferizzazione
1485 scelta, si può forzare lo scarico dei dati sul file con la funzione
1486 \funcd{fflush}, il suo prototipo è:
1487 \begin{prototype}{stdio.h}{int fflush(FILE *stream)}
1488   
1489   Forza la scrittura di tutti i dati bufferizzati dello stream \param{stream}.
1490   
1491   \bodydesc{Restituisce zero in caso di successo, ed \val{EOF} in caso di
1492     errore, impostando \var{errno} a \errval{EBADF} se \param{stream} non è
1493     aperto o non è aperto in scrittura, o ad uno degli errori di
1494     \func{write}.}
1495 \end{prototype}
1496 \noindent anche di questa funzione esiste una analoga
1497 \func{fflush\_unlocked}\footnote{accessibile definendo \macro{\_BSD\_SOURCE} o
1498   \macro{\_SVID\_SOURCE} o \macro{\_GNU\_SOURCE}.} che non effettua il blocco
1499 dello stream.
1500
1501 Se \param{stream} è \val{NULL} lo scarico dei dati è forzato per tutti gli
1502 stream aperti. Esistono però circostanze, ad esempio quando si vuole essere
1503 sicuri che sia stato eseguito tutto l'output su terminale, in cui serve poter
1504 effettuare lo scarico dei dati solo per gli stream in modalità line buffered;
1505 per questo motivo le \acr{glibc} supportano una estensione di Solaris, la
1506 funzione \funcd{\_flushlbf}, il cui prototipo è:
1507 \begin{prototype}{stdio-ext.h}{void \_flushlbf(void)}
1508   Forza la scrittura di tutti i dati bufferizzati degli stream in modalità
1509   line buffered.
1510 \end{prototype}
1511
1512 Si ricordi comunque che lo scarico dei dati dai buffer effettuato da queste
1513 funzioni non comporta la scrittura di questi su disco; se si vuole che il
1514 kernel dia effettivamente avvio alle operazioni di scrittura su disco occorre
1515 usare \func{sync} o \func{fsync} (si veda~sez.~\ref{sec:file_sync}).
1516
1517 Infine esistono anche circostanze in cui si vuole scartare tutto l'output
1518 pendente; per questo si può usare \funcd{fpurge}, il cui prototipo è:
1519 \begin{prototype}{stdio.h}{int fpurge(FILE *stream)}
1520  
1521   Cancella i buffer di input e di output dello stream \param{stream}.
1522   
1523   \bodydesc{Restituisce zero in caso di successo, ed \val{EOF} in caso di
1524     errore.}
1525 \end{prototype}
1526
1527 La funzione scarta tutti i dati non ancora scritti (se il file è aperto in
1528 scrittura), e tutto l'input non ancora letto (se è aperto in lettura),
1529 compresi gli eventuali caratteri rimandati indietro con \func{ungetc}.
1530
1531
1532 \subsection{Gli stream e i thread}
1533 \label{sec:file_stream_thread}
1534
1535 Gli stream possono essere usati in applicazioni multi-thread allo stesso
1536 modo in cui sono usati nelle applicazioni normali, ma si deve essere
1537 consapevoli delle possibili complicazioni anche quando non si usano i
1538 thread, dato che l'implementazione delle librerie è influenzata
1539 pesantemente dalle richieste necessarie per garantirne l'uso con i thread.
1540
1541 Lo standard POSIX richiede che le operazioni sui file siano atomiche rispetto
1542 ai thread, per questo le operazioni sui buffer effettuate dalle funzioni di
1543 libreria durante la lettura e la scrittura di uno stream devono essere
1544 opportunamente protette (in quanto il sistema assicura l'atomicità solo per le
1545 system call). Questo viene fatto associando ad ogni stream un opportuno blocco
1546 che deve essere implicitamente acquisito prima dell'esecuzione di qualunque
1547 operazione.
1548
1549 Ci sono comunque situazioni in cui questo non basta, come quando un thread
1550 necessita di compiere più di una operazione sullo stream atomicamente, per
1551 questo motivo le librerie provvedono anche delle funzioni \funcd{flockfile},
1552 \funcd{ftrylockfile} e \funcd{funlockfile}, che permettono la gestione
1553 esplicita dei blocchi sugli stream; esse sono disponibili definendo
1554 \macro{\_POSIX\_THREAD\_SAFE\_FUNCTIONS} ed i loro prototipi sono:
1555 \begin{functions}
1556   \headdecl{stdio.h}
1557   
1558   \funcdecl{void flockfile(FILE *stream)} Esegue l'acquisizione del lock dello
1559   stream \param{stream}, bloccandosi se il lock non è disponibile.
1560   
1561   \funcdecl{int ftrylockfile(FILE *stream)} Tenta l'acquisizione del lock
1562   dello stream \param{stream}, senza bloccarsi se il lock non è disponibile.
1563   Ritorna zero in caso di acquisizione del lock, diverso da zero altrimenti.
1564   
1565   \funcdecl{void funlockfile(FILE *stream)} Rilascia il lock dello
1566   stream \param{stream}.
1567 \end{functions}
1568 \noindent con queste funzioni diventa possibile acquisire un blocco ed
1569 eseguire tutte le operazioni volute, per poi rilasciarlo. 
1570
1571 Ma, vista la complessità delle strutture di dati coinvolte, le operazioni di
1572 blocco non sono del tutto indolori, e quando il locking dello stream non è
1573 necessario (come in tutti i programmi che non usano i thread), tutta la
1574 procedura può comportare dei costi pesanti in termini di prestazioni. Per
1575 questo motivo abbiamo visto come alle usuali funzioni di I/O non formattato
1576 siano associate delle versioni \code{\_unlocked} (alcune previste dallo stesso
1577 standard POSIX, altre aggiunte come estensioni dalle \acr{glibc}) che possono
1578 essere usate quando il locking non serve\footnote{in certi casi dette funzioni
1579   possono essere usate, visto che sono molto più efficienti, anche in caso di
1580   necessità di locking, una volta che questo sia stato acquisito manualmente.}
1581 con prestazioni molto più elevate, dato che spesso queste versioni (come
1582 accade per \func{getc} e \func{putc}) sono realizzate come macro.
1583
1584 La sostituzione di tutte le funzioni di I/O con le relative versioni
1585 \code{\_unlocked} in un programma che non usa i thread è però un lavoro
1586 abbastanza noioso; per questo motivo le \acr{glibc} forniscono al
1587 programmatore pigro un'altra via\footnote{anche questa mutuata da estensioni
1588   introdotte in Solaris.} da poter utilizzare per disabilitare in blocco il
1589 locking degli stream: l'uso della funzione \funcd{\_\_fsetlocking}, il cui
1590 prototipo è:
1591 \begin{prototype}{stdio\_ext.h}{int \_\_fsetlocking (FILE *stream, int type)}
1592   Specifica o richiede a seconda del valore di \param{type} la modalità in cui
1593   le operazioni di I/O su \param{stream} vengono effettuate rispetto
1594   all'acquisizione implicita del blocco sullo stream.
1595
1596   \bodydesc{Restituisce lo stato di locking interno dello stream con uno dei
1597   valori \const{FSETLOCKING\_INTERNAL} o \const{FSETLOCKING\_BYCALLER}.}
1598 \end{prototype}
1599
1600 La funzione imposta o legge lo stato della modalità di operazione di uno stream
1601 nei confronti del locking a seconda del valore specificato con \param{type},
1602 che può essere uno dei seguenti:
1603 \begin{basedescript}{\desclabelwidth{4.0cm}}
1604 \item[\const{FSETLOCKING\_INTERNAL}] Lo stream userà da ora in poi il blocco
1605   implicito predefinito.
1606 \item[\const{FSETLOCKING\_BYCALLER}] Al ritorno della funzione sarà l'utente a
1607   dover gestire da solo il locking dello stream.
1608 \item[\const{FSETLOCKING\_QUERY}] Restituisce lo stato corrente della modalità
1609   di blocco dello stream.
1610 \end{basedescript}
1611
1612
1613 %%% Local Variables: 
1614 %%% mode: latex
1615 %%% TeX-master: "gapil"
1616 %%% End: 
1617
1618 % LocalWords:  stream cap system call kernel Ritchie glibc descriptor Stevens
1619 % LocalWords:  buf read write filesystem st blksize stat sez l'header stdio BSD
1620 % LocalWords:  nell'header stdin shell stdout stderr error freopen flush line
1621 % LocalWords:  unbuffered buffered newline fully SVr fopen fdopen POSIX const
1622 % LocalWords:  char path int fildes NULL errno malloc fcntl fclose fflush tab
1623 % LocalWords:  dup fifo socket append EXCL ccs STRING IRUSR IWUSR IRGRP IWGRP
1624 % LocalWords:  IROTH IWOTH umask fseek fsetpos rewind SEEK CUR EOF EBADF close
1625 % LocalWords:  sync fcloseall SOURCE void stdlib of feof ferror clearerr l'I ws
1626 % LocalWords:  unlocked fread fwrite size ptr nmemb nelem gcc padding point str
1627 % LocalWords:  lock thread fgetc getc getchar dell'overhead altresì unsigned ap
1628 % LocalWords:  getwc fgetwc getwchar wint wchar WEOF putc fputc putchar dell'I
1629 % LocalWords:  SVID getw putw parsing peeking ahead ungetc gets fgets string
1630 % LocalWords:  overflow Aleph stack fputs puts fgetws fputws getline ssize leak
1631 % LocalWords:  realloc value result argument memory getdelim delim printf short
1632 % LocalWords:  fprintf sprintf format snprintf variadic long double intmax list
1633 % LocalWords:  uintmax ptrdiff vprintf vfprintf vsprintf vsnprintf asprintf lex
1634 % LocalWords:  vasprintf strptr dprintf vdprintf print scanf fscanf sscanf flex
1635 % LocalWords:  vscanf vfscanf vsscanf bison parser yacc like off VMS whence pos
1636 % LocalWords:  lseek ftell fgetpos fpos fseeko ftello fileno Solaris freadable
1637 % LocalWords:  fwritable ext freading fwriting buffering setvbuf BUFSIZ setbuf
1638 % LocalWords:  IONBF IOLBF IOFBF setbuffer setlinebuf flbf fbufsize flushlbf
1639 % LocalWords:  fsync fpurge flockfile ftrylockfile funlockfile SAFE FUNCTIONS
1640 % LocalWords:  locking fsetlocking type BYCALLER QUERY