dat.h

   1 typedef unsigned char uchar;
   2 typedef uchar         byte;
   3 typedef unsigned int  uint;
   4 typedef int32_t       int32;
   5 typedef uint32_t      uint32;
   6 typedef int64_t       int64;
   7 typedef uint64_t      uint64;
   8
   9 #define int8_t   do_not_use_int8_t
  10 #define uint8_t  do_not_use_uint8_t
  11 #define int32_t  do_not_use_int32_t
  12 #define uint32_t do_not_use_uint32_t
  13 #define int64_t  do_not_use_int64_t
  14 #define uint64_t do_not_use_uint64_t
  15
  16 typedef struct ms     *ms;
  17 typedef struct job    *job;
  18 typedef struct tube   *tube;
  19 typedef struct conn   *conn;
  20 typedef struct Heap   Heap;
  21 typedef struct Jobrec Jobrec;
  22 typedef struct File   File;
  23 typedef struct Socket Socket;
  24 typedef struct Srv    Srv;
  25 typedef struct Wal    Wal;
  26
  27 typedef void(*evh)(int, short, void *);
  28 typedef void(*ms_event_fn)(ms a, void *item, size_t i);
  29 typedef void(*Handle)(void*, int rw); // rw can also be 'h' for hangup
  30 typedef int(*Less)(void*, void*);
  31 typedef void(*Record)(void*, int);
  32
  33 #if _LP64
  34 #define NUM_PRIMES 48
  35 #else
  36 #define NUM_PRIMES 19
  37 #endif
  38
  39 #define MAX_TUBE_NAME_LEN 201
  40
  41 /* A command can be at most LINE_BUF_SIZE chars, including "\r\n". This value
  42  * MUST be enough to hold the longest possible command or reply line, which is
  43  * currently "USING a{200}\r\n". */
  44 #define LINE_BUF_SIZE 208
  45
  46 /* CONN_TYPE_* are bit masks */
  47 #define CONN_TYPE_PRODUCER 1
  48 #define CONN_TYPE_WORKER   2
  49 #define CONN_TYPE_WAITING  4
  50
  51 #define min(a,b) ((a)<(b)?(a):(b))
  52
  53 #define twarn(fmt, args...) warn("%s:%d in %s: " fmt, \
  54                                  __FILE__, __LINE__, __func__, ##args)
  55 #define twarnx(fmt, args...) warnx("%s:%d in %s: " fmt, \
  56                                    __FILE__, __LINE__, __func__, ##args)
  57
  58 #ifdef DEBUG
  59 #define dbgprintf(fmt, args...) ((void) fprintf(stderr, fmt, ##args))
  60 #else
  61 #define dbgprintf(fmt, ...) ((void) 0)
  62 #endif
  63
  64 #define URGENT_THRESHOLD 1024
  65 #define JOB_DATA_SIZE_LIMIT_DEFAULT ((1 << 16) - 1)
  66
  67 extern const char version[];
  68
  69 struct stats {
  70     uint urgent_ct;
  71     uint waiting_ct;
  72     uint buried_ct;
  73     uint reserved_ct;
  74     uint pause_ct;
  75     uint64   total_delete_ct;
  76     uint64   total_jobs_ct;
  77 };
  78
  79
  80 struct Heap {
  81     int     cap;
  82     int     len;
  83     void    **data;
  84     Less    less;
  85     Record  rec;
  86 };
  87 int   heapinsert(Heap *h, void *x);
  88 void* heapremove(Heap *h, int k);
  89
  90
  91 struct Socket {
  92     int    fd;
  93     Handle f;
  94     void   *x;
  95     int    added;
  96 };
  97
  98 void sockinit(Handle tick, void *x, int64 ns);
  99 int  sockwant(Socket *s, int rw);
 100 void sockmain(void); // does not return
 101
 102 struct ms {
 103     size_t used, cap, last;
 104     void **items;
 105     ms_event_fn oninsert, onremove;
 106 };
 107
 108 enum
 109 {
 110     Walver = 7
 111 };
 112
 113 enum // Jobrec.state
 114 {
 115     Invalid,
 116     Ready,
 117     Reserved,
 118     Buried,
 119     Delayed,
 120     Copy
 121 };
 122
 123 // if you modify this struct, you must increment Walver above
 124 struct Jobrec {
 125     uint64 id;
 126     uint32 pri;
 127     int64  delay;
 128     int64  ttr;
 129     int32  body_size;
 130     int64  created_at;
 131     int64  deadline_at;
 132     uint32 reserve_ct;
 133     uint32 timeout_ct;
 134     uint32 release_ct;
 135     uint32 bury_ct;
 136     uint32 kick_ct;
 137     byte   state;
 138 };
 139
 140 struct job {
 141     Jobrec r; // persistent fields; these get written to the wal
 142
 143     /* bookeeping fields; these are in-memory only */
 144     char pad[6];
 145     tube tube;
 146     job prev, next; /* linked list of jobs */
 147     job ht_next; /* Next job in a hash table list */
 148     size_t heap_index; /* where is this job in its current heap */
 149     File *file;
 150     job  fnext;
 151     job  fprev;
 152     void *reserver;
 153     int walresv;
 154     int walused;
 155
 156     char body[]; // written separately to the wal
 157 };
 158
 159 struct tube {
 160     uint refs;
 161     char name[MAX_TUBE_NAME_LEN];
 162     Heap ready;
 163     Heap delay;
 164     struct ms waiting; /* set of conns */
 165     struct stats stat;
 166     uint using_ct;
 167     uint watching_ct;
 168     int64 pause;
 169     int64 deadline_at;
 170     struct job buried;
 171 };
 172
 173 struct conn {
 174     conn prev, next; /* linked list of connections */
 175     Srv *srv;
 176     Socket sock;
 177     char state;
 178     char type;
 179     int rw; // currently want: 'r' or 'w'
 180     int pending_timeout;
 181     int64 tickat; // time at which to do more work
 182     int tickpos; // position in srv->conns
 183
 184     /* we cannot share this buffer with the reply line because we might read in
 185      * command line data for a subsequent command, and we need to store it
 186      * here. */
 187     char cmd[LINE_BUF_SIZE]; /* this string is NOT NUL-terminated */
 188     int cmd_len;
 189     int cmd_read;
 190     const char *reply;
 191     int reply_len;
 192     int reply_sent;
 193     char reply_buf[LINE_BUF_SIZE]; /* this string IS NUL-terminated */
 194
 195     /* A job to be read from the client. */
 196     job in_job;
 197
 198     /* Memoization of the soonest job */
 199     job soonest_job;
 200
 201     /* How many bytes of in_job->body have been read so far. If in_job is NULL
 202      * while in_job_read is nonzero, we are in bit bucket mode and
 203      * in_job_read's meaning is inverted -- then it counts the bytes that
 204      * remain to be thrown away. */
 205     int in_job_read;
 206
 207     job out_job;
 208     int out_job_sent;
 209     tube use;
 210     struct ms watch;
 211     struct job reserved_jobs; /* doubly-linked list header */
 212 };
 213
 214
 215 void v(void);
 216
 217 void warn(const char *fmt, ...);
 218 void warnx(const char *fmt, ...);
 219 char* fmtalloc(char *fmt, ...);
 220 void* zalloc(int n);
 221 #define new(T) zalloc(sizeof(T))
 222
 223 extern const char *progname;
 224
 225 int64 nanoseconds(void);
 226 int   falloc(int fd, int len);
 227
 228
 229 void ms_init(ms a, ms_event_fn oninsert, ms_event_fn onremove);
 230 void ms_clear(ms a);
 231 int ms_append(ms a, void *item);
 232 int ms_remove(ms a, void *item);
 233 int ms_contains(ms a, void *item);
 234 void *ms_take(ms a);
 235
 236
 237 #define make_job(pri,delay,ttr,body_size,tube) make_job_with_id(pri,delay,ttr,body_size,tube,0)
 238
 239 job allocate_job(int body_size);
 240 job make_job_with_id(uint pri, int64 delay, int64 ttr,
 241              int body_size, tube tube, uint64 id);
 242 void job_free(job j);
 243
 244 /* Lookup a job by job ID */
 245 job job_find(uint64 job_id);
 246
 247 /* the void* parameters are really job pointers */
 248 void job_setheappos(void*, int);
 249 int job_pri_less(void*, void*);
 250 int job_delay_less(void*, void*);
 251
 252 job job_copy(job j);
 253
 254 const char * job_state(job j);
 255
 256 int job_list_any_p(job head);
 257 job job_remove(job j);
 258 void job_insert(job head, job j);
 259
 260 uint64 total_jobs(void);
 261
 262 /* for unit tests */
 263 size_t get_all_jobs_used(void);
 264
 265
 266 extern struct ms tubes;
 267
 268 tube make_tube(const char *name);
 269 void tube_dref(tube t);
 270 void tube_iref(tube t);
 271 tube tube_find(const char *name);
 272 tube tube_find_or_make(const char *name);
 273 #define TUBE_ASSIGN(a,b) (tube_dref(a), (a) = (b), tube_iref(a))
 274
 275
 276 conn make_conn(int fd, char start_state, tube use, tube watch);
 277
 278 int  connless(conn a, conn b);
 279 void connrec(conn c, int i);
 280 void connwant(conn c, const int mask, conn list);
 281 void connsched(conn c);
 282
 283 void conn_close(conn c);
 284
 285 conn conn_remove(conn c);
 286 void conn_insert(conn head, conn c);
 287
 288 int count_cur_conns(void);
 289 uint count_tot_conns(void);
 290 int count_cur_producers(void);
 291 int count_cur_workers(void);
 292
 293 void conn_set_producer(conn c);
 294 void conn_set_worker(conn c);
 295
 296 job soonest_job(conn c);
 297 int has_reserved_this_job(conn c, job j);
 298 int conn_has_close_deadline(conn c);
 299 int conn_ready(conn c);
 300
 301 #define conn_waiting(c) ((c)->type & CONN_TYPE_WAITING)
 302
 303
 304 extern size_t primes[];
 305
 306
 307 extern size_t job_data_size_limit;
 308
 309 void prot_init(void);
 310 void prottick(Srv *s);
 311
 312 conn remove_waiting_conn(conn c);
 313
 314 void enqueue_reserved_jobs(conn c);
 315
 316 void enter_drain_mode(int sig);
 317 void h_accept(const int fd, const short which, Srv* srv);
 318 void prot_remove_tube(tube t);
 319 void prot_replay(Srv *s, job list);
 320
 321
 322 int make_server_socket(char *host_addr, char *port);
 323
 324
 325 enum
 326 {
 327     Filesizedef = (10 << 20)
 328 };
 329
 330 struct Wal {
 331     int    use;
 332     char   *dir;
 333     File   *head;
 334     File   *cur;
 335     File   *tail;
 336     int    nfile;
 337     int    next;
 338     int    filesz;
 339     int    resv;  // bytes reserved
 340     int    alive; // bytes in use
 341     int64  nmig;  // migrations
 342     int64  nrec;  // records written ever
 343     int    wantsync;
 344     int64  syncrate;
 345     int64  lastsync;
 346     int    nocomp; // disable binlog compaction?
 347 };
 348 int  waldirlock(Wal*);
 349 void walinit(Wal*, job list);
 350 int  walwrite(Wal*, job);
 351 void walmaint(Wal*);
 352 int  walresvput(Wal*, job);
 353 int  walresvupdate(Wal*, job);
 354 void walgc(Wal*);
 355
 356
 357 struct File {
 358     File *next;
 359     uint refs;
 360     int  seq;
 361     int  iswopen; // is open for writing
 362     int  fd;
 363     int  free;
 364     int  resv;
 365     char *path;
 366     Wal  *w;
 367
 368     struct job jlist; // jobs written in this file
 369 };
 370 int  fileinit(File*, Wal*, int);
 371 Wal* fileadd(File*, Wal*);
 372 void fileincref(File*);
 373 void filedecref(File*);
 374 void fileaddjob(File*, job);
 375 void filermjob(File*, job);
 376 int  fileread(File*, job list);
 377 void filewopen(File*);
 378 void filewclose(File*);
 379 int  filewrjobshort(File*, job);
 380 int  filewrjobfull(File*, job);
 381
 382
 383 struct Srv {
 384     Socket sock;
 385     Heap   conns;
 386     Wal    wal;
 387 };
 388 void srv(Srv *srv);
 389 void srvaccept(Srv *s, int ev);
 390 void srvschedconn(Srv *srv, conn c);
 391 void srvtick(Srv *s, int ev);