1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/Sys/PetscMallocValidate.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>PetscMallocValidate</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
<div id="version" align=right><b>petsc-3.14.5 2021-03-03</b></div>
<div id="bugreport" align=right><a href="mailto:petsc-maint@mcs.anl.gov?subject=Typo or Error in Documentation &body=Please describe the typo or error in the documentation: petsc-3.14.5 v3.14.5 docs/manualpages/Sys/PetscMallocValidate.html "><small>Report Typos and Errors</small></a></div>
<A NAME="PetscMallocValidate"><H1>PetscMallocValidate</H1></A>
Test the memory for corruption. This can be called at any time between <A HREF="../Sys/PetscInitialize.html#PetscInitialize">PetscInitialize</A>() and <A HREF="../Sys/PetscFinalize.html#PetscFinalize">PetscFinalize</A>()
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscsys.h"
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../Sys/PetscMallocValidate.html#PetscMallocValidate">PetscMallocValidate</A>(int line,const char function[],const char file[])
</PRE>
<H3><FONT COLOR="#CC3333">Input Parameters</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>line </B></TD><TD>- line number where call originated.
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>function </B></TD><TD>- name of function calling
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>file </B></TD><TD>- file where function is
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Return value</FONT></H3>
The number of errors detected.
<P>
Options Database:.
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-malloc_test </B></TD><TD>- turns this feature on when PETSc was not configured with --with-debugging=0
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-malloc_debug </B></TD><TD>- turns this feature on anytime
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Output Effect</FONT></H3>
Error messages are written to stdout.
<P>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
This is only run if <A HREF="../Sys/PetscMallocSetDebug.html#PetscMallocSetDebug">PetscMallocSetDebug</A>() has been called which is set by -malloc_test (if debugging is turned on) or -malloc_debug (any time)
<P>
You should generally use <A HREF="../Sys/CHKMEMQ.html#CHKMEMQ">CHKMEMQ</A> as a short cut for calling this routine.
<P>
The Fortran calling sequence is simply <A HREF="../Sys/PetscMallocValidate.html#PetscMallocValidate">PetscMallocValidate</A>(ierr)
<P>
No output is generated if there are no problems detected.
<P>
<H3><FONT COLOR="#CC3333">Developers Note</FONT></H3>
Uses the flg TRdebugLevel (set as the first argument to <A HREF="../Sys/PetscMallocSetDebug.html#PetscMallocSetDebug">PetscMallocSetDebug</A>()) to determine if it should run
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../Sys/CHKMEMQ.html#CHKMEMQ">CHKMEMQ</A>
<BR>
<P>
<P><B></B><H3><FONT COLOR="#CC3333">Level</FONT></H3>advanced<BR>
<H3><FONT COLOR="#CC3333">Location</FONT></H3>
</B><A HREF="../../../src/sys/memory/mtr.c.html#PetscMallocValidate">src/sys/memory/mtr.c</A>
<BR><A HREF="./index.html">Index of all Sys routines</A>
<BR><A HREF="../../index.html">Table of Contents for all manual pages</A>
<BR><A HREF="../singleindex.html">Index of all manual pages</A>
</BODY></HTML>
|
