songtianlun/openfoam
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

ENH: support optional upper limit for printStack

Browse Source 
- when only a partial stacktrace is desirable.

ENH: add stack trace decorators

- the 0-th frame is always printStack(), so skip that and emit
  some headers/footers instead. Eg,

  [stack trace]
  =============
  #1  Foam::SymmTensor<double> Foam::inv<double>(...)
  #2  Foam::inv(Foam::UList<Foam::SymmTensor<double>> const&) ...
  ...
  =============
This commit is contained in:
Mark Olesen 2023-03-21 20:27:10 +01:00
parent 81807646ca
commit f6969631a6
4 changed files with 34 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
src/OSspecific/MSwindows/printStack/dummyPrintStack.C
View File

@ -5,7 +5,8 @@
\\ / A nd | www.openfoam.com
\\/ M anipulation |
-------------------------------------------------------------------------------
Copyright (C) 2011-2017 OpenFOAM Foundation
Copyright (C) 2011 OpenFOAM Foundation
Copyright (C) 2023 OpenCFD Ltd.
-------------------------------------------------------------------------------
License
This file is part of OpenFOAM.
@ -29,11 +30,11 @@ License
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
void Foam::error::safePrintStack(std::ostream& os)
void Foam::error::safePrintStack(std::ostream& os, int size)
{}
void Foam::error::printStack(Ostream& os)
void Foam::error::printStack(Ostream& os, int size)
{}

7
src/OSspecific/POSIX/printStack/dummyPrintStack.C
View File

@ -5,7 +5,8 @@
\\ / A nd | www.openfoam.com
\\/ M anipulation |
-------------------------------------------------------------------------------
Copyright (C) 2011-2017 OpenFOAM Foundation
Copyright (C) 2011 OpenFOAM Foundation
Copyright (C) 2023 OpenCFD Ltd.
-------------------------------------------------------------------------------
License
This file is part of OpenFOAM.
@ -29,11 +30,11 @@ License
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
void Foam::error::safePrintStack(std::ostream& os)
void Foam::error::safePrintStack(std::ostream& os, int size)
{}
void Foam::error::printStack(Ostream& os)
void Foam::error::printStack(Ostream& os, int size)
{}

27
src/OSspecific/POSIX/printStack/printStack.C
View File

@ -6,7 +6,7 @@
\\/ M anipulation |
-------------------------------------------------------------------------------
Copyright (C) 2011-2016 OpenFOAM Foundation
Copyright (C) 2019-2022 OpenCFD Ltd.
Copyright (C) 2019-2023 OpenCFD Ltd.
-------------------------------------------------------------------------------
License
This file is part of OpenFOAM.
@ -201,15 +201,20 @@ inline Foam::fileName whichPath(const char* fn)
// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
void Foam::error::safePrintStack(std::ostream& os)
void Foam::error::safePrintStack(std::ostream& os, int size)
{
// Get raw stack symbols
void *callstack[100];
const int size = backtrace(callstack, 100);
size = backtrace(callstack, (size > 0 && size < 100) ? size + 1 : 100);
char **strings = backtrace_symbols(callstack, size);
size_t rdelim;
for (int i = 0; i < size; ++i)
// Frame 0 is 'printStack()' - report something more meaningful
os << "[stack trace]" << std::endl
<< "=============" << std::endl;
for (int i = 1; i < size; ++i)
{
std::string str(strings[i]);
@ -269,20 +274,26 @@ void Foam::error::safePrintStack(std::ostream& os)
os << std::endl;
}
os << "=============" << std::endl;
free(strings);
}
void Foam::error::printStack(Ostream& os)
void Foam::error::printStack(Ostream& os, int size)
{
// Get raw stack symbols
void *callstack[100];
const int size = backtrace(callstack, 100);
size = backtrace(callstack, (size > 0 && size < 100) ? size + 1 : 100);
Dl_info info;
fileName fname;
for (int i = 0; i < size; ++i)
// Frame 0 is 'printStack()' - report something more meaningful
os << "[stack trace]" << nl
<< "=============" << nl;
for (int i = 1; i < size; ++i)
{
int st = dladdr(callstack[i], &info);
@ -309,6 +320,8 @@ void Foam::error::printStack(Ostream& os)
printSourceFileAndLine(os, fname, info, callstack[i]);
os << nl;
}
os << "=============" << nl;
}

12
src/OpenFOAM/db/error/error.H
View File

@ -6,7 +6,7 @@
\\/ M anipulation |
-------------------------------------------------------------------------------
Copyright (C) 2011-2015 OpenFOAM Foundation
Copyright (C) 2015-2021 OpenCFD Ltd.
Copyright (C) 2015-2023 OpenCFD Ltd.
-------------------------------------------------------------------------------
License
This file is part of OpenFOAM.
@ -231,12 +231,12 @@ public:
operator dictionary() const;
//- Helper function to print a stack,
//- used when OpenFOAM IO not yet initialised.
static void safePrintStack(std::ostream& os);
//- Helper function to print a stack, with optional upper limit.
//- Used when OpenFOAM IO not yet initialised.
static void safePrintStack(std::ostream& os, int size = -1);
//- Helper function to print a stack
static void printStack(Ostream& os);
//- Helper function to print a stack, with optional upper limit.
static void printStack(Ostream& os, int size = -1);
//- True if FOAM_ABORT is on.
static bool useAbort();