4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 only,
8 * as published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License version 2 for more details (a copy is included
14 * in the LICENSE file that accompanied this code).
16 * You should have received a copy of the GNU General Public License
17 * version 2 along with this program; If not, see
18 * http://www.gnu.org/licenses/gpl-2.0.html
23 * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Use is subject to license terms.
26 * Copyright (c) 2011, 2014, Intel Corporation.
28 * Copyright 2017 Cray Inc, all rights reserved.
31 * Store PID->JobID mappings
34 #define DEBUG_SUBSYSTEM S_RPC
35 #include <linux/user_namespace.h>
36 #ifdef HAVE_UIDGID_HEADER
37 #include <linux/uidgid.h>
39 #include <linux/utsname.h>
41 #include <libcfs/libcfs.h>
42 #include <obd_support.h>
43 #include <obd_class.h>
44 #include <lustre_net.h>
46 static struct cfs_hash *jobid_hash;
47 static struct cfs_hash_ops jobid_hash_ops;
48 spinlock_t jobid_hash_lock;
50 #define RESCAN_INTERVAL 30
51 #define DELETE_INTERVAL 300
53 char obd_jobid_var[JOBSTATS_JOBID_VAR_MAX_LEN + 1] = JOBSTATS_DISABLE;
54 char obd_jobid_name[LUSTRE_JOBID_SIZE] = "%e.%u";
57 * Structure to store a single PID->JobID mapping
59 struct jobid_pid_map {
60 struct hlist_node jp_hash;
62 spinlock_t jp_lock; /* protects jp_jobid */
63 char jp_jobid[LUSTRE_JOBID_SIZE];
64 unsigned int jp_joblen;
70 * Get jobid of current process by reading the environment variable
71 * stored in between the "env_start" & "env_end" of task struct.
73 * If some job scheduler doesn't store jobid in the "env_start/end",
74 * then an upcall could be issued here to get the jobid by utilizing
75 * the userspace tools/API. Then, the jobid must be cached.
77 int jobid_get_from_environ(char *jobid_var, char *jobid, int *jobid_len)
82 rc = cfs_get_environ(jobid_var, jobid, jobid_len);
86 if (unlikely(rc == -EOVERFLOW && !printed)) {
87 /* For the PBS_JOBID and LOADL_STEP_ID keys (which are
88 * variable length strings instead of just numbers), it
89 * might make sense to keep the unique parts for JobID,
90 * instead of just returning an error. That means a
91 * larger temp buffer for cfs_get_environ(), then
92 * truncating the string at some separator to fit into
93 * the specified jobid_len. Fix later if needed. */
94 LCONSOLE_ERROR_MSG(0x16b,
95 "jobid: '%s' value too large (%d)\n",
96 obd_jobid_var, *jobid_len);
101 CDEBUG((rc == -ENOENT || rc == -EINVAL ||
102 rc == -EDEADLK) ? D_INFO : D_ERROR,
103 "jobid: get '%s' failed: rc = %d\n",
112 * jobid_should_free_item
114 * Each item is checked to see if it should be released
115 * Removed from hash table by caller
116 * Actually freed in jobid_put_locked
118 * Returns 1 if item is to be freed, 0 if it is to be kept
121 static int jobid_should_free_item(void *obj, void *data)
124 struct jobid_pid_map *pidmap = obj;
130 spin_lock(&pidmap->jp_lock);
133 else if (jobid[0] == '\0')
135 else if (ktime_get_real_seconds() - pidmap->jp_time > DELETE_INTERVAL)
137 else if (strcmp(pidmap->jp_jobid, jobid) == 0)
139 spin_unlock(&pidmap->jp_lock);
145 * jobid_name_is_valid
147 * Checks if the jobid is a Lustre process
149 * Returns true if jobid is valid
150 * Returns false if jobid looks like it's a Lustre process
152 static bool jobid_name_is_valid(char *jobid)
154 const char *const lustre_reserved[] = { "ll_ping", "ptlrpc",
155 "ldlm", "ll_sa", NULL };
158 if (jobid[0] == '\0')
161 for (i = 0; lustre_reserved[i] != NULL; i++) {
162 if (strncmp(jobid, lustre_reserved[i],
163 strlen(lustre_reserved[i])) == 0)
170 * jobid_get_from_cache()
172 * Returns contents of jobid_var from process environment for current PID.
173 * This will be cached for some time to avoid overhead scanning environment.
175 * Return: -ENOMEM if allocating a new pidmap fails
176 * -ENOENT if no entry could be found
177 * +ve string length for success (something was returned in jobid)
179 static int jobid_get_from_cache(char *jobid, size_t joblen)
181 static time64_t last_expire;
182 bool expire_cache = false;
183 pid_t pid = current_pid();
184 struct jobid_pid_map *pidmap = NULL;
185 time64_t now = ktime_get_real_seconds();
189 LASSERT(jobid_hash != NULL);
191 /* scan hash periodically to remove old PID entries from cache */
192 spin_lock(&jobid_hash_lock);
193 if (unlikely(last_expire + DELETE_INTERVAL <= now)) {
197 spin_unlock(&jobid_hash_lock);
200 cfs_hash_cond_del(jobid_hash, jobid_should_free_item,
201 "intentionally_bad_jobid");
203 /* first try to find PID in the hash and use that value */
204 pidmap = cfs_hash_lookup(jobid_hash, &pid);
205 if (pidmap == NULL) {
206 struct jobid_pid_map *pidmap2;
208 OBD_ALLOC_PTR(pidmap);
210 GOTO(out, rc = -ENOMEM);
212 pidmap->jp_pid = pid;
214 pidmap->jp_jobid[0] = '\0';
215 spin_lock_init(&pidmap->jp_lock);
216 INIT_HLIST_NODE(&pidmap->jp_hash);
219 * Add the newly created map to the hash, on key collision we
220 * lost a racing addition and must destroy our newly allocated
221 * map. The object which exists in the hash will be returned.
223 pidmap2 = cfs_hash_findadd_unique(jobid_hash, &pid,
225 if (unlikely(pidmap != pidmap2)) {
226 CDEBUG(D_INFO, "jobid: duplicate found for PID=%u\n",
228 OBD_FREE_PTR(pidmap);
231 cfs_hash_get(jobid_hash, &pidmap->jp_hash);
236 * If pidmap is old (this is always true for new entries) refresh it.
237 * If obd_jobid_var is not found, cache empty entry and try again
238 * later, to avoid repeat lookups for PID if obd_jobid_var missing.
240 spin_lock(&pidmap->jp_lock);
241 if (pidmap->jp_time + RESCAN_INTERVAL <= now) {
242 char env_jobid[LUSTRE_JOBID_SIZE] = "";
243 int env_len = sizeof(env_jobid);
245 pidmap->jp_time = now;
247 spin_unlock(&pidmap->jp_lock);
248 rc = jobid_get_from_environ(obd_jobid_var, env_jobid, &env_len);
250 CDEBUG(D_INFO, "jobid: PID mapping established: %d->%s\n",
251 pidmap->jp_pid, env_jobid);
252 spin_lock(&pidmap->jp_lock);
254 pidmap->jp_joblen = env_len;
255 strlcpy(pidmap->jp_jobid, env_jobid,
256 sizeof(pidmap->jp_jobid));
258 } else if (rc == -ENOENT) {
259 /* It might have been deleted, clear out old entry */
260 pidmap->jp_joblen = 0;
261 pidmap->jp_jobid[0] = '\0';
266 * Regardless of how pidmap was found, if it contains a valid entry
267 * use that for now. If there was a technical error (e.g. -ENOMEM)
268 * use the old cached value until it can be looked up again properly.
269 * If a cached missing entry was found, return -ENOENT.
271 if (pidmap->jp_joblen) {
272 strlcpy(jobid, pidmap->jp_jobid, joblen);
273 joblen = pidmap->jp_joblen;
278 spin_unlock(&pidmap->jp_lock);
280 cfs_hash_put(jobid_hash, &pidmap->jp_hash);
284 return rc < 0 ? rc : joblen;
288 * jobid_interpret_string()
290 * Interpret the jobfmt string to expand specified fields, like coredumps do:
294 * %j = jobid from environment
298 * Unknown escape strings are dropped. Other characters are copied through,
299 * excluding whitespace (to avoid making jobid parsing difficult).
301 * Return: -EOVERFLOW if the expanded string does not fit within @joblen
304 static int jobid_interpret_string(const char *jobfmt, char *jobid,
309 while ((c = *jobfmt++) && joblen > 1) {
313 if (isspace(c)) /* Don't allow embedded spaces */
323 switch ((f = *jobfmt++)) {
324 case 'e': /* executable name */
325 l = snprintf(jobid, joblen, "%s", current_comm());
327 case 'g': /* group ID */
328 l = snprintf(jobid, joblen, "%u",
329 from_kgid(&init_user_ns, current_fsgid()));
331 case 'h': /* hostname */
332 l = snprintf(jobid, joblen, "%s",
333 init_utsname()->nodename);
335 case 'j': /* jobid stored in process environment */
336 l = jobid_get_from_cache(jobid, joblen);
340 case 'p': /* process ID */
341 l = snprintf(jobid, joblen, "%u", current_pid());
343 case 'u': /* user ID */
344 l = snprintf(jobid, joblen, "%u",
345 from_kuid(&init_user_ns, current_fsuid()));
347 case '\0': /* '%' at end of format string */
350 default: /* drop unknown %x format strings */
358 * This points at the end of the buffer, so long as jobid is always
359 * incremented the same amount as joblen is decremented.
362 jobid[joblen - 1] = '\0';
364 return joblen < 0 ? -EOVERFLOW : 0;
368 * Hash initialization, copied from server-side job stats bucket sizes
370 #define HASH_JOBID_BKT_BITS 5
371 #define HASH_JOBID_CUR_BITS 7
372 #define HASH_JOBID_MAX_BITS 12
374 int jobid_cache_init(void)
382 spin_lock_init(&jobid_hash_lock);
383 jobid_hash = cfs_hash_create("JOBID_HASH", HASH_JOBID_CUR_BITS,
384 HASH_JOBID_MAX_BITS, HASH_JOBID_BKT_BITS,
385 0, CFS_HASH_MIN_THETA, CFS_HASH_MAX_THETA,
386 &jobid_hash_ops, CFS_HASH_DEFAULT);
392 EXPORT_SYMBOL(jobid_cache_init);
394 void jobid_cache_fini(void)
396 struct cfs_hash *tmp_hash;
399 spin_lock(&jobid_hash_lock);
400 tmp_hash = jobid_hash;
402 spin_unlock(&jobid_hash_lock);
404 if (tmp_hash != NULL) {
405 cfs_hash_cond_del(tmp_hash, jobid_should_free_item, NULL);
406 cfs_hash_putref(tmp_hash);
411 EXPORT_SYMBOL(jobid_cache_fini);
414 * Hash operations for pid<->jobid
416 static unsigned jobid_hashfn(struct cfs_hash *hs, const void *key,
419 return cfs_hash_djb2_hash(key, sizeof(pid_t), mask);
422 static void *jobid_key(struct hlist_node *hnode)
424 struct jobid_pid_map *pidmap;
426 pidmap = hlist_entry(hnode, struct jobid_pid_map, jp_hash);
427 return &pidmap->jp_pid;
430 static int jobid_keycmp(const void *key, struct hlist_node *hnode)
432 const pid_t *pid_key1;
433 const pid_t *pid_key2;
435 LASSERT(key != NULL);
436 pid_key1 = (pid_t *)key;
437 pid_key2 = (pid_t *)jobid_key(hnode);
439 return *pid_key1 == *pid_key2;
442 static void *jobid_object(struct hlist_node *hnode)
444 return hlist_entry(hnode, struct jobid_pid_map, jp_hash);
447 static void jobid_get(struct cfs_hash *hs, struct hlist_node *hnode)
449 struct jobid_pid_map *pidmap;
451 pidmap = hlist_entry(hnode, struct jobid_pid_map, jp_hash);
453 atomic_inc(&pidmap->jp_refcount);
456 static void jobid_put_locked(struct cfs_hash *hs, struct hlist_node *hnode)
458 struct jobid_pid_map *pidmap;
463 pidmap = hlist_entry(hnode, struct jobid_pid_map, jp_hash);
464 LASSERT(atomic_read(&pidmap->jp_refcount) > 0);
465 if (atomic_dec_and_test(&pidmap->jp_refcount)) {
466 CDEBUG(D_INFO, "Freeing: %d->%s\n",
467 pidmap->jp_pid, pidmap->jp_jobid);
469 OBD_FREE_PTR(pidmap);
473 static struct cfs_hash_ops jobid_hash_ops = {
474 .hs_hash = jobid_hashfn,
475 .hs_keycmp = jobid_keycmp,
477 .hs_object = jobid_object,
479 .hs_put = jobid_put_locked,
480 .hs_put_locked = jobid_put_locked,
484 * Generate the job identifier string for this process for tracking purposes.
486 * Fill in @jobid string based on the value of obd_jobid_var:
487 * JOBSTATS_DISABLE: none
488 * JOBSTATS_NODELOCAL: content of obd_jobid_node (jobid_interpret_string())
489 * JOBSTATS_PROCNAME_UID: process name/UID
490 * anything else: look up obd_jobid_var in the processes environment
492 * Return -ve error number, 0 on success.
494 int lustre_get_jobid(char *jobid, size_t joblen)
499 if (unlikely(joblen < 2)) {
505 if (strcmp(obd_jobid_var, JOBSTATS_DISABLE) == 0) {
506 /* Jobstats isn't enabled */
507 memset(jobid, 0, joblen);
508 } else if (strcmp(obd_jobid_var, JOBSTATS_NODELOCAL) == 0) {
509 /* Whole node dedicated to single job */
510 rc = jobid_interpret_string(obd_jobid_name, jobid, joblen);
511 } else if (strcmp(obd_jobid_var, JOBSTATS_PROCNAME_UID) == 0) {
512 rc = jobid_interpret_string("%e.%u", jobid, joblen);
513 } else if (jobid_name_is_valid(current_comm())) {
515 * obd_jobid_var holds the jobid environment variable name.
516 * Skip initial check if obd_jobid_name already uses "%j",
517 * otherwise try just "%j" first, then fall back to whatever
518 * is in obd_jobid_name if obd_jobid_var is not found.
521 if (!strnstr(obd_jobid_name, "%j", joblen))
522 rc = jobid_get_from_cache(jobid, joblen);
524 /* fall back to jobid_node if jobid_var not in environment */
526 int rc2 = jobid_interpret_string(obd_jobid_name,
535 EXPORT_SYMBOL(lustre_get_jobid);
540 * Search cache for JobID given by @find_jobid.
541 * If any entries in the hash table match the value, they are removed
543 void lustre_jobid_clear(const char *find_jobid)
545 char jobid[LUSTRE_JOBID_SIZE];
548 if (jobid_hash == NULL)
551 strlcpy(jobid, find_jobid, sizeof(jobid));
552 /* trim \n off the end of the incoming jobid */
553 end = strchr(jobid, '\n');
554 if (end && *end == '\n')
557 CDEBUG(D_INFO, "Clearing Jobid: %s\n", jobid);
558 cfs_hash_cond_del(jobid_hash, jobid_should_free_item, jobid);
560 CDEBUG(D_INFO, "%d items remain in jobID table\n",
561 atomic_read(&jobid_hash->hs_count));