unreal 项目,IOS下排查错误: Memory mapped file has the wrong alignment!

现象:

  • 前阵子做了个 repack 安装包的功能(拿可正常运行的包解开,修改某项内容后再封装成新包),一直运行正常,最近 repack 的包在 ios 平台闪退,其它平台(Android,Windows)正常
  • 闪退没有崩溃信息,连接到 xcode 抓报错信息,最后一行错误为:Engine\Source\Runtime\CoreUObject\Private\Serialization\BulkData2.cpp line:1681 Memory mapped file has the wrong alignment!
  • 这错误只在对 develop 模式打出的包 repack 之后出现

调查:

1,错误定位:

报错位置在 Engine\Source\Runtime\CoreUObject\Private\Serialization\BulkData2.cpp line:1681
很明显是个 check 失败,内容如下:

checkf(IsAligned(MappedRegion->GetMappedPtr(), FPlatformProperties::GetMemoryMappingAlignment()), TEXT("Memory mapped file has the wrong alignment!"));

ISAligned 从字面含义来看就是内存是否对齐,具体代码内容如下:

/**
 * Checks if a pointer is aligned to the specified alignment.
 *
 * @param  Val        The value to align.
 * @param  Alignment  The alignment value, must be a power of two.
 *
 * @return true if the pointer is aligned to the specified alignment, false otherwise.
 */
template <typename T>
FORCEINLINE constexpr bool IsAligned(T Val, uint64 Alignment)
{
    static_assert(TIsIntegral<T>::Value || TIsPointer<T>::Value, "IsAligned expects an integer or pointer type");

    return !((uint64)Val & (Alignment - 1));
}

那这个错误基本就是内存没对齐造成的问题,现在只要搞清楚为什么只在 IOS 会报这个错误。

2,错误排查:

通过阅读上面代码,可以得知,对齐方式是通过 FPlatformProperties::GetMemoryMappingAlignment() 来确定的。在 unreal 中,一看到 FPlatform 下意识就会想到,一开始的入口并不是最终的调用入口,下面肯定隐藏着各平台的实现。果不然,在项目中分别找到了各个实现:

  • Engine\Source\Runtime\Core\Public\GenericPlatform\GenericPlatformProperties.h
  • Engine\Source\Runtime\Core\Public\IOS\IOSPlatformProperties.h
  • Engine\Source\Runtime\Core\Public\Android\AndroidPlatformProperties.h
  • Engine\Source\Runtime\Core\Public\Windows\WindowsPlatformProperties.h
    在除 GenericPlatformProperties.h 外的各个实现里,都有类似的如下定义:
#ifdef PROPERTY_HEADER_SHOULD_DEFINE_TYPE
typedef FIOSPlatformProperties FPlatformProperties;
#endif

PROPERTY_HEADER_SHOULD_DEFINE_TYPE 定义在 Engine\Source\Runtime\Core\Public\HAL\PlatformProperties.h

// note that this is not defined to 1 like normal, because we don't want to have to define it to 0 whenever
// the Properties.h files are included in all other places, so just use #ifdef not #if in this special case
#define PROPERTY_HEADER_SHOULD_DEFINE_TYPE

完整结合起来的含义就是:

  • typedef FIOSPlatformProperties FPlatformProperties;:这行代码在满足条件(即已经定义了PROPERTY_HEADER_SHOULD_DEFINE_TYPE)时执行。它定义了一个类型别名:将FIOSPlatformProperties重命名为FPlatformProperties,使得在后续的代码中可以用FPlatformProperties来代替FIOSPlatformProperties。

那么 IOS 平台下,GetMemoryMappingAlignment 是怎么定义的?代码在 Engine\Source\Runtime\Core\Public\IOS\IOSPlatformProperties.h line:83:

static FORCEINLINE int64 GetMemoryMappingAlignment()
{
    return 16384;
}

对,你没看出,就是写死在代码中,固定为 16384,16进制表示则为:0X4000
其它平台没有单独实现,调用的是默认值 0 。

3,unreal pak 流程中是怎么处理这个问题的?

问题找到这就很好奇,unreal 的 pak 流程中是怎么处理这个对齐问题的,于是翻开项目,找到了 Engine\Source\Programs\AutomationTool\Scripts\CopyBuildToStagingDirectory.Automation.cs文件,在其中搜索 MemoryMappedFiles便能找到这么段代码:

string BulkOption = "";
{
    ConfigHierarchy PlatformEngineConfig;
    if (Params.EngineConfigs.TryGetValue(SC.StageTargetPlatform.PlatformType, out PlatformEngineConfig))
    {
        bool bMasterEnable = false;
        PlatformEngineConfig.GetBool("MemoryMappedFiles", "MasterEnable", out bMasterEnable);
        if (bMasterEnable)
        {
            int Value = 0;
            PlatformEngineConfig.GetInt32("MemoryMappedFiles", "Alignment", out Value);
            if (Value > 0)
            {
                BulkOption = String.Format(" -AlignForMemoryMapping={0}", Value);
            }
        }
    }
}

然后在Engine\Config\IOS\IOSEngine.ini中能找到这样的定义:

[MemoryMappedFiles]
MasterEnable=true
Alignment=16384

ini 中的 16384 和 IOSPlatformProperties.h 中的一致,也就意味着在 unreal pak 过程中传入了 AlignForMemoryMapping 参数。

然后再来看看 Engine\Source\Developer\PakFileUtilities\Private\PakFileUtilities.cpp 中是怎么处理这个参数:

bool bIsMappedBulk = Input.Source.EndsWith(TEXT(".m.ubulk"));
// Align bulk data
if (bIsMappedBulk && CmdLineParameters.AlignForMemoryMapping > 0 && OriginalFileSize != INDEX_NONE && !bDeleted)
{
    if (!IsAligned(NewEntryOffset + NewEntry.Info.GetSerializedSize(FPakInfo::PakFile_Version_Latest), CmdLineParameters.AlignForMemoryMapping))
    {
        int64 OldOffset = NewEntryOffset;
        NewEntryOffset = AlignArbitrary(NewEntryOffset + NewEntry.Info.GetSerializedSize(FPakInfo::PakFile_Version_Latest), CmdLineParameters.AlignForMemoryMapping) - NewEntry.Info.GetSerializedSize(FPakInfo::PakFile_Version_Latest);
        int64 PaddingRequired = NewEntryOffset - OldOffset;

        check(PaddingRequired > 0);
        check(PaddingBuffer && PaddingBufferSize >= PaddingRequired);

        {
            UE_LOG(LogPakFile, Verbose, TEXT("%14llu - %14llu : %14llu bulk padding."), PakFileHandle->Tell(), PakFileHandle->Tell() + PaddingRequired, PaddingRequired);
            PakFileHandle->Serialize(PaddingBuffer, PaddingRequired);
            check(PakFileHandle->Tell() == NewEntryOffset);
        }
    }
}

4, 综合上述线索,我们可以得出结论:

  • ios 平台做了特殊的内存对齐,而且是写死在代码中的 16384
  • unreal 在 pak 过程中会检索平台配置参数,获取对齐信息
  • unreal 对 AlignForMemoryMapping 进行响应,在 pak 时,对文件做内存对齐

解决方法:

  • pak时,针对 IOS 平台,加入 -AlignForMemoryMapping=16384 参数,这个数字可以通过读配置来获得,也可以写死在脚本中,毕竟 unreal engine 是写死在代码中的
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,271评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,275评论 2 380
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,151评论 0 336
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,550评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,553评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,559评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,924评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,580评论 0 257
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,826评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,578评论 2 320
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,661评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,363评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,940评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,926评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,156评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,872评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,391评论 2 342

推荐阅读更多精彩内容