-
Notifications
You must be signed in to change notification settings - Fork 243
Expand file tree
/
Copy pathprocess.rbs
More file actions
2244 lines (2121 loc) · 74.3 KB
/
process.rbs
File metadata and controls
2244 lines (2121 loc) · 74.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# <!-- rdoc-file=process.c -->
# Module `Process` represents a process in the underlying operating system. Its
# methods support management of the current process and its child processes.
#
# ## Process Creation
#
# Each of the following methods executes a given command in a new process or
# subshell, or multiple commands in new processes and/or subshells. The choice
# of process or subshell depends on the form of the command; see [Argument
# command_line or exe_path](rdoc-ref:Process@Argument+command_line+or+exe_path).
#
# * Process.spawn, Kernel#spawn: Executes the command; returns the new pid
# without waiting for completion.
# * Process.exec: Replaces the current process by executing the command.
#
#
# In addition:
#
# * Method Kernel#system executes a given command-line (string) in a subshell;
# returns `true`, `false`, or `nil`.
# * Method Kernel#` executes a given command-line (string) in a subshell;
# returns its $stdout string.
# * Module Open3 supports creating child processes with access to their
# $stdin, $stdout, and $stderr streams.
#
#
# ### Execution Environment
#
# Optional leading argument `env` is a hash of name/value pairs, where each name
# is a string and each value is a string or `nil`; each name/value pair is added
# to ENV in the new process.
#
# Process.spawn( 'ruby -e "p ENV[\"Foo\"]"')
# Process.spawn({'Foo' => '0'}, 'ruby -e "p ENV[\"Foo\"]"')
#
# Output:
#
# "0"
#
# The effect is usually similar to that of calling ENV#update with argument
# `env`, where each named environment variable is created or updated (if the
# value is non-`nil`), or deleted (if the value is `nil`).
#
# However, some modifications to the calling process may remain if the new
# process fails. For example, hard resource limits are not restored.
#
# ### Argument `command_line` or `exe_path`
#
# The required string argument is one of the following:
#
# * `command_line` if it begins with a shell reserved word or special
# built-in, or if it contains one or more meta characters.
# * `exe_path` otherwise.
#
#
# **Argument `command_line`**
#
# String argument `command_line` is a command line to be passed to a shell; it
# must begin with a shell reserved word, begin with a special built-in, or
# contain meta characters:
#
# system('if true; then echo "Foo"; fi') # => true # Shell reserved word.
# system('echo') # => true # Built-in.
# system('date > /tmp/date.tmp') # => true # Contains meta character.
# system('date > /nop/date.tmp') # => false
# system('date > /nop/date.tmp', exception: true) # Raises RuntimeError.
#
# The command line may also contain arguments and options for the command:
#
# system('echo "Foo"') # => true
#
# Output:
#
# Foo
#
# See [Execution Shell](rdoc-ref:Process@Execution+Shell) for details about the
# shell.
#
# **Argument `exe_path`**
#
# Argument `exe_path` is one of the following:
#
# * The string path to an executable to be called.
# * A 2-element array containing the path to an executable to be called, and
# the string to be used as the name of the executing process.
#
#
# Example:
#
# system('/usr/bin/date') # => true # Path to date on Unix-style system.
# system('foo') # => nil # Command failed.
#
# Output:
#
# Mon Aug 28 11:43:10 AM CDT 2023
#
# ### Execution Options
#
# Optional trailing argument `options` is a hash of execution options.
#
# #### Working Directory (`:chdir`)
#
# By default, the working directory for the new process is the same as that of
# the current process:
#
# Dir.chdir('/var')
# Process.spawn('ruby -e "puts Dir.pwd"')
#
# Output:
#
# /var
#
# Use option `:chdir` to set the working directory for the new process:
#
# Process.spawn('ruby -e "puts Dir.pwd"', {chdir: '/tmp'})
#
# Output:
#
# /tmp
#
# The working directory of the current process is not changed:
#
# Dir.pwd # => "/var"
#
# #### File Redirection (File Descriptor)
#
# Use execution options for file redirection in the new process.
#
# The key for such an option may be an integer file descriptor (fd), specifying
# a source, or an array of fds, specifying multiple sources.
#
# An integer source fd may be specified as:
#
# * *n*: Specifies file descriptor *n*.
#
#
# There are these shorthand symbols for fds:
#
# * `:in`: Specifies file descriptor 0 (STDIN).
# * `:out`: Specifies file descriptor 1 (STDOUT).
# * `:err`: Specifies file descriptor 2 (STDERR).
#
#
# The value given with a source is one of:
#
# * *n*: Redirects to fd *n* in the parent process.
# * `filepath`: Redirects from or to the file at `filepath` via
# `open(filepath, mode, 0644)`, where `mode` is `'r'` for source `:in`, or
# `'w'` for source `:out` or `:err`.
# * `[filepath]`: Redirects from the file at `filepath` via `open(filepath,
# 'r', 0644)`.
# * `[filepath, mode]`: Redirects from or to the file at `filepath` via
# `open(filepath, mode, 0644)`.
# * `[filepath, mode, perm]`: Redirects from or to the file at `filepath` via
# `open(filepath, mode, perm)`.
# * `[:child, fd]`: Redirects to the redirected `fd`.
# * `:close`: Closes the file descriptor in child process.
#
#
# See [Access Modes](rdoc-ref:File@Access+Modes) and [File
# Permissions](rdoc-ref:File@File+Permissions).
#
# #### Environment Variables (`:unsetenv_others`)
#
# By default, the new process inherits environment variables from the parent
# process; use execution option key `:unsetenv_others` with value `true` to
# clear environment variables in the new process.
#
# Any changes specified by execution option `env` are made after the new process
# inherits or clears its environment variables; see [Execution
# Environment](rdoc-ref:Process@Execution+Environment).
#
# #### File-Creation Access (`:umask`)
#
# Use execution option `:umask` to set the file-creation access for the new
# process; see [Access Modes](rdoc-ref:File@Access+Modes):
#
# command = 'ruby -e "puts sprintf(\"0%o\", File.umask)"'
# options = {:umask => 0644}
# Process.spawn(command, options)
#
# Output:
#
# 0644
#
# #### Process Groups (`:pgroup` and `:new_pgroup`)
#
# By default, the new process belongs to the same [process
# group](https://en.wikipedia.org/wiki/Process_group) as the parent process.
#
# To specify a different process group. use execution option `:pgroup` with one
# of the following values:
#
# * `true`: Create a new process group for the new process.
# * *pgid*: Create the new process in the process group whose id is *pgid*.
#
#
# On Windows only, use execution option `:new_pgroup` with value `true` to
# create a new process group for the new process.
#
# #### Resource Limits
#
# Use execution options to set resource limits.
#
# The keys for these options are symbols of the form `:rlimit_*resource_name`*,
# where *resource_name* is the downcased form of one of the string resource
# names described at method Process.setrlimit. For example, key `:rlimit_cpu`
# corresponds to resource limit `'CPU'`.
#
# The value for such as key is one of:
#
# * An integer, specifying both the current and maximum limits.
# * A 2-element array of integers, specifying the current and maximum limits.
#
#
# #### File Descriptor Inheritance
#
# By default, the new process inherits file descriptors from the parent process.
#
# Use execution option `:close_others => true` to modify that inheritance by
# closing non-standard fds (3 and greater) that are not otherwise redirected.
#
# ### Execution Shell
#
# On a Unix-like system, the shell invoked is `/bin/sh`; otherwise the shell
# invoked is determined by environment variable `ENV['RUBYSHELL']`, if defined,
# or `ENV['COMSPEC']` otherwise.
#
# Except for the `COMSPEC` case, the entire string `command_line` is passed as
# an argument to [shell option
# -c](https://pubs.opengroup.org/onlinepubs/9699919799.2018edition/utilities/sh.
# html).
#
# The shell performs normal shell expansion on the command line:
#
# spawn('echo C*') # => 799139
# Process.wait # => 799139
#
# Output:
#
# CONTRIBUTING.md COPYING COPYING.ja
#
# ## What's Here
#
# ### Current-Process Getters
#
# * ::argv0: Returns the process name as a frozen string.
# * ::egid: Returns the effective group ID.
# * ::euid: Returns the effective user ID.
# * ::getpgrp: Return the process group ID.
# * ::getrlimit: Returns the resource limit.
# * ::gid: Returns the (real) group ID.
# * ::pid: Returns the process ID.
# * ::ppid: Returns the process ID of the parent process.
# * ::uid: Returns the (real) user ID.
#
#
# ### Current-Process Setters
#
# * ::egid=: Sets the effective group ID.
# * ::euid=: Sets the effective user ID.
# * ::gid=: Sets the (real) group ID.
# * ::setproctitle: Sets the process title.
# * ::setpgrp: Sets the process group ID of the process to zero.
# * ::setrlimit: Sets a resource limit.
# * ::setsid: Establishes the process as a new session and process group
# leader, with no controlling tty.
# * ::uid=: Sets the user ID.
#
#
# ### Current-Process Execution
#
# * ::abort: Immediately terminates the process.
# * ::daemon: Detaches the process from its controlling terminal and continues
# running it in the background as system daemon.
# * ::exec: Replaces the process by running a given external command.
# * ::exit: Initiates process termination by raising exception SystemExit
# (which may be caught).
# * ::exit!: Immediately exits the process.
# * ::warmup: Notifies the Ruby virtual machine that the boot sequence for the
# application is completed, and that the VM may begin optimizing the
# application.
#
#
# ### Child Processes
#
# * ::detach: Guards against a child process becoming a zombie.
# * ::fork: Creates a child process.
# * ::kill: Sends a given signal to processes.
# * ::spawn: Creates a child process.
# * ::wait, ::waitpid: Waits for a child process to exit; returns its process
# ID.
# * ::wait2, ::waitpid2: Waits for a child process to exit; returns its
# process ID and status.
# * ::waitall: Waits for all child processes to exit; returns their process
# IDs and statuses.
#
#
# ### Process Groups
#
# * ::getpgid: Returns the process group ID for a process.
# * ::getpriority: Returns the scheduling priority for a process, process
# group, or user.
# * ::getsid: Returns the session ID for a process.
# * ::groups: Returns an array of the group IDs in the supplemental group
# access list for this process.
# * ::groups=: Sets the supplemental group access list to the given array of
# group IDs.
# * ::initgroups: Initializes the supplemental group access list.
# * ::last_status: Returns the status of the last executed child process in
# the current thread.
# * ::maxgroups: Returns the maximum number of group IDs allowed in the
# supplemental group access list.
# * ::maxgroups=: Sets the maximum number of group IDs allowed in the
# supplemental group access list.
# * ::setpgid: Sets the process group ID of a process.
# * ::setpriority: Sets the scheduling priority for a process, process group,
# or user.
#
#
# ### Timing
#
# * ::clock_getres: Returns the resolution of a system clock.
# * ::clock_gettime: Returns the time from a system clock.
# * ::times: Returns a Process::Tms object containing times for the current
# process and its child processes.
#
module Process
# <!--
# rdoc-file=process.c
# - Process._fork -> integer
# -->
# An internal API for fork. Do not call this method directly. Currently, this is
# called via Kernel#fork, Process.fork, and IO.popen with `"-"`.
#
# This method is not for casual code but for application monitoring libraries.
# You can add custom code before and after fork events by overriding this
# method.
#
# Note: Process.daemon may be implemented using fork(2) BUT does not go through
# this method. Thus, depending on your reason to hook into this method, you may
# also want to hook into that one. See [this
# issue](https://bugs.ruby-lang.org/issues/18911) for a more detailed discussion
# of this.
#
def self._fork: () -> Integer
# <!--
# rdoc-file=ruby.c
# - Process.argv0 -> frozen_string
# -->
# Returns the name of the script being executed. The value is not affected by
# assigning a new value to $0.
#
# This method first appeared in Ruby 2.1 to serve as a global variable free
# means to get the script name.
#
def self.argv0: () -> String
# <!--
# rdoc-file=process.c
# - Process.clock_getres(clock_id, unit = :float_second) -> number
# -->
# Returns a clock resolution as determined by POSIX function
# [clock_getres()](https://man7.org/linux/man-pages/man3/clock_getres.3.html):
#
# Process.clock_getres(:CLOCK_REALTIME) # => 1.0e-09
#
# See Process.clock_gettime for the values of `clock_id` and `unit`.
#
# Examples:
#
# Process.clock_getres(:CLOCK_PROCESS_CPUTIME_ID, :float_microsecond) # => 0.001
# Process.clock_getres(:CLOCK_PROCESS_CPUTIME_ID, :float_millisecond) # => 1.0e-06
# Process.clock_getres(:CLOCK_PROCESS_CPUTIME_ID, :float_second) # => 1.0e-09
# Process.clock_getres(:CLOCK_PROCESS_CPUTIME_ID, :microsecond) # => 0
# Process.clock_getres(:CLOCK_PROCESS_CPUTIME_ID, :millisecond) # => 0
# Process.clock_getres(:CLOCK_PROCESS_CPUTIME_ID, :nanosecond) # => 1
# Process.clock_getres(:CLOCK_PROCESS_CPUTIME_ID, :second) # => 0
#
# In addition to the values for `unit` supported in Process.clock_gettime, this
# method supports `:hertz`, the integer number of clock ticks per second (which
# is the reciprocal of `:float_second`):
#
# Process.clock_getres(:TIMES_BASED_CLOCK_PROCESS_CPUTIME_ID, :hertz) # => 100.0
# Process.clock_getres(:TIMES_BASED_CLOCK_PROCESS_CPUTIME_ID, :float_second) # => 0.01
#
# **Accuracy**: Note that the returned resolution may be inaccurate on some
# platforms due to underlying bugs. Inaccurate resolutions have been reported
# for various clocks including `:CLOCK_MONOTONIC` and `:CLOCK_MONOTONIC_RAW` on
# Linux, macOS, BSD or AIX platforms, when using ARM processors, or when using
# virtualization.
#
def self.clock_getres: (Symbol | Integer clock_id, ?Symbol unit) -> (Float | Integer)
# <!--
# rdoc-file=process.c
# - Process.clock_gettime(clock_id, unit = :float_second) -> number
# -->
# Returns a clock time as determined by POSIX function
# [clock_gettime()](https://man7.org/linux/man-pages/man3/clock_gettime.3.html):
#
# Process.clock_gettime(:CLOCK_PROCESS_CPUTIME_ID) # => 198.650379677
#
# Argument `clock_id` should be a symbol or a constant that specifies the clock
# whose time is to be returned; see below.
#
# Optional argument `unit` should be a symbol that specifies the unit to be used
# in the returned clock time; see below.
#
# **Argument `clock_id`**
#
# Argument `clock_id` specifies the clock whose time is to be returned; it may
# be a constant such as `Process::CLOCK_REALTIME`, or a symbol shorthand such as
# `:CLOCK_REALTIME`.
#
# The supported clocks depend on the underlying operating system; this method
# supports the following clocks on the indicated platforms (raises Errno::EINVAL
# if called with an unsupported clock):
#
# * `:CLOCK_BOOTTIME`: Linux 2.6.39.
# * `:CLOCK_BOOTTIME_ALARM`: Linux 3.0.
# * `:CLOCK_MONOTONIC`: SUSv3 to 4, Linux 2.5.63, FreeBSD 3.0, NetBSD 2.0,
# OpenBSD 3.4, macOS 10.12, Windows-2000.
# * `:CLOCK_MONOTONIC_COARSE`: Linux 2.6.32.
# * `:CLOCK_MONOTONIC_FAST`: FreeBSD 8.1.
# * `:CLOCK_MONOTONIC_PRECISE`: FreeBSD 8.1.
# * `:CLOCK_MONOTONIC_RAW`: Linux 2.6.28, macOS 10.12.
# * `:CLOCK_MONOTONIC_RAW_APPROX`: macOS 10.12.
# * `:CLOCK_PROCESS_CPUTIME_ID`: SUSv3 to 4, Linux 2.5.63, FreeBSD 9.3,
# OpenBSD 5.4, macOS 10.12.
# * `:CLOCK_PROF`: FreeBSD 3.0, OpenBSD 2.1.
# * `:CLOCK_REALTIME`: SUSv2 to 4, Linux 2.5.63, FreeBSD 3.0, NetBSD 2.0,
# OpenBSD 2.1, macOS 10.12, Windows-8/Server-2012. Time.now is recommended
# over +:CLOCK_REALTIME:.
# * `:CLOCK_REALTIME_ALARM`: Linux 3.0.
# * `:CLOCK_REALTIME_COARSE`: Linux 2.6.32.
# * `:CLOCK_REALTIME_FAST`: FreeBSD 8.1.
# * `:CLOCK_REALTIME_PRECISE`: FreeBSD 8.1.
# * `:CLOCK_SECOND`: FreeBSD 8.1.
# * `:CLOCK_TAI`: Linux 3.10.
# * `:CLOCK_THREAD_CPUTIME_ID`: SUSv3 to 4, Linux 2.5.63, FreeBSD 7.1, OpenBSD
# 5.4, macOS 10.12.
# * `:CLOCK_UPTIME`: FreeBSD 7.0, OpenBSD 5.5.
# * `:CLOCK_UPTIME_FAST`: FreeBSD 8.1.
# * `:CLOCK_UPTIME_PRECISE`: FreeBSD 8.1.
# * `:CLOCK_UPTIME_RAW`: macOS 10.12.
# * `:CLOCK_UPTIME_RAW_APPROX`: macOS 10.12.
# * `:CLOCK_VIRTUAL`: FreeBSD 3.0, OpenBSD 2.1.
#
#
# Note that SUS stands for Single Unix Specification. SUS contains POSIX and
# clock_gettime is defined in the POSIX part. SUS defines `:CLOCK_REALTIME` as
# mandatory but `:CLOCK_MONOTONIC`, `:CLOCK_PROCESS_CPUTIME_ID`, and
# `:CLOCK_THREAD_CPUTIME_ID` are optional.
#
# Certain emulations are used when the given `clock_id` is not supported
# directly:
#
# * Emulations for `:CLOCK_REALTIME`:
#
# * `:GETTIMEOFDAY_BASED_CLOCK_REALTIME`: Use gettimeofday() defined by
# SUS (deprecated in SUSv4). The resolution is 1 microsecond.
# * `:TIME_BASED_CLOCK_REALTIME`: Use time() defined by ISO C. The
# resolution is 1 second.
#
#
# * Emulations for `:CLOCK_MONOTONIC`:
#
# * `:MACH_ABSOLUTE_TIME_BASED_CLOCK_MONOTONIC`: Use mach_absolute_time(),
# available on Darwin. The resolution is CPU dependent.
# * `:TIMES_BASED_CLOCK_MONOTONIC`: Use the result value of times()
# defined by POSIX, thus:
# > Upon successful completion, times() shall return the elapsed real
# time, in clock ticks, since an arbitrary point in the past (for
# example, system start-up time).
#
# > For example, GNU/Linux returns a value based on jiffies and it is
# monotonic. However, 4.4BSD uses gettimeofday() and it is not
# monotonic. (FreeBSD uses `:CLOCK_MONOTONIC` instead, though.)
#
# The resolution is the clock tick. "getconf CLK_TCK" command shows the
# clock ticks per second. (The clock ticks-per-second is defined by HZ
# macro in older systems.) If it is 100 and clock_t is 32 bits integer
# type, the resolution is 10 millisecond and cannot represent over 497
# days.
#
#
# * Emulations for `:CLOCK_PROCESS_CPUTIME_ID`:
#
# * `:GETRUSAGE_BASED_CLOCK_PROCESS_CPUTIME_ID`: Use getrusage() defined
# by SUS. getrusage() is used with RUSAGE_SELF to obtain the time only
# for the calling process (excluding the time for child processes). The
# result is addition of user time (ru_utime) and system time (ru_stime).
# The resolution is 1 microsecond.
# * `:TIMES_BASED_CLOCK_PROCESS_CPUTIME_ID`: Use times() defined by POSIX.
# The result is addition of user time (tms_utime) and system time
# (tms_stime). tms_cutime and tms_cstime are ignored to exclude the time
# for child processes. The resolution is the clock tick. "getconf
# CLK_TCK" command shows the clock ticks per second. (The clock ticks
# per second is defined by HZ macro in older systems.) If it is 100, the
# resolution is 10 millisecond.
# * `:CLOCK_BASED_CLOCK_PROCESS_CPUTIME_ID`: Use clock() defined by ISO C.
# The resolution is `1/CLOCKS_PER_SEC`. `CLOCKS_PER_SEC` is the C-level
# macro defined by time.h. SUS defines `CLOCKS_PER_SEC` as 1000000;
# other systems may define it differently. If `CLOCKS_PER_SEC` is
# 1000000 (as in SUS), the resolution is 1 microsecond. If
# `CLOCKS_PER_SEC` is 1000000 and clock_t is a 32-bit integer type, it
# cannot represent over 72 minutes.
#
#
#
# **Argument `unit`**
#
# Optional argument `unit` (default `:float_second`) specifies the unit for the
# returned value.
#
# * `:float_microsecond`: Number of microseconds as a float.
# * `:float_millisecond`: Number of milliseconds as a float.
# * `:float_second`: Number of seconds as a float.
# * `:microsecond`: Number of microseconds as an integer.
# * `:millisecond`: Number of milliseconds as an integer.
# * `:nanosecond`: Number of nanoseconds as an integer.
# * `::second`: Number of seconds as an integer.
#
#
# Examples:
#
# Process.clock_gettime(:CLOCK_PROCESS_CPUTIME_ID, :float_microsecond)
# # => 203605054.825
# Process.clock_gettime(:CLOCK_PROCESS_CPUTIME_ID, :float_millisecond)
# # => 203643.696848
# Process.clock_gettime(:CLOCK_PROCESS_CPUTIME_ID, :float_second)
# # => 203.762181929
# Process.clock_gettime(:CLOCK_PROCESS_CPUTIME_ID, :microsecond)
# # => 204123212
# Process.clock_gettime(:CLOCK_PROCESS_CPUTIME_ID, :millisecond)
# # => 204298
# Process.clock_gettime(:CLOCK_PROCESS_CPUTIME_ID, :nanosecond)
# # => 204602286036
# Process.clock_gettime(:CLOCK_PROCESS_CPUTIME_ID, :second)
# # => 204
#
# The underlying function, clock_gettime(), returns a number of nanoseconds.
# Float object (IEEE 754 double) is not enough to represent the return value for
# `:CLOCK_REALTIME`. If the exact nanoseconds value is required, use
# `:nanosecond` as the `unit`.
#
# The origin (time zero) of the returned value is system-dependent, and may be,
# for example, system start up time, process start up time, the Epoch, etc.
#
# The origin in `:CLOCK_REALTIME` is defined as the Epoch: `1970-01-01 00:00:00
# UTC`; some systems count leap seconds and others don't, so the result may vary
# across systems.
#
def self.clock_gettime: (Symbol | Integer clock_id) -> Float
| (Symbol | Integer clock_id, :float_second | :float_millisecond | :float_microsecond unit) -> Float
| (Symbol | Integer clock_id, :second | :millisecond | :microsecond | :nanosecond unit) -> Integer
# <!--
# rdoc-file=process.c
# - Process.daemon(nochdir = nil, noclose = nil) -> 0
# -->
# Detaches the current process from its controlling terminal and runs it in the
# background as system daemon; returns zero.
#
# By default:
#
# * Changes the current working directory to the root directory.
# * Redirects $stdin, $stdout, and $stderr to the null device.
#
#
# If optional argument `nochdir` is `true`, does not change the current working
# directory.
#
# If optional argument `noclose` is `true`, does not redirect $stdin, $stdout,
# or $stderr.
#
def self.daemon: (?untyped nochdir, ?untyped noclose) -> Integer
# <!--
# rdoc-file=process.c
# - Process.detach(pid) -> thread
# -->
# Avoids the potential for a child process to become a [zombie
# process](https://en.wikipedia.org/wiki/Zombie_process). Process.detach
# prevents this by setting up a separate Ruby thread whose sole job is to reap
# the status of the process *pid* when it terminates.
#
# This method is needed only when the parent process will never wait for the
# child process.
#
# This example does not reap the second child process; that process appears as a
# zombie in the process status (`ps`) output:
#
# pid = Process.spawn('ruby', '-e', 'exit 13') # => 312691
# sleep(1)
# # Find zombies.
# system("ps -ho pid,state -p #{pid}")
#
# Output:
#
# 312716 Z
#
# This example also does not reap the second child process, but it does detach
# the process so that it does not become a zombie:
#
# pid = Process.spawn('ruby', '-e', 'exit 13') # => 313213
# thread = Process.detach(pid)
# sleep(1)
# # => #<Process::Waiter:0x00007f038f48b838 run>
# system("ps -ho pid,state -p #{pid}") # Finds no zombies.
#
# The waiting thread can return the pid of the detached child process:
#
# thread.join.pid # => 313262
#
def self.detach: (Integer pid) -> Thread
# <!--
# rdoc-file=process.c
# - Process.egid -> integer
# - Process::GID.eid -> integer
# - Process::Sys.geteid -> integer
# -->
# Returns the effective group ID for the current process:
#
# Process.egid # => 500
#
# Not available on all platforms.
#
def self.egid: () -> Integer
# <!--
# rdoc-file=process.c
# - Process.egid = new_egid -> new_egid
# -->
# Sets the effective group ID for the current process.
#
# Not available on all platforms.
#
def self.egid=: (Integer arg0) -> Integer
# <!--
# rdoc-file=process.c
# - Process.euid -> integer
# - Process::UID.eid -> integer
# - Process::Sys.geteuid -> integer
# -->
# Returns the effective user ID for the current process.
#
# Process.euid # => 501
#
def self.euid: () -> Integer
# <!--
# rdoc-file=process.c
# - Process.euid = new_euid -> new_euid
# -->
# Sets the effective user ID for the current process.
#
# Not available on all platforms.
#
def self.euid=: (Integer arg0) -> Integer
# <!--
# rdoc-file=process.c
# - Process.getpgid(pid) -> integer
# -->
# Returns the process group ID for the given process ID +pid+:
#
# Process.getpgid(Process.ppid) # => 25527
#
# Not available on all platforms.
#
def self.getpgid: (Integer pid) -> Integer
# <!--
# rdoc-file=process.c
# - Process.getpgrp -> integer
# -->
# Returns the process group ID for the current process:
#
# Process.getpgid(0) # => 25527
# Process.getpgrp # => 25527
#
def self.getpgrp: () -> Integer
# <!--
# rdoc-file=process.c
# - Process.getpriority(kind, id) -> integer
# -->
# Returns the scheduling priority for specified process, process group, or user.
#
# Argument `kind` is one of:
#
# * Process::PRIO_PROCESS: return priority for process.
# * Process::PRIO_PGRP: return priority for process group.
# * Process::PRIO_USER: return priority for user.
#
#
# Argument `id` is the ID for the process, process group, or user; zero
# specified the current ID for `kind`.
#
# Examples:
#
# Process.getpriority(Process::PRIO_USER, 0) # => 19
# Process.getpriority(Process::PRIO_PROCESS, 0) # => 19
#
# Not available on all platforms.
#
def self.getpriority: (Integer kind, Integer arg0) -> Integer
# <!--
# rdoc-file=process.c
# - Process.getrlimit(resource) -> [cur_limit, max_limit]
# -->
# Returns a 2-element array of the current (soft) limit and maximum (hard) limit
# for the given `resource`.
#
# Argument `resource` specifies the resource whose limits are to be returned;
# see Process.setrlimit.
#
# Each of the returned values `cur_limit` and `max_limit` is an integer; see
# Process.setrlimit.
#
# Example:
#
# Process.getrlimit(:CORE) # => [0, 18446744073709551615]
#
# See Process.setrlimit.
#
# Not available on all platforms.
#
def self.getrlimit: (interned | Integer resource) -> [ Integer, Integer ]
# <!--
# rdoc-file=process.c
# - Process.getsid(pid = nil) -> integer
# -->
# Returns the session ID of the given process ID `pid`, or of the current
# process if not given:
#
# Process.getsid # => 27422
# Process.getsid(0) # => 27422
# Process.getsid(Process.pid()) # => 27422
#
# Not available on all platforms.
#
def self.getsid: (?Integer pid) -> Integer
# <!--
# rdoc-file=process.c
# - Process.gid -> integer
# - Process::GID.rid -> integer
# - Process::Sys.getgid -> integer
# -->
# Returns the (real) group ID for the current process:
#
# Process.gid # => 1000
#
def self.gid: () -> Integer
# <!--
# rdoc-file=process.c
# - Process.gid = new_gid -> new_gid
# -->
# Sets the group ID for the current process to `new_gid`:
#
# Process.gid = 1000 # => 1000
#
def self.gid=: (Integer arg0) -> Integer
# <!--
# rdoc-file=process.c
# - Process.groups -> array
# -->
# Returns an array of the group IDs in the supplemental group access list for
# the current process:
#
# Process.groups # => [4, 24, 27, 30, 46, 122, 135, 136, 1000]
#
# These properties of the returned array are system-dependent:
#
# * Whether (and how) the array is sorted.
# * Whether the array includes effective group IDs.
# * Whether the array includes duplicate group IDs.
# * Whether the array size exceeds the value of Process.maxgroups.
#
#
# Use this call to get a sorted and unique array:
#
# Process.groups.uniq.sort
#
def self.groups: () -> ::Array[Integer]
# <!--
# rdoc-file=process.c
# - Process.groups = new_groups -> new_groups
# -->
# Sets the supplemental group access list to the given array of group IDs.
#
# Process.groups # => [0, 1, 2, 3, 4, 6, 10, 11, 20, 26, 27]
# Process.groups = [27, 6, 10, 11] # => [27, 6, 10, 11]
# Process.groups # => [27, 6, 10, 11]
#
def self.groups=: (::Array[Integer] arg0) -> ::Array[Integer]
# <!--
# rdoc-file=process.c
# - Process.initgroups(username, gid) -> array
# -->
# Sets the supplemental group access list; the new list includes:
#
# * The group IDs of those groups to which the user given by `username`
# belongs.
# * The group ID `gid`.
#
#
# Example:
#
# Process.groups # => [0, 1, 2, 3, 4, 6, 10, 11, 20, 26, 27]
# Process.initgroups('me', 30) # => [30, 6, 10, 11]
# Process.groups # => [30, 6, 10, 11]
#
# Not available on all platforms.
#
def self.initgroups: (String username, Integer gid) -> ::Array[Integer]
# <!--
# rdoc-file=process.c
# - Process.kill(signal, *ids) -> count
# -->
# Sends a signal to each process specified by `ids` (which must specify at least
# one ID); returns the count of signals sent.
#
# For each given `id`, if `id` is:
#
# * Positive, sends the signal to the process whose process ID is `id`.
# * Zero, send the signal to all processes in the current process group.
# * Negative, sends the signal to a system-dependent collection of processes.
#
#
# Argument `signal` specifies the signal to be sent; the argument may be:
#
# * An integer signal number: e.g., `-29`, `0`, `29`.
# * A signal name (string), with or without leading `'SIG'`, and with or
# without a further prefixed minus sign (`'-'`): e.g.:
#
# * `'SIGPOLL'`.
# * `'POLL'`,
# * `'-SIGPOLL'`.
# * `'-POLL'`.
#
#
# * A signal symbol, with or without leading `'SIG'`, and with or without a
# further prefixed minus sign (`'-'`): e.g.:
#
# * `:SIGPOLL`.
# * `:POLL`.
# * `:'-SIGPOLL'`.
# * `:'-POLL'`.
#
#
#
# If `signal` is:
#
# * A non-negative integer, or a signal name or symbol without prefixed `'-'`,
# each process with process ID `id` is signalled.
# * A negative integer, or a signal name or symbol with prefixed `'-'`, each
# process group with group ID `id` is signalled.
#
#
# Use method Signal.list to see which signals are supported by Ruby on the
# underlying platform; the method returns a hash of the string names and
# non-negative integer values of the supported signals. The size and content of
# the returned hash varies widely among platforms.
#
# Additionally, signal `0` is useful to determine if the process exists.
#
# Example:
#
# pid = fork do
# Signal.trap('HUP') { puts 'Ouch!'; exit }
# # ... do some work ...
# end
# # ...
# Process.kill('HUP', pid)
# Process.wait
#
# Output:
#
# Ouch!
#
# Exceptions:
#
# * Raises Errno::EINVAL or RangeError if `signal` is an integer but invalid.
# * Raises ArgumentError if `signal` is a string or symbol but invalid.
# * Raises Errno::ESRCH or RangeError if one of `ids` is invalid.
# * Raises Errno::EPERM if needed permissions are not in force.
#
#
# In the last two cases, signals may have been sent to some processes.
#
def self.kill: (Integer | interned signal, *Integer pids) -> Integer
# <!--
# rdoc-file=process.c
# - Process.maxgroups -> integer
# -->
# Returns the maximum number of group IDs allowed in the supplemental group
# access list:
#
# Process.maxgroups # => 32
#
def self.maxgroups: () -> Integer
# <!--
# rdoc-file=process.c
# - Process.maxgroups = new_max -> new_max
# -->
# Sets the maximum number of group IDs allowed in the supplemental group access
# list.
#
def self.maxgroups=: (Integer arg0) -> Integer
# <!--
# rdoc-file=process.c
# - Process.pid -> integer
# -->
# Returns the process ID of the current process:
#
# Process.pid # => 15668
#
def self.pid: () -> Integer
# <!--
# rdoc-file=process.c
# - Process.ppid -> integer
# -->
# Returns the process ID of the parent of the current process:
#
# puts "Pid is #{Process.pid}."
# fork { puts "Parent pid is #{Process.ppid}." }
#
# Output:
#
# Pid is 271290.
# Parent pid is 271290.
#
# May not return a trustworthy value on certain platforms.
#
def self.ppid: () -> Integer
# <!--
# rdoc-file=process.c
# - Process.setpgid(pid, pgid) -> 0
# -->
# Sets the process group ID for the process given by process ID `pid` to `pgid`.
#
# Not available on all platforms.
#
def self.setpgid: (Integer pid, Integer arg0) -> Integer
# <!--
# rdoc-file=process.c
# - Process.setpriority(kind, integer, priority) -> 0
# -->
# See Process.getpriority.
#
# Examples:
#
# Process.setpriority(Process::PRIO_USER, 0, 19) # => 0
# Process.setpriority(Process::PRIO_PROCESS, 0, 19) # => 0
# Process.getpriority(Process::PRIO_USER, 0) # => 19
# Process.getpriority(Process::PRIO_PROCESS, 0) # => 19
#
# Not available on all platforms.
#
def self.setpriority: (Integer kind, Integer arg0, Integer priority) -> Integer
# <!--
# rdoc-file=ruby.c
# - Process.setproctitle(string) -> string
# -->
# Sets the process title that appears on the ps(1) command. Not necessarily
# effective on all platforms. No exception will be raised regardless of the
# result, nor will NotImplementedError be raised even if the platform does not
# support the feature.
#
# Calling this method does not affect the value of $0.
#
# Process.setproctitle('myapp: worker #%d' % worker_id)
#
# This method first appeared in Ruby 2.1 to serve as a global variable free
# means to change the process title.
#
def self.setproctitle: (String arg0) -> String
# <!--