SolarisPowerSource.java

/**
 * Oshi (https://github.com/oshi/oshi)
 *
 * Copyright (c) 2010 - 2017 The Oshi Project Team
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Maintainers:
 * dblock[at]dblock[dot]org
 * widdis[at]gmail[dot]com
 * enrico.bianchi[at]gmail[dot]com
 *
 * Contributors:
 * https://github.com/oshi/oshi/graphs/contributors
 */
package oshi.hardware.platform.unix.solaris;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import oshi.hardware.PowerSource;
import oshi.hardware.common.AbstractPowerSource;
import oshi.jna.platform.unix.solaris.LibKstat.Kstat;
import oshi.util.platform.unix.solaris.KstatUtil;

/**
 * A Power Source
 *
 * @author widdis[at]gmail[dot]com
 */
public class SolarisPowerSource extends AbstractPowerSource {

    private static final long serialVersionUID = 1L;

    private static final Logger LOG = LoggerFactory.getLogger(SolarisPowerSource.class);

    /*
     * One-time lookup to see which kstat module to use
     */
    private static final String[] KSTAT_BATT_MOD = { null, "battery", "acpi_drv" };

    private static final int KSTAT_BATT_IDX;

    static {
        if (KstatUtil.kstatLookup(KSTAT_BATT_MOD[1], 0, null) != null) {
            KSTAT_BATT_IDX = 1;
        } else if (KstatUtil.kstatLookup(KSTAT_BATT_MOD[2], 0, null) != null) {
            KSTAT_BATT_IDX = 2;
        } else {
            KSTAT_BATT_IDX = 0;
        }
    }

    public SolarisPowerSource(String newName, double newRemainingCapacity, double newTimeRemaining) {
        super(newName, newRemainingCapacity, newTimeRemaining);
        LOG.debug("Initialized SolarisPowerSource");
    }

    /**
     * Gets Battery Information
     *
     * @return An array of PowerSource objects representing batteries, etc.
     */
    public static PowerSource[] getPowerSources() {
        // If no kstat info, return empty
        if (KSTAT_BATT_IDX == 0) {
            return new SolarisPowerSource[0];
        }
        // Get kstat for the battery information
        Kstat ksp = KstatUtil.kstatLookup(KSTAT_BATT_MOD[KSTAT_BATT_IDX], 0, "battery BIF0");
        if (ksp == null) {
            return new SolarisPowerSource[0];
        }

        // Predicted battery capacity when fully charged.
        long energyFull = KstatUtil.kstatDataLookupLong(ksp, "bif_last_cap");
        if (energyFull == 0xffffffff || energyFull <= 0) {
            energyFull = KstatUtil.kstatDataLookupLong(ksp, "bif_design_cap");
        }
        if (energyFull == 0xffffffff || energyFull <= 0) {
            return new SolarisPowerSource[0];
        }

        // Get kstat for the battery state
        ksp = KstatUtil.kstatLookup(KSTAT_BATT_MOD[KSTAT_BATT_IDX], 0, "battery BST0");
        if (ksp == null) {
            return new SolarisPowerSource[0];
        }

        // estimated remaining battery capacity
        long energyNow = KstatUtil.kstatDataLookupLong(ksp, "bst_rem_cap");
        if (energyNow < 0) {
            return new SolarisPowerSource[0];
        }

        // power or current supplied at battery terminal
        long powerNow = KstatUtil.kstatDataLookupLong(ksp, "bst_rate");
        if (powerNow == 0xFFFFFFFF) {
            powerNow = 0L;
        }

        // Battery State:
        // bit 0 = discharging
        // bit 1 = charging
        // bit 2 = critical energy state
        boolean isCharging = (KstatUtil.kstatDataLookupLong(ksp, "bst_state") & 0x10) > 0;

        // Set up single battery in array
        SolarisPowerSource[] ps = new SolarisPowerSource[1];
        ps[0] = new SolarisPowerSource("BAT0", (double) energyNow / energyFull,
                isCharging ? -2d : powerNow > 0 ? 3600d * energyNow / powerNow : -1d);
        return ps;
    }
}