------------------------------------------------------------------------------ | |

-- -- | |

-- GNAT COMPILER COMPONENTS -- | |

-- -- | |

-- S Y S T E M . A R I T H _ 1 2 8 -- | |

-- -- | |

-- S p e c -- | |

-- -- | |

-- Copyright (C) 2020-2021, Free Software Foundation, Inc. -- | |

-- -- | |

-- GNAT is free software; you can redistribute it and/or modify it under -- | |

-- terms of the GNU General Public License as published by the Free Soft- -- | |

-- ware Foundation; either version 3, or (at your option) any later ver- -- | |

-- sion. GNAT is distributed in the hope that it will be useful, but WITH- -- | |

-- OUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY -- | |

-- or FITNESS FOR A PARTICULAR PURPOSE. -- | |

-- -- | |

-- As a special exception under Section 7 of GPL version 3, you are granted -- | |

-- additional permissions described in the GCC Runtime Library Exception, -- | |

-- version 3.1, as published by the Free Software Foundation. -- | |

-- -- | |

-- You should have received a copy of the GNU General Public License and -- | |

-- a copy of the GCC Runtime Library Exception along with this program; -- | |

-- see the files COPYING3 and COPYING.RUNTIME respectively. If not, see -- | |

-- <http://www.gnu.org/licenses/>. -- | |

-- -- | |

-- GNAT was originally developed by the GNAT team at New York University. -- | |

-- Extensive contributions were provided by Ada Core Technologies Inc. -- | |

-- -- | |

------------------------------------------------------------------------------ | |

-- This unit provides software routines for doing arithmetic on 128-bit | |

-- signed integer values in cases where either overflow checking is | |

-- required, or intermediate results are longer than 128 bits. | |

pragma Restrictions (No_Elaboration_Code); | |

-- Allow direct call from gigi generated code | |

with Interfaces; | |

package System.Arith_128 is | |

pragma Pure; | |

subtype Int128 is Interfaces.Integer_128; | |

function Add_With_Ovflo_Check128 (X, Y : Int128) return Int128; | |

-- Raises Constraint_Error if sum of operands overflows 128 bits, | |

-- otherwise returns the 128-bit signed integer sum. | |

function Subtract_With_Ovflo_Check128 (X, Y : Int128) return Int128; | |

-- Raises Constraint_Error if difference of operands overflows 128 | |

-- bits, otherwise returns the 128-bit signed integer difference. | |

function Multiply_With_Ovflo_Check128 (X, Y : Int128) return Int128; | |

pragma Export (C, Multiply_With_Ovflo_Check128, "__gnat_mulv128"); | |

-- Raises Constraint_Error if product of operands overflows 128 | |

-- bits, otherwise returns the 128-bit signed integer product. | |

-- Gigi may also call this routine directly. | |

procedure Scaled_Divide128 | |

(X, Y, Z : Int128; | |

Q, R : out Int128; | |

Round : Boolean); | |

-- Performs the division of (X * Y) / Z, storing the quotient in Q | |

-- and the remainder in R. Constraint_Error is raised if Z is zero, | |

-- or if the quotient does not fit in 128 bits. Round indicates if | |

-- the result should be rounded. If Round is False, then Q, R are | |

-- the normal quotient and remainder from a truncating division. | |

-- If Round is True, then Q is the rounded quotient. The remainder | |

-- R is not affected by the setting of the Round flag. | |

procedure Double_Divide128 | |

(X, Y, Z : Int128; | |

Q, R : out Int128; | |

Round : Boolean); | |

-- Performs the division X / (Y * Z), storing the quotient in Q and | |

-- the remainder in R. Constraint_Error is raised if Y or Z is zero, | |

-- or if the quotient does not fit in 128 bits. Round indicates if the | |

-- result should be rounded. If Round is False, then Q, R are the normal | |

-- quotient and remainder from a truncating division. If Round is True, | |

-- then Q is the rounded quotient. The remainder R is not affected by the | |

-- setting of the Round flag. | |

private | |

-- Make it callable from strub contexts. | |

-- There is a matching setting in trans.c, | |

-- for calls issued by Gigi. | |

pragma Machine_Attribute (Multiply_With_Ovflo_Check128, | |

"strub", "callable"); | |

end System.Arith_128; |