efi_wrap.c

Go to the documentation of this file.

/*
 * Copyright (C) 2014 Michael Brown <mbrown@fensystems.co.uk>.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation; either version 2 of the
 * License, or any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 * 02110-1301, USA.
 *
 * You can also choose to distribute this program under the terms of
 * the Unmodified Binary Distribution Licence (as given in the file
 * COPYING.UBDL), provided that you have satisfied its requirements.
 */

FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );

/**
 * @file
 *
 * EFI image wrapping
 *
 */

#include <string.h>
#include <stdio.h>
#include <errno.h>
#include <ipxe/efi/efi.h>
#include <ipxe/efi/Protocol/LoadedImage.h>
#include <ipxe/efi/efi_wrap.h>

/** Colour for debug messages */
#define colour &efi_systab

/** Maximum size for hex dumps */
#define EFI_WRAP_DUMP_MAX 128

/** Number of lines to prescroll when needed */
#define EFI_WRAP_PRESCROLL 16

/** Public EFI system table pointer */
static EFI_SYSTEM_TABLE *efi_systab_pub;

/** Private EFI system table used while wrapping is active */
static EFI_SYSTEM_TABLE efi_systab_priv;

/** Original EFI boot services table pointer */
static EFI_BOOT_SERVICES *efi_bs_orig;

/** Backup of original EFI boot services table */
static EFI_BOOT_SERVICES efi_bs_copy;

/** Original EFI runtime services table pointer */
static EFI_RUNTIME_SERVICES *efi_rs_orig;

/** Backup of original EFI runtime services table */
static EFI_RUNTIME_SERVICES efi_rs_copy;

/**
 * Convert EFI status code to text
 *
 * @v efirc             EFI status code
 * @ret text            EFI status code text
 */
static const char * efi_status ( EFI_STATUS efirc ) {
        static char buf[ 19 /* "0xXXXXXXXXXXXXXXXX" + NUL */ ];

        switch ( efirc ) {
        case EFI_SUCCESS :                      return "0";
        case EFI_LOAD_ERROR :                   return "LOAD_ERROR";
        case EFI_INVALID_PARAMETER :            return "INVALID_PARAMETER";
        case EFI_UNSUPPORTED :                  return "UNSUPPORTED";
        case EFI_BAD_BUFFER_SIZE :              return "BAD_BUFFER_SIZE";
        case EFI_BUFFER_TOO_SMALL :             return "BUFFER_TOO_SMALL";
        case EFI_NOT_READY :                    return "NOT_READY";
        case EFI_DEVICE_ERROR :                 return "DEVICE_ERROR";
        case EFI_WRITE_PROTECTED :              return "WRITE_PROTECTED";
        case EFI_OUT_OF_RESOURCES :             return "OUT_OF_RESOURCES";
        case EFI_VOLUME_CORRUPTED :             return "VOLUME_CORRUPTED";
        case EFI_VOLUME_FULL :                  return "VOLUME_FULL";
        case EFI_NO_MEDIA :                     return "NO_MEDIA";
        case EFI_MEDIA_CHANGED :                return "MEDIA_CHANGED";
        case EFI_NOT_FOUND :                    return "NOT_FOUND";
        case EFI_ACCESS_DENIED :                return "ACCESS_DENIED";
        case EFI_NO_RESPONSE :                  return "NO_RESPONSE";
        case EFI_NO_MAPPING :                   return "NO_MAPPING";
        case EFI_TIMEOUT :                      return "TIMEOUT";
        case EFI_NOT_STARTED :                  return "NOT_STARTED";
        case EFI_ALREADY_STARTED :              return "ALREADY_STARTED";
        case EFI_ABORTED :                      return "ABORTED";
        case EFI_ICMP_ERROR :                   return "ICMP_ERROR";
        case EFI_TFTP_ERROR :                   return "TFTP_ERROR";
        case EFI_PROTOCOL_ERROR :               return "PROTOCOL_ERROR";
        case EFI_INCOMPATIBLE_VERSION :         return "INCOMPATIBLE_VERSION";
        case EFI_SECURITY_VIOLATION :           return "SECURITY_VIOLATION";
        case EFI_CRC_ERROR :                    return "CRC_ERROR";
        case EFI_END_OF_MEDIA :                 return "END_OF_MEDIA";
        case EFI_END_OF_FILE :                  return "END_OF_FILE";
        case EFI_INVALID_LANGUAGE :             return "INVALID_LANGUAGE";
        case EFI_COMPROMISED_DATA :             return "COMPROMISED_DATA";
        case EFI_WARN_UNKNOWN_GLYPH :           return "WARN_UNKNOWN_GLYPH";
        case EFI_WARN_DELETE_FAILURE :          return "WARN_DELETE_FAILURE";
        case EFI_WARN_WRITE_FAILURE :           return "WARN_WRITE_FAILURE";
        case EFI_WARN_BUFFER_TOO_SMALL :        return "WARN_BUFFER_TOO_SMALL";
        case EFI_WARN_STALE_DATA :              return "WARN_STALE_DATA";
        default:
                snprintf ( buf, sizeof ( buf ), "%#lx",
                           ( unsigned long ) efirc );
                return buf;
        }
}

/**
 * Convert EFI boolean to text
 *
 * @v boolean           Boolean value
 * @ret text            Boolean value text
 */
static const char * efi_boolean ( BOOLEAN boolean ) {

        return ( boolean ? "TRUE" : "FALSE" );
}

/**
 * Convert EFI allocation type to text
 *
 * @v type              Allocation type
 * @ret text            Allocation type as text
 */
static const char * efi_allocate_type ( EFI_ALLOCATE_TYPE type ) {
        static char buf[ 11 /* "0xXXXXXXXX" + NUL */ ];

        switch ( type ) {
        case AllocateAnyPages:          return "AnyPages";
        case AllocateMaxAddress:        return "MaxAddress";
        case AllocateAddress:           return "Address";
        default:
                snprintf ( buf, sizeof ( buf ), "%#x", type );
                return buf;
        }
}

/**
 * Convert EFI memory type to text
 *
 * @v type              Memory type
 * @ret text            Memory type as text
 */
static const char * efi_memory_type ( EFI_MEMORY_TYPE type ) {
        static char buf[ 11 /* "0xXXXXXXXX" + NUL */ ];

        switch ( type ) {
        case EfiReservedMemoryType:     return "Reserved";
        case EfiLoaderCode:             return "LoaderCode";
        case EfiLoaderData:             return "LoaderData";
        case EfiBootServicesCode:       return "BootCode";
        case EfiBootServicesData:       return "BootData";
        case EfiRuntimeServicesCode:    return "RuntimeCode";
        case EfiRuntimeServicesData:    return "RuntimeData";
        case EfiConventionalMemory:     return "Conventional";
        case EfiUnusableMemory:         return "Unusable";
        case EfiACPIReclaimMemory:      return "ACPIReclaim";
        case EfiACPIMemoryNVS:          return "ACPINVS";
        case EfiMemoryMappedIO:         return "MMIO";
        case EfiMemoryMappedIOPortSpace:return "PIO";
        case EfiPalCode:                return "PalCode";
        case EfiPersistentMemory:       return "Persistent";
        default:
                snprintf ( buf, sizeof ( buf ), "%#x", type );
                return buf;
        }
}

/**
 * Convert EFI timer delay type to text
 *
 * @v type              Timer delay type
 * @ret text            Timer delay type as text
 */
static const char * efi_timer_delay ( EFI_TIMER_DELAY type ) {
        static char buf[ 11 /* "0xXXXXXXXX" + NUL */ ];

        switch ( type ) {
        case TimerCancel:               return "Cancel";
        case TimerPeriodic:             return "Periodic";
        case TimerRelative:             return "Relative";
        default:
                snprintf ( buf, sizeof ( buf ), "%#x", type );
                return buf;
        }
}

/**
 * Convert EFI time to text
 *
 * @v time              Time, or NULL
 * @ret text            Time as text
 */
static const char * efi_time ( EFI_TIME *time ) {
        static char buf[ 20 /* "xxxx-xx-xx xx:xx:xx" + NUL */ ];

        if ( ! time )
                return "<NULL>";
        snprintf ( buf, sizeof ( buf ), "%04d-%02d-%02d %02d:%02d:%02d",
                   time->Year, time->Month, time->Day, time->Hour,
                   time->Minute, time->Second );
        return buf;
}

/**
 * Convert EFI reset type to text
 *
 * @v type              Reset type
 * @ret text            Reset type as text
 */
static const char * efi_reset_type ( EFI_RESET_TYPE type ) {
        static char buf[ 11 /* "0xXXXXXXXX" + NUL */ ];

        switch ( type ) {
        case EfiResetCold:              return "Cold";
        case EfiResetWarm:              return "Warm";
        case EfiResetShutdown:          return "Shutdown";
        case EfiResetPlatformSpecific:  return "PlatformSpecific";
        default:
                snprintf ( buf, sizeof ( buf ), "%#x", type );
                return buf;
        }
}

/**
 * Pre-scroll display to create space for output lines
 *
 * @v lines             Number of lines required
 * @ret efirc           EFI status code
 */
static int efi_prescroll ( unsigned int lines ) {
        EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *conout = efi_systab->ConOut;
        UINTN columns;
        UINTN rows;
        UINTN space;
        EFI_STATUS efirc;

        /* Get number of rows and columns */
        if ( ( efirc = conout->QueryMode ( conout, conout->Mode->Mode,
                                           &columns, &rows ) ) != 0 )
                return efirc;

        /* Calculate available space */
        space = ( rows - conout->Mode->CursorRow - 1 );

        /* Scroll to create space */
        while ( space++ < lines )
                conout->OutputString ( conout, L"\n" );

        /* Move cursor to start of space */
        conout->SetCursorPosition ( conout, 0,
                                    ( conout->Mode->CursorRow - lines ) );

        return 0;
}

/**
 * Dump information about a loaded image
 *
 * @v handle            Image handle
 */
static void efi_dump_image ( EFI_HANDLE handle ) {
        EFI_LOADED_IMAGE_PROTOCOL *loaded;
        int rc;

        /* Open loaded image protocol */
        if ( ( rc = efi_open ( handle, &efi_loaded_image_protocol_guid,
                               &loaded ) ) != 0 ) {
                DBGC ( colour, "WRAP %s could not get loaded image protocol: "
                       "%s\n", efi_handle_name ( handle ), strerror ( rc ) );
                return;
        }

        /* Dump image information */
        DBGC ( colour, "WRAP %s at base %p has protocols:\n",
               efi_handle_name ( handle ), loaded->ImageBase );
        DBGC_EFI_PROTOCOLS ( colour, handle );
        DBGC ( colour, "WRAP %s parent", efi_handle_name ( handle ) );
        DBGC ( colour, " %s\n", efi_handle_name ( loaded->ParentHandle ) );
        DBGC ( colour, "WRAP %s device", efi_handle_name ( handle ) );
        DBGC ( colour, " %s\n", efi_handle_name ( loaded->DeviceHandle ) );
        DBGC ( colour, "WRAP %s file", efi_handle_name ( handle ) );
        DBGC ( colour, " %s\n", efi_devpath_text ( loaded->FilePath ) );
}

/**
 * Wrap RaiseTPL()
 *
 */
static EFI_TPL EFIAPI
efi_raise_tpl_wrapper ( EFI_TPL new_tpl ) {
        EFI_BOOT_SERVICES *bs = efi_systab->BootServices;
        void *retaddr = __builtin_return_address ( 0 );
        EFI_TPL old_tpl;

        DBGCP ( colour, "RaiseTPL ( %s ) ", efi_tpl_name ( new_tpl ) );
        old_tpl = bs->RaiseTPL ( new_tpl );
        DBGCP ( colour, "= %s -> %p\n", efi_tpl_name ( old_tpl ), retaddr );
        return old_tpl;
}

/**
 * Wrap RestoreTPL()
 *
 */
static VOID EFIAPI
efi_restore_tpl_wrapper ( EFI_TPL old_tpl ) {
        EFI_BOOT_SERVICES *bs = efi_systab->BootServices;
        void *retaddr = __builtin_return_address ( 0 );

        DBGCP ( colour, "RestoreTPL ( %s ) ", efi_tpl_name ( old_tpl ) );
        bs->RestoreTPL ( old_tpl );
        DBGCP ( colour, "-> %p\n", retaddr );
}

/**
 * Wrap AllocatePages()
 *
 */
static EFI_STATUS EFIAPI
efi_allocate_pages_wrapper ( EFI_ALLOCATE_TYPE type,
                             EFI_MEMORY_TYPE memory_type, UINTN pages,
                             EFI_PHYSICAL_ADDRESS *memory ) {
        EFI_BOOT_SERVICES *bs = efi_systab->BootServices;
        void *retaddr = __builtin_return_address ( 0 );
        EFI_STATUS efirc;

        DBGC2 ( colour, "AllocatePages ( %s, %s, %#llx, %#llx ) ",
                efi_allocate_type ( type ), efi_memory_type ( memory_type ),
                ( ( unsigned long long ) pages ),
                ( ( unsigned long long ) *memory ) );
        efirc = bs->AllocatePages ( type, memory_type, pages, memory );
        DBGC2 ( colour, "= %s ( %#llx ) -> %p\n", efi_status ( efirc ),
                ( ( unsigned long long ) *memory ), retaddr );
        return efirc;
}

/**
 * Wrap FreePages()
 *
 */
static EFI_STATUS EFIAPI
efi_free_pages_wrapper ( EFI_PHYSICAL_ADDRESS memory, UINTN pages ) {
        EFI_BOOT_SERVICES *bs = efi_systab->BootServices;
        void *retaddr = __builtin_return_address ( 0 );
        EFI_STATUS efirc;

        DBGC2 ( colour, "FreePages ( %#llx, %#llx ) ",
                ( ( unsigned long long ) memory ),
                ( ( unsigned long long ) pages ) );
        efirc = bs->FreePages ( memory, pages );
        DBGC2 ( colour, "= %s -> %p\n", efi_status ( efirc ), retaddr );
        return efirc;
}

/**
 * Wrap GetMemoryMap()
 *
 */
static EFI_STATUS EFIAPI
efi_get_memory_map_wrapper ( UINTN *memory_map_size,
                             EFI_MEMORY_DESCRIPTOR *memory_map, UINTN *map_key,
                             UINTN *descriptor_size,
                             UINT32 *descriptor_version ) {
        EFI_BOOT_SERVICES *bs = efi_systab->BootServices;
        void *retaddr = __builtin_return_address ( 0 );
        EFI_MEMORY_DESCRIPTOR *desc;
        size_t remaining;
        EFI_STATUS efirc;

        DBGC ( colour, "GetMemoryMap ( %#llx, %p ) ",
               ( ( unsigned long long ) *memory_map_size ), memory_map );
        efirc = bs->GetMemoryMap ( memory_map_size, memory_map, map_key,
                                   descriptor_size, descriptor_version );
        DBGC ( colour, "= %s ( %#llx, %#llx, %#llx, v%d",
               efi_status ( efirc ),
               ( ( unsigned long long ) *memory_map_size ),
               ( ( unsigned long long ) *map_key ),
               ( ( unsigned long long ) *descriptor_size ),
               *descriptor_version );
        if ( DBG_EXTRA && ( efirc == 0 ) ) {
                DBGC2 ( colour, ",\n" );
                for ( desc = memory_map, remaining = *memory_map_size ;
                      remaining >= *descriptor_size ;
                      desc = ( ( ( void * ) desc ) + *descriptor_size ),
                      remaining -= *descriptor_size ) {
                        DBGC2 ( colour, "%#016llx+%#08llx %#016llx "
                                "%s\n", desc->PhysicalStart,
                                ( desc->NumberOfPages * EFI_PAGE_SIZE ),
                                desc->Attribute,
                                efi_memory_type ( desc->Type ) );
                }
        } else {
                DBGC ( colour, " " );
        }
        DBGC ( colour, ") -> %p\n", retaddr );
        return efirc;
}

/**
 * Wrap AllocatePool()
 *
 */
static EFI_STATUS EFIAPI
efi_allocate_pool_wrapper ( EFI_MEMORY_TYPE pool_type, UINTN size,
                            VOID **buffer ) {
        EFI_BOOT_SERVICES *bs = efi_systab->BootServices;
        void *retaddr = __builtin_return_address ( 0 );
        EFI_STATUS efirc;

        DBGC2 ( colour, "AllocatePool ( %s, %#llx ) ",
                efi_memory_type ( pool_type ),
                ( ( unsigned long long ) size ) );
        efirc = bs->AllocatePool ( pool_type, size, buffer );
        DBGC2 ( colour, "= %s ( %p ) -> %p\n",
                efi_status ( efirc ), *buffer, retaddr );
        return efirc;
}

/**
 * Wrap FreePool()
 *
 */
static EFI_STATUS EFIAPI
efi_free_pool_wrapper ( VOID *buffer ) {
        EFI_BOOT_SERVICES *bs = efi_systab->BootServices;
        void *retaddr = __builtin_return_address ( 0 );
        EFI_STATUS efirc;

        DBGC2 ( colour, "FreePool ( %p ) ", buffer );
        efirc = bs->FreePool ( buffer );
        DBGC2 ( colour, "= %s -> %p\n", efi_status ( efirc ), retaddr );
        return efirc;
}

/**
 * Wrap CreateEvent()
 *
 */
static EFI_STATUS EFIAPI
efi_create_event_wrapper ( UINT32 type, EFI_TPL notify_tpl,
                           EFI_EVENT_NOTIFY notify_function,
                           VOID *notify_context, EFI_EVENT *event ) {
        EFI_BOOT_SERVICES *bs = efi_systab->BootServices;
        void *retaddr = __builtin_return_address ( 0 );
        EFI_STATUS efirc;

        DBGC ( colour, "CreateEvent ( %#x, %s, %p, %p ) ", type,
               efi_tpl_name ( notify_tpl ), notify_function, notify_context );
        efirc = bs->CreateEvent ( type, notify_tpl, notify_function,
                                  notify_context, event );
        DBGC ( colour, "= %s ( %p ) -> %p\n",
               efi_status ( efirc ), *event, retaddr );
        return efirc;
}

/**
 * Wrap SetTimer()
 *
 */
static EFI_STATUS EFIAPI
efi_set_timer_wrapper ( EFI_EVENT event, EFI_TIMER_DELAY type,
                        UINT64 trigger_time ) {
        EFI_BOOT_SERVICES *bs = efi_systab->BootServices;
        void *retaddr = __builtin_return_address ( 0 );
        EFI_STATUS efirc;

        DBGC ( colour, "SetTimer ( %p, %s, %ld.%07ld00s ) ",
               event, efi_timer_delay ( type ),
               ( ( unsigned long ) ( trigger_time / 10000000 ) ),
               ( ( unsigned long ) ( trigger_time % 10000000 ) ) );
        efirc = bs->SetTimer ( event, type, trigger_time );
        DBGC ( colour, "= %s -> %p\n", efi_status ( efirc ), retaddr );
        return efirc;
}

/**
 * Wrap WaitForEvent()
 *
 */
static EFI_STATUS EFIAPI
efi_wait_for_event_wrapper ( UINTN number_of_events, EFI_EVENT *event,
                             UINTN *index ) {
        EFI_BOOT_SERVICES *bs = efi_systab->BootServices;
        void *retaddr = __builtin_return_address ( 0 );
        unsigned int i;
        EFI_STATUS efirc;

        DBGC ( colour, "WaitForEvent (" );
        for ( i = 0 ; i < number_of_events ; i++ )
                DBGC ( colour, " %p", event[i] );
        DBGC ( colour, " ) " );
        efirc = bs->WaitForEvent ( number_of_events, event, index );
        DBGC ( colour, "= %s", efi_status ( efirc ) );
        if ( efirc == 0 )
                DBGC ( colour, " ( %p )", event[*index] );
        DBGC ( colour, " -> %p\n", retaddr );
        return efirc;
}

/**
 * Wrap SignalEvent()
 *
 */
static EFI_STATUS EFIAPI
efi_signal_event_wrapper ( EFI_EVENT event ) {
        EFI_BOOT_SERVICES *bs = efi_systab->BootServices;
        void *retaddr = __builtin_return_address ( 0 );
        EFI_STATUS efirc;

        DBGC2 ( colour, "SignalEvent ( %p ) ", event );
        efirc = bs->SignalEvent ( event );
        DBGC2 ( colour, "= %s -> %p\n", efi_status ( efirc ), retaddr );
        return efirc;
}

/**
 * Wrap CloseEvent()
 *
 */
static EFI_STATUS EFIAPI
efi_close_event_wrapper ( EFI_EVENT event ) {
        EFI_BOOT_SERVICES *bs = efi_systab->BootServices;
        void *retaddr = __builtin_return_address ( 0 );
        EFI_STATUS efirc;

        DBGC ( colour, "CloseEvent ( %p ) ", event );
        efirc = bs->CloseEvent ( event );
        DBGC ( colour, "= %s -> %p\n", efi_status ( efirc ), retaddr );
        return efirc;
}
/**
 * Wrap CheckEvent()
 *
 */
static EFI_STATUS EFIAPI
efi_check_event_wrapper ( EFI_EVENT event ) {
        EFI_BOOT_SERVICES *bs = efi_systab->BootServices;
        void *retaddr = __builtin_return_address ( 0 );
        EFI_STATUS efirc;

        DBGCP ( colour, "CheckEvent ( %p ) ", event );
        efirc = bs->CheckEvent ( event );
        DBGCP ( colour, "= %s -> %p\n", efi_status ( efirc ), retaddr );
        return efirc;
}

/**
 * Wrap InstallProtocolInterface()
 *
 */
static EFI_STATUS EFIAPI
efi_install_protocol_interface_wrapper ( EFI_HANDLE *handle, EFI_GUID *protocol,
                                         EFI_INTERFACE_TYPE interface_type,
                                         VOID *interface ) {
        EFI_BOOT_SERVICES *bs = efi_systab->BootServices;
        void *retaddr = __builtin_return_address ( 0 );
        EFI_STATUS efirc;

        DBGC ( colour, "InstallProtocolInterface ( %s, %s, %d, %p ) ",
               efi_handle_name ( *handle ), efi_guid_ntoa ( protocol ),
               interface_type, interface );
        efirc = bs->InstallProtocolInterface ( handle, protocol, interface_type,
                                               interface );
        DBGC ( colour, "= %s ( %s ) -> %p\n",
               efi_status ( efirc ), efi_handle_name ( *handle ), retaddr );
        return efirc;
}

/**
 * Wrap ReinstallProtocolInterface()
 *
 */
static EFI_STATUS EFIAPI
efi_reinstall_protocol_interface_wrapper ( EFI_HANDLE handle,
                                           EFI_GUID *protocol,
                                           VOID *old_interface,
                                           VOID *new_interface ) {
        EFI_BOOT_SERVICES *bs = efi_systab->BootServices;
        void *retaddr = __builtin_return_address ( 0 );
        EFI_STATUS efirc;

        DBGC ( colour, "ReinstallProtocolInterface ( %s, %s, %p, %p ) ",
               efi_handle_name ( handle ), efi_guid_ntoa ( protocol ),
               old_interface, new_interface );
        efirc = bs->ReinstallProtocolInterface ( handle, protocol,
                                                 old_interface, new_interface );
        DBGC ( colour, "= %s -> %p\n", efi_status ( efirc ), retaddr );
        return efirc;
}

/**
 * Wrap UninstallProtocolInterface()
 *
 */
static EFI_STATUS EFIAPI
efi_uninstall_protocol_interface_wrapper ( EFI_HANDLE handle,
                                           EFI_GUID *protocol,
                                           VOID *interface ) {
        EFI_BOOT_SERVICES *bs = efi_systab->BootServices;
        void *retaddr = __builtin_return_address ( 0 );
        EFI_STATUS efirc;

        DBGC ( colour, "UninstallProtocolInterface ( %s, %s, %p ) ",
               efi_handle_name ( handle ), efi_guid_ntoa ( protocol ),
               interface );
        efirc = bs->UninstallProtocolInterface ( handle, protocol, interface );
        DBGC ( colour, "= %s -> %p\n", efi_status ( efirc ), retaddr );
        return efirc;
}

/**
 * Wrap HandleProtocol()
 *
 */
static EFI_STATUS EFIAPI
efi_handle_protocol_wrapper ( EFI_HANDLE handle, EFI_GUID *protocol,
                              VOID **interface ) {
        EFI_BOOT_SERVICES *bs = efi_systab->BootServices;
        void *retaddr = __builtin_return_address ( 0 );
        EFI_STATUS efirc;

        DBGC ( colour, "HandleProtocol ( %s, %s ) ",
               efi_handle_name ( handle ), efi_guid_ntoa ( protocol ) );
        efirc = bs->HandleProtocol ( handle, protocol, interface );
        DBGC ( colour, "= %s ( %p ) -> %p\n",
               efi_status ( efirc ), *interface, retaddr );
        return efirc;
}

/**
 * Wrap RegisterProtocolNotify()
 *
 */
static EFI_STATUS EFIAPI
efi_register_protocol_notify_wrapper ( EFI_GUID *protocol, EFI_EVENT event,
                                       VOID **registration ) {
        EFI_BOOT_SERVICES *bs = efi_systab->BootServices;
        void *retaddr = __builtin_return_address ( 0 );
        EFI_STATUS efirc;

        DBGC ( colour, "RegisterProtocolNotify ( %s, %p ) ",
               efi_guid_ntoa ( protocol ), event );
        efirc = bs->RegisterProtocolNotify ( protocol, event, registration );
        DBGC ( colour, "= %s ( %p ) -> %p\n",
               efi_status ( efirc ), *registration, retaddr );
        return efirc;
}

/**
 * Wrap LocateHandle()
 *
 */
static EFI_STATUS EFIAPI
efi_locate_handle_wrapper ( EFI_LOCATE_SEARCH_TYPE search_type,
                            EFI_GUID *protocol, VOID *search_key,
                            UINTN *buffer_size, EFI_HANDLE *buffer ) {
        EFI_BOOT_SERVICES *bs = efi_systab->BootServices;
        void *retaddr = __builtin_return_address ( 0 );
        unsigned int i;
        EFI_STATUS efirc;

        DBGC ( colour, "LocateHandle ( %s, %s, %p, %zd ) ",
               efi_locate_search_type_name ( search_type ),
               efi_guid_ntoa ( protocol ), search_key,
               ( ( size_t ) *buffer_size ) );
        efirc = bs->LocateHandle ( search_type, protocol, search_key,
                                   buffer_size, buffer );
        DBGC ( colour, "= %s ( %zd", efi_status ( efirc ),
               ( ( size_t ) *buffer_size ) );
        if ( efirc == 0 ) {
                DBGC ( colour, ", {" );
                for ( i = 0; i < ( *buffer_size / sizeof ( buffer[0] ) ); i++ ){
                        DBGC ( colour, "%s%s", ( i ? ", " : " " ),
                               efi_handle_name ( buffer[i] ) );
                }
                DBGC ( colour, " }" );
        }
        DBGC ( colour, " ) -> %p\n", retaddr );
        return efirc;
}

/**
 * Wrap LocateDevicePath()
 *
 */
static EFI_STATUS EFIAPI
efi_locate_device_path_wrapper ( EFI_GUID *protocol,
                                 EFI_DEVICE_PATH_PROTOCOL **device_path,
                                 EFI_HANDLE *device ) {
        EFI_BOOT_SERVICES *bs = efi_systab->BootServices;
        void *retaddr = __builtin_return_address ( 0 );
        EFI_STATUS efirc;

        DBGC ( colour, "LocateDevicePath ( %s, %s ) ",
               efi_guid_ntoa ( protocol ), efi_devpath_text ( *device_path ) );
        efirc = bs->LocateDevicePath ( protocol, device_path, device );
        DBGC ( colour, "= %s ( %s, ",
               efi_status ( efirc ), efi_devpath_text ( *device_path ) );
        DBGC ( colour, "%s ) -> %p\n", efi_handle_name ( *device ), retaddr );
        return efirc;
}

/**
 * Wrap InstallConfigurationTable()
 *
 */
static EFI_STATUS EFIAPI
efi_install_configuration_table_wrapper ( EFI_GUID *guid, VOID *table ) {
        EFI_BOOT_SERVICES *bs = efi_systab->BootServices;
        void *retaddr = __builtin_return_address ( 0 );
        EFI_STATUS efirc;

        DBGC ( colour, "InstallConfigurationTable ( %s, %p ) ",
               efi_guid_ntoa ( guid ), table );
        efirc = bs->InstallConfigurationTable ( guid, table );
        DBGC ( colour, "= %s -> %p\n", efi_status ( efirc ), retaddr );
        return efirc;
}

/**
 * Wrap LoadImage()
 *
 */
static EFI_STATUS EFIAPI
efi_load_image_wrapper ( BOOLEAN boot_policy, EFI_HANDLE parent_image_handle,
                         EFI_DEVICE_PATH_PROTOCOL *device_path,
                         VOID *source_buffer, UINTN source_size,
                         EFI_HANDLE *image_handle ) {
        EFI_BOOT_SERVICES *bs = efi_systab->BootServices;
        void *retaddr = __builtin_return_address ( 0 );
        EFI_STATUS efirc;

        DBGC ( colour, "LoadImage ( %s, %s, ", efi_boolean ( boot_policy ),
               efi_handle_name ( parent_image_handle ) );
        DBGC ( colour, "%s, %p, %#llx ) ",
               efi_devpath_text ( device_path ), source_buffer,
               ( ( unsigned long long ) source_size ) );
        efirc = bs->LoadImage ( boot_policy, parent_image_handle, device_path,
                                source_buffer, source_size, image_handle );
        DBGC ( colour, "= %s ( ", efi_status ( efirc ) );
        if ( efirc == 0 )
                DBGC ( colour, "%s ", efi_handle_name ( *image_handle ) );
        DBGC ( colour, ") -> %p\n", retaddr );

        /* Dump information about loaded image */
        if ( efirc == 0 )
                efi_dump_image ( *image_handle );

        return efirc;
}

/**
 * Wrap StartImage()
 *
 */
static EFI_STATUS EFIAPI
efi_start_image_wrapper ( EFI_HANDLE image_handle, UINTN *exit_data_size,
                          CHAR16 **exit_data ) {
        EFI_BOOT_SERVICES *bs = efi_systab->BootServices;
        void *retaddr = __builtin_return_address ( 0 );
        EFI_STATUS efirc;

        DBGC ( colour, "StartImage ( %s ) ", efi_handle_name ( image_handle ) );
        efirc = bs->StartImage ( image_handle, exit_data_size, exit_data );
        DBGC ( colour, "= %s", efi_status ( efirc ) );
        if ( ( efirc != 0 ) && exit_data && *exit_data_size )
                DBGC ( colour, " ( \"%ls\" )", *exit_data );
        DBGC ( colour, " -> %p\n", retaddr );
        if ( ( efirc != 0 ) && exit_data && *exit_data_size )
                DBGC_HD ( colour, *exit_data, *exit_data_size );
        return efirc;
}

/**
 * Wrap Exit()
 *
 */
static EFI_STATUS EFIAPI
efi_exit_wrapper ( EFI_HANDLE image_handle, EFI_STATUS exit_status,
                   UINTN exit_data_size, CHAR16 *exit_data ) {
        EFI_BOOT_SERVICES *bs = efi_systab->BootServices;
        void *retaddr = __builtin_return_address ( 0 );
        EFI_STATUS efirc;

        if ( ( exit_status != 0 ) && exit_data && exit_data_size )
                DBGC_HD ( colour, exit_data, exit_data_size );
        DBGC ( colour, "Exit ( %s, %s",
               efi_handle_name ( image_handle ), efi_status ( exit_status ) );
        if ( ( exit_status != 0 ) && exit_data && exit_data_size )
                DBGC ( colour, ", \"%ls\"", exit_data );
        DBGC ( colour, " ) " );
        efirc = bs->Exit ( image_handle, exit_status, exit_data_size,
                           exit_data );
        DBGC ( colour, "= %s -> %p\n", efi_status ( efirc ), retaddr );
        return efirc;
}

/**
 * Wrap UnloadImage()
 *
 */
static EFI_STATUS EFIAPI
efi_unload_image_wrapper ( EFI_HANDLE image_handle ) {
        EFI_BOOT_SERVICES *bs = efi_systab->BootServices;
        void *retaddr = __builtin_return_address ( 0 );
        EFI_STATUS efirc;

        DBGC ( colour, "UnloadImage ( %s ) ",
               efi_handle_name ( image_handle ) );
        efirc = bs->UnloadImage ( image_handle );
        DBGC ( colour, "= %s -> %p\n", efi_status ( efirc ), retaddr );
        return efirc;
}

/**
 * Wrap ExitBootServices()
 *
 */
static EFI_STATUS EFIAPI
efi_exit_boot_services_wrapper ( EFI_HANDLE image_handle, UINTN map_key ) {
        EFI_BOOT_SERVICES *bs = efi_systab->BootServices;
        void *retaddr = __builtin_return_address ( 0 );
        EFI_STATUS efirc;

        DBGC ( colour, "ExitBootServices ( %s, %#llx ) -> %p\n",
               efi_handle_name ( image_handle ),
               ( ( unsigned long long ) map_key ), retaddr );
        efirc = bs->ExitBootServices ( image_handle, map_key );
        if ( efirc != 0 ) {
                DBGC ( colour, "ExitBootServices ( ... ) = %s -> %p\n",
                       efi_status ( efirc ), retaddr );
                /* On some systems, scrolling the output will cause
                 * the system memory map to change (and so cause
                 * ExitBootServices() to fail).
                 *
                 * After the first failed attempt, prescroll the
                 * screen to maximise the chance of the subsequent
                 * attempt succeeding.
                 */
                efi_prescroll ( EFI_WRAP_PRESCROLL );
        }
        return efirc;
}

/**
 * Wrap GetNextMonotonicCount()
 *
 */
static EFI_STATUS EFIAPI
efi_get_next_monotonic_count_wrapper ( UINT64 *count ) {
        EFI_BOOT_SERVICES *bs = efi_systab->BootServices;
        void *retaddr = __builtin_return_address ( 0 );
        EFI_STATUS efirc;

        DBGCP ( colour, "GetNextMonotonicCount() " );
        efirc = bs->GetNextMonotonicCount ( count );
        DBGCP ( colour, "= %s ( %#llx ) -> %p\n",
                efi_status ( efirc ), *count, retaddr );
        return efirc;
}

/**
 * Wrap Stall()
 *
 */
static EFI_STATUS EFIAPI
efi_stall_wrapper ( UINTN microseconds ) {
        EFI_BOOT_SERVICES *bs = efi_systab->BootServices;
        void *retaddr = __builtin_return_address ( 0 );
        EFI_STATUS efirc;

        DBGCP ( colour, "Stall ( %ld.%06lds ) ",
                ( ( unsigned long ) ( microseconds / 1000000 ) ),
                ( ( unsigned long ) ( microseconds % 1000000 ) ) );
        efirc = bs->Stall ( microseconds );
        DBGCP ( colour, "= %s -> %p\n", efi_status ( efirc ), retaddr );
        return efirc;
}

/**
 * Wrap SetWatchdogTimer()
 *
 */
static EFI_STATUS EFIAPI
efi_set_watchdog_timer_wrapper ( UINTN timeout, UINT64 watchdog_code,
                                 UINTN data_size, CHAR16 *watchdog_data ) {
        EFI_BOOT_SERVICES *bs = efi_systab->BootServices;
        void *retaddr = __builtin_return_address ( 0 );
        EFI_STATUS efirc;

        DBGC ( colour, "SetWatchdogTimer ( %lds, %#llx, %#llx, %p ) ",
               ( ( unsigned long ) timeout ), watchdog_code,
               ( ( unsigned long long ) data_size ), watchdog_data );
        efirc = bs->SetWatchdogTimer ( timeout, watchdog_code, data_size,
                                       watchdog_data );
        DBGC ( colour, "= %s -> %p\n", efi_status ( efirc ), retaddr );
        return efirc;
}

/**
 * Wrap ConnectController()
 *
 */
static EFI_STATUS EFIAPI
efi_connect_controller_wrapper ( EFI_HANDLE controller_handle,
                                 EFI_HANDLE *driver_image_handle,
                                 EFI_DEVICE_PATH_PROTOCOL *remaining_path,
                                 BOOLEAN recursive ) {
        EFI_BOOT_SERVICES *bs = efi_systab->BootServices;
        void *retaddr = __builtin_return_address ( 0 );
        EFI_HANDLE *tmp;
        EFI_STATUS efirc;

        DBGC ( colour, "ConnectController ( %s, {",
               efi_handle_name ( controller_handle ) );
        if ( driver_image_handle ) {
                for ( tmp = driver_image_handle ; *tmp ; tmp++ ) {
                        DBGC ( colour, "%s%s",
                               ( ( tmp == driver_image_handle ) ? " " : ", " ),
                               efi_handle_name ( *tmp ) );
                }
        }
        DBGC ( colour, " }, %s, %s ) ", efi_devpath_text ( remaining_path ),
               efi_boolean ( recursive ) );
        efirc = bs->ConnectController ( controller_handle, driver_image_handle,
                                        remaining_path, recursive );
        DBGC ( colour, "= %s -> %p\n", efi_status ( efirc ), retaddr );
        return efirc;
}

/**
 * Wrap DisconnectController()
 *
 */
static EFI_STATUS EFIAPI
efi_disconnect_controller_wrapper ( EFI_HANDLE controller_handle,
                                    EFI_HANDLE driver_image_handle,
                                    EFI_HANDLE child_handle ) {
        EFI_BOOT_SERVICES *bs = efi_systab->BootServices;
        void *retaddr = __builtin_return_address ( 0 );
        EFI_STATUS efirc;

        DBGC ( colour, "DisconnectController ( %s",
               efi_handle_name ( controller_handle ) );
        DBGC ( colour, ", %s", efi_handle_name ( driver_image_handle ) );
        DBGC ( colour, ", %s ) ", efi_handle_name ( child_handle ) );
        efirc = bs->DisconnectController ( controller_handle,
                                           driver_image_handle,
                                           child_handle );
        DBGC ( colour, "= %s -> %p\n", efi_status ( efirc ), retaddr );
        return efirc;
}

/**
 * Wrap OpenProtocol()
 *
 */
static EFI_STATUS EFIAPI
efi_open_protocol_wrapper ( EFI_HANDLE handle, EFI_GUID *protocol,
                            VOID **interface, EFI_HANDLE agent_handle,
                            EFI_HANDLE controller_handle, UINT32 attributes ) {
        EFI_BOOT_SERVICES *bs = efi_systab->BootServices;
        void *retaddr = __builtin_return_address ( 0 );
        EFI_STATUS efirc;

        DBGC ( colour, "OpenProtocol ( %s, %s, ",
               efi_handle_name ( handle ), efi_guid_ntoa ( protocol ) );
        DBGC ( colour, "%s, ", efi_handle_name ( agent_handle ) );
        DBGC ( colour, "%s, %s ) ", efi_handle_name ( controller_handle ),
               efi_open_attributes_name ( attributes ) );
        efirc = bs->OpenProtocol ( handle, protocol, interface, agent_handle,
                                   controller_handle, attributes );
        DBGC ( colour, "= %s ( %p ) -> %p\n",
               efi_status ( efirc ), *interface, retaddr );
        return efirc;
}

/**
 * Wrap CloseProtocol()
 *
 */
static EFI_STATUS EFIAPI
efi_close_protocol_wrapper ( EFI_HANDLE handle, EFI_GUID *protocol,
                             EFI_HANDLE agent_handle,
                             EFI_HANDLE controller_handle ) {
        EFI_BOOT_SERVICES *bs = efi_systab->BootServices;
        void *retaddr = __builtin_return_address ( 0 );
        EFI_STATUS efirc;

        DBGC ( colour, "CloseProtocol ( %s, %s, ",
               efi_handle_name ( handle ), efi_guid_ntoa ( protocol ) );
        DBGC ( colour, "%s, ", efi_handle_name ( agent_handle ) );
        DBGC ( colour, "%s ) ", efi_handle_name ( controller_handle ) );
        efirc = bs->CloseProtocol ( handle, protocol, agent_handle,
                                    controller_handle );
        DBGC ( colour, "= %s -> %p\n",
               efi_status ( efirc ), retaddr );
        return efirc;
}

/**
 * Wrap OpenProtocolInformation()
 *
 */
static EFI_STATUS EFIAPI
efi_open_protocol_information_wrapper ( EFI_HANDLE handle, EFI_GUID *protocol,
                                        EFI_OPEN_PROTOCOL_INFORMATION_ENTRY
                                        **entry_buffer,
                                        UINTN *entry_count ) {
        EFI_BOOT_SERVICES *bs = efi_systab->BootServices;
        void *retaddr = __builtin_return_address ( 0 );
        EFI_STATUS efirc;

        DBGC ( colour, "OpenProtocolInformation ( %s, %s ) ",
               efi_handle_name ( handle ), efi_guid_ntoa ( protocol ) );
        efirc = bs->OpenProtocolInformation ( handle, protocol, entry_buffer,
                                              entry_count );
        DBGC ( colour, "= %s ( %p, %#llx ) -> %p\n",
               efi_status ( efirc ), *entry_buffer,
               ( ( unsigned long long ) *entry_count ), retaddr );
        return efirc;
}

/**
 * Wrap ProtocolsPerHandle()
 *
 */
static EFI_STATUS EFIAPI
efi_protocols_per_handle_wrapper ( EFI_HANDLE handle,
                                   EFI_GUID ***protocol_buffer,
                                   UINTN *protocol_buffer_count ) {
        EFI_BOOT_SERVICES *bs = efi_systab->BootServices;
        void *retaddr = __builtin_return_address ( 0 );
        unsigned int i;
        EFI_STATUS efirc;

        DBGC ( colour, "ProtocolsPerHandle ( %s ) ",
               efi_handle_name ( handle ) );
        efirc = bs->ProtocolsPerHandle ( handle, protocol_buffer,
                                         protocol_buffer_count );
        DBGC ( colour, "= %s", efi_status ( efirc ) );
        if ( efirc == 0 ) {
                DBGC ( colour, " ( {" );
                for ( i = 0 ; i < *protocol_buffer_count ; i++ ) {
                        DBGC ( colour, "%s%s", ( i ? ", " : " " ),
                               efi_guid_ntoa ( (*protocol_buffer)[i] ) );
                }
                DBGC ( colour, " } )" );
        }
        DBGC ( colour, " -> %p\n", retaddr );
        return efirc;
}

/**
 * Wrap LocateHandleBuffer()
 *
 */
static EFI_STATUS EFIAPI
efi_locate_handle_buffer_wrapper ( EFI_LOCATE_SEARCH_TYPE search_type,
                                   EFI_GUID *protocol, VOID *search_key,
                                   UINTN *no_handles, EFI_HANDLE **buffer ) {
        EFI_BOOT_SERVICES *bs = efi_systab->BootServices;
        void *retaddr = __builtin_return_address ( 0 );
        unsigned int i;
        EFI_STATUS efirc;

        DBGC ( colour, "LocateHandleBuffer ( %s, %s, %p ) ",
               efi_locate_search_type_name ( search_type ),
               efi_guid_ntoa ( protocol ), search_key );
        efirc = bs->LocateHandleBuffer ( search_type, protocol, search_key,
                                         no_handles, buffer );
        DBGC ( colour, "= %s", efi_status ( efirc ) );
        if ( efirc == 0 ) {
                DBGC ( colour, " ( %d, {", ( ( unsigned int ) *no_handles ) );
                for ( i = 0 ; i < *no_handles ; i++ ) {
                        DBGC ( colour, "%s%s", ( i ? ", " : " " ),
                               efi_handle_name ( (*buffer)[i] ) );
                }
                DBGC ( colour, " } )" );
        }
        DBGC ( colour, " -> %p\n", retaddr );
        return efirc;
}

/**
 * Wrap LocateProtocol()
 *
 */
static EFI_STATUS EFIAPI
efi_locate_protocol_wrapper ( EFI_GUID *protocol, VOID *registration,
                              VOID **interface ) {
        EFI_BOOT_SERVICES *bs = efi_systab->BootServices;
        void *retaddr = __builtin_return_address ( 0 );
        EFI_STATUS efirc;

        DBGC ( colour, "LocateProtocol ( %s, %p ) ",
               efi_guid_ntoa ( protocol ), registration );
        efirc = bs->LocateProtocol ( protocol, registration, interface );
        DBGC ( colour, "= %s ( %p ) -> %p\n",
               efi_status ( efirc ), *interface, retaddr );
        return efirc;
}

/** Maximum number of interfaces for wrapped ...MultipleProtocolInterfaces() */
#define MAX_WRAP_MULTI 20

/**
 * Wrap InstallMultipleProtocolInterfaces()
 *
 */
static EFI_STATUS EFIAPI
efi_install_multiple_protocol_interfaces_wrapper ( EFI_HANDLE *handle, ... ) {
        EFI_BOOT_SERVICES *bs = efi_systab->BootServices;
        void *retaddr = __builtin_return_address ( 0 );
        EFI_GUID *protocol[ MAX_WRAP_MULTI + 1 ];
        VOID *interface[MAX_WRAP_MULTI];
        VA_LIST ap;
        unsigned int i;
        EFI_STATUS efirc;

        DBGC ( colour, "InstallMultipleProtocolInterfaces ( %s",
               efi_handle_name ( *handle ) );
        memset ( protocol, 0, sizeof ( protocol ) );
        memset ( interface, 0, sizeof ( interface ) );
        VA_START ( ap, handle );
        for ( i = 0 ; ( protocol[i] = VA_ARG ( ap, EFI_GUID * ) ) ; i++ ) {
                if ( i == MAX_WRAP_MULTI ) {
                        VA_END ( ap );
                        efirc = EFI_OUT_OF_RESOURCES;
                        DBGC ( colour, "<FATAL: too many arguments> ) = %s "
                               "-> %p\n", efi_status ( efirc ), retaddr );
                        return efirc;
                }
                interface[i] = VA_ARG ( ap, VOID * );
                DBGC ( colour, ", %s, %p",
                       efi_guid_ntoa ( protocol[i] ), interface[i] );
        }
        VA_END ( ap );
        DBGC ( colour, " ) " );
        efirc = bs->InstallMultipleProtocolInterfaces ( handle,
                protocol[0], interface[0], protocol[1], interface[1],
                protocol[2], interface[2], protocol[3], interface[3],
                protocol[4], interface[4], protocol[5], interface[5],
                protocol[6], interface[6], protocol[7], interface[7],
                protocol[8], interface[8], protocol[9], interface[9],
                protocol[10], interface[10], protocol[11], interface[11],
                protocol[12], interface[12], protocol[13], interface[13],
                protocol[14], interface[14], protocol[15], interface[15],
                protocol[16], interface[16], protocol[17], interface[17],
                protocol[18], interface[18], protocol[19], interface[19],
                NULL );
        DBGC ( colour, "= %s ( %s ) -> %p\n",
               efi_status ( efirc ), efi_handle_name ( *handle ), retaddr );
        return efirc;
}

/**
 * Wrap UninstallMultipleProtocolInterfaces()
 *
 */
static EFI_STATUS EFIAPI
efi_uninstall_multiple_protocol_interfaces_wrapper ( EFI_HANDLE handle, ... ) {
        EFI_BOOT_SERVICES *bs = efi_systab->BootServices;
        void *retaddr = __builtin_return_address ( 0 );
        EFI_GUID *protocol[ MAX_WRAP_MULTI  + 1 ];
        VOID *interface[MAX_WRAP_MULTI];
        VA_LIST ap;
        unsigned int i;
        EFI_STATUS efirc;

        DBGC ( colour, "UninstallMultipleProtocolInterfaces ( %s",
               efi_handle_name ( handle ) );
        memset ( protocol, 0, sizeof ( protocol ) );
        memset ( interface, 0, sizeof ( interface ) );
        VA_START ( ap, handle );
        for ( i = 0 ; ( protocol[i] = VA_ARG ( ap, EFI_GUID * ) ) ; i++ ) {
                if ( i == MAX_WRAP_MULTI ) {
                        VA_END ( ap );
                        efirc = EFI_OUT_OF_RESOURCES;
                        DBGC ( colour, "<FATAL: too many arguments> ) = %s "
                               "-> %p\n", efi_status ( efirc ), retaddr );
                        return efirc;
                }
                interface[i] = VA_ARG ( ap, VOID * );
                DBGC ( colour, ", %s, %p",
                       efi_guid_ntoa ( protocol[i] ), interface[i] );
        }
        VA_END ( ap );
        DBGC ( colour, " ) " );
        efirc = bs->UninstallMultipleProtocolInterfaces ( handle,
                protocol[0], interface[0], protocol[1], interface[1],
                protocol[2], interface[2], protocol[3], interface[3],
                protocol[4], interface[4], protocol[5], interface[5],
                protocol[6], interface[6], protocol[7], interface[7],
                protocol[8], interface[8], protocol[9], interface[9],
                protocol[10], interface[10], protocol[11], interface[11],
                protocol[12], interface[12], protocol[13], interface[13],
                protocol[14], interface[14], protocol[15], interface[15],
                protocol[16], interface[16], protocol[17], interface[17],
                protocol[18], interface[18], protocol[19], interface[19],
                NULL );
        DBGC ( colour, "= %s -> %p\n",
               efi_status ( efirc ), retaddr );
        return efirc;
}

/**
 * Wrap CreateEventEx()
 *
 */
static EFI_STATUS EFIAPI
efi_create_event_ex_wrapper ( UINT32 type, EFI_TPL notify_tpl,
                              EFI_EVENT_NOTIFY notify_function,
                              CONST VOID *notify_context,
                              CONST EFI_GUID *event_group, EFI_EVENT *event ) {
        EFI_BOOT_SERVICES *bs = efi_systab->BootServices;
        void *retaddr = __builtin_return_address ( 0 );
        EFI_STATUS efirc;

        DBGC ( colour, "CreateEventEx ( %#x, %s, %p, %p, %s ) ",
               type, efi_tpl_name ( notify_tpl ), notify_function,
               notify_context, efi_guid_ntoa ( event_group ) );
        efirc = bs->CreateEventEx ( type, notify_tpl, notify_function,
                                    notify_context, event_group, event );
        DBGC ( colour, "= %s ( %p ) -> %p\n",
               efi_status ( efirc ), *event, retaddr );
        return efirc;
}

/**
 * Wrap GetTime()
 *
 */
static EFI_STATUS EFIAPI
efi_get_time_wrapper ( EFI_TIME *time, EFI_TIME_CAPABILITIES *cap ) {
        EFI_RUNTIME_SERVICES *rs = efi_systab->RuntimeServices;
        void *retaddr = __builtin_return_address ( 0 );
        EFI_STATUS efirc;

        DBGCP ( colour, "GetTime() " );
        efirc = rs->GetTime ( time, cap );
        DBGCP ( colour, "= %s ( %s ) -> %p\n",
                efi_status ( efirc ), efi_time ( time ), retaddr );
        return efirc;
}

/**
 * Wrap SetTime()
 *
 */
static EFI_STATUS EFIAPI
efi_set_time_wrapper ( EFI_TIME *time ) {
        EFI_RUNTIME_SERVICES *rs = efi_systab->RuntimeServices;
        void *retaddr = __builtin_return_address ( 0 );
        EFI_STATUS efirc;

        DBGC ( colour, "SetTime ( %s ) ", efi_time ( time ) );
        efirc = rs->SetTime ( time );
        DBGC ( colour, "= %s -> %p\n", efi_status ( efirc ), retaddr );
        return efirc;
}

/**
 * Wrap GetWakeupTime()
 *
 */
static EFI_STATUS EFIAPI
efi_get_wakeup_time_wrapper ( BOOLEAN *enabled, BOOLEAN *pending,
                              EFI_TIME *time ) {
        EFI_RUNTIME_SERVICES *rs = efi_systab->RuntimeServices;
        void *retaddr = __builtin_return_address ( 0 );
        EFI_STATUS efirc;

        DBGC ( colour, "GetWakeupTime() " );
        efirc = rs->GetWakeupTime ( enabled, pending, time );
        DBGC ( colour, "= %s ( %s, %s, %s ) -> %p\n", efi_status ( efirc ),
               efi_boolean ( *enabled ), efi_boolean ( *pending ),
               efi_time ( time ), retaddr );
        return efirc;
}

/**
 * Wrap SetWakeupTime()
 *
 */
static EFI_STATUS EFIAPI
efi_set_wakeup_time_wrapper ( BOOLEAN enable, EFI_TIME *time ) {
        EFI_RUNTIME_SERVICES *rs = efi_systab->RuntimeServices;
        void *retaddr = __builtin_return_address ( 0 );
        EFI_STATUS efirc;

        DBGC ( colour, "SetWakeupTime ( %s, %s ) ",
               efi_boolean ( enable ), efi_time ( time ) );
        efirc = rs->SetWakeupTime ( enable, time );
        DBGC ( colour, "= %s -> %p\n", efi_status ( efirc ), retaddr );
        return efirc;
}

/**
 * Wrap GetVariable()
 *
 */
static EFI_STATUS EFIAPI
efi_get_variable_wrapper ( CHAR16 *name, EFI_GUID *guid, UINT32 *attrs,
                           UINTN *len, VOID *data ) {
        EFI_RUNTIME_SERVICES *rs = efi_systab->RuntimeServices;
        void *retaddr = __builtin_return_address ( 0 );
        size_t dumplen;
        EFI_STATUS efirc;

        DBGC ( colour, "GetVariable ( %s:%ls, %#llx ) ",
               efi_guid_ntoa ( guid ), name, ( ( unsigned long long ) *len ) );
        efirc = rs->GetVariable ( name, guid, attrs, len, data );
        DBGC ( colour, "= %s ( %#llx",
               efi_status ( efirc ), ( ( unsigned long long ) *len ) );
        if ( DBG_EXTRA && ( efirc == 0 ) ) {
                dumplen = *len;
                if ( dumplen > EFI_WRAP_DUMP_MAX )
                        dumplen = EFI_WRAP_DUMP_MAX;
                DBGC2 ( colour, ",\n" );
                DBGC2_HD ( colour, data, dumplen );
                if ( dumplen != *len )
                        DBGC2 ( colour, "... " );
        } else {
                DBGC ( colour, " " );
        }
        DBGC ( colour, ") -> %p\n", retaddr );
        return efirc;
}

/**
 * Wrap GetNextVariableName()
 *
 */
static EFI_STATUS EFIAPI
efi_get_next_variable_name_wrapper ( UINTN *len, CHAR16 *name,
                                     EFI_GUID *guid ) {
        EFI_RUNTIME_SERVICES *rs = efi_systab->RuntimeServices;
        void *retaddr = __builtin_return_address ( 0 );
        EFI_STATUS efirc;

        DBGC ( colour, "GetNextVariableName ( %#llx, %s:%ls ) ",
               ( ( unsigned long long ) *len ), efi_guid_ntoa ( guid ), name );
        efirc = rs->GetNextVariableName ( len, name, guid );
        DBGC ( colour, "= %s ( %#llx, %s:%ls ) -> %p\n", efi_status ( efirc ),
               ( ( unsigned long long ) *len ), efi_guid_ntoa ( guid ), name,
               retaddr );
        return efirc;
}

/**
 * Wrap SetVariable()
 *
 */
static EFI_STATUS EFIAPI
efi_set_variable_wrapper ( CHAR16 *name, EFI_GUID *guid, UINT32 attrs,
                           UINTN len, VOID *data ) {
        EFI_RUNTIME_SERVICES *rs = efi_systab->RuntimeServices;
        void *retaddr = __builtin_return_address ( 0 );
        EFI_STATUS efirc;

        DBGC ( colour, "SetVariable ( %s:%ls, %#02x",
               efi_guid_ntoa ( guid ), name, attrs );
        if ( len ) {
                DBGC ( colour, ",\n" );
                DBGC_HD ( colour, data, len );
                DBGC ( colour, ") " );
        } else {
                DBGC ( colour, ", %#llx, %p ) ",
                       ( ( unsigned long long ) len ), data );
        }
        efirc = rs->SetVariable ( name, guid, attrs, len, data );
        DBGC ( colour, "= %s -> %p\n", efi_status ( efirc ), retaddr );
        return efirc;
}

/**
 * Wrap ResetSystem()
 *
 */
static VOID EFIAPI
efi_reset_system_wrapper ( EFI_RESET_TYPE type, EFI_STATUS status,
                           UINTN len, VOID *data ) {
        EFI_RUNTIME_SERVICES *rs = efi_systab->RuntimeServices;
        void *retaddr = __builtin_return_address ( 0 );

        DBGC ( colour, "ResetSystem ( %s, %s, %#llx, %p ) -> %p\n",
               efi_reset_type ( type ), efi_status ( status ),
               ( ( unsigned long long ) len ), data, retaddr );
        rs->ResetSystem ( type, status, len, data );
}

/**
 * Wrap a boot services table
 *
 * @v wrapper           Boot services table to wrap
 */
void efi_wrap_bs ( EFI_BOOT_SERVICES *wrapper ) {
        EFI_BOOT_SERVICES *bs = efi_systab->BootServices;

        /* Do nothing unless debugging is enabled */
        if ( ! DBG_LOG )
                return;

        /* Build boot services table wrapper */
        memcpy ( wrapper, bs, sizeof ( *wrapper ) );
        wrapper->RaiseTPL               = efi_raise_tpl_wrapper;
        wrapper->RestoreTPL             = efi_restore_tpl_wrapper;
        wrapper->AllocatePages          = efi_allocate_pages_wrapper;
        wrapper->FreePages              = efi_free_pages_wrapper;
        wrapper->GetMemoryMap           = efi_get_memory_map_wrapper;
        wrapper->AllocatePool           = efi_allocate_pool_wrapper;
        wrapper->FreePool               = efi_free_pool_wrapper;
        wrapper->CreateEvent            = efi_create_event_wrapper;
        wrapper->SetTimer               = efi_set_timer_wrapper;
        wrapper->WaitForEvent           = efi_wait_for_event_wrapper;
        wrapper->SignalEvent            = efi_signal_event_wrapper;
        wrapper->CloseEvent             = efi_close_event_wrapper;
        wrapper->CheckEvent             = efi_check_event_wrapper;
        wrapper->InstallProtocolInterface
                = efi_install_protocol_interface_wrapper;
        wrapper->ReinstallProtocolInterface
                = efi_reinstall_protocol_interface_wrapper;
        wrapper->UninstallProtocolInterface
                = efi_uninstall_protocol_interface_wrapper;
        wrapper->HandleProtocol         = efi_handle_protocol_wrapper;
        wrapper->RegisterProtocolNotify = efi_register_protocol_notify_wrapper;
        wrapper->LocateHandle           = efi_locate_handle_wrapper;
        wrapper->LocateDevicePath       = efi_locate_device_path_wrapper;
        wrapper->InstallConfigurationTable
                = efi_install_configuration_table_wrapper;
        wrapper->LoadImage              = efi_load_image_wrapper;
        wrapper->StartImage             = efi_start_image_wrapper;
        wrapper->Exit                   = efi_exit_wrapper;
        wrapper->UnloadImage            = efi_unload_image_wrapper;
        wrapper->ExitBootServices       = efi_exit_boot_services_wrapper;
        wrapper->GetNextMonotonicCount  = efi_get_next_monotonic_count_wrapper;
        wrapper->Stall                  = efi_stall_wrapper;
        wrapper->SetWatchdogTimer       = efi_set_watchdog_timer_wrapper;
        wrapper->ConnectController      = efi_connect_controller_wrapper;
        wrapper->DisconnectController   = efi_disconnect_controller_wrapper;
        wrapper->OpenProtocol           = efi_open_protocol_wrapper;
        wrapper->CloseProtocol          = efi_close_protocol_wrapper;
        wrapper->OpenProtocolInformation
                = efi_open_protocol_information_wrapper;
        wrapper->ProtocolsPerHandle     = efi_protocols_per_handle_wrapper;
        wrapper->LocateHandleBuffer     = efi_locate_handle_buffer_wrapper;
        wrapper->LocateProtocol         = efi_locate_protocol_wrapper;
        wrapper->InstallMultipleProtocolInterfaces
                = efi_install_multiple_protocol_interfaces_wrapper;
        wrapper->UninstallMultipleProtocolInterfaces
                = efi_uninstall_multiple_protocol_interfaces_wrapper;
        wrapper->CreateEventEx          = efi_create_event_ex_wrapper;
}

/**
 * Wrap a runtime services table
 *
 * @v wrapper           Runtime services table to wrap
 */
void efi_wrap_rs ( EFI_RUNTIME_SERVICES *wrapper ) {
        EFI_RUNTIME_SERVICES *rs = efi_systab->RuntimeServices;

        /* Do nothing unless debugging is enabled */
        if ( ! DBG_LOG )
                return;

        /* Build boot services table wrapper */
        memcpy ( wrapper, rs, sizeof ( *wrapper ) );
        wrapper->GetTime                = efi_get_time_wrapper;
        wrapper->SetTime                = efi_set_time_wrapper;
        wrapper->GetWakeupTime          = efi_get_wakeup_time_wrapper;
        wrapper->SetWakeupTime          = efi_set_wakeup_time_wrapper;
        wrapper->GetVariable            = efi_get_variable_wrapper;
        wrapper->GetNextVariableName    = efi_get_next_variable_name_wrapper;
        wrapper->SetVariable            = efi_set_variable_wrapper;
        wrapper->ResetSystem            = efi_reset_system_wrapper;
}

/**
 * Wrap the public EFI system table
 *
 * @v global            Patch global boot services table in-place
 */
void efi_wrap_systab ( int global ) {
        static EFI_BOOT_SERVICES local_bs;
        static EFI_RUNTIME_SERVICES local_rs;
        EFI_BOOT_SERVICES *bs;
        EFI_RUNTIME_SERVICES *rs;

        /* Do nothing unless debugging is enabled */
        if ( ! DBG_LOG )
                return;

        /* Preserve original system and boot services tables */
        if ( ! efi_systab_pub ) {
                efi_systab_pub = efi_systab;
                efi_bs_orig = efi_systab_pub->BootServices;
                efi_rs_orig = efi_systab_pub->RuntimeServices;
                memcpy ( &efi_bs_copy, efi_bs_orig, sizeof ( efi_bs_copy ) );
                memcpy ( &efi_rs_copy, efi_rs_orig, sizeof ( efi_rs_copy ) );
        }

        /* Construct and use private system table */
        if ( efi_systab != &efi_systab_priv ) {
                memcpy ( &efi_systab_priv, efi_systab_pub,
                         sizeof ( efi_systab_priv ) );
                efi_systab_priv.BootServices = &efi_bs_copy;
                efi_systab_priv.RuntimeServices = &efi_rs_copy;
                efi_systab = &efi_systab_priv;
        }

        /* Wrap global or local boot services table as applicable */
        bs = ( global ? efi_bs_orig : &local_bs );
        rs = ( global ? efi_rs_orig : &local_rs );
        efi_wrap_bs ( bs );
        efi_wrap_rs ( rs );
        efi_systab_pub->BootServices = bs;
        efi_systab_pub->RuntimeServices = rs;
        DBGC ( colour, "WRAP installed %s wrappers\n",
               ( global ? "global" : "local" ) );
}

/**
 * Remove boot services table wrapper
 *
 */
void efi_unwrap ( void ) {

        /* Do nothing unless debugging is enabled */
        if ( ! DBG_LOG )
                return;

        /* Do nothing if wrapping was never enabled */
        if ( ! efi_systab_pub )
                return;

        /* Restore original system and boot services tables */
        memcpy ( efi_bs_orig, &efi_bs_copy, sizeof ( *efi_bs_orig ) );
        efi_systab_pub->BootServices = efi_bs_orig;

        /* Switch back to using public system table */
        efi_systab = efi_systab_pub;
        DBGC ( colour, "WRAP uninstalled wrappers\n" );
}

/**
 * Wrap calls made by a newly loaded image
 *
 * @v handle            Image handle
 */
void efi_wrap_image ( EFI_HANDLE handle ) {

        /* Do nothing unless debugging is enabled */
        if ( ! DBG_LOG )
                return;

        /* Dump image information */
        efi_dump_image ( handle );

        /* Patch public system table */
        efi_wrap_systab ( 0 );
}