]> git.proxmox.com Git - rustc.git/blob - src/doc/rustc/src/target-tier-policy.md
New upstream version 1.53.0+dfsg1
[rustc.git] / src / doc / rustc / src / target-tier-policy.md
1 # Target Tier Policy
2
3 Rust provides three tiers of target support:
4
5 - Rust provides no guarantees about tier 3 targets; they exist in the codebase,
6 but may or may not build.
7 - Rust's continuous integration checks that tier 2 targets will always build,
8 but they may or may not pass tests.
9 - Rust's continuous integration checks that tier 1 targets will always build
10 and pass tests.
11
12 Adding a new tier 3 target imposes minimal requirements; we focus primarily on
13 avoiding disruption to other ongoing Rust development.
14
15 Tier 2 and tier 1 targets place work on Rust project developers as a whole, to
16 avoid breaking the target. The broader Rust community may also feel more
17 inclined to support higher-tier targets in their crates (though they are not
18 obligated to do so). Thus, these tiers require commensurate and ongoing efforts
19 from the maintainers of the target, to demonstrate value and to minimize any
20 disruptions to ongoing Rust development.
21
22 This policy defines the requirements for accepting a proposed target at a given
23 level of support.
24
25 Each tier builds on all the requirements from the previous tier, unless
26 overridden by a stronger requirement. Targets at tier 2 and tier 1 may also
27 provide *host tools* (such as `rustc` and `cargo`); each of those tiers
28 includes a set of supplementary requirements that must be met if supplying host
29 tools for the target. A target at tier 2 or tier 1 is not required to supply
30 host tools, but if it does, it must meet the corresponding additional
31 requirements for host tools.
32
33 The policy for each tier also documents the Rust governance teams that must
34 approve the addition of any target at that tier. Those teams are responsible
35 for reviewing and evaluating the target, based on these requirements and their
36 own judgment. Those teams may apply additional requirements, including
37 subjective requirements, such as to deal with issues not foreseen by this
38 policy. (Such requirements may subsequently motivate additions to this policy.)
39
40 While these criteria attempt to document the policy, that policy still involves
41 human judgment. Targets must fulfill the spirit of the requirements as well, as
42 determined by the judgment of the approving teams. Reviewers and team members
43 evaluating targets and target-specific patches should always use their own best
44 judgment regarding the quality of work, and the suitability of a target for the
45 Rust project. Neither this policy nor any decisions made regarding targets
46 shall create any binding agreement or estoppel by any party.
47
48 Before filing an issue or pull request (PR) to introduce or promote a target,
49 the target should already meet the corresponding tier requirements. This does
50 not preclude an existing target's maintainers using issues (on the Rust
51 repository or otherwise) to track requirements that have not yet been met, as
52 appropriate; however, before officially proposing the introduction or promotion
53 of a target, it should meet all of the necessary requirements. A target
54 proposal is encouraged to quote the corresponding requirements verbatim as part
55 of explaining how the target meets those requirements.
56
57 For a list of all supported targets and their corresponding tiers ("tier 3",
58 "tier 2", "tier 2 with host tools", "tier 1", or "tier 1 with host tools"), see
59 [platform support](platform-support.md).
60
61 Note that a target must have already received approval for the next lower tier,
62 and spent a reasonable amount of time at that tier, before making a proposal
63 for promotion to the next higher tier; this is true even if a target meets the
64 requirements for several tiers at once. This policy leaves the precise
65 interpretation of "reasonable amount of time" up to the approving teams; those
66 teams may scale the amount of time required based on their confidence in the
67 target and its demonstrated track record at its current tier. At a minimum,
68 multiple stable releases of Rust should typically occur between promotions of a
69 target.
70
71 The availability or tier of a target in stable Rust is not a hard stability
72 guarantee about the future availability or tier of that target. Higher-level
73 target tiers are an increasing commitment to the support of a target, and we
74 will take that commitment and potential disruptions into account when
75 evaluating the potential demotion or removal of a target that has been part of
76 a stable release. The promotion or demotion of a target will not generally
77 affect existing stable releases, only current development and future releases.
78
79 In this policy, the words "must" and "must not" specify absolute requirements
80 that a target must meet to qualify for a tier. The words "should" and "should
81 not" specify requirements that apply in almost all cases, but for which the
82 approving teams may grant an exception for good reason. The word "may"
83 indicates something entirely optional, and does not indicate guidance or
84 recommendations. This language is based on [IETF RFC
85 2119](https://tools.ietf.org/html/rfc2119).
86
87 ## Tier 3 target policy
88
89 At this tier, the Rust project provides no official support for a target, so we
90 place minimal requirements on the introduction of targets.
91
92 A proposed new tier 3 target must be reviewed and approved by a member of the
93 compiler team based on these requirements. The reviewer may choose to gauge
94 broader compiler team consensus via a Major Change Proposal (MCP).
95
96 A proposed target or target-specific patch that substantially changes code
97 shared with other targets (not just target-specific code) must be reviewed and
98 approved by the appropriate team for that shared code before acceptance.
99
100 - A tier 3 target must have a designated developer or developers (the "target
101 maintainers") on record to be CCed when issues arise regarding the target.
102 (The mechanism to track and CC such developers may evolve over time.)
103 - Targets must use naming consistent with any existing targets; for instance, a
104 target for the same CPU or OS as an existing Rust target should use the same
105 name for that CPU or OS. Targets should normally use the same names and
106 naming conventions as used elsewhere in the broader ecosystem beyond Rust
107 (such as in other toolchains), unless they have a very good reason to
108 diverge. Changing the name of a target can be highly disruptive, especially
109 once the target reaches a higher tier, so getting the name right is important
110 even for a tier 3 target.
111 - Target names should not introduce undue confusion or ambiguity unless
112 absolutely necessary to maintain ecosystem compatibility. For example, if
113 the name of the target makes people extremely likely to form incorrect
114 beliefs about what it targets, the name should be changed or augmented to
115 disambiguate it.
116 - Tier 3 targets may have unusual requirements to build or use, but must not
117 create legal issues or impose onerous legal terms for the Rust project or for
118 Rust developers or users.
119 - The target must not introduce license incompatibilities.
120 - Anything added to the Rust repository must be under the standard Rust
121 license (`MIT OR Apache-2.0`).
122 - The target must not cause the Rust tools or libraries built for any other
123 host (even when supporting cross-compilation to the target) to depend
124 on any new dependency less permissive than the Rust licensing policy. This
125 applies whether the dependency is a Rust crate that would require adding
126 new license exceptions (as specified by the `tidy` tool in the
127 rust-lang/rust repository), or whether the dependency is a native library
128 or binary. In other words, the introduction of the target must not cause a
129 user installing or running a version of Rust or the Rust tools to be
130 subject to any new license requirements.
131 - If the target supports building host tools (such as `rustc` or `cargo`),
132 those host tools must not depend on proprietary (non-FOSS) libraries, other
133 than ordinary runtime libraries supplied by the platform and commonly used
134 by other binaries built for the target. For instance, `rustc` built for the
135 target may depend on a common proprietary C runtime library or console
136 output library, but must not depend on a proprietary code generation
137 library or code optimization library. Rust's license permits such
138 combinations, but the Rust project has no interest in maintaining such
139 combinations within the scope of Rust itself, even at tier 3.
140 - Targets should not require proprietary (non-FOSS) components to link a
141 functional binary or library.
142 - "onerous" here is an intentionally subjective term. At a minimum, "onerous"
143 legal/licensing terms include but are *not* limited to: non-disclosure
144 requirements, non-compete requirements, contributor license agreements
145 (CLAs) or equivalent, "non-commercial"/"research-only"/etc terms,
146 requirements conditional on the employer or employment of any particular
147 Rust developers, revocable terms, any requirements that create liability
148 for the Rust project or its developers or users, or any requirements that
149 adversely affect the livelihood or prospects of the Rust project or its
150 developers or users.
151 - Neither this policy nor any decisions made regarding targets shall create any
152 binding agreement or estoppel by any party. If any member of an approving
153 Rust team serves as one of the maintainers of a target, or has any legal or
154 employment requirement (explicit or implicit) that might affect their
155 decisions regarding a target, they must recuse themselves from any approval
156 decisions regarding the target's tier status, though they may otherwise
157 participate in discussions.
158 - This requirement does not prevent part or all of this policy from being
159 cited in an explicit contract or work agreement (e.g. to implement or
160 maintain support for a target). This requirement exists to ensure that a
161 developer or team responsible for reviewing and approving a target does not
162 face any legal threats or obligations that would prevent them from freely
163 exercising their judgment in such approval, even if such judgment involves
164 subjective matters or goes beyond the letter of these requirements.
165 - Tier 3 targets should attempt to implement as much of the standard libraries
166 as possible and appropriate (`core` for most targets, `alloc` for targets
167 that can support dynamic memory allocation, `std` for targets with an
168 operating system or equivalent layer of system-provided functionality), but
169 may leave some code unimplemented (either unavailable or stubbed out as
170 appropriate), whether because the target makes it impossible to implement or
171 challenging to implement. The authors of pull requests are not obligated to
172 avoid calling any portions of the standard library on the basis of a tier 3
173 target not implementing those portions.
174 - The target must provide documentation for the Rust community explaining how
175 to build for the target, using cross-compilation if possible. If the target
176 supports running tests (even if they do not pass), the documentation must
177 explain how to run tests for the target, using emulation if possible or
178 dedicated hardware if necessary.
179 - Tier 3 targets must not impose burden on the authors of pull requests, or
180 other developers in the community, to maintain the target. In particular,
181 do not post comments (automated or manual) on a PR that derail or suggest a
182 block on the PR based on a tier 3 target. Do not send automated messages or
183 notifications (via any medium, including via `@`) to a PR author or others
184 involved with a PR regarding a tier 3 target, unless they have opted into
185 such messages.
186 - Backlinks such as those generated by the issue/PR tracker when linking to
187 an issue or PR are not considered a violation of this policy, within
188 reason. However, such messages (even on a separate repository) must not
189 generate notifications to anyone involved with a PR who has not requested
190 such notifications.
191 - Patches adding or updating tier 3 targets must not break any existing tier 2
192 or tier 1 target, and must not knowingly break another tier 3 target without
193 approval of either the compiler team or the maintainers of the other tier 3
194 target.
195 - In particular, this may come up when working on closely related targets,
196 such as variations of the same architecture with different features. Avoid
197 introducing unconditional uses of features that another variation of the
198 target may not have; use conditional compilation or runtime detection, as
199 appropriate, to let each target run code supported by that target.
200
201 If a tier 3 target stops meeting these requirements, or the target maintainers
202 no longer have interest or time, or the target shows no signs of activity and
203 has not built for some time, or removing the target would improve the quality
204 of the Rust codebase, we may post a PR to remove it; any such PR will be CCed
205 to the target maintainers (and potentially other people who have previously
206 worked on the target), to check potential interest in improving the situation.
207
208 ## Tier 2 target policy
209
210 At this tier, the Rust project guarantees that a target builds, and will reject
211 patches that fail to build on a target. Thus, we place requirements that ensure
212 the target will not block forward progress of the Rust project.
213
214 A proposed new tier 2 target must be reviewed and approved by the compiler team
215 based on these requirements. Such review and approval may occur via a Major
216 Change Proposal (MCP).
217
218 In addition, the infrastructure team must approve the integration of the target
219 into Continuous Integration (CI), and the tier 2 CI-related requirements. This
220 review and approval may take place in a PR adding the target to CI, or simply
221 by an infrastructure team member reporting the outcome of a team discussion.
222
223 - A tier 2 target must have value to people other than its maintainers. (It may
224 still be a niche target, but it must not be exclusively useful for an
225 inherently closed group.)
226 - A tier 2 target must have a designated team of developers (the "target
227 maintainers") available to consult on target-specific build-breaking issues,
228 or if necessary to develop target-specific language or library implementation
229 details. This team must have at least 2 developers.
230 - The target maintainers should not only fix target-specific issues, but
231 should use any such issue as an opportunity to educate the Rust community
232 about portability to their target, and enhance documentation of the target.
233 - The target must not place undue burden on Rust developers not specifically
234 concerned with that target. Rust developers are expected to not gratuitously
235 break a tier 2 target, but are not expected to become experts in every tier 2
236 target, and are not expected to provide target-specific implementations for
237 every tier 2 target.
238 - The target must provide documentation for the Rust community explaining how
239 to build for the target using cross-compilation, and explaining how to run
240 tests for the target. If at all possible, this documentation should show how
241 to run Rust programs and tests for the target using emulation, to allow
242 anyone to do so. If the target cannot be feasibly emulated, the documentation
243 should explain how to obtain and work with physical hardware, cloud systems,
244 or equivalent.
245 - The target must document its baseline expectations for the features or
246 versions of CPUs, operating systems, libraries, runtime environments, and
247 similar.
248 - If introducing a new tier 2 or higher target that is identical to an existing
249 Rust target except for the baseline expectations for the features or versions
250 of CPUs, operating systems, libraries, runtime environments, and similar,
251 then the proposed target must document to the satisfaction of the approving
252 teams why the specific difference in baseline expectations provides
253 sufficient value to justify a separate target.
254 - Note that in some cases, based on the usage of existing targets within the
255 Rust community, Rust developers or a target's maintainers may wish to
256 modify the baseline expectations of a target, or split an existing target
257 into multiple targets with different baseline expectations. A proposal to
258 do so will be treated similarly to the analogous promotion, demotion, or
259 removal of a target, according to this policy, with the same team approvals
260 required.
261 - For instance, if an OS version has become obsolete and unsupported, a
262 target for that OS may raise its baseline expectations for OS version
263 (treated as though removing a target corresponding to the older
264 versions), or a target for that OS may split out support for older OS
265 versions into a lower-tier target (treated as though demoting a target
266 corresponding to the older versions, and requiring justification for a
267 new target at a lower tier for the older OS versions).
268 - Tier 2 targets must not leave any significant portions of `core` or the
269 standard library unimplemented or stubbed out, unless they cannot possibly be
270 supported on the target.
271 - The right approach to handling a missing feature from a target may depend
272 on whether the target seems likely to develop the feature in the future. In
273 some cases, a target may be co-developed along with Rust support, and Rust
274 may gain new features on the target as that target gains the capabilities
275 to support those features.
276 - As an exception, a target identical to an existing tier 1 target except for
277 lower baseline expectations for the OS, CPU, or similar, may propose to
278 qualify as tier 2 (but not higher) without support for `std` if the target
279 will primarily be used in `no_std` applications, to reduce the support
280 burden for the standard library. In this case, evaluation of the proposed
281 target's value will take this limitation into account.
282 - The code generation backend for the target should not have deficiencies that
283 invalidate Rust safety properties, as evaluated by the Rust compiler team.
284 (This requirement does not apply to arbitrary security enhancements or
285 mitigations provided by code generation backends, only to those properties
286 needed to ensure safe Rust code cannot cause undefined behavior or other
287 unsoundness.) If this requirement does not hold, the target must clearly and
288 prominently document any such limitations as part of the target's entry in
289 the target tier list, and ideally also via a failing test in the testsuite.
290 The Rust compiler team must be satisfied with the balance between these
291 limitations and the difficulty of implementing the necessary features.
292 - For example, if Rust relies on a specific code generation feature to ensure
293 that safe code cannot overflow the stack, the code generation for the
294 target should support that feature.
295 - If the Rust compiler introduces new safety properties (such as via new
296 capabilities of a compiler backend), the Rust compiler team will determine
297 if they consider those new safety properties a best-effort improvement for
298 specific targets, or a required property for all Rust targets. In the
299 latter case, the compiler team may require the maintainers of existing
300 targets to either implement and confirm support for the property or update
301 the target tier list with documentation of the missing property.
302 - If the target supports C code, and the target has an interoperable calling
303 convention for C code, the Rust target must support that C calling convention
304 for the platform via `extern "C"`. The C calling convention does not need to
305 be the default Rust calling convention for the target, however.
306 - The target must build reliably in CI, for all components that Rust's CI
307 considers mandatory.
308 - The approving teams may additionally require that a subset of tests pass in
309 CI, such as enough to build a functional "hello world" program, `./x.py test
310 --no-run`, or equivalent "smoke tests". In particular, this requirement may
311 apply if the target builds host tools, or if the tests in question provide
312 substantial value via early detection of critical problems.
313 - Building the target in CI must not take substantially longer than the current
314 slowest target in CI, and should not substantially raise the maintenance
315 burden of the CI infrastructure. This requirement is subjective, to be
316 evaluated by the infrastructure team, and will take the community importance
317 of the target into account.
318 - Tier 2 targets should, if at all possible, support cross-compiling. Tier 2
319 targets should not require using the target as the host for builds, even if
320 the target supports host tools.
321 - In addition to the legal requirements for all targets (specified in the tier
322 3 requirements), because a tier 2 target typically involves the Rust project
323 building and supplying various compiled binaries, incorporating the target
324 and redistributing any resulting compiled binaries (e.g. built libraries,
325 host tools if any) must not impose any onerous license requirements on any
326 members of the Rust project, including infrastructure team members and those
327 operating CI systems. This is a subjective requirement, to be evaluated by
328 the approving teams.
329 - As an exception to this, if the target's primary purpose is to build
330 components for a Free and Open Source Software (FOSS) project licensed
331 under "copyleft" terms (terms which require licensing other code under
332 compatible FOSS terms), such as kernel modules or plugins, then the
333 standard libraries for the target may potentially be subject to copyleft
334 terms, as long as such terms are satisfied by Rust's existing practices of
335 providing full corresponding source code. Note that anything added to the
336 Rust repository itself must still use Rust's standard license terms.
337 - Tier 2 targets must not impose burden on the authors of pull requests, or
338 other developers in the community, to ensure that tests pass for the target.
339 In particular, do not post comments (automated or manual) on a PR that derail
340 or suggest a block on the PR based on tests failing for the target. Do not
341 send automated messages or notifications (via any medium, including via `@`)
342 to a PR author or others involved with a PR regarding the PR breaking tests
343 on a tier 2 target, unless they have opted into such messages.
344 - Backlinks such as those generated by the issue/PR tracker when linking to
345 an issue or PR are not considered a violation of this policy, within
346 reason. However, such messages (even on a separate repository) must not
347 generate notifications to anyone involved with a PR who has not requested
348 such notifications.
349 - The target maintainers should regularly run the testsuite for the target, and
350 should fix any test failures in a reasonably timely fashion.
351 - All requirements for tier 3 apply.
352
353 A tier 2 target may be demoted or removed if it no longer meets these
354 requirements. Any proposal for demotion or removal will be CCed to the target
355 maintainers, and will be communicated widely to the Rust community before being
356 dropped from a stable release. (The amount of time between such communication
357 and the next stable release may depend on the nature and severity of the failed
358 requirement, the timing of its discovery, whether the target has been part of a
359 stable release yet, and whether the demotion or removal can be a planned and
360 scheduled action.)
361
362 In some circumstances, especially if the target maintainers do not respond in a
363 timely fashion, Rust teams may land pull requests that temporarily disable some
364 targets in the nightly compiler, in order to implement a feature not yet
365 supported by those targets. (As an example, this happened when introducing the
366 128-bit types `u128` and `i128`.) Such a pull request will include notification
367 and coordination with the maintainers of such targets, and will ideally happen
368 towards the beginning of a new development cycle to give maintainers time to
369 update their targets. The maintainers of such targets will then be expected to
370 implement the corresponding target-specific support in order to re-enable the
371 target. If the maintainers of such targets cannot provide such support in time
372 for the next stable release, this may result in demoting or removing the
373 targets.
374
375 ### Tier 2 with host tools
376
377 Some tier 2 targets may additionally have binaries built to run on them as a
378 host (such as `rustc` and `cargo`). This allows the target to be used as a
379 development platform, not just a compilation target.
380
381 A proposed new tier 2 target with host tools must be reviewed and approved by
382 the compiler team based on these requirements. Such review and approval may
383 occur via a Major Change Proposal (MCP).
384
385 In addition, the infrastructure team must approve the integration of the
386 target's host tools into Continuous Integration (CI), and the CI-related
387 requirements for host tools. This review and approval may take place in a PR
388 adding the target's host tools to CI, or simply by an infrastructure team
389 member reporting the outcome of a team discussion.
390
391 - Depending on the target, its capabilities, its performance, and the
392 likelihood of use for any given tool, the host tools provided for a tier 2
393 target may include only `rustc` and `cargo`, or may include additional tools
394 such as `clippy` and `rustfmt`.
395 - Approval of host tools will take into account the additional time required to
396 build the host tools, and the substantial additional storage required for the
397 host tools.
398 - The host tools must have direct value to people other than the target's
399 maintainers. (It may still be a niche target, but the host tools must not be
400 exclusively useful for an inherently closed group.) This requirement will be
401 evaluated independently from the corresponding tier 2 requirement.
402 - The requirement to provide "direct value" means that it does not suffice to
403 argue that having host tools will help the target's maintainers more easily
404 provide the target to others. The tools themselves must provide value to
405 others.
406 - There must be a reasonable expectation that the host tools will be used, for
407 purposes other than to prove that they can be used.
408 - The host tools must build and run reliably in CI (for all components that
409 Rust's CI considers mandatory), though they may or may not pass tests.
410 - Building host tools for the target must not take substantially longer than
411 building host tools for other targets, and should not substantially raise the
412 maintenance burden of the CI infrastructure.
413 - The host tools must provide a substantively similar experience as on other
414 targets, subject to reasonable target limitations.
415 - Adding a substantively different interface to an existing tool, or a
416 target-specific interface to the functionality of an existing tool,
417 requires design and implementation approval (e.g. RFC/MCP) from the
418 appropriate approving teams for that tool.
419 - Such an interface should have a design that could potentially work for
420 other targets with similar properties.
421 - This should happen separately from the review and approval of the target,
422 to simplify the target review and approval processes, and to simplify the
423 review and approval processes for the proposed new interface.
424 - By way of example, a target that runs within a sandbox may need to modify
425 the handling of files, tool invocation, and similar to meet the
426 expectations and conventions of the sandbox, but must not introduce a
427 separate "sandboxed compilation" interface separate from the CLI interface
428 without going through the normal approval process for such an interface.
429 Such an interface should take into account potential other targets with
430 similar sandboxes.
431 - If the host tools for the platform would normally be expected to be signed or
432 equivalent (e.g. if running unsigned binaries or similar involves a
433 "developer mode" or an additional prompt), it must be possible for the Rust
434 project's automated builds to apply the appropriate signature process,
435 without any manual intervention by either Rust developers, target
436 maintainers, or a third party. This process must meet the approval of the
437 infrastructure team.
438 - This process may require one-time or semi-regular manual steps by the
439 infrastructure team, such as registration or renewal of a signing key. Any
440 such manual process must meet the approval of the infrastructure team.
441 - This process may require the execution of a legal agreement with the
442 signature provider. Such a legal agreement may be revocable, and may
443 potentially require a nominal fee, but must not be otherwise onerous. Any
444 such legal agreement must meet the approval of the infrastructure team.
445 (The infrastructure team is not expected or required to sign binding legal
446 agreements on behalf of the Rust project; this review and approval exists
447 to ensure no terms are onerous or cause problems for infrastructure,
448 especially if such terms may impose requirements or obligations on people
449 who have access to target-specific infrastructure.)
450 - Changes to this process, or to any legal agreements involved, may
451 cause a target to stop meeting this requirement.
452 - This process involved must be available under substantially similar
453 non-onerous terms to the general public. Making it available exclusively to
454 the Rust project does not suffice.
455 - This requirement exists to ensure that Rust builds, including nightly
456 builds, can meet the necessary requirements to allow users to smoothly run
457 the host tools.
458 - Providing host tools does not exempt a target from requirements to support
459 cross-compilation if at all possible.
460 - All requirements for tier 2 apply.
461
462 A target may be promoted directly from tier 3 to tier 2 with host tools if it
463 meets all the necessary requirements, but doing so may introduce substantial
464 additional complexity. If in doubt, the target should qualify for tier 2
465 without host tools first.
466
467 ## Tier 1 target policy
468
469 At this tier, the Rust project guarantees that a target builds and passes all
470 tests, and will reject patches that fail to build or pass the testsuite on a
471 target. We hold tier 1 targets to our highest standard of requirements.
472
473 A proposed new tier 1 target must be reviewed and approved by the compiler team
474 based on these requirements. In addition, the release team must approve the
475 viability and value of supporting the target. For a tier 1 target, this will
476 typically take place via a full RFC proposing the target, to be jointly
477 reviewed and approved by the compiler team and release team.
478
479 In addition, the infrastructure team must approve the integration of the target
480 into Continuous Integration (CI), and the tier 1 CI-related requirements. This
481 review and approval may take place in a PR adding the target to CI, by an
482 infrastructure team member reporting the outcome of a team discussion, or by
483 including the infrastructure team in the RFC proposing the target.
484
485 - Tier 1 targets must have substantial, widespread interest within the
486 developer community, and must serve the ongoing needs of multiple production
487 users of Rust across multiple organizations or projects. These requirements
488 are subjective, and determined by consensus of the approving teams. A tier 1
489 target may be demoted or removed if it becomes obsolete or no longer meets
490 this requirement.
491 - The target maintainer team must include at least 3 developers.
492 - The target must build and pass tests reliably in CI, for all components that
493 Rust's CI considers mandatory.
494 - The target must not disable an excessive number of tests or pieces of tests
495 in the testsuite in order to do so. This is a subjective requirement.
496 - If the target does not have host tools support, or if the target has low
497 performance, the infrastructure team may choose to have CI cross-compile
498 the testsuite from another platform, and then run the compiled tests
499 either natively or via accurate emulation. However, the approving teams may
500 take such performance considerations into account when determining the
501 viability of the target or of its host tools.
502 - The target must provide as much of the Rust standard library as is feasible
503 and appropriate to provide. For instance, if the target can support dynamic
504 memory allocation, it must provide an implementation of `alloc` and the
505 associated data structures.
506 - Building the target and running the testsuite for the target must not take
507 substantially longer than other targets, and should not substantially raise
508 the maintenance burden of the CI infrastructure.
509 - In particular, if building the target takes a reasonable amount of time,
510 but the target cannot run the testsuite in a timely fashion due to low
511 performance of either native code or accurate emulation, that alone may
512 prevent the target from qualifying as tier 1.
513 - If running the testsuite requires additional infrastructure (such as physical
514 systems running the target), the target maintainers must arrange to provide
515 such resources to the Rust project, to the satisfaction and approval of the
516 Rust infrastructure team.
517 - Such resources may be provided via cloud systems, via emulation, or via
518 physical hardware.
519 - If the target requires the use of emulation to meet any of the tier
520 requirements, the approving teams for those requirements must have high
521 confidence in the accuracy of the emulation, such that discrepancies
522 between emulation and native operation that affect test results will
523 constitute a high-priority bug in either the emulation or the
524 implementation of the target.
525 - If it is not possible to run the target via emulation, these resources must
526 additionally be sufficient for the Rust infrastructure team to make them
527 available for access by Rust team members, for the purposes of development
528 and testing. (Note that the responsibility for doing target-specific
529 development to keep the target well maintained remains with the target
530 maintainers. This requirement ensures that it is possible for other
531 Rust developers to test the target, but does not obligate other Rust
532 developers to make target-specific fixes.)
533 - Resources provided for CI and similar infrastructure must be available for
534 continuous exclusive use by the Rust project. Resources provided
535 for access by Rust team members for development and testing must be
536 available on an exclusive basis when in use, but need not be available on a
537 continuous basis when not in use.
538 - Tier 1 targets must not have a hard requirement for signed, verified, or
539 otherwise "approved" binaries. Developers must be able to build, run, and
540 test binaries for the target on systems they control, or provide such
541 binaries for others to run. (Doing so may require enabling some appropriate
542 "developer mode" on such systems, but must not require the payment of any
543 additional fee or other consideration, or agreement to any onerous legal
544 agreements.)
545 - The Rust project may decide to supply appropriately signed binaries if
546 doing so provides a smoother experience for developers using the target,
547 and a tier 2 target with host tools already requires providing appropriate
548 mechanisms that enable our infrastructure to provide such signed binaries.
549 However, this additional tier 1 requirement ensures that Rust developers
550 can develop and test Rust software for the target (including Rust itself),
551 and that development or testing for the target is not limited.
552 - All requirements for tier 2 apply.
553
554 A tier 1 target may be demoted if it no longer meets these requirements but
555 still meets the requirements for a lower tier. Any proposal for demotion of a
556 tier 1 target requires a full RFC process, with approval by the compiler and
557 release teams. Any such proposal will be communicated widely to the Rust
558 community, both when initially proposed and before being dropped from a stable
559 release. A tier 1 target is highly unlikely to be directly removed without
560 first being demoted to tier 2 or tier 3. (The amount of time between such
561 communication and the next stable release may depend on the nature and severity
562 of the failed requirement, the timing of its discovery, whether the target has
563 been part of a stable release yet, and whether the demotion or removal can be a
564 planned and scheduled action.)
565
566 Raising the baseline expectations of a tier 1 target (such as the minimum CPU
567 features or OS version required) requires the approval of the compiler and
568 release teams, and should be widely communicated as well, but does not
569 necessarily require a full RFC.
570
571 ### Tier 1 with host tools
572
573 Some tier 1 targets may additionally have binaries built to run on them as a
574 host (such as `rustc` and `cargo`). This allows the target to be used as a
575 development platform, not just a compilation target.
576
577 A proposed new tier 1 target with host tools must be reviewed and approved by
578 the compiler team based on these requirements. In addition, the release team
579 must approve the viability and value of supporting host tools for the target.
580 For a tier 1 target, this will typically take place via a full RFC proposing
581 the target, to be jointly reviewed and approved by the compiler team and
582 release team.
583
584 In addition, the infrastructure team must approve the integration of the
585 target's host tools into Continuous Integration (CI), and the CI-related
586 requirements for host tools. This review and approval may take place in a PR
587 adding the target's host tools to CI, by an infrastructure team member
588 reporting the outcome of a team discussion, or by including the infrastructure
589 team in the RFC proposing the target.
590
591 - Tier 1 targets with host tools should typically include all of the additional
592 tools such as `clippy` and `rustfmt`, unless there is a target-specific
593 reason why a tool cannot possibly make sense for the target.
594 - Unlike with tier 2, for tier 1 we will not exclude specific tools on the
595 sole basis of them being less likely to be used; rather, we'll take that
596 into account when considering whether the target should be at tier 1 with
597 host tools. In general, on any tier 1 target with host tools, people
598 should be able to expect to find and install all the same components that
599 they would for any other tier 1 target with host tools.
600 - Approval of host tools will take into account the additional time required to
601 build the host tools, and the substantial additional storage required for the
602 host tools.
603 - Host tools for the target must have substantial, widespread interest within
604 the developer community, and must serve the ongoing needs of multiple
605 production users of Rust across multiple organizations or projects. These
606 requirements are subjective, and determined by consensus of the approving
607 teams. This requirement will be evaluated independently from the
608 corresponding tier 1 requirement; it is possible for a target to have
609 sufficient interest for cross-compilation, but not have sufficient interest
610 for native compilation. The host tools may be dropped if they no longer meet
611 this requirement, even if the target otherwise qualifies as tier 1.
612 - The host tools must build, run, and pass tests reliably in CI, for all
613 components that Rust's CI considers mandatory.
614 - The target must not disable an excessive number of tests or pieces of tests
615 in the testsuite in order to do so. This is a subjective requirement.
616 - Building the host tools and running the testsuite for the host tools must not
617 take substantially longer than other targets, and should not substantially raise
618 the maintenance burden of the CI infrastructure.
619 - In particular, if building the target's host tools takes a reasonable
620 amount of time, but the target cannot run the testsuite in a timely fashion
621 due to low performance of either native code or accurate emulation, that
622 alone may prevent the target from qualifying as tier 1 with host tools.
623 - Providing host tools does not exempt a target from requirements to support
624 cross-compilation if at all possible.
625 - All requirements for tier 2 targets with host tools apply.
626 - All requirements for tier 1 apply.
627
628 A target seeking promotion to tier 1 with host tools should typically either be
629 tier 2 with host tools or tier 1 without host tools, to reduce the number of
630 requirements to simultaneously review and approve.
631
632 In addition to the general process for demoting a tier 1 target, a tier 1
633 target with host tools may be demoted (including having its host tools dropped,
634 or being demoted to tier 2 with host tools) if it no longer meets these
635 requirements but still meets the requirements for a lower tier. Any proposal
636 for demotion of a tier 1 target (with or without host tools) requires a full
637 RFC process, with approval by the compiler and release teams. Any such proposal
638 will be communicated widely to the Rust community, both when initially proposed
639 and before being dropped from a stable release.