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

Fix rust breakage with nr2 #3266

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions gcc/rust/Make-lang.in
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,7 @@ GRS_OBJS = \
rust/rust-toplevel-name-resolver-2.0.o \
rust/rust-early-name-resolver-2.0.o \
rust/rust-finalize-imports-2.0.o \
rust/rust-ice-finalizer.o \
rust/rust-late-name-resolver-2.0.o \
rust/rust-immutable-name-resolution-context.o \
rust/rust-early-name-resolver.o \
Expand Down
41 changes: 1 addition & 40 deletions gcc/rust/resolve/rust-ast-resolve-expr.cc
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@
#include "rust-ast-resolve-type.h"
#include "rust-ast-resolve-pattern.h"
#include "rust-ast-resolve-path.h"
#include "diagnostic.h"
#include "rust-expr.h"
#include "rust-ice-finalizer.h"

namespace Rust {
namespace Resolver {
Expand Down Expand Up @@ -108,45 +108,6 @@ ResolveExpr::visit (AST::AssignmentExpr &expr)
ResolveExpr::go (expr.get_right_expr (), prefix, canonical_prefix);
}

/* The "break rust" Easter egg.

Backstory: once upon a time, there used to be a bug in rustc: it would ICE
during typechecking on a 'break' with an expression outside of a loop. The
issue has been reported [0] and fixed [1], but in recognition of this, as a
special Easter egg, "break rust" was made to intentionally cause an ICE.

[0]: https://github.com/rust-lang/rust/issues/43162
[1]: https://github.com/rust-lang/rust/pull/43745

This was made in a way that does not break valid programs: namely, it only
happens when the 'break' is outside of a loop (so invalid anyway).

GCC Rust supports this essential feature as well, but in a slightly
different way. Instead of delaying the error until type checking, we emit
it here in the resolution phase. We, too, only do this to programs that
are already invalid: we only emit our funny ICE if the name "rust" (which
must be immediately inside a break-with-a-value expression) fails to
resolve. Note that "break (rust)" does not trigger our ICE, only using
"break rust" directly does, and only if there's no "rust" in scope. We do
this in the same way regardless of whether the "break" is outside of a loop
or inside one.

As a GNU extension, we also support "break gcc", much to the same effect,
subject to the same rules. */

/* The finalizer for our funny ICE. This prints a custom message instead of
the default bug reporting instructions, as there is no bug to report. */

static void ATTRIBUTE_NORETURN
funny_ice_finalizer (diagnostic_context *context,
const diagnostic_info *diagnostic, diagnostic_t diag_kind)
{
gcc_assert (diag_kind == DK_ICE_NOBT);
default_diagnostic_finalizer (context, diagnostic, diag_kind);
fnotice (stderr, "You have broken GCC Rust. This is a feature.\n");
exit (ICE_EXIT_CODE);
}

void
ResolveExpr::visit (AST::IdentifierExpr &expr)
{
Expand Down
35 changes: 35 additions & 0 deletions gcc/rust/resolve/rust-ice-finalizer.cc
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
// Copyright (C) 2020-2024 Free Software Foundation, Inc.

// This file is part of GCC.

// GCC is free software; you can redistribute it and/or modify it under
// the terms of the GNU General Public License as published by the Free
// Software Foundation; either version 3, or (at your option) any later
// version.

// GCC is distributed in the hope that it will be useful, but WITHOUT ANY
// WARRANTY; without even the implied warranty of MERCHANTABILITY or
// FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
// for more details.

// You should have received a copy of the GNU General Public License
// along with GCC; see the file COPYING3. If not see
// <http://www.gnu.org/licenses/>.

#include "rust-ice-finalizer.h"

namespace Rust {
namespace Resolver {

void ATTRIBUTE_NORETURN
funny_ice_finalizer (diagnostic_context *context,
const diagnostic_info *diagnostic, diagnostic_t diag_kind)
{
gcc_assert (diag_kind == DK_ICE_NOBT);
default_diagnostic_finalizer (context, diagnostic, diag_kind);
fnotice (stderr, "You have broken GCC Rust. This is a feature.\n");
exit (ICE_EXIT_CODE);
}

} // namespace Resolver
} // namespace Rust
64 changes: 64 additions & 0 deletions gcc/rust/resolve/rust-ice-finalizer.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
// Copyright (C) 2020-2024 Free Software Foundation, Inc.

// This file is part of GCC.

// GCC is free software; you can redistribute it and/or modify it under
// the terms of the GNU General Public License as published by the Free
// Software Foundation; either version 3, or (at your option) any later
// version.

// GCC is distributed in the hope that it will be useful, but WITHOUT ANY
// WARRANTY; without even the implied warranty of MERCHANTABILITY or
// FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
// for more details.

// You should have received a copy of the GNU General Public License
// along with GCC; see the file COPYING3. If not see
// <http://www.gnu.org/licenses/>.

#ifndef RUST_ICE_FINALIZER_H
#define RUST_ICE_FINALIZER_H

#include "rust-linemap.h"
#include "diagnostic.h"

namespace Rust {
namespace Resolver {

/* The "break rust" Easter egg.
Backstory: once upon a time, there used to be a bug in rustc: it would ICE
during typechecking on a 'break' with an expression outside of a loop. The
issue has been reported [0] and fixed [1], but in recognition of this, as a
special Easter egg, "break rust" was made to intentionally cause an ICE.
[0]: https://github.com/rust-lang/rust/issues/43162
[1]: https://github.com/rust-lang/rust/pull/43745
This was made in a way that does not break valid programs: namely, it only
happens when the 'break' is outside of a loop (so invalid anyway).
GCC Rust supports this essential feature as well, but in a slightly
different way. Instead of delaying the error until type checking, we emit
it here in the resolution phase. We, too, only do this to programs that
are already invalid: we only emit our funny ICE if the name "rust" (which
must be immediately inside a break-with-a-value expression) fails to
resolve. Note that "break (rust)" does not trigger our ICE, only using
"break rust" directly does, and only if there's no "rust" in scope. We do
this in the same way regardless of whether the "break" is outside of a loop
or inside one.
As a GNU extension, we also support "break gcc", much to the same effect,
subject to the same rules. */

/* The finalizer for our funny ICE. This prints a custom message instead of
the default bug reporting instructions, as there is no bug to report. */

void ATTRIBUTE_NORETURN
funny_ice_finalizer (diagnostic_context *context,
const diagnostic_info *diagnostic, diagnostic_t diag_kind);

} // namespace Resolver
} // namespace Rust

#endif /* ! RUST_ICE_FINALIZER_H */
37 changes: 37 additions & 0 deletions gcc/rust/resolve/rust-late-name-resolver-2.0.cc
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@

#include "optional.h"
#include "rust-ast-full.h"
#include "rust-ast.h"
#include "rust-hir-map.h"
#include "rust-late-name-resolver-2.0.h"
#include "rust-default-resolver.h"
Expand All @@ -26,6 +27,7 @@
#include "rust-system.h"
#include "rust-tyty.h"
#include "rust-hir-type-check.h"
#include "rust-ice-finalizer.h"

namespace Rust {
namespace Resolver2_0 {
Expand Down Expand Up @@ -176,6 +178,34 @@ Late::visit (AST::SelfParam &param)
param.get_node_id ());
}

void
Late::visit (AST::BreakExpr &expr)
{
if (expr.has_break_expr ())
{
auto &break_expr = expr.get_break_expr ();
if (break_expr.get_ast_kind () == AST::Kind::IDENTIFIER)
{
/* This is a break with an expression, and the expression is
just a single identifier. See if the identifier is either
"rust" or "gcc", in which case we have "break rust" or "break
gcc", and so may need to emit our funny error. We cannot yet
emit the error here though, because the identifier may still
be in scope, and ICE'ing on valid programs would not be very
funny. */
std::string ident
= static_cast<AST::IdentifierExpr &> (expr.get_break_expr ())
.as_string ();
if (ident == "rust" || ident == "gcc")
funny_error = true;
}
}

DefaultResolver::visit (expr);

funny_error = false;
}

void
Late::visit (AST::IdentifierExpr &expr)
{
Expand All @@ -191,6 +221,13 @@ Late::visit (AST::IdentifierExpr &expr)
{
resolved = type;
}
else if (funny_error)
{
diagnostic_finalizer (global_dc) = Resolver::funny_ice_finalizer;
emit_diagnostic (DK_ICE_NOBT, expr.get_locus (), -1,
"are you trying to break %s? how dare you?",
expr.as_string ().c_str ());
}
else
{
rust_error_at (expr.get_locus (),
Expand Down
3 changes: 3 additions & 0 deletions gcc/rust/resolve/rust-late-name-resolver-2.0.h
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ class Late : public DefaultResolver

// resolutions
void visit (AST::IdentifierExpr &) override;
void visit (AST::BreakExpr &) override;
void visit (AST::PathInExpression &) override;
void visit (AST::TypePath &) override;
void visit (AST::StructExprStruct &) override;
Expand All @@ -57,6 +58,8 @@ class Late : public DefaultResolver
private:
/* Setup Rust's builtin types (u8, i32, !...) in the resolver */
void setup_builtin_types ();

bool funny_error;
};

// TODO: Add missing mappings and data structures
Expand Down
1 change: 0 additions & 1 deletion gcc/testsuite/rust/compile/nr2/exclude
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ attr_deprecated_2.rs
bad=file-name.rs
bounds1.rs
break-rust2.rs
break-rust3.rs
macros/builtin/eager1.rs
macros/builtin/eager2.rs
macros/builtin/recurse2.rs
Expand Down
Loading