set_process_title.cc revision 5821806d5e7f356e8fa4b058a389a808ea183019
15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Copyright (c) 2012 The Chromium Authors. All rights reserved.
25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Use of this source code is governed by a BSD-style license that can be
35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// found in the LICENSE file.
45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
55821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "content/common/set_process_title.h"
65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "build/build_config.h"
85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#if defined(OS_POSIX) && !defined(OS_MACOSX) && !defined(OS_SOLARIS)
105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <limits.h>
115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <stdlib.h>
125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <unistd.h>
135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <string>
155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/command_line.h"
175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif  // defined(OS_POSIX) && !defined(OS_MACOSX) && !defined(OS_SOLARIS)
185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#if defined(OS_LINUX)
205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <sys/prctl.h>
215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/file_path.h"
235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/file_util.h"
245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/process_util.h"
255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/string_util.h"
265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Linux/glibc doesn't natively have setproctitle().
275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "content/common/set_process_title_linux.h"
285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif  // defined(OS_LINUX)
295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace content {
315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// TODO(jrg): Find out if setproctitle or equivalent is available on Android.
335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#if defined(OS_POSIX) && !defined(OS_MACOSX) && !defined(OS_SOLARIS) && \
345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  !defined(OS_ANDROID)
355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void SetProcessTitleFromCommandLine(const char** main_argv) {
375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // Build a single string which consists of all the arguments separated
385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // by spaces. We can't actually keep them separate due to the way the
395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // setproctitle() function works.
405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  std::string title;
415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  bool have_argv0 = false;
425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#if defined(OS_LINUX)
445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  if (main_argv)
455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    setproctitle_init(main_argv);
465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // In Linux we sometimes exec ourselves from /proc/self/exe, but this makes us
485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // show up as "exe" in process listings. Read the symlink /proc/self/exe and
495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // use the path it points at for our process title. Note that this is only for
505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // display purposes and has no TOCTTOU security implications.
515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  FilePath target;
525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  FilePath self_exe(base::kProcSelfExe);
535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  if (file_util::ReadSymbolicLink(self_exe, &target)) {
545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    have_argv0 = true;
555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    title = target.value();
565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    // If the binary has since been deleted, Linux appends " (deleted)" to the
575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    // symlink target. Remove it, since this is not really part of our name.
585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    const std::string kDeletedSuffix = " (deleted)";
595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    if (EndsWith(title, kDeletedSuffix, true))
605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)      title.resize(title.size() - kDeletedSuffix.size());
615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#if defined(PR_SET_NAME)
625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    // If PR_SET_NAME is available at compile time, we try using it. We ignore
635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    // any errors if the kernel does not support it at runtime though. When
645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    // available, this lets us set the short process name that shows when the
655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    // full command line is not being displayed in most process listings.
665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    prctl(PR_SET_NAME, FilePath(title).BaseName().value().c_str());
675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif  // defined(PR_SET_NAME)
685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  }
695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif  // defined(OS_LINUX)
705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  const CommandLine* command_line = CommandLine::ForCurrentProcess();
725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  for (size_t i = 1; i < command_line->argv().size(); ++i) {
735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    if (!title.empty())
745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)      title += " ";
755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    title += command_line->argv()[i];
765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  }
775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // Disable prepending argv[0] with '-' if we prepended it ourselves above.
785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  setproctitle(have_argv0 ? "-%s" : "%s", title.c_str());
795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#else
825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// All other systems (basically Windows & Mac) have no need or way to implement
845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// this function.
855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void SetProcessTitleFromCommandLine(const char** /* main_argv */) {
865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif
895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} // namespace content
91