File Coverage

blib/lib/Linux/SysInfo.pm

Criterion	Covered	Total	%
statement	14	14	100.0
branch			n/a
condition			n/a
subroutine	6	6	100.0
pod			n/a
total	20	20	100.0

package Linux::SysInfo;

use 5.006;

use strict;
use warnings;

=head1 NAME

Linux::SysInfo - Perl interface to the sysinfo(2) Linux system call.

=head1 VERSION

Version 0.15

=cut

our $VERSION;
BEGIN {
 $VERSION = '0.15';
}

=head1 SYNOPSIS

    use Linux::SysInfo qw;

    my $si = sysinfo;
    print "$_: $si->{$_}\n" for keys %$si;

=head1 DESCRIPTION

This module is a wrapper around the C Linux system call.
It gives information about the current uptime, load average, memory usage and processes running.
Other systems have also this system call (e.g. Solaris), but in most cases the returned information is different.

=head1 CONSTANTS

=head2 C

This constant is set to C<1> if your kernel supports the three extended fields C, C and C ; and to C<0> otherwise.

=head1 FUNCTIONS

=cut

BEGIN {
 require XSLoader;
 XSLoader::load(__PACKAGE__, $VERSION);
}

=head2 C

This function takes no argument.
It returns C on failure or a hash reference whose keys are the members name of the C on success :

=over 4

=item *

C

Seconds elapsed since the system booted.

=item *

C, C, C

1, 5 and 15 minutes load average.

=item *

C

Total usable main memory size.

=item *

C

Available memory size.

=item *

C

Amount of shared memory.

=item *

C

Memory used by buffers.

=item *

C

Total swap space size.

=item *

C

Swap space still available.

=item *

C

Number of current processes.

=back

Prior to Linux 2.3.23 on i386 and 2.3.48 on all other architectures, the memory sizes were given in bytes.
Since then, the following members are also available and all the memory sizes are given as multiples of C bytes :

=over 4

=item *

C

Total high memory size.

=item *

C

Available high memory size.

=item *

C

Memory unit size in bytes.

=back

=head1 EXPORT

The only function of this module, C, and the constant C are only exported on request.
Functions are also exported by the C<:funcs> tag, and constants by C<:consts>.

=cut

use base qw;

our @EXPORT         = ();
our %EXPORT_TAGS    = (
 'funcs'  => [ qw ],
 'consts' => [ qw ]
);
our @EXPORT_OK      = map { @$_ } values %EXPORT_TAGS;
$EXPORT_TAGS{'all'} = [ @EXPORT_OK ];

=head1 BINARY COMPATIBILITY

If you upgrade your kernel to a greater version than 2.3.23 on i386 or 2.3.48 on any other platform, you will need to rebuild the module to access the extended fields.

Moreover, since the perl hash function has changed after the 5.6 version, you will also need to recompile the module if you upgrade your perl from a version earlier than 5.6.

=head1 DEPENDENCIES

L 5.6.

A C compiler.
This module may happen to build with a C++ compiler as well, but don't rely on it, as no guarantee is made in this regard.

=head1 SEE ALSO

The C man page.

L : Gather information about your system.

L : Try several different methods to retrieve the load average.

L : Wrapper to the C BSD system call.

=head1 AUTHOR

Vincent Pit, C<<  >>, L.

You can contact me by mail or on C (vincent).

=head1 BUGS

Please report any bugs or feature requests to C, or through the web interface at L.
I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

=head1 SUPPORT

You can find documentation for this module with the perldoc command.

    perldoc Linux::SysInfo

=head1 COPYRIGHT & LICENSE

Copyright 2007,2008,2009,2010,2013,2017 Vincent Pit, all rights reserved.

This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.

=cut

1; # End of Linux::SysInfo