/
usb_moded-dyn-config.c
384 lines (329 loc) · 15 KB
/
usb_moded-dyn-config.c
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
/**
* @file usb_moded-dyn-config.c
*
* Copyright (c) 2011 Nokia Corporation. All rights reserved.
* Copyright (c) 2013 - 2021 Jolla Ltd.
* Copyright (c) 2020 Open Mobile Platform LLC.
*
* @author Philippe De Swert <philippe.de-swert@nokia.com>
* @author Philippe De Swert <philippedeswert@gmail.com>
* @author Philippe De Swert <philippe.deswert@jollamobile.com>
* @author Thomas Perl <thomas.perl@jolla.com>
* @author Slava Monich <slava.monich@jolla.com>
* @author Simo Piiroinen <simo.piiroinen@jollamobile.com>
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the Lesser GNU General Public License
* version 2 as published by the Free Software Foundation.
*
* This program 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 Lesser GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA
*/
#include "usb_moded-dyn-config.h"
#include "usb_moded-config-private.h"
#include "usb_moded-log.h"
#include <glob.h>
/* ========================================================================= *
* Prototypes
* ========================================================================= */
/* ------------------------------------------------------------------------- *
* MODEDATA
* ------------------------------------------------------------------------- */
static void modedata_free_cb (gpointer self);
void modedata_free (modedata_t *self);
modedata_t *modedata_copy (const modedata_t *that);
static void modedata_flush_settings(modedata_t *self);
void modedata_cache_settings(modedata_t *self);
static gint modedata_sort_cb (gconstpointer a, gconstpointer b);
static modedata_t *modedata_load (const gchar *filename);
/* ------------------------------------------------------------------------- *
* MODELIST
* ------------------------------------------------------------------------- */
void modelist_free(GList *modelist);
GList *modelist_load(bool diag);
/* ========================================================================= *
* MODEDATA
* ========================================================================= */
/** Type agnostice relase modedata_t object callback
*
* @param self Object pointer, or NULL
*/
static void
modedata_free_cb(gpointer self)
{
modedata_free(self);
}
/** Relase modedata_t object
*
* @param self Object pointer, or NULL
*/
void
modedata_free(modedata_t *self)
{
LOG_REGISTER_CONTEXT;
if( self ) {
g_free(self->mode_name);
g_free(self->mode_module);
g_free(self->network_interface);
g_free(self->sysfs_path);
g_free(self->sysfs_value);
g_free(self->sysfs_reset_value);
g_free(self->android_extra_sysfs_path);
g_free(self->android_extra_sysfs_value);
g_free(self->android_extra_sysfs_path2);
g_free(self->android_extra_sysfs_value2);
g_free(self->android_extra_sysfs_path3);
g_free(self->android_extra_sysfs_value3);
g_free(self->android_extra_sysfs_path4);
g_free(self->android_extra_sysfs_value4);
g_free(self->idProduct);
g_free(self->idVendorOverride);
#ifdef CONNMAN
g_free(self->connman_tethering);
#endif
modedata_flush_settings(self);
free(self);
}
}
/** Clone modedata_t object
*
* @param that Object pointer, or NULL
*
* @return Object pointer, or NULL
*/
modedata_t *
modedata_copy(const modedata_t *that)
{
modedata_t *self = 0;
if( !that )
goto EXIT;
if( !(self = calloc(1, sizeof *self)) )
goto EXIT;
self->mode_name = g_strdup(that->mode_name);
self->mode_module = g_strdup(that->mode_module);
self->appsync = that->appsync;
self->network = that->network;
self->mass_storage = that->mass_storage;
self->network_interface = g_strdup(that->network_interface);
self->sysfs_path = g_strdup(that->sysfs_path);
self->sysfs_value = g_strdup(that->sysfs_value);
self->sysfs_reset_value = g_strdup(that->sysfs_reset_value);
self->android_extra_sysfs_path = g_strdup(that->android_extra_sysfs_path);
self->android_extra_sysfs_value = g_strdup(that->android_extra_sysfs_value);
self->android_extra_sysfs_path2 = g_strdup(that->android_extra_sysfs_path2);
self->android_extra_sysfs_value2 = g_strdup(that->android_extra_sysfs_value2);
self->android_extra_sysfs_path3 = g_strdup(that->android_extra_sysfs_path3);
self->android_extra_sysfs_value3 = g_strdup(that->android_extra_sysfs_value3);
self->android_extra_sysfs_path4 = g_strdup(that->android_extra_sysfs_path4);
self->android_extra_sysfs_value4 = g_strdup(that->android_extra_sysfs_value4);
self->idProduct = g_strdup(that->idProduct);
self->idVendorOverride = g_strdup(that->idVendorOverride);
self->nat = that->nat;
self->dhcp_server = that->dhcp_server;
#ifdef CONNMAN
self->connman_tethering = g_strdup(that->connman_tethering);
#endif
self->cached_ip = g_strdup(that->cached_ip);
self->cached_interface = g_strdup(that->cached_interface);
self->cached_gateway = g_strdup(that->cached_gateway);
self->cached_nat_interface = g_strdup(that->cached_nat_interface);
self->cached_netmask = g_strdup(that->cached_netmask);
EXIT:
return self;
}
static void
modedata_flush_settings(modedata_t *self)
{
g_free(self->cached_ip),
self->cached_ip = NULL;
g_free(self->cached_interface),
self->cached_interface = NULL;
g_free(self->cached_gateway),
self->cached_gateway = NULL;
g_free(self->cached_nat_interface),
self->cached_nat_interface = NULL;
g_free(self->cached_netmask),
self->cached_netmask = NULL;
}
void
modedata_cache_settings(modedata_t *self)
{
modedata_flush_settings(self);
if( !(self->cached_ip = config_get_network_setting(NETWORK_IP_KEY)) )
self->cached_ip = config_get_network_fallback(NETWORK_IP_KEY);
if( !(self->cached_interface = config_get_network_setting(NETWORK_INTERFACE_KEY)) )
if( !(self->cached_interface = g_strdup(self->network_interface)) )
self->cached_interface = config_get_network_fallback(NETWORK_INTERFACE_KEY);
if( !(self->cached_gateway = config_get_network_setting(NETWORK_GATEWAY_KEY)) )
self->cached_gateway = config_get_network_fallback(NETWORK_GATEWAY_KEY);
if( !(self->cached_nat_interface = config_get_network_setting(NETWORK_NAT_INTERFACE_KEY)) )
self->cached_nat_interface = config_get_network_fallback(NETWORK_NAT_INTERFACE_KEY);
if( !(self->cached_netmask = config_get_network_setting(NETWORK_NETMASK_KEY)) )
self->cached_netmask = config_get_network_fallback(NETWORK_NETMASK_KEY);
log_debug("%s: %s = %s", self->mode_name, "cached_ip", self->cached_ip);
log_debug("%s: %s = %s", self->mode_name, "cached_interface", self->cached_interface);
log_debug("%s: %s = %s", self->mode_name, "cached_gateway", self->cached_gateway);
log_debug("%s: %s = %s", self->mode_name, "cached_nat_interface", self->cached_nat_interface);
log_debug("%s: %s = %s", self->mode_name, "cached_netmask", self->cached_netmask);
}
/** Callback for sorting mode list alphabetically
*
* For use with g_list_sort()
*
* @param a Object pointer
* @param b Object pointer
*
* @return result of comparing object names
*/
static gint
modedata_sort_cb(gconstpointer a, gconstpointer b)
{
LOG_REGISTER_CONTEXT;
modedata_t *aa = (modedata_t *)a;
modedata_t *bb = (modedata_t *)b;
return g_strcmp0(aa->mode_name, bb->mode_name);
}
/** Load mode data from file
*
* @param filename Path to file from which to read
*
* @return Mode data object, or NULL
*/
static modedata_t *
modedata_load(const gchar *filename)
{
LOG_REGISTER_CONTEXT;
modedata_t *self = NULL;
bool success = false;
GKeyFile *settingsfile = g_key_file_new();
if( !g_key_file_load_from_file(settingsfile, filename, G_KEY_FILE_NONE, NULL) ) {
log_err("%s: can't read mode configuration file", filename);
goto EXIT;
}
if( !(self = calloc(1, sizeof *self)) )
goto EXIT;
// [MODE_ENTRY = "mode"]
self->mode_name = g_key_file_get_string(settingsfile, MODE_ENTRY, MODE_NAME_KEY, NULL);
self->mode_module = g_key_file_get_string(settingsfile, MODE_ENTRY, MODE_MODULE_KEY, NULL);
log_debug("Dynamic mode name = %s\n", self->mode_name);
log_debug("Dynamic mode module = %s\n", self->mode_module);
self->appsync = g_key_file_get_integer(settingsfile, MODE_ENTRY, MODE_NEEDS_APPSYNC_KEY, NULL);
self->mass_storage = g_key_file_get_integer(settingsfile, MODE_ENTRY, MODE_MASS_STORAGE_KEY, NULL);
self->network = g_key_file_get_integer(settingsfile, MODE_ENTRY, MODE_NETWORK_KEY, NULL);
self->network_interface = g_key_file_get_string(settingsfile, MODE_ENTRY, MODE_NETWORK_INTERFACE_KEY, NULL);
// [MODE_OPTIONS_ENTRY = "options"]
self->sysfs_path = g_key_file_get_string(settingsfile, MODE_OPTIONS_ENTRY, MODE_SYSFS_PATH, NULL);
self->sysfs_value = g_key_file_get_string(settingsfile, MODE_OPTIONS_ENTRY, MODE_SYSFS_VALUE, NULL);
self->sysfs_reset_value = g_key_file_get_string(settingsfile, MODE_OPTIONS_ENTRY, MODE_SYSFS_RESET_VALUE, NULL);
self->android_extra_sysfs_path = g_key_file_get_string(settingsfile, MODE_OPTIONS_ENTRY, MODE_ANDROID_EXTRA_SYSFS_PATH, NULL);
self->android_extra_sysfs_path2 = g_key_file_get_string(settingsfile, MODE_OPTIONS_ENTRY, MODE_ANDROID_EXTRA_SYSFS_PATH2, NULL);
self->android_extra_sysfs_path3 = g_key_file_get_string(settingsfile, MODE_OPTIONS_ENTRY, MODE_ANDROID_EXTRA_SYSFS_PATH3, NULL);
self->android_extra_sysfs_path4 = g_key_file_get_string(settingsfile, MODE_OPTIONS_ENTRY, MODE_ANDROID_EXTRA_SYSFS_PATH4, NULL);
self->android_extra_sysfs_value = g_key_file_get_string(settingsfile, MODE_OPTIONS_ENTRY, MODE_ANDROID_EXTRA_SYSFS_VALUE, NULL);
self->android_extra_sysfs_value2 = g_key_file_get_string(settingsfile, MODE_OPTIONS_ENTRY, MODE_ANDROID_EXTRA_SYSFS_VALUE2, NULL);
self->android_extra_sysfs_value3 = g_key_file_get_string(settingsfile, MODE_OPTIONS_ENTRY, MODE_ANDROID_EXTRA_SYSFS_VALUE3, NULL);
self->android_extra_sysfs_value4 = g_key_file_get_string(settingsfile, MODE_OPTIONS_ENTRY, MODE_ANDROID_EXTRA_SYSFS_VALUE4, NULL);
self->idProduct = g_key_file_get_string(settingsfile, MODE_OPTIONS_ENTRY, MODE_IDPRODUCT, NULL);
self->idVendorOverride = g_key_file_get_string(settingsfile, MODE_OPTIONS_ENTRY, MODE_IDVENDOROVERRIDE, NULL);
self->nat = g_key_file_get_integer(settingsfile, MODE_OPTIONS_ENTRY, MODE_HAS_NAT, NULL);
self->dhcp_server = g_key_file_get_integer(settingsfile, MODE_OPTIONS_ENTRY, MODE_HAS_DHCP_SERVER, NULL);
#ifdef CONNMAN
self->connman_tethering = g_key_file_get_string(settingsfile, MODE_OPTIONS_ENTRY, MODE_CONNMAN_TETHERING, NULL);
#endif
//log_debug("Dynamic mode sysfs path = %s\n", self->sysfs_path);
//log_debug("Dynamic mode sysfs value = %s\n", self->sysfs_value);
//log_debug("Android extra mode sysfs path2 = %s\n", self->android_extra_sysfs_path2);
//log_debug("Android extra value2 = %s\n", self->android_extra_sysfs_value2);
if( self->mode_name == NULL || self->mode_module == NULL ) {
log_err("%s: mode_name or mode_module not defined", filename);
goto EXIT;
}
if( self->network && self->network_interface == NULL) {
/* Original behavior was such that mode configuration files that
* declare network=1 without also defining network_interface were
* rejected. This makes little sense as:
* - the interface value is very likely to get overridden by
* kernel command line / usb-moded settings
* - there is fallback strategy in case no explicit value is set
* - one could argue that all this requirement manages to do is
* that mode configuration files have a meaningless, confusing
* line present
*
* Ignoring the value altogether could cause problems with some
* existing configurations out in the wild. But at least we can
* relax future requirements and demote diagnostic logging to
* debug level.
*/
log_debug("%s: network_interface not defined", filename);
}
if( (self->sysfs_path && !self->sysfs_value) ||
(self->sysfs_reset_value && !self->sysfs_path) ) {
/* In theory all of this is optional.
*
* In most cases 'sysfs_value' holds a list of functions to enable,
* and 'sysfs_path' or 'sysfs_reset_value' values are simply ignored.
*
* However, for the benefit of existing special configuration files
* like the one for host mode:
* - having sysfs_path implies that sysfs_value should be set too
* - having sysfs_reset_value implies that sysfs_path should be set
*/
log_err("%s: sysfs_value not fully defined", filename);
goto EXIT;
}
log_debug("%s: successfully loaded", filename);
success = true;
EXIT:
g_key_file_free(settingsfile);
if( !success )
modedata_free(self), self = 0;
return self;
}
/* ========================================================================= *
* MODELIST
* ========================================================================= */
/** Release mode list
*
* @param modelist List pointer, or NULL
*/
void
modelist_free(GList *modelist)
{
LOG_REGISTER_CONTEXT;
g_list_free_full(modelist, modedata_free_cb);
}
/** Load mode data files from configuration directory
*
* @param diag true to load diagnostic modes, or
* false for normal modes
*
* @return List of mode data objects, or NULL
*/
GList *
modelist_load(bool diag)
{
LOG_REGISTER_CONTEXT;
GList *modelist = 0;
const char *dirpath = diag ? DIAG_DIR_PATH : MODE_DIR_PATH;
gchar *pattern = g_strdup_printf("%s/*.ini", dirpath);
glob_t gb = {};
if( glob(pattern, 0, 0, &gb) != 0 )
log_debug("no mode configuration ini-files found");
for( size_t i = 0; i < gb.gl_pathc; ++i ) {
const char *filepath = gb.gl_pathv[i];
log_debug("Read file %s\n", filepath);
modedata_t *list_item = modedata_load(filepath);
if(list_item)
modelist = g_list_append(modelist, list_item);
}
globfree(&gb);
g_free(pattern);
return g_list_sort(modelist, modedata_sort_cb);
}