qclib-1.1.0/0000755000200300017500000000000012650354047011625 5ustar rasplrasplqclib-1.1.0/query_capacity_hypfs.c0000644000200300017500000006312612650354047016234 0ustar rasplraspl/* Copyright IBM Corp. 2013, 2015 */ #define _GNU_SOURCE #define _BSD_SOURCE #include #include #include #include #include #include #include #include "query_capacity_int.h" #include "query_capacity_data.h" #define QC_HYPFS_LPAR "/s390_hypfs/diag_204" #define QC_HYPFS_ZVM "/s390_hypfs/diag_2fc" #define QC_NAME_LEN 8 #define QC_CPU_TYPE_CP 0 #define QC_CPU_TYPE_AP 2 #define QC_CPU_TYPE_IFL 3 #define QC_CPU_TYPE_IIP 5 #define HYPFS_NA 0 #define HYPFS_AVAIL_ASCII_LPAR 1 #define HYPFS_AVAIL_ASCII_ZVM 2 #define HYPFS_AVAIL_BIN_LPAR 3 #define HYPFS_AVAIL_BIN_ZVM 4 struct dfs_diag_hdr { __u64 len; __u16 version; __u8 tod_ext[16]; __u64 count; __u8 reserved[30]; } __attribute__ ((packed)); struct dfs_info_blk_hdr { __u8 npar; __u8 flags; __u8 reserved1[6]; __u64 curtod1; __u64 curtod2; __u8 reserved[40]; } __attribute__ ((packed)); struct dfs_sys_hdr { __u8 reserved1; __u8 cpus; __u8 rcpus; __u8 reserved2[5]; char sys_name[8]; __u8 reserved3[80]; } __attribute__ ((packed)); struct dfs_cpu_info { __u16 cpu_addr; __u8 reserved1[2]; __u8 ctidx; __u8 reserved2[3]; __u64 acc_time; __u64 lp_time; __u8 reserved3[6]; __u8 reserved4[2]; __u64 online_time; __u8 reserved5[56]; } __attribute__ ((packed)); struct dfs_diag2fc { __u32 version; __u32 flags; __u64 used_cpu; __u64 el_time; __u64 mem_min_kb; __u64 mem_max_kb; __u64 mem_share_kb; __u64 mem_used_kb; __u32 pcpus; __u32 lcpus; __u32 vcpus; __u32 ocpus; __u32 cpu_max; __u32 cpu_shares; __u32 cpu_use_samp; __u32 cpu_delay_samp; __u32 page_wait_samp; __u32 idle_samp; __u32 other_samp; __u32 total_samp; char guest_name[QC_NAME_LEN]; } __attribute__ ((packed)); struct hypfs_priv { char *data; int avail; ssize_t len; char *diag; char *hypfs; }; // Returns a malloc'd string with the concatenated path static char *qc_get_path(struct qc_handle *hdl, const char *dbgfs, const char *file) { char *buf; if (asprintf(&buf, "%s%s", dbgfs, file) == -1) { qc_debug(hdl, "Error: Buffer allocation failed\n"); buf = NULL; } return buf; } static void qc_dump_hypfs(struct qc_handle *hdl, char *hypfs) { char *cmd; int rc; qc_debug_indent_inc(); /* dumping textual hypfs this way and a lot later than the actual parse can give us different data from what we parsed before - but that is the best that we can do */ if (!hypfs) { qc_debug(hdl, "Error: Failed to dump textual hypfs as hypfs==NULL\n"); qc_mark_dump_incomplete(hdl, "hypfs textual"); qc_debug_indent_dec(); return; } /* We read all files individually during regular processing, so we can do now is to copy the content with 'cp -r' */ if (asprintf(&cmd, "cp -r %s/hyp %s/cpus %s/systems %s > /dev/null 2>&1", hypfs, hypfs, hypfs, qc_dbg_dump_dir) == -1) { qc_debug(hdl, "Error: Mem alloc failure, cannot dump textual hypfs\n"); qc_mark_dump_incomplete(hdl, "hypfs textual"); qc_debug_indent_dec(); return; } if ((rc = system(cmd)) == 0) { qc_debug(hdl, "hypfs (textual) dumped to '%s'\n", qc_dbg_dump_dir); } else { qc_debug(hdl, "Error: Failed to dump textual hypfs with command '%s', rc=%d\n", cmd, rc); qc_mark_dump_incomplete(hdl, "hypfs textual"); } free(cmd); qc_debug_indent_dec(); return; } static void qc_dump_hypfs_bin(struct qc_handle *hdl, const char *diag, __u8 *data, ssize_t len) { char *fname = NULL, *cmd; int fd, rc, success = 0; /* We re-create the same directory/file structure that we read from */ // first off, create a subdirectory so the files look exactly like on dbgfs if (!data) { qc_debug(hdl, "Error: No data passed in, cannot write binary dump\n"); goto out; } if (asprintf(&fname, "%s/s390_hypfs", qc_dbg_dump_dir) == -1) { qc_debug(hdl, "Error: Mem alloc error, cannot create dump dir\n"); goto out; } mkdir(fname, S_IRWXU); // we don't care about a failure - could exist from a previous dump, // and we'll know when we store the actual data if things are good free(fname); if (asprintf(&fname, "%s/%s", qc_dbg_dump_dir, strcmp(diag, QC_HYPFS_LPAR) ? QC_HYPFS_ZVM : QC_HYPFS_LPAR) == -1) { qc_debug(hdl, "Error: Mem alloc error, cannot write dump\n"); goto out; } fd = open(fname, O_WRONLY | O_CREAT, S_IRUSR | S_IWUSR); if (fd == -1) { qc_debug(hdl, "Error: Failed to open file '%s' to write dump\n", fname); goto out; } rc = write(fd, data, len); close(fd); if (rc == -1) { qc_debug(hdl, "Error: Failed to write binary hypfs data into dump: %s\n", strerror(errno)); } else { qc_debug(hdl, "hypfs binary data dumped to '%s'\n", fname); success = 1; } if (strcmp(diag, QC_HYPFS_ZVM) == 0) { // if we're on z/VM, we need to make sure that the LPAR file exists, as logic // uses it as a flag to indicate presence of the binary hypfs API if (asprintf(&cmd, "touch %s/%s > /dev/null 2>&1", qc_dbg_dump_dir, QC_HYPFS_LPAR) == -1) { qc_debug(hdl, "Error: Mem alloc failure, could not touch '%s'. " "Dump will not work without, fix by adding it manually later on.\n", QC_HYPFS_LPAR); qc_mark_dump_incomplete(hdl, QC_HYPFS_LPAR); goto out; } if ((rc = system(cmd)) != 0) { qc_debug(hdl, "Error: Command '%s' failed, rc=%d. Dump will not work " "without, fix by adding it manually later on.\n", cmd, rc); qc_mark_dump_incomplete(hdl, QC_HYPFS_LPAR); } free(cmd); } out: free(fname); if (!success) qc_mark_dump_incomplete(hdl, "hypfs binary"); } static void qc_hypfs_dump(struct qc_handle *hdl, char *buf) { struct hypfs_priv *priv = (struct hypfs_priv *)buf; qc_debug(hdl, "Dump hypfs\n"); qc_debug_indent_inc(); if (!priv) goto out; switch(priv->avail) { case HYPFS_AVAIL_ASCII_LPAR: case HYPFS_AVAIL_ASCII_ZVM: qc_dump_hypfs(hdl, priv->hypfs); break; case HYPFS_AVAIL_BIN_LPAR: case HYPFS_AVAIL_BIN_ZVM: qc_dump_hypfs_bin(hdl, priv->diag, (__u8 *)priv->data, priv->len); break; case HYPFS_NA: default: break; } out: qc_debug_indent_dec(); return; } // path must be hypfs path ending with '.../cpus' static int qc_get_hypfs_cpu_types(struct qc_handle *hdl, const char *path, int *cpu_total, int *ifl_total, int *cp_total) { char str_buf[STR_BUF_SIZE]; struct dirent **namelist; int n, no_files, un_total = 0, rc = 0; FILE *file; char *tmp; *cpu_total = *ifl_total = *cp_total = 0; no_files = scandir(path, &namelist, NULL, alphasort); for (n = 0; n < no_files; n++) { if (*namelist[n]->d_name == '.') // skip '.' and '..' to avoid false positives continue; if (asprintf(&tmp, "%s/%s/type", path, namelist[n]->d_name) == -1) { qc_debug(hdl, "Error: Couldn't allocate buffer for hypfs type path\n"); rc = -1; goto out; } file = fopen(tmp, "r"); if (!file) { free(tmp); continue; } qc_debug(hdl, "Parsing file %s\n", tmp); free(tmp); memset(str_buf, 0, STR_BUF_SIZE); if (fread(str_buf, 1, STR_BUF_SIZE, file) > 0) { if (!strncmp("CP", str_buf, strlen("CP"))) { (*cp_total)++; (*cpu_total)++; } else if (!strncmp("IFL", str_buf, strlen("IFL"))) { (*ifl_total)++; (*cpu_total)++; } else if (!strncmp("IIP", str_buf, strlen("IIP")) || !strncmp("AP", str_buf, strlen("AP"))) { un_total++; (*cpu_total)++; } else { qc_debug(hdl, "Error: CPU of unknown type '%s' " "encountered, discarding results\n", str_buf); fclose(file); rc = -2; goto out; } } fclose(file); } qc_debug(hdl, "Found %d cpus total (%d CP, %d IFL, %d UN)\n", *cpu_total, *cp_total, *ifl_total, un_total); out: for (n = 0; n < no_files; n++) free(namelist[n]); if (no_files > 0) free(namelist); return rc; } // Returns the sys hdr from the LPAR matching the name of the respective layer 1 attribute in hdl, // and sets hdl to point to the LPAR layer. static struct dfs_sys_hdr *qc_get_lpar_sys_hdr(struct qc_handle **hdl, iconv_t *cd, __u8 *data) { struct dfs_sys_hdr *sys_hdr = NULL; struct dfs_info_blk_hdr *time_hdr; char lpar_name[QC_NAME_LEN + 1]; const char *s; int i; *hdl = (*hdl)->next; // points to LPAR layer now if ((s = qc_get_attr_value_string(*hdl, qc_layer_name)) == NULL) return NULL; time_hdr = (struct dfs_info_blk_hdr *)(data + sizeof(struct dfs_diag_hdr)); data = (__u8 *)(time_hdr + 1); qc_debug(*hdl, "Found %d LPARs\n", time_hdr->npar); for (i = 0; i < time_hdr->npar; ++i) { sys_hdr = (struct dfs_sys_hdr*)data; memset(lpar_name, 0, QC_NAME_LEN + 1); memcpy(&lpar_name, sys_hdr->sys_name, QC_NAME_LEN); if (qc_ebcdic_to_ascii(*hdl, cd, lpar_name, QC_NAME_LEN) != 0) return NULL; if (strcmp(s, lpar_name) == 0) break; data += (sizeof(struct dfs_sys_hdr) + (sys_hdr->rcpus * sizeof(struct dfs_cpu_info))); } if (i == time_hdr->npar) { qc_debug(*hdl, "Error: LPAR '%s' not found in sys hdrs\n", s); sys_hdr = NULL; } return sys_hdr; } static int qc_fill_in_hypfs_lpar_values(struct qc_handle *hdl, const char *hypfs) { int num_cpu = 0, num_ifl = 0, num_cp = 0; char *fpath = NULL; const char *s; int rc = 0; qc_debug(hdl, "Add LPAR values from textual hypfs API\n"); qc_debug_indent_inc(); hdl = hdl->next; // points to LPAR layer now if ((s = qc_get_attr_value_string(hdl, qc_layer_name)) == NULL) { rc = -1; goto out; } if (asprintf(&fpath, "%s/systems/%s/cpus", hypfs, s) == -1) { qc_debug(hdl, "Error: Couldn't allocate buffer for hypfs systems path\n"); rc = -4; goto out; } rc = qc_get_hypfs_cpu_types(hdl, fpath, &num_cpu, &num_ifl, &num_cp); free(fpath); if (rc) { rc = -5; goto out; } if (qc_set_attr_int(hdl, qc_num_cp_total, num_cp, ATTR_SRC_HYPFS) || qc_set_attr_int(hdl, qc_num_ifl_total, num_ifl, ATTR_SRC_HYPFS)) rc = -6; out: qc_debug_indent_dec(); return rc; } static int qc_fill_in_hypfs_lpar_values_bin(struct qc_handle *hdl, iconv_t *cd, __u8 *data) { int num_cpu = 0, num_ifl = 0, num_cp = 0, num_un = 0, i, rc = 0; struct dfs_sys_hdr *sys_hdr; struct dfs_cpu_info *cpu; qc_debug(hdl, "Add LPAR values from binary hypfs API\n"); qc_debug_indent_inc(); if ((sys_hdr = qc_get_lpar_sys_hdr(&hdl, cd, data)) == NULL) { rc = -1; goto out; } cpu = (struct dfs_cpu_info*)(sys_hdr + 1); for (i = 0; i < sys_hdr->rcpus; ++i, ++cpu) { switch (cpu->ctidx) { case QC_CPU_TYPE_CP: num_cp++; num_cpu++; break; case QC_CPU_TYPE_IFL: num_ifl++; num_cpu++; break; case QC_CPU_TYPE_AP: case QC_CPU_TYPE_IIP: num_un++; num_cpu++; break; default: qc_debug(hdl, "Error: Unknown CPU type '%d' in cpu %d in phys hdr " "encountered, discarding results\n", cpu->ctidx, i); rc = -2; goto out; } } qc_debug(hdl, "Found %d cpus total (%d CP, %d IFL, %d UN)\n", num_cpu, num_cp, num_ifl, num_un); if (qc_set_attr_int(hdl, qc_num_cp_total, num_cp, ATTR_SRC_HYPFS) || qc_set_attr_int(hdl, qc_num_ifl_total, num_ifl, ATTR_SRC_HYPFS)) rc = -3; out: qc_debug_indent_dec(); return rc; } static int qc_read_file(struct qc_handle *hdl, const char *fpath, char *buf, int buflen) { FILE *file; int rc = 0; qc_debug(hdl, "Read file %s\n", fpath); file = fopen(fpath, "r"); if (file) { memset(buf, 0, buflen); rc = fread(buf, 1, buflen, file); fclose(file); } else qc_debug(hdl, "Could not open file %s: %s\n", fpath, strerror(errno)); return rc; } static int qc_read_diag_file(struct qc_handle *hdl, const char *dbgfs, struct hypfs_priv *priv) { long buflen = sizeof(struct dfs_diag_hdr); struct dfs_diag_hdr *hdr; int fh, i = 0, rc = 0; char *fpath = NULL; ssize_t lrc; if ((fpath = qc_get_path(hdl, dbgfs, priv->diag)) == NULL) goto out_fail; qc_debug(hdl, "Read in file '%s'\n", fpath); // file content needs to be read in one(!) go for (i = 0; i < 10; ++i) { fh = open(fpath, O_RDONLY); if (fh == -1) { qc_debug(hdl, "Error: Failed to open file '%s'\n", fpath); goto out_fail; } priv->data = malloc(buflen); if (!priv->data) { qc_debug(hdl, "Error: Failed to allocate '%ld' Bytes for file content\n", buflen); goto out_fail; } lrc = read(fh, priv->data, buflen); close(fh); if (lrc == -1) { qc_debug(hdl, "Error: Failed to read '%ld' Bytes from '%s'\n", buflen, priv->diag); close(fh); goto out_fail; } hdr = (struct dfs_diag_hdr*)priv->data; if ((buflen = sizeof(struct dfs_diag_hdr) + htobe64(hdr->len)) == lrc) { priv->len = lrc; break; } free(priv->data); priv->data = NULL; } if (i >= 10) { qc_debug(hdl, "Error: Tried %d times, still no consistent content " "- giving up\n", i + 1); rc = 1; } goto out; out_fail: free(priv->data); priv->data = NULL; rc = -1; out: free(fpath); return rc; } /* Returns handle to top-layer z/VM instance along with its name. */ static struct qc_handle *qc_get_zvm_hdl(struct qc_handle *hdl, const char **s) { int *i; while (hdl->next) hdl = hdl->next; i = qc_get_attr_value_int(hdl, qc_layer_type_num); if (!i) { qc_debug(hdl, "Error: Attr 'qc_layer_type' not defined at layer %d\n", hdl->layer_no); return NULL; } if (*i != QC_LAYER_TYPE_ZVM_GUEST) { qc_debug(hdl, "Error: Layer type is '%d', expected %d\n", *i, QC_LAYER_TYPE_ZVM_GUEST); return NULL; } *s = qc_get_attr_value_string(hdl, qc_layer_name); if (!*s) { qc_debug(hdl, "Error: Required attr 'qc_layer_name' at layer %d not defined\n", hdl->layer_no); return NULL; } return hdl; } static int qc_fill_in_hypfs_zvm_values(struct qc_handle *hdl, const char *hypfs) { int fplen, cpu_count, cap_num, rc = 0; char str_buf[STR_BUF_SIZE], *fpath = NULL, *cap = NULL; int dedicated = -1; /* can be 0 or 1, if set; remains -1, if not set */ const char *s; qc_debug(hdl, "Add z/VM values from textual hypfs API\n"); qc_debug_indent_inc(); if ((hdl = qc_get_zvm_hdl(hdl, &s)) == NULL) { rc = -1; goto out; } fplen = strlen(hypfs) + strlen("/systems/") + strlen(s) + strlen("/cpus/"); fpath = malloc(fplen + strlen("dedicated") + 1); // longest string possible if (!fpath) { qc_debug(hdl, "Error: Could not allocate systems path\n"); rc = -2; goto out; } /* read capping off/soft/hard */ sprintf(fpath, "%s/systems/%s/cpus/capped", hypfs, s); // fill string 1st time only, // overwrite filename in all successive occasions if (qc_read_file(hdl, fpath, str_buf, STR_BUF_SIZE)) { if (!strncmp("1", str_buf, 1)) { cap_num = QC_CAPPING_SOFT; cap = "soft"; } else if (!strncmp("2", str_buf, 1)) { cap_num = QC_CAPPING_HARD; cap = "hard"; } else { cap_num = QC_CAPPING_OFF; cap = "off"; } if (qc_set_attr_int(hdl, qc_capping_num, cap_num, ATTR_SRC_HYPFS) || qc_set_attr_string(hdl, qc_capping, cap, strlen(cap), ATTR_SRC_HYPFS)) { rc = -3; goto out; } } /* if guest dedicated, all cpus are dedicated, update sums */ strcpy(fpath + fplen, "dedicated"); if (qc_read_file(hdl, fpath, str_buf, STR_BUF_SIZE)) { if (!strncmp("0", str_buf, 1)) dedicated = 0; else if (!strncmp("1", str_buf, 1)) dedicated = 1; } strcpy(fpath + fplen, "count"); if (qc_read_file(hdl, fpath, str_buf, STR_BUF_SIZE)) { if (sscanf(str_buf, "%i", &cpu_count) <= 0) cpu_count = 0; } qc_debug(hdl, "Raw data: %d cpus, dedicated=%u, capped=%s\n", cpu_count, dedicated, cap); if (cpu_count) { /* the dedicated flag tells us, if the guest has got at least one dedicated CPU. * That means, we can only derive information, if no CPU is dedicated * (i.e. all shared) */ if (dedicated == 0) { /* dedicated flag present and not set */ if (qc_set_attr_int(hdl, qc_num_cpu_shared, cpu_count, ATTR_SRC_HYPFS) || qc_set_attr_int(hdl, qc_num_cpu_dedicated, 0, ATTR_SRC_HYPFS)) { rc = -4; goto out; } } } out: free(fpath); qc_debug_indent_dec(); return rc; } // Returns diag data for highest layer z/VM instance in var 'data', with pointer to entire data // stored in 'buf' (must be free()'d), and updates hdl to point to respective handle. static int qc_get_zvm_diag_data(struct qc_handle **hdl, iconv_t *cd, struct dfs_diag_hdr *hdr, struct dfs_diag2fc **data) { char name[QC_NAME_LEN + 1]; const char *s; int i; if ((*hdl = qc_get_zvm_hdl(*hdl, &s)) == NULL) return -1; qc_debug(*hdl, "Found data for %llu z/VM guest(s)\n", htobe64(hdr->count)); for (i = 0, *data = (struct dfs_diag2fc*)(hdr + 1); i < htobe64(hdr->count); ++i, ++*data) { memset(&name, 0, QC_NAME_LEN + 1); memcpy(name, (*data)->guest_name, QC_NAME_LEN); if (qc_ebcdic_to_ascii(*hdl, cd, name, QC_NAME_LEN) != 0) return -2; if (strcmp(name, s) == 0) return 0; } qc_debug(*hdl, "Error: No matching data found for z/VM guest '%s'\n", s); return -3; } static int qc_fill_in_hypfs_zvm_values_bin(struct qc_handle *hdl, iconv_t *cd, struct hypfs_priv *priv) { unsigned int dedicated, capped; struct dfs_diag2fc *data; int rc = 0, cap_num; char *cap; qc_debug(hdl, "Add z/VM values from binary hypfs API\n"); qc_debug_indent_inc(); if ((rc = qc_get_zvm_diag_data(&hdl, cd, (struct dfs_diag_hdr *)priv->data, &data)) != 0) goto out; // update capping information capped = (htobe32(data->flags) & 0x00000006) >> 1; dedicated = (htobe32(data->flags) & 0x00000008) >> 3; qc_debug(hdl, "Raw data: %u cpus, dedicated=%u, capped=%u\n", htobe32(data->vcpus), dedicated, capped); switch (capped) { case 1: cap_num = QC_CAPPING_SOFT; cap = "soft"; break; case 2: cap_num = QC_CAPPING_HARD; cap = "hard"; break; default: cap_num = QC_CAPPING_OFF; cap = "off"; } if (qc_set_attr_int(hdl, qc_capping_num, cap_num, ATTR_SRC_HYPFS) || qc_set_attr_string(hdl, qc_capping, cap, strlen(cap), ATTR_SRC_HYPFS)) { rc = -1; goto out; } // update shared cpu counts if (dedicated == 0) { /* the dedicated flag tells us, if the guest has got at * least one dedicated CPU. That means, we can only * derive information, if no CPU is dedicated (i.e. * all shared) */ if (qc_set_attr_int(hdl, qc_num_cpu_shared, htobe32(data->vcpus), ATTR_SRC_HYPFS) || qc_set_attr_int(hdl, qc_num_cpu_dedicated, 0, ATTR_SRC_HYPFS)) { rc = -4; goto out; } } out: qc_debug_indent_dec(); return rc; } /* Retrieve mountpoint of fstype from /etc/mtab. Returns 0 on success with malloc'd mountpoint in 'mp', >0 if not found and <0 in case of an error. */ static int qc_get_mountpoint(struct qc_handle *hdl, char *fstype, char **mp) { struct mntent *mntbuf; FILE *mounts; char *fname; int rc; if (qc_dbg_use_dump) { // dumped data will look exactly like if on dbgfs or hypfs, so all we need // to do is point *mp to the right directory - if the respective data is present, // which we check with a simple sanity check qc_debug(hdl, "Read hypfs from dump\n"); if (strcmp(fstype, "s390_hypfs") == 0) { if (asprintf(&fname, "%s/hyp", qc_dbg_use_dump) == -1) { qc_debug(hdl, "Error: Mem alloc failed, cannot read dump\n"); return -1; } } else { if (asprintf(&fname, "%s/%s", qc_dbg_use_dump, QC_HYPFS_LPAR) == -1) { qc_debug(hdl, "Error: Mem alloc failed, cannot read dump\n"); return -1; } } rc = access(fname, R_OK); free(fname); if (rc) return 1; *mp = strdup(qc_dbg_use_dump); return 0; } qc_debug(hdl, "Locate mount point of %s\n", fstype); *mp = NULL; mounts = setmntent(_PATH_MOUNTED, "r"); if (!mounts) { qc_debug(hdl, "Error: Failed to open %s\n", _PATH_MOUNTED); return -1; } while ((mntbuf = getmntent(mounts)) != NULL) { if (strcmp(mntbuf->mnt_type, fstype) == 0) { *mp = strdup(mntbuf->mnt_dir); if (!*mp) { qc_debug(hdl, "Error: Failed to allocate buffer\n"); endmntent(mounts); return -2; } break; } } endmntent(mounts); if (!*mp) { qc_debug(hdl, "%s not mounted according to '%s'\n", fstype, _PATH_MOUNTED); return 1; } qc_debug(hdl, "%s mounted at '%s'\n", fstype, *mp); return 0; } static int qc_update_hypfs(struct qc_handle *hdl, const char *upath) { FILE *file; size_t rc; qc_debug(hdl, "Update hypfs using %s\n", upath); file = fopen(upath, "w"); if (!file) { /* Don't treat as an error in case hypfs is mounted but not accessible. But we assume the remainder of hypfs won't be accessible either, so out we go. */ qc_debug(hdl, "Warning: Failed to open '%s': %s\n", upath, strerror(errno)); return 1; } rc = fwrite("1\n", 1, strlen("1\n"), file); fclose(file); if (rc < strlen("1\n")) { // Could be file access rights preventing us from a proper update qc_debug(hdl, "Warning: Failed to write to '%s', rc=%zd\n", upath, rc); return 2; } return 0; } static int qc_get_update_mod_time(struct qc_handle *hdl, const char *hypfs, time_t *mtime) { char *fpath = NULL; struct stat buf; if (qc_dbg_use_dump) { *mtime = 37; return 0; } qc_debug(hdl, "Retrieve mod time of %s/update\n", hypfs); if ((fpath = qc_get_path(hdl, hypfs, "/update")) == NULL) return -1; if (stat(fpath, &buf)) { qc_debug(hdl, "Error: Couldn't stat '%s'\n", fpath); free(fpath); return -2; } free(fpath); *mtime = buf.st_mtime; qc_debug(hdl, "Mod time: %ld\n", *mtime); return 0; } static int qc_hypfs_open(struct qc_handle *hdl, char **buf) { char *dbgfs = NULL, *fpath = NULL; struct hypfs_priv *priv; int rc = 0; qc_debug(hdl, "Retrieve hypfs information\n"); qc_debug_indent_inc(); if ((priv = malloc(sizeof(struct hypfs_priv))) == NULL) { qc_debug(hdl, "Error: Failed to allocate hypfs_priv\n"); rc = -1; goto out; } bzero(priv, sizeof(struct hypfs_priv)); *buf = (char *)priv; // check for binary hypfs interface if ((rc = qc_get_mountpoint(hdl, "debugfs", &dbgfs)) < 0) goto out; if (rc == 0) { // LPAR diag file is always present if binary interface is available if ((fpath = qc_get_path(hdl, dbgfs, QC_HYPFS_LPAR)) == NULL) { rc = -2; goto out; } rc = access(fpath, R_OK); free(fpath); fpath = NULL; if (rc == 0) { qc_debug(hdl, "Use binary hypfs API\n"); if ((fpath = qc_get_path(hdl, dbgfs, QC_HYPFS_ZVM)) == NULL) { rc = -3; goto out; } if (access(fpath, R_OK) == 0) { /* if z/VM diag file exists, the LPAR diag file's content isn't valid, so we're done after handling the z/VM file */ priv->diag = QC_HYPFS_ZVM; if ((rc = qc_read_diag_file(hdl, dbgfs, priv)) != 0) goto out; priv->avail = HYPFS_AVAIL_BIN_ZVM; } else { qc_debug(hdl, "No z/VM diag file found, must be an LPAR\n"); priv->diag = QC_HYPFS_LPAR; if ((rc = qc_read_diag_file(hdl, dbgfs, priv)) != 0) goto out; priv->avail = HYPFS_AVAIL_BIN_LPAR; } } else { qc_debug(hdl, "Binary hypfs API not available: %s\n", strerror(errno)); rc = 0; } } else rc = 0; // Note: The ASCII hypfs has to be parsed on the fly in qc_hypfs_fill_in() out: qc_debug_indent_dec(); free(dbgfs); free(fpath); return rc; } static void qc_hypfs_close(struct qc_handle *hdl, char *buf) { struct hypfs_priv *priv = (struct hypfs_priv *)buf; if (priv) { free(priv->data); free(priv->hypfs); free(priv); } } static int qc_hypfs_process(struct qc_handle *hdl, iconv_t *cd, char *buf) { struct hypfs_priv *priv = (struct hypfs_priv *)buf; char str_buf[STR_BUF_SIZE] = ""; time_t mtime, mtime_old; char *fpath = NULL; FILE *file = NULL; int i, rc = 0; qc_debug(hdl, "Process hypfs\n"); qc_debug_indent_inc(); if (!priv) { qc_debug(hdl, "qc_hypfs_fill_in() called with priv==NULL, exiting\n"); goto out; } if (priv->avail == HYPFS_AVAIL_BIN_LPAR) { rc = qc_fill_in_hypfs_lpar_values_bin(hdl, cd, (__u8 *)priv->data); goto out; } if (priv->avail == HYPFS_AVAIL_BIN_ZVM) { rc = qc_fill_in_hypfs_zvm_values_bin(hdl, cd, priv); goto out; } /* fallback to textual interface */ qc_debug(hdl, "Use textual hypfs API\n"); rc = qc_get_mountpoint(hdl, "s390_hypfs", &priv->hypfs); if (rc < 0) goto out; if (rc > 0) { rc = 0; // don't treat non-presence of hypfs as an error qc_debug(hdl, "hypfs info not available\n"); goto out; } if ((fpath = qc_get_path(hdl, priv->hypfs, "/update")) == NULL) goto mem_err; rc = qc_update_hypfs(hdl, fpath); if (rc < 0) goto out; if (rc > 0) { qc_debug(hdl, "hypfs info not available\n"); rc = 0; // don't treat as an error goto out; } free(fpath); fpath = NULL; /* If we can't get it right within 3 tries, we give up */ for(i = 0; i < 3; ++i) { if (qc_get_update_mod_time(hdl, priv->hypfs, &mtime_old)) { rc = -2; goto out; } memset(str_buf, 0, STR_BUF_SIZE); if ((fpath = qc_get_path(hdl, priv->hypfs, "/hyp/type")) == NULL) goto mem_err; if (!qc_read_file(hdl, fpath, str_buf, STR_BUF_SIZE)) { qc_debug(hdl, "Error: Failed to open or read '%s'\n", fpath); rc = -4; goto out; } if (!strncmp(str_buf, "LPAR Hypervisor", strlen("LPAR Hypervisor"))) { if (qc_fill_in_hypfs_lpar_values(hdl, priv->hypfs)) { rc = -6; goto out; } priv->avail = HYPFS_AVAIL_ASCII_LPAR; } else if (!strncmp("z/VM Hypervisor", str_buf, strlen("z/VM Hypervisor"))) { if (qc_fill_in_hypfs_zvm_values(hdl, priv->hypfs)) { rc = -7; goto out; } priv->avail = HYPFS_AVAIL_ASCII_ZVM; } else { qc_debug(hdl, "Error: Unhandled hypervisor '%s', ignored\n", str_buf); rc = 0; goto out; } if (qc_get_update_mod_time(hdl, priv->hypfs, &mtime)) { rc = -8; goto out; } if (mtime == mtime_old) goto out; } /* Ideally we'd clear any data possibly collected in an invalid attempt (mod_time != buf.st_mtime). However, that's complicated, as we'd have to revert to previously filled in values from other sources - which we currently can't */ qc_debug(hdl, "Error: Failed to get consistent data from hypfs\n"); rc = -9; goto out; mem_err: qc_debug(hdl, "Error: Memory allocation error\n"); rc = -10; out: free(fpath); if (file) fclose(file); qc_debug_indent_dec(); return rc; } struct qc_data_src hypfs = {qc_hypfs_open, qc_hypfs_process, qc_hypfs_dump, qc_hypfs_close, NULL, NULL}; qclib-1.1.0/query_capacity_data.c0000644000200300017500000006726012650354047016017 0ustar rasplraspl/* IBM Corp. 2013, 2015 */ //_GNU_SOURCE used for getline and posix_memalign #define _GNU_SOURCE #include #include #include "query_capacity_data.h" /* * Below are the structures that define the attributes. The attribute is * reference as an enum, see documentation in query_capacity.h. * * Note that strings (char pointers) carry the trailing zero byte. */ #define QC_LAYER_TYPE_LEN 20 #define QC_LAYER_CAT_LEN 6 struct qc_cec_values { int layer_type_num; int layer_category_num; char layer_type[QC_LAYER_TYPE_LEN]; char layer_category[QC_LAYER_CAT_LEN]; char layer_name[9]; char manufacturer[17]; char type[5]; char model_capacity[17]; char model[17]; char sequence_code[17]; char plant[5]; int num_cpu_total; int num_cpu_configured; int num_cpu_standby; int num_cpu_reserved; int num_cpu_dedicated; int num_cpu_shared; int num_cp_total; int num_cp_dedicated; int num_cp_shared; int num_ifl_total; int num_ifl_dedicated; int num_ifl_shared; float capability; float secondary_capability; int capacity_adjustment_indication; int capacity_change_reason; }; struct qc_lpar_values { int layer_type_num; int layer_category_num; char layer_type[QC_LAYER_TYPE_LEN]; char layer_category[QC_LAYER_CAT_LEN]; int partition_number; char partition_char[26]; int partition_char_num; char layer_name[9]; int adjustment; int num_cpu_total; int num_cpu_configured; int num_cpu_standby; int num_cpu_reserved; int num_cpu_dedicated; int num_cpu_shared; int num_cp_total; int num_cp_dedicated; int num_cp_shared; int num_ifl_total; int num_ifl_dedicated; int num_ifl_shared; int cp_absolute_capping; int ifl_absolute_capping; int cp_weight_capping; int ifl_weight_capping; }; struct qc_zvm_pool_values { int layer_type_num; int layer_category_num; char layer_type[QC_LAYER_TYPE_LEN]; char layer_category[QC_LAYER_CAT_LEN]; char layer_name[9]; int cp_limithard_cap; int cp_capacity_cap; int ifl_limithard_cap; int ifl_capacity_cap; int cp_capped_capacity; int ifl_capped_capacity; }; struct qc_zvm_hypervisor_values { int layer_type_num; int layer_category_num; char layer_type[QC_LAYER_TYPE_LEN]; char layer_category[QC_LAYER_CAT_LEN]; char layer_name[9]; char cluster_name[9]; char control_program_id[17]; int adjustment; int hardlimit_consumption; int num_cpu_total; int num_cpu_dedicated; int num_cpu_shared; int num_cp_total; int num_cp_dedicated; int num_cp_shared; int num_ifl_total; int num_ifl_dedicated; int num_ifl_shared; }; struct qc_zvm_guest_values { int layer_type_num; int layer_category_num; char layer_type[QC_LAYER_TYPE_LEN]; char layer_category[QC_LAYER_CAT_LEN]; char layer_name[9]; char system_identifier[9]; char cluster_name[9]; char control_program_id[17]; int adjustment; char capping[5]; int capping_num; int num_cpu_total; int num_cpu_configured; int num_cpu_standby; int num_cpu_reserved; int num_cpu_dedicated; int num_cpu_shared; int num_cp_total; int num_cp_dedicated; int num_cp_shared; int num_ifl_total; int num_ifl_dedicated; int num_ifl_shared; int mobility_eligible; int has_multiple_cpu_types; int cp_dispatch_limithard; int ifl_dispatch_limithard; int cp_dispatch_type; int ifl_dispatch_type; int cp_capped_capacity; int ifl_capped_capacity; char pool_name[9]; int pool_cp_limithard_cap; int pool_cp_capacity_cap; int pool_ifl_limithard_cap; int pool_ifl_capacity_cap; int pool_cp_capped_capacity; int pool_ifl_capped_capacity; int hardlimit_consumption; int hyp_cpu_total; int hyp_cpu_dedicated; int hyp_cpu_shared; int hyp_cp_total; int hyp_cp_dedicated; int hyp_cp_shared; int hyp_ifl_total; int hyp_ifl_dedicated; int hyp_ifl_shared; }; struct qc_kvm_hypervisor_values { int layer_type_num; int layer_category_num; char layer_type[QC_LAYER_TYPE_LEN]; char layer_category[QC_LAYER_CAT_LEN]; char control_program_id[17]; int adjustment; }; struct qc_kvm_guest_values { int layer_type_num; int layer_category_num; char layer_type[QC_LAYER_TYPE_LEN]; char layer_category[QC_LAYER_CAT_LEN]; char layer_name[9]; char layer_extended_name[257]; char layer_uuid[37]; int num_cpu_total; int num_cpu_configured; int num_cpu_standby; int num_cpu_reserved; }; enum qc_data_type { string, integer, floatingpoint }; struct qc_attr { enum qc_attr_id id; enum qc_data_type type; int offset; }; static struct qc_attr cec_attrs[] = { {qc_layer_type_num, integer, offsetof(struct qc_cec_values, layer_type_num)}, {qc_layer_category_num, integer, offsetof(struct qc_cec_values, layer_category_num)}, {qc_layer_type, string, offsetof(struct qc_cec_values, layer_type)}, {qc_layer_category, string, offsetof(struct qc_cec_values, layer_category)}, {qc_layer_name, string, offsetof(struct qc_cec_values, layer_name)}, {qc_manufacturer, string, offsetof(struct qc_cec_values, manufacturer)}, {qc_type, string, offsetof(struct qc_cec_values, type)}, {qc_model_capacity, string, offsetof(struct qc_cec_values, model_capacity)}, {qc_model, string, offsetof(struct qc_cec_values, model)}, {qc_sequence_code, string, offsetof(struct qc_cec_values, sequence_code)}, {qc_plant, string, offsetof(struct qc_cec_values, plant)}, {qc_num_cpu_total, integer, offsetof(struct qc_cec_values, num_cpu_total)}, {qc_num_cpu_configured, integer, offsetof(struct qc_cec_values, num_cpu_configured)}, {qc_num_cpu_standby, integer, offsetof(struct qc_cec_values, num_cpu_standby)}, {qc_num_cpu_reserved, integer, offsetof(struct qc_cec_values, num_cpu_reserved)}, {qc_num_cpu_dedicated, integer, offsetof(struct qc_cec_values, num_cpu_dedicated)}, {qc_num_cpu_shared, integer, offsetof(struct qc_cec_values, num_cpu_shared)}, {qc_num_cp_total, integer, offsetof(struct qc_cec_values, num_cp_total)}, {qc_num_cp_dedicated, integer, offsetof(struct qc_cec_values, num_cp_dedicated)}, {qc_num_cp_shared, integer, offsetof(struct qc_cec_values, num_cp_shared)}, {qc_num_ifl_total, integer, offsetof(struct qc_cec_values, num_ifl_total)}, {qc_num_ifl_dedicated, integer, offsetof(struct qc_cec_values, num_ifl_dedicated)}, {qc_num_ifl_shared, integer, offsetof(struct qc_cec_values, num_ifl_shared)}, {qc_capability, floatingpoint, offsetof(struct qc_cec_values, capability)}, {qc_secondary_capability, floatingpoint, offsetof(struct qc_cec_values, secondary_capability)}, {qc_capacity_adjustment_indication, integer, offsetof(struct qc_cec_values, capacity_adjustment_indication)}, {qc_capacity_change_reason, integer, offsetof(struct qc_cec_values, capacity_change_reason)}, {-1, string, -1} }; static struct qc_attr lpar_attrs[] = { {qc_layer_type_num, integer, offsetof(struct qc_lpar_values, layer_type_num)}, {qc_layer_category_num, integer, offsetof(struct qc_lpar_values, layer_category_num)}, {qc_layer_type, string, offsetof(struct qc_lpar_values, layer_type)}, {qc_layer_category, string, offsetof(struct qc_lpar_values, layer_category)}, {qc_partition_number, integer, offsetof(struct qc_lpar_values, partition_number)}, {qc_partition_char, string, offsetof(struct qc_lpar_values, partition_char)}, {qc_partition_char_num, integer, offsetof(struct qc_lpar_values, partition_char_num)}, {qc_layer_name, string, offsetof(struct qc_lpar_values, layer_name)}, {qc_adjustment, integer, offsetof(struct qc_lpar_values, adjustment)}, {qc_num_cpu_total, integer, offsetof(struct qc_lpar_values, num_cpu_total)}, {qc_num_cpu_configured, integer, offsetof(struct qc_lpar_values, num_cpu_configured)}, {qc_num_cpu_standby, integer, offsetof(struct qc_lpar_values, num_cpu_standby)}, {qc_num_cpu_reserved, integer, offsetof(struct qc_lpar_values, num_cpu_reserved)}, {qc_num_cpu_dedicated, integer, offsetof(struct qc_lpar_values, num_cpu_dedicated)}, {qc_num_cpu_shared, integer, offsetof(struct qc_lpar_values, num_cpu_shared)}, {qc_num_cp_total, integer, offsetof(struct qc_lpar_values, num_cp_total)}, {qc_num_cp_dedicated, integer, offsetof(struct qc_lpar_values, num_cp_dedicated)}, {qc_num_cp_shared, integer, offsetof(struct qc_lpar_values, num_cp_shared)}, {qc_num_ifl_total, integer, offsetof(struct qc_lpar_values, num_ifl_total)}, {qc_num_ifl_dedicated, integer, offsetof(struct qc_lpar_values, num_ifl_dedicated)}, {qc_num_ifl_shared, integer, offsetof(struct qc_lpar_values, num_ifl_shared)}, {qc_cp_absolute_capping, integer, offsetof(struct qc_lpar_values, cp_absolute_capping)}, {qc_ifl_absolute_capping, integer, offsetof(struct qc_lpar_values, ifl_absolute_capping)}, {qc_cp_weight_capping, integer, offsetof(struct qc_lpar_values, cp_weight_capping)}, {qc_ifl_weight_capping, integer, offsetof(struct qc_lpar_values, ifl_weight_capping)}, {-1, string, -1} }; static struct qc_attr zvm_hv_attrs[] = { {qc_layer_type_num, integer, offsetof(struct qc_zvm_hypervisor_values, layer_type_num)}, {qc_layer_category_num, integer, offsetof(struct qc_zvm_hypervisor_values, layer_category_num)}, {qc_layer_type, string, offsetof(struct qc_zvm_hypervisor_values, layer_type)}, {qc_layer_category, string, offsetof(struct qc_zvm_hypervisor_values, layer_category)}, {qc_layer_name, string, offsetof(struct qc_zvm_hypervisor_values, layer_name)}, {qc_cluster_name, string, offsetof(struct qc_zvm_hypervisor_values, cluster_name)}, {qc_control_program_id, string, offsetof(struct qc_zvm_hypervisor_values, control_program_id)}, {qc_adjustment, integer, offsetof(struct qc_zvm_hypervisor_values, adjustment)}, {qc_hardlimit_consumption, integer, offsetof(struct qc_zvm_hypervisor_values, hardlimit_consumption)}, {qc_num_cpu_total, integer, offsetof(struct qc_zvm_hypervisor_values, num_cpu_total)}, {qc_num_cpu_dedicated, integer, offsetof(struct qc_zvm_hypervisor_values, num_cpu_dedicated)}, {qc_num_cpu_shared, integer, offsetof(struct qc_zvm_hypervisor_values, num_cpu_shared)}, {qc_num_cp_total, integer, offsetof(struct qc_zvm_hypervisor_values, num_cp_total)}, {qc_num_cp_dedicated, integer, offsetof(struct qc_zvm_hypervisor_values, num_cp_dedicated)}, {qc_num_cp_shared, integer, offsetof(struct qc_zvm_hypervisor_values, num_cp_shared)}, {qc_num_ifl_total, integer, offsetof(struct qc_zvm_hypervisor_values, num_ifl_total)}, {qc_num_ifl_dedicated, integer, offsetof(struct qc_zvm_hypervisor_values, num_ifl_dedicated)}, {qc_num_ifl_shared, integer, offsetof(struct qc_zvm_hypervisor_values, num_ifl_shared)}, {-1, string, -1} }; static struct qc_attr kvm_hv_attrs[] = { {qc_layer_type_num, integer, offsetof(struct qc_kvm_hypervisor_values, layer_type_num)}, {qc_layer_category_num, integer, offsetof(struct qc_kvm_hypervisor_values, layer_category_num)}, {qc_layer_type, string, offsetof(struct qc_kvm_hypervisor_values, layer_type)}, {qc_layer_category, string, offsetof(struct qc_kvm_hypervisor_values, layer_category)}, {qc_control_program_id, string, offsetof(struct qc_kvm_hypervisor_values, control_program_id)}, {qc_adjustment, integer, offsetof(struct qc_kvm_hypervisor_values, adjustment)}, {-1, string, -1} }; static struct qc_attr zvm_pool_attrs[] = { {qc_layer_type_num, integer, offsetof(struct qc_zvm_pool_values, layer_type_num)}, {qc_layer_category_num, integer, offsetof(struct qc_zvm_pool_values, layer_category_num)}, {qc_layer_type, string, offsetof(struct qc_zvm_pool_values, layer_type)}, {qc_layer_category, string, offsetof(struct qc_zvm_pool_values, layer_category)}, {qc_layer_name, string, offsetof(struct qc_zvm_pool_values, layer_name)}, {qc_cp_limithard_cap, integer, offsetof(struct qc_zvm_pool_values, cp_limithard_cap)}, {qc_cp_capacity_cap, integer, offsetof(struct qc_zvm_pool_values, cp_capacity_cap)}, {qc_ifl_limithard_cap, integer, offsetof(struct qc_zvm_pool_values, ifl_limithard_cap)}, {qc_ifl_capacity_cap, integer, offsetof(struct qc_zvm_pool_values, ifl_capacity_cap)}, {qc_cp_capped_capacity, integer, offsetof(struct qc_zvm_pool_values, cp_capped_capacity)}, {qc_ifl_capped_capacity, integer, offsetof(struct qc_zvm_pool_values, ifl_capped_capacity)}, {-1, string, -1} }; static struct qc_attr zvm_guest_attrs[] = { {qc_layer_type_num, integer, offsetof(struct qc_zvm_guest_values, layer_type_num)}, {qc_layer_category_num, integer, offsetof(struct qc_zvm_guest_values, layer_category_num)}, {qc_layer_type, string, offsetof(struct qc_zvm_guest_values, layer_type)}, {qc_layer_category, string, offsetof(struct qc_zvm_guest_values, layer_category)}, {qc_layer_name, string, offsetof(struct qc_zvm_guest_values, layer_name)}, {qc_capping, string, offsetof(struct qc_zvm_guest_values, capping)}, {qc_capping_num, integer, offsetof(struct qc_zvm_guest_values, capping_num)}, {qc_num_cpu_total, integer, offsetof(struct qc_zvm_guest_values, num_cpu_total)}, {qc_num_cpu_configured, integer, offsetof(struct qc_zvm_guest_values, num_cpu_configured)}, {qc_num_cpu_standby, integer, offsetof(struct qc_zvm_guest_values, num_cpu_standby)}, {qc_num_cpu_reserved, integer, offsetof(struct qc_zvm_guest_values, num_cpu_reserved)}, {qc_num_cpu_dedicated, integer, offsetof(struct qc_zvm_guest_values, num_cpu_dedicated)}, {qc_num_cpu_shared, integer, offsetof(struct qc_zvm_guest_values, num_cpu_shared)}, {qc_num_cp_total, integer, offsetof(struct qc_zvm_guest_values, num_cp_total)}, {qc_num_cp_dedicated, integer, offsetof(struct qc_zvm_guest_values, num_cp_dedicated)}, {qc_num_cp_shared, integer, offsetof(struct qc_zvm_guest_values, num_cp_shared)}, {qc_num_ifl_total, integer, offsetof(struct qc_zvm_guest_values, num_ifl_total)}, {qc_num_ifl_dedicated, integer, offsetof(struct qc_zvm_guest_values, num_ifl_dedicated)}, {qc_num_ifl_shared, integer, offsetof(struct qc_zvm_guest_values, num_ifl_shared)}, {qc_mobility_eligible, integer, offsetof(struct qc_zvm_guest_values, mobility_eligible)}, {qc_has_multiple_cpu_types, integer, offsetof(struct qc_zvm_guest_values, has_multiple_cpu_types)}, {qc_cp_dispatch_limithard, integer, offsetof(struct qc_zvm_guest_values, cp_dispatch_limithard)}, {qc_cp_capped_capacity, integer, offsetof(struct qc_zvm_guest_values, cp_capped_capacity)}, {qc_ifl_dispatch_limithard, integer, offsetof(struct qc_zvm_guest_values, ifl_dispatch_limithard)}, {qc_ifl_capped_capacity, integer, offsetof(struct qc_zvm_guest_values, ifl_capped_capacity)}, {qc_cp_dispatch_type, integer, offsetof(struct qc_zvm_guest_values, cp_dispatch_type)}, {qc_ifl_dispatch_type, integer, offsetof(struct qc_zvm_guest_values, ifl_dispatch_type)}, {-1, string, -1} }; static struct qc_attr kvm_guest_attrs[] = { {qc_layer_type_num, integer, offsetof(struct qc_kvm_guest_values, layer_type_num)}, {qc_layer_category_num, integer, offsetof(struct qc_kvm_guest_values, layer_category_num)}, {qc_layer_type, string, offsetof(struct qc_kvm_guest_values, layer_type)}, {qc_layer_category, string, offsetof(struct qc_kvm_guest_values, layer_category)}, {qc_layer_name, string, offsetof(struct qc_kvm_guest_values, layer_name)}, {qc_layer_extended_name, string, offsetof(struct qc_kvm_guest_values, layer_extended_name)}, {qc_layer_uuid, string, offsetof(struct qc_kvm_guest_values, layer_uuid)}, {qc_num_cpu_total, integer, offsetof(struct qc_kvm_guest_values, num_cpu_total)}, {qc_num_cpu_configured, integer, offsetof(struct qc_kvm_guest_values, num_cpu_configured)}, {qc_num_cpu_standby, integer, offsetof(struct qc_kvm_guest_values, num_cpu_standby)}, {qc_num_cpu_reserved, integer, offsetof(struct qc_kvm_guest_values, num_cpu_reserved)}, {-1, string, -1} }; const char *qc_attr_id_to_char(struct qc_handle *hdl, enum qc_attr_id id) { switch (id) { case qc_layer_type_num: return "layer_type_num"; case qc_layer_category_num: return "layer_category_num"; case qc_layer_type: return "layer_type"; case qc_layer_category: return "layer_category"; case qc_layer_name: return "layer_name"; case qc_layer_extended_name: return "layer_extended_name"; case qc_layer_uuid: return "layer_uuid"; case qc_manufacturer: return "manufacturer"; case qc_type: return "type"; case qc_model_capacity: return "model_capacity"; case qc_model: return "model"; case qc_sequence_code: return "sequence_code"; case qc_plant: return "plant"; case qc_num_cpu_total: return "num_cpu_total"; case qc_num_cpu_configured: return "num_cpu_configured"; case qc_num_cpu_standby: return "num_cpu_standby"; case qc_num_cpu_reserved: return "num_cpu_reserved"; case qc_num_cpu_dedicated: return "num_cpu_dedicated"; case qc_num_cpu_shared: return "num_cpu_shared"; case qc_num_cp_total: return "num_cp_total"; case qc_num_cp_dedicated: return "num_cp_dedicated"; case qc_num_cp_shared: return "num_cp_shared"; case qc_num_ifl_total: return "num_ifl_total"; case qc_num_ifl_dedicated: return "num_ifl_dedicated"; case qc_num_ifl_shared: return "num_ifl_shared"; case qc_capability: return "capability"; case qc_secondary_capability: return "secondary_capability"; case qc_capacity_adjustment_indication: return "capacity_adjustment_indication"; case qc_capacity_change_reason: return "capacity_change_reason"; case qc_partition_number: return "partition_number"; case qc_partition_char: return "partition_char"; case qc_partition_char_num: return "partition_char_num"; case qc_adjustment: return "adjustment"; case qc_cp_absolute_capping: return "cp_absolute_capping"; case qc_ifl_absolute_capping: return "ifl_absolute_capping"; case qc_cp_weight_capping: return "cp_weight_capping"; case qc_ifl_weight_capping: return "ifl_weight_capping"; case qc_cluster_name: return "cluster_name"; case qc_control_program_id: return "control_program_id"; case qc_hardlimit_consumption: return "hardlimit_consumption"; case qc_cp_limithard_cap: return "pool_cp_limithard_cap"; case qc_cp_capacity_cap: return "pool_cp_capacity_cap"; case qc_ifl_limithard_cap: return "pool_ifl_limithard_cap"; case qc_ifl_capacity_cap: return "pool_ifl_capacity_cap"; case qc_capping: return "capping"; case qc_capping_num: return "capping_num"; case qc_mobility_eligible: return "mobility_eligible"; case qc_has_multiple_cpu_types: return "has_multiple_cpu_types"; case qc_cp_dispatch_limithard: return "cp_dispatch_limithard"; case qc_ifl_dispatch_limithard: return "ifl_dispatch_limithard"; case qc_cp_dispatch_type: return "cp_dispatch_type"; case qc_ifl_dispatch_type: return "ifl_dispatch_type"; case qc_cp_capped_capacity: return "cp_capped_capacity"; case qc_ifl_capped_capacity: return "ifl_capped_capacity"; default: break; } qc_debug(hdl, "Error: Cannot convert unknown attribute '%d' to char*\n", id); return NULL; } // 'hdl' is for error reporting, as 'tgthdl' might not be part of the pointer lists yet int qc_new_handle(struct qc_handle *hdl, struct qc_handle **tgthdl, int layer_no, int layer_type_num) { int num_attrs, layer_category_num; char *layer_type, *layer_category; struct qc_attr *attrs; size_t layer_sz; switch (layer_type_num) { case QC_LAYER_TYPE_CEC: layer_sz = sizeof(struct qc_cec_values); attrs = cec_attrs; layer_category_num = QC_LAYER_CAT_HOST; layer_category = "HOST"; layer_type = "CEC"; break; case QC_LAYER_TYPE_LPAR: layer_sz = sizeof(struct qc_lpar_values); attrs = lpar_attrs; layer_category_num = QC_LAYER_CAT_GUEST; layer_category = "GUEST"; layer_type = "LPAR"; break; case QC_LAYER_TYPE_ZVM_HYPERVISOR: layer_sz = sizeof(struct qc_zvm_hypervisor_values); attrs = zvm_hv_attrs; layer_category_num = QC_LAYER_CAT_HOST; layer_category = "HOST"; layer_type = "z/VM-hypervisor"; break; case QC_LAYER_TYPE_ZVM_CPU_POOL: layer_sz = sizeof(struct qc_zvm_pool_values); attrs = zvm_pool_attrs; layer_category_num = QC_LAYER_CAT_POOL; layer_category = "POOL"; layer_type = "z/VM-CPU-pool"; break; case QC_LAYER_TYPE_ZVM_GUEST: layer_sz = sizeof(struct qc_zvm_guest_values); attrs = zvm_guest_attrs; layer_category_num = QC_LAYER_CAT_GUEST; layer_category = "GUEST"; layer_type = "z/VM-guest"; break; case QC_LAYER_TYPE_KVM_HYPERVISOR: layer_sz = sizeof(struct qc_kvm_hypervisor_values); attrs = kvm_hv_attrs; layer_category_num = QC_LAYER_CAT_HOST; layer_category = "HOST"; layer_type = "KVM-hypervisor"; break; case QC_LAYER_TYPE_KVM_GUEST: layer_sz = sizeof(struct qc_kvm_guest_values); attrs = kvm_guest_attrs; layer_category_num = QC_LAYER_CAT_GUEST; layer_category = "GUEST"; layer_type = "KVM-guest"; break; default: qc_debug(hdl, "Error: Unhandled layer type in qc_new_handle()\n"); return -1; } // determine number of attributes for (num_attrs = 0; attrs[num_attrs].offset >= 0; ++num_attrs); num_attrs++; if (hdl || *tgthdl == NULL) { // Possibly reuse existing handle when alloc'ing the cec layer. // Otherwise we'd change the handle which serves as an identified in // our log output, which could be confusing. *tgthdl = malloc(sizeof(struct qc_handle)); if (!*tgthdl) { qc_debug(hdl, "Error: Failed to allocate handle\n"); return -2; } } memset(*tgthdl, 0, sizeof(struct qc_handle)); (*tgthdl)->layer_no = layer_no; (*tgthdl)->attr_list = attrs; if (hdl) (*tgthdl)->root = hdl->root; else (*tgthdl)->root = *tgthdl; (*tgthdl)->layer = malloc(layer_sz); if (!(*tgthdl)->layer) { qc_debug(hdl, "Error: Failed to allocate layer\n"); free(*tgthdl); *tgthdl = NULL; return -3; } memset((*tgthdl)->layer, 0, layer_sz); (*tgthdl)->attr_present = calloc(num_attrs, sizeof(int)); (*tgthdl)->src = calloc(num_attrs, sizeof(int)); if (!(*tgthdl)->attr_present || !(*tgthdl)->src) { qc_debug(hdl, "Error: Failed to allocate attr_present array\n"); free((*tgthdl)->layer); free(*tgthdl); *tgthdl = NULL; return -4; } if (qc_set_attr_int(*tgthdl, qc_layer_type_num, layer_type_num, ATTR_SRC_UNDEF) || qc_set_attr_int(*tgthdl, qc_layer_category_num, layer_category_num, ATTR_SRC_UNDEF) || qc_set_attr_string(*tgthdl, qc_layer_type, layer_type, strlen(layer_type), ATTR_SRC_UNDEF) || qc_set_attr_string(*tgthdl, qc_layer_category, layer_category, strlen(layer_category), ATTR_SRC_UNDEF)) return -5; return 0; } int qc_insert_handle(struct qc_handle *hdl, struct qc_handle **inserted_hdl, int type) { struct qc_handle *prev_hdl = qc_get_prev_handle(hdl); if (!prev_hdl) return -1; if (qc_new_handle(hdl, inserted_hdl, hdl->layer_no, type)) return -2; (*inserted_hdl)->next = hdl; prev_hdl->next = *inserted_hdl; // adjust layer_no in remaining layers for (; hdl != NULL; hdl = hdl->next) hdl->layer_no++; return 0; } int qc_append_handle(struct qc_handle *hdl, struct qc_handle **appended_hdl, int type) { struct qc_handle *next_hdl = hdl->next; if (qc_new_handle(hdl, appended_hdl, hdl->layer_no + 1, type)) return -1; hdl->next = *appended_hdl; (*appended_hdl)->next = next_hdl; // adjust layer_no in remaining layers for (hdl = next_hdl; hdl != NULL; hdl = hdl->next) hdl->layer_no++; return 0; } static char *qc_set_attr(struct qc_handle *hdl, enum qc_attr_id id, enum qc_data_type type, char src) { struct qc_attr *attr_list = hdl->attr_list; int count; for (count = 0; attr_list[count].offset >= 0; ++count) { if (attr_list[count].id == id && attr_list[count].type == type) { hdl->attr_present[count] = 1; hdl->src[count] = src; return (char *)hdl->layer + attr_list[count].offset; } } qc_debug(hdl, "Error: Failed to set attr=%s\n", qc_attr_id_to_char(hdl, id)); return NULL; } // Sets attribute 'id' in layer as pointed to by 'hdl' int qc_set_attr_int(struct qc_handle *hdl, enum qc_attr_id id, int val, char src) { int *ptr; if ((ptr = (int *)qc_set_attr(hdl, id, integer, src)) == NULL) return -1; *ptr = val; return 0; } // Sets attribute 'id' in layer as pointed to by 'hdl' int qc_set_attr_float(struct qc_handle *hdl, enum qc_attr_id id, float val, char src) { float *ptr; if ((ptr = (float *)qc_set_attr(hdl, id, floatingpoint, src)) == NULL) return -1; *ptr = val; return 0; } // Sets string attribute 'id' in layer as pointed to by 'hdl', stripping trailing blanks int qc_set_attr_string(struct qc_handle *hdl, enum qc_attr_id id, char *str, unsigned int str_len, char src) { char *ptr, *p; if ((ptr = qc_set_attr(hdl, id, string, src)) == NULL) return -1; ptr[str_len] = '\0'; strncpy(ptr, str, str_len); // strip trailing blanks for (p = &ptr[str_len - 1]; *p == ' ' && p != ptr; --p) *p = '\0'; return 0; } // Sets ebcdic string attribute 'id' in layer as pointed to by 'hdl' // Note: Copy content to temporary buffer for conversion first, as we do not want to modify the source data. int qc_set_attr_ebcdic_string(struct qc_handle *hdl, enum qc_attr_id id, unsigned char *str, unsigned int str_len, iconv_t *cd, char src) { char *buf; int rc; buf = malloc(str_len + 1); if (!buf) { qc_debug(hdl, "Error: Memory allocation error\n"); return -1; } memset(buf, '\0', str_len + 1); memcpy(buf, str, str_len); if ((rc = qc_ebcdic_to_ascii(hdl, cd, buf, str_len)) == 0) { if (strlen(buf) && qc_set_attr_string(hdl, id, (char *)buf, str_len, src)) rc = -2; } free(buf); return rc; } // Certain parts assume that empty strings might also consist of spaces // Returns >0 if not empty, 0 if empty, and <0 for errors int qc_is_nonempty_ebcdic(struct qc_handle *hdl, const unsigned char *buf, unsigned int buflen, iconv_t *cd) { char str[9] = ""; // suffices for all users of this function if (*buf == '\0') return 0; if (buflen > sizeof(str)) { qc_debug(hdl, "Error: Insufficient static buffer length\n"); return -1; } memcpy(str, buf, buflen); if (qc_ebcdic_to_ascii(hdl, cd, str, sizeof(str))) return -2; return *str != '\0'; } // Sets attribute 'id' in layer as pointed to by 'hdl' static int qc_is_attr_set(struct qc_handle *hdl, enum qc_attr_id id, enum qc_data_type type) { struct qc_attr *attr_list = hdl->attr_list; int count = 0; while (attr_list[count].offset >= 0) { if (attr_list[count].id == id && attr_list[count].type == type) return hdl->attr_present[count]; count++; } return 0; } int qc_is_attr_set_int(struct qc_handle *hdl, enum qc_attr_id id) { return qc_is_attr_set(hdl, id, integer); } int qc_is_attr_set_float(struct qc_handle *hdl, enum qc_attr_id id) { return qc_is_attr_set(hdl, id, floatingpoint); } int qc_is_attr_set_string(struct qc_handle *hdl, enum qc_attr_id id) { return qc_is_attr_set(hdl, id, string); } struct qc_handle *qc_get_root_handle(struct qc_handle *hdl) { return hdl ? hdl->root : hdl; } struct qc_handle *qc_get_prev_handle(struct qc_handle *hdl) { struct qc_handle *prev_hdl = NULL; for (prev_hdl = hdl->root; prev_hdl->next != NULL; prev_hdl = prev_hdl->next) if (prev_hdl->next == hdl) return prev_hdl; qc_debug(hdl, "Error: Couldn't find handle pointing at layer %d handle\n", hdl->layer_no); return NULL; } /// Retrieve value of attribute 'id' of layer pointed at by 'hdl' static void *qc_get_attr_value(struct qc_handle *hdl, enum qc_attr_id id, enum qc_data_type type) { struct qc_attr *attr_list = hdl->attr_list; int count; for (count = 0; attr_list[count].offset >= 0; ++count) { if (attr_list[count].id == id && attr_list[count].type == type) { if (!hdl->attr_present[count]) return NULL; return (char *)hdl->layer + attr_list[count].offset; } } return NULL; } int *qc_get_attr_value_int(struct qc_handle *hdl, enum qc_attr_id id) { return (int *)qc_get_attr_value(hdl, id, integer); } float *qc_get_attr_value_float(struct qc_handle *hdl, enum qc_attr_id id) { return (float *)qc_get_attr_value(hdl, id, floatingpoint); } char *qc_get_attr_value_string(struct qc_handle *hdl, enum qc_attr_id id) { return (char *)qc_get_attr_value(hdl, id, string); } static char qc_get_attr_value_src(struct qc_handle *hdl, enum qc_attr_id id, enum qc_data_type type) { struct qc_attr *attr_list = hdl->attr_list; int count; for (count = 0; attr_list[count].offset >= 0; ++count) if (attr_list[count].id == id && attr_list[count].type == type) return hdl->src[count]; return 'x'; } char qc_get_attr_value_src_int(struct qc_handle *hdl, enum qc_attr_id id) { return qc_get_attr_value_src(hdl, id, integer); } char qc_get_attr_value_src_float(struct qc_handle *hdl, enum qc_attr_id id) { return qc_get_attr_value_src(hdl, id, floatingpoint); } char qc_get_attr_value_src_string(struct qc_handle *hdl, enum qc_attr_id id) { return qc_get_attr_value_src(hdl, id, string); } qclib-1.1.0/config.doxygen0000644000200300017500000030342712650354047014502 0ustar rasplraspl# Doxyfile 1.8.7 # This file describes the settings to be used by the documentation system # doxygen (www.doxygen.org) for a project. # # All text after a double hash (##) is considered a comment and is placed in # front of the TAG it is preceding. # # All text after a single hash (#) is considered a comment and will be ignored. # The format is: # TAG = value [value, ...] # For lists, items can also be appended using: # TAG += value [value, ...] # Values that contain spaces should be placed between quotes (\" \"). #--------------------------------------------------------------------------- # Project related configuration options #--------------------------------------------------------------------------- # This tag specifies the encoding used for all characters in the config file # that follow. The default is UTF-8 which is also the encoding used for all text # before the first occurrence of this tag. Doxygen uses libiconv (or the iconv # built into libc) for the transcoding. See http://www.gnu.org/software/libiconv # for the list of possible encodings. # The default value is: UTF-8. DOXYFILE_ENCODING = UTF-8 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by # double-quotes, unless you are using Doxywizard) that should identify the # project for which the documentation is generated. This name is used in the # title of most generated pages and in a few other places. # The default value is: My Project. PROJECT_NAME = qclib # The PROJECT_NUMBER tag can be used to enter a project or revision number. This # could be handy for archiving the generated documentation or if some version # control system is used. PROJECT_NUMBER = # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer a # quick idea about the purpose of the project. Keep the description short. PROJECT_BRIEF = # With the PROJECT_LOGO tag one can specify an logo or icon that is included in # the documentation. The maximum height of the logo should not exceed 55 pixels # and the maximum width should not exceed 200 pixels. Doxygen will copy the logo # to the output directory. PROJECT_LOGO = # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path # into which the generated documentation will be written. If a relative path is # entered, it will be relative to the location where doxygen was started. If # left blank the current directory will be used. OUTPUT_DIRECTORY = # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub- # directories (in 2 levels) under the output directory of each output format and # will distribute the generated files over these directories. Enabling this # option can be useful when feeding doxygen a huge amount of source files, where # putting all generated files in the same directory would otherwise causes # performance problems for the file system. # The default value is: NO. CREATE_SUBDIRS = NO # The OUTPUT_LANGUAGE tag is used to specify the language in which all # documentation generated by doxygen is written. Doxygen will use this # information to generate all constant output in the proper language. # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, # Ukrainian and Vietnamese. # The default value is: English. OUTPUT_LANGUAGE = English # If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member # descriptions after the members that are listed in the file and class # documentation (similar to Javadoc). Set to NO to disable this. # The default value is: YES. BRIEF_MEMBER_DESC = YES # If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief # description of a member or function before the detailed description # # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the # brief descriptions will be completely suppressed. # The default value is: YES. REPEAT_BRIEF = YES # This tag implements a quasi-intelligent brief description abbreviator that is # used to form the text in various listings. Each string in this list, if found # as the leading text of the brief description, will be stripped from the text # and the result, after processing the whole list, is used as the annotated # text. Otherwise, the brief description is used as-is. If left blank, the # following values are used ($name is automatically replaced with the name of # the entity):The $name class, The $name widget, The $name file, is, provides, # specifies, contains, represents, a, an and the. ABBREVIATE_BRIEF = # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then # doxygen will generate a detailed section even if there is only a brief # description. # The default value is: NO. ALWAYS_DETAILED_SEC = NO # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all # inherited members of a class in the documentation of that class as if those # members were ordinary class members. Constructors, destructors and assignment # operators of the base classes will not be shown. # The default value is: NO. INLINE_INHERITED_MEMB = NO # If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path # before files name in the file list and in the header files. If set to NO the # shortest path that makes the file name unique will be used # The default value is: YES. FULL_PATH_NAMES = YES # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. # Stripping is only done if one of the specified strings matches the left-hand # part of the path. The tag can be used to show relative paths in the file list. # If left blank the directory from which doxygen is run is used as the path to # strip. # # Note that you can specify absolute paths here, but also relative paths, which # will be relative from the directory where doxygen is started. # This tag requires that the tag FULL_PATH_NAMES is set to YES. STRIP_FROM_PATH = # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the # path mentioned in the documentation of a class, which tells the reader which # header file to include in order to use a class. If left blank only the name of # the header file containing the class definition is used. Otherwise one should # specify the list of include paths that are normally passed to the compiler # using the -I flag. STRIP_FROM_INC_PATH = # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but # less readable) file names. This can be useful is your file systems doesn't # support long names like on DOS, Mac, or CD-ROM. # The default value is: NO. SHORT_NAMES = NO # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the # first line (until the first dot) of a Javadoc-style comment as the brief # description. If set to NO, the Javadoc-style will behave just like regular Qt- # style comments (thus requiring an explicit @brief command for a brief # description.) # The default value is: NO. JAVADOC_AUTOBRIEF = NO # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first # line (until the first dot) of a Qt-style comment as the brief description. If # set to NO, the Qt-style will behave just like regular Qt-style comments (thus # requiring an explicit \brief command for a brief description.) # The default value is: NO. QT_AUTOBRIEF = NO # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a # multi-line C++ special comment block (i.e. a block of //! or /// comments) as # a brief description. This used to be the default behavior. The new default is # to treat a multi-line C++ comment block as a detailed description. Set this # tag to YES if you prefer the old behavior instead. # # Note that setting this tag to YES also means that rational rose comments are # not recognized any more. # The default value is: NO. MULTILINE_CPP_IS_BRIEF = NO # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the # documentation from any documented member that it re-implements. # The default value is: YES. INHERIT_DOCS = YES # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a # new page for each member. If set to NO, the documentation of a member will be # part of the file/class/namespace that contains it. # The default value is: NO. SEPARATE_MEMBER_PAGES = NO # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen # uses this value to replace tabs by spaces in code fragments. # Minimum value: 1, maximum value: 16, default value: 4. TAB_SIZE = 8 # This tag can be used to specify a number of aliases that act as commands in # the documentation. An alias has the form: # name=value # For example adding # "sideeffect=@par Side Effects:\n" # will allow you to put the command \sideeffect (or @sideeffect) in the # documentation, which will result in a user-defined paragraph with heading # "Side Effects:". You can put \n's in the value part of an alias to insert # newlines. ALIASES = # This tag can be used to specify a number of word-keyword mappings (TCL only). # A mapping has the form "name=value". For example adding "class=itcl::class" # will allow you to use the command class in the itcl::class meaning. TCL_SUBST = # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources # only. Doxygen will then generate output that is more tailored for C. For # instance, some of the names that are used will be different. The list of all # members will be omitted, etc. # The default value is: NO. OPTIMIZE_OUTPUT_FOR_C = YES # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or # Python sources only. Doxygen will then generate output that is more tailored # for that language. For instance, namespaces will be presented as packages, # qualified scopes will look different, etc. # The default value is: NO. OPTIMIZE_OUTPUT_JAVA = NO # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran # sources. Doxygen will then generate output that is tailored for Fortran. # The default value is: NO. OPTIMIZE_FOR_FORTRAN = NO # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL # sources. Doxygen will then generate output that is tailored for VHDL. # The default value is: NO. OPTIMIZE_OUTPUT_VHDL = NO # Doxygen selects the parser to use depending on the extension of the files it # parses. With this tag you can assign which parser to use for a given # extension. Doxygen has a built-in mapping, but you can override or extend it # using this tag. The format is ext=language, where ext is a file extension, and # language is one of the parsers supported by doxygen: IDL, Java, Javascript, # C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: # FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: # Fortran. In the later case the parser tries to guess whether the code is fixed # or free formatted code, this is the default for Fortran type files), VHDL. For # instance to make doxygen treat .inc files as Fortran files (default is PHP), # and .f files as C (default is Fortran), use: inc=Fortran f=C. # # Note For files without extension you can use no_extension as a placeholder. # # Note that for custom extensions you also need to set FILE_PATTERNS otherwise # the files are not read by doxygen. EXTENSION_MAPPING = # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments # according to the Markdown format, which allows for more readable # documentation. See http://daringfireball.net/projects/markdown/ for details. # The output of markdown processing is further processed by doxygen, so you can # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in # case of backward compatibilities issues. # The default value is: YES. MARKDOWN_SUPPORT = YES # When enabled doxygen tries to link words that correspond to documented # classes, or namespaces to their corresponding documentation. Such a link can # be prevented in individual cases by by putting a % sign in front of the word # or globally by setting AUTOLINK_SUPPORT to NO. # The default value is: YES. AUTOLINK_SUPPORT = YES # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want # to include (a tag file for) the STL sources as input, then you should set this # tag to YES in order to let doxygen match functions declarations and # definitions whose arguments contain STL classes (e.g. func(std::string); # versus func(std::string) {}). This also make the inheritance and collaboration # diagrams that involve STL classes more complete and accurate. # The default value is: NO. BUILTIN_STL_SUPPORT = NO # If you use Microsoft's C++/CLI language, you should set this option to YES to # enable parsing support. # The default value is: NO. CPP_CLI_SUPPORT = NO # Set the SIP_SUPPORT tag to YES if your project consists of sip (see: # http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen # will parse them like normal C++ but will assume all classes use public instead # of private inheritance when no explicit protection keyword is present. # The default value is: NO. SIP_SUPPORT = NO # For Microsoft's IDL there are propget and propput attributes to indicate # getter and setter methods for a property. Setting this option to YES will make # doxygen to replace the get and set methods by a property in the documentation. # This will only work if the methods are indeed getting or setting a simple # type. If this is not the case, or you want to show the methods anyway, you # should set this option to NO. # The default value is: YES. IDL_PROPERTY_SUPPORT = YES # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC # tag is set to YES, then doxygen will reuse the documentation of the first # member in the group (if any) for the other members of the group. By default # all members of a group must be documented explicitly. # The default value is: NO. DISTRIBUTE_GROUP_DOC = NO # Set the SUBGROUPING tag to YES to allow class member groups of the same type # (for instance a group of public functions) to be put as a subgroup of that # type (e.g. under the Public Functions section). Set it to NO to prevent # subgrouping. Alternatively, this can be done per class using the # \nosubgrouping command. # The default value is: YES. SUBGROUPING = YES # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions # are shown inside the group in which they are included (e.g. using \ingroup) # instead of on a separate page (for HTML and Man pages) or section (for LaTeX # and RTF). # # Note that this feature does not work in combination with # SEPARATE_MEMBER_PAGES. # The default value is: NO. INLINE_GROUPED_CLASSES = NO # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions # with only public data fields or simple typedef fields will be shown inline in # the documentation of the scope in which they are defined (i.e. file, # namespace, or group documentation), provided this scope is documented. If set # to NO, structs, classes, and unions are shown on a separate page (for HTML and # Man pages) or section (for LaTeX and RTF). # The default value is: NO. INLINE_SIMPLE_STRUCTS = NO # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or # enum is documented as struct, union, or enum with the name of the typedef. So # typedef struct TypeS {} TypeT, will appear in the documentation as a struct # with name TypeT. When disabled the typedef will appear as a member of a file, # namespace, or class. And the struct will be named TypeS. This can typically be # useful for C code in case the coding convention dictates that all compound # types are typedef'ed and only the typedef is referenced, never the tag name. # The default value is: NO. TYPEDEF_HIDES_STRUCT = NO # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This # cache is used to resolve symbols given their name and scope. Since this can be # an expensive process and often the same symbol appears multiple times in the # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small # doxygen will become slower. If the cache is too large, memory is wasted. The # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 # symbols. At the end of a run doxygen will report the cache usage and suggest # the optimal cache size from a speed point of view. # Minimum value: 0, maximum value: 9, default value: 0. LOOKUP_CACHE_SIZE = 0 #--------------------------------------------------------------------------- # Build related configuration options #--------------------------------------------------------------------------- # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in # documentation are documented, even if no documentation was available. Private # class members and static file members will be hidden unless the # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. # Note: This will also disable the warnings about undocumented members that are # normally produced when WARNINGS is set to YES. # The default value is: NO. EXTRACT_ALL = NO # If the EXTRACT_PRIVATE tag is set to YES all private members of a class will # be included in the documentation. # The default value is: NO. EXTRACT_PRIVATE = NO # If the EXTRACT_PACKAGE tag is set to YES all members with package or internal # scope will be included in the documentation. # The default value is: NO. EXTRACT_PACKAGE = NO # If the EXTRACT_STATIC tag is set to YES all static members of a file will be # included in the documentation. # The default value is: NO. EXTRACT_STATIC = YES # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined # locally in source files will be included in the documentation. If set to NO # only classes defined in header files are included. Does not have any effect # for Java sources. # The default value is: YES. EXTRACT_LOCAL_CLASSES = YES # This flag is only useful for Objective-C code. When set to YES local methods, # which are defined in the implementation section but not in the interface are # included in the documentation. If set to NO only methods in the interface are # included. # The default value is: NO. EXTRACT_LOCAL_METHODS = NO # If this flag is set to YES, the members of anonymous namespaces will be # extracted and appear in the documentation as a namespace called # 'anonymous_namespace{file}', where file will be replaced with the base name of # the file that contains the anonymous namespace. By default anonymous namespace # are hidden. # The default value is: NO. EXTRACT_ANON_NSPACES = NO # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all # undocumented members inside documented classes or files. If set to NO these # members will be included in the various overviews, but no documentation # section is generated. This option has no effect if EXTRACT_ALL is enabled. # The default value is: NO. HIDE_UNDOC_MEMBERS = NO # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all # undocumented classes that are normally visible in the class hierarchy. If set # to NO these classes will be included in the various overviews. This option has # no effect if EXTRACT_ALL is enabled. # The default value is: NO. HIDE_UNDOC_CLASSES = NO # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend # (class|struct|union) declarations. If set to NO these declarations will be # included in the documentation. # The default value is: NO. HIDE_FRIEND_COMPOUNDS = NO # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any # documentation blocks found inside the body of a function. If set to NO these # blocks will be appended to the function's detailed documentation block. # The default value is: NO. HIDE_IN_BODY_DOCS = NO # The INTERNAL_DOCS tag determines if documentation that is typed after a # \internal command is included. If the tag is set to NO then the documentation # will be excluded. Set it to YES to include the internal documentation. # The default value is: NO. INTERNAL_DOCS = NO # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file # names in lower-case letters. If set to YES upper-case letters are also # allowed. This is useful if you have classes or files whose names only differ # in case and if your file system supports case sensitive file names. Windows # and Mac users are advised to set this option to NO. # The default value is: system dependent. CASE_SENSE_NAMES = YES # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with # their full class and namespace scopes in the documentation. If set to YES the # scope will be hidden. # The default value is: NO. HIDE_SCOPE_NAMES = NO # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of # the files that are included by a file in the documentation of that file. # The default value is: YES. SHOW_INCLUDE_FILES = NO # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each # grouped member an include statement to the documentation, telling the reader # which file to include in order to use the member. # The default value is: NO. SHOW_GROUPED_MEMB_INC = NO # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include # files with double quotes in the documentation rather than with sharp brackets. # The default value is: NO. FORCE_LOCAL_INCLUDES = NO # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the # documentation for inline members. # The default value is: YES. INLINE_INFO = YES # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the # (detailed) documentation of file and class members alphabetically by member # name. If set to NO the members will appear in declaration order. # The default value is: YES. SORT_MEMBER_DOCS = YES # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief # descriptions of file, namespace and class members alphabetically by member # name. If set to NO the members will appear in declaration order. Note that # this will also influence the order of the classes in the class list. # The default value is: NO. SORT_BRIEF_DOCS = NO # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the # (brief and detailed) documentation of class members so that constructors and # destructors are listed first. If set to NO the constructors will appear in the # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief # member documentation. # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting # detailed member documentation. # The default value is: NO. SORT_MEMBERS_CTORS_1ST = NO # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy # of group names into alphabetical order. If set to NO the group names will # appear in their defined order. # The default value is: NO. SORT_GROUP_NAMES = NO # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by # fully-qualified names, including namespaces. If set to NO, the class list will # be sorted only by class name, not including the namespace part. # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. # Note: This option applies only to the class list, not to the alphabetical # list. # The default value is: NO. SORT_BY_SCOPE_NAME = NO # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper # type resolution of all parameters of a function it will reject a match between # the prototype and the implementation of a member function even if there is # only one candidate or it is obvious which candidate to choose by doing a # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still # accept a match between prototype and implementation in such cases. # The default value is: NO. STRICT_PROTO_MATCHING = NO # The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the # todo list. This list is created by putting \todo commands in the # documentation. # The default value is: YES. GENERATE_TODOLIST = YES # The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the # test list. This list is created by putting \test commands in the # documentation. # The default value is: YES. GENERATE_TESTLIST = YES # The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug # list. This list is created by putting \bug commands in the documentation. # The default value is: YES. GENERATE_BUGLIST = YES # The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO) # the deprecated list. This list is created by putting \deprecated commands in # the documentation. # The default value is: YES. GENERATE_DEPRECATEDLIST= YES # The ENABLED_SECTIONS tag can be used to enable conditional documentation # sections, marked by \if ... \endif and \cond # ... \endcond blocks. ENABLED_SECTIONS = # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the # initial value of a variable or macro / define can have for it to appear in the # documentation. If the initializer consists of more lines than specified here # it will be hidden. Use a value of 0 to hide initializers completely. The # appearance of the value of individual variables and macros / defines can be # controlled using \showinitializer or \hideinitializer command in the # documentation regardless of this setting. # Minimum value: 0, maximum value: 10000, default value: 30. MAX_INITIALIZER_LINES = 30 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at # the bottom of the documentation of classes and structs. If set to YES the list # will mention the files that were used to generate the documentation. # The default value is: YES. SHOW_USED_FILES = YES # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This # will remove the Files entry from the Quick Index and from the Folder Tree View # (if specified). # The default value is: YES. SHOW_FILES = YES # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces # page. This will remove the Namespaces entry from the Quick Index and from the # Folder Tree View (if specified). # The default value is: YES. SHOW_NAMESPACES = YES # The FILE_VERSION_FILTER tag can be used to specify a program or script that # doxygen should invoke to get the current version for each file (typically from # the version control system). Doxygen will invoke the program by executing (via # popen()) the command command input-file, where command is the value of the # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided # by doxygen. Whatever the program writes to standard output is used as the file # version. For an example see the documentation. FILE_VERSION_FILTER = # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed # by doxygen. The layout file controls the global structure of the generated # output files in an output format independent way. To create the layout file # that represents doxygen's defaults, run doxygen with the -l option. You can # optionally specify a file name after the option, if omitted DoxygenLayout.xml # will be used as the name of the layout file. # # Note that if you run doxygen from a directory containing a file called # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE # tag is left empty. LAYOUT_FILE = # The CITE_BIB_FILES tag can be used to specify one or more bib files containing # the reference definitions. This must be a list of .bib files. The .bib # extension is automatically appended if omitted. This requires the bibtex tool # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. # For LaTeX the style of the bibliography can be controlled using # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the # search path. Do not use file names with spaces, bibtex cannot handle them. See # also \cite for info how to create references. CITE_BIB_FILES = #--------------------------------------------------------------------------- # Configuration options related to warning and progress messages #--------------------------------------------------------------------------- # The QUIET tag can be used to turn on/off the messages that are generated to # standard output by doxygen. If QUIET is set to YES this implies that the # messages are off. # The default value is: NO. QUIET = NO # The WARNINGS tag can be used to turn on/off the warning messages that are # generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES # this implies that the warnings are on. # # Tip: Turn warnings on while writing the documentation. # The default value is: YES. WARNINGS = YES # If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag # will automatically be disabled. # The default value is: YES. WARN_IF_UNDOCUMENTED = NO # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for # potential errors in the documentation, such as not documenting some parameters # in a documented function, or documenting parameters that don't exist or using # markup commands wrongly. # The default value is: YES. WARN_IF_DOC_ERROR = YES # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that # are documented, but have no documentation for their parameters or return # value. If set to NO doxygen will only warn about wrong or incomplete parameter # documentation, but not about the absence of documentation. # The default value is: NO. WARN_NO_PARAMDOC = NO # The WARN_FORMAT tag determines the format of the warning messages that doxygen # can produce. The string should contain the $file, $line, and $text tags, which # will be replaced by the file and line number from which the warning originated # and the warning text. Optionally the format may contain $version, which will # be replaced by the version of the file (if it could be obtained via # FILE_VERSION_FILTER) # The default value is: $file:$line: $text. WARN_FORMAT = "$file:$line: $text" # The WARN_LOGFILE tag can be used to specify a file to which warning and error # messages should be written. If left blank the output is written to standard # error (stderr). WARN_LOGFILE = #--------------------------------------------------------------------------- # Configuration options related to the input files #--------------------------------------------------------------------------- # The INPUT tag is used to specify the files and/or directories that contain # documented source files. You may enter file names like myfile.cpp or # directories like /usr/src/myproject. Separate the files or directories with # spaces. # Note: If this tag is empty the current directory is searched. INPUT = # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses # libiconv (or the iconv built into libc) for the transcoding. See the libiconv # documentation (see: http://www.gnu.org/software/libiconv) for the list of # possible encodings. # The default value is: UTF-8. INPUT_ENCODING = UTF-8 # If the value of the INPUT tag contains directories, you can use the # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and # *.h) to filter out the source-files in the directories. If left blank the # following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii, # *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, # *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, # *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, # *.qsf, *.as and *.js. FILE_PATTERNS = *.c *.h # The RECURSIVE tag can be used to specify whether or not subdirectories should # be searched for input files as well. # The default value is: NO. RECURSIVE = NO # The EXCLUDE tag can be used to specify files and/or directories that should be # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. # # Note that relative paths are relative to the directory from which doxygen is # run. EXCLUDE = qc_test.c hcpinfbk.h query_capacity_int.h # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or # directories that are symbolic links (a Unix file system feature) are excluded # from the input. # The default value is: NO. EXCLUDE_SYMLINKS = NO # If the value of the INPUT tag contains directories, you can use the # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude # certain files from those directories. # # Note that the wildcards are matched against the file with absolute path, so to # exclude all test directories for example use the pattern */test/* EXCLUDE_PATTERNS = # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names # (namespaces, classes, functions, etc.) that should be excluded from the # output. The symbol name can be a fully qualified name, a word, or if the # wildcard * is used, a substring. Examples: ANamespace, AClass, # AClass::ANamespace, ANamespace::*Test # # Note that the wildcards are matched against the file with absolute path, so to # exclude all test directories use the pattern */test/* EXCLUDE_SYMBOLS = # The EXAMPLE_PATH tag can be used to specify one or more files or directories # that contain example code fragments that are included (see the \include # command). EXAMPLE_PATH = # If the value of the EXAMPLE_PATH tag contains directories, you can use the # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and # *.h) to filter out the source-files in the directories. If left blank all # files are included. EXAMPLE_PATTERNS = # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be # searched for input files to be used with the \include or \dontinclude commands # irrespective of the value of the RECURSIVE tag. # The default value is: NO. EXAMPLE_RECURSIVE = NO # The IMAGE_PATH tag can be used to specify one or more files or directories # that contain images that are to be included in the documentation (see the # \image command). IMAGE_PATH = # The INPUT_FILTER tag can be used to specify a program that doxygen should # invoke to filter for each input file. Doxygen will invoke the filter program # by executing (via popen()) the command: # # # # where is the value of the INPUT_FILTER tag, and is the # name of an input file. Doxygen will then use the output that the filter # program writes to standard output. If FILTER_PATTERNS is specified, this tag # will be ignored. # # Note that the filter must not add or remove lines; it is applied before the # code is scanned, but not when the output code is generated. If lines are added # or removed, the anchors will not be placed correctly. INPUT_FILTER = # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern # basis. Doxygen will compare the file name with each pattern and apply the # filter if there is a match. The filters are a list of the form: pattern=filter # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how # filters are used. If the FILTER_PATTERNS tag is empty or if none of the # patterns match the file name, INPUT_FILTER is applied. FILTER_PATTERNS = # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using # INPUT_FILTER ) will also be used to filter the input files that are used for # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). # The default value is: NO. FILTER_SOURCE_FILES = NO # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and # it is also possible to disable source filtering for a specific pattern using # *.ext= (so without naming a filter). # This tag requires that the tag FILTER_SOURCE_FILES is set to YES. FILTER_SOURCE_PATTERNS = # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that # is part of the input, its contents will be placed on the main page # (index.html). This can be useful if you have a project on for instance GitHub # and want to reuse the introduction page also for the doxygen output. USE_MDFILE_AS_MAINPAGE = #--------------------------------------------------------------------------- # Configuration options related to source browsing #--------------------------------------------------------------------------- # If the SOURCE_BROWSER tag is set to YES then a list of source files will be # generated. Documented entities will be cross-referenced with these sources. # # Note: To get rid of all source code in the generated output, make sure that # also VERBATIM_HEADERS is set to NO. # The default value is: NO. SOURCE_BROWSER = NO # Setting the INLINE_SOURCES tag to YES will include the body of functions, # classes and enums directly into the documentation. # The default value is: NO. INLINE_SOURCES = NO # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any # special comment blocks from generated source code fragments. Normal C, C++ and # Fortran comments will always remain visible. # The default value is: YES. STRIP_CODE_COMMENTS = YES # If the REFERENCED_BY_RELATION tag is set to YES then for each documented # function all documented functions referencing it will be listed. # The default value is: NO. REFERENCED_BY_RELATION = NO # If the REFERENCES_RELATION tag is set to YES then for each documented function # all documented entities called/used by that function will be listed. # The default value is: NO. REFERENCES_RELATION = NO # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set # to YES, then the hyperlinks from functions in REFERENCES_RELATION and # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will # link to the documentation. # The default value is: YES. REFERENCES_LINK_SOURCE = YES # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the # source code will show a tooltip with additional information such as prototype, # brief description and links to the definition and documentation. Since this # will make the HTML file larger and loading of large files a bit slower, you # can opt to disable this feature. # The default value is: YES. # This tag requires that the tag SOURCE_BROWSER is set to YES. SOURCE_TOOLTIPS = YES # If the USE_HTAGS tag is set to YES then the references to source code will # point to the HTML generated by the htags(1) tool instead of doxygen built-in # source browser. The htags tool is part of GNU's global source tagging system # (see http://www.gnu.org/software/global/global.html). You will need version # 4.8.6 or higher. # # To use it do the following: # - Install the latest version of global # - Enable SOURCE_BROWSER and USE_HTAGS in the config file # - Make sure the INPUT points to the root of the source tree # - Run doxygen as normal # # Doxygen will invoke htags (and that will in turn invoke gtags), so these # tools must be available from the command line (i.e. in the search path). # # The result: instead of the source browser generated by doxygen, the links to # source code will now point to the output of htags. # The default value is: NO. # This tag requires that the tag SOURCE_BROWSER is set to YES. USE_HTAGS = NO # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a # verbatim copy of the header file for each class for which an include is # specified. Set to NO to disable this. # See also: Section \class. # The default value is: YES. VERBATIM_HEADERS = YES #--------------------------------------------------------------------------- # Configuration options related to the alphabetical class index #--------------------------------------------------------------------------- # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all # compounds will be generated. Enable this if the project contains a lot of # classes, structs, unions or interfaces. # The default value is: YES. ALPHABETICAL_INDEX = YES # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in # which the alphabetical index list will be split. # Minimum value: 1, maximum value: 20, default value: 5. # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. COLS_IN_ALPHA_INDEX = 5 # In case all classes in a project start with a common prefix, all classes will # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag # can be used to specify a prefix (or a list of prefixes) that should be ignored # while generating the index headers. # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. IGNORE_PREFIX = #--------------------------------------------------------------------------- # Configuration options related to the HTML output #--------------------------------------------------------------------------- # If the GENERATE_HTML tag is set to YES doxygen will generate HTML output # The default value is: YES. GENERATE_HTML = YES # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of # it. # The default directory is: html. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_OUTPUT = html # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each # generated HTML page (for example: .htm, .php, .asp). # The default value is: .html. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_FILE_EXTENSION = .html # The HTML_HEADER tag can be used to specify a user-defined HTML header file for # each generated HTML page. If the tag is left blank doxygen will generate a # standard header. # # To get valid HTML the header file that includes any scripts and style sheets # that doxygen needs, which is dependent on the configuration options used (e.g. # the setting GENERATE_TREEVIEW). It is highly recommended to start with a # default header using # doxygen -w html new_header.html new_footer.html new_stylesheet.css # YourConfigFile # and then modify the file new_header.html. See also section "Doxygen usage" # for information on how to generate the default header that doxygen normally # uses. # Note: The header is subject to change so you typically have to regenerate the # default header when upgrading to a newer version of doxygen. For a description # of the possible markers and block names see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_HEADER = # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each # generated HTML page. If the tag is left blank doxygen will generate a standard # footer. See HTML_HEADER for more information on how to generate a default # footer and what special commands can be used inside the footer. See also # section "Doxygen usage" for information on how to generate the default footer # that doxygen normally uses. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_FOOTER = # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style # sheet that is used by each HTML page. It can be used to fine-tune the look of # the HTML output. If left blank doxygen will generate a default style sheet. # See also section "Doxygen usage" for information on how to generate the style # sheet that doxygen normally uses. # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as # it is more robust and this tag (HTML_STYLESHEET) will in the future become # obsolete. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_STYLESHEET = # The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user- # defined cascading style sheet that is included after the standard style sheets # created by doxygen. Using this option one can overrule certain style aspects. # This is preferred over using HTML_STYLESHEET since it does not replace the # standard style sheet and is therefor more robust against future updates. # Doxygen will copy the style sheet file to the output directory. For an example # see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_EXTRA_STYLESHEET = # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or # other source files which should be copied to the HTML output directory. Note # that these files will be copied to the base HTML output directory. Use the # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these # files. In the HTML_STYLESHEET file, use the file name only. Also note that the # files will be copied as-is; there are no commands or markers available. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_EXTRA_FILES = # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen # will adjust the colors in the stylesheet and background images according to # this color. Hue is specified as an angle on a colorwheel, see # http://en.wikipedia.org/wiki/Hue for more information. For instance the value # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 # purple, and 360 is red again. # Minimum value: 0, maximum value: 359, default value: 220. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_COLORSTYLE_HUE = 220 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors # in the HTML output. For a value of 0 the output will use grayscales only. A # value of 255 will produce the most vivid colors. # Minimum value: 0, maximum value: 255, default value: 100. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_COLORSTYLE_SAT = 100 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the # luminance component of the colors in the HTML output. Values below 100 # gradually make the output lighter, whereas values above 100 make the output # darker. The value divided by 100 is the actual gamma applied, so 80 represents # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not # change the gamma. # Minimum value: 40, maximum value: 240, default value: 80. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_COLORSTYLE_GAMMA = 80 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML # page will contain the date and time when the page was generated. Setting this # to NO can help when comparing the output of multiple runs. # The default value is: YES. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_TIMESTAMP = YES # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML # documentation will contain sections that can be hidden and shown after the # page has loaded. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_DYNAMIC_SECTIONS = NO # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries # shown in the various tree structured indices initially; the user can expand # and collapse entries dynamically later on. Doxygen will expand the tree to # such a level that at most the specified number of entries are visible (unless # a fully collapsed tree already exceeds this amount). So setting the number of # entries 1 will produce a full collapsed tree by default. 0 is a special value # representing an infinite number of entries and will result in a full expanded # tree by default. # Minimum value: 0, maximum value: 9999, default value: 100. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_INDEX_NUM_ENTRIES = 100 # If the GENERATE_DOCSET tag is set to YES, additional index files will be # generated that can be used as input for Apple's Xcode 3 integrated development # environment (see: http://developer.apple.com/tools/xcode/), introduced with # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a # Makefile in the HTML output directory. Running make will produce the docset in # that directory and running make install will install the docset in # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at # startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html # for more information. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_DOCSET = NO # This tag determines the name of the docset feed. A documentation feed provides # an umbrella under which multiple documentation sets from a single provider # (such as a company or product suite) can be grouped. # The default value is: Doxygen generated docs. # This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_FEEDNAME = "Doxygen generated docs" # This tag specifies a string that should uniquely identify the documentation # set bundle. This should be a reverse domain-name style string, e.g. # com.mycompany.MyDocSet. Doxygen will append .docset to the name. # The default value is: org.doxygen.Project. # This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_BUNDLE_ID = org.doxygen.Project # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify # the documentation publisher. This should be a reverse domain-name style # string, e.g. com.mycompany.MyDocSet.documentation. # The default value is: org.doxygen.Publisher. # This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_PUBLISHER_ID = org.doxygen.Publisher # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. # The default value is: Publisher. # This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_PUBLISHER_NAME = Publisher # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three # additional HTML index files: index.hhp, index.hhc, and index.hhk. The # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on # Windows. # # The HTML Help Workshop contains a compiler that can convert all HTML output # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML # files are now used as the Windows 98 help format, and will replace the old # Windows help format (.hlp) on all Windows platforms in the future. Compressed # HTML files also contain an index, a table of contents, and you can search for # words in the documentation. The HTML workshop also contains a viewer for # compressed HTML files. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_HTMLHELP = NO # The CHM_FILE tag can be used to specify the file name of the resulting .chm # file. You can add a path in front of the file if the result should not be # written to the html output directory. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. CHM_FILE = # The HHC_LOCATION tag can be used to specify the location (absolute path # including file name) of the HTML help compiler ( hhc.exe). If non-empty # doxygen will try to run the HTML help compiler on the generated index.hhp. # The file has to be specified with full path. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. HHC_LOCATION = # The GENERATE_CHI flag controls if a separate .chi index file is generated ( # YES) or that it should be included in the master .chm file ( NO). # The default value is: NO. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. GENERATE_CHI = NO # The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc) # and project file content. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. CHM_INDEX_ENCODING = # The BINARY_TOC flag controls whether a binary table of contents is generated ( # YES) or a normal table of contents ( NO) in the .chm file. Furthermore it # enables the Previous and Next buttons. # The default value is: NO. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. BINARY_TOC = NO # The TOC_EXPAND flag can be set to YES to add extra items for group members to # the table of contents of the HTML help documentation and to the tree view. # The default value is: NO. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. TOC_EXPAND = NO # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help # (.qch) of the generated HTML documentation. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_QHP = NO # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify # the file name of the resulting .qch file. The path specified is relative to # the HTML output folder. # This tag requires that the tag GENERATE_QHP is set to YES. QCH_FILE = # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help # Project output. For more information please see Qt Help Project / Namespace # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). # The default value is: org.doxygen.Project. # This tag requires that the tag GENERATE_QHP is set to YES. QHP_NAMESPACE = org.doxygen.Project # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt # Help Project output. For more information please see Qt Help Project / Virtual # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- # folders). # The default value is: doc. # This tag requires that the tag GENERATE_QHP is set to YES. QHP_VIRTUAL_FOLDER = doc # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom # filter to add. For more information please see Qt Help Project / Custom # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- # filters). # This tag requires that the tag GENERATE_QHP is set to YES. QHP_CUST_FILTER_NAME = # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the # custom filter to add. For more information please see Qt Help Project / Custom # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- # filters). # This tag requires that the tag GENERATE_QHP is set to YES. QHP_CUST_FILTER_ATTRS = # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this # project's filter section matches. Qt Help Project / Filter Attributes (see: # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). # This tag requires that the tag GENERATE_QHP is set to YES. QHP_SECT_FILTER_ATTRS = # The QHG_LOCATION tag can be used to specify the location of Qt's # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the # generated .qhp file. # This tag requires that the tag GENERATE_QHP is set to YES. QHG_LOCATION = # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be # generated, together with the HTML files, they form an Eclipse help plugin. To # install this plugin and make it available under the help contents menu in # Eclipse, the contents of the directory containing the HTML and XML files needs # to be copied into the plugins directory of eclipse. The name of the directory # within the plugins directory should be the same as the ECLIPSE_DOC_ID value. # After copying Eclipse needs to be restarted before the help appears. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_ECLIPSEHELP = NO # A unique identifier for the Eclipse help plugin. When installing the plugin # the directory name containing the HTML and XML files should also have this # name. Each documentation set should have its own identifier. # The default value is: org.doxygen.Project. # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. ECLIPSE_DOC_ID = org.doxygen.Project # If you want full control over the layout of the generated HTML pages it might # be necessary to disable the index and replace it with your own. The # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top # of each HTML page. A value of NO enables the index and the value YES disables # it. Since the tabs in the index contain the same information as the navigation # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. DISABLE_INDEX = NO # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index # structure should be generated to display hierarchical information. If the tag # value is set to YES, a side panel will be generated containing a tree-like # index structure (just like the one that is generated for HTML Help). For this # to work a browser that supports JavaScript, DHTML, CSS and frames is required # (i.e. any modern browser). Windows users are probably better off using the # HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can # further fine-tune the look of the index. As an example, the default style # sheet generated by doxygen has an example that shows how to put an image at # the root of the tree instead of the PROJECT_NAME. Since the tree basically has # the same information as the tab index, you could consider setting # DISABLE_INDEX to YES when enabling this option. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_TREEVIEW = NO # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that # doxygen will group on one line in the generated HTML documentation. # # Note that a value of 0 will completely suppress the enum values from appearing # in the overview section. # Minimum value: 0, maximum value: 20, default value: 4. # This tag requires that the tag GENERATE_HTML is set to YES. ENUM_VALUES_PER_LINE = 4 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used # to set the initial width (in pixels) of the frame in which the tree is shown. # Minimum value: 0, maximum value: 1500, default value: 250. # This tag requires that the tag GENERATE_HTML is set to YES. TREEVIEW_WIDTH = 250 # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to # external symbols imported via tag files in a separate window. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. EXT_LINKS_IN_WINDOW = NO # Use this tag to change the font size of LaTeX formulas included as images in # the HTML documentation. When you change the font size after a successful # doxygen run you need to manually remove any form_*.png images from the HTML # output directory to force them to be regenerated. # Minimum value: 8, maximum value: 50, default value: 10. # This tag requires that the tag GENERATE_HTML is set to YES. FORMULA_FONTSIZE = 10 # Use the FORMULA_TRANPARENT tag to determine whether or not the images # generated for formulas are transparent PNGs. Transparent PNGs are not # supported properly for IE 6.0, but are supported on all modern browsers. # # Note that when changing this option you need to delete any form_*.png files in # the HTML output directory before the changes have effect. # The default value is: YES. # This tag requires that the tag GENERATE_HTML is set to YES. FORMULA_TRANSPARENT = YES # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see # http://www.mathjax.org) which uses client side Javascript for the rendering # instead of using prerendered bitmaps. Use this if you do not have LaTeX # installed or if you want to formulas look prettier in the HTML output. When # enabled you may also need to install MathJax separately and configure the path # to it using the MATHJAX_RELPATH option. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. USE_MATHJAX = NO # When MathJax is enabled you can set the default output format to be used for # the MathJax output. See the MathJax site (see: # http://docs.mathjax.org/en/latest/output.html) for more details. # Possible values are: HTML-CSS (which is slower, but has the best # compatibility), NativeMML (i.e. MathML) and SVG. # The default value is: HTML-CSS. # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_FORMAT = HTML-CSS # When MathJax is enabled you need to specify the location relative to the HTML # output directory using the MATHJAX_RELPATH option. The destination directory # should contain the MathJax.js script. For instance, if the mathjax directory # is located at the same level as the HTML output directory, then # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax # Content Delivery Network so you can quickly see the result without installing # MathJax. However, it is strongly recommended to install a local copy of # MathJax from http://www.mathjax.org before deployment. # The default value is: http://cdn.mathjax.org/mathjax/latest. # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax # extension names that should be enabled during MathJax rendering. For example # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_EXTENSIONS = # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces # of code that will be used on startup of the MathJax code. See the MathJax site # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an # example see the documentation. # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_CODEFILE = # When the SEARCHENGINE tag is enabled doxygen will generate a search box for # the HTML output. The underlying search engine uses javascript and DHTML and # should work on any modern browser. Note that when using HTML help # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) # there is already a search function so this one should typically be disabled. # For large projects the javascript based search engine can be slow, then # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to # search using the keyboard; to jump to the search box use + S # (what the is depends on the OS and browser, but it is typically # , /