1 ------------------------------------------------------------------------------
3 -- GNAT RUN-TIME COMPONENTS --
5 -- S Y S T E M . F I L E _ I O --
11 -- Copyright (C) 1992-2001 Free Software Foundation, Inc. --
13 -- GNAT is free software; you can redistribute it and/or modify it under --
14 -- terms of the GNU General Public License as published by the Free Soft- --
15 -- ware Foundation; either version 2, or (at your option) any later ver- --
16 -- sion. GNAT is distributed in the hope that it will be useful, but WITH- --
17 -- OUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY --
18 -- or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License --
19 -- for more details. You should have received a copy of the GNU General --
20 -- Public License distributed with GNAT; see file COPYING. If not, write --
21 -- to the Free Software Foundation, 59 Temple Place - Suite 330, Boston, --
22 -- MA 02111-1307, USA. --
24 -- As a special exception, if other files instantiate generics from this --
25 -- unit, or you link this unit with other files to produce an executable, --
26 -- this unit does not by itself cause the resulting executable to be --
27 -- covered by the GNU General Public License. This exception does not --
28 -- however invalidate any other reasons why the executable file might be --
29 -- covered by the GNU Public License. --
31 -- GNAT was originally developed by the GNAT team at New York University. --
32 -- It is now maintained by Ada Core Technologies Inc (http://www.gnat.com). --
34 ------------------------------------------------------------------------------
36 with Ada
.Finalization
; use Ada
.Finalization
;
37 with Ada
.IO_Exceptions
; use Ada
.IO_Exceptions
;
38 with Interfaces
.C_Streams
; use Interfaces
.C_Streams
;
39 with System
.Soft_Links
;
40 with Unchecked_Deallocation
;
42 package body System
.File_IO
is
44 use System
.File_Control_Block
;
46 package SSL
renames System
.Soft_Links
;
48 ----------------------
49 -- Global Variables --
50 ----------------------
52 Open_Files
: AFCB_Ptr
;
53 -- This points to a list of AFCB's for all open files. This is a doubly
54 -- linked list, with the Prev pointer of the first entry, and the Next
55 -- pointer of the last entry containing null. Note that this global
56 -- variable must be properly protected to provide thread safety.
58 type Temp_File_Record
;
59 type Temp_File_Record_Ptr
is access all Temp_File_Record
;
61 type Temp_File_Record
is record
62 Name
: String (1 .. L_tmpnam
+ 1);
63 Next
: Temp_File_Record_Ptr
;
65 -- One of these is allocated for each temporary file created
67 Temp_Files
: Temp_File_Record_Ptr
;
68 -- Points to list of names of temporary files. Note that this global
69 -- variable must be properly protected to provide thread safety.
71 type File_IO_Clean_Up_Type
is new Controlled
with null record;
72 -- The closing of all open files and deletion of temporary files is an
73 -- action which takes place at the end of execution of the main program.
74 -- This action can be implemented using a library level object which
75 -- gets finalized at the end of the main program execution. The above is
76 -- a controlled type introduced for this purpose.
78 procedure Finalize
(V
: in out File_IO_Clean_Up_Type
);
79 -- This is the finalize operation that is used to do the cleanup.
81 File_IO_Clean_Up_Object
: File_IO_Clean_Up_Type
;
82 -- This is the single object of the type that triggers the finalization
83 -- call. Since it is at the library level, this happens just before the
84 -- environment task is finalized.
86 text_translation_required
: Boolean;
88 (C
, text_translation_required
, "__gnat_text_translation_required");
89 -- If true, add appropriate suffix to control string for Open.
91 -----------------------
92 -- Local Subprograms --
93 -----------------------
95 procedure Free_String
is new Unchecked_Deallocation
(String, Pstring
);
97 subtype Fopen_String
is String (1 .. 4);
98 -- Holds open string (longest is "w+b" & nul)
105 Fopstr
: out Fopen_String
);
106 -- Determines proper open mode for a file to be opened in the given
107 -- Ada mode. Text is true for a text file and false otherwise, and
108 -- Creat is true for a create call, and False for an open call. The
109 -- value stored in Fopstr is a nul-terminated string suitable for a
110 -- call to fopen or freopen. Amethod is the character designating
111 -- the access method from the Access_Method field of the FCB.
117 procedure Append_Set
(File
: AFCB_Ptr
) is
119 if File
.Mode
= Append_File
then
120 if fseek
(File
.Stream
, 0, SEEK_END
) /= 0 then
130 procedure Chain_File
(File
: AFCB_Ptr
) is
132 -- Take a task lock, to protect the global data value Open_Files
133 -- No exception handler needed, since we cannot get an exception.
136 File
.Next
:= Open_Files
;
140 if File
.Next
/= null then
141 File
.Next
.Prev
:= File
;
147 ---------------------
148 -- Check_File_Open --
149 ---------------------
151 procedure Check_File_Open
(File
: AFCB_Ptr
) is
158 -----------------------
159 -- Check_Read_Status --
160 -----------------------
162 procedure Check_Read_Status
(File
: AFCB_Ptr
) is
166 elsif File
.Mode
> Inout_File
then
169 end Check_Read_Status
;
171 ------------------------
172 -- Check_Write_Status --
173 ------------------------
175 procedure Check_Write_Status
(File
: AFCB_Ptr
) is
179 elsif File
.Mode
= In_File
then
182 end Check_Write_Status
;
188 procedure Close
(File
: in out AFCB_Ptr
) is
189 Close_Status
: int
:= 0;
190 Dup_Strm
: Boolean := False;
193 Check_File_Open
(File
);
196 -- Sever the association between the given file and its associated
197 -- external file. The given file is left closed. Do not perform system
198 -- closes on the standard input, output and error files and also do
199 -- not attempt to close a stream that does not exist (signalled by a
200 -- null stream value -- happens in some error situations).
202 if not File
.Is_System_File
203 and then File
.Stream
/= NULL_Stream
205 -- Do not do an fclose if this is a shared file and there is
206 -- at least one other instance of the stream that is open.
208 if File
.Shared_Status
= Yes
then
216 and then File
.Stream
= P
.Stream
227 -- Do the fclose unless this was a duplicate in the shared case
230 Close_Status
:= fclose
(File
.Stream
);
234 -- Dechain file from list of open files and then free the storage
235 -- Since this is a global data structure, we have to protect against
236 -- multiple tasks attempting to access this list.
238 -- Note that we do not use an exception handler to unlock here since
239 -- no exception can occur inside the lock/unlock pair.
244 if File
.Prev
= null then
245 Open_Files
:= File
.Next
;
247 File
.Prev
.Next
:= File
.Next
;
250 if File
.Next
/= null then
251 File
.Next
.Prev
:= File
.Prev
;
257 -- Deallocate some parts of the file structure that were kept in heap
258 -- storage with the exception of system files (standard input, output
259 -- and error) since they had some information allocated in the stack.
261 if not File
.Is_System_File
then
262 Free_String
(File
.Name
);
263 Free_String
(File
.Form
);
269 if Close_Status
/= 0 then
278 procedure Delete
(File
: in out AFCB_Ptr
) is
280 Check_File_Open
(File
);
282 if not File
.Is_Regular_File
then
287 Filename
: aliased constant String := File
.Name
.all;
292 -- Now unlink the external file. Note that we use the full name
293 -- in this unlink, because the working directory may have changed
294 -- since we did the open, and we want to unlink the right file!
296 if unlink
(Filename
'Address) = -1 then
306 function End_Of_File
(File
: AFCB_Ptr
) return Boolean is
308 Check_File_Open
(File
);
310 if feof
(File
.Stream
) /= 0 then
314 Check_Read_Status
(File
);
316 if ungetc
(fgetc
(File
.Stream
), File
.Stream
) = EOF
then
317 clearerr
(File
.Stream
);
329 -- Note: we do not need to worry about locking against multiple task
330 -- access in this routine, since it is called only from the environment
331 -- task just before terminating execution.
333 procedure Finalize
(V
: in out File_IO_Clean_Up_Type
) is
339 -- First close all open files (the slightly complex form of this loop
340 -- is required because Close as a side effect nulls out its argument)
343 while Fptr1
/= null loop
349 -- Now unlink all temporary files. We do not bother to free the
350 -- blocks because we are just about to terminate the program. We
351 -- also ignore any errors while attempting these unlink operations.
353 while Temp_Files
/= null loop
354 Discard
:= unlink
(Temp_Files
.Name
'Address);
355 Temp_Files
:= Temp_Files
.Next
;
364 procedure Flush
(File
: AFCB_Ptr
) is
366 Check_Write_Status
(File
);
368 if fflush
(File
.Stream
) = 0 then
379 -- The fopen mode to be used is shown by the following table:
382 -- Append_File "r+" "w+"
384 -- Out_File (Direct_IO) "r+" "w"
385 -- Out_File (all others) "w" "w"
386 -- Inout_File "r+" "w+"
388 -- Note: we do not use "a" or "a+" for Append_File, since this would not
389 -- work in the case of stream files, where even if in append file mode,
390 -- you can reset to earlier points in the file. The caller must use the
391 -- Append_Set routine to deal with the necessary positioning.
393 -- Note: in several cases, the fopen mode used allows reading and
394 -- writing, but the setting of the Ada mode is more restrictive. For
395 -- instance, Create in In_File mode uses "w+" which allows writing,
396 -- but the Ada mode In_File will cause any write operations to be
397 -- rejected with Mode_Error in any case.
399 -- Note: for the Out_File/Open cases for other than the Direct_IO case,
400 -- an initial call will be made by the caller to first open the file in
401 -- "r" mode to be sure that it exists. The real open, in "w" mode, will
402 -- then destroy this file. This is peculiar, but that's what Ada semantics
403 -- require and the ACVT tests insist on!
405 -- If text file translation is required, then either b or t is
406 -- added to the mode, depending on the setting of Text.
413 Fopstr
: out Fopen_String
)
430 if Amethod
= 'D' and not Creat
then
439 when Inout_File | Append_File
=>
451 -- If text_translation_required is true then we need to append
452 -- either a t or b to the string to get the right mode
454 if text_translation_required
then
456 Fopstr
(Fptr
) := 't';
458 Fopstr
(Fptr
) := 'b';
464 Fopstr
(Fptr
) := ASCII
.NUL
;
471 function Form
(File
: in AFCB_Ptr
) return String is
476 return File
.Form
.all (1 .. File
.Form
'Length - 1);
484 function Form_Boolean
493 Form_Parameter
(Form
, Keyword
, V1
, V2
);
498 elsif Form
(V1
) = 'y' then
501 elsif Form
(V1
) = 'n' then
513 function Form_Integer
523 Form_Parameter
(Form
, Keyword
, V1
, V2
);
531 for J
in V1
.. V2
loop
532 if Form
(J
) not in '0' .. '9' then
535 V
:= V
* 10 + Character'Pos (Form
(J
)) - Character'Pos ('0');
551 procedure Form_Parameter
557 Klen
: constant Integer := Keyword
'Length;
559 -- Start of processing for Form_Parameter
562 for J
in Form
'First + Klen
.. Form
'Last - 1 loop
564 and then Form
(J
- Klen
.. J
- 1) = Keyword
569 while Form
(Stop
+ 1) /= ASCII
.NUL
570 and then Form
(Stop
+ 1) /= ','
587 function Is_Open
(File
: in AFCB_Ptr
) return Boolean is
589 return (File
/= null);
596 procedure Make_Buffered
598 Buf_Siz
: Interfaces
.C_Streams
.size_t
) is
602 status
:= setvbuf
(File
.Stream
, Null_Address
, IOFBF
, Buf_Siz
);
605 ------------------------
606 -- Make_Line_Buffered --
607 ------------------------
609 procedure Make_Line_Buffered
611 Line_Siz
: Interfaces
.C_Streams
.size_t
) is
615 status
:= setvbuf
(File
.Stream
, Null_Address
, IOLBF
, Line_Siz
);
616 end Make_Line_Buffered
;
618 ---------------------
619 -- Make_Unbuffered --
620 ---------------------
622 procedure Make_Unbuffered
(File
: AFCB_Ptr
) is
626 status
:= setvbuf
(File
.Stream
, Null_Address
, IONBF
, 0);
633 function Mode
(File
: in AFCB_Ptr
) return File_Mode
is
646 function Name
(File
: in AFCB_Ptr
) return String is
651 return File
.Name
.all (1 .. File
.Name
'Length - 1);
660 (File_Ptr
: in out AFCB_Ptr
;
661 Dummy_FCB
: in out AFCB
'Class;
668 C_Stream
: FILEs
:= NULL_Stream
)
670 procedure Tmp_Name
(Buffer
: Address
);
671 pragma Import
(C
, Tmp_Name
, "__gnat_tmp_name");
672 -- set buffer (a String address) with a temporary filename.
674 Stream
: FILEs
:= C_Stream
;
675 -- Stream which we open in response to this request
677 Shared
: Shared_Status_Type
;
678 -- Setting of Shared_Status field for file
680 Fopstr
: aliased Fopen_String
;
681 -- Mode string used in fopen call
683 Formstr
: aliased String (1 .. Form
'Length + 1);
684 -- Form string with ASCII.NUL appended, folded to lower case
686 Tempfile
: constant Boolean := (Name
'Length = 0);
687 -- Indicates temporary file case
689 Namelen
: constant Integer := max_path_len
;
690 -- Length required for file name, not including final ASCII.NUL
691 -- Note that we used to reference L_tmpnam here, which is not
692 -- reliable since __gnat_tmp_name does not always use tmpnam.
694 Namestr
: aliased String (1 .. Namelen
+ 1);
695 -- Name as given or temporary file name with ASCII.NUL appended
697 Fullname
: aliased String (1 .. max_path_len
+ 1);
698 -- Full name (as required for Name function, and as stored in the
699 -- control block in the Name field) with ASCII.NUL appended.
701 Full_Name_Len
: Integer;
702 -- Length of name actually stored in Fullname
705 if File_Ptr
/= null then
709 -- Acquire form string, setting required NUL terminator
711 Formstr
(1 .. Form
'Length) := Form
;
712 Formstr
(Formstr
'Last) := ASCII
.NUL
;
714 -- Convert form string to lower case
716 for J
in Formstr
'Range loop
717 if Formstr
(J
) in 'A' .. 'Z' then
718 Formstr
(J
) := Character'Val (Character'Pos (Formstr
(J
)) + 32);
722 -- Acquire setting of shared parameter
728 Form_Parameter
(Formstr
, "shared", V1
, V2
);
733 elsif Formstr
(V1
.. V2
) = "yes" then
736 elsif Formstr
(V1
.. V2
) = "no" then
744 -- If we were given a stream (call from xxx.C_Streams.Open), then set
745 -- full name to null and that is all we have to do in this case so
746 -- skip to end of processing.
748 if Stream
/= NULL_Stream
then
749 Fullname
(1) := ASCII
.Nul
;
752 -- Normal case of Open or Create
755 -- If temporary file case, get temporary file name and add
756 -- to the list of temporary files to be deleted on exit.
763 Tmp_Name
(Namestr
'Address);
765 if Namestr
(1) = ASCII
.NUL
then
769 -- Chain to temp file list, ensuring thread safety with a lock
774 new Temp_File_Record
'(Name => Namestr, Next => Temp_Files);
783 -- Normal case of non-null name given
786 Namestr (1 .. Name'Length) := Name;
787 Namestr (Name'Length + 1) := ASCII.NUL;
790 -- Get full name in accordance with the advice of RM A.8.2(22).
792 full_name (Namestr'Address, Fullname'Address);
794 if Fullname (1) = ASCII.NUL then
798 for J in Fullname'Range loop
799 if Fullname (J) = ASCII.NUL then
805 -- If Shared=None or Shared=Yes, then check for the existence
806 -- of another file with exactly the same full name.
815 if Fullname (1 .. Full_Name_Len) = P.Name.all then
817 -- If we get a match, and either file has Shared=None,
818 -- then raise Use_Error, since we don't allow two
819 -- files of the same name to be opened unless they
820 -- specify the required sharing mode.
823 or else P.Shared_Status = None
827 -- If both files have Shared=Yes, then we acquire the
828 -- stream from the located file to use as our stream.
831 and then P.Shared_Status = Yes
836 -- Otherwise one of the files has Shared=Yes and one
837 -- has Shared=No. If the current file has Shared=No
838 -- then all is well but we don't want to share any
839 -- other file's stream. If the current file has
840 -- Shared=Yes, we would like to share a stream, but
841 -- not from a file that has Shared=No, so in either
842 -- case we just keep going on the search.
854 -- Open specified file if we did not find an existing stream
856 if Stream = NULL_Stream then
857 Fopen_Mode (Mode, Text, Creat, Amethod, Fopstr);
859 -- A special case, if we are opening (OPEN case) a file and
860 -- the mode returned by Fopen_Mode is not "r" or "r+", then
861 -- we first make sure that the file exists as required by
864 if Creat = False and then Fopstr (1) /= 'r
' then
865 if file_exists (Namestr'Address) = 0 then
870 -- Now open the file. Note that we use the name as given
871 -- in the original Open call for this purpose, since that
872 -- seems the clearest implementation of the intent. It
873 -- would presumably work to use the full name here, but
874 -- if there is any difference, then we should use the
875 -- name used in the call.
877 -- Note: for a corresponding delete, we will use the
878 -- full name, since by the time of the delete, the
879 -- current working directory may have changed and
880 -- we do not want to delete a different file!
882 Stream := fopen (Namestr'Address, Fopstr'Address);
884 if Stream = NULL_Stream then
885 if file_exists (Namestr'Address) = 0 then
894 -- Stream has been successfully located or opened, so now we are
895 -- committed to completing the opening of the file. Allocate block
896 -- on heap and fill in its fields.
898 File_Ptr := AFCB_Allocate (Dummy_FCB);
900 File_Ptr.Is_Regular_File := (is_regular_file
901 (fileno (Stream)) /= 0);
902 File_Ptr.Is_System_File := False;
903 File_Ptr.Is_Text_File := Text;
904 File_Ptr.Shared_Status := Shared;
905 File_Ptr.Access_Method := Amethod;
906 File_Ptr.Stream := Stream;
907 File_Ptr.Form := new String'(Formstr
);
908 File_Ptr
.Name
:= new String'(Fullname
909 (1 .. Full_Name_Len));
910 File_Ptr.Mode := Mode;
911 File_Ptr.Is_Temporary_File := Tempfile;
913 Chain_File (File_Ptr);
914 Append_Set (File_Ptr);
921 procedure Read_Buf (File : AFCB_Ptr; Buf : Address; Siz : size_t) is
925 Nread := fread (Buf, 1, Siz, File.Stream);
930 elsif ferror (File.Stream) /= 0 then
936 else -- 0 < Nread < Siz
945 Siz : in Interfaces.C_Streams.size_t;
946 Count : out Interfaces.C_Streams.size_t)
949 Count := fread (Buf, 1, Siz, File.Stream);
951 if Count = 0 and then ferror (File.Stream) /= 0 then
960 -- The reset which does not change the mode simply does a rewind.
962 procedure Reset (File : in out AFCB_Ptr) is
964 Check_File_Open (File);
965 Reset (File, File.Mode);
968 -- The reset with a change in mode is done using freopen, and is
969 -- not permitted except for regular files (since otherwise there
970 -- is no name for the freopen, and in any case it seems meaningless)
972 procedure Reset (File : in out AFCB_Ptr; Mode : in File_Mode) is
973 Fopstr : aliased Fopen_String;
976 Check_File_Open (File);
978 -- Change of mode not allowed for shared file or file with no name
979 -- or file that is not a regular file, or for a system file.
981 if File.Shared_Status = Yes
982 or else File.Name'Length <= 1
983 or else File.Is_System_File
984 or else (not File.Is_Regular_File)
988 -- For In_File or Inout_File for a regular file, we can just do a
989 -- rewind if the mode is unchanged, which is more efficient than
990 -- doing a full reopen.
992 elsif Mode = File.Mode
993 and then Mode <= Inout_File
995 rewind (File.Stream);
997 -- Here the change of mode is permitted, we do it by reopening the
998 -- file in the new mode and replacing the stream with a new stream.
1002 (Mode, File.Is_Text_File, False, File.Access_Method, Fopstr);
1005 freopen (File.Name.all'Address, Fopstr'Address, File.Stream);
1007 if File.Stream = NULL_Stream then
1022 procedure Write_Buf (File : AFCB_Ptr; Buf : Address; Siz : size_t) is
1024 -- Note: for most purposes, the Siz and 1 parameters in the fwrite
1025 -- call could be reversed, but on VMS, this is a better choice, since
1026 -- for some file formats, reversing the parameters results in records
1027 -- of one byte each.
1029 SSL.Abort_Defer.all;
1031 if fwrite (Buf, Siz, 1, File.Stream) /= 1 then
1033 SSL.Abort_Undefer.all;
1038 SSL.Abort_Undefer.all;