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:  Dec 2002
   9 ;;;;
  10 ;;;; $Id: listener.lisp,v 1.1 2003/07/08 16:12:40 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)
  33    (socket :initarg :socket :accessor socket)
  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
  50 ;; High-level API
  51
  52 (defun init/listener (listener state)
  53   (check-type listener listener)
  54   (case state
  55     (:start
  56      (when (member listener *active-listeners*)
  57        (warn "~&listener already started")
  58        (return-from init/listener listener))
  59      (handler-case
  60          (progn
  61            (setf (name listener) (next-server-name (base-name listener)))
  62            (make-socket-server listener))
  63        (error (e)
  64          (format t "~&Error while trying to start listener~&  ~A" e)
  65          (decf *listener-count*)
  66          nil)
  67        (:no-error (res)
  68          (declare (ignore res))
  69          (push listener *active-listeners*)
  70          listener)))
  71     (:stop
  72      (unless (member listener *active-listeners*)
  73        (warn "~&listener is not in active list")
  74        (return-from init/listener listener))
  75      (dolist (worker (workers listener))
  76        (close-active-socket (connection worker))
  77        (destroy-process (process worker)))
  78      (setf (workers listener) nil)
  79      (with-slots (process socket) listener
  80        (errorset (close-passive-socket socket) t)
  81        (errorset (destroy-process process) t))
  82      (setq *active-listeners* (remove listener *active-listeners*)))
  83     (:restart
  84      (init/listener listener :stop)
  85      (init/listener listener :start))))
  86
  87 (defun stop-all/listener ()
  88   (dolist (listener *active-listeners*)
  89     (ignore-errors
  90        (init/listener listener :stop))))
  91
  92 ;; Low-level functions
  93
  94 (defun next-server-name (base-name)
  95   (format nil "~A-socket-server-~D" base-name (incf *listener-count*)))
  96
  97 (defun next-worker-name (base-name)
  98   (format nil "~A-worker-~D" base-name (incf *worker-count*)))
  99
 100 (defun make-socket-server (listener)
 101   (setf (socket listener) (create-inet-listener
 102                            (port listener)
 103                            :format (listener-format listener)))
 104   (setf (process listener) (make-process
 105                             (name listener)
 106                             #'(lambda () (start-socket-server listener))))
 107   listener)
 108
 109
 110 (defmethod initialize-instance :after
 111     ((self worker) &key listener connection name &allow-other-keys)
 112   (unless connection
 113     (error "connection not provided to modlisp-worker"))
 114   (setf (slot-value self 'listener) listener)
 115   (setf (slot-value self 'name) name)
 116   (setf (slot-value self 'connection) connection)
 117   (setf (slot-value self 'thread-fun)
 118         #'(lambda ()
 119             (unwind-protect
 120                 (if (catch-errors listener)
 121                     (handler-case
 122                         (apply (listener-function listener)
 123                                connection
 124                                (function-args listener))
 125                       (error (e)
 126                         (cmsg "Error ~A [~A]" e name)))
 127                   (apply (listener-function listener)
 128                          connection
 129                          (function-args listener)))
 130           (progn
 131             (errorset (close-active-socket connection) nil)
 132             (cmsg-c :threads "~A ended" name)
 133             (setf (workers listener)
 134                   (remove self (workers listener))))))))
 135
 136 (defun start-socket-server (listener)
 137   (unwind-protect
 138       (loop
 139        (let ((connection (accept-tcp-connection (socket listener))))
 140          (if (wait listener)
 141              (unwind-protect
 142                   (apply (listener-function listener)
 143                          connection
 144                          (function-args listener))
 145                (errorset (close connection) nil))
 146              (let ((worker (make-instance 'worker :listener listener
 147                                           :connection connection
 148                                           :name (next-worker-name
 149                                                  (base-name listener)))))
 150               (setf (process worker)
 151                 (make-process (name worker) (thread-fun worker)))
 152               (push worker (workers listener))))))
 153     (errorset (close-passive-socket (socket listener)) nil)))