drgn/scripts/generate_page_flag_getters.py
Omar Sandoval 87b7292aa5 Relicense drgn from GPLv3+ to LGPLv2.1+
drgn is currently licensed as GPLv3+. Part of the long term vision for
drgn is that other projects can use it as a library providing
programmatic interfaces for debugger functionality. A more permissive
license is better suited to this goal. We decided on LGPLv2.1+ as a good
balance between software freedom and permissiveness.

All contributors not employed by Meta were contacted via email and
consented to the license change. The only exception was the author of
commit c4fbf7e589 ("libdrgn: fix for compilation error"), who did not
respond. That commit reverted a single line of code to one originally
written by me in commit 640b1c011d ("libdrgn: embed DWARF index in
DWARF info cache").

Signed-off-by: Omar Sandoval <osandov@osandov.com>
2022-11-01 17:05:16 -07:00

50 lines
1.5 KiB
Python
Executable File

#!/usr/bin/env python3
# Copyright (c) Meta Platforms, Inc. and affiliates.
# SPDX-License-Identifier: LGPL-2.1-or-later
import argparse
import re
import sys
if __name__ == "__main__":
parser = argparse.ArgumentParser(
description="Generate PageFlag() helpers from include/linux/page-flags.h"
)
args = parser.parse_args()
flags = {
# PageUptodate() isn't defined with PAGEFLAG because it needs
# additional memory barriers, but other than that it's the same.
"Uptodate": "uptodate",
}
for match in re.finditer(
r"\b(?:|__|TEST)PAGEFLAG\s*\(\s*(\w+)(?<!uname)\s*,\s*(\w+)\s*,\s*\w+\s*\)",
sys.stdin.read(),
):
if flags.setdefault(match.group(1), match.group(2)) != match.group(2):
sys.exit(f"{match.group('uname')} has multiple lowercase names?")
print(" # Generated by scripts/generate_page_flag_getters.py.")
for uname, lname in sorted(flags.items()):
print(f' "Page{uname}",')
print(")")
print()
for uname, lname in sorted(flags.items()):
print(
f'''
def Page{uname}(page: Object) -> bool:
"""
Return whether the ``PG_{lname}`` flag is set on a page.
:param page: ``struct page *``
"""
try:
flag = page.prog_["PG_{lname}"]
except KeyError:
return False
return bool(page.flags & (1 << flag))
'''
)
print()
print("# End generated by scripts/generate_page_flag_getters.py.")