sys-proctable 0.7.6 → 1.2.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8c36a4455aa4fd0172d51e7e1e69b69c180a86da3570247c6958c2bdee34a314
+  data.tar.gz: 2659ffc977988520db6d68703efa079815d966fd0320679c8cc961a75daf3f13
+SHA512:
+  metadata.gz: d2a101a16b5c3a767917fc2f4e32633f20785a9d678c46f6def07aabc3d5392238bfe8b48a73f203f607a161c1908f0e412e73f5b2a6c92a56c16c8e65c72594
+  data.tar.gz: c372c2763018d53376e11aaaa8004071eff144dfd3830c1fb15dbfcc4f35316a2870b1519d0a77613a3465e31bcca0da9f0397dba0c1bfaf1e0e9b0649029a04

data/{CHANGES → CHANGES.rdoc}

@@ -1,3 +1,200 @@
+== 1.2.4 - 18-Jun-2020
+* Added the num_threads field for Linux. This was originally a dead field in
+  older versions of Linux that was skipped, but as of Linux 2.6+ it actually
+  holds meaningful data.
+* Updated the specs for Linux.
+
+== 1.2.3 - 17-Mar-2020
+* Properly include a copy of Apache-2.0 in LICENSE file as part of library.
+* Add explicit .rdoc extensions to CHANGES and MANIFEST files.
+
+== 1.2.2 - 12-Aug-2019
+* Added compatibility for JRuby on Mac which apparently doesn't define a
+  read_uint64 method, nor a CharArray. Thanks go to Adithya Pentela for
+  the spot.
+* Refactored the specs a bit, adding a spec_helper.rb. This was mainly
+  for JRuby compatibility.
+* Updates to the travis.yml file for both Ruby and JRuby versions.
+* Removed the doc directory and all the files it contained. It was
+  redundant, and some of the information was wrong. All of the
+  documentation you need is on the wiki.
+* Cleaned up the MANIFEST file, updated the gemspec, and fixed the
+  license name, which was missing a hyphen.
+
+== 1.2.1 - 8-Jun-2018
+* The code for OSX is now more efficient when a pid argument is provided.
+  Thanks go to Nick LaMuro for his efforts.
+* Added metadata to the gemspec.
+* Switched the README (now README.md) to markdown format. Thanks go to
+  Tim Meusel for the update.
+* Updated the cert. Should be good for ten years now.
+
+== 1.2.0 - 20-Feb-2018
+* There has been an API change. The ProcTable.ps method now uses keyword
+  arguments. The 'pid' option is universal, the rest depend on the platform.
+  As part of this change, support for Ruby < 2.0 has been dropped.
+* Support for HP-UX has been dropped, both because it was the last remaining
+  platform that still used C code, and because it's basically a dead platform.
+* There are no more platform-specific gems. There is now a single gem that
+  will load the appropriate code based on your host's operating system.
+* The tests were switched from test-unit to rspec.
+* Lots of Rakefile updates based on the above changes.
+* The cert was updated.
+
+== 1.1.5 - 10-Aug-2017
+* Fixed a warning that cropped up in Ruby 2.4.x because I was type checking
+  against Fixnum. Those have been replaced with Numeric.
+
+== 1.1.4 - 30-Mar-2017
+* Fixed a potential issue where OSX could return a struct with invalid data.
+* Set the default field to :pid for OSX when using Sys::Top.
+* Fixed a duplicate test warning for OSX.
+
+== 1.1.3 - 28-Sep-2016
+* Fixed an issue on OSX where the value returned for argc is invalid.
+
+== 1.1.2 - 18-Sep-2016
+* Fixed cmdline parsing and handling for OSX. Thanks go to Ben Mathwig for
+  the spot and the patch.
+
+== 1.1.1 - 30-Jun-2016
+* Added thread information for OS X.
+* Fixed VERSION constant for HP-UX.
+
+== 1.1.0 - 27-Jun-2016
+* License was changed to Apache 2.0.
+* The OS X version now requires OS X 10.7 or later.
+* Scrapped the C implementation for OS X, and replaced it with a libproc wrapper
+  using FFI, so it is now pure Ruby. Note that some new struct members have been
+  added, while others have been dropped. This includes pctcpu, so Sys::Top does
+  not work at the moment.
+* Rakefile updates to accomodate the changes for OS X.
+* Some test suite updates and refactoring.
+
+== 1.0.0 - 11-Jan-2016
+* Added smaps information for Linux. Thanks go to Joe Rafaniello for the patch.
+* This really should not have been a major release, sorry.
+
+== 0.9.9 - 8-Nov-2015
+* Added support for cgroups on Linux. Thanks go to Dennis Günnewig for the patch.
+* Added a sys-proctable.rb file for convenience.
+* This gem is now signed.
+* Gem related tasks in the Rakefile now assume Rubygems 2.x.
+
+== 0.9.8 - 18-Apr-2015
+* Fixed a bug in the gemspec. Last version got yanked.
+
+== 0.9.7 - 18-Apr-2015
+* Fixed a bug in the OSX code that could cause the ps method to fail. Thanks
+  go to Koshevoy Anton for the spot.
+* Some internal refactoring of version handling. Now all platforms use a
+  single version file.
+* Replaced vm_size_t and lwpid_t with universal data types on FreeBSD because
+  FFI on FreeBSD 10 no longer understands them. Thanks go to Mike Owens for
+  the spot.
+
+== 0.9.6 - 24-Feb-2015
+* Added NLWP field on Linux. Thanks go to Rich Chatterton for the patch.
+
+== 0.9.5 - 10-Feb-2015
+* Significant cleanup and memory reduction of the OSX code. Thanks go
+  to Ivan (toy) for the patches.
+* Skip over /proc/<file>/status if unreadable on Linux. Thanks go to Jianjun
+  Mao for the patch.
+
+== 0.9.4 - 4-Mar-2014
+* Added support for AIX 5.3 or later courtesy of Rick Ohnemus.
+* The Solaris version now uses FFI structs instead of a packed array.
+  It solved issues with 64-bit versions of Ruby and it's self-documenting.
+* The FreeBSD version has been converted to use FFI. In addition, additional
+  struct members have been added, and members that previously returned nil
+  now return meaningful data.
+* Support for NetBSD and OpenBSD has been temporarily dropped. Considering
+  that the C code did not build on those platforms anyway, I doubt most of
+  you will notice. Patches for those platforms are welcome, but only using FFI.
+
+== 0.9.3 - 17-Mar-2013
+* Fixed a bug on OSX where a long command string arg could cause
+  a segfault. Thanks go to Nathaniel Bibler for the spot.
+* Changed the gem platform from mingw to mingw32 for Windows.
+
+== 0.9.2 - 8-Oct-2012
+* Added cmdline support for OS X. Thanks go to Matthias Zirnstein for
+  the patch.
+* Warning cleanup for 1.9.
+* Updated the gem platform handling. Replaced the borked string approach
+  with a two element array for Gem::Platform.new.
+* MS date strings are now parse with DateTime instead of Date.
+
+== 0.9.1 - 3-Aug-2011
+* Added the pctcpu and pctmem members for Linux.
+* Added Errno::ESRCH to a rescue clause on Linux that fixed a bug
+  where a missing entry wasn't being skipped when run as root. Thanks
+  go to Austin Ziegler for the spot and patch.
+* Fixed a build warning for Darwin.
+* Updates to the test suite for both Darwin and Linux.
+* Added an explicit type check for BSD for pids.
+* Added nicer error messages for BSD if kvm_open fails.
+* Added .core files to the clean task.
+* Altered the platform settings in the Rakefile so that generated gems
+  use 'universal' platform architectures for any particular operating system.
+
+== 0.9.0 - 14-Oct-2009
+* Changed the license to Artistic 2.0.
+* Fixed a bug in the OS X code where a segfault would occur when an attempt
+  was made to gather resource usage information on zombie processes. From
+  now on that information is always set to nil for zombie processes. Thanks
+  go to Tom Lianza for the spot and Philip Kromer for investigating the
+  root cause of the failure.
+* Removed the FreeBSD code that read out of /proc. It was a pain from a
+  maintenance point of view, and most FreeBSD installs do not mount /proc
+  by default. The FreeBSD platform now uses the same code that the other
+  BSD platforms use.
+* Fixed a bug in the BSD code where the ProcTable::Error class had the
+  wrong parent class.
+* Some major gemspec updates, including an updated license. The platform
+  handling logic is now in the Rakefile in the 'gem' task.
+* Updated the README file to include an additional acknowledgement, a
+  license change and some minor formatting changes.
+* The test-unit library was changed from a runtime to a development dependency.
+
+== 0.8.1 - 6-Apr-2009
+* The Linux and Solaris libraries now handle the possibility of a process
+  terminating in the middle of a read more gracefully. If that happens, they
+  merely skip to the next record, i.e. it's all or nothing. Thanks go to
+  Heejong Lee for the spot and patch.
+* Fixed a bug in the Linux version where embedded nulls were not being
+  stripped out of the cmdline data.
+* Added the comm alias back to the Solaris version. Thanks go to Jun Young Kim
+  for the spot.
+
+== 0.8.0 - 26-Jan-2009
+* The Linux and Solaris versions of this library are now pure Ruby. Be warned,
+  however, that only Solaris 8 and later are now supported. This may change
+  in a future release if there's demand to support 2.6 and 2.7.
+* Some Struct::ProcTableStruct members have changed. As a general rule they
+  now more closely match the C struct member name. See individual platforms
+  for more details.
+* Bug fix for the cmd_args struct member on Solaris.
+* Bug fixes for OS X. Added a VERSION constant, fixed struct name, and changed
+  pct_cpu to pctcpu.
+* The .new method is now explicitly illegal.
+* The Struct::ProcTableStruct instances are now frozen. This is read-only data.
+* Added the peak_page_file_usage and status members on MS Windows. The status
+  member is always nil, but was added for completeness.
+* Fixed the quota_peak_paged_pool_usage member on MS Windows.
+* ProcTableError is now ProcTable::Error.
+* Minor test case fix for kvm/bsd based versions.
+* Added the 'time' library as a require for Windows (to parse MS date/time
+  format strings).
+* The kvm (bsd.c) implementation now works for FreeBSD 7.
+* Added many more tests.
+* Added some benchmarking code in the 'benchmarks' directory.
+* Added a 'bench' Rake task.
+* Renamed the test_ps.rb file to example_ps.rb in order to avoid any possible
+  confusion with actual test files.
+* Added an 'example' rake task to run the example file.
+
 == 0.7.6 - 11-Jul-2007
 * Fixed the starttime for Linux. Thanks go to Yaroslav Dmitriev for the spot.
 * Fixed a bug in the MS Windows version within a private method that parsed

data/LICENSE

@@ -0,0 +1,177 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

data/MANIFEST.rdoc

@@ -0,0 +1,26 @@
+* CHANGES
+* LICENSE
+* MANIFEST
+* Rakefile
+* README
+* sys-proctable.gemspec
+* benchmarks/bench_ps.rb
+* benchmarks/bench_ips_ps.rb
+* example/example_ps.rb
+* lib/sys-proctable.rb
+* lib/sys/top.rb
+* lib/sys/proctable/version.rb
+* lib/aix/sys/proctable.rb
+* lib/darwin/sys/proctable.rb
+* lib/freebsd/sys/proctable.rb
+* lib/linux/sys/proctable.rb
+* lib/sunos/sys/proctable.rb
+* lib/windows/sys/proctable.rb
+* test/test_sys_proctable_aix.rb
+* test/test_sys_proctable_all.rb
+* test/test_sys_proctable_darwin.rb
+* test/test_sys_proctable_freebsd.rb
+* test/test_sys_proctable_linux.rb
+* test/test_sys_proctable_sunos.rb
+* test/test_sys_proctable_windows.rb
+* test/test_sys_top.rb

data/README.md

@@ -0,0 +1,158 @@
+# sys-proctable
+
+## Description
+
+  A Ruby interface for gathering process information.
+
+## Prerequisites
+
+* RSpec 3.x (development only)
+
+## Supported Platforms
+
+* Windows 2000 or later
+* Linux 2.6+
+* FreeBSD
+* Solaris 8+
+* OS X 10.7+
+* AIX 5.3+
+
+## Installation
+
+```sh
+gem install sys-proctable
+```
+
+For version 1.1.5 or earlier, you may need to specify a platform in some cases. For example:
+
+```sh
+gem install sys-proctable --platform mswin32 # Windows
+gem install sys-proctable --platform sunos   # Solaris
+gem install sys-proctable --platform linux   # Linux
+gem install sys-proctable --platform freebsd # FreeBSD
+gem install sys-proctable --platform darwin  # OS X
+```
+
+## Synopsis
+
+```ruby
+require 'sys/proctable'
+include Sys
+
+# Everything
+ProcTable.ps{ |p|
+  puts p.pid.to_s
+  puts p.comm
+  # ...
+}
+
+# Just one process
+s = ProcTable.ps(pid: 2123)
+puts s.pid.to_s
+puts s.comm
+# ...
+
+# Return the results as an array of ProcTableStructs
+a = ProcTable.ps
+a.each do |p|
+  puts p.pid
+  # ...
+end
+```
+
+## Notes
+
+Various platforms support different options. Mostly this is to let you
+skip the collection of certain bits of information in order to improve
+speed and/or reduce memory. For example on Linux you can do this to
+skip the collection of smaps information:
+
+```ruby
+Sys::ProcTable.ps(smaps: false)
+```
+
+Windows users may send a host name to get process information from a
+different host. This relies on the WMI service running.
+
+```ruby
+Sys::ProcTable.ps(host: some_host)
+```
+
+## Known Issues
+
+### FreeBSD
+
+A kvm interface is used. That means the owner of the process using the
+sys-proctable library needs to be a member of the kvm group (or root).
+
+### Bundler
+
+For version 1.1.5 or earlier, Bundler seems to have trouble installing the
+proper gem because of the platform specific gem names. To deal with that,
+run this command first:
+
+```sh
+bundle config specific_platform true
+```
+
+You should not have to do this for version 1.2.0 or later.
+
+### Solaris
+
+The cmdline member on Solaris is limited to 80 characters unless you (or
+your program) own the process. This is a Solaris design flaw/feature.
+
+### OS X
+
+The libproc interface is used. That means you will only get list of
+processes that you have access to. To get a full listing, run as root.
+
+## Future Plans
+
+Support for Solaris will probably be dropped in the next major release.
+
+## Acknowledgements
+
+This library was originally based on the Perl module Proc::ProcessTable
+by Dan Urist. Many ideas, as well as large chunks of code, were taken
+from his work. So, a big THANK YOU goes out to Dan Urist.
+
+A big thanks also goes out to Mike Hall who was very helpful with ideas,
+logic and testing.
+
+Thanks also go to Sean Chittenden for providing an account on one of his
+FreeBSD machines. This is how the FreeBSD support was (initially) added.
+
+Thanks go to James Hranicky for providing a patch that grabs name, eid,
+euid, gid and guid info in the Linux version, along with some general
+debugging help.
+
+Thanks go to David Felstead for the original OS X code. Thanks also go
+to Matthias Zirnstein for adding the original cmdline support for OS X.
+
+Finally I'd like to thank all the folks who have submitted bug reports
+and/or patches.
+
+## Help Wanted
+
+I do not have access to all platforms. If your platform is not supported
+then you will need to either submit a patch or give me a remote account
+on a box with a compiler so that I can write the code.
+
+## More documentation
+
+See the documentation under the 'doc' directory for more information,
+including platform specific notes and issues.
+
+## License
+
+Apache 2.0
+
+## Copyright
+
+(C) 2003-2019 Daniel J. Berger
+All Rights Reserved.
+
+## Author
+
+Daniel J. Berger