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
|
// SPDX-License-Identifier: GPL-2.0-or-later
/*
Copyright (c) 2018 Martin Wilck, SUSE Linux GmbH
*/
#ifndef GENERIC_H_INCLUDED
#define GENERIC_H_INCLUDED
#include "vector.h"
/*
* fieldwidth_t is required in print.h and foreign.h.
* Defining it twice is not allowed before C11.
* So do it here.
*/
typedef unsigned char fieldwidth_t;
#define MAX_FIELD_WIDTH UCHAR_MAX
struct strbuf;
struct gen_multipath;
struct gen_pathgroup;
struct gen_path;
/**
* Methods implemented for gen_multipath "objects"
*/
struct gen_multipath_ops {
/**
* method: get_pathgroups(gmp)
* caller is responsible to returned data using rel_pathgroups()
* caller is also responsible to lock the gmp (directly or indirectly)
* while working with the return value.
* @param gmp: generic multipath object to act on
* @returns a vector of const struct gen_pathgroup*
*/
const struct vector_s* (*get_pathgroups)(const struct gen_multipath*);
/**
* method: rel_pathgroups(gmp, v)
* free data allocated by get_pathgroups(), if any
* @param gmp: generic multipath object to act on
* @param v the value returned by get_pathgroups()
*/
void (*rel_pathgroups)(const struct gen_multipath*,
const struct vector_s*);
/**
* method: snprint(gmp, buf, len, wildcard)
* prints the property of the multipath map matching
* the passed-in wildcard character into "buf",
* 0-terminated, no more than "len" characters including trailing '\0'.
*
* @param gmp: generic multipath object to act on
* @param buf: output struct strbuf
* @param wildcard: the multipath wildcard (see print.c)
* @returns the number of characters printed (without trailing '\0').
*/
int (*snprint)(const struct gen_multipath*,
struct strbuf *buf, char wildcard);
/**
* method: style(gmp, buf, len, verbosity)
* returns the format string to be used for the multipath object,
* defined with the wildcards as defined in print.c
* generic_style() should work well in most cases.
* @param gmp: generic multipath object to act on
* @param buf: output strbuf
* @param verbosity: verbosity level
* @returns number of format chars printed
*/
int (*style)(const struct gen_multipath*,
struct strbuf *buf, int verbosity);
};
/**
* Methods implemented for gen_pathgroup "objects"
*/
struct gen_pathgroup_ops {
/**
* method: get_paths(gpg)
* caller is responsible to returned data using rel_paths()
* @param gpg: generic pathgroup object to act on
* @returns a vector of const struct gen_path*
*/
const struct vector_s* (*get_paths)(const struct gen_pathgroup*);
/**
* method: rel_paths(gpg, v)
* free data allocated by get_paths(), if any
* @param gmp: generic pathgroup object to act on
* @param v the value returned by get_paths()
*/
void (*rel_paths)(const struct gen_pathgroup*, const struct vector_s*);
/**
* Method snprint()
* see gen_multipath_ops->snprint() above
*/
int (*snprint)(const struct gen_pathgroup*,
struct strbuf *buf, char wildcard);
};
struct gen_path_ops {
/**
* Method snprint()
* see gen_multipath_ops->snprint() above
*/
int (*snprint)(const struct gen_path*,
struct strbuf *buf, char wildcard);
};
struct gen_multipath {
const struct gen_multipath_ops *ops;
};
struct gen_pathgroup {
const struct gen_pathgroup_ops *ops;
};
struct gen_path {
const struct gen_path_ops *ops;
};
/**
* Helper functions for setting up the various generic_X_ops
*/
/**
* generic_style()
* A simple style() method (see above) that should fit most
* foreign libraries.
*/
int generic_style(const struct gen_multipath*,
struct strbuf *buf, int verbosity);
#endif /* GENERIC_H_INCLUDED */
|
