File: btrymeter.cc

package info (click to toggle)
xosview 1.24-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,184 kB
  • sloc: cpp: 11,975; makefile: 154; ansic: 32; awk: 13; sh: 8
file content (696 lines) | stat: -rw-r--r-- 17,970 bytes parent folder | download | duplicates (2)
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
//
//  Copyright (c) 1997, 2006 by Mike Romberg ( mike.romberg@noaa.gov )
//
//  This file may be distributed under terms of the GPL
//

#include "btrymeter.h"
#include <stdlib.h>
#include <stdio.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <unistd.h>
#include <fcntl.h>
#include <dirent.h>
#include <string.h>
#include <errno.h>
#include <fstream>
#include <string>
#include <iostream>
#include <sstream>
#include "stringutils.h"

static const char APMFILENAME[] = "/proc/apm";
static const char ACPIBATTERYDIR[] = "/proc/acpi/battery";
static const char SYSPOWERDIR[] = "/sys/class/power_supply";


BtryMeter::BtryMeter( XOSView *parent )
  : FieldMeter( parent, 2, "BTRY", "CHRG/USED", 1, 1, 0 ){

  // find out ONCE whether to use ACPI, APM or sysfs
  use_acpi = use_apm = use_syspower = false;
  if ( has_apm() ) {
      use_apm=true; use_acpi=false; use_syspower=false;
  }
  if ( has_acpi() ) {
      use_acpi=true; use_apm=false; use_syspower=false;
  }
  if ( has_syspower() ) {
      use_acpi=false; use_apm=false; use_syspower=true;
  }

  old_apm_battery_state = apm_battery_state = 0xFF;
  old_acpi_charge_state = acpi_charge_state = -2;

}

BtryMeter::~BtryMeter( void ){
}

// determine if any usable source of battery information
bool BtryMeter::has_source( void ){
  return has_apm() || has_acpi() || has_syspower();
}

// determine if /proc/apm exists and is readable
bool BtryMeter::has_apm( void ){

  struct stat stbuf;
  int fd;

  if ( stat(APMFILENAME, &stbuf) != 0 ) {
     XOSDEBUG("APM: stat failed: %d - not APM ?\n",errno);
     return false;
  }
  if ( S_ISREG(stbuf.st_mode) ) {
     XOSDEBUG("apm: %s exists and is a file\n",APMFILENAME);
  } else {
     XOSDEBUG("no APM file\n");
     return false;
  }
  fd=open(APMFILENAME,O_RDONLY);
  if ( fd < 0 ) {
     XOSDEBUG("open failed on %s: with errno=%d\n",APMFILENAME,errno);
     return false;
  } else
     close(fd); // good enough ...

  // all our tests succeeded - apm seems usable
  return true;

}

// determine if /proc/acpi/battery exists and is a DIR
// (XXX: too lazy -  no tests for actual readability is done)
bool BtryMeter::has_acpi( void ){

  struct stat stbuf;

  if ( stat(ACPIBATTERYDIR, &stbuf) != 0 ) {
     XOSDEBUG("has_acpi(): stat failed: %d\n",errno);
     return false;
  }
  if ( S_ISDIR(stbuf.st_mode) ) {
     XOSDEBUG("%s exists and is a DIR.\n", ACPIBATTERYDIR);
  } else {
     XOSDEBUG("no ACPI dir\n");
     return false;
  }

  // declare ACPI as usable
  return true;

}

/*
 * Look for something resembling a battery in /sys/class/power_supply
 */

bool BtryMeter::has_syspower( void ){
  bool found;
  DIR *dir;
  struct dirent *dp;
  struct stat buf;
  char dirname[80], f[80];
  std::ifstream type;
  std::string t;

  dir = opendir(SYSPOWERDIR);
  if (dir == NULL)
      return false;

  found = false;
  while (!found && (dp = readdir(dir))) {
    if (!strncmp(dp->d_name, ".", 1))
      continue;
    if (!strncmp(dp->d_name, "..", 2))
      continue;
    snprintf_or_abort(dirname, 80, "%s/%s", SYSPOWERDIR, dp->d_name);
    if (stat(dirname, &buf) == 0 && S_ISDIR(buf.st_mode)) {
      snprintf_or_abort(f, 80, "%s%s", dirname, "/type");
      type.open(f);
      if (type.good()) {
        type >> t;
        if (strncmp(t.c_str(), "Battery", 7) == 0) {
          found = true;
          break;
        }
      }
      type.close();
    }
  }
  if (closedir(dir) != 0)
      abort();

  return found;
}

void BtryMeter::checkResources( void ){
  FieldMeter::checkResources();

  setfieldcolor( 0, parent_->getResource( "batteryLeftColor" ) );
  setfieldcolor( 1, parent_->getResource( "batteryUsedColor" ) );

  priority_ = atoi (parent_->getResource( "batteryPriority" ) );
  SetUsedFormat(parent_->getResource( "batteryUsedFormat" ) );
}

void BtryMeter::handle_apm_state( void ){
  switch ( apm_battery_state ) {
  case 0: /* high (e.g. over 25% on my box) */
    XOSDEBUG("battery_status HIGH\n");
    setfieldcolor( 0, parent_->getResource("batteryLeftColor"));
    legend("High AVAIL/USED");
    break;

  case 1: /* low  ( e.g. under 25% on my box ) */
    XOSDEBUG("battery_status LOW\n");
    setfieldcolor( 0, parent_->getResource("batteryLowColor"));
    legend("LOW avail/used");
    break;

  case 2: /* critical ( less than  5% on my box ) */
    XOSDEBUG("battery_status CRITICAL\n");
    setfieldcolor( 0, parent_->getResource("batteryCritColor"));
    legend( "Crit LOW/Used");
    break;

  case 3: /* Charging */
    XOSDEBUG("battery_status CHARGING\n");
    setfieldcolor( 0, parent_->getResource("batteryChargeColor"));
    legend( "AC/Charging");
    break;

  case 4: /* selected batt not present */
    /* no idea how this state ever could happen with APM */
    XOSDEBUG("battery_status not present\n");
    setfieldcolor( 0, parent_->getResource("batteryNoneColor"));
    legend( "Not Present/N.A.");
    break;

  case 255: /* unknown - do nothing - maybe not APM */
    // on my system this state comes if you pull both batteries
    // ( while on AC of course :-)) )
    XOSDEBUG("apm battery_state not known\n");
    setfieldcolor( 0, parent_->getResource("batteryNoneColor"));
    legend( "Unknown/N.A.");
    break;
  }
}

void BtryMeter::handle_acpi_state( void ){
  switch ( acpi_charge_state ) {
  case 0:  // charged
    XOSDEBUG("battery_status CHARGED\n");
    setfieldcolor( 0, parent_->getResource("batteryFullColor"));
    legend( "CHRG/FULL");
    break;

  case -1: // discharging
    XOSDEBUG("battery_status DISCHARGING\n");
    setfieldcolor( 0, parent_->getResource("batteryLeftColor"));
    legend( "CHRG/USED");
    break;

  case -2: // discharging - below alarm
    XOSDEBUG("battery_status ALARM DISCHARGING\n");
    setfieldcolor( 0, parent_->getResource("batteryCritColor"));
    legend( "CHRG/USED");
    break;

  case -3: // not present
    XOSDEBUG("battery_status NOT PRESENT\n");
    setfieldcolor( 0, parent_->getResource("batteryNoneColor"));
    legend( "NONE/NONE");
    break;

  case 1:  // charging
    XOSDEBUG("battery_status CHARGING\n");
    setfieldcolor( 0, parent_->getResource("batteryChargeColor"));
    legend( "CHRG/AC");
    break;
  }
}

/*
 * All redraws come from this function (not children)
 */

void BtryMeter::checkevent( void ){

  getpwrinfo();

  if ( old_apm_battery_state != apm_battery_state ) {
    /* APM only changes if we have APM */
    handle_apm_state();
    drawlegend();
    drawfields(1);
    return;
  }

  if ( old_acpi_charge_state != acpi_charge_state ) {
    handle_acpi_state();
    drawlegend();
    drawfields(1);
    return;
  }

  drawfields();
}


void BtryMeter::getpwrinfo( void ){

  if ( use_acpi || use_syspower ) {
	getacpi_or_sys_info(); return;
  }
  if ( use_apm ) {
	getapminfo(); return;
  }

  // We can hit this spot in any of two cases:
  // - We have an ACPI system and the battery is removed
  // - We have neither ACPI nor APM in the system
  // We report an empty battery (i.e., we are running off AC power) instead of
  // original behavior of just exiting the program.
  // (Refer to Debian bug report #281565)
  total_ = 100;
  fields_[0] = 0;
  fields_[1] = 100;
  setUsed(fields_[0], total_);
}


bool BtryMeter::getapminfo( void ){
  std::ifstream loadinfo( APMFILENAME );

/* just a tiny note here about APM states:
   See: arch/i386/kernel/apm.c apm_get_info()

           Arguments, with symbols from linux/apm_bios.h.  Information is
           from the Get Power Status (0x0a) call unless otherwise noted.

           0) Linux driver version (this will change if format changes)
           1) APM BIOS Version.  Usually 1.0, 1.1 or 1.2.
           2) APM flags from APM Installation Check (0x00):
              bit 0: APM_16_BIT_SUPPORT
              bit 1: APM_32_BIT_SUPPORT
              bit 2: APM_IDLE_SLOWS_CLOCK
              bit 3: APM_BIOS_DISABLED
              bit 4: APM_BIOS_DISENGAGED
           3) AC line status
              0x00: Off-line
              0x01: On-line
              0x02: On backup power (BIOS >= 1.1 only)
              0xff: Unknown
           4) Battery status
              0x00: High
              0x01: Low
              0x02: Critical
              0x03: Charging
              0x04: Selected battery not present (BIOS >= 1.2 only)
              0xff: Unknown
           5) Battery flag
              bit 0: High
              bit 1: Low
              bit 2: Critical
              bit 3: Charging
              bit 7: No system battery
              0xff: Unknown
           6) Remaining battery life (percentage of charge):
              0-100: valid
              -1: Unknown
           7) Remaining battery life (time units):
              Number of remaining minutes or seconds
              -1: Unknown
           8) min = minutes; sec = seconds
*/

  if ( !loadinfo.good() ){
    XOSDEBUG("Can not open file : %s\n", APMFILENAME);
    return false;
  }

  int battery_status=0xff; // assume unknown as default
  char buff[256];

  loadinfo >> buff >> buff >> buff >> buff >> std::hex >> battery_status >> buff >> fields_[0];


  // XOSDEBUG("apm battery_status is: %d\n",battery_status);

  // save previous state
  // if there was no state-change - the gui won't do full redraw

  old_apm_battery_state=apm_battery_state;
  apm_battery_state=battery_status;

  // If the battery status is reported as a negative number, it means we are
  // running on AC power and no battery status is available - Report it as
  // completely empty (0). (Refer to Debian bug report #281565)
  if (fields_[0] < 0)
    fields_[0] = 0;

  total_ = 100;

  if ( apm_battery_state != 0xFF ) {

	  fields_[1] = total_ - fields_[0];

  } else { // prevent setting it to '-1' if no batt

	fields_[0] = 0; fields_[1] = total_;
  }

  setUsed (fields_[0], total_);

  return true;
}

// ACPI provides a lot of info,
// but munging it into something usefull is ugly
// esp. as you can have more than one battery ...

bool BtryMeter::getacpi_or_sys_info( void ){

  DIR *dir = NULL;
  std::string abs_battery_dir;

  if (use_acpi) {
    abs_battery_dir = ACPIBATTERYDIR;
  } else {
    abs_battery_dir = SYSPOWERDIR;
  }

  dir = opendir(abs_battery_dir.c_str());
  if (dir==NULL) {
    XOSDEBUG("ACPI/SYS: Cannot open directory : %s\n", abs_battery_dir.c_str());
    return false;
  }

  bool found = false; // whether we found at least ONE battery

  // reset all sums
  acpi_sum_cap=0;
  acpi_sum_remain=0;
  acpi_sum_rate=0;
  acpi_sum_alarm=0;

  // save old state
  old_acpi_charge_state=acpi_charge_state;

  acpi_charge_state=0; // assume charged

  for (struct dirent *dirent; (dirent = readdir(dir)) != NULL; ) {
    if (strncmp(dirent->d_name, ".", 1) == 0
    	|| strncmp(dirent->d_name, "..", 2) == 0)
      continue;

    std::string abs_battery_name = abs_battery_dir + "/" + dirent->d_name;

    XOSDEBUG("ACPI/SYS Batt: %s\n", dirent->d_name);

    // still can happen that it's not present:
    if ( (use_acpi &&
          (acpi_battery_present(abs_battery_name + "/info" )) &&
          (acpi_parse_battery(abs_battery_name))) ||
         (use_syspower &&
          (sys_battery_present(abs_battery_name + "/present" )) &&
          (sys_parse_battery(abs_battery_name))) ) {

		// sum up:

		// clip values to get realistic on full-charged batteries

		if ( battery.remaining_capacity >= battery.last_full_capacity)
			battery.remaining_capacity=battery.last_full_capacity;

		acpi_sum_cap   +=battery.last_full_capacity;
		acpi_sum_remain+=battery.remaining_capacity;
		acpi_sum_rate  +=battery.present_rate;
		acpi_sum_alarm +=battery.alarm;

		// sum up charge state ...
		// works only w. signed formats
		acpi_charge_state|=battery.charging_state;

	      found = true; // found at least one
      }
    }

  closedir(dir);

  total_ = 100;

  // convert into percent vals
  // XOSDEBUG("acpi: total max=%d, remain=%d\n",acpi_sum_cap,acpi_sum_remain);

  // below alarm ?
  if ( acpi_sum_alarm >= acpi_sum_remain && acpi_charge_state != 1 )
		acpi_charge_state=-2;

  // if NONE of the batts is present:
  if ( found ) {
	  fields_[0] = (float)acpi_sum_remain/(float)acpi_sum_cap*100.0;
  } else {
	  // none of the batts is present
	  // (just pull out both while on AC)
	  fields_[0] = 0;
	  acpi_charge_state=-3;
  }

  fields_[1] = total_ - fields_[0];

  setUsed (fields_[0], total_);

  return true;

}

// present yes/no can change anytime !
// by adding/removing a battery
bool BtryMeter::acpi_battery_present(const std::string& filename)
{
  std::ifstream loadinfo( filename.c_str() );

  std::string argname;
  std::string argval;

  while ( !loadinfo.eof() ) {

	argname.clear(); argval.clear();
	loadinfo >> argname >> argval;

	XOSDEBUG("batt ?: a=\"%s\" v=\"%s\"\n",argname.c_str(),argval.c_str() );
	if ( argname == "present:" )
           if ( argval == "yes" )
		return true;
  }
  XOSDEBUG("batt %s not present\n",filename.c_str() );
  return false;
}

bool BtryMeter::acpi_parse_battery(const std::string& dirname)
{
  // actually there are THREE files to check:
  // 'alarm', 'info' and 'state'

  std::string filename;
  std::ifstream loadinfo;
  std::istringstream inp_strm;
  std::string inp_line;

  std::string argname;
  std::string argval;

  filename = dirname + "/alarm";
  loadinfo.open(filename.c_str() );
  while ( loadinfo.good() ) {
	std::getline(loadinfo,inp_line);
	inp_strm.str(inp_line.c_str() );
	argname.clear(); argval.clear();
	inp_strm >> argname >> argval;
	XOSDEBUG("alarm: a=\"%s\" v=\"%s\"\n",argname.c_str(),argval.c_str() );

	if ( argname == "alarm:" ) {
		battery.alarm = atoi(argval.c_str());
		break;
	}
  }
  loadinfo.close(); loadinfo.clear();

  filename = dirname + "/info";
  loadinfo.open(filename.c_str() );
  while ( loadinfo.good() ) {

	argname.clear();
	std::getline(loadinfo,argname,':');

	argval.clear();
	std::getline(loadinfo,argval);

	XOSDEBUG("info: a=\"%s\" v=\"%s\"\n",argname.c_str(),argval.c_str() );

	if ( argname == "design capacity" ) {
		battery.design_capacity=atoi(argval.c_str() );
	}
	if ( argname == "last full capacity" ) {
		battery.last_full_capacity=atoi(argval.c_str() );
	}
	if ( argname == "last full capacity" ) {
		battery.last_full_capacity=atoi(argval.c_str() );
	}

  }
  loadinfo.close(); loadinfo.clear(); // clear eof-bit

  filename = dirname + "/state";
  loadinfo.open(filename.c_str() );
  while ( loadinfo.good() ) {

	// argname can contain spaces
	argname.clear();
	std::getline(loadinfo,argname,':');

	// argval should NOT contain blanks
	inp_line.clear();
	std::getline(loadinfo,inp_line);
	inp_strm.clear(); inp_strm.seekg(0);
	inp_strm.str(inp_line.c_str() );

	argval.clear();
	inp_strm >> argval; // this ignores leading spaces

	XOSDEBUG("state: a=\"%s\" v=\"%s\"\n",argname.c_str(),argval.c_str() );

	if ( argname == "charging state" ) {
		if ( argval == "charged" )
			battery.charging_state=0;
		if ( argval == "discharging" )
			battery.charging_state=-1;
		if ( argval == "charging" )
			battery.charging_state=1;
	}

	if ( argname == "last full capacity" ) {
		battery.last_full_capacity=atoi(argval.c_str() );
	}
	if ( argname == "last full capacity" ) {
		battery.last_full_capacity=atoi(argval.c_str() );
	}
	if ( argname == "remaining capacity" ) {
		battery.remaining_capacity=atoi(argval.c_str() );
	}

  }

return true;
}

// present yes/no can change anytime !
// by adding/removing a battery
bool BtryMeter::sys_battery_present(const std::string& filename)
{
  std::ifstream loadinfo( filename.c_str() );
  std::string value;

  while ( loadinfo.good() ) {

	value.clear();
	loadinfo >> value;

    if (value == "1")
	  return true;
  }
  XOSDEBUG("batt %s not present\n",filename.c_str() );
  return false;
}

bool BtryMeter::sys_parse_battery(const std::string& dirname)
{
  std::string filename;
  std::ifstream loadinfo;
  std::string value;
  struct stat stbuf;

  filename = dirname + "/alarm";
  loadinfo.open(filename.c_str() );
  while ( loadinfo.good() ) {
	value.clear();
	loadinfo >> value;
	XOSDEBUG("alarm (%s): v=\"%s\"\n", filename.c_str(), value.c_str() );
    battery.alarm = atoi(value.c_str());
    break;
  }
  loadinfo.close();
  loadinfo.clear();

  filename = dirname + "/energy_full_design";
  if (stat(filename.c_str(),&stbuf)!=0)
     filename=dirname+"/charge_full_design";
  loadinfo.open(filename.c_str() );
  while ( loadinfo.good() ) {
	value.clear();
	loadinfo >> value;
	XOSDEBUG("design_capacity (%s): v=\"%s\"\n", filename.c_str(), value.c_str() );
    battery.design_capacity = atoi(value.c_str());
    break;
  }
  loadinfo.close();
  loadinfo.clear();

  filename = dirname + "/energy_full";
  if (stat(filename.c_str(),&stbuf)!=0)
     filename=dirname+"/charge_full";
  loadinfo.open(filename.c_str() );
  if (!loadinfo.good()) {
	loadinfo.close();
	loadinfo.clear();
	filename=dirname+"/charge_full_design";
	loadinfo.open(filename.c_str());
  }

  while ( loadinfo.good() ) {
	value.clear();
	loadinfo >> value;
	XOSDEBUG("last_full_capacity (%s): v=\"%s\"\n", filename.c_str(), value.c_str() );
    battery.last_full_capacity = atoi(value.c_str());
    break;
  }
  loadinfo.close();
  loadinfo.clear();

  filename = dirname + "/energy_now";
  if (stat(filename.c_str(),&stbuf)!=0)
     filename=dirname+"/charge_now";
  loadinfo.open(filename.c_str() );
  while ( loadinfo.good() ) {
	value.clear();
	loadinfo >> value;
	XOSDEBUG("remaining_capacity (%s): v=\"%s\"\n", filename.c_str(), value.c_str() );
    battery.remaining_capacity = atoi(value.c_str());
    break;
  }
  loadinfo.close();
  loadinfo.clear();

  filename = dirname + "/status";
  loadinfo.open(filename.c_str() );
  while ( loadinfo.good() ) {
	value.clear();
	loadinfo >> value;
	XOSDEBUG("status (%s): v=\"%s\"\n", filename.c_str(), value.c_str() );

    battery.charging_state=0;
    if ( value == "Discharging" )
        battery.charging_state=-1;
    if ( value == "Charging" )
        battery.charging_state=1;
    break;
  }
  loadinfo.close();
  loadinfo.clear();

  return true;
}