blob: 6ca8068f0fc4853f9fc957aaedb6fdee198df056 [file] [log] [blame]
-- --
-- --
-- S Y S T E M . S T A C K _ U S A G E . T A S K I N G --
-- --
-- S p e c --
-- --
-- Copyright (C) 2009-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 --
-- --
-- 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 --
-- <>. --
-- --
-- GNARL was developed by the GNARL team at Florida State University. --
-- Extensive contributions were provided by Ada Core Technologies, Inc. --
-- --
-- This package provides exported subprograms to be called at debug time to
-- measure stack usage at run-time.
-- Note: this package must be a child package of System.Stack_Usage to have
-- visibility over its private part; it is however part of GNARL because it
-- needs to access tasking features via System.Tasking.Debug and
-- System.Task_Primitives.Operations;
package System.Stack_Usage.Tasking is
procedure Report_All_Tasks;
-- Print the current stack usage of all tasks on stderr. Exported to be
-- called also in debug mode.
pragma Export
procedure Report_Current_Task;
-- Print the stack usage of current task on stderr. Exported to be called
-- also in debug mode.
pragma Export
subtype Stack_Usage_Result is System.Stack_Usage.Task_Result;
-- This type is a descriptor for task stack usage result
type Stack_Usage_Result_Array is
array (Positive range <>) of Stack_Usage_Result;
function Get_Current_Task_Usage return Stack_Usage_Result;
-- Return the current stack usage for the invoking task
function Get_All_Tasks_Usage return Stack_Usage_Result_Array;
-- Return an array containing the stack usage results for all tasks
procedure Print (Obj : Stack_Usage_Result);
-- Print Obj on stderr
end System.Stack_Usage.Tasking;