mirror of
git://sourceware.org/git/lvm2.git
synced 2024-12-21 13:34:40 +03:00
6d667adeea
The "<lvm command> -S/--select help" shows help (including list of fields to match against):
...field list here including the field type name...
Selection operands
------------------
field - Reporting field.
number - Non-negative integer value.
size - Floating point value with units specified.
string - Characters quoted by ' or " or unquoted.
string list - Strings enclosed by [ ] and elements delimited by either
"all items must match" or "at least one item must match" operator.
regular expression - Characters quoted by ' or " or unquoted.
Selection operators
-------------------
Comparison operators:
=~ - Matching regular expression.
!~ - Not matching regular expression.
= - Equal to.
!= - Not equal to.
>= - Greater than or equal to.
> - Greater than
<= - Less than or equal to.
< - Less than.
Logical and grouping operators:
&& - All fields must match
, - All fields must match
|| - At least one field must match
# - At least one field must match
! - Logical negation
( - Left parenthesis
) - Right parenthesis
[ - List start
] - List end
2531 lines
63 KiB
C
2531 lines
63 KiB
C
/*
|
|
* Copyright (C) 2002-2004 Sistina Software, Inc. All rights reserved.
|
|
* Copyright (C) 2004-2007 Red Hat, Inc. All rights reserved.
|
|
*
|
|
* This file is part of the device-mapper userspace tools.
|
|
*
|
|
* This copyrighted material is made available to anyone wishing to use,
|
|
* modify, copy, or redistribute it subject to the terms and conditions
|
|
* of the GNU Lesser General Public License v.2.1.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public License
|
|
* along with this program; if not, write to the Free Software Foundation,
|
|
* Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
|
*/
|
|
|
|
#include "dmlib.h"
|
|
|
|
#include <ctype.h>
|
|
#include <math.h> /* fabs() */
|
|
#include <float.h> /* DBL_EPSILON */
|
|
|
|
/*
|
|
* Internal flags
|
|
*/
|
|
#define RH_SORT_REQUIRED 0x00000100
|
|
#define RH_HEADINGS_PRINTED 0x00000200
|
|
|
|
struct dm_report {
|
|
struct dm_pool *mem;
|
|
|
|
/* To report all available types */
|
|
#define REPORT_TYPES_ALL UINT32_MAX
|
|
uint32_t report_types;
|
|
const char *output_field_name_prefix;
|
|
const char *field_prefix;
|
|
uint32_t flags;
|
|
const char *separator;
|
|
|
|
uint32_t keys_count;
|
|
|
|
/* Ordered list of fields needed for this report */
|
|
struct dm_list field_props;
|
|
|
|
/* Rows of report data */
|
|
struct dm_list rows;
|
|
|
|
/* Array of field definitions */
|
|
const struct dm_report_field_type *fields;
|
|
const struct dm_report_object_type *types;
|
|
|
|
/* To store caller private data */
|
|
void *private;
|
|
|
|
struct selection_node *selection_root;
|
|
};
|
|
|
|
/*
|
|
* Internal per-field flags
|
|
*/
|
|
#define FLD_HIDDEN 0x00000100
|
|
#define FLD_SORT_KEY 0x00000200
|
|
#define FLD_ASCENDING 0x00000400
|
|
#define FLD_DESCENDING 0x00000800
|
|
|
|
struct field_properties {
|
|
struct dm_list list;
|
|
uint32_t field_num;
|
|
uint32_t sort_posn;
|
|
int32_t width;
|
|
const struct dm_report_object_type *type;
|
|
uint32_t flags;
|
|
};
|
|
|
|
/*
|
|
* Report selection
|
|
*/
|
|
struct op_def {
|
|
const char *string;
|
|
uint32_t flags;
|
|
const char *desc;
|
|
};
|
|
|
|
#define FLD_CMP_MASK 0x000FF000
|
|
#define FLD_CMP_EQUAL 0x00001000
|
|
#define FLD_CMP_NOT 0x00002000
|
|
#define FLD_CMP_GT 0x00004000
|
|
#define FLD_CMP_LT 0x00008000
|
|
#define FLD_CMP_REGEX 0x00010000
|
|
#define FLD_CMP_NUMBER 0x00020000
|
|
/*
|
|
* #define FLD_CMP_STRING 0x00040000
|
|
* We could defined FLD_CMP_STRING here for completeness here,
|
|
* but it's not needed - we can check operator compatibility with
|
|
* field type by using FLD_CMP_REGEX and FLD_CMP_NUMBER flags only.
|
|
*/
|
|
|
|
/*
|
|
* When defining operators, always define longer one before
|
|
* shorter one if one is a prefix of another!
|
|
* (e.g. =~ comes before =)
|
|
*/
|
|
static struct op_def _op_cmp[] = {
|
|
{ "=~", FLD_CMP_REGEX, "Matching regular expression." },
|
|
{ "!~", FLD_CMP_REGEX|FLD_CMP_NOT, "Not matching regular expression." },
|
|
{ "=", FLD_CMP_EQUAL, "Equal to." },
|
|
{ "!=", FLD_CMP_NOT|FLD_CMP_EQUAL, "Not equal to." },
|
|
{ ">=", FLD_CMP_NUMBER|FLD_CMP_GT|FLD_CMP_EQUAL, "Greater than or equal to." },
|
|
{ ">", FLD_CMP_NUMBER|FLD_CMP_GT, "Greater than" },
|
|
{ "<=", FLD_CMP_NUMBER|FLD_CMP_LT|FLD_CMP_EQUAL, "Less than or equal to." },
|
|
{ "<", FLD_CMP_NUMBER|FLD_CMP_LT, "Less than." },
|
|
{ NULL, 0, NULL }
|
|
};
|
|
|
|
#define SEL_MASK 0x000000FF
|
|
#define SEL_ITEM 0x00000001
|
|
#define SEL_AND 0x00000002
|
|
#define SEL_OR 0x00000004
|
|
|
|
#define SEL_MODIFIER_MASK 0x00000F00
|
|
#define SEL_MODIFIER_NOT 0x00000100
|
|
|
|
#define SEL_PRECEDENCE_MASK 0x0000F000
|
|
#define SEL_PRECEDENCE_PS 0x00001000
|
|
#define SEL_PRECEDENCE_PE 0x00002000
|
|
|
|
#define SEL_LIST_MASK 0x000F0000
|
|
#define SEL_LIST_LS 0x00010000
|
|
#define SEL_LIST_LE 0x00020000
|
|
|
|
static struct op_def _op_log[] = {
|
|
{ "&&", SEL_AND, "All fields must match" },
|
|
{ ",", SEL_AND, "All fields must match" },
|
|
{ "||", SEL_OR, "At least one field must match" },
|
|
{ "#", SEL_OR, "At least one field must match" },
|
|
{ "!", SEL_MODIFIER_NOT, "Logical negation" },
|
|
{ "(", SEL_PRECEDENCE_PS, "Left parenthesis" },
|
|
{ ")", SEL_PRECEDENCE_PE, "Right parenthesis" },
|
|
{ "[", SEL_LIST_LS, "List start" },
|
|
{ "]", SEL_LIST_LE, "List end"},
|
|
{ NULL, 0, NULL},
|
|
};
|
|
|
|
struct selection_str_list {
|
|
unsigned type; /* either SEL_AND or SEL_OR */
|
|
struct dm_list *list;
|
|
};
|
|
|
|
struct field_selection {
|
|
struct field_properties *fp;
|
|
uint32_t flags;
|
|
union {
|
|
const char *s;
|
|
uint64_t i;
|
|
double d;
|
|
struct dm_regex *r;
|
|
struct selection_str_list *l;
|
|
} v;
|
|
};
|
|
|
|
struct selection_node {
|
|
struct dm_list list;
|
|
uint32_t type;
|
|
union {
|
|
struct field_selection *item;
|
|
struct dm_list set;
|
|
} selection;
|
|
};
|
|
|
|
/*
|
|
* Report data field
|
|
*/
|
|
struct dm_report_field {
|
|
struct dm_list list;
|
|
struct field_properties *props;
|
|
|
|
const char *report_string; /* Formatted ready for display */
|
|
const void *sort_value; /* Raw value for sorting */
|
|
};
|
|
|
|
struct row {
|
|
struct dm_list list;
|
|
struct dm_report *rh;
|
|
struct dm_list fields; /* Fields in display order */
|
|
struct dm_report_field *(*sort_fields)[]; /* Fields in sort order */
|
|
};
|
|
|
|
static const struct dm_report_object_type *_find_type(struct dm_report *rh,
|
|
uint32_t report_type)
|
|
{
|
|
const struct dm_report_object_type *t;
|
|
|
|
for (t = rh->types; t->data_fn; t++)
|
|
if (t->id == report_type)
|
|
return t;
|
|
|
|
return NULL;
|
|
}
|
|
|
|
/*
|
|
* Data-munging functions to prepare each data type for display and sorting
|
|
*/
|
|
|
|
int dm_report_field_string(struct dm_report *rh,
|
|
struct dm_report_field *field, const char *const *data)
|
|
{
|
|
char *repstr;
|
|
|
|
if (!(repstr = dm_pool_strdup(rh->mem, *data))) {
|
|
log_error("dm_report_field_string: dm_pool_strdup failed");
|
|
return 0;
|
|
}
|
|
|
|
field->report_string = repstr;
|
|
field->sort_value = (const void *) field->report_string;
|
|
|
|
return 1;
|
|
}
|
|
|
|
static int _str_cmp(const void *a, const void *b)
|
|
{
|
|
const char **str_a = (const char **) a;
|
|
const char **str_b = (const char **) b;
|
|
|
|
return strcmp(*str_a, *str_b);
|
|
}
|
|
|
|
struct str_list_sort_value_item {
|
|
unsigned pos;
|
|
size_t len;
|
|
};
|
|
|
|
struct str_list_sort_value {
|
|
const char *value;
|
|
struct str_list_sort_value_item *items;
|
|
};
|
|
|
|
int dm_report_field_string_list(struct dm_report *rh,
|
|
struct dm_report_field *field,
|
|
const struct dm_list *data,
|
|
const char *delimiter)
|
|
{
|
|
static const char _string_list_grow_object_failed_msg[] = "dm_report_field_string_list: dm_pool_grow_object_failed";
|
|
struct str_list_sort_value *sort_value = NULL;
|
|
unsigned int list_size, pos, i;
|
|
const char **arr = NULL;
|
|
struct dm_str_list *sl;
|
|
size_t delimiter_len, len;
|
|
void *object;
|
|
int r = 0;
|
|
|
|
if (!(sort_value = dm_pool_zalloc(rh->mem, sizeof(struct str_list_sort_value)))) {
|
|
log_error("dm_report_field_string_list: dm_pool_zalloc failed for sort_value");
|
|
return 0;
|
|
}
|
|
|
|
list_size = dm_list_size(data);
|
|
|
|
/*
|
|
* Sort value stores the pointer to the report_string and then
|
|
* position and length for each list element withing the report_string.
|
|
* The first element stores number of elements in 'len' (therefore
|
|
* list_size + 1 is used below for the extra element).
|
|
*/
|
|
if (!(sort_value->items = dm_pool_zalloc(rh->mem, (list_size + 1) * sizeof(struct str_list_sort_value_item)))) {
|
|
log_error("dm_report_fiel_string_list: dm_pool_zalloc failed for sort value items");
|
|
goto out;
|
|
}
|
|
sort_value->items[0].len = list_size;
|
|
|
|
/* zero items */
|
|
if (!list_size) {
|
|
sort_value->value = field->report_string = "";
|
|
sort_value->items[1].pos = 0;
|
|
sort_value->items[1].len = 0;
|
|
field->sort_value = sort_value;
|
|
return 1;
|
|
}
|
|
|
|
/* one item */
|
|
if (list_size == 1) {
|
|
sl = (struct dm_str_list *) dm_list_first(data);
|
|
if (!(sort_value->value = field->report_string = dm_pool_strdup(rh->mem, sl->str))) {
|
|
log_error("dm_report_field_string_list: dm_pool_strdup failed");
|
|
goto out;
|
|
}
|
|
sort_value->items[1].pos = 0;
|
|
sort_value->items[1].len = strlen(sl->str);
|
|
field->sort_value = sort_value;
|
|
return 1;
|
|
}
|
|
|
|
/* more than one item - sort the list */
|
|
if (!(arr = dm_malloc(sizeof(char *) * list_size))) {
|
|
log_error("dm_report_field_string_list: dm_malloc failed");
|
|
goto out;
|
|
}
|
|
i = 0;
|
|
dm_list_iterate_items(sl, data)
|
|
arr[i++] = sl->str;
|
|
qsort(arr, i, sizeof(char *), _str_cmp);
|
|
|
|
if (!(dm_pool_begin_object(rh->mem, 256))) {
|
|
log_error(_string_list_grow_object_failed_msg);
|
|
goto out;
|
|
}
|
|
|
|
if (!delimiter)
|
|
delimiter = ",";
|
|
delimiter_len = strlen(delimiter);
|
|
|
|
/* start from 1 - the item 0 stores the list size! */
|
|
for (i = 1, pos = 0; i <= list_size; i++) {
|
|
len = strlen(arr[i-1]);
|
|
if (!dm_pool_grow_object(rh->mem, arr[i-1], len) ||
|
|
(i != list_size && !dm_pool_grow_object(rh->mem, delimiter, delimiter_len))) {
|
|
log_error(_string_list_grow_object_failed_msg);
|
|
goto out;
|
|
}
|
|
/*
|
|
* save position and length of the string
|
|
* element in report_string for sort_value
|
|
*/
|
|
sort_value->items[i].pos = pos;
|
|
sort_value->items[i].len = len;
|
|
pos = i == list_size ? pos+len : pos+len+1;
|
|
}
|
|
|
|
if (!dm_pool_grow_object(rh->mem, "\0", 1)) {
|
|
log_error(_string_list_grow_object_failed_msg);
|
|
goto out;
|
|
}
|
|
|
|
object = dm_pool_end_object(rh->mem);
|
|
sort_value->value = object;
|
|
field->sort_value = sort_value;
|
|
field->report_string = object;
|
|
r = 1;
|
|
out:
|
|
if (!r && sort_value)
|
|
dm_pool_free(rh->mem, sort_value);
|
|
if (arr)
|
|
dm_free(arr);
|
|
return r;
|
|
}
|
|
|
|
int dm_report_field_int(struct dm_report *rh,
|
|
struct dm_report_field *field, const int *data)
|
|
{
|
|
const int value = *data;
|
|
uint64_t *sortval;
|
|
char *repstr;
|
|
|
|
if (!(repstr = dm_pool_zalloc(rh->mem, 13))) {
|
|
log_error("dm_report_field_int: dm_pool_alloc failed");
|
|
return 0;
|
|
}
|
|
|
|
if (!(sortval = dm_pool_alloc(rh->mem, sizeof(int64_t)))) {
|
|
log_error("dm_report_field_int: dm_pool_alloc failed");
|
|
return 0;
|
|
}
|
|
|
|
if (dm_snprintf(repstr, 12, "%d", value) < 0) {
|
|
log_error("dm_report_field_int: int too big: %d", value);
|
|
return 0;
|
|
}
|
|
|
|
*sortval = (uint64_t) value;
|
|
field->sort_value = sortval;
|
|
field->report_string = repstr;
|
|
|
|
return 1;
|
|
}
|
|
|
|
int dm_report_field_uint32(struct dm_report *rh,
|
|
struct dm_report_field *field, const uint32_t *data)
|
|
{
|
|
const uint32_t value = *data;
|
|
uint64_t *sortval;
|
|
char *repstr;
|
|
|
|
if (!(repstr = dm_pool_zalloc(rh->mem, 12))) {
|
|
log_error("dm_report_field_uint32: dm_pool_alloc failed");
|
|
return 0;
|
|
}
|
|
|
|
if (!(sortval = dm_pool_alloc(rh->mem, sizeof(uint64_t)))) {
|
|
log_error("dm_report_field_uint32: dm_pool_alloc failed");
|
|
return 0;
|
|
}
|
|
|
|
if (dm_snprintf(repstr, 11, "%u", value) < 0) {
|
|
log_error("dm_report_field_uint32: uint32 too big: %u", value);
|
|
return 0;
|
|
}
|
|
|
|
*sortval = (uint64_t) value;
|
|
field->sort_value = sortval;
|
|
field->report_string = repstr;
|
|
|
|
return 1;
|
|
}
|
|
|
|
int dm_report_field_int32(struct dm_report *rh,
|
|
struct dm_report_field *field, const int32_t *data)
|
|
{
|
|
const int32_t value = *data;
|
|
uint64_t *sortval;
|
|
char *repstr;
|
|
|
|
if (!(repstr = dm_pool_zalloc(rh->mem, 13))) {
|
|
log_error("dm_report_field_int32: dm_pool_alloc failed");
|
|
return 0;
|
|
}
|
|
|
|
if (!(sortval = dm_pool_alloc(rh->mem, sizeof(int64_t)))) {
|
|
log_error("dm_report_field_int32: dm_pool_alloc failed");
|
|
return 0;
|
|
}
|
|
|
|
if (dm_snprintf(repstr, 12, "%d", value) < 0) {
|
|
log_error("dm_report_field_int32: int32 too big: %d", value);
|
|
return 0;
|
|
}
|
|
|
|
*sortval = (uint64_t) value;
|
|
field->sort_value = sortval;
|
|
field->report_string = repstr;
|
|
|
|
return 1;
|
|
}
|
|
|
|
int dm_report_field_uint64(struct dm_report *rh,
|
|
struct dm_report_field *field, const uint64_t *data)
|
|
{
|
|
const uint64_t value = *data;
|
|
uint64_t *sortval;
|
|
char *repstr;
|
|
|
|
if (!(repstr = dm_pool_zalloc(rh->mem, 22))) {
|
|
log_error("dm_report_field_uint64: dm_pool_alloc failed");
|
|
return 0;
|
|
}
|
|
|
|
if (!(sortval = dm_pool_alloc(rh->mem, sizeof(uint64_t)))) {
|
|
log_error("dm_report_field_uint64: dm_pool_alloc failed");
|
|
return 0;
|
|
}
|
|
|
|
if (dm_snprintf(repstr, 21, "%" PRIu64 , value) < 0) {
|
|
log_error("dm_report_field_uint64: uint64 too big: %" PRIu64, value);
|
|
return 0;
|
|
}
|
|
|
|
*sortval = value;
|
|
field->sort_value = sortval;
|
|
field->report_string = repstr;
|
|
|
|
return 1;
|
|
}
|
|
|
|
/*
|
|
* Helper functions for custom report functions
|
|
*/
|
|
void dm_report_field_set_value(struct dm_report_field *field, const void *value, const void *sortvalue)
|
|
{
|
|
field->report_string = (const char *) value;
|
|
field->sort_value = sortvalue ? : value;
|
|
|
|
if ((field->sort_value == value) &&
|
|
(field->props->flags & DM_REPORT_FIELD_TYPE_NUMBER))
|
|
log_warn(INTERNAL_ERROR "Using string as sort value for numerical field.");
|
|
}
|
|
|
|
/*
|
|
* show help message
|
|
*/
|
|
static void _display_fields(struct dm_report *rh, int display_all_fields_item)
|
|
{
|
|
uint32_t f;
|
|
const struct dm_report_object_type *type;
|
|
const char *desc, *last_desc = "";
|
|
size_t id_len = 0;
|
|
|
|
for (f = 0; rh->fields[f].report_fn; f++)
|
|
if (strlen(rh->fields[f].id) > id_len)
|
|
id_len = strlen(rh->fields[f].id);
|
|
|
|
|
|
for (type = rh->types; type->data_fn; type++)
|
|
if (strlen(type->prefix) + 3 > id_len)
|
|
id_len = strlen(type->prefix) + 3;
|
|
|
|
for (f = 0; rh->fields[f].report_fn; f++) {
|
|
if ((type = _find_type(rh, rh->fields[f].type)) && type->desc)
|
|
desc = type->desc;
|
|
else
|
|
desc = " ";
|
|
if (desc != last_desc) {
|
|
if (*last_desc)
|
|
log_warn(" ");
|
|
log_warn("%s Fields", desc);
|
|
log_warn("%*.*s", (int) strlen(desc) + 7,
|
|
(int) strlen(desc) + 7,
|
|
"-------------------------------------------------------------------------------");
|
|
if (display_all_fields_item) {
|
|
log_warn(" %sall%-*s - %s", type->prefix,
|
|
(int) (id_len - 3 - strlen(type->prefix)), "",
|
|
"All fields in this section.");
|
|
}
|
|
}
|
|
|
|
/* FIXME Add line-wrapping at terminal width (or 80 cols) */
|
|
log_warn(" %-*s - %s", (int) id_len, rh->fields[f].id, rh->fields[f].desc);
|
|
last_desc = desc;
|
|
}
|
|
}
|
|
|
|
/*
|
|
* Initialise report handle
|
|
*/
|
|
static int _copy_field(struct dm_report *rh, struct field_properties *dest,
|
|
uint32_t field_num)
|
|
{
|
|
dest->field_num = field_num;
|
|
dest->width = rh->fields[field_num].width;
|
|
dest->flags = rh->fields[field_num].flags & DM_REPORT_FIELD_MASK;
|
|
|
|
/* set object type method */
|
|
dest->type = _find_type(rh, rh->fields[field_num].type);
|
|
if (!dest->type) {
|
|
log_error("dm_report: field not match: %s",
|
|
rh->fields[field_num].id);
|
|
return 0;
|
|
}
|
|
|
|
return 1;
|
|
}
|
|
|
|
static struct field_properties * _add_field(struct dm_report *rh,
|
|
uint32_t field_num, uint32_t flags)
|
|
{
|
|
struct field_properties *fp;
|
|
|
|
if (!(fp = dm_pool_zalloc(rh->mem, sizeof(struct field_properties)))) {
|
|
log_error("dm_report: struct field_properties allocation "
|
|
"failed");
|
|
return NULL;
|
|
}
|
|
|
|
if (!_copy_field(rh, fp, field_num)) {
|
|
stack;
|
|
dm_pool_free(rh->mem, fp);
|
|
return NULL;
|
|
}
|
|
|
|
fp->flags |= flags;
|
|
|
|
/*
|
|
* Place hidden fields at the front so dm_list_end() will
|
|
* tell us when we've reached the last visible field.
|
|
*/
|
|
if (fp->flags & FLD_HIDDEN)
|
|
dm_list_add_h(&rh->field_props, &fp->list);
|
|
else
|
|
dm_list_add(&rh->field_props, &fp->list);
|
|
|
|
return fp;
|
|
}
|
|
|
|
/*
|
|
* Compare name1 against name2 or prefix plus name2
|
|
* name2 is not necessarily null-terminated.
|
|
* len2 is the length of name2.
|
|
*/
|
|
static int _is_same_field(const char *name1, const char *name2,
|
|
size_t len2, const char *prefix)
|
|
{
|
|
size_t prefix_len;
|
|
|
|
/* Exact match? */
|
|
if (!strncasecmp(name1, name2, len2) && strlen(name1) == len2)
|
|
return 1;
|
|
|
|
/* Match including prefix? */
|
|
prefix_len = strlen(prefix);
|
|
if (!strncasecmp(prefix, name1, prefix_len) &&
|
|
!strncasecmp(name1 + prefix_len, name2, len2) &&
|
|
strlen(name1) == prefix_len + len2)
|
|
return 1;
|
|
|
|
return 0;
|
|
}
|
|
|
|
/*
|
|
* Check for a report type prefix + "all" match.
|
|
*/
|
|
static uint32_t _all_match(struct dm_report *rh, const char *field, size_t flen)
|
|
{
|
|
size_t prefix_len;
|
|
const struct dm_report_object_type *t;
|
|
uint32_t report_types = 0;
|
|
unsigned unprefixed_all_matched = 0;
|
|
|
|
if (!strncasecmp(field, "all", 3) && flen == 3) {
|
|
/* If there's no report prefix, match all report types */
|
|
if (!(flen = strlen(rh->field_prefix)))
|
|
return rh->report_types ? : REPORT_TYPES_ALL;
|
|
|
|
/* otherwise include all fields beginning with the report prefix. */
|
|
unprefixed_all_matched = 1;
|
|
field = rh->field_prefix;
|
|
report_types = rh->report_types;
|
|
}
|
|
|
|
/* Combine all report types that have a matching prefix. */
|
|
for (t = rh->types; t->data_fn; t++) {
|
|
prefix_len = strlen(t->prefix);
|
|
|
|
if (!strncasecmp(t->prefix, field, prefix_len) &&
|
|
((unprefixed_all_matched && (flen == prefix_len)) ||
|
|
(!strncasecmp(field + prefix_len, "all", 3) &&
|
|
(flen == prefix_len + 3))))
|
|
report_types |= t->id;
|
|
}
|
|
|
|
return report_types;
|
|
}
|
|
|
|
/*
|
|
* Add all fields with a matching type.
|
|
*/
|
|
static int _add_all_fields(struct dm_report *rh, uint32_t type)
|
|
{
|
|
uint32_t f;
|
|
|
|
for (f = 0; rh->fields[f].report_fn; f++)
|
|
if ((rh->fields[f].type & type) && !_add_field(rh, f, 0))
|
|
return 0;
|
|
|
|
return 1;
|
|
}
|
|
|
|
static int _get_field(struct dm_report *rh, const char *field, size_t flen, uint32_t *f_ret)
|
|
{
|
|
uint32_t f;
|
|
|
|
if (!flen)
|
|
return 0;
|
|
|
|
for (f = 0; rh->fields[f].report_fn; f++) {
|
|
if (_is_same_field(rh->fields[f].id, field, flen, rh->field_prefix)) {
|
|
*f_ret = f;
|
|
return 1;
|
|
}
|
|
}
|
|
|
|
return 0;
|
|
}
|
|
|
|
static int _field_match(struct dm_report *rh, const char *field, size_t flen,
|
|
unsigned report_type_only)
|
|
{
|
|
uint32_t f, type;
|
|
|
|
if (!flen)
|
|
return 0;
|
|
|
|
if ((_get_field(rh, field, flen, &f))) {
|
|
if (report_type_only) {
|
|
rh->report_types |= rh->fields[f].type;
|
|
return 1;
|
|
} else
|
|
return _add_field(rh, f, 0) ? 1 : 0;
|
|
}
|
|
|
|
if ((type = _all_match(rh, field, flen))) {
|
|
if (report_type_only) {
|
|
rh->report_types |= type;
|
|
return 1;
|
|
} else
|
|
return _add_all_fields(rh, type);
|
|
}
|
|
|
|
return 0;
|
|
}
|
|
|
|
static int _add_sort_key(struct dm_report *rh, uint32_t field_num,
|
|
uint32_t flags, unsigned report_type_only)
|
|
{
|
|
struct field_properties *fp, *found = NULL;
|
|
|
|
dm_list_iterate_items(fp, &rh->field_props) {
|
|
if (fp->field_num == field_num) {
|
|
found = fp;
|
|
break;
|
|
}
|
|
}
|
|
|
|
if (!found) {
|
|
if (report_type_only)
|
|
rh->report_types |= rh->fields[field_num].type;
|
|
else if (!(found = _add_field(rh, field_num, FLD_HIDDEN)))
|
|
return_0;
|
|
}
|
|
|
|
if (report_type_only)
|
|
return 1;
|
|
|
|
if (found->flags & FLD_SORT_KEY) {
|
|
log_warn("dm_report: Ignoring duplicate sort field: %s.",
|
|
rh->fields[field_num].id);
|
|
return 1;
|
|
}
|
|
|
|
found->flags |= FLD_SORT_KEY;
|
|
found->sort_posn = rh->keys_count++;
|
|
found->flags |= flags;
|
|
|
|
return 1;
|
|
}
|
|
|
|
static int _key_match(struct dm_report *rh, const char *key, size_t len,
|
|
unsigned report_type_only)
|
|
{
|
|
uint32_t f;
|
|
uint32_t flags;
|
|
|
|
if (!len)
|
|
return 0;
|
|
|
|
if (*key == '+') {
|
|
key++;
|
|
len--;
|
|
flags = FLD_ASCENDING;
|
|
} else if (*key == '-') {
|
|
key++;
|
|
len--;
|
|
flags = FLD_DESCENDING;
|
|
} else
|
|
flags = FLD_ASCENDING;
|
|
|
|
if (!len) {
|
|
log_error("dm_report: Missing sort field name");
|
|
return 0;
|
|
}
|
|
|
|
for (f = 0; rh->fields[f].report_fn; f++)
|
|
if (_is_same_field(rh->fields[f].id, key, len,
|
|
rh->field_prefix))
|
|
return _add_sort_key(rh, f, flags, report_type_only);
|
|
|
|
return 0;
|
|
}
|
|
|
|
static int _parse_fields(struct dm_report *rh, const char *format,
|
|
unsigned report_type_only)
|
|
{
|
|
const char *ws; /* Word start */
|
|
const char *we = format; /* Word end */
|
|
|
|
while (*we) {
|
|
/* Allow consecutive commas */
|
|
while (*we && *we == ',')
|
|
we++;
|
|
|
|
/* start of the field name */
|
|
ws = we;
|
|
while (*we && *we != ',')
|
|
we++;
|
|
|
|
if (!_field_match(rh, ws, (size_t) (we - ws), report_type_only)) {
|
|
_display_fields(rh, 1);
|
|
log_warn(" ");
|
|
if (strcasecmp(ws, DM_REPORT_FIELD_RESERVED_NAME_HELP) &&
|
|
strcmp(ws, DM_REPORT_FIELD_RESERVED_NAME_HELP_ALT))
|
|
log_error("Unrecognised field: %.*s",
|
|
(int) (we - ws), ws);
|
|
return 0;
|
|
}
|
|
}
|
|
|
|
return 1;
|
|
}
|
|
|
|
static int _parse_keys(struct dm_report *rh, const char *keys,
|
|
unsigned report_type_only)
|
|
{
|
|
const char *ws; /* Word start */
|
|
const char *we = keys; /* Word end */
|
|
|
|
if (!keys)
|
|
return 1;
|
|
|
|
while (*we) {
|
|
/* Allow consecutive commas */
|
|
while (*we && *we == ',')
|
|
we++;
|
|
ws = we;
|
|
while (*we && *we != ',')
|
|
we++;
|
|
if (!_key_match(rh, ws, (size_t) (we - ws), report_type_only)) {
|
|
_display_fields(rh, 1);
|
|
log_warn(" ");
|
|
if (strcasecmp(ws, DM_REPORT_FIELD_RESERVED_NAME_HELP) &&
|
|
strcmp(ws, DM_REPORT_FIELD_RESERVED_NAME_HELP_ALT))
|
|
log_error("dm_report: Unrecognised field: %.*s",
|
|
(int) (we - ws), ws);
|
|
return 0;
|
|
}
|
|
}
|
|
|
|
return 1;
|
|
}
|
|
|
|
struct dm_report *dm_report_init(uint32_t *report_types,
|
|
const struct dm_report_object_type *types,
|
|
const struct dm_report_field_type *fields,
|
|
const char *output_fields,
|
|
const char *output_separator,
|
|
uint32_t output_flags,
|
|
const char *sort_keys,
|
|
void *private_data)
|
|
{
|
|
struct dm_report *rh;
|
|
const struct dm_report_object_type *type;
|
|
|
|
if (!(rh = dm_zalloc(sizeof(*rh)))) {
|
|
log_error("dm_report_init: dm_malloc failed");
|
|
return 0;
|
|
}
|
|
|
|
/*
|
|
* rh->report_types is updated in _parse_fields() and _parse_keys()
|
|
* to contain all types corresponding to the fields specified by
|
|
* fields or keys.
|
|
*/
|
|
if (report_types)
|
|
rh->report_types = *report_types;
|
|
|
|
rh->separator = output_separator;
|
|
rh->fields = fields;
|
|
rh->types = types;
|
|
rh->private = private_data;
|
|
|
|
rh->flags |= output_flags & DM_REPORT_OUTPUT_MASK;
|
|
|
|
/* With columns_as_rows we must buffer and not align. */
|
|
if (output_flags & DM_REPORT_OUTPUT_COLUMNS_AS_ROWS) {
|
|
if (!(output_flags & DM_REPORT_OUTPUT_BUFFERED))
|
|
rh->flags |= DM_REPORT_OUTPUT_BUFFERED;
|
|
if (output_flags & DM_REPORT_OUTPUT_ALIGNED)
|
|
rh->flags &= ~DM_REPORT_OUTPUT_ALIGNED;
|
|
}
|
|
|
|
if (output_flags & DM_REPORT_OUTPUT_BUFFERED)
|
|
rh->flags |= RH_SORT_REQUIRED;
|
|
|
|
dm_list_init(&rh->field_props);
|
|
dm_list_init(&rh->rows);
|
|
|
|
if ((type = _find_type(rh, rh->report_types)) && type->prefix)
|
|
rh->field_prefix = type->prefix;
|
|
else
|
|
rh->field_prefix = "";
|
|
|
|
if (!(rh->mem = dm_pool_create("report", 10 * 1024))) {
|
|
log_error("dm_report_init: allocation of memory pool failed");
|
|
dm_free(rh);
|
|
return NULL;
|
|
}
|
|
|
|
/*
|
|
* To keep the code needed to add the "all" field to a minimum, we parse
|
|
* the field lists twice. The first time we only update the report type.
|
|
* FIXME Use one pass instead and expand the "all" field afterwards.
|
|
*/
|
|
if (!_parse_fields(rh, output_fields, 1) ||
|
|
!_parse_keys(rh, sort_keys, 1)) {
|
|
dm_report_free(rh);
|
|
return NULL;
|
|
}
|
|
|
|
/* Generate list of fields for output based on format string & flags */
|
|
if (!_parse_fields(rh, output_fields, 0) ||
|
|
!_parse_keys(rh, sort_keys, 0)) {
|
|
dm_report_free(rh);
|
|
return NULL;
|
|
}
|
|
|
|
/* Return updated types value for further compatility check by caller */
|
|
if (report_types)
|
|
*report_types = rh->report_types;
|
|
|
|
return rh;
|
|
}
|
|
|
|
void dm_report_free(struct dm_report *rh)
|
|
{
|
|
dm_pool_destroy(rh->mem);
|
|
dm_free(rh);
|
|
}
|
|
|
|
static char *_toupperstr(char *str)
|
|
{
|
|
char *u = str;
|
|
|
|
do
|
|
*u = toupper(*u);
|
|
while (*u++);
|
|
|
|
return str;
|
|
}
|
|
|
|
int dm_report_set_output_field_name_prefix(struct dm_report *rh, const char *output_field_name_prefix)
|
|
{
|
|
char *prefix;
|
|
|
|
if (!(prefix = dm_pool_strdup(rh->mem, output_field_name_prefix))) {
|
|
log_error("dm_report_set_output_field_name_prefix: dm_pool_strdup failed");
|
|
return 0;
|
|
}
|
|
|
|
rh->output_field_name_prefix = _toupperstr(prefix);
|
|
|
|
return 1;
|
|
}
|
|
|
|
/*
|
|
* Create a row of data for an object
|
|
*/
|
|
static void *_report_get_field_data(struct dm_report *rh,
|
|
struct field_properties *fp, void *object)
|
|
{
|
|
char *ret = fp->type->data_fn(object);
|
|
|
|
if (!ret)
|
|
return NULL;
|
|
|
|
return (void *)(ret + rh->fields[fp->field_num].offset);
|
|
}
|
|
|
|
static int _cmp_field_int(const char *field_id, uint64_t a, uint64_t b, uint32_t flags)
|
|
{
|
|
switch(flags & FLD_CMP_MASK) {
|
|
case FLD_CMP_EQUAL:
|
|
return a == b;
|
|
case FLD_CMP_NOT|FLD_CMP_EQUAL:
|
|
return a != b;
|
|
case FLD_CMP_NUMBER|FLD_CMP_GT:
|
|
return a > b;
|
|
case FLD_CMP_NUMBER|FLD_CMP_GT|FLD_CMP_EQUAL:
|
|
return a >= b;
|
|
case FLD_CMP_NUMBER|FLD_CMP_LT:
|
|
return a < b;
|
|
case FLD_CMP_NUMBER|FLD_CMP_LT|FLD_CMP_EQUAL:
|
|
return a <= b;
|
|
default:
|
|
log_error(INTERNAL_ERROR "_cmp_field_int: unsupported number "
|
|
"comparison type for field %s", field_id);
|
|
}
|
|
|
|
return 0;
|
|
}
|
|
|
|
static int _close_enough(double d1, double d2)
|
|
{
|
|
return fabs(d1 - d2) < DBL_EPSILON;
|
|
}
|
|
|
|
static int _cmp_field_double(const char *field_id, double a, double b, uint32_t flags)
|
|
{
|
|
switch(flags & FLD_CMP_MASK) {
|
|
case FLD_CMP_EQUAL:
|
|
return _close_enough(a, b);
|
|
case FLD_CMP_NOT|FLD_CMP_EQUAL:
|
|
return !_close_enough(a, b);
|
|
case FLD_CMP_NUMBER|FLD_CMP_GT:
|
|
return (a > b) && !_close_enough(a, b);
|
|
case FLD_CMP_NUMBER|FLD_CMP_GT|FLD_CMP_EQUAL:
|
|
return (a > b) || _close_enough(a, b);
|
|
case FLD_CMP_NUMBER|FLD_CMP_LT:
|
|
return (a < b) && !_close_enough(a, b);
|
|
case FLD_CMP_NUMBER|FLD_CMP_LT|FLD_CMP_EQUAL:
|
|
return a < b || _close_enough(a, b);
|
|
default:
|
|
log_error(INTERNAL_ERROR "_cmp_field_double: unsupported number "
|
|
"comparison type for selection field %s", field_id);
|
|
}
|
|
|
|
return 0;
|
|
}
|
|
|
|
static int _cmp_field_string(const char *field_id, const char *a, const char *b, uint32_t flags)
|
|
{
|
|
switch (flags & FLD_CMP_MASK) {
|
|
case FLD_CMP_EQUAL:
|
|
return !strcmp(a, b);
|
|
case FLD_CMP_NOT|FLD_CMP_EQUAL:
|
|
return strcmp(a, b);
|
|
default:
|
|
log_error(INTERNAL_ERROR "_cmp_field_string: unsupported string "
|
|
"comparison type for selection field %s", field_id);
|
|
}
|
|
|
|
return 0;
|
|
}
|
|
|
|
/* Matches if all items from selection string list match. */
|
|
static int _cmp_field_string_list_all(const struct str_list_sort_value *val,
|
|
const struct selection_str_list *sel)
|
|
{
|
|
struct dm_str_list *sel_item;
|
|
unsigned int i = 1;
|
|
|
|
/* if item count differs, it's clear the lists do not match */
|
|
if (val->items[0].len != dm_list_size(sel->list))
|
|
return 0;
|
|
|
|
/* both lists are sorted so they either match 1:1 or not */
|
|
dm_list_iterate_items(sel_item, sel->list) {
|
|
if (strncmp(sel_item->str, val->value + val->items[i].pos, val->items[i].len))
|
|
return 0;
|
|
i++;
|
|
}
|
|
|
|
return 1;
|
|
}
|
|
|
|
/* Matches if any item from selection string list matches. */
|
|
static int _cmp_field_string_list_any(const struct str_list_sort_value *val,
|
|
const struct selection_str_list *sel)
|
|
{
|
|
struct dm_str_list *sel_item;
|
|
unsigned int i;
|
|
|
|
/* if value has no items and selection has at least one, it's clear there's no match */
|
|
if ((val->items[0].len == 0) && dm_list_size(sel->list))
|
|
return 0;
|
|
|
|
dm_list_iterate_items(sel_item, sel->list) {
|
|
/*
|
|
* TODO: Optimize this so we don't need to compare the whole lists' content.
|
|
* Make use of the fact that the lists are sorted!
|
|
*/
|
|
for (i = 1; i <= val->items[0].len; i++) {
|
|
if (!strncmp(sel_item->str, val->value + val->items[i].pos, val->items[i].len))
|
|
return 1;
|
|
}
|
|
}
|
|
|
|
return 0;
|
|
}
|
|
|
|
static int _cmp_field_string_list(const char *field_id,
|
|
const struct str_list_sort_value *value,
|
|
const struct selection_str_list *selection, uint32_t flags)
|
|
{
|
|
int r;
|
|
|
|
switch (selection->type & SEL_MASK) {
|
|
case SEL_AND:
|
|
r = _cmp_field_string_list_all(value, selection);
|
|
break;
|
|
case SEL_OR:
|
|
r = _cmp_field_string_list_any(value, selection);
|
|
break;
|
|
default:
|
|
log_error(INTERNAL_ERROR "_cmp_field_string_list: unsupported string "
|
|
"list type found, expecting either AND or OR list for "
|
|
"selection field %s", field_id);
|
|
return 0;
|
|
}
|
|
|
|
return flags & FLD_CMP_NOT ? !r : r;
|
|
}
|
|
|
|
static int _cmp_field_regex(const char *s, struct dm_regex *r, uint32_t flags)
|
|
{
|
|
int match = dm_regex_match(r, s) >= 0;
|
|
return flags & FLD_CMP_NOT ? !match : match;
|
|
}
|
|
|
|
static int _compare_selection_field(struct dm_report *rh,
|
|
struct dm_report_field *f,
|
|
struct field_selection *fs)
|
|
{
|
|
const char *field_id = rh->fields[f->props->field_num].id;
|
|
int r = 0;
|
|
|
|
if (!f->sort_value) {
|
|
log_error("_compare_selection_field: field without value :%d",
|
|
f->props->field_num);
|
|
return 0;
|
|
}
|
|
|
|
if (fs->flags & FLD_CMP_REGEX)
|
|
r = _cmp_field_regex((const char *) f->sort_value, fs->v.r, fs->flags);
|
|
else {
|
|
switch(f->props->flags & DM_REPORT_FIELD_TYPE_MASK) {
|
|
case DM_REPORT_FIELD_TYPE_NUMBER:
|
|
r = _cmp_field_int(field_id, *(const uint64_t *) f->sort_value, fs->v.i, fs->flags);
|
|
break;
|
|
case DM_REPORT_FIELD_TYPE_SIZE:
|
|
r = _cmp_field_double(field_id, *(const uint64_t *) f->sort_value, fs->v.d, fs->flags);
|
|
break;
|
|
case DM_REPORT_FIELD_TYPE_STRING:
|
|
r = _cmp_field_string(field_id, (const char *) f->sort_value, fs->v.s, fs->flags);
|
|
break;
|
|
case DM_REPORT_FIELD_TYPE_STRING_LIST:
|
|
r = _cmp_field_string_list(field_id, (const struct str_list_sort_value *) f->sort_value,
|
|
fs->v.l, fs->flags);
|
|
break;
|
|
default:
|
|
log_error(INTERNAL_ERROR "_compare_selection_field: unknown field type for field %s", field_id);
|
|
}
|
|
}
|
|
|
|
return r;
|
|
}
|
|
|
|
static int _check_selection(struct dm_report *rh, struct selection_node *sn,
|
|
struct dm_list *fields)
|
|
{
|
|
int r;
|
|
struct selection_node *iter_n;
|
|
struct dm_report_field *f;
|
|
|
|
switch (sn->type & SEL_MASK) {
|
|
case SEL_ITEM:
|
|
r = 1;
|
|
dm_list_iterate_items(f, fields) {
|
|
if (sn->selection.item->fp != f->props)
|
|
continue;
|
|
if (!_compare_selection_field(rh, f, sn->selection.item))
|
|
r = 0;
|
|
}
|
|
break;
|
|
case SEL_OR:
|
|
r = 0;
|
|
dm_list_iterate_items(iter_n, &sn->selection.set)
|
|
if ((r |= _check_selection(rh, iter_n, fields)))
|
|
break;
|
|
break;
|
|
case SEL_AND:
|
|
r = 1;
|
|
dm_list_iterate_items(iter_n, &sn->selection.set)
|
|
if (!(r &= _check_selection(rh, iter_n, fields)))
|
|
break;
|
|
break;
|
|
default:
|
|
log_error("Unsupported selection type");
|
|
return 0;
|
|
}
|
|
|
|
return (sn->type & SEL_MODIFIER_NOT) ? !r : r;
|
|
}
|
|
|
|
static int _check_report_selection(struct dm_report *rh, struct dm_list *fields)
|
|
{
|
|
if (!rh->selection_root)
|
|
return 1;
|
|
|
|
return _check_selection(rh, rh->selection_root, fields);
|
|
}
|
|
|
|
int dm_report_object(struct dm_report *rh, void *object)
|
|
{
|
|
struct field_properties *fp;
|
|
struct row *row = NULL;
|
|
struct dm_report_field *field;
|
|
void *data = NULL;
|
|
int len;
|
|
int r = 0;
|
|
|
|
if (!rh) {
|
|
log_error(INTERNAL_ERROR "dm_report handler is NULL.");
|
|
goto out;
|
|
}
|
|
|
|
if (!(row = dm_pool_zalloc(rh->mem, sizeof(*row)))) {
|
|
log_error("dm_report_object: struct row allocation failed");
|
|
goto out;
|
|
}
|
|
|
|
row->rh = rh;
|
|
|
|
if ((rh->flags & RH_SORT_REQUIRED) &&
|
|
!(row->sort_fields =
|
|
dm_pool_zalloc(rh->mem, sizeof(struct dm_report_field *) *
|
|
rh->keys_count))) {
|
|
log_error("dm_report_object: "
|
|
"row sort value structure allocation failed");
|
|
goto out;
|
|
}
|
|
|
|
dm_list_init(&row->fields);
|
|
|
|
/* For each field to be displayed, call its report_fn */
|
|
dm_list_iterate_items(fp, &rh->field_props) {
|
|
if (!(field = dm_pool_zalloc(rh->mem, sizeof(*field)))) {
|
|
log_error("dm_report_object: "
|
|
"struct dm_report_field allocation failed");
|
|
goto out;
|
|
}
|
|
field->props = fp;
|
|
|
|
if (!(data = _report_get_field_data(rh, fp, object))) {
|
|
log_error("dm_report_object: "
|
|
"no data assigned to field %s",
|
|
rh->fields[fp->field_num].id);
|
|
goto out;
|
|
}
|
|
|
|
if (!rh->fields[fp->field_num].report_fn(rh, rh->mem,
|
|
field, data,
|
|
rh->private)) {
|
|
log_error("dm_report_object: "
|
|
"report function failed for field %s",
|
|
rh->fields[fp->field_num].id);
|
|
goto out;
|
|
}
|
|
|
|
dm_list_add(&row->fields, &field->list);
|
|
}
|
|
|
|
if (!_check_report_selection(rh, &row->fields)) {
|
|
r = 1;
|
|
goto out;
|
|
}
|
|
|
|
dm_list_add(&rh->rows, &row->list);
|
|
|
|
dm_list_iterate_items(field, &row->fields) {
|
|
len = (int) strlen(field->report_string);
|
|
if ((len > field->props->width))
|
|
field->props->width = len;
|
|
|
|
if ((rh->flags & RH_SORT_REQUIRED) &&
|
|
(field->props->flags & FLD_SORT_KEY)) {
|
|
(*row->sort_fields)[field->props->sort_posn] = field;
|
|
}
|
|
}
|
|
|
|
if (!(rh->flags & DM_REPORT_OUTPUT_BUFFERED))
|
|
return dm_report_output(rh);
|
|
|
|
r = 1;
|
|
out:
|
|
if (!r)
|
|
dm_pool_free(rh->mem, row);
|
|
return r;
|
|
}
|
|
|
|
/*
|
|
* Selection parsing
|
|
*/
|
|
|
|
/*
|
|
* Other tokens (FIELD, VALUE, STRING, NUMBER, REGEX)
|
|
* FIELD := <strings of alphabet, number and '_'>
|
|
* VALUE := NUMBER | STRING
|
|
* REGEX := <strings quoted by '"', '\'', '(', '{', '[' or unquoted>
|
|
* NUMBER := <strings of [0-9]> (because sort_value is unsigned)
|
|
* STRING := <strings quoted by '"', '\'' or unquoted>
|
|
*/
|
|
|
|
static const char * _skip_space(const char *s)
|
|
{
|
|
while (*s && isspace(*s))
|
|
s++;
|
|
return s;
|
|
}
|
|
|
|
static int _tok_op(struct op_def *t, const char *s, const char **end,
|
|
uint32_t expect)
|
|
{
|
|
size_t len;
|
|
|
|
s = _skip_space(s);
|
|
|
|
for (; t->string; t++) {
|
|
if (expect && !(t->flags & expect))
|
|
continue;
|
|
|
|
len = strlen(t->string);
|
|
if (!strncmp(s, t->string, len)) {
|
|
if (end)
|
|
*end = s + len;
|
|
return t->flags;
|
|
}
|
|
}
|
|
|
|
if (end)
|
|
*end = s;
|
|
return 0;
|
|
}
|
|
|
|
static int _tok_op_log(const char *s, const char **end, uint32_t expect)
|
|
{
|
|
return _tok_op(_op_log, s, end, expect);
|
|
}
|
|
|
|
static int _tok_op_cmp(const char *s, const char **end)
|
|
{
|
|
return _tok_op(_op_cmp, s, end, 0);
|
|
}
|
|
|
|
/*
|
|
*
|
|
* Input:
|
|
* s - a pointer to the parsed string
|
|
* Output:
|
|
* begin - a pointer to the beginning of the token
|
|
* end - a pointer to the end of the token + 1
|
|
* or undefined if return value is NULL
|
|
* return value - a starting point of the next parsing or
|
|
* NULL if 's' doesn't match with token type
|
|
* (the parsing should be terminated)
|
|
*/
|
|
static const char *_tok_value_number(const char *s,
|
|
const char **begin, const char **end)
|
|
|
|
{
|
|
int is_float = 0;
|
|
|
|
*begin = s;
|
|
while (*s && ((!is_float && *s=='.' && (is_float=1)) || isdigit(*s)))
|
|
s++;
|
|
*end = s;
|
|
|
|
if (*begin == *end)
|
|
return NULL;
|
|
|
|
return s;
|
|
}
|
|
|
|
/*
|
|
* Input:
|
|
* s - a pointer to the parsed string
|
|
* endchar - terminating character
|
|
* end_op_flags - terminating operator flags (see _op_log)
|
|
* (if endchar is non-zero then endflags is ignored)
|
|
* Output:
|
|
* begin - a pointer to the beginning of the token
|
|
* end - a pointer to the end of the token + 1
|
|
* end_op_flag_hit - the flag from endflags hit during parsing
|
|
* return value - a starting point of the next parsing
|
|
*/
|
|
static const char *_tok_value_string(const char *s,
|
|
const char **begin, const char **end,
|
|
const char endchar, uint32_t end_op_flags,
|
|
uint32_t *end_op_flag_hit)
|
|
{
|
|
uint32_t flag_hit = 0;
|
|
|
|
*begin = s;
|
|
|
|
/*
|
|
* If endchar is defined, scan the string till
|
|
* the endchar or the end of string is hit.
|
|
* This is in case the string is quoted and we
|
|
* know exact character that is the stopper.
|
|
*/
|
|
if (endchar) {
|
|
while (*s && *s != endchar)
|
|
s++;
|
|
if (*s != endchar) {
|
|
log_error("Missing end quote.");
|
|
return NULL;
|
|
}
|
|
*end = s;
|
|
s++;
|
|
} else {
|
|
/*
|
|
* If endchar is not defined then endchar is/are the
|
|
* operator/s as defined by 'endflags' arg or space char.
|
|
* This is in case the string is not quoted and
|
|
* we don't know which character is the exact stopper.
|
|
*/
|
|
while (*s) {
|
|
if ((flag_hit = _tok_op(_op_log, s, NULL, end_op_flags)) || *s == ' ')
|
|
break;
|
|
s++;
|
|
}
|
|
*end = s;
|
|
/*
|
|
* If we hit one of the strings as defined by 'endflags'
|
|
* and if 'endflag_hit' arg is provided, save the exact
|
|
* string flag that was hit.
|
|
*/
|
|
if (end_op_flag_hit)
|
|
*end_op_flag_hit = flag_hit;
|
|
}
|
|
|
|
return s;
|
|
}
|
|
|
|
/*
|
|
* Input:
|
|
* ft - field type for which the value is parsed
|
|
* s - a pointer to the parsed string
|
|
* Output:
|
|
* begin - a pointer to the beginning of the token
|
|
* end - a pointer to the end of the token + 1
|
|
* flags - parsing flags
|
|
*/
|
|
static const char *_tok_value_regex(const struct dm_report_field_type *ft,
|
|
const char *s, const char **begin,
|
|
const char **end, uint32_t *flags)
|
|
{
|
|
char c;
|
|
|
|
s = _skip_space(s);
|
|
|
|
if (!*s) {
|
|
log_error("Regular expression expected for selection field %s", ft->id);
|
|
return NULL;
|
|
}
|
|
|
|
switch (*s) {
|
|
case '(': c = ')'; break;
|
|
case '{': c = '}'; break;
|
|
case '[': c = ']'; break;
|
|
case '"':
|
|
case '\'': c = *s; break;
|
|
default: c = 0;
|
|
}
|
|
|
|
if (!(s = _tok_value_string(c ? s + 1 : s, begin, end, c, SEL_AND | SEL_OR | SEL_PRECEDENCE_PE, NULL))) {
|
|
log_error("Failed to parse regex value for selection field %s.", ft->id);
|
|
return NULL;
|
|
}
|
|
|
|
*flags |= DM_REPORT_FIELD_TYPE_STRING;
|
|
return s;
|
|
}
|
|
|
|
static int _str_list_item_cmp(const void *a, const void *b)
|
|
{
|
|
const struct dm_str_list **item_a = (const struct dm_str_list **) a;
|
|
const struct dm_str_list **item_b = (const struct dm_str_list **) b;
|
|
|
|
return strcmp((*item_a)->str, (*item_b)->str);
|
|
}
|
|
|
|
static int _add_item_to_string_list(struct dm_pool *mem, const char *begin,
|
|
const char *end, struct dm_list *list)
|
|
{
|
|
struct dm_str_list *item;
|
|
|
|
if (begin == end)
|
|
return_0;
|
|
|
|
if (!(item = dm_pool_zalloc(mem, sizeof(*item))) ||
|
|
!(item->str = dm_pool_strndup(mem, begin, end - begin))) {
|
|
log_error("_add_item_to_string_list: memory allocation failed for string list item");
|
|
return 0;
|
|
}
|
|
dm_list_add(list, &item->list);
|
|
|
|
return 1;
|
|
}
|
|
|
|
static char _get_and_skip_quote_char(char const **s)
|
|
{
|
|
char c = 0;
|
|
|
|
if (**s == '"' || **s == '\'') {
|
|
c = **s;
|
|
(*s)++;
|
|
}
|
|
|
|
return c;
|
|
}
|
|
|
|
/*
|
|
* Input:
|
|
* ft - field type for which the value is parsed
|
|
* mem - memory pool to allocate from
|
|
* s - a pointer to the parsed string
|
|
* Output:
|
|
* begin - a pointer to the beginning of the token (whole list)
|
|
* end - a pointer to the end of the token + 1 (whole list)
|
|
* sel_str_list - the list of strings parsed
|
|
*/
|
|
static const char *_tok_value_string_list(const struct dm_report_field_type *ft,
|
|
struct dm_pool *mem, const char *s,
|
|
const char **begin, const char **end,
|
|
struct selection_str_list **sel_str_list)
|
|
{
|
|
static const char _str_list_item_parsing_failed[] = "Failed to parse string list value "
|
|
"for selection field %s.";
|
|
struct selection_str_list *ssl = NULL;
|
|
struct dm_str_list *item;
|
|
const char *begin_item, *end_item, *tmp;
|
|
uint32_t end_op_flags, end_op_flag_hit;
|
|
struct dm_str_list **arr;
|
|
size_t list_size;
|
|
unsigned int i;
|
|
int list_end;
|
|
char c;
|
|
|
|
if (!(ssl = dm_pool_alloc(mem, sizeof(*ssl))) ||
|
|
!(ssl->list = dm_pool_alloc(mem, sizeof(*ssl->list)))) {
|
|
log_error("_tok_value_string_list: memory allocation failed for selection list");
|
|
goto bad;
|
|
}
|
|
dm_list_init(ssl->list);
|
|
ssl->type = 0;
|
|
*begin = s;
|
|
|
|
if (!_tok_op_log(s, &tmp, SEL_LIST_LS)) {
|
|
/* Only one item - SEL_LIST_LS and SEL_LIST_LE not used */
|
|
c = _get_and_skip_quote_char(&s);
|
|
if (!(s = _tok_value_string(s, &begin_item, &end_item, c, SEL_AND | SEL_OR | SEL_PRECEDENCE_PE, NULL))) {
|
|
log_error(_str_list_item_parsing_failed, ft->id);
|
|
goto bad;
|
|
}
|
|
if (!_add_item_to_string_list(mem, begin_item, end_item, ssl->list))
|
|
goto_bad;
|
|
ssl->type = SEL_OR;
|
|
goto out;
|
|
}
|
|
|
|
/* More than one item - items enclosed in SEL_LIST_LS and SEL_LIST_LE.
|
|
* Each element is terminated by AND or OR operator or 'list end'.
|
|
* The first operator hit is then the one allowed for the whole list,
|
|
* no mixing allowed!
|
|
*/
|
|
end_op_flags = SEL_LIST_LE | SEL_AND | SEL_OR;
|
|
s++;
|
|
while (*s) {
|
|
s = _skip_space(s);
|
|
c = _get_and_skip_quote_char(&s);
|
|
if (!(s = _tok_value_string(s, &begin_item, &end_item, c, end_op_flags, NULL))) {
|
|
log_error(_str_list_item_parsing_failed, ft->id);
|
|
goto bad;
|
|
}
|
|
s = _skip_space(s);
|
|
|
|
if (!(end_op_flag_hit = _tok_op_log(s, &tmp, end_op_flags))) {
|
|
log_error("Invalid operator in selection list.");
|
|
goto bad;
|
|
}
|
|
|
|
list_end = end_op_flag_hit == SEL_LIST_LE;
|
|
|
|
if (ssl->type) {
|
|
if (!list_end && !(ssl->type & end_op_flag_hit)) {
|
|
log_error("Only one type of logical operator allowed "
|
|
"in selection list at a time.");
|
|
goto bad;
|
|
}
|
|
} else
|
|
ssl->type = list_end ? SEL_OR : end_op_flag_hit;
|
|
|
|
if (!_add_item_to_string_list(mem, begin_item, end_item, ssl->list))
|
|
goto_bad;
|
|
|
|
s = tmp;
|
|
|
|
if (list_end)
|
|
break;
|
|
}
|
|
|
|
if (end_op_flag_hit != SEL_LIST_LE) {
|
|
log_error("Missing list end for selection field %s", ft->id);
|
|
goto bad;
|
|
}
|
|
|
|
/* Sort the list. */
|
|
if (!(list_size = dm_list_size(ssl->list))) {
|
|
log_error(INTERNAL_ERROR "_tok_value_string_list: list has no items");
|
|
goto bad;
|
|
} else if (list_size == 1)
|
|
goto out;
|
|
if (!(arr = dm_malloc(sizeof(item) * list_size))) {
|
|
log_error("_tok_value_string_list: memory allocation failed for sort array");
|
|
goto bad;
|
|
}
|
|
|
|
i = 0;
|
|
dm_list_iterate_items(item, ssl->list)
|
|
arr[i++] = item;
|
|
qsort(arr, list_size, sizeof(item), _str_list_item_cmp);
|
|
dm_list_init(ssl->list);
|
|
for (i = 0; i < list_size; i++)
|
|
dm_list_add(ssl->list, &arr[i]->list);
|
|
|
|
dm_free(arr);
|
|
out:
|
|
*end = s;
|
|
*sel_str_list = ssl;
|
|
return s;
|
|
bad:
|
|
*end = s;
|
|
if (ssl)
|
|
dm_pool_free(mem, ssl);
|
|
*sel_str_list = NULL;
|
|
return s;
|
|
}
|
|
|
|
/*
|
|
* Input:
|
|
* ft - field type for which the value is parsed
|
|
* s - a pointer to the parsed string
|
|
* mem - memory pool to allocate from
|
|
* Output:
|
|
* begin - a pointer to the beginning of the token
|
|
* end - a pointer to the end of the token + 1
|
|
* flags - parsing flags
|
|
* custom - custom data specific to token type
|
|
* (e.g. size unit factor)
|
|
*/
|
|
static const char *_tok_value(const struct dm_report_field_type *ft,
|
|
const char *s, const char **begin,
|
|
const char **end, uint32_t *flags,
|
|
struct dm_pool *mem, void *custom)
|
|
{
|
|
int expected_type = ft->flags & DM_REPORT_FIELD_TYPE_MASK;
|
|
struct selection_str_list **str_list;
|
|
uint64_t *factor;
|
|
const char *tmp;
|
|
char c;
|
|
|
|
s = _skip_space(s);
|
|
|
|
switch (expected_type) {
|
|
|
|
case DM_REPORT_FIELD_TYPE_STRING:
|
|
c = _get_and_skip_quote_char(&s);
|
|
if (!(s = _tok_value_string(s, begin, end, c, SEL_AND | SEL_OR | SEL_PRECEDENCE_PE, NULL))) {
|
|
log_error("Failed to parse string value "
|
|
"for selection field %s.", ft->id);
|
|
return NULL;
|
|
}
|
|
*flags |= DM_REPORT_FIELD_TYPE_STRING;
|
|
break;
|
|
|
|
case DM_REPORT_FIELD_TYPE_STRING_LIST:
|
|
str_list = (struct selection_str_list **) custom;
|
|
s = _tok_value_string_list(ft, mem, s, begin, end, str_list);
|
|
if (!(*str_list)) {
|
|
log_error("Failed to parse string list value "
|
|
"for selection field %s.", ft->id);
|
|
return NULL;
|
|
}
|
|
*flags |= DM_REPORT_FIELD_TYPE_STRING_LIST;
|
|
break;
|
|
|
|
case DM_REPORT_FIELD_TYPE_NUMBER:
|
|
case DM_REPORT_FIELD_TYPE_SIZE:
|
|
if (!(s = _tok_value_number(s, begin, end))) {
|
|
log_error("Failed to parse numeric value "
|
|
"for selection field %s.", ft->id);
|
|
return NULL;
|
|
}
|
|
factor = (uint64_t *) custom;
|
|
*factor = dm_units_to_factor(s, &c, 0, &tmp);
|
|
|
|
if (expected_type == DM_REPORT_FIELD_TYPE_NUMBER) {
|
|
if (*factor) {
|
|
log_error("Found size unit specifier but "
|
|
"only numeric value expected for "
|
|
"selection field %s.",ft->id);
|
|
return NULL;
|
|
}
|
|
*flags |= DM_REPORT_FIELD_TYPE_NUMBER;
|
|
} else {
|
|
s = tmp;
|
|
/*
|
|
* If size unit is not defined in the selection
|
|
* use use 'm' (1 MiB) by default. This is the
|
|
* same behaviour as seen in lvcreate -L <size>.
|
|
*/
|
|
if (!*factor)
|
|
*factor = 1024*1024;
|
|
*flags |= DM_REPORT_FIELD_TYPE_SIZE;
|
|
}
|
|
}
|
|
|
|
return s;
|
|
}
|
|
|
|
/*
|
|
* Input:
|
|
* s - a pointer to the parsed string
|
|
* Output:
|
|
* begin - a pointer to the beginning of the token
|
|
* end - a pointer to the end of the token + 1
|
|
*/
|
|
static const char *_tok_field_name(const char *s,
|
|
const char **begin, const char **end)
|
|
{
|
|
char c;
|
|
s = _skip_space(s);
|
|
|
|
*begin = s;
|
|
while ((c = *s) &&
|
|
(isalnum(c) || c == '_' || c == '-'))
|
|
s++;
|
|
*end = s;
|
|
|
|
if (*begin == *end)
|
|
return NULL;
|
|
|
|
return s;
|
|
}
|
|
|
|
static struct field_selection *_create_field_selection(struct dm_report *rh,
|
|
uint32_t field_num,
|
|
const char *v,
|
|
size_t len,
|
|
uint32_t flags,
|
|
void *custom)
|
|
{
|
|
static const char *_out_of_range_msg = "Field selection value %s out of supported range for field %s.";
|
|
struct field_properties *fp, *found = NULL;
|
|
struct field_selection *fs;
|
|
const char *field_id;
|
|
uint64_t factor;
|
|
char *s;
|
|
|
|
dm_list_iterate_items(fp, &rh->field_props) {
|
|
if (fp->field_num == field_num) {
|
|
found = fp;
|
|
break;
|
|
}
|
|
}
|
|
|
|
/* The field is neither used in display options nor sort keys. */
|
|
if (!found) {
|
|
if (!(found = _add_field(rh, field_num, FLD_HIDDEN)))
|
|
return NULL;
|
|
rh->report_types |= rh->fields[field_num].type;
|
|
}
|
|
|
|
field_id = rh->fields[found->field_num].id;
|
|
|
|
if (!(found->flags & flags & DM_REPORT_FIELD_TYPE_MASK)) {
|
|
log_error("dm_report: incompatible comparison "
|
|
"type for selection field %s", field_id);
|
|
return NULL;
|
|
}
|
|
|
|
/* set up selection */
|
|
if (!(fs = dm_pool_zalloc(rh->mem, sizeof(struct field_selection)))) {
|
|
log_error("dm_report: struct field_selection "
|
|
"allocation failed for selection field %s", field_id);
|
|
return NULL;
|
|
}
|
|
fs->fp = found;
|
|
fs->flags = flags;
|
|
|
|
/* store comparison operand */
|
|
if (flags & FLD_CMP_REGEX) {
|
|
/* REGEX */
|
|
if (!(s = dm_malloc(len + 1))) {
|
|
log_error("dm_report: dm_malloc failed to store "
|
|
"regex value for selection field %s", field_id);
|
|
goto error;
|
|
}
|
|
memcpy(s, v, len);
|
|
s[len] = '\0';
|
|
|
|
fs->v.r = dm_regex_create(rh->mem, (const char **) &s, 1);
|
|
dm_free(s);
|
|
if (!fs->v.r) {
|
|
log_error("dm_report: failed to create regex "
|
|
"matcher for selection field %s", field_id);
|
|
goto error;
|
|
}
|
|
} else {
|
|
/* STRING, NUMBER, SIZE or STRING_LIST */
|
|
if (!(s = dm_pool_alloc(rh->mem, len + 1))) {
|
|
log_error("dm_report: dm_pool_alloc failed to store "
|
|
"value for selection field %s", field_id);
|
|
goto error;
|
|
}
|
|
memcpy(s, v, len);
|
|
s[len] = '\0';
|
|
|
|
switch (flags & DM_REPORT_FIELD_TYPE_MASK) {
|
|
case DM_REPORT_FIELD_TYPE_STRING:
|
|
fs->v.s = s;
|
|
break;
|
|
case DM_REPORT_FIELD_TYPE_NUMBER:
|
|
if (((fs->v.i = strtoull(s, NULL, 10)) == ULLONG_MAX) &&
|
|
(errno == ERANGE)) {
|
|
log_error(_out_of_range_msg, s, field_id);
|
|
goto error;
|
|
}
|
|
dm_pool_free(rh->mem, s);
|
|
break;
|
|
case DM_REPORT_FIELD_TYPE_SIZE:
|
|
fs->v.d = strtod(s, NULL);
|
|
if (errno == ERANGE) {
|
|
log_error(_out_of_range_msg, s, field_id);
|
|
goto error;
|
|
}
|
|
if (custom && (factor = *((uint64_t *)custom)))
|
|
fs->v.d *= factor;
|
|
fs->v.d /= 512; /* store size in sectors! */
|
|
dm_pool_free(rh->mem, s);
|
|
break;
|
|
case DM_REPORT_FIELD_TYPE_STRING_LIST:
|
|
fs->v.l = *(struct selection_str_list **)custom;
|
|
break;
|
|
default:
|
|
log_error(INTERNAL_ERROR "_create_field_selection: "
|
|
"unknown type of selection field %s", field_id);
|
|
goto error;
|
|
}
|
|
}
|
|
|
|
return fs;
|
|
error:
|
|
dm_pool_free(rh->mem, fs);
|
|
return NULL;
|
|
}
|
|
|
|
static struct selection_node *_alloc_selection_node(struct dm_pool *mem, uint32_t type)
|
|
{
|
|
struct selection_node *sn;
|
|
|
|
if (!(sn = dm_pool_zalloc(mem, sizeof(struct selection_node)))) {
|
|
log_error("dm_report: struct selection_node allocation failed");
|
|
return NULL;
|
|
}
|
|
|
|
dm_list_init(&sn->list);
|
|
sn->type = type;
|
|
if (!(type & SEL_ITEM))
|
|
dm_list_init(&sn->selection.set);
|
|
|
|
return sn;
|
|
}
|
|
|
|
static void _display_selection_help(struct dm_report *rh)
|
|
{
|
|
struct op_def *t;
|
|
|
|
log_warn("Selection operands");
|
|
log_warn("------------------");
|
|
log_warn(" field - Reporting field.");
|
|
log_warn(" number - Non-negative integer value.");
|
|
log_warn(" size - Floating point value with units, 'm' unit used by default if not specified.");
|
|
log_warn(" string - Characters quoted by \' or \" or unquoted.");
|
|
log_warn(" string list - Strings enclosed by [ ] and elements delimited by either");
|
|
log_warn(" \"all items must match\" or \"at least one item must match\" operator.");
|
|
log_warn(" regular expression - Characters quoted by \' or \" or unquoted.");
|
|
log_warn(" ");
|
|
log_warn("Selection operators");
|
|
log_warn("-------------------");
|
|
log_warn(" Comparison operators:");
|
|
t = _op_cmp;
|
|
for (; t->string; t++)
|
|
log_warn(" %4s - %s", t->string, t->desc);
|
|
log_warn(" ");
|
|
log_warn(" Logical and grouping operators:");
|
|
t = _op_log;
|
|
for (; t->string; t++)
|
|
log_warn(" %4s - %s", t->string, t->desc);
|
|
log_warn(" ");
|
|
}
|
|
|
|
static char _sel_syntax_error_at_msg[] = "Selection syntax error at '%s'.";
|
|
|
|
/*
|
|
* Selection parser
|
|
*
|
|
* _parse_* functions
|
|
*
|
|
* Input:
|
|
* s - a pointer to the parsed string
|
|
* Output:
|
|
* next - a pointer used for next _parse_*'s input,
|
|
* next == s if return value is NULL
|
|
* return value - a filter node pointer,
|
|
* NULL if s doesn't match
|
|
*/
|
|
|
|
/*
|
|
* SELECTION := FIELD_NAME OP_CMP STRING |
|
|
* FIELD_NAME OP_CMP NUMBER |
|
|
* FIELD_NAME OP_REGEX REGEX
|
|
*/
|
|
static struct selection_node *_parse_selection(struct dm_report *rh,
|
|
const char *s,
|
|
const char **next)
|
|
{
|
|
struct field_selection *fs;
|
|
struct selection_node *sn;
|
|
const char *ws, *we; /* field name */
|
|
const char *vs, *ve; /* value */
|
|
const char *last;
|
|
uint32_t flags, field_num;
|
|
const struct dm_report_field_type *ft;
|
|
struct selection_str_list *str_list;
|
|
uint64_t factor;
|
|
void *custom;
|
|
char *tmp;
|
|
char c;
|
|
|
|
/* field name */
|
|
if (!(last = _tok_field_name(s, &ws, &we))) {
|
|
log_error("Expecting field name");
|
|
goto bad;
|
|
}
|
|
|
|
/* check if the field with given name exists */
|
|
if (!_get_field(rh, ws, (size_t) (we - ws), &field_num)) {
|
|
c = we[0];
|
|
tmp = (char *) we;
|
|
tmp[0] = '\0';
|
|
_display_fields(rh, 0);
|
|
log_warn(" ");
|
|
log_error("Unrecognised selection field: %s", ws);
|
|
tmp[0] = c;
|
|
goto bad;
|
|
}
|
|
|
|
ft = &rh->fields[field_num];
|
|
|
|
/* comparison operator */
|
|
if (!(flags = _tok_op_cmp(we, &last))) {
|
|
_display_selection_help(rh);
|
|
log_error("Unrecognised comparison operator: %s", we);
|
|
goto bad;
|
|
}
|
|
if (!last) {
|
|
_display_selection_help(rh);
|
|
log_error("Missing value after operator");
|
|
goto bad;
|
|
}
|
|
|
|
/* some operators can compare only numeric fields */
|
|
if ((flags & FLD_CMP_NUMBER) &&
|
|
(ft->flags != DM_REPORT_FIELD_TYPE_NUMBER) &&
|
|
(ft->flags != DM_REPORT_FIELD_TYPE_SIZE)) {
|
|
_display_selection_help(rh);
|
|
log_error("Operator can be used only with numeric or size fields: %s", ws);
|
|
goto bad;
|
|
}
|
|
|
|
/* comparison value */
|
|
if (flags & FLD_CMP_REGEX) {
|
|
if (!(last = _tok_value_regex(ft, last, &vs, &ve, &flags)))
|
|
goto_bad;
|
|
} else {
|
|
if (ft->flags == DM_REPORT_FIELD_TYPE_SIZE ||
|
|
ft->flags == DM_REPORT_FIELD_TYPE_NUMBER)
|
|
custom = &factor;
|
|
else if (ft->flags == DM_REPORT_FIELD_TYPE_STRING_LIST)
|
|
custom = &str_list;
|
|
else
|
|
custom = NULL;
|
|
if (!(last = _tok_value(ft, last, &vs, &ve, &flags, rh->mem, custom)))
|
|
goto_bad;
|
|
}
|
|
|
|
*next = _skip_space(last);
|
|
|
|
/* create selection */
|
|
if (!(fs = _create_field_selection(rh, field_num, vs, (size_t) (ve - vs), flags, custom)))
|
|
return_NULL;
|
|
|
|
/* create selection node */
|
|
if (!(sn = _alloc_selection_node(rh->mem, SEL_ITEM)))
|
|
return_NULL;
|
|
|
|
/* add selection to selection node */
|
|
sn->selection.item = fs;
|
|
|
|
return sn;
|
|
bad:
|
|
log_error(_sel_syntax_error_at_msg, s);
|
|
*next = s;
|
|
return NULL;
|
|
}
|
|
|
|
static struct selection_node *_parse_or_ex(struct dm_report *rh,
|
|
const char *s,
|
|
const char **next,
|
|
struct selection_node *or_sn);
|
|
|
|
static struct selection_node *_parse_ex(struct dm_report *rh,
|
|
const char *s,
|
|
const char **next)
|
|
{
|
|
static const char _ps_expected_msg[] = "Syntax error: left parenthesis expected at \'%s\'";
|
|
static const char _pe_expected_msg[] = "Syntax error: right parenthesis expected at \'%s\'";
|
|
struct selection_node *sn = NULL;
|
|
uint32_t t;
|
|
const char *tmp;
|
|
|
|
t = _tok_op_log(s, next, SEL_MODIFIER_NOT | SEL_PRECEDENCE_PS);
|
|
if (t == SEL_MODIFIER_NOT) {
|
|
/* '!' '(' EXPRESSION ')' */
|
|
if (!_tok_op_log(*next, &tmp, SEL_PRECEDENCE_PS)) {
|
|
log_error(_ps_expected_msg, *next);
|
|
goto error;
|
|
}
|
|
if (!(sn = _parse_or_ex(rh, tmp, next, NULL)))
|
|
goto error;
|
|
sn->type |= SEL_MODIFIER_NOT;
|
|
if (!_tok_op_log(*next, &tmp, SEL_PRECEDENCE_PE)) {
|
|
log_error(_pe_expected_msg, *next);
|
|
goto error;
|
|
}
|
|
*next = tmp;
|
|
} else if (t == SEL_PRECEDENCE_PS) {
|
|
/* '(' EXPRESSION ')' */
|
|
if (!(sn = _parse_or_ex(rh, *next, &tmp, NULL)))
|
|
goto error;
|
|
if (!_tok_op_log(tmp, next, SEL_PRECEDENCE_PE)) {
|
|
log_error(_pe_expected_msg, *next);
|
|
goto error;
|
|
}
|
|
} else if ((s = _skip_space(s))) {
|
|
/* SELECTION */
|
|
sn = _parse_selection(rh, s, next);
|
|
} else {
|
|
sn = NULL;
|
|
*next = s;
|
|
}
|
|
|
|
return sn;
|
|
error:
|
|
*next = s;
|
|
return NULL;
|
|
}
|
|
|
|
/* AND_EXPRESSION := EX (AND_OP AND_EXPRSSION) */
|
|
static struct selection_node *_parse_and_ex(struct dm_report *rh,
|
|
const char *s,
|
|
const char **next,
|
|
struct selection_node *and_sn)
|
|
{
|
|
struct selection_node *n;
|
|
const char *tmp;
|
|
|
|
n = _parse_ex(rh, s, next);
|
|
if (!n)
|
|
goto error;
|
|
|
|
if (!_tok_op_log(*next, &tmp, SEL_AND)) {
|
|
if (!and_sn)
|
|
return n;
|
|
dm_list_add(&and_sn->selection.set, &n->list);
|
|
return and_sn;
|
|
}
|
|
|
|
if (!and_sn) {
|
|
if (!(and_sn = _alloc_selection_node(rh->mem, SEL_AND)))
|
|
goto error;
|
|
}
|
|
dm_list_add(&and_sn->selection.set, &n->list);
|
|
|
|
return _parse_and_ex(rh, tmp, next, and_sn);
|
|
error:
|
|
*next = s;
|
|
return NULL;
|
|
}
|
|
|
|
/* OR_EXPRESSION := AND_EXPRESSION (OR_OP OR_EXPRESSION) */
|
|
static struct selection_node *_parse_or_ex(struct dm_report *rh,
|
|
const char *s,
|
|
const char **next,
|
|
struct selection_node *or_sn)
|
|
{
|
|
struct selection_node *n;
|
|
const char *tmp;
|
|
|
|
n = _parse_and_ex(rh, s, next, NULL);
|
|
if (!n)
|
|
goto error;
|
|
|
|
if (!_tok_op_log(*next, &tmp, SEL_OR)) {
|
|
if (!or_sn)
|
|
return n;
|
|
dm_list_add(&or_sn->selection.set, &n->list);
|
|
return or_sn;
|
|
}
|
|
|
|
if (!or_sn) {
|
|
if (!(or_sn = _alloc_selection_node(rh->mem, SEL_OR)))
|
|
goto error;
|
|
}
|
|
dm_list_add(&or_sn->selection.set, &n->list);
|
|
|
|
return _parse_or_ex(rh, tmp, next, or_sn);
|
|
error:
|
|
*next = s;
|
|
return NULL;
|
|
}
|
|
|
|
struct dm_report *dm_report_init_with_selection(uint32_t *report_types,
|
|
const struct dm_report_object_type *types,
|
|
const struct dm_report_field_type *fields,
|
|
const char *output_fields,
|
|
const char *output_separator,
|
|
uint32_t output_flags,
|
|
const char *sort_keys,
|
|
const char *selection,
|
|
void *private_data)
|
|
{
|
|
struct dm_report *rh;
|
|
struct selection_node *root = NULL;
|
|
const char *fin, *next;
|
|
|
|
if (!(rh = dm_report_init(report_types, types, fields, output_fields,
|
|
output_separator, output_flags, sort_keys, private_data)))
|
|
return NULL;
|
|
|
|
if (!selection || !selection[0]) {
|
|
rh->selection_root = NULL;
|
|
return rh;
|
|
}
|
|
|
|
if (!strcasecmp(selection, DM_REPORT_FIELD_RESERVED_NAME_HELP) ||
|
|
!strcmp(selection, DM_REPORT_FIELD_RESERVED_NAME_HELP_ALT)) {
|
|
_display_fields(rh, 0);
|
|
log_warn(" ");
|
|
_display_selection_help(rh);
|
|
dm_report_free(rh);
|
|
return NULL;
|
|
}
|
|
|
|
if (!(root = _alloc_selection_node(rh->mem, SEL_OR)))
|
|
return_0;
|
|
|
|
if (!_parse_or_ex(rh, selection, &fin, root))
|
|
goto error;
|
|
|
|
next = _skip_space(fin);
|
|
if (*next) {
|
|
log_error("Expecting logical operator");
|
|
log_error(_sel_syntax_error_at_msg, next);
|
|
goto error;
|
|
}
|
|
|
|
if (report_types)
|
|
*report_types = rh->report_types;
|
|
|
|
rh->selection_root = root;
|
|
return rh;
|
|
error:
|
|
dm_report_free(rh);
|
|
return NULL;
|
|
}
|
|
|
|
/*
|
|
* Print row of headings
|
|
*/
|
|
static int _report_headings(struct dm_report *rh)
|
|
{
|
|
struct field_properties *fp;
|
|
const char *heading;
|
|
char *buf = NULL;
|
|
size_t buf_size = 0;
|
|
|
|
if (rh->flags & RH_HEADINGS_PRINTED)
|
|
return 1;
|
|
|
|
rh->flags |= RH_HEADINGS_PRINTED;
|
|
|
|
if (!(rh->flags & DM_REPORT_OUTPUT_HEADINGS))
|
|
return 1;
|
|
|
|
if (!dm_pool_begin_object(rh->mem, 128)) {
|
|
log_error("dm_report: "
|
|
"dm_pool_begin_object failed for headings");
|
|
return 0;
|
|
}
|
|
|
|
dm_list_iterate_items(fp, &rh->field_props) {
|
|
if ((int) buf_size < fp->width)
|
|
buf_size = (size_t) fp->width;
|
|
}
|
|
/* Including trailing '\0'! */
|
|
buf_size++;
|
|
|
|
if (!(buf = dm_malloc(buf_size))) {
|
|
log_error("dm_report: Could not allocate memory for heading buffer.");
|
|
goto bad;
|
|
}
|
|
|
|
/* First heading line */
|
|
dm_list_iterate_items(fp, &rh->field_props) {
|
|
if (fp->flags & FLD_HIDDEN)
|
|
continue;
|
|
|
|
heading = rh->fields[fp->field_num].heading;
|
|
if (rh->flags & DM_REPORT_OUTPUT_ALIGNED) {
|
|
if (dm_snprintf(buf, buf_size, "%-*.*s",
|
|
fp->width, fp->width, heading) < 0) {
|
|
log_error("dm_report: snprintf heading failed");
|
|
goto bad;
|
|
}
|
|
if (!dm_pool_grow_object(rh->mem, buf, fp->width)) {
|
|
log_error("dm_report: Failed to generate report headings for printing");
|
|
goto bad;
|
|
}
|
|
} else if (!dm_pool_grow_object(rh->mem, heading, 0)) {
|
|
log_error("dm_report: Failed to generate report headings for printing");
|
|
goto bad;
|
|
}
|
|
|
|
if (!dm_list_end(&rh->field_props, &fp->list))
|
|
if (!dm_pool_grow_object(rh->mem, rh->separator, 0)) {
|
|
log_error("dm_report: Failed to generate report headings for printing");
|
|
goto bad;
|
|
}
|
|
}
|
|
if (!dm_pool_grow_object(rh->mem, "\0", 1)) {
|
|
log_error("dm_report: Failed to generate report headings for printing");
|
|
goto bad;
|
|
}
|
|
log_print("%s", (char *) dm_pool_end_object(rh->mem));
|
|
|
|
dm_free(buf);
|
|
|
|
return 1;
|
|
|
|
bad:
|
|
dm_free(buf);
|
|
dm_pool_abandon_object(rh->mem);
|
|
return 0;
|
|
}
|
|
|
|
/*
|
|
* Sort rows of data
|
|
*/
|
|
static int _row_compare(const void *a, const void *b)
|
|
{
|
|
const struct row *rowa = *(const struct row * const *) a;
|
|
const struct row *rowb = *(const struct row * const *) b;
|
|
const struct dm_report_field *sfa, *sfb;
|
|
uint32_t cnt;
|
|
|
|
for (cnt = 0; cnt < rowa->rh->keys_count; cnt++) {
|
|
sfa = (*rowa->sort_fields)[cnt];
|
|
sfb = (*rowb->sort_fields)[cnt];
|
|
if ((sfa->props->flags & DM_REPORT_FIELD_TYPE_NUMBER) ||
|
|
(sfa->props->flags & DM_REPORT_FIELD_TYPE_SIZE)) {
|
|
const uint64_t numa =
|
|
*(const uint64_t *) sfa->sort_value;
|
|
const uint64_t numb =
|
|
*(const uint64_t *) sfb->sort_value;
|
|
|
|
if (numa == numb)
|
|
continue;
|
|
|
|
if (sfa->props->flags & FLD_ASCENDING) {
|
|
return (numa > numb) ? 1 : -1;
|
|
} else { /* FLD_DESCENDING */
|
|
return (numa < numb) ? 1 : -1;
|
|
}
|
|
} else {
|
|
/* DM_REPORT_FIELD_TYPE_STRING
|
|
* DM_REPORT_FIELD_TYPE_STRING_LIST */
|
|
const char *stra = (const char *) sfa->sort_value;
|
|
const char *strb = (const char *) sfb->sort_value;
|
|
int cmp = strcmp(stra, strb);
|
|
|
|
if (!cmp)
|
|
continue;
|
|
|
|
if (sfa->props->flags & FLD_ASCENDING) {
|
|
return (cmp > 0) ? 1 : -1;
|
|
} else { /* FLD_DESCENDING */
|
|
return (cmp < 0) ? 1 : -1;
|
|
}
|
|
}
|
|
}
|
|
|
|
return 0; /* Identical */
|
|
}
|
|
|
|
static int _sort_rows(struct dm_report *rh)
|
|
{
|
|
struct row *(*rows)[];
|
|
uint32_t count = 0;
|
|
struct row *row;
|
|
|
|
if (!(rows = dm_pool_alloc(rh->mem, sizeof(**rows) *
|
|
dm_list_size(&rh->rows)))) {
|
|
log_error("dm_report: sort array allocation failed");
|
|
return 0;
|
|
}
|
|
|
|
dm_list_iterate_items(row, &rh->rows)
|
|
(*rows)[count++] = row;
|
|
|
|
qsort(rows, count, sizeof(**rows), _row_compare);
|
|
|
|
dm_list_init(&rh->rows);
|
|
while (count--)
|
|
dm_list_add_h(&rh->rows, &(*rows)[count]->list);
|
|
|
|
return 1;
|
|
}
|
|
|
|
/*
|
|
* Produce report output
|
|
*/
|
|
static int _output_field(struct dm_report *rh, struct dm_report_field *field)
|
|
{
|
|
char *field_id;
|
|
int32_t width;
|
|
uint32_t align;
|
|
const char *repstr;
|
|
char *buf = NULL;
|
|
size_t buf_size = 0;
|
|
|
|
if (rh->flags & DM_REPORT_OUTPUT_FIELD_NAME_PREFIX) {
|
|
if (!(field_id = dm_strdup(rh->fields[field->props->field_num].id))) {
|
|
log_error("dm_report: Failed to copy field name");
|
|
return 0;
|
|
}
|
|
|
|
if (!dm_pool_grow_object(rh->mem, rh->output_field_name_prefix, 0)) {
|
|
log_error("dm_report: Unable to extend output line");
|
|
dm_free(field_id);
|
|
return 0;
|
|
}
|
|
|
|
if (!dm_pool_grow_object(rh->mem, _toupperstr(field_id), 0)) {
|
|
log_error("dm_report: Unable to extend output line");
|
|
dm_free(field_id);
|
|
return 0;
|
|
}
|
|
|
|
dm_free(field_id);
|
|
|
|
if (!dm_pool_grow_object(rh->mem, "=", 1)) {
|
|
log_error("dm_report: Unable to extend output line");
|
|
return 0;
|
|
}
|
|
|
|
if (!(rh->flags & DM_REPORT_OUTPUT_FIELD_UNQUOTED) &&
|
|
!dm_pool_grow_object(rh->mem, "\'", 1)) {
|
|
log_error("dm_report: Unable to extend output line");
|
|
return 0;
|
|
}
|
|
}
|
|
|
|
repstr = field->report_string;
|
|
width = field->props->width;
|
|
if (!(rh->flags & DM_REPORT_OUTPUT_ALIGNED)) {
|
|
if (!dm_pool_grow_object(rh->mem, repstr, 0)) {
|
|
log_error("dm_report: Unable to extend output line");
|
|
return 0;
|
|
}
|
|
} else {
|
|
if (!(align = field->props->flags & DM_REPORT_FIELD_ALIGN_MASK))
|
|
align = ((field->props->flags & DM_REPORT_FIELD_TYPE_NUMBER) ||
|
|
(field->props->flags & DM_REPORT_FIELD_TYPE_SIZE)) ?
|
|
DM_REPORT_FIELD_ALIGN_RIGHT : DM_REPORT_FIELD_ALIGN_LEFT;
|
|
|
|
/* Including trailing '\0'! */
|
|
buf_size = width + 1;
|
|
if (!(buf = dm_malloc(buf_size))) {
|
|
log_error("dm_report: Could not allocate memory for output line buffer.");
|
|
return 0;
|
|
}
|
|
|
|
if (align & DM_REPORT_FIELD_ALIGN_LEFT) {
|
|
if (dm_snprintf(buf, buf_size, "%-*.*s",
|
|
width, width, repstr) < 0) {
|
|
log_error("dm_report: left-aligned snprintf() failed");
|
|
goto bad;
|
|
}
|
|
if (!dm_pool_grow_object(rh->mem, buf, width)) {
|
|
log_error("dm_report: Unable to extend output line");
|
|
goto bad;
|
|
}
|
|
} else if (align & DM_REPORT_FIELD_ALIGN_RIGHT) {
|
|
if (dm_snprintf(buf, buf_size, "%*.*s",
|
|
width, width, repstr) < 0) {
|
|
log_error("dm_report: right-aligned snprintf() failed");
|
|
goto bad;
|
|
}
|
|
if (!dm_pool_grow_object(rh->mem, buf, width)) {
|
|
log_error("dm_report: Unable to extend output line");
|
|
goto bad;
|
|
}
|
|
}
|
|
}
|
|
|
|
if ((rh->flags & DM_REPORT_OUTPUT_FIELD_NAME_PREFIX) &&
|
|
!(rh->flags & DM_REPORT_OUTPUT_FIELD_UNQUOTED))
|
|
if (!dm_pool_grow_object(rh->mem, "\'", 1)) {
|
|
log_error("dm_report: Unable to extend output line");
|
|
goto bad;
|
|
}
|
|
|
|
dm_free(buf);
|
|
return 1;
|
|
|
|
bad:
|
|
dm_free(buf);
|
|
return 0;
|
|
}
|
|
|
|
static int _output_as_rows(struct dm_report *rh)
|
|
{
|
|
struct field_properties *fp;
|
|
struct dm_report_field *field;
|
|
struct row *row;
|
|
|
|
dm_list_iterate_items(fp, &rh->field_props) {
|
|
if (fp->flags & FLD_HIDDEN) {
|
|
dm_list_iterate_items(row, &rh->rows) {
|
|
field = dm_list_item(dm_list_first(&row->fields), struct dm_report_field);
|
|
dm_list_del(&field->list);
|
|
}
|
|
continue;
|
|
}
|
|
|
|
if (!dm_pool_begin_object(rh->mem, 512)) {
|
|
log_error("dm_report: Unable to allocate output line");
|
|
return 0;
|
|
}
|
|
|
|
if ((rh->flags & DM_REPORT_OUTPUT_HEADINGS)) {
|
|
if (!dm_pool_grow_object(rh->mem, rh->fields[fp->field_num].heading, 0)) {
|
|
log_error("dm_report: Failed to extend row for field name");
|
|
goto bad;
|
|
}
|
|
if (!dm_pool_grow_object(rh->mem, rh->separator, 0)) {
|
|
log_error("dm_report: Failed to extend row with separator");
|
|
goto bad;
|
|
}
|
|
}
|
|
|
|
dm_list_iterate_items(row, &rh->rows) {
|
|
if ((field = dm_list_item(dm_list_first(&row->fields), struct dm_report_field))) {
|
|
if (!_output_field(rh, field))
|
|
goto bad;
|
|
dm_list_del(&field->list);
|
|
}
|
|
|
|
if (!dm_list_end(&rh->rows, &row->list))
|
|
if (!dm_pool_grow_object(rh->mem, rh->separator, 0)) {
|
|
log_error("dm_report: Unable to extend output line");
|
|
goto bad;
|
|
}
|
|
}
|
|
|
|
if (!dm_pool_grow_object(rh->mem, "\0", 1)) {
|
|
log_error("dm_report: Failed to terminate row");
|
|
goto bad;
|
|
}
|
|
log_print("%s", (char *) dm_pool_end_object(rh->mem));
|
|
}
|
|
|
|
return 1;
|
|
|
|
bad:
|
|
dm_pool_abandon_object(rh->mem);
|
|
return 0;
|
|
}
|
|
|
|
static int _output_as_columns(struct dm_report *rh)
|
|
{
|
|
struct dm_list *fh, *rowh, *ftmp, *rtmp;
|
|
struct row *row = NULL;
|
|
struct dm_report_field *field;
|
|
|
|
/* If headings not printed yet, calculate field widths and print them */
|
|
if (!(rh->flags & RH_HEADINGS_PRINTED))
|
|
_report_headings(rh);
|
|
|
|
/* Print and clear buffer */
|
|
dm_list_iterate_safe(rowh, rtmp, &rh->rows) {
|
|
if (!dm_pool_begin_object(rh->mem, 512)) {
|
|
log_error("dm_report: Unable to allocate output line");
|
|
return 0;
|
|
}
|
|
row = dm_list_item(rowh, struct row);
|
|
dm_list_iterate_safe(fh, ftmp, &row->fields) {
|
|
field = dm_list_item(fh, struct dm_report_field);
|
|
if (field->props->flags & FLD_HIDDEN)
|
|
continue;
|
|
|
|
if (!_output_field(rh, field))
|
|
goto bad;
|
|
|
|
if (!dm_list_end(&row->fields, fh))
|
|
if (!dm_pool_grow_object(rh->mem, rh->separator, 0)) {
|
|
log_error("dm_report: Unable to extend output line");
|
|
goto bad;
|
|
}
|
|
|
|
dm_list_del(&field->list);
|
|
}
|
|
if (!dm_pool_grow_object(rh->mem, "\0", 1)) {
|
|
log_error("dm_report: Unable to terminate output line");
|
|
goto bad;
|
|
}
|
|
log_print("%s", (char *) dm_pool_end_object(rh->mem));
|
|
dm_list_del(&row->list);
|
|
}
|
|
|
|
if (row)
|
|
dm_pool_free(rh->mem, row);
|
|
|
|
return 1;
|
|
|
|
bad:
|
|
dm_pool_abandon_object(rh->mem);
|
|
return 0;
|
|
}
|
|
|
|
int dm_report_output(struct dm_report *rh)
|
|
{
|
|
if (dm_list_empty(&rh->rows))
|
|
return 1;
|
|
|
|
if ((rh->flags & RH_SORT_REQUIRED))
|
|
_sort_rows(rh);
|
|
|
|
if ((rh->flags & DM_REPORT_OUTPUT_COLUMNS_AS_ROWS))
|
|
return _output_as_rows(rh);
|
|
else
|
|
return _output_as_columns(rh);
|
|
}
|