disklog.c File Reference

Disk log console. More...

#include <assert.h>
#include <errno.h>
#include <string.h>
#include <ipxe/disklog.h>

Go to the source code of this file.

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
	FILE_SECBOOT (PERMITTED)
int	disklog_open (struct disklog *disklog)
	Open disk log console.
void	disklog_putchar (struct disklog *disklog, int character)
	Write character to disk log console.

Detailed Description

Disk log console.

Definition in file disklog.c.

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

FILE_SECBOOT()

FILE_SECBOOT

(

PERMITTED

)

disklog_open()

int disklog_open

(

struct disklog *

disklog

)

Open disk log console.

Parameters

disklog

Disk log

Return values

rc	Return status code

The data buffer must already contain the initial logical block.

Definition at line 46 of file disklog.c.

                                             {
        struct disklog_header *hdr =
                ( ( struct disklog_header * ) disklog->buffer );
 
        /* Sanity checks */
        assert ( disklog->console != NULL );
        assert ( disklog->buffer != NULL );
        assert ( disklog->blksize > 0 );
        assert ( ( disklog->blksize & ( disklog->blksize - 1 ) ) == 0 );
        assert ( disklog->lba <= disklog->max_lba );
        assert ( disklog->op != NULL );
        assert ( disklog->op->write != NULL );
 
        /* Check magic signature */
        if ( ( disklog->blksize < sizeof ( *hdr ) ) ||
             ( memcmp ( hdr->magic, DISKLOG_MAGIC,
                        sizeof ( hdr->magic ) ) != 0 ) ) {
                DBGC ( disklog, "DISKLOG has bad magic signature\n" );
                return -EINVAL;
        }
 
        /* Initialise buffer */
        disklog->offset = sizeof ( *hdr );
        disklog->unwritten = 0;
        memset ( ( disklog->buffer + sizeof ( *hdr ) ), 0,
                 ( disklog->blksize - sizeof ( *hdr ) ) );
 
        /* Enable console */
        disklog->console->disabled = 0;
 
        return 0;
}

References assert, disklog::blksize, disklog::buffer, disklog::console, DBGC, console_driver::disabled, DISKLOG_MAGIC, EINVAL, hdr, disklog::lba, disklog::max_lba, memcmp(), memset(), NULL, disklog::offset, disklog::op, disklog::unwritten, and disklog_operations::write.

Referenced by efi_disklog_open(), and int13con_find().

disklog_putchar()

void disklog_putchar	(	struct disklog *	disklog,
		int	character )

Write character to disk log console.

Parameters

disklog	Disk log
character	Character

Definition at line 85 of file disklog.c.

                                                                {
        static int busy;
        int rc;
 
        /* Ignore if we are already mid-logging */
        if ( busy )
                return;
        busy = 1;
 
        /* Sanity checks */
        assert ( disklog->offset < disklog->blksize );
 
        /* Write character to buffer */
        disklog->buffer[disklog->offset++] = character;
        disklog->unwritten++;
 
        /* Write sector to disk, if applicable */
        if ( ( disklog->offset == disklog->blksize ) ||
             ( disklog->unwritten == DISKLOG_MAX_UNWRITTEN ) ||
             ( character == '\n' ) ) {
 
                /* Write sector to disk */
                if ( ( rc = disklog->op->write() ) != 0 ) {
                        DBGC ( disklog, "DISKLOG could not write: %s\n",
                               strerror ( rc ) );
                        /* Ignore and continue; there's nothing we can do */
                }
 
                /* Reset count of unwritten characters */
                disklog->unwritten = 0;
        }
 
        /* Move to next sector, if applicable */
        if ( disklog->offset == disklog->blksize ) {
 
                /* Disable console if we have run out of space */
                if ( disklog->lba >= disklog->max_lba )
                        disklog->console->disabled = 1;
 
                /* Clear log buffer */
                memset ( disklog->buffer, 0, disklog->blksize );
                disklog->offset = 0;
 
                /* Move to next sector */
                disklog->lba++;
        }
 
        /* Clear busy flag */
        busy = 0;
}

References assert, disklog::blksize, disklog::buffer, disklog::console, DBGC, console_driver::disabled, DISKLOG_MAX_UNWRITTEN, disklog::lba, disklog::max_lba, memset(), disklog::offset, disklog::op, rc, strerror(), disklog::unwritten, and disklog_operations::write.

Referenced by efi_disklog_putchar(), and int13con_putchar().