88 lines
3.3 KiB
C
88 lines
3.3 KiB
C
#ifndef RABIT_WRAPPER_H_
|
|
#define RABIT_WRAPPER_H_
|
|
/*!
|
|
* \file rabit_wrapper.h
|
|
* \author Tianqi Chen
|
|
* \brief a C style wrapper of rabit
|
|
* can be used to create wrapper of other languages
|
|
*/
|
|
#ifdef _MSC_VER
|
|
#define RABIT_DLL __declspec(dllexport)
|
|
#else
|
|
#define RABIT_DLL
|
|
#endif
|
|
// manually define unsign long
|
|
typedef unsigned long rbt_ulong;
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
/*!
|
|
* \brief intialize the rabit module, call this once before using anything
|
|
* \param argc number of arguments in argv
|
|
* \param argv the array of input arguments
|
|
*/
|
|
RABIT_DLL void RabitInit(int argc, char *argv[]);
|
|
/*!
|
|
* \brief finalize the rabit engine, call this function after you finished all jobs
|
|
*/
|
|
RABIT_DLL void RabitFinalize(void);
|
|
/*! \brief get rank of current process */
|
|
RABIT_DLL int RabitGetRank(void);
|
|
/*! \brief get total number of process */
|
|
RABIT_DLL int RabitGetWorldSize(void);
|
|
/*!
|
|
* \brief print the msg to the tracker,
|
|
* this function can be used to communicate the information of the progress to
|
|
* the user who monitors the tracker
|
|
* \param msg the message to be printed
|
|
*/
|
|
RABIT_DLL void RabitTrackerPrint(const char *msg);
|
|
/*!
|
|
* \brief get name of processor
|
|
* \param out_name hold output string
|
|
* \param out_len hold length of output string
|
|
* \param max_len maximum buffer length of input
|
|
*/
|
|
RABIT_DLL void RabitGetProcessorName(char *out_name,
|
|
rbt_ulong *out_len,
|
|
rbt_ulong max_len);
|
|
/*!
|
|
* \brief broadcast an memory region to all others from root
|
|
*
|
|
* Example: int a = 1; Broadcast(&a, sizeof(a), root);
|
|
* \param sendrecv_data the pointer to send or recive buffer,
|
|
* \param size the size of the data
|
|
* \param root the root of process
|
|
*/
|
|
RABIT_DLL void RabitBroadcast(void *sendrecv_data,
|
|
rbt_ulong size, int root);
|
|
/*!
|
|
* \brief perform in-place allreduce, on sendrecvbuf
|
|
* this function is NOT thread-safe
|
|
*
|
|
* Example Usage: the following code gives sum of the result
|
|
* vector<int> data(10);
|
|
* ...
|
|
* Allreduce<op::Sum>(&data[0], data.size());
|
|
* ...
|
|
* \param sendrecvbuf buffer for both sending and recving data
|
|
* \param count number of elements to be reduced
|
|
* \param enum_dtype the enumeration of data type, see rabit::engine::mpi::DataType in engine.h of rabit include
|
|
* \param enum_op the enumeration of operation type, see rabit::engine::mpi::OpType in engine.h of rabit
|
|
* \param prepare_fun Lazy preprocessing function, if it is not NULL, prepare_fun(prepare_arg)
|
|
* will be called by the function before performing Allreduce, to intialize the data in sendrecvbuf_.
|
|
* If the result of Allreduce can be recovered directly, then prepare_func will NOT be called
|
|
* \param prepare_arg argument used to passed into the lazy preprocessing function
|
|
*/
|
|
RABIT_DLL void RabitAllreduce(void *sendrecvbuf,
|
|
size_t count,
|
|
int enum_dtype,
|
|
int enum_op,
|
|
void (*prepare_fun)(void *arg),
|
|
void *prepare_arg);
|
|
#ifdef __cplusplus
|
|
} // C
|
|
#endif
|
|
#endif // XGBOOST_WRAPPER_H_
|