Return to TraceFileHandlerUnix.cpp CVS log

Up to [Pegasus] / pegasus / src / Pegasus / Common

BUG#: 2196
TITLE: Copyright update

DESCRIPTION: Update all .cpp and .h files for new license and
update the doc/license.txt file.  Note that there were also
a couple of files that had to be fixed because they had violated
the comments rules (ex. blank line at head of file or in the case of
xmlwriter.cpp a comment line //=========  which drove the strip
function nuts.  These were fixed.  This has been compiled and tested
on windows.

//%2004////////////////////////////////////////////////////////////////////////
//
// Copyright (c) 2000, 2001, 2002 BMC Software; Hewlett-Packard Development
// Company, L.P.; IBM Corp.; The Open Group; Tivoli Systems.
// Copyright (c) 2003 BMC Software; Hewlett-Packard Development Company, L.P.;
// IBM Corp.; EMC Corporation, The Open Group.
// Copyright (c) 2004 BMC Software; Hewlett-Packard Development Company, L.P.;
// IBM Corp.; EMC Corporation; VERITAS Software Corporation; The Open Group.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to
// deal in the Software without restriction, including without limitation the
// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
// sell copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
// 
// THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE SHALL BE INCLUDED IN
// ALL COPIES OR SUBSTANTIAL PORTIONS OF THE SOFTWARE. THE SOFTWARE IS PROVIDED
// "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
// LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
// PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
// ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
//
//==============================================================================
//
// Author: Sushma Fernandes, Hewlett-Packard Company (sushma_fernandes@hp.com)
//
// Modified By: Amit K Arora, IBM (amita@in.ibm.com) for Bug#1527
//
//%/////////////////////////////////////////////////////////////////////////////


#include <fcntl.h>
#include <Pegasus/Common/Logger.h>
#include <Pegasus/Common/System.h>
#include <Pegasus/Common/TraceFileHandler.h>

PEGASUS_USING_STD;

PEGASUS_NAMESPACE_BEGIN

/////////////////////////////////////////////////////////////////////////////// 
//  Writes message to file. Locks the file before writing to it
//  Implementation of this function is platform specific
///////////////////////////////////////////////////////////////////////////////
void TraceFileHandler::handleMessage(
    const char* message,
    const char* fmt,
    va_list argList) 
{
    struct flock lock;
    Sint32 retCode;

    lock.l_type = F_WRLCK;
    lock.l_whence = SEEK_SET;
    lock.l_start = 0;
    lock.l_len = 1;

    // Try to lock the file. If the lock is busy, wait for it to be free.
    // Do not add Trace calls in the Critical section
    // ---- BEGIN CRITICAL SECTION

    // Check if the file has been deleted, if so re-open the file and continue
    if (!System::exists(_fileName))
    {
	freopen(_fileName,"a+",_fileHandle);
        if (!_fileHandle)
        {
            // Unable to re-open file, log a message
            //l10n
            //Logger::put(Logger::DEBUG_LOG,System::CIMSERVER,Logger::WARNING,
                //"Failed to open File $0",_fileName);
            Logger::put_l(Logger::DEBUG_LOG,System::CIMSERVER,Logger::WARNING,
            	"Common.TraceFileHandlerUnix.FAILED_TO_OPEN_FILE",
                "Failed to open File $0",_fileName);
            return; 
        } 	

        //
        // Set permissions on the trace file to 0600
        //
        if ( !FileSystem::changeFilePermissions(String(_fileName), (S_IRUSR|S_IWUSR)) )
        {
            Logger::put_l(Logger::DEBUG_LOG,"Tracer",Logger::WARNING,
               "Common.TraceFileHandlerUnix.FAILED_TO_SET_FILE_PERMISSIONS",
               "Failed to set permissions on file $0",_fileName);
                return;
        }
    }

    retCode = fcntl(fileno(_fileHandle), F_SETLKW, &lock);

    if (retCode != -1)
    {
	// Got the Lock on the File. Seek to the end of File
	fseek(_fileHandle,0,SEEK_END);
#ifdef PEGASUS_PLATFORM_LINUX_GENERIC_GNU
        long pos = ftell(_fileHandle);
        // Check if the file size is approaching 2GB - which is the
        // maximum size a file on 32 bit Linux can grow (ofcourse if
        // not using large-files option). If this is not checked, the 
        // cimserver may get a SIGXFSZ signal and shutdown. See Bug#1527.
        if(pos >= 0x7ff00000) 
        {
           // If the file size is almost 2 GB in size, close this trace
           // file and open a new trace file which would have _fileCount
           // as the suffix. So, if "cimserver.trc" is the trace file that
           // approaches 2GB, the next file which gets created would be
           // named "cimserver.trc.1" and so on ...

           // Free the Lock on the File
           lock.l_type = F_UNLCK;
           retCode = fcntl(fileno(_fileHandle), F_SETLK, &lock);

           if (retCode == -1)
           {  
              Logger::put_l(Logger::DEBUG_LOG,System::CIMSERVER,Logger::WARNING,
                     "Common.TraceFileHandlerUnix.FAILED_TO_RELEASE_WRITE_LOCK",
                     "Failed to release write lock on File $0",_fileName);
           }
           fclose(_fileHandle);
           sprintf(_fileName,"%s.%u",_baseFileName,++_fileCount);
           _fileHandle = fopen(_fileName,"a+");
           if (!_fileHandle)
           {
             // Unable to open file, log a message
             if (!_wroteToLog)
             {
               Logger::put_l(Logger::DEBUG_LOG,"Tracer",Logger::WARNING,
                     "Common.TraceFileHandler.FAILED_TO_OPEN_FILE",
                     "Failed to open File $0",_fileName);
               _wroteToLog = true;
             }
              return;
            }
            retCode = fcntl(fileno(_fileHandle), F_SETLKW, &lock);

            if (retCode == -1)
            {
             if (!_wroteToLog)
             {
              Logger::put_l(Logger::DEBUG_LOG,System::CIMSERVER,Logger::WARNING,
                      "Common.TraceFileHandlerUnix.FAILED_TO_OBTAIN_WRITE_LOCK",
                      "Failed to obtain write lock on File $0",_fileName);
              _wroteToLog = true;
             }
             return;
            }
        }
#endif

	// Write the message to the file
        fprintf (_fileHandle, "%s",message);
	retCode = vfprintf(_fileHandle,fmt,argList);
	fprintf(_fileHandle,"\n");
	fflush(_fileHandle);
	
	// Free the Lock on the File
        lock.l_type = F_UNLCK;
        retCode = fcntl(fileno(_fileHandle), F_SETLK, &lock);

	if (retCode == -1)
	{
	    // Failed to release lock on file. Log message and return
	    //l10n
	    //Logger::put(Logger::DEBUG_LOG,System::CIMSERVER,Logger::WARNING,
		//"Failed to release write lock on File $0",_fileName);
		Logger::put_l(Logger::DEBUG_LOG,System::CIMSERVER,Logger::WARNING,
			"Common.TraceFileHandlerUnix.FAILED_TO_RELEASE_WRITE_LOCK",
			"Failed to release write lock on File $0",_fileName);
        }
	_wroteToLog = false;
    }
    else
    {
	// Unable to Lock the file for writing
	// Log message and return
	// Check if message is already logged, so as to not to flood log file
	if (!_wroteToLog)
	{ 
		//l10n
	    //Logger::put(Logger::DEBUG_LOG,System::CIMSERVER,Logger::WARNING,
		//"Failed to obtain write lock on File $0",_fileName);
		Logger::put_l(Logger::DEBUG_LOG,System::CIMSERVER,Logger::WARNING,
			"Common.TraceFileHandlerUnix.FAILED_TO_OBTAIN_WRITE_LOCK",
			"Failed to obtain write lock on File $0",_fileName);
            _wroteToLog = true;
	}
    }
    // ---- END CRITICAL SECTION

    return;
} 

PEGASUS_NAMESPACE_END