forked from freebsd/freebsd-src
-
Notifications
You must be signed in to change notification settings - Fork 44
/
Copy pathdevstat.c
1631 lines (1515 loc) · 48.9 KB
/
devstat.c
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
/*
* Copyright (c) 1997, 1998 Kenneth D. Merry.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. The name of the author may not be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*/
#include <sys/cdefs.h>
__FBSDID("$FreeBSD$");
#include <sys/types.h>
#include <sys/sysctl.h>
#include <sys/errno.h>
#include <sys/resource.h>
#include <sys/queue.h>
#include <ctype.h>
#include <err.h>
#include <fcntl.h>
#include <limits.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <stdarg.h>
#include <kvm.h>
#include <nlist.h>
#include "devstat.h"
int
compute_stats(struct devstat *current, struct devstat *previous,
long double etime, u_int64_t *total_bytes,
u_int64_t *total_transfers, u_int64_t *total_blocks,
long double *kb_per_transfer, long double *transfers_per_second,
long double *mb_per_second, long double *blocks_per_second,
long double *ms_per_transaction);
typedef enum {
DEVSTAT_ARG_NOTYPE,
DEVSTAT_ARG_UINT64,
DEVSTAT_ARG_LD,
DEVSTAT_ARG_SKIP
} devstat_arg_type;
char devstat_errbuf[DEVSTAT_ERRBUF_SIZE];
/*
* Table to match descriptive strings with device types. These are in
* order from most common to least common to speed search time.
*/
struct devstat_match_table match_table[] = {
{"da", DEVSTAT_TYPE_DIRECT, DEVSTAT_MATCH_TYPE},
{"cd", DEVSTAT_TYPE_CDROM, DEVSTAT_MATCH_TYPE},
{"scsi", DEVSTAT_TYPE_IF_SCSI, DEVSTAT_MATCH_IF},
{"ide", DEVSTAT_TYPE_IF_IDE, DEVSTAT_MATCH_IF},
{"other", DEVSTAT_TYPE_IF_OTHER, DEVSTAT_MATCH_IF},
{"worm", DEVSTAT_TYPE_WORM, DEVSTAT_MATCH_TYPE},
{"sa", DEVSTAT_TYPE_SEQUENTIAL,DEVSTAT_MATCH_TYPE},
{"pass", DEVSTAT_TYPE_PASS, DEVSTAT_MATCH_PASS},
{"optical", DEVSTAT_TYPE_OPTICAL, DEVSTAT_MATCH_TYPE},
{"array", DEVSTAT_TYPE_STORARRAY, DEVSTAT_MATCH_TYPE},
{"changer", DEVSTAT_TYPE_CHANGER, DEVSTAT_MATCH_TYPE},
{"scanner", DEVSTAT_TYPE_SCANNER, DEVSTAT_MATCH_TYPE},
{"printer", DEVSTAT_TYPE_PRINTER, DEVSTAT_MATCH_TYPE},
{"floppy", DEVSTAT_TYPE_FLOPPY, DEVSTAT_MATCH_TYPE},
{"proc", DEVSTAT_TYPE_PROCESSOR, DEVSTAT_MATCH_TYPE},
{"comm", DEVSTAT_TYPE_COMM, DEVSTAT_MATCH_TYPE},
{"enclosure", DEVSTAT_TYPE_ENCLOSURE, DEVSTAT_MATCH_TYPE},
{NULL, 0, 0}
};
struct devstat_args {
devstat_metric metric;
devstat_arg_type argtype;
} devstat_arg_list[] = {
{ DSM_NONE, DEVSTAT_ARG_NOTYPE },
{ DSM_TOTAL_BYTES, DEVSTAT_ARG_UINT64 },
{ DSM_TOTAL_BYTES_READ, DEVSTAT_ARG_UINT64 },
{ DSM_TOTAL_BYTES_WRITE, DEVSTAT_ARG_UINT64 },
{ DSM_TOTAL_TRANSFERS, DEVSTAT_ARG_UINT64 },
{ DSM_TOTAL_TRANSFERS_READ, DEVSTAT_ARG_UINT64 },
{ DSM_TOTAL_TRANSFERS_WRITE, DEVSTAT_ARG_UINT64 },
{ DSM_TOTAL_TRANSFERS_OTHER, DEVSTAT_ARG_UINT64 },
{ DSM_TOTAL_BLOCKS, DEVSTAT_ARG_UINT64 },
{ DSM_TOTAL_BLOCKS_READ, DEVSTAT_ARG_UINT64 },
{ DSM_TOTAL_BLOCKS_WRITE, DEVSTAT_ARG_UINT64 },
{ DSM_KB_PER_TRANSFER, DEVSTAT_ARG_LD },
{ DSM_KB_PER_TRANSFER_READ, DEVSTAT_ARG_LD },
{ DSM_KB_PER_TRANSFER_WRITE, DEVSTAT_ARG_LD },
{ DSM_TRANSFERS_PER_SECOND, DEVSTAT_ARG_LD },
{ DSM_TRANSFERS_PER_SECOND_READ, DEVSTAT_ARG_LD },
{ DSM_TRANSFERS_PER_SECOND_WRITE, DEVSTAT_ARG_LD },
{ DSM_TRANSFERS_PER_SECOND_OTHER, DEVSTAT_ARG_LD },
{ DSM_MB_PER_SECOND, DEVSTAT_ARG_LD },
{ DSM_MB_PER_SECOND_READ, DEVSTAT_ARG_LD },
{ DSM_MB_PER_SECOND_WRITE, DEVSTAT_ARG_LD },
{ DSM_BLOCKS_PER_SECOND, DEVSTAT_ARG_LD },
{ DSM_BLOCKS_PER_SECOND_READ, DEVSTAT_ARG_LD },
{ DSM_BLOCKS_PER_SECOND_WRITE, DEVSTAT_ARG_LD },
{ DSM_MS_PER_TRANSACTION, DEVSTAT_ARG_LD },
{ DSM_MS_PER_TRANSACTION_READ, DEVSTAT_ARG_LD },
{ DSM_MS_PER_TRANSACTION_WRITE, DEVSTAT_ARG_LD },
{ DSM_SKIP, DEVSTAT_ARG_SKIP },
{ DSM_TOTAL_BYTES_FREE, DEVSTAT_ARG_UINT64 },
{ DSM_TOTAL_TRANSFERS_FREE, DEVSTAT_ARG_UINT64 },
{ DSM_TOTAL_BLOCKS_FREE, DEVSTAT_ARG_UINT64 },
{ DSM_KB_PER_TRANSFER_FREE, DEVSTAT_ARG_LD },
{ DSM_MB_PER_SECOND_FREE, DEVSTAT_ARG_LD },
{ DSM_TRANSFERS_PER_SECOND_FREE, DEVSTAT_ARG_LD },
{ DSM_BLOCKS_PER_SECOND_FREE, DEVSTAT_ARG_LD },
{ DSM_MS_PER_TRANSACTION_OTHER, DEVSTAT_ARG_LD },
{ DSM_MS_PER_TRANSACTION_FREE, DEVSTAT_ARG_LD },
{ DSM_BUSY_PCT, DEVSTAT_ARG_LD },
{ DSM_QUEUE_LENGTH, DEVSTAT_ARG_UINT64 },
};
static const char *namelist[] = {
#define X_NUMDEVS 0
"_devstat_num_devs",
#define X_GENERATION 1
"_devstat_generation",
#define X_VERSION 2
"_devstat_version",
#define X_DEVICE_STATQ 3
"_device_statq",
#define X_END 4
};
/*
* Local function declarations.
*/
static int compare_select(const void *arg1, const void *arg2);
static int readkmem(kvm_t *kd, unsigned long addr, void *buf, size_t nbytes);
static int readkmem_nl(kvm_t *kd, const char *name, void *buf, size_t nbytes);
static char *get_devstat_kvm(kvm_t *kd);
#define KREADNL(kd, var, val) \
readkmem_nl(kd, namelist[var], &val, sizeof(val))
int
devstat_getnumdevs(kvm_t *kd)
{
size_t numdevsize;
int numdevs;
numdevsize = sizeof(int);
/*
* Find out how many devices we have in the system.
*/
if (kd == NULL) {
if (sysctlbyname("kern.devstat.numdevs", &numdevs,
&numdevsize, NULL, 0) == -1) {
snprintf(devstat_errbuf, sizeof(devstat_errbuf),
"%s: error getting number of devices\n"
"%s: %s", __func__, __func__,
strerror(errno));
return(-1);
} else
return(numdevs);
} else {
if (KREADNL(kd, X_NUMDEVS, numdevs) == -1)
return(-1);
else
return(numdevs);
}
}
/*
* This is an easy way to get the generation number, but the generation is
* supplied in a more atmoic manner by the kern.devstat.all sysctl.
* Because this generation sysctl is separate from the statistics sysctl,
* the device list and the generation could change between the time that
* this function is called and the device list is retreived.
*/
long
devstat_getgeneration(kvm_t *kd)
{
size_t gensize;
long generation;
gensize = sizeof(long);
/*
* Get the current generation number.
*/
if (kd == NULL) {
if (sysctlbyname("kern.devstat.generation", &generation,
&gensize, NULL, 0) == -1) {
snprintf(devstat_errbuf, sizeof(devstat_errbuf),
"%s: error getting devstat generation\n%s: %s",
__func__, __func__, strerror(errno));
return(-1);
} else
return(generation);
} else {
if (KREADNL(kd, X_GENERATION, generation) == -1)
return(-1);
else
return(generation);
}
}
/*
* Get the current devstat version. The return value of this function
* should be compared with DEVSTAT_VERSION, which is defined in
* sys/devicestat.h. This will enable userland programs to determine
* whether they are out of sync with the kernel.
*/
int
devstat_getversion(kvm_t *kd)
{
size_t versize;
int version;
versize = sizeof(int);
/*
* Get the current devstat version.
*/
if (kd == NULL) {
if (sysctlbyname("kern.devstat.version", &version, &versize,
NULL, 0) == -1) {
snprintf(devstat_errbuf, sizeof(devstat_errbuf),
"%s: error getting devstat version\n%s: %s",
__func__, __func__, strerror(errno));
return(-1);
} else
return(version);
} else {
if (KREADNL(kd, X_VERSION, version) == -1)
return(-1);
else
return(version);
}
}
/*
* Check the devstat version we know about against the devstat version the
* kernel knows about. If they don't match, print an error into the
* devstat error buffer, and return -1. If they match, return 0.
*/
int
devstat_checkversion(kvm_t *kd)
{
int buflen, res, retval = 0, version;
version = devstat_getversion(kd);
if (version != DEVSTAT_VERSION) {
/*
* If getversion() returns an error (i.e. -1), then it
* has printed an error message in the buffer. Therefore,
* we need to add a \n to the end of that message before we
* print our own message in the buffer.
*/
if (version == -1)
buflen = strlen(devstat_errbuf);
else
buflen = 0;
res = snprintf(devstat_errbuf + buflen,
DEVSTAT_ERRBUF_SIZE - buflen,
"%s%s: userland devstat version %d is not "
"the same as the kernel\n%s: devstat "
"version %d\n", version == -1 ? "\n" : "",
__func__, DEVSTAT_VERSION, __func__, version);
if (res < 0)
devstat_errbuf[buflen] = '\0';
buflen = strlen(devstat_errbuf);
if (version < DEVSTAT_VERSION)
res = snprintf(devstat_errbuf + buflen,
DEVSTAT_ERRBUF_SIZE - buflen,
"%s: libdevstat newer than kernel\n",
__func__);
else
res = snprintf(devstat_errbuf + buflen,
DEVSTAT_ERRBUF_SIZE - buflen,
"%s: kernel newer than libdevstat\n",
__func__);
if (res < 0)
devstat_errbuf[buflen] = '\0';
retval = -1;
}
return(retval);
}
/*
* Get the current list of devices and statistics, and the current
* generation number.
*
* Return values:
* -1 -- error
* 0 -- device list is unchanged
* 1 -- device list has changed
*/
int
devstat_getdevs(kvm_t *kd, struct statinfo *stats)
{
int error;
size_t dssize;
int oldnumdevs;
long oldgeneration;
int retval = 0;
struct devinfo *dinfo;
struct timespec ts;
dinfo = stats->dinfo;
if (dinfo == NULL) {
snprintf(devstat_errbuf, sizeof(devstat_errbuf),
"%s: stats->dinfo was NULL", __func__);
return(-1);
}
oldnumdevs = dinfo->numdevs;
oldgeneration = dinfo->generation;
clock_gettime(CLOCK_MONOTONIC, &ts);
stats->snap_time = ts.tv_sec + ts.tv_nsec * 1e-9;
if (kd == NULL) {
/* If this is our first time through, mem_ptr will be null. */
if (dinfo->mem_ptr == NULL) {
/*
* Get the number of devices. If it's negative, it's an
* error. Don't bother setting the error string, since
* getnumdevs() has already done that for us.
*/
if ((dinfo->numdevs = devstat_getnumdevs(kd)) < 0)
return(-1);
/*
* The kern.devstat.all sysctl returns the current
* generation number, as well as all the devices.
* So we need four bytes more.
*/
dssize = (dinfo->numdevs * sizeof(struct devstat)) +
sizeof(long);
dinfo->mem_ptr = (u_int8_t *)malloc(dssize);
} else
dssize = (dinfo->numdevs * sizeof(struct devstat)) +
sizeof(long);
/*
* Request all of the devices. We only really allow for one
* ENOMEM failure. It would, of course, be possible to just go
* in a loop and keep reallocing the device structure until we
* don't get ENOMEM back. I'm not sure it's worth it, though.
* If devices are being added to the system that quickly, maybe
* the user can just wait until all devices are added.
*/
for (;;) {
error = sysctlbyname("kern.devstat.all",
dinfo->mem_ptr,
&dssize, NULL, 0);
if (error != -1 || errno != EBUSY)
break;
}
if (error == -1) {
/*
* If we get ENOMEM back, that means that there are
* more devices now, so we need to allocate more
* space for the device array.
*/
if (errno == ENOMEM) {
/*
* No need to set the error string here,
* devstat_getnumdevs() will do that if it fails.
*/
if ((dinfo->numdevs = devstat_getnumdevs(kd)) < 0)
return(-1);
dssize = (dinfo->numdevs *
sizeof(struct devstat)) + sizeof(long);
dinfo->mem_ptr = (u_int8_t *)
realloc(dinfo->mem_ptr, dssize);
if ((error = sysctlbyname("kern.devstat.all",
dinfo->mem_ptr, &dssize, NULL, 0)) == -1) {
snprintf(devstat_errbuf,
sizeof(devstat_errbuf),
"%s: error getting device "
"stats\n%s: %s", __func__,
__func__, strerror(errno));
return(-1);
}
} else {
snprintf(devstat_errbuf, sizeof(devstat_errbuf),
"%s: error getting device stats\n"
"%s: %s", __func__, __func__,
strerror(errno));
return(-1);
}
}
} else {
/*
* This is of course non-atomic, but since we are working
* on a core dump, the generation is unlikely to change
*/
if ((dinfo->numdevs = devstat_getnumdevs(kd)) == -1)
return(-1);
if ((dinfo->mem_ptr = (u_int8_t *)get_devstat_kvm(kd)) == NULL)
return(-1);
}
/*
* The sysctl spits out the generation as the first four bytes,
* then all of the device statistics structures.
*/
dinfo->generation = *(long *)dinfo->mem_ptr;
/*
* If the generation has changed, and if the current number of
* devices is not the same as the number of devices recorded in the
* devinfo structure, it is likely that the device list has shrunk.
* The reason that it is likely that the device list has shrunk in
* this case is that if the device list has grown, the sysctl above
* will return an ENOMEM error, and we will reset the number of
* devices and reallocate the device array. If the second sysctl
* fails, we will return an error and therefore never get to this
* point. If the device list has shrunk, the sysctl will not
* return an error since we have more space allocated than is
* necessary. So, in the shrinkage case, we catch it here and
* reallocate the array so that we don't use any more space than is
* necessary.
*/
if (oldgeneration != dinfo->generation) {
if (devstat_getnumdevs(kd) != dinfo->numdevs) {
if ((dinfo->numdevs = devstat_getnumdevs(kd)) < 0)
return(-1);
dssize = (dinfo->numdevs * sizeof(struct devstat)) +
sizeof(long);
dinfo->mem_ptr = (u_int8_t *)realloc(dinfo->mem_ptr,
dssize);
}
retval = 1;
}
dinfo->devices = (struct devstat *)(dinfo->mem_ptr + sizeof(long));
return(retval);
}
/*
* selectdevs():
*
* Devices are selected/deselected based upon the following criteria:
* - devices specified by the user on the command line
* - devices matching any device type expressions given on the command line
* - devices with the highest I/O, if 'top' mode is enabled
* - the first n unselected devices in the device list, if maxshowdevs
* devices haven't already been selected and if the user has not
* specified any devices on the command line and if we're in "add" mode.
*
* Input parameters:
* - device selection list (dev_select)
* - current number of devices selected (num_selected)
* - total number of devices in the selection list (num_selections)
* - devstat generation as of the last time selectdevs() was called
* (select_generation)
* - current devstat generation (current_generation)
* - current list of devices and statistics (devices)
* - number of devices in the current device list (numdevs)
* - compiled version of the command line device type arguments (matches)
* - This is optional. If the number of devices is 0, this will be ignored.
* - The matching code pays attention to the current selection mode. So
* if you pass in a matching expression, it will be evaluated based
* upon the selection mode that is passed in. See below for details.
* - number of device type matching expressions (num_matches)
* - Set to 0 to disable the matching code.
* - list of devices specified on the command line by the user (dev_selections)
* - number of devices selected on the command line by the user
* (num_dev_selections)
* - Our selection mode. There are four different selection modes:
* - add mode. (DS_SELECT_ADD) Any devices matching devices explicitly
* selected by the user or devices matching a pattern given by the
* user will be selected in addition to devices that are already
* selected. Additional devices will be selected, up to maxshowdevs
* number of devices.
* - only mode. (DS_SELECT_ONLY) Only devices matching devices
* explicitly given by the user or devices matching a pattern
* given by the user will be selected. No other devices will be
* selected.
* - addonly mode. (DS_SELECT_ADDONLY) This is similar to add and
* only. Basically, this will not de-select any devices that are
* current selected, as only mode would, but it will also not
* gratuitously select up to maxshowdevs devices as add mode would.
* - remove mode. (DS_SELECT_REMOVE) Any devices matching devices
* explicitly selected by the user or devices matching a pattern
* given by the user will be de-selected.
* - maximum number of devices we can select (maxshowdevs)
* - flag indicating whether or not we're in 'top' mode (perf_select)
*
* Output data:
* - the device selection list may be modified and passed back out
* - the number of devices selected and the total number of items in the
* device selection list may be changed
* - the selection generation may be changed to match the current generation
*
* Return values:
* -1 -- error
* 0 -- selected devices are unchanged
* 1 -- selected devices changed
*/
int
devstat_selectdevs(struct device_selection **dev_select, int *num_selected,
int *num_selections, long *select_generation,
long current_generation, struct devstat *devices,
int numdevs, struct devstat_match *matches, int num_matches,
char **dev_selections, int num_dev_selections,
devstat_select_mode select_mode, int maxshowdevs,
int perf_select)
{
int i, j, k;
int init_selections = 0, init_selected_var = 0;
struct device_selection *old_dev_select = NULL;
int old_num_selections = 0, old_num_selected;
int selection_number = 0;
int changed = 0, found = 0;
if ((dev_select == NULL) || (devices == NULL) || (numdevs < 0))
return(-1);
/*
* We always want to make sure that we have as many dev_select
* entries as there are devices.
*/
/*
* In this case, we haven't selected devices before.
*/
if (*dev_select == NULL) {
*dev_select = (struct device_selection *)malloc(numdevs *
sizeof(struct device_selection));
*select_generation = current_generation;
init_selections = 1;
changed = 1;
/*
* In this case, we have selected devices before, but the device
* list has changed since we last selected devices, so we need to
* either enlarge or reduce the size of the device selection list.
*/
} else if (*num_selections != numdevs) {
*dev_select = (struct device_selection *)realloc(*dev_select,
numdevs * sizeof(struct device_selection));
*select_generation = current_generation;
init_selections = 1;
/*
* In this case, we've selected devices before, and the selection
* list is the same size as it was the last time, but the device
* list has changed.
*/
} else if (*select_generation < current_generation) {
*select_generation = current_generation;
init_selections = 1;
}
/*
* If we're in "only" mode, we want to clear out the selected
* variable since we're going to select exactly what the user wants
* this time through.
*/
if (select_mode == DS_SELECT_ONLY)
init_selected_var = 1;
/*
* In all cases, we want to back up the number of selected devices.
* It is a quick and accurate way to determine whether the selected
* devices have changed.
*/
old_num_selected = *num_selected;
/*
* We want to make a backup of the current selection list if
* the list of devices has changed, or if we're in performance
* selection mode. In both cases, we don't want to make a backup
* if we already know for sure that the list will be different.
* This is certainly the case if this is our first time through the
* selection code.
*/
if (((init_selected_var != 0) || (init_selections != 0)
|| (perf_select != 0)) && (changed == 0)){
old_dev_select = (struct device_selection *)malloc(
*num_selections * sizeof(struct device_selection));
old_num_selections = *num_selections;
bcopy(*dev_select, old_dev_select,
sizeof(struct device_selection) * *num_selections);
}
if (init_selections != 0) {
bzero(*dev_select, sizeof(struct device_selection) * numdevs);
for (i = 0; i < numdevs; i++) {
(*dev_select)[i].device_number =
devices[i].device_number;
strncpy((*dev_select)[i].device_name,
devices[i].device_name,
DEVSTAT_NAME_LEN);
(*dev_select)[i].device_name[DEVSTAT_NAME_LEN - 1]='\0';
(*dev_select)[i].unit_number = devices[i].unit_number;
(*dev_select)[i].position = i;
}
*num_selections = numdevs;
} else if (init_selected_var != 0) {
for (i = 0; i < numdevs; i++)
(*dev_select)[i].selected = 0;
}
/* we haven't gotten around to selecting anything yet.. */
if ((select_mode == DS_SELECT_ONLY) || (init_selections != 0)
|| (init_selected_var != 0))
*num_selected = 0;
/*
* Look through any devices the user specified on the command line
* and see if they match known devices. If so, select them.
*/
for (i = 0; (i < *num_selections) && (num_dev_selections > 0); i++) {
char tmpstr[80];
snprintf(tmpstr, sizeof(tmpstr), "%s%d",
(*dev_select)[i].device_name,
(*dev_select)[i].unit_number);
for (j = 0; j < num_dev_selections; j++) {
if (strcmp(tmpstr, dev_selections[j]) == 0) {
/*
* Here we do different things based on the
* mode we're in. If we're in add or
* addonly mode, we only select this device
* if it hasn't already been selected.
* Otherwise, we would be unnecessarily
* changing the selection order and
* incrementing the selection count. If
* we're in only mode, we unconditionally
* select this device, since in only mode
* any previous selections are erased and
* manually specified devices are the first
* ones to be selected. If we're in remove
* mode, we de-select the specified device and
* decrement the selection count.
*/
switch(select_mode) {
case DS_SELECT_ADD:
case DS_SELECT_ADDONLY:
if ((*dev_select)[i].selected)
break;
/* FALLTHROUGH */
case DS_SELECT_ONLY:
(*dev_select)[i].selected =
++selection_number;
(*num_selected)++;
break;
case DS_SELECT_REMOVE:
(*dev_select)[i].selected = 0;
(*num_selected)--;
/*
* This isn't passed back out, we
* just use it to keep track of
* how many devices we've removed.
*/
num_dev_selections--;
break;
}
break;
}
}
}
/*
* Go through the user's device type expressions and select devices
* accordingly. We only do this if the number of devices already
* selected is less than the maximum number we can show.
*/
for (i = 0; (i < num_matches) && (*num_selected < maxshowdevs); i++) {
/* We should probably indicate some error here */
if ((matches[i].match_fields == DEVSTAT_MATCH_NONE)
|| (matches[i].num_match_categories <= 0))
continue;
for (j = 0; j < numdevs; j++) {
int num_match_categories;
num_match_categories = matches[i].num_match_categories;
/*
* Determine whether or not the current device
* matches the given matching expression. This if
* statement consists of three components:
* - the device type check
* - the device interface check
* - the passthrough check
* If a the matching test is successful, it
* decrements the number of matching categories,
* and if we've reached the last element that
* needed to be matched, the if statement succeeds.
*
*/
if ((((matches[i].match_fields & DEVSTAT_MATCH_TYPE)!=0)
&& ((devices[j].device_type & DEVSTAT_TYPE_MASK) ==
(matches[i].device_type & DEVSTAT_TYPE_MASK))
&&(((matches[i].match_fields & DEVSTAT_MATCH_PASS)!=0)
|| (((matches[i].match_fields &
DEVSTAT_MATCH_PASS) == 0)
&& ((devices[j].device_type &
DEVSTAT_TYPE_PASS) == 0)))
&& (--num_match_categories == 0))
|| (((matches[i].match_fields & DEVSTAT_MATCH_IF) != 0)
&& ((devices[j].device_type & DEVSTAT_TYPE_IF_MASK) ==
(matches[i].device_type & DEVSTAT_TYPE_IF_MASK))
&&(((matches[i].match_fields & DEVSTAT_MATCH_PASS)!=0)
|| (((matches[i].match_fields &
DEVSTAT_MATCH_PASS) == 0)
&& ((devices[j].device_type &
DEVSTAT_TYPE_PASS) == 0)))
&& (--num_match_categories == 0))
|| (((matches[i].match_fields & DEVSTAT_MATCH_PASS)!=0)
&& ((devices[j].device_type & DEVSTAT_TYPE_PASS) != 0)
&& (--num_match_categories == 0))) {
/*
* This is probably a non-optimal solution
* to the problem that the devices in the
* device list will not be in the same
* order as the devices in the selection
* array.
*/
for (k = 0; k < numdevs; k++) {
if ((*dev_select)[k].position == j) {
found = 1;
break;
}
}
/*
* There shouldn't be a case where a device
* in the device list is not in the
* selection list...but it could happen.
*/
if (found != 1) {
fprintf(stderr, "selectdevs: couldn't"
" find %s%d in selection "
"list\n",
devices[j].device_name,
devices[j].unit_number);
break;
}
/*
* We do different things based upon the
* mode we're in. If we're in add or only
* mode, we go ahead and select this device
* if it hasn't already been selected. If
* it has already been selected, we leave
* it alone so we don't mess up the
* selection ordering. Manually specified
* devices have already been selected, and
* they have higher priority than pattern
* matched devices. If we're in remove
* mode, we de-select the given device and
* decrement the selected count.
*/
switch(select_mode) {
case DS_SELECT_ADD:
case DS_SELECT_ADDONLY:
case DS_SELECT_ONLY:
if ((*dev_select)[k].selected != 0)
break;
(*dev_select)[k].selected =
++selection_number;
(*num_selected)++;
break;
case DS_SELECT_REMOVE:
(*dev_select)[k].selected = 0;
(*num_selected)--;
break;
}
}
}
}
/*
* Here we implement "top" mode. Devices are sorted in the
* selection array based on two criteria: whether or not they are
* selected (not selection number, just the fact that they are
* selected!) and the number of bytes in the "bytes" field of the
* selection structure. The bytes field generally must be kept up
* by the user. In the future, it may be maintained by library
* functions, but for now the user has to do the work.
*
* At first glance, it may seem wrong that we don't go through and
* select every device in the case where the user hasn't specified
* any devices or patterns. In fact, though, it won't make any
* difference in the device sorting. In that particular case (i.e.
* when we're in "add" or "only" mode, and the user hasn't
* specified anything) the first time through no devices will be
* selected, so the only criterion used to sort them will be their
* performance. The second time through, and every time thereafter,
* all devices will be selected, so again selection won't matter.
*/
if (perf_select != 0) {
/* Sort the device array by throughput */
qsort(*dev_select, *num_selections,
sizeof(struct device_selection),
compare_select);
if (*num_selected == 0) {
/*
* Here we select every device in the array, if it
* isn't already selected. Because the 'selected'
* variable in the selection array entries contains
* the selection order, the devstats routine can show
* the devices that were selected first.
*/
for (i = 0; i < *num_selections; i++) {
if ((*dev_select)[i].selected == 0) {
(*dev_select)[i].selected =
++selection_number;
(*num_selected)++;
}
}
} else {
selection_number = 0;
for (i = 0; i < *num_selections; i++) {
if ((*dev_select)[i].selected != 0) {
(*dev_select)[i].selected =
++selection_number;
}
}
}
}
/*
* If we're in the "add" selection mode and if we haven't already
* selected maxshowdevs number of devices, go through the array and
* select any unselected devices. If we're in "only" mode, we
* obviously don't want to select anything other than what the user
* specifies. If we're in "remove" mode, it probably isn't a good
* idea to go through and select any more devices, since we might
* end up selecting something that the user wants removed. Through
* more complicated logic, we could actually figure this out, but
* that would probably require combining this loop with the various
* selections loops above.
*/
if ((select_mode == DS_SELECT_ADD) && (*num_selected < maxshowdevs)) {
for (i = 0; i < *num_selections; i++)
if ((*dev_select)[i].selected == 0) {
(*dev_select)[i].selected = ++selection_number;
(*num_selected)++;
}
}
/*
* Look at the number of devices that have been selected. If it
* has changed, set the changed variable. Otherwise, if we've
* made a backup of the selection list, compare it to the current
* selection list to see if the selected devices have changed.
*/
if ((changed == 0) && (old_num_selected != *num_selected))
changed = 1;
else if ((changed == 0) && (old_dev_select != NULL)) {
/*
* Now we go through the selection list and we look at
* it three different ways.
*/
for (i = 0; (i < *num_selections) && (changed == 0) &&
(i < old_num_selections); i++) {
/*
* If the device at index i in both the new and old
* selection arrays has the same device number and
* selection status, it hasn't changed. We
* continue on to the next index.
*/
if (((*dev_select)[i].device_number ==
old_dev_select[i].device_number)
&& ((*dev_select)[i].selected ==
old_dev_select[i].selected))
continue;
/*
* Now, if we're still going through the if
* statement, the above test wasn't true. So we
* check here to see if the device at index i in
* the current array is the same as the device at
* index i in the old array. If it is, that means
* that its selection number has changed. Set
* changed to 1 and exit the loop.
*/
else if ((*dev_select)[i].device_number ==
old_dev_select[i].device_number) {
changed = 1;
break;
}
/*
* If we get here, then the device at index i in
* the current array isn't the same device as the
* device at index i in the old array.
*/
else {
found = 0;
/*
* Search through the old selection array
* looking for a device with the same
* device number as the device at index i
* in the current array. If the selection
* status is the same, then we mark it as
* found. If the selection status isn't
* the same, we break out of the loop.
* Since found isn't set, changed will be
* set to 1 below.
*/
for (j = 0; j < old_num_selections; j++) {
if (((*dev_select)[i].device_number ==
old_dev_select[j].device_number)
&& ((*dev_select)[i].selected ==
old_dev_select[j].selected)){
found = 1;
break;
}
else if ((*dev_select)[i].device_number
== old_dev_select[j].device_number)
break;
}
if (found == 0)
changed = 1;
}
}
}
if (old_dev_select != NULL)
free(old_dev_select);
return(changed);
}
/*
* Comparison routine for qsort() above. Note that the comparison here is
* backwards -- generally, it should return a value to indicate whether
* arg1 is <, =, or > arg2. Instead, it returns the opposite. The reason
* it returns the opposite is so that the selection array will be sorted in
* order of decreasing performance. We sort on two parameters. The first
* sort key is whether or not one or the other of the devices in question
* has been selected. If one of them has, and the other one has not, the
* selected device is automatically more important than the unselected
* device. If neither device is selected, we judge the devices based upon
* performance.
*/
static int
compare_select(const void *arg1, const void *arg2)
{
if ((((const struct device_selection *)arg1)->selected)
&& (((const struct device_selection *)arg2)->selected == 0))
return(-1);
else if ((((const struct device_selection *)arg1)->selected == 0)
&& (((const struct device_selection *)arg2)->selected))
return(1);
else if (((const struct device_selection *)arg2)->bytes <
((const struct device_selection *)arg1)->bytes)
return(-1);
else if (((const struct device_selection *)arg2)->bytes >
((const struct device_selection *)arg1)->bytes)
return(1);
else
return(0);
}
/*
* Take a string with the general format "arg1,arg2,arg3", and build a
* device matching expression from it.
*/
int
devstat_buildmatch(char *match_str, struct devstat_match **matches,
int *num_matches)
{