system/dev/misc/sysinfo/sysinfo.c

// Copyright 2016 The Fuchsia Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include <ddk/binding.h>
#include <ddk/device.h>
#include <ddk/driver.h>
#include <ddk/metadata.h>

#include <zircon/types.h>
#include <zircon/process.h>
#include <zircon/processargs.h>

#include <zircon/boot/image.h>
#include <zircon/device/sysinfo.h>
#include <zircon/syscalls/resource.h>

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <threads.h>


#define ID_HJOBROOT 4

typedef struct {
    zx_device_t* zxdev;
    zx_handle_t job_root;
    mtx_t lock;
    char board_name[ZBI_BOARD_NAME_LEN];
} sysinfo_t;

static zx_handle_t get_sysinfo_job_root(sysinfo_t* sysinfo) {
    mtx_lock(&sysinfo->lock);
    if (sysinfo->job_root == ZX_HANDLE_INVALID) {
        sysinfo->job_root = zx_take_startup_handle(PA_HND(PA_USER0, ID_HJOBROOT));
    }
    mtx_unlock(&sysinfo->lock);

    zx_handle_t h;
    if ((sysinfo->job_root != ZX_HANDLE_INVALID) &&
        (zx_handle_duplicate(sysinfo->job_root, ZX_RIGHT_SAME_RIGHTS, &h) == ZX_OK)) {
        return h;
    }

    return ZX_HANDLE_INVALID;
}

static zx_status_t sysinfo_ioctl(void* ctx, uint32_t op, const void* cmd, size_t cmdlen,
                             void* reply, size_t max, size_t* out_actual) {
    sysinfo_t* sysinfo = ctx;

    switch (op) {
    case IOCTL_SYSINFO_GET_ROOT_JOB: {
        if ((cmdlen != 0) || (max < sizeof(zx_handle_t))) {
            return ZX_ERR_INVALID_ARGS;
        }
        zx_handle_t h = get_sysinfo_job_root(sysinfo);
        if (h == ZX_HANDLE_INVALID) {
            return ZX_ERR_NOT_SUPPORTED;
        } else {
            memcpy(reply, &h, sizeof(zx_handle_t));
            *out_actual = sizeof(zx_handle_t);
            return ZX_OK;
        }
    }
    case IOCTL_SYSINFO_GET_ROOT_RESOURCE: {
        if ((cmdlen != 0) || (max < sizeof(zx_handle_t))) {
            return ZX_ERR_INVALID_ARGS;
        }
        zx_handle_t h = get_root_resource();
        if (h == ZX_HANDLE_INVALID) {
            return ZX_ERR_NOT_SUPPORTED;
        }
        zx_status_t status = zx_handle_duplicate(h, ZX_RIGHT_TRANSFER, &h);
        if (status < 0) {
            return status;
        }
        memcpy(reply, &h, sizeof(zx_handle_t));
        *out_actual = sizeof(zx_handle_t);
        return ZX_OK;
    }
    case IOCTL_SYSINFO_GET_HYPERVISOR_RESOURCE: {
        if ((cmdlen != 0) || (max < sizeof(zx_handle_t))) {
            return ZX_ERR_INVALID_ARGS;
        }
        zx_handle_t h;
        const char name[] = "hypervisor";
        zx_status_t status = zx_resource_create(get_root_resource(),
                                                ZX_RSRC_KIND_HYPERVISOR,
                                                0, 0, name, sizeof(name), &h);
        if (status < 0) {
            return status;
        }
        memcpy(reply, &h, sizeof(zx_handle_t));
        *out_actual = sizeof(zx_handle_t);
        return ZX_OK;
    }
    case IOCTL_SYSINFO_GET_BOARD_NAME: {
        if ((cmdlen != 0) || (max < sizeof(sysinfo->board_name))) {
            return ZX_ERR_INVALID_ARGS;
        }
        zx_status_t status = ZX_OK;

        mtx_lock(&sysinfo->lock);
        if (sysinfo->board_name[0] == 0) {
            size_t actual = 0;
            status = device_get_metadata(sysinfo->zxdev, DEVICE_METADATA_BOARD_NAME,
                                         sysinfo->board_name, sizeof(sysinfo->board_name),
                                         &actual);
        }
        mtx_unlock(&sysinfo->lock);
        if (status != ZX_OK) {
            return status;
        }
        memcpy(reply, sysinfo->board_name, sizeof(sysinfo->board_name));
        *out_actual = sizeof(sysinfo->board_name);
        return ZX_OK;
    }
    case IOCTL_SYSINFO_GET_INTERRUPT_CONTROLLER_INFO : {
        interrupt_controller_info_t info = {};

#if defined(__aarch64__)
        size_t actual = 0;
        zx_status_t status = device_get_metadata(sysinfo->zxdev,
                                                 DEVICE_METADATA_INTERRUPT_CONTROLLER_TYPE,
                                                 &info.type, sizeof(uint8_t), &actual);
        if (status != ZX_OK) {
            return status;
        }
#elif defined(__x86_64__)
        info.type = INTERRUPT_CONTROLLER_TYPE_APIC;
#else
        info.type = INTERRUPT_CONTROLLER_TYPE_UNKNOWN;
#endif

        memcpy(reply, &info, sizeof(interrupt_controller_info_t));
        *out_actual = sizeof(interrupt_controller_info_t);
        return ZX_OK;
    }
    default:
        return ZX_ERR_INVALID_ARGS;
    }
}

static zx_protocol_device_t sysinfo_ops = {
    .version = DEVICE_OPS_VERSION,
    .ioctl = sysinfo_ioctl,
};

zx_status_t sysinfo_bind(void* ctx, zx_device_t* parent) {
    sysinfo_t* sysinfo = calloc(1, sizeof(sysinfo_t));
    if (!sysinfo) {
        return ZX_ERR_NO_MEMORY;
    }

    mtx_init(&sysinfo->lock, mtx_plain);

    device_add_args_t args = {
        .version = DEVICE_ADD_ARGS_VERSION,
        .name = "sysinfo",
        .ctx = sysinfo,
        .ops = &sysinfo_ops,
    };

    return device_add(parent, &args, &sysinfo->zxdev);
}

static zx_driver_ops_t sysinfo_driver_ops = {
    .version = DRIVER_OPS_VERSION,
    .bind = sysinfo_bind,
};

ZIRCON_DRIVER_BEGIN(sysinfo, sysinfo_driver_ops, "zircon", "0.1", 1)
    BI_MATCH_IF(EQ, BIND_PROTOCOL, ZX_PROTOCOL_MISC_PARENT),
ZIRCON_DRIVER_END(sysinfo)