summaryrefslogtreecommitdiff
path: root/xmake/rules/utils/bin2obj/utils.lua
blob: dcd4b9c804999eb288279520fa1e9309dec67dbb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
--!A cross-platform build utility based on Lua
--
-- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License.
-- You may obtain a copy of the License at
--
--     http://www.apache.org/licenses/LICENSE-2.0
--
-- Unless required by applicable law or agreed to in writing, software
-- distributed under the License is distributed on an "AS IS" BASIS,
-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-- See the License for the specific language governing permissions and
-- limitations under the License.
--
-- Copyright (C) 2015-present, Xmake Open Source Community.
--
-- @author      ruki
-- @file        utils.lua
--

-- pick a reference object already compiled by the target's own toolchain
--
-- bin2obj mirrors its class/endianness/machine/e_flags, so the generated object matches the
-- toolchain exactly instead of guessing from the (sometimes ambiguous) arch name. we reuse one
-- of the target's own objects rather than compiling a dedicated probe; any object the toolchain
-- emits carries the same identity. we return the first one that already exists on disk, skipping
-- the object we are generating right now (which does not exist yet anyway).
function _get_refobj(target, objectfile)
    for _, obj in ipairs(target:objectfiles()) do
        if obj ~= objectfile and os.isfile(obj) then
            return obj
        end
    end
end

-- generate object file from binary file
--
-- @param target        the target
-- @param batchcmds     the batch commands
-- @param binaryfile    the binary file path
-- @param opt           the options
--                       - progress: the progress callback
--                       - format: the object file format (coff, elf, macho), auto-detected if not provided
--                       - symbol_prefix: the symbol prefix (default: _binary_)
--                       - zeroend: append null terminator (default: false)
--                       - rulename: the rule name for getting extra config (default: utils.bin2obj)
--                       - objectfile: the output object file path (optional, auto-generated if not provided)
--
function generate_objectfile(target, batchcmds, binaryfile, opt)
    opt = opt or {}
    local rulename = opt.rulename or "utils.bin2obj"
    local progress = opt.progress
    local fileconfig = target:fileconfig(binaryfile)

    -- check for cosmocc toolchain
    local is_cosmocc = target:toolchain("cosmocc") or (target:has_tool("cc", "cosmocc") and target:has_tool("ar", "cosmoar"))

    -- get format (default: auto-detect from platform)
    local format = opt.format or target:extraconf("rules", rulename, "format")
    if not format then
        if is_cosmocc then
            format = "elf"
        elseif target:is_plat("windows", "mingw", "msys", "cygwin") then
            format = "coff"
        elseif target:is_plat("macosx", "iphoneos", "watchos", "appletvos") then
            format = "macho"
        else
            format = "elf"
        end
    end

    -- transform binary data first
    -- @see https://github.com/xmake-io/xmake/issues/7513
    local transform = opt.transform or (fileconfig and fileconfig.transform) or target:extraconf("rules", rulename, "transform")
    if transform then
        batchcmds:show_progress(progress, "${color.build.object}transforming.bin2obj %s", binaryfile)
        local transformed_file = target:autogenfile(binaryfile)
        batchcmds:call(transform, {binaryfile, transformed_file}, {name = "bin2obj/transform", target = target})
        binaryfile = transformed_file
    end

    -- get object file
    local objectfile = opt.objectfile
    if not objectfile then
        objectfile = target:objectfile(binaryfile)
        -- adjust extension based on format (use .obj for COFF, .o for others)
        local objext = (format == "coff") and ".obj" or ".o"
        objectfile = objectfile:gsub("%.o$", objext):gsub("%.obj$", objext)
    end
    table.insert(target:objectfiles(), objectfile)

    -- add commands
    if progress then
        batchcmds:show_progress(progress, "${color.build.object}generating.bin2obj %s", binaryfile)
    end
    batchcmds:mkdir(path.directory(objectfile))

    -- get symbol prefix (default: _binary_)
    local symbol_prefix = opt.symbol_prefix or target:extraconf("rules", rulename, "symbol_prefix") or "_binary_"

    -- get zeroend (default: false, but can be overridden)
    local zeroend = opt.zeroend
    if zeroend == nil then
        zeroend = fileconfig and fileconfig.zeroend
    end
    if zeroend == nil then
        zeroend = target:extraconf("rules", rulename, "zeroend") or false
    end

    -- get architecture and platform
    local arch = target:arch()
    local plat = target:plat()

    -- get target_minver and xcode_sdkver from xcode toolchain (if available)
    local target_minver = nil
    local xcode_sdkver = nil
    if format == "macho" then
        local toolchain = target:toolchain("xcode")
        if toolchain then
            target_minver = toolchain:config("target_minver")
            xcode_sdkver = toolchain:config("xcode_sdkver")
        end
    end

    -- convert binary file to object file
    local argv = {
        "-i", path(binaryfile),
        "-o", path(objectfile),
        "-f", format,
        "-a", arch,
        "-p", plat
    }
    if symbol_prefix ~= "_binary_" then
        table.insert(argv, "--symbol_prefix=" .. symbol_prefix)
    end
    if target_minver then
        table.insert(argv, "--target_minver=" .. target_minver)
    end
    if xcode_sdkver then
        table.insert(argv, "--xcode_sdkver=" .. xcode_sdkver)
    end
    if zeroend then
        table.insert(argv, "--zeroend")
    end
    if is_cosmocc then
        table.insert(argv, "--cosmocc")
    end

    -- mirror the toolchain's elf identity (endianness/machine/e_flags) from one of the target's
    -- own compiled objects, so the output matches and links regardless of how the arch name maps
    if format == "elf" and not is_cosmocc then
        local refobj = _get_refobj(target, objectfile)
        if refobj then
            table.insert(argv, "--refobj=" .. refobj)
        end
    end
    batchcmds:vlua("cli.binutils.bin2obj", argv)

    return objectfile
end