/* SPDX-License-Identifier: GPL-2.0-or-later */ /* * Copyright (C) 2020, Google Inc. * * file.cpp - File I/O operations tests */ #include #include #include #include #include #include #include #include #include "test.h" using namespace std; using namespace libcamera; class FileTest : public Test { protected: int init() { fileName_ = "/tmp/libcamera.test.XXXXXX"; int fd = mkstemp(&fileName_.front()); if (fd == -1) return TestFail; close(fd); unlink(fileName_.c_str()); return TestPass; } int run() { /* Test static functions. */ if (!File::exists("/dev/null")) { cerr << "Valid file not found" << endl; return TestFail; } if (File::exists("/dev/null/invalid")) { cerr << "Invalid file should not exist" << endl; return TestFail; } if (File::exists("/dev")) { cerr << "Directories should not be treated as files" << endl; return TestFail; } /* Test unnamed file. */ File file; if (!file.fileName().empty()) { cerr << "Unnamed file has non-empty file name" << endl; return TestFail; } if (file.exists()) { cerr << "Unnamed file exists" << endl; return TestFail; } if (file.isOpen()) { cerr << "File is open after construction" << endl; return TestFail; } if (file.openMode() != File::OpenModeFlag::NotOpen) { cerr << "File has invalid open mode after construction" << endl; return TestFail; } if (file.size() >= 0) { cerr << "Unnamed file has a size" << endl; return TestFail; } if (file.open(File::OpenModeFlag::ReadWrite)) { cerr << "Opening unnamed file succeeded" << endl; return TestFail; } if (file.error() == 0) { cerr << "Open failure didn't set error" << endl; return TestFail; } /* Test named file referring to an invalid file. */ file.setFileName("/dev/null/invalid"); if (file.fileName() != "/dev/null/invalid") { cerr << "File reports incorrect file name" << endl; return TestFail; } if (file.exists()) { cerr << "Invalid file exists" << endl; return TestFail; } if (file.isOpen()) { cerr << "Invalid file is open after construction" << endl; return TestFail; } if (file.openMode() != File::OpenModeFlag::NotOpen) { cerr << "Invalid file has invalid open mode after construction" << endl; return TestFail; } if (file.size() >= 0) { cerr << "Invalid file has a size" << endl; return TestFail; } if (file.open(File::OpenModeFlag::ReadWrite)) { cerr << "Opening invalid file succeeded" << endl; return TestFail; } /* Test named file referring to a valid file. */ file.setFileName("/dev/null"); if (!file.exists()) { cerr << "Valid file does not exist" << endl; return TestFail; } if (file.isOpen()) { cerr << "Valid file is open after construction" << endl; return TestFail; } if (file.openMode() != File::OpenModeFlag::NotOpen) { cerr << "Valid file has invalid open mode after construction" << endl; return TestFail; } if (file.size() >= 0) { cerr << "Invalid file has a size" << endl; return TestFail; } /* Test open and close. */ if (!file.open(File::OpenModeFlag::ReadWrite)) { cerr << "Opening file failed" << endl; return TestFail; } if (!file.isOpen()) { cerr << "Open file reported as closed" << endl; return TestFail; } if (file.openMode() != File::OpenModeFlag::ReadWrite) { cerr << "Open file has invalid open mode" << endl; return TestFail; } file.close(); if (file.isOpen()) { cerr << "Closed file reported as open" << endl; return TestFail; } if (file.openMode() != File::OpenModeFlag::NotOpen) { cerr << "Closed file has invalid open mode" << endl; return TestFail; } /* Test size(). */ file.setFileName(self()); if (file.size() >= 0) { cerr << "File has valid size before open" << endl; return TestFail; } file.open(File::OpenModeFlag::ReadOnly); ssize_t size = file.size(); if (size <= 0) { cerr << "File has invalid size after open" << endl; return TestFail; } file.close(); /* Test file creation. */ file.setFileName(fileName_); if (file.exists()) { cerr << "Temporary file already exists" << endl; return TestFail; } if (file.open(File::OpenModeFlag::ReadOnly)) { cerr << "Read-only open succeeded on nonexistent file" << endl; return TestFail; } if (!file.open(File::OpenModeFlag::WriteOnly)) { cerr << "Write-only open failed on nonexistent file" << endl; return TestFail; } if (!file.exists()) { cerr << "Write-only open failed to create file" << endl; return TestFail; } file.close(); /* Test read and write. */ std::array buffer = { 0 }; strncpy(reinterpret_cast(buffer.data()), "libcamera", buffer.size()); if (file.read(buffer) >= 0) { cerr << "Read succeeded on closed file" << endl; return TestFail; } if (file.write(buffer) >= 0) { cerr << "Write succeeded on closed file" << endl; return TestFail; } file.open(File::OpenModeFlag::ReadOnly); if (file.write(buffer) >= 0) { cerr << "Write succeeded on read-only file" << endl; return TestFail; } file.close(); file.open(File::OpenModeFlag::ReadWrite); if (file.write({ buffer.data(), 9 }) != 9) { cerr << "Write test failed" << endl; return TestFail; } if (file.read(buffer) != 0) { cerr << "Read at end of file test failed" << endl; return TestFail; } if (file.seek(0) != 0) { cerr << "Seek test failed" << endl; return TestFail; } if (file.read(buffer) != 9) { cerr << "Read test failed" << endl; return TestFail; } if (file.pos() != 9) { cerr << "Position test failed" << endl; return TestFail; } file.close(); /* Test mapping and unmapping. */ file.setFileName(self()); file.open(File::OpenModeFlag::ReadOnly); Span data = file.map(); if (data.empty()) { cerr << "Mapping of complete file failed" << endl; return TestFail; } if (data.size() != static_cast(size)) { cerr << "Mapping of complete file has invalid size" << endl; return TestFail; } if (!file.unmap(data.data())) { cerr << "Unmapping of complete file failed" << endl; return TestFail; } data = file.map(4096, 8192); if (data.empty()) { cerr << "Mapping of file region failed" << endl; return TestFail; } if (data.size() != 8192) { cerr << "Mapping of file region has invalid size" << endl; return TestFail; } if (!file.unmap(data.data())) { cerr << "Unmapping of file region failed" << endl; return TestFail; } file.close(); /* Test private mapping. */ file.setFileName(fileName_); file.open(File::OpenModeFlag::ReadWrite); data = file.map(0, -1, File::MapFlag::Private); if (data.empty()) { cerr << "Private mapping failed" << endl; return TestFail; } std::string str{ reinterpret_cast(data.data()), data.size() }; if (str != "libcamera") { cerr << "Invalid contents of private mapping" << endl; return TestFail; } memcpy(data.data(), "LIBCAMERA", 9); if (!file.unmap(data.data())) { cerr << "Private unmapping failed" << endl; return TestFail; } data = file.map(); str = { reinterpret_cast(data.data()), data.size() }; if (str != "libcamera") { cerr << "Private mapping changed file contents" << endl; return TestFail; } /* Test shared mapping. */ data = file.map(); if (data.empty()) { cerr << "Shared mapping failed" << endl; return TestFail; } memcpy(data.data(), "LIBCAMERA", 9); if (!file.unmap(data.data())) { cerr << "Shared unmapping failed" << endl; return TestFail; } data = file.map(); str = { reinterpret_cast(data.data()), data.size() }; if (str != "LIBCAMERA") { cerr << "Shared mapping failed to change file contents" << endl; return TestFail; } return TestPass; } void cleanup() { unlink(fileName_.c_str()); } private: std::string fileName_; }; TEST_REGISTER(FileTest) 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299

/* SPDX-License-Identifier: LGPL-2.1-or-later */
/*
 * Copyright (C) 2019, Google Inc.
 *
 * camera_hal_manager.cpp - libcamera Android Camera Manager
 */

#include "camera_hal_manager.h"

#include <libcamera/base/log.h>

#include <libcamera/camera.h>
#include <libcamera/property_ids.h>

#include "camera_device.h"

using namespace libcamera;

LOG_DECLARE_CATEGORY(HAL)

/*
 * \class CameraHalManager
 *
 * The HAL camera manager is initializated at camera_module_t 'hal_init()' time
 * and spawns its own thread where libcamera related events are dispatched to.
 * It wraps the libcamera CameraManager operations and provides helpers for the
 * camera_module_t operations, to retrieve the number of cameras in the system,
 * their static information and to open camera devices.
 */

CameraHalManager::CameraHalManager()
	: cameraManager_(nullptr), callbacks_(nullptr), numInternalCameras_(0),
	  nextExternalCameraId_(firstExternalCameraId_)
{
}

/* CameraManager calls stop() in the destructor. */
CameraHalManager::~CameraHalManager() = default;

/* static */
CameraHalManager *CameraHalManager::instance()
{
	static CameraHalManager *cameraHalManager = new CameraHalManager;
	return cameraHalManager;
}

int CameraHalManager::init()
{
	cameraManager_ = std::make_unique<CameraManager>();

	/*
	 * If the configuration file is not available the HAL only supports
	 * external cameras. If it exists but it's not valid then error out.
	 */
	if (halConfig_.exists() && !halConfig_.isValid()) {
		LOG(HAL, Error) << "HAL configuration file is not valid";
		return -EINVAL;
	}

	/* Support camera hotplug. */
	cameraManager_->cameraAdded.connect(this, &CameraHalManager::cameraAdded);
	cameraManager_->cameraRemoved.connect(this, &CameraHalManager::cameraRemoved);

	int ret = cameraManager_->start();
	if (ret) {
		LOG(HAL, Error) << "Failed to start camera manager: "
				<< strerror(-ret);
		cameraManager_.reset();
		return ret;
	}

	return 0;
}

std::tuple<CameraDevice *, int>
CameraHalManager::open(unsigned int id, const hw_module_t *hardwareModule)
{
	MutexLocker locker(mutex_);

	if (!callbacks_) {
		LOG(HAL, Error) << "Can't open camera before callbacks are set";
		return { nullptr, -ENODEV };
	}

	CameraDevice *camera = cameraDeviceFromHalId(id);
	if (!camera) {
		LOG(HAL, Error) << "Invalid camera id '" << id << "'";
		return { nullptr, -ENODEV };
	}

	int ret = camera->open(hardwareModule);
	if (ret)
		return { nullptr, ret };

	LOG(HAL, Info) << "Open camera '" << id << "'";

	return { camera, 0 };
}

void CameraHalManager::cameraAdded(std::shared_ptr<Camera> cam)
{
	unsigned int id;
	bool isCameraExternal = false;
	bool isCameraNew = false;

	MutexLocker locker(mutex_);

	/*
	 * Each camera is assigned a unique integer ID when it is seen for the
	 * first time. If the camera has been seen before, the previous ID is
	 * re-used.
	 *
	 * IDs starts from '0' for internal cameras and '1000' for external
	 * cameras.
	 */
	auto iter = cameraIdsMap_.find(cam->id());
	if (iter != cameraIdsMap_.end()) {
		id = iter->second;
		if (id >= firstExternalCameraId_)
			isCameraExternal = true;
	} else {
		isCameraNew = true;

		/*
		 * Now check if this is an external camera and assign
		 * its id accordingly.
		 */
		if (cameraLocation(cam.get()) == properties::CameraLocationExternal) {
			isCameraExternal = true;
			id = nextExternalCameraId_;
		} else {
			id = numInternalCameras_;
		}
	}

	/*
	 * The configuration file must be valid, and contain a corresponding
	 * entry for internal cameras. External cameras can be initialized
	 * without configuration file.
	 */
	if (!isCameraExternal && !halConfig_.exists()) {
		LOG(HAL, Error)
			<< "HAL configuration file is mandatory for internal cameras";
		return;
	}

	const CameraConfigData *cameraConfigData = halConfig_.cameraConfigData(cam->id());

	/*
	 * Some cameras whose location is reported by libcamera as external may
	 * actually be internal to the device. This is common with UVC cameras
	 * that are integrated in a laptop. In that case the real location
	 * should be specified in the configuration file.
	 *
	 * If the camera location is external and a configuration entry exists
	 * for it, override its location.
	 */
	if (isCameraNew && isCameraExternal) {
		if (cameraConfigData && cameraConfigData->facing != -1) {
			isCameraExternal = false;
			id = numInternalCameras_;
		}
	}

	if (!isCameraExternal && !cameraConfigData) {
		LOG(HAL, Error)
			<< "HAL configuration entry for internal camera "
			<< cam->id() << " is missing";
		return;
	}

	/* Create a CameraDevice instance to wrap the libcamera Camera. */
	std::unique_ptr<CameraDevice> camera = CameraDevice::create(id, cam);

	int ret = camera->initialize(cameraConfigData);
	if (ret) {
		LOG(HAL, Error) << "Failed to initialize camera: " << cam->id();
		return;
	}

	if (isCameraNew) {
		cameraIdsMap_.emplace(cam->id(), id);

		if (isCameraExternal)
			nextExternalCameraId_++;
		else
			numInternalCameras_++;
	}

	cameras_.emplace_back(std::move(camera));

	if (callbacks_)
		callbacks_->camera_device_status_change(callbacks_, id,
							CAMERA_DEVICE_STATUS_PRESENT);

	LOG(HAL, Debug) << "Camera ID: " << id << " added successfully.";
}

void CameraHalManager::cameraRemoved(std::shared_ptr<Camera> cam)
{
	MutexLocker locker(mutex_);

	auto iter = std::find_if(cameras_.begin(), cameras_.end(),
				 [&cam](const std::unique_ptr<CameraDevice> &camera) {
					 return cam == camera->camera();
				 });
	if (iter == cameras_.end())
		return;

	/*
	 * CAMERA_DEVICE_STATUS_NOT_PRESENT should be set for external cameras
	 * only.
	 */
	unsigned int id = (*iter)->id();
	if (id >= firstExternalCameraId_)
		callbacks_->camera_device_status_change(callbacks_, id,
							CAMERA_DEVICE_STATUS_NOT_PRESENT);

	/*
	 * \todo Check if the camera is already open and running.
	 * Inform the framework about its absence before deleting its
	 * reference here.
	 */
	cameras_.erase(iter);

	LOG(HAL, Debug) << "Camera ID: " << id << " removed successfully.";
}

int32_t CameraHalManager::cameraLocation(const Camera *cam)
{
	const ControlList &properties = cam->properties();
	if (!properties.contains(properties::Location))
		return -1;

	return properties.get(properties::Location);
}

CameraDevice *CameraHalManager::cameraDeviceFromHalId(unsigned int id)
{
	auto iter = std::find_if(cameras_.begin(), cameras_.end(),
				 [id](const std::unique_ptr<CameraDevice> &camera) {
					 return camera->id() == id;
				 });
	if (iter == cameras_.end())
		return nullptr;

	return iter->get();
}

unsigned int CameraHalManager::numCameras() const
{
	return numInternalCameras_;
}

int CameraHalManager::getCameraInfo(unsigned int id, struct camera_info *info)
{
	if (!info)
		return -EINVAL;

	MutexLocker locker(mutex_);

	CameraDevice *camera = cameraDeviceFromHalId(id);
	if (!camera) {
		LOG(HAL, Error) << "Invalid camera id '" << id << "'";
		return -EINVAL;
	}

	info->facing = camera->facing();
	info->orientation = camera->orientation();
	info->device_version = CAMERA_DEVICE_API_VERSION_3_3;
	info->resource_cost = 0;
	info->static_camera_characteristics = camera->getStaticMetadata();
	info->conflicting_devices = nullptr;
	info->conflicting_devices_length = 0;

	return 0;
}

void CameraHalManager::setCallbacks(const camera_module_callbacks_t *callbacks)
{
	callbacks_ = callbacks;

	MutexLocker locker(mutex_);

	/*
	 * Some external cameras may have been identified before the callbacks_
	 * were set. Iterate all existing external cameras and mark them as
	 * CAMERA_DEVICE_STATUS_PRESENT explicitly.
	 *
	 * Internal cameras are already assumed to be present at module load
	 * time by the Android framework.
	 */
	for (const std::unique_ptr<CameraDevice> &camera : cameras_) {
		unsigned int id = camera->id();
		if (id >= firstExternalCameraId_)
			callbacks_->camera_device_status_change(callbacks_, id,
								CAMERA_DEVICE_STATUS_PRESENT);
	}
}