/usr/include/pcp/impl.h is in libpcp3-dev 3.10.8build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 | /*
* Copyright (c) 2012-2015 Red Hat.
* Copyright (c) 2008-2009 Aconex. All Rights Reserved.
* Copyright (c) 1995-2002 Silicon Graphics, Inc. All Rights Reserved.
*
* This library is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as published
* by the Free Software Foundation; either version 2.1 of the License, or
* (at your option) any later version.
*
* This library is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
* License for more details.
*/
#ifndef PCP_IMPL_H
#define PCP_IMPL_H
#include <time.h>
#include <fcntl.h>
#include <dirent.h>
#include <signal.h>
#include <unistd.h>
#include <sys/types.h>
#include <sys/param.h>
#include <sys/time.h>
#ifdef HAVE_SYS_SOCKET_H
#include <sys/socket.h>
#endif
#ifdef HAVE_NETINET_TCP_H
#include <netinet/tcp.h>
#endif
#ifdef HAVE_NETINET_IN_H
#include <netinet/in.h>
#endif
#ifdef HAVE_ARPA_INET_H
#include <arpa/inet.h>
#endif
#ifdef HAVE_NETDB_H
#include <netdb.h>
#endif
/*
* Thread-safe support ... #define to enable thread-safe protection of
* global data structures and mutual exclusion when required.
*
* We require pthread.h and working mutex, the rest can be faked
* by the libpcp itself.
*/
#if defined(HAVE_PTHREAD_H) && defined(HAVE_PTHREAD_MUTEX_T)
#define PM_MULTI_THREAD 1
#include <pthread.h>
typedef pthread_mutex_t __pmMutex;
#else
typedef void * __pmMutex;
#endif
#ifdef __cplusplus
extern "C" {
#endif
/*
* This defines the routines, macros and data structures that are used
* in the Performance Metrics Collection Subsystem (PMCS) below the
* PMAPI.
*/
/*
* internal libpcp state ... PM_STATE_APPL means we are at or above the
* PMAPI in a state where PMAPI calls can safely be made ... PM_STATE_PMCS
* means we are in the PMCD, or a PMDA, or low-level PDU code, and
* PMAPI calls are a bad idea.
*/
#define PM_STATE_APPL 0
#define PM_STATE_PMCS 1
PCP_CALL extern void __pmSetInternalState(int);
PCP_CALL extern int __pmGetInternalState(void);
/*
* PMCD connections come here by default, over-ride with $PMCD_PORT in
* environment
*/
#define SERVER_PORT 44321
#define SERVER_PROTOCOL "pcp"
/*
* port that clients connect to pmproxy(1) on by default, over-ride with
* $PMPROXY_PORT in environment
*/
#define PROXY_PORT 44322
#define PROXY_PROTOCOL "proxy"
/*
* port that clients connect to pmwebd(1) by default
*/
#define PMWEBD_PORT 44323
#define PMWEBD_PROTOCOL "http"
/*
* Internally, this is how to decode a PMID!
* - flag is to denote state internally in some operations
* - domain is usually the unique domain number of a PMDA, but DYNAMIC_PMID
* (number 511) is reserved for PMIDs representing the root of a
* dynamic subtree in the PMNS (and in this case the real domain number
* is encoded in the cluster field)
* - cluster and item together uniquely identify a metric within a domain
*/
#define DYNAMIC_PMID 511
typedef struct {
#ifdef HAVE_BITFIELDS_LTOR
unsigned int flag : 1;
unsigned int domain : 9;
unsigned int cluster : 12;
unsigned int item : 10;
#else
unsigned int item : 10;
unsigned int cluster : 12;
unsigned int domain : 9;
unsigned int flag : 1;
#endif
} __pmID_int;
static inline __pmID_int *
__pmid_int(pmID *idp)
{
/* avoid gcc's warning about dereferencing type-punned pointers */
return (__pmID_int *)idp;
}
static inline unsigned int
pmid_item(pmID id)
{
return __pmid_int(&id)->item;
}
static inline unsigned int
pmid_cluster(pmID id)
{
return __pmid_int(&id)->cluster;
}
static inline unsigned int
pmid_domain(pmID id)
{
return __pmid_int(&id)->domain;
}
static inline pmID
pmid_build(unsigned int domain, unsigned int cluster, unsigned int item)
{
pmID id;
__pmID_int idint;
idint.flag = 0;
idint.domain = domain;
idint.cluster = cluster;
idint.item = item;
memcpy(&id, &idint, sizeof(id));
return id;
}
/*
* Internally, this is how to decode an Instance Domain Identifier
* - flag is to denote state internally in some operations
* - domain is usually the unique domain number of a PMDA, but DYNAMIC_PMID
* (number 511) is reserved (see above for PMID encoding rules)
* - serial uniquely identifies an InDom within a domain
*/
typedef struct {
#ifdef HAVE_BITFIELDS_LTOR
int flag : 1;
unsigned int domain : 9;
unsigned int serial : 22;
#else
unsigned int serial : 22;
unsigned int domain : 9;
int flag : 1;
#endif
} __pmInDom_int;
static inline __pmInDom_int *
__pmindom_int(pmInDom *idp)
{
/* avoid gcc's warning about dereferencing type-punned pointers */
return (__pmInDom_int *)idp;
}
static inline unsigned int
pmInDom_domain(pmInDom id)
{
return __pmindom_int(&id)->domain;
}
static inline unsigned int
pmInDom_serial(pmInDom id)
{
return __pmindom_int(&id)->serial;
}
static inline pmInDom
pmInDom_build(unsigned int domain, unsigned int serial)
{
pmInDom ind;
__pmInDom_int indint;
indint.flag = 0;
indint.domain = domain;
indint.serial = serial;
memcpy(&ind, &indint, sizeof(ind));
return ind;
}
/*
* internal structure of a PMNS node
*/
typedef struct __pmnsNode {
struct __pmnsNode *parent;
struct __pmnsNode *next;
struct __pmnsNode *first;
struct __pmnsNode *hash; /* used as "last" in build, then pmid hash synonym */
char *name;
pmID pmid;
} __pmnsNode;
/*
* internal structure of a PMNS tree
*/
typedef struct __pmnsTree {
__pmnsNode *root; /* root of tree structure */
__pmnsNode **htab; /* hash table of nodes keyed on pmid */
int htabsize; /* number of nodes in the table */
char *symbol; /* store all names contiguously */
int contiguous; /* is data stored contiguously ? */
int mark_state; /* the total mark value for trimming */
} __pmnsTree;
/* used by pmnsmerge... */
PCP_CALL extern __pmnsTree *__pmExportPMNS(void);
/* for PMNS in archives */
PCP_CALL extern int __pmNewPMNS(__pmnsTree **);
PCP_CALL extern void __pmFreePMNS(__pmnsTree *);
PCP_CALL extern void __pmUsePMNS(__pmnsTree *); /* for debugging */
PCP_CALL extern int __pmFixPMNSHashTab(__pmnsTree *, int, int);
PCP_CALL extern int __pmAddPMNSNode(__pmnsTree *, int, const char *);
/* helper routine to print all names of a metric */
PCP_CALL extern void __pmPrintMetricNames(FILE *, int, char **, char *);
/* return true if the named pmns file has changed */
PCP_CALL extern int __pmHasPMNSFileChanged(const char *);
/* standard log file set up */
PCP_CALL extern FILE *__pmOpenLog(const char *, const char *, FILE *, int *);
PCP_CALL extern FILE *__pmRotateLog(const char *, const char *, FILE *, int *);
/* make __pmNotifyErr also add entries to syslog */
PCP_CALL extern void __pmSyslog(int);
/* standard error, warning and info wrapper for syslog(3C) */
PCP_CALL extern void __pmNotifyErr(int, const char *, ...) __PM_PRINTFLIKE(2,3);
/*
* These are for debugging only (but are present in the shipped libpcp)
*/
PCP_DATA extern int pmDebug;
#define DBG_TRACE_PDU 1 /* PDU send and receive */
#define DBG_TRACE_FETCH 2 /* dump pmFetch results */
#define DBG_TRACE_PROFILE 4 /* trace profile changes */
#define DBG_TRACE_VALUE 8 /* metric value conversions */
#define DBG_TRACE_CONTEXT 16 /* trace PMAPI context changes */
#define DBG_TRACE_INDOM 32 /* instance domain operations */
#define DBG_TRACE_PDUBUF 64 /* PDU buffer management */
#define DBG_TRACE_LOG 128 /* generic archive log operations */
#define DBG_TRACE_LOGMETA (1<<8) /* meta data in archives */
#define DBG_TRACE_OPTFETCH (1<<9) /* optFetch tracing */
#define DBG_TRACE_AF (1<<10) /* trace async timer events */
#define DBG_TRACE_APPL0 (1<<11) /* reserved for applications */
#define DBG_TRACE_APPL1 (1<<12) /* reserved for applications */
#define DBG_TRACE_APPL2 (1<<13) /* reserved for applications */
#define DBG_TRACE_PMNS (1<<14) /* PMNS operations */
#define DBG_TRACE_LIBPMDA (1<<15) /* libpcp_pmda */
#define DBG_TRACE_TIMECONTROL (1<<16) /* time control api */
#define DBG_TRACE_PMC (1<<17) /* metrics class */
#define DBG_TRACE_DERIVE (1<<18) /* derived metrics */
#define DBG_TRACE_LOCK (1<<19) /* lock tracing */
#define DBG_TRACE_INTERP (1<<20) /* interpolate mode for archives */
#define DBG_TRACE_CONFIG (1<<21) /* configuration parameters */
#define DBG_TRACE_LOOP (1<<22) /* pmLoop tracing */
#define DBG_TRACE_FAULT (1<<23) /* fault injection tracing */
#define DBG_TRACE_AUTH (1<<24) /* authentication tracing */
#define DBG_TRACE_DISCOVERY (1<<25) /* service discovery tracing */
#define DBG_TRACE_ATTR (1<<26) /* all connection attributes */
/* not yet allocated, bits (1<<27) ... (1<<29) */
#define DBG_TRACE_DESPERATE (1<<30) /* verbose/desperate level */
PCP_CALL extern int __pmParseDebug(const char *);
PCP_CALL extern void __pmDumpResult(FILE *, const pmResult *);
PCP_CALL extern void __pmDumpHighResResult(FILE *, const pmHighResResult *);
PCP_CALL extern void __pmPrintStamp(FILE *, const struct timeval *);
PCP_CALL extern void __pmPrintHighResStamp(FILE *, const struct timespec *);
PCP_CALL extern void __pmPrintTimespec(FILE *, const __pmTimespec *);
PCP_CALL extern void __pmPrintTimeval(FILE *, const __pmTimeval *);
PCP_CALL extern void __pmPrintDesc(FILE *, const pmDesc *);
PCP_CALL extern void __pmFreeResultValues(pmResult *);
PCP_CALL extern char *__pmPDUTypeStr_r(int, char *, int);
PCP_CALL extern const char *__pmPDUTypeStr(int); /* NOT thread-safe */
PCP_CALL extern void __pmDumpNameSpace(FILE *, int);
PCP_CALL extern void __pmDumpNameNode(FILE *, __pmnsNode *, int);
PCP_CALL extern void __pmDumpStack(FILE *);
PCP_DATA extern int __pmLogReads;
#ifdef PCP_DEBUG
PCP_CALL extern void __pmDumpIDList(FILE *, int, const pmID *);
PCP_CALL extern void __pmDumpNameList(FILE *, int, char **);
PCP_CALL extern void __pmDumpStatusList(FILE *, int, const int *);
PCP_CALL extern void __pmDumpNameAndStatusList(FILE *, int, char **, int *);
#endif
/*
* Logs and archives of performance metrics (not to be confused
* with diagnostic logs for error messages, etc.)
*
* __pmLogCtl log control
* __pmLogTI temporal index record
*/
/*
* Hashed Data Structures for the Processing of Logs and Archives
*/
typedef struct __pmHashNode {
struct __pmHashNode *next;
unsigned int key;
void *data;
} __pmHashNode;
typedef struct __pmHashCtl {
int nodes;
int hsize;
__pmHashNode **hash;
__pmHashNode *next;
unsigned int index;
} __pmHashCtl;
typedef enum {
PM_HASH_WALK_START = 0,
PM_HASH_WALK_NEXT,
PM_HASH_WALK_STOP,
PM_HASH_WALK_DELETE_NEXT,
PM_HASH_WALK_DELETE_STOP,
} __pmHashWalkState;
PCP_CALL extern void __pmHashInit(__pmHashCtl *);
typedef __pmHashWalkState(*__pmHashWalkCallback)(const __pmHashNode *, void *);
PCP_CALL extern void __pmHashWalkCB(__pmHashWalkCallback, void *, const __pmHashCtl *);
PCP_CALL extern __pmHashNode *__pmHashWalk(__pmHashCtl *, __pmHashWalkState);
PCP_CALL extern __pmHashNode *__pmHashSearch(unsigned int, __pmHashCtl *);
PCP_CALL extern int __pmHashAdd(unsigned int, void *, __pmHashCtl *);
PCP_CALL extern int __pmHashDel(unsigned int, void *, __pmHashCtl *);
PCP_CALL extern void __pmHashClear(__pmHashCtl *);
/*
* External file and internal (below PMAPI) format for an archive label
* Note: int is OK here, because configure ensures int is a 32-bit integer
*/
typedef struct {
int ill_magic; /* PM_LOG_MAGIC | log format version no. */
int ill_pid; /* PID of logger */
__pmTimeval ill_start; /* start of this log */
int ill_vol; /* current log volume no. */
char ill_hostname[PM_LOG_MAXHOSTLEN];/* name of collection host */
char ill_tz[PM_TZ_MAXLEN]; /* $TZ at collection host */
} __pmLogLabel;
/*
* unfortunately, in this version, PCP archives are limited to no
* more than 2 Gbytes ...
*/
typedef __uint32_t __pm_off_t;
/*
* Temporal Index Record
* Note: int is OK here, because configure ensures int is a 32-bit integer
*/
typedef struct {
__pmTimeval ti_stamp; /* now */
int ti_vol; /* current log volume no. */
__pm_off_t ti_meta; /* end of meta data file */
__pm_off_t ti_log; /* end of metrics log file */
} __pmLogTI;
/*
* Log/Archive Control
*/
typedef struct {
int l_refcnt; /* number of contexts using this log */
char *l_name; /* external log base name */
FILE *l_tifp; /* temporal index */
FILE *l_mdfp; /* meta data */
FILE *l_mfp; /* current metrics log */
int l_curvol; /* current metrics log volume no. */
int l_state; /* (when writing) log state */
__pmHashCtl l_hashpmid; /* PMID hashed access */
__pmHashCtl l_hashindom; /* instance domain hashed access */
__pmHashCtl l_hashrange; /* ptr to first and last value in log for */
/* each metric */
int l_minvol; /* (when reading) lowest known volume no. */
int l_maxvol; /* (when reading) highest known volume no. */
int l_numseen; /* (when reading) size of l_seen */
int *l_seen; /* (when reading) volumes opened OK */
__pmLogLabel l_label; /* (when reading) log label */
__pm_off_t l_physend; /* (when reading) offset to physical EOF */
/* for last volume */
__pmTimeval l_endtime; /* (when reading) timestamp at logical EOF */
int l_numti; /* (when reading) no. temporal index entries */
__pmLogTI *l_ti; /* (when reading) temporal index */
__pmnsTree *l_pmns; /* namespace from meta data */
} __pmLogCtl;
/* l_state values */
#define PM_LOG_STATE_NEW 0
#define PM_LOG_STATE_INIT 1
/*
* Return the argument if it's a valid filename else return NULL
* (note: this function could be replaced with a call to access(),
* but is retained for historical reasons).
*/
PCP_CALL extern const char *__pmFindPMDA(const char *);
/*
* Internal instance profile states
*/
#define PM_PROFILE_INCLUDE 0 /* include all, exclude some */
#define PM_PROFILE_EXCLUDE 1 /* exclude all, include some */
/* Profile entry (per instance domain) */
typedef struct __pmInDomProfile {
pmInDom indom; /* instance domain */
int state; /* include all or exclude all */
int instances_len; /* length of instances array */
int *instances; /* array of instances */
} __pmInDomProfile;
/* Instance profile for all domains */
typedef struct __pmProfile {
int state; /* default global state */
int profile_len; /* length of profile array */
__pmInDomProfile *profile; /* array of instance profiles */
} __pmProfile;
/*
* Dump the instance profile, for a particular instance domain
* If indom == PM_INDOM_NULL, then print all instance domains
*/
PCP_CALL extern void __pmDumpProfile(FILE *, int, const __pmProfile *);
/*
* Result structure for instance domain queries
* Only the PMDAs and pmcd need to know about this.
*/
typedef struct __pmInResult {
pmInDom indom; /* instance domain */
int numinst; /* may be 0 */
int *instlist; /* instance ids, may be NULL */
char **namelist; /* instance names, may be NULL */
} __pmInResult;
PCP_CALL extern void __pmDumpInResult(FILE *, const __pmInResult *);
/* instance profile methods */
PCP_CALL extern int __pmProfileSetSent(void);
PCP_CALL extern void __pmFreeProfile(__pmProfile *);
PCP_CALL extern __pmInDomProfile *__pmFindProfile(pmInDom, const __pmProfile *);
PCP_CALL extern int __pmInProfile(pmInDom, const __pmProfile *, int);
PCP_CALL extern void __pmFreeInResult(__pmInResult *);
/*
* Version and capabilities information for PDU exchanges
*/
#define UNKNOWN_VERSION 0
#define PDU_VERSION2 2
#define PDU_VERSION PDU_VERSION2
#define PDU_OVERRIDE2 -1002
typedef struct {
#ifdef HAVE_BITFIELDS_LTOR
unsigned int zero : 1; /* ensure this is zero for 1.x compatibility */
unsigned int version : 7; /* PDU_VERSION collector protocol preference */
unsigned int licensed : 8; /* ensure this is one for 2.x compatibility */
unsigned int features : 16; /* advertised (enabled) collector features */
#else
unsigned int features : 16;
unsigned int licensed : 8;
unsigned int version : 7;
unsigned int zero : 1;
#endif
} __pmPDUInfo;
/*
* Host specification allowing one or more pmproxy host, and port numbers
* within the one string, i.e. pmcd host specifications of the form:
* host:port,port@proxy:port,port
*/
typedef struct {
char *name; /* hostname (always valid) */
int *ports; /* array of host port numbers */
int nports; /* number of ports in host port array */
} pmHostSpec;
PCP_CALL extern int __pmParseHostSpec(const char *, pmHostSpec **, int *, char **);
PCP_CALL extern int __pmUnparseHostSpec(pmHostSpec *, int, char *, size_t);
PCP_CALL extern void __pmFreeHostSpec(pmHostSpec *, int);
typedef enum {
PCP_ATTR_NONE = 0,
PCP_ATTR_PROTOCOL = 1, /* either pcp:/pcps: protocol (libssl) */
PCP_ATTR_SECURE = 2, /* relaxed/enforced pcps mode (libssl) */
PCP_ATTR_COMPRESS = 3, /* compression flag, no value (libnss) */
PCP_ATTR_USERAUTH = 4, /* user auth flag, no value (libsasl) */
PCP_ATTR_USERNAME = 5, /* user login identity (libsasl) */
PCP_ATTR_AUTHNAME = 6, /* authentication name (libsasl) */
PCP_ATTR_PASSWORD = 7, /* passphrase-based secret (libsasl) */
PCP_ATTR_METHOD = 8, /* use authentication method (libsasl) */
PCP_ATTR_REALM = 9, /* realm to authenticate in (libsasl) */
PCP_ATTR_UNIXSOCK = 10, /* AF_UNIX socket + SO_PEERCRED (unix) */
PCP_ATTR_USERID = 11, /* uid - user identifier (posix) */
PCP_ATTR_GROUPID = 12, /* gid - group identifier (posix) */
PCP_ATTR_LOCAL = 13, /* AF_UNIX socket with localhost fallback */
PCP_ATTR_PROCESSID = 14, /* pid - process identifier (posix) */
PCP_ATTR_CONTAINER = 15, /* container name (linux) */
} __pmAttrKey;
PCP_CALL extern __pmAttrKey __pmLookupAttrKey(const char *, size_t);
PCP_CALL extern int __pmAttrKeyStr_r(__pmAttrKey, char *, size_t);
PCP_CALL extern int __pmAttrStr_r(__pmAttrKey, const char *, char *, size_t);
PCP_CALL extern int __pmParseHostAttrsSpec(
const char *, pmHostSpec **, int *, __pmHashCtl *, char **);
PCP_CALL extern int __pmUnparseHostAttrsSpec(
pmHostSpec *, int, __pmHashCtl *, char *, size_t);
PCP_CALL extern void __pmFreeHostAttrsSpec(pmHostSpec *, int, __pmHashCtl *);
PCP_CALL extern void __pmFreeAttrsSpec(__pmHashCtl *);
/*
* Control for connection to a PMCD
*/
typedef struct {
__pmMutex pc_lock; /* mutex pmcd ipc */
int pc_refcnt; /* number of contexts using this socket */
int pc_fd; /* socket for comm with pmcd */
/* ... -1 means no connection */
pmHostSpec *pc_hosts; /* pmcd and proxy host specifications */
int pc_nhosts; /* number of pmHostSpec entries */
int pc_timeout; /* set if connect times out */
int pc_tout_sec; /* timeout for __pmGetPDU */
time_t pc_again; /* time to try again */
} __pmPMCDCtl;
PCP_CALL extern int __pmConnectPMCD(pmHostSpec *, int, int, __pmHashCtl *);
PCP_CALL extern int __pmConnectLocal(__pmHashCtl *);
PCP_CALL extern int __pmAuxConnectPMCD(const char *);
PCP_CALL extern int __pmAuxConnectPMCDPort(const char *, int);
PCP_CALL extern int __pmAuxConnectPMCDUnixSocket(const char *);
PCP_CALL extern int __pmAddHostPorts(pmHostSpec *, int *, int);
PCP_CALL extern void __pmDropHostPort(pmHostSpec *);
PCP_CALL extern void __pmConnectGetPorts(pmHostSpec *);
/*
* SSL/TLS/IPv6 support via NSS/NSPR.
*/
PCP_CALL extern int __pmSecureServerSetup(const char *, const char *);
PCP_CALL extern void __pmSecureServerShutdown(void);
PCP_CALL extern int __pmSecureServerHandshake(int, int, __pmHashCtl *);
PCP_CALL extern int __pmSecureClientHandshake(int, int, const char *, __pmHashCtl *);
typedef fd_set __pmFdSet;
typedef struct __pmSockAddr __pmSockAddr;
typedef struct __pmHostEnt __pmHostEnt;
PCP_CALL extern int __pmCreateSocket(void);
PCP_CALL extern int __pmCreateIPv6Socket(void);
PCP_CALL extern int __pmCreateUnixSocket(void);
PCP_CALL extern void __pmCloseSocket(int);
PCP_CALL extern int __pmSetSockOpt(int, int, int, const void *, __pmSockLen);
PCP_CALL extern int __pmGetSockOpt(int, int, int, void *, __pmSockLen *);
PCP_CALL extern int __pmConnect(int, void *, __pmSockLen);
PCP_CALL extern int __pmBind(int, void *, __pmSockLen);
PCP_CALL extern int __pmListen(int, int);
PCP_CALL extern int __pmAccept(int, void *, __pmSockLen *);
PCP_CALL extern ssize_t __pmWrite(int, const void *, size_t);
PCP_CALL extern ssize_t __pmRead(int, void *, size_t);
PCP_CALL extern ssize_t __pmSend(int, const void *, size_t, int);
PCP_CALL extern ssize_t __pmRecv(int, void *, size_t, int);
PCP_CALL extern int __pmConnectTo(int, const __pmSockAddr *, int);
PCP_CALL extern int __pmConnectCheckError(int);
PCP_CALL extern int __pmConnectRestoreFlags(int, int);
PCP_CALL extern int __pmSocketClosed(void);
PCP_CALL extern int __pmGetFileStatusFlags(int);
PCP_CALL extern int __pmSetFileStatusFlags(int, int);
PCP_CALL extern int __pmGetFileDescriptorFlags(int);
PCP_CALL extern int __pmSetFileDescriptorFlags(int, int);
PCP_CALL extern int __pmFD(int);
PCP_CALL extern void __pmFD_CLR(int, __pmFdSet *);
PCP_CALL extern int __pmFD_ISSET(int, __pmFdSet *);
PCP_CALL extern void __pmFD_SET(int, __pmFdSet *);
PCP_CALL extern void __pmFD_ZERO(__pmFdSet *);
PCP_CALL extern void __pmFD_COPY(__pmFdSet *, const __pmFdSet *);
PCP_CALL extern int __pmSelectRead(int, __pmFdSet *, struct timeval *);
PCP_CALL extern int __pmSelectWrite(int, __pmFdSet *, struct timeval *);
PCP_CALL extern __pmSockAddr *__pmSockAddrAlloc(void);
PCP_CALL extern void __pmSockAddrFree(__pmSockAddr *);
PCP_CALL extern size_t __pmSockAddrSize(void);
PCP_CALL extern void __pmSockAddrInit(__pmSockAddr *, int, int, int);
PCP_CALL extern int __pmSockAddrCompare(const __pmSockAddr *, const __pmSockAddr *);
PCP_CALL extern __pmSockAddr *__pmSockAddrDup(const __pmSockAddr *);
PCP_CALL extern __pmSockAddr *__pmSockAddrMask(__pmSockAddr *, const __pmSockAddr *);
PCP_CALL extern void __pmSockAddrSetFamily(__pmSockAddr *, int);
PCP_CALL extern int __pmSockAddrGetFamily(const __pmSockAddr *);
PCP_CALL extern void __pmSockAddrSetPort(__pmSockAddr *, int);
PCP_CALL extern int __pmSockAddrGetPort(const __pmSockAddr *);
PCP_CALL extern void __pmSockAddrSetScope(__pmSockAddr *, int);
PCP_CALL extern void __pmSockAddrSetPath(__pmSockAddr *, const char *);
PCP_CALL extern int __pmSockAddrIsLoopBack(const __pmSockAddr *);
PCP_CALL extern int __pmSockAddrIsInet(const __pmSockAddr *);
PCP_CALL extern int __pmSockAddrIsIPv6(const __pmSockAddr *);
PCP_CALL extern int __pmSockAddrIsUnix(const __pmSockAddr *);
PCP_CALL extern char * __pmSockAddrToString(const __pmSockAddr *);
PCP_CALL extern __pmSockAddr *__pmStringToSockAddr(const char *);
PCP_CALL extern __pmSockAddr *__pmLoopBackAddress(int);
PCP_CALL extern __pmSockAddr *__pmSockAddrFirstSubnetAddr(const __pmSockAddr *, int);
PCP_CALL extern __pmSockAddr *__pmSockAddrNextSubnetAddr(__pmSockAddr *, int);
PCP_CALL extern __pmHostEnt * __pmHostEntAlloc(void);
PCP_CALL extern void __pmHostEntFree(__pmHostEnt *);
PCP_CALL extern __pmSockAddr *__pmHostEntGetSockAddr(const __pmHostEnt *, void **);
PCP_CALL extern char * __pmHostEntGetName(__pmHostEnt *);
PCP_CALL extern __pmHostEnt * __pmGetAddrInfo(const char *);
PCP_CALL extern char * __pmGetNameInfo(__pmSockAddr *);
/*
* Query server features - used for expressing protocol capabilities
*/
typedef enum {
PM_SERVER_FEATURE_SECURE = 0,
PM_SERVER_FEATURE_COMPRESS,
PM_SERVER_FEATURE_IPV6,
PM_SERVER_FEATURE_AUTH,
PM_SERVER_FEATURE_CREDS_REQD,
PM_SERVER_FEATURE_UNIX_DOMAIN,
PM_SERVER_FEATURE_DISCOVERY,
PM_SERVER_FEATURE_CONTAINERS,
PM_SERVER_FEATURE_LOCAL,
PM_SERVER_FEATURES
} __pmServerFeature;
PCP_CALL extern int __pmServerHasFeature(__pmServerFeature);
PCP_CALL extern int __pmServerSetFeature(__pmServerFeature);
PCP_CALL extern int __pmServerClearFeature(__pmServerFeature);
PCP_CALL extern int __pmServerCreatePIDFile(const char *, int);
PCP_CALL extern int __pmServerAddPorts(const char *);
PCP_CALL extern int __pmServerAddInterface(const char *);
PCP_CALL extern void __pmServerSetLocalSocket(const char *);
PCP_CALL extern int __pmServerSetLocalCreds(int, __pmHashCtl *);
PCP_CALL extern void __pmServerSetServiceSpec(const char *);
typedef void (*__pmServerCallback)(__pmFdSet *, int, int);
PCP_CALL extern void __pmServerAddNewClients(__pmFdSet *, __pmServerCallback);
PCP_CALL extern int __pmServerAddToClientFdSet(__pmFdSet *, int);
PCP_CALL extern int __pmServerOpenRequestPorts(__pmFdSet *, int);
PCP_CALL extern void __pmServerCloseRequestPorts(void);
PCP_CALL extern void __pmServerDumpRequestPorts(FILE *);
PCP_CALL extern char *__pmServerRequestPortString(int, char *, size_t);
/* Service broadcasting, for servers. */
typedef struct __pmServerPresence __pmServerPresence;
PCP_CALL extern __pmServerPresence *__pmServerAdvertisePresence(const char *, int);
PCP_CALL extern void __pmServerUnadvertisePresence(__pmServerPresence *);
/*
* Per-context controls for archives and logs
*/
typedef struct {
__pmLogCtl *ac_log; /* global logging and archive control */
long ac_offset; /* fseek ptr for archives */
int ac_vol; /* volume for ac_offset */
int ac_serial; /* serial access pattern for archives */
__pmHashCtl ac_pmid_hc; /* per PMID controls for INTERP */
double ac_end; /* time at end of archive */
void *ac_want; /* used in interp.c */
void *ac_unbound; /* used in interp.c */
void *ac_cache; /* used in interp.c */
int ac_cache_idx; /* used in interp.c */
} __pmArchCtl;
/*
* PMAPI context. We keep an array of these,
* one for each context created by the application.
*/
typedef struct {
__pmMutex c_lock; /* mutex for multi-thread access */
int c_type; /* HOST, ARCHIVE, LOCAL or FREE */
int c_mode; /* current mode PM_MODE_* */
__pmPMCDCtl *c_pmcd; /* pmcd control for HOST contexts */
__pmArchCtl *c_archctl; /* log control for ARCHIVE contexts */
__pmTimeval c_origin; /* pmFetch time origin / current time */
int c_delta; /* for updating origin */
int c_sent; /* profile has been sent to pmcd */
__pmProfile *c_instprof; /* instance profile */
void *c_dm; /* derived metrics, if any */
int c_flags; /* ctx flags (set via type/env/attrs) */
__pmHashCtl c_attrs; /* various optional context attributes */
} __pmContext;
#define __PM_MODE_MASK 0xffff
#define PM_CONTEXT_FREE -1 /* special type */
/*
* Convert opaque context handle to __pmContext pointer
*/
PCP_CALL extern __pmContext *__pmHandleToPtr(int);
/*
* Dump the current context (source details + instance profile),
* for a particular instance domain.
* If indom == PM_INDOM_NULL, then print all all instance domains
*/
PCP_CALL extern void __pmDumpContext(FILE *, int, pmInDom);
/*
* pmFetch helper routines, hooks for derivations and local contexts.
*/
PCP_CALL extern int __pmPrepareFetch(__pmContext *, int, const pmID *, pmID **);
PCP_CALL extern int __pmFinishResult(__pmContext *, int, pmResult **);
PCP_CALL extern int __pmFetchLocal(__pmContext *, int, pmID *, pmResult **);
/*
* Protocol data unit support
* Note: int is OK here, because configure ensures int is a 32-bit integer
*/
typedef struct {
int len; /* length of pdu_header + PDU */
int type; /* PDU type */
int from; /* pid of PDU originator */
} __pmPDUHdr;
typedef __uint32_t __pmPDU;
/*
* round a size up to the next multiple of a __pmPDU size
*
* PM_PDU_SIZE is in units of __pmPDU size
* PM_PDU_SIZE_BYTES is in units of bytes
*/
#define PM_PDU_SIZE(x) (((x)+sizeof(__pmPDU)-1)/sizeof(__pmPDU))
#define PM_PDU_SIZE_BYTES(x) (sizeof(__pmPDU)*PM_PDU_SIZE(x))
/* Types of credential PDUs (c_type) */
#define CVERSION 0x1
typedef struct {
#ifdef HAVE_BITFIELDS_LTOR
unsigned int c_type: 8; /* Credentials PDU type */
unsigned int c_vala: 8;
unsigned int c_valb: 8;
unsigned int c_valc: 8;
#else
unsigned int c_valc: 8;
unsigned int c_valb: 8;
unsigned int c_vala: 8;
unsigned int c_type: 8;
#endif
} __pmCred;
/* Flags for CVERSION credential PDUs, and __pmPDUInfo features */
#define PDU_FLAG_SECURE (1U<<0)
#define PDU_FLAG_COMPRESS (1U<<1)
#define PDU_FLAG_AUTH (1U<<2)
#define PDU_FLAG_CREDS_REQD (1U<<3)
#define PDU_FLAG_SECURE_ACK (1U<<4)
#define PDU_FLAG_NO_NSS_INIT (1U<<5)
#define PDU_FLAG_CONTAINER (1U<<6)
/* Credential CVERSION PDU elements look like this */
typedef struct {
#ifdef HAVE_BITFIELDS_LTOR
unsigned int c_type: 8; /* Credentials PDU type */
unsigned int c_version: 8; /* PCP protocol version */
unsigned int c_flags: 16; /* All feature requests */
#else
unsigned int c_flags: 16;
unsigned int c_version: 8;
unsigned int c_type: 8;
#endif
} __pmVersionCred;
PCP_CALL extern void __pmIgnoreSignalPIPE(void);
PCP_CALL extern int __pmXmitPDU(int, __pmPDU *);
PCP_CALL extern int __pmGetPDU(int, int, int, __pmPDU **);
PCP_CALL extern int __pmGetPDUCeiling(void);
PCP_CALL extern int __pmSetPDUCeiling(int);
PCP_DATA extern unsigned int *__pmPDUCntIn;
PCP_DATA extern unsigned int *__pmPDUCntOut;
PCP_CALL extern void __pmSetPDUCntBuf(unsigned *, unsigned *);
/* timeout options for PDU handling */
#define TIMEOUT_NEVER 0
#define TIMEOUT_DEFAULT -1
/*#define TIMEOUT_ASYNC -2*/
#define TIMEOUT_CONNECT -3
/* mode options for __pmGetPDU */
#define ANY_SIZE 0 /* replacement for old PDU_BINARY */
#define LIMIT_SIZE 2 /* replacement for old PDU_CLIENT */
PCP_CALL extern __pmPDU *__pmFindPDUBuf(int);
PCP_CALL extern void __pmPinPDUBuf(void *);
PCP_CALL extern int __pmUnpinPDUBuf(void *);
PCP_CALL extern void __pmCountPDUBuf(int, int *, int *);
#define PDU_START 0x7000
#define PDU_ERROR PDU_START
#define PDU_RESULT 0x7001
#define PDU_PROFILE 0x7002
#define PDU_FETCH 0x7003
#define PDU_DESC_REQ 0x7004
#define PDU_DESC 0x7005
#define PDU_INSTANCE_REQ 0x7006
#define PDU_INSTANCE 0x7007
#define PDU_TEXT_REQ 0x7008
#define PDU_TEXT 0x7009
#define PDU_CONTROL_REQ 0x700a
#define PDU_CREDS 0x700c
#define PDU_PMNS_IDS 0x700d
#define PDU_PMNS_NAMES 0x700e
#define PDU_PMNS_CHILD 0x700f
#define PDU_PMNS_TRAVERSE 0x7010
#define PDU_ATTR 0x7011
#define PDU_AUTH PDU_ATTR
#define PDU_FINISH 0x7011
#define PDU_MAX (PDU_FINISH - PDU_START)
/*
* Unit of space allocation for PDU buffer.
*/
#define PDU_CHUNK 1024
/*
* PDU encoding formats
* These have been retired ...
* #define PDU_BINARY 0
* #define PDU_ASCII 1
* And this has been replaced by LIMIT_SIZE for __pmGetPDU
* #define PDU_CLIENT 2
*/
/*
* Anonymous PDU sender, when context does not matter, e.g. PDUs from
* a PMDA sent to PMCD
*/
#define FROM_ANON 0
PCP_CALL extern int __pmSendError(int, int, int);
PCP_CALL extern int __pmDecodeError(__pmPDU *, int *);
PCP_CALL extern int __pmSendXtendError(int, int, int, int);
PCP_CALL extern int __pmDecodeXtendError(__pmPDU *, int *, int *);
PCP_CALL extern int __pmSendResult(int, int, const pmResult *);
PCP_CALL extern int __pmEncodeResult(int, const pmResult *, __pmPDU **);
PCP_CALL extern int __pmDecodeResult(__pmPDU *, pmResult **);
PCP_CALL extern int __pmSendProfile(int, int, int, __pmProfile *);
PCP_CALL extern int __pmDecodeProfile(__pmPDU *, int *, __pmProfile **);
PCP_CALL extern int __pmSendFetch(int, int, int, __pmTimeval *, int, pmID *);
PCP_CALL extern int __pmDecodeFetch(__pmPDU *, int *, __pmTimeval *, int *, pmID **);
PCP_CALL extern int __pmSendDescReq(int, int, pmID);
PCP_CALL extern int __pmDecodeDescReq(__pmPDU *, pmID *);
PCP_CALL extern int __pmSendDesc(int, int, pmDesc *);
PCP_CALL extern int __pmDecodeDesc(__pmPDU *, pmDesc *);
PCP_CALL extern int __pmSendInstanceReq(int, int, const __pmTimeval *, pmInDom, int, const char *);
PCP_CALL extern int __pmDecodeInstanceReq(__pmPDU *, __pmTimeval *, pmInDom *, int *, char **);
PCP_CALL extern int __pmSendInstance(int, int, __pmInResult *);
PCP_CALL extern int __pmDecodeInstance(__pmPDU *, __pmInResult **);
PCP_CALL extern int __pmSendTextReq(int, int, int, int);
PCP_CALL extern int __pmDecodeTextReq(__pmPDU *, int *, int *);
PCP_CALL extern int __pmSendText(int, int, int, const char *);
PCP_CALL extern int __pmDecodeText(__pmPDU *, int *, char **);
PCP_CALL extern int __pmSendCreds(int, int, int, const __pmCred *);
PCP_CALL extern int __pmDecodeCreds(__pmPDU *, int *, int *, __pmCred **);
PCP_CALL extern int __pmSendIDList(int, int, int, const pmID *, int);
PCP_CALL extern int __pmDecodeIDList(__pmPDU *, int, pmID *, int *);
PCP_CALL extern int __pmSendNameList(int, int, int, char **, const int *);
PCP_CALL extern int __pmDecodeNameList(__pmPDU *, int *, char ***, int **);
PCP_CALL extern int __pmSendChildReq(int, int, const char *, int);
PCP_CALL extern int __pmDecodeChildReq(__pmPDU *, char **, int *);
PCP_CALL extern int __pmSendTraversePMNSReq(int, int, const char *);
PCP_CALL extern int __pmDecodeTraversePMNSReq(__pmPDU *, char **);
PCP_CALL extern int __pmSendAuth(int, int, int, const char *, int);
PCP_CALL extern int __pmDecodeAuth(__pmPDU *, int *, char **, int *);
PCP_CALL extern int __pmSendAttr(int, int, int, const char *, int);
PCP_CALL extern int __pmDecodeAttr(__pmPDU *, int *, char **, int *);
#if defined(HAVE_64BIT_LONG)
/*
* A pmValue contains the union of a 32-bit int and a pointer. In the world
* of 64-bit pointers, a pmValue is therefore larger than in the 32-bit world.
* The structures below are used in all PDUs containing pmResults to ensure
* 32-bit and 64-bit programs exchanging PDUs can communicate.
* Note that a pmValue can only hold a 32-bit value in situ regardless of
* whether the pointer size is 32 or 64 bits.
*/
typedef struct {
int inst; /* instance identifier */
union {
unsigned int pval; /* offset into PDU buffer for value */
int lval; /* 32-bit value in situ */
} value;
} __pmValue_PDU;
typedef struct {
pmID pmid; /* metric identifier */
int numval; /* number of values */
int valfmt; /* value style */
__pmValue_PDU vlist[1]; /* set of instances/values */
} __pmValueSet_PDU;
#elif defined(HAVE_32BIT_LONG)
/* In the 32-bit world, structures may be used in PDUs as defined */
typedef pmValue __pmValue_PDU;
typedef pmValueSet __pmValueSet_PDU;
#else
bozo - unknown size of long !!!
#endif
/*
* For the help text PDUs, the type (PM_TEXT_ONELINE or PM_TEXT_HELP)
* is 'or'd with the following to encode the request for a PMID or
* a pmInDom ...
* Note the values must therefore be (a) bit fields and (b) different
* to the public macros PM_TEXT_* in pmapi.h
*/
#define PM_TEXT_PMID 4
#define PM_TEXT_INDOM 8
/*
* no mem today, my love has gone away ....
*/
PCP_CALL extern void __pmNoMem(const char *, size_t, int);
#define PM_FATAL_ERR 1
#define PM_RECOV_ERR 0
/*
* Startup handling:
* set program name, as used in __pmNotifyErr() ... default is "pcp"
* set default user for __pmSetProcessIdentity() ... default is "pcp"
*/
PCP_DATA extern char *pmProgname;
PCP_CALL extern int __pmSetProgname(const char *);
PCP_CALL extern int __pmGetUsername(char **);
/*
* Cleanup handling:
* shutdown various components in libpcp, releasing all resources
* (local context PMDAs, any global NSS socket state, etc).
*/
PCP_CALL extern int __pmShutdown(void);
/*
* Map platform error values to PMAPI error codes.
*/
PCP_CALL extern int __pmMapErrno(int);
PCP_CALL extern void __pmDumpErrTab(FILE *);
/*
* __pmLogInDom is used to hold the instance identifiers for an instance
* domain internally ... if multiple sets are observed over time, these
* are linked together in reverse chronological order
* -- externally we write these as
* timestamp
* indom <- note, added wrt indom_t
* numinst
* inst[0], .... inst[numinst-1]
* nameindex[0] .... nameindex[numinst-1]
* string (name) table, all null-byte terminated
*
* NOTE: 3 types of allocation
* (1)
* buf is NULL,
* namelist and instlist have been allocated
* separately and so must each be freed.
* (2)
* buf is NOT NULL, allinbuf == 1,
* all allocations were in the buffer and so only
* the buffer should be freed,
* (3)
* buf is NOT NULL, allinbuf == 0,
* as well as buffer allocation,
* the namelist has been allocated separately and so
* both the buf and namelist should be freed.
*/
typedef struct _indom_t {
struct _indom_t *next;
__pmTimeval stamp;
int numinst;
int *instlist;
char **namelist;
int *buf;
int allinbuf;
} __pmLogInDom;
/*
* record header in the metadata log file ... len (by itself) also is
* used as a trailer
*/
typedef struct {
int len; /* record length, includes header and trailer */
int type; /* see TYPE_* #defines below */
} __pmLogHdr;
#define TYPE_DESC 1 /* header, pmDesc, trailer */
#define TYPE_INDOM 2 /* header, __pmLogInDom, trailer */
PCP_CALL extern void __pmLogPutIndex(const __pmLogCtl *, const __pmTimeval *);
PCP_CALL extern const char *__pmLogName_r(const char *, int, char *, int);
PCP_CALL extern const char *__pmLogName(const char *, int); /* NOT thread-safe */
PCP_CALL extern FILE *__pmLogNewFile(const char *, int);
PCP_CALL extern int __pmLogCreate(const char *, const char *, int, __pmLogCtl *);
#define PMLOGREAD_NEXT 0
#define PMLOGREAD_TO_EOF 1
PCP_CALL extern int __pmLogRead(__pmLogCtl *, int, FILE *, pmResult **, int);
PCP_CALL extern int __pmLogWriteLabel(FILE *, const __pmLogLabel *);
PCP_CALL extern int __pmLogOpen(const char *, __pmContext *);
PCP_CALL extern int __pmLogLoadLabel(__pmLogCtl *, const char *);
PCP_CALL extern int __pmLogLoadIndex(__pmLogCtl *);
PCP_CALL extern int __pmLogLoadMeta(__pmLogCtl *);
PCP_CALL extern void __pmLogClose(__pmLogCtl *);
PCP_CALL extern void __pmLogCacheClear(FILE *);
PCP_CALL extern int __pmLogPutDesc(__pmLogCtl *, const pmDesc *, int, char **);
PCP_CALL extern int __pmLogLookupDesc(__pmLogCtl *, pmID, pmDesc *);
PCP_CALL extern int __pmLogPutInDom(__pmLogCtl *, pmInDom, const __pmTimeval *, int, int *, char **);
PCP_CALL extern int __pmLogGetInDom(__pmLogCtl *, pmInDom, __pmTimeval *, int **, char ***);
PCP_CALL extern int __pmLogLookupInDom(__pmLogCtl *, pmInDom, __pmTimeval *, const char *);
PCP_CALL extern int __pmLogNameInDom(__pmLogCtl *, pmInDom, __pmTimeval *, int, char **);
PCP_CALL extern int __pmLogPutResult(__pmLogCtl *, __pmPDU *);
PCP_CALL extern int __pmLogPutResult2(__pmLogCtl *, __pmPDU *);
PCP_CALL extern int __pmLogFetch(__pmContext *, int, pmID *, pmResult **);
PCP_CALL extern int __pmLogFetchInterp(__pmContext *, int, pmID *, pmResult **);
PCP_CALL extern void __pmLogSetTime(__pmContext *);
PCP_CALL extern void __pmLogResetInterp(__pmContext *);
PCP_CALL extern void __pmFreeInterpData(__pmContext *);
PCP_CALL extern int __pmLogChangeVol(__pmLogCtl *, int);
PCP_CALL extern int __pmLogChkLabel(__pmLogCtl *, FILE *, __pmLogLabel *, int);
PCP_CALL extern int __pmGetArchiveEnd(__pmLogCtl *, struct timeval *);
/* struct for maintaining information about pmlogger ports */
typedef struct {
int pid; /* process id of logger */
int port; /* internet port for logger control */
char *pmcd_host; /* host pmlogger is collecting from */
char *archive; /* archive base pathname */
char *name; /* file name (minus dirname) */
} __pmLogPort;
/* Returns control port info for a pmlogger given its pid.
* If pid == PM_LOG_ALL_PIDS, get all pmloggers' control ports.
* If pid == PM_LOG_PRIMARY_PID, get primar logger's control port.
* Note: do NOT free any part of result returned via the parameter.
*
* __pmLogFindPort(const char *hostname, int pid, __pmLogPort **result);
*/
PCP_CALL extern int __pmLogFindPort(const char *, int, __pmLogPort **);
#define PM_LOG_PRIMARY_PID 0 /* symbolic pid for primary logger */
#define PM_LOG_PRIMARY_PORT 0 /* symbolic port for primary pmlogger */
#define PM_LOG_ALL_PIDS -1 /* symbolic pid for all pmloggers */
#define PM_LOG_NO_PID -2 /* not a valid pid for pmlogger */
#define PM_LOG_NO_PORT -2 /* not a valid port for pmlogger */
PCP_CALL extern const char *__pmLogLocalSocketDefault(int, char *buf, size_t bufSize);
PCP_CALL extern const char *__pmLogLocalSocketUser(int, char *buf, size_t bufSize);
/* time utils */
PCP_CALL extern time_t __pmMktime(struct tm *);
/* reverse ctime and time interval parsing */
PCP_CALL extern int __pmParseCtime(const char *, struct tm *, char **);
PCP_CALL extern int __pmConvertTime(struct tm *, struct timeval *, struct timeval *);
PCP_CALL extern int __pmParseTime(const char *, struct timeval *, struct timeval *,
struct timeval *, char **);
/* manipulate internal timestamps */
PCP_CALL extern double __pmTimevalSub(const __pmTimeval *, const __pmTimeval *);
/* 32-bit file checksum */
PCP_CALL extern __int32_t __pmCheckSum(FILE *);
/* check for localhost */
PCP_CALL extern int __pmIsLocalhost(const char *);
/*
* struct timeval manipulations
*/
PCP_CALL extern double __pmtimevalAdd(const struct timeval *, const struct timeval *);
PCP_CALL extern void __pmtimevalInc(struct timeval *, const struct timeval *);
PCP_CALL extern double __pmtimevalSub(const struct timeval *, const struct timeval *);
PCP_CALL extern void __pmtimevalDec(struct timeval *, const struct timeval *);
PCP_CALL extern double __pmtimevalToReal(const struct timeval *);
PCP_CALL extern void __pmtimevalFromReal(double, struct timeval *);
PCP_CALL extern void __pmtimevalSleep(struct timeval);
PCP_CALL extern void __pmtimevalPause(struct timeval);
PCP_CALL extern void __pmtimevalNow(struct timeval *);
typedef struct {
char *label; /* label to name tz */
char *tz; /* env $TZ */
int handle; /* handle from pmNewZone() */
} pmTimeZone;
/*
* event tracing for monitoring time between events
*/
PCP_CALL extern void __pmEventTrace(const char *); /* NOT thread-safe */
PCP_CALL extern void __pmEventTrace_r(const char *, int *, double *, double *);
/*
* More IPC protocol stuff
*/
typedef int (*__pmConnectHostType)(int, int);
PCP_CALL extern int __pmSetSocketIPC(int);
PCP_CALL extern int __pmSetVersionIPC(int, int);
PCP_CALL extern int __pmSetDataIPC(int, void *);
PCP_CALL extern int __pmDataIPCSize(void);
PCP_CALL extern int __pmLastVersionIPC(void);
PCP_CALL extern int __pmVersionIPC(int);
PCP_CALL extern int __pmSocketIPC(int);
PCP_CALL extern int __pmDataIPC(int, void *);
PCP_CALL extern void __pmOverrideLastFd(int);
PCP_CALL extern void __pmPrintIPC(void);
PCP_CALL extern void __pmResetIPC(int);
/* safely insert an atom value into a pmValue */
PCP_CALL extern int __pmStuffValue(const pmAtomValue *, pmValue *, int);
/*
* Optimized fetch bundling ("optfetch") services
*/
typedef struct __optreq {
struct __optreq *r_next; /* next request */
struct __fetchctl *r_fetch; /* back ptr */
pmDesc *r_desc; /* pmDesc for request pmID */
int r_numinst; /* request instances */
int *r_instlist; /* request instances */
void *r_aux; /* generic pointer to aux data */
} optreq_t;
typedef struct __pmidctl {
struct __pmidctl *p_next; /* next pmid control */
optreq_t *p_rqp; /* first request for this metric */
pmID p_pmid; /* my pmID */
int p_numinst; /* union over requests */
int *p_instlist; /* union over requests */
void *p_aux; /* generic pointer to aux data */
} pmidctl_t;
typedef struct __indomctl {
struct __indomctl *i_next; /* next indom control */
pmidctl_t *i_pmp; /* first metric, in this group */
pmInDom i_indom; /* my pmInDom */
int i_numinst; /* arg for pmAddProfile */
int *i_instlist; /* arg for pmAddProfile */
void *i_aux; /* generic pointer to aux data */
} indomctl_t;
typedef struct __fetchctl {
struct __fetchctl *f_next; /* next fetch control */
indomctl_t *f_idp; /* first indom, in this group */
int f_state; /* state changes during updates */
int f_cost; /* used internally for optimization */
int f_newcost; /* used internally for optimization */
int f_numpmid; /* arg for pmFetch() */
pmID *f_pmidlist; /* arg for pmFetch() */
void *f_aux; /* generic pointer to aux data */
} fetchctl_t;
/* states relevant to user */
#define OPT_STATE_NEW 1 /* newly created group */
#define OPT_STATE_PMID 2 /* list of pmids changed */
#define OPT_STATE_PROFILE 4 /* instance profile changed */
/* states used during optimization */
#define OPT_STATE_UMASK 7 /* preserve user state bits */
#define OPT_STATE_XREQ 8 /* things that may have changed */
#define OPT_STATE_XPMID 16
#define OPT_STATE_XINDOM 32
#define OPT_STATE_XFETCH 64
#define OPT_STATE_XPROFILE 128
/*
* Objective function parameters
*/
typedef struct {
int c_pmid; /* cost per PMD for PMIDs in a fetch */
int c_indom; /* cost per PMD for indoms in a fetch */
int c_fetch; /* cost of a new fetch group */
int c_indomsize; /* expected numer of instances for an indom */
int c_xtrainst; /* cost of retrieving an unwanted metric inst */
int c_scope; /* cost opt., 0 for incremental, 1 for global */
} optcost_t;
#define OPT_COST_INFINITY 0x7fffffff
PCP_CALL extern void __pmOptFetchAdd(fetchctl_t **, optreq_t *);
PCP_CALL extern int __pmOptFetchDel(fetchctl_t **, optreq_t *);
PCP_CALL extern void __pmOptFetchRedo(fetchctl_t **);
PCP_CALL extern void __pmOptFetchDump(FILE *, const fetchctl_t *);
PCP_CALL extern void __pmOptFetchGetParams(optcost_t *);
PCP_CALL extern void __pmOptFetchPutParams(optcost_t *);
/* work out local timezone */
PCP_CALL extern char *__pmTimezone(void); /* NOT thread-safe */
PCP_CALL extern char *__pmTimezone_r(char *, int);
/*
* Generic access control routines
*/
PCP_CALL extern int __pmAccAddOp(unsigned int);
PCP_CALL extern int __pmAccAddHost(const char *, unsigned int, unsigned int, int);
PCP_CALL extern int __pmAccAddUser(const char *, unsigned int, unsigned int, int);
PCP_CALL extern int __pmAccAddGroup(const char *, unsigned int, unsigned int, int);
PCP_CALL extern int __pmAccAddClient(__pmSockAddr *, unsigned int *);
PCP_CALL extern int __pmAccAddAccount(const char *, const char *, unsigned int *);
PCP_CALL extern void __pmAccDelClient(__pmSockAddr *);
PCP_CALL extern void __pmAccDelAccount(const char *, const char *);
PCP_CALL extern void __pmAccDumpHosts(FILE *);
PCP_CALL extern void __pmAccDumpUsers(FILE *);
PCP_CALL extern void __pmAccDumpGroups(FILE *);
PCP_CALL extern void __pmAccDumpLists(FILE *);
PCP_CALL extern int __pmAccSaveHosts(void);
PCP_CALL extern int __pmAccSaveUsers(void);
PCP_CALL extern int __pmAccSaveGroups(void);
PCP_CALL extern int __pmAccSaveLists(void);
PCP_CALL extern int __pmAccRestoreHosts(void);
PCP_CALL extern int __pmAccRestoreUsers(void);
PCP_CALL extern int __pmAccRestoreGroups(void);
PCP_CALL extern int __pmAccRestoreLists(void);
PCP_CALL extern void __pmAccFreeSavedHosts(void);
PCP_CALL extern void __pmAccFreeSavedUsers(void);
PCP_CALL extern void __pmAccFreeSavedGroups(void);
PCP_CALL extern void __pmAccFreeSavedLists(void);
/*
* platform independent process routines
*/
PCP_CALL extern int __pmProcessExists(pid_t);
PCP_CALL extern int __pmProcessTerminate(pid_t, int);
PCP_CALL extern pid_t __pmProcessCreate(char **, int *, int *);
PCP_CALL extern int __pmProcessDataSize(unsigned long *);
PCP_CALL extern int __pmProcessRunTimes(double *, double *);
PCP_CALL extern int __pmSetProcessIdentity(const char *);
/*
* platform independent memory mapped file handling
*/
PCP_CALL extern void *__pmMemoryMap(int, size_t, int);
PCP_CALL extern void __pmMemoryUnmap(void *, size_t);
/*
* platform independent signal handling
*/
typedef void (*__pmSignalHandler)(int);
PCP_CALL extern int __pmSetSignalHandler(int, __pmSignalHandler);
/*
* platform independent environment and filesystem path access
*/
typedef void (*__pmConfigCallback)(char *, char *, char *);
PCP_DATA extern const __pmConfigCallback __pmNativeConfig;
PCP_CALL extern void __pmConfig(__pmConfigCallback);
PCP_CALL extern char *__pmNativePath(char *);
PCP_CALL extern int __pmAbsolutePath(char *);
PCP_CALL extern int __pmPathSeparator(void);
PCP_CALL extern int __pmMakePath(const char *, mode_t);
/*
* discover configurable features of the shared libraries
*/
typedef void (*__pmAPIConfigCallback)(const char *, const char *);
PCP_CALL extern void __pmAPIConfig(__pmAPIConfigCallback);
PCP_CALL extern const char *__pmGetAPIConfig(const char *);
/*
* internals of argument parsing for special circumstances
*/
PCP_CALL extern void __pmStartOptions(pmOptions *);
PCP_CALL extern void __pmAddOptArchive(pmOptions *, char *);
PCP_CALL extern void __pmAddOptArchiveList(pmOptions *, char *);
PCP_CALL extern void __pmAddOptArchiveFolio(pmOptions *, char *);
PCP_CALL extern void __pmAddOptHost(pmOptions *, char *);
PCP_CALL extern void __pmAddOptHostList(pmOptions *, char *);
PCP_CALL extern void __pmEndOptions(pmOptions *);
/*
* AF - general purpose asynchronous event management routines
*/
PCP_CALL extern int __pmAFsetup(const struct timeval *, const struct timeval *, void *, void (*)(int, void *));
PCP_CALL extern int __pmAFregister(const struct timeval *, void *, void (*)(int, void *));
PCP_CALL extern int __pmAFunregister(int);
PCP_CALL extern void __pmAFblock(void);
PCP_CALL extern void __pmAFunblock(void);
PCP_CALL extern int __pmAFisempty(void);
/*
* private PDU protocol between pmlc and pmlogger
*/
#define LOG_PDU_VERSION2 2 /* private pdus & PCP 2.0 error codes */
#define LOG_PDU_VERSION LOG_PDU_VERSION2
#define LOG_REQUEST_NEWVOLUME 1
#define LOG_REQUEST_STATUS 2
#define LOG_REQUEST_SYNC 3
typedef struct {
__pmTimeval ls_start; /* start time for log */
__pmTimeval ls_last; /* last time log written */
__pmTimeval ls_timenow; /* current time */
int ls_state; /* state of log (from __pmLogCtl) */
int ls_vol; /* current volume number of log */
__int64_t ls_size; /* size of current volume */
char ls_hostname[PM_LOG_MAXHOSTLEN];
/* name of pmcd host */
char ls_fqdn[PM_LOG_MAXHOSTLEN];
/* fully qualified domain name of pmcd host */
char ls_tz[PM_TZ_MAXLEN];
/* $TZ at collection host */
char ls_tzlogger[PM_TZ_MAXLEN];
/* $TZ at pmlogger */
} __pmLoggerStatus;
#define PDU_LOG_CONTROL 0x8000
#define PDU_LOG_STATUS 0x8001
#define PDU_LOG_REQUEST 0x8002
PCP_CALL extern int __pmConnectLogger(const char *, int *, int *);
PCP_CALL extern int __pmSendLogControl(int, const pmResult *, int, int, int);
PCP_CALL extern int __pmDecodeLogControl(const __pmPDU *, pmResult **, int *, int *, int *);
PCP_CALL extern int __pmSendLogRequest(int, int);
PCP_CALL extern int __pmDecodeLogRequest(const __pmPDU *, int *);
PCP_CALL extern int __pmSendLogStatus(int, __pmLoggerStatus *);
PCP_CALL extern int __pmDecodeLogStatus(__pmPDU *, __pmLoggerStatus **);
/* logger timeout helper function */
PCP_CALL extern int __pmLoggerTimeout(void);
/*
* other interfaces shared by pmlc and pmlogger
*/
PCP_CALL extern int __pmControlLog(int, const pmResult *, int, int, int, pmResult **);
#define PM_LOG_OFF 0 /* state */
#define PM_LOG_MAYBE 1
#define PM_LOG_ON 2
#define PM_LOG_MANDATORY 11 /* control */
#define PM_LOG_ADVISORY 12
#define PM_LOG_ENQUIRE 13
/* macros for logging control values from __pmControlLog() */
#define PMLC_SET_ON(val, flag) \
(val) = ((val) & ~0x1) | ((flag) & 0x1)
#define PMLC_GET_ON(val) \
((val) & 0x1)
#define PMLC_SET_MAND(val, flag) \
(val) = ((val) & ~0x2) | (((flag) & 0x1) << 1)
#define PMLC_GET_MAND(val) \
(((val) & 0x2) >> 1)
#define PMLC_SET_AVAIL(val, flag) \
(val) = ((val) & ~0x4) | (((flag) & 0x1) << 2)
#define PMLC_GET_AVAIL(val) \
(((val) & 0x4) >> 2)
#define PMLC_SET_INLOG(val, flag) \
(val) = ((val) & ~0x8) | (((flag) & 0x1) << 3)
#define PMLC_GET_INLOG(val) \
(((val) & 0x8) >> 3)
#define PMLC_SET_STATE(val, state) \
(val) = ((val) & ~0xf) | ((state) & 0xf)
#define PMLC_GET_STATE(val) \
((val) & 0xf)
/* 28 bits of delta, 32 bits of state */
#define PMLC_MAX_DELTA 0x0fffffff
#define PMLC_SET_DELTA(val, delta) \
(val) = ((val) & 0xf) | ((delta) << 4)
#define PMLC_GET_DELTA(val) \
((((val) & ~0xf) >> 4) & PMLC_MAX_DELTA)
/*
* helper functions to register client identity with pmcd for export
* via pmcd.client.whoami
*/
PCP_CALL extern char *__pmGetClientId(int, char **);
PCP_CALL extern int __pmSetClientIdArgv(int, char **);
PCP_CALL extern int __pmSetClientId(const char *);
/*
* Adding/deleting/clearing the list of DSO PMDAs supported for
* PM_CONTEXT_LOCAL contexts
*/
#define PM_LOCAL_ADD 1
#define PM_LOCAL_DEL 2
#define PM_LOCAL_CLEAR 3
PCP_CALL extern int __pmLocalPMDA(int, int, const char *, const char *);
PCP_CALL extern char *__pmSpecLocalPMDA(const char *);
struct __pmDSO;
PCP_CALL extern struct __pmDSO *__pmLookupDSO(int);
/*
* Helper methods for packed arrays of event records
*/
PCP_CALL extern int __pmCheckEventRecords(pmValueSet *, int);
PCP_CALL extern int __pmCheckHighResEventRecords(pmValueSet *, int);
PCP_CALL extern void __pmDumpEventRecords(FILE *, pmValueSet *, int);
PCP_CALL extern void __pmDumpHighResEventRecords(FILE *, pmValueSet *, int);
/* Get nanosecond precision timestamp from system clocks */
PCP_CALL extern int __pmGetTimespec(struct timespec *);
/* Anonymous metric registration (uses derived metrics support) */
PCP_CALL extern int __pmRegisterAnon(const char *, int);
/*
* Multi-thread support
* Use PM_MULTI_THREAD_DEBUG for lock debugging with -Dlock[,appl?...]
*/
PCP_CALL extern void __pmInitLocks(void);
PCP_CALL extern int __pmLock(void *, const char *, int);
PCP_CALL extern int __pmUnlock(void *, const char *, int);
/*
* Each of these scopes defines one or more PMAPI routines that will
* not allow calls from more than one thread.
*/
#define PM_SCOPE_DSO_PMDA 0
#define PM_SCOPE_ACL 1
#define PM_SCOPE_AF 2
#define PM_SCOPE_LOGPORT 3
#define PM_SCOPE_MAX 3
PCP_CALL extern int __pmMultiThreaded(int);
#define PM_INIT_LOCKS() __pmInitLocks()
#define PM_MULTIPLE_THREADS(x) __pmMultiThreaded(x)
#define PM_LOCK(lock) __pmLock(&(lock), __FILE__, __LINE__)
#define PM_UNLOCK(lock) __pmUnlock(&(lock), __FILE__, __LINE__)
#ifdef HAVE_PTHREAD_MUTEX_T
PCP_CALL extern pthread_mutex_t __pmLock_libpcp; /* big libpcp lock */
#else
PCP_CALL extern void *__pmLock_libpcp; /* symbol exposure */
#endif
/*
* Service discovery with options.
* The 4th argument is a pointer to a mask of flags for boolean options
* and status. It is set and tested using the following bits.
*/
#define PM_SERVICE_DISCOVERY_INTERRUPTED 0x1
#define PM_SERVICE_DISCOVERY_RESOLVE 0x2
PCP_CALL extern int __pmDiscoverServicesWithOptions(const char *,
const char *,
const char *,
const volatile sig_atomic_t *,
char ***);
#ifdef __cplusplus
}
#endif
#endif /* PCP_IMPL_H */
|