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