Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Unsafe Extern Blocks #3484

Merged
merged 29 commits into from
May 20, 2024
Merged

Commits on Sep 7, 2023

  1. add rfc text

    Lokathor committed Sep 7, 2023
    Configuration menu
    Copy the full SHA
    63441ea View commit details
    Browse the repository at this point in the history
  2. Update text/0000-unsafe-extern-blocks.md

    Co-authored-by: Jacob Lifshay <programmerjake@gmail.com>
    Lokathor and programmerjake authored Sep 7, 2023
    Configuration menu
    Copy the full SHA
    726478f View commit details
    Browse the repository at this point in the history

Commits on Mar 25, 2024

  1. per rust-lang#3484 (comment)

    Lokathor committed Mar 25, 2024
    Configuration menu
    Copy the full SHA
    47949ec View commit details
    Browse the repository at this point in the history
  2. typo: missing "have"

    Lokathor committed Mar 25, 2024
    Configuration menu
    Copy the full SHA
    0637684 View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    3fa1a61 View commit details
    Browse the repository at this point in the history
  4. typo: remove "of"

    Lokathor committed Mar 25, 2024
    Configuration menu
    Copy the full SHA
    7754241 View commit details
    Browse the repository at this point in the history

Commits on Mar 31, 2024

  1. Update text/0000-unsafe-extern-blocks.md

    Co-authored-by: Waffle Maybe <waffle.lapkin@gmail.com>
    Lokathor and WaffleLapkin authored Mar 31, 2024
    Configuration menu
    Copy the full SHA
    2144ac3 View commit details
    Browse the repository at this point in the history

Commits on Apr 1, 2024

  1. Update text/0000-unsafe-extern-blocks.md

    Co-authored-by: Jacob Lifshay <programmerjake@gmail.com>
    Lokathor and programmerjake authored Apr 1, 2024
    Configuration menu
    Copy the full SHA
    676383f View commit details
    Browse the repository at this point in the history

Commits on Apr 2, 2024

  1. Update text/0000-unsafe-extern-blocks.md

    Co-authored-by: Waffle Maybe <waffle.lapkin@gmail.com>
    Lokathor and WaffleLapkin authored Apr 2, 2024
    Configuration menu
    Copy the full SHA
    d5bb7db View commit details
    Browse the repository at this point in the history

Commits on May 6, 2024

  1. Cleanup whitespace

    traviscross committed May 6, 2024
    Configuration menu
    Copy the full SHA
    6dba902 View commit details
    Browse the repository at this point in the history
  2. Improve wording of the drawback

    During the FCP, people noticed that the wording of the drawback
    probably fit better with an earlier draft of this RFC.  Let's
    incorporate that feedback before merging.
    
    (Thanks to Waffle for raising this point.)
    traviscross committed May 6, 2024
    Configuration menu
    Copy the full SHA
    23f0acf View commit details
    Browse the repository at this point in the history
  3. Improve wording of where safe is allowed

    Let's improve the wording related to where the `safe` keyword is
    allowed.
    
    (Thanks to Waffle for raising this point.)
    traviscross committed May 6, 2024
    Configuration menu
    Copy the full SHA
    1cef026 View commit details
    Browse the repository at this point in the history
  4. Fix typo

    (Thanks to spastorino for noticing this.)
    traviscross committed May 6, 2024
    Configuration menu
    Copy the full SHA
    842bd55 View commit details
    Browse the repository at this point in the history
  5. Clarify extent of UB

    An incorrect declaration in an `extern` block may cause undefined
    behavior in the resulting program.  Let's clarify that in the text.
    
    (Thanks to Waffle for raising this point.)
    traviscross committed May 6, 2024
    Configuration menu
    Copy the full SHA
    176d73f View commit details
    Browse the repository at this point in the history
  6. Clarify what we're replacing in the Reference

    This RFC suggests replacements to text within the Rust Reference.
    Let's clarify where those sections are.
    
    (Thanks to Waffle for raising this point.)
    traviscross committed May 6, 2024
    Configuration menu
    Copy the full SHA
    60631ce View commit details
    Browse the repository at this point in the history
  7. Add reference to Rust issue 46188

    There's a long history of discussion on how incorrect declarations in
    `extern` blocks might cause UB in programs compiled using LLVM.  Let's
    link to one of the issues in that history.
    
    (Thanks to madsmtm for raising this question, and to RalfJ for
    providing this citation.)
    traviscross committed May 6, 2024
    Configuration menu
    Copy the full SHA
    fc53654 View commit details
    Browse the repository at this point in the history
  8. Clarify that we will "eventually" lint

    This RFC means to specify that we will *eventually* issue a lint in
    all editions when `extern` is not prefixed with `unsafe`.  Let's
    specify this more clearly.
    
    (Thanks to Waffle and joshtriplett for raising this point.)
    traviscross committed May 6, 2024
    Configuration menu
    Copy the full SHA
    5cc4cc3 View commit details
    Browse the repository at this point in the history
  9. Unwrap lines

    This document had a mix of line wrapping styles.  Let's consistently
    unwrap the lines.
    traviscross committed May 6, 2024
    Configuration menu
    Copy the full SHA
    4684d53 View commit details
    Browse the repository at this point in the history
  10. Lowercase "undefined behavior"

    The term "undefined behavior" is not a proper noun, so let's make this
    lowercase.
    traviscross committed May 6, 2024
    Configuration menu
    Copy the full SHA
    b423b2b View commit details
    Browse the repository at this point in the history

Commits on May 7, 2024

  1. Address feedback and questions

    As this RFC was reviewed in the GitHub thread, many alternatives were
    proposed and questions raised.  As those of us who were a bit too
    close to it were cursed with knowledge, the rationale for rejecting
    these alternatives were not fully articulated and not all of these
    questions were clearly answered.
    
    Let's better document these alternatives, the rationale for rejecting
    each, and the answers to various known questions.
    
    (Thanks to GoldsteinE, madsmtm, kennytm, samih, and tmccombs for
    raising these alternatives and questions.)
    traviscross committed May 7, 2024
    Configuration menu
    Copy the full SHA
    09a088c View commit details
    Browse the repository at this point in the history
  2. Add alternative of fixing LLVM (if it is a fix)

    One possibility we should mention is that of changing the behavior of
    LLVM and then not adding `unsafe extern`, so let's mention that.
    
    (Thanks to RalfJ for raising this point.)
    traviscross committed May 7, 2024
    Configuration menu
    Copy the full SHA
    ca7713c View commit details
    Browse the repository at this point in the history
  3. Clarify about fixing LLVM despite C

    Even if the C standard allows for what LLVM is doing, we could still
    conceivably fix LLVM.  In the text, let's draw this out a bit more
    finely.
    
    (Thanks to RalfJ for raising this point.)
    traviscross committed May 7, 2024
    Configuration menu
    Copy the full SHA
    efc671c View commit details
    Browse the repository at this point in the history
  4. Clarify about unsafe_code and edition migration

    When people migrate to the new edition, if they have turned up the
    severity of the `unsafe_code` lint and they have `extern` blocks that
    need to be marked `unsafe`, they will see this lint as intended.
    Let's make a note of that.
    
    (Thanks to kennytm for raising this point.)
    traviscross committed May 7, 2024
    Configuration menu
    Copy the full SHA
    2c106c3 View commit details
    Browse the repository at this point in the history
  5. Fix typo

    traviscross committed May 7, 2024
    Configuration menu
    Copy the full SHA
    c1192da View commit details
    Browse the repository at this point in the history
  6. Remove issue 46188 as a motivation

    This RFC had used as one motivation that undefined behavior can
    currently result simply from having an incorrect `extern` block even
    if the items within are not used from Rust code.
    
    This motivation was not cited in the lang team's 2023-10-11 consensus
    for how and why to proceed with this RFC, and it's possible that we
    may be able to resolve this issue in other ways, so let's remove that
    motivation from this RFC.
    
    (Thanks to RalfJ for raising this point and suggesting this.)
    traviscross committed May 7, 2024
    Configuration menu
    Copy the full SHA
    9f36a92 View commit details
    Browse the repository at this point in the history
  7. Configuration menu
    Copy the full SHA
    c198396 View commit details
    Browse the repository at this point in the history
  8. Fix optionality of safe/unsafe in guide section

    The 2023-10-11 consensus from lang on how to move forward included
    that the `safe` and `unsafe` keywords would be optional within an
    `unsafe extern` block.
    
    The reference-level section correctly followed this consensus, but the
    guide-level section did not, and suggested that annotating items with
    these keywords was required.  Let's fix that.
    traviscross committed May 7, 2024
    Configuration menu
    Copy the full SHA
    39795a0 View commit details
    Browse the repository at this point in the history

Commits on May 19, 2024

  1. Prepare RFC 3484 to be merged

    The FCP for RFC 3484 has completed with a disposition to merge.  Let's
    prepare to merge it.
    traviscross committed May 19, 2024
    Configuration menu
    Copy the full SHA
    3b6ae2b View commit details
    Browse the repository at this point in the history

Commits on May 20, 2024

  1. Do some copyediting

    We had earlier made clarifying edits to many sections, but not to all
    of them.  Let's clarify some text in these remaining sections.
    traviscross committed May 20, 2024
    Configuration menu
    Copy the full SHA
    45590fe View commit details
    Browse the repository at this point in the history