1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
9 -- Copyright (C) 2003-2004 Free Software Foundation, Inc. --
11 -- GNAT is free software; you can redistribute it and/or modify it under --
12 -- terms of the GNU General Public License as published by the Free Soft- --
13 -- ware Foundation; either version 2, or (at your option) any later ver- --
14 -- sion. GNAT is distributed in the hope that it will be useful, but WITH- --
15 -- OUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY --
16 -- or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License --
17 -- for more details. You should have received a copy of the GNU General --
18 -- Public License distributed with GNAT; see file COPYING. If not, write --
19 -- to the Free Software Foundation, 59 Temple Place - Suite 330, Boston, --
20 -- MA 02111-1307, USA. --
22 -- GNAT was originally developed by the GNAT team at New York University. --
23 -- Extensive contributions were provided by Ada Core Technologies Inc. --
25 ------------------------------------------------------------------------------
27 -- This is the VMS version of this package
29 with Ada
.Exceptions
; use Ada
.Exceptions
;
30 with Ada
.Sequential_IO
;
31 with Ada
.Text_IO
; use Ada
.Text_IO
;
33 package body Symbols
is
35 Case_Sensitive
: constant String := "case_sensitive=";
36 Symbol_Vector
: constant String := "SYMBOL_VECTOR=(";
37 Equal_Data
: constant String := "=DATA)";
38 Equal_Procedure
: constant String := "=PROCEDURE)";
39 Gsmatch
: constant String := "gsmatch=equal,";
41 Symbol_File_Name
: String_Access
:= null;
42 -- Name of the symbol file
44 Sym_Policy
: Policy
:= Autonomous
;
45 -- The symbol policy. Set by Initialize
47 Major_ID
: Integer := 1;
48 -- The Major ID. May be modified by Initialize if Library_Version is
49 -- specified or if it is read from the reference symbol file.
51 Soft_Major_ID
: Boolean := True;
52 -- False if library version is specified in procedure Initialize.
53 -- When True, Major_ID may be modified if found in the reference symbol
56 Minor_ID
: Natural := 0;
57 -- The Minor ID. May be modified if read from the reference symbol file
59 Soft_Minor_ID
: Boolean := True;
60 -- False if symbol policy is Autonomous, if library version is specified
61 -- in procedure Initialize and is not the same as the major ID read from
62 -- the reference symbol file. When True, Minor_ID may be increased in
63 -- Compliant symbol policy.
65 subtype Byte
is Character;
66 -- Object files are stream of bytes, but some of these bytes, those for
67 -- the names of the symbols, are ASCII characters.
69 package Byte_IO
is new Ada
.Sequential_IO
(Byte
);
72 type Number
is mod 2**16;
73 -- 16 bits unsigned number for number of characters
75 GSD
: constant Number
:= 10;
76 -- Code for the Global Symbol Definition section
78 C_SYM
: constant Number
:= 1;
79 -- Code for a Symbol subsection
81 V_DEF_Mask
: constant Number
:= 2**1;
82 V_NORM_Mask
: constant Number
:= 2**6;
84 File
: Byte_IO
.File_Type
;
85 -- Each object file is read as a stream of bytes (characters)
89 Number_Of_Characters
: Natural := 0;
90 -- The number of characters of each section
92 -- The following variables are used by procedure Process when reading an
96 Length
: Natural := 0;
100 Nchars
: Natural := 0;
103 Symbol
: String (1 .. 255);
106 function Equal
(Left
, Right
: Symbol_Data
) return Boolean;
107 -- Test for equality of symbols
109 procedure Get
(N
: out Number
);
110 -- Read two bytes from the object file LSB first as unsigned 16 bit number
112 procedure Get
(N
: out Natural);
113 -- Read two bytes from the object file, LSByte first, as a Natural
116 function Image
(N
: Integer) return String;
117 -- Returns the image of N, without the initial space
123 function Equal
(Left
, Right
: Symbol_Data
) return Boolean is
125 return Left
.Name
/= null and then
126 Right
.Name
/= null and then
127 Left
.Name
.all = Right
.Name
.all and then
128 Left
.Kind
= Right
.Kind
and then
129 Left
.Present
= Right
.Present
;
136 procedure Get
(N
: out Number
) is
141 LSByte
:= Byte
'Pos (C
);
143 N
:= LSByte
+ (256 * Byte
'Pos (C
));
146 procedure Get
(N
: out Natural) is
150 N
:= Natural (Result
);
157 function Image
(N
: Integer) return String is
158 Result
: constant String := N
'Img;
160 if Result
(Result
'First) = ' ' then
161 return Result
(Result
'First + 1 .. Result
'Last);
173 (Symbol_File
: String;
175 Symbol_Policy
: Policy
;
178 Success
: out Boolean)
180 File
: Ada
.Text_IO
.File_Type
;
181 Line
: String (1 .. 1_000
);
185 -- Record the symbol file name
187 Symbol_File_Name
:= new String'(Symbol_File);
191 Sym_Policy := Symbol_Policy;
193 -- Record the version (Major ID)
197 Soft_Major_ID := True;
201 Major_ID := Integer'Value (Version);
202 Soft_Major_ID := False;
204 if Major_ID <= 0 then
205 raise Constraint_Error;
209 when Constraint_Error =>
211 Put_Line ("Version """ & Version & """ is illegal.");
212 Put_Line ("On VMS, version must be a positive number");
221 Soft_Minor_ID := Sym_Policy /= Autonomous;
223 -- Empty the symbol tables
225 Symbol_Table.Set_Last (Original_Symbols, 0);
226 Symbol_Table.Set_Last (Complete_Symbols, 0);
228 -- Assume that everything will be fine
232 -- If policy is Compliant or Controlled, attempt to read the reference
233 -- file. If policy is Restricted, attempt to read the symbol file.
235 if Sym_Policy /= Autonomous then
240 when Compliant | Controlled =>
242 Open (File, In_File, Reference);
245 when Ada.Text_IO.Name_Error =>
251 Put_Line ("could not open """ & Reference & """");
252 Put_Line (Exception_Message (X));
261 Open (File, In_File, Symbol_File);
264 when Ada.Text_IO.Name_Error =>
270 Put_Line ("could not open """ & Symbol_File & """");
271 Put_Line (Exception_Message (X));
281 while not End_Of_File (File) loop
282 Get_Line (File, Line, Last);
284 -- Ignore empty lines
289 -- Ignore lines starting with "case_sensitive="
291 elsif Last > Case_Sensitive'Length
292 and then Line (1 .. Case_Sensitive'Length) = Case_Sensitive
296 -- Line starting with "SYMBOL_VECTOR=("
298 elsif Last > Symbol_Vector'Length
299 and then Line (1 .. Symbol_Vector'Length) = Symbol_Vector
302 -- SYMBOL_VECTOR=(<symbol>=DATA)
304 if Last > Symbol_Vector'Length + Equal_Data'Length and then
305 Line (Last - Equal_Data'Length + 1 .. Last) = Equal_Data
307 Symbol_Table.Increment_Last (Original_Symbols);
308 Original_Symbols.Table
309 (Symbol_Table.Last (Original_Symbols)) :=
311 new String'(Line
(Symbol_Vector
'Length + 1 ..
312 Last
- Equal_Data
'Length)),
316 -- SYMBOL_VECTOR=(<symbol>=PROCEDURE)
318 elsif Last
> Symbol_Vector
'Length + Equal_Procedure
'Length
320 Line
(Last
- Equal_Procedure
'Length + 1 .. Last
) =
323 Symbol_Table
.Increment_Last
(Original_Symbols
);
324 Original_Symbols
.Table
325 (Symbol_Table
.Last
(Original_Symbols
)) :=
327 new String'(Line (Symbol_Vector'Length + 1 ..
328 Last - Equal_Procedure'Length)),
332 -- Anything else is incorrectly formatted
336 Put_Line ("symbol file """ & Reference &
337 """ is incorrectly formatted:");
338 Put_Line ("""" & Line (1 .. Last) & """");
346 -- Lines with "gsmatch=equal,<Major_ID>,<Minor_Id>
348 elsif Last > Gsmatch'Length
349 and then Line (1 .. Gsmatch'Length) = Gsmatch
352 Start : Positive := Gsmatch'Length + 1;
353 Finish : Positive := Start;
354 OK : Boolean := True;
359 if Line (Finish) not in '0' .. '9'
360 or else Finish >= Last - 1
366 exit when Line (Finish + 1) = ',';
368 Finish := Finish + 1;
372 ID := Integer'Value (Line (Start .. Finish));
375 -- If Soft_Major_ID is True, it means that
376 -- Library_Version was not specified.
378 if Soft_Major_ID then
381 -- If the Major ID in the reference file is different
382 -- from the Library_Version, then the Minor ID will be 0
383 -- because there is no point in taking the Minor ID in
384 -- the reference file, or incrementing it. So, we set
385 -- Soft_Minor_ID to False, so that we don't modify
386 -- the Minor_ID later.
388 elsif Major_ID /= ID then
389 Soft_Minor_ID := False;
396 if Line (Finish) not in '0' .. '9' then
401 exit when Finish = Last;
403 Finish := Finish + 1;
406 -- Only set Minor_ID if Soft_Minor_ID is True (see above)
408 if OK and then Soft_Minor_ID then
409 Minor_ID := Integer'Value (Line (Start .. Finish));
413 -- If OK is not True, that means the line is not correctly
418 Put_Line ("symbol file """ & Reference &
419 """ is incorrectly formatted");
420 Put_Line ("""" & Line (1 .. Last) & """");
429 -- Anything else is incorrectly formatted
433 Put_Line ("unexpected line in symbol file """ &
435 Put_Line ("""" & Line (1 .. Last) & """");
453 (Object_File : String;
454 Success : out Boolean)
457 -- Open the object file with Byte_IO. Return with Success = False if
461 Open (File, In_File, Object_File);
465 ("*** Unable to open object file """ & Object_File & """");
470 -- Assume that the object file has a correct format
474 -- Get the different sections one by one from the object file
476 while not End_Of_File (File) loop
479 Get (Number_Of_Characters);
480 Number_Of_Characters := Number_Of_Characters - 4;
482 -- If this is not a Global Symbol Definition section, skip to the
487 for J in 1 .. Number_Of_Characters loop
493 -- Skip over the next 4 bytes
497 Number_Of_Characters := Number_Of_Characters - 4;
499 -- Get each subsection in turn
506 Number_Of_Characters := Number_Of_Characters - 8;
507 Nchars := Nchars - 8;
509 -- If this is a symbol and the V_DEF flag is set, get the
512 if Code = C_SYM and then ((Flags and V_DEF_Mask) /= 0) then
513 -- First, reach the symbol length
515 for J in 1 .. 25 loop
517 Nchars := Nchars - 1;
518 Number_Of_Characters := Number_Of_Characters - 1;
521 Length := Byte'Pos (B);
524 -- Get the symbol characters
526 for J in 1 .. Nchars loop
528 Number_Of_Characters := Number_Of_Characters - 1;
532 Length := Length - 1;
536 -- Create the new Symbol
539 S_Data : Symbol_Data;
541 S_Data.Name := new String'(Symbol
(1 .. LSymb
));
543 -- The symbol kind (Data or Procedure) depends on the
546 if (Flags
and V_NORM_Mask
) = 0 then
553 -- Put the new symbol in the table
555 Symbol_Table
.Increment_Last
(Complete_Symbols
);
556 Complete_Symbols
.Table
557 (Symbol_Table
.Last
(Complete_Symbols
)) := S_Data
;
561 -- As it is not a symbol subsection, skip to the next
564 for J
in 1 .. Nchars
loop
566 Number_Of_Characters
:= Number_Of_Characters
- 1;
570 -- Exit the GSD section when number of characters reaches 0
572 exit when Number_Of_Characters
= 0;
577 -- The object file has been processed, close it
582 -- For any exception, output an error message, close the object file
583 -- and return with Success = False.
586 Put_Line
("unexpected exception raised while processing """
587 & Object_File
& """");
588 Put_Line
(Exception_Information
(X
));
599 Success
: out Boolean)
601 File
: Ada
.Text_IO
.File_Type
;
604 S_Data
: Symbol_Data
;
608 -- Most probable index in the Complete_Symbols of the current symbol
609 -- in Original_Symbol.
614 -- Nothing to be done if Initialize has never been called
616 if Symbol_File_Name
= null then
621 -- First find if the symbols in the reference symbol file are also
622 -- in the object files. Note that this is not done if the policy is
623 -- Autonomous, because no reference symbol file has been read.
625 -- Expect the first symbol in the symbol file to also be the first
626 -- in Complete_Symbols.
630 for Index_1
in 1 .. Symbol_Table
.Last
(Original_Symbols
) loop
631 S_Data
:= Original_Symbols
.Table
(Index_1
);
635 for Index_2
in Cur
.. Symbol_Table
.Last
(Complete_Symbols
) loop
636 if Equal
(S_Data
, Complete_Symbols
.Table
(Index_2
)) then
638 Complete_Symbols
.Table
(Index_2
).Present
:= False;
640 exit First_Object_Loop
;
642 end loop First_Object_Loop
;
644 -- If the symbol could not be found between Cur and Last, try
649 for Index_2
in 1 .. Cur
- 1 loop
650 if Equal
(S_Data
, Complete_Symbols
.Table
(Index_2
)) then
652 Complete_Symbols
.Table
(Index_2
).Present
:= False;
654 exit Second_Object_Loop
;
656 end loop Second_Object_Loop
;
659 -- If the symbol is not found, mark it as such in the table
662 if (not Quiet
) or else Sym_Policy
= Controlled
then
663 Put_Line
("symbol """ & S_Data
.Name
.all &
664 """ is no longer present in the object files");
667 if Sym_Policy
= Controlled
or else Sym_Policy
= Restricted
then
671 elsif Soft_Minor_ID
then
672 Minor_ID
:= Minor_ID
+ 1;
673 Soft_Minor_ID
:= False;
676 Original_Symbols
.Table
(Index_1
).Present
:= False;
677 Free
(Original_Symbols
.Table
(Index_1
).Name
);
679 if Soft_Minor_ID
then
680 Minor_ID
:= Minor_ID
+ 1;
681 Soft_Minor_ID
:= False;
686 if Sym_Policy
/= Restricted
then
688 -- Append additional symbols, if any, to the Original_Symbols
691 for Index
in 1 .. Symbol_Table
.Last
(Complete_Symbols
) loop
692 S_Data
:= Complete_Symbols
.Table
(Index
);
694 if S_Data
.Present
then
696 if Sym_Policy
= Controlled
then
697 Put_Line
("symbol """ & S_Data
.Name
.all &
698 """ is not in the reference symbol file");
702 elsif Soft_Minor_ID
then
703 Minor_ID
:= Minor_ID
+ 1;
704 Soft_Minor_ID
:= False;
707 Symbol_Table
.Increment_Last
(Original_Symbols
);
708 Original_Symbols
.Table
709 (Symbol_Table
.Last
(Original_Symbols
)) := S_Data
;
710 Complete_Symbols
.Table
(Index
).Present
:= False;
714 -- Create the symbol file
716 Create
(File
, Ada
.Text_IO
.Out_File
, Symbol_File_Name
.all);
718 Put
(File
, Case_Sensitive
);
719 Put_Line
(File
, "yes");
721 -- Put a line in the symbol file for each symbol in symbol table
723 for Index
in 1 .. Symbol_Table
.Last
(Original_Symbols
) loop
724 if Original_Symbols
.Table
(Index
).Present
then
725 Put
(File
, Symbol_Vector
);
726 Put
(File
, Original_Symbols
.Table
(Index
).Name
.all);
728 if Original_Symbols
.Table
(Index
).Kind
= Data
then
729 Put_Line
(File
, Equal_Data
);
732 Put_Line
(File
, Equal_Procedure
);
735 Free
(Original_Symbols
.Table
(Index
).Name
);
739 Put
(File
, Case_Sensitive
);
740 Put_Line
(File
, "NO");
742 -- Put the version IDs
745 Put
(File
, Image
(Major_ID
));
747 Put_Line
(File
, Image
(Minor_ID
));
755 Symbol_Table
.Set_Last
(Original_Symbols
, 0);
756 Symbol_Table
.Set_Last
(Complete_Symbols
, 0);
758 -- Clear the symbol file name
760 Free
(Symbol_File_Name
);
768 Put_Line
("unexpected exception raised while finalizing """
769 & Symbol_File_Name
.all & """");
770 Put_Line
(Exception_Information
(X
));