GooFit::Application Class Reference

#include <Application.h>

Inheritance diagram for GooFit::Application:

Public Member Functions
	Application (std::string discription, int argc, char **argv)
	Make a new Application. More...
	Application (int argc, char **argv)
	Shortcut for the lazy. More...
int	get_device () const
	Get the set GPU device. More...
void	run ()
	simple run since argc and argv are stored More...
void	pre_callback () override
	Gets called in parse. More...
int	exit (const CLI::Error &e)
	Exit. More...
void	set_device () const
	~Application () override
	Cleanup MPI if needed. More...
std::string	get_filename (const std::string &input_str, std::string base="") const

Protected Attributes
int	gpuDev_ = 0
bool	show_gpus_
bool	quiet_
bool	splash_
int	argc_
char **	argv_
struct sigaction	sigIntHandler
	Handle control-c codes. More...

Detailed Description

Definition at line 42 of file Application.h.

Constructor & Destructor Documentation

Application() [1/2]

GooFit::Application::Application	(	std::string	discription,
		int	argc,
		char **	argv
	)

Make a new Application.

Definition at line 124 of file Application.cpp.

References argc_, argv_, gpuDev_, quiet_, GooFit::reset, show_gpus_, sigIntHandler, GooFit::signal_handler(), and splash_.

    : App(discription)
    , argc_(argc)
    , argv_(argv) {
#ifdef GOOFIT_MPI
    MPI_Init(&argc_, &argv_);

    int myId, numProcs;
    MPI_Comm_size(MPI_COMM_WORLD, &numProcs);
    MPI_Comm_rank(MPI_COMM_WORLD, &myId);

#if THRUST_DEVICE_SYSTEM == THRUST_DEVICE_SYSTEM_CUDA
    int deviceCount;
    cudaGetDeviceCount(&deviceCount);

    // Get Batch system number of nodes if possible
    auto PBS_NUM_NODES = getenv("PBS_NUM_NODES");

    int nodes = PBS_NUM_NODES == nullptr ? 1 : atoi(PBS_NUM_NODES);

    if(nodes == 0)
        nodes = 1;

    int procsPerNode = numProcs / nodes;
    int localRank    = myId % procsPerNode;

    // Note, this will (probably) be overwritten by gpu-set-device calls...
    if(deviceCount == 1 && localRank > 1) {
        // Multi-process to one GPU!
        gpuDev_ = 0;
    } else if(procsPerNode > 1 && deviceCount > 1) {
        if(localRank <= deviceCount) {
            // setting multiple processes to multiple GPU's
            gpuDev_ = localRank;
        } else {
            // More multiple processes than GPU's, distribute sort of evenly!
            gpuDev_ = localRank % deviceCount;
        }
    } else {
        // multiple GPU's, using one process
        gpuDev_ = 0;
    }

    std::cout << "MPI using CUDA device: " << gpuDev_ << std::endl;
    cudaSetDevice(gpuDev_);
#endif
#endif

    // Fallthrough is useful for most models of GooFit subcommands
    fallthrough();

#if THRUST_DEVICE_SYSTEM == THRUST_DEVICE_SYSTEM_CUDA
#ifndef GOOFIT_MPI
    add_option("--gpu-dev", gpuDev_, "GPU device to use", true)->group("GooFit");
#endif
    add_flag("--show-gpus", show_gpus_, "Show the available GPU devices and exit")->group("GooFit");
#endif
    auto quiet = add_flag("-q,--quiet", quiet_, "Reduce the verbosity of the Application")->group("GooFit");

    add_flag("--nosplash", splash_, "Do not print a splash")->group("GooFit")->excludes(quiet);

    set_config("--config", "config.ini", "An ini file with command line options in it")->group("GooFit");

    // Reset color on exit (but not control-c)
    std::atexit([]() { std::cout << GooFit::reset; });

#ifndef _MSC_VER
    sigIntHandler.sa_handler = signal_handler;
    sigemptyset(&sigIntHandler.sa_mask);
    sigIntHandler.sa_flags = 0;
    sigaction(SIGINT, &sigIntHandler, nullptr);
#endif
}

Application() [2/2]

GooFit::Application::Application ( int  argc, char **  argv  )

inline

Shortcut for the lazy.

Definition at line 59 of file Application.h.

        : Application("", argc, argv) {}

~Application()

GooFit::Application::~Application ( )

overridedefault

Cleanup MPI if needed.

Referenced by exit(), and run().

Member Function Documentation

exit()

int GooFit::Application::exit

(

const CLI::Error &

e

)

Exit.

Definition at line 216 of file Application.cpp.

References GooFit::blue, GooFit::red, GooFit::reset, and ~Application().

Referenced by run().

                                       {
#ifdef GOOFIT_MPI
    int myId;
    MPI_Comm_rank(MPI_COMM_WORLD, &myId);

    if(myId > 0)
        return e.get_exit_code();

#endif
    std::cout << (e.get_exit_code() == 0 ? blue : red);
    int rval = CLI::App::exit(e);
    std::cout << GooFit::reset;
    return rval;
}

get_device()

int GooFit::Application::get_device ( ) const

inline

Get the set GPU device.

Definition at line 63 of file Application.h.

References gpuDev_.

{ return gpuDev_; }

get_filename()

std::string GooFit::Application::get_filename	(	const std::string &	input_str,
		std::string	base = ""
	)		const

Get a file from the current directory, looks up one and in the true current directory Base gives a relative path from the source directory

Definition at line 240 of file Application.cpp.

References argv_.

Referenced by getToyData(), makeBackgroundHistogram(), makeBkg2DalitzPdf(), makeBkg3Eff(), makeOverallSignal(), makeSigmaHists(), run(), runBackgroundDalitzFit(), runBackgroundSigmaFit(), runEfficiencyFit(), runGeneratedMCFit(), runToyFit(), and writeBackgroundHistograms().

                                                                                    {
    // Run from current directory
    if(CLI::ExistingFile(input_str).empty())
        return input_str;

    // Run from a different directory
    std::string prog_name{argv_[0]};
    size_t loc = prog_name.rfind("/");
    if(loc != std::string::npos) {
        std::string cdir = prog_name.substr(0, loc);
        std::string new_input{cdir + "/" + input_str};
        if(CLI::ExistingFile(new_input).empty()) {
            std::cout << "Found file at " << new_input << std::endl;
            return new_input;
        }
    }

    // If all else fails, try to get file from source directory (if base is specified)
    if(base.size() > 0) {
        std::string new_input = std::string(GOOFIT_SOURCE_DIR) + "/" + base + "/" + input_str;
        if(CLI::ExistingFile(new_input).empty()) {
            std::cout << "Found file at " << new_input << std::endl;
            return new_input;
        }
    }

    // Could not find file
    throw GooFit::FileError(input_str);
}

pre_callback()

void GooFit::Application::pre_callback ( )

override

Gets called in parse.

Definition at line 198 of file Application.cpp.

References gpuDev_, GooFit::print_goofit_info(), GooFit::print_splash(), quiet_, set_device(), and splash_.

Referenced by run().

                               {
    set_device();

    if(!quiet_) {
        if(!splash_)
            print_splash();
        print_goofit_info(gpuDev_);
    }
}

run()

void GooFit::Application::run ( )

inline

simple run since argc and argv are stored

Definition at line 66 of file Application.h.

References exit(), get_filename(), pre_callback(), set_device(), and ~Application().

{ parse(argc_, argv_); }

set_device()

void GooFit::Application::set_device

(

)

const

Call if the application might fork, otherwise automatic For example, if explicitly using omp

Definition at line 208 of file Application.cpp.

References gpuDev_.

Referenced by pre_callback(), and run().

                                   {
#if THRUST_DEVICE_SYSTEM == THRUST_DEVICE_SYSTEM_CUDA
    if(gpuDev_ != 0) {
        cudaSetDevice(gpuDev_);
    }
#endif
}

Member Data Documentation

argc_

int GooFit::Application::argc_

protected

Definition at line 48 of file Application.h.

Referenced by Application().

argv_

char** GooFit::Application::argv_

protected

Definition at line 49 of file Application.h.

Referenced by Application(), and get_filename().

gpuDev_

int GooFit::Application::gpuDev_ = 0

protected

Definition at line 44 of file Application.h.

Referenced by Application(), get_device(), pre_callback(), and set_device().

quiet_

bool GooFit::Application::quiet_

protected

Definition at line 46 of file Application.h.

Referenced by Application(), and pre_callback().

show_gpus_

bool GooFit::Application::show_gpus_

protected

Definition at line 45 of file Application.h.

Referenced by Application().

sigIntHandler

struct sigaction GooFit::Application::sigIntHandler

protected

Handle control-c codes.

Definition at line 52 of file Application.h.

Referenced by Application().

splash_

bool GooFit::Application::splash_

protected

Definition at line 47 of file Application.h.

Referenced by Application(), and pre_callback().

---

The documentation for this class was generated from the following files:

• /home/travis/build/GooFit/GooFit/include/goofit/Application.h
• /home/travis/build/GooFit/GooFit/src/goofit/Application.cpp