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 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556
// This Source Code Form is subject to the terms of the Mozilla Public // License, v. 2.0. If a copy of the MPL was not distributed with this // file, You can obtain one at https://mozilla.org/MPL/2.0/. /*! YAML structures in text stub files. This module defines raw YAML primitives existing in text stub files / `.tbd` files. See https://github.com/llvm/llvm-project/blob/main/llvm/lib/TextAPI/MachO/TextStub.cpp for specifications of the YAML files. */ use serde::{Deserialize, Serialize}; /* The TBD v1 format only support two level address libraries and is per definition application extension safe. --- # the tag !tapi-tbd-v1 is optional and # shouldn't be emitted to support older linker. archs: [ armv7, armv7s, arm64 ] # the list of architecture slices that are # supported by this file. platform: ios # Specifies the platform (macosx, ios, etc) install-name: /u/l/libfoo.dylib # current-version: 1.2.3 # Optional: defaults to 1.0 compatibility-version: 1.0 # Optional: defaults to 1.0 swift-version: 0 # Optional: defaults to 0 objc-constraint: none # Optional: defaults to none exports: # List of export sections ... Each export section is defined as following: - archs: [ arm64 ] # the list of architecture slices allowed-clients: [ client ] # Optional: List of clients re-exports: [ ] # Optional: List of re-exports symbols: [ _sym ] # Optional: List of symbols objc-classes: [] # Optional: List of Objective-C classes objc-ivars: [] # Optional: List of Objective C Instance # Variables weak-def-symbols: [] # Optional: List of weak defined symbols thread-local-symbols: [] # Optional: List of thread local symbols */ /// Version 1 of the TBD structure. #[derive(Clone, Debug, Deserialize, Serialize)] #[serde(rename_all = "kebab-case")] pub struct TbdVersion1 { /// The list of architecture slices that are supported by this file. /// /// armv7, arm64, etc. archs: Vec<String>, /// Specifies the platform (macosx, ios, etc). platform: String, /// Path of installed library. install_name: String, /// Current version of library. /// /// Defaults to `1.0`. current_version: Option<String>, /// Compatibility version of library. /// /// Defaults to `1.0`. compatibility_version: Option<String>, /// Swift version of library. /// /// Defaults to `0`. swift_version: Option<String>, /// Objective-C constraint. /// /// Defaults to `none`. objc_constraint: Option<String>, /// Export sections. exports: Vec<TbdVersion12ExportSection>, } /// Export section in a TBD version 1 or 2 structure. #[derive(Clone, Debug, Deserialize, Serialize)] #[serde(rename_all = "kebab-case")] pub struct TbdVersion12ExportSection { /// List of architecture slices. pub archs: Vec<String>, /// List of clients. #[serde(default)] pub allowed_clients: Vec<String>, /// List of re-exports. #[serde(default)] pub re_exports: Vec<String>, /// List of symbols. #[serde(default)] pub symbols: Vec<String>, /// List of Objective-C classes. #[serde(default)] pub objc_classes: Vec<String>, /// List of Objective-C instance variables. #[serde(default)] pub objc_ivars: Vec<String>, /// List of weak defined symbols. #[serde(default)] pub weak_def_symbols: Vec<String>, /// List of thread local symbols. #[serde(default)] pub thread_local_symbols: Vec<String>, } /* --- !tapi-tbd-v2 archs: [ armv7, armv7s, arm64 ] # the list of architecture slices that are # supported by this file. uuids: [ armv7:... ] # Optional: List of architecture and UUID pairs. platform: ios # Specifies the platform (macosx, ios, etc) flags: [] # Optional: install-name: /u/l/libfoo.dylib # current-version: 1.2.3 # Optional: defaults to 1.0 compatibility-version: 1.0 # Optional: defaults to 1.0 swift-version: 0 # Optional: defaults to 0 objc-constraint: retain_release # Optional: defaults to retain_release parent-umbrella: # Optional: exports: # List of export sections ... undefineds: # List of undefineds sections ... Each export section is defined as following: - archs: [ arm64 ] # the list of architecture slices allowed-clients: [ client ] # Optional: List of clients re-exports: [ ] # Optional: List of re-exports symbols: [ _sym ] # Optional: List of symbols objc-classes: [] # Optional: List of Objective-C classes objc-ivars: [] # Optional: List of Objective C Instance # Variables weak-def-symbols: [] # Optional: List of weak defined symbols thread-local-symbols: [] # Optional: List of thread local symbols Each undefineds section is defined as following: - archs: [ arm64 ] # the list of architecture slices symbols: [ _sym ] # Optional: List of symbols objc-classes: [] # Optional: List of Objective-C classes objc-ivars: [] # Optional: List of Objective C Instance Variables weak-ref-symbols: [] # Optional: List of weak defined symbols */ /// Version 2 of the TBD data structure. #[derive(Clone, Debug, Deserialize, Serialize)] #[serde(rename_all = "kebab-case")] pub struct TbdVersion2 { /// The list of architecture slices that are supported by this file. pub archs: Vec<String>, /// List of architecture and UUID pairs. #[serde(default)] pub uuids: Vec<String>, /// Specifies the paltform (macosx, ios, etc). pub platform: String, #[serde(default)] pub flags: Vec<String>, pub install_name: String, /// Current version of library. /// /// Defaults to `1.0`. pub current_version: Option<String>, /// Compatibility version of library. /// /// Defaults to `1.0`. pub compatibility_version: Option<String>, /// Swift version of library. pub swift_version: Option<String>, /// Objective-C constraint. pub objc_constraint: Option<String>, pub parent_umbrella: Option<String>, /// Export sections. pub exports: Vec<TbdVersion12ExportSection>, /// Undefineds sections. pub undefineds: Vec<TbdVersion2UndefinedsSection>, } /// Undefineds sections in a version 2 TBD structure. #[derive(Clone, Debug, Deserialize, Serialize)] #[serde(rename_all = "kebab-case")] pub struct TbdVersion2UndefinedsSection { /// The list of architecture slices. pub archs: Vec<String>, /// List of symbols. #[serde(default)] pub symbols: Vec<String>, /// List of Objective-C classes. #[serde(default)] pub objc_classes: Vec<String>, /// List of Objective-C instance variables. #[serde(default)] pub objc_ivars: Vec<String>, /// List of weak defined symbols. #[serde(default)] pub weak_ref_symbols: Vec<String>, } #[derive(Clone, Debug, Deserialize, Serialize)] #[serde(rename_all = "kebab-case")] pub struct TbdUmbrellaSection { #[serde(default)] pub targets: Vec<String>, pub umbrella: String, } /* --- !tapi-tbd-v3 archs: [ armv7, armv7s, arm64 ] # the list of architecture slices that are # supported by this file. uuids: [ armv7:... ] # Optional: List of architecture and UUID pairs. platform: ios # Specifies the platform (macosx, ios, etc) flags: [] # Optional: install-name: /u/l/libfoo.dylib # current-version: 1.2.3 # Optional: defaults to 1.0 compatibility-version: 1.0 # Optional: defaults to 1.0 swift-abi-version: 0 # Optional: defaults to 0 objc-constraint: retain_release # Optional: defaults to retain_release parent-umbrella: # Optional: exports: # List of export sections ... undefineds: # List of undefineds sections ... Each export section is defined as following: - archs: [ arm64 ] # the list of architecture slices allowed-clients: [ client ] # Optional: List of clients re-exports: [ ] # Optional: List of re-exports symbols: [ _sym ] # Optional: List of symbols objc-classes: [] # Optional: List of Objective-C classes objc-eh-types: [] # Optional: List of Objective-C classes # with EH objc-ivars: [] # Optional: List of Objective C Instance # Variables weak-def-symbols: [] # Optional: List of weak defined symbols thread-local-symbols: [] # Optional: List of thread local symbols Each undefineds section is defined as following: - archs: [ arm64 ] # the list of architecture slices symbols: [ _sym ] # Optional: List of symbols objc-classes: [] # Optional: List of Objective-C classes objc-eh-types: [] # Optional: List of Objective-C classes # with EH objc-ivars: [] # Optional: List of Objective C Instance Variables weak-ref-symbols: [] # Optional: List of weak defined symbols */ /// Version 3 of the TBD data structure. #[derive(Clone, Debug, Deserialize, Serialize)] #[serde(rename_all = "kebab-case")] pub struct TbdVersion3 { /// The list of architecture slices that are supported by this file. pub archs: Vec<String>, /// List of architecture and UUID pairs. #[serde(default)] pub uuids: Vec<String>, /// Specifies the paltform (macosx, ios, etc). pub platform: String, #[serde(default)] pub flags: Vec<String>, pub install_name: String, /// Current version of library. /// /// Defaults to `1.0`. pub current_version: Option<String>, /// Compatibility version of library. /// /// Defaults to `1.0`. pub compatibility_version: Option<String>, /// Swift version of library. pub swift_abi_version: Option<String>, /// Objective-C constraint. /// /// Defaults to `retain_release`. pub objc_constraint: Option<String>, pub parent_umbrella: Option<String>, /// Export sections. #[serde(default)] pub exports: Vec<TbdVersion3ExportSection>, /// Undefineds sections. #[serde(default)] pub undefineds: Vec<TbdVersion3UndefinedsSection>, } /// Export section in a TBD version 3 structure. #[derive(Clone, Debug, Deserialize, Serialize)] #[serde(rename_all = "kebab-case")] pub struct TbdVersion3ExportSection { /// List of architecture slices. pub archs: Vec<String>, /// List of clients. #[serde(default)] pub allowed_clients: Vec<String>, /// List of re-exports. #[serde(default)] pub re_exports: Vec<String>, /// List of symbols. #[serde(default)] pub symbols: Vec<String>, /// List of Objective-C classes. #[serde(default)] pub objc_classes: Vec<String>, /// List of Objective-C classes with EH. #[serde(default)] pub objc_eh_types: Vec<String>, /// List of Objective-C instance variables. #[serde(default)] pub objc_ivars: Vec<String>, /// List of weak defined symbols. #[serde(default)] pub weak_def_symbols: Vec<String>, /// List of thread local symbols. #[serde(default)] pub thread_local_symbols: Vec<String>, } /// Undefineds section in a version 3 TBD structure. #[derive(Clone, Debug, Deserialize, Serialize)] #[serde(rename_all = "kebab-case")] pub struct TbdVersion3UndefinedsSection { /// The list of architecture slices. pub archs: Vec<String>, /// List of symbols. #[serde(default)] pub symbols: Vec<String>, /// List of Objective-C classes. #[serde(default)] pub objc_classes: Vec<String>, /// List of Objective-C classes with EH. #[serde(default)] pub objc_eh_types: Vec<String>, /// List of Objective-C instance variables. #[serde(default)] pub objc_ivars: Vec<String>, /// List of weak defined symbols. #[serde(default)] pub weak_ref_symbols: Vec<String>, } /* --- !tapi-tbd tbd-version: 4 # The tbd version for format targets: [ armv7-ios, x86_64-maccatalyst ] # The list of applicable tapi supported target triples uuids: # Optional: List of target and UUID pairs. - target: armv7-ios value: ... - target: x86_64-maccatalyst value: ... flags: [] # Optional: install-name: /u/l/libfoo.dylib # current-version: 1.2.3 # Optional: defaults to 1.0 compatibility-version: 1.0 # Optional: defaults to 1.0 swift-abi-version: 0 # Optional: defaults to 0 parent-umbrella: # Optional: allowable-clients: - targets: [ armv7-ios ] # Optional: clients: [ clientA ] exports: # List of export sections ... re-exports: # List of reexport sections ... undefineds: # List of undefineds sections ... Each export and reexport section is defined as following: - targets: [ arm64-macos ] # The list of target triples associated with symbols symbols: [ _symA ] # Optional: List of symbols objc-classes: [] # Optional: List of Objective-C classes objc-eh-types: [] # Optional: List of Objective-C classes # with EH objc-ivars: [] # Optional: List of Objective C Instance # Variables weak-symbols: [] # Optional: List of weak defined symbols thread-local-symbols: [] # Optional: List of thread local symbols - targets: [ arm64-macos, x86_64-maccatalyst ] # Optional: Targets for applicable additional symbols symbols: [ _symB ] # Optional: List of symbols Each undefineds section is defined as following: - targets: [ arm64-macos ] # The list of target triples associated with symbols symbols: [ _symC ] # Optional: List of symbols objc-classes: [] # Optional: List of Objective-C classes objc-eh-types: [] # Optional: List of Objective-C classes # with EH objc-ivars: [] # Optional: List of Objective C Instance Variables weak-symbols: [] # Optional: List of weak defined symbols */ /// Version 4 of the TBD data structure. #[derive(Clone, Debug, Deserialize, Serialize)] #[serde(rename_all = "kebab-case")] pub struct TbdVersion4 { /// The tbd version for format. pub tbd_version: usize, /// The list of applicable tapi supported target triples. pub targets: Vec<String>, /// List of architecture and UUID pairs. #[serde(default)] pub uuids: Vec<TbdVersion4Uuid>, #[serde(default)] pub flags: Vec<String>, pub install_name: String, /// Current version of library. /// /// Defaults to `1.0`. pub current_version: Option<String>, /// Compatibility version of library. /// /// Defaults to `1.0`. pub compatibility_version: Option<String>, /// Swift version of library. pub swift_abi_version: Option<String>, #[serde(default)] pub parent_umbrella: Vec<TbdUmbrellaSection>, #[serde(default)] pub allowable_clients: Vec<TbdVersion4AllowableClient>, /// Export sections. #[serde(default)] pub exports: Vec<TbdVersion4ExportSection>, /// Reexport sections. #[serde(default)] pub re_exports: Vec<TbdVersion4ExportSection>, /// Undefineds sections. #[serde(default)] pub undefineds: Vec<TbdVersion4UndefinedsSection>, } /// A UUID value in a TBD version 4 data structure. #[derive(Clone, Debug, Deserialize, Serialize)] pub struct TbdVersion4Uuid { pub target: String, pub value: String, } /// An allowable client in a TBD version 4 data structure. #[derive(Clone, Debug, Deserialize, Serialize)] pub struct TbdVersion4AllowableClient { #[serde(default)] targets: Vec<String>, clients: Vec<String>, } /// (Re)export section in a TBD version 4 structure. #[derive(Clone, Debug, Deserialize, Serialize)] #[serde(rename_all = "kebab-case")] pub struct TbdVersion4ExportSection { /// Target triples associated with symbols. pub targets: Vec<String>, /// List of symbols. #[serde(default)] pub symbols: Vec<String>, /// List of Objective-C classes. #[serde(default)] pub objc_classes: Vec<String>, /// List of Objective-C classes with EH. #[serde(default)] pub objc_eh_types: Vec<String>, /// List of Objective-C instance variables. #[serde(default)] pub objc_ivars: Vec<String>, /// List of weak defined symbols. #[serde(default)] pub weak_symbols: Vec<String>, /// List of thread local symbols. #[serde(default)] pub thread_local_symbols: Vec<String>, } /// Undefineds sections in a version 4 TBD structure. #[derive(Clone, Debug, Deserialize, Serialize)] #[serde(rename_all = "kebab-case")] pub struct TbdVersion4UndefinedsSection { /// The list of target triples associated with symbols. pub targets: Vec<String>, /// List of symbols. #[serde(default)] pub symbols: Vec<String>, /// List of Objective-C classes. #[serde(default)] pub objc_classes: Vec<String>, /// List of Objective-C classes with EH. #[serde(default)] pub objc_eh_types: Vec<String>, /// List of Objective-C instance variables. #[serde(default)] pub objc_ivars: Vec<String>, /// List of weak defined symbols. #[serde(default)] pub weak_symbols: Vec<String>, }