libvirt/src/util/virtypedparam.h
Erik Skultety 9afc115f73 util: Export remoteFreeTypedParameters internally via util
Since the method is static to remote_driver, it can't even be used by our
daemon. Other than that, it would be useful to be able to use it with admin as
well. This patch uses the new virTypedParameterRemote datatype introduced in
one of previous patches.
2016-02-03 15:46:45 +01:00

134 lines
4.8 KiB
C

/*
* virtypedparam.h: managing typed parameters
*
* Copyright (C) 2011-2012 Red Hat, Inc.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library. If not, see
* <http://www.gnu.org/licenses/>.
*
*/
#ifndef __VIR_TYPED_PARAM_H_
# define __VIR_TYPED_PARAM_H_
# include "internal.h"
# include "virutil.h"
/**
* VIR_TYPED_PARAM_MULTIPLE:
*
* Flag indicating that the params has multiple occurrences of the parameter.
* Only used as a flag for @type argument of the virTypedParamsValidate.
*/
# define VIR_TYPED_PARAM_MULTIPLE (1 << 31)
verify(!(VIR_TYPED_PARAM_LAST & VIR_TYPED_PARAM_MULTIPLE));
typedef struct _virTypedParameterRemoteValue virTypedParameterRemoteValue;
typedef struct virTypedParameterRemoteValue *virTypedParameterRemoteValuePtr;
struct _virTypedParameterRemoteValue {
int type;
union {
int i; /* exempt from syntax-check */
unsigned int ui;
long long int l;
unsigned long long int ul;
double d;
char b;
char *s;
} remote_typed_param_value;
};
typedef struct _virTypedParameterRemote *virTypedParameterRemotePtr;
struct _virTypedParameterRemote {
char *field;
virTypedParameterRemoteValue value;
};
int virTypedParamsValidate(virTypedParameterPtr params, int nparams,
/* const char *name, int type ... */ ...)
ATTRIBUTE_SENTINEL ATTRIBUTE_RETURN_CHECK;
bool virTypedParamsCheck(virTypedParameterPtr params,
int nparams,
const char **names,
int nnames);
int
virTypedParamsGetStringList(virTypedParameterPtr params,
int nparams,
const char *name,
const char ***values);
int
virTypedParamsFilter(virTypedParameterPtr params,
int nparams,
const char *name,
virTypedParameterPtr **ret)
ATTRIBUTE_RETURN_CHECK ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(3)
ATTRIBUTE_NONNULL(4);
int virTypedParameterAssign(virTypedParameterPtr param, const char *name,
int type, /* TYPE arg */ ...)
ATTRIBUTE_RETURN_CHECK;
int virTypedParameterAssignFromStr(virTypedParameterPtr param,
const char *name,
int type,
const char *val)
ATTRIBUTE_RETURN_CHECK;
int virTypedParamsReplaceString(virTypedParameterPtr *params,
int *nparams,
const char *name,
const char *value);
int virTypedParamsCopy(virTypedParameterPtr *dst,
virTypedParameterPtr src,
int nparams);
char *virTypedParameterToString(virTypedParameterPtr param);
void virTypedParamsRemoteFree(virTypedParameterRemotePtr remote_params_val,
unsigned int remote_params_len);
int virTypedParamsDeserialize(virTypedParameterRemotePtr remote_params,
unsigned int remote_params_len,
int limit,
virTypedParameterPtr *params,
int *nparams);
VIR_ENUM_DECL(virTypedParameter)
# define VIR_TYPED_PARAMS_DEBUG(params, nparams) \
do { \
int _i; \
if (!params) \
break; \
for (_i = 0; _i < (nparams); _i++) { \
char *_value = virTypedParameterToString((params) + _i); \
VIR_DEBUG("params[\"%s\"]=(%s)%s", \
(params)[_i].field, \
virTypedParameterTypeToString((params)[_i].type), \
NULLSTR(_value)); \
VIR_FREE(_value); \
} \
} while (0)
#endif /* __VIR_TYPED_PARAM_H */