blob: db417c84280d5145dbaf66e743dfb094fd14298f [file] [log] [blame]
Patrick Williamsc124f4f2015-09-15 14:41:29 -05001#
2# BitBake Process based server.
3#
4# Copyright (C) 2010 Bob Foerster <robert@erafx.com>
5#
Brad Bishopc342db32019-05-15 21:57:59 -04006# SPDX-License-Identifier: GPL-2.0-only
Patrick Williamsc124f4f2015-09-15 14:41:29 -05007#
Patrick Williamsc124f4f2015-09-15 14:41:29 -05008
9"""
10 This module implements a multiprocessing.Process based server for bitbake.
11"""
12
13import bb
14import bb.event
Patrick Williamsc124f4f2015-09-15 14:41:29 -050015import logging
16import multiprocessing
Brad Bishopd7bf8c12018-02-25 22:55:05 -050017import threading
18import array
Patrick Williamsc124f4f2015-09-15 14:41:29 -050019import os
Patrick Williamsc124f4f2015-09-15 14:41:29 -050020import sys
21import time
22import select
Brad Bishopd7bf8c12018-02-25 22:55:05 -050023import socket
24import subprocess
25import errno
26import re
27import datetime
Andrew Geisslerc9f78652020-09-18 14:11:35 -050028import pickle
Patrick Williams213cb262021-08-07 19:21:33 -050029import traceback
Patrick Williamsde0582f2022-04-08 10:23:27 -050030import gc
Andrew Geissler517393d2023-01-13 08:55:19 -060031import stat
Brad Bishopd7bf8c12018-02-25 22:55:05 -050032import bb.server.xmlrpcserver
33from bb import daemonize
34from multiprocessing import queues
Patrick Williamsc124f4f2015-09-15 14:41:29 -050035
36logger = logging.getLogger('BitBake')
37
Brad Bishopd7bf8c12018-02-25 22:55:05 -050038class ProcessTimeout(SystemExit):
39 pass
Patrick Williamsc124f4f2015-09-15 14:41:29 -050040
Andrew Geisslerc9f78652020-09-18 14:11:35 -050041def serverlog(msg):
42 print(str(os.getpid()) + " " + datetime.datetime.now().strftime('%H:%M:%S.%f') + " " + msg)
43 sys.stdout.flush()
44
Andrew Geissler517393d2023-01-13 08:55:19 -060045#
46# When we have lockfile issues, try and find infomation about which process is
47# using the lockfile
48#
49def get_lockfile_process_msg(lockfile):
50 # Some systems may not have lsof available
51 procs = None
52 try:
53 procs = subprocess.check_output(["lsof", '-w', lockfile], stderr=subprocess.STDOUT)
54 except subprocess.CalledProcessError:
55 # File was deleted?
56 pass
57 except OSError as e:
58 if e.errno != errno.ENOENT:
59 raise
60 if procs is None:
61 # Fall back to fuser if lsof is unavailable
62 try:
63 procs = subprocess.check_output(["fuser", '-v', lockfile], stderr=subprocess.STDOUT)
64 except subprocess.CalledProcessError:
65 # File was deleted?
66 pass
67 except OSError as e:
68 if e.errno != errno.ENOENT:
69 raise
70 if procs:
71 return procs.decode("utf-8")
72 return None
73
74class idleFinish():
75 def __init__(self, msg):
76 self.msg = msg
77
Andrew Geissler635e0e42020-08-21 15:58:33 -050078class ProcessServer():
Patrick Williamsc124f4f2015-09-15 14:41:29 -050079 profile_filename = "profile.log"
80 profile_processed_filename = "profile.log.processed"
81
Andrew Geisslerc9f78652020-09-18 14:11:35 -050082 def __init__(self, lock, lockname, sock, sockname, server_timeout, xmlrpcinterface):
Brad Bishopd7bf8c12018-02-25 22:55:05 -050083 self.command_channel = False
84 self.command_channel_reply = False
Patrick Williamsc124f4f2015-09-15 14:41:29 -050085 self.quit = False
Brad Bishop6e60e8b2018-02-01 10:27:11 -050086 self.heartbeat_seconds = 1 # default, BB_HEARTBEAT_EVENT will be checked once we have a datastore.
87 self.next_heartbeat = time.time()
Patrick Williamsc124f4f2015-09-15 14:41:29 -050088
Brad Bishopd7bf8c12018-02-25 22:55:05 -050089 self.event_handle = None
Andrew Geissler635e0e42020-08-21 15:58:33 -050090 self.hadanyui = False
Brad Bishopd7bf8c12018-02-25 22:55:05 -050091 self.haveui = False
Andrew Geisslerb7d28612020-07-24 16:15:54 -050092 self.maxuiwait = 30
Brad Bishopd7bf8c12018-02-25 22:55:05 -050093 self.xmlrpc = False
94
Andrew Geissler517393d2023-01-13 08:55:19 -060095 self.idle = None
96 # Need a lock for _idlefuns changes
Brad Bishopd7bf8c12018-02-25 22:55:05 -050097 self._idlefuns = {}
Andrew Geissler517393d2023-01-13 08:55:19 -060098 self._idlefuncsLock = threading.Lock()
99 self.idle_cond = threading.Condition(self._idlefuncsLock)
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500100
101 self.bitbake_lock = lock
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500102 self.bitbake_lock_name = lockname
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500103 self.sock = sock
104 self.sockname = sockname
Andrew Geissler517393d2023-01-13 08:55:19 -0600105 # It is possible the directory may be renamed. Cache the inode of the socket file
106 # so we can tell if things changed.
107 self.sockinode = os.stat(self.sockname)[stat.ST_INO]
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500108
Andrew Geissler635e0e42020-08-21 15:58:33 -0500109 self.server_timeout = server_timeout
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500110 self.timeout = self.server_timeout
Andrew Geissler635e0e42020-08-21 15:58:33 -0500111 self.xmlrpcinterface = xmlrpcinterface
112
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500113 def register_idle_function(self, function, data):
114 """Register a function to be called while the server is idle"""
115 assert hasattr(function, '__call__')
Andrew Geissler517393d2023-01-13 08:55:19 -0600116 with bb.utils.lock_timeout(self._idlefuncsLock):
117 self._idlefuns[function] = data
118 serverlog("Registering idle function %s" % str(function))
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500119
120 def run(self):
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500121
122 if self.xmlrpcinterface[0]:
123 self.xmlrpc = bb.server.xmlrpcserver.BitBakeXMLRPCServer(self.xmlrpcinterface, self.cooker, self)
124
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500125 serverlog("Bitbake XMLRPC server address: %s, server port: %s" % (self.xmlrpc.host, self.xmlrpc.port))
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500126
127 try:
128 self.bitbake_lock.seek(0)
129 self.bitbake_lock.truncate()
130 if self.xmlrpc:
131 self.bitbake_lock.write("%s %s:%s\n" % (os.getpid(), self.xmlrpc.host, self.xmlrpc.port))
132 else:
133 self.bitbake_lock.write("%s\n" % (os.getpid()))
134 self.bitbake_lock.flush()
135 except Exception as e:
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500136 serverlog("Error writing to lock file: %s" % str(e))
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500137 pass
138
139 if self.cooker.configuration.profile:
140 try:
141 import cProfile as profile
142 except:
143 import profile
144 prof = profile.Profile()
145
146 ret = profile.Profile.runcall(prof, self.main)
147
148 prof.dump_stats("profile.log")
149 bb.utils.process_profilelog("profile.log")
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500150 serverlog("Raw profiling information saved to profile.log and processed statistics to profile.log.processed")
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500151
152 else:
153 ret = self.main()
154
155 return ret
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500156
Andrew Geissler517393d2023-01-13 08:55:19 -0600157 def _idle_check(self):
158 return len(self._idlefuns) == 0 and self.cooker.command.currentAsyncCommand is None
159
160 def wait_for_idle(self, timeout=30):
161 # Wait for the idle loop to have cleared
162 with bb.utils.lock_timeout(self._idlefuncsLock):
163 return self.idle_cond.wait_for(self._idle_check, timeout) is not False
164
165 def set_async_cmd(self, cmd):
166 with bb.utils.lock_timeout(self._idlefuncsLock):
167 ret = self.idle_cond.wait_for(self._idle_check, 30)
168 if ret is False:
169 return False
170 self.cooker.command.currentAsyncCommand = cmd
171 return True
172
173 def clear_async_cmd(self):
174 with bb.utils.lock_timeout(self._idlefuncsLock):
175 self.cooker.command.currentAsyncCommand = None
176 self.idle_cond.notify_all()
177
178 def get_async_cmd(self):
179 with bb.utils.lock_timeout(self._idlefuncsLock):
180 return self.cooker.command.currentAsyncCommand
181
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500182 def main(self):
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500183 self.cooker.pre_serve()
184
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500185 bb.utils.set_process_name("Cooker")
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500186
187 ready = []
Brad Bishopf058f492019-01-28 23:50:33 -0500188 newconnections = []
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500189
190 self.controllersock = False
191 fds = [self.sock]
192 if self.xmlrpc:
193 fds.append(self.xmlrpc)
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500194 seendata = False
195 serverlog("Entering server connection loop")
Andrew Geissler517393d2023-01-13 08:55:19 -0600196 serverlog("Lockfile is: %s\nSocket is %s (%s)" % (self.bitbake_lock_name, self.sockname, os.path.exists(self.sockname)))
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500197
198 def disconnect_client(self, fds):
Andrew Geissler517393d2023-01-13 08:55:19 -0600199 serverlog("Disconnecting Client (socket: %s)" % os.path.exists(self.sockname))
Brad Bishopf058f492019-01-28 23:50:33 -0500200 if self.controllersock:
201 fds.remove(self.controllersock)
202 self.controllersock.close()
203 self.controllersock = False
204 if self.haveui:
Andrew Geissler517393d2023-01-13 08:55:19 -0600205 # Wait for the idle loop to have cleared (30s max)
206 if not self.wait_for_idle(30):
207 serverlog("Idle loop didn't finish queued commands after 30s, exiting.")
208 self.quit = True
Brad Bishopf058f492019-01-28 23:50:33 -0500209 fds.remove(self.command_channel)
210 bb.event.unregister_UIHhandler(self.event_handle, True)
211 self.command_channel_reply.writer.close()
212 self.event_writer.writer.close()
213 self.command_channel.close()
214 self.command_channel = False
215 del self.event_writer
216 self.lastui = time.time()
217 self.cooker.clientComplete()
218 self.haveui = False
219 ready = select.select(fds,[],[],0)[0]
Andrew Geissler517393d2023-01-13 08:55:19 -0600220 if newconnections and not self.quit:
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500221 serverlog("Starting new client")
Brad Bishopf058f492019-01-28 23:50:33 -0500222 conn = newconnections.pop(-1)
223 fds.append(conn)
224 self.controllersock = conn
Andrew Geissler5f350902021-07-23 13:09:54 -0400225 elif not self.timeout and not ready:
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500226 serverlog("No timeout, exiting.")
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500227 self.quit = True
228
Andrew Geisslerb7d28612020-07-24 16:15:54 -0500229 self.lastui = time.time()
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500230 while not self.quit:
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500231 if self.sock in ready:
Brad Bishopf058f492019-01-28 23:50:33 -0500232 while select.select([self.sock],[],[],0)[0]:
233 controllersock, address = self.sock.accept()
234 if self.controllersock:
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500235 serverlog("Queuing %s (%s)" % (str(ready), str(newconnections)))
Brad Bishopf058f492019-01-28 23:50:33 -0500236 newconnections.append(controllersock)
237 else:
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500238 serverlog("Accepting %s (%s)" % (str(ready), str(newconnections)))
Brad Bishopf058f492019-01-28 23:50:33 -0500239 self.controllersock = controllersock
240 fds.append(controllersock)
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500241 if self.controllersock in ready:
242 try:
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500243 serverlog("Processing Client")
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500244 ui_fds = recvfds(self.controllersock, 3)
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500245 serverlog("Connecting Client")
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500246
247 # Where to write events to
248 writer = ConnectionWriter(ui_fds[0])
249 self.event_handle = bb.event.register_UIHhandler(writer, True)
250 self.event_writer = writer
251
252 # Where to read commands from
253 reader = ConnectionReader(ui_fds[1])
254 fds.append(reader)
255 self.command_channel = reader
256
257 # Where to send command return values to
258 writer = ConnectionWriter(ui_fds[2])
259 self.command_channel_reply = writer
260
261 self.haveui = True
Andrew Geissler635e0e42020-08-21 15:58:33 -0500262 self.hadanyui = True
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500263
264 except (EOFError, OSError):
265 disconnect_client(self, fds)
266
Andrew Geisslerb7d28612020-07-24 16:15:54 -0500267 if not self.timeout == -1.0 and not self.haveui and self.timeout and \
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500268 (self.lastui + self.timeout) < time.time():
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500269 serverlog("Server timeout, exiting.")
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500270 self.quit = True
271
Andrew Geisslerb7d28612020-07-24 16:15:54 -0500272 # If we don't see a UI connection within maxuiwait, its unlikely we're going to see
273 # one. We have had issue with processes hanging indefinitely so timing out UI-less
274 # servers is useful.
Andrew Geissler635e0e42020-08-21 15:58:33 -0500275 if not self.hadanyui and not self.xmlrpc and not self.timeout and (self.lastui + self.maxuiwait) < time.time():
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500276 serverlog("No UI connection within max timeout, exiting to avoid infinite loop.")
Andrew Geisslerb7d28612020-07-24 16:15:54 -0500277 self.quit = True
278
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500279 if self.command_channel in ready:
280 try:
281 command = self.command_channel.get()
282 except EOFError:
283 # Client connection shutting down
284 ready = []
285 disconnect_client(self, fds)
286 continue
287 if command[0] == "terminateServer":
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500288 self.quit = True
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500289 continue
290 try:
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500291 serverlog("Running command %s" % command)
Andrew Geissler517393d2023-01-13 08:55:19 -0600292 self.command_channel_reply.send(self.cooker.command.runCommand(command, self))
293 serverlog("Command Completed (socket: %s)" % os.path.exists(self.sockname))
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500294 except Exception as e:
Patrick Williams213cb262021-08-07 19:21:33 -0500295 stack = traceback.format_exc()
296 serverlog('Exception in server main event loop running command %s (%s)' % (command, stack))
297 logger.exception('Exception in server main event loop running command %s (%s)' % (command, stack))
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500298
299 if self.xmlrpc in ready:
300 self.xmlrpc.handle_requests()
301
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500302 if not seendata and hasattr(self.cooker, "data"):
303 heartbeat_event = self.cooker.data.getVar('BB_HEARTBEAT_EVENT')
304 if heartbeat_event:
305 try:
306 self.heartbeat_seconds = float(heartbeat_event)
307 except:
308 bb.warn('Ignoring invalid BB_HEARTBEAT_EVENT=%s, must be a float specifying seconds.' % heartbeat_event)
309
310 self.timeout = self.server_timeout or self.cooker.data.getVar('BB_SERVER_TIMEOUT')
311 try:
312 if self.timeout:
313 self.timeout = float(self.timeout)
314 except:
315 bb.warn('Ignoring invalid BB_SERVER_TIMEOUT=%s, must be a float specifying seconds.' % self.timeout)
316 seendata = True
317
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500318 ready = self.idle_commands(.1, fds)
319
Andrew Geissler517393d2023-01-13 08:55:19 -0600320 if self.idle:
321 self.idle.join()
322
323 serverlog("Exiting (socket: %s)" % os.path.exists(self.sockname))
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500324 # Remove the socket file so we don't get any more connections to avoid races
Andrew Geissler517393d2023-01-13 08:55:19 -0600325 # The build directory could have been renamed so if the file isn't the one we created
326 # we shouldn't delete it.
Andrew Geisslerb7d28612020-07-24 16:15:54 -0500327 try:
Andrew Geissler517393d2023-01-13 08:55:19 -0600328 sockinode = os.stat(self.sockname)[stat.ST_INO]
329 if sockinode == self.sockinode:
330 os.unlink(self.sockname)
331 else:
332 serverlog("bitbake.sock inode mismatch (%s vs %s), not deleting." % (sockinode, self.sockinode))
333 except Exception as err:
334 serverlog("Removing socket file '%s' failed (%s)" % (self.sockname, err))
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500335 self.sock.close()
336
Andrew Geisslerb7d28612020-07-24 16:15:54 -0500337 try:
Andrew Geissler517393d2023-01-13 08:55:19 -0600338 self.cooker.shutdown(True, idle=False)
Brad Bishop316dfdd2018-06-25 12:45:53 -0400339 self.cooker.notifier.stop()
340 self.cooker.confignotifier.stop()
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500341 except:
342 pass
343
344 self.cooker.post_serve()
345
Andrew Geissler9aee5002022-03-30 16:27:02 +0000346 if len(threading.enumerate()) != 1:
347 serverlog("More than one thread left?: " + str(threading.enumerate()))
348
Andrew Geissler635e0e42020-08-21 15:58:33 -0500349 # Flush logs before we release the lock
350 sys.stdout.flush()
351 sys.stderr.flush()
352
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500353 # Finally release the lockfile but warn about other processes holding it open
354 lock = self.bitbake_lock
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500355 lockfile = self.bitbake_lock_name
356
357 def get_lock_contents(lockfile):
358 try:
359 with open(lockfile, "r") as f:
360 return f.readlines()
361 except FileNotFoundError:
362 return None
363
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500364 lock.close()
365 lock = None
366
367 while not lock:
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500368 i = 0
369 lock = None
Andrew Geisslerc5535c92023-01-27 16:10:19 -0600370 if not os.path.exists(os.path.basename(lockfile)):
371 serverlog("Lockfile directory gone, exiting.")
372 return
373
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500374 while not lock and i < 30:
375 lock = bb.utils.lockfile(lockfile, shared=False, retry=False, block=False)
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500376 if not lock:
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500377 newlockcontents = get_lock_contents(lockfile)
Andrew Geisslerc5535c92023-01-27 16:10:19 -0600378 if not newlockcontents[0].startswith([os.getpid() + "\n", os.getpid() + " "]):
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500379 # A new server was started, the lockfile contents changed, we can exit
380 serverlog("Lockfile now contains different contents, exiting: " + str(newlockcontents))
381 return
382 time.sleep(0.1)
383 i += 1
384 if lock:
385 # We hold the lock so we can remove the file (hide stale pid data)
386 # via unlockfile.
387 bb.utils.unlockfile(lock)
388 serverlog("Exiting as we could obtain the lock")
389 return
390
391 if not lock:
Andrew Geissler517393d2023-01-13 08:55:19 -0600392 procs = get_lockfile_process_msg(lockfile)
Andrew Geissler595f6302022-01-24 19:11:47 +0000393 msg = ["Delaying shutdown due to active processes which appear to be holding bitbake.lock"]
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500394 if procs:
Andrew Geissler517393d2023-01-13 08:55:19 -0600395 msg.append(":\n%s" % procs)
Andrew Geissler595f6302022-01-24 19:11:47 +0000396 serverlog("".join(msg))
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500397
Andrew Geissler517393d2023-01-13 08:55:19 -0600398 def idle_thread(self):
399 def remove_idle_func(function):
400 with bb.utils.lock_timeout(self._idlefuncsLock):
401 del self._idlefuns[function]
402 self.idle_cond.notify_all()
403
404 while not self.quit:
405 nextsleep = 0.1
406 fds = []
407
Andrew Geissler6aa7eec2023-03-03 12:41:14 -0600408 try:
409 self.cooker.process_inotify_updates()
410 except Exception as exc:
411 serverlog("Exception %s in inofify updates broke the idle_thread, exiting" % traceback.format_exc())
412 self.quit = True
Andrew Geissler517393d2023-01-13 08:55:19 -0600413
414 with bb.utils.lock_timeout(self._idlefuncsLock):
415 items = list(self._idlefuns.items())
416
417 for function, data in items:
418 try:
419 retval = function(self, data, False)
420 if isinstance(retval, idleFinish):
421 serverlog("Removing idle function %s at idleFinish" % str(function))
422 remove_idle_func(function)
423 self.cooker.command.finishAsyncCommand(retval.msg)
424 nextsleep = None
425 elif retval is False:
426 serverlog("Removing idle function %s" % str(function))
427 remove_idle_func(function)
428 nextsleep = None
429 elif retval is True:
430 nextsleep = None
431 elif isinstance(retval, float) and nextsleep:
432 if (retval < nextsleep):
433 nextsleep = retval
434 elif nextsleep is None:
435 continue
436 else:
437 fds = fds + retval
438 except SystemExit:
439 raise
440 except Exception as exc:
441 if not isinstance(exc, bb.BBHandledException):
442 logger.exception('Running idle function')
443 remove_idle_func(function)
444 serverlog("Exception %s broke the idle_thread, exiting" % traceback.format_exc())
445 self.quit = True
446
447 # Create new heartbeat event?
448 now = time.time()
449 if bb.event._heartbeat_enabled and now >= self.next_heartbeat:
450 # We might have missed heartbeats. Just trigger once in
451 # that case and continue after the usual delay.
452 self.next_heartbeat += self.heartbeat_seconds
453 if self.next_heartbeat <= now:
454 self.next_heartbeat = now + self.heartbeat_seconds
455 if hasattr(self.cooker, "data"):
456 heartbeat = bb.event.HeartbeatEvent(now)
457 try:
458 bb.event.fire(heartbeat, self.cooker.data)
459 except Exception as exc:
460 if not isinstance(exc, bb.BBHandledException):
461 logger.exception('Running heartbeat function')
462 serverlog("Exception %s broke in idle_thread, exiting" % traceback.format_exc())
463 self.quit = True
464 if nextsleep and bb.event._heartbeat_enabled and now + nextsleep > self.next_heartbeat:
465 # Shorten timeout so that we we wake up in time for
466 # the heartbeat.
467 nextsleep = self.next_heartbeat - now
468
469 if nextsleep is not None:
470 select.select(fds,[],[],nextsleep)[0]
471
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500472 def idle_commands(self, delay, fds=None):
473 nextsleep = delay
474 if not fds:
475 fds = []
476
Andrew Geissler517393d2023-01-13 08:55:19 -0600477 if not self.idle:
478 self.idle = threading.Thread(target=self.idle_thread)
479 self.idle.start()
Andrew Geissler6aa7eec2023-03-03 12:41:14 -0600480 elif self.idle and not self.idle.is_alive():
481 serverlog("Idle thread terminated, main thread exiting too")
482 bb.error("Idle thread terminated, main thread exiting too")
483 self.quit = True
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500484
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500485 if nextsleep is not None:
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500486 if self.xmlrpc:
487 nextsleep = self.xmlrpc.get_timeout(nextsleep)
488 try:
489 return select.select(fds,[],[],nextsleep)[0]
490 except InterruptedError:
491 # Ignore EINTR
492 return []
493 else:
494 return select.select(fds,[],[],0)[0]
495
496
497class ServerCommunicator():
498 def __init__(self, connection, recv):
499 self.connection = connection
500 self.recv = recv
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500501
502 def runCommand(self, command):
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500503 self.connection.send(command)
504 if not self.recv.poll(30):
Andrew Geisslerb7d28612020-07-24 16:15:54 -0500505 logger.info("No reply from server in 30s")
Andrew Geissler475cb722020-07-10 16:00:51 -0500506 if not self.recv.poll(30):
507 raise ProcessTimeout("Timeout while waiting for a reply from the bitbake server (60s)")
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500508 ret, exc = self.recv.get()
509 # Should probably turn all exceptions in exc back into exceptions?
510 # For now, at least handle BBHandledException
511 if exc and ("BBHandledException" in exc or "SystemExit" in exc):
512 raise bb.BBHandledException()
513 return ret, exc
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500514
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500515 def updateFeatureSet(self, featureset):
516 _, error = self.runCommand(["setFeatures", featureset])
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500517 if error:
518 logger.error("Unable to set the cooker to the correct featureset: %s" % error)
519 raise BaseException(error)
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500520
521 def getEventHandle(self):
522 handle, error = self.runCommand(["getUIHandlerNum"])
523 if error:
524 logger.error("Unable to get UI Handler Number: %s" % error)
525 raise BaseException(error)
526
527 return handle
528
529 def terminateServer(self):
530 self.connection.send(['terminateServer'])
531 return
532
533class BitBakeProcessServerConnection(object):
534 def __init__(self, ui_channel, recv, eq, sock):
535 self.connection = ServerCommunicator(ui_channel, recv)
536 self.events = eq
537 # Save sock so it doesn't get gc'd for the life of our connection
538 self.socket_connection = sock
539
540 def terminate(self):
Andrew Geissler78b72792022-06-14 06:47:25 -0500541 self.events.close()
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500542 self.socket_connection.close()
543 self.connection.connection.close()
544 self.connection.recv.close()
545 return
546
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500547start_log_format = '--- Starting bitbake server pid %s at %s ---'
548start_log_datetime_format = '%Y-%m-%d %H:%M:%S.%f'
549
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500550class BitBakeServer(object):
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500551
Andrew Geissler517393d2023-01-13 08:55:19 -0600552 def __init__(self, lock, sockname, featureset, server_timeout, xmlrpcinterface, profile):
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500553
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500554 self.server_timeout = server_timeout
555 self.xmlrpcinterface = xmlrpcinterface
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500556 self.featureset = featureset
557 self.sockname = sockname
558 self.bitbake_lock = lock
Andrew Geissler517393d2023-01-13 08:55:19 -0600559 self.profile = profile
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500560 self.readypipe, self.readypipein = os.pipe()
561
Brad Bishop1a4b7ee2018-12-16 17:11:34 -0800562 # Place the log in the builddirectory alongside the lock file
563 logfile = os.path.join(os.path.dirname(self.bitbake_lock.name), "bitbake-cookerdaemon.log")
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500564 self.logfile = logfile
Brad Bishop1a4b7ee2018-12-16 17:11:34 -0800565
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500566 startdatetime = datetime.datetime.now()
567 bb.daemonize.createDaemon(self._startServer, logfile)
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500568 self.bitbake_lock.close()
Brad Bishop1a4b7ee2018-12-16 17:11:34 -0800569 os.close(self.readypipein)
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500570
571 ready = ConnectionReader(self.readypipe)
Brad Bishopf058f492019-01-28 23:50:33 -0500572 r = ready.poll(5)
573 if not r:
574 bb.note("Bitbake server didn't start within 5 seconds, waiting for 90")
575 r = ready.poll(90)
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500576 if r:
Brad Bishop1a4b7ee2018-12-16 17:11:34 -0800577 try:
578 r = ready.get()
579 except EOFError:
Andrew Geisslerd159c7f2021-09-02 21:05:58 -0500580 # Trap the child exiting/closing the pipe and error out
Brad Bishop1a4b7ee2018-12-16 17:11:34 -0800581 r = None
Brad Bishopf058f492019-01-28 23:50:33 -0500582 if not r or r[0] != "r":
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500583 ready.close()
Brad Bishopf058f492019-01-28 23:50:33 -0500584 bb.error("Unable to start bitbake server (%s)" % str(r))
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500585 if os.path.exists(logfile):
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500586 logstart_re = re.compile(start_log_format % ('([0-9]+)', '([0-9-]+ [0-9:.]+)'))
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500587 started = False
588 lines = []
Brad Bishopa5c52ff2018-11-23 10:55:50 +1300589 lastlines = []
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500590 with open(logfile, "r") as f:
591 for line in f:
592 if started:
593 lines.append(line)
594 else:
Brad Bishopa5c52ff2018-11-23 10:55:50 +1300595 lastlines.append(line)
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500596 res = logstart_re.search(line.rstrip())
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500597 if res:
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500598 ldatetime = datetime.datetime.strptime(res.group(2), start_log_datetime_format)
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500599 if ldatetime >= startdatetime:
600 started = True
601 lines.append(line)
Brad Bishopa5c52ff2018-11-23 10:55:50 +1300602 if len(lastlines) > 60:
603 lastlines = lastlines[-60:]
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500604 if lines:
Brad Bishopa5c52ff2018-11-23 10:55:50 +1300605 if len(lines) > 60:
606 bb.error("Last 60 lines of server log for this session (%s):\n%s" % (logfile, "".join(lines[-60:])))
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500607 else:
608 bb.error("Server log for this session (%s):\n%s" % (logfile, "".join(lines)))
Brad Bishopa5c52ff2018-11-23 10:55:50 +1300609 elif lastlines:
610 bb.error("Server didn't start, last 60 loglines (%s):\n%s" % (logfile, "".join(lastlines)))
611 else:
612 bb.error("%s doesn't exist" % logfile)
613
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500614 raise SystemExit(1)
Brad Bishopa5c52ff2018-11-23 10:55:50 +1300615
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500616 ready.close()
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500617
618 def _startServer(self):
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500619 os.close(self.readypipe)
620 os.set_inheritable(self.bitbake_lock.fileno(), True)
621 os.set_inheritable(self.readypipein, True)
622 serverscript = os.path.realpath(os.path.dirname(__file__) + "/../../../bin/bitbake-server")
Andrew Geissler517393d2023-01-13 08:55:19 -0600623 os.execl(sys.executable, "bitbake-server", serverscript, "decafbad", str(self.bitbake_lock.fileno()), str(self.readypipein), self.logfile, self.bitbake_lock.name, self.sockname, str(self.server_timeout or 0), str(int(self.profile)), str(self.xmlrpcinterface[0]), str(self.xmlrpcinterface[1]))
Brad Bishope2d5b612018-11-23 10:55:50 +1300624
Andrew Geissler517393d2023-01-13 08:55:19 -0600625def execServer(lockfd, readypipeinfd, lockname, sockname, server_timeout, xmlrpcinterface, profile):
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500626
627 import bb.cookerdata
628 import bb.cooker
629
630 serverlog(start_log_format % (os.getpid(), datetime.datetime.now().strftime(start_log_datetime_format)))
631
632 try:
633 bitbake_lock = os.fdopen(lockfd, "w")
634
635 # Create server control socket
636 if os.path.exists(sockname):
Andrew Geissler517393d2023-01-13 08:55:19 -0600637 serverlog("WARNING: removing existing socket file '%s'" % sockname)
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500638 os.unlink(sockname)
639
640 sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
641 # AF_UNIX has path length issues so chdir here to workaround
642 cwd = os.getcwd()
Brad Bishop08902b02019-08-20 09:16:51 -0400643 try:
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500644 os.chdir(os.path.dirname(sockname))
645 sock.bind(os.path.basename(sockname))
Andrew Geissler635e0e42020-08-21 15:58:33 -0500646 finally:
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500647 os.chdir(cwd)
648 sock.listen(1)
649
650 server = ProcessServer(bitbake_lock, lockname, sock, sockname, server_timeout, xmlrpcinterface)
651 writer = ConnectionWriter(readypipeinfd)
652 try:
653 featureset = []
Andrew Geissler517393d2023-01-13 08:55:19 -0600654 cooker = bb.cooker.BBCooker(featureset, server)
655 cooker.configuration.profile = profile
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500656 except bb.BBHandledException:
657 return None
658 writer.send("r")
659 writer.close()
660 server.cooker = cooker
661 serverlog("Started bitbake server pid %d" % os.getpid())
662
663 server.run()
664 finally:
Andrew Geissler9aee5002022-03-30 16:27:02 +0000665 # Flush any messages/errors to the logfile before exit
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500666 sys.stdout.flush()
667 sys.stderr.flush()
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500668
669def connectProcessServer(sockname, featureset):
670 # Connect to socket
671 sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
672 # AF_UNIX has path length issues so chdir here to workaround
673 cwd = os.getcwd()
674
Brad Bishopf058f492019-01-28 23:50:33 -0500675 readfd = writefd = readfd1 = writefd1 = readfd2 = writefd2 = None
676 eq = command_chan_recv = command_chan = None
677
678 sock.settimeout(10)
679
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500680 try:
Brad Bishope2d5b612018-11-23 10:55:50 +1300681 try:
682 os.chdir(os.path.dirname(sockname))
Brad Bishopf058f492019-01-28 23:50:33 -0500683 finished = False
684 while not finished:
685 try:
686 sock.connect(os.path.basename(sockname))
687 finished = True
688 except IOError as e:
689 if e.errno == errno.EWOULDBLOCK:
690 pass
Richard Purdie3da11142019-02-05 21:34:37 +0000691 raise
Brad Bishope2d5b612018-11-23 10:55:50 +1300692 finally:
693 os.chdir(cwd)
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500694
695 # Send an fd for the remote to write events to
696 readfd, writefd = os.pipe()
697 eq = BBUIEventQueue(readfd)
698 # Send an fd for the remote to recieve commands from
699 readfd1, writefd1 = os.pipe()
700 command_chan = ConnectionWriter(writefd1)
701 # Send an fd for the remote to write commands results to
702 readfd2, writefd2 = os.pipe()
703 command_chan_recv = ConnectionReader(readfd2)
704
705 sendfds(sock, [writefd, readfd1, writefd2])
706
707 server_connection = BitBakeProcessServerConnection(command_chan, command_chan_recv, eq, sock)
708
709 # Close the ends of the pipes we won't use
710 for i in [writefd, readfd1, writefd2]:
711 os.close(i)
712
713 server_connection.connection.updateFeatureSet(featureset)
714
715 except (Exception, SystemExit) as e:
716 if command_chan_recv:
717 command_chan_recv.close()
718 if command_chan:
719 command_chan.close()
720 for i in [writefd, readfd1, writefd2]:
721 try:
Brad Bishope2d5b612018-11-23 10:55:50 +1300722 if i:
723 os.close(i)
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500724 except OSError:
725 pass
726 sock.close()
727 raise
728
729 return server_connection
730
731def sendfds(sock, fds):
732 '''Send an array of fds over an AF_UNIX socket.'''
733 fds = array.array('i', fds)
734 msg = bytes([len(fds) % 256])
735 sock.sendmsg([msg], [(socket.SOL_SOCKET, socket.SCM_RIGHTS, fds)])
736
737def recvfds(sock, size):
738 '''Receive an array of fds over an AF_UNIX socket.'''
739 a = array.array('i')
740 bytes_size = a.itemsize * size
741 msg, ancdata, flags, addr = sock.recvmsg(1, socket.CMSG_LEN(bytes_size))
742 if not msg and not ancdata:
743 raise EOFError
744 try:
745 if len(ancdata) != 1:
746 raise RuntimeError('received %d items of ancdata' %
747 len(ancdata))
748 cmsg_level, cmsg_type, cmsg_data = ancdata[0]
749 if (cmsg_level == socket.SOL_SOCKET and
750 cmsg_type == socket.SCM_RIGHTS):
751 if len(cmsg_data) % a.itemsize != 0:
752 raise ValueError
753 a.frombytes(cmsg_data)
754 assert len(a) % 256 == msg[0]
755 return list(a)
756 except (ValueError, IndexError):
757 pass
758 raise RuntimeError('Invalid data received')
759
760class BBUIEventQueue:
761 def __init__(self, readfd):
762
763 self.eventQueue = []
764 self.eventQueueLock = threading.Lock()
765 self.eventQueueNotify = threading.Event()
766
767 self.reader = ConnectionReader(readfd)
768
769 self.t = threading.Thread()
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500770 self.t.run = self.startCallbackHandler
771 self.t.start()
772
773 def getEvent(self):
Andrew Geissler517393d2023-01-13 08:55:19 -0600774 with bb.utils.lock_timeout(self.eventQueueLock):
Andrew Geissler78b72792022-06-14 06:47:25 -0500775 if len(self.eventQueue) == 0:
776 return None
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500777
Andrew Geissler78b72792022-06-14 06:47:25 -0500778 item = self.eventQueue.pop(0)
779 if len(self.eventQueue) == 0:
780 self.eventQueueNotify.clear()
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500781
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500782 return item
783
784 def waitEvent(self, delay):
785 self.eventQueueNotify.wait(delay)
786 return self.getEvent()
787
788 def queue_event(self, event):
Andrew Geissler517393d2023-01-13 08:55:19 -0600789 with bb.utils.lock_timeout(self.eventQueueLock):
Andrew Geissler78b72792022-06-14 06:47:25 -0500790 self.eventQueue.append(event)
791 self.eventQueueNotify.set()
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500792
793 def send_event(self, event):
794 self.queue_event(pickle.loads(event))
795
796 def startCallbackHandler(self):
797 bb.utils.set_process_name("UIEventQueue")
798 while True:
799 try:
Andrew Geissler78b72792022-06-14 06:47:25 -0500800 ready = self.reader.wait(0.25)
801 if ready:
802 event = self.reader.get()
803 self.queue_event(event)
804 except (EOFError, OSError, TypeError):
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500805 # Easiest way to exit is to close the file descriptor to cause an exit
806 break
Andrew Geissler78b72792022-06-14 06:47:25 -0500807
808 def close(self):
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500809 self.reader.close()
Andrew Geissler78b72792022-06-14 06:47:25 -0500810 self.t.join()
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500811
812class ConnectionReader(object):
813
814 def __init__(self, fd):
815 self.reader = multiprocessing.connection.Connection(fd, writable=False)
816 self.rlock = multiprocessing.Lock()
817
818 def wait(self, timeout=None):
819 return multiprocessing.connection.wait([self.reader], timeout)
820
821 def poll(self, timeout=None):
822 return self.reader.poll(timeout)
823
824 def get(self):
Andrew Geissler517393d2023-01-13 08:55:19 -0600825 with bb.utils.lock_timeout(self.rlock):
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500826 res = self.reader.recv_bytes()
827 return multiprocessing.reduction.ForkingPickler.loads(res)
828
829 def fileno(self):
830 return self.reader.fileno()
831
832 def close(self):
833 return self.reader.close()
834
835
836class ConnectionWriter(object):
837
838 def __init__(self, fd):
839 self.writer = multiprocessing.connection.Connection(fd, readable=False)
840 self.wlock = multiprocessing.Lock()
841 # Why bb.event needs this I have no idea
842 self.event = self
843
Andrew Geissler9aee5002022-03-30 16:27:02 +0000844 def _send(self, obj):
Patrick Williamsde0582f2022-04-08 10:23:27 -0500845 gc.disable()
Andrew Geissler517393d2023-01-13 08:55:19 -0600846 with bb.utils.lock_timeout(self.wlock):
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500847 self.writer.send_bytes(obj)
Patrick Williamsde0582f2022-04-08 10:23:27 -0500848 gc.enable()
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500849
Andrew Geissler9aee5002022-03-30 16:27:02 +0000850 def send(self, obj):
851 obj = multiprocessing.reduction.ForkingPickler.dumps(obj)
852 # See notes/code in CookerParser
853 # We must not terminate holding this lock else processes will hang.
854 # For SIGTERM, raising afterwards avoids this.
855 # For SIGINT, we don't want to have written partial data to the pipe.
856 # pthread_sigmask block/unblock would be nice but doesn't work, https://bugs.python.org/issue47139
857 process = multiprocessing.current_process()
858 if process and hasattr(process, "queue_signals"):
Andrew Geissler517393d2023-01-13 08:55:19 -0600859 with bb.utils.lock_timeout(process.signal_threadlock):
Andrew Geissler9aee5002022-03-30 16:27:02 +0000860 process.queue_signals = True
861 self._send(obj)
862 process.queue_signals = False
Andrew Geissler615f2f12022-07-15 14:00:58 -0500863 try:
864 for sig in process.signal_received.pop():
865 process.handle_sig(sig, None)
866 except IndexError:
867 pass
Andrew Geissler9aee5002022-03-30 16:27:02 +0000868 else:
869 self._send(obj)
870
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500871 def fileno(self):
872 return self.writer.fileno()
873
874 def close(self):
875 return self.writer.close()