mach_init.tproj/lists.h

   1 /*
   2  * Copyright (c) 1999-2002 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * Copyright (c) 1999-2003 Apple Computer, Inc.  All Rights Reserved.
   7  *
   8  * This file contains Original Code and/or Modifications of Original Code
   9  * as defined in and that are subject to the Apple Public Source License
  10  * Version 2.0 (the 'License'). You may not use this file except in
  11  * compliance with the License. Please obtain a copy of the License at
  12  * http://www.opensource.apple.com/apsl/ and read it before using this
  13  * file.
  14  *
  15  * The Original Code and all software distributed under the License are
  16  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  17  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  18  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  20  * Please see the License for the specific language governing rights and
  21  * limitations under the License.
  22  *
  23  * @APPLE_LICENSE_HEADER_END@
  24  */
  25 /*
  26  * bootstrap -- fundamental service initiator and port server
  27  * Mike DeMoney, NeXT, Inc.
  28  * Copyright, 1990.  All rights reserved.
  29  *
  30  * lists.h -- interface to list routines
  31  */
  32
  33 #import <sys/types.h>
  34 #import <mach/mach.h>
  35 #import <mach/boolean.h>
  36 #import <servers/bootstrap_defs.h>
  37
  38 #ifndef NULL
  39 #define NULL    ((void *)0)
  40 #endif NULL
  41
  42 typedef struct bootstrap bootstrap_info_t;
  43 typedef struct service service_t;
  44 typedef struct server server_t;
  45
  46 /* Bootstrap info */
  47 struct bootstrap {
  48         bootstrap_info_t                *next;          /* list of all bootstraps */
  49         bootstrap_info_t                *prev;
  50         bootstrap_info_t                *parent;
  51         bootstrap_info_t                *deactivate;    /* list being deactivated */
  52         mach_port_name_t                bootstrap_port;
  53         mach_port_name_t                requestor_port;
  54         unsigned int                    ref_count;
  55 };
  56
  57 /* Service types */
  58 typedef enum {
  59         DECLARED,       /* Declared in config file */
  60         REGISTERED,     /* Registered dynamically */
  61         SELF            /* Name bound bootstrap service itself */
  62 } servicetype_t;
  63
  64 struct service {
  65         service_t       *next;          /* list of all services */
  66         service_t       *prev;
  67         name_t          name;           /* service name */
  68         mach_port_name_t        port;           /* service port,
  69                                            may have all rights if inactive */
  70         bootstrap_info_t        *bootstrap;     /* bootstrap port(s) used at this
  71                                          * level. */
  72         boolean_t       isActive;       /* server is running */
  73         servicetype_t   servicetype;    /* Declared, Registered, or Machport */
  74         server_t        *server;        /* server, declared services only */
  75 };
  76
  77 /* Server types */
  78 typedef enum {
  79         SERVER,         /* Launchable server */
  80         RESTARTABLE,    /* Restartable server */
  81         DEMAND,         /* Restartable server - on demand */
  82         MACHINIT,       /* mach_init doesn't get launched. */
  83 } servertype_t;
  84
  85 #define NULL_SERVER     NULL
  86 #define ACTIVE          TRUE
  87
  88 struct server {
  89         server_t        *next;          /* list of all servers */
  90         server_t        *prev;
  91         servertype_t    servertype;
  92         cmd_t           cmd;            /* server command to exec */
  93         int                     uid;            /* uid to exec server with */
  94         mach_port_t     port;           /* server's priv bootstrap port */
  95         mach_port_t     task_port;      /* server's task port */
  96         pid_t           pid;            /* server's pid */
  97         int             activity;               /* count of checkins/registers this instance */
  98         int             active_services;/* count of active services */
  99         bootstrap_info_t *bootstrap; /* bootstrap context */
 100 };
 101
 102 #define NO_PID  (-1)
 103
 104 extern void init_lists(void);
 105
 106 extern server_t *new_server(
 107         bootstrap_info_t        *bootstrap,
 108         const char                      *cmd,
 109         int                                     uid,
 110         servertype_t            servertype);
 111
 112 extern service_t                *new_service(
 113         bootstrap_info_t        *bootstrap,
 114         const char                      *name,
 115         mach_port_t                     service_port,
 116         boolean_t                       isActive,
 117         servicetype_t           servicetype,
 118         server_t                        *serverp);
 119
 120 extern bootstrap_info_t *new_bootstrap(
 121         bootstrap_info_t        *parent,
 122         mach_port_name_t        bootstrap_port,
 123         mach_port_name_t        requestor_port);
 124
 125 extern server_t *lookup_server_by_port(mach_port_t port);
 126 extern server_t *lookup_server_by_task_port(mach_port_t port);
 127 extern void setup_server(server_t *serverp);
 128 extern void delete_server(server_t *serverp);
 129 extern boolean_t active_server(server_t *serverp);
 130 extern boolean_t useless_server(server_t *serverp);
 131
 132 extern void delete_service(service_t *servicep);
 133 extern service_t *lookup_service_by_name(bootstrap_info_t *bootstrap, name_t name);
 134 extern service_t *lookup_service_by_port(mach_port_t port);
 135 extern service_t *lookup_service_by_server(server_t *serverp);
 136
 137 extern bootstrap_info_t *lookup_bootstrap_by_port(mach_port_t port);
 138 extern bootstrap_info_t *lookup_bootstrap_by_req_port(mach_port_t port);
 139 extern void deactivate_bootstrap(bootstrap_info_t *bootstrap);
 140 extern void deallocate_bootstrap(bootstrap_info_t *bootstrap);
 141 extern boolean_t active_bootstrap(bootstrap_info_t *bootstrap);
 142
 143 extern void *ckmalloc(unsigned nbytes);
 144
 145 extern bootstrap_info_t bootstraps;             /* head of list of bootstrap ports */
 146 extern server_t servers;                /* head of list of all servers */
 147 extern service_t services;              /* head of list of all services */
 148 extern unsigned nservices;              /* number of services in list */
 149
 150 #define FIRST(q)                ((q).next)
 151 #define NEXT(qe)                ((qe)->next)
 152 #define PREV(qe)                ((qe)->prev)
 153 #define IS_END(qe, q)           ((qe) == &(q))