forked from khorton/nas_fan_control
-
Notifications
You must be signed in to change notification settings - Fork 4
/
MASTER_PID_fan_control.pl
1712 lines (1424 loc) · 63.1 KB
/
MASTER_PID_fan_control.pl
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#!/usr/local/bin/perl -w
# modify the above for TrueNAS SCALE to /usr/bin/perl
use strict;
use warnings;
# This script is based on the hybrid fan controller script created by @Stux,
# and posted at:
# https://forums.freenas.org/index.php?threads/script-hybrid-cpu-hd-fan-zone-controller.46159/
# The significant changes from @Stux's script are:
# 1. Replace HD fan control of several discrete duty cycles as a function of
# hottest HD temperature with a PID controller which controls duty cycle
# in 1% steps as a function of average HD temperature. As a protection,
# if any HD temperature exceeds a specified value, the HD fans are
# commanded to 100% duty cycle. This covers cases where one HD may be
# running hot, even if the average HD temperature is acceptable, or the
# PID loop control has gone awry.
# 2. Add optional setting to command CPU fans to 100% duty cycle if needed
# to assist with HD cooling, to cover scenarios where the CPU fan zone
# also controls chassis exit fans.
# 3. Add optional log of HD fan temperatures, PID loop values and commanded
# fan duty cycles. The log may optionally contain a record of each HD
# temperature, or only the coolest and warmest HD temperatures.
# 4. Added ability to specify the number of warmest disks to use when
# calculating the average temperature.
# 5. Added ability to put certain configuration values in a configuration
# file that is checked each time around the control loop.
# This script can be downloaded from :
# https://forums.freenas.org/index.php?threads/pid-fan-controller-perl-script.50908/
###############################################################################
# This script is designed to control both the CPU and HD fans in a Supermicro
# X10 based system according to both the CPU and HD temperatures in order to
# minimize noise while providing sufficient cooling to deal with scrubs and
# CPU torture tests. It may work in X9 based systems, but this has not been
# tested. It has been found to work on at least the X11SSM-F.
# It relies on the motherboard having two fan zones, FAN1..FAN4 and FANA..FANC.
# To use this correctly, you should connect all your PWM HD fans, by splitters
# if necessary to the FANA..FANC headers, or to the numbered FAN1..FAN4
# headers. The CPU, case and exhaust fans should then be connected to the
# other headers. This script will then control the HD fans in response to
# the HD temp, and the other fans in response to CPU temperature. When CPU
# temperature is high the HD fans will be used to provide additional cooling,
# if you specify cpu/hd shared cooling.
# If the fans should be high, and they are stuck low, or vice-versa, the BMC
# will be rebooted, thus it is critical to set the cpu/hd_max_fan_speed
# variables correctly.
# NOTE: It is highly likely the "get_hd_temp" function will not work as-is
# with your HDs. Until a better solution is provided you will need to modify
# this function to properly acquire the temperature. Setting debug=2 will help.
# Tested with a SuperMicro X10SRH-cF, Xeon E5-1650v4, Noctua 120, 90 and 80mm
# fans in a Norco RPC-4224 4U chassis, with 16 x 4 TB WD Red drives.
# More information on CPU/Peripheral Zone can be found in this post:
# https://forums.freenas.org/index.php?threads/thermal-and-accoustical-design-validation.28364/
# stux (+ editorial changes on Fan Zones from Kevin Horton)
###############################################################################
# The IPMI fan lower and upper fan speed thresholds must be adjusted to be
# compatible with the fans used. Do not rely completely on manufacturer specs
# to determine the slowest and fastest possible fan speeds, as some fans have
# been found to run at speeds that differ somewhat from the official specs.
# See:
# https://forums.freenas.org/index.php?resources/how-to-change-ipmi-sensor-thresholds-using-ipmitool.35/
# The following ipmitool commands can be run when connected to the FreeNAS
# server via ssh. They are useful to set a desired fan duty cycle before
# checking the fan speeds.
# Set duty cycle in Zone 0 to 100%: ipmitool raw 0x30 0x70 0x66 0x01 0x00 100
# Set duty cycle in Zone 0 to 50%: ipmitool raw 0x30 0x70 0x66 0x01 0x00 50
# Set duty cycle in Zone 0 to 20%: ipmitool raw 0x30 0x70 0x66 0x01 0x00 20
# Set duty cycle in Zone 1 to 100%: ipmitool raw 0x30 0x70 0x66 0x01 0x01 100
# Set duty cycle in Zone 1 to 50%: ipmitool raw 0x30 0x70 0x66 0x01 0x01 50
# Set duty cycle in Zone 1 to 20%: ipmitool raw 0x30 0x70 0x66 0x01 0x01 20
# Check duty cycle in Zone 0:
# ipmitool raw 0x30 0x70 0x66 0x00 0x00
# result is hex, with 64 being 100% duty cycle. 32 is 50% duty cycle.
# 14 is 20% duty cycle.
# Check duty cycle in Zone 1:
# ipmitool raw 0x30 0x70 0x66 0x00 0x01
# result is hex, with 64 being 100% duty cycle. 32 is 50% duty cycle.
# 14 is 20% duty cycle.
# Check fan speeds using: ipmitool sdr
# Number of warmest disks to average
# Originally, the script would calculate an average temperature for all disks,
# and vary fan speed as required to achieve the target temperature. Later,
# the option was added to have the script only worry about the warmest X
# disks, and use the average of those disks as the target. This better
# accomadated the common situation where there are several disks that run
# several degrees warmer than the others, and it is desired to keep those
# warm disks from exceeding a specified temperature.
# If desired, certain settings may be defined in a configuration file that
# can be changed on the fly, while the script is running. The script will
# check the latest modification time of the config file each time it
# determines the new fan duty cycle, and reload the configuration data if
# it has changed. This is useful when testing the script, as the PID control
# gains, average disk target temperature and number of warmest disk
# temperatures to average
# Kevin Horton
###############################################################################################
# VERSION HISTORY
#####################
# 2016-09-19 Initial Version
# 2016-09-19 Added cpu_hd_override_temp, to prevent HD fans cycling when
# CPU fans are sufficient for cooling CPU
# 2016-09-26 hd_list is now refreshed before checking HD temps so that we
# start/stop monitoring devices that have been hot inserted/removed.
# "Drives are warm, going to 75%" log message was missing an unless
# clause causing it to print every time
# 2016-10-07 Replaced get_cpu_temp() function with get_cpu_temp_sysctl()
# which queries the kernel, instead of IPMI. This is faster, more
# accurate and more compatible, hopefully allowing this to work on X9
# systems. The original function is still present and is now called
# get_cpu_temp_ipmi().
# Because this is a much faster method of reading the temps, and
# because its actually the max core temp, I found that the previous
# cpu_hd_override_temp of 60 was too sensitive and caused the override
# too often. I've bumped it up to 62, which on my system seems good.
# This means that if a core gets to 62C the HD fans will kick in, and
# this will generally bring temps back down to around 60C... depending
# on the actual load. Your results will vary, and for best results you
# should tune controller with mprime testing at various thread levels.
# Updated the cpu threasholds to 35/45/55 because of the improved
# responsiveness of the get_cpu_temp function
#
# The following changes are by Kevin Horton
# 2017-01-14 Reworked get_hd_list() to exclude SSDs
# Added function to calculate maximum and average HD temperatures.
# Replaced original HD fan control scheme with a PID controller,
# controlling the average HD temp..
# Added safety override if any HD reaches a specified max temperature.
# If so, the PID loop is overridden, and HD fans are set to 100%
# Retain float value of fan duty cycle between loop cycles, so that
# small duty cycle corrections accumulate and eventually push the duty
# cycle to the next integer value.
# 2017-01-18 Added log file
# 2017-01-21 Refactored code to bump up CPU fan to help cool HD. Drop the
# variabe CPU duty cycle, and just set to High,
# Added log file option without temps for every HD.
# 2017-01-29 Add header to log file every X hours
#
# 2018-08-24 v1.0 Version optimized for 1500 rpm Noctua NF-F12 fans
#
# 2018-08-25 Revised gains and thresholds for 3000 rpm Noctua NF-F12 iPPC fans
# Added 10s pause before checking fan speed, to allow time for fans to
# respond to latest gain change
#
# 2018-09-17 Revised HD temp average to only look at warmest X disks.
#
# 2018-09-27 Use config file to determine number of warmest disks to average,
# PID gains and target average temperature.
# The config file may be revised while the script is running, and the
# updated values will be read into the script each time around the
# control loop.
#
# 2020-01-01 Merged options for selectable number of disks to average and
# certain settings in config file to Master branch
#
# 2020-06-05 general cleanup (Rob Urban, 5-JUN-2020)
# - fixed several small bugs
# corrected reference to "bail_with_full_fans()"
# - removed newlines ("\n") from calls to dprint() and added one to function definition
# - explicitly declared variables as global or local
# - added "use strict;" to turn on strict syntax checking
# - got rid of all external pipelines and converted the output-processing of external commands
# to pure Perl. This has several advantages:
# - fewer forks. only essential external programs are executed
# - consistency: all the text processing is done in Perl
# - simpler to read and understand
# To simplify calling external programs, run_command() was added, which
# must be passed the external program name and arguments as separate tokens
# and returns an array consisting of stdout split into lines.
#
# TO DO
# Do not change fan speed due to calculated Tave changes when switching
# config scripts
##############################################################################
## CONFIGURATION
################
#---------------------------------------------------------------------------
##CONFIG FILE
## Read following config file at start and every X minutes to determine
## number of warmest disks to average, target average temperature and PID gains.
## If file is not available, or corrupt, use defaults specified in this script.
#---------------------------------------------------------------------------
my $config_file = '/root/PID_fan_control_config.ini';
#---------------------------------------------------------------------------
# the "script mode": what motherboard(-class) is being driven. Possible values:
# - "supermicro" (SuperMicro X10SRH-cF, some other models too)
# - "asrock" (ASRock Rack X470D4U2-2T)
# - "ocl" (OpenCorsairLink Fan controller)
#---------------------------------------------------------------------------
my $script_mode = 'ocl';
#---------------------------------------------------------------------------
# ASRock mapping -- TODO: put in a config file
#---------------------------------------------------------------------------
my @asrock_zones = (
{ FAN1 => 0 }, # CPU
{ FAN2 => 1, FAN3 => 2, FAN4 => 3, FAN5 => 4, FAN6 => 5 }, # HD
);
#---------------------------------------------------------------------------
# current values for duty cycle values for ASRock fans 1 - 6
#---------------------------------------------------------------------------
my @asrock_current_fan_duty_cycle_values;
#---------------------------------------------------------------------------
# OCL mapping -- TODO: put in a config file
#---------------------------------------------------------------------------
my @ocl_zones = (
{ 'Fan 0' => 0 }, # CPU
{ 'Fan 1'=> 1, 'Fan 2' => 2,}, # HD
);
my @ocl_sensors = ("Temperature 0", "Temperature 1", "Temperature 2", "Temperature 3");
#---------------------------------------------------------------------------
# current values for duty cycle values for OCL fans 0 - 5 and speeds from output
#---------------------------------------------------------------------------
my @ocl_current_fan_duty_cycle_values;
my @ocl_current_fan_speeds;
#---------------------------------------------------------------------------
# Optionally log fan speeds and/or disk temps to influxdb
# also for OpenCorsairLink, log onboard temperature sensor readings as specified in that section
#create the db with: curl -XPOST 'http://influxdb.host:8086/query' --data-urlencode 'q=CREATE DATABASE "freenas"'
#---------------------------------------------------------------------------
my $use_influx = 1;
my $influx_fan_speed = 1;
my $influx_fan_duty = 1;
my $influx_disks = 1;
my $influx_sensors = 1;
my $influx_average = 1;
my $influxdb_db="freenas";
my $influxdb_host="192.168.1.1";
my $influxdb_port="8086";
my $influxdb_protocol="http";
my $influxdb_hostname="fantest";
my $influxdb_url="$influxdb_protocol://$influxdb_host:$influxdb_port/write?db=$influxdb_db";
##DEFAULT VALUES
## Use the values declared below if the config file is not present
#---------------------------------------------------------------------------
## PID CONTROL GAINS
## If you were using the spinpid.sh PID control script published by
## @Glorious1 at the link below, you will need to adjust the value of $Kp
## that you were using, as that script defined Kp in terms of the gain per
## one cycle around the loop, but this script defines it in terms of the
## gain per minute. Divide the Kp value from the spinpid.sh script by the
## time in minutes for checking hard drive temperatures.
## For example, if you used a gain of Kp = 8, and a T = 3 (3 minute interval),
## the new value is $Kp = 8/3.
## Kd values from the spinpid.sh script can be used directly here.
## https://forums.freenas.org/index.php?threads/script-to-control-fan-speed-in-response-to-hard-drive-temperatures.41294/page-4#post-285668
#---------------------------------------------------------------------------
# PID control loop will target this average temperature for the warmest N disks
#---------------------------------------------------------------------------
my $hd_ave_target = 38;
my $Kp = 16 / 3; # PID control loop proportional gain
my $Ki = 0; # PID control loop integral gain
my $Kd = 24; # PID control loop derivative gain
my $hd_num_peak = 4; # Number of warmest HDs to use when calculating average temp
my $hd_fan_duty_start = 60; # HD fan duty cycle when script starts
#---------------------------------------------------------------------------
## DEBUG LEVEL
## 0 means no debugging. 1,2,3,4 provide more verbosity
## You should run this script in at least level 1 to verify its working
## correctly on your system
#---------------------------------------------------------------------------
my $debug = 4;
my $debug_log = '/root/Debug_PID_fan_control.log';
## LOG
#my $log = '/root/PID_fan_control.log';
my $log = '/var/log/PID_fan_control.log';
#---------------------------------------------------------------------------
# 1 if not logging individual HD temperatures. 0 if logging temp of each HD
#---------------------------------------------------------------------------
my $log_temp_summary_only = 0;
#---------------------------------------------------------------------------
# number of hours between log headers. Valid options are 1, 2, 3, 4, 6 & 12.
# log headers will always appear at the start of a log, at midnight and any
# time the list of HDs changes (if individual HD temperatures are logged)
#---------------------------------------------------------------------------
my $log_header_hourly_interval = 2;
#---------------------------------------------------------------------------
## CPU THRESHOLD TEMPS
## A modern CPU can heat up from 35C to 60C in a second or two. The fan
## duty cycle is set based on this
#---------------------------------------------------------------------------
my $high_cpu_temp = 55; # will go HIGH when we hit
my $med_cpu_temp = 45; # will go MEDIUM when we hit, or drop below again
my $low_cpu_temp = 35; # will go LOW when we fall below 35 again
#---------------------------------------------------------------------------
## HD THRESHOLD TEMPS
## HD change temperature slowly.
## This is the temperature that we regard as being uncomfortable. The higher
## this is the more silent your system.
## Note, it is possible for your HDs to go above this... but if your cooling
## is good, they shouldn't.
# PID control aborts and fans set to 100% duty cycle when a HD hits
# this temp. This ensures that no matter how poorly chosen the PID gains are,
# or how much of a spread there is between the average HD temperature and the
# maximum HD temperature, the HD fans will be set to 100% if any drive
# reaches this temperature. Unit is Celcius
#---------------------------------------------------------------------------
my $hd_max_allowed_temp = 40;
#---------------------------------------------------------------------------
## CPU TEMP TO OVERRIDE HD FANS
## when the CPU climbs above this temperature, the HD fans will be overridden
## this prevents the HD fans from spinning up when the CPU fans are capable
# of providing sufficient cooling.
#---------------------------------------------------------------------------
my $cpu_hd_override_temp = 65;
#---------------------------------------------------------------------------
## CPU/HD SHARED COOLING
## If your HD fans contribute to the cooling of your CPU you should set this
## value. It will mean when you CPU heats up your HD fans will be turned up to
## help cool the case/cpu. This would only not apply if your HDs and fans are
## in a separate thermal compartment.
#---------------------------------------------------------------------------
#---------------------------------------------------------------------------
# 1 if the hd fans should spin up to cool the cpu, 0 otherwise
#---------------------------------------------------------------------------
my $hd_fans_cool_cpu = 1;
#---------------------------------------------------------------------------
## HD FAN DUTY CYCLE TO OVERRIDE CPU FANS
#---------------------------------------------------------------------------
#---------------------------------------------------------------------------
# 1 if the CPU fans should spin up to cool the HDs, when needed.
# 0 otherwise. This may be useful if the CPU fan zone also contains chassis
# exit fans, as an increase in chassis exit fan speed may increase the HD
# cooling air flow.
#---------------------------------------------------------------------------
my $cpu_fans_cool_hd = 0;
#---------------------------------------------------------------------------
# when the HD duty cycle equals or exceeds this value, the CPU fans may be
# overridden to help cool HDs
#---------------------------------------------------------------------------
my $hd_cpu_override_duty_cycle = 95;
#---------------------------------------------------------------------------
## CPU TEMP CONTROL
#---------------------------------------------------------------------------
#---------------------------------------------------------------------------
# 1 if the script will control a CPU fan to control CPU temperatures.
# 0 if the script only controls HD fans.
#---------------------------------------------------------------------------
my $cpu_temp_control = 1;
#######################
## FAN CONFIGURATION
####################
#---------------------------------------------------------------------------
## FAN SPEEDS
## You need to determine the actual max fan speeds that are achieved by the fans
## Connected to the cpu_fan_header and the hd_fan_header.
## These values are used to verify high/low fan speeds and trigger a BMC reset
## if necessary.
#---------------------------------------------------------------------------
my $cpu_max_fan_speed = 2200;
my $hd_max_fan_speed = 1500;
#---------------------------------------------------------------------------
## CPU FAN DUTY LEVELS
## These levels are used to control the CPU fans
#---------------------------------------------------------------------------
my $fan_duty_high = 100; # percentage on, ie 100% is full speed.
my $fan_duty_med = 80;
my $fan_duty_low = 55;
#---------------------------------------------------------------------------
## HD FAN DUTY LEVELS
## These levels are used to control the HD fans
#---------------------------------------------------------------------------
my $hd_fan_duty_high = 100; # percentage on, ie 100% is full speed.
my $hd_fan_duty_med_high = 80;
my $hd_fan_duty_med_low = 50;
my $hd_fan_duty_low = 30; # some 120mm fans stall below 30.
#---------------------------------------------------------------------------
# HD fan duty cycle when script starts - defined in config file
#---------------------------------------------------------------------------
#$hd_fan_duty_start = 60;
#---------------------------------------------------------------------------
## FAN ZONES
## Your CPU/case fans should probably be connected to the main fan sockets,
## which are in fan zone zero
## Your HD fans should be connected to FANA which is in Zone 1
## You could switch the CPU/HD fans around, as long as you change the zones
## and fan header configurations.
##
## 0 = FAN1..5
## 1 = FANA..FANC
#---------------------------------------------------------------------------
my $cpu_fan_zone = 0;
my $hd_fan_zone = 1;
#---------------------------------------------------------------------------
## FAN HEADERS
## these are the fan headers which are used to verify the fan zone is high.
## FAN1+ are all in Zone 0, FANA is Zone 1.
## cpu_fan_header should be in the cpu_fan_zone
## hd_fan_header should be in the hd_fan_zone
#---------------------------------------------------------------------------
my $cpu_fan_header = "Fan 2"; # used for printing to standard output for debugging
my $hd_fan_header = "Fan 0"; # used for printing to standard output for debugging
my @hd_fan_list = ("Fan 0", "Fan 1"); # used for logging to file
################
## MISC
#######
#---------------------------------------------------------------------------
## IPMITOOL PATH
## The script needs to know where ipmitool is
#---------------------------------------------------------------------------
my $ipmitool = '/usr/local/bin/ipmitool';
# smartctl path
my $smartctlCmd = '/usr/local/sbin/smartctl';
# opencorsairlink path
my $opencorsairlink = "/root/OpenCorsairLink.elf.new";
#---------------------------------------------------------------------------
## HD POLLING INTERVAL
## The controller will only poll the harddrives periodically. Since hard
## drives change temperature slowly this is a good thing. 180 seconds is a
## good value.
#---------------------------------------------------------------------------
my $hd_polling_interval = 90; # seconds
#---------------------------------------------------------------------------
## FAN SPEED CHANGE DELAY TIME
## It takes the fans a few seconds to change speeds, we allow a grace before
## verifying. If we fail the verify we'll reset the BMC
#---------------------------------------------------------------------------
my $fan_speed_change_delay = 10; # seconds
#---------------------------------------------------------------------------
## BMC REBOOT TIME
## It takes the BMC a number of seconds to reset and start providing sensible
## output. We'll only Reset the BMC if its still providing rubbish after this
## time.
#---------------------------------------------------------------------------
my $bmc_reboot_grace_time = 120; # seconds
#---------------------------------------------------------------------------
## BMC RETRIES BEFORE REBOOTING
## We verify high/low of fans, and if they're not where they should be we
## reboot the BMC after so many failures
#---------------------------------------------------------------------------
my $bmc_fail_threshold = 1; # will retry n times before rebooting
# edit nothing below this line
########################################################################################################################
# GLOBALS
my @hd_list;
my ($P, $I, $D);
my ($cpu_fan_override, $hd_ave_temp_old);
# massage fan speeds
$cpu_max_fan_speed *= 0.8;
$hd_max_fan_speed *= 0.8;
my $hd_duty = $hd_fan_duty_start;
# fan/bmc verification globals/timers
my $last_fan_level_change_time = 0; # the time when we changed a fan level last
#---------------------------------------------------------------------------
# the time when a fan read failure started, 0 if there is none.
#---------------------------------------------------------------------------
my $fan_unreadable_time = 0;
#---------------------------------------------------------------------------
# how many times the fans failed verification in the last period.
#---------------------------------------------------------------------------
my $bmc_fail_count = 0;
# this is the last cpu temp that was read
my $last_cpu_temp = 0;
use POSIX qw(strftime);
use Time::Local;
#use IPC::Run qw(run timeout);
$SIG{INT} = sub {
print "\nCaught SIGINT: setting fan mode to optimal\n";
set_fan_mode("optimal");
exit(0);
};
$SIG{TERM} = sub {
print "\nCaught SIGTERM: setting fan mode to optimal\n";
set_fan_mode("optimal");
exit(0);
};
$SIG{HUP} = sub {
print "\nCaught SIGHUP: setting fan mode to optimal\n";
set_fan_mode("optimal");
exit(0);
};
# start the controller
main();
################################################ MAIN
sub main {
open LOG, ">>", $log or die $!;
open DEBUG_LOG, ">>", $debug_log or die $!;
my ($next_log_hour, $next_log_time, $hd_fan_duty, $hd_min_temp, $hd_max_temp, @hd_temps);
my ($config_time, $config_time_new, @last_hd_list, $hd_ave_temp, $hd_fan_duty_old);
my ($hd_fan_mode, $ave_fan_speed, $cput);
@asrock_current_fan_duty_cycle_values = ($hd_fan_duty_start) x 6;
( $hd_ave_target, $Kp, $Ki, $Kd, $hd_num_peak, $hd_fan_duty_start ) = read_config();
# Print Log Header
@hd_list = get_hd_list();
print_log_header(@hd_list);
# current time
#( $sec, $min, $hour, $day, $month, $year, $wday, $yday, $isdst ) = localtime(time);
my ($hour, $day, $month, $year) = (localtime(time))[2..5];
$next_log_hour = ( int( $hour / $log_header_hourly_interval ) + 1 ) *
$log_header_hourly_interval;
if ( $next_log_hour >= 24 ) {
#-----------------------------------------------------------------
# next log time is after midnight. Roll back to previous log time,
# calcuate Unix epoch seconds, and add required seconds to get next
# log time
#-----------------------------------------------------------------
$next_log_hour -= $log_header_hourly_interval;
$next_log_time = timelocal( 0, 0, $next_log_hour, $day, $month, $year ) +
3600 * $log_header_hourly_interval;
}
else {
# next log time in seconds past Unix epoch
$next_log_time = timelocal( 0, 0, $next_log_hour, $day, $month, $year );
}
#-----------------------------------------------------------------
# need to go to Full mode so we have unfettered control of Fans
# this is only required for SuperMicro boards.
#-----------------------------------------------------------------
($script_mode eq 'supermicro') && set_fan_mode("full");
my $cpu_fan_level = "";
my $old_cpu_fan_level = "";
my $override_hd_fan_level = 0;
my $last_hd_check_time = 0;
# reference to $temp_error here looks like a bug...
#$temp_error = 0;
my $integral = 0;
$cpu_fan_override = 0;
$hd_fan_duty = $hd_fan_duty_start;
($hd_min_temp, $hd_max_temp, $hd_ave_temp_old, @hd_temps) = get_hd_temps();
($hd_ave_target, $Kp, $Ki, $Kd, $hd_num_peak, $hd_fan_duty_start, $config_time) = read_config();
while () {
if ($cpu_temp_control) {
$old_cpu_fan_level = $cpu_fan_level;
$cpu_fan_level = control_cpu_fan($old_cpu_fan_level);
if ( $old_cpu_fan_level ne $cpu_fan_level ) {
$last_fan_level_change_time = time;
}
if ( $cpu_fan_level eq "high" ) {
if (
$hd_fans_cool_cpu
&& !$override_hd_fan_level
&& ( $last_cpu_temp >= $cpu_hd_override_temp
|| $last_cpu_temp == 0 )
)
{
#-------------------------------------------------------
# override hd fan zone level, once we override we won't
# backoff until the cpu drops to below "high"
#-------------------------------------------------------
$override_hd_fan_level = 1;
dprint( 0, "CPU Temp: $last_cpu_temp >= $cpu_hd_override_temp, Overiding HD fan zone to $hd_fan_duty_high%");
set_fan_zone_duty_cycle( $hd_fan_zone, $hd_fan_duty_high );
$last_fan_level_change_time = time;
}
}
elsif ($override_hd_fan_level) {
# restore hd fan zone level;
$override_hd_fan_level = 0;
dprint( 0, "Restoring HD fan zone to $hd_fan_duty%" );
set_fan_zone_duty_cycle( $hd_fan_zone, $hd_fan_duty );
$last_fan_level_change_time = time;
}
}
# periodically determine hd fan zone level
my $check_time = time;
if ( $check_time - $last_hd_check_time >= $hd_polling_interval ) {
$last_hd_check_time = $check_time;
@last_hd_list = @hd_list;
#--------------------------------------------------------------
# check to see if config file has been updated. If so, update
# the config values and print a new log header
#--------------------------------------------------------------
$config_time_new = ( stat($config_file) )[9];
if ( $config_time_new > $config_time ) {
(
$hd_ave_target, $Kp, $Ki, $Kd, $hd_num_peak,
$hd_fan_duty_start, $config_time
) = read_config();
print_log_header(@hd_list);
}
#--------------------------------------------------------------
# we refresh the hd_list from camcontrol devlist
# everytime because if you're adding/removing HDs we want
# starting checking their temps too!
#--------------------------------------------------------------
@hd_list = get_hd_list();
( $hd_min_temp, $hd_max_temp, $hd_ave_temp, @hd_temps ) = get_hd_temps();
$hd_fan_duty_old = $hd_fan_duty;
$hd_fan_duty = calculate_hd_fan_duty_cycle_PID($hd_max_temp, $hd_ave_temp, $hd_fan_duty);
if ( !$override_hd_fan_level ) {
set_fan_zone_duty_cycle( $hd_fan_zone, $hd_fan_duty );
#--------------------------------------------------------------
# this resets every time, but it shouldn't matter since
# hd_polling_interval is large.
#--------------------------------------------------------------
$last_fan_level_change_time = time;
}
# print to log
if ( @hd_list != @last_hd_list && $log_temp_summary_only == 0 ) {
#--------------------------------------------------------------
# print new disk iD header if it has changed (e.g. hot swap
# insert or remove)
#--------------------------------------------------------------
@hd_list = print_log_header(@hd_list);
}
elsif ( $check_time >= $next_log_time ) {
# time to print a new log header
@hd_list = print_log_header(@hd_list);
$next_log_time += 3600 * $log_header_hourly_interval;
}
my $timestring = build_time_string();
# ($hd_min_temp, $hd_max_temp, $hd_ave_temp, @hd_temps) = get_hd_temps();
print LOG "$timestring";
if ($log_temp_summary_only) {
#--------------------------------------------------------------
# number of HDs, so it can be seen if a hot swap addition or
# removal was detected
#--------------------------------------------------------------
printf( LOG " %2i", 0 + @hd_list );
printf( LOG " %2i", $hd_min_temp );
}
else {
foreach my $item (@hd_temps) {
printf( LOG "%5s", $item );
}
}
printf( LOG " ^%2i", $hd_max_temp );
printf( LOG "%7.2f", $hd_ave_temp );
printf( LOG "%6.2f", $hd_ave_temp - $hd_ave_target );
$hd_fan_mode = get_fan_mode();
printf( LOG "%6s", $hd_fan_mode );
sleep 10; # pause 10s to allow fans to change speed after setting it
$ave_fan_speed = get_fan_ave_speed(@hd_fan_list);
printf( LOG "%6s", $ave_fan_speed );
printf( LOG "%4i/%-3i", $hd_fan_duty_old, $hd_fan_duty );
$cput = get_cpu_temp_sysctl();
printf( LOG "%4i %6.2f %6.2f %6.2f %6.2f%%\n",
$cput, $P, $I, $D, $hd_duty );
}
# verify_fan_speed_levels function is fairly complicated
if ($cpu_temp_control) {
verify_fan_speed_levels( $cpu_fan_level,
$override_hd_fan_level ? $hd_fan_duty_high : $hd_fan_duty );
}
else {
verify_fan_speed_levels2($hd_fan_duty);
}
# if ($cpu_temp_control) {
# # CPU temps can go from cool to hot in 2 seconds! so we only ever
# # sleep for 1 second.
# sleep 1;
# }
# else {
# sleep $hd_polling_interval - 1;
# }
# CPU temps can go from cool to hot in 2 seconds! so we only ever
# sleep for 1 second.
sleep 1;
} # inf loop
}
################################################# SUBS
#-----------------------------------------------------------------------
# run_command()
# execute an external program and collect stdout and stderr. Upon successful
# completion, stdout is split into lines which are returned as a list.
# Input is a list containing the individual tokens of the command, i.e.,
# ('program', 'arg1', 'arg2', 'arg3')
# On failure logs stderr using dprint() and dies.
#-----------------------------------------------------------------------
#sub run_command {
# my @cmd = @_;
# my ($out, $err);
# dprint(3, 'run_command: '.join(' ', @cmd));
# if (!run \@cmd, \undef, \$out, \$err) {
# chomp($err);
# dprint(0, "command [@cmd] failed: $err");
# die "command [@cmd] failed: $err";
# }
# chomp($out);
# dprint(2, $out);
# return split(/\n/, $out);
#}
sub run_command {
my @cmd = @_;
my ($out, $err);
dprint(3, 'run_command: '.join(' ', @cmd));
my $command = join(' ', @cmd);
$out = `$command`;
print $out;
# if (!run \@cmd, \undef, \$out, \$err) {
# chomp($err);
# dprint(0, "command [@cmd] failed: $err");
# die "command [@cmd] failed: $err";
# }
chomp($out);
dprint(2, $out);
return split(/\n/, $out);
}
#-----------------------------------------------------------------------
# asrock_set_zone_values()
# given a duty cycle % value and a zone returns a series of values to be added to the
# end of the ipmitool raw command to set the duty-cycle for the fans belonging to the zone
# side effect: changes global variable "$asrock_current_fan_duty_cycle_values"
#-----------------------------------------------------------------------
sub asrock_set_zone_values
{
my ($zone, $duty_cycle) = @_;
foreach my $fan (keys(%{ $asrock_zones[$zone] })) {
$asrock_current_fan_duty_cycle_values[ $asrock_zones[$zone]->{$fan} ] = $duty_cycle;
}
}
sub asrock_build_set_command {
#return ($ipmitool, 'raw', '0x3a', '0x01', @asrock_current_fan_duty_cycle_values, '0x0', '0x0');
return ($ipmitool, 'raw', '0x3a', '0x01', (map { sprintf("0x%2x", $_) } @asrock_current_fan_duty_cycle_values), '0x0', '0x0');
}
sub ocl_set_zone_values
{
my ( $zone, $duty) = @_;
my $pattern;
my @lines;
my @temp;
my @speed;
my @result;
my @command;
foreach my $fan (values(%{ $ocl_zones[$zone] })) {
@command = ($opencorsairlink, '--device 0', "--fan channel=$fan,mode=0,pwm=$duty");
@result = run_command(@command);
}
foreach my $fan (keys(%{ $ocl_zones[$zone] })) {
$ocl_current_fan_duty_cycle_values[ $ocl_zones[$zone]->{$fan} ] = $duty;
if ($use_influx == 1 && $influx_fan_duty == 1) { log_to_influx("FanDuty", $fan, $duty) ; }
}
@command = ($opencorsairlink, '--device 0');
@result = run_command(@command);
foreach my $fan (keys(%{ $ocl_zones[$zone] })) {
$pattern = qr/($fan.*)\n(.PWM.*)\n(.RPM.*)/;
@lines = join("\n", @result) =~ m/$pattern/g;
@speed = split(/ /, @lines[2]);
$ocl_current_fan_speeds[ $ocl_zones[$zone]->{$fan} ] = $speed[1];
#if ($use_influx == 1 && $influx_fan_speed == 1) { log_to_influx("FanSpeed", $fan, $speed[1]) ;}
}
if ($use_influx == 1 && $influx_sensors == 1) {
foreach my $sensor (@ocl_sensors) {
$pattern = qr/($sensor.*)\n/;
@lines = join("\n", @result) =~ m/$pattern/g;
@temp = split / /, @lines[0];
log_to_influx("SensorTemp", $sensor, $temp[2]) ;
}
}
}
sub log_to_influx
{
# $type should be SensorTemp, FanSpeed, FanDuty or DiskTemp, $name should identify the item (da0, Fan 1, Temp...)
my ( $type, $name, $value) = @_;
(my $name_nospaces = $name) =~ s/\s//g;
my $data = "$type,component=$influxdb_hostname$name_nospaces value=$value";
my @command = ('curl', '-i', "-XPOST $influxdb_url -d \"$data\"");
my @output = run_command(@command);
}
sub get_hd_list {
my @cmd = ('camcontrol', 'devlist');
my @vals;
foreach (run_command(@cmd)) {
next if (/SSD|Verbatim|Kingston|Elements|Enclosure|Virtual|KINGSTON/);
if (/\((?:pass\d+,(a?da\d+)|(a?da\d+),pass\d+)\)/) {
dprint(2, $1);
push(@vals, $1);
}
}
dprint(3, "@vals");
return @vals;
}
sub get_one_hd_temp
{
my $disk_dev = shift;
my @command = ($smartctlCmd, '-A', "/dev/$disk_dev");
my $temp;
foreach (run_command(@command)) {
chomp;
dprint(2, $_);
if (/Temperature_Celsius/) { $temp = (split)[9]; }
}
if ($use_influx == 1 && $influx_disks == 1) { log_to_influx("DiskTemp", $disk_dev, $temp);}
return $temp;
}
sub get_hd_temp {
my $max_temp = 0;
foreach my $item (@hd_list) {
my $disk_dev = "/dev/$item";
my @command = ($smartctlCmd, '-A', $disk_dev);
my $temp;
foreach (run_command(@command)) {
chomp;
dprint(2, $_);
# temperature is 10th token
if (/Temperature_Celsius/) {
$temp = (split)[9];
if ($use_influx == 1 && $influx_disks == 1) { log_to_influx("DiskTemp", $item, $temp);}
}
}
if ($temp) {
dprint( 1, "$disk_dev: $temp" );
$max_temp = $temp if $temp > $max_temp;
}
}
dprint( 0, "Maximum HD Temperature: $max_temp" );
return $max_temp;
}
# return minimum, maximum, average HD temperatures and array of individual temps
sub get_hd_temps
{
my $max_temp = 0;
my $min_temp = 1000;
my $temp_sum = 0;
my $HD_count = 0;
my @temp_list = ();
foreach my $item (@hd_list) {
my $temp = get_one_hd_temp($item);
if ($temp) {
push( @temp_list, $temp );
$temp_sum += $temp;
$HD_count += 1;
$max_temp = $temp if $temp > $max_temp;
$min_temp = $temp if $temp < $min_temp;
}
}
my @temps_sorted = sort { $a <=> $b } @temp_list;
$temp_sum = 0;
for ( my $n = $hd_num_peak ; $n > 0 ; $n = $n - 1 ) {
$temp_sum += pop(@temps_sorted);
}
my $ave_temp = $temp_sum / $hd_num_peak;
if ($use_influx == 1 && $influx_average == 1) {
log_to_influx("DiskTemp", "avg", $ave_temp);
log_to_influx("DiskTemp", "count", $HD_count);
}
return ( $min_temp, $max_temp, $ave_temp, @temp_list );
}
sub verify_fan_speed_levels {
my ( $cpu_fan_level, $hd_fan_duty ) = @_;
dprint( 4, "verify_fan_speed_levels: cpu_fan_level: $cpu_fan_level, hd_fan_duty: $hd_fan_duty" );
my $extra_delay_before_next_check = 0;
my $temp_time = time - $last_fan_level_change_time;
dprint( 4, "Time since last verify : $temp_time, last change: $last_fan_level_change_time, delay: $fan_speed_change_delay" );
if ( $temp_time > $fan_speed_change_delay ) {
# we've waited for the speed change to take effect.
my $cpu_fan_speed = get_fan_speed("CPU");
if ( $cpu_fan_speed < 0 ) {
dprint( 1, "CPU Fan speed unavailable" );
$fan_unreadable_time = time if $fan_unreadable_time == 0;
}
my $hd_fan_speed = get_fan_speed("HD");
if ( $hd_fan_speed < 0 ) {
dprint( 1, "HD Fan speed unavailable" );
$fan_unreadable_time = time if $fan_unreadable_time == 0;
}
if ( $hd_fan_speed < 0 || $cpu_fan_speed < 0 ) {
# one of the fans couldn't be reliably read
my $temp_time = time - $fan_unreadable_time;
if ( $temp_time > $bmc_reboot_grace_time ) {