listener.lisp

   1 ;;;; -*- Mode: Lisp; Syntax: ANSI-Common-Lisp; Base: 10; Package: modlisp -*-
   2 ;;;; *************************************************************************
   3 ;;;; FILE IDENTIFICATION
   4 ;;;;
   5 ;;;; Name:          listener.lisp
   6 ;;;; Purpose:       Listener and worker processes
   7 ;;;; Programmer:    Kevin M. Rosenberg
   8 ;;;; Date Started:  Jun 2003
   9 ;;;;
  10 ;;;; $Id: listener.lisp,v 1.3 2003/07/10 18:52:10 kevin Exp $
  11 ;;;; *************************************************************************
  12
  13 (in-package #:kmrcl)
  14
  15 ;;; Variables and data structures for Listener
  16
  17 (defvar *listener-count* 0
  18   "used to name listeners")
  19
  20 (defvar *worker-count* 0
  21   "used to name workers")
  22
  23 (defvar *active-listeners* nil
  24     "List of active listeners")
  25
  26 (defclass listener ()
  27   ((port :initarg :port :accessor port)
  28    (function :initarg :function :accessor listener-function
  29              :initform nil)
  30    (function-args :initarg :function-args :accessor function-args
  31                   :initform nil)
  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    (catch-errors :initform nil :accessor catch-errors :initarg :catch-errors)
  40    (format :initform :text :accessor listener-format :initarg :format)))
  41
  42 (defclass worker ()
  43   ((listener :initarg :listener :accessor listener :initform nil)
  44    (connection :initarg :connection :accessor connection :initform nil)
  45    (name :initarg :name :accessor name :initform nil)
  46    (thread-fun :initarg :thread-fun :accessor thread-fun :initform nil)
  47    (process :initarg :process :accessor process :initform nil)))
  48
  49 (defmethod print-object ((obj listener) s)
  50   (print-unreadable-object (obj s :type t :identity nil)
  51     (format s "port ~A" (port obj))))
  52
  53 (defmethod print-object ((obj worker) s)
  54   (print-unreadable-object (obj s :type t :identity nil)
  55     (format s "port ~A" (port (listener obj)))))
  56
  57 ;; High-level API
  58
  59 (defun init/listener (listener state)
  60   (check-type listener listener)
  61   (case state
  62     (:start
  63      (when (member listener *active-listeners*)
  64        (warn "~&listener already started")
  65        (return-from init/listener listener))
  66      (handler-case
  67          (progn
  68            (setf (name listener) (next-server-name (base-name listener)))
  69            (make-socket-server listener))
  70        (error (e)
  71          (format t "~&Error while trying to start listener~&  ~A" e)
  72          (decf *listener-count*)
  73          nil)
  74        (:no-error (res)
  75          (declare (ignore res))
  76          (push listener *active-listeners*)
  77          listener)))
  78     (:stop
  79      (unless (member listener *active-listeners*)
  80        (warn "~&listener is not in active list")
  81        (return-from init/listener listener))
  82      (dolist (worker (workers listener))
  83        (with-slots (connection process) worker
  84          (when connection
  85            (errorset (close-active-socket connection) nil)
  86            (setf connection nil))
  87          (when process
  88            (errorset (destroy-process process) nil)
  89            (setf process nil))))
  90      (setf (workers listener) nil)
  91      (with-slots (process socket) listener
  92        (when socket
  93          (errorset (close-passive-socket socket) nil)
  94          (setf socket nil))
  95        (when process
  96          (errorset (destroy-process process) nil)
  97          (setf process nil)))
  98      (setq *active-listeners* (remove listener *active-listeners*)))
  99     (:restart
 100      (init/listener listener :stop)
 101      (init/listener listener :start))))
 102
 103 (defun stop-all/listener ()
 104   (dolist (listener *active-listeners*)
 105     (ignore-errors
 106        (init/listener listener :stop))))
 107
 108 ;; Low-level functions
 109
 110 (defun next-server-name (base-name)
 111   (format nil "~A-socket-server-~D" base-name (incf *listener-count*)))
 112
 113 (defun next-worker-name (base-name)
 114   (format nil "~A-worker-~D" base-name (incf *worker-count*)))
 115
 116 (defun make-socket-server (listener)
 117   #+lispworks
 118   (progn
 119     (setf (process listener)
 120       (comm:start-up-server :process-name (name listener)
 121                             :service (port listener)
 122                             :function
 123                             #'(lambda (handle)
 124                                 (lw-worker handle listener)))))
 125   #-lispworks
 126   (progn
 127     (setf (socket listener) (create-inet-listener
 128                              (port listener)
 129                              :format (listener-format listener)))
 130     (setf (process listener) (make-process
 131                               (name listener)
 132                               #'(lambda () (start-socket-server listener)))))
 133   listener)
 134
 135
 136 (defmethod initialize-instance :after
 137     ((self worker) &key listener connection name &allow-other-keys)
 138   (unless connection
 139     (error "connection not provided to modlisp-worker"))
 140   (setf (slot-value self 'listener) listener)
 141   (setf (slot-value self 'name) name)
 142   (setf (slot-value self 'connection) connection)
 143   (setf (slot-value self 'thread-fun)
 144         #'(lambda ()
 145             (unwind-protect
 146                 (if (catch-errors listener)
 147                     (handler-case
 148                         (apply (listener-function listener)
 149                                connection
 150                                (function-args listener))
 151                       (error (e)
 152                         (cmsg "Error ~A [~A]" e name)))
 153                   (apply (listener-function listener)
 154                          connection
 155                          (function-args listener)))
 156           (progn
 157             (errorset (close-active-socket connection) nil)
 158             (cmsg-c :threads "~A ended" name)
 159             (setf (workers listener)
 160                   (remove self (workers listener))))))))
 161
 162 (defun start-socket-server (listener)
 163   (unwind-protect
 164       (loop
 165        (let ((connection (accept-tcp-connection (socket listener))))
 166          (if (wait listener)
 167              (unwind-protect
 168                   (apply (listener-function listener)
 169                          connection
 170                          (function-args listener))
 171                (errorset (close connection) nil))
 172              (let ((worker (make-instance 'worker :listener listener
 173                                           :connection connection
 174                                           :name (next-worker-name
 175                                                  (base-name listener)))))
 176               (setf (process worker)
 177                 (make-process (name worker) (thread-fun worker)))
 178               (push worker (workers listener))))))
 179     (errorset (close-passive-socket (socket listener)) nil)))
 180
 181 #+lispworks
 182 (defun lw-worker (handle listener)
 183   (let ((connection (make-instance 'comm:socket-stream
 184                       :socket handle
 185                       :direction :io
 186                       :element-type 'base-char)))
 187     (if (wait listener)
 188         (apply (listener-function listener)
 189                connection
 190                (function-args listener))
 191       (let ((worker (make-instance 'worker :listener listener
 192                                    :connection connection
 193                                    :name (next-worker-name
 194                                                   (base-name listener)))))
 195         (setf (process worker)
 196           (make-process (name worker) (thread-fun worker)))
 197         (push worker (workers listener))))))