Skip to content

Commit 0655578

Browse files
authored
Merge pull request #71226 from kubamracek/embedded-cdecls-runtime
[embedded] Fix calling convention on embedded runtime APIs (switch @_silgen_name for @_cdecl)
2 parents f7e0caa + 6383d05 commit 0655578

File tree

2 files changed

+106
-26
lines changed

2 files changed

+106
-26
lines changed

stdlib/public/core/EmbeddedRuntime.swift

Lines changed: 50 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -48,10 +48,10 @@ public struct HeapObject {
4848

4949
/// Forward declarations of C functions
5050

51-
@_silgen_name("posix_memalign")
51+
@_extern(c, "posix_memalign")
5252
func posix_memalign(_: UnsafeMutablePointer<UnsafeMutableRawPointer?>, _: Int, _: Int) -> CInt
5353

54-
@_silgen_name("free")
54+
@_extern(c, "free")
5555
func free(_ p: Builtin.RawPointer)
5656

5757

@@ -81,38 +81,58 @@ public func swift_slowDealloc(_ ptr: UnsafeMutableRawPointer, _ size: Int, _ ali
8181
free(ptr._rawValue)
8282
}
8383

84-
@_silgen_name("swift_allocObject")
85-
public func swift_allocObject(metadata: UnsafeMutablePointer<ClassMetadata>, requiredSize: Int, requiredAlignmentMask: Int) -> UnsafeMutablePointer<HeapObject> {
84+
@_cdecl("swift_allocObject")
85+
public func swift_allocObject(metadata: Builtin.RawPointer, requiredSize: Int, requiredAlignmentMask: Int) -> Builtin.RawPointer {
86+
return swift_allocObject(metadata: UnsafeMutablePointer<ClassMetadata>(metadata), requiredSize: requiredSize, requiredAlignmentMask: requiredAlignmentMask)._rawValue
87+
}
88+
89+
func swift_allocObject(metadata: UnsafeMutablePointer<ClassMetadata>, requiredSize: Int, requiredAlignmentMask: Int) -> UnsafeMutablePointer<HeapObject> {
8690
let p = swift_slowAlloc(requiredSize, requiredAlignmentMask)!
8791
let object = p.assumingMemoryBound(to: HeapObject.self)
8892
_swift_embedded_set_heap_object_metadata_pointer(object, metadata)
8993
object.pointee.refcount = 1
9094
return object
9195
}
9296

93-
@_silgen_name("swift_deallocObject")
94-
public func swift_deallocObject(object: UnsafeMutablePointer<HeapObject>, allocatedSize: Int, allocatedAlignMask: Int) {
97+
@_cdecl("swift_deallocObject")
98+
public func swift_deallocObject(object: Builtin.RawPointer, allocatedSize: Int, allocatedAlignMask: Int) {
99+
swift_deallocObject(object: UnsafeMutablePointer<HeapObject>(object), allocatedSize: allocatedSize, allocatedAlignMask: allocatedAlignMask)
100+
}
101+
102+
func swift_deallocObject(object: UnsafeMutablePointer<HeapObject>, allocatedSize: Int, allocatedAlignMask: Int) {
95103
free(object._rawValue)
96104
}
97105

98-
@_silgen_name("swift_deallocClassInstance")
99-
public func swift_deallocClassInstance(object: UnsafeMutablePointer<HeapObject>, allocatedSize: Int, allocatedAlignMask: Int) {
106+
@_cdecl("swift_deallocClassInstance")
107+
public func swift_deallocClassInstance(object: Builtin.RawPointer, allocatedSize: Int, allocatedAlignMask: Int) {
108+
swift_deallocClassInstance(object: UnsafeMutablePointer<HeapObject>(object), allocatedSize: allocatedSize, allocatedAlignMask: allocatedAlignMask)
109+
}
110+
111+
func swift_deallocClassInstance(object: UnsafeMutablePointer<HeapObject>, allocatedSize: Int, allocatedAlignMask: Int) {
100112
if (object.pointee.refcount & HeapObject.doNotFreeBit) != 0 {
101113
return
102114
}
103115

104116
free(object._rawValue)
105117
}
106118

107-
@_silgen_name("swift_initStaticObject")
108-
public func swift_initStaticObject(metadata: UnsafeMutablePointer<ClassMetadata>, object: UnsafeMutablePointer<HeapObject>) -> UnsafeMutablePointer<HeapObject> {
119+
@_cdecl("swift_initStaticObject")
120+
public func swift_initStaticObject(metadata: Builtin.RawPointer, object: Builtin.RawPointer) -> Builtin.RawPointer {
121+
return swift_initStaticObject(metadata: UnsafeMutablePointer<ClassMetadata>(metadata), object: UnsafeMutablePointer<HeapObject>(object))._rawValue
122+
}
123+
124+
func swift_initStaticObject(metadata: UnsafeMutablePointer<ClassMetadata>, object: UnsafeMutablePointer<HeapObject>) -> UnsafeMutablePointer<HeapObject> {
109125
_swift_embedded_set_heap_object_metadata_pointer(object, metadata)
110126
object.pointee.refcount = HeapObject.immortalRefCount
111127
return object
112128
}
113129

114-
@_silgen_name("swift_initStackObject")
115-
public func swift_initStackObject(metadata: UnsafeMutablePointer<ClassMetadata>, object: UnsafeMutablePointer<HeapObject>) -> UnsafeMutablePointer<HeapObject> {
130+
@_cdecl("swift_initStackObject")
131+
public func swift_initStackObject(metadata: Builtin.RawPointer, object: Builtin.RawPointer) -> Builtin.RawPointer {
132+
return swift_initStackObject(metadata: UnsafeMutablePointer<ClassMetadata>(metadata), object: UnsafeMutablePointer<HeapObject>(object))._rawValue
133+
}
134+
135+
func swift_initStackObject(metadata: UnsafeMutablePointer<ClassMetadata>, object: UnsafeMutablePointer<HeapObject>) -> UnsafeMutablePointer<HeapObject> {
116136
_swift_embedded_set_heap_object_metadata_pointer(object, metadata)
117137
object.pointee.refcount = 1 | HeapObject.doNotFreeBit
118138
return object
@@ -122,25 +142,29 @@ public func swift_initStackObject(metadata: UnsafeMutablePointer<ClassMetadata>,
122142

123143
/// Refcounting
124144

125-
@_silgen_name("swift_setDeallocating")
126-
public func swift_setDeallocating(object: UnsafeMutablePointer<HeapObject>) {
145+
@_cdecl("swift_setDeallocating")
146+
public func swift_setDeallocating(object: Builtin.RawPointer) {
147+
}
148+
149+
@_cdecl("swift_isUniquelyReferenced_nonNull_native")
150+
public func swift_isUniquelyReferenced_nonNull_native(object: Builtin.RawPointer) -> Bool {
151+
return swift_isUniquelyReferenced_nonNull_native(object: UnsafeMutablePointer<HeapObject>(object))
127152
}
128153

129-
@_silgen_name("swift_isUniquelyReferenced_nonNull_native")
130-
public func swift_isUniquelyReferenced_nonNull_native(object: UnsafeMutablePointer<HeapObject>) -> Bool {
154+
func swift_isUniquelyReferenced_nonNull_native(object: UnsafeMutablePointer<HeapObject>) -> Bool {
131155
let refcount = refcountPointer(for: object)
132156
return loadAcquire(refcount) == 1
133157
}
134158

135-
@_silgen_name("swift_retain")
159+
@_cdecl("swift_retain")
136160
public func swift_retain(object: Builtin.RawPointer) -> Builtin.RawPointer {
137161
if Int(Builtin.ptrtoint_Word(object)) == 0 { return object }
138162
let o = UnsafeMutablePointer<HeapObject>(object)
139163
return swift_retain_n_(object: o, n: 1)._rawValue
140164
}
141165

142166
// Cannot use UnsafeMutablePointer<HeapObject>? directly in the function argument or return value as it causes IRGen crashes
143-
@_silgen_name("swift_retain_n")
167+
@_cdecl("swift_retain_n")
144168
public func swift_retain_n(object: Builtin.RawPointer, n: UInt32) -> Builtin.RawPointer {
145169
if Int(Builtin.ptrtoint_Word(object)) == 0 { return object }
146170
let o = UnsafeMutablePointer<HeapObject>(object)
@@ -158,21 +182,21 @@ func swift_retain_n_(object: UnsafeMutablePointer<HeapObject>, n: UInt32) -> Uns
158182
return object
159183
}
160184

161-
@_silgen_name("swift_release")
185+
@_cdecl("swift_release")
162186
public func swift_release(object: Builtin.RawPointer) {
163187
if Int(Builtin.ptrtoint_Word(object)) == 0 { return }
164188
let o = UnsafeMutablePointer<HeapObject>(object)
165189
swift_release_n_(object: o, n: 1)
166190
}
167191

168-
@_silgen_name("swift_release_n")
192+
@_cdecl("swift_release_n")
169193
public func swift_release_n(object: Builtin.RawPointer, n: UInt32) {
170194
if Int(Builtin.ptrtoint_Word(object)) == 0 { return }
171195
let o = UnsafeMutablePointer<HeapObject>(object)
172196
swift_release_n_(object: o, n: n)
173197
}
174198

175-
public func swift_release_n_(object: UnsafeMutablePointer<HeapObject>?, n: UInt32) {
199+
func swift_release_n_(object: UnsafeMutablePointer<HeapObject>?, n: UInt32) {
176200
guard let object else {
177201
return
178202
}
@@ -228,12 +252,12 @@ fileprivate func storeRelease(_ atomic: UnsafeMutablePointer<Int>, newValue: Int
228252

229253
/// Exclusivity checking
230254

231-
@_silgen_name("swift_beginAccess")
255+
@_cdecl("swift_beginAccess")
232256
public func swift_beginAccess(pointer: UnsafeMutableRawPointer, buffer: UnsafeMutableRawPointer, flags: UInt, pc: UnsafeMutableRawPointer) {
233257
// TODO: Add actual exclusivity checking.
234258
}
235259

236-
@_silgen_name("swift_endAccess")
260+
@_cdecl("swift_endAccess")
237261
public func swift_endAccess(buffer: UnsafeMutableRawPointer) {
238262
// TODO: Add actual exclusivity checking.
239263
}
@@ -242,7 +266,7 @@ public func swift_endAccess(buffer: UnsafeMutableRawPointer) {
242266

243267
// Once
244268

245-
@_silgen_name("swift_once")
269+
@_cdecl("swift_once")
246270
public func swift_once(predicate: UnsafeMutablePointer<Int>, fn: (@convention(c) (UnsafeMutableRawPointer)->()), context: UnsafeMutableRawPointer) {
247271
let checkedLoadAcquire = { predicate in
248272
let value = loadAcquire(predicate)
@@ -269,12 +293,12 @@ public func swift_once(predicate: UnsafeMutablePointer<Int>, fn: (@convention(c)
269293

270294
// Misc
271295

272-
@_silgen_name("swift_deletedMethodError")
296+
@_cdecl("swift_deletedMethodError")
273297
public func swift_deletedMethodError() -> Never {
274298
Builtin.int_trap()
275299
}
276300

277-
@_silgen_name("swift_willThrow")
301+
@_silgen_name("swift_willThrow") // This is actually expected to be swiftcc (@_silgen_name and not @_cdecl).
278302
public func swift_willThrow() throws {
279303
}
280304

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
// Regression test for a runtime failure that used to happen under some very specific conditions: (1) LTO, (2) Swift
2+
// compiler is used with -num-threads to emit multiple .o files even in WMO mode, (3) the first listed source file
3+
// contains no code that would trigger the use of swift_initStaticObject runtime function (e.g. no array literals), (4)
4+
// another source file does use swift_initStaticObject that doesn't get optimized away (e.g. an array literal in a
5+
// never-inline function, but not an empty array). In that case, we used to have a mismatching calling convention on
6+
// swift_initStaticObject that the LTO pipeline would conclude is invalid IR and replace it with an unconditional trap.
7+
8+
// RUN: %empty-directory(%t)
9+
// RUN: %{python} %utils/split_file.py -o %t %s
10+
11+
// RUN: %target-swift-frontend -Osize -lto=llvm-full %t/MyFile1.swift %t/MyFile2.swift -enable-experimental-feature Embedded -emit-bc -num-threads 2 -o %t/MyFile1.o -o %t/MyFile2.o
12+
// RUN: %target-clang -Oz %t/MyFile1.o %t/MyFile2.o -o %t/a.out
13+
// RUN: %target-run %t/a.out | %FileCheck %s
14+
15+
// REQUIRES: swift_in_compiler
16+
// REQUIRES: executable_test
17+
// REQUIRES: OS=macosx
18+
19+
// For LTO, the linker dlopen()'s the libLTO library, which is a scenario that
20+
// ASan cannot work in ("Interceptors are not working, AddressSanitizer is
21+
// loaded too late").
22+
// REQUIRES: no_asan
23+
24+
// BEGIN MyFile1.swift
25+
26+
public func foo() {
27+
print("foo")
28+
}
29+
30+
// BEGIN MyFile2.swift
31+
32+
public func bar() {
33+
print("bar")
34+
}
35+
36+
@inline(never)
37+
public func baz(array: [Int]) -> ([Int], [Int]) {
38+
let x = [1, 2, 3]
39+
let y = [3, 4, 5]
40+
return (x, y)
41+
}
42+
43+
@main
44+
struct Main {
45+
static func main() {
46+
foo()
47+
let (x, y) = baz(array: Array<Int>.init(repeating: 0, count: 8))
48+
let c = x.count + y.count
49+
print(c)
50+
bar()
51+
}
52+
}
53+
54+
// CHECK: foo
55+
// CHECK-NEXT: 6
56+
// CHECK-NEXT: bar

0 commit comments

Comments
 (0)