DwmProcessInfo.hh

Go to the documentation of this file.

//===========================================================================
// @(#) $DwmPath: dwm/libDwm/tags/libDwm-0.6.0/include/DwmProcessInfo.hh 9018 $
// @(#) $Id: DwmProcessInfo.hh 9018 2017-04-11 20:05:43Z dwm $
//===========================================================================
//  Copyright (c) Daniel W. McRobb 2006-2007, 2016
//  All rights reserved.
//
//  Redistribution and use in source and binary forms, with or without
//  modification, are permitted provided that the following conditions
//  are met:
//
//  1. Redistributions of source code must retain the above copyright
//     notice, this list of conditions and the following disclaimer.
//  2. Redistributions in binary form must reproduce the above copyright
//     notice, this list of conditions and the following disclaimer in the
//     documentation and/or other materials provided with the distribution.
//  3. The names of the authors and copyright holders may not be used to
//     endorse or promote products derived from this software without
//     specific prior written permission.
//
//  IN NO EVENT SHALL DANIEL W. MCROBB BE LIABLE TO ANY PARTY FOR
//  DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES,
//  INCLUDING LOST PROFITS, ARISING OUT OF THE USE OF THIS SOFTWARE,
//  EVEN IF DANIEL W. MCROBB HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
//  DAMAGE.
//
//  THE SOFTWARE PROVIDED HEREIN IS ON AN "AS IS" BASIS, AND
//  DANIEL W. MCROBB HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT,
//  UPDATES, ENHANCEMENTS, OR MODIFICATIONS. DANIEL W. MCROBB MAKES NO
//  REPRESENTATIONS AND EXTENDS NO WARRANTIES OF ANY KIND, EITHER
//  IMPLIED OR EXPRESS, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
//  WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE,
//  OR THAT THE USE OF THIS SOFTWARE WILL NOT INFRINGE ANY PATENT,
//  TRADEMARK OR OTHER RIGHTS.
//===========================================================================

//---------------------------------------------------------------------------
//---------------------------------------------------------------------------

#ifndef _DWMPROCESSINFO_HH_
#define _DWMPROCESSINFO_HH_

extern "C" {
  #ifdef HAVE_KVM_H
    #include <kvm.h>
  #endif
  #include <sys/param.h>
  #include <sys/sysctl.h>
  #include <sys/user.h>
  #include <inttypes.h>
#ifdef __linux__
  #include <proc/readproc.h>
#endif
}

#include <string>
#include <vector>

#include "DwmGZReadable.hh"
#include "DwmGZWritable.hh"
#include "DwmReadable.hh"
#include "DwmRusage.hh"
#include "DwmTimeValue.hh"
#include "DwmWritable.hh"

namespace Dwm {

  //--------------------------------------------------------------------------
  //--------------------------------------------------------------------------
  class ProcessInfo
    : public Readable, public Writable,
      public GZReadable, public GZWritable
  {
  public:
    ProcessInfo();

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    ProcessInfo(pid_t pid);
    
#if (defined(__FreeBSD__) || defined(__APPLE__))
    ProcessInfo(const struct kinfo_proc & proc);
#elif (defined __OpenBSD__)
    ProcessInfo(const struct kinfo_proc2 & proc);
#elif (defined __linux__)
    ProcessInfo(proc_t *proc);
#endif

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    virtual ~ProcessInfo();
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    pid_t Id() const;

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    pid_t ParentId() const;

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    pid_t GroupId() const;

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    const std::string & ControllingTty() const;

    pid_t SessionId() const;
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    uid_t EffectiveUserId() const;

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    std::string EffectiveUserName() const;

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    uid_t RealUserId() const;

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    std::string RealUserName() const;

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    uid_t SavedEffectiveUserId() const;

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    std::string SavedEffectiveUserName() const;

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    uid_t RealGroupId() const;

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    uid_t SavedEffectiveGroupId() const;

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    const std::string & Command() const;

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    const std::vector<std::string> & Args() const;
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    const TimeValue & StartTime() const;

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    uint32_t Size() const;

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    uint32_t ResidentSetSize() const;

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    const Dwm::Rusage & Rusage() const;

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool operator == (const ProcessInfo & process) const;
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    std::istream & Read(std::istream & is);

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    std::ostream & Write(std::ostream & os) const;

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    int Read(gzFile gzf);
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    int Write(gzFile gzf) const;
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    ssize_t Read(int fd);

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    ssize_t Write(int fd) const;

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    size_t Read(FILE * f);

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    size_t Write(FILE *f) const;

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    uint32_t StreamedLength() const;
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    void AddArg(const char *arg);
    
  private:
    pid_t                     _id;
    pid_t                     _parentId;
    pid_t                     _groupId;
    std::string               _controllingTty;
    pid_t                     _sessionId;
    pid_t                     _terminalSessionId;
    uid_t                     _effectiveUserId;
    uid_t                     _realUserId;
    uid_t                     _savedEffectiveUserId;
    uid_t                     _realGroupId;
    uid_t                     _savedEffectiveGroupId;
    std::string               _command;
    TimeValue                 _startTime;
    uint32_t                  _size;
    uint32_t                  _residentSetSize;
    Dwm::Rusage               _rusage;
    std::vector<std::string>  _args;

  };
  
}  // namespace Dwm

#endif  // _DWMPROCESSINFO_HH_

//---------------------------- emacs settings -----------------------------
//  Local Variables:
//  mode: C++/la
//  tab-width: 2
//  indent-tabs-mode: nil
//  c-basic-offset: 2
//  End:
//-------------------------------------------------------------------------