summaryrefslogtreecommitdiff
path: root/lib/ipmi_cfgp.c
blob: b8af80d2c731416b34712c6912f0fafe6bf80bfc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
/*
 * Copyright (c) 2016 Pentair Technical Products. All right reserved
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * Redistribution of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *
 * Redistribution in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution.
 *
 * Neither the name of Pentair Technical Products or the names of
 * contributors may be used to endorse or promote products derived
 * from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
 * PENTAIR TECHNICAL SOLUTIONS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#include <malloc.h>
#include <string.h>

#include <ipmitool/helper.h>
#include <ipmitool/ipmi_cfgp.h>
#include <ipmitool/log.h>

/* ipmi_cfgp_init  initialize configuration parameter context
 * @param ctx      context to initialize
 * @param set      array of parameter descriptors
 * @param count    amount of descriptors supplied
 * @param handler  function to do real job on parameters from the set
 * @param priv     private data for the handler
 */
int
ipmi_cfgp_init(struct ipmi_cfgp_ctx *ctx, const struct ipmi_cfgp *set,
		unsigned int count, const char *cmdname,
		ipmi_cfgp_handler_t handler, void *priv)
{
	if (ctx == NULL || set == NULL || handler == NULL || !cmdname) {
		return -1;
	}

	memset(ctx, 0, sizeof(struct ipmi_cfgp_ctx));

	ctx->set = set;
	ctx->count = count;
	ctx->cmdname = cmdname;
	ctx->handler = handler;
	ctx->priv = priv;

	return 0;
}

/* ipmi_cfgp_uninit  destroy data list attached to context
 * @param ctx          parameter context to clear
 * @returns  0 -- list destroyed
 *          -1 -- ctx is NULL
 */
int
ipmi_cfgp_uninit(struct ipmi_cfgp_ctx *ctx)
{
	struct ipmi_cfgp_data *d;

	if (ctx == NULL) {
		return -1;
	}

	while (ctx->v) {
		d = ctx->v;
		ctx->v = d->next;
		free(d);
		d = NULL;
	}

	return 0;
}

/* lookup_cfgp -- find a parameter in a set*/
static const struct ipmi_cfgp *
lookup_cfgp(const struct ipmi_cfgp_ctx *ctx, const char *name)
{
	const struct ipmi_cfgp *p;
	int i;

	for (i = 0; i < ctx->count; i++) {
		p = &ctx->set[i];

		if (p->name && !strcasecmp(p->name, name)) {
			return p;
		}
	}

	return NULL;
}

/* ipmi_cfgp_parse_sel parse parameter selector
 * (parameter ID, set selector, block selector) from cmdline.
 *
 * @param ctx     configuration parameter context to use
 * @param argc    elements left in argv
 * @param argv    array of arguments
 * @param sel     where to store parsed selector
 *
 * @returns       >=0 number of argv elements used
 *                <0 error
 */
int
ipmi_cfgp_parse_sel(struct ipmi_cfgp_ctx *ctx,
		int argc, const char **argv, struct ipmi_cfgp_sel *sel)
{
	const struct ipmi_cfgp *p;

	if (ctx == NULL || argv == NULL || sel == NULL) {
		return -1;
	}

	sel->param = -1;
	sel->set = -1;
	sel->block = -1;

	if (argc == 0) {
		/* no parameter specified, good for print, save */
		return 0;
	}

	p = lookup_cfgp(ctx, argv[0]);
	if (p == NULL) {
		lprintf(LOG_ERR, "invalid parameter");
		return -1;
	}

	sel->param = p - ctx->set;
	sel->set = p->is_set ? -1 : 0;
	sel->block = p->has_blocks ? -1 : 0;

	if (argc == 1 || !p->is_set) {
		/* No set and block selector applicable or specified */
		return 1;
	}

	if (str2int(argv[1], &sel->set)
		|| sel->set < 0
		|| (sel->set == 0 && p->first_set)) {
		lprintf(LOG_ERR, "invalid set selector");
		return -1;
	}

	if (argc == 2 || !p->has_blocks) {
		/* No block selector applicable or specified */
		return 2;
	}

	if (str2int(argv[2], &sel->block)
		|| sel->block < 0
		|| (sel->block == 0 && p->first_block)) {
		lprintf(LOG_ERR, "invalid block selector");
		return -1;
	}

	return 3;
}

/* cfgp_add_data  adds block of data to list in the configuration
 * parameter context
 *
 * @param ctx    context to add data to
 * @param data   parameter data
 */
static void
cfgp_add_data(struct ipmi_cfgp_ctx *ctx, struct ipmi_cfgp_data *data)
{
	struct ipmi_cfgp_data **pprev = &ctx->v;

	data->next = NULL;

	while (*pprev) {
		pprev = &(*pprev)->next;
	}

	*pprev = data;
}

/* cfgp_usage     prints format for configuration parameter
 *
 * @param p       configuration parameter descriptor
 * @param write   0 if no value is expected, !=0 otherwise
 */
static void
cfgp_usage(const struct ipmi_cfgp *p, int write)
{
	if (p->name == NULL) {
		return;
	}

	if (write && p->format == NULL) {
		return;
	}

	printf("    %s%s%s %s\n",
		p->name, p->is_set ? " <set_sel>" : "",
		p->has_blocks ? " <block_sel>" : "",
		write ? p->format : "");
}

/* ipmi_cfgp_usage     prints format for configuration parameter set
 *
 * @param set       configuration parameter descriptor array
 * @param count     number of elements in set
 * @param write     0 if no value is expected, !=0 otherwise
 */
void
ipmi_cfgp_usage(const struct ipmi_cfgp *set, int count, int write)
{
	const struct ipmi_cfgp *p;
	int i;

	if (set == NULL) {
		return;
	}

	for (i = 0; i < count; i++) {
		p = &set[i];

		if (write && p->access == CFGP_RDONLY) {
			continue;
		}

		if (!write && p->access == CFGP_WRONLY) {
			continue;
		}

		cfgp_usage(p, write);
	}
}

/* ipmi_cfgp_parse_data   parse parameter data from command line into context
 * @param ctx        context to add data
 * @param sel        parameter selector
 * @param argc       number of elements in argv
 * @param argv       array of unparsed arguments
 *
 * @returns          0 on success
 *                  <0 on error
 */
int
ipmi_cfgp_parse_data(struct ipmi_cfgp_ctx *ctx,
		const struct ipmi_cfgp_sel *sel, int argc, const char **argv)
{
	const struct ipmi_cfgp *p;
	struct ipmi_cfgp_data *data;
	struct ipmi_cfgp_action action;

	if (ctx == NULL || sel == NULL || argv == NULL) {
		return -1;
	}

	if (sel->param == -1 || sel->param >= ctx->count) {
		lprintf(LOG_ERR, "invalid parameter, must be one of:");
		ipmi_cfgp_usage(ctx->set, ctx->count, 1);
		return -1;
	}

	if (sel->set == -1) {
		lprintf(LOG_ERR, "set selector is not specified");
		return -1;
	}

	if (sel->block == -1) {
		lprintf(LOG_ERR, "block selector is not specified");
		return -1;
	}

	p = &ctx->set[sel->param];

	if (p->size == 0) {
		return -1;
	}

	data = malloc(sizeof(struct ipmi_cfgp_data) + p->size);
	if (data == NULL) {
		return -1;
	}

	memset(data, 0, sizeof(struct ipmi_cfgp_data) + p->size);

	action.type = CFGP_PARSE;
	action.set = sel->set;
	action.block = sel->block;
	action.argc = argc;
	action.argv = argv;
	action.file = NULL;

	if (ctx->handler(ctx->priv, p, &action, data->data) != 0) {
		ipmi_cfgp_usage(p, 1, 1);
		free(data);
		data = NULL;
		return -1;
	}

	data->sel = *sel;

	cfgp_add_data(ctx, data);
	return 0;
}

/* cfgp_get_param -- get parameter data from MC into data list within context
 *
 * @param ctx      context
 * @param p        parameter descriptor
 * @param set      parameter set selector, can be -1 to scan all set selectors
 * @param block    parameter block selector, can be -1 to get all blocks
 * @param quiet    set to non-zero to continue on errors
 *                 (required for -1 to work)
 * @returns        0 on success, non-zero otherwise
 */
static int
cfgp_get_param(struct ipmi_cfgp_ctx *ctx, const struct ipmi_cfgp *p,
		int set, int block, int quiet)
{
	struct ipmi_cfgp_data *data;
	struct ipmi_cfgp_action action;
	int cset;
	int cblock;
	int ret;

	if (p->size == 0) {
		return -1;
	}

	action.type = CFGP_GET;
	action.argc = 0;
	action.argv = NULL;
	action.file = NULL;

	if (set == -1 && !p->is_set) {
		set = 0;
	}

	if (block == -1 && !p->has_blocks) {
		block = 0;
	}

	if (set == -1) {
		cset = p->first_set;
	} else {
		cset = set;
	}

	action.quiet = quiet;

	do {
		if (block == -1) {
			cblock = p->first_block;
		} else {
			cblock = block;
		}

		do {
			data = malloc(sizeof(struct ipmi_cfgp_data) + p->size);
			if (data == NULL) {
				return -1;
			}

			memset(data, 0, sizeof(struct ipmi_cfgp_data) + p->size);

			action.set = cset;
			action.block = cblock;

			ret = ctx->handler(ctx->priv, p, &action, data->data);
			if (ret != 0) {
				free(data);
				data = NULL;

				if (!action.quiet) {
					return ret;
				}
				break;
			}

			data->sel.param = p - ctx->set;
			data->sel.set = cset;
			data->sel.block = cblock;

			cfgp_add_data(ctx, data);

			cblock++;
			action.quiet = 1;
		} while (block == -1);

		if (ret != 0 && cblock == p->first_block) {
			break;
		}

		cset++;
	} while (set == -1);

	return 0;
}

/* ipmi_cfgp_get -- get parameters data from MC into data list within context
 *
 * @param ctx      context
 * @param sel      parameter selector
 * @returns        0 on success, non-zero otherwise
 */
int
ipmi_cfgp_get(struct ipmi_cfgp_ctx *ctx, const struct ipmi_cfgp_sel *sel)
{
	int i;
	int ret;

	if (ctx == NULL || sel == NULL) {
		return -1;
	}

	if (sel->param != -1) {
		if (sel->param >= ctx->count) {
			return -1;
		}

		ret = cfgp_get_param(ctx, &ctx->set[sel->param],
			sel->set, sel->block, 0);
		if (ret) {
			return -1;
		}
		return 0;
	}

	for (i = 0; i < ctx->count; i++) {
		if (ctx->set[i].access == CFGP_WRONLY) {
			continue;
		}

		if (cfgp_get_param(ctx, &ctx->set[i], sel->set, sel->block, 1)) {
			return -1;
		}
	}

	return 0;
}

static int
cfgp_do_action(struct ipmi_cfgp_ctx *ctx, int action_type,
		const struct ipmi_cfgp_sel *sel, FILE *file, int filter)
{
	const struct ipmi_cfgp *p;
	struct ipmi_cfgp_data *data;
	struct ipmi_cfgp_action action;
	int ret;

	if (ctx == NULL || sel == NULL) {
		return -1;
	}

	action.type = action_type;
	action.argc = 0;
	action.argv = NULL;
	action.file = file;

	for (data = ctx->v; data != NULL; data = data->next) {
		if (sel->param != -1 && sel->param != data->sel.param) {
			continue;
		}
		if (sel->set != -1 && sel->set != data->sel.set) {
			continue;
		}
		if (sel->block != -1 && sel->block != data->sel.block) {
			continue;
		}
		if (ctx->set[data->sel.param].access == filter) {
			continue;
		}

		p = &ctx->set[data->sel.param];

		action.set = data->sel.set;
		action.block = data->sel.block;

		if (action_type == CFGP_SAVE) {
			fprintf(file, "%s %s ", ctx->cmdname, p->name);
			if (p->is_set) {
				fprintf(file, "%d ", data->sel.set);
			}
			if (p->has_blocks) {
				fprintf(file, "%d ", data->sel.block);
			}
		}

		ret = ctx->handler(ctx->priv, p, &action, data->data);

		if (action_type == CFGP_SAVE) {
			fputc('\n', file);
		}

		if (ret != 0) {
			return -1;
		}
	}

	return 0;
}

int
ipmi_cfgp_set(struct ipmi_cfgp_ctx *ctx, const struct ipmi_cfgp_sel *sel)
{
	return cfgp_do_action(ctx, CFGP_SET, sel, NULL, CFGP_RDONLY);
}

int
ipmi_cfgp_save(struct ipmi_cfgp_ctx *ctx,
		const struct ipmi_cfgp_sel *sel, FILE *file)
{
	if (file == NULL) {
		return -1;
	}

	return cfgp_do_action(ctx, CFGP_SAVE, sel, file, CFGP_RDONLY);
}

int
ipmi_cfgp_print(struct ipmi_cfgp_ctx *ctx,
		const struct ipmi_cfgp_sel *sel, FILE *file)
{
	if (file == NULL) {
		return -1;
	}

	return cfgp_do_action(ctx, CFGP_PRINT, sel, file, CFGP_RESERVED);
}