/
linux_modules.py
549 lines (474 loc) · 19.2 KB
/
linux_modules.py
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
543
544
545
546
547
548
549
from io import BytesIO
import elf
from elftools.elf.elffile import ELFFile
from gzip import GzipFile
import os
import os.path
from io import SEEK_CUR
from collections import defaultdict
import struct
from os.path import commonprefix
from os.path import basename
import sys
MODULE_DIR = os.path.join("lib", "modules")
# This function, and some of the functions it calls, are based on "depmod"
# from "module-init-tools" (apparently GPL 2)
def depmod(basedir, kver):
"""Only generates the following files (the real "depmod" generates other
files as well)
modules.dep
modules.dep.bin
modules.alias.bin
modules.symbols.bin
modules.devname
"""
verify_version(kver)
dirname = os.path.join(basedir, MODULE_DIR, kver)
if not os.access(dirname, os.W_OK):
msg = "WARNING: {}: No write access!".format(dirname)
print(msg, file=sys.stderr)
print("Scanning modules in", dirname, file=sys.stderr)
module_files = dict()
tree = os.walk(dirname, onerror=raiseerror, followlinks=True)
for (dirpath, dirnames, filenames) in tree:
#~ print("Scanning", dirpath, file=sys.stderr)
for f in filenames:
if not f.endswith((".ko", ".ko.gz")):
continue
fullpath = os.path.join(dirpath, f)
pathname = os.path.relpath(fullpath, dirname)
if f not in module_files:
module_files[f] = Module(open_elf(fullpath), pathname)
i = 0
while i < len(dirnames):
if dirnames[i] in ("source", "build"):
del dirnames[i]
else:
i = i + 1
print('Ordering modules by "modules.order"', file=sys.stderr)
module_paths = dict((mod.pathname, mod) for mod in module_files.values())
tlist = list()
file_name = os.path.join(dirname, "modules.order")
if os.path.exists(file_name):
with open(file_name, "r") as modorder:
for (linenum, line) in enumerate(modorder, 1):
try:
mod = module_paths.pop(line)
except LookupError:
continue
mod["order"] = linenum
tlist.append(mod)
tlist.extend(module_paths.values())
print("Reading symbols from modules", file=sys.stderr)
symbol_owners = defaultdict(list)
for (i, mod) in enumerate(tlist):
print("{}/{}".format(i, len(tlist)), end="\r", file=sys.stderr)
with mod.elf as file:
for sym in elf.iter_strings(file, b"__ksymtab_strings"):
symbol_owners[sym].append(mod)
strings = file.get_section_by_name(b".strtab")
syms = file.get_section_by_name(b".symtab")
if strings is not None and syms is not None:
tables = dict.fromkeys((
b"pci", b"usb", b"ccw", b"ieee1394", b"pnp", b"pnp_card",
b"input", b"serio", b"of",
))
for sym in syms.iter_symbols():
prefix = b"__mod_"
suffix = b"_device_table"
if (not sym.name.startswith(prefix) or
not sym.name.endswith(suffix)):
continue
name = sym.name[len(prefix):-len(suffix)]
if name not in tables or tables[name] is not None:
continue
sect = file.get_section(sym["st_shndx"])
if sect["sh_type"] == "SHT_NOBITS":
continue
tables[name] = sect["sh_offset"] + sym["st_value"]
print("{0}/{0}".format(len(tlist)), file=sys.stderr)
print("Reading dependencies of modules", file=sys.stderr)
for (i, mod) in enumerate(tlist):
print("{}/{}".format(i, len(tlist)), end="\r", file=sys.stderr)
with mod.elf as file:
strings = file.get_section_by_name(b".strtab")
syms = file.get_section_by_name(b".symtab")
if strings is None or syms is None:
msg = '{}: no ".strtab" nor ".symtab" sections'
print(msg.format(mod.pathname), file=sys.stderr)
continue
sparc = file["e_machine"] in {"EM_SPARC", "EM_SPARCV9"}
for sym in syms.iter_symbols():
if (sym["st_shndx"] != "SHN_UNDEF" or
sparc and sym["type"] == elf.STT_SPARC_REGISTER):
continue
if sym.name.startswith(b"."):
lookup = sym.name[1:]
else:
lookup = sym.name
try:
# Original "depmod" places later modules at front of hash
# table chain, so take latest module here
owner = symbol_owners[lookup][-1]
except LookupError:
continue
#~ msg = "{} needs {!r}: {}"
#~ msg = msg.format(mod.pathname, name, owner.pathname)
#~ print(msg, file=sys.stderr)
mod.deps.add(owner)
print("{0}/{0}".format(len(tlist)), file=sys.stderr)
deps_index = Index()
print('Generating "modules.dep"', file=sys.stderr)
with open(os.path.join(dirname, "modules.dep"), "w") as file:
for (i, mod) in enumerate(tlist):
dfs_steps = list()
ancestors = set()
visited = set()
postorder = list()
node = mod
while True:
dfs_steps.append(dict(
node=node, queue=iter(node.deps)))
ancestors.add(node)
while dfs_steps:
current = dfs_steps[-1]
try:
node = next(current["queue"])
except StopIteration:
node = current["node"]
ancestors.remove(node)
visited.add(node)
postorder.append(node)
dfs_steps.pop()
else:
if node in ancestors:
msg = ("{}: Ignoring cyclic dependency of {} "
"on {}")
msg = msg.format(mod.pathname,
current["node"].pathname, node.pathname)
print(msg, file=sys.stderr)
continue
if node in visited:
continue
break
if not dfs_steps:
break
line = mod.pathname + ":"
if mod.deps:
line += " " + " ".join(dep.pathname
for dep in reversed(postorder[:-1]))
file.write(line)
file.write("\n")
deps_index.add(modname(mod.pathname), line.encode("ASCII"),
mod.order)
print('Writing "modules.dep.bin"', file=sys.stderr)
deps_index.write(dirname, "modules.dep.bin")
print('Generating "modules.alias.bin"', file=sys.stderr)
alias_index = Index()
for (i, mod) in enumerate(tlist):
print("{}/{}".format(i, len(tlist)), end="\r", file=sys.stderr)
name = modname(mod.pathname)
with mod.elf as file:
for alias in elf.iter_strings(file, b".modalias"):
alias_index.add(underscores(alias), name, mod.order)
for p in elf.iter_strings(file, b".modinfo"):
prefix = b"alias="
if not p.startswith(prefix):
continue
alias = p[len(prefix):]
alias_index.add(underscores(alias), name, mod.order)
print("{0}/{0}".format(len(tlist)), file=sys.stderr)
alias_index.write(dirname, "modules.alias.bin")
print('Writing "modules.symbols.bin"', file=sys.stderr)
symbols_index = Index()
for (name, owners) in symbol_owners.items():
# Owners list should be ordered according to modules.order
for owner in owners:
symbols_index.add(b"symbol:" + name,
modname(owner.pathname), owner.order)
symbols_index.write(dirname, "modules.symbols.bin")
print('Writing "modules.devname"', file=sys.stderr)
with open(os.path.join(dirname, "modules.devname"), "wb") as outfile:
for (i, mod) in enumerate(tlist):
print("{}/{}".format(i, len(tlist)), end="\r", file=sys.stderr)
devname = None
devid = None
with mod.elf as modfile:
for info in elf.iter_strings(modfile, b".modinfo"):
if not info.startswith(b"alias="):
continue
if info.startswith(b"devname:", 6):
devname = info[6 + 8:]
for type in (b"char", b"block"):
prefix = type + b"-major-"
if not info.startswith(prefix, 6):
continue
majorminor = info[6 + len(prefix):]
try:
(major, minor) = majorminor.split(b"-", 1)
major = int(major)
minor = minor.decode("ascii", "replace")
(minor, _) = slice_int(minor)
except ValueError:
break
devid = "{:c}{}:{}".format(type[0], major, minor)
break
if devname is not None and devid is not None:
break
if devname is not None:
if devid is None:
msg = ("{}: Ignoring devname "
"without major and minor identifiers")
print(msg.format(mod.pathname), file=sys.stderr)
else:
outfile.write(modname(mod.pathname))
outfile.write(b" ")
outfile.write(devname)
outfile.write(b" ")
outfile.write(devid.encode("ascii"))
outfile.write(b"\n")
print("{0}/{0}".format(len(tlist)), file=sys.stderr)
# This is based on "modinfo" from "module-init-tools" (apparently GPL 2)
def modinfo(basedir, kernel, module):
if "." not in module and "/" not in module:
moddir = os.path.join(basedir, MODULE_DIR, kernel)
(file, raw) = gzopen(os.path.join(moddir, "modules.dep"))
with raw:
for line in file:
line = line.strip()
if line.startswith(b"#"):
continue
try:
(filename, deps) = line.split(b":", 1)
except ValueError:
continue
filename = os.fsdecode(filename)
candidate = basename(filename)
if candidate.find(".") != len(module):
continue
for (i, c) in enumerate(module):
if c == ":":
continue
cc = candidate[i]
if c == cc:
continue
if c in "_-" and cc in "_-":
continue
break
else:
break
else:
msg = "Could not find module {}".format(module)
raise LookupError(msg)
if os.path.isabs(filename):
module = os.path.join(basedir, filename[1:])
else:
module = os.path.join(moddir, filename)
ret = defaultdict(list, filename=module, params=list())
param_indexes = dict()
PARAM_TAGS = (b"parm", b"parmtype")
with open_elf(module) as modelf:
for info in elf.iter_strings(modelf, b".modinfo"):
for tag in PARAM_TAGS:
if not info.startswith(tag + b"="):
continue
param = info[len(tag) + 1:]
(param_name, param_info) = param.split(b":", 1)
try:
i = param_indexes[param_name]
except LookupError:
i = len(ret["params"])
param = dict.fromkeys(PARAM_TAGS)
param.update(name=param_name)
ret["params"].append(param)
ret["params"][i][tag] = param_info
break
else:
try:
(tag, eq) = info.split(b"=", 1)
except ValueError:
msg = '{}: Missing "=" separator in ".modinfo" tag'
print(msg.format(module), file=sys.stderr)
continue
ret[tag].append(eq)
return ret
# Part of GPL 2 "depmod" port
class Module:
def __init__(self, elf, pathname):
self.elf = elf
self.pathname = pathname
self.order = self.INDEX_PRIORITY_MIN
self.deps = set()
INDEX_PRIORITY_MIN = ~(~0 << 32)
# Part of GPL 2 "depmod" port
def verify_version(version):
(major, minor) = slice_int(version)
if major > 2:
return
if major < 2:
raise ValueError("Required at least Linux version 2")
if not minor.startswith("."):
raise ValueError('Linux version 2 missing ".minor" part')
(sub, minor) = slice_int(minor[1:])
if sub > 5:
return
if sub < 5:
raise ValueError("Required at least Linux version 2.5")
(minor, _) = slice_int(minor)
if minor < 48:
raise ValueError("Required at least Linux version 2.5.48")
# Part of GPL 2 "depmod" port
def modname(path):
name = basename(path)
try:
end = name.index(".")
except ValueError:
pass
else:
name = name[:end]
return name.encode("ASCII").replace(b"-", b"_")
# Part of GPL 2 "depmod" port
class Index(object):
NODE_PREFIX = 0x80000000
NODE_VALUES = 0x40000000
NODE_CHILDS = 0x20000000
def __init__(self):
self.index = defaultdict(list)
def add(self, key, value, priority):
"""Order added must correspond with priority (typically modules.order
file)"""
self.index[key].append(dict(value=value, priority=priority))
def write(self, dirname, filename):
with open(os.path.join(dirname, filename), "wb") as file:
file.write(struct.pack("!LHH", 0xB007F457, 2, 1))
if not self.index:
self.index = {b"": None}
keys = sorted(self.index.keys())
branches = [dict(
prefix=0,
end=len(keys),
fixup=file.tell(),
)]
file.seek(+4, SEEK_CUR)
i = 0
while branches:
branch = branches.pop()
first = keys[i]
last = keys[branch["end"] - 1]
node = self.index[first]
offset = file.tell()
prefix = commonprefix(
(first[branch["prefix"]:], last[branch["prefix"]:]))
prefix_len = branch["prefix"] + len(prefix)
if len(first) == prefix_len:
i += 1
else:
node = None
if prefix:
offset |= self.NODE_PREFIX
file.write(prefix)
file.write(b"\x00")
if i < branch["end"]:
offset |= self.NODE_CHILDS
first = keys[i][prefix_len:prefix_len + 1]
last = last[prefix_len:prefix_len + 1]
file.write(first)
file.write(last)
ch_end = ord(last) + 1
span = ch_end - ord(first)
file.write(span * struct.pack("!L", 0))
fixups = file.tell()
# Branches list is in reverse, so add to it in reverse
ki = branch["end"]
for ci in range(1, 1 + span):
ch = ch_end - ci
end = ki
while ki > i and keys[ki - 1][prefix_len] == ch:
ki -= 1
if ki >= end:
continue
branches.append(dict(
prefix=prefix_len + 1,
end=end,
fixup = fixups - 4 * ci,
))
if node:
offset |= self.NODE_VALUES
file.write(struct.pack("!L", len(node)))
for v in node:
file.write(struct.pack("!L", v["priority"]))
file.write(v["value"])
file.write(b"\x00")
pos = file.tell()
file.seek(branch["fixup"])
file.write(struct.pack("!L", offset))
file.seek(pos)
# Part of GPL 2 "depmod" port
def underscores(string):
res = bytearray()
i = 0
while i < len(string):
c = string[i:i + 1]
if c == b"[":
i = string.index(b"]", i) + 1
continue
if c == b"]":
msg = "{}: unexpected closing square bracket"
print(msg.format(string.decode()), file=sys.stderr)
if c == b"-":
c = b"_"
res.extend(c)
i += 1
return bytes(res)
# The remaining code is not part of the GPL 2 "depmod" port
def open_elf(path):
(payload, raw) = gzopen(path)
with raw:
if payload is raw: # Uncompressed file
return FilenameElf(path)
else:
return DataElf(payload.read())
class FilenameElf:
def __init__(self, filename):
self._filename = filename
def __enter__(self):
try:
self._f = open(self._filename, "rb")
return ELFFile(self._f)
except:
self._f.close()
raise
def __exit__(self, *exc):
self._f.close()
class DataElf:
def __init__(self, data):
self._file = BytesIO(data)
def __enter__(self):
return ELFFile(self._file)
def __exit__(self, *exc):
pass
def gzopen(path):
'''Open a file and decompress with "gzip" if appropriate
Returns (file, raw), where
"raw" must be closed, and
the data can be read from "file"'''
raw = open(path, "rb")
try:
header = raw.read(2)
raw.seek(0)
if header == bytearray((31, 139)):
return (GzipFile(fileobj=raw), raw)
else:
return (raw, raw)
except:
raw.close()
raise
def slice_int(s):
for (i, d) in enumerate(s):
if not d.isdigit():
break
else:
i = len(s)
return (int(s[:i]), s[i:])
def raiseerror(err):
raise err