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
|
/*
This file is part of GNUnet.
Copyright (C) 2001 - 2013 GNUnet e.V.
GNUnet is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published
by the Free Software Foundation; either version 3, or (at your
option) any later version.
GNUnet 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
General Public License for more details.
You should have received a copy of the GNU General Public License
along with GNUnet; see the file COPYING. If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*/
/**
* @file cadet/cadet_path.h
* @brief Path handling functions
* @author Bartlomiej Polot
*/
#ifndef CADET_PATH_H_
#define CADET_PATH_H_
#ifdef __cplusplus
extern "C"
{
#if 0 /* keep Emacsens' auto-indent happy */
}
#endif
#endif
/******************************************************************************/
/************************ DATA STRUCTURES ****************************/
/******************************************************************************/
/**
* Information regarding a possible path to reach a single peer
*/
struct CadetPeerPath
{
/**
* Linked list
*/
struct CadetPeerPath *next;
struct CadetPeerPath *prev;
/**
* List of all the peers that form the path from origin to target.
*/
GNUNET_PEER_Id *peers;
/**
* Number of peers (hops) in the path
*/
unsigned int length;
/**
* User defined data store.
*/
struct CadetConnection *c;
/**
* Path's score, how reliable is the path.
*/
// int score;
/**
* Task to delete the path.
* We tried it, it didn't work, don't try again in a while.
*/
struct GNUNET_SCHEDULER_Task * path_delete;
};
/******************************************************************************/
/************************* FUNCTIONS *****************************/
/******************************************************************************/
/**
* Create a new path.
*
* @param length How many hops will the path have.
*
* @return A newly allocated path with a peer array of the specified length.
*/
struct CadetPeerPath *
path_new (unsigned int length);
/**
* Invert the path.
*
* @param path The path to invert.
*/
void
path_invert (struct CadetPeerPath *path);
/**
* Duplicate a path, incrementing short peer's rc.
*
* @param path The path to duplicate.
*/
struct CadetPeerPath *
path_duplicate (const struct CadetPeerPath *path);
/**
* Get the length of a path.
*
* @param path The path to measure, with the local peer at any point of it.
*
* @return Number of hops to reach destination.
* UINT_MAX in case the peer is not in the path.
*/
unsigned int
path_get_length (struct CadetPeerPath *path);
/**
* Mark path as invalid: keep it aroud for a while to avoid trying it in a loop.
*
* DHT_get sometimes returns bad cached results, for instance, on a locally
* cached result where the PUT followed a path that is no longer current.
*
* @param p Path to invalidate.
*/
void
path_invalidate (struct CadetPeerPath *p);
/**
* Test if two paths are equivalent (equal or revese of each other).
*
* @param p1 First path
* @param p2 Second path
*
* @return GNUNET_YES if both paths are equivalent
* GNUNET_NO otherwise
*/
int
path_equivalent (const struct CadetPeerPath *p1,
const struct CadetPeerPath *p2);
/**
* Test if a path is valid (or at least not known to be invalid).
*
* @param path Path to test.
*
* @return #GNUNET_YES If the path is valid or unknown,
* #GNUNET_NO If the path is known to be invalid.
*/
int
path_is_valid (const struct CadetPeerPath *path);
/**
* Destroy the path and free any allocated resources linked to it
*
* @param p the path to destroy
*
* @return GNUNET_OK on success
*/
int
path_destroy (struct CadetPeerPath *p);
/**
* Compare two paths.
*
* @param p1 First path.
* @param p2 Second path.
*
* @return > 0 if p1 is longer, or the first differing PEER_Id is higher on p1.
* < 0 if p2 is longer, or the first differing PEER_Id is higher on p2.
* 0 if they are identical.
*/
int
path_cmp (const struct CadetPeerPath *p1, const struct CadetPeerPath *p2);
/**
* Builds a path from a PeerIdentity array.
*
* @param peers PeerIdentity array.
* @param size Size of the @c peers array.
* @param myid ID of local peer, to find @c own_pos.
* @param own_pos Output parameter: own position in the path.
*
* @return Fixed and shortened path.
*/
struct CadetPeerPath *
path_build_from_peer_ids (struct GNUNET_PeerIdentity *peers,
unsigned int size,
GNUNET_PEER_Id myid,
unsigned int *own_pos);
/**
* Path -> allocated one line string. Caller must free.
*
* @param p Path.
*/
char *
path_2s (struct CadetPeerPath *p);
/**
* Print info about the path for debug.
*
* @param p Path to debug.
*/
void
path_debug (struct CadetPeerPath *p);
#if 0 /* keep Emacsens' auto-indent happy */
{
#endif
#ifdef __cplusplus
}
#endif
/* ifndef CADET_PATH_H */
#endif
|
