hal/driver.h

// Copyright 2019 Google LLC
//
// Licensed 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
//
//      https://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.

#ifndef THIRD_PARTY_MLIR_EDGE_IREE_HAL_DRIVER_H_
#define THIRD_PARTY_MLIR_EDGE_IREE_HAL_DRIVER_H_

#include <memory>
#include <string>
#include <vector>

#include "third_party/mlir_edge/iree/base/status.h"
#include "third_party/mlir_edge/iree/hal/device.h"
#include "third_party/mlir_edge/iree/hal/device_info.h"

namespace iree {
namespace hal {

class Driver {
 public:
  virtual ~Driver() = default;

  // Driver name used during registration.
  const std::string& name() const { return name_; }

  // TODO(benvanik): info/query (version number, etc).

  // Enumerates devices available for creation from the driver.
  // This may fail if the driver is in an invalid state but otherwise will
  // return an empty list if no devices are available.
  virtual StatusOr<std::vector<DeviceInfo>> EnumerateAvailableDevices() = 0;

  // Creates the driver-defined 'default' device.
  // This may simply be the first device enumerated.
  virtual StatusOr<std::shared_ptr<Device>> CreateDefaultDevice() = 0;

  // Creates a device as queried with the given |device_info|.
  virtual StatusOr<std::shared_ptr<Device>> CreateDevice(
      const DeviceInfo& device_info) = 0;

 protected:
  explicit Driver(std::string name) : name_(std::move(name)) {}

 private:
  const std::string name_;
};

}  // namespace hal
}  // namespace iree

#endif  // THIRD_PARTY_MLIR_EDGE_IREE_HAL_DRIVER_H_