ProgMPIRun Class Reference

Inheritance diagram for ProgMPIRun:

Collaboration diagram for ProgMPIRun:

Public Member Functions
	ProgMPIRun (int argc, char **argv)
void	readParams ()
void	defineParams ()
void	show ()
void	run ()
Public Member Functions inherited from XmippProgram
const char *	getParam (const char *param, int arg=0)
const char *	getParam (const char *param, const char *subparam, int arg=0)
int	getIntParam (const char *param, int arg=0)
int	getIntParam (const char *param, const char *subparam, int arg=0)
double	getDoubleParam (const char *param, int arg=0)
double	getDoubleParam (const char *param, const char *subparam, int arg=0)
float	getFloatParam (const char *param, int arg=0)
float	getFloatParam (const char *param, const char *subparam, int arg=0)
void	getListParam (const char *param, StringVector &list)
int	getCountParam (const char *param)
bool	checkParam (const char *param)
bool	existsParam (const char *param)
void	addParamsLine (const String &line)
void	addParamsLine (const char *line)
ParamDef *	getParamDef (const char *param) const
virtual void	quit (int exit_code=0) const
virtual int	tryRun ()
void	initProgress (size_t total, size_t stepBin=60)
void	setProgress (size_t value=0)
void	endProgress ()
void	processDefaultComment (const char *param, const char *left)
void	setDefaultComment (const char *param, const char *comment)
virtual void	initComments ()
void	setProgramName (const char *name)
void	addUsageLine (const char *line, bool verbatim=false)
void	clearUsage ()
void	addExampleLine (const char *example, bool verbatim=true)
void	addSeeAlsoLine (const char *seeAlso)
void	addKeywords (const char *keywords)
const char *	name () const
virtual void	usage (int verb=0) const
virtual void	usage (const String &param, int verb=2)
int	version () const
virtual void	show () const
virtual void	read (int argc, const char **argv, bool reportErrors=true)
virtual void	read (int argc, char **argv, bool reportErrors=true)
void	read (const String &argumentsLine)
	XmippProgram ()
	XmippProgram (int argc, const char **argv)
virtual	~XmippProgram ()

Public Attributes
FileName	fn_commands
MPI_Status	status
MpiNode *	node
char	szline [MAX_LINE+1]
Public Attributes inherited from XmippProgram
bool	doRun
bool	runWithoutArgs
int	verbose
	Verbosity level. More...
int	debug

Additional Inherited Members
Protected Member Functions inherited from XmippProgram
void	defineCommons ()
Protected Attributes inherited from XmippProgram
int	errorCode
ProgramDef *	progDef
	Program definition and arguments parser. More...
std::map< String, CommentList >	defaultComments
int	argc
	Original command line arguments. More...
const char **	argv

Detailed Description

Definition at line 35 of file mpi_run.cpp.

Constructor & Destructor Documentation

ProgMPIRun()

ProgMPIRun::ProgMPIRun ( int  argc, char **  argv  )

inline

Definition at line 47 of file mpi_run.cpp.

    {
        node=new MpiNode(argc,argv);
        if (!node->isMaster())
            verbose=0;
    }

Member Function Documentation

defineParams()

void ProgMPIRun::defineParams ( )

inlinevirtual

Function in which the param of each Program are defined.

Reimplemented from XmippProgram.

Definition at line 62 of file mpi_run.cpp.

    {
        addUsageLine("Run commands in a text file in a parallel environment");
        addUsageLine("+You may use the tag MPI_BARRIER to separate execution blocks.");
        addUsageLine("+You may use the tag MPI_NEWLINE to force a line break (this is useful for programs accepting parameters directly from stdin).");
        addParamsLine("-i <commandFile>    : File with commands in different lines");
    }

readParams()

void ProgMPIRun::readParams ( )

inlinevirtual

Function in which each program will read parameters that it need. If some error occurs the usage will be printed out.

Reimplemented from XmippProgram.

Definition at line 54 of file mpi_run.cpp.

    {
        fn_commands = getParam("-i");
        if (node->size < 2)
            REPORT_ERROR(ERR_ARG_INCORRECT,
                         "This program cannot be executed in a single working node");
    }

run()

void ProgMPIRun::run ( )

inlinevirtual

This function will be start running the program. it also should be implemented by derived classes.

Reimplemented from XmippProgram.

Definition at line 80 of file mpi_run.cpp.

    {
        if (node->rank == 0)
        {
            std::ifstream fh_in;
            fh_in.open(fn_commands.c_str());
            if (!fh_in)
                REPORT_ERROR(ERR_IO_NOTOPEN, (std::string)"Cannot open " + fn_commands);
            std::string line;
            int number_of_node_waiting = 0; // max is nprocs -1
            while (!fh_in.eof())
            {
                //wait until a server is free
                MPI_Recv(0, 0, MPI_INT, MPI_ANY_SOURCE, 0,
                         MPI_COMM_WORLD, &status);
                number_of_node_waiting++;
                getline(fh_in, line);
                line=findAndReplace(line,"MPI_NEWLINE","\n");
                strcpy(szline, line.c_str());

                std::string::size_type loc = line.find("MPI_BARRIER", 0);
                if (loc != std::string::npos)
                {
                    while (number_of_node_waiting < (node->size - 1))
                    {
                        MPI_Recv(0, 0, MPI_INT, MPI_ANY_SOURCE, 0,
                                 MPI_COMM_WORLD, &status);
                        number_of_node_waiting++;
                    }
                    while (number_of_node_waiting > 0)
                    {
                        MPI_Send(&szline, 1, MPI_CHAR, number_of_node_waiting,
                                 TAG_WAIT, MPI_COMM_WORLD);
                        number_of_node_waiting--;
                    }
                    continue;
                }

                //send work
                MPI_Send(&szline, MAX_LINE, MPI_CHAR, status.MPI_SOURCE,
                         TAG_WORK, MPI_COMM_WORLD);
                number_of_node_waiting--;
            }

            fh_in.close();
            for (size_t i = 1; i < node->size; i++)
                MPI_Send(0, 0, MPI_INT, i, TAG_STOP, MPI_COMM_WORLD);
        }
        else
        {
            while (1)
            {
                //I am free
                MPI_Send(0, 0, MPI_INT, 0, 0, MPI_COMM_WORLD);
                //get your next task
                MPI_Probe(0, MPI_ANY_TAG, MPI_COMM_WORLD, &status);
                if (status.MPI_TAG == TAG_STOP)//I am free
                    break;
                else if (status.MPI_TAG == TAG_WAIT)//wait
                {
                    MPI_Recv(&szline, 1, MPI_CHAR, 0, TAG_WAIT, MPI_COMM_WORLD, &status);
                    continue;
                }
                else if (status.MPI_TAG == TAG_WORK)//work to do
                {
                    MPI_Recv(&szline, MAX_LINE, MPI_CHAR, 0, TAG_WORK, MPI_COMM_WORLD, &status);
                    //do the job
                    if(strlen(szline)<1)
                        continue;
                    else
                    {
                        if (system(szline)==-1)
                            REPORT_ERROR(ERR_UNCLASSIFIED,"Cannot open shell");
                    }
                }
                else
                    std::cerr << "WRONG TAG RECEIVED" << std::endl;

            }
        }

    }

show()

void ProgMPIRun::show ( )

inline

Definition at line 70 of file mpi_run.cpp.

    {
        if (!verbose)
            return;
        std::cout << "Commands  file: " << fn_commands << std::endl;
    }

Member Data Documentation

fn_commands

FileName ProgMPIRun::fn_commands

Command file

Definition at line 39 of file mpi_run.cpp.

node

MpiNode* ProgMPIRun::node

Definition at line 45 of file mpi_run.cpp.

status

MPI_Status ProgMPIRun::status

status after am MPI call

Definition at line 42 of file mpi_run.cpp.

szline

char ProgMPIRun::szline[MAX_LINE+1]

Definition at line 79 of file mpi_run.cpp.

---

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

• xmipp/libraries/parallel/mpi_run.cpp