119 lines
4.0 KiB
C++
119 lines
4.0 KiB
C++
/*
|
|
* Licensed to the Apache Software Foundation (ASF) under one
|
|
* or more contributor license agreements. See the NOTICE file
|
|
* distributed with this work for additional information
|
|
* regarding copyright ownership. The ASF licenses this file
|
|
* to you under the Apache License, Version 2.0 (the
|
|
* "License"); you may not use this file except in compliance
|
|
* with the License. You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing,
|
|
* software distributed under the License is distributed on an
|
|
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
|
* KIND, either express or implied. See the License for the
|
|
* specific language governing permissions and limitations
|
|
* under the License.
|
|
*/
|
|
/*!
|
|
* \file disco_worker.h
|
|
* \brief This file defines a worker in Disco. A worker can be launched in a separate thread or
|
|
* process as long as the channel supports bi-directional communication in-between the worker and
|
|
* the controler.
|
|
*/
|
|
#ifndef TVM_RUNTIME_DISCO_DISCO_WORKER_H_
|
|
#define TVM_RUNTIME_DISCO_DISCO_WORKER_H_
|
|
|
|
#include <tvm/ffi/function.h>
|
|
#include <tvm/runtime/disco/session.h>
|
|
|
|
#include <vector>
|
|
|
|
namespace tvm {
|
|
namespace runtime {
|
|
|
|
/*!
|
|
* \brief A worker in Disco. It takes a channel to communication with the controler.
|
|
* The worker can be run in a separate thread or process as long as the channel supports
|
|
* bi-directional communication in-between.
|
|
*/
|
|
class DiscoWorker {
|
|
public:
|
|
/*!
|
|
* \brief Construct a worker.
|
|
* \param worker_id The id of the worker.
|
|
* \param num_workers The number of the workers.
|
|
* \param num_groups The number of the worker groups.
|
|
* \param worker_zero_data The data shared between worker-0 and the controler. It's a nullptr if
|
|
* the worker is not worker-0.
|
|
* \param channel The communication channel between the worker and the controler.
|
|
*/
|
|
explicit DiscoWorker(int worker_id, int num_workers, int num_groups,
|
|
WorkerZeroData* worker_zero_data, DiscoChannel* channel)
|
|
: worker_id(worker_id),
|
|
local_worker_id(worker_id),
|
|
num_workers(num_workers),
|
|
num_groups(num_groups),
|
|
default_device(Device{DLDeviceType::kDLCPU, 0}),
|
|
worker_zero_data(worker_zero_data),
|
|
channel(channel),
|
|
register_file{} {}
|
|
|
|
/*! \brief Main loop of the worker */
|
|
void MainLoop();
|
|
/*! \brief Get the worker instance on the current thread */
|
|
TVM_RUNTIME_DLL static DiscoWorker* ThreadLocal();
|
|
/*! \brief Set the specific register to a specific value */
|
|
void SetRegister(int reg_id, ffi::AnyView value);
|
|
|
|
/*! \brief The id of the worker.*/
|
|
int worker_id;
|
|
/*! \brief The local id of the worker. This can be different from worker_id if the session is
|
|
* consisted with multiple sub-sessions. */
|
|
int local_worker_id;
|
|
/*! \brief Total number of workers */
|
|
int num_workers;
|
|
/*! \brief Total number of workers */
|
|
int num_groups;
|
|
/*! \brief The default device to allocate data if not specified */
|
|
Device default_device;
|
|
/*! \brief The name of the underlying collective communication library. */
|
|
ffi::String ccl;
|
|
/*!
|
|
* \brief The data shared between worker-0 and the controler. It's a nullptr if
|
|
* the worker is not worker-0.
|
|
* \note This data structure is owned by the controler.
|
|
*/
|
|
WorkerZeroData* worker_zero_data;
|
|
/*!
|
|
* \brief The communication channel between the worker and the controler.
|
|
* \note This data structure is owned by the controler.
|
|
*/
|
|
DiscoChannel* channel;
|
|
/*! \brief The registers in the worker */
|
|
std::vector<ffi::Any> register_file;
|
|
|
|
struct Impl;
|
|
friend struct DiscoWorker::Impl;
|
|
};
|
|
/*!
|
|
* \brief A threadlocal wrapper of DiscoWorker.
|
|
*/
|
|
struct ThreadLocalDiscoWorker {
|
|
/*! \brief The Disco worker */
|
|
DiscoWorker* worker;
|
|
|
|
/*!
|
|
* \brief Get the threadlocal Disco worker.
|
|
*/
|
|
static ThreadLocalDiscoWorker* Get() {
|
|
thread_local static ThreadLocalDiscoWorker worker;
|
|
return &worker;
|
|
}
|
|
};
|
|
|
|
} // namespace runtime
|
|
} // namespace tvm
|
|
#endif // TVM_RUNTIME_DISCO_DISCO_WORKER_H_
|