Files
libreoffice/framework/inc/macros/debug/memorymeasure.hxx

227 lines
12 KiB
C++
Raw Normal View History

/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2008 by Sun Microsystems, Inc.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: memorymeasure.hxx,v $
* $Revision: 1.3 $
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef __FRAMEWORK_MACROS_DEBUG_MEMORYMEASURE_HXX_
#define __FRAMEWORK_MACROS_DEBUG_MEMORYMEASURE_HXX_
//*************************************************************************************************************
// special macros for time measures
// 1) LOGFILE_MEMORYMEASURE used it to define log file for this operations (default will be set automaticly)
// 2) MAKE_MEMORY_SNAPSHOT make snapshot of currently set memory informations of OS
// 3) LOG_MEMORYMEASURE write measured time to logfile
//*************************************************************************************************************
#ifdef ENABLE_MEMORYMEASURE
#if !defined( WIN ) && !defined( WNT )
#error "Macros to measure memory access not available under platforms different from windows!"
#endif
//_________________________________________________________________________________________________________________
// includes
//_________________________________________________________________________________________________________________
#ifndef _RTL_STRBUF_HXX_
#include <rtl/strbuf.hxx>
#endif
#ifndef __SGI_STL_VECTOR
#include <vector>
#endif
/*_____________________________________________________________________________________________________________
LOGFILE_MEMORYMEASURE
For follow macros we need a special log file. If user forget to specify anyone, we must do it for him!
_____________________________________________________________________________________________________________*/
#ifndef LOGFILE_MEMORYMEASURE
#define LOGFILE_MEMORYMEASURE "memorymeasure.log"
#endif
/*_____________________________________________________________________________________________________________
class MemoryMeasure
We use this baseclass to collect all snapshots in one object and analyze this information at one point.
Macros of this file are used to enable using of this class by special compile-parameter only!
_____________________________________________________________________________________________________________*/
class _DBGMemoryMeasure
{
//---------------------------------------------------------------------------------------------------------
private:
struct _MemoryInfo
{
MEMORYSTATUS aStatus ;
::rtl::OString sComment ;
};
//---------------------------------------------------------------------------------------------------------
public:
//_____________________________________________________________________________________________________
inline _DBGMemoryMeasure()
{
}
//_____________________________________________________________________________________________________
// clear used container!
inline ~_DBGMemoryMeasure()
{
::std::vector< _MemoryInfo >().swap( m_lSnapshots );
}
//_____________________________________________________________________________________________________
inline void makeSnapshot( const ::rtl::OString& sComment )
{
_MemoryInfo aInfo;
aInfo.sComment = sComment;
GlobalMemoryStatus ( &(aInfo.aStatus) );
m_lSnapshots.push_back( aInfo );
}
//_____________________________________________________________________________________________________
inline ::rtl::OString getLog()
{
::rtl::OStringBuffer sBuffer( 10000 );
CWS-TOOLING: integrate CWS oj18 2009-08-21 15:08:49 +0200 oj r275263 : wrong check 2009-08-21 08:56:01 +0200 oj r275215 : missing not 2009-08-20 07:27:13 +0200 oj r275164 : use new method from global 2009-08-19 10:22:35 +0200 oj r275138 : call GetLocale instead of pLocale 2009-08-18 10:39:32 +0200 oj r275082 : missing header include 2009-08-18 10:09:44 +0200 oj r275081 : new methods at global 2009-08-18 10:09:00 +0200 oj r275080 : unused var 2009-08-18 08:59:04 +0200 oj r275078 : move files from classes to xml 2009-08-17 14:58:16 +0200 oj r275056 : CWS-TOOLING: rebase CWS oj18 to trunk@275001 (milestone: DEV300:m55) 2009-08-17 13:29:44 +0200 oj r275047 : compile error 2009-08-17 13:27:47 +0200 oj r275045 : compile error 2009-08-17 11:44:54 +0200 oj r275040 : add dep 2009-07-22 14:26:05 +0200 oj r274240 : move unused services into fwl 2009-07-22 14:25:35 +0200 oj r274239 : move unused services into fwl 2009-07-22 13:47:45 +0200 oj r274233 : remove some unused code 2009-07-22 09:06:20 +0200 oj r274219 : export dbtoolsclient dbcharsethelper for sc 2009-07-22 08:48:58 +0200 oj r274218 : create NumberFormatter on demand 2009-07-22 08:39:23 +0200 oj r274217 : change char to sal_Char 2009-07-22 07:33:34 +0200 oj r274214 : export dbtoolsclient dbcharsethelper for sc 2009-07-22 07:30:04 +0200 oj r274213 : late init of numberformatter and breakiterator 2009-07-22 07:28:55 +0200 oj r274212 : export dbtoolsclient dbcharsethelper for sc 2009-07-21 13:43:28 +0200 oj r274196 : check if quick start is enbaled 2009-07-21 13:40:09 +0200 oj r274195 : check config entry for UiEventsLogger 2009-07-21 13:37:40 +0200 oj r274194 : code refactoring, remove of duplicate code and some late inits and removale of not needed files 2009-07-21 13:35:38 +0200 oj r274193 : code refactoring, remove of duplicate code and some late inits and removale of not needed files 2009-07-21 13:33:41 +0200 oj r274192 : doc meta data will now be created on demand 2009-07-21 13:13:40 +0200 oj r274187 : load ldap functions on demand 2009-07-21 13:03:17 +0200 oj r274183 : late init of TransliterationImpl 2009-07-21 12:36:10 +0200 oj r274180 : late init of charClass
2009-09-08 04:57:32 +00:00
if( !m_lSnapshots.empty() )
{
// Write informations to return buffer
::std::vector< _MemoryInfo >::const_iterator pItem1;
::std::vector< _MemoryInfo >::const_iterator pItem2;
pItem1 = m_lSnapshots.begin();
pItem2 = pItem1;
++pItem2;
while( pItem1!=m_lSnapshots.end() )
{
sBuffer.append( "snap [ " );
sBuffer.append( pItem1->sComment );
sBuffer.append( " ]\n\tavail phys\t=\t" );
sBuffer.append( (sal_Int32)pItem1->aStatus.dwAvailPhys );
sBuffer.append( "\n\tavail page\t=\t" );
sBuffer.append( (sal_Int32)pItem1->aStatus.dwAvailPageFile );
sBuffer.append( "\n\tavail virt\t=\t" );
sBuffer.append( (sal_Int32)pItem1->aStatus.dwAvailVirtual );
sBuffer.append( "\n\tdifference\t=\t[ " );
if( pItem1 == m_lSnapshots.begin() )
{
sBuffer.append( (sal_Int32)pItem1->aStatus.dwAvailPhys );
sBuffer.append( ", " );
sBuffer.append( (sal_Int32)pItem1->aStatus.dwAvailPageFile );
sBuffer.append( ", " );
sBuffer.append( (sal_Int32)pItem1->aStatus.dwAvailVirtual );
sBuffer.append( " ]\n\n" );
}
else if( pItem2 != m_lSnapshots.end() )
{
sBuffer.append( (sal_Int32)(pItem2->aStatus.dwAvailPhys - pItem1->aStatus.dwAvailPhys ) );
sBuffer.append( ", " );
sBuffer.append( (sal_Int32)(pItem2->aStatus.dwAvailPageFile - pItem1->aStatus.dwAvailPageFile ) );
sBuffer.append( ", " );
sBuffer.append( (sal_Int32)(pItem2->aStatus.dwAvailVirtual - pItem1->aStatus.dwAvailVirtual ) );
sBuffer.append( " ]\n\n" );
}
else
{
sBuffer.append( "0, 0, 0 ]\n\n" );
}
if( pItem1!=m_lSnapshots.end() ) ++pItem1;
if( pItem2!=m_lSnapshots.end() ) ++pItem2;
}
// clear current list ... make it empty for further snapshots!
::std::vector< _MemoryInfo >().swap( m_lSnapshots );
}
return sBuffer.makeStringAndClear();
}
//---------------------------------------------------------------------------------------------------------
private:
::std::vector< _MemoryInfo > m_lSnapshots;
};
/*_____________________________________________________________________________________________________________
START_MEMORY_MEASURE
Create new object to measure memory access.
_____________________________________________________________________________________________________________*/
#define START_MEMORYMEASURE( AOBJECT ) \
_DBGMemoryMeasure AOBJECT;
/*_____________________________________________________________________________________________________________
MAKE_MEMORY_SNAPSHOT
Make snapshot of currently set memory informations of OS.
see _DBGMemoryMeasure for further informations
_____________________________________________________________________________________________________________*/
#define MAKE_MEMORY_SNAPSHOT( AOBJECT, SCOMMENT ) \
AOBJECT.makeSnapshot( SCOMMENT );
/*_____________________________________________________________________________________________________________
LOG_MEMORYMEASURE( SOPERATION, SCOMMENT, AOBJECT )
Write measured values to logfile.
_____________________________________________________________________________________________________________*/
#define LOG_MEMORYMEASURE( SOPERATION, SCOMMENT, AOBJECT ) \
{ \
::rtl::OStringBuffer _sBuffer( 256 ); \
_sBuffer.append( SOPERATION ); \
_sBuffer.append( "\n" ); \
_sBuffer.append( SCOMMENT ); \
_sBuffer.append( "\n\n" ); \
_sBuffer.append( AOBJECT.getLog() ); \
WRITE_LOGFILE( LOGFILE_MEMORYMEASURE, _sBuffer.makeStringAndClear() ) \
}
#else // #ifdef ENABLE_MEMORYMEASURE
/*_____________________________________________________________________________________________________________
If right testmode is'nt set - implements these macros empty!
_____________________________________________________________________________________________________________*/
#undef LOGFILE_MEMORYMEASURE
#define START_MEMORYMEASURE( AOBJECT )
#define MAKE_MEMORY_SNAPSHOT( AOBJECT, SCOMMENT )
#define LOG_MEMORYMEASURE( SOPERATION, SCOMMENT, AOBJECT )
#endif // #ifdef ENABLE_MEMORYMEASURE
//*****************************************************************************************************************
// end of file
//*****************************************************************************************************************
#endif // #ifndef __FRAMEWORK_MACROS_DEBUG_MEMORYMEASURE_HXX_