res.c File Reference

#include <rtl.h>
#include <debug.h>

Include dependency graph for res.c:

Go to the source code of this file.

Macros
#define	NDEBUG
#define	NAME_FROM_RESOURCE_ENTRY(RootDirectory, Entry)    ((Entry)->NameIsString ? (ULONG_PTR)(RootDirectory) + (Entry)->NameOffset : (Entry)->Id)

Functions
NTSTATUS	find_entry (PVOID BaseAddress, LDR_RESOURCE_INFO *info, ULONG level, void **ret, int want_dir)
int	page_fault (ULONG ExceptionCode)
static int	is_data_file_module (PVOID BaseAddress)
int	push_language (USHORT *list, ULONG pos, WORD lang)
IMAGE_RESOURCE_DIRECTORY *	find_first_entry (IMAGE_RESOURCE_DIRECTORY *dir, void *root, int want_dir)
IMAGE_RESOURCE_DIRECTORY *	find_entry_by_id (IMAGE_RESOURCE_DIRECTORY *dir, WORD id, void *root, int want_dir)
IMAGE_RESOURCE_DIRECTORY *	find_entry_by_name (IMAGE_RESOURCE_DIRECTORY *dir, LPCWSTR name, void *root, int want_dir)
static NTSTATUS	LdrpAccessResource (PVOID BaseAddress, IMAGE_RESOURCE_DATA_ENTRY *entry, void **ptr, ULONG *size)
NTSTATUS NTAPI	LdrFindResource_U (PVOID BaseAddress, PLDR_RESOURCE_INFO ResourceInfo, ULONG Level, PIMAGE_RESOURCE_DATA_ENTRY *ResourceDataEntry)
NTSTATUS NTAPI	LdrAccessResource (IN PVOID BaseAddress, IN PIMAGE_RESOURCE_DATA_ENTRY ResourceDataEntry, OUT PVOID *Resource OPTIONAL, OUT PULONG Size OPTIONAL)
NTSTATUS NTAPI	LdrFindResourceDirectory_U (IN PVOID BaseAddress, IN PLDR_RESOURCE_INFO info, IN ULONG level, OUT PIMAGE_RESOURCE_DIRECTORY *addr)
static LONG	LdrpCompareResourceNames_U (_In_ PUCHAR ResourceData, _In_ PIMAGE_RESOURCE_DIRECTORY_ENTRY Entry, _In_ ULONG_PTR CompareName)
NTSTATUS NTAPI	LdrEnumResources (_In_ PVOID ImageBase, _In_ PLDR_RESOURCE_INFO ResourceInfo, _In_ ULONG Level, _Inout_ ULONG *ResourceCount, _Out_writes_to_(*ResourceCount, *ResourceCount) LDR_ENUM_RESOURCE_INFO *Resources)

Macro Definition Documentation

NAME_FROM_RESOURCE_ENTRY

#define NAME_FROM_RESOURCE_ENTRY	(		RootDirectory,
			Entry
	)		((Entry)->NameIsString ? (ULONG_PTR)(RootDirectory) + (Entry)->NameOffset : (Entry)->Id)

Definition at line 288 of file res.c.

NDEBUG

#define NDEBUG

Definition at line 29 of file res.c.

Function Documentation

find_entry()

NTSTATUS find_entry	(	PVOID	BaseAddress,
		LDR_RESOURCE_INFO *	info,
		ULONG	level,
		void **	ret,
		int	want_dir
	)

Definition at line 569 of file libsupp.c.

{
    ULONG size;
    void *root;
    IMAGE_RESOURCE_DIRECTORY *resdirptr;
    USHORT list[9];  /* list of languages to try */
    int i, pos = 0;
    LCID user_lcid, system_lcid;
 
    root = RtlImageDirectoryEntryToData( BaseAddress, TRUE, IMAGE_DIRECTORY_ENTRY_RESOURCE, &size );
    if (!root) return STATUS_RESOURCE_DATA_NOT_FOUND;
    if (size < sizeof(*resdirptr)) return STATUS_RESOURCE_DATA_NOT_FOUND;
    resdirptr = root;
 
    if (!level--) goto done;
    if (!(*ret = find_entry_by_name( resdirptr, (LPCWSTR)info->Type, root, want_dir || level )))
        return STATUS_RESOURCE_TYPE_NOT_FOUND;
    if (!level--) return STATUS_SUCCESS;
 
    resdirptr = *ret;
    if (!(*ret = find_entry_by_name( resdirptr, (LPCWSTR)info->Name, root, want_dir || level )))
        return STATUS_RESOURCE_NAME_NOT_FOUND;
    if (!level--) return STATUS_SUCCESS;
    if (level) return STATUS_INVALID_PARAMETER;  /* level > 3 */
 
    /* 1. specified language */
    pos = push_language( list, pos, info->Language );
 
    /* 2. specified language with neutral sublanguage */
    pos = push_language( list, pos, MAKELANGID( PRIMARYLANGID(info->Language), SUBLANG_NEUTRAL ) );
 
    /* 3. neutral language with neutral sublanguage */
    pos = push_language( list, pos, MAKELANGID( LANG_NEUTRAL, SUBLANG_NEUTRAL ) );
 
    /* if no explicitly specified language, try some defaults */
    if (PRIMARYLANGID(info->Language) == LANG_NEUTRAL)
    {
        /* user defaults, unless SYS_DEFAULT sublanguage specified  */
        if (SUBLANGID(info->Language) != SUBLANG_SYS_DEFAULT)
        {
            /* 4. current thread locale language */
            pos = push_language( list, pos, LANGIDFROMLCID(NtCurrentTeb()->CurrentLocale) );
 
            if (NT_SUCCESS(NtQueryDefaultLocale(TRUE, &user_lcid)))
            {
                /* 5. user locale language */
                pos = push_language( list, pos, LANGIDFROMLCID(user_lcid) );
 
                /* 6. user locale language with neutral sublanguage  */
                pos = push_language( list, pos, MAKELANGID( PRIMARYLANGID(user_lcid), SUBLANG_NEUTRAL ) );
            }
        }
 
        /* now system defaults */
 
        if (NT_SUCCESS(NtQueryDefaultLocale(FALSE, &system_lcid)))
        {
            /* 7. system locale language */
            pos = push_language( list, pos, LANGIDFROMLCID( system_lcid ) );
 
            /* 8. system locale language with neutral sublanguage */
            pos = push_language( list, pos, MAKELANGID( PRIMARYLANGID(system_lcid), SUBLANG_NEUTRAL ) );
        }
 
        /* 9. English */
        pos = push_language( list, pos, MAKELANGID( LANG_ENGLISH, SUBLANG_DEFAULT ) );
    }
 
    resdirptr = *ret;
    for (i = 0; i < pos; i++)
        if ((*ret = find_entry_by_id( resdirptr, list[i], root, want_dir ))) return STATUS_SUCCESS;
 
    /* if no explicitly specified language, return the first entry */
    if (PRIMARYLANGID(info->Language) == LANG_NEUTRAL)
    {
        if ((*ret = find_first_entry( resdirptr, root, want_dir ))) return STATUS_SUCCESS;
    }
    return STATUS_RESOURCE_LANG_NOT_FOUND;
 
done:
    *ret = resdirptr;
    return STATUS_SUCCESS;
}

Referenced by LdrFindResource_U(), and LdrFindResourceDirectory_U().

find_entry_by_id()

IMAGE_RESOURCE_DIRECTORY * find_entry_by_id	(	IMAGE_RESOURCE_DIRECTORY *	dir,
		WORD	id,
		void *	root,
		int	want_dir
	)

Definition at line 95 of file res.c.

{
    const IMAGE_RESOURCE_DIRECTORY_ENTRY *entry;
    int min, max, pos;
 
    entry = (const IMAGE_RESOURCE_DIRECTORY_ENTRY *)(dir + 1);
    min = dir->NumberOfNamedEntries;
    max = min + dir->NumberOfIdEntries - 1;
    while (min <= max)
    {
        pos = (min + max) / 2;
        if (entry[pos].Id == id)
        {
            if (!entry[pos].DataIsDirectory == !want_dir)
            {
                DPRINT("root %p dir %p id %04x ret %p\n",
                       root, dir, id, (const char*)root + entry[pos].OffsetToDirectory);
                return (IMAGE_RESOURCE_DIRECTORY *)((char *)root + entry[pos].OffsetToDirectory);
            }
            break;
        }
        if (entry[pos].Id > id) max = pos - 1;
        else min = pos + 1;
    }
    DPRINT("root %p dir %p id %04x not found\n", root, dir, id );
    return NULL;
}

Referenced by find_entry(), and find_entry_by_name().

find_entry_by_name()

IMAGE_RESOURCE_DIRECTORY * find_entry_by_name	(	IMAGE_RESOURCE_DIRECTORY *	dir,
		LPCWSTR	name,
		void *	root,
		int	want_dir
	)

Definition at line 130 of file res.c.

{
    const IMAGE_RESOURCE_DIRECTORY_ENTRY *entry;
    const IMAGE_RESOURCE_DIR_STRING_U *str;
    int min, max, res, pos;
    size_t namelen;
 
    if (!((ULONG_PTR)name & 0xFFFF0000)) return find_entry_by_id( dir, (ULONG_PTR)name & 0xFFFF, root, want_dir );
    entry = (const IMAGE_RESOURCE_DIRECTORY_ENTRY *)(dir + 1);
    namelen = wcslen(name);
    min = 0;
    max = dir->NumberOfNamedEntries - 1;
    while (min <= max)
    {
        pos = (min + max) / 2;
        str = (const IMAGE_RESOURCE_DIR_STRING_U *)((const char *)root + entry[pos].NameOffset);
        res = _wcsnicmp( name, str->NameString, str->Length );
        if (!res && namelen == str->Length)
        {
            if (!entry[pos].DataIsDirectory == !want_dir)
            {
                DPRINT("root %p dir %p name %ws ret %p\n",
                       root, dir, name, (const char*)root + entry[pos].OffsetToDirectory);
                return (IMAGE_RESOURCE_DIRECTORY *)((char *)root + entry[pos].OffsetToDirectory);
            }
            break;
        }
        if (res < 0) max = pos - 1;
        else min = pos + 1;
    }
    DPRINT("root %p dir %p name %ws not found\n", root, dir, name);
    return NULL;
}

Referenced by find_entry().

find_first_entry()

IMAGE_RESOURCE_DIRECTORY * find_first_entry	(	IMAGE_RESOURCE_DIRECTORY *	dir,
		void *	root,
		int	want_dir
	)

Definition at line 75 of file res.c.

{
    const IMAGE_RESOURCE_DIRECTORY_ENTRY *entry = (const IMAGE_RESOURCE_DIRECTORY_ENTRY *)(dir + 1);
    int pos;
 
    for (pos = 0; pos < dir->NumberOfNamedEntries + dir->NumberOfIdEntries; pos++)
    {
        if (!entry[pos].DataIsDirectory == !want_dir)
            return (IMAGE_RESOURCE_DIRECTORY *)((char *)root + entry[pos].OffsetToDirectory);
    }
    return NULL;
}

Referenced by find_entry().

is_data_file_module()

static int is_data_file_module ( PVOID  BaseAddress )

static

Definition at line 50 of file res.c.

{
    return (ULONG_PTR)BaseAddress & 1;
}

Referenced by LdrpAccessResource().

LdrAccessResource()

NTSTATUS NTAPI LdrAccessResource	(	IN PVOID	BaseAddress,
		IN PIMAGE_RESOURCE_DATA_ENTRY	ResourceDataEntry,
		OUT PVOID *Resource	OPTIONAL,
		OUT PULONG Size	OPTIONAL
	)

Definition at line 244 of file res.c.

{
    return LdrpAccessResource( BaseAddress, ResourceDataEntry, Resource, Size );
}

LdrEnumResources()

NTSTATUS NTAPI LdrEnumResources	(	_In_ PVOID	ImageBase,
		_In_ PLDR_RESOURCE_INFO	ResourceInfo,
		_In_ ULONG	Level,
		_Inout_ ULONG *	ResourceCount,
		_Out_writes_to_ *, *ResourceCount LDR_ENUM_RESOURCE_INFO *	Resources
	)

Definition at line 343 of file res.c.

{
    PUCHAR ResourceData;
    NTSTATUS Status;
    ULONG i, j, k;
    ULONG NumberOfTypeEntries, NumberOfNameEntries, NumberOfLangEntries;
    ULONG Count, MaxResourceCount;
    PIMAGE_RESOURCE_DIRECTORY TypeDirectory, NameDirectory, LangDirectory;
    PIMAGE_RESOURCE_DIRECTORY_ENTRY TypeEntry, NameEntry, LangEntry;
    PIMAGE_RESOURCE_DATA_ENTRY DataEntry;
    ULONG Size;
    LONG Result;
 
    /* If the caller wants data, get the maximum count of entries */
    MaxResourceCount = (Resources != NULL) ? *ResourceCount : 0;
 
    /* Default to 0 */
    *ResourceCount = 0;
 
    /* Locate the resource directory */
    ResourceData = RtlImageDirectoryEntryToData(ImageBase,
                                                TRUE,
                                                IMAGE_DIRECTORY_ENTRY_RESOURCE,
                                                &Size);
    if (ResourceData == NULL)
        return STATUS_RESOURCE_DATA_NOT_FOUND;
 
    /* The type directory is at the root, followed by the entries */
    TypeDirectory = (PIMAGE_RESOURCE_DIRECTORY)ResourceData;
    TypeEntry = (PIMAGE_RESOURCE_DIRECTORY_ENTRY)(TypeDirectory + 1);
 
    /* Get the number of entries in the type directory */
    NumberOfTypeEntries = TypeDirectory->NumberOfNamedEntries +
                          TypeDirectory->NumberOfIdEntries;
 
    /* Start with 0 resources and status success */
    Status = STATUS_SUCCESS;
    Count = 0;
 
    /* Loop all entries in the type directory */
    for (i = 0; i < NumberOfTypeEntries; ++i, ++TypeEntry)
    {
        /* Check if comparison of types is requested */
        if (Level > RESOURCE_TYPE_LEVEL)
        {
            /* Compare the type with the requested Type */
            Result = LdrpCompareResourceNames_U(ResourceData,
                                                TypeEntry,
                                                ResourceInfo->Type);
 
            /* Not equal, continue with next entry */
            if (Result != 0) continue;
        }
 
        /* The entry must point to the name directory */
        if (!TypeEntry->DataIsDirectory)
        {
            return STATUS_INVALID_IMAGE_FORMAT;
        }
 
        /* Get a pointer to the name subdirectory and it's first entry */
        NameDirectory = (PIMAGE_RESOURCE_DIRECTORY)(ResourceData +
                                                    TypeEntry->OffsetToDirectory);
        NameEntry = (PIMAGE_RESOURCE_DIRECTORY_ENTRY)(NameDirectory + 1);
 
        /* Get the number of entries in the name directory */
        NumberOfNameEntries = NameDirectory->NumberOfNamedEntries +
                              NameDirectory->NumberOfIdEntries;
 
        /* Loop all entries in the name directory */
        for (j = 0; j < NumberOfNameEntries; ++j, ++NameEntry)
        {
            /* Check if comparison of names is requested */
            if (Level > RESOURCE_NAME_LEVEL)
            {
                /* Compare the name with the requested name */
                Result = LdrpCompareResourceNames_U(ResourceData,
                                                    NameEntry,
                                                    ResourceInfo->Name);
 
                /* Not equal, continue with next entry */
                if (Result != 0) continue;
            }
 
            /* The entry must point to the language directory */
            if (!NameEntry->DataIsDirectory)
            {
                return STATUS_INVALID_IMAGE_FORMAT;
            }
 
            /* Get a pointer to the language subdirectory and it's first entry */
            LangDirectory = (PIMAGE_RESOURCE_DIRECTORY)(ResourceData +
                                                        NameEntry->OffsetToDirectory);
            LangEntry = (PIMAGE_RESOURCE_DIRECTORY_ENTRY)(LangDirectory + 1);
 
            /* Get the number of entries in the language directory */
            NumberOfLangEntries = LangDirectory->NumberOfNamedEntries +
                                  LangDirectory->NumberOfIdEntries;
 
            /* Loop all entries in the language directory */
            for (k = 0; k < NumberOfLangEntries; ++k, ++LangEntry)
            {
                /* Check if comparison of languages is requested */
                if (Level > RESOURCE_LANGUAGE_LEVEL)
                {
                    /* Compare the language with the requested language */
                    Result = LdrpCompareResourceNames_U(ResourceData,
                                                        LangEntry,
                                                        ResourceInfo->Language);
 
                    /* Not equal, continue with next entry */
                    if (Result != 0) continue;
                }
 
                /* This entry must point to data */
                if (LangEntry->DataIsDirectory)
                {
                    return STATUS_INVALID_IMAGE_FORMAT;
                }
 
                /* Get a pointer to the data entry */
                DataEntry = (PIMAGE_RESOURCE_DATA_ENTRY)(ResourceData +
                                                         LangEntry->OffsetToData);
 
                /* Check if there is still space to store the data */
                if (Count < MaxResourceCount)
                {
                    /* There is, fill the entry */
                    Resources[Count].Type =
                        NAME_FROM_RESOURCE_ENTRY(ResourceData, TypeEntry);
                    Resources[Count].Name =
                        NAME_FROM_RESOURCE_ENTRY(ResourceData, NameEntry);
                    Resources[Count].Language =
                        NAME_FROM_RESOURCE_ENTRY(ResourceData, LangEntry);
                    Resources[Count].Data = (PUCHAR)ImageBase + DataEntry->OffsetToData;
                    Resources[Count].Reserved = 0;
                    Resources[Count].Size = DataEntry->Size;
                }
                else
                {
                    /* There is not enough space, save error status */
                    Status = STATUS_INFO_LENGTH_MISMATCH;
                }
 
                /* Count this resource */
                ++Count;
            }
        }
    }
 
    /* Return the number of matching resources */
    *ResourceCount = Count;
    return Status;
}

Referenced by Test_Data(), and Test_Parameters().

LdrFindResource_U()

NTSTATUS NTAPI LdrFindResource_U	(	PVOID	BaseAddress,
		PLDR_RESOURCE_INFO	ResourceInfo,
		ULONG	Level,
		PIMAGE_RESOURCE_DATA_ENTRY *	ResourceDataEntry
	)

Definition at line 209 of file res.c.

{
    void *res;
    NTSTATUS status = STATUS_SUCCESS;
 
    _SEH2_TRY
    {
        if (ResourceInfo)
        {
            DPRINT( "module %p type %lx name %lx lang %04lx level %lu\n",
                     BaseAddress, ResourceInfo->Type,
                     Level > 1 ? ResourceInfo->Name : 0,
                     Level > 2 ? ResourceInfo->Language : 0, Level );
        }
 
        status = find_entry( BaseAddress, ResourceInfo, Level, &res, FALSE );
        if (NT_SUCCESS(status))
            *ResourceDataEntry = res;
    }
    _SEH2_EXCEPT(page_fault(_SEH2_GetExceptionCode()))
    {
        status = _SEH2_GetExceptionCode();
    }
    _SEH2_END;
    return status;
}

LdrFindResourceDirectory_U()

NTSTATUS NTAPI LdrFindResourceDirectory_U	(	IN PVOID	BaseAddress,
		IN PLDR_RESOURCE_INFO	info,
		IN ULONG	level,
		OUT PIMAGE_RESOURCE_DIRECTORY *	addr
	)

Definition at line 257 of file res.c.

{
    void *res;
    NTSTATUS status = STATUS_SUCCESS;
 
    _SEH2_TRY
    {
        if (info)
        {
            DPRINT( "module %p type %ws name %ws lang %04lx level %lu\n",
                     BaseAddress, (LPCWSTR)info->Type,
                     level > 1 ? (LPCWSTR)info->Name : L"",
                     level > 2 ? info->Language : 0, level );
        }
 
        status = find_entry( BaseAddress, info, level, &res, TRUE );
        if (NT_SUCCESS(status))
            *addr = res;
    }
    _SEH2_EXCEPT(page_fault(_SEH2_GetExceptionCode()))
    {
        status = _SEH2_GetExceptionCode();
    }
    _SEH2_END;
    return status;
}

LdrpAccessResource()

static NTSTATUS LdrpAccessResource ( PVOID  BaseAddress, IMAGE_RESOURCE_DATA_ENTRY *  entry, void **  ptr, ULONG *  size  )

static

Definition at line 170 of file res.c.

{
    NTSTATUS status = STATUS_SUCCESS;
 
    _SEH2_TRY
    {
        ULONG dirsize;
 
        if (!RtlImageDirectoryEntryToData( BaseAddress, TRUE, IMAGE_DIRECTORY_ENTRY_RESOURCE, &dirsize ))
            status = STATUS_RESOURCE_DATA_NOT_FOUND;
        else
        {
            if (ptr)
            {
                if (is_data_file_module(BaseAddress))
                {
                    PVOID mod = (PVOID)((ULONG_PTR)BaseAddress & ~1);
                    *ptr = RtlImageRvaToVa( RtlImageNtHeader(mod), mod, entry->OffsetToData, NULL );
                }
                else *ptr = (char *)BaseAddress + entry->OffsetToData;
            }
            if (size) *size = entry->Size;
        }
    }
    _SEH2_EXCEPT(page_fault(_SEH2_GetExceptionCode()))
    {
        status = _SEH2_GetExceptionCode();
    }
    _SEH2_END;
    return status;
}

Referenced by LdrAccessResource().

LdrpCompareResourceNames_U()

static LONG LdrpCompareResourceNames_U ( _In_ PUCHAR  ResourceData, _In_ PIMAGE_RESOURCE_DIRECTORY_ENTRY  Entry, _In_ ULONG_PTR  CompareName  )

static

Definition at line 293 of file res.c.

{
    PIMAGE_RESOURCE_DIR_STRING_U ResourceString;
    PWSTR String1, String2;
    USHORT ResourceStringLength;
    WCHAR Char1, Char2;
 
    /* Check if the resource name is an ID */
    if (CompareName <= USHRT_MAX)
    {
        /* Just compare the 2 IDs */
        return (CompareName - Entry->Id);
    }
    else
    {
        /* Get the resource string */
        ResourceString = (PIMAGE_RESOURCE_DIR_STRING_U)(ResourceData +
                                                        Entry->NameOffset);
 
        /* Get the string length */
        ResourceStringLength = ResourceString->Length;
 
        String1 = ResourceString->NameString;
        String2 = (PWSTR)CompareName;
 
        /* Loop all characters of the resource string */
        while (ResourceStringLength--)
        {
            /* Get the next characters */
            Char1 = *String1++;
            Char2 = *String2++;
 
            /* Check if they don't match, or if the compare string ends */
            if ((Char1 != Char2) || (Char2 == 0))
            {
                /* They don't match, fail */
                return Char2 - Char1;
            }
        }
 
        /* All characters match, check if the compare string ends here */
        return (*String2 == 0) ? 0 : 1;
    }
}

Referenced by LdrEnumResources().

page_fault()

int page_fault

(

ULONG

ExceptionCode

)

Definition at line 37 of file res.c.

{
    if (ExceptionCode == EXCEPTION_ACCESS_VIOLATION ||
        ExceptionCode == EXCEPTION_PRIV_INSTRUCTION)
        return EXCEPTION_EXECUTE_HANDLER;
    return EXCEPTION_CONTINUE_SEARCH;
}

Referenced by LdrFindResource_U(), LdrFindResourceDirectory_U(), and LdrpAccessResource().

push_language()

int push_language	(	USHORT *	list,
		ULONG	pos,
		WORD	lang
	)

Definition at line 61 of file res.c.

{
    ULONG i;
    for (i = 0; i < pos; i++) if (list[i] == lang) return pos;
    list[pos++] = lang;
    return pos;
}

Referenced by find_entry().