1 ------------------------------------------------------------------------------
3 -- GNAT LIBRARY COMPONENTS --
5 -- ADA.CONTAINERS.HASH_TABLES.GENERIC_OPERATIONS --
9 -- Copyright (C) 2004-2017, 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 3, 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. --
18 -- As a special exception under Section 7 of GPL version 3, you are granted --
19 -- additional permissions described in the GCC Runtime Library Exception, --
20 -- version 3.1, as published by the Free Software Foundation. --
22 -- You should have received a copy of the GNU General Public License and --
23 -- a copy of the GCC Runtime Library Exception along with this program; --
24 -- see the files COPYING3 and COPYING.RUNTIME respectively. If not, see --
25 -- <http://www.gnu.org/licenses/>. --
27 -- This unit was originally developed by Matthew J Heaney. --
28 ------------------------------------------------------------------------------
30 with Ada
.Containers
.Prime_Numbers
;
31 with Ada
.Unchecked_Deallocation
;
33 with System
; use type System
.Address
;
35 package body Ada
.Containers
.Hash_Tables
.Generic_Operations
is
37 pragma Warnings
(Off
, "variable ""Busy*"" is not referenced");
38 pragma Warnings
(Off
, "variable ""Lock*"" is not referenced");
39 -- See comment in Ada.Containers.Helpers
41 type Buckets_Allocation
is access all Buckets_Type
;
42 -- Used for allocation and deallocation (see New_Buckets and Free_Buckets).
43 -- This is necessary because Buckets_Access has an empty storage pool.
49 procedure Adjust
(HT
: in out Hash_Table_Type
) is
50 Src_Buckets
: constant Buckets_Access
:= HT
.Buckets
;
51 N
: constant Count_Type
:= HT
.Length
;
52 Src_Node
: Node_Access
;
53 Dst_Prev
: Node_Access
;
56 -- If the counts are nonzero, execution is technically erroneous, but
57 -- it seems friendly to allow things like concurrent "=" on shared
69 -- Technically it isn't necessary to allocate the exact same length
70 -- buckets array, because our only requirement is that following
71 -- assignment the source and target containers compare equal (that is,
72 -- operator "=" returns True). We can satisfy this requirement with any
73 -- hash table length, but we decide here to match the length of the
74 -- source table. This has the benefit that when iterating, elements of
75 -- the target are delivered in the exact same order as for the source.
77 HT
.Buckets
:= New_Buckets
(Length
=> Src_Buckets
'Length);
79 for Src_Index
in Src_Buckets
'Range loop
80 Src_Node
:= Src_Buckets
(Src_Index
);
82 if Src_Node
/= null then
84 Dst_Node
: constant Node_Access
:= Copy_Node
(Src_Node
);
88 pragma Assert
(Checked_Index
(HT
, Dst_Node
) = Src_Index
);
91 HT
.Buckets
(Src_Index
) := Dst_Node
;
92 HT
.Length
:= HT
.Length
+ 1;
97 Src_Node
:= Next
(Src_Node
);
98 while Src_Node
/= null loop
100 Dst_Node
: constant Node_Access
:= Copy_Node
(Src_Node
);
104 pragma Assert
(Checked_Index
(HT
, Dst_Node
) = Src_Index
);
107 Set_Next
(Node
=> Dst_Prev
, Next
=> Dst_Node
);
108 HT
.Length
:= HT
.Length
+ 1;
110 Dst_Prev
:= Dst_Node
;
113 Src_Node
:= Next
(Src_Node
);
118 pragma Assert
(HT
.Length
= N
);
125 function Capacity
(HT
: Hash_Table_Type
) return Count_Type
is
127 if HT
.Buckets
= null then
131 return HT
.Buckets
'Length;
138 function Checked_Index
139 (Hash_Table
: aliased in out Hash_Table_Type
;
140 Buckets
: Buckets_Type
;
141 Node
: Node_Access
) return Hash_Type
143 Lock
: With_Lock
(Hash_Table
.TC
'Unrestricted_Access);
145 return Index
(Buckets
, Node
);
148 function Checked_Index
149 (Hash_Table
: aliased in out Hash_Table_Type
;
150 Node
: Node_Access
) return Hash_Type
153 return Checked_Index
(Hash_Table
, Hash_Table
.Buckets
.all, Node
);
160 procedure Clear
(HT
: in out Hash_Table_Type
) is
161 Index
: Hash_Type
:= 0;
167 while HT
.Length
> 0 loop
168 while HT
.Buckets
(Index
) = null loop
173 Bucket
: Node_Access
renames HT
.Buckets
(Index
);
177 Bucket
:= Next
(Bucket
);
178 HT
.Length
:= HT
.Length
- 1;
180 exit when Bucket
= null;
186 --------------------------
187 -- Delete_Node_At_Index --
188 --------------------------
190 procedure Delete_Node_At_Index
191 (HT
: in out Hash_Table_Type
;
193 X
: in out Node_Access
)
199 Prev
:= HT
.Buckets
(Indx
);
202 HT
.Buckets
(Indx
) := Next
(Prev
);
203 HT
.Length
:= HT
.Length
- 1;
208 if Checks
and then HT
.Length
= 1 then
209 raise Program_Error
with
210 "attempt to delete node not in its proper hash bucket";
216 if Checks
and then Curr
= null then
217 raise Program_Error
with
218 "attempt to delete node not in its proper hash bucket";
222 Set_Next
(Node
=> Prev
, Next
=> Next
(Curr
));
223 HT
.Length
:= HT
.Length
- 1;
230 end Delete_Node_At_Index
;
232 ---------------------------
233 -- Delete_Node_Sans_Free --
234 ---------------------------
236 procedure Delete_Node_Sans_Free
237 (HT
: in out Hash_Table_Type
;
240 pragma Assert
(X
/= null);
247 if Checks
and then HT
.Length
= 0 then
248 raise Program_Error
with
249 "attempt to delete node from empty hashed container";
252 Indx
:= Checked_Index
(HT
, X
);
253 Prev
:= HT
.Buckets
(Indx
);
255 if Checks
and then Prev
= null then
256 raise Program_Error
with
257 "attempt to delete node from empty hash bucket";
261 HT
.Buckets
(Indx
) := Next
(Prev
);
262 HT
.Length
:= HT
.Length
- 1;
266 if Checks
and then HT
.Length
= 1 then
267 raise Program_Error
with
268 "attempt to delete node not in its proper hash bucket";
274 if Checks
and then Curr
= null then
275 raise Program_Error
with
276 "attempt to delete node not in its proper hash bucket";
280 Set_Next
(Node
=> Prev
, Next
=> Next
(Curr
));
281 HT
.Length
:= HT
.Length
- 1;
287 end Delete_Node_Sans_Free
;
293 procedure Finalize
(HT
: in out Hash_Table_Type
) is
296 Free_Buckets
(HT
.Buckets
);
304 (HT
: Hash_Table_Type
) return Node_Access
308 return First
(HT
, Dummy
);
312 (HT
: Hash_Table_Type
;
313 Position
: out Hash_Type
) return Node_Access
is
315 if HT
.Length
= 0 then
316 Position
:= Hash_Type
'Last;
320 Position
:= HT
.Buckets
'First;
322 if HT
.Buckets
(Position
) /= null then
323 return HT
.Buckets
(Position
);
326 Position
:= Position
+ 1;
334 procedure Free_Buckets
(Buckets
: in out Buckets_Access
) is
336 new Ada
.Unchecked_Deallocation
(Buckets_Type
, Buckets_Allocation
);
339 -- Buckets must have been created by New_Buckets. Here, we convert back
340 -- to the Buckets_Allocation type, and do the free on that.
342 Free
(Buckets_Allocation
(Buckets
));
345 ---------------------
346 -- Free_Hash_Table --
347 ---------------------
349 procedure Free_Hash_Table
(Buckets
: in out Buckets_Access
) is
353 if Buckets
= null then
357 for J
in Buckets
'Range loop
358 while Buckets
(J
) /= null loop
360 Buckets
(J
) := Next
(Node
);
365 Free_Buckets
(Buckets
);
372 function Generic_Equal
373 (L
, R
: Hash_Table_Type
) return Boolean
376 if L
.Length
/= R
.Length
then
385 -- Per AI05-0022, the container implementation is required to detect
386 -- element tampering by a generic actual subprogram.
388 Lock_L
: With_Lock
(L
.TC
'Unrestricted_Access);
389 Lock_R
: With_Lock
(R
.TC
'Unrestricted_Access);
392 L_Node
: Node_Access
;
396 -- Find the first node of hash table L
400 L_Node
:= L
.Buckets
(L_Index
);
401 exit when L_Node
/= null;
402 L_Index
:= L_Index
+ 1;
405 -- For each node of hash table L, search for an equivalent node in
410 if not Find
(HT
=> R
, Key
=> L_Node
) then
416 L_Node
:= Next
(L_Node
);
418 if L_Node
= null then
419 -- We have exhausted the nodes in this bucket
425 -- Find the next bucket
428 L_Index
:= L_Index
+ 1;
429 L_Node
:= L
.Buckets
(L_Index
);
430 exit when L_Node
/= null;
437 -----------------------
438 -- Generic_Iteration --
439 -----------------------
441 procedure Generic_Iteration
(HT
: Hash_Table_Type
) is
442 procedure Wrapper
(Node
: Node_Access
; Dummy_Pos
: Hash_Type
);
448 procedure Wrapper
(Node
: Node_Access
; Dummy_Pos
: Hash_Type
) is
453 procedure Internal_With_Pos
is
454 new Generic_Iteration_With_Position
(Wrapper
);
456 -- Start of processing for Generic_Iteration
459 Internal_With_Pos
(HT
);
460 end Generic_Iteration
;
462 -------------------------------------
463 -- Generic_Iteration_With_Position --
464 -------------------------------------
466 procedure Generic_Iteration_With_Position
467 (HT
: Hash_Table_Type
)
472 if HT
.Length
= 0 then
476 for Indx
in HT
.Buckets
'Range loop
477 Node
:= HT
.Buckets
(Indx
);
478 while Node
/= null loop
479 Process
(Node
, Indx
);
483 end Generic_Iteration_With_Position
;
489 procedure Generic_Read
490 (Stream
: not null access Root_Stream_Type
'Class;
491 HT
: out Hash_Table_Type
)
499 Count_Type
'Base'Read (Stream, N);
501 if Checks and then N < 0 then
502 raise Program_Error with "stream appears to be corrupt";
509 -- The RM does not specify whether or how the capacity changes when a
510 -- hash table is streamed in. Therefore we decide here to allocate a new
511 -- buckets array only when it's necessary to preserve representation
515 or else HT.Buckets'Length < N
517 Free_Buckets (HT.Buckets);
518 NN := Prime_Numbers.To_Prime (N);
519 HT.Buckets := New_Buckets (Length => NN);
524 Node : constant Node_Access := New_Node (Stream);
525 Indx : constant Hash_Type := Checked_Index (HT, Node);
526 B : Node_Access renames HT.Buckets (Indx);
528 Set_Next (Node => Node, Next => B);
532 HT.Length := HT.Length + 1;
540 procedure Generic_Write
541 (Stream : not null access Root_Stream_Type'Class;
542 HT : Hash_Table_Type)
544 procedure Write (Node : Node_Access);
545 pragma Inline (Write);
547 procedure Write is new Generic_Iteration (Write);
553 procedure Write (Node : Node_Access) is
555 Write (Stream, Node);
559 -- See Generic_Read for an explanation of why we do not stream out the
560 -- buckets array length too.
562 Count_Type'Base'Write
(Stream
, HT
.Length
);
571 (Buckets
: Buckets_Type
;
572 Node
: Node_Access
) return Hash_Type
is
574 return Hash_Node
(Node
) mod Buckets
'Length;
578 (Hash_Table
: Hash_Table_Type
;
579 Node
: Node_Access
) return Hash_Type
is
581 return Index
(Hash_Table
.Buckets
.all, Node
);
588 procedure Move
(Target
, Source
: in out Hash_Table_Type
) is
590 if Target
'Address = Source
'Address then
594 TC_Check
(Source
.TC
);
599 Buckets
: constant Buckets_Access
:= Target
.Buckets
;
601 Target
.Buckets
:= Source
.Buckets
;
602 Source
.Buckets
:= Buckets
;
605 Target
.Length
:= Source
.Length
;
613 function New_Buckets
(Length
: Hash_Type
) return Buckets_Access
is
614 subtype Rng
is Hash_Type
range 0 .. Length
- 1;
617 -- Allocate in Buckets_Allocation'Storage_Pool, then convert to
620 return Buckets_Access
(Buckets_Allocation
'(new Buckets_Type (Rng)));
628 (HT : aliased in out Hash_Table_Type;
630 Position : in out Hash_Type) return Node_Access
632 Result : Node_Access;
636 -- First, check if the node has other nodes chained to it
637 Result := Next (Node);
639 if Result /= null then
643 -- Check if we were supplied a position for Node, from which we
644 -- can start iteration on the buckets.
646 if Position /= Hash_Type'Last then
647 First := Position + 1;
649 First := Checked_Index (HT, Node) + 1;
652 for Indx in First .. HT.Buckets'Last loop
653 Result := HT.Buckets (Indx);
655 if Result /= null then
665 (HT : aliased in out Hash_Table_Type;
666 Node : Node_Access) return Node_Access
668 Pos : Hash_Type := Hash_Type'Last;
670 return Next (HT, Node, Pos);
673 ----------------------
674 -- Reserve_Capacity --
675 ----------------------
677 procedure Reserve_Capacity
678 (HT : in out Hash_Table_Type;
684 if HT.Buckets = null then
686 NN := Prime_Numbers.To_Prime (N);
687 HT.Buckets := New_Buckets (Length => NN);
693 if HT.Length = 0 then
695 -- This is the easy case. There are no nodes, so no rehashing is
696 -- necessary. All we need to do is allocate a new buckets array
697 -- having a length implied by the specified capacity. (We say
698 -- "implied by" because bucket arrays are always allocated with a
699 -- length that corresponds to a prime number.)
702 Free_Buckets (HT.Buckets);
706 if N = HT.Buckets'Length then
710 NN := Prime_Numbers.To_Prime (N);
712 if NN = HT.Buckets'Length then
717 X : Buckets_Access := HT.Buckets;
718 pragma Warnings (Off, X);
720 HT.Buckets := New_Buckets (Length => NN);
727 if N = HT.Buckets'Length then
731 if N < HT.Buckets'Length then
733 -- This is a request to contract the buckets array. The amount of
734 -- contraction is bounded in order to preserve the invariant that the
735 -- buckets array length is never smaller than the number of elements
736 -- (the load factor is 1).
738 if HT.Length >= HT.Buckets'Length then
742 NN := Prime_Numbers.To_Prime (HT.Length);
744 if NN >= HT.Buckets'Length then
749 NN := Prime_Numbers.To_Prime (Count_Type'Max (N, HT.Length));
751 if NN = HT.Buckets'Length then -- can't expand any more
759 Dst_Buckets : Buckets_Access := New_Buckets (Length => NN);
760 Src_Buckets : Buckets_Access := HT.Buckets;
761 pragma Warnings (Off, Src_Buckets);
763 L : Count_Type renames HT.Length;
764 LL : constant Count_Type := L;
766 Src_Index : Hash_Type := Src_Buckets'First;
771 Src_Bucket : Node_Access renames Src_Buckets (Src_Index);
774 while Src_Bucket /= null loop
776 Src_Node : constant Node_Access := Src_Bucket;
778 Dst_Index : constant Hash_Type :=
779 Checked_Index (HT, Dst_Buckets.all, Src_Node);
781 Dst_Bucket : Node_Access renames Dst_Buckets (Dst_Index);
784 Src_Bucket := Next (Src_Node);
786 Set_Next (Src_Node, Dst_Bucket);
788 Dst_Bucket := Src_Node;
791 pragma Assert (L > 0);
798 -- If there's an error computing a hash value during a
799 -- rehash, then AI-302 says the nodes "become lost." The
800 -- issue is whether to actually deallocate these lost nodes,
801 -- since they might be designated by extant cursors. Here
802 -- we decide to deallocate the nodes, since it's better to
803 -- solve real problems (storage consumption) rather than
804 -- imaginary ones (the user might, or might not, dereference
805 -- a cursor designating a node that has been deallocated),
806 -- and because we have a way to vet a dangling cursor
807 -- reference anyway, and hence can actually detect the
810 for Dst_Index in Dst_Buckets'Range loop
812 B : Node_Access renames Dst_Buckets (Dst_Index);
823 Free_Buckets (Dst_Buckets);
824 raise Program_Error with
825 "hash function raised exception during rehash";
828 Src_Index := Src_Index + 1;
831 HT.Buckets := Dst_Buckets;
834 Free_Buckets (Src_Buckets);
836 end Reserve_Capacity;
838 end Ada.Containers.Hash_Tables.Generic_Operations;