efi_debug.c File Reference

EFI debugging utilities. More...

#include <stdio.h>
#include <errno.h>
#include <ipxe/base16.h>
#include <ipxe/vsprintf.h>
#include <ipxe/efi/efi.h>
#include <ipxe/efi/efi_path.h>
#include <ipxe/efi/Protocol/ComponentName.h>
#include <ipxe/efi/Protocol/ComponentName2.h>
#include <ipxe/efi/Protocol/DriverBinding.h>
#include <ipxe/efi/Protocol/DevicePathToText.h>
#include <ipxe/efi/IndustryStandard/PeImage.h>

Go to the source code of this file.

Data Structures
struct	efi_handle_name_type
	An EFI handle name type. More...

Macros
#define	EFI_HANDLE_NAME_TYPE(protocol, name)
	Define an EFI handle name type.

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
	EFI_REQUEST_PROTOCOL (EFI_DEVICE_PATH_TO_TEXT_PROTOCOL, &efidpt)
const char *	efi_tpl_name (EFI_TPL tpl)
	Name EFI TPL.
const char *	efi_locate_search_type_name (EFI_LOCATE_SEARCH_TYPE search_type)
	Name locate search type.
const char *	efi_open_attributes_name (unsigned int attributes)
	Name protocol open attributes.
void	dbg_efi_opener (EFI_HANDLE handle, EFI_GUID *protocol, EFI_OPEN_PROTOCOL_INFORMATION_ENTRY *opener)
	Print opened protocol information.
void	dbg_efi_openers (EFI_HANDLE handle, EFI_GUID *protocol)
	Print list of openers of a given protocol on a given handle.
void	dbg_efi_protocol (EFI_HANDLE handle, EFI_GUID *protocol)
	Print protocol information on a given handle.
void	dbg_efi_protocols (EFI_HANDLE handle)
	Print list of protocol handlers attached to a handle.
const char *	efi_devpath_text (EFI_DEVICE_PATH_PROTOCOL *path)
	Get textual representation of device path.
static const char *	efi_driver_name (EFI_COMPONENT_NAME_PROTOCOL *wtf)
	Get driver name.
static const char *	efi_driver_name2 (EFI_COMPONENT_NAME2_PROTOCOL *wtf)
	Get driver name.
static const char *	efi_binding_name (EFI_DRIVER_BINDING_PROTOCOL *binding)
	Get driver binding name.
static const char *	efi_binding_name2 (EFI_DRIVER_BINDING_PROTOCOL *binding)
	Get driver binding name.
static const char *	efi_pecoff_debug_name (EFI_LOADED_IMAGE_PROTOCOL *loaded)
	Get PE/COFF debug filename.
static const char *	efi_first_loaded_image_name (EFI_LOADED_IMAGE_PROTOCOL *loaded)
	Get initial loaded image name.
static const char *	efi_loaded_image_filepath_name (EFI_LOADED_IMAGE_PROTOCOL *loaded)
	Get loaded image name from file path.
static const char *	efi_conin_name (EFI_SIMPLE_TEXT_INPUT_PROTOCOL *input)
	Get console input handle name.
static const char *	efi_conout_name (EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *output)
	Get console output handle name.
const char *	efi_handle_name (EFI_HANDLE handle)
	Get name of an EFI handle.

Variables
static EFI_DEVICE_PATH_TO_TEXT_PROTOCOL *	efidpt
	Device path to text protocol.
static struct efi_handle_name_type	efi_handle_name_types []
	EFI handle name types.

Detailed Description

EFI debugging utilities.

Definition in file efi_debug.c.

Macro Definition Documentation

EFI_HANDLE_NAME_TYPE

#define EFI_HANDLE_NAME_TYPE	(		protocol,
			name )

Value:

        {       \
        (protocol),                                     \
        ( const char * ( * ) ( void * ) ) (name),   \
        }

Define an EFI handle name type.

Parameters

protocol	Protocol interface
name	Method to get name

Return values

type	EFI handle name type

Definition at line 610 of file efi_debug.c.

#define EFI_HANDLE_NAME_TYPE( protocol, name ) {        \
        (protocol),                                     \
        ( const char * ( * ) ( void * ) ) (name),       \
        }

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

EFI_REQUEST_PROTOCOL()

EFI_REQUEST_PROTOCOL	(	EFI_DEVICE_PATH_TO_TEXT_PROTOCOL	,
		&	efidpt )

References efidpt.

efi_tpl_name()

const char * efi_tpl_name

(

EFI_TPL

tpl

)

Name EFI TPL.

Parameters

tpl	Task priority level

Return values

text	Task priority level as text

Definition at line 55 of file efi_debug.c.

                                                                   {
        static char buf[ 19 /* "0xXXXXXXXXXXXXXXXX" + NUL */ ];
 
        switch ( tpl ) {
        case TPL_APPLICATION:            return "Application";
        case TPL_CALLBACK:          return "Callback";
        case TPL_NOTIFY:              return "Notify";
        case TPL_HIGH_LEVEL:              return "HighLevel";
        default:
                snprintf ( buf, sizeof ( buf ), "%#lx",
                           ( unsigned long ) tpl );
                return buf;
        }
}

References snprintf(), TPL_APPLICATION, TPL_CALLBACK, TPL_HIGH_LEVEL, and TPL_NOTIFY.

Referenced by efi_connect(), efi_create_event_ex_wrapper(), efi_create_event_wrapper(), efi_disconnect(), efi_raise_tpl_wrapper(), and efi_restore_tpl_wrapper().

efi_locate_search_type_name()

const char * efi_locate_search_type_name

(

EFI_LOCATE_SEARCH_TYPE

search_type

)

Name locate search type.

Parameters

search_type

Locate search type

Return values

name	Locate search type name

Definition at line 77 of file efi_debug.c.

                                                                   {
        static char buf[16];
 
        switch ( search_type ) {
        case AllHandles :     return "AllHandles";
        case ByRegisterNotify:  return "ByRegisterNotify";
        case ByProtocol:      return "ByProtocol";
        default:
                snprintf ( buf, sizeof ( buf ), "UNKNOWN<%d>", search_type );
                return buf;
        }
}

References AllHandles, ByProtocol, ByRegisterNotify, and snprintf().

Referenced by efi_locate_handle_buffer_wrapper(), and efi_locate_handle_wrapper().

efi_open_attributes_name()

const char * efi_open_attributes_name

(

unsigned int

attributes

)

Name protocol open attributes.

Parameters

attributes

Protocol open attributes

Return values

name	Protocol open attributes name

Returns a (static) string with characters for each set bit corresponding to BY_(H)ANDLE_PROTOCOL, (G)ET_PROTOCOL, (T)EST_PROTOCOL, BY_(C)HILD_CONTROLLER, BY_(D)RIVER, and E(X)CLUSIVE.

Definition at line 102 of file efi_debug.c.

                                                     {
        static char attribute_chars[] = "HGTCDX";
        static char name[ sizeof ( attribute_chars ) ];
        char *tmp = name;
        unsigned int i;
 
        for ( i = 0 ; i < ( sizeof ( attribute_chars ) - 1 ) ; i++ ) {
                if ( attributes & ( 1 << i ) )
                        *(tmp++) = attribute_chars[i];
        }
        *tmp = '\0';
 
        return name;
}

References name, and tmp.

Referenced by dbg_efi_opener(), and efi_open_protocol_wrapper().

dbg_efi_opener()

void dbg_efi_opener	(	EFI_HANDLE	handle,
		EFI_GUID *	protocol,
		EFI_OPEN_PROTOCOL_INFORMATION_ENTRY *	opener )

Print opened protocol information.

Parameters

handle	EFI handle @V protocol Protocol GUID
opener	Opened protocol information

Definition at line 124 of file efi_debug.c.

                                                                    {
 
        printf ( "HANDLE %s %s opened %dx (%s)", efi_handle_name ( handle ),
                 efi_guid_ntoa ( protocol ), opener->OpenCount,
                 efi_open_attributes_name ( opener->Attributes ) );
        printf ( " by %s", efi_handle_name ( opener->AgentHandle ) );
        if ( opener->ControllerHandle == handle ) {
                printf ( "\n" );
        } else {
                printf ( " for %s\n",
                         efi_handle_name ( opener->ControllerHandle ) );
        }
}

References EFI_OPEN_PROTOCOL_INFORMATION_ENTRY::AgentHandle, EFI_OPEN_PROTOCOL_INFORMATION_ENTRY::Attributes, EFI_OPEN_PROTOCOL_INFORMATION_ENTRY::ControllerHandle, efi_guid_ntoa(), EFI_HANDLE, efi_handle_name(), efi_open_attributes_name(), handle, EFI_OPEN_PROTOCOL_INFORMATION_ENTRY::OpenCount, printf(), and protocol.

Referenced by dbg_efi_openers().

dbg_efi_openers()

void dbg_efi_openers	(	EFI_HANDLE	handle,
		EFI_GUID *	protocol )

Print list of openers of a given protocol on a given handle.

Parameters

handle	EFI handle
protocol	Protocol GUID

Definition at line 145 of file efi_debug.c.

                                                               {
        EFI_BOOT_SERVICES *bs = efi_systab->BootServices;
        EFI_OPEN_PROTOCOL_INFORMATION_ENTRY *openers;
        UINTN count;
        unsigned int i;
        EFI_STATUS efirc;
        int rc;
 
        /* Sanity check */
        if ( ( ! handle ) || ( ! protocol ) ) {
                printf ( "HANDLE %s could not retrieve openers for %s\n",
                         efi_handle_name ( handle ),
                         efi_guid_ntoa ( protocol ) );
                return;
        }
 
        /* Retrieve list of openers */
        if ( ( efirc = bs->OpenProtocolInformation ( handle, protocol, &openers,
                                                     &count ) ) != 0 ) {
                rc = -EEFI ( efirc );
                printf ( "HANDLE %s could not retrieve openers for %s: %s\n",
                         efi_handle_name ( handle ),
                         efi_guid_ntoa ( protocol ), strerror ( rc ) );
                return;
        }
 
        /* Dump list of openers */
        for ( i = 0 ; i < count ; i++ )
                dbg_efi_opener ( handle, protocol, &openers[i] );
 
        /* Free list */
        bs->FreePool ( openers );
}

References count, dbg_efi_opener(), EEFI, efi_guid_ntoa(), EFI_HANDLE, efi_handle_name(), efi_systab, EFI_BOOT_SERVICES::FreePool, handle, EFI_BOOT_SERVICES::OpenProtocolInformation, printf(), protocol, rc, and strerror().

Referenced by dbg_efi_protocol().

dbg_efi_protocol()

void dbg_efi_protocol	(	EFI_HANDLE	handle,
		EFI_GUID *	protocol )

Print protocol information on a given handle.

Parameters

handle	EFI handle
protocol	Protocol GUID

Definition at line 185 of file efi_debug.c.

                                                                {
        VOID *interface;
        int rc;
 
        /* Get protocol instance */
        if ( ( rc = efi_open ( handle, protocol, &interface ) ) != 0 ) {
                printf ( "HANDLE %s could not identify %s: %s\n",
                         efi_handle_name ( handle ),
                         efi_guid_ntoa ( protocol ), strerror ( rc ) );
                return;
        }
        printf ( "HANDLE %s %s at %p\n", efi_handle_name ( handle ),
                 efi_guid_ntoa ( protocol ), interface );
 
        /* Dump list of openers */
        dbg_efi_openers ( handle, protocol );
}

References dbg_efi_openers(), efi_guid_ntoa(), EFI_HANDLE, efi_handle_name(), efi_open, handle, printf(), protocol, rc, strerror(), and VOID.

Referenced by dbg_efi_protocols().

dbg_efi_protocols()

void dbg_efi_protocols

(

EFI_HANDLE

handle

)

Print list of protocol handlers attached to a handle.

Parameters

handle

EFI handle

Definition at line 208 of file efi_debug.c.

                                             {
        EFI_BOOT_SERVICES *bs = efi_systab->BootServices;
        EFI_GUID **protocols;
        UINTN count;
        unsigned int i;
        EFI_STATUS efirc;
        int rc;
 
        /* Sanity check */
        if ( ! handle ) {
                printf ( "HANDLE %p could not retrieve protocols\n", handle );
                return;
        }
 
        /* Retrieve list of protocols */
        if ( ( efirc = bs->ProtocolsPerHandle ( handle, &protocols,
                                                &count ) ) != 0 ) {
                rc = -EEFI ( efirc );
                printf ( "HANDLE %s could not retrieve protocols: %s\n",
                         efi_handle_name ( handle ), strerror ( rc ) );
                return;
        }
 
        /* Dump list of protocols */
        for ( i = 0 ; i < count ; i++ ) {
                dbg_efi_protocol ( handle, protocols[i] );
        }
 
        /* Free list */
        bs->FreePool ( protocols );
}

References count, dbg_efi_protocol(), EEFI, EFI_HANDLE, efi_handle_name(), efi_systab, EFI_BOOT_SERVICES::FreePool, handle, printf(), EFI_BOOT_SERVICES::ProtocolsPerHandle, rc, and strerror().

efi_devpath_text()

const char * efi_devpath_text

(

EFI_DEVICE_PATH_PROTOCOL *

path

)

Get textual representation of device path.

Parameters

path	Device path

Return values

text	Textual representation of device path, or NULL

Definition at line 247 of file efi_debug.c.

                                                    {
        EFI_BOOT_SERVICES *bs = efi_systab->BootServices;
        static char text[512];
        size_t len;
        CHAR16 *wtext;
 
        /* Sanity checks */
        if ( ! path ) {
                DBG ( "[NULL DevicePath]" );
                return NULL;
        }
 
        /* If we have no DevicePathToText protocol then use a raw hex string */
        if ( ! efidpt ) {
                DBG ( "[No DevicePathToText]" );
                len = efi_path_len ( path );
                base16_encode ( path, len, text, sizeof ( text ) );
                return text;
        }
 
        /* Convert path to a textual representation */
        wtext = efidpt->ConvertDevicePathToText ( path, FALSE, FALSE );
        if ( ! wtext )
                return NULL;
 
        /* Store path in buffer */
        snprintf ( text, sizeof ( text ), "%ls", wtext );
 
        /* Free path */
        bs->FreePool ( wtext );
 
        return text;
}

References DBG, efi_path_len(), efi_systab, efidpt, FALSE, EFI_BOOT_SERVICES::FreePool, len, NULL, and snprintf().

Referenced by efi_block_exec(), efi_block_hook(), efi_block_match(), efi_connect_controller_wrapper(), efi_driver_start(), efi_driver_supported(), efi_dump_image(), efi_file_path_claim(), efi_file_path_install(), efi_file_path_uninstall(), efi_init(), efi_init_application(), efi_load_image_wrapper(), efi_loaded_image_filepath_name(), efi_local_open_volume(), efi_locate_device(), efi_locate_device_path_wrapper(), efi_path_net_probe(), usbio_open(), and usbio_path().

efi_driver_name()

const char * efi_driver_name ( EFI_COMPONENT_NAME_PROTOCOL * wtf )

static

Get driver name.

Parameters

wtf	Component name protocol

Return values

name	Driver name, or NULL

Definition at line 287 of file efi_debug.c.

                                                                         {
        static char name[64];
        CHAR16 *driver_name;
        EFI_STATUS efirc;
 
        /* Sanity check */
        if ( ! wtf ) {
                DBG ( "[NULL ComponentName]" );
                return NULL;
        }
 
        /* Try "eng" first; if that fails then try the first language */
        if ( ( ( efirc = wtf->GetDriverName ( wtf, "eng",
                                              &driver_name ) ) != 0 ) &&
             ( ( efirc = wtf->GetDriverName ( wtf, wtf->SupportedLanguages,
                                              &driver_name ) ) != 0 ) ) {
                return NULL;
        }
 
        /* Convert name from CHAR16 to char */
        snprintf ( name, sizeof ( name ), "%ls", driver_name );
        return name;
}

References DBG, name, NULL, snprintf(), and wtf.

Referenced by efi_binding_name().

efi_driver_name2()

const char * efi_driver_name2 ( EFI_COMPONENT_NAME2_PROTOCOL * wtf )

static

Get driver name.

Parameters

wtf	Component name protocol

Return values

name	Driver name, or NULL

Definition at line 317 of file efi_debug.c.

                                                                           {
        static char name[64];
        CHAR16 *driver_name;
        EFI_STATUS efirc;
 
        /* Sanity check */
        if ( ! wtf ) {
                DBG ( "[NULL ComponentName2]" );
                return NULL;
        }
 
        /* Try "en" first; if that fails then try the first language */
        if ( ( ( efirc = wtf->GetDriverName ( wtf, "en",
                                              &driver_name ) ) != 0 ) &&
             ( ( efirc = wtf->GetDriverName ( wtf, wtf->SupportedLanguages,
                                              &driver_name ) ) != 0 ) ) {
                return NULL;
        }
 
        /* Convert name from CHAR16 to char */
        snprintf ( name, sizeof ( name ), "%ls", driver_name );
        return name;
}

References DBG, name, NULL, snprintf(), and wtf.

Referenced by efi_binding_name2().

efi_binding_name()

const char * efi_binding_name ( EFI_DRIVER_BINDING_PROTOCOL * binding )

static

Get driver binding name.

Parameters

binding

Driver binding protocol

Return values

name	Driver name, or NULL

Definition at line 347 of file efi_debug.c.

                                                                              {
        EFI_COMPONENT_NAME_PROTOCOL *name;
        EFI_HANDLE image;
        int rc;
 
        /* Sanity check */
        if ( ! binding ) {
                DBG ( "[NULL DriverBinding]" );
                return NULL;
        }
 
        /* Try to open component name protocol on image handle */
        image = binding->ImageHandle;
        if ( ( rc = efi_open ( image, &efi_component_name_protocol_guid,
                               &name ) ) != 0 ) {
                DBG ( "[DriverBinding no ComponentName]" );
                return NULL;
        }
 
        /* Try to get name from component name protocol */
        return efi_driver_name ( name );
}

References DBG, efi_component_name_protocol_guid, efi_driver_name(), EFI_HANDLE, efi_open, _EFI_DRIVER_BINDING_PROTOCOL::ImageHandle, name, NULL, and rc.

efi_binding_name2()

const char * efi_binding_name2 ( EFI_DRIVER_BINDING_PROTOCOL * binding )

static

Get driver binding name.

Parameters

binding

Driver binding protocol

Return values

name	Driver name, or NULL

Definition at line 376 of file efi_debug.c.

                                                                              {
        EFI_HANDLE image;
        EFI_COMPONENT_NAME2_PROTOCOL *name2;
        int rc;
 
        /* Sanity check */
        if ( ! binding ) {
                DBG ( "[NULL DriverBinding]" );
                return NULL;
        }
 
        /* Try to open component name protocol on image handle */
        image = binding->ImageHandle;
        if ( ( rc = efi_open ( image, &efi_component_name2_protocol_guid,
                               &name2 ) ) != 0 ) {
                DBG ( "[DriverBinding no ComponentName2]" );
                return NULL;
        }
 
        /* Try to get name from component name protocol */
        return efi_driver_name2 ( name2 );
}

References DBG, efi_component_name2_protocol_guid, efi_driver_name2(), EFI_HANDLE, efi_open, _EFI_DRIVER_BINDING_PROTOCOL::ImageHandle, NULL, and rc.

efi_pecoff_debug_name()

const char * efi_pecoff_debug_name ( EFI_LOADED_IMAGE_PROTOCOL * loaded )

static

Get PE/COFF debug filename.

Parameters

loaded

Loaded image

Return values

name	PE/COFF debug filename, or NULL

Definition at line 406 of file efi_debug.c.

                                                            {
        static char buf[32];
        EFI_IMAGE_DOS_HEADER *dos;
        EFI_IMAGE_OPTIONAL_HEADER_UNION *pe;
        EFI_IMAGE_OPTIONAL_HEADER32 *opt32;
        EFI_IMAGE_OPTIONAL_HEADER64 *opt64;
        EFI_IMAGE_DATA_DIRECTORY *datadir;
        EFI_IMAGE_DEBUG_DIRECTORY_ENTRY *debug;
        EFI_IMAGE_DEBUG_CODEVIEW_NB10_ENTRY *codeview_nb10;
        EFI_IMAGE_DEBUG_CODEVIEW_RSDS_ENTRY *codeview_rsds;
        EFI_IMAGE_DEBUG_CODEVIEW_MTOC_ENTRY *codeview_mtoc;
        uint16_t dos_magic;
        uint32_t pe_magic;
        uint16_t opt_magic;
        uint32_t codeview_magic;
        size_t max_len;
        char *name;
        char *tmp;
 
        /* Sanity check */
        if ( ! loaded ) {
                DBG ( "[NULL LoadedImage]" );
                return NULL;
        }
 
        /* Parse DOS header */
        dos = loaded->ImageBase;
        if ( ! dos ) {
                DBG ( "[Missing DOS header]" );
                return NULL;
        }
        dos_magic = dos->e_magic;
        if ( dos_magic != EFI_IMAGE_DOS_SIGNATURE ) {
                DBG ( "[Bad DOS signature %#04x]", dos_magic );
                return NULL;
        }
        pe = ( loaded->ImageBase + dos->e_lfanew );
 
        /* Parse PE header */
        pe_magic = pe->Pe32.Signature;
        if ( pe_magic != EFI_IMAGE_NT_SIGNATURE ) {
                DBG ( "[Bad PE signature %#08x]", pe_magic );
                return NULL;
        }
        opt32 = &pe->Pe32.OptionalHeader;
        opt64 = &pe->Pe32Plus.OptionalHeader;
        opt_magic = opt32->Magic;
        if ( opt_magic == EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC ) {
                datadir = opt32->DataDirectory;
        } else if ( opt_magic == EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC ) {
                datadir = opt64->DataDirectory;
        } else {
                DBG ( "[Bad optional header signature %#04x]", opt_magic );
                return NULL;
        }
 
        /* Parse data directory entry */
        if ( ! datadir[EFI_IMAGE_DIRECTORY_ENTRY_DEBUG].VirtualAddress ) {
                DBG ( "[Empty debug directory entry]" );
                return NULL;
        }
        debug = ( loaded->ImageBase +
                  datadir[EFI_IMAGE_DIRECTORY_ENTRY_DEBUG].VirtualAddress );
 
        /* Parse debug directory entry */
        if ( debug->Type != EFI_IMAGE_DEBUG_TYPE_CODEVIEW ) {
                DBG ( "[Not a CodeView debug directory entry (type %d)]",
                      debug->Type );
                return NULL;
        }
        codeview_nb10 = ( loaded->ImageBase + debug->RVA );
        codeview_rsds = ( loaded->ImageBase + debug->RVA );
        codeview_mtoc = ( loaded->ImageBase + debug->RVA );
        codeview_magic = codeview_nb10->Signature;
 
        /* Parse CodeView entry */
        if ( codeview_magic == CODEVIEW_SIGNATURE_NB10 ) {
                name = ( ( void * ) ( codeview_nb10 + 1 ) );
        } else if ( codeview_magic == CODEVIEW_SIGNATURE_RSDS ) {
                name = ( ( void * ) ( codeview_rsds + 1 ) );
        } else if ( codeview_magic == CODEVIEW_SIGNATURE_MTOC ) {
                name = ( ( void * ) ( codeview_mtoc + 1 ) );
        } else {
                DBG ( "[Bad CodeView signature %#08x]", codeview_magic );
                return NULL;
        }
 
        /* Sanity check - avoid scanning endlessly through memory */
        max_len = EFI_PAGE_SIZE; /* Reasonably sane */
        if ( strnlen ( name, max_len ) == max_len ) {
                DBG ( "[Excessively long or invalid CodeView name]" );
                return NULL;
        }
 
        /* Skip any directory components.  We cannot modify this data
         * or create a temporary buffer, so do not use basename().
         */
        while ( ( ( tmp = strchr ( name, '/' ) ) != NULL ) ||
                ( ( tmp = strchr ( name, '\\' ) ) != NULL ) ) {
                name = ( tmp + 1 );
        }
 
        /* Copy base name to buffer */
        snprintf ( buf, sizeof ( buf ), "%s", name );
 
        /* Strip file suffix, if present */
        if ( ( tmp = strrchr ( buf, '.' ) ) != NULL )
                *tmp = '\0';
 
        return buf;
}

References CODEVIEW_SIGNATURE_MTOC, CODEVIEW_SIGNATURE_NB10, CODEVIEW_SIGNATURE_RSDS, EFI_IMAGE_OPTIONAL_HEADER32::DataDirectory, EFI_IMAGE_OPTIONAL_HEADER64::DataDirectory, DBG, debug, EFI_IMAGE_DOS_HEADER::e_lfanew, EFI_IMAGE_DOS_HEADER::e_magic, EFI_IMAGE_DEBUG_TYPE_CODEVIEW, EFI_IMAGE_DIRECTORY_ENTRY_DEBUG, EFI_IMAGE_DOS_SIGNATURE, EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC, EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC, EFI_IMAGE_NT_SIGNATURE, EFI_PAGE_SIZE, EFI_LOADED_IMAGE_PROTOCOL::ImageBase, EFI_IMAGE_OPTIONAL_HEADER32::Magic, name, NULL, EFI_IMAGE_NT_HEADERS32::OptionalHeader, EFI_IMAGE_NT_HEADERS64::OptionalHeader, EFI_IMAGE_OPTIONAL_HEADER_UNION::Pe32, EFI_IMAGE_OPTIONAL_HEADER_UNION::Pe32Plus, EFI_IMAGE_DEBUG_CODEVIEW_NB10_ENTRY::Signature, EFI_IMAGE_NT_HEADERS32::Signature, snprintf(), strchr(), strnlen(), strrchr(), tmp, and EFI_IMAGE_DATA_DIRECTORY::VirtualAddress.

efi_first_loaded_image_name()

const char * efi_first_loaded_image_name ( EFI_LOADED_IMAGE_PROTOCOL * loaded )

static

Get initial loaded image name.

Parameters

loaded

Loaded image

Return values

name	Initial loaded image name, or NULL

Definition at line 525 of file efi_debug.c.

                                                                  {
 
        /* Sanity check */
        if ( ! loaded ) {
                DBG ( "[NULL LoadedImage]" );
                return NULL;
        }
 
        return ( ( loaded->ParentHandle == NULL ) ? "DxeCore(?)" : NULL );
}

References DBG, NULL, and EFI_LOADED_IMAGE_PROTOCOL::ParentHandle.

efi_loaded_image_filepath_name()

const char * efi_loaded_image_filepath_name ( EFI_LOADED_IMAGE_PROTOCOL * loaded )

static

Get loaded image name from file path.

Parameters

loaded

Loaded image

Return values

name	Loaded image name, or NULL

Definition at line 543 of file efi_debug.c.

                                                                     {
 
        /* Sanity check */
        if ( ! loaded ) {
                DBG ( "[NULL LoadedImage]" );
                return NULL;
        }
 
        return efi_devpath_text ( loaded->FilePath );
}

References DBG, efi_devpath_text(), EFI_LOADED_IMAGE_PROTOCOL::FilePath, and NULL.

efi_conin_name()

const char * efi_conin_name ( EFI_SIMPLE_TEXT_INPUT_PROTOCOL * input )

static

Get console input handle name.

Parameters

input

Simple text input protocol

Return values

name	Console input handle name, or NULL

Definition at line 561 of file efi_debug.c.

                                                         {
 
        /* Check for match against ConIn */
        if ( input == efi_systab->ConIn )
                return "ConIn";
 
        return NULL;
}

References efi_systab, and NULL.

efi_conout_name()

const char * efi_conout_name ( EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL * output )

static

Get console output handle name.

Parameters

output

Simple text output protocol

Return values

name	Console output handle name, or NULL

Definition at line 577 of file efi_debug.c.

                                                            {
 
        /* Check for match against ConOut */
        if ( output == efi_systab->ConOut )
                return "ConOut";
 
        /* Check for match against StdErr (if different from ConOut) */
        if ( output == efi_systab->StdErr )
                return "StdErr";
 
        return NULL;
}

References efi_systab, and NULL.

efi_handle_name()

const char * efi_handle_name

(

EFI_HANDLE

handle

)

Get name of an EFI handle.

Parameters

handle

EFI handle

Return values

text	Name of handle, or NULL

Definition at line 652 of file efi_debug.c.

                                                                            {
        EFI_BOOT_SERVICES *bs = efi_systab->BootServices;
        struct efi_handle_name_type *type;
        static char buf[256];
        size_t used = 0;
        EFI_GUID **protocols;
        UINTN count;
        unsigned int i;
        void *interface;
        const char *name;
        EFI_STATUS efirc;
        int rc;
 
        /* Fail immediately for NULL handles */
        if ( ! handle )
                return NULL;
 
        /* Try each name type in turn */
        for ( i = 0 ; i < ( sizeof ( efi_handle_name_types ) /
                            sizeof ( efi_handle_name_types[0] ) ) ; i++ ) {
                type = &efi_handle_name_types[i];
                DBG2 ( "<%d", i );
 
                /* Try to open the applicable protocol */
                if ( ( rc = efi_open ( handle, type->protocol,
                                       &interface ) ) != 0 ) {
                        DBG2 ( ">" );
                        continue;
                }
 
                /* Try to get name from this protocol */
                DBG2 ( "-" );
                name = type->name ( interface );
                DBG2 ( "%c>", ( name ? ( name[0] ? 'Y' : 'E' ) : 'N' ) );
 
                /* Use this name, if possible */
                if ( name && name[0] )
                        return name;
        }
 
        /* If no name is found, then use the raw handle value and a
         * list of installed protocols.
         */
        used = ssnprintf ( buf, sizeof ( buf ), "UNKNOWN<%p", handle );
        if ( ( efirc = bs->ProtocolsPerHandle ( handle, &protocols,
                                                &count ) ) == 0 ) {
                for ( i = 0 ; i < count ; i++ ) {
                        used += ssnprintf ( ( buf + used ),
                                            ( sizeof ( buf ) - used ), ",%s",
                                            efi_guid_ntoa ( protocols[i] ) );
                }
                bs->FreePool ( protocols );
        }
        used += ssnprintf ( ( buf + used ), ( sizeof ( buf ) - used ), ">" );
        return buf;
}

References count, DBG2, efi_guid_ntoa(), EFI_HANDLE, efi_handle_name_types, efi_open, efi_systab, EFI_BOOT_SERVICES::FreePool, handle, name, NULL, EFI_BOOT_SERVICES::ProtocolsPerHandle, rc, ssnprintf(), and type.

Referenced by chained_locate(), chained_supported(), dbg_efi_opener(), dbg_efi_openers(), dbg_efi_protocol(), dbg_efi_protocols(), efi_autoexec_filesystem(), efi_autoexec_load(), efi_autoexec_network(), efi_block_boot(), efi_block_filename(), efi_block_hook(), efi_block_local(), efi_block_match(), efi_block_root(), efi_bofm_start(), efi_bofm_supported(), efi_cachedhcp_record(), efi_child_add(), efi_child_del(), efi_close_protocol_wrapper(), efi_connect(), efi_connect_controller_wrapper(), efi_device_info(), efi_device_info_pci(), efi_disconnect(), efi_disconnect_controller_wrapper(), efi_driver_connect(), efi_driver_exclude(), efi_driver_start(), efi_driver_stop(), efi_driver_supported(), efi_dump_image(), efi_exit_boot_services_wrapper(), efi_exit_wrapper(), efi_file_path_claim(), efi_handle_protocol_wrapper(), efi_install_multiple_protocol_interfaces_wrapper(), efi_install_protocol_interface_wrapper(), efi_load_image_wrapper(), efi_local_check_volume_name(), efi_local_open_root(), efi_local_open_volume(), efi_locate_device(), efi_locate_device_path_wrapper(), efi_locate_handle_buffer_wrapper(), efi_locate_handle_wrapper(), efi_open_protocol_information_wrapper(), efi_open_protocol_wrapper(), efi_protocols_per_handle_wrapper(), efi_pxe_install(), efi_pxe_uninstall(), efi_reinstall_protocol_interface_wrapper(), efi_service_add(), efi_service_del(), efi_set_autoboot_ll_addr(), efi_snp_probe(), efi_start_image_wrapper(), efi_uninstall_multiple_protocol_interfaces_wrapper(), efi_uninstall_protocol_interface_wrapper(), efi_unload_image_wrapper(), efi_usb_install(), efi_usb_uninstall(), efi_veto(), efi_veto_close(), efi_veto_close_handle(), efi_veto_close_protocol(), efi_veto_destroy(), efi_veto_disconnect(), efi_veto_find(), efi_veto_uninstall(), efi_veto_unload(), efidev_alloc(), efipci_discover_one(), efipci_exclude(), efipci_info(), efipci_root_open(), efipci_start(), mnpnet_start(), mnptemp_create(), nii_exclude(), nii_start(), snpnet_exclude(), snpnet_insomniac_patch(), snpnet_insomniac_restore(), snpnet_is_insomniac(), snpnet_start(), snpnet_stop(), snpnet_supported(), usbio_bulk_in_poll(), usbio_bulk_out_poll(), usbio_config(), usbio_control_poll(), usbio_endpoint_open(), usbio_exclude(), usbio_interface(), usbio_interfaces(), usbio_interrupt_callback(), usbio_interrupt_open(), usbio_open(), usbio_path(), usbio_start(), and usbio_supported().

Variable Documentation

efidpt

EFI_DEVICE_PATH_TO_TEXT_PROTOCOL* efidpt

static

Device path to text protocol.

Definition at line 46 of file efi_debug.c.

Referenced by efi_devpath_text(), and EFI_REQUEST_PROTOCOL().

efi_handle_name_types

struct efi_handle_name_type efi_handle_name_types[]

static

Initial value:

= {
        
        EFI_HANDLE_NAME_TYPE ( &efi_driver_binding_protocol_guid,
                               efi_binding_name2 ),
        
        EFI_HANDLE_NAME_TYPE ( &efi_driver_binding_protocol_guid,
                               efi_binding_name ),
        
        EFI_HANDLE_NAME_TYPE ( &efi_loaded_image_protocol_guid,
                               efi_pecoff_debug_name ),
        
        EFI_HANDLE_NAME_TYPE ( &efi_loaded_image_device_path_protocol_guid,
                               efi_devpath_text ),
        
        EFI_HANDLE_NAME_TYPE ( &efi_loaded_image_protocol_guid,
                               efi_first_loaded_image_name ),
        
        EFI_HANDLE_NAME_TYPE ( &efi_loaded_image_protocol_guid,
                               efi_loaded_image_filepath_name ),
        
        EFI_HANDLE_NAME_TYPE ( &efi_device_path_protocol_guid,
                               efi_devpath_text ),
        
        EFI_HANDLE_NAME_TYPE ( &efi_simple_text_input_protocol_guid,
                               efi_conin_name ),
        
        EFI_HANDLE_NAME_TYPE ( &efi_simple_text_output_protocol_guid,
                               efi_conout_name ),
}

EFI handle name types.

Definition at line 616 of file efi_debug.c.

                                                             {
        /* Driver name (for driver binding handles) */
        EFI_HANDLE_NAME_TYPE ( &efi_driver_binding_protocol_guid,
                               efi_binding_name2 ),
        /* Driver name (via obsolete original ComponentName protocol) */
        EFI_HANDLE_NAME_TYPE ( &efi_driver_binding_protocol_guid,
                               efi_binding_name ),
        /* PE/COFF debug filename (for image handles) */
        EFI_HANDLE_NAME_TYPE ( &efi_loaded_image_protocol_guid,
                               efi_pecoff_debug_name ),
        /* Loaded image device path (for image handles) */
        EFI_HANDLE_NAME_TYPE ( &efi_loaded_image_device_path_protocol_guid,
                               efi_devpath_text ),
        /* First loaded image name (for the DxeCore image) */
        EFI_HANDLE_NAME_TYPE ( &efi_loaded_image_protocol_guid,
                               efi_first_loaded_image_name ),
        /* Handle's loaded image file path (for image handles) */
        EFI_HANDLE_NAME_TYPE ( &efi_loaded_image_protocol_guid,
                               efi_loaded_image_filepath_name ),
        /* Device path */
        EFI_HANDLE_NAME_TYPE ( &efi_device_path_protocol_guid,
                               efi_devpath_text ),
        /* Our standard input file handle */
        EFI_HANDLE_NAME_TYPE ( &efi_simple_text_input_protocol_guid,
                               efi_conin_name ),
        /* Our standard output and standard error file handles */
        EFI_HANDLE_NAME_TYPE ( &efi_simple_text_output_protocol_guid,
                               efi_conout_name ),
};

Referenced by efi_handle_name().