lm-sensors/lib/access.c

/*
    access.c - Part of libsensors, a Linux library for reading sensor data.
    Copyright (c) 1998, 1999  Frodo Looijaard <frodol@dds.nl>
    Copyright (C) 2007        Jean Delvare <khali@linux-fr.org>

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/

#include <stdlib.h>
#include <string.h>
#include <math.h>
#include "access.h"
#include "sensors.h"
#include "data.h"
#include "error.h"
#include "sysfs.h"
#include "general.h"

static int sensors_eval_expr(const sensors_chip_name *name,
			     const sensors_expr *expr,
			     double val, double *result);

/* Compare two chips name descriptions, to see whether they could match.
   Return 0 if it does not match, return 1 if it does match. */
static int sensors_match_chip(const sensors_chip_name *chip1,
		       const sensors_chip_name *chip2)
{
	if ((chip1->prefix != SENSORS_CHIP_NAME_PREFIX_ANY) &&
	    (chip2->prefix != SENSORS_CHIP_NAME_PREFIX_ANY) &&
	    strcasecmp(chip1->prefix, chip2->prefix))
		return 0;

	if ((chip1->bus.type != SENSORS_BUS_TYPE_ANY) &&
	    (chip2->bus.type != SENSORS_BUS_TYPE_ANY) &&
	    (chip1->bus.type != chip2->bus.type))
		return 0;

	if ((chip1->bus.nr != SENSORS_BUS_NR_ANY) &&
	    (chip2->bus.nr != SENSORS_BUS_NR_ANY) &&
	    (chip1->bus.nr != chip2->bus.nr))
		return 0;

	if ((chip1->addr != chip2->addr) &&
	    (chip1->addr != SENSORS_CHIP_NAME_ADDR_ANY) &&
	    (chip2->addr != SENSORS_CHIP_NAME_ADDR_ANY))
		return 0;

	return 1;
}

/* Returns, one by one, a pointer to all sensor_chip structs of the
   config file which match with the given chip name. Last should be
   the value returned by the last call, or NULL if this is the first
   call. Returns NULL if no more matches are found. Do not modify
   the struct the return value points to! 
   Note that this visits the list of chips from last to first. Usually,
   you want the match that was latest in the config file. */
static sensors_chip *
sensors_for_all_config_chips(const sensors_chip_name *name,
			     const sensors_chip *last)
{
	int nr, i;
	sensors_chip_name_list chips;

	for (nr = last ? last - sensors_config_chips - 1 :
			 sensors_config_chips_count - 1; nr >= 0; nr--) {

		chips = sensors_config_chips[nr].chips;
		for (i = 0; i < chips.fits_count; i++) {
			if (sensors_match_chip(&chips.fits[i], name))
				return sensors_config_chips + nr;
		}
	}
	return NULL;
}

/* Look up a resource in the intern chip list, and return a pointer to it. 
   Do not modify the struct the return value points to! Returns NULL if 
   not found.*/
const sensors_chip_feature *sensors_lookup_feature_nr(const sensors_chip_name *chip,
						      int feature)
{
	int i, j;
	const sensors_chip_feature *features;

	for (i = 0; i < sensors_proc_chips_count; i++)
		if (sensors_match_chip(&sensors_proc_chips[i].chip, chip)) {
			features = sensors_proc_chips[i].feature;
			for (j = 0; features[j].data.name; j++)
				if (features[j].data.number == feature)
					return features + j;
		}
	return NULL;
}

/* Look up a resource in the intern chip list, and return a pointer to it. 
   Do not modify the struct the return value points to! Returns NULL if 
   not found.*/
static const sensors_chip_feature *
sensors_lookup_feature_name(const sensors_chip_name *chip, const char *feature)
{
	int i, j;
	const sensors_chip_feature *features;

	for (i = 0; i < sensors_proc_chips_count; i++)
		if (sensors_match_chip(&sensors_proc_chips[i].chip, chip)) {
			features = sensors_proc_chips[i].feature;
			for (j = 0; features[j].data.name; j++)
				if (!strcasecmp(features[j].data.name, feature))
					return features + j;
		}
	return NULL;
}

/* Check whether the chip name is an 'absolute' name, which can only match
   one chip, or whether it has wildcards. Returns 0 if it is absolute, 1
   if there are wildcards. */
int sensors_chip_name_has_wildcards(const sensors_chip_name *chip)
{
	if ((chip->prefix == SENSORS_CHIP_NAME_PREFIX_ANY) ||
	    (chip->bus.type == SENSORS_BUS_TYPE_ANY) ||
	    (chip->bus.nr == SENSORS_BUS_NR_ANY) ||
	    (chip->addr == SENSORS_CHIP_NAME_ADDR_ANY))
		return 1;
	else
		return 0;
}

/* Look up the label which belongs to this chip. Note that chip should not
   contain wildcard values! The returned string is newly allocated (free it
   yourself). On failure, NULL is returned.
   If no label exists for this feature, its name is returned itself. */
char *sensors_get_label(const sensors_chip_name *name, int feature)
{
	char *label;
	const sensors_chip *chip;
	const sensors_chip_feature *featureptr;
	char buf[128], path[PATH_MAX];
	FILE *f;
	int i;

	if (sensors_chip_name_has_wildcards(name))
		return NULL;
	if (!(featureptr = sensors_lookup_feature_nr(name, feature)))
		return NULL;

	for (chip = NULL; (chip = sensors_for_all_config_chips(name, chip));)
		for (i = 0; i < chip->labels_count; i++)
			if (!strcasecmp(featureptr->data.name, chip->labels[i].name)) {
				label = strdup(chip->labels[i].value);
				goto sensors_get_label_exit;
			}

	/* No user specified label, check for a _label sysfs file */
	snprintf(path, PATH_MAX, "%s/%s_label", name->path,
		featureptr->data.name);
	
	if ((f = fopen(path, "r"))) {
		i = fread(buf, 1, sizeof(buf) - 1, f);
		fclose(f);
		if (i > 0) {
			/* i - 1 to strip the '\n' at the end */
			buf[i - 1] = 0;
			label = strdup(buf);
			goto sensors_get_label_exit;
		}
	}

	/* No label, return the feature name instead */
	label = strdup(featureptr->data.name);
	
sensors_get_label_exit:
	if (!label)
		sensors_fatal_error("sensors_get_label",
				    "Allocating label text");
	return label;
}

/* Looks up whether a feature should be ignored. Returns
   1 if it should be ignored, 0 if not. This function takes
   logical mappings into account. */
static int sensors_get_ignored(const sensors_chip_name *name,
			       const sensors_chip_feature *feature)
{
	const sensors_chip *chip;
	const char *main_feature_name;
	int i;

	if (feature->data.mapping == SENSORS_NO_MAPPING)
		main_feature_name = NULL;
	else
		main_feature_name = sensors_lookup_feature_nr(name,
					feature->data.mapping)->data.name;

	for (chip = NULL; (chip = sensors_for_all_config_chips(name, chip));)
		for (i = 0; i < chip->ignores_count; i++)
			if (!strcasecmp(feature->data.name, chip->ignores[i].name) ||
			    (main_feature_name &&
			     !strcasecmp(main_feature_name, chip->ignores[i].name)))
				return 1;
	return 0;
}

/* Read the value of a feature of a certain chip. Note that chip should not
   contain wildcard values! This function will return 0 on success, and <0
   on failure. */
int sensors_get_value(const sensors_chip_name *name, int feature,
		      double *result)
{
	const sensors_chip_feature *main_feature;
	const sensors_chip_feature *alt_feature;
	const sensors_chip *chip;
	const sensors_expr *expr = NULL;
	double val;
	int res, i;
	int final_expr = 0;

	if (sensors_chip_name_has_wildcards(name))
		return -SENSORS_ERR_WILDCARDS;
	if (!(main_feature = sensors_lookup_feature_nr(name, feature)))
		return -SENSORS_ERR_NO_ENTRY;

	if (main_feature->data.compute_mapping == SENSORS_NO_MAPPING)
		alt_feature = NULL;
	else
		alt_feature = sensors_lookup_feature_nr(name,
					main_feature->data.compute_mapping);

	if (!(main_feature->data.flags & SENSORS_MODE_R))
		return -SENSORS_ERR_ACCESS_R;
	for (chip = NULL;
	     !expr && (chip = sensors_for_all_config_chips(name, chip));)
		for (i = 0; !final_expr && (i < chip->computes_count); i++) {
			if (!strcasecmp(main_feature->data.name, chip->computes[i].name)) {
				expr = chip->computes[i].from_proc;
				final_expr = 1;
			} else if (alt_feature && !strcasecmp(alt_feature->data.name,
					       chip->computes[i].name)) {
				expr = chip->computes[i].from_proc;
			}
		}
	if (sensors_read_sysfs_attr(name, feature, &val))
		return -SENSORS_ERR_PROC;
	if (!expr)
		*result = val;
	else if ((res = sensors_eval_expr(name, expr, val, result)))
		return res;
	return 0;
}

/* Set the value of a feature of a certain chip. Note that chip should not
   contain wildcard values! This function will return 0 on success, and <0
   on failure. */
int sensors_set_value(const sensors_chip_name *name, int feature,
		      double value)
{
	const sensors_chip_feature *main_feature;
	const sensors_chip_feature *alt_feature;
	const sensors_chip *chip;
	const sensors_expr *expr = NULL;
	int i, res;
	int final_expr = 0;
	double to_write;

	if (sensors_chip_name_has_wildcards(name))
		return -SENSORS_ERR_WILDCARDS;
	if (!(main_feature = sensors_lookup_feature_nr(name, feature)))
		return -SENSORS_ERR_NO_ENTRY;

	if (main_feature->data.compute_mapping == SENSORS_NO_MAPPING)
		alt_feature = NULL;
	else
		alt_feature = sensors_lookup_feature_nr(name,
					main_feature->data.compute_mapping);

	if (!(main_feature->data.flags & SENSORS_MODE_W))
		return -SENSORS_ERR_ACCESS_W;
	for (chip = NULL;
	     !expr && (chip = sensors_for_all_config_chips(name, chip));)
		for (i = 0; !final_expr && (i < chip->computes_count); i++)
			if (!strcasecmp(main_feature->data.name, chip->computes[i].name)) {
				expr = chip->computes->to_proc;
				final_expr = 1;
			} else if (alt_feature && !strcasecmp(alt_feature->data.name,
					       chip->computes[i].name)) {
				expr = chip->computes[i].to_proc;
			}

	to_write = value;
	if (expr)
		if ((res = sensors_eval_expr(name, expr, value, &to_write)))
			return res;
	if (sensors_write_sysfs_attr(name, feature, to_write))
		return -SENSORS_ERR_PROC;
	return 0;
}

const sensors_chip_name *sensors_get_detected_chips(const sensors_chip_name
						    *match, int *nr)
{
	const sensors_chip_name *res;

	while (*nr < sensors_proc_chips_count) {
		res = &sensors_proc_chips[(*nr)++].chip;
		if (!match || sensors_match_chip(res, match))
			return res;
	}
	return NULL;
}

const char *sensors_get_adapter_name(const sensors_bus_id *bus)
{
	int i;

	/* bus types with a single instance */
	switch (bus->type) {
	case SENSORS_BUS_TYPE_ISA:
		return "ISA adapter";
	case SENSORS_BUS_TYPE_PCI:
		return "PCI adapter";
	/* SPI should not be here, but for now SPI adapters have no name
	   so we don't have any custom string to return. */
	case SENSORS_BUS_TYPE_SPI:
		return "SPI adapter";
	}

	/* bus types with several instances */
	for (i = 0; i < sensors_proc_bus_count; i++)
		if (sensors_proc_bus[i].bus.type == bus->type &&
		    sensors_proc_bus[i].bus.nr == bus->nr)
			return sensors_proc_bus[i].adapter;
	return NULL;
}

/* nr-1 is the last feature returned */
const sensors_feature_data *sensors_get_all_features(const sensors_chip_name *name,
						     int *nr)
{
	sensors_chip_feature *feature_list;
	int i;

	for (i = 0; i < sensors_proc_chips_count; i++)
		if (sensors_match_chip(&sensors_proc_chips[i].chip, name)) {
			feature_list = sensors_proc_chips[i].feature;
			while (feature_list[*nr].data.name
			    && sensors_get_ignored(name, &feature_list[*nr]))
				(*nr)++;
			if (!feature_list[*nr].data.name)
				return NULL;
			return &feature_list[(*nr)++].data;
		}
	return NULL;
}

/* Evaluate an expression */
int sensors_eval_expr(const sensors_chip_name *name,
		      const sensors_expr *expr,
		      double val, double *result)
{
	double res1, res2;
	int res;
	const sensors_chip_feature *feature;

	if (expr->kind == sensors_kind_val) {
		*result = expr->data.val;
		return 0;
	}
	if (expr->kind == sensors_kind_source) {
		*result = val;
		return 0;
	}
	if (expr->kind == sensors_kind_var) {
		if (!(feature = sensors_lookup_feature_name(name,
							    expr->data.var)))
			return SENSORS_ERR_NO_ENTRY;
		if (!(res = sensors_get_value(name, feature->data.number, result)))
			return res;
		return 0;
	}
	if ((res = sensors_eval_expr(name, expr->data.subexpr.sub1, val, &res1)))
		return res;
	if (expr->data.subexpr.sub2 &&
	    (res = sensors_eval_expr(name, expr->data.subexpr.sub2, val, &res2)))
		return res;
	switch (expr->data.subexpr.op) {
	case sensors_add:
		*result = res1 + res2;
		return 0;
	case sensors_sub:
		*result = res1 - res2;
		return 0;
	case sensors_multiply:
		*result = res1 * res2;
		return 0;
	case sensors_divide:
		if (res2 == 0.0)
			return -SENSORS_ERR_DIV_ZERO;
		*result = res1 / res2;
		return 0;
	case sensors_negate:
		*result = -res1;
		return 0;
	case sensors_exp:
		*result = exp(res1);
		return 0;
	case sensors_log:
		if (res1 < 0.0)
			return -SENSORS_ERR_DIV_ZERO;
		*result = log(res1);
		return 0;
	}
	return 0;
}

/* Execute all set statements for this particular chip. The chip may not 
   contain wildcards!  This function will return 0 on success, and <0 on 
   failure. */
static int sensors_do_this_chip_sets(const sensors_chip_name *name)
{
	sensors_chip *chip;
	double value;
	int i, j;
	int err = 0, res;
	const sensors_chip_feature *feature;
	int *feature_list = NULL;
	int feature_count = 0;
	int feature_max = 0;
	int feature_nr;

	for (chip = NULL; (chip = sensors_for_all_config_chips(name, chip));)
		for (i = 0; i < chip->sets_count; i++) {
			feature = sensors_lookup_feature_name(name,
							chip->sets[i].name);
			if (!feature) {
				sensors_parse_error("Unknown feature name",
						    chip->sets[i].lineno);
				err = SENSORS_ERR_NO_ENTRY;
				continue;
			}
			feature_nr = feature->data.number;

			/* Check whether we already set this feature */
			for (j = 0; j < feature_count; j++)
				if (feature_list[j] == feature_nr)
					break;
			if (j != feature_count)
				continue;
			sensors_add_array_el(&feature_nr, &feature_list,
					     &feature_count, &feature_max,
					     sizeof(int));

			res = sensors_eval_expr(name, chip->sets[i].value, 0,
					      &value);
			if (res) {
				sensors_parse_error("Error parsing expression",
						    chip->sets[i].lineno);
				err = res;
				continue;
			}
			if ((res = sensors_set_value(name, feature_nr, value))) {
				sensors_parse_error("Failed to set feature",
						chip->sets[i].lineno);
				err = res;
				continue;
			}
		}
	free(feature_list);
	return err;
}

/* Execute all set statements for this particular chip. The chip may contain
   wildcards!  This function will return 0 on success, and <0 on failure. */
int sensors_do_chip_sets(const sensors_chip_name *name)
{
	int nr, this_res;
	const sensors_chip_name *found_name;
	int res = 0;

	for (nr = 0; (found_name = sensors_get_detected_chips(name, &nr));) {
		this_res = sensors_do_this_chip_sets(found_name);
		if (this_res)
			res = this_res;
	}
	return res;
}

/* Static mappings for use by sensors_feature_get_type() */
struct feature_subtype_match
{
	const char *name;
	sensors_feature_type type;
};

struct feature_type_match
{
	const char *name;
	const struct feature_subtype_match *submatches;
};

static const struct feature_subtype_match temp_matches[] = {
	{ "input", SENSORS_FEATURE_TEMP },
	{ "max", SENSORS_FEATURE_TEMP_MAX },
	{ "max_hyst", SENSORS_FEATURE_TEMP_MAX_HYST },
	{ "min", SENSORS_FEATURE_TEMP_MIN },
	{ "crit", SENSORS_FEATURE_TEMP_CRIT },
	{ "crit_hyst", SENSORS_FEATURE_TEMP_CRIT_HYST },
	{ "alarm", SENSORS_FEATURE_TEMP_ALARM },
	{ "min_alarm", SENSORS_FEATURE_TEMP_MIN_ALARM },
	{ "max_alarm", SENSORS_FEATURE_TEMP_MAX_ALARM },
	{ "crit_alarm", SENSORS_FEATURE_TEMP_CRIT_ALARM },
	{ "fault", SENSORS_FEATURE_TEMP_FAULT },
	{ "type", SENSORS_FEATURE_TEMP_TYPE },
	{ NULL, 0 }
};

static const struct feature_subtype_match in_matches[] = {
	{ "input", SENSORS_FEATURE_IN },
	{ "min", SENSORS_FEATURE_IN_MIN },
	{ "max", SENSORS_FEATURE_IN_MAX },
	{ "alarm", SENSORS_FEATURE_IN_ALARM },
	{ "min_alarm", SENSORS_FEATURE_IN_MIN_ALARM },
	{ "max_alarm", SENSORS_FEATURE_IN_MAX_ALARM },
	{ NULL, 0 }
};

static const struct feature_subtype_match fan_matches[] = {
	{ "input", SENSORS_FEATURE_FAN },
	{ "min", SENSORS_FEATURE_FAN_MIN },
	{ "div", SENSORS_FEATURE_FAN_DIV },
	{ "alarm", SENSORS_FEATURE_FAN_ALARM },
	{ "fault", SENSORS_FEATURE_FAN_FAULT },
	{ NULL, 0 }
};

static const struct feature_subtype_match cpu_matches[] = {
	{ "vid", SENSORS_FEATURE_VID },
	{ NULL, 0 }
};

static struct feature_type_match matches[] = { 
	{ "temp%d%c", temp_matches },
	{ "in%d%c", in_matches },
	{ "fan%d%c", fan_matches },
	{ "cpu%d%c", cpu_matches },
};

/* Return the feature type and channel number based on the feature name */
sensors_feature_type sensors_feature_get_type(const char *name, int *nr)
{
	char c;
	int i, count;
	const struct feature_subtype_match *submatches;
	
	for (i = 0; i < ARRAY_SIZE(matches); i++)
		if ((count = sscanf(name, matches[i].name, nr, &c)))
			break;
	
	if (i == ARRAY_SIZE(matches) || count != 2 || c != '_')
		return SENSORS_FEATURE_UNKNOWN;  /* no match */

	submatches = matches[i].submatches;
	name = strchr(name + 3, '_') + 1;
	for (i = 0; submatches[i].name != NULL; i++)
		if (!strcmp(name, submatches[i].name))
			return submatches[i].type;
	
	return SENSORS_FEATURE_UNKNOWN;
}