Changeset 5649

Timestamp:

02/15/09 18:26:57 (4 years ago)

Author:

khali

Message:

Include the configuration file name when reporting parse errors.

Location:

lm-sensors/trunk

Files:

• CHANGES (modified) (1 diff)
• doc/libsensors-API.txt (modified) (1 diff)
• lib/access.c (modified) (4 diffs)
• lib/conf-parse.y (modified) (1 diff)
• lib/conf.h (modified) (1 diff)
• lib/data.c (modified) (4 diffs)
• lib/error.c (modified) (3 diffs)
• lib/error.h (modified) (2 diffs)
• lib/init.c (modified) (3 diffs)

lm-sensors/trunk/CHANGES

@@ -13 +13 @@
               Exit the configuration file parser sooner
               Free bus statements from the configuration file sooner
-              Read extra configuration files from /etc/sensors.d
+              Read extra configuration files from /etc/sensors.d (#2174)
+              Report the configuration file name on parse errors
   lm_sensors.init: Support new format of /etc/sysconfig/lm_sensors (#2246)
                    Drop support for kernels 2.4 and earlier

lm-sensors/trunk/doc/libsensors-API.txt

@@ -25 +25 @@
 * Added error value for excessive recursion depth
   #define SENSORS_ERR_RECURSION 11
+* Added parse error reporting function including the configuration file
+  name
+  extern void (*sensors_parse_error_wfn) (const char *err,
+                                          const char *filename, int lineno);
 
 0x401   lm-sensors 3.0.2 to 3.0.3

lm-sensors/trunk/lib/access.c

@@ -2 +2 @@
     access.c - Part of libsensors, a Linux library for reading sensor data.
     Copyright (c) 1998, 1999  Frodo Looijaard <frodol@dds.nl>
-    Copyright (C) 2007, 2008  Jean Delvare <khali@linux-fr.org>
+    Copyright (C) 2007-2009   Jean Delvare <khali@linux-fr.org>
 
     This program is free software; you can redistribute it and/or modify
@@ -512 +512 @@
                                                         chip->sets[i].name);
                         if (!subfeature) {
-                                sensors_parse_error("Unknown feature name",
+                                sensors_parse_error_wfn("Unknown feature name",
+                                                    chip->sets[i].line.filename,
                                                     chip->sets[i].line.lineno);
                                 err = -SENSORS_ERR_NO_ENTRY;
@@ -522 +523 @@
                                                 0, &value);
                         if (res) {
-                                sensors_parse_error("Error parsing expression",
+                                sensors_parse_error_wfn("Error parsing expression",
+                                                    chip->sets[i].line.filename,
                                                     chip->sets[i].line.lineno);
                                 err = res;
@@ -529 +531 @@
                         if ((res = sensors_set_value(name, subfeature->number,
                                                      value))) {
-                                sensors_parse_error("Failed to set value",
+                                sensors_parse_error_wfn("Failed to set value",
+                                                chip->sets[i].line.filename,
                                                 chip->sets[i].line.lineno);
                                 err = res;

lm-sensors/trunk/lib/conf-parse.y

@@ -333 +333 @@
 {
   if (sensors_lex_error[0]) {
-    sensors_parse_error(sensors_lex_error,sensors_yylineno);
+    sensors_parse_error_wfn(sensors_lex_error, sensors_yyfilename, sensors_yylineno);
     sensors_lex_error[0] = '\0';
   } else
-    sensors_parse_error(err,sensors_yylineno);
+    sensors_parse_error_wfn(err, sensors_yyfilename, sensors_yylineno);
 }
 

lm-sensors/trunk/lib/conf.h

@@ -25 +25 @@
 int sensors_yylex(void);
 extern char sensors_lex_error[];
+extern const char *sensors_yyfilename;
 extern int sensors_yylineno;
 extern FILE *sensors_yyin;

lm-sensors/trunk/lib/data.c

@@ -203 +203 @@
 }
 
-static int sensors_substitute_chip(sensors_chip_name *name, int lineno)
+static int sensors_substitute_chip(sensors_chip_name *name,
+                                   const char *filename, int lineno)
 {
         int i, j;
@@ -212 +213 @@
 
         if (i == sensors_config_busses_count) {
-                sensors_parse_error("Undeclared bus id referenced", lineno);
+                sensors_parse_error_wfn("Undeclared bus id referenced",
+                                        filename, lineno);
                 name->bus.nr = SENSORS_BUS_NR_IGNORE;
                 return -SENSORS_ERR_BUS_NAME;
@@ -239 +241 @@
         int err, i, j, lineno;
         sensors_chip_name_list *chips;
+        const char *filename;
         int res = 0;
 
         for (i = sensors_config_chips_subst;
              i < sensors_config_chips_count; i++) {
+                filename = sensors_config_chips[i].line.filename;
                 lineno = sensors_config_chips[i].line.lineno;
                 chips = &sensors_config_chips[i].chips;
@@ -251 +255 @@
                                 continue;
 
-                        err = sensors_substitute_chip(&chips->fits[j], lineno);
+                        err = sensors_substitute_chip(&chips->fits[j],
+                                                      filename, lineno);
                         if (err)
                                 res = err;

lm-sensors/trunk/lib/error.c

@@ -2 +2 @@
     error.c - Part of libsensors, a Linux library for reading sensor data.
     Copyright (c) 1998, 1999  Frodo Looijaard <frodol@dds.nl>
-    Copyright (C) 2007, 2008  Jean Delvare <khali@linux-fr.org>
+    Copyright (C) 2007-2009   Jean Delvare <khali@linux-fr.org>
 
     This program is free software; you can redistribute it and/or modify
@@ -26 +26 @@
 
 static void sensors_default_parse_error(const char *err, int lineno);
+static void sensors_default_parse_error_wfn(const char *err,
+                                            const char *filename, int lineno);
 static void sensors_default_fatal_error(const char *proc, const char *err);
 
 void (*sensors_parse_error) (const char *err, int lineno) =
                                                 sensors_default_parse_error;
+void (*sensors_parse_error_wfn) (const char *err, const char *filename,
+                                 int lineno) = sensors_default_parse_error_wfn;
 void (*sensors_fatal_error) (const char *proc, const char *err) =
                                                 sensors_default_fatal_error;
@@ -65 +69 @@
 }
 
+void sensors_default_parse_error_wfn(const char *err,
+                                     const char *filename, int lineno)
+{
+        /* If application provided a custom parse error reporting function
+           but not the variant with the filename, fall back to the original
+           variant without the filename, for backwards compatibility. */
+        if (sensors_parse_error != sensors_default_parse_error ||
+            !filename)
+                return sensors_parse_error(err, lineno);
+
+        if (lineno)
+                fprintf(stderr, "Error: File %s, line %d: %s\n", filename,
+                        lineno, err);
+        else
+                fprintf(stderr, "Error: File %s: %s\n", filename, err);
+}
+
 void sensors_default_fatal_error(const char *proc, const char *err)
 {

lm-sensors/trunk/lib/error.h

@@ -2 +2 @@
     error.h - Part of libsensors, a Linux library for reading sensor data.
     Copyright (c) 1998, 1999  Frodo Looijaard <frodol@dds.nl>
-    Copyright (C) 2007, 2008  Jean Delvare <khali@linux-fr.org>
+    Copyright (C) 2007-2009   Jean Delvare <khali@linux-fr.org>
 
     This program is free software; you can redistribute it and/or modify
@@ -45 +45 @@
 const char *sensors_strerror(int errnum);
 
-/* This function is called when a parse error is detected. Give it a new
-   value, and your own function is called instead of the default (which
-   prints to stderr). This function may terminate the program, but it
-   usually outputs an error and returns. */
+/* These functions are called when a parse error is detected. Give them new
+   values, and your own functions are called instead of the default (which
+   print to stderr). These functions may terminate the program, but they
+   usually output an error and return. The first function is the original
+   one, the second one was added later when support for multiple
+   configuration files was added.
+   The library code now only calls the second function. However, for
+   backwards compatibility, if an application provides a custom handling
+   function for the first function but not the second, then all parse
+   errors will be reported using the first function (that is, the filename
+   is never reported.)
+   Note that filename can be NULL (if filename isn't known) and lineno
+   can be 0 (if the error occurs before the actual parsing starts.) */
 extern void (*sensors_parse_error) (const char *err, int lineno);
+extern void (*sensors_parse_error_wfn) (const char *err,
+                                        const char *filename, int lineno);
 
 /* This function is called when an immediately fatal error (like no

lm-sensors/trunk/lib/init.c

@@ -126 +126 @@
         count = scandir(dir, &namelist, config_file_filter, alphasort);
         if (count < 0) {
-                sensors_parse_error(strerror(errno), 0);
+                sensors_parse_error_wfn(strerror(errno), NULL, 0);
                 return -SENSORS_ERR_PARSE;
         }
@@ -148 +148 @@
                 } else {
                         res = -SENSORS_ERR_PARSE;
-                        sensors_parse_error(strerror(errno), 0);
+                        sensors_parse_error_wfn(strerror(errno), path, 0);
                 }
         }
@@ -188 +188 @@
 
                 } else if (errno != ENOENT) {
-                        sensors_parse_error(strerror(errno), 0);
+                        sensors_parse_error_wfn(strerror(errno), name, 0);
                         res = -SENSORS_ERR_PARSE;
                         goto exit_cleanup;