server.cc 43 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084
  1. /* vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
  2. *
  3. * Gearmand client and server library.
  4. *
  5. * Copyright (C) 2011-2013 Data Differential, http://datadifferential.com/
  6. * Copyright (C) 2008 Brian Aker, Eric Day
  7. * All rights reserved.
  8. *
  9. * Redistribution and use in source and binary forms, with or without
  10. * modification, are permitted provided that the following conditions are
  11. * met:
  12. *
  13. * * Redistributions of source code must retain the above copyright
  14. * notice, this list of conditions and the following disclaimer.
  15. *
  16. * * Redistributions in binary form must reproduce the above
  17. * copyright notice, this list of conditions and the following disclaimer
  18. * in the documentation and/or other materials provided with the
  19. * distribution.
  20. *
  21. * * The names of its contributors may not be used to endorse or
  22. * promote products derived from this software without specific prior
  23. * written permission.
  24. *
  25. * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  26. * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  27. * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  28. * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  29. * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  30. * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  31. * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  32. * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  33. * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  34. * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  35. * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  36. *
  37. */
  38. /**
  39. * @file
  40. * @brief Server Definitions
  41. */
  42. #include "gear_config.h"
  43. #include "libgearman-server/common.h"
  44. #include "libgearman-server/queue.h"
  45. #include "libgearman-server/plugins/base.h"
  46. #include <cerrno>
  47. #include <climits>
  48. #include <cstdlib>
  49. #include <cstring>
  50. #include <cassert>
  51. #include "libgearman-1.0/return.h"
  52. #include "libgearman-1.0/strerror.h"
  53. #include "libgearman/magic.h"
  54. /*
  55. * Private declarations
  56. */
  57. /**
  58. * @addtogroup gearman_server_private Private Server Functions
  59. * @ingroup gearman_server
  60. * @{
  61. */
  62. /**
  63. * Queue an error packet.
  64. */
  65. static gearmand_error_t _server_error_packet(gearman_server_con_st *server_con,
  66. gearman_return_t client_return_code, const char *error_string)
  67. {
  68. const char* error_code_string= gearman_strerror(client_return_code);
  69. error_code_string+= 8;
  70. gearmand_log_error(GEARMAN_DEFAULT_LOG_PARAM, "%s:%s", gearman_strerror(client_return_code), error_string);
  71. return gearman_server_io_packet_add(server_con, false, GEARMAN_MAGIC_RESPONSE,
  72. GEARMAN_COMMAND_ERROR, error_code_string,
  73. (size_t)(strlen(error_code_string) + 1),
  74. error_string,
  75. (size_t)strlen(error_string), NULL);
  76. }
  77. /**
  78. * Send work result packets with data back to clients.
  79. */
  80. static gearmand_error_t
  81. _server_queue_work_data(gearman_server_job_st *server_job,
  82. gearmand_packet_st *packet, gearman_command_t command);
  83. /** @} */
  84. /*
  85. * Public definitions
  86. */
  87. gearmand_error_t gearman_server_run_command(gearman_server_con_st *server_con,
  88. gearmand_packet_st *packet)
  89. {
  90. gearmand_error_t ret;
  91. gearman_server_client_st *server_client= NULL;
  92. if (packet->magic == GEARMAN_MAGIC_RESPONSE)
  93. {
  94. return _server_error_packet(server_con, GEARMAN_INVALID_MAGIC, "Request magic expected");
  95. }
  96. gearmand_log_debug(GEARMAN_DEFAULT_LOG_PARAM,
  97. "%15s:%5s packet command %s",
  98. server_con->con.context == NULL || server_con->con.context->host == NULL ? "-" : server_con->con.context->host,
  99. server_con->con.context == NULL || server_con->con.context->port == NULL ? "-" : server_con->con.context->port,
  100. gearmand_strcommand(packet));
  101. switch (packet->command)
  102. {
  103. /* Client/worker requests. */
  104. case GEARMAN_COMMAND_ECHO_REQ:
  105. /* Reuse the data buffer and just shove the data back. */
  106. ret= gearman_server_io_packet_add(server_con, true, GEARMAN_MAGIC_RESPONSE,
  107. GEARMAN_COMMAND_ECHO_RES, packet->data,
  108. packet->data_size, NULL);
  109. if (gearmand_failed(ret))
  110. {
  111. return gearmand_gerror("gearman_server_io_packet_add", ret);
  112. }
  113. packet->options.free_data= false;
  114. break;
  115. case GEARMAN_COMMAND_SUBMIT_REDUCE_JOB: // Reduce request
  116. server_client= gearman_server_client_add(server_con);
  117. if (server_client == NULL)
  118. {
  119. return GEARMAND_MEMORY_ALLOCATION_FAILURE;
  120. }
  121. case GEARMAN_COMMAND_SUBMIT_REDUCE_JOB_BACKGROUND:
  122. {
  123. gearmand_log_debug(GEARMAN_DEFAULT_LOG_PARAM,
  124. "Received reduce submission, Partitioner: %.*s(%lu) Reducer: %.*s(%lu) Unique: %.*s(%lu) with %d arguments",
  125. packet->arg_size[0] -1, packet->arg[0], packet->arg_size[0] -1,
  126. packet->arg_size[2] -1, packet->arg[2], packet->arg_size[2] -1, // reducer
  127. packet->arg_size[1] -1, packet->arg[1], packet->arg_size[1] -1,
  128. (int)packet->argc);
  129. if (packet->arg_size[2] -1 > GEARMAN_UNIQUE_SIZE)
  130. {
  131. gearman_server_client_free(server_client);
  132. gearmand_gerror("unique value too large", GEARMAND_ARGUMENT_TOO_LARGE);
  133. return _server_error_packet(server_con, GEARMAN_ARGUMENT_TOO_LARGE, "Unique value too large");
  134. }
  135. gearman_job_priority_t map_priority= GEARMAN_JOB_PRIORITY_NORMAL;
  136. /* Schedule job. */
  137. gearman_server_job_st *server_job= gearman_server_job_add_reducer(Server,
  138. (char *)(packet->arg[0]), packet->arg_size[0] -1, // Function
  139. (char *)(packet->arg[1]), packet->arg_size[1] -1, // unique
  140. (char *)(packet->arg[2]), packet->arg_size[2] -1, // reducer
  141. packet->data, packet->data_size, map_priority,
  142. server_client, &ret, 0);
  143. if (gearmand_success(ret))
  144. {
  145. packet->options.free_data= false;
  146. }
  147. else if (ret == GEARMAND_JOB_QUEUE_FULL)
  148. {
  149. gearman_server_client_free(server_client);
  150. return _server_error_packet(server_con, GEARMAN_QUEUE_ERROR, "Job queue is full");
  151. }
  152. else if (ret != GEARMAND_JOB_EXISTS)
  153. {
  154. gearman_server_client_free(server_client);
  155. gearmand_gerror("gearman_server_job_add", ret);
  156. return _server_error_packet(server_con, GEARMAN_QUEUE_ERROR, gearmand_strerror(ret));
  157. }
  158. /* Queue the job created packet. */
  159. ret= gearman_server_io_packet_add(server_con, false, GEARMAN_MAGIC_RESPONSE,
  160. GEARMAN_COMMAND_JOB_CREATED,
  161. server_job->job_handle,
  162. (size_t)strlen(server_job->job_handle),
  163. NULL);
  164. if (gearmand_failed(ret))
  165. {
  166. gearman_server_client_free(server_client);
  167. gearmand_gerror("gearman_server_io_packet_add", ret);
  168. return ret;
  169. }
  170. gearmand_log_notice(GEARMAN_DEFAULT_LOG_PARAM,"accepted,%.*s,%.*s,%.*s",
  171. packet->arg_size[0] -1, packet->arg[0], // Function
  172. packet->arg_size[1] -1, packet->arg[1], // unique
  173. packet->arg_size[2] -1, packet->arg[2]); // reducer
  174. }
  175. break;
  176. /* Client requests. */
  177. case GEARMAN_COMMAND_SUBMIT_JOB:
  178. case GEARMAN_COMMAND_SUBMIT_JOB_BG:
  179. case GEARMAN_COMMAND_SUBMIT_JOB_HIGH:
  180. case GEARMAN_COMMAND_SUBMIT_JOB_HIGH_BG:
  181. case GEARMAN_COMMAND_SUBMIT_JOB_LOW:
  182. case GEARMAN_COMMAND_SUBMIT_JOB_LOW_BG:
  183. case GEARMAN_COMMAND_SUBMIT_JOB_EPOCH:
  184. {
  185. gearman_job_priority_t priority;
  186. if (packet->command == GEARMAN_COMMAND_SUBMIT_JOB or
  187. packet->command == GEARMAN_COMMAND_SUBMIT_JOB_BG or
  188. packet->command == GEARMAN_COMMAND_SUBMIT_JOB_EPOCH)
  189. {
  190. priority= GEARMAN_JOB_PRIORITY_NORMAL;
  191. }
  192. else if (packet->command == GEARMAN_COMMAND_SUBMIT_JOB_HIGH or
  193. packet->command == GEARMAN_COMMAND_SUBMIT_JOB_HIGH_BG)
  194. {
  195. priority= GEARMAN_JOB_PRIORITY_HIGH;
  196. }
  197. else
  198. {
  199. priority= GEARMAN_JOB_PRIORITY_LOW;
  200. }
  201. if (packet->command == GEARMAN_COMMAND_SUBMIT_JOB_BG or
  202. packet->command == GEARMAN_COMMAND_SUBMIT_JOB_HIGH_BG or
  203. packet->command == GEARMAN_COMMAND_SUBMIT_JOB_LOW_BG or
  204. packet->command == GEARMAN_COMMAND_SUBMIT_JOB_EPOCH)
  205. {
  206. server_client= NULL;
  207. }
  208. else
  209. {
  210. server_client= gearman_server_client_add(server_con);
  211. if (server_client == NULL)
  212. {
  213. return GEARMAND_MEMORY_ALLOCATION_FAILURE;
  214. }
  215. }
  216. gearmand_log_debug(GEARMAN_DEFAULT_LOG_PARAM,
  217. "Received submission, function:%.*s unique:%.*s with %d arguments",
  218. packet->arg_size[0], packet->arg[0],
  219. packet->arg_size[1], packet->arg[1],
  220. (int)packet->argc);
  221. int64_t when= 0;
  222. if (packet->command == GEARMAN_COMMAND_SUBMIT_JOB_EPOCH)
  223. {
  224. char *endptr;
  225. // @note stroll will set errno if error, but it might also leave errno
  226. // alone if none happens (so a previous call that sets it might cause
  227. // an error.
  228. errno= 0;
  229. when= strtoll((char *)packet->arg[2], &endptr, 10);
  230. if (errno)
  231. {
  232. return gearmand_log_error(GEARMAN_DEFAULT_LOG_PARAM, "strtoul(%ul)", when);
  233. }
  234. gearmand_log_debug(GEARMAN_DEFAULT_LOG_PARAM,
  235. "Received EPOCH job submission, function:%.*s unique:%.*s with data for %jd at %jd, args %d",
  236. packet->arg_size[0], packet->arg[0],
  237. packet->arg_size[1], packet->arg[1],
  238. when, time(NULL),
  239. (int)packet->argc);
  240. }
  241. if (packet->arg_size[1] -1 > GEARMAN_UNIQUE_SIZE)
  242. {
  243. gearmand_gerror("unique value too large", GEARMAND_ARGUMENT_TOO_LARGE);
  244. gearman_server_client_free(server_client);
  245. return _server_error_packet(server_con, GEARMAN_ARGUMENT_TOO_LARGE, "Unique value too large");
  246. }
  247. /* Schedule job. */
  248. gearman_server_job_st *server_job= gearman_server_job_add(Server,
  249. (char *)(packet->arg[0]), packet->arg_size[0] -1, // Function
  250. (char *)(packet->arg[1]), packet->arg_size[1] -1, // unique
  251. packet->data, packet->data_size, priority,
  252. server_client, &ret,
  253. when);
  254. if (gearmand_success(ret))
  255. {
  256. packet->options.free_data= false;
  257. }
  258. else if (ret == GEARMAND_JOB_QUEUE_FULL)
  259. {
  260. gearman_server_client_free(server_client);
  261. return _server_error_packet(server_con, GEARMAN_QUEUE_ERROR, "Job queue is full");
  262. }
  263. else if (ret != GEARMAND_JOB_EXISTS)
  264. {
  265. gearman_server_client_free(server_client);
  266. gearmand_gerror("gearman_server_job_add", ret);
  267. return _server_error_packet(server_con, GEARMAN_QUEUE_ERROR, gearmand_strerror(ret));
  268. }
  269. /* Queue the job created packet. */
  270. ret= gearman_server_io_packet_add(server_con, false, GEARMAN_MAGIC_RESPONSE,
  271. GEARMAN_COMMAND_JOB_CREATED,
  272. server_job->job_handle,
  273. (size_t)strlen(server_job->job_handle),
  274. NULL);
  275. if (gearmand_failed(ret))
  276. {
  277. gearman_server_client_free(server_client);
  278. gearmand_gerror("gearman_server_io_packet_add", ret);
  279. return ret;
  280. }
  281. gearmand_log_notice(GEARMAN_DEFAULT_LOG_PARAM,"accepted,%.*s,%.*s,%jd",
  282. packet->arg_size[0], packet->arg[0], // Function
  283. packet->arg_size[1], packet->arg[1], // Unique
  284. when);
  285. }
  286. break;
  287. case GEARMAN_COMMAND_GET_STATUS_UNIQUE:
  288. {
  289. char unique_handle[GEARMAN_MAX_UNIQUE_SIZE];
  290. /* This may not be NULL terminated, so copy to make sure it is. */
  291. int unique_handle_length= snprintf(unique_handle, GEARMAN_MAX_UNIQUE_SIZE, "%.*s",
  292. (int)(packet->arg_size[0]), (char *)(packet->arg[0]));
  293. if (unique_handle_length >= GEARMAN_MAX_UNIQUE_SIZE || unique_handle_length < 0)
  294. {
  295. gearmand_log_error(GEARMAN_DEFAULT_LOG_PARAM, "snprintf(%d)", unique_handle_length);
  296. return GEARMAND_MEMORY_ALLOCATION_FAILURE;
  297. }
  298. gearman_server_job_st *server_job= gearman_server_job_get_by_unique(Server,
  299. unique_handle, (size_t)unique_handle_length,
  300. NULL);
  301. gearmand_log_debug(GEARMAN_DEFAULT_LOG_PARAM, "Searching for unique job: \"%s\" found: %s clients:%d", unique_handle,
  302. server_job ? "yes" : "no",
  303. server_job ? server_job->client_count : 0);
  304. /* Queue status result packet. */
  305. if (server_job == NULL)
  306. {
  307. ret= gearman_server_io_packet_add(server_con, false,
  308. GEARMAN_MAGIC_RESPONSE,
  309. GEARMAN_COMMAND_STATUS_RES_UNIQUE,
  310. unique_handle, (size_t)(unique_handle_length +1), // Job Handle
  311. "0", (size_t)2, //
  312. "0", (size_t)2, //
  313. "0", (size_t)2, //
  314. "0", (size_t)2, //
  315. "0", (size_t)1, // client_count
  316. NULL);
  317. }
  318. else
  319. {
  320. char numerator_buffer[11]; /* Max string size to hold a uint32_t. */
  321. int numerator_buffer_length= snprintf(numerator_buffer, sizeof(numerator_buffer), "%u", server_job->numerator);
  322. if ((size_t)numerator_buffer_length >= sizeof(numerator_buffer) || numerator_buffer_length < 0)
  323. {
  324. gearmand_log_error(GEARMAN_DEFAULT_LOG_PARAM, "snprintf(%d)", numerator_buffer_length);
  325. return GEARMAND_MEMORY_ALLOCATION_FAILURE;
  326. }
  327. char denominator_buffer[11]; /* Max string size to hold a uint32_t. */
  328. int denominator_buffer_length= snprintf(denominator_buffer, sizeof(denominator_buffer), "%u", server_job->denominator);
  329. if ((size_t)denominator_buffer_length >= sizeof(denominator_buffer) || denominator_buffer_length < 0)
  330. {
  331. gearmand_log_error(GEARMAN_DEFAULT_LOG_PARAM, "snprintf(%d)", denominator_buffer_length);
  332. return GEARMAND_MEMORY_ALLOCATION_FAILURE;
  333. }
  334. char client_count_buffer[11]; /* Max string size to hold a uint32_t. */
  335. int client_count_buffer_length= snprintf(client_count_buffer, sizeof(client_count_buffer), "%u", server_job->client_count);
  336. if ((size_t)client_count_buffer_length >= sizeof(client_count_buffer) || client_count_buffer_length < 0)
  337. {
  338. gearmand_log_error(GEARMAN_DEFAULT_LOG_PARAM, "snprintf(%d)", client_count_buffer_length);
  339. return GEARMAND_MEMORY_ALLOCATION_FAILURE;
  340. }
  341. ret= gearman_server_io_packet_add(server_con, false,
  342. GEARMAN_MAGIC_RESPONSE,
  343. GEARMAN_COMMAND_STATUS_RES_UNIQUE,
  344. unique_handle, (size_t)(unique_handle_length +1), // unique_handle
  345. "1", (size_t)2, // is_known
  346. server_job->worker == NULL ? "0" : "1", (size_t)2, // is_running
  347. numerator_buffer, (size_t)(numerator_buffer_length +1), // numerator
  348. denominator_buffer, (size_t)(denominator_buffer_length +1), //denominator
  349. client_count_buffer, (size_t)(client_count_buffer_length), //client_count
  350. NULL);
  351. }
  352. if (ret != GEARMAND_SUCCESS)
  353. {
  354. gearmand_gerror("gearman_server_io_packet_add", ret);
  355. return ret;
  356. }
  357. }
  358. break;
  359. case GEARMAN_COMMAND_GET_STATUS:
  360. {
  361. char job_handle[GEARMAND_JOB_HANDLE_SIZE];
  362. /* This may not be NULL terminated, so copy to make sure it is. */
  363. int job_handle_length= snprintf(job_handle, GEARMAND_JOB_HANDLE_SIZE, "%.*s",
  364. (int)(packet->arg_size[0]), (char *)(packet->arg[0]));
  365. if (job_handle_length >= GEARMAND_JOB_HANDLE_SIZE || job_handle_length < 0)
  366. {
  367. gearmand_log_error(GEARMAN_DEFAULT_LOG_PARAM, "snprintf(%d)", job_handle_length);
  368. return GEARMAND_MEMORY_ALLOCATION_FAILURE;
  369. }
  370. gearman_server_job_st *server_job= gearman_server_job_get(Server,
  371. job_handle, (size_t)job_handle_length,
  372. NULL);
  373. /* Queue status result packet. */
  374. if (server_job == NULL)
  375. {
  376. gearmand_log_debug(GEARMAN_DEFAULT_LOG_PARAM,"status,%.*s,unknown,unknown,unknown,unknown",
  377. int(job_handle_length), job_handle);
  378. ret= gearman_server_io_packet_add(server_con, false,
  379. GEARMAN_MAGIC_RESPONSE,
  380. GEARMAN_COMMAND_STATUS_RES,
  381. job_handle, (size_t)(job_handle_length +1), // Job Handle
  382. "0", (size_t)2, //
  383. "0", (size_t)2, //
  384. "0", (size_t)2, //
  385. "0", (size_t)1, //
  386. NULL);
  387. }
  388. else
  389. {
  390. char numerator_buffer[11]; /* Max string size to hold a uint32_t. */
  391. int numerator_buffer_length= snprintf(numerator_buffer, sizeof(numerator_buffer), "%u", server_job->numerator);
  392. if ((size_t)numerator_buffer_length >= sizeof(numerator_buffer) || numerator_buffer_length < 0)
  393. {
  394. gearmand_log_error(GEARMAN_DEFAULT_LOG_PARAM, "snprintf(%d)", numerator_buffer_length);
  395. return GEARMAND_MEMORY_ALLOCATION_FAILURE;
  396. }
  397. char denominator_buffer[11]; /* Max string size to hold a uint32_t. */
  398. int denominator_buffer_length= snprintf(denominator_buffer, sizeof(denominator_buffer), "%u", server_job->denominator);
  399. if ((size_t)denominator_buffer_length >= sizeof(denominator_buffer) || denominator_buffer_length < 0)
  400. {
  401. gearmand_log_error(GEARMAN_DEFAULT_LOG_PARAM, "snprintf(%d)", denominator_buffer_length);
  402. return GEARMAND_MEMORY_ALLOCATION_FAILURE;
  403. }
  404. gearmand_log_debug(GEARMAN_DEFAULT_LOG_PARAM,"status,%.*s,known,%s,%.*s,%.*s",
  405. int(job_handle_length), job_handle,
  406. server_job->worker == NULL ? "quiet" : "running",
  407. int(numerator_buffer_length), numerator_buffer,
  408. int(denominator_buffer_length), denominator_buffer);
  409. ret= gearman_server_io_packet_add(server_con, false,
  410. GEARMAN_MAGIC_RESPONSE,
  411. GEARMAN_COMMAND_STATUS_RES,
  412. job_handle, (size_t)(job_handle_length +1),
  413. "1", (size_t)2,
  414. server_job->worker == NULL ? "0" : "1", (size_t)2,
  415. numerator_buffer, (size_t)(numerator_buffer_length +1),
  416. denominator_buffer, (size_t)(denominator_buffer_length),
  417. NULL);
  418. }
  419. if (ret != GEARMAND_SUCCESS)
  420. {
  421. gearmand_gerror("gearman_server_io_packet_add", ret);
  422. return ret;
  423. }
  424. }
  425. break;
  426. case GEARMAN_COMMAND_OPTION_REQ:
  427. {
  428. char option[GEARMAND_OPTION_SIZE];
  429. /* This may not be NULL terminated, so copy to make sure it is. */
  430. int option_length= snprintf(option, sizeof(option), "%.*s",
  431. (int)(packet->arg_size[0]), (char *)(packet->arg[0]));
  432. if (option_length >= GEARMAND_OPTION_SIZE || option_length < 0)
  433. {
  434. gearmand_log_error(GEARMAN_DEFAULT_LOG_PARAM, "snprintf(%d)", option_length);
  435. return _server_error_packet(server_con, GEARMAN_UNKNOWN_OPTION,
  436. "Server does not recognize given option");
  437. }
  438. if (strcasecmp(option, "exceptions") == 0)
  439. {
  440. gearmand_log_debug(GEARMAN_DEFAULT_LOG_PARAM, "'exceptions'");
  441. server_con->is_exceptions= true;
  442. }
  443. else
  444. {
  445. return _server_error_packet(server_con, GEARMAN_UNKNOWN_OPTION,
  446. "Server does not recognize given option");
  447. }
  448. ret= gearman_server_io_packet_add(server_con, false, GEARMAN_MAGIC_RESPONSE,
  449. GEARMAN_COMMAND_OPTION_RES,
  450. packet->arg[0], packet->arg_size[0],
  451. NULL);
  452. if (ret != GEARMAND_SUCCESS)
  453. {
  454. gearmand_gerror("gearman_server_io_packet_add", ret);
  455. return ret;
  456. }
  457. }
  458. break;
  459. /* Worker requests. */
  460. case GEARMAN_COMMAND_CAN_DO:
  461. gearmand_log_debug(GEARMAN_DEFAULT_LOG_PARAM, "Registering function: %.*s", packet->arg_size[0], packet->arg[0]);
  462. if (gearman_server_worker_add(server_con, (char *)(packet->arg[0]),
  463. packet->arg_size[0], 0) == NULL)
  464. {
  465. return GEARMAND_MEMORY_ALLOCATION_FAILURE;
  466. }
  467. break;
  468. case GEARMAN_COMMAND_CAN_DO_TIMEOUT:
  469. {
  470. if (packet->arg_size[1] > GEARMAN_MAXIMUM_INTEGER_DISPLAY_LENGTH)
  471. {
  472. return gearmand_log_gerror(GEARMAN_DEFAULT_LOG_PARAM, GEARMAND_INVALID_PACKET, "GEARMAND_INVALID_PACKET:strtol");
  473. }
  474. char strtol_buffer[GEARMAN_MAXIMUM_INTEGER_DISPLAY_LENGTH +1];
  475. memcpy(strtol_buffer, packet->arg[1], packet->arg_size[1]);
  476. strtol_buffer[packet->arg_size[1]]= 0;
  477. char *endptr;
  478. errno= 0;
  479. long timeout= strtol(strtol_buffer, &endptr, 10);
  480. if (timeout == LONG_MIN or timeout == LONG_MAX or errno != 0)
  481. {
  482. return gearmand_log_perror(GEARMAN_DEFAULT_LOG_PARAM, errno, "GEARMAN_COMMAND_CAN_DO_TIMEOUT:strtol");
  483. }
  484. gearmand_log_debug(GEARMAN_DEFAULT_LOG_PARAM, "Registering function: %.*s with timeout %dl",
  485. packet->arg_size[0], packet->arg[0], timeout);
  486. if (gearman_server_worker_add(server_con, (char *)(packet->arg[0]),
  487. packet->arg_size[0] - 1,
  488. timeout) == NULL)
  489. {
  490. return GEARMAND_MEMORY_ALLOCATION_FAILURE;
  491. }
  492. }
  493. break;
  494. case GEARMAN_COMMAND_CANT_DO:
  495. gearmand_log_debug(GEARMAN_DEFAULT_LOG_PARAM, "Removing function: %.*s", packet->arg_size[0], packet->arg[0]);
  496. gearman_server_con_free_worker(server_con, (char *)(packet->arg[0]),
  497. packet->arg_size[0]);
  498. break;
  499. case GEARMAN_COMMAND_RESET_ABILITIES:
  500. gearman_server_con_free_workers(server_con);
  501. break;
  502. case GEARMAN_COMMAND_PRE_SLEEP:
  503. {
  504. gearman_server_job_st *server_job= gearman_server_job_peek(server_con);
  505. if (server_job == NULL)
  506. {
  507. server_con->is_sleeping= true;
  508. /* Remove any timeouts while sleeping */
  509. gearman_server_con_delete_timeout(server_con);
  510. }
  511. else
  512. {
  513. /* If there are jobs that could be run, queue a NOOP packet to wake the
  514. worker up. This could be the result of a race codition. */
  515. ret= gearman_server_io_packet_add(server_con, false,
  516. GEARMAN_MAGIC_RESPONSE,
  517. GEARMAN_COMMAND_NOOP, NULL);
  518. if (ret != GEARMAND_SUCCESS)
  519. {
  520. gearmand_gerror("gearman_server_io_packet_add", ret);
  521. return ret;
  522. }
  523. }
  524. }
  525. break;
  526. case GEARMAN_COMMAND_GRAB_JOB:
  527. case GEARMAN_COMMAND_GRAB_JOB_UNIQ:
  528. case GEARMAN_COMMAND_GRAB_JOB_ALL:
  529. {
  530. server_con->is_sleeping= false;
  531. server_con->is_noop_sent= false;
  532. gearman_server_job_st *server_job= gearman_server_job_take(server_con);
  533. if (server_job == NULL)
  534. {
  535. /* No jobs found, queue no job packet. */
  536. ret= gearman_server_io_packet_add(server_con, false,
  537. GEARMAN_MAGIC_RESPONSE,
  538. GEARMAN_COMMAND_NO_JOB, NULL);
  539. }
  540. else if (packet->command == GEARMAN_COMMAND_GRAB_JOB_UNIQ)
  541. {
  542. /*
  543. We found a runnable job, queue job assigned packet and take the job off the queue.
  544. */
  545. ret= gearman_server_io_packet_add(server_con, false,
  546. GEARMAN_MAGIC_RESPONSE,
  547. GEARMAN_COMMAND_JOB_ASSIGN_UNIQ,
  548. server_job->job_handle, (size_t)(strlen(server_job->job_handle) + 1),
  549. server_job->function->function_name, server_job->function->function_name_size + 1,
  550. server_job->unique, (size_t)(server_job->unique_length + 1),
  551. server_job->data, server_job->data_size,
  552. NULL);
  553. }
  554. else if (packet->command == GEARMAN_COMMAND_GRAB_JOB_ALL and server_job->reducer)
  555. {
  556. gearmand_log_debug(GEARMAN_DEFAULT_LOG_PARAM,
  557. "Sending reduce submission, Partitioner: %.*s(%lu) Reducer: %.*s(%lu) Unique: %.*s(%lu) with data sized (%lu)" ,
  558. server_job->function->function_name_size, server_job->function->function_name, server_job->function->function_name_size,
  559. strlen(server_job->reducer), server_job->reducer, strlen(server_job->reducer),
  560. server_job->unique_length, server_job->unique, server_job->unique_length,
  561. (unsigned long)server_job->data_size);
  562. /*
  563. We found a runnable job, queue job assigned packet and take the job off the queue.
  564. */
  565. ret= gearman_server_io_packet_add(server_con, false,
  566. GEARMAN_MAGIC_RESPONSE,
  567. GEARMAN_COMMAND_JOB_ASSIGN_ALL,
  568. server_job->job_handle, (size_t)(strlen(server_job->job_handle) + 1),
  569. server_job->function->function_name, server_job->function->function_name_size + 1,
  570. server_job->unique, server_job->unique_length +1,
  571. server_job->reducer, (size_t)(strlen(server_job->reducer) +1),
  572. server_job->data, server_job->data_size,
  573. NULL);
  574. }
  575. else if (packet->command == GEARMAN_COMMAND_GRAB_JOB_ALL)
  576. {
  577. /*
  578. We found a runnable job, queue job assigned packet and take the job off the queue.
  579. */
  580. ret= gearman_server_io_packet_add(server_con, false,
  581. GEARMAN_MAGIC_RESPONSE,
  582. GEARMAN_COMMAND_JOB_ASSIGN_UNIQ,
  583. server_job->job_handle, (size_t)(strlen(server_job->job_handle) +1),
  584. server_job->function->function_name, server_job->function->function_name_size +1,
  585. server_job->unique, server_job->unique_length +1,
  586. server_job->data, server_job->data_size,
  587. NULL);
  588. }
  589. else
  590. {
  591. gearmand_log_debug(GEARMAN_DEFAULT_LOG_PARAM,
  592. "Sending GEARMAN_COMMAND_JOB_ASSIGN Function: %.*s(%lu) with data sized (%lu)" ,
  593. server_job->function->function_name_size, server_job->function->function_name, server_job->function->function_name_size,
  594. (unsigned long)server_job->data_size);
  595. /* Same, but without unique ID. */
  596. ret= gearman_server_io_packet_add(server_con, false,
  597. GEARMAN_MAGIC_RESPONSE,
  598. GEARMAN_COMMAND_JOB_ASSIGN,
  599. server_job->job_handle, (size_t)(strlen(server_job->job_handle) + 1),
  600. server_job->function->function_name, server_job->function->function_name_size + 1,
  601. server_job->data, server_job->data_size,
  602. NULL);
  603. }
  604. if (gearmand_failed(ret))
  605. {
  606. gearmand_gerror("gearman_server_io_packet_add", ret);
  607. if (server_job)
  608. {
  609. return gearman_server_job_queue(server_job);
  610. }
  611. return ret;
  612. }
  613. /* Since job is assigned, we should respect function timeout */
  614. if (server_job != NULL)
  615. {
  616. gearman_server_con_add_job_timeout(server_con, server_job);
  617. }
  618. }
  619. break;
  620. case GEARMAN_COMMAND_WORK_DATA:
  621. case GEARMAN_COMMAND_WORK_WARNING:
  622. {
  623. gearman_server_job_st *server_job= gearman_server_job_get(Server,
  624. (char *)(packet->arg[0]), (size_t)strlen(packet->arg[0]),
  625. server_con);
  626. if (server_job == NULL)
  627. {
  628. return _server_error_packet(server_con, GEARMAN_NO_JOBS,
  629. "Job given in work result not found");
  630. }
  631. /* Queue the data/warning packet for all clients. */
  632. ret= _server_queue_work_data(server_job, packet, packet->command);
  633. if (gearmand_failed(ret))
  634. {
  635. gearmand_gerror("_server_queue_work_data", ret);
  636. return ret;
  637. }
  638. }
  639. break;
  640. case GEARMAN_COMMAND_WORK_STATUS:
  641. {
  642. gearman_server_job_st *server_job= gearman_server_job_get(Server,
  643. (char *)(packet->arg[0]), (size_t)strlen(packet->arg[0]),
  644. server_con);
  645. if (server_job == NULL)
  646. {
  647. return _server_error_packet(server_con, GEARMAN_NO_JOBS,
  648. "Job given in work result not found");
  649. }
  650. /* Update job status. */
  651. server_job->numerator= (uint32_t)atoi((char *)(packet->arg[1]));
  652. /* This may not be NULL terminated, so copy to make sure it is. */
  653. char denominator_buffer[11]; /* Max string size to hold a uint32_t. */
  654. int denominator_buffer_length= snprintf(denominator_buffer, sizeof(denominator_buffer), "%.*s",
  655. (int)(packet->arg_size[2]),
  656. (char *)(packet->arg[2]));
  657. if ((size_t)denominator_buffer_length > sizeof(denominator_buffer) || denominator_buffer_length < 0)
  658. {
  659. gearmand_log_error(GEARMAN_DEFAULT_LOG_PARAM, "snprintf(%d)", denominator_buffer_length);
  660. return GEARMAND_MEMORY_ALLOCATION_FAILURE;
  661. }
  662. server_job->denominator= (uint32_t)atoi(denominator_buffer);
  663. /* Queue the status packet for all clients. */
  664. for (server_client= server_job->client_list; server_client;
  665. server_client= server_client->job_next)
  666. {
  667. ret= gearman_server_io_packet_add(server_client->con, false,
  668. GEARMAN_MAGIC_RESPONSE,
  669. GEARMAN_COMMAND_WORK_STATUS,
  670. packet->arg[0], packet->arg_size[0],
  671. packet->arg[1], packet->arg_size[1],
  672. packet->arg[2], packet->arg_size[2],
  673. NULL);
  674. if (gearmand_failed(ret))
  675. {
  676. gearmand_gerror("gearman_server_io_packet_add", ret);
  677. return ret;
  678. }
  679. }
  680. }
  681. break;
  682. case GEARMAN_COMMAND_WORK_COMPLETE:
  683. {
  684. gearman_server_job_st *server_job= gearman_server_job_get(Server,
  685. (char *)(packet->arg[0]), (size_t)strlen(packet->arg[0]),
  686. server_con);
  687. if (server_job == NULL)
  688. {
  689. return _server_error_packet(server_con, GEARMAN_NO_JOBS, "Job given in work result not found");
  690. }
  691. /* Queue the complete packet for all clients. */
  692. ret= _server_queue_work_data(server_job, packet,
  693. GEARMAN_COMMAND_WORK_COMPLETE);
  694. if (gearmand_failed(ret))
  695. {
  696. gearmand_gerror("_server_queue_work_data", ret);
  697. return ret;
  698. }
  699. /* Remove from persistent queue if one exists. */
  700. if (server_job->job_queued)
  701. {
  702. ret= gearman_queue_done(Server,
  703. server_job->unique,
  704. server_job->unique_length,
  705. server_job->function->function_name,
  706. server_job->function->function_name_size);
  707. if (gearmand_failed(ret))
  708. {
  709. gearmand_gerror("Remove from persistent queue", ret);
  710. return ret;
  711. }
  712. }
  713. /* Job is done, remove it. */
  714. gearman_server_job_free(server_job);
  715. }
  716. break;
  717. case GEARMAN_COMMAND_WORK_EXCEPTION:
  718. {
  719. gearman_server_job_st *server_job= gearman_server_job_get(Server,
  720. (char *)(packet->arg[0]), (size_t)strlen(packet->arg[0]),
  721. server_con);
  722. gearmand_log_debug(GEARMAN_DEFAULT_LOG_PARAM,
  723. "Exception being sent from: %.*s(%lu)",
  724. server_job->function->function_name_size, server_job->function->function_name, server_job->function->function_name_size);
  725. if (server_job == NULL)
  726. {
  727. return _server_error_packet(server_con, GEARMAN_NO_JOBS, "An exception was received for a job that does not exist");
  728. }
  729. /* Queue the exception packet for all clients. */
  730. ret= _server_queue_work_data(server_job, packet, GEARMAN_COMMAND_WORK_EXCEPTION);
  731. if (gearmand_failed(ret))
  732. {
  733. return gearmand_gerror("_server_queue_work_data", ret);
  734. }
  735. #if 0
  736. /* Remove from persistent queue if one exists. */
  737. if (server_job->job_queued)
  738. {
  739. ret= gearman_queue_done(Server,
  740. server_job->unique,
  741. server_job->unique_length,
  742. server_job->function->function_name,
  743. server_job->function->function_name_size);
  744. if (gearmand_failed(ret))
  745. {
  746. gearmand_gerror("Remove from persistent queue", ret);
  747. return ret;
  748. }
  749. }
  750. /* Job is done, remove it. */
  751. gearman_server_job_free(server_job);
  752. #endif
  753. }
  754. break;
  755. case GEARMAN_COMMAND_WORK_FAIL:
  756. {
  757. char job_handle[GEARMAND_JOB_HANDLE_SIZE];
  758. /* This may not be NULL terminated, so copy to make sure it is. */
  759. int job_handle_length= snprintf(job_handle, GEARMAND_JOB_HANDLE_SIZE, "%.*s",
  760. (int)(packet->arg_size[0]), (char *)(packet->arg[0]));
  761. if (job_handle_length >= GEARMAND_JOB_HANDLE_SIZE || job_handle_length < 0)
  762. {
  763. return _server_error_packet(server_con, GEARMAN_ARGUMENT_TOO_LARGE,
  764. "Error occured due to GEARMAND_JOB_HANDLE_SIZE being too small from snprintf");
  765. }
  766. gearman_server_job_st *server_job= gearman_server_job_get(Server, job_handle, (size_t)job_handle_length,
  767. server_con);
  768. if (server_job == NULL)
  769. {
  770. return _server_error_packet(server_con, GEARMAN_NO_JOBS,
  771. "Job given in work result not found");
  772. }
  773. /* Queue the fail packet for all clients. */
  774. for (server_client= server_job->client_list; server_client;
  775. server_client= server_client->job_next)
  776. {
  777. ret= gearman_server_io_packet_add(server_client->con, false,
  778. GEARMAN_MAGIC_RESPONSE,
  779. GEARMAN_COMMAND_WORK_FAIL,
  780. packet->arg[0], packet->arg_size[0],
  781. NULL);
  782. if (gearmand_failed(ret))
  783. {
  784. gearmand_gerror("gearman_server_io_packet_add", ret);
  785. return ret;
  786. }
  787. }
  788. /* Remove from persistent queue if one exists. */
  789. if (server_job->job_queued)
  790. {
  791. ret= gearman_queue_done(Server,
  792. server_job->unique,
  793. server_job->unique_length,
  794. server_job->function->function_name,
  795. server_job->function->function_name_size);
  796. if (gearmand_failed(ret))
  797. {
  798. gearmand_gerror("Remove from persistent queue", ret);
  799. return ret;
  800. }
  801. }
  802. /* Job is done, remove it. */
  803. gearman_server_job_free(server_job);
  804. }
  805. break;
  806. case GEARMAN_COMMAND_SET_CLIENT_ID:
  807. gearman_server_con_set_id(server_con, (char *)(packet->arg[0]),
  808. packet->arg_size[0]);
  809. break;
  810. case GEARMAN_COMMAND_TEXT:
  811. return server_run_text(server_con, packet);
  812. case GEARMAN_COMMAND_UNUSED:
  813. case GEARMAN_COMMAND_NOOP:
  814. case GEARMAN_COMMAND_JOB_CREATED:
  815. case GEARMAN_COMMAND_NO_JOB:
  816. case GEARMAN_COMMAND_JOB_ASSIGN:
  817. case GEARMAN_COMMAND_ECHO_RES:
  818. case GEARMAN_COMMAND_ERROR:
  819. case GEARMAN_COMMAND_STATUS_RES:
  820. case GEARMAN_COMMAND_ALL_YOURS:
  821. case GEARMAN_COMMAND_OPTION_RES:
  822. case GEARMAN_COMMAND_SUBMIT_JOB_SCHED:
  823. case GEARMAN_COMMAND_JOB_ASSIGN_UNIQ:
  824. case GEARMAN_COMMAND_JOB_ASSIGN_ALL:
  825. case GEARMAN_COMMAND_MAX:
  826. case GEARMAN_COMMAND_STATUS_RES_UNIQUE:
  827. default:
  828. return _server_error_packet(server_con, GEARMAN_INVALID_COMMAND, "Command not expected");
  829. }
  830. return GEARMAND_SUCCESS;
  831. }
  832. gearmand_error_t gearman_server_shutdown_graceful(gearman_server_st *server)
  833. {
  834. server->shutdown_graceful= true;
  835. if (server->job_count == 0)
  836. {
  837. return GEARMAND_SHUTDOWN;
  838. }
  839. return GEARMAND_SHUTDOWN_GRACEFUL;
  840. }
  841. static gearmand_error_t gearman_queue_replay(gearman_server_st& server)
  842. {
  843. assert(server.state.queue_startup == true);
  844. if (server.queue_version == QUEUE_VERSION_FUNCTION)
  845. {
  846. assert(server.queue.functions->_replay_fn);
  847. return (*(server.queue.functions->_replay_fn))(&server,
  848. (void *)server.queue.functions->_context,
  849. gearmand::queue::Context::replay_add,
  850. &server);
  851. }
  852. assert(server.queue.object);
  853. return server.queue.object->replay(&server);
  854. }
  855. gearmand_error_t gearman_server_queue_replay(gearman_server_st& server)
  856. {
  857. server.state.queue_startup= true;
  858. gearmand_error_t ret= gearman_queue_replay(server);
  859. assert(ret != GEARMAND_UNKNOWN_STATE);
  860. server.state.queue_startup= false;
  861. return ret;
  862. }
  863. void *gearman_server_queue_context(const gearman_server_st *server)
  864. {
  865. if (server->queue_version == QUEUE_VERSION_FUNCTION)
  866. {
  867. return (void *)server->queue.functions->_context;
  868. }
  869. return NULL;
  870. }
  871. namespace gearmand {
  872. namespace queue {
  873. gearmand_error_t Context::replay_add(gearman_server_st *server,
  874. void*, // context
  875. const char *unique, size_t unique_size,
  876. const char *function_name, size_t function_name_size,
  877. const void *data, size_t data_size,
  878. gearman_job_priority_t priority,
  879. int64_t when)
  880. {
  881. assert(server->state.queue_startup == true);
  882. gearmand_error_t ret= GEARMAND_UNKNOWN_STATE;
  883. (void)gearman_server_job_add(server,
  884. function_name, function_name_size,
  885. unique, unique_size,
  886. data, data_size, priority, NULL, &ret, when);
  887. if (gearmand_failed(ret))
  888. {
  889. gearmand_gerror("gearman_server_job_add", ret);
  890. }
  891. return ret;
  892. }
  893. } // namespace queue
  894. } // namespace gearmand
  895. /*
  896. * Private definitions
  897. */
  898. static gearmand_error_t
  899. _server_queue_work_data(gearman_server_job_st *server_job,
  900. gearmand_packet_st *packet, gearman_command_t command)
  901. {
  902. for (gearman_server_client_st* server_client= server_job->client_list; server_client;
  903. server_client= server_client->job_next)
  904. {
  905. if (command == GEARMAN_COMMAND_WORK_EXCEPTION and (server_client->con->is_exceptions == false))
  906. {
  907. gearmand_debug("Dropping GEARMAN_COMMAND_WORK_EXCEPTION");
  908. continue;
  909. }
  910. else if (command == GEARMAN_COMMAND_WORK_EXCEPTION)
  911. {
  912. gearmand_debug("Sending GEARMAN_COMMAND_WORK_EXCEPTION");
  913. }
  914. uint8_t *data;
  915. if (packet->data_size > 0)
  916. {
  917. if (packet->options.free_data and
  918. server_client->job_next == NULL)
  919. {
  920. data= (uint8_t *)(packet->data);
  921. packet->options.free_data= false;
  922. }
  923. else
  924. {
  925. data= (uint8_t *)realloc(NULL, packet->data_size);
  926. if (data == NULL)
  927. {
  928. return gearmand_perror(errno, "realloc");
  929. }
  930. memcpy(data, packet->data, packet->data_size);
  931. }
  932. }
  933. else
  934. {
  935. data= NULL;
  936. }
  937. gearmand_error_t ret= gearman_server_io_packet_add(server_client->con, true,
  938. GEARMAN_MAGIC_RESPONSE, command,
  939. packet->arg[0], packet->arg_size[0],
  940. data, packet->data_size, NULL);
  941. if (ret != GEARMAND_SUCCESS)
  942. {
  943. return gearmand_gerror("gearman_server_io_packet_add", ret);
  944. }
  945. }
  946. return GEARMAND_SUCCESS;
  947. }