ipc/chromium/src/chrome/common/child_process_info.h
author Benjamin Smedberg <benjamin@smedbergs.us>
Mon, 29 Jun 2009 08:35:58 -0400
changeset 35729 6fd4bb500d425c406c1b52f66e5b195b20ae5e0a
child 84338 f357bdd35f1b6808566b94ba7dee14e4d9630719
permissions -rw-r--r--
Import Chromium sources r15462

// Copyright (c) 2009 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef CHROME_COMMON_CHILD_PROCESS_INFO_H_
#define CHROME_COMMON_CHILD_PROCESS_INFO_H_

#include <string>

#include "base/process.h"

// Holds information about a child process.
class ChildProcessInfo {
 public:
  enum ProcessType {
    BROWSER_PROCESS,
    RENDER_PROCESS,
    PLUGIN_PROCESS,
    WORKER_PROCESS,
    UNKNOWN_PROCESS,
  };

  // Returns the type of the process.
  ProcessType type() const { return type_; }

  // Returns the name of the process.  i.e. for plugins it might be Flash, while
  // for workers it might be the domain that it's from.
  std::wstring name() const { return name_; }

  // Getter to the process handle.
  base::ProcessHandle handle() const { return process_.handle(); }

  virtual int GetProcessId() const {
    if (pid_ != -1)
      return pid_;

    pid_ = process_.pid();
    return pid_;
  }
  void SetProcessBackgrounded() const { process_.SetProcessBackgrounded(true); }
  void ReduceWorkingSet() const { process_.ReduceWorkingSet(); }

  // Returns an English name of the process type, should only be used for non
  // user-visible strings, or debugging pages like about:memory.
  static std::wstring GetTypeNameInEnglish(ProcessType type);

  // Returns a localized title for the child process.  For example, a plugin
  // process would be "Plug-in: Flash" when name is "Flash".
  std::wstring GetLocalizedTitle() const;

  ChildProcessInfo(const ChildProcessInfo& original) {
    type_ = original.type_;
    name_ = original.name_;
    process_ = original.process_;
    pid_ = original.pid_;
  }

  ChildProcessInfo& operator=(const ChildProcessInfo& original) {
    if (&original != this) {
      type_ = original.type_;
      name_ = original.name_;
      process_ = original.process_;
      pid_ = original.pid_;
    }
    return *this;
  }

  virtual ~ChildProcessInfo();

  // We define the < operator so that the ChildProcessInfo can be used as a key
  // in a std::map.
  bool operator <(const ChildProcessInfo& rhs) const {
    if (process_.handle() != rhs.process_.handle())
      return process_ .handle() < rhs.process_.handle();
    return false;
  }

  bool operator ==(const ChildProcessInfo& rhs) const {
    return process_.handle() == rhs.process_.handle();
  }

  // Generates a unique channel name for a child renderer/plugin process.
  // The "instance" pointer value is baked into the channel id.
  static std::wstring GenerateRandomChannelID(void* instance);

 protected:
  void set_type(ProcessType type) { type_ = type; }
  void set_name(const std::wstring& name) { name_ = name; }
  void set_handle(base::ProcessHandle handle) {
    process_.set_handle(handle);
    pid_ = -1;
  }

  // Derived objects need to use this constructor so we know what type we are.
  ChildProcessInfo(ProcessType type);

 private:
  ProcessType type_;
  std::wstring name_;
  mutable int pid_;  // Cache of the process id.

  // The handle to the process.
  mutable base::Process process_;
};

#endif  // CHROME_COMMON_CHILD_PROCESS_INFO_H_