First set of licensing changes
[mono.git] / mono / utils / mono-proclib.c
1 /*
2  * Copyright 2008-2011 Novell Inc
3  * Copyright 2011 Xamarin Inc
4  * Licensed under the MIT license. See LICENSE file in the project root for full license information.
5  */
6
7 #include "config.h"
8 #include "utils/mono-proclib.h"
9 #include "utils/mono-time.h"
10
11 #include <stdlib.h>
12 #include <stdio.h>
13 #include <string.h>
14 #include <fcntl.h>
15 #ifdef HAVE_UNISTD_H
16 #include <unistd.h>
17 #endif
18 #ifdef HAVE_SCHED_GETAFFINITY
19 #include <sched.h>
20 #endif
21
22 #ifdef HOST_WIN32
23 #include <windows.h>
24 #include <process.h>
25 #endif
26
27 #if defined(_POSIX_VERSION)
28 #include <sys/errno.h>
29 #include <sys/param.h>
30 #ifdef HAVE_SYS_TYPES_H
31 #include <sys/types.h>
32 #endif
33 #ifdef HAVE_SYS_SYSCTL_H
34 #include <sys/sysctl.h>
35 #endif
36 #include <sys/resource.h>
37 #endif
38 #if defined(__APPLE__) || defined(__FreeBSD__) || defined(__OpenBSD__) || defined(__NetBSD__)
39 #include <sys/proc.h>
40 #if defined(__APPLE__)
41 #include <mach/mach.h>
42 #endif
43 #ifdef HAVE_SYS_USER_H
44 #include <sys/user.h>
45 #endif
46 #ifdef HAVE_STRUCT_KINFO_PROC_KP_PROC
47 #    define kinfo_starttime_member kp_proc.p_starttime
48 #    define kinfo_pid_member kp_proc.p_pid
49 #    define kinfo_name_member kp_proc.p_comm
50 #elif defined(__OpenBSD__)
51 // Can not figure out how to get the proc's start time on OpenBSD
52 #    undef kinfo_starttime_member 
53 #    define kinfo_pid_member p_pid
54 #    define kinfo_name_member p_comm
55 #else
56 #define kinfo_starttime_member ki_start
57 #define kinfo_pid_member ki_pid
58 #define kinfo_name_member ki_comm
59 #endif
60 #define USE_SYSCTL 1
61 #endif
62
63 /**
64  * mono_process_list:
65  * @size: a pointer to a location where the size of the returned array is stored
66  *
67  * Return an array of pid values for the processes currently running on the system.
68  * The size of the array is stored in @size.
69  */
70 gpointer*
71 mono_process_list (int *size)
72 {
73 #if USE_SYSCTL
74         int res, i;
75 #ifdef KERN_PROC2
76         int mib [6];
77         size_t data_len = sizeof (struct kinfo_proc2) * 400;
78         struct kinfo_proc2 *processes = malloc (data_len);
79 #else
80         int mib [4];
81         size_t data_len = sizeof (struct kinfo_proc) * 16;
82         struct kinfo_proc *processes;
83         int limit = 8;
84 #endif /* KERN_PROC2 */
85         void **buf = NULL;
86
87         if (size)
88                 *size = 0;
89
90 #ifdef KERN_PROC2
91         if (!processes)
92                 return NULL;
93
94         mib [0] = CTL_KERN;
95         mib [1] = KERN_PROC2;
96         mib [2] = KERN_PROC_ALL;
97         mib [3] = 0;
98         mib [4] = sizeof(struct kinfo_proc2);
99         mib [5] = 400; /* XXX */
100
101         res = sysctl (mib, 6, processes, &data_len, NULL, 0);
102         if (res < 0) {
103                 free (processes);
104                 return NULL;
105         }
106 #else
107         processes = NULL;
108         while (limit) {
109                 mib [0] = CTL_KERN;
110                 mib [1] = KERN_PROC;
111                 mib [2] = KERN_PROC_ALL;
112                 mib [3] = 0;
113
114                 res = sysctl (mib, 4, NULL, &data_len, NULL, 0);
115                 if (res)
116                         return NULL;
117                 processes = (struct kinfo_proc *) malloc (data_len);
118                 res = sysctl (mib, 4, processes, &data_len, NULL, 0);
119                 if (res < 0) {
120                         free (processes);
121                         if (errno != ENOMEM)
122                                 return NULL;
123                         limit --;
124                 } else {
125                         break;
126                 }
127         }
128 #endif /* KERN_PROC2 */
129
130 #ifdef KERN_PROC2
131         res = data_len/sizeof (struct kinfo_proc2);
132 #else
133         res = data_len/sizeof (struct kinfo_proc);
134 #endif /* KERN_PROC2 */
135         buf = (void **) g_realloc (buf, res * sizeof (void*));
136         for (i = 0; i < res; ++i)
137                 buf [i] = GINT_TO_POINTER (processes [i].kinfo_pid_member);
138         free (processes);
139         if (size)
140                 *size = res;
141         return buf;
142 #elif defined(__HAIKU__)
143         /* FIXME: Add back the code from 9185fcc305e43428d0f40f3ee37c8a405d41c9ae */
144         g_assert_not_reached ();
145         return NULL;
146 #else
147         const char *name;
148         void **buf = NULL;
149         int count = 0;
150         int i = 0;
151         GDir *dir = g_dir_open ("/proc/", 0, NULL);
152         if (!dir) {
153                 if (size)
154                         *size = 0;
155                 return NULL;
156         }
157         while ((name = g_dir_read_name (dir))) {
158                 int pid;
159                 char *nend;
160                 pid = strtol (name, &nend, 10);
161                 if (pid <= 0 || nend == name || *nend)
162                         continue;
163                 if (i >= count) {
164                         if (!count)
165                                 count = 16;
166                         else
167                                 count *= 2;
168                         buf = (void **)g_realloc (buf, count * sizeof (void*));
169                 }
170                 buf [i++] = GINT_TO_POINTER (pid);
171         }
172         g_dir_close (dir);
173         if (size)
174                 *size = i;
175         return buf;
176 #endif
177 }
178
179 static G_GNUC_UNUSED char*
180 get_pid_status_item_buf (int pid, const char *item, char *rbuf, int blen, MonoProcessError *error)
181 {
182         char buf [256];
183         char *s;
184         FILE *f;
185         int len = strlen (item);
186
187         g_snprintf (buf, sizeof (buf), "/proc/%d/status", pid);
188         f = fopen (buf, "r");
189         if (!f) {
190                 if (error)
191                         *error = MONO_PROCESS_ERROR_NOT_FOUND;
192                 return NULL;
193         }
194         while ((s = fgets (buf, sizeof (buf), f))) {
195                 if (*item != *buf)
196                         continue;
197                 if (strncmp (buf, item, len))
198                         continue;
199                 s = buf + len;
200                 while (g_ascii_isspace (*s)) s++;
201                 if (*s++ != ':')
202                         continue;
203                 while (g_ascii_isspace (*s)) s++;
204                 fclose (f);
205                 len = strlen (s);
206                 strncpy (rbuf, s, MIN (len, blen));
207                 rbuf [MIN (len, blen) - 1] = 0;
208                 if (error)
209                         *error = MONO_PROCESS_ERROR_NONE;
210                 return rbuf;
211         }
212         fclose (f);
213         if (error)
214                 *error = MONO_PROCESS_ERROR_OTHER;
215         return NULL;
216 }
217
218 #if USE_SYSCTL
219
220 #ifdef KERN_PROC2
221 #define KINFO_PROC struct kinfo_proc2
222 #else
223 #define KINFO_PROC struct kinfo_proc
224 #endif
225
226 static gboolean
227 sysctl_kinfo_proc (gpointer pid, KINFO_PROC* processi)
228 {
229         int res;
230         size_t data_len = sizeof (KINFO_PROC);
231
232 #ifdef KERN_PROC2
233         int mib [6];
234         mib [0] = CTL_KERN;
235         mib [1] = KERN_PROC2;
236         mib [2] = KERN_PROC_PID;
237         mib [3] = GPOINTER_TO_UINT (pid);
238         mib [4] = sizeof(KINFO_PROC);
239         mib [5] = 400; /* XXX */
240
241         res = sysctl (mib, 6, processi, &data_len, NULL, 0);
242 #else
243         int mib [4];
244         mib [0] = CTL_KERN;
245         mib [1] = KERN_PROC;
246         mib [2] = KERN_PROC_PID;
247         mib [3] = GPOINTER_TO_UINT (pid);
248
249         res = sysctl (mib, 4, processi, &data_len, NULL, 0);
250 #endif /* KERN_PROC2 */
251
252         if (res < 0 || data_len != sizeof (KINFO_PROC))
253                 return FALSE;
254
255         return TRUE;
256 }
257 #endif /* USE_SYSCTL */
258
259 /**
260  * mono_process_get_name:
261  * @pid: pid of the process
262  * @buf: byte buffer where to store the name of the prcoess
263  * @len: size of the buffer @buf
264  *
265  * Return the name of the process identified by @pid, storing it
266  * inside @buf for a maximum of len bytes (including the terminating 0).
267  */
268 char*
269 mono_process_get_name (gpointer pid, char *buf, int len)
270 {
271 #if USE_SYSCTL
272         KINFO_PROC processi;
273
274         memset (buf, 0, len);
275
276         if (sysctl_kinfo_proc (pid, &processi))
277                 strncpy (buf, processi.kinfo_name_member, len - 1);
278
279         return buf;
280 #else
281         char fname [128];
282         FILE *file;
283         char *p;
284         int r;
285         sprintf (fname, "/proc/%d/cmdline", GPOINTER_TO_INT (pid));
286         buf [0] = 0;
287         file = fopen (fname, "r");
288         if (!file)
289                 return buf;
290         r = fread (buf, 1, len - 1, file);
291         fclose (file);
292         buf [r] = 0;
293         p = strrchr (buf, '/');
294         if (p)
295                 return p + 1;
296         if (r == 0) {
297                 return get_pid_status_item_buf (GPOINTER_TO_INT (pid), "Name", buf, len, NULL);
298         }
299         return buf;
300 #endif
301 }
302
303 void
304 mono_process_get_times (gpointer pid, gint64 *start_time, gint64 *user_time, gint64 *kernel_time)
305 {
306         if (user_time)
307                 *user_time = mono_process_get_data (pid, MONO_PROCESS_USER_TIME);
308
309         if (kernel_time)
310                 *kernel_time = mono_process_get_data (pid, MONO_PROCESS_SYSTEM_TIME);
311
312         if (start_time) {
313                 *start_time = 0;
314
315 #if USE_SYSCTL && defined(kinfo_starttime_member)
316                 {
317                         KINFO_PROC processi;
318
319                         if (sysctl_kinfo_proc (pid, &processi))
320                                 *start_time = mono_100ns_datetime_from_timeval (processi.kinfo_starttime_member);
321                 }
322 #endif
323
324                 if (*start_time == 0) {
325                         static guint64 boot_time = 0;
326                         if (!boot_time)
327                                 boot_time = mono_100ns_datetime () - ((guint64)mono_msec_ticks ()) * 10000;
328
329                         *start_time = boot_time + mono_process_get_data (pid, MONO_PROCESS_ELAPSED);
330                 }
331         }
332 }
333
334 /*
335  * /proc/pid/stat format:
336  * pid (cmdname) S 
337  *      [0] ppid pgid sid tty_nr tty_pgrp flags min_flt cmin_flt maj_flt cmaj_flt
338  *      [10] utime stime cutime cstime prio nice threads 0 start_time vsize
339  *      [20] rss rsslim start_code end_code start_stack esp eip pending blocked sigign
340  *      [30] sigcatch wchan 0 0 exit_signal cpu rt_prio policy
341  */
342
343 #define RET_ERROR(err) do {     \
344                 if (error) *error = (err);      \
345                 return 0;                       \
346         } while (0)
347
348 static gint64
349 get_process_stat_item (int pid, int pos, int sum, MonoProcessError *error)
350 {
351 #if defined(__APPLE__) 
352         double process_user_time = 0, process_system_time = 0;//, process_percent = 0;
353         task_t task;
354         struct task_basic_info t_info;
355         mach_msg_type_number_t t_info_count = TASK_BASIC_INFO_COUNT, th_count;
356         thread_array_t th_array;
357         size_t i;
358
359         if (pid == getpid ()) {
360                 /* task_for_pid () doesn't work on ios, even for the current process */
361                 task = mach_task_self ();
362         } else {
363                 if (task_for_pid (mach_task_self (), pid, &task) != KERN_SUCCESS)
364                         RET_ERROR (MONO_PROCESS_ERROR_NOT_FOUND);
365         }
366
367         if (task_info (task, TASK_BASIC_INFO, (task_info_t)&t_info, &t_info_count) != KERN_SUCCESS) {
368                 if (pid != getpid ())
369                         mach_port_deallocate (mach_task_self (), task);
370                 RET_ERROR (MONO_PROCESS_ERROR_OTHER);
371         }
372         
373         if (task_threads(task, &th_array, &th_count) != KERN_SUCCESS) {
374                 if (pid != getpid ())
375                         mach_port_deallocate (mach_task_self (), task);
376                 RET_ERROR (MONO_PROCESS_ERROR_OTHER);
377         }
378                 
379         for (i = 0; i < th_count; i++) {
380                 double thread_user_time, thread_system_time;//, thread_percent;
381                 
382                 struct thread_basic_info th_info;
383                 mach_msg_type_number_t th_info_count = THREAD_BASIC_INFO_COUNT;
384                 if (thread_info(th_array[i], THREAD_BASIC_INFO, (thread_info_t)&th_info, &th_info_count) == KERN_SUCCESS) {
385                         thread_user_time = th_info.user_time.seconds + th_info.user_time.microseconds / 1e6;
386                         thread_system_time = th_info.system_time.seconds + th_info.system_time.microseconds / 1e6;
387                         //thread_percent = (double)th_info.cpu_usage / TH_USAGE_SCALE;
388                         
389                         process_user_time += thread_user_time;
390                         process_system_time += thread_system_time;
391                         //process_percent += th_percent;
392                 }
393         }
394         
395         for (i = 0; i < th_count; i++)
396                 mach_port_deallocate(task, th_array[i]);
397
398         if (pid != getpid ())
399                 mach_port_deallocate (mach_task_self (), task);
400
401         process_user_time += t_info.user_time.seconds + t_info.user_time.microseconds / 1e6;
402         process_system_time += t_info.system_time.seconds + t_info.system_time.microseconds / 1e6;
403     
404         if (pos == 10 && sum == TRUE)
405                 return (gint64)((process_user_time + process_system_time) * 10000000);
406         else if (pos == 10)
407                 return (gint64)(process_user_time * 10000000);
408         else if (pos == 11)
409                 return (gint64)(process_system_time * 10000000);
410                 
411         return 0;
412 #else
413         char buf [512];
414         char *s, *end;
415         FILE *f;
416         int len, i;
417         gint64 value;
418
419         g_snprintf (buf, sizeof (buf), "/proc/%d/stat", pid);
420         f = fopen (buf, "r");
421         if (!f)
422                 RET_ERROR (MONO_PROCESS_ERROR_NOT_FOUND);
423         len = fread (buf, 1, sizeof (buf), f);
424         fclose (f);
425         if (len <= 0)
426                 RET_ERROR (MONO_PROCESS_ERROR_OTHER);
427         s = strchr (buf, ')');
428         if (!s)
429                 RET_ERROR (MONO_PROCESS_ERROR_OTHER);
430         s++;
431         while (g_ascii_isspace (*s)) s++;
432         if (!*s)
433                 RET_ERROR (MONO_PROCESS_ERROR_OTHER);
434         /* skip the status char */
435         while (*s && !g_ascii_isspace (*s)) s++;
436         if (!*s)
437                 RET_ERROR (MONO_PROCESS_ERROR_OTHER);
438         for (i = 0; i < pos; ++i) {
439                 while (g_ascii_isspace (*s)) s++;
440                 if (!*s)
441                         RET_ERROR (MONO_PROCESS_ERROR_OTHER);
442                 while (*s && !g_ascii_isspace (*s)) s++;
443                 if (!*s)
444                         RET_ERROR (MONO_PROCESS_ERROR_OTHER);
445         }
446         /* we are finally at the needed item */
447         value = strtoul (s, &end, 0);
448         /* add also the following value */
449         if (sum) {
450                 while (g_ascii_isspace (*s)) s++;
451                 if (!*s)
452                         RET_ERROR (MONO_PROCESS_ERROR_OTHER);
453                 value += strtoul (s, &end, 0);
454         }
455         if (error)
456                 *error = MONO_PROCESS_ERROR_NONE;
457         return value;
458 #endif
459 }
460
461 static int
462 get_user_hz (void)
463 {
464         static int user_hz = 0;
465         if (user_hz == 0) {
466 #ifdef _SC_CLK_TCK
467                 user_hz = sysconf (_SC_CLK_TCK);
468 #endif
469                 if (user_hz == 0)
470                         user_hz = 100;
471         }
472         return user_hz;
473 }
474
475 static gint64
476 get_process_stat_time (int pid, int pos, int sum, MonoProcessError *error)
477 {
478         gint64 val = get_process_stat_item (pid, pos, sum, error);
479 #if defined(__APPLE__)
480         return val;
481 #else
482         /* return 100ns ticks */
483         return (val * 10000000) / get_user_hz ();
484 #endif
485 }
486
487 static gint64
488 get_pid_status_item (int pid, const char *item, MonoProcessError *error, int multiplier)
489 {
490 #if defined(__APPLE__)
491         // ignore the multiplier
492         
493         gint64 ret;
494         task_t task;
495         struct task_basic_info t_info;
496         mach_msg_type_number_t th_count = TASK_BASIC_INFO_COUNT;
497
498         if (pid == getpid ()) {
499                 /* task_for_pid () doesn't work on ios, even for the current process */
500                 task = mach_task_self ();
501         } else {
502                 if (task_for_pid (mach_task_self (), pid, &task) != KERN_SUCCESS)
503                         RET_ERROR (MONO_PROCESS_ERROR_NOT_FOUND);
504         }
505         
506         if (task_info (task, TASK_BASIC_INFO, (task_info_t)&t_info, &th_count) != KERN_SUCCESS) {
507                 if (pid != getpid ())
508                         mach_port_deallocate (mach_task_self (), task);
509                 RET_ERROR (MONO_PROCESS_ERROR_OTHER);
510         }
511
512         if (strcmp (item, "VmRSS") == 0 || strcmp (item, "VmHWM") == 0 || strcmp (item, "VmData") == 0)
513                 ret = t_info.resident_size;
514         else if (strcmp (item, "VmSize") == 0 || strcmp (item, "VmPeak") == 0)
515                 ret = t_info.virtual_size;
516         else if (strcmp (item, "Threads") == 0)
517                 ret = th_count;
518         else
519                 ret = 0;
520
521         if (pid != getpid ())
522                 mach_port_deallocate (mach_task_self (), task);
523         
524         return ret;
525 #else
526         char buf [64];
527         char *s;
528
529         s = get_pid_status_item_buf (pid, item, buf, sizeof (buf), error);
530         if (s)
531                 return ((gint64) atol (s)) * multiplier;
532         return 0;
533 #endif
534 }
535
536 /**
537  * mono_process_get_data:
538  * @pid: pid of the process
539  * @data: description of data to return
540  *
541  * Return a data item of a process like user time, memory use etc,
542  * according to the @data argumet.
543  */
544 gint64
545 mono_process_get_data_with_error (gpointer pid, MonoProcessData data, MonoProcessError *error)
546 {
547         gint64 val;
548         int rpid = GPOINTER_TO_INT (pid);
549
550         if (error)
551                 *error = MONO_PROCESS_ERROR_OTHER;
552
553         switch (data) {
554         case MONO_PROCESS_NUM_THREADS:
555                 return get_pid_status_item (rpid, "Threads", error, 1);
556         case MONO_PROCESS_USER_TIME:
557                 return get_process_stat_time (rpid, 10, FALSE, error);
558         case MONO_PROCESS_SYSTEM_TIME:
559                 return get_process_stat_time (rpid, 11, FALSE, error);
560         case MONO_PROCESS_TOTAL_TIME:
561                 return get_process_stat_time (rpid, 10, TRUE, error);
562         case MONO_PROCESS_WORKING_SET:
563                 return get_pid_status_item (rpid, "VmRSS", error, 1024);
564         case MONO_PROCESS_WORKING_SET_PEAK:
565                 val = get_pid_status_item (rpid, "VmHWM", error, 1024);
566                 if (val == 0)
567                         val = get_pid_status_item (rpid, "VmRSS", error, 1024);
568                 return val;
569         case MONO_PROCESS_PRIVATE_BYTES:
570                 return get_pid_status_item (rpid, "VmData", error, 1024);
571         case MONO_PROCESS_VIRTUAL_BYTES:
572                 return get_pid_status_item (rpid, "VmSize", error, 1024);
573         case MONO_PROCESS_VIRTUAL_BYTES_PEAK:
574                 val = get_pid_status_item (rpid, "VmPeak", error, 1024);
575                 if (val == 0)
576                         val = get_pid_status_item (rpid, "VmSize", error, 1024);
577                 return val;
578         case MONO_PROCESS_FAULTS:
579                 return get_process_stat_item (rpid, 6, TRUE, error);
580         case MONO_PROCESS_ELAPSED:
581                 return get_process_stat_time (rpid, 18, FALSE, error);
582         case MONO_PROCESS_PPID:
583                 return get_process_stat_time (rpid, 0, FALSE, error);
584         case MONO_PROCESS_PAGED_BYTES:
585                 return get_pid_status_item (rpid, "VmSwap", error, 1024);
586
587                 /* Nothing yet */
588         case MONO_PROCESS_END:
589                 return 0;
590         }
591         return 0;
592 }
593
594 gint64
595 mono_process_get_data (gpointer pid, MonoProcessData data)
596 {
597         MonoProcessError error;
598         return mono_process_get_data_with_error (pid, data, &error);
599 }
600
601 int
602 mono_process_current_pid ()
603 {
604 #if defined(HAVE_UNISTD_H)
605         return (int) getpid ();
606 #elif defined(HOST_WIN32)
607         return (int) GetCurrentProcessId ();
608 #else
609 #error getpid
610 #endif
611 }
612
613 /**
614  * mono_cpu_count:
615  *
616  * Return the number of processors on the system.
617  */
618 int
619 mono_cpu_count (void)
620 {
621 #ifdef HOST_WIN32
622         SYSTEM_INFO info;
623         GetSystemInfo (&info);
624         return info.dwNumberOfProcessors;
625 #else
626 #ifdef PLATFORM_ANDROID
627         /* Android tries really hard to save power by powering off CPUs on SMP phones which
628          * means the normal way to query cpu count returns a wrong value with userspace API.
629          * Instead we use /sys entries to query the actual hardware CPU count.
630          */
631         int count = 0;
632         char buffer[8] = {'\0'};
633         int present = open ("/sys/devices/system/cpu/present", O_RDONLY);
634         /* Format of the /sys entry is a cpulist of indexes which in the case
635          * of present is always of the form "0-(n-1)" when there is more than
636          * 1 core, n being the number of CPU cores in the system. Otherwise
637          * the value is simply 0
638          */
639         if (present != -1 && read (present, (char*)buffer, sizeof (buffer)) > 3)
640                 count = strtol (((char*)buffer) + 2, NULL, 10);
641         if (present != -1)
642                 close (present);
643         if (count > 0)
644                 return count + 1;
645 #endif
646
647 #if defined(HOST_ARM) || defined (HOST_ARM64)
648
649 /*
650  * Recap from Alexander Köplinger <alex.koeplinger@outlook.com>:
651  *
652  * When we merged the change from PR #2722, we started seeing random failures on ARM in
653  * the MonoTests.System.Threading.ThreadPoolTests.SetAndGetMaxThreads and
654  * MonoTests.System.Threading.ManualResetEventSlimTests.Constructor_Defaults tests. Both
655  * of those tests are dealing with Environment.ProcessorCount to verify some implementation
656  * details.
657  *
658  * It turns out that on the Jetson TK1 board we use on public Jenkins and on ARM kernels
659  * in general, the value returned by sched_getaffinity (or _SC_NPROCESSORS_ONLN) doesn't
660  * contain CPUs/cores that are powered off for power saving reasons. This is contrary to
661  * what happens on x86, where even cores in deep-sleep state are returned [1], [2]. This
662  * means that we would get a processor count of 1 at one point in time and a higher value
663  * when load increases later on as the system wakes CPUs.
664  *
665  * Various runtime pieces like the threadpool and also user code however relies on the
666  * value returned by Environment.ProcessorCount e.g. for deciding how many parallel tasks
667  * to start, thereby limiting the performance when that code thinks we only have one CPU.
668  *
669  * Talking to a few people, this was the reason why we changed to _SC_NPROCESSORS_CONF in
670  * mono#1688 and why we added a special case for Android in mono@de3addc to get the "real"
671  * number of processors in the system.
672  *
673  * Because of those issues Android/Dalvik also switched from _ONLN to _SC_NPROCESSORS_CONF
674  * for the Java API Runtime.availableProcessors() too [3], citing:
675  * > Traditionally this returned the number currently online, but many mobile devices are
676  * able to take unused cores offline to save power, so releases newer than Android 4.2 (Jelly
677  * Bean) return the maximum number of cores that could be made available if there were no
678  * power or heat constraints.
679  *
680  * The problem with sticking to _SC_NPROCESSORS_CONF however is that it breaks down in
681  * constrained environments like Docker or with an explicit CPU affinity set by the Linux
682  * `taskset` command, They'd get a higher CPU count than can be used, start more threads etc.
683  * which results in unnecessary context switches and overloaded systems. That's why we need
684  * to respect sched_getaffinity.
685  *
686  * So while in an ideal world we would be able to rely on sched_getaffinity/_SC_NPROCESSORS_ONLN
687  * to return the number of theoretically available CPUs regardless of power saving measures
688  * everywhere, we can't do this on ARM.
689  *
690  * I think the pragmatic solution is the following:
691  * * use sched_getaffinity (+ fallback to _SC_NPROCESSORS_ONLN in case of error) on x86. This
692  * ensures we're inline with what OpenJDK [4] and CoreCLR [5] do
693  * * use _SC_NPROCESSORS_CONF exclusively on ARM (I think we could eventually even get rid of
694  * the PLATFORM_ANDROID special case)
695  *
696  * Helpful links:
697  *
698  * [1] https://sourceware.org/ml/libc-alpha/2013-07/msg00383.html
699  * [2] https://lists.01.org/pipermail/powertop/2012-September/000433.html
700  * [3] https://android.googlesource.com/platform/libcore/+/750dc634e56c58d1d04f6a138734ac2b772900b5%5E1..750dc634e56c58d1d04f6a138734ac2b772900b5/
701  * [4] https://bugs.openjdk.java.net/browse/JDK-6515172
702  * [5] https://github.com/dotnet/coreclr/blob/7058273693db2555f127ce16e6b0c5b40fb04867/src/pal/src/misc/sysinfo.cpp#L148
703  */
704
705 #ifdef _SC_NPROCESSORS_CONF
706         {
707                 int count = sysconf (_SC_NPROCESSORS_CONF);
708                 if (count > 0)
709                         return count;
710         }
711 #endif
712
713 #else
714
715 #ifdef HAVE_SCHED_GETAFFINITY
716         {
717                 cpu_set_t set;
718                 if (sched_getaffinity (mono_process_current_pid (), sizeof (set), &set) == 0)
719                         return CPU_COUNT (&set);
720         }
721 #endif
722 #ifdef _SC_NPROCESSORS_ONLN
723         {
724                 int count = sysconf (_SC_NPROCESSORS_ONLN);
725                 if (count > 0)
726                         return count;
727         }
728 #endif
729
730 #endif /* defined(HOST_ARM) || defined (HOST_ARM64) */
731
732 #ifdef USE_SYSCTL
733         {
734                 int count;
735                 int mib [2];
736                 size_t len = sizeof (int);
737                 mib [0] = CTL_HW;
738                 mib [1] = HW_NCPU;
739                 if (sysctl (mib, 2, &count, &len, NULL, 0) == 0)
740                         return count;
741         }
742 #endif
743 #endif /* HOST_WIN32 */
744         /* FIXME: warn */
745         return 1;
746 }
747
748 static void
749 get_cpu_times (int cpu_id, gint64 *user, gint64 *systemt, gint64 *irq, gint64 *sirq, gint64 *idle)
750 {
751         char buf [256];
752         char *s;
753         int hz = get_user_hz ();
754         guint64 user_ticks = 0, nice_ticks = 0, system_ticks = 0, idle_ticks = 0, irq_ticks = 0, sirq_ticks = 0;
755         FILE *f = fopen ("/proc/stat", "r");
756         if (!f)
757                 return;
758         if (cpu_id < 0)
759                 hz *= mono_cpu_count ();
760         while ((s = fgets (buf, sizeof (buf), f))) {
761                 char *data = NULL;
762                 if (cpu_id < 0 && strncmp (s, "cpu", 3) == 0 && g_ascii_isspace (s [3])) {
763                         data = s + 4;
764                 } else if (cpu_id >= 0 && strncmp (s, "cpu", 3) == 0 && strtol (s + 3, &data, 10) == cpu_id) {
765                         if (data == s + 3)
766                                 continue;
767                         data++;
768                 } else {
769                         continue;
770                 }
771                 
772                 user_ticks = strtoull (data, &data, 10);
773                 nice_ticks = strtoull (data, &data, 10);
774                 system_ticks = strtoull (data, &data, 10);
775                 idle_ticks = strtoull (data, &data, 10);
776                 /* iowait_ticks = strtoull (data, &data, 10); */
777                 irq_ticks = strtoull (data, &data, 10);
778                 sirq_ticks = strtoull (data, &data, 10);
779                 break;
780         }
781         fclose (f);
782
783         if (user)
784                 *user = (user_ticks + nice_ticks) * 10000000 / hz;
785         if (systemt)
786                 *systemt = (system_ticks) * 10000000 / hz;
787         if (irq)
788                 *irq = (irq_ticks) * 10000000 / hz;
789         if (sirq)
790                 *sirq = (sirq_ticks) * 10000000 / hz;
791         if (idle)
792                 *idle = (idle_ticks) * 10000000 / hz;
793 }
794
795 /**
796  * mono_cpu_get_data:
797  * @cpu_id: processor number or -1 to get a summary of all the processors
798  * @data: type of data to retrieve
799  *
800  * Get data about a processor on the system, like time spent in user space or idle time.
801  */
802 gint64
803 mono_cpu_get_data (int cpu_id, MonoCpuData data, MonoProcessError *error)
804 {
805         gint64 value = 0;
806
807         if (error)
808                 *error = MONO_PROCESS_ERROR_NONE;
809         switch (data) {
810         case MONO_CPU_USER_TIME:
811                 get_cpu_times (cpu_id, &value, NULL, NULL, NULL, NULL);
812                 break;
813         case MONO_CPU_PRIV_TIME:
814                 get_cpu_times (cpu_id, NULL, &value, NULL, NULL, NULL);
815                 break;
816         case MONO_CPU_INTR_TIME:
817                 get_cpu_times (cpu_id, NULL, NULL, &value, NULL, NULL);
818                 break;
819         case MONO_CPU_DCP_TIME:
820                 get_cpu_times (cpu_id, NULL, NULL, NULL, &value, NULL);
821                 break;
822         case MONO_CPU_IDLE_TIME:
823                 get_cpu_times (cpu_id, NULL, NULL, NULL, NULL, &value);
824                 break;
825
826         case MONO_CPU_END:
827                 /* Nothing yet */
828                 return 0;
829         }
830         return value;
831 }
832
833 int
834 mono_atexit (void (*func)(void))
835 {
836 #ifdef PLATFORM_ANDROID
837         /* Some versions of android libc doesn't define atexit () */
838         return 0;
839 #else
840         return atexit (func);
841 #endif
842 }
843
844 /*
845  * This function returns the cpu usage in percentage,
846  * normalized on the number of cores.
847  *
848  * Warning : the percentage returned can be > 100%. This
849  * might happens on systems like Android which, for
850  * battery and performance reasons, shut down cores and
851  * lie about the number of active cores.
852  */
853 gint32
854 mono_cpu_usage (MonoCpuUsageState *prev)
855 {
856         gint32 cpu_usage = 0;
857         gint64 cpu_total_time;
858         gint64 cpu_busy_time;
859
860 #ifndef HOST_WIN32
861         struct rusage resource_usage;
862         gint64 current_time;
863         gint64 kernel_time;
864         gint64 user_time;
865
866         if (getrusage (RUSAGE_SELF, &resource_usage) == -1) {
867                 g_error ("getrusage() failed, errno is %d (%s)\n", errno, strerror (errno));
868                 return -1;
869         }
870
871         current_time = mono_100ns_ticks ();
872         kernel_time = resource_usage.ru_stime.tv_sec * 1000 * 1000 * 10 + resource_usage.ru_stime.tv_usec * 10;
873         user_time = resource_usage.ru_utime.tv_sec * 1000 * 1000 * 10 + resource_usage.ru_utime.tv_usec * 10;
874
875         cpu_busy_time = (user_time - (prev ? prev->user_time : 0)) + (kernel_time - (prev ? prev->kernel_time : 0));
876         cpu_total_time = (current_time - (prev ? prev->current_time : 0)) * mono_cpu_count ();
877
878         if (prev) {
879                 prev->kernel_time = kernel_time;
880                 prev->user_time = user_time;
881                 prev->current_time = current_time;
882         }
883 #else
884         guint64 idle_time;
885         guint64 kernel_time;
886         guint64 user_time;
887
888         if (!GetSystemTimes ((FILETIME*) &idle_time, (FILETIME*) &kernel_time, (FILETIME*) &user_time)) {
889                 g_error ("GetSystemTimes() failed, error code is %d\n", GetLastError ());
890                 return -1;
891         }
892
893         cpu_total_time = (gint64)((user_time - (prev ? prev->user_time : 0)) + (kernel_time - (prev ? prev->kernel_time : 0)));
894         cpu_busy_time = (gint64)(cpu_total_time - (idle_time - (prev ? prev->idle_time : 0)));
895
896         if (prev) {
897                 prev->idle_time = idle_time;
898                 prev->kernel_time = kernel_time;
899                 prev->user_time = user_time;
900         }
901 #endif
902
903         if (cpu_total_time > 0 && cpu_busy_time > 0)
904                 cpu_usage = (gint32)(cpu_busy_time * 100 / cpu_total_time);
905
906         return cpu_usage;
907 }