utils_hex.cpp File Reference

#include "eve-core.h"
#include "log/logsys.h"
#include "utils/utils_string.h"

Include dependency graph for utils_hex.cpp:

Go to the source code of this file.

Functions
void	build_hex_line (const uint8 *buffer, size_t length, size_t offset, char *ret, unsigned int padding)
	Build a printable line suitable for hex dump. More...
void	pfxHexDump (const char *pfx, FILE *into, const uint8 *data, size_t length)
void	pfxHexDump (const char *pfx, LogType type, const uint8 *data, size_t length)
void	pfxHexDumpPreview (const char *pfx, FILE *into, const uint8 *data, size_t length)
void	pfxHexDumpPreview (const char *pfx, LogType type, const uint8 *data, size_t length)

Variables
const uint32	HEX_DUMP_PREVIEW_LIMIT = 1024

Function Documentation

void build_hex_line	(	const uint8 *	buffer,
		size_t	length,
		size_t	offset,
		char *	ret,
		unsigned int	padding = 4
	)

Build a printable line suitable for hex dump.

Parameters

[in]	buffer	Buffer which is being dumped.
[in]	length	Length of buffer.
[in]	offset	Offset at which the dump should start.
[out]	ret	Array where result is stored.
[in]	padding	Padding to be used when printing offset.

Definition at line 33 of file utils_hex.cpp.

References IsPrintable(), and snprintf.

Referenced by log_hex(), log_phex(), pfxHexDump(), and pfxHexDumpPreview().

{
    ret += snprintf( ret, length, "%0*zX:", padding, offset );

    char printable[17];

    for( size_t i = 0; i < 16; i++ )
    {
        if( i == 8 )
        {
            ret += snprintf( ret, length, " -" );
        }

        if( ( i + offset ) < length )
        {
            uint8 c = *(const uint8*)( buffer + offset + i );

            ret += snprintf( ret, length, " %02X", c );
            printable[i] = ( IsPrintable( c ) ? (char)c : '.' );
        }
        else
        {
            ret += snprintf( ret, length, "   " );
            printable[i] = 0;
        }
    }

    snprintf( ret, length, "  | %.16s", printable );
}

Here is the call graph for this function:

Here is the caller graph for this function:

void pfxHexDump	(	const char *	pfx,
		FILE *	into,
		const uint8 *	data,
		size_t	length
	)

Definition at line 63 of file utils_hex.cpp.

References build_hex_line().

Referenced by PyLogDumpVisitor::_dump(), PyFileDumpVisitor::_dump(), and pfxHexDumpPreview().

{
    char buffer[80];

    for( uint32 offset = 0; offset < length; offset += 16 )
    {
        build_hex_line( data, length, offset, buffer, 4 );

        fprintf( into, "%s%s\n", pfx, buffer );
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

void pfxHexDump	(	const char *	pfx,
		LogType	type,
		const uint8 *	data,
		size_t	length
	)

Definition at line 75 of file utils_hex.cpp.

References _log, and build_hex_line().

{
    char buffer[80];

    for( uint32 offset = 0; offset < length; offset += 16 )
    {
        build_hex_line( data, length, offset, buffer, 4 );

        _log( type, "%s%s", pfx, buffer );
    }
}

Here is the call graph for this function:

void pfxHexDumpPreview	(	const char *	pfx,
		FILE *	into,
		const uint8 *	data,
		size_t	length
	)

Definition at line 87 of file utils_hex.cpp.

References build_hex_line(), HEX_DUMP_PREVIEW_LIMIT, and pfxHexDump().

Referenced by PyLogDumpVisitor::_dump(), and PyFileDumpVisitor::_dump().

{
    char buffer[80];

    if( length > HEX_DUMP_PREVIEW_LIMIT )
    {
        pfxHexDump( pfx, into, data, HEX_DUMP_PREVIEW_LIMIT - 32 );
        fprintf( into, "%s ... truncated ...\n", pfx );

        build_hex_line( data, length, length - 16, buffer, 4 );
        fprintf( into, "%s%s\n", pfx, buffer );
    }
    else
        pfxHexDump( pfx, into, data, length );
}

Here is the call graph for this function:

Here is the caller graph for this function:

void pfxHexDumpPreview	(	const char *	pfx,
		LogType	type,
		const uint8 *	data,
		size_t	length
	)

Definition at line 103 of file utils_hex.cpp.

References _log, build_hex_line(), HEX_DUMP_PREVIEW_LIMIT, and pfxHexDump().

{
    char buffer[80];

    if( length > HEX_DUMP_PREVIEW_LIMIT )
    {
        pfxHexDump( pfx, type, data, HEX_DUMP_PREVIEW_LIMIT - 32 );
        _log( type, "%s ... truncated ...", pfx );

        build_hex_line( data, length, length - 16, buffer, 4 );
        _log( type, "%s%s", pfx, buffer );
    }
    else
        pfxHexDump( pfx, type, data, length );
}

Here is the call graph for this function:

Variable Documentation

const uint32 HEX_DUMP_PREVIEW_LIMIT = 1024

The maximal number of bytes printed by pfxHexDumpPreview.

Definition at line 31 of file utils_hex.cpp.

Referenced by pfxHexDumpPreview().