debug.c File Reference

#include <stdio.h>
#include <stdint.h>
#include <stdarg.h>
#include <gpxe/io.h>
#include <console.h>

Go to the source code of this file.

Data Structures
struct	autocolour
	A colour assigned to an autocolourised debug message stream. More...
Defines
#define	GUARD_SYMBOL   ( ( 'M' << 24 ) | ( 'I' << 16 ) | ( 'N' << 8 ) | 'E' )
#define	NUM_AUTO_COLOURS   6
	Maximum number of separately coloured message streams.
Functions
void	pause (void)
void	more (void)
static void	dbg_hex_dump_da_row (unsigned long dispaddr, const void *data, unsigned long len, unsigned int offset)
	Print row of a hex dump with specified display address.
void	dbg_hex_dump_da (unsigned long dispaddr, const void *data, unsigned long len)
	Print hex dump with specified display address.
void	guard_region (void *region, size_t len)
int	check_region (void *region, size_t len)
static int	dbg_autocolour (unsigned long stream)
	Choose colour index for debug autocolourisation.
void	dbg_autocolourise (unsigned long stream)
	Select automatic colour for debug messages.
void	dbg_decolourise (void)
	Revert to normal colour.

---

Define Documentation

#define GUARD_SYMBOL   ( ( 'M' << 24 ) | ( 'I' << 16 ) | ( 'N' << 8 ) | 'E' )

Definition at line 72 of file debug.c.

Referenced by check_region(), and guard_region().

#define NUM_AUTO_COLOURS   6

Maximum number of separately coloured message streams.

Six is the realistic maximum; there are 8 basic ANSI colours, one of which will be the terminal default and one of which will be invisible on the terminal because it matches the background colour.

Definition at line 132 of file debug.c.

---

Function Documentation

void pause

(

void

)

Definition at line 7 of file debug.c.

References getchar(), and printf().

Referenced by mentormac_init().

                    {
        printf ( "\nPress a key" );
        getchar();
        printf ( "\r           \r" );
}

void more

(

void

)

Definition at line 13 of file debug.c.

References getchar(), and printf().

                   {
        printf ( "---more---" );
        getchar();
        printf ( "\r          \r" );
}

static void dbg_hex_dump_da_row	(	unsigned long	dispaddr,
		const void *	data,
		unsigned long	len,
		unsigned int	offset
	)			[static]

Print row of a hex dump with specified display address.

Parameters:

	dispaddr	Display address
	data	Data to print
	len	Length of data
	offset	Starting offset within data

Definition at line 27 of file debug.c.

References printf().

Referenced by dbg_hex_dump_da().

                                                                           {
        const uint8_t *bytes = data;
        unsigned int i;
        uint8_t byte;

        printf ( "%08lx :", ( dispaddr + offset ) );
        for ( i = offset ; i < ( offset + 16 ) ; i++ ) {
                if ( i >= len ) {
                        printf ( "   " );
                        continue;
                }
                printf ( "%c%02x",
                         ( ( ( i % 16 ) == 8 ) ? '-' : ' ' ), bytes[i] );
        }
        printf ( " : " );
        for ( i = offset ; i < ( offset + 16 ) ; i++ ) {
                if ( i >= len ) {
                        printf ( " " );
                        continue;
                }
                byte = bytes[i];
                if ( ( byte < 0x20 ) || ( byte >= 0x7f ) )
                        byte = '.';
                printf ( "%c", byte );
        }
        printf ( "\n" );
}

void guard_region	(	void *	region,
		size_t	len
	)

Definition at line 77 of file debug.c.

References GUARD_SYMBOL, and offset.

                                               {
        uint32_t offset = 0;

        len &= ~0x03;
        for ( offset = 0; offset < len ; offset += 4 ) {
                *((uint32_t *)(region + offset)) = GUARD_SYMBOL;
        }
}

int check_region	(	void *	region,
		size_t	len
	)

Definition at line 89 of file debug.c.

References GUARD_SYMBOL, offset, printf(), test, and virt_to_phys().

                                              {
        uint8_t corrupted = 0;
        uint8_t in_corruption = 0;
        uint32_t offset = 0;
        uint32_t test = 0;

        len &= ~0x03;
        for ( offset = 0; offset < len ; offset += 4 ) {
                test = *((uint32_t *)(region + offset)) = GUARD_SYMBOL;
                if ( ( in_corruption == 0 ) &&
                     ( test != GUARD_SYMBOL ) ) {
                        /* Start of corruption */
                        if ( corrupted == 0 ) {
                                corrupted = 1;
                                printf ( "Region %p-%p (physical %#lx-%#lx) "
                                         "corrupted\n",
                                         region, region + len,
                                         virt_to_phys ( region ),
                                         virt_to_phys ( region + len ) );
                        }
                        in_corruption = 1;
                        printf ( "--- offset %#x ", offset );
                } else if ( ( in_corruption != 0 ) &&
                            ( test == GUARD_SYMBOL ) ) {
                        /* End of corruption */
                        in_corruption = 0;
                        printf ( "to offset %#x", offset );
                }

        }
        if ( in_corruption != 0 ) {
                printf ( "to offset %#zx (end of region)\n", len-1 );
        }
        return corrupted;
}

static int dbg_autocolour

(

unsigned long

stream

)

[static]

Choose colour index for debug autocolourisation.

Parameters:

stream

Message stream ID

Return values:

colour

Colour ID

Definition at line 148 of file debug.c.

References autocolour::last_used, and autocolour::stream.

Referenced by dbg_autocolourise().

                                                   {
        static struct autocolour acs[NUM_AUTO_COLOURS];
        static unsigned long use;
        unsigned int i;
        unsigned int oldest;
        unsigned int oldest_last_used;

        /* Increment usage iteration counter */
        use++;

        /* Scan through list for a currently assigned colour */
        for ( i = 0 ; i < ( sizeof ( acs ) / sizeof ( acs[0] ) ) ; i++ ) {
                if ( acs[i].stream == stream ) {
                        acs[i].last_used = use;
                        return i;
                }
        }

        /* No colour found; evict the oldest from the list */
        oldest = 0;
        oldest_last_used = use;
        for ( i = 0 ; i < ( sizeof ( acs ) / sizeof ( acs[0] ) ) ; i++ ) {
                if ( acs[i].last_used < oldest_last_used ) {
                        oldest_last_used = acs[i].last_used;
                        oldest = i;
                }
        }
        acs[oldest].stream = stream;
        acs[oldest].last_used = use;
        return oldest;
}