File Coverage

lib/App/OS/Detect/MachineCores.pm

Criterion	Covered	Total	%
statement	33	46	71.7
branch	2	14	14.2
condition			n/a
subroutine	10	11	90.9
pod			n/a
total	45	71	63.3

package App::OS::Detect::MachineCores;

#  PODNAME: App::OS::Detect::MachineCores
# ABSTRACT: Detect how many cores your machine has (OS-independently)

use Carp;
use 5.010;
use strict;
use warnings;

use Moo;
use MooX::Options skip_options => [qw];
use POSIX qw/ sysconf /;
use IPC::Open2;

has os => (
    is       => 'ro',
    required => 1,
    default  => sub { $^O },
);

has cores => (
    is      => 'rw',
    isa     => sub { die "$_[0] is not a reasonable number of cores!" unless $_[0] > 0 and $_[0] < 100 },
    lazy    => 1,
    builder => '_build_cores',
);

option add_one => (
    is      => 'rw',
    isa     => sub { die "Invalid bool!" unless $_[0] == 0 or $_[0] == 1 },
    default => sub { '0' },
    short   => 'i',
    doc     => q{add one to the number of cores (useful in scripts)},
);

has SC_NPROCESSORS_ONLN => (
    is       => 'ro',
    default  => sub { 84 },
);

sub _build_SC_NPROCESSORS_ONLN {
    my ($self) = @_;
    return ($self->os eq 'aix') ? 73 : 84;
}

sub _build_cores {
    my ($self) = @_;
    my $cores;

    if ($self->os =~ /aix|bsdos|darwin|dynixptx|freebsd|linux|hpux|irix|openbsd|solaris|sunos/) {
        $cores = sysconf $self->SC_NPROCESSORS_ONLN;
    }

    if (!$cores) {
        my $cmd;

        if ($self->os eq 'linux')   { $cmd = q }
        if ($self->os eq 'darwin')  { $cmd = q }
        if ($self->os eq 'MSWin32') { $cmd = q }

        if ($cmd) {
            waitpid( open2(my $out, my $in, $cmd), 0);
            $cores = <$out> + 0;
        }
        else {
            carp("Can't detect the cores for your system/OS, sorry.");
        }
    }

    return $cores;
}

around cores => sub {
    my ($orig, $self) = (shift, shift);

    return $self->$orig() + 1 if $self->add_one;
    return $self->$orig();
};

no Moo;

1;

=for Pod::Coverage os cores _build_cores add_one

=begin wikidoc

= SYNOPSIS

On different system, different approaches are needed to detect the number of cores for that machine.

This Module is a wrapper around these different approaches.

= USAGE

This module will install one executable, {mcores}, in your bin.

It is really simple and straightforward:

    usage: mcores [-?i] [long options...]
        -h --help       Prints this usage information.
        -i --add_one    add one to the number of cores (useful in scripts)

= SUPPORTED SYSTEMS

* Linux
* OSX
* Windows
* aix
* bsdos
* darwin
* dynixptx
* freebsd
* linux
* hpux
* irix
* openbsd
* solaris
* sunos

= MOTIVATION

During development of dotfiles for different platforms I was searching for some way to be able to
transparantly detect the number of available cores and couldn't find one.
Also it is quite handy to be able to increment the number by simply using a little switch {-i}.

Example:

    export TEST_JOBS=`mcores -i`

=end wikidoc