Bob King | 833b8e0 | 2020-06-11 14:56:38 +0800 | [diff] [blame] | 1 | /** |
| 2 | * Copyright © 2020 IBM Corporation |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | |
| 17 | #include "sensor_monitoring.hpp" |
| 18 | |
| 19 | #include "action_environment.hpp" |
| 20 | #include "action_utils.hpp" |
| 21 | #include "chassis.hpp" |
| 22 | #include "device.hpp" |
Shawn McCarney | 81a2f90 | 2021-03-23 21:41:34 -0500 | [diff] [blame] | 23 | #include "error_logging_utils.hpp" |
Bob King | 833b8e0 | 2020-06-11 14:56:38 +0800 | [diff] [blame] | 24 | #include "exception_utils.hpp" |
Bob King | 833b8e0 | 2020-06-11 14:56:38 +0800 | [diff] [blame] | 25 | #include "rail.hpp" |
Shawn McCarney | 17bac89 | 2021-05-08 07:55:52 -0500 | [diff] [blame] | 26 | #include "sensors.hpp" |
Bob King | 833b8e0 | 2020-06-11 14:56:38 +0800 | [diff] [blame] | 27 | #include "system.hpp" |
| 28 | |
| 29 | #include <exception> |
| 30 | |
| 31 | namespace phosphor::power::regulators |
| 32 | { |
| 33 | |
Shawn McCarney | fa2734d | 2022-03-30 21:16:40 -0500 | [diff] [blame] | 34 | /** |
| 35 | * Maximum number of consecutive errors before an error log entry is created. |
| 36 | * This provides "de-glitching" to ignore transient hardware problems. |
| 37 | * |
| 38 | * Also the maximum number of consecutive errors that will be logged to the |
| 39 | * journal. |
| 40 | */ |
| 41 | constexpr unsigned short maxErrorCount{6}; |
| 42 | |
Bob King | 8a55292 | 2020-08-05 17:02:31 +0800 | [diff] [blame] | 43 | void SensorMonitoring::execute(Services& services, System& system, |
Shawn McCarney | 17bac89 | 2021-05-08 07:55:52 -0500 | [diff] [blame] | 44 | Chassis& chassis, Device& device, Rail& rail) |
Bob King | 833b8e0 | 2020-06-11 14:56:38 +0800 | [diff] [blame] | 45 | { |
Shawn McCarney | 17bac89 | 2021-05-08 07:55:52 -0500 | [diff] [blame] | 46 | // Notify sensors service that monitoring is starting for this rail |
| 47 | Sensors& sensors = services.getSensors(); |
| 48 | sensors.startRail(rail.getID(), device.getFRU(), |
| 49 | chassis.getInventoryPath()); |
| 50 | |
| 51 | // Read all sensors defined for this rail |
Bob King | 833b8e0 | 2020-06-11 14:56:38 +0800 | [diff] [blame] | 52 | try |
| 53 | { |
| 54 | // Create ActionEnvironment |
Bob King | 73eacee | 2020-10-23 13:58:02 +0800 | [diff] [blame] | 55 | ActionEnvironment environment{system.getIDMap(), device.getID(), |
| 56 | services}; |
Bob King | 833b8e0 | 2020-06-11 14:56:38 +0800 | [diff] [blame] | 57 | |
| 58 | // Execute the actions |
| 59 | action_utils::execute(actions, environment); |
Shawn McCarney | fa2734d | 2022-03-30 21:16:40 -0500 | [diff] [blame] | 60 | |
| 61 | // Reset consecutive error count since sensors were read successfully |
| 62 | errorCount = 0; |
Bob King | 833b8e0 | 2020-06-11 14:56:38 +0800 | [diff] [blame] | 63 | } |
| 64 | catch (const std::exception& e) |
| 65 | { |
Shawn McCarney | fa2734d | 2022-03-30 21:16:40 -0500 | [diff] [blame] | 66 | // If we haven't hit the maximum consecutive error count yet |
| 67 | if (errorCount < maxErrorCount) |
Shawn McCarney | 17bac89 | 2021-05-08 07:55:52 -0500 | [diff] [blame] | 68 | { |
Shawn McCarney | fa2734d | 2022-03-30 21:16:40 -0500 | [diff] [blame] | 69 | // Log error messages in journal |
Shawn McCarney | 17bac89 | 2021-05-08 07:55:52 -0500 | [diff] [blame] | 70 | services.getJournal().logError(exception_utils::getMessages(e)); |
| 71 | services.getJournal().logError( |
| 72 | "Unable to monitor sensors for rail " + rail.getID()); |
Shawn McCarney | 17bac89 | 2021-05-08 07:55:52 -0500 | [diff] [blame] | 73 | |
Shawn McCarney | fa2734d | 2022-03-30 21:16:40 -0500 | [diff] [blame] | 74 | // Increment error count. If now at max, create error log entry. |
| 75 | if (++errorCount >= maxErrorCount) |
| 76 | { |
| 77 | error_logging_utils::logError(std::current_exception(), |
| 78 | Entry::Level::Warning, services, |
| 79 | errorHistory); |
| 80 | } |
| 81 | } |
Bob King | 833b8e0 | 2020-06-11 14:56:38 +0800 | [diff] [blame] | 82 | } |
Shawn McCarney | 17bac89 | 2021-05-08 07:55:52 -0500 | [diff] [blame] | 83 | |
| 84 | // Notify sensors service that monitoring has ended for this rail |
Shawn McCarney | fa2734d | 2022-03-30 21:16:40 -0500 | [diff] [blame] | 85 | bool errorOccurred = (errorCount > 0); |
Shawn McCarney | 17bac89 | 2021-05-08 07:55:52 -0500 | [diff] [blame] | 86 | sensors.endRail(errorOccurred); |
Bob King | 833b8e0 | 2020-06-11 14:56:38 +0800 | [diff] [blame] | 87 | } |
| 88 | |
| 89 | } // namespace phosphor::power::regulators |