1 ;;;; -*- Mode: Lisp; Syntax: ANSI-Common-Lisp; Base: 10; Package: modlisp -*-
2 ;;;; *************************************************************************
3 ;;;; FILE IDENTIFICATION
5 ;;;; Name: listener.lisp
6 ;;;; Purpose: Listener and worker processes
7 ;;;; Programmer: Kevin M. Rosenberg
8 ;;;; Date Started: Jun 2003
11 ;;;; *************************************************************************
15 ;;; Variables and data structures for Listener
17 (defvar *listener-count* 0
18 "used to name listeners")
20 (defvar *worker-count* 0
21 "used to name workers")
23 (defvar *active-listeners* nil
24 "List of active listeners")
27 ((port :initarg :port :accessor port)
28 (function :initarg :function :accessor listener-function
30 (function-args :initarg :function-args :accessor function-args
32 (process :initarg :process :accessor process :initform nil)
33 (socket :initarg :socket :accessor socket :initform nil)
34 (workers :initform nil :accessor workers
35 :documentation "list of worker threads")
36 (name :initform "" :accessor name :initarg :name)
37 (base-name :initform "listener" :accessor base-name :initarg :base-name)
38 (wait :initform nil :accessor wait :initarg :wait)
39 (timeout :initform nil :accessor timeout :initarg :timeout)
40 (number-fixed-workers :initform nil :accessor number-fixed-workers
41 :initarg :number-fixed-workers)
42 (catch-errors :initform nil :accessor catch-errors :initarg :catch-errors)
43 (remote-host-checker :initform nil :accessor remote-host-checker
44 :initarg :remote-host-checker)
45 (format :initform :text :accessor listener-format :initarg :format)))
47 (defclass fixed-worker ()
48 ((listener :initarg :listener :accessor listener :initform nil)
49 (name :initarg :name :accessor name :initform nil)
50 (process :initarg :process :accessor process :initform nil)))
52 (defclass worker (fixed-worker)
53 ((connection :initarg :connection :accessor connection :initform nil)
54 (thread-fun :initarg :thread-fun :accessor thread-fun :initform nil)))
57 (defmethod print-object ((obj listener) s)
58 (print-unreadable-object (obj s :type t :identity nil)
59 (format s "port ~A" (port obj))))
61 (defmethod print-object ((obj fixed-worker) s)
62 (print-unreadable-object (obj s :type t :identity nil)
63 (format s "port ~A" (port (listener obj)))))
67 (defun init/listener (listener state)
68 (check-type listener listener)
71 (when (member listener *active-listeners*)
72 (cmsg "~&listener ~A already initialized" listener)
73 (return-from init/listener))
74 (when (listener-startup listener)
75 (push listener *active-listeners*)
78 (unless (member listener *active-listeners*)
79 (cmsg "~&listener ~A is not in active list" listener)
80 (return-from init/listener listener))
81 (listener-shutdown listener)
82 (setq *active-listeners* (remove listener *active-listeners*)))
84 (init/listener listener :stop)
85 (init/listener listener :start))))
87 (defun stop-all/listener ()
88 (dolist (listener *active-listeners*)
90 (init/listener listener :stop))))
92 (defun listener-startup (listener)
95 (setf (name listener) (next-server-name (base-name listener)))
96 (make-socket-server listener))
98 (format t "~&Error while trying to start listener on port ~A~& ~A"
100 (decf *listener-count*)
103 (declare (ignore res))
106 (defun listener-shutdown (listener)
107 (dolist (worker (workers listener))
108 (when (and (typep worker 'worker)
110 (errorset (close-active-socket
111 (connection worker)) nil)
112 (setf (connection worker) nil))
113 (when (process worker)
114 (errorset (destroy-process (process worker)) nil)
115 (setf (process worker) nil)))
116 (setf (workers listener) nil)
117 (with-slots (process socket) listener
119 (errorset (close-passive-socket socket) nil)
122 (errorset (destroy-process process) nil)
123 (setf process nil))))
125 ;; Low-level functions
127 (defun next-server-name (base-name)
128 (format nil "~D-~A-socket-server" (incf *listener-count*) base-name))
130 (defun next-worker-name (base-name)
131 (format nil "~D-~A-worker" (incf *worker-count*) base-name))
133 (defun make-socket-server (listener)
136 (setf (process listener)
137 (comm:start-up-server :process-name (name listener)
138 :service (port listener)
141 (lw-worker handle listener)))))
144 (setf (socket listener) (create-inet-listener
146 :format (listener-format listener)))
147 (if (number-fixed-workers listener)
148 (start-fixed-number-of-workers listener)
149 (setf (process listener) (make-process
152 (start-socket-server listener))))))
156 (defmethod initialize-instance :after
157 ((self worker) &key listener connection name &allow-other-keys)
159 (apply (listener-function listener)
161 (function-args listener))))
163 (error "connection not provided to modlisp-worker"))
164 (setf (slot-value self 'listener) listener)
165 (setf (slot-value self 'name) name)
166 (setf (slot-value self 'connection) connection)
167 (setf (slot-value self 'thread-fun)
170 (if (catch-errors listener)
172 (if (timeout listener)
173 (with-timeout ((timeout listener))
177 (cmsg "Error ~A [~A]" e name)))
178 (if (timeout listener)
179 (with-timeout ((timeout listener))
183 (errorset (finish-output connection) nil)
184 (errorset (close-active-socket connection) nil)
185 (cmsg-c :threads "~A ended" name)
186 (setf (workers listener)
187 (remove self (workers listener)))))))))
189 (defun accept-and-check-tcp-connection (listener)
190 (multiple-value-bind (conn socket) (accept-tcp-connection (socket listener))
191 (when (and (remote-host-checker listener)
192 (not (funcall (remote-host-checker listener)
193 (remote-host socket))))
194 (cmsg-c :thread "Deny connection from ~A" (remote-host conn))
195 (errorset (close-active-socket conn) nil)
199 (defun start-socket-server (listener)
202 (let ((connection (accept-and-check-tcp-connection listener)))
206 (apply (listener-function listener)
208 (function-args listener))
210 (errorset (finish-output connection) nil)
211 (errorset (close-active-socket connection) nil)))
212 (let ((worker (make-instance 'worker :listener listener
213 :connection connection
214 :name (next-worker-name
215 (base-name listener)))))
216 (setf (process worker)
217 (make-process (name worker) (thread-fun worker)))
218 (push worker (workers listener)))))))
219 (errorset (close-passive-socket (socket listener)) nil)))
222 (defun lw-worker (handle listener)
223 (let ((connection (make-instance 'comm:socket-stream
226 :element-type 'base-char)))
229 (apply (listener-function listener)
231 (function-args listener))
232 (finish-output connection))
233 (let ((worker (make-instance 'worker :listener listener
234 :connection connection
235 :name (next-worker-name
236 (base-name listener)))))
237 (setf (process worker)
238 (make-process (name worker) (thread-fun worker)))
239 (push worker (workers listener))))))
241 ;; Fixed pool of workers
243 (defun start-fixed-number-of-workers (listener)
244 (dotimes (i (number-fixed-workers listener))
245 (let ((name (next-worker-name (base-name listener))))
247 (make-instance 'fixed-worker
252 name #'(lambda () (fixed-worker name listener))))
253 (workers listener)))))
256 (defun fixed-worker (name listener)
258 (let ((connection (accept-and-check-tcp-connection listener)))
261 (apply (listener-function listener)
263 (function-args listener))))
266 (if (catch-errors listener)
268 (if (timeout listener)
269 (with-timeout ((timeout listener))
273 (cmsg "Error ~A [~A]" e name)))
274 (if (timeout listener)
275 (with-timeout ((timeout listener))
279 (format t "Error: ~A" e)))
280 (errorset (finish-output connection) nil)
281 (errorset (close connection) nil)))))))