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.

Sign up for GitHub

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

Jump to bottom

[JENKINS-72833] Do not attempt to self-exec on systems without libc #9025

Merged
merged 1 commit into from Mar 10, 2024
Merged

[JENKINS-72833] Do not attempt to self-exec on systems without libc #9025

merged 1 commit into from Mar 10, 2024

Conversation

basil
Copy link
Member

@basil basil commented Mar 8, 2024

See JENKINS-72833. We were attempting to use UnixLifecycle on a system not supported by JNA.

While I was here I also did some other cleanup of this class.

Testing done

Tested /safeRestart on Linux both inside and outside systemd.

Proposed changelog entries

  • Do not attempt to self-restart on operating systems where this is not supported.

Proposed upgrade guidelines

N/A

Submitter checklist

Edit tasklist title
Beta Give feedback Tasklist Submitter checklist, more options

Delete tasklist

Delete tasklist block?
Are you sure? All relationships in this tasklist will be removed.
  1. The Jira issue, if it exists, is well-described.
    Options
  2. The changelog entries and upgrade guidelines are appropriate for the audience affected by the change (users or developers, depending on the change) and are in the imperative mood (see examples). Fill in the Proposed upgrade guidelines section only if there are breaking changes or changes that may require extra steps from users during upgrade.
    Options
  3. There is automated testing or an explanation as to why this change has no tests.
    Options
  4. New public classes, fields, and methods are annotated with @Restricted or have @since TODO Javadocs, as appropriate.
    Options
  5. New deprecations are annotated with @Deprecated(since = "TODO") or @Deprecated(forRemoval = true, since = "TODO"), if applicable.
    Options
  6. New or substantially changed JavaScript is not defined inline and does not call eval to ease future introduction of Content Security Policy (CSP) directives (see documentation).
    Options
  7. For dependency updates, there are links to external changelogs and, if possible, full differentials.
    Options
  8. For new APIs and extension points, there is a link to at least one consumer.
    Options

Desired reviewers

@mention

Before the changes are marked as ready-for-merge:

Maintainer checklist

Edit tasklist title
Beta Give feedback Tasklist Maintainer checklist, more options

Delete tasklist

Delete tasklist block?
Are you sure? All relationships in this tasklist will be removed.
  1. There are at least two (2) approvals for the pull request and no outstanding requests for change.
    Options
  2. Conversations in the pull request are over, or it is explicit that a reviewer is not blocking the change.
    Options
  3. Changelog entries in the pull request title and/or Proposed changelog entries are accurate, human-readable, and in the imperative mood.
    Options
  4. Proper changelog labels are set so that the changelog can be generated automatically.
    Options
  5. If the change needs additional upgrade steps from users, the upgrade-guide-needed label is set and there is a Proposed upgrade guidelines section in the pull request title (see example).
    Options
  6. If it would make sense to backport the change to LTS, a Jira issue must exist, be a Bug or Improvement, and be labeled as lts-candidate to be considered (see query).
    Options

@basil basil added the bug For changelog: Minor bug. Will be listed after features label Mar 8, 2024
basil
basil commented Mar 8, 2024
View reviewed changes
core/src/main/java/hudson/lifecycle/Lifecycle.java
@@ -120,13 +120,13 @@ public void verifyRestartable() throws RestartNotSupportedException {
// if run on Unix, we can do restart
try {
instance = new UnixLifecycle();
} catch (final IOException e) {
LOGGER.log(Level.WARNING, "Failed to install embedded lifecycle implementation", e);
} catch (final Throwable t) {
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Dead code, since this constructor could never in fact throw IOException, but I thought it best to keep this fallback since any unanticipated errors here should not be fatal.

core/src/main/java/hudson/lifecycle/UnixLifecycle.java
@@ -50,16 +52,12 @@
* @since 1.304
*/
public class UnixLifecycle extends Lifecycle {

@NonNull
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This can never be null, so annotate it as such.

core/src/main/java/hudson/lifecycle/UnixLifecycle.java

public UnixLifecycle() throws IOException {
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This can never throw IOException, so stop declaring it.

core/src/main/java/hudson/lifecycle/UnixLifecycle.java
Comment on lines -57 to -62
try {
args = JavaVMArguments.current();
} catch (UnsupportedOperationException | LinkageError e) {
// can't restart / see JENKINS-3875
failedToObtainArgs = e;
}
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was based on the old implementation, which used Akuma. That was ripped out a long time ago, and these exceptions shouldn't be thrown in the current implementation. But just to be on the safe side, we're now catching Throwable in the caller, so this shouldn't result in a regression in any case.

core/src/main/java/hudson/lifecycle/UnixLifecycle.java
Comment on lines +90 to +92
if (!Functions.isGlibcSupported()) {
throw new RestartNotSupportedException("Restart is not supported on platforms without libc");
}
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The fix for JENKINS-72833: do not attempt to use UnixLifecycle if JNA can't make calls to libc.

core/src/main/java/hudson/lifecycle/UnixLifecycle.java
Comment on lines -100 to -101
if (args == null)
throw new RestartNotSupportedException("Failed to obtain the command line arguments of the process", failedToObtainArgs);
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Dead code, since args can never be null.

core/src/main/java/jenkins/util/JavaVMArguments.java
@@ -30,7 +31,7 @@ public static List<String> current() {
return args;
} else if (Functions.isGlibcSupported()) {
// Native approach
int pid = Ints.checkedCast(ProcessHandle.current().pid());
int pid = Math.toIntExact(ProcessHandle.current().pid());
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unnecessary use of Guava.

NotMyFault
NotMyFault approved these changes Mar 9, 2024
View reviewed changes
Copy link
Member

@NotMyFault NotMyFault left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/label ready-for-merge

This PR is now ready for merge. We will merge it after ~24 hours if there is no negative feedback.
Please see the merge process documentation for more information about the merge process.
Thanks!

@comment-ops-bot comment-ops-bot bot added the ready-for-merge The PR is ready to go, and it will be merged soon if there is no negative feedback label Mar 9, 2024
@NotMyFault NotMyFault merged commit 434bf2b into jenkinsci:master Mar 10, 2024
16 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@MarkEWaite MarkEWaite MarkEWaite approved these changes

@NotMyFault NotMyFault NotMyFault approved these changes

@StefanSpieker StefanSpieker StefanSpieker approved these changes

Assignees
No one assigned
Labels
bug For changelog: Minor bug. Will be listed after features ready-for-merge The PR is ready to go, and it will be merged soon if there is no negative feedback
Projects
None yet
Milestone
No milestone
4 participants
@basil @MarkEWaite @NotMyFault @StefanSpieker