1 ;;;; -*- Mode: Lisp; Syntax: ANSI-Common-Lisp; Base: 10 -*-
2 ;;;; *************************************************************************
3 ;;;; FILE IDENTIFICATION
5 ;;;; Name: listener.lisp
6 ;;;; Purpose: Listener and worker processes
7 ;;;; Programmer: Kevin M. Rosenberg
8 ;;;; Date Started: Jun 2003
10 ;;;; This file, part of KMRCL, is Copyright (c) 2002-2003 by Kevin M. Rosenberg
12 ;;;; KMRCL users are granted the rights to distribute and use this software
13 ;;;; as governed by the terms of the Lisp Lesser GNU Public License
14 ;;;; (http://opensource.franz.com/preamble.html), also known as the LLGPL.
15 ;;;; *************************************************************************
19 ;;; Variables and data structures for Listener
21 (defvar *listener-count* 0
22 "used to name listeners")
24 (defvar *worker-count* 0
25 "used to name workers")
27 (defvar *active-listeners* nil
28 "List of active listeners")
31 ((port :initarg :port :accessor port)
32 (function :initarg :function :accessor listener-function
34 (function-args :initarg :function-args :accessor function-args
36 (process :initarg :process :accessor process :initform nil)
37 (socket :initarg :socket :accessor socket :initform nil)
38 (workers :initform nil :accessor workers
39 :documentation "list of worker threads")
40 (name :initform "" :accessor name :initarg :name)
41 (base-name :initform "listener" :accessor base-name :initarg :base-name)
42 (wait :initform nil :accessor wait :initarg :wait)
43 (timeout :initform nil :accessor timeout :initarg :timeout)
44 (number-fixed-workers :initform nil :accessor number-fixed-workers
45 :initarg :number-fixed-workers)
46 (catch-errors :initform nil :accessor catch-errors :initarg :catch-errors)
47 (remote-host-checker :initform nil :accessor remote-host-checker
48 :initarg :remote-host-checker)
49 (format :initform :text :accessor listener-format :initarg :format)))
51 (defclass fixed-worker ()
52 ((listener :initarg :listener :accessor listener :initform nil)
53 (name :initarg :name :accessor name :initform nil)
54 (process :initarg :process :accessor process :initform nil)))
56 (defclass worker (fixed-worker)
57 ((connection :initarg :connection :accessor connection :initform nil)
58 (thread-fun :initarg :thread-fun :accessor thread-fun :initform nil)))
61 (defmethod print-object ((obj listener) s)
62 (print-unreadable-object (obj s :type t :identity nil)
63 (format s "port ~A" (port obj))))
65 (defmethod print-object ((obj fixed-worker) s)
66 (print-unreadable-object (obj s :type t :identity nil)
67 (format s "port ~A" (port (listener obj)))))
71 (defun init/listener (listener state)
72 (check-type listener listener)
75 (when (member listener *active-listeners*)
76 (cmsg "~&listener ~A already initialized" listener)
77 (return-from init/listener))
78 (when (listener-startup listener)
79 (push listener *active-listeners*)
82 (unless (member listener *active-listeners*)
83 (cmsg "~&listener ~A is not in active list" listener)
84 (return-from init/listener listener))
85 (listener-shutdown listener)
86 (setq *active-listeners* (remove listener *active-listeners*)))
88 (init/listener listener :stop)
89 (init/listener listener :start))))
91 (defun stop-all/listener ()
92 (dolist (listener *active-listeners*)
94 (init/listener listener :stop))))
96 (defun listener-startup (listener)
99 (setf (name listener) (next-server-name (base-name listener)))
100 (make-socket-server listener))
102 (format t "~&Error while trying to start listener on port ~A~& ~A"
104 (decf *listener-count*)
107 (declare (ignore res))
110 (defun listener-shutdown (listener)
111 (dolist (worker (workers listener))
112 (when (and (typep worker 'worker)
114 (errorset (close-active-socket
115 (connection worker)) nil)
116 (setf (connection worker) nil))
117 (when (process worker)
118 (errorset (destroy-process (process worker)) nil)
119 (setf (process worker) nil)))
120 (setf (workers listener) nil)
121 (with-slots (process socket) listener
123 (errorset (close-passive-socket socket) nil)
126 (errorset (destroy-process process) nil)
127 (setf process nil))))
129 ;; Low-level functions
131 (defun next-server-name (base-name)
132 (format nil "~D-~A-socket-server" (incf *listener-count*) base-name))
134 (defun next-worker-name (base-name)
135 (format nil "~D-~A-worker" (incf *worker-count*) base-name))
137 (defun make-socket-server (listener)
140 (setf (process listener)
141 (comm:start-up-server :process-name (name listener)
142 :service (port listener)
145 (lw-worker handle listener)))))
148 (setf (socket listener) (create-inet-listener
150 :format (listener-format listener)))
151 (if (number-fixed-workers listener)
152 (start-fixed-number-of-workers listener)
153 (setf (process listener) (make-process
156 (start-socket-server listener))))))
160 (defmethod initialize-instance :after
161 ((self worker) &key listener connection name &allow-other-keys)
163 (apply (listener-function listener)
165 (function-args listener))))
167 (error "connection not provided to modlisp-worker"))
168 (setf (slot-value self 'listener) listener)
169 (setf (slot-value self 'name) name)
170 (setf (slot-value self 'connection) connection)
171 (setf (slot-value self 'thread-fun)
174 (if (catch-errors listener)
176 (if (timeout listener)
177 (with-timeout ((timeout listener))
181 (cmsg "Error ~A [~A]" e name)))
182 (if (timeout listener)
183 (with-timeout ((timeout listener))
187 (errorset (finish-output connection) nil)
188 (errorset (close-active-socket connection) nil)
189 (cmsg-c :threads "~A ended" name)
190 (setf (workers listener)
191 (remove self (workers listener)))))))))
193 (defun accept-and-check-tcp-connection (listener)
194 (multiple-value-bind (conn socket) (accept-tcp-connection (socket listener))
195 (when (and (remote-host-checker listener)
196 (not (funcall (remote-host-checker listener)
197 (remote-host socket))))
198 (cmsg-c :thread "Deny connection from ~A" (remote-host conn))
199 (errorset (close-active-socket conn) nil)
203 (defun start-socket-server (listener)
206 (let ((connection (accept-and-check-tcp-connection listener)))
210 (apply (listener-function listener)
212 (function-args listener))
214 (errorset (finish-output connection) nil)
215 (errorset (close-active-socket connection) nil)))
216 (let ((worker (make-instance 'worker :listener listener
217 :connection connection
218 :name (next-worker-name
219 (base-name listener)))))
220 (setf (process worker)
221 (make-process (name worker) (thread-fun worker)))
222 (push worker (workers listener)))))))
223 (errorset (close-passive-socket (socket listener)) nil)))
226 (defun lw-worker (handle listener)
227 (let ((connection (make-instance 'comm:socket-stream
230 :element-type 'base-char)))
233 (apply (listener-function listener)
235 (function-args listener))
236 (finish-output connection))
237 (let ((worker (make-instance 'worker :listener listener
238 :connection connection
239 :name (next-worker-name
240 (base-name listener)))))
241 (setf (process worker)
242 (make-process (name worker) (thread-fun worker)))
243 (push worker (workers listener))))))
245 ;; Fixed pool of workers
247 (defun start-fixed-number-of-workers (listener)
248 (dotimes (i (number-fixed-workers listener))
249 (let ((name (next-worker-name (base-name listener))))
251 (make-instance 'fixed-worker
256 name #'(lambda () (fixed-worker name listener))))
257 (workers listener)))))
260 (defun fixed-worker (name listener)
262 (let ((connection (accept-and-check-tcp-connection listener)))
265 (apply (listener-function listener)
267 (function-args listener))))
270 (if (catch-errors listener)
272 (if (timeout listener)
273 (with-timeout ((timeout listener))
277 (cmsg "Error ~A [~A]" e name)))
278 (if (timeout listener)
279 (with-timeout ((timeout listener))
283 (format t "Error: ~A" e)))
284 (errorset (finish-output connection) nil)
285 (errorset (close connection) nil)))))))