1010System calls require a great deal of boilerplate code in order to implement
1111completely. This script is the first step in the build system's process of
1212auto-generating this code by doing a text scan of directories containing
13- header files, and building up a database of system calls and their
13+ C or header files, and building up a database of system calls and their
1414function call prototypes. This information is emitted to a generated
1515JSON file for further processing.
1616
17+ This script also scans for struct definitions such as __subsystem and
18+ __net_socket, emitting a JSON dictionary mapping tags to all the struct
19+ declarations found that were tagged with them.
20+
1721If the output JSON file already exists, its contents are checked against
1822what information this script would have outputted; if the result is that the
1923file would be unchanged, it is not modified to prevent unnecessary
2630import os
2731import json
2832
33+ regex_flags = re .MULTILINE | re .VERBOSE
34+
2935syscall_regex = re .compile (r'''
3036__syscall\s+ # __syscall attribute, must be first
3137([^(]+) # type and name of system call (split later)
3238[(] # Function opening parenthesis
3339([^)]*) # Arg list (split later)
3440[)] # Closing parenthesis
35- ''' , re . MULTILINE | re . VERBOSE )
41+ ''' , regex_flags )
3642
37- subsys_regex = re .compile (r'''
38- __subsystem\s+ # __subsystem attribute, must be first
43+ struct_tags = ["__subsystem" ]
44+
45+ tagged_struct_decl_template = r'''
46+ %s\s+ # tag, must be first
3947struct\s+ # struct keyword is next
4048([^{]+) # name of subsystem
4149[{] # Open curly bracket
42- ''' , re .MULTILINE | re .VERBOSE )
50+ '''
51+
52+ def tagged_struct_update (target_list , tag , contents ):
53+ regex = re .compile (tagged_struct_decl_template % tag , regex_flags )
54+ items = [mo .groups ()[0 ].strip () for mo in regex .finditer (contents )]
55+ target_list .extend (items )
56+
4357
4458def analyze_headers (multiple_directories ):
4559 syscall_ret = []
46- subsys_ret = []
60+ tagged_ret = {}
61+
62+ for tag in struct_tags :
63+ tagged_ret [tag ] = []
4764
4865 for base_path in multiple_directories :
4966 for root , dirs , files in os .walk (base_path , topdown = True ):
5067 dirs .sort ()
5168 files .sort ()
5269 for fn in files :
5370
54- # toolchain/common.h has the definitions of __syscall and __subsystem which we
71+ # toolchain/common.h has the definitions of these tagswhich we
5572 # don't want to trip over
5673 path = os .path .join (root , fn )
57- if not fn .endswith (".h" ) or path .endswith (os .path .join (os .sep , 'toolchain' , 'common.h' )):
74+ if (not (path .endswith (".h" ) or path .endswith (".c" )) or
75+ path .endswith (os .path .join (os .sep , 'toolchain' ,
76+ 'common.h' ))):
5877 continue
5978
6079 with open (path , "r" , encoding = "utf-8" ) as fp :
@@ -63,16 +82,15 @@ def analyze_headers(multiple_directories):
6382 try :
6483 syscall_result = [(mo .groups (), fn )
6584 for mo in syscall_regex .finditer (contents )]
66- subsys_result = [ mo . groups ()[ 0 ]. strip ()
67- for mo in subsys_regex . finditer ( contents )]
85+ for tag in struct_tags :
86+ tagged_struct_update ( tagged_ret [ tag ], tag , contents )
6887 except Exception :
6988 sys .stderr .write ("While parsing %s\n " % fn )
7089 raise
7190
7291 syscall_ret .extend (syscall_result )
73- subsys_ret .extend (subsys_result )
7492
75- return syscall_ret , subsys_ret
93+ return syscall_ret , tagged_ret
7694
7795
7896def update_file_if_changed (path , new ):
@@ -102,18 +120,19 @@ def parse_args():
102120 "-j" , "--json-file" , required = True ,
103121 help = "Write system call prototype information as json to file" )
104122 parser .add_argument (
105- "-s" , "--subsystem-file" , required = True ,
106- help = "Write subsystem name information as json to file" )
123+ "-t" , "--tag-struct-file" , required = True ,
124+ help = "Write tagged struct name information as json to file" )
125+
107126 args = parser .parse_args ()
108127
109128
110129def main ():
111130 parse_args ()
112131
113- syscalls , subsys = analyze_headers (args .include )
132+ syscalls , tagged = analyze_headers (args .include )
114133
115134 # Only write json files if they don't exist or have changes since
116- # they will force and incremental rebuild.
135+ # they will force an incremental rebuild.
117136
118137 syscalls_in_json = json .dumps (
119138 syscalls ,
@@ -122,12 +141,12 @@ def main():
122141 )
123142 update_file_if_changed (args .json_file , syscalls_in_json )
124143
125- subsys_in_json = json .dumps (
126- subsys ,
144+ tagged_struct_in_json = json .dumps (
145+ tagged ,
127146 indent = 4 ,
128147 sort_keys = True
129148 )
130- update_file_if_changed (args .subsystem_file , subsys_in_json )
149+ update_file_if_changed (args .tag_struct_file , tagged_struct_in_json )
131150
132151
133152if __name__ == "__main__" :
0 commit comments