10Sigor@sysoev.ru 20Sigor@sysoev.ru /* 30Sigor@sysoev.ru * Copyright (C) Igor Sysoev 40Sigor@sysoev.ru * Copyright (C) NGINX, Inc. 50Sigor@sysoev.ru */ 60Sigor@sysoev.ru 70Sigor@sysoev.ru #ifndef _NXT_JOB_H_INCLUDED_ 80Sigor@sysoev.ru #define _NXT_JOB_H_INCLUDED_ 90Sigor@sysoev.ru 100Sigor@sysoev.ru 110Sigor@sysoev.ru /* 120Sigor@sysoev.ru * A job may run by separate thread, so each job should have its 130Sigor@sysoev.ru * its own mem_pool. A job itself is allocated from this mem_pool. 140Sigor@sysoev.ru * On job completion a job initiator can destroy the job at once 150Sigor@sysoev.ru * with nxt_job_destroy() or can postpone the destruction with 160Sigor@sysoev.ru * nxt_job_cleanup_add(), if the initiator uses data from the job's 170Sigor@sysoev.ru * mem_pool. 180Sigor@sysoev.ru * 190Sigor@sysoev.ru * Several child jobs may run in context of another job in the same 200Sigor@sysoev.ru * thread. In this case the child job may use a mem_pool of the 210Sigor@sysoev.ru * parent job and the child job is allocated using the mem_pool's cache. 220Sigor@sysoev.ru * nxt_job_destroy() just returns the job to the cache. All job 230Sigor@sysoev.ru * allocations however still remain in the parent mem_pool. 240Sigor@sysoev.ru * 250Sigor@sysoev.ru * The first thread in job thread pool is created on demand. If this 260Sigor@sysoev.ru * operation fails the job abort handler is called. It also is called 270Sigor@sysoev.ru * if the job is canceled. To avoid race condition the abort handler 280Sigor@sysoev.ru * always runs in context of a thread initiated the job. The abort 290Sigor@sysoev.ru * handler may be as simple as nxt_job_destroy(). 300Sigor@sysoev.ru */ 310Sigor@sysoev.ru 320Sigor@sysoev.ru 330Sigor@sysoev.ru typedef struct { 340Sigor@sysoev.ru void *data; 350Sigor@sysoev.ru 36*4Sigor@sysoev.ru nxt_task_t *task; 371Sigor@sysoev.ru 380Sigor@sysoev.ru nxt_work_handler_t abort_handler; 390Sigor@sysoev.ru 400Sigor@sysoev.ru uint16_t cache_size; 410Sigor@sysoev.ru uint8_t cancel; /* 1 bit */ 420Sigor@sysoev.ru 430Sigor@sysoev.ru nxt_mem_pool_t *mem_pool; 440Sigor@sysoev.ru nxt_queue_link_t link; 450Sigor@sysoev.ru 460Sigor@sysoev.ru #if (NXT_THREADS) 470Sigor@sysoev.ru nxt_thread_pool_t *thread_pool; 480Sigor@sysoev.ru nxt_event_engine_t *engine; 490Sigor@sysoev.ru nxt_log_t *log; 500Sigor@sysoev.ru #endif 510Sigor@sysoev.ru 52*4Sigor@sysoev.ru nxt_work_t work; 53*4Sigor@sysoev.ru 540Sigor@sysoev.ru #if (NXT_DEBUG) 550Sigor@sysoev.ru const char *name; 560Sigor@sysoev.ru #endif 570Sigor@sysoev.ru 580Sigor@sysoev.ru } nxt_job_t; 590Sigor@sysoev.ru 600Sigor@sysoev.ru 610Sigor@sysoev.ru NXT_EXPORT void *nxt_job_create(nxt_mem_pool_t *mp, size_t size); 620Sigor@sysoev.ru NXT_EXPORT void nxt_job_init(nxt_job_t *job, size_t size); 630Sigor@sysoev.ru NXT_EXPORT void nxt_job_destroy(void *data); 640Sigor@sysoev.ru NXT_EXPORT nxt_int_t nxt_job_cleanup_add(nxt_mem_pool_t *mp, nxt_job_t *job); 650Sigor@sysoev.ru 661Sigor@sysoev.ru NXT_EXPORT void nxt_job_start(nxt_task_t *task, nxt_job_t *job, 670Sigor@sysoev.ru nxt_work_handler_t handler); 681Sigor@sysoev.ru NXT_EXPORT void nxt_job_return(nxt_task_t *task, nxt_job_t *job, 690Sigor@sysoev.ru nxt_work_handler_t handler); 700Sigor@sysoev.ru 710Sigor@sysoev.ru 720Sigor@sysoev.ru #define \ 730Sigor@sysoev.ru nxt_job_cancel(job) \ 740Sigor@sysoev.ru (job)->cancel = 1 750Sigor@sysoev.ru 760Sigor@sysoev.ru 770Sigor@sysoev.ru #if (NXT_DEBUG) 780Sigor@sysoev.ru 790Sigor@sysoev.ru #define \ 800Sigor@sysoev.ru nxt_job_set_name(job, text) \ 810Sigor@sysoev.ru (job)->name = text 820Sigor@sysoev.ru 830Sigor@sysoev.ru #else 840Sigor@sysoev.ru 850Sigor@sysoev.ru #define \ 860Sigor@sysoev.ru nxt_job_set_name(job, text) 870Sigor@sysoev.ru 880Sigor@sysoev.ru #endif 890Sigor@sysoev.ru 900Sigor@sysoev.ru 910Sigor@sysoev.ru #endif /* _NXT_JOB_H_INCLUDED_ */ 92