[Lldb-commits] [PATCH] D106226: [lldb] Improve error message when "lldb attach" fails

[APOORV SACHAN via Phabricator via lldb-commits]

apoos-maximus updated this revision to Diff 370960.
apoos-maximus added a comment.

Changed the error message to be more informative, and added things,
based on the previous review.


Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D106226/new/

https://reviews.llvm.org/D106226

Files:
  lldb/source/Target/Target.cpp


Index: lldb/source/Target/Target.cpp
===================================================================
--- lldb/source/Target/Target.cpp
+++ lldb/source/Target/Target.cpp
@@ -3118,6 +3118,54 @@
   return CreateTrace();
 }
 
+const char *fetchPtracePolicyIfApplicable(lldb::PlatformSP platform_sp) {
+  FileSpec filespec =
+      FileSpec(llvm::StringRef("/proc/sys/kernel/yama/ptrace_scope"));
+  char ptrace_scope = '\0';
+  char *status_message = NULL;
+
+  // check if /proc/sys/kernel/yama/ptrace_scope file exists
+  if (platform_sp->GetFileExists(filespec)) {
+    Status fileOperationStatus = Status();
+    mode_t perms = lldb::eFilePermissionsUserRW |
+                   lldb::eFilePermissionsGroupRead |
+                   lldb::eFilePermissionsWorldRead;
+    lldb::user_id_t fd = platform_sp->OpenFile(
+        filespec, File::eOpenOptionReadOnly, perms, fileOperationStatus);
+
+    platform_sp->ReadFile(fd, 0, &ptrace_scope, sizeof(char),
+                          fileOperationStatus);
+    platform_sp->CloseFile(fd, fileOperationStatus);
+
+    // return ptrace policy message only if ptrace_scope value is not zero
+    // i.e. ptrace_scope is the reason behind attach fail
+    if (ptrace_scope != '0') {
+      status_message =
+          "Note that attaching might have failed due to the ptrace_scope "
+          "security policy \n"
+          "which restricts debuggers from attaching to other processes.\n"
+
+          "\nSee the ptrace_scope documentation for more information: \n"
+          "\thttps://www.kernel.org/doc/Documentation/security/Yama.txt \n"
+
+          "\nThe current ptrace_scope policy can be found here: \n"
+          "\t/proc/sys/kernel/yama/ptrace_scope\n"
+
+          "\nTo Enable the debugger to attach to the process, run:\n"
+          "\nsudo sysctl -w kernel.yama.ptrace_scope=0\n";
+    } else {
+      status_message = "Try again as the root user";
+    }
+  }
+
+  // simply return try as Root user if file doesn't exist
+  else {
+    status_message = "Try again as the root user";
+  }
+
+  return status_message;
+}
+
 Status Target::Attach(ProcessAttachInfo &attach_info, Stream *stream) {
   auto state = eStateInvalid;
   auto process_sp = GetProcessSP();
@@ -3188,9 +3236,14 @@
 
       if (state != eStateStopped) {
         const char *exit_desc = process_sp->GetExitDescription();
-        if (exit_desc)
-          error.SetErrorStringWithFormat("%s", exit_desc);
-        else
+        const char *ptrace_reason = "";
+        if (exit_desc) {
+          // If we are on a linux flavoured system
+          if (platform_sp->GetSystemArchitecture().GetTriple().isOSLinux()) {
+            ptrace_reason = fetchPtracePolicyIfApplicable(platform_sp);
+          }
+          error.SetErrorStringWithFormat("%s\n%s", exit_desc, ptrace_reason);
+        } else
           error.SetErrorString(
               "process did not stop (no such process or permission problem?)");
         process_sp->Destroy(false);


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D106226.370960.patch
Type: text/x-patch
Size: 2988 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/lldb-commits/attachments/20210906/090f0ace/attachment.bin>